Trabalhar com referências

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

Quando configura um TargetServer para suportar o protocolo TLS, especifica um keystore ou um truststore através de uma referência. Uma referência é uma variável que contém o nome do keystore ou do truststore, em vez de especificar diretamente o nome do keystore ou do truststore.

Uma referência pode ser representada por um objeto XML como o abaixo:

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

A vantagem de usar uma referência é que pode alterar o valor da referência para alterar o arquivo de chaves usado pelo servidor de destino, normalmente porque o certificado no arquivo de chaves atual vai expirar num futuro próximo.

Só pode usar uma referência ao keystore e ao truststore. Não pode usar uma referência ao alias. Quando alterar a referência a um keystore, certifique-se de que o nome do alias do certificado é o mesmo que no keystore antigo.

Restrições relativas à utilização de referências a keystores e truststores

Se tiver um balanceador de carga e terminar o TLS no balanceador de carga, não pode usar referências de repositórios de chaves e repositórios fidedignos no servidor de destino.

Crie uma referência

Pode usar a interface do utilizador ou a API Apigee para criar uma nova referência.

Apigee na Google Cloud consola

Para criar uma referência através da consola Google Cloud :

  1. Na Google Cloud consola, aceda à página Gestão > Ambientes.

    Aceder a Ambientes

  2. Selecione o ambiente pretendido onde quer criar a referência.

  3. Clique no separador Referências.

  4. Clique em Create reference.

  5. No painel Criar referência, introduza os seguintes detalhes:
    • Nome: o nome da referência.
    • Keystore: o keystore para o qual a referência aponta.

  6. Clique em Criar.

IU clássica

Para criar uma referência através da IU:

  1. Inicie sessão na IU do Apigee.
  2. Selecione o nome da sua organização.
  3. Selecione Admin > Environments > References.
  4. Selecione o ambiente (normalmente, prod ou test).
  5. Selecione o botão + Referência.
  6. No pop-up Adicionar referência:
    1. Adicione o Nome da referência.
    2. Selecione a Referência, o keystore ou o truststore referidos.
    3. Selecione Adicionar referência.

API

Para criar uma referência através da chamada 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

Modifique uma referência

Pode usar a IU ou a API Apigee para modificar uma referência existente.

Apigee na Google Cloud consola

Para modificar uma referência através da Google Cloud consola:

  1. Na Google Cloud consola, aceda à página Gestão > Ambientes.

    Aceder a Ambientes

  2. Selecione o ambiente pretendido onde quer modificar a referência.

  3. Clique no separador Referências.

  4. Na lista apresentada, selecione a referência que quer modificar.

  5. Clique em Ações > Editar.

  6. No painel Editar referência, atualize a referência para especificar o novo keystore.

  7. Clique em Atualizar.

IU do Apigee Classic

Para modificar o valor de uma referência na IU:

  1. Inicie sessão na IU do Apigee.
  2. Selecione o nome da sua organização.
  3. Selecione Admin > Environments > References.
  4. Selecione o ambiente (normalmente, prod ou test).
  5. Selecione o botão Editar para a referência.
  6. Atualize a referência para especificar o novo keystore ou truststore. Aviso: Certifique-se de que o alias no novo keystore tem o mesmo nome que o alias no keystore antigo.
  7. Guarde as atualizações.

API

Para alterar a referência de modo a apontar para um keystore diferente, garantindo que o alias no novo keystore tem o mesmo nome que o alias no keystore antigo, use a 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/*}