Installer et configurer l'authentification unique Apigee

Pour installer et configurer le module d'authentification unique Apigee avec un IdP externe, procédez comme suit:

  1. Créer les clés et les certificats TLS:le module d'authentification unique Apigee utilise TLS pour sécuriser la transmission des informations avec les entités externes.
  2. Définir la configuration de base de l'authentification unique Apigee:le fichier de base doit inclure les propriétés communes à toutes les configurations SSO.
  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 suivant dans votre fichier de configuration :
  4. Installer l'authentification unique Apigee:installez le module d'authentification unique Apigee et transmettez le fichier de configuration au programme d'installation.

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

Créer les clés et les certificats TLS

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

Pour créer la clé de validation et de signature et le certificat autosigné:

  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. Remplacez le propriétaire du fichier PEM de sortie par l'utilisateur "apigee" :
    sudo chown apigee:apigee *.pem

Pour créer la clé et le certificat autosigné sans phrase secrète, afin de 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 -aes256 -out server.key 1024
  4. Supprimez la phrase secrète de la clé :
    sudo openssl rsa -in server.key -out server.key
  5. Générer 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 un délai d'expiration de 365 jours :
    sudo openssl x509 -sha256 -days 365 -in server.csr -signkey server.key -out selfsigned.crt
  7. Remplacez le propriétaire des fichiers de clé et de certificat par le propriétaire "apigee" :
    sudo chown apigee:apigee server.key
    sudo chown apigee:apigee selfsigned.crt

Pour activer le protocole TLS sur le module d'authentification unique Apigee, vous ne pouvez pas utiliser de certificat autosigné en définissant SSO_TOMCAT_PROFILE sur SSL_TERMINATION ou SSL_PROXY. Vous devez générer un certificat auprès 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 de l'authentification unique Apigee

Avant de pouvoir installer le module SSO Apigee, vous devez définir un fichier de configuration. Vous transmettez ce fichier de configuration au programme d'installation lorsque vous installez le module SSO Apigee.

Le fichier de configuration se présente sous la forme suivante:

IP1=hostname_or_IP_of_management_server
IP2=hostname_or_IP_of_UI_and_apigge_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 to user when they attempt to access Edge UI.
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.19.06.12.
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 illustré 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 une liaison indirecte LDAP pour votre IdP, utilisez le bloc de propriétés de configuration suivant dans votre fichier de configuration, comme illustré 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 d'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 SSO Apigee

Une fois les clés et le fichier de configuration créés, vous pouvez installer le module d'authentification unique 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 de configuration Edge d'Apigee.

    Vous pouvez aussi installer le module d'authentification unique Apigee sur un nœud différent. Cependant, 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

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

  3. Installez l'utilitaire apigee-ssoadminapi.sh permettant de gérer les administrateurs et les utilisateurs machine pour le module apigee-sso :
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  4. Déconnectez-vous de l'interface système, 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'accepte pas les URL de métadonnées HTTP/HTTPS, vous pouvez utiliser un fichier XML de métadonnées pour configurer l'authentification unique Apigee.

Pour utiliser un fichier de métadonnées au lieu d'une URL afin de configurer l'authentification unique Apigee:

  1. Copiez le contenu du fichier XML de métadonnées de votre IdP dans un fichier sur le nœud SSO Apigee. Par exemple, copiez le code XML vers :
    /opt/apigee/customer/application/apigee-sso/saml/metadata.xml
  2. Remplacez la propriété du fichier XML par 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 absolu au fichier :
    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 au fichier, suivi du chemin absolu depuis la racine (/).