Configurer l'authentification unique Apigee pour un accès HTTPS

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

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, le module SSO Apigee, 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. Spécifiez ensuite le port utilisé sur apigee-sso pour les requêtes provenant de l'équilibreur de charge.
  • SSL_TERMINATION::activé l'accès TLS à apigee-sso 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 lors de l'installation et de la configuration initiales de apigee-sso, ou ultérieurement.

L'activation de l'accès HTTPS à apigee-sso dans l'un ou l'autre mode désactive l'accès HTTP. Autrement dit, 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 d'authentification unique Apigee et interrompt le protocole TLS au niveau de l'équilibreur de charge. Dans la figure suivante, l'équilibreur de charge interrompt le protocole TLS sur le port 443, puis transfère les requêtes au module d'authentification unique Apigee sur le port 9099:

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

Vous devez configurer le module d'authentification unique Apigee en mode SSL_PROXY parce qu'il génère 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 SSO Apigee, 9099.

Pour configurer le module SSO Apigee 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.
# The default is 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 SSO Apigee : 
    /opt/apigee/apigee-service/bin/apigee-service apigee-sso setup -f configFile
  3. Mettez à jour votre configuration IDP pour effectuer maintenant une requête HTTPS sur le port 443 de l'équilibreur de charge pour accéder à l'authentification unique Apigee. Pour en savoir plus, consultez l'une des pages suivantes :
  4. Mettez à jour la configuration de l'interface utilisateur Edge pour HTTPS en définissant les propriétés suivantes dans le fichier de configuration:
    SSO_PUBLIC_URL_PORT=443
SSO_PUBLIC_URL_SCHEME=https

    Mettez ensuite à jour l'interface utilisateur Edge:

    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile

    Utilisez le composant edge-ui pour l'interface utilisateur classique.

  5. Si vous avez installé le portail de services pour les développeurs Apigee (ou simplement le portail), mettez-le à jour pour qu'il utilise HTTPS pour accéder à l'authentification unique Apigee. Pour en savoir plus, consultez Configurer le portail pour utiliser des IdP externes.

Pour plus d'informations, consultez la section Activer un fournisseur d'identité externe dans l'interface utilisateur Edge.

Activer le mode SSL_TERMINATION

Pour le mode SSL_TERMINATION, vous devez:

  • Générez un certificat et une clé TLS, puis stockez-les dans un fichier keystore. Vous ne pouvez pas utiliser de certificat autosigné. Vous devez générer un certificat auprès d'une autorité de certification.
  • Mettre à 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é. Vous devez spécifier un keystore pour ce mode 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 la section Configurer TLS/SSL pour Edge sur site.
  4. Faites en sorte que le fichier JKS soit détenu par l'utilisateur "apigee" :
    sudo chown -R apigee:apigee /opt/apigee/customer/application/apigee-sso/tomcat-ssl

Pour configurer le module SSO Apigee:

  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.
# The default is 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 SSO Apigee : 
    /opt/apigee/apigee-service/bin/apigee-service apigee-sso setup -f configFile
  3. Mettez à jour votre configuration IDP pour effectuer maintenant une requête HTTPS sur le port 9443 de l'équilibreur de charge afin d'accéder à l'authentification unique Apigee. Vérifiez qu'aucun autre service n'utilise ce port.

    Pour en savoir plus, consultez les ressources suivantes :

  4. Mettez à jour la configuration de l'interface utilisateur Edge pour HTTPS en définissant les propriétés suivantes : 
    SSO_PUBLIC_URL_PORT=9443
SSO_PUBLIC_URL_SCHEME=https
  5. Si vous avez installé le portail de services pour les développeurs, mettez-le à jour pour qu'il utilise HTTPS pour accéder à l'authentification unique Apigee. Pour en savoir plus, consultez la section Configurer le portail pour utiliser des IdP externes.

Définir SSO_TOMCAT_PROXY_PORT lors de l'utilisation du mode SSL_TERMINATION

Vous pouvez disposer d'un équilibreur de charge devant le module d'authentification unique Apigee qui met fin au protocole TLS au niveau de l'équilibreur de charge, mais active également TLS entre l'équilibreur de charge et l'authentification unique Apigee. Dans la figure ci-dessus pour le mode SSL_PROXY, cela signifie que la connexion de l'équilibreur de charge à l'authentification unique Apigee utilise TLS.

Dans ce scénario, vous configurez TLS sur l'authentification unique Apigee 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 Apigee 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 interrompt le protocole TLS sur le port 443
  • Apigee SSO met fin au protocole TLS sur le port 9443

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

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

Il configure l'interface utilisateur IdP et Edge pour effectuer des requêtes HTTPS sur le port 443.