Secretos en la API de Reactor

En la API de Reactor, un secreto es un recurso que representa una credencial de autenticación. Los secretos se utilizan en el reenvío de eventos para autenticarse en otro sistema y asegurar el intercambio de datos. Por lo tanto, los secretos solo se pueden crear en propiedades de reenvío de eventos (propiedades cuyo atributo platform está establecido en edge).

Actualmente hay tres tipos de secretos admitidos indicados en el atributo type_of:

Esta guía proporciona información general de alto nivel sobre cómo configurar secretos para usarlos en el reenvío de eventos. Para obtener instrucciones detalladas sobre cómo administrar secretos en la API de Reactor, incluido el ejemplo JSON de la estructura de un secreto, consulte la guía de extremo de secretos.

Credenciales

Cada secreto contiene un atributo credentials que contiene sus valores de credenciales respectivos. Al crear un secreto en la API, cada tipo de secreto tiene diferentes atributos requeridos, como se muestra en las secciones siguientes:

token token

Los secretos con un valor type_of de token solo requieren un único atributo en credentials:

El token se almacena como un valor estático y, por lo tanto, las propiedades expires_at y refresh_at del secreto se establecen en null cuando se crea el secreto.

simple-http simple-http

Los secretos con un valor type_of de simple-http requieren los siguientes atributos en credentials:

Cuando se crea el secreto, los dos atributos se intercambian con una codificación BASE64 de username:password. Después del intercambio, las propiedades expires_at y refresh_at del secreto se establecen en null.

oauth2-client_credentials oauth2-client_credentials

Los secretos con un valor type_of de oauth2-client_credentials requieren los siguientes atributos en credentials:

Cuando se crea o actualiza un secreto oauth2-client_credentials, client_id y client_secret (y posiblemente options) se intercambian en una solicitud de POST a token_url, según el flujo de credenciales de cliente del protocolo de OAuth.

Si el servicio de autorización responde con 200 OK y un cuerpo de respuesta JSON, se analiza el cuerpo y se inserta access_token en el entorno de Edge y se utiliza expires_in para calcular los atributos expires_at y refresh_at del secreto. Si no hay ninguna asociación de entorno en el secreto, access_token se descarta.

Un intercambio de credenciales se considera exitoso bajo las siguientes condiciones:

Si el intercambio se realiza correctamente, el atributo de estado del secreto se establece en succeeded y los valores de expires_at y refresh_at se establecen:

Si el intercambio falla por algún motivo, el atributo status_details del objeto meta se actualiza con información relevante.

Actualizando un secreto oauth2-client_credentials

Si se ha asignado un secreto oauth2-client_credentials a un entorno y su estado es succeeded (las credenciales se intercambiaron correctamente), se realiza un nuevo intercambio automáticamente en refresh_at.

Si el intercambio se realiza correctamente, el atributo refresh_status del objeto meta se establece en succeeded, mientras que expires_at, refresh_at y activated_at se actualizan en consecuencia.

Si el intercambio falla, la operación se intenta tres veces más, con el último intento no más de dos horas antes de que caduque el token de acceso. Si todos los intentos fallan, el atributo refresh_status_details del objeto meta se actualiza con los detalles relevantes.

oauth2-google oauth2-google

Los secretos con un valor type_of de oauth2-google requieren el siguiente atributo en credentials:

Después de crear el secreto oauth2-google, la respuesta incluye una propiedad meta.authorization_url. Debe copiar y pegar esta dirección URL en un explorador para completar el flujo de autenticación de Google.

Volver a autorizar un secreto oauth2-google

La dirección URL de autorización para un secreto oauth2-google caduca una hora después de crearse el secreto (tal como indica meta.authorization_url_expires_at). Después de este tiempo, el secreto debe volver a autorizarse para renovar el proceso de autenticación.

Consulte la guía de extremo de secretos para obtener detalles sobre cómo volver a autorizar un secreto oauth2-google realizando una solicitud del PATCH a la API de Reactor.

Relación del entorno

Cuando cree un secreto, debe especificar el entorno en el que existirá. Los secretos se implementan inmediatamente en el entorno en el que se crean.

Un secreto solo se puede asociar a un entorno. Una vez establecida la relación entre un secreto y un entorno, el secreto no se puede borrar del entorno y no se puede asociar con un entorno diferente.

Después de intercambiar correctamente las credenciales de un secreto, para que un secreto se asocie a un entorno, el artefacto de intercambio (la cadena de token para token, la cadena codificada en Base64 para simple-http o el token de acceso para oauth2-client_credentials) se guarda de forma segura en el entorno.

Una vez guardado correctamente el artefacto de intercambio en el entorno, el atributo activated_at del secreto se establece en la hora UTC actual y ahora se puede hacer referencia a él mediante un elemento de datos. Consulte la sección siguiente para obtener más información sobre cómo hacer referencia a secretos.

Secretos de referencia referencing-secrets

Para hacer referencia a un secreto, debe crear un elemento de datos de tipo "Secreto" (proporcionado por la extensión Core) en una propiedad de reenvío de eventos. Al configurar este elemento de datos, se le pedirá que indique qué secreto utilizar para cada entorno. A continuación, puede crear reglas que hagan referencia a un elemento de datos secreto, como dentro del encabezado de una llamada HTTP.

Durante el tiempo de ejecución, el elemento de datos secreto se reemplaza por el artefacto de intercambio secreto correspondiente guardado en el entorno.

Pasos siguientes

Esta guía abarcaba los aspectos básicos del trabajo con secretos en la API de Reactor. Para obtener más información sobre cómo administrar secretos mediante llamadas API, consulte la guía de extremo de secretos.