Diese Seite wurde von der Cloud Translation API übersetzt.

Apigee-SSO installieren und konfigurieren

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

Schlüssel und Zertifikate erstellen
Richten Sie die Apigee-Basiskonfiguration für die SSO ein:Die Basisdatei muss die Attribute enthalten, die für alle SSO-Konfigurationen gelten.
IdP-spezifische Konfigurationsattribute hinzufügen: Verwenden Sie einen der folgenden IdP-spezifischen Blöcke von Konfigurationsattributen in der Konfigurationsdatei:
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:

Erstellen Sie als sudo-Nutzer das folgende neue Verzeichnis:

sudo mkdir -p /opt/apigee/customer/application/apigee-sso/jwt-keys

Wechseln Sie zum neuen Verzeichnis:

cd /opt/apigee/customer/application/apigee-sso/jwt-keys/

Hinweis:Wenn Sie RHEL 9 oder ein ähnliches Betriebssystem verwenden, verwenden Sie möglicherweise OpenSSL 3.X. Fügen Sie in solchen Fällen dem OpenSSL-Befehl das Flag -traditional hinzu, damit Schlüssel und Zertifikate im erwarteten Format generiert werden.

Generieren Sie den privaten Schlüssel mit dem folgenden Befehl:
```
sudo openssl genrsa -out privkey.pem 2048
```
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
```
Ä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:

Erstellen Sie als Sudo-Nutzer ein neues Verzeichnis:

sudo mkdir -p /opt/apigee/customer/application/apigee-sso/idp/

Wechseln Sie zum neuen Verzeichnis:

cd /opt/apigee/customer/application/apigee-sso/idp/

Generieren Sie Ihren privaten Schlüssel mit einer Passphrase:
```
sudo openssl genrsa -aes256 -out server.key 1024
```
Entfernen Sie die Passphrase aus dem Schlüssel:
```
sudo openssl rsa -in server.key -out server.key
```
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
```

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

Ändern Sie den Inhaber der Schlüssel- und .crt-Datei in den Inhaber „apigee“:
```
sudo chown apigee:apigee server.key
sudo chown apigee:apigee selfsigned.crt
```

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 selbstsigniertes 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 den folgenden Block mit Konfigurationsattributen (wie oben definiert):

## 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

# SAML service provider key and cert from Create the TLS keys and certificates above.
SSO_SAML_SERVICE_PROVIDER_KEY=/opt/apigee/customer/application/apigee-sso/saml/server.key
SSO_SAML_SERVICE_PROVIDER_CERTIFICATE=/opt/apigee/customer/application/apigee-sso/saml/selfsigned.crt

# The passphrase used when you created the SAML cert and key.
# The section "Create the TLS keys and certificates" above removes the passphrase,
# but this property is available if you require a passphrase.
# SSO_SAML_SERVICE_PROVIDER_PASSWORD=samlSP123

# 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 LDAP-Direktbindung für Ihren IdP verwenden, verwenden Sie in Ihrer Konfigurationsdatei den folgenden Block von Konfigurationseigenschaften, wie im obigen Beispiel 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 nutzen, verwenden Sie in der Konfigurationsdatei den folgenden Block mit Konfigurationseigenschaften, wie im obigen Beispiel 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

# Attributname, der vom LDAP-Server verwendet wird, um auf die E-Mail-Adresse des Nutzers zu verweisen, 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:

Melden Sie sich beim Knoten des Verwaltungsservers an. Auf diesem Knoten sollte bereits apigee-service installiert sein, wie unter Installieren Sie das Hilfsprogramm für das Edge-Apigee-Setup 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.
Führen Sie den folgenden Befehl aus, um apigee-sso zu installieren und zu konfigurieren:
```
/opt/apigee/apigee-setup/bin/setup.sh -p sso -f configFile
```
Dabei ist configFile die Konfigurationsdatei, die Sie oben definiert haben.
Installieren Sie das Dienstprogramm apigee-ssoadminapi.sh, mit dem Administratoren und Nutzer von Computern für das apigee-sso-Modul verwaltet werden:
```
/opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
```
Melden Sie sich von der Shell ab und 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:

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 unter:
```
/opt/apigee/customer/application/apigee-sso/saml/metadata.xml
```
HINWEIS:Die Datei muss den Namen metadata.xml haben.

Weisen Sie die Eigentümerschaft der XML-Datei dem Nutzer „apigee“ zu:

chown apigee:apigee /opt/apigee/customer/application/apigee-sso/saml/metadata.xml

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 (/).