Autenticación entre servicios
Además de autenticar las solicitudes de los usuarios finales, te recomendamos que autentiques los servicios (usuarios no humanos) que realizan solicitudes a tu API. En esta página, se explica cómo usar las cuentas de servicio para proporcionar autenticación a personas o servicios.
Descripción general
Para identificar un servicio que envía solicitudes a tu API, usas una cuenta de servicio. El servicio de llamadas usa la clave privada de la cuenta de servicio para firmar un token web JSON (JWT) seguro y enviarlo en la solicitud a tu API.
Para implementar la autenticación de cuentas de servicio en tu API y en el servicio de llamadas, completa los pasos siguientes:
- Crea una cuenta de servicio y una clave para que use el servicio de llamadas.
- Agrega compatibilidad con la autenticación en la configuración de la API para tu servicio de API Gateway.
Agrega código al servicio de llamadas que realiza las tareas siguientes:
- Crea un JWT y fírmalo con la clave privada de la cuenta de servicio.
- Envía el JWT firmado en una solicitud a la API.
API Gateway valida que las reclamaciones en el JWT coincidan con la configuración en tu configuración de la API antes de reenviar la solicitud a tu API. API Gateway no verifica los permisos de Cloud Identity que hayas otorgado en la cuenta de servicio.
Requisitos previos
En esta página, se supone que ya:
Crea una cuenta de servicio con una clave
Necesitas una cuenta de servicio con un archivo de claves privadas que el servicio de llamadas usa para firmar el JWT. Si tienes más de un servicio que envía solicitudes a tu API, puedes crear una cuenta que represente todos los servicios de llamadas. Si necesitas diferenciar entre los servicios (por ejemplo, podrían tener permisos diferentes), puedes crear una cuenta de servicio y una clave para cada servicio de llamadas.
En esta sección, se muestra cómo usar la consola de Google Cloud y la herramienta de línea de comandos de gcloud
para crear la cuenta de servicio y el archivo de claves privadas, y asignar a la cuenta de servicio el rol de Creador de tokens de la cuenta de servicio. Si deseas obtener más información sobre el uso de una API a fin de realizar esta tarea, consulta la sección para crear y administrar cuentas de servicio.
Para crear una cuenta de servicio con una clave, completa los pasos siguientes:
Consola de Google Cloud
Crear una cuenta de servicio:
En la consola de Google Cloud, ve a Crear cuenta de servicio.
Selecciona un proyecto
Ingresa un nombre en el campo Nombre de cuenta de servicio. La consola de Google Cloud completa el campo ID de cuenta de servicio según este nombre.
Opcional: en el campo Descripción de la cuenta de servicio, ingresa una descripción.
Haga clic en Crear.
Haz clic en el campo Seleccionar una función.
En Todas las funciones, selecciona Cuentas de servicio > Creador de tokens de cuenta de servicio.
Haga clic en Continuar.
Haz clic en Listo para terminar de crear la cuenta de servicio.
No cierres la ventana del navegador. La usarás en el siguiente procedimiento.
Para crear una clave de cuenta de servicio, haz lo siguiente:
- En la consola de Google Cloud, haz clic en la dirección de correo electrónico de la cuenta de servicio que creaste.
- Haga clic en Claves.
- Haz clic en Agregar clave -> Crear nueva clave.
- Haz clic en Crear. Se descargará un archivo de claves JSON en tu computadora.
- Haga clic en Cerrar.
gcloud
Puedes ejecutar los siguientes comandos con Google Cloud CLI en tu máquina virtual o en Cloud Shell.
Configura la cuenta predeterminada para
gcloud
. Si tienes más de una cuenta, asegúrate de elegir la que está en el proyecto de Google Cloud que deseas usar.gcloud auth login
Muestra los ID de tus proyectos de Google Cloud:
gcloud projects list
Configura el proyecto predeterminado. Reemplaza
PROJECT_ID
con el ID del proyecto de Google Cloud que deseas usar.gcloud config set project PROJECT_ID
Crea una cuenta de servicio. Reemplaza
SA_NAME
ySA_DISPLAY_NAME
por el nombre y el nombre comercial que deseas usar.gcloud iam service-accounts create SA_NAME \ --display-name "SA_DISPLAY_NAME"
Muestra la dirección de correo electrónico de la cuenta de servicio que acabas de crear.
gcloud iam service-accounts list
Agrega la función Creador de tokens de cuenta de servicio. Reemplaza
SA_EMAIL_ADDRESS
por la dirección de correo electrónico de la cuenta de servicio.gcloud projects add-iam-policy-binding PROJECT_ID \ --member serviceAccount:SA_EMAIL_ADDRESS \ --role roles/iam.serviceAccountTokenCreator
Crea un archivo de claves de cuenta de servicio en el directorio de trabajo actual. Reemplaza
FILE_NAME
por el nombre que deseas usar para el archivo de claves. De forma predeterminada, el comando degcloud
crea un archivo JSON.gcloud iam service-accounts keys create FILE_NAME.json \ --iam-account SA_EMAIL_ADDRESS
Consulta la referencia de gcloud
para obtener más información sobre los comandos anteriores.
Si deseas obtener información sobre cómo proteger la clave privada, consulta Recomendaciones para administrar las credenciales.
Configura tu API para que sea compatible con la autenticación
Cuando creas una configuración de API para tu puerta de enlace, debes especificar una cuenta de servicio que la puerta de enlace usa para interactuar con otros servicios. Para habilitar la autenticación de cuentas de servicio para los servicios que llaman a tu puerta de enlace, modifica el objeto de requisitos de seguridad y el objeto de definiciones de seguridad en la configuración de tu API. Seguir los pasos que se indican a continuación permitirá que API Gateway valide las reclamaciones en el JWT firmado que usan los servicios de llamada.
Agrega la cuenta de servicio como una entidad emisora en la configuración de tu API.
securityDefinitions: DEFINITION_NAME: authorizationUrl: "" flow: "implicit" type: "oauth2" x-google-issuer: "SA_EMAIL_ADDRESS" x-google-jwks_uri: "https://www.googleapis.com/robot/v1/metadata/x509/SA_EMAIL_ADDRESS"
- Reemplaza
DEFINITION_NAME
por una string que identifique esta definición de seguridad. Es posible que desees reemplazarlo por el nombre de la cuenta de servicio o un nombre que identifique el servicio de llamadas. - Reemplaza
SA_EMAIL_ADDRESS
por la dirección de correo electrónico de la cuenta de servicio. - Puedes establecer varias definiciones de seguridad en tu configuración de API, pero cada definición debe tener un
x-google-issuer
diferente. Si creaste cuentas de servicio separadas para cada servicio de llamadas, puedes crear una definición de seguridad por cada cuenta de servicio, por ejemplo:
securityDefinitions: service-1: authorizationUrl: "" flow: "implicit" type: "oauth2" x-google-issuer: "service-1@example-project-12345.iam.gserviceaccount.com" x-google-jwks_uri: "https://www.googleapis.com/robot/v1/metadata/x509/service-1@example-project-12345.iam.gserviceaccount.com" service-2: authorizationUrl: "" flow: "implicit" type: "oauth2" x-google-issuer: "service-2@example-project-12345.iam.gserviceaccount.com" x-google-jwks_uri: "https://www.googleapis.com/robot/v1/metadata/x509/service-2@example-project-12345.iam.gserviceaccount.com"
- Reemplaza
O bien agrega
x-google-audiences
a la secciónsecurityDefinitions
. Si no agregasx-google-audiences
, API Gateway requiere que la reclamación"aud"
(público) en el JWT tenga el formatohttps://SERVICE_NAME
, en el que SERVICE_NAME es el nombre de tu servicio de API Gateway que configuraste en el campohost
de tu documento de OpenAPI.Agrega una sección
security
al nivel superior del archivo (sin sangría ni anidado) para aplicarla en toda la API, o al nivel de los métodos a fin de aplicarla a un método específico. Si usas las seccionessecurity
en los niveles de la API y de los métodos, la configuración del nivel de los métodos anula la configuración del nivel de la API.security: - DEFINITION_NAME: []
- Reemplaza
DEFINITION_NAME
por el nombre que usaste en la secciónsecurityDefinitions
. Si tienes más de una definición en la sección
securityDefinitions
, agrégalas en la secciónsecurity
, por ejemplo:security: - service-1: [] - service-2: []
- Reemplaza
Implementa la configuración de API actualizada.
Antes de que API Gateway reenvíe una solicitud a tu API, la puerta de enlace de API verifica lo siguiente:
- La firma del JWT mediante la clave pública, que se encuentra en el URI especificado en el campo
x-google-jwks_uri
en tu configuración de API. - Que la reclamación
"iss"
(entidad emisora) en el JWT coincida con el valor especificado en el campox-google-issuer
- Que la reclamación
"aud"
(público) en el JWT contenga el nombre de tu servicio de API Gateway o coincida con uno de los valores que especificaste en el campox-google-audiences
- Que el token no haya vencido mediante la reclamación
"exp"
(hora de vencimiento)
Para obtener más información sobre x-google-issuer
, x-google-jwks_uri
y x-google-audiences
, consulta Extensiones de OpenAPI.
Realiza una solicitud autenticada a una API de API Gateway
Para realizar una solicitud autenticada, el servicio de llamadas envía un JWT firmado por la cuenta de servicio que especificaste en la configuración de API. El servicio de llamadas debe hacer lo siguiente:
- Crear un JWT y firmarlo con la clave privada de la cuenta de servicio
- Enviar el JWT firmado en una solicitud a la API
En el siguiente código de muestra, se muestra este proceso para los lenguajes seleccionados. Si deseas realizar una solicitud autenticada en otros lenguajes, consulta jwt.io para obtener una lista de bibliotecas compatibles.
- En el servicio de llamadas, agrega la función que sigue y pásala a los parámetros siguientes:
Java saKeyfile
: La ruta de acceso completa al archivo de claves privadas de la cuenta de servicio-
saEmail
: La dirección de correo electrónico de la cuenta de servicio -
audience
: Si agregaste el campox-google-audiences
a la configuración de tu API, estableceaudience
en uno de los valores que que especificaste parax-google-audiences
. De lo contrario, configuraaudience
comohttps://SERVICE_NAME
, en el queSERVICE_NAME
es el nombre de tu servicio de API Gateway. expiryLength
: El tiempo de vencimiento del JWT, en segundos
Python -
sa_keyfile
: La ruta de acceso completa al archivo de claves privadas de la cuenta de servicio -
sa_email
: La dirección de correo electrónico de la cuenta de servicio -
audience
: Si agregaste el campox-google-audiences
a la configuración de tu API, estableceaudience
en uno de los valores que que especificaste parax-google-audiences
. De lo contrario, configuraaudience
comohttps://SERVICE_NAME
, en el queSERVICE_NAME
es el nombre de tu servicio de API Gateway. expiry_length
: El tiempo de vencimiento del JWT, en segundos
Go saKeyfile
: La ruta de acceso completa al archivo de claves privadas de la cuenta de servicio-
saEmail
: La dirección de correo electrónico de la cuenta de servicio -
audience
: Si agregaste el campox-google-audiences
a tu configuración de API, configuraaudience
como uno de los valores que especificaste parax-google-audiences
. De lo contrario, configuraaudience
comohttps://SERVICE_NAME
, en el queSERVICE_NAME
es el nombre de tu servicio de API Gateway. expiryLength
: El tiempo de vencimiento del JWT, en segundos
La función crea un JWT, lo firma con el archivo de claves privadas y muestra el JWT firmado.
Java Python Go - En el servicio de llamadas, agrega la función siguiente para enviar el JWT firmado en el encabezado
Authorization: Bearer
de la solicitud a la API:Java Python Go
Cuando envíes una solicitud con un JWT, por motivos de seguridad, te recomendamos que coloques el token de autenticación en el encabezado Authorization: Bearer
. Por ejemplo:
curl --request POST \ --header "Authorization: Bearer ${TOKEN}" \ "${GATEWAY_URL}/echo"
En el ejemplo anterior, 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.
Recibe resultados autenticados en tu API
Por lo general, API Gateway reenvía todos los encabezados que recibe. Sin embargo, anula el
encabezado Authorization
original cuando la dirección de backend se especifica mediante
x-google-backend
en la configuración de la API.
API Gateway enviará el resultado de la autenticación en el 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.