Installer et configurer l'authentification unique Apigee

Pour installer et configurer le module SSO Apigee avec un IDP externe, procédez comme suit:

  1. Créez des clés et des certificats.
  2. Configurez la configuration de base de l'authentification unique Apigee:le fichier de base doit inclure les propriétés communes à toutes les configurations d'authentification unique.
  3. Ajoutez des propriétés de configuration spécifiques à l'IDP:utilisez l'un des blocs de propriétés de configuration spécifiques à l'IDP suivants dans votre fichier de configuration :
  4. Installer Apigee SSO:installez le module Apigee SSO et transmettez le fichier de configuration à l'installateur.

Toutes ces étapes sont décrites plus en détail dans les sections suivantes.

Créer des clés et des certificats

Cette section explique comment créer des certificats autosignés, qui peuvent convenir pour votre environnement de test, mais vous devez utiliser des certificats signés par une autorité de certification (CA) pour un environnement de production.

Pour créer la paire de clés à signer pour la validation:

  1. En tant qu'utilisateur sudo, créez le répertoire suivant: 
    sudo mkdir -p /opt/apigee/customer/application/apigee-sso/jwt-keys
  2. Accédez au nouveau répertoire: 
    cd /opt/apigee/customer/application/apigee-sso/jwt-keys/
  3. Générez la clé privée à l'aide de la commande suivante: 
    sudo openssl genrsa -out privkey.pem 2048
  4. Générez la clé publique à partir de la clé privée à l'aide de la commande suivante: 
    sudo openssl rsa -pubout -in privkey.pem -out pubkey.pem
  5. Définissez l'utilisateur "apigee" comme propriétaire du fichier PEM de sortie: 
    sudo chown apigee:apigee *.pem

Pour créer la clé et le certificat autosigné, sans phrase secrète, pour communiquer avec l'IDP:

  1. En tant qu'utilisateur sudo, créez un répertoire: 
    sudo mkdir -p /opt/apigee/customer/application/apigee-sso/idp/
  2. Accédez au nouveau répertoire: 
    cd /opt/apigee/customer/application/apigee-sso/idp/
  3. Générez votre clé privée avec une phrase secrète: 
    sudo openssl genrsa -out server.key 2048
  4. Supprimez la phrase de passe de la clé: 
    sudo openssl rsa -in server.key -out server.key
  5. Générez une requête de signature de certificat pour l'autorité de certification: 
    sudo openssl req -x509 -sha256 -new -key server.key -out server.csr
  6. Générez un certificat autosigné avec une date d'expiration de 365 jours: 
    sudo openssl x509 -sha256 -days 365 -in server.csr -signkey server.key -out selfsigned.crt
  7. Exportez la clé et le certificat vers un keystore:
    1. Exportez la clé et le certificat vers un keystore PKCS12:
      2. sudo openssl pkcs12 -export -clcerts -in <certificate_path> -inkey <key_path> -out <keystore_path> -name <alias>

      Paramètres :

      • certificate_path:chemin d'accès au certificat créé à l'étape 6.
      • key_path:chemin d'accès à la clé privée générée à l'étape 3.
      • keystore_path:chemin d'accès au keystore PKCS12 nouvellement créé contenant le certificat et la clé privée.
      • alias:alias utilisé pour faire référence à la paire de clé et de certificat dans le keystore.

      Pour en savoir plus, consultez la documentation OpenSSL.

    2. (Facultatif) Exporter la clé et le certificat du keystore PKCS12 vers le keystore JKS:
      3. sudo keytool -importkeystore -srckeystore <PKCS12_keystore_path> -srcstoretype PKCS12 
-destkeystore <destination_keystore_path> -deststoretype JKS -alias <alias>

      Paramètres :

      • PKCS12_keystore_path:chemin d'accès au keystore PKCS12 créé à l'étape 7, contenant le certificat et la clé privée.
      • destination_keystore_path:chemin d'accès au keystore JKS nouvellement créé contenant le même certificat et la même clé.
      • alias:alias utilisé pour la paire de clé et de certificat dans le keystore JKS.

      Pour en savoir plus, consultez la documentation keytool.

    3. Définissez l'utilisateur "apigee" comme propriétaire du fichier keystore de sortie: 
      sudo chown apigee:apigee <keystore_file>
    4. Modifiez les propriétés suivantes dans 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

    Pour activer TLS sur le module SSO Apigee, en définissant SSO_TOMCAT_PROFILE sur SSL_TERMINATION ou SSL_PROXY, vous ne pouvez pas utiliser de certificat autosigné. Vous devez générer un certificat à partir d'une autorité de certification. Pour en savoir plus, consultez la section Configurer l'authentification unique Apigee pour l'accès HTTPS.

    Paramètres de configuration du SSO Apigee

    Avant de pouvoir installer le module d'authentification unique Apigee, vous devez définir un fichier de configuration. Vous transmettez ce fichier de configuration à l'installateur lorsque vous installez le module SSO Apigee.

    Le fichier de configuration se présente comme suit:

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

    Propriétés de configuration de l'authentification unique SAML

    Si vous utilisez SAML pour votre IDP, utilisez le bloc de propriétés de configuration suivant dans votre fichier de configuration (défini ci-dessus):

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

    Propriétés de configuration de la liaison directe LDAP

    Si vous utilisez la liaison directe LDAP pour votre IDP, utilisez le bloc de propriétés de configuration suivant dans votre fichier de configuration, comme indiqué dans l'exemple ci-dessus: 

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

    Propriétés de configuration de la liaison indirecte LDAP

    Si vous utilisez la liaison indirecte LDAP pour votre IDP, utilisez le bloc de propriétés de configuration suivant dans votre fichier de configuration, comme indiqué dans l'exemple ci-dessus: 

    ## 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
     # Nom de l'attribut utilisé par le serveur LDAP pour faire référence à l'adresse e-mail de l'utilisateur (par exemple, "mail") SSO_LDAP_MAIL_ATTRIBUTE=LDAP_email_attribute

    Installer le module Apigee SSO

    Une fois les clés créées et le fichier de configuration configuré, vous pouvez installer le module SSO Apigee.

    Pour installer le module d'authentification unique Apigee:

    1. Connectez-vous au nœud du serveur de gestion. apigee-service doit déjà être installé sur ce nœud, comme décrit dans la section Installer l'utilitaire apigee-setup Edge.

      Vous pouvez également installer le module SSO Apigee sur un autre nœud. Toutefois, ce nœud doit pouvoir accéder au serveur de gestion via le port 8080.

    2. Installez et configurez apigee-sso en exécutant la commande suivante: 
      /opt/apigee/apigee-setup/bin/setup.sh -p sso -f configFile

      où configFile est le fichier de configuration que vous avez défini ci-dessus.

    3. Installez l'utilitaire apigee-ssoadminapi.sh utilisé pour gérer les utilisateurs administrateur et de machine pour le module apigee-sso: 
      /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
    4. Déconnectez-vous du shell, puis reconnectez-vous pour ajouter l'utilitaire apigee-ssoadminapi.sh à votre chemin d'accès.

    Spécifier un fichier de métadonnées au lieu d'une URL

    Si votre IdP n'est pas compatible avec une URL de métadonnées HTTP/HTTPS, vous pouvez utiliser un fichier XML de métadonnées pour configurer le SSO Apigee.

    Pour configurer le SSO Apigee à l'aide d'un fichier de métadonnées au lieu d'une URL:

    1. Copiez le contenu du fichier XML de métadonnées de votre IdP dans un fichier sur le nœud d'authentification unique Apigee. Par exemple, copiez le code XML dans: 
      /opt/apigee/customer/application/apigee-sso/saml/metadata.xml
    2. Attribuez la propriété du fichier XML à l'utilisateur "apigee" : 
      chown apigee:apigee /opt/apigee/customer/application/apigee-sso/saml/metadata.xml
    3. Définissez la valeur de SSO_SAML_IDP_METADATA_URL sur le chemin d'accès au fichier absolu: 
      SSO_SAML_IDP_METADATA_URL=file:///opt/apigee/customer/application/apigee-sso/saml/metadata.xml

      Vous devez ajouter le préfixe "file://" au chemin d'accès du fichier, suivi du chemin absolu à partir de la racine (/).