API de App Identity para servicios agrupados en paquetes heredados

ID de región

REGION_ID es un código abreviado que Google asigna en función de la región que eliges cuando creas la app. El código no corresponde a un país ni a una provincia, aunque algunos ID de región puedan parecer similares a los códigos de país y provincia que se suelen usar. En el caso de las apps creadas después de febrero de 2020, REGION_ID.r se incluye en las URL de App Engine. En el caso de las apps existentes creadas antes de esta fecha, el ID de región es opcional en la URL.

Obtén más información acerca de los ID de región.

Aceptar

La API de App Identity permite que una aplicación descubra su ID de aplicación (también llamado ID del proyecto). A través del ID, una aplicación de App Engine puede confirmar su identidad a otras aplicaciones de App Engine, a las API de Google, y a las aplicaciones y servicios de terceros. El ID de aplicación también se puede usar para generar una URL o dirección de correo electrónico, o tomar una decisión en tiempo de ejecución.

Esta API es compatible con entornos de ejecución de primera generación y se puede usar en actualizaciones a los entornos de ejecución de segunda generación correspondientes. Si quieres actualizar al entorno de ejecución de PHP 7/8 de App Engine, consulta la guía de migración para obtener información sobre tus opciones de migración para servicios empaquetados heredados.

Obtén el ID del proyecto

El ID del proyecto se puede encontrar mediante el método AppIdentityService::getApplicationId().

Obtén el nombre de host de la aplicación

De forma predeterminada, las apps de App Engine se entregan desde las URL en el formato https://PROJECT_ID.REGION_ID.r.appspot.com, en el que el ID del proyecto forma parte del nombre de host. Si una app se entrega desde un dominio personalizado, tal vez sea necesario recuperar todo el componente del nombre de host. Puedes hacerlo mediante el método AppIdentityService::getDefaultVersionHostname().

Confirma la identidad de otras apps de App Engine

Si deseas determinar la identidad de la app de App Engine que realiza una solicitud a tu app de App Engine, puedes usar el encabezado de solicitud X-Appengine-Inbound-Appid. El servicio URLFetch agrega este encabezado a la solicitud y el usuario no puede modificarlo, por lo que indica de manera segura el ID del proyecto de la aplicación solicitante, si está presente.

Requisitos:

• Solo las llamadas realizadas al dominio appspot.com de la app tendrán el encabezado X-Appengine-Inbound-Appid. Las llamadas a dominios personalizados no contienen el encabezado.
• Tus solicitudes deben configurarse para no seguir redireccionamientos.

En el controlador de la aplicación, puedes verificar el ID entrante si lees el encabezado X-Appengine-Inbound-Appid y lo comparas con una lista de ID permitidos para realizar solicitudes.

Confirma la identidad a las API de Google

Las API de Google usan el protocolo OAuth 2.0 para la autenticación y la autorización. La API de App Identity puede crear tokens de OAuth que pueden usarse para confirmar que el origen de una solicitud es la aplicación en sí. El método getAccessToken() muestra un token de acceso para un permiso o una lista de permisos. Este token se puede configurar en los encabezados HTTP de una llamada para identificar la aplicación que realiza la llamada.

En el ejemplo siguiente, se muestra cómo usar la API de App Identity para recuperar los contactos del Calendario de Google con OAuth.

Nota: Las bibliotecas cliente de la API de Google también pueden hacer gran parte de este trabajo de forma automática.

// Retrieves Google Calendar contacts using OAuth

use google\appengine\api\app_identity\AppIdentityService;

function setAuthHeader() {
  $access_token = AppIdentityService::getAccessToken('https://www.google.com/m8/feeds');
  return [sprintf('Authorization: OAuth %s', $access_token['access_token'])];
}

$get_contacts_url = 'https://www.google.com/m8/feeds/contacts/default/full';
$headers = setAuthHeader();
$opts = [
  'http' => [
    'header' => implode("\r\n", $headers),
  ],
];

$context = stream_context_create($opts);

$response = file_get_contents($get_contacts_url, false, $context);

$xml = simplexml_load_string($response);

$email = $xml->author->email;
$service_account = AppIdentityService::getServiceAccountName();

if (strcmp($email, $service_account) != 0) {
  die(sprintf('%s does not match the service account name %s.',
              $email,
              $service_account));
}

Ten en cuenta que el nombre de la cuenta de servicio representa la identidad de la aplicación, el cual suele ser [e-mail]. Puedes obtener el valor exacto mediante el método getServiceAccountName(). Para los servicios que ofrecen LCA, puedes otorgar acceso a la aplicación si se lo otorgas a esta cuenta.

Confirma la identidad a servicios de terceros

El token que genera getAccessToken() solo funciona en los servicios de Google. Sin embargo, puedes usar la tecnología de firma subyacente para confirmar la identidad de tu aplicación a otros servicios. El método signForApp() firmará bytes mediante una clave privada única para la aplicación, y el método getPublicCertificates() mostrará los certificados que se pueden usar a fin de validar la firma.

Nota: Los certificados se pueden rotar cada tanto, y el método puede mostrar varios certificados. Solo se muestran los certificados que son válidos en ese momento; si almacenas mensajes firmados, necesitarás una administración de claves adicional para verificar las firmas más adelante.

Cómo obtener el nombre predeterminado del bucket de Cloud Storage

Cada aplicación puede tener un bucket de Cloud Storage predeterminado, que incluye 5 GB de almacenamiento gratuito y una cuota gratuita para operaciones de E/S.

Para obtener el nombre del depósito predeterminado, llama a CloudStorageTools::getDefaultGoogleStorageBucketName. También puedes usar el valor #default# como nombre del bucket, en el que #default# se reemplazará de forma automática en el entorno de ejecución por el nombre del bucket predeterminado de la aplicación.