Usar JWT para autenticar usuarios

En esta página, se describe cómo admitir la autenticación de usuarios en API Gateway.

Para autenticar un usuario, una aplicación cliente debe enviar un token web JSON (JWT) en el encabezado de autorización de la solicitud HTTP a tu API de backend. API Gateway valida el token en nombre de la API, por lo que no es necesario agregar ningún código a la API para procesar la autenticación. Sin embargo, debes ajustar la configuración de la API para que la puerta de enlace sea compatible con los métodos de autenticación que elegiste.

API Gateway valida un JWT de forma eficaz mediante el conjunto de claves web JSON (JWKS) del emisor del JWT. La ubicación de la JWKS se especifica en el campo x-google-jwks_uri de la configuración de la API de la puerta de enlace. API Gateway almacena en caché el JWKS durante cinco y lo actualiza cada cinco minutos.

Antes de comenzar

  • Agrega el código de autenticación a tu aplicación cliente, de acuerdo con la documentación del proveedor de autenticación.

  • Cuando tu aplicación cliente envía una solicitud HTTP, el encabezado de autorización en la solicitud debe contener las siguientes reclamaciones JWT:
    • iss (Emisor)
    • sub (Asunto)
    • aud (Público)
    • iat (Hora de emisión)
    • exp (Fecha y hora de vencimiento)

Configura API Gateway para admitir la autenticación de clientes

Debes tener un objeto de requisitos de seguridad y un objeto de definiciones de seguridad en la configuración de la API para API Gateway a fin de validar las reclamaciones en el JWT firmado.

Para admitir la autenticación de JWT, haz lo siguiente:

  1. Agrega lo siguiente a la definición de seguridad de la configuración de tu API, que sigue el esquema de seguridad de OpenAPI 2.0:

     securityDefinitions:
   your_custom_auth_id:
     authorizationUrl: ""
     flow: "implicit"
     type: "oauth2"
     # The value below should be unique
     x-google-issuer: "issuer of the token"
     x-google-jwks_uri: "url to the public key"
     # Optional. Replace YOUR-CLIENT-ID with your client ID
     x-google-audiences: "YOUR-CLIENT-ID"

  2. Agrega una sección de seguridad en el nivel de la API para aplicarlo en su totalidad o en el nivel de los métodos y así aplicarla a un método específico.

     security:
   - your_custom_auth_id: []

Puedes establecer varias definiciones de seguridad en la configuración de la API, pero cada definición debe tener una entidad emisora diferente. Si usas las secciones security a nivel de API y de los métodos, la configuración del nivel de los métodos anula la de la API.

El campo x-google-audiences no es obligatorio. API Gateway acepta todos los JWT con el nombre del servicio de backend en el formato https://SERVICE_NAME en la reclamación aud.

Para permitir que los IDs de cliente adicionales accedan al servicio de backend, puedes especificar los IDs de cliente permitidos en el campo x-google-audiences mediante valores separados por comas. Luego, API Gateway acepta los JWT con cualquiera de los ID de cliente especificados en la reclamación aud.

El campo x-google-jwks_uri es obligatorio. API Gateway admite dos formatos asimétricos de clave pública definidos por la extensión x-google-jwks_uri de OpenAPI:

  • Formato fijo de JWK. Por ejemplo: 
    x-google-jwks_uri: "https://YOUR_ACCOUNT_NAME.YOUR_AUTH_PROVIDER_URL/.well-known/jwks.json"
  • X509. Por ejemplo: 
    x-google-jwks_uri: "https://www.googleapis.com/service_accounts/v1/metadata/x509/securetoken@system.gserviceaccount.com"

Si usas un formato de claves simétrico, configura x-google-jwks_uri como el URI de un archivo que contiene la string de clave codificada en base64url.

Realiza una llamada autenticada a una API de API Gateway

Cuando envías una solicitud con un token de autenticación, se recomienda colocar el token en el encabezado Authorization:Bearer. Por ejemplo:

curl --request POST \
  --header "Authorization: Bearer ${TOKEN}" \
  "${GATEWAY_URL}/echo"

Aquí, GATEWAY_URL y TOKEN son variables de entorno que contienen la URL de la puerta de enlace implementada y el token de autenticación, respectivamente. Consulta Realiza una solicitud autenticada a una API de API Gateway para obtener un código de muestra que envía una solicitud con el encabezado Authorization:Bearer.

Si no puedes usar el encabezado cuando envías la solicitud, puedes colocar el token de autenticación en un parámetro de consulta llamado access_token. Por ejemplo:

curl "${GATEWAY_URL}/echo?access_token=${TOKEN}"

Recibe resultados autenticados en tu API

Por lo general, API Gateway reenvía todos los encabezados que recibe. Sin embargo, anula el encabezado original Authorization cuando la dirección de backend se especifique mediante x-google-backend en la configuración de la API.

API Gateway enviará el resultado de la autenticación en X-Apigateway-Api-Userinfo a la API de backend. Se recomienda usar este encabezado en lugar del encabezado Authorization original. Este encabezado está codificado en base64url y contiene la carga útil de JWT.

¿Qué sigue?