Como trabalhar com referências

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Ao configurar um host virtual para aceitar TLS, você especifica um keystore ou 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 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 é poder alterar o valor da referência para mudar o keystore usado pelo host virtual, geralmente porque o certificado no keystore atual expira em breve. Não é necessário reiniciar o roteador de borda para alterar o valor da referência.

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 usar 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 a keystore e truststore em hosts virtuais se você aceitar 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, não será possível usar as referências do keystore e truststore em hosts virtuais.

Criar uma referência

Para criar uma referência na interface do Edge:

1. Faça login na interface de gerenciamento do Edge em https://enterprise.apigee.com.
2. No menu da interface de gerenciamento do Edge, selecione o nome da sua organização.
3. Dependendo da sua versão da interface do Edge:
   1. Se você estiver usando a interface 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 pop-up a seguir aparece:
   
7. Especifique o:
   1. Nome da referência.
   2. A entidade referenciada pela referência, ou seja, o nome do keystore ou do truststore.
   3. Selecione Salvar.

Como alternativa, use a chamada de API 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.

Modificar uma referência

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

1. Faça login na interface de gerenciamento do Edge em https://enterprise.apigee.com.
2. No menu da interface de gerenciamento do Edge, selecione o nome da sua organização.
3. Dependendo da sua versão da interface do Edge:
   1. Se você estiver usando a interface 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 para a 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 mudar a referência a fim de direcionar para um keystore diferente, garantindo que o alias no novo keystore tenha o mesmo nome que o do 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