Configurazione del portale per l'utilizzo di SAML per comunicare con Edge

Edge per Private Cloud v4.19.01

Il portale Servizi per gli sviluppatori Apigee (o semplicemente il portale) funge da client di Apigee Edge. Ciò significa che il portale non funziona come un sistema autonomo. Invece, gran parte delle informazioni utilizzate dal portale viene effettivamente archiviata su Edge. Se necessario, il portale invia una richiesta per recuperare informazioni da Edge o per inviarle a Edge.

Il portale è sempre associato a una singola organizzazione Edge. Quando configuri il portale, puoi specificare le credenziali di autenticazione di base (nome utente e password) per un account dell'organizzazione che il portale utilizza per comunicare con Edge.

Se scegli di abilitare SAML per l'autenticazione Edge, potrai configurare il portale in modo che utilizzi l'autenticazione SAML quando invii richieste a Edge. La configurazione del portale per l'utilizzo di SAML crea automaticamente un nuovo account utente della macchina nell'organizzazione Edge, che verrà quindi utilizzato dal portale per effettuare richieste a Edge. Per saperne di più sugli utenti delle macchine, vedi Utilizzare SAML con attività automatizzate.

Il supporto SAML per il portale richiede che sia già stato installato e configurato il modulo Edge SSO sul nodo Edge Management Server. La procedura generale per attivare SAML per il portale è la seguente:

  1. Configura SAML su Edge come descritto in Installazione e configurazione di SAML per Edge. Nota: per installare il portale, l'autenticazione di base deve ancora essere abilitata su Edge. Non disabilitare l'autenticazione di base su Edge prima di aver configurato il portale per l'utilizzo di SAML.
  2. Installa il portale e assicurati che l'installazione funzioni correttamente. Vedi Installazione del portale Edge for Private Cloud.
  3. Configura SAML sul portale.
  4. Ora puoi disabilitare l'autenticazione di base su Edge.

Creazione di un utente della macchina per il portale

Quando SAML è abilitato, Edge supporta la generazione automatica di token OAuth2 tramite l'uso di utenti delle macchine. Un utente delle macchine può ottenere i token OAuth2 senza dover specificare un passcode. Ciò significa che puoi automatizzare completamente il processo di ottenimento e aggiornamento dei token OAuth2.

Il processo di configurazione SAML per il portale crea automaticamente un utente macchina nell'organizzazione associata al portale. Il portale utilizza quindi questo account utente della macchina per connettersi a Edge. Per saperne di più sugli utenti delle macchine, consulta Utilizzare SAML con attività automatizzate.

Informazioni sull'autenticazione per gli account sviluppatore del portale

Quando configuri il portale per l'utilizzo di SAML, lo autorizzi a utilizzare SAML per eseguire l'autenticazione con Edge, in modo che possa effettuare richieste a Edge. Tuttavia, il portale supporta anche un tipo di utente chiamato sviluppatori.

Gli sviluppatori costituiscono la community di utenti che creano app utilizzando le tue API. Gli sviluppatori di app utilizzano il portale per conoscere le tue API, registrare le app che le utilizzano, interagire con la community di sviluppatori e visualizzare informazioni statistiche sull'utilizzo delle app in una dashboard.

Quando uno sviluppatore accede al portale, quest'ultimo è responsabile dell'autenticazione dello sviluppatore e dell'applicazione delle autorizzazioni basate sui ruoli. Il portale continua a utilizzare l'autenticazione di base con gli sviluppatori anche dopo aver attivato SAML tra il portale ed Edge. Per saperne di più, consulta Comunicazione tra il portale ed Edge.

È possibile anche configurare il portale in modo che utilizzi SAML per autenticare gli sviluppatori. Per un esempio sull'attivazione di SAML utilizzando moduli Drupal di terze parti, consulta Integrazione del servizio SSO tramite SAML con il portale per gli sviluppatori.

Configura SAML sul portale per comunicare con Edge

Per configurare SAML per il portale, devi creare un file di configurazione per configurare il portale:

# 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

Per attivare il supporto SAML sul portale:

  1. Nella UI di Edge, aggiungi l'utente della macchina specificato da DEVPORTAL_ADMIN_EMAIL all'organizzazione associata al portale come Amministratore organizzazione.
  2. Esegui questo comando per configurare SAML sul portale: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f samlConfigFile

    Dove samlConfigFile è il file di configurazione SAML.

  3. Accedi al portale come amministratore del portale.
  4. Nel menu principale di Drupal, seleziona Configuration > Dev Portal (Configurazione > Portale di sviluppo). Viene visualizzata la schermata di configurazione del portale, che include le impostazioni SAML:

    Tieni presente che la casella per Questa organizzazione è abilitata per SAML è selezionata, l'endpoint per il modulo SSO Edge è compilato, i campi Chiave API e Segreto utente per il client OAuth del portale sono compilati e viene visualizzato il messaggio Connessione riuscita sotto il pulsante Verifica connessione.

  5. Puoi premere il pulsante Verifica connessione per ripetere il test della connessione in qualsiasi momento.

Per modificare questi valori in un secondo momento, aggiorna il file di configurazione ed esegui di nuovo il comando.

Disabilita SAML sul portale

Se scegli di disabilitare SAML per le comunicazioni tra il portale ed Edge, il portale non potrà più inviare richieste a Edge. Gli sviluppatori possono accedere al portale ma non possono visualizzare il prodotto o creare app.

Per disabilitare SAML sul portale:

  1. Modifica il file di configurazione utilizzato per configurare SAM per impostare: 
    DEVPORTAL_SSO_ENABLED=n
  2. Configura il portale: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile