Travailler avec des références

Vous consultez la documentation Apigee Edge.
Accédez à la documentation Apigee X. info

Lorsque vous configurez un hôte virtuel pour qu'il soit compatible avec TLS, vous spécifiez un keystore ou un truststore à l'aide de une référence. Une référence est une variable contenant le nom du keystore ou du truststore, qui évite de spécifier directement le nom du keystore/truststore, comme illustré ci-dessous :

    <SSLInfo> 
        <Enabled>true</Enabled> 
        <ClientAuthEnabled>false</ClientAuthEnabled> 
        <KeyStore>ref://myTestKeystoreRef</KeyStore> 
        <KeyAlias>myKeyAlias</KeyAlias> 
    </SSLInfo>

L'avantage d'utiliser une référence est que vous pouvez modifier la valeur de la référence afin de changer le keystore utilisé par l'hôte virtuel, généralement en cas d'expiration prochaine du certificat du keystore actuel. Modifier la valeur de la référence ne vous oblige pas à redémarrer le routeur Edge.

Vous ne pouvez utiliser qu'une référence au keystore et au truststore. Vous ne pouvez pas utiliser de référence à l' alias. Lorsque vous modifiez la référence à un keystore, assurez-vous que le nom d'alias du certificat est le même que dans l'ancien keystore.

Restrictions liées à l'utilisation des références aux keystores et au truststore

Vous devez tenir compte de la restriction suivante lorsque vous utilisez des références à des keystores et des truststores :

  • Vous ne pouvez utiliser des références keystore et truststore dans des hôtes virtuels que si vous êtes compatible avec SNI et que vous interrompez le protocole SSL sur les routeurs Apigee.
  • Si un équilibreur de charge est placé devant les routeurs Apigee et que vous interrompez le protocole TLS sur le équilibreur de charge, vous ne pouvez pas utiliser les références keystore et truststore dans les hôtes virtuels.

Créer une référence

Pour créer une référence dans l'interface utilisateur Edge :

  1. Connectez-vous à l'interface utilisateur de gestion Edge à l'adresse https://enterprise.apigee.com.
  2. Dans le menu de l'interface utilisateur de gestion Edge, sélectionnez le nom de votre organisation.
  3. Selon votre version de l'interface utilisateur Edge :
    1. Si vous utilisez l'interface utilisateur Edge classique : sélectionnez API > Configuration de l'environnement.
    2. Si vous utilisez la nouvelle interface utilisateur Edge : sélectionnez Administrateur > Environnements.
  4. Sélectionnez l'environnement (généralement prod ou test).
  5. Sélectionnez l'onglet Références.
  6. Sélectionnez le bouton + Référence. Le pop-up suivant s'affiche :
  7. Spécifiez les éléments suivants :
    1. Nom de la référence.
    2. Entité à laquelle la référence fait référence, c'est-à-dire le nom du keystore ou du truststore.
    3. Sélectionnez Enregistrer.

Vous pouvez également utiliser l'appel d'API Create Reference pour créer la référence nommée keystoreref :

curl -X POST  -H "Content-Type:application/xml" https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/references \
-d '<ResourceReference name="keystoreref">
    <Refers>myTestKeystore</Refers>
    <ResourceType>KeyStore</ResourceType>
</ResourceReference>' -u orgAdminEmail:password

La référence spécifie le nom du magasin de clés et son type. Utilisez le même appel d'API pour créer une référence à un truststore.

Modifier une référence

Pour modifier la valeur d'une référence dans l'interface utilisateur Edge :

  1. Connectez-vous à l'interface utilisateur de gestion Edge à l'adresse https://enterprise.apigee.com.
  2. Dans le menu de l'interface utilisateur de gestion Edge, sélectionnez le nom de votre organisation.
  3. Selon votre version de l'interface utilisateur Edge :
    1. Si vous utilisez l'interface utilisateur Edge classique : sélectionnez API > Configuration de l'environnement.
    2. Si vous utilisez la nouvelle interface utilisateur Edge : sélectionnez Administrateur > Environnements.
  4. Sélectionnez l'environnement (généralement prod ou test).
  5. Sélectionnez l'onglet Références.
  6. Dans l'onglet Référence, sélectionnez le bouton Modifier pour la référence.
  7. Mettez à jour la référence pour spécifier le nouveau keystore ou le nouveau truststore. Attention : Assurez-vous que l'alias du nouveau keystore porte le même nom que l'alias de l'ancien keystore.
  8. Sélectionnez Enregistrer.

Pour modifier la référence afin qu'elle pointe vers un keystore différent, et vous assurer que l'alias du nouveau keystore porte le même nom que l'alias de l'ancien keystore, utilisez l'API Update Reference :

curl -X PUT -H "Content-Type:application/xml" https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/references/keystoreref \
-d '<ResourceReference name="keystoreref">
    <Refers>myNewKeystore</Refers>
    <ResourceType>KeyStore</ResourceType>
</ResourceReference>' -u orgAdminEmail:password