Como trabalhar com referências

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
informações

Ao configurar um host virtual para oferecer suporte a TLS, especifique um keystore ou um truststore usando uma referência. Uma referência é uma variável que contém o nome do keystore ou do truststore, em vez de especificar o nome do keystore ou do truststore diretamente, como mostrado abaixo.

    <SSLInfo> 
        <Enabled>true</Enabled> 
        <ClientAuthEnabled>false</ClientAuthEnabled> 
        <KeyStore>ref://myTestKeystoreRef</KeyStore> 
        <KeyAlias>myKeyAlias</KeyAlias> 
    </SSLInfo>

A vantagem de usar uma referência é que você pode alterar o valor da referência para alterar o keystore usado pelo host virtual, geralmente porque o certificado no keystore atual vai expirar em um futuro próximo. Alterar o valor da referência não exige que você reinicie o roteador de borda.

Só é possível usar uma referência ao keystore e truststore. Não é possível usar uma referência ao alias. Ao alterar a referência para um keystore, verifique se o nome do alias do certificado é o mesmo do keystore antigo.

Restrições ao uso de referências a keystores e truststore

Considere a seguinte restrição ao usar referências a keystores e truststores:

  • Só é possível usar referências de keystore e truststore em hosts virtuais se você oferecer suporte à SNI e encerrar o SSL nos roteadores da Apigee.
  • Se você tiver um balanceador de carga na frente dos roteadores da Apigee e encerrar o TLS no balanceador de carga, não será possível usar as referências de keystore e truststore em hosts virtuais.

Criar uma referência

Para criar uma referência na IU do Edge:

  1. Faça login na IU de gerenciamento do Edge em https://enterprise.apigee.com.
  2. No menu "IU de gerenciamento de borda", selecione o nome da sua organização.
  3. Dependendo da sua versão da interface do Edge:
    1. Se você estiver usando a IU clássica do Edge: selecione APIs > Configuração do ambiente.
    2. Se você estiver usando a Nova interface do Edge: selecione Administrador > Ambientes.
  4. Selecione o ambiente (normalmente prod ou test)
  5. Selecione a guia Referências.
  6. Selecione o botão + Referência. O seguinte pop-up vai aparecer:
  7. Especifique o seguinte:
    1. Nome da referência.
    2. A entidade mencionada pela referência, ou seja, o nome do keystore ou do truststore.
    3. Selecione Salvar.

Como alternativa, use a chamada de API Create Reference para criar a referência chamada 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

A referência especifica o nome e o tipo do keystore. Use a mesma chamada de API para criar uma referência a um truststore.

Modificar uma referência

Para modificar o valor de uma referência na interface do usuário do Edge:

  1. Faça login na IU de gerenciamento do Edge em https://enterprise.apigee.com.
  2. No menu "IU de gerenciamento de borda", selecione o nome da sua organização.
  3. Dependendo da sua versão da interface do Edge:
    1. Se você estiver usando a IU clássica do Edge: selecione APIs > Configuração do ambiente.
    2. Se você estiver usando a Nova interface do Edge: selecione Administrador > Ambientes.
  4. Selecione o ambiente (normalmente prod ou test)
  5. Selecione a guia Referências.
  6. Na guia Referência, selecione o botão Editar da referência.
  7. Atualize a referência para especificar o novo keystore ou truststore. Cuidado: verifique se o alias no novo keystore tem o mesmo nome que o alias no keystore antigo.
  8. Selecione Salvar.

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