هنگام استفاده از سرویسهای هویت گوگل یا جریان کد مجوز OAuth 2.0، گوگل توکن شناسه را با استفاده از روش POST به نقطه پایانی تغییر مسیر برمیگرداند. از طرف دیگر، جریان ضمنی OIDC از یک درخواست GET استفاده میکند. در نتیجه، برنامه شما مسئول انتقال ایمن این اعتبارنامههای دریافتی به سرور شما است.
این جریان ضمنی است، توکن شناسه در قطعه URL بازگردانده میشود، که جاوا اسکریپت سمت کلاینت باید آن را تجزیه کند. برنامه شما مسئول پیادهسازی مکانیسمهای اعتبارسنجی خود برای اطمینان از صحت درخواست و جلوگیری از حملاتی مانند CSRF است. توکن شناسه به عنوان فیلد HTTP/1.1 302 Found
Location: https://<REDIRECT_URI>#access_token=<ACCESS_TOKEN>&token_type=bearer&expires_in=<TIME_IN_SECONDS>&scope=<SCOPE>&state=<STATE_STRING>
credential ارسال میشود. هنگام آماده شدن برای ارسال توکن شناسه به سرور، کتابخانه GIS به طور خودکار g_csrf_token را به کوکی هدر و بدنه درخواست اضافه میکند. این یک نمونه درخواست POST است:POST /auth/token-verification HTTP/1.1
Host: example.com
Content-Type: application/json;charset=UTF-8
Cookie: g_csrf_token=<CSRF_TOKEN>
Origin: https://example.com
Content-Length: <LENGTH_OF_JSON_BODY>
{
"credential": "<ID_TOKEN>",
"g_csrf_token": "<CSRF_TOKEN>",
"client_id": "<CLIENT_ID>"
}
اعتبارسنجی
g_csrf_tokenبرای جلوگیری از حملات جعل درخواست بین سایتی (CSRF):- مقدار توکن CSRF را از کوکی
g_csrf_tokenاستخراج کنید. - مقدار توکن CSRF را از بدنه درخواست استخراج کنید. کتابخانه GIS این توکن را به عنوان یک پارامتر در بدنه درخواست POST قرار میدهد که با نام
g_csrf_tokenنیز شناخته میشود. - دو مقدار توکن را با هم مقایسه کنید
- اگر هر دو مقدار وجود داشته باشند و کاملاً مطابقت داشته باشند، درخواست معتبر تلقی شده و از دامنه شما سرچشمه گرفته است.
- اگر مقادیر موجود نباشند یا مطابقت نداشته باشند، درخواست باید توسط سرور رد شود. این بررسی تضمین میکند که درخواست از جاوا اسکریپتی که در دامنه شما اجرا میشود، آغاز شده است، زیرا فقط دامنه شما میتواند به کوکی
g_csrf_tokenدسترسی داشته باشد.
- مقدار توکن CSRF را از کوکی
توکن شناسایی را تأیید کنید.
To verify that the token is valid, ensure that the following criteria are satisfied:
- The ID token is properly signed by Google. Use Google's public keys
(available in
JWK or
PEM format)
to verify the token's signature. These keys are regularly rotated; examine
the
Cache-Controlheader in the response to determine when you should retrieve them again. - The value of
audin the ID token is equal to one of your app's client IDs. This check is necessary to prevent ID tokens issued to a malicious app being used to access data about the same user on your app's backend server. - The value of
issin the ID token is equal toaccounts.google.comorhttps://accounts.google.com. - The expiry time (
exp) of the ID token has not passed. - If you need to validate that the ID token represents a Google Workspace or Cloud
organization account, you can check the
hdclaim, which indicates the hosted domain of the user. This must be used when restricting access to a resource to only members of certain domains. The absence of this claim indicates that the account does not belong to a Google hosted domain.
Using the
email,email_verifiedandhdfields, you can determine if Google hosts and is authoritative for an email address. In the cases where Google is authoritative, the user is known to be the legitimate account owner, and you may skip password or other challenge methods.Cases where Google is authoritative:
emailhas a@gmail.comsuffix, this is a Gmail account.email_verifiedis true andhdis set, this is a Google Workspace account.
Users may register for Google Accounts without using Gmail or Google Workspace. When
emaildoes not contain a@gmail.comsuffix andhdis absent, Google is not authoritative and password or other challenge methods are recommended to verify the user.email_verifiedcan also be true as Google initially verified the user when the Google account was created, however ownership of the third party email account may have since changed.Rather than writing your own code to perform these verification steps, we strongly recommend using a Google API client library for your platform, or a general-purpose JWT library. For development and debugging, you can call our
tokeninfovalidation endpoint.Using a Google API Client Library
Using one of the Google API Client Libraries (e.g. Java, Node.js, PHP, Python) is the recommended way to validate Google ID tokens in a production environment.
Java To validate an ID token in Java, use the GoogleIdTokenVerifier object. For example:
import com.google.api.client.googleapis.auth.oauth2.GoogleIdToken; import com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload; import com.google.api.client.googleapis.auth.oauth2.GoogleIdTokenVerifier; ... GoogleIdTokenVerifier verifier = new GoogleIdTokenVerifier.Builder(transport, jsonFactory) // Specify the WEB_CLIENT_ID of the app that accesses the backend: .setAudience(Collections.singletonList(WEB_CLIENT_ID)) // Or, if multiple clients access the backend: //.setAudience(Arrays.asList(WEB_CLIENT_ID_1, WEB_CLIENT_ID_2, WEB_CLIENT_ID_3)) .build(); // (Receive idTokenString by HTTPS POST) GoogleIdToken idToken = verifier.verify(idTokenString); if (idToken != null) { Payload payload = idToken.getPayload(); // Print user identifier. This ID is unique to each Google Account, making it suitable for // use as a primary key during account lookup. Email is not a good choice because it can be // changed by the user. String userId = payload.getSubject(); System.out.println("User ID: " + userId); // Get profile information from payload String email = payload.getEmail(); boolean emailVerified = Boolean.valueOf(payload.getEmailVerified()); String name = (String) payload.get("name"); String pictureUrl = (String) payload.get("picture"); String locale = (String) payload.get("locale"); String familyName = (String) payload.get("family_name"); String givenName = (String) payload.get("given_name"); // Use or store profile information // ... } else { System.out.println("Invalid ID token."); }
The
GoogleIdTokenVerifier.verify()method verifies the JWT signature, theaudclaim, theissclaim, and theexpclaim.If you need to validate that the ID token represents a Google Workspace or Cloud organization account, you can verify the
hdclaim by checking the domain name returned by thePayload.getHostedDomain()method. The domain of theemailclaim is insufficient to ensure that the account is managed by a domain or organization.Node.js To validate an ID token in Node.js, use the Google Auth Library for Node.js. Install the library:
Then, call thenpm install google-auth-library --save
verifyIdToken()function. For example:const {OAuth2Client} = require('google-auth-library'); const client = new OAuth2Client(); async function verify() { const ticket = await client.verifyIdToken({ idToken: token, audience: WEB_CLIENT_ID, // Specify the WEB_CLIENT_ID of the app that accesses the backend // Or, if multiple clients access the backend: //[WEB_CLIENT_ID_1, WEB_CLIENT_ID_2, WEB_CLIENT_ID_3] }); const payload = ticket.getPayload(); // This ID is unique to each Google Account, making it suitable for use as a primary key // during account lookup. Email is not a good choice because it can be changed by the user. const userid = payload['sub']; // If the request specified a Google Workspace domain: // const domain = payload['hd']; } verify().catch(console.error);
The
verifyIdTokenfunction verifies the JWT signature, theaudclaim, theexpclaim, and theissclaim.If you need to validate that the ID token represents a Google Workspace or Cloud organization account, you can check the
hdclaim, which indicates the hosted domain of the user. This must be used when restricting access to a resource to only members of certain domains. The absence of this claim indicates that the account does not belong to a Google hosted domain.PHP To validate an ID token in PHP, use the Google API Client Library for PHP. Install the library (for example, using Composer):
Then, call thecomposer require google/apiclient
verifyIdToken()function. For example:require_once 'vendor/autoload.php'; // Get $id_token via HTTPS POST. $client = new Google_Client(['client_id' => $WEB_CLIENT_ID]); // Specify the WEB_CLIENT_ID of the app that accesses the backend $payload = $client->verifyIdToken($id_token); if ($payload) { // This ID is unique to each Google Account, making it suitable for use as a primary key // during account lookup. Email is not a good choice because it can be changed by the user. $userid = $payload['sub']; // If the request specified a Google Workspace domain //$domain = $payload['hd']; } else { // Invalid ID token }
The
verifyIdTokenfunction verifies the JWT signature, theaudclaim, theexpclaim, and theissclaim.If you need to validate that the ID token represents a Google Workspace or Cloud organization account, you can check the
hdclaim, which indicates the hosted domain of the user. This must be used when restricting access to a resource to only members of certain domains. The absence of this claim indicates that the account does not belong to a Google hosted domain.Python To validate an ID token in Python, use the verify_oauth2_token function. For example:
from google.oauth2 import id_token from google.auth.transport import requests # (Receive token by HTTPS POST) # ... try: # Specify the WEB_CLIENT_ID of the app that accesses the backend: idinfo = id_token.verify_oauth2_token(token, requests.Request(), WEB_CLIENT_ID) # Or, if multiple clients access the backend server: # idinfo = id_token.verify_oauth2_token(token, requests.Request()) # if idinfo['aud'] not in [WEB_CLIENT_ID_1, WEB_CLIENT_ID_2, WEB_CLIENT_ID_3]: # raise ValueError('Could not verify audience.') # If the request specified a Google Workspace domain # if idinfo['hd'] != DOMAIN_NAME: # raise ValueError('Wrong domain name.') # ID token is valid. Get the user's Google Account ID from the decoded token. # This ID is unique to each Google Account, making it suitable for use as a primary key # during account lookup. Email is not a good choice because it can be changed by the user. userid = idinfo['sub'] except ValueError: # Invalid token pass
The
verify_oauth2_tokenfunction verifies the JWT signature, theaudclaim, and theexpclaim. You must also verify thehdclaim (if applicable) by examining the object thatverify_oauth2_tokenreturns. If multiple clients access the backend server, also manually verify theaudclaim.- The ID token is properly signed by Google. Use Google's public keys
(available in
JWK or
PEM format)
to verify the token's signature. These keys are regularly rotated; examine
the
پس از تأیید اعتبار توکن، میتوانید از اطلاعات موجود در توکن شناسه گوگل برای مرتبط کردن وضعیت حساب کاربری سایت خود استفاده کنید:
کاربر ثبتنام نشده: میتوانید رابط کاربری (UI) ثبتنام را نمایش دهید که به کاربر اجازه میدهد در صورت نیاز اطلاعات پروفایل بیشتری ارائه دهد. همچنین به کاربر اجازه میدهد تا بهطور مخفیانه حساب کاربری جدید و یک جلسه کاربری وارد شده ایجاد کند.
یک حساب کاربری موجود که از قبل در سایت شما وجود دارد: میتوانید صفحه وبی را نمایش دهید که به کاربر نهایی اجازه میدهد رمز عبور خود را وارد کند و حساب کاربری قدیمی را به اطلاعات کاربری گوگل خود پیوند دهد. این تأیید میکند که کاربر به حساب کاربری موجود دسترسی دارد.
یک کاربر فدرالِ در حال بازگشت: میتوانید کاربر را بیسروصدا وارد سیستم کنید.