Como trabalhar com referências

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X. informações

Ao configurar um host virtual para oferecer suporte a TLS, você especifica um keystore ou um truststore usando como 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, conforme 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 dela para alterar o keystore usado pelo host virtual, geralmente porque o certificado no keystore atual é expira em breve. 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 no uso de referências a keystores e truststore

Você deve levar em consideração a seguinte restrição ao usar referências a keystores e truststores:

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

Como criar uma referência

Para criar uma referência na interface do usuário do Edge:

  1. Faça login na IU de gerenciamento de borda em https://enterprise.apigee.com.
  2. No menu da interface de gerenciamento de borda, selecione o nome da sua organização.
  3. Dependendo da 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 New Edge UI, selecione Admin > 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:
    1. Nome da referência.
    2. A entidade referida pela referência, ou seja, o nome do keystore ou do truststore.
    3. Selecione Salvar.

Como alternativa, use o botão Criar Referência 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.

Como modificar uma referência

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

  1. Faça login na IU de gerenciamento de borda em https://enterprise.apigee.com.
  2. No menu da interface de gerenciamento de borda, selecione o nome da sua organização.
  3. Dependendo da 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 New Edge UI, selecione Admin > 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 para o de referência.
  7. Atualize a referência para especificar o novo keystore ou truststore. Atenção: Verifique se o alias no novo keystore tem o mesmo nome que o alias no antigo um repositório de chaves de acesso.
  8. Selecione Salvar.

Para alterar a referência para apontar para um keystore diferente, certifique-se de que o alias no novo o keystore tiver o mesmo nome que o alias no keystore antigo, use o método Update Referência:

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