Configurer apigee-sso pour l'accès HTTPS

Edge for Private Cloud v4.18.01

La section Installer et configurer l'authentification unique Edge explique comment installer et configurer le module d'authentification unique Edge pour utiliser HTTP sur le port 9099, comme spécifié par la propriété suivante dans le fichier de configuration :

SSO_TOMCAT_PROFILE=DEFAULT

Vous pouvez également définir SSO_TOMCAT_PROFILE sur l'une des valeurs suivantes pour activer l'accès HTTPS :

  • SSL_PROXY : configure apigee-sso en mode proxy, ce qui signifie que vous avez installé un équilibreur de charge devant apigee-sso et arrêté TLS sur l'équilibreur de charge. Vous spécifiez ensuite le port utilisé sur apigee-sso pour les requêtes provenant de l'équilibreur de charge.
  • SSL_TERMINATION : active l'accès TLS à apigee-sso, le module d'authentification unique Edge, sur le port de votre choix. Pour ce mode, vous devez spécifier un keystore contenant un certificat signé par une autorité de certification. Vous ne pouvez pas utiliser de certificat autosigné.

Vous pouvez choisir d'activer HTTPS au moment de l'installation et de la configuration initiales d'apigee-sso, ou vous pouvez l'activer ultérieurement.

L'activation de l'accès HTTPS à apigee-sso à l'aide de l'un ou l'autre mode désactive l'accès HTTP. En d'autres termes, vous ne pouvez pas accéder à apigee-sso en utilisant simultanément HTTP et HTTPS.

Activer le mode SSL_PROXY

En mode SSL_PROXY, votre système utilise un équilibreur de charge devant le module Edge SSO et met fin au protocole TLS sur l'équilibreur de charge. Dans la figure suivante, l'équilibreur de charge met fin au protocole TLS sur le port 443, puis transfère les requêtes au module SSO Edge sur le port 9099 :

Dans cette configuration, vous faites confiance à la connexion entre l'équilibreur de charge et le module Edge SSO. Il n'est donc pas nécessaire d'utiliser TLS pour cette connexion. Toutefois, les entités externes, telles que le fournisseur d'identité SAML, doivent désormais accéder au module Edge SSO sur le port 443, et non sur le port non protégé 9099.

La configuration du module Edge SSO en mode SSL_PROXY permet au module Edge SSO de générer automatiquement des URL de redirection utilisées en externe par l'IdP dans le cadre du processus d'authentification. Par conséquent, ces URL de redirection doivent contenir le numéro de port externe de l'équilibreur de charge (443 dans cet exemple) et non le port interne du module Edge SSO (9099).

Remarque : Vous n'avez pas besoin de créer un certificat et une clé TLS pour le mode SSL_PROXY, car la connexion de l'équilibreur de charge au module SSO Edge utilise HTTP.

Pour configurer le module Edge SSO pour le mode SSL_PROXY :

  1. Ajoutez les paramètres suivants à votre fichier de configuration :
    # Enable SSL_PROXY mode.
    SSO_TOMCAT_PROFILE=SSL_PROXY

    # Specify the apigee-sso port, typically between 1025 and 65535.
    # Typically ports 1024 and below require root access by apigee-sso.
    # La valeur par défaut est 9099.
    SSO_TOMCAT_PORT=9099

    # Specify the port number on the load balancer for terminating TLS.
    # This port number is necessary for apigee-sso to auto-generate redirect URLs.
    SSO_TOMCAT_PROXY_PORT=443
    SSO_PUBLIC_URL_PORT=443

    # Set public access scheme of apigee-sso to https.
    SSO_PUBLIC_URL_SCHEME=https
  2. Configurez le module Edge SSO :
    > /opt/apigee/apigee-service/bin/apigee-service apigee-sso setup -f configFile
  3. Mettez à jour la configuration de votre fournisseur d'identité pour qu'il envoie une requête HTTPS sur le port 443 de l'équilibreur de charge afin d'accéder à l'authentification unique Edge. Pour en savoir plus, consultez Configurer votre IdP SAML.
  4. Mettez à jour votre configuration de l'UI Edge pour HTTPS en définissant les propriétés suivantes :
    SSO_PUBLIC_URL_PORT=443
    SSO_PUBLIC_URL_SCHEME=https

    Pour en savoir plus, consultez Activer SAML sur l'UI Edge.
  5. Si vous avez installé le portail des services pour les développeurs ou l'API BaaS, mettez-les à jour pour qu'ils utilisent HTTPS pour accéder à l'authentification unique Edge. Pour en savoir plus, consultez :

Activer le mode SSL_TERMINATION

Pour le mode SSL_TERMINATION, vous devez :

  • Générer un certificat et une clé TLS, et les stocker dans un fichier keystore. Vous ne pouvez pas utiliser de certificat autosigné. Vous devez générer un certificat à partir d'une autorité de certification.
  • Mettez à jour les paramètres de configuration pour apigee-sso.

Pour créer un fichier keystore à partir de votre certificat et de votre clé :

  1. Créez un répertoire pour le fichier JKS :
    > sudo mkdir -p /opt/apigee/customer/application/apigee-sso/tomcat-ssl/
  2. Accédez au nouveau répertoire :
    > cd /opt/apigee/customer/application/apigee-sso/tomcat-ssl/
  3. Créez un fichier JKS contenant le certificat et la clé. Pour ce mode, vous devez spécifier un keystore contenant un certificat signé par une autorité de certification. Vous ne pouvez pas utiliser de certificat autosigné. Pour obtenir un exemple de création d'un fichier JKS, consultez Configurer TLS/SSL pour Edge sur site.
  4. Faites en sorte que le fichier JKS appartienne à l'utilisateur "apigee" :
    > sudo chown -R apigee:apigee /opt/apigee/customer/application/apigee-sso/tomcat-ssl

Pour configurer le module SSO Edge :

  1. Ajoutez les paramètres suivants à votre fichier de configuration :
    # Enable SSL_TERMINATION mode.
    SSO_TOMCAT_PROFILE=SSL_TERMINATION

    # Specify the path to the keystore file.
    SSO_TOMCAT_KEYSTORE_FILEPATH=/opt/apigee/customer/application/apigee-sso/tomcat-ssl/keystore.jks
    SSO_TOMCAT_KEYSTORE_ALIAS=sso

    # The password specified when you created the keystore.
    SSO_TOMCAT_KEYSTORE_PASSWORD=keystorePassword

    # Specify the HTTPS port number between 1025 and 65535.
    # Typically ports 1024 and below require root access by apigee-sso.
    # La valeur par défaut est 9099.
    SSO_TOMCAT_PORT=9443
    SSO_PUBLIC_URL_PORT=9443

    # Set public access scheme of apigee-sso to https.
    SSO_PUBLIC_URL_SCHEME=https
  2. Configurez le module Edge SSO :
    > /opt/apigee/apigee-service/bin/apigee-service apigee-sso setup -f configFile
  3. Mettez à jour la configuration de votre fournisseur d'identité pour qu'il envoie une requête HTTPS sur le port 9443 de l'équilibreur de charge afin d'accéder à l'authentification unique Edge. Pour en savoir plus, consultez Configurer votre IdP SAML.
  4. Mettez à jour votre configuration de l'UI Edge pour HTTPS en définissant les propriétés suivantes :
    SSO_PUBLIC_URL_PORT=9443
    SSO_PUBLIC_URL_SCHEME=https

    Pour en savoir plus, consultez Activer SAML sur l'UI Edge.
  5. Si vous avez installé le portail des services pour les développeurs ou l'API BaaS, mettez-les à jour pour qu'ils utilisent HTTPS pour accéder à l'authentification unique Edge. Pour en savoir plus, consultez :

Définir SSO_TOMCAT_PROXY_PORT en mode SSL_TERMINATION

Vous pouvez avoir un équilibreur de charge devant le module Edge SSO qui met fin au protocole TLS sur l'équilibreur de charge, mais vous pouvez également activer TLS entre l'équilibreur de charge et Edge SSO. Dans la figure ci-dessus pour le mode SSL_PROXY, cela signifie que la connexion entre l'équilibreur de charge et Edge SSO utilise TLS.

Dans ce scénario, vous configurez TLS sur l'authentification unique Edge comme vous l'avez fait ci-dessus pour le mode SSL_TERMINATION. Toutefois, si l'équilibreur de charge utilise un numéro de port TLS différent de celui utilisé par Edge SSO pour TLS, vous devez également spécifier la propriété SSO_TOMCAT_PROXY_PORT dans le fichier de configuration. Exemple :

  • L'équilibreur de charge met fin au protocole TLS sur le port 443.
  • Edge SSO met fin au protocole TLS sur le port 9443

Veillez à inclure le paramètre suivant dans le fichier de configuration :

# Spécifiez le numéro de port sur l'équilibreur de charge pour la terminaison TLS.
# This port number is necessary for apigee-sso to generate redirect URLs.
SSO_TOMCAT_PROXY_PORT=443
SSO_PUBLIC_URL_PORT=443

Configurez l'IDP et l'UI Edge pour qu'ils envoient des requêtes HTTPS sur le port 443.