Travailler avec des références

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X. en savoir plus

Lorsque vous configurez un hôte virtuel pour qu'il soit compatible avec TLS, vous spécifiez un keystore ou un Truststore à l'aide d'une référence. Une référence est une variable qui contient le nom du keystore ou du truststore, au lieu de spécifier directement le nom du keystore ou du truststore, comme indiqué 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 sa valeur pour modifier le keystore utilisé par l'hôte virtuel, généralement parce que le certificat du keystore actuel expire dans un avenir proche. La modification de la valeur de référence ne nécessite pas de 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 dans un keystore, assurez-vous que le nom d'alias du certificat est identique à celui de l'ancien keystore.

Restrictions d'utilisation des références aux keystores et aux Trustedstores

Vous devez prendre en compte la restriction suivante lorsque vous utilisez des références à des keystores et à des Truststores:

  • Vous ne pouvez utiliser des références de keystore et de Trustedstore dans des hôtes virtuels que si vous êtes compatible avec l'extension SNI et que vous arrêtez le protocole SSL sur les routeurs Apigee.
  • Si vous disposez d'un équilibreur de charge devant les routeurs Apigee et que vous interrompez le protocole TLS au niveau de l'équilibreur de charge, vous ne pouvez pas utiliser de références à un keystore et à un magasin de confiance 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 classique de Edge: sélectionnez APIs > Configuration de l'environnement.
    2. Si vous utilisez la nouvelle interface utilisateur Edge: sélectionnez Admin > 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 paramètres suivants :
    1. Le nom de la référence.
    2. Entité à laquelle se réfère la référence, c'est-à-dire le nom du keystore ou du magasin de clés de confiance.
    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 classique de Edge: sélectionnez APIs > Configuration de l'environnement.
    2. Si vous utilisez la nouvelle interface utilisateur Edge: sélectionnez Admin > Environnements.
  4. Sélectionnez l'environnement (généralement prod ou test).
  5. Sélectionnez l'onglet Références.
  6. Dans l'onglet Reference (Référence), sélectionnez le bouton Edit (Modifier) de 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 celui de l'ancien keystore.
  8. Sélectionnez Enregistrer.

Pour modifier la référence afin qu'elle pointe vers un autre keystore, en vous assurant 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