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, qui évite de spécifier directement le nom du keystore/truststore.

Une référence peut être représentée par un objet XML comme celui exposé 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 à 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 au 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.

Interface utilisateur d'Apigee

Pour créer une référence à l'aide de la console Google Cloud  :

  1. Dans la console Google Cloud , accédez à la page Gestion > Environnements.

    Accéder à la page Environnements

  2. Sélectionnez l'environnement dans lequel vous souhaitez créer la référence.

  3. Cliquez sur l'onglet Références.

  4. Cliquez sur Créer une référence.

  5. Dans le volet Créer une référence, saisissez les informations suivantes :
    • Nom : nom de la référence.
    • Keystore : keystore vers lequel pointe la référence.

  6. Cliquez sur Créer.

API

Pour créer une référence à l'aide de l'appel d'API Create Reference :

      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.

Interface utilisateur d'Apigee

Pour modifier une référence à l'aide de la console Google Cloud  :

  1. Dans la console Google Cloud , accédez à la page Gestion > Environnements.

    Accéder à la page Environnements

  2. Sélectionnez l'environnement dans lequel vous souhaitez modifier la référence.

  3. Cliquez sur l'onglet Références.

  4. Dans la liste affichée, sélectionnez la référence que vous souhaitez modifier.

  5. Cliquez sur Actions > Modifier.

  6. Dans le volet Modifier la référence, mettez à jour la référence pour spécifier le nouveau keystore.

  7. Cliquez sur Mettre à jour.

API

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, utilisez l'API Update Reference :

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