Apigee-SSO installieren und konfigurieren

So installieren und konfigurieren Sie das Apigee-SSO-Modul mit einem externen IDP:

  1. Schlüssel und Zertifikate erstellen
  2. Grundlegende Apigee-SSO-Konfiguration einrichten:Die Basisdatei muss die Eigenschaften enthalten, die für alle SSO-Konfigurationen gemeinsam sind.
  3. IDP-spezifische Konfigurationseigenschaften hinzufügen:Verwenden Sie einen der folgenden IDP-spezifischen Blöcke von Konfigurationseigenschaften in Ihrer Konfigurationsdatei:
  4. Apigee SSO installieren:Installieren Sie das Apigee SSO-Modul und übergeben Sie die Konfigurationsdatei an das Installationsprogramm.

Jeder dieser Schritte wird in den folgenden Abschnitten beschrieben.

Schlüssel und Zertifikate erstellen

In diesem Abschnitt wird beschrieben, wie Sie selbst signierte Zertifikate erstellen. Diese eignen sich zwar für Ihre Testumgebung, für eine Produktionsumgebung sollten Sie jedoch Zertifikate verwenden, die von einer Zertifizierungsstelle signiert wurden.

So erstellen Sie das Schlüsselpaar, das zur Bestätigung signiert werden soll:

  1. Erstellen Sie als sudo-Nutzer das folgende neue Verzeichnis: 
    sudo mkdir -p /opt/apigee/customer/application/apigee-sso/jwt-keys
  2. Wechseln Sie zum neuen Verzeichnis: 
    cd /opt/apigee/customer/application/apigee-sso/jwt-keys/
  3. Generieren Sie den privaten Schlüssel mit dem folgenden Befehl: 
    sudo openssl genrsa -out privkey.pem 2048
  4. Generieren Sie den öffentlichen Schlüssel aus dem privaten Schlüssel mit dem folgenden Befehl: 
    sudo openssl rsa -pubout -in privkey.pem -out pubkey.pem
  5. Ändern Sie den Eigentümer der Ausgabe-PEM-Datei in den Nutzer „apigee“: 
    sudo chown apigee:apigee *.pem

So erstellen Sie den Schlüssel und das selbst signierte Zertifikat ohne Passphrase für die Kommunikation mit dem IdP:

  1. Erstellen Sie als Sudo-Nutzer ein neues Verzeichnis: 
    sudo mkdir -p /opt/apigee/customer/application/apigee-sso/idp/
  2. Wechseln Sie zum neuen Verzeichnis: 
    cd /opt/apigee/customer/application/apigee-sso/idp/
  3. Generieren Sie Ihren privaten Schlüssel mit einer Passphrase: 
    sudo openssl genrsa -out server.key 2048
  4. Entfernen Sie die Passphrase aus dem Schlüssel: 
    sudo openssl rsa -in server.key -out server.key
  5. Generieren Sie eine Anfrage für die Signierung des Zertifikats für die Zertifizierungsstelle: 
    sudo openssl req -x509 -sha256 -new -key server.key -out server.csr
  6. Selbst signiertes Zertifikat mit einer Ablaufzeit von 365 Tagen generieren: 
    sudo openssl x509 -sha256 -days 365 -in server.csr -signkey server.key -out selfsigned.crt
  7. Exportieren Sie den Schlüssel und das Zertifikat in einen Schlüsselspeicher:
    1. Exportieren Sie den Schlüssel und das Zertifikat in einen PKCS12-Schlüsselspeicher:
      2. sudo openssl pkcs12 -export -clcerts -in <certificate_path> -inkey <key_path> -out <keystore_path> -name <alias>

      Parameter:

      • certificate_path:Pfad zum in Schritt 6 erstellten Zertifikat.
      • key_path:Pfad zum privaten Schlüssel, der in Schritt 3 generiert wurde.
      • keystore_path:Pfad zum neu erstellten PKCS12-Keystore mit dem Zertifikat und dem privaten Schlüssel.
      • alias:Alias, der auf das Schlüssel-/Zertifikatspaar im Schlüsselspeicher verweist.

      Weitere Informationen finden Sie in der OpenSSL-Dokumentation.

    2. Optional: Exportieren Sie den Schlüssel und das Zertifikat aus PKCS12 in den JKS-Schlüsselspeicher:
      3. sudo keytool -importkeystore -srckeystore <PKCS12_keystore_path> -srcstoretype PKCS12 
-destkeystore <destination_keystore_path> -deststoretype JKS -alias <alias>

      Parameter:

      • PKCS12_keystore_path:Pfad zum PKCS12-Keystore, der in Schritt 7 erstellt wurde und das Zertifikat und den privaten Schlüssel enthält.
      • destination_keystore_path:Pfad zum neu erstellten JKS-Schlüsselspeicher mit demselben Zertifikat und Schlüssel.
      • alias:Alias, der für das Schlüssel- und Zertifikatspaar im JKS-Schlüsselspeicher verwendet wird.

      Weitere Informationen finden Sie in der Keytool-Dokumentation.

    3. Ändern Sie den Eigentümer der Ausgabe-Schlüsselspeicherdatei in den Nutzer „apigee“: 
      sudo chown apigee:apigee <keystore_file>
    4. Aktualisieren Sie die folgenden Properties in silent.conf:
      5. # Path to your keystore  
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_PATH=/opt/apigee/customer/application/apigee-sso/saml/keystore.p12  

# Keystore password
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_PASSWORD=Secret123

# Alias within keystore that stores the key and certificate  
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_ALIAS=service-provider-cert  

# [Optional] Only specify if you are using something other than JKS. Values could be PKCS12 or BCFKS  
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_TYPE=JKS

    Wenn Sie TLS im Apigee-SSO-Modul aktivieren möchten, indem Sie SSO_TOMCAT_PROFILE auf SSL_TERMINATION oder SSL_PROXY festlegen, können Sie kein selbst signiertes Zertifikat verwenden. Sie müssen ein Zertifikat von einer Zertifizierungsstelle generieren. Weitere Informationen finden Sie unter Apigee SSO für HTTPS-Zugriff konfigurieren.

    Apigee-SSO-Konfigurationseinstellungen

    Bevor Sie das Apigee-SSO-Modul installieren können, müssen Sie eine Konfigurationsdatei definieren. Sie übergeben diese Konfigurationsdatei an das Installationsprogramm, wenn Sie das Apigee-SSO-Modul installieren.

    Die Konfigurationsdatei hat folgendes Format:

    IP1=hostname_or_IP_of_apigee_SSO
IP2=hostname_or_IP_of_apigee_SSO

## Management Server configuration.
# Management Server IP address and port
MSIP=$IP1
MGMT_PORT=8080
# Edge sys admin username and password as set when you installed Edge.
ADMIN_EMAIL=opdk@google.com
APIGEE_ADMINPW=Secret123
# Set the protocol for the Edge management API. Default is http.
# Set to https if you enabled TLS on the management API.
MS_SCHEME=http

## Postgres configuration.
# Postgres IP address and port
PG_HOST=$IP1
PG_PORT=5432
# Postgres username and password as set when you installed Edge.
PG_USER=apigee
PG_PWD=postgres

## Apigee SSO module configuration.
# Choose either "saml" or "ldap".
SSO_PROFILE="[saml|ldap]"
# Externally accessible IP or DNS name of apigee-sso.
SSO_PUBLIC_URL_HOSTNAME=$IP2
SSO_PG_DB_NAME=database_name_for_sso

# Default port is 9099. If changing, set both properties to the same value.
SSO_PUBLIC_URL_PORT=9099
SSO_TOMCAT_PORT=9099
# Set Tomcat TLS mode to DEFAULT to use HTTP access to apigee-sso.
SSO_TOMCAT_PROFILE=DEFAULT
SSO_PUBLIC_URL_SCHEME=http

# SSO admin user name. The default is ssoadmin.
SSO_ADMIN_NAME=ssoadmin
# SSO admin password using uppercase, lowercase, number, and special chars.
SSO_ADMIN_SECRET=Secret123

# Enable the ability to sign an authentication request with SAML SSO.
SSO_SAML_SIGN_REQUEST=y

# Path to signing key and secret from Create the TLS keys and certificates above.
SSO_JWT_SIGNING_KEY_FILEPATH=/opt/apigee/customer/application/apigee-sso/jwt-keys/privkey.pem
SSO_JWT_VERIFICATION_KEY_FILEPATH=/opt/apigee/customer/application/apigee-sso/jwt-keys/pubkey.pem

###########################################################
#                 Define External IDP                     #
# Use one of the following configuration blocks to        #
# define your IDP settings:                               #
#  - SAML configuration properties                     #
#  - LDAP Direct Binding configuration properties        #
#  - LDAP Indirect Binding configuration properties       #
###########################################################

INSERT_IDP_CONFIG_BLOCK_HERE (SAML, LDAP direct, or LDAP indirect, below)

# Configure an SMTP server so that the Apigee SSO module can send emails to users
SKIP_SMTP=n
SMTPHOST=smtp.example.com
SMTPUSER=smtp@example.com
# omit for no username
SMTPPASSWORD=smtppwd
# omit for no password
SMTPSSL=n
SMTPPORT=25
# The address from which emails are sent
SMTPMAILFROM="My Company <myco@company.com>"

    Konfigurationseigenschaften für die SAML-Einmalanmeldung

    Wenn Sie SAML für Ihren IdP verwenden, verwenden Sie in Ihrer Konfigurationsdatei (wie oben definiert) den folgenden Block mit Konfigurationseigenschaften:

    ## SAML Configuration Properties
# Insert this section into your base configuration file, as described previously.

# Name of SAML IDP. For example, okta or adfs.
SSO_SAML_IDP_NAME=okta
# Text displayed on the SSO sign-in page after being redirected by either the New or Classic Edge UI for SAML logins.
# Note: Installing SSO does not depend on the Edge UI or which version of the UI you are using.
SSO_SAML_IDP_LOGIN_TEXT="Please log in to your IDP"

# The metadata URL from your IDP.
# If you have a metadata file, and not a URL,
# see "Specifying a metadata file instead of a URL" below.
SSO_SAML_IDP_METADATA_URL=https://dev-343434.oktapreview.com/app/exkar20cl/sso/saml/metadata

# Determines whether to skip TLS validation for the URL specified
# by SSO_SAML_IDP_METADATA_URL.
# This is necessary if the URL uses a self-signed certificate.
# The default value is "n".
SSO_SAML_IDPMETAURL_SKIPSSLVALIDATION=n

# Keystore configuration details
# [Optional] Only specify KEYSTORE_TYPE if you are using something other than JKS. Values could be PKCS12 or BCFKS.
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_PATH=/opt/apigee/customer/application/apigee-sso/saml/keystore.jks
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_PASSWORD=Secret123
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_ALIAS=service-provider-cert
SSO_SAML_SERVICE_PROVIDER_KEYSTORE_TYPE=JKS

# Requires that SAML responses be signed by your IDP.
# This property is enabled by default since release 4.50.00.05.
SSO_SAML_SIGNED_ASSERTIONS=y

    Konfigurationseigenschaften für die direkte LDAP-Bindung

    Wenn Sie die direkte LDAP-Bindung für Ihren IdP verwenden, verwenden Sie in Ihrer Konfigurationsdatei den folgenden Block mit Konfigurationseigenschaften, wie im Beispiel oben gezeigt: 

    ## LDAP Direct Binding configuration
# Insert this section into your base configuration file, as described previously.

# The type of LDAP profile; in this case, "direct"
SSO_LDAP_PROFILE=direct

# The base URL to which SSO connects; in the form: "ldap://hostname_or_IP:port
SSO_LDAP_BASE_URL=LDAP_base_URL

# Attribute name used by the LDAP server to refer to the user's email address; for example, "mail"
SSO_LDAP_MAIL_ATTRIBUTE=LDAP_email_attribute

# Pattern of the user's DN; for example: =cn={0},ou=people,dc=example,dc=org
# If there is more than one pattern, separate with semicolons (";"); for example:
# =cn={0},ou=people,dc=example,dc=org;=cn={0},ou=people,dc=example,dc=com
SSO_LDAP_USER_DN_PATTERN=LDAP_DN_pattern

    Konfigurationseigenschaften für die indirekte LDAP-Bindung

    Wenn Sie die indirekte LDAP-Bindung für Ihren IdP verwenden, verwenden Sie in Ihrer Konfigurationsdatei den folgenden Block mit Konfigurationseigenschaften, wie im Beispiel oben gezeigt: 

    ## LDAP Indirect Binding configuration
# Insert this section into your base configuration file, as described previously.

# Type of LDAP profile; in this case, "indirect"
SSO_LDAP_PROFILE=indirect

# Base URL to which SSO connects; in the form: "ldap://hostname_or_IP:port
SSO_LDAP_BASE_URL=LDAP_base_URL

# DN and password of the LDAP server's admin user
SSO_LDAP_ADMIN_USER_DN=LDAP_admin_DN
SSO_LDAP_ADMIN_PWD=LDAP_admin_password

# LDAP search base; for example, "dc=example,dc=org"
SSO_LDAP_SEARCH_BASE=LDAP_search_base

# LDAP search filter; for example, "cn={0}"
SSO_LDAP_SEARCH_FILTER=LDAP_search_filter
     # Name des Attributs, das vom LDAP-Server für die E-Mail-Adresse des Nutzers verwendet wird, z. B. „mail“ SSO_LDAP_MAIL_ATTRIBUTE=LDAP_email_attribute

    Apigee-SSO-Modul installieren

    Nachdem Sie die Schlüssel erstellt und die Konfigurationsdatei eingerichtet haben, können Sie das Apigee-SSO-Modul installieren.

    So installieren Sie das Apigee-SSO-Modul:

    1. Melden Sie sich beim Knoten des Verwaltungsservers an. Auf diesem Knoten sollte bereits apigee-service installiert sein, wie unter Edge-Dienstprogramm „apigee-setup“ installieren beschrieben.

      Alternativ können Sie das Apigee-SSO-Modul auf einem anderen Knoten installieren. Dieser Knoten muss jedoch über Port 8080 auf den Verwaltungsserver zugreifen können.

    2. Installieren und konfigurieren Sie apigee-sso mit dem folgenden Befehl: 
      /opt/apigee/apigee-setup/bin/setup.sh -p sso -f configFile

      Dabei ist configFile die oben definierte Konfigurationsdatei.

    3. Installieren Sie das Dienstprogramm apigee-ssoadminapi.sh, mit dem Administratoren und Nutzer von Computern für das Modul apigee-sso verwaltet werden: 
      /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
    4. Melden Sie sich von der Shell ab und melden Sie sich dann wieder an, um das apigee-ssoadminapi.sh-Dienstprogramm zu Ihrem Pfad hinzuzufügen.

    Metadatendatei anstelle einer URL angeben

    Wenn Ihr IdP keine HTTP-/HTTPS-Metadaten-URL unterstützt, können Sie Apigee SSO mit einer Metadaten-XML-Datei konfigurieren.

    So verwenden Sie eine Metadatendatei anstelle einer URL, um Apigee SSO zu konfigurieren:

    1. Kopieren Sie den Inhalt der Metadaten-XML-Datei von Ihrem IdP in eine Datei auf dem Apigee-SSO-Knoten. Kopieren Sie die XML-Datei beispielsweise an folgende Stelle: 
      /opt/apigee/customer/application/apigee-sso/saml/metadata.xml
    2. Ändern Sie die Eigentümerschaft der XML-Datei in „apigee“: 
      chown apigee:apigee /opt/apigee/customer/application/apigee-sso/saml/metadata.xml
    3. Legen Sie den Wert von SSO_SAML_IDP_METADATA_URL auf den absoluten Dateipfad fest: 
      SSO_SAML_IDP_METADATA_URL=file:///opt/apigee/customer/application/apigee-sso/saml/metadata.xml

      Sie müssen dem Dateipfad das Präfix „file://“ voranstellen, gefolgt vom absoluten Pfad vom Stammverzeichnis (/).