Trabajar con referencias

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

Cuando configuras un host virtual para que admita TLS, debes especificar un almacén de claves o un almacén de certificados de confianza mediante una referencia. Una referencia es una variable que contiene el nombre del almacén de claves o del almacén de certificados de confianza, en lugar de especificar directamente el nombre del almacén de claves, como se muestra a continuación:

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

La ventaja de usar una referencia es que puedes cambiar el valor de la referencia para cambiar el almacén de claves que usa el host virtual, por lo general, porque el certificado del almacén de claves actual vencerá pronto. Si deseas cambiar el valor de la referencia, no es necesario que reinicies el router de Edge.

Solo puedes usar una referencia al almacén de claves y al almacén de certificados de confianza; no puedes usar una referencia al alias. Cuando cambies la referencia a un almacén de claves, asegúrate de que el nombre de alias del certificado sea el mismo que en el almacén de claves anterior.

Restricciones para el uso de referencias a almacenes de claves y al almacén de certificados de confianza

Debes tener en cuenta la siguiente restricción cuando uses referencias a almacenes de claves y almacenes de confianza:

  • Solo puedes usar referencias a almacenes de claves y almacenes de certificados de confianza en hosts virtuales si admites SNI y cierras SSL en los routers de Apigee.
  • Si tienes un balanceador de cargas delante de los routers de Apigee y cierras TLS en el balanceador de cargas, no puedes usar referencias a almacenes de claves y almacenes de certificados de confianza en hosts virtuales.

Crea una referencia

Para crear una referencia en la IU de Edge, haz lo siguiente:

  1. Accede a la IU de administración de Edge en https://enterprise.apigee.com.
  2. En el menú de la IU de administración de Edge, selecciona el nombre de tu organización.
  3. Según tu versión de la IU de Edge, haz lo siguiente:
    1. Si usas la IU clásica de Edge, selecciona APIs > Environment Configuration.
    2. Si usas la nueva IU de Edge, selecciona Administrador > Entornos.
  4. Selecciona el entorno (por lo general, prod o test).
  5. Elige la pestaña Referencias.
  6. Selecciona el botón + Referencia. Aparecerá la siguiente ventana emergente:
  7. Especifica lo siguiente:
    1. El nombre de la referencia
    2. La entidad a la que hace referencia la referencia, es decir, el nombre del almacén de claves o del almacén de confianza
    3. Selecciona Guardar.

Como alternativa, usa la llamada a la API de Create Reference para crear la referencia llamada 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

En la referencia, se especifica el nombre del almacén de claves y su tipo. Usa la misma llamada a la API para crear una referencia a un almacén de confianza.

Modifica una referencia

Para modificar el valor de una referencia en la IU de Edge, haz lo siguiente:

  1. Accede a la IU de administración de Edge en https://enterprise.apigee.com.
  2. En el menú de la IU de administración de Edge, selecciona el nombre de tu organización.
  3. Según tu versión de la IU de Edge, haz lo siguiente:
    1. Si usas la IU clásica de Edge, selecciona APIs > Environment Configuration.
    2. Si usas la nueva IU de Edge, selecciona Administrador > Entornos.
  4. Selecciona el entorno (por lo general, prod o test).
  5. Elige la pestaña Referencias.
  6. En la pestaña Referencia, selecciona el botón Editar de la referencia.
  7. Actualiza la referencia para especificar el nuevo almacén de claves o almacén de certificados de confianza. Precaución: Asegúrate de que el alias del almacén de claves nuevo tenga el mismo nombre que el alias del almacén de claves anterior.
  8. Selecciona Guardar.

Para cambiar la referencia a fin de que apunte a un almacén de claves diferente, para asegurarte de que el alias del almacén de claves nuevo tenga el mismo nombre que el alias del almacén de claves anterior, usa la API Actualiza la referencia:

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