Portal für die Kommunikation mit Edge mit SAML konfigurieren

Edge for Private Cloud v4.18.05

Das Apigee Developer Services-Portal (oder einfach das Portal) fungiert als Client von Apigee Edge. Das Portal funktioniert also nicht als eigenständiges System. Stattdessen werden viele der vom Portal verwendeten Informationen in Edge gespeichert. Bei Bedarf sendet das Portal eine Anfrage, um Informationen von Edge abzurufen oder Informationen an Edge zu senden.

Das Portal ist immer mit einer einzelnen Edge-Organisation verknüpft. Wenn Sie das Portal konfigurieren, können Sie die Anmeldedaten für die Basisauthentifizierung (Nutzername und Passwort) für ein Konto in der Organisation angeben, über das das Portal mit Edge kommuniziert.

Wenn Sie SAML für die Edge-Authentifizierung aktivieren, können Sie das Portal so konfigurieren, dass bei Anfragen an Edge die SAML-Authentifizierung verwendet wird. Wenn Sie das Portal für die Verwendung von SAML konfigurieren, wird automatisch ein neues Nutzerkonto für den Computer in der Edge-Organisation erstellt, über das das Portal dann Anfragen an Edge sendet. Weitere Informationen zu Nutzerkonten für Maschinen finden Sie unter SAML mit automatisierten Aufgaben verwenden.

Für die SAML-Unterstützung für das Portal müssen Sie das Edge SSO-Modul bereits auf dem Edge Management Server-Knoten installiert und konfiguriert haben. So aktivieren Sie SAML für das Portal:

  1. Konfigurieren Sie SAML in Edge wie unter Installation und Konfiguration von SAML für Edge beschrieben. Hinweis: Die grundlegende Authentifizierung muss weiterhin in Edge aktiviert sein, damit das Portal installiert werden kann. Deaktivieren Sie die Basisauthentifizierung auf Edge erst, nachdem Sie das Portal für die Verwendung von SAML konfiguriert haben.
  2. Installieren Sie das Portal und prüfen Sie, ob es ordnungsgemäß funktioniert. Weitere Informationen finden Sie unter Edge for Private Cloud-Portal installieren.
  3. Konfigurieren Sie SAML im Portal.
  4. Sie können die einfache Authentifizierung in Edge jetzt deaktivieren.

Nutzer für das Portal erstellen

Wenn SAML aktiviert ist, unterstützt Edge die automatische OAuth2-Tokengenerierung mithilfe von Maschinennutzern. Ein Nutzer eines Geräts kann OAuth2-Tokens abrufen, ohne einen Sicherheitscode angeben zu müssen. Das bedeutet, dass Sie das Abrufen und Aktualisieren von OAuth2-Tokens vollständig automatisieren können.

Beim SAML-Konfigurationsprozess für das Portal wird automatisch ein Nutzerkonto für den Computer in der mit dem Portal verknüpften Organisation erstellt. Das Portal verwendet dann dieses Nutzerkonto, um eine Verbindung zu Edge herzustellen. Weitere Informationen zu Nutzerkonten für Maschinen finden Sie unter SAML mit automatisierten Aufgaben verwenden.

Authentifizierung für Entwicklerkonten im Portal

Wenn Sie das Portal für die Verwendung von SAML konfigurieren, aktivieren Sie die SAML-Authentifizierung des Portals bei Edge, damit das Portal Anfragen an Edge senden kann. Das Portal unterstützt jedoch auch einen Nutzertyp namens Entwickler.

Entwickler sind die Nutzer, die mithilfe Ihrer APIs Apps erstellen. App-Entwickler können sich über das Portal über Ihre APIs informieren, Apps registrieren, die Ihre APIs verwenden, mit der Entwickler-Community interagieren und sich in einem Dashboard statistische Informationen zur App-Nutzung ansehen.

Wenn sich ein Entwickler im Portal anmeldet, ist das Portal für die Authentifizierung des Entwicklers und die Durchsetzung rollenbasierter Berechtigungen verantwortlich. Das Portal verwendet auch dann weiterhin die einfache Authentifizierung für Entwickler, wenn Sie SAML zwischen dem Portal und Edge aktivieren. Weitere Informationen finden Sie unter Kommunikation zwischen dem Portal und Edge.

Sie können das Portal auch so konfigurieren, dass Entwickler mit SAML authentifiziert werden. Ein Beispiel zum Aktivieren von SAML mit Drupal-Modulen von Drittanbietern finden Sie unter SSO-Integration über SAML mit dem Entwicklerportal.

SAML auf dem Portal für die Kommunikation mit Edge konfigurieren

Wenn Sie SAML für das Portal konfigurieren möchten, müssen Sie eine Konfigurationsdatei erstellen:

# IP address of Edge Management Server and apigee-sso node.
IP1=22.222.22.222

# URL of Edge management API.
MGMT_URL=http://$IP1:8080/v1

# Org associated with the portal.
EDGE_ORG=myorg

# Information about apigee-sso.
# Externally accessible IP or DNS of apigee-sso.
SSO_PUBLIC_URL_HOSTNAME=$IP1
SSO_PUBLIC_URL_PORT=9099
# Default is http. Set to https if you enabled TLS on apigee-sso.
SSO_PUBLIC_URL_SCHEME=http

# SSO admin credentials as set when you installed apigee-sso.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=Secret123

# Default is "n" to disable SAML support.
DEVPORTAL_SSO_ENABLED=y

# The name of the OAuth client used to connect to apigee-sso. 
# The default client name is portalcli.
PORTALCLI_SSO_CLIENT_NAME=portalcli
# Oauth client password using uppercase, lowercase, number, and special chars. 
PORTALCLI_SSO_CLIENT_SECRET=Abcdefg@1

# Email address and user info for the machine user created in 
# the Edge org specified above by EDGE_ORG. 
# This account is used by the portal to make requests to Edge.
# Add this email as an org admin before configuring the portal to use SAML. 
DEVPORTAL_ADMIN_EMAIL=DevPortal_SAML@google.com
DEVPORTAL_ADMIN_FIRSTNAME=DevPortal
DEVPORTAL_ADMIN_LASTNAME=SAMLAdmin
DEVPORTAL_ADMIN_PWD=Abcdefg@1

# If set, the existing portal OAuth client is deleted and new one is created.
# The default value is "n".
# Set to "y" when you configure SAML and change the value of 
# any of the PORTALCLI_* properties.
PORTALCLI_SSO_CLIENT_OVERWRITE=y

So aktivieren Sie die SAML-Unterstützung im Portal:

  1. Fügen Sie in der Edge-Benutzeroberfläche den mit DEVPORTAL_ADMIN_EMAIL angegebenen Computernutzer der Organisation hinzu, die mit dem Portal verknüpft ist, als Administrator der Organisation.
  2. Führen Sie den folgenden Befehl aus, um SAML im Portal zu konfigurieren:
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f samlConfigFile

    Dabei ist samlConfigFile die SAML-Konfigurationsdatei.

  3. Melden Sie sich im Portal als Portaladministrator an.
  4. Wählen Sie im Hauptmenü von Drupal Konfiguration > Dev-Portal aus. Der Konfigurationsbildschirm des Portals wird angezeigt, einschließlich der SAML-Einstellungen:

    Das Kästchen für Diese Organisation ist SAML-fähig ist angeklickt, der Endpunkt für das Edge-SSO-Modul ist ausgefüllt, die Felder API-Schlüssel und Nutzer geheim für den Oauth-Client des Portals sind ausgefüllt und die Meldung Verbindung erfolgreich wird unter der Schaltfläche Verbindung testen angezeigt.

  5. Sie können die Verbindung jederzeit noch einmal testen, indem Sie auf die Schaltfläche Verbindung testen klicken.

Wenn Sie diese Werte später ändern möchten, aktualisieren Sie die Konfigurationsdatei und führen Sie den Befehl noch einmal aus.

SAML im Portal deaktivieren

Wenn Sie SAML für die Kommunikation zwischen dem Portal und Edge deaktivieren, kann das Portal keine Anfragen mehr an Edge senden. Entwickler können sich im Portal anmelden, können aber keine Produkte ansehen oder Apps erstellen.

So deaktivieren Sie SAML im Portal:

  1. Bearbeiten Sie die Konfigurationsdatei, mit der Sie SAM konfiguriert haben, um Folgendes festzulegen:
    DEVPORTAL_SSO_ENABLED=n
  2. Portal konfigurieren:
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile