Trabajar con referencias

Estás viendo la documentación de Apigee Edge.
Ve a la Documentación de Apigee X. información

Al configurar un host virtual para que admita TLS, debes especificar un almacén de claves o un almacén de confianza mediante una referencia. Una referencia es una variable que contiene el nombre del almacén de claves o del almacén de confianza. en lugar de especificar el nombre del almacén de claves o del almacén de confianza directamente, 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 su valor para que cambie el almacén de claves que usa el host virtual, por lo general, porque el certificado del almacén de claves actual se que vencerá próximamente. Cambiar el valor de la referencia no requiere que reinicies el router perimetral.

Solo puedes usar una referencia al almacén de claves y al almacén 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 en el uso de referencias a almacenes de claves y almacenes 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 de almacén de claves y almacén de confianza en hosts virtuales si admites SNI y finaliza SSL en los routers de Apigee.
  • Si tiene un balanceador de cargas frente a los routers de Apigee y finaliza TLS en balanceador de cargas, no podrás usar referencias de almacén de claves y almacén de confianza en hosts virtuales.

Cómo crear una referencia

Para crear una referencia en la IU de Edge, sigue estos pasos:

  1. Accede a la IU de la 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 la versión de la IU de Edge, haz lo siguiente:
    1. Si usas la IU clásica de Edge, selecciona APIs > Configuración del entorno.
    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. Nombre de la referencia.
    2. La entidad a la que se hace referencia en la referencia, es decir, el nombre del almacén de claves o del almacén de confianza.
    3. Selecciona Guardar.

Como alternativa, puedes usar el botón Crear Referencia para crear la referencia con el nombre 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.

Cómo modificar una referencia

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

  1. Accede a la IU de la 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 la versión de la IU de Edge, haz lo siguiente:
    1. Si usas la IU clásica de Edge, selecciona APIs > Configuración del entorno.
    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 del referencia.
  7. Actualiza la referencia para especificar el nuevo almacén de claves o almacén de confianza. Precaución: Asegúrate de que el alias del nuevo almacén de claves tenga el mismo nombre que el alias del antiguo. el almacén de claves.
  8. Selecciona Guardar.

Para cambiar la referencia para que apunte a un almacén de claves diferente, asegúrate de que el alias del nuevo tiene el mismo nombre que el alias del antiguo almacén de claves, usa el API de referencia de actualización:

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