Utiliser OAuth 2.0 pour l'authentification serveur à serveur

Pour en savoir plus, consultez la section Présentation de l'authentification dans la documentation Google Cloud Platform.

Le système OAuth 2.0 de Google est compatible avec les interactions entre serveurs, par exemple entre une application Web et un service Google. Pour ce scénario, vous avez besoin d'un compte de service, qui appartient à votre application et non à un utilisateur final individuel. Votre application appelle les API Google au nom du compte de service, de sorte que les utilisateurs ne sont pas directement impliqués. Ce scénario est parfois appelé "OAuth à deux acteurs" ou "2LO". (Le terme associé "OAuth à trois étapes" fait référence aux scénarios dans lesquels votre application appelle des API Google au nom des utilisateurs finaux et dans lesquels le consentement de l'utilisateur est parfois requis.)

En règle générale, une application utilise un compte de service lorsqu'elle utilise des API Google pour travailler avec ses propres données plutôt qu'avec celles d'un utilisateur. Par exemple, une application qui utilise Google Cloud Datastore pour la persistance des données utiliserait un compte de service pour authentifier ses appels à l'API Google Cloud Datastore.

Les administrateurs de domaine Google Workspace peuvent également accorder aux comptes de service une autorité au niveau du domaine pour accéder aux données utilisateur pour le compte des utilisateurs du domaine.

Ce document explique comment une application peut effectuer le flux OAuth 2.0 de serveur à serveur à l'aide d'une bibliothèque cliente d'API Google (recommandée) ou d'HTTP.

Avec certaines API Google, vous pouvez effectuer des appels d'API autorisés à l'aide d'un jeton JWT signé au lieu d'utiliser OAuth 2.0, ce qui peut vous faire économiser une requête réseau. Consultez la section Avenant: Autorisation du compte de service sans OAuth.

Présentation

Pour prendre en charge les interactions entre serveurs, créez d'abord un compte de service pour votre projet dans API Console. Si vous souhaitez accéder aux données utilisateur des utilisateurs de votre compte Google Workspace, déléguez l'accès au compte de service au niveau du domaine.

Ensuite, votre application se prépare à effectuer des appels d'API autorisés à l'aide des identifiants du compte de service pour demander un jeton d'accès au serveur d'authentification OAuth 2.0.

Enfin, votre application peut utiliser le jeton d'accès pour appeler les API Google.

Recommandation:Votre application peut effectuer ces tâches à l'aide de la bibliothèque cliente des API Google pour votre langue ou en interagissant directement avec le système OAuth 2.0 à l'aide de HTTP. Toutefois, les mécanismes d'interactions d'authentification de serveur à serveur exigent que les applications créent et signent de manière cryptographique des jetons Web JSON (JWT). Il est facile de commettre des erreurs graves qui peuvent avoir un impact grave sur la sécurité de votre application.

C'est pourquoi nous vous encourageons vivement à utiliser des bibliothèques telles que les bibliothèques clientes des API Google, qui extraient la cryptographie du code de votre application.

Créer un compte de service

Les identifiants d'un compte de service incluent une adresse e-mail générée unique et au moins une paire de clés publique/privée. Si la délégation au niveau du domaine est activée, un ID client fait également partie des identifiants du compte de service.

Si votre application s'exécute sur Google App Engine, un compte de service est configuré automatiquement lorsque vous créez votre projet.

Si votre application s'exécute sur Google Compute Engine, un compte de service est également configuré automatiquement lorsque vous créez votre projet. Toutefois, vous devez spécifier les niveaux d'accès dont votre application a besoin lorsque vous créez une instance Google Compute Engine. Pour en savoir plus, consultez la section Préparer une instance à utiliser des comptes de service.

Si votre application ne s'exécute pas sur Google App Engine ou Google Compute Engine, vous devez obtenir ces identifiants dans Google API Console. Pour générer des identifiants de compte de service ou afficher les identifiants publics que vous avez déjà générés, procédez comme suit:

首先，创建一个服务帐户：

1. 打开 Service accounts page。
2. If prompted, select a project, or create a new one.
3. 单击创建服务帐户。
4. 在Service account details下，键入服务帐户的名称、ID 和描述，然后点击Create and continue 。
5. 可选：在Grant this service account access to project下，选择要授予服务帐户的 IAM 角色。
6. 单击继续。
7. 可选：在Grant users access to this service account下，添加允许使用和管理服务帐户的用户或组。
8. 单击完成。

接下来，创建一个服务帐户密钥：

1. 单击您创建的服务帐户的电子邮件地址。
2. 单击密钥选项卡。
3. 在添加密钥下拉列表中，选择创建新密钥。
4. 单击创建。

您的新公钥/私钥对已生成并下载到您的机器上；它作为私钥的唯一副本。您有责任安全地存储它。如果您丢失了这个密钥对，您将需要生成一个新的。

Vous pouvez revenir à API Console à tout moment pour afficher l'adresse e-mail, les empreintes de clé publique et d'autres informations, ou pour générer des paires de clés publiques/privées supplémentaires. Pour en savoir plus sur les identifiants de compte de service dans API Console, consultez la section Comptes de service dans le fichier d'aide API Console.

Notez l'adresse e-mail du compte de service et stockez le fichier de clé privée du compte de service dans un emplacement accessible à votre application. Votre application en a besoin pour effectuer des appels d'API autorisés.

Remarque:Vous devez stocker et gérer les clés privées de manière sécurisée dans les environnements de développement et de production. Google ne conserve pas de copie de vos clés privées, mais uniquement de vos clés publiques. Pour en savoir plus, consultez la section Gérer les identifiants client de manière sécurisée dans les règles OAuth 2.0.

Déléguer l'autorité au niveau du domaine au compte de service

À l'aide d'un compte Google Workspace, un administrateur Workspace de l'organisation peut autoriser une application à accéder aux données utilisateur Workspace pour le compte des utilisateurs du domaine Google Workspace. Par exemple, une application qui se sert de l'API Google Agenda pour ajouter des événements aux agendas de tous les utilisateurs d'un domaine Google Workspace peut accéder à l'API Google Agenda pour le compte des utilisateurs via un compte de service. Le fait d'autoriser un compte de service à accéder aux données pour le compte d'utilisateurs d'un domaine est parfois appelé "délégation de l'autorité au niveau du domaine" à ce compte de service.

Remarque:Lorsque vous utilisez Google Workspace Marketplace pour installer une application pour votre domaine, les autorisations requises sont automatiquement accordées à l'application lors de l'installation. Vous n'avez pas besoin d'autoriser manuellement les comptes de service utilisés par l'application.

Remarque:Bien que vous puissiez utiliser des comptes de service dans des applications exécutées à partir d'un domaine Google Workspace, ils ne sont pas membres de votre compte Google Workspace et ne sont pas soumis aux règles de domaine définies par les administrateurs Google Workspace. Par exemple, une règle définie dans la console d'administration Google Workspace pour limiter la possibilité pour les utilisateurs finaux Google Workspace de partager des documents en dehors du domaine ne s'applique pas aux comptes de service.

Pour déléguer une autorité de domaine à un compte de service, un super-administrateur du domaine Google Workspace doit suivre ces étapes:

1. Dans la console d'administration de votre domaine Google Workspace, accédez à Menu principal  > Sécurité > Contrôle des accès et des données > Commandes des API.
2. Dans le volet Délégation au niveau du domaine, sélectionnez Gérer la délégation au niveau du domaine.
3. Cliquez sur Ajouter.
4. Dans le champ ID client, saisissez l'ID client du compte de service. Vous trouverez l'ID client de votre compte de service dans Service accounts page.
5. Dans le champ Champs d'application OAuth (séparés par une virgule), saisissez la liste des champs d'application auxquels votre application doit être autorisée. Par exemple, si votre application nécessite un accès complet au niveau du domaine à l'API Google Drive et à l'API Google Agenda, saisissez : https://www.googleapis.com/auth/drive, https://www.googleapis.com/auth/calendar.
6. Cliquez sur Autoriser.

Votre application est désormais autorisée à effectuer des appels d'API en tant qu'utilisateur de votre domaine Workspace (pour "usurper" l'identité des utilisateurs). Lorsque vous vous préparez à effectuer ces appels d'API délégués, vous spécifiez explicitement l'utilisateur à usurper.

Remarque:L'accès par usurpation d'identité est généralement accordé en quelques minutes après l'ajout de l'ID client, mais dans certains cas, il peut s'écouler jusqu'à 24 heures avant qu'il ne soit appliqué à tous les utilisateurs de votre compte Google.

Préparation d'un appel d'API délégué

Java

Après avoir obtenu l'adresse e-mail et la clé privée du client à partir de API Console, utilisez la bibliothèque cliente des API Google pour Java pour créer un objet GoogleCredential à partir des identifiants du compte de service et des champs d'application auxquels votre application doit accéder. Exemple :

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.services.sqladmin.SQLAdminScopes;

// ...

GoogleCredential credential = GoogleCredential.fromStream(new FileInputStream("MyProject-1234.json"))
    .createScoped(Collections.singleton(SQLAdminScopes.SQLSERVICE_ADMIN));

Si vous développez une application sur Google Cloud Platform, vous pouvez utiliser les identifiants par défaut de l'application à la place, ce qui peut simplifier le processus.

Délégation d'autorité au niveau du domaine

Si vous avez délégué un accès au niveau du domaine au compte de service et que vous souhaitez usurper l'identité d'un compte utilisateur, spécifiez l'adresse e-mail du compte utilisateur avec la méthode createDelegated de l'objet GoogleCredential. Par exemple :

GoogleCredential credential = GoogleCredential.fromStream(new FileInputStream("MyProject-1234.json"))
    .createScoped(Collections.singleton(SQLAdminScopes.SQLSERVICE_ADMIN))
    .createDelegated("[e-mail]");

Le code ci-dessus utilise l'objet GoogleCredential pour appeler sa méthode createDelegated(). L'argument de la méthode createDelegated() doit être un utilisateur appartenant à votre compte Workspace. Votre code effectuant la requête utilisera ces identifiants pour appeler les API Google à l'aide de votre compte de service.

Python

Après avoir obtenu l'adresse e-mail et la clé privée du client à partir de API Console, utilisez la bibliothèque cliente des API Google pour Python pour effectuer les étapes suivantes:

1. Créez un objet Credentials à partir des identifiants du compte de service et des champs d'application auxquels votre application doit accéder. Exemple :

   from google.oauth2 import service_account
   
   SCOPES = ['https://www.googleapis.com/auth/sqlservice.admin']
   SERVICE_ACCOUNT_FILE = '/path/to/service.json'
   
   credentials = service_account.Credentials.from_service_account_file(
           SERVICE_ACCOUNT_FILE, scopes=SCOPES)

   Si vous développez une application sur Google Cloud Platform, vous pouvez utiliser les identifiants par défaut de l'application à la place, ce qui peut simplifier le processus.

2. Délégation d'autorité au niveau du domaine

   Si vous avez délégué un accès au niveau du domaine au compte de service et que vous souhaitez usurper l'identité d'un compte utilisateur, utilisez la méthode with_subject d'un objet ServiceAccountCredentials existant. Exemple :

   delegated_credentials = credentials.with_subject('[e-mail]')

Utilisez l'objet Credentials pour appeler les API Google dans votre application.

HTTP/REST

Recommandation:Bien que votre application puisse effectuer ces tâches en interagissant directement avec le système OAuth 2.0 à l'aide de HTTP, les mécanismes d'interactions d'authentification de serveur à serveur exigent que les applications créent et signent de manière cryptographique des jetons Web JSON (JWT). Il est facile de commettre des erreurs graves qui peuvent avoir un impact grave sur la sécurité de votre application.

C'est pourquoi nous vous encourageons vivement à utiliser des bibliothèques telles que les bibliothèques clientes des API Google, qui extraient la cryptographie du code de votre application.

Une fois que vous avez obtenu l'ID client et la clé privée de API Console, votre application doit suivre les étapes suivantes:

1. Créez un jeton Web JSON (JWT, prononcé "jot") qui comprend un en-tête, un ensemble de revendications et une signature.
2. Demandez un jeton d'accès au serveur d'autorisation Google OAuth 2.0.
3. Gérez la réponse JSON renvoyée par le serveur d'autorisation.

Les sections suivantes décrivent comment suivre ces étapes.

Si la réponse inclut un jeton d'accès, vous pouvez l'utiliser pour appeler une API Google. (Si la réponse n'inclut pas de jeton d'accès, il est possible que votre JWT et votre requête de jeton ne soient pas correctement formés, ou que le compte de service ne soit pas autorisé à accéder aux champs d'application d'accès demandés.)

Lorsque le jeton d'accès expire, votre application génère un autre jeton JWT, le signe et demande un autre jeton d'accès.

Le reste de cette section décrit les détails de la création d'un jeton JWT, de sa signature, de la création de la requête de jeton d'accès et de la gestion de la réponse.

Créer un jeton JWT

Un jeton JWT se compose de trois parties: un en-tête, un ensemble de revendications et une signature. L'en-tête et l'ensemble de revendications sont des objets JSON. Ces objets JSON sont sérialisés en octets UTF-8, puis encodés à l'aide de l'encodage Base64url. Cet encodage offre une résilience contre les modifications d'encodage dues à des opérations d'encodage répétées. L'en-tête, l'ensemble de revendications et la signature sont concaténés avec un caractère point (.).

Un jeton JWT se compose comme suit:

{Base64url encoded header}.{Base64url encoded claim set}.{Base64url encoded signature}

La chaîne de base de la signature est la suivante:

{Base64url encoded header}.{Base64url encoded claim set}

Former l'en-tête JWT

L'en-tête se compose de trois champs qui indiquent l'algorithme de signature, le format de l'assertion et l'[ID de clé du compte de service](https://cloud.google.com/iam/docs/reference/rest/v1/projects.serviceAccounts.keys) utilisé pour signer le jeton JWT. L'algorithme et le format sont obligatoires, et chaque champ ne comporte qu'une seule valeur. À mesure que des algorithmes et des formats supplémentaires seront introduits, cet en-tête changera en conséquence. L'ID de clé est facultatif. Si un ID de clé incorrect est spécifié, GCP essaie toutes les clés associées au compte de service pour valider le jeton et le rejette si aucune clé valide n'est trouvée. Google se réserve le droit de rejeter les jetons avec des ID de clé incorrects à l'avenir.

Les comptes de service s'appuient sur l'algorithme RSA SHA-256 et le format de jeton JWT. Par conséquent, la représentation JSON de l'en-tête est la suivante:

{"alg":"RS256","typ":"JWT", "kid":"370ab79b4513eb9bad7c9bd16a95cb76b5b2a56a"}

La représentation en base64url est la suivante:

          eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsICJraWQiOiIzNzBhYjc5YjQ1MTNlYjliYWQ3YzliZDE2YTk1Y2I3NmI1YjJhNTZhIn0=

Former l'ensemble de revendications JWT

L'ensemble de revendications JWT contient des informations sur le jeton JWT, y compris les autorisations demandées (champs d'application), la cible du jeton, l'émetteur, l'heure à laquelle le jeton a été émis et la durée de vie du jeton. La plupart des champs sont obligatoires. Comme l'en-tête JWT, l'ensemble de revendications JWT est un objet JSON et est utilisé dans le calcul de la signature.

Revendications requises

Les revendications requises dans l'ensemble de revendications JWT sont présentées ci-dessous. Elles peuvent apparaître dans n'importe quel ordre dans l'ensemble de revendications.

Nom	Description
iss	Adresse e-mail du compte de service.
scope	Liste des autorisations demandées par l'application, délimitées par des espaces.
aud	Descripteur de la cible visée de l'assertion. Lorsque vous effectuez une requête de jeton d'accès, cette valeur est toujours https://oauth2.googleapis.com/token.
exp	Heure d'expiration de l'assertion, spécifiée en secondes depuis 00:00:00 UTC, le 1er janvier 1970. Cette valeur ne doit pas dépasser une heure après l'heure d'émission.
iat	Heure à laquelle l'assertion a été émise, spécifiée en secondes depuis 00:00:00 UTC, le 1er janvier 1970.

La représentation JSON des champs obligatoires dans un ensemble de revendications JWT est présentée ci-dessous:

{
  "iss": "[e-mail]",
  "scope": "https://www.googleapis.com/auth/devstorage.read_only",
  "aud": "https://oauth2.googleapis.com/token",
  "exp": 1328554385,
  "iat": 1328550785
}

Revendications supplémentaires

Dans certains cas d'entreprise, une application peut utiliser la délégation au niveau du domaine pour agir au nom d'un utilisateur particulier d'une organisation. L'autorisation d'effectuer ce type d'usurpation d'identité doit être accordée avant qu'une application puisse usurper l'identité d'un utilisateur. Elle est généralement gérée par un super-administrateur. Pour en savoir plus, consultez Contrôler l'accès à l'API à l'aide de la délégation au niveau du domaine.

Pour obtenir un jeton d'accès qui accorde à une application un accès délégué à une ressource, incluez l'adresse e-mail de l'utilisateur dans la revendication JWT définie comme valeur du champ sub.

Nom	Description
sub	Adresse e-mail de l'utilisateur pour lequel l'application demande un accès délégué.

Si une application n'est pas autorisée à usurper l'identité d'un utilisateur, la réponse à une requête de jeton d'accès incluant le champ sub sera une erreur.

Un exemple d'ensemble de revendications JWT incluant le champ sub est présenté ci-dessous:

{
  "iss": "[e-mail]",
  "sub": "[e-mail]",
  "scope": "https://www.googleapis.com/auth/prediction",
  "aud": "https://oauth2.googleapis.com/token",
  "exp": 1328554385,
  "iat": 1328550785
}

Encodage de l'ensemble de revendications JWT

Comme l'en-tête JWT, l'ensemble de revendications JWT doit être sérialisé en UTF-8 et encodé en base64url. Vous trouverez ci-dessous un exemple de représentation JSON d'un ensemble de revendications JWT:

{
  "iss": "[e-mail]",
  "scope": "https://www.googleapis.com/auth/prediction",
  "aud": "https://oauth2.googleapis.com/token",
  "exp": 1328554385,
  "iat": 1328550785
}

Calculer la signature

La signature Web JSON (JWS) est la spécification qui guide la mécanique de génération de la signature pour le JWT. L'entrée de la signature est la matrice d'octets du contenu suivant:

{Base64url encoded header}.{Base64url encoded claim set}

L'algorithme de signature de l'en-tête JWT doit être utilisé lors du calcul de la signature. Le seul algorithme de signature compatible avec le serveur d'autorisation Google OAuth 2.0 est RSA, qui utilise l'algorithme de hachage SHA-256. Cette valeur est exprimée sous la forme RS256 dans le champ alg de l'en-tête JWT.

Signez la représentation UTF-8 de l'entrée à l'aide de SHA256withRSA (également appelé RSASSA-PKCS1-V1_5-SIGN avec la fonction de hachage SHA-256) avec la clé privée obtenue à partir de Google API Console. La sortie sera un tableau d'octets.

La signature doit ensuite être encodée au format Base64url. L'en-tête, l'ensemble de revendications et la signature sont concaténés avec un caractère point (.). Le résultat est le JWT. Il doit être le suivant (sauts de ligne ajoutés pour plus de clarté):

{Base64url encoded header}.
{Base64url encoded claim set}.
{Base64url encoded signature}

Vous trouverez ci-dessous un exemple de JWT avant l'encodage Base64url:

{"alg":"RS256","typ":"JWT"}.
{
"iss":"[e-mail]",
"scope":"https://www.googleapis.com/auth/prediction",
"aud":"https://oauth2.googleapis.com/token",
"exp":1328554385,
"iat":1328550785
}.
[signature bytes]

Vous trouverez ci-dessous un exemple de jeton JWT signé et prêt à être transmis:

eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiI3NjEzMjY3OTgwNjktcjVtbGpsbG4xcmQ0bHJiaGc3NWVmZ2lncDM2bTc4ajVAZGV2ZWxvcGVyLmdzZXJ2aWNlYWNjb3VudC5jb20iLCJzY29wZSI6Imh0dHBzOi8vd3d3Lmdvb2dsZWFwaXMuY29tL2F1dGgvcHJlZGljdGlvbiIsImF1ZCI6Imh0dHBzOi8vd3d3Lmdvb2dsZWFwaXMuY29tL29hdXRoMi92NC90b2tlbiIsImV4cCI6MTMyODU1NDM4NSwiaWF0IjoxMzI4NTUwNzg1fQ.UFUt59SUM2_AW4cRU8Y0BYVQsNTo4n7AFsNrqOpYiICDu37vVt-tw38UKzjmUKtcRsLLjrR3gFW3dNDMx_pL9DVjgVHDdYirtrCekUHOYoa1CMR66nxep5q5cBQ4y4u2kIgSvChCTc9pmLLNoIem-ruCecAJYgI9Ks7pTnW1gkOKs0x3YpiLpzplVHAkkHztaXiJdtpBcY1OXyo6jTQCa3Lk2Q3va1dPkh_d--GU2M5flgd8xNBPYw4vxyt0mP59XZlHMpztZt0soSgObf7G3GXArreF_6tpbFsS3z2t5zkEiHuWJXpzcYr5zWTRPDEHsejeBSG8EgpLDce2380ROQ

Envoyer la demande de jeton d'accès

Une fois le jeton JWT signé généré, une application peut l'utiliser pour demander un jeton d'accès. Cette requête de jeton d'accès est une requête POST HTTPS, et le corps est encodé en URL. L'URL est indiquée ci-dessous:

https://oauth2.googleapis.com/token

Les paramètres suivants sont obligatoires dans la requête POST HTTPS:

Nom	Description
grant_type	Utilisez la chaîne suivante, encodée au format URL si nécessaire : urn:ietf:params:oauth:grant-type:jwt-bearer
assertion	Le jeton JWT, y compris la signature.

Vous trouverez ci-dessous un dump brut de la requête POST HTTPS utilisée dans une requête de jeton d'accès:

POST /token HTTP/1.1
Host: oauth2.googleapis.com
Content-Type: application/x-www-form-urlencoded

grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Ajwt-bearer&assertion=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiI3NjEzMjY3OTgwNjktcjVtbGpsbG4xcmQ0bHJiaGc3NWVmZ2lncDM2bTc4ajVAZGV2ZWxvcGVyLmdzZXJ2aWNlYWNjb3VudC5jb20iLCJzY29wZSI6Imh0dHBzOi8vd3d3Lmdvb2dsZWFwaXMuY29tL2F1dGgvcHJlZGljdGlvbiIsImF1ZCI6Imh0dHBzOi8vYWNjb3VudHMuZ29vZ2xlLmNvbS9vL29hdXRoMi90b2tlbiIsImV4cCI6MTMyODU3MzM4MSwiaWF0IjoxMzI4NTY5NzgxfQ.ixOUGehweEVX_UKXv5BbbwVEdcz6AYS-6uQV6fGorGKrHf3LIJnyREw9evE-gs2bmMaQI5_UbabvI4k-mQE4kBqtmSpTzxYBL1TCd7Kv5nTZoUC1CmwmWCFqT9RE6D7XSgPUh_jF1qskLa2w0rxMSjwruNKbysgRNctZPln7cqQ

Vous trouverez ci-dessous la même requête, utilisant curl:

curl -d 'grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Ajwt-bearer&assertion=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiI3NjEzMjY3OTgwNjktcjVtbGpsbG4xcmQ0bHJiaGc3NWVmZ2lncDM2bTc4ajVAZGV2ZWxvcGVyLmdzZXJ2aWNlYWNjb3VudC5jb20iLCJzY29wZSI6Imh0dHBzOi8vd3d3Lmdvb2dsZWFwaXMuY29tL2F1dGgvcHJlZGljdGlvbiIsImF1ZCI6Imh0dHBzOi8vYWNjb3VudHMuZ29vZ2xlLmNvbS9vL29hdXRoMi90b2tlbiIsImV4cCI6MTMyODU3MzM4MSwiaWF0IjoxMzI4NTY5NzgxfQ.RZVpzWygMLuL-n3GwjW1_yhQhrqDacyvaXkuf8HcJl8EtXYjGjMaW5oiM5cgAaIorrqgYlp4DPF_GuncFqg9uDZrx7pMmCZ_yHfxhSCXru3gbXrZvAIicNQZMFxrEEn4REVuq7DjkTMyCMGCY1dpMa8aWfTQFt3Eh7smLchaZsU
' https://oauth2.googleapis.com/token

Gérer la réponse

Si le JWT et la requête de jeton d'accès sont correctement formés et que le compte de service est autorisé à effectuer l'opération, la réponse JSON du serveur d'autorisation inclut un jeton d'accès. Voici un exemple de réponse :

{
  "access_token": "1/8xbJqaOZXSUZbHLl5EOtu1pxz3fmmetKx9W8CV4t79M",
  "scope": "https://www.googleapis.com/auth/prediction"
  "token_type": "Bearer",
  "expires_in": 3600
}

Les jetons d'accès peuvent être réutilisés pendant la période de validité spécifiée par la valeur expires_in.

Appeler des API Google

Java

Pour utiliser l'objet GoogleCredential pour appeler les API Google, procédez comme suit:

1. Créez un objet de service pour l'API que vous souhaitez appeler à l'aide de l'objet GoogleCredential. Exemple :

   SQLAdmin sqladmin =
       new SQLAdmin.Builder(httpTransport, JSON_FACTORY, credential).build();

2. Envoyez des requêtes au service d'API à l'aide de l'interface fournie par l'objet de service. Par exemple, pour lister les instances de bases de données Cloud SQL dans le projet exciting-example-123:

   SQLAdmin.Instances.List instances =
       sqladmin.instances().list("exciting-example-123").execute();

Python

Utilisez l'objet Credentials autorisé pour appeler les API Google en procédant comme suit:

1. Créez un objet de service pour l'API que vous souhaitez appeler. Vous créez un objet de service en appelant la fonction build avec le nom et la version de l'API, ainsi que l'objet Credentials autorisé. Par exemple, pour appeler la version 1beta3 de l'API Cloud SQL Administration:

   import googleapiclient.discovery
   
   sqladmin = googleapiclient.discovery.build('sqladmin', 'v1beta3', credentials=credentials)

2. Envoyez des requêtes au service d'API à l'aide de l'interface fournie par l'objet de service. Par exemple, pour lister les instances de bases de données Cloud SQL dans le projet exciting-example-123:

   response = sqladmin.instances().list(project='exciting-example-123').execute()

HTTP/REST

Une fois que votre application a obtenu un jeton d'accès, vous pouvez l'utiliser pour effectuer des appels à une API Google au nom d'un compte de service ou d'un compte utilisateur donné si le ou les champs d'application de l'accès requis par l'API ont été accordés. Pour ce faire, incluez le jeton d'accès dans une requête envoyée à l'API en incluant un paramètre de requête access_token ou une valeur Bearer d'en-tête HTTP Authorization. Lorsque c'est possible, l'en-tête HTTP est préférable, car les chaînes de requête ont tendance à être visibles dans les journaux du serveur. Dans la plupart des cas, vous pouvez utiliser une bibliothèque cliente pour configurer vos appels aux API Google (par exemple, lorsque vous appelez l'API Drive Files).

Vous pouvez tester toutes les API Google et consulter leurs champs d'application sur OAuth 2.0 Playground.

Exemples de requêtes HTTP GET

Un appel au point de terminaison drive.files (API Drive Files) à l'aide de l'en-tête HTTP Authorization: Bearer peut se présenter comme suit. Notez que vous devez spécifier votre propre jeton d'accès:

GET /drive/v2/files HTTP/1.1
Host: www.googleapis.com
Authorization: Bearer access_token

Voici un appel à la même API pour l'utilisateur authentifié à l'aide du paramètre de chaîne de requête access_token:

GET https://www.googleapis.com/drive/v2/files?access_token=access_token

curl exemples

Vous pouvez tester ces commandes avec l'application de ligne de commande curl. Voici un exemple qui utilise l'option d'en-tête HTTP (recommandée):

curl -H "Authorization: Bearer access_token" https://www.googleapis.com/drive/v2/files

Vous pouvez également utiliser l'option de paramètre de chaîne de requête:

curl https://www.googleapis.com/drive/v2/files?access_token=access_token

Lorsque les jetons d'accès expirent

Les jetons d'accès émis par le serveur d'autorisation Google OAuth 2.0 expirent après la durée indiquée par la valeur expires_in. Lorsqu'un jeton d'accès arrive à expiration, l'application doit générer un autre jeton JWT, le signer et demander un autre jeton d'accès.

Codes d'erreur JWT

Champ error	Champ error_description	Signification	Procédure de résolution
unauthorized_client	Unauthorized client or scope in request.	Si vous essayez d'utiliser la délégation au niveau du domaine, le compte de service n'est pas autorisé dans la console d'administration du domaine de l'utilisateur.	Assurez-vous que le compte de service est autorisé sur la page Délégation au niveau du domaine de la console d'administration pour l'utilisateur dans la revendication sub (champ). En principe, l'autorisation prend effet en quelques minutes, mais un délai maximal de 24 heures peut être nécessaire.
unauthorized_client	Client is unauthorized to retrieve access tokens using this method, or client not authorized for any of the scopes requested.	Un compte de service a été autorisé à l'aide de l'adresse e-mail du client plutôt qu'à l'aide de l'ID client (numérique) dans la console d'administration.	Sur la page Délégation au niveau du domaine de la console d'administration, supprimez le client, puis ajoutez-le à nouveau avec l'ID numérique.
access_denied	(toute valeur)	Si vous utilisez la délégation au niveau du domaine, un ou plusieurs des champs d'application demandés ne sont pas autorisés dans la console d'administration.	Assurez-vous que le compte de service est autorisé sur la page Délégation au niveau du domaine de la console d'administration pour l'utilisateur dans la revendication sub (champ), et qu'il inclut tous les champs d'application que vous demandez dans la revendication scope de votre JWT. En principe, l'autorisation prend effet en quelques minutes, mais un délai maximal de 24 heures peut être nécessaire.
admin_policy_enforced	(toute valeur)	Le compte Google ne peut pas autoriser un ou plusieurs champs d'application demandés en raison des règles de son administrateur Google Workspace.	Pour en savoir plus sur la façon dont un administrateur peut restreindre l'accès à tous les champs d'application ou à des champs d'application sensibles et limités jusqu'à ce que l'accès soit explicitement accordé à votre ID client OAuth, consultez l'article d'aide pour les administrateurs Google Workspace Contrôler l'accès des applications tierces et internes aux données Google Workspace.
invalid_client	(toute valeur)	Le client OAuth ou le jeton JWT n'est pas valide ou n'est pas configuré correctement. Pour en savoir plus, consultez la description de l'erreur.	Assurez-vous que le jeton JWT est valide et qu'il contient les revendications appropriées. Vérifiez que le client OAuth et le compte de service sont correctement configurés et que vous utilisez la bonne adresse e-mail. Vérifiez que le jeton JWT est correct et qu'il a été émis pour l'ID client indiqué dans la requête.
invalid_grant	Not a valid email.	Cet utilisateur n'existe pas.	Vérifiez que l'adresse e-mail indiquée dans la revendication (champ) sub est correcte.
invalid_grant	Invalid JWT: Token must be a short-lived token (60 minutes) and in a reasonable timeframe. Check your 'iat' and 'exp' values and use a clock with skew to account for clock differences between systems.	En général, cela signifie que l'heure système locale n'est pas correcte. Cela peut également se produire si la valeur exp est supérieure à 65 minutes après la valeur iat ou si la valeur exp est inférieure à la valeur iat.	Assurez-vous que l'horloge du système sur lequel le jeton JWT est généré est correcte. Si nécessaire, synchronisez votre heure avec le protocole NTP de Google.
invalid_grant	Invalid JWT Signature.	L'assertion JWT est signée avec une clé privée qui n'est pas associée au compte de service identifié par l'adresse e-mail du client, ou la clé utilisée a été supprimée, désactivée ou a expiré. L'assertion JWT peut également être encodée de manière incorrecte. Elle doit être encodée en base64, sans lignes vides ni signes égals de remplissage.	Décodez l'ensemble de revendications JWT et vérifiez que la clé qui a signé l'assertion est associée au compte de service. Essayez d'utiliser une bibliothèque OAuth fournie par Google pour vous assurer que le JWT est généré correctement.
invalid_scope	Invalid OAuth scope or ID token audience provided.	Aucun champ d'application n'a été demandé (liste vide de champs d'application) ou l'un des champs d'application demandés n'existe pas (c'est-à-dire qu'il n'est pas valide).	Assurez-vous que la revendication (champ) scope du jeton JWT est renseignée, puis comparez les champs d'application qu'il contient avec les champs d'application documentés pour les API que vous souhaitez utiliser afin de vous assurer qu'il n'y a pas d'erreurs ni de fautes de frappe. Notez que la liste des champs d'application de la revendication scope doit être séparée par des espaces, et non par des virgules.
disabled_client	The OAuth client was disabled.	La clé utilisée pour signer l'assertion JWT est désactivée.	Accédez à Google API Console, puis sous IAM et administration > Comptes de service, activez le compte de service contenant l'ID de clé utilisé pour signer l'assertion.
org_internal	This client is restricted to users within its organization.	L'ID client OAuth de la requête fait partie d'un projet limitant l'accès aux comptes Google dans une organisation Google Cloud spécifique.	Utilisez un compte de service de l'organisation pour vous authentifier. Vérifiez la configuration du type d'utilisateur pour votre application OAuth.

Avenant: Autorisation du compte de service sans OAuth

Avec certaines API Google, vous pouvez effectuer des appels d'API autorisés à l'aide d'un jeton JWT signé directement en tant que jeton de support, plutôt qu'un jeton d'accès OAuth 2.0. Lorsque cela est possible, vous pouvez éviter d'envoyer une requête réseau au serveur d'autorisation de Google avant d'effectuer un appel d'API.

Si la définition de service de l'API que vous souhaitez appeler est publiée dans le dépôt GitHub des API Google, vous pouvez effectuer des appels d'API autorisés à l'aide d'un jeton JWT au lieu d'un jeton d'accès. Procédez comme suit :

1. Créez un compte de service comme décrit ci-dessus. Veillez à conserver le fichier JSON que vous obtenez lorsque vous créez le compte.
2. À l'aide de n'importe quelle bibliothèque JWT standard, comme celle disponible sur jwt.io, créez un jeton JWT avec un en-tête et une charge utile comme dans l'exemple suivant:

   {
     "alg": "RS256",
     "typ": "JWT",
     "kid": "abcdef1234567890"
   }
   .
   {
     "iss": "[e-mail]",
     "sub": "[e-mail]",
     "aud": "https://firestore.googleapis.com/",
     "iat": 1511900000,
     "exp": 1511903600
   }

• Pour le champ kid de l'en-tête, spécifiez l'ID de la clé privée de votre compte de service. Vous trouverez cette valeur dans le champ private_key_id de votre fichier JSON de compte de service.
• Pour les champs iss et sub, spécifiez l'adresse e-mail de votre compte de service. Vous trouverez cette valeur dans le champ client_email du fichier JSON de votre compte de service.
• Pour le champ aud, spécifiez le point de terminaison de l'API. Exemple : https://SERVICE.googleapis.com/.
• Pour le champ iat, spécifiez l'heure Unix actuelle, et pour le champ exp, spécifiez l'heure exacte 3 600 secondes plus tard, lorsque le jeton JWT expirera.

Signez le jeton JWT avec RSA-256 à l'aide de la clé privée figurant dans le fichier JSON de votre compte de service.

Exemple :

Java

À l'aide de google-api-java-client et de java-jwt:

GoogleCredential credential =
        GoogleCredential.fromStream(new FileInputStream("MyProject-1234.json"));
PrivateKey privateKey = credential.getServiceAccountPrivateKey();
String privateKeyId = credential.getServiceAccountPrivateKeyId();

long now = System.currentTimeMillis();

try {
    Algorithm algorithm = Algorithm.RSA256(null, privateKey);
    String signedJwt = JWT.create()
        .withKeyId(privateKeyId)
        .withIssuer("[e-mail]")
        .withSubject("[e-mail]")
        .withAudience("https://firestore.googleapis.com/")
        .withIssuedAt(new Date(now))
        .withExpiresAt(new Date(now + 3600 * 1000L))
        .sign(algorithm);
} catch ...

Python

Avec PyJWT:

iat = time.time()
exp = iat + 3600
payload = {'iss': '[e-mail]',
           'sub': '[e-mail]',
           'aud': 'https://firestore.googleapis.com/',
           'iat': iat,
           'exp': exp}
additional_headers = {'kid': PRIVATE_KEY_ID_FROM_JSON}
signed_jwt = jwt.encode(payload, PRIVATE_KEY_FROM_JSON, headers=additional_headers,
                       algorithm='RS256')

1. Appelez l'API en utilisant le jeton JWT signé comme jeton porteur:

   GET /v1/projects/abc/databases/123/indexes HTTP/1.1
   Authorization: Bearer SIGNED_JWT
   Host: firestore.googleapis.com

Implémenter la protection multicompte

Pour protéger les comptes de vos utilisateurs, vous devez également implémenter la protection multicompte à l'aide du service de protection multicompte de Google. Ce service vous permet de vous abonner à des notifications d'événements de sécurité qui fournissent des informations à votre application sur les modifications majeures apportées au compte utilisateur. Vous pouvez ensuite utiliser ces informations pour prendre des mesures en fonction de la façon dont vous décidez de répondre aux événements.

Voici quelques exemples de types d'événements envoyés à votre application par le service de protection multicompte de Google:

• https://schemas.openid.net/secevent/risc/event-type/sessions-revoked
• https://schemas.openid.net/secevent/oauth/event-type/token-revoked
• https://schemas.openid.net/secevent/risc/event-type/account-disabled

Pour en savoir plus sur l'implémentation de la Protection multicompte et obtenir la liste complète des événements disponibles, consultez la page Protéger les comptes utilisateur avec la Protection multicompte .