Esta página se ha traducido con Cloud Translation API.
Switch to English

Usa Firebase para autenticar usuarios

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

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. El proxy de servicio extensible (ESP) valida el token en nombre de tu API, por lo que no es necesario agregar ningún código a la API para procesar la autenticación. Sin embargo, debes configurar tu documento de OpenAPI para que sea compatible con los métodos de autenticación que elegiste.

El ESP valida un JWT de forma eficaz mediante las claves públicas de la entidad emisora de JWT. El ESP almacena en caché las claves públicas durante cinco minutos. Además, el ESP almacena en caché los JWT validados durante cinco minutos o hasta que venzan los JWT, lo que ocurra primero.

Antes de comenzar

  • Agrega el código de autenticación a tu aplicación cliente, según la documentación de Firebase Authentication. Firebase admite la autenticación mediante contraseñas, números de teléfono y proveedores de identidad federada populares, como Google, Facebook y Twitter.

  • 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 tu documento de OpenAPI

Debes tener un objeto de requisitos de seguridad y un objeto de definiciones de seguridad en tu documento de OpenAPI para que el ESP valide las reclamaciones en el JWT firmado.

Para que admita la autenticación de Firebase:

  1. Agrega lo siguiente a la definición de seguridad del documento de tu OpenAPI:

      securityDefinitions:
        firebase:
          authorizationUrl: ""
          flow: "implicit"
          type: "oauth2"
          # Replace YOUR-PROJECT-ID with your project ID
          x-google-issuer: "https://securetoken.google.com/YOUR-PROJECT-ID"
          x-google-jwks_uri: "https://www.googleapis.com/service_accounts/v1/metadata/x509/securetoken@system.gserviceaccount.com"
          x-google-audiences: "YOUR-PROJECT-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:
        - firebase: []
    

Puedes crear varias definiciones de seguridad en el documento de OpenAPI, 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.

También puedes personalizar las ubicaciones de JWT si agregas x-google-extensions. Para obtener más información, consulta las extensiones de openAPI.

Cómo hacer una llamada autenticada a una API de Endpoints

Cuando envías una solicitud con un token de autenticación, te recomendamos que coloques el token en el encabezado Authorization:Bearer por motivos de seguridad. Por ejemplo:

curl -H "Authorization: Bearer ${TOKEN}" "${ENDPOINTS_HOST}/echo"

Aquí, TOKEN y ENDPOINTS_HOST son entornos variables que contienen el token de autenticación y el nombre de host de tu API de forma respectiva. Consulta Realiza una solicitud autenticada a una API de Endpoints si deseas obtener un código de muestra que envía una solicitud mediante 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 "${ENDPOINTS_HOST}/echo?access_token=${TOKEN}"

Recibe resultados autenticados en tu API

Por lo general, el ESP 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 especificación de OpenAPI o BackendRule en la configuración del servicio de gRPC.

El ESP enviará el resultado de la autenticación en X-Endpoint-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 el objeto JSON siguiente:

{
  "id": "from-sub",
  "issuer": "from-iss",
  "email": "from-email",
  "audiences": ["from-aud"],
  "claims": {
     original-jwt-payload
   }
}

Si usas el ESPv2, el formato del valor en el encabezado es diferente. Consulta Migra al proxy de servicio extensible Beta V2 para obtener más información sobre el nuevo formato.

¿Qué sigue?