Travailler avec des références

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d'Apigee Edge.

Lorsque vous configurez un TargetServer 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 contenant le nom du keystore ou du truststore, plutôt que de spécifier directement le nom du keystore ou du truststore.

Une référence peut être représentée par un objet XML comme celui présenté ci-dessous :

  <reference>
    <name>ReferenceName</name>
    <description>ReferencDescription</description>
    <resourceType>ReferredResourceType<resourceType>
    <refers>ReferredResource<refers>
  </reference>

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 le serveur cible, généralement en cas d'expiration prochaine du certificat du keystore actuel.

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 liées à l'utilisation des références aux keystores et au truststore

Si vous disposez d'un équilibreur de charge et que vous arrêtez le protocole TLS sur l'équilibreur de charge, vous ne pouvez pas utiliser les références au keystore et truststore dans le serveur cible.

Créer une référence

Vous pouvez utiliser l'interface utilisateur ou l'API Apigee pour créer une référence.

Créer dans l'interface utilisateur Apigee

Pour créer une référence à l'aide de l'interface utilisateur, procédez comme suit :

  1. Connectez-vous à l'interface utilisateur Apigee.
  2. Sélectionnez le nom de votre organisation.
  3. Sélectionnez Admin > Environnements > Références.
  4. Sélectionnez l'environnement (généralement prod ou test).
  5. Sélectionnez le bouton + Référence.
  6. Dans la fenêtre pop-up Ajouter une référence :
    1. Ajoutez le nom de la référence.
    2. Sélectionnez la référence, le keystore ou le truststore désigné.
    3. Sélectionnez Ajouter une référence.

Créer dans l'API Apigee

Pour créer une référence à l'aide de l'appel d'API Create Reference, procédez comme suit :

      curl -H "Authorization: Bearer $TOKEN" \
        -X POST \
        -d '{
            "reference": {
              "name": MyReferenceName",
              "resourceType": "KeyStore",
              "refers": "KeyStoreID"
            }
           }' \
        https://apigee.googleapis.com/v1/{parent=organizations/*/environments/*}/references

Modifier une référence

Vous pouvez utiliser l'interface utilisateur ou l'API Apigee pour modifier une référence existante.

Modifier dans l'interface utilisateur Apigee

Pour modifier la valeur d'une référence dans l'interface utilisateur, procédez comme suit :

  1. Connectez-vous à l'interface utilisateur Apigee.
  2. Sélectionnez le nom de votre organisation.
  3. Sélectionnez Admin > Environnements > Références.
  4. Sélectionnez l'environnement (généralement prod ou test).
  5. Sélectionnez le bouton Modifier pour la référence.
  6. 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.
  7. Enregistrez vos modifications.

Modifier dans l'API Apigee

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 -H "Authorization: Bearer $TOKEN" \
          -X PUT \
          -d '{
              "reference": {
              "name": MyReferenceName",
              "resourceType": "KeyStore",
              "refers": "KeyStoreID"
          }
         }' \
        https://apigee.googleapis.com/v1/{name=organizations/*/environments/*/references/*}