Utilizzo dei riferimenti

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Quando configuri un TargetServer per supportare TLS, specifichi un keystore o un truststore utilizzando un riferimento. Un riferimento è una variabile che contiene il nome dell'archivio chiavi o dell'archivio attendibile, anziché specificare direttamente il nome dell'archivio chiavi o dell'archivio attendibile.

Un riferimento può essere rappresentato da un oggetto XML come quello riportato di seguito:

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

Il vantaggio di utilizzare un riferimento è che puoi modificarne il valore per cambiare il keystore utilizzato dal server di destinazione, di solito perché il certificato nel keystore corrente scadrà a breve.

Puoi utilizzare solo un riferimento al keystore e al truststore; non puoi utilizzare un riferimento all'alias. Quando modifichi il riferimento a un keystore, assicurati che il nome alias del certificato sia lo stesso del keystore precedente.

Limitazioni all'utilizzo di riferimenti a keystore e truststore

Se hai un bilanciatore del carico e termini TLS sul bilanciatore del carico, non puoi utilizzare i riferimenti al keystore e al truststore nel server di destinazione.

Creare un riferimento

Puoi utilizzare la UI o l'API Apigee per creare un nuovo riferimento.

Apigee nella console Google Cloud

Per creare un riferimento utilizzando la console Google Cloud :

  1. Nella console Google Cloud , vai alla pagina Gestione > Ambienti.

    Vai ad Ambienti

  2. Seleziona l'ambiente in cui vuoi creare il riferimento.

  3. Fai clic sulla scheda Riferimenti.

  4. Fai clic su Crea riferimento.

  5. Nel riquadro Crea riferimento, inserisci i seguenti dettagli:
    • Nome: il nome del riferimento.
    • Keystore: l'archivio chiavi a cui fa riferimento.

  6. Fai clic su Crea.

UI classica

Per creare un riferimento utilizzando la UI:

  1. Accedi alla UI Apigee.
  2. Seleziona il nome della tua organizzazione.
  3. Seleziona Amministrazione > Ambienti > Riferimenti.
  4. Seleziona l'ambiente (in genere prod o test).
  5. Seleziona il pulsante + Riferimento.
  6. Nel popup Aggiungi riferimento:
    1. Aggiungi il Nome del riferimento.
    2. Seleziona Riferimento, il keystore o il truststore a cui viene fatto riferimento.
    3. Seleziona Aggiungi riferimento.

API

Per creare un riferimento utilizzando la chiamata 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

Modificare un riferimento

Puoi utilizzare l'API o l'interfaccia utente di Apigee per modificare un riferimento esistente.

Apigee nella console Google Cloud

Per modificare un riferimento utilizzando la console Google Cloud :

  1. Nella console Google Cloud , vai alla pagina Gestione > Ambienti.

    Vai ad Ambienti

  2. Seleziona l'ambiente in cui vuoi modificare il riferimento.

  3. Fai clic sulla scheda Riferimenti.

  4. Nell'elenco visualizzato, seleziona il riferimento che vuoi modificare.

  5. Fai clic su Azioni > Modifica.

  6. Nel riquadro Modifica riferimento, aggiorna il riferimento per specificare il nuovo keystore.

  7. Fai clic su Aggiorna.

UI Apigee classica

Per modificare il valore di un riferimento nell'interfaccia utente:

  1. Accedi alla UI Apigee.
  2. Seleziona il nome della tua organizzazione.
  3. Seleziona Amministrazione > Ambienti > Riferimenti.
  4. Seleziona l'ambiente (in genere prod o test).
  5. Seleziona il pulsante Modifica per il riferimento.
  6. Aggiorna il riferimento per specificare il nuovo keystore o truststore. Attenzione: Assicurati che l'alias nel nuovo keystore abbia lo stesso nome dell'alias nel vecchio keystore.
  7. Salva gli aggiornamenti.

API

Per modificare il riferimento in modo che rimandi a un keystore diverso, assicurandoti che l'alias nel nuovo keystore abbia lo stesso nome dell'alias nel vecchio keystore, utilizza 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/*}