כשמשתמשים בכניסה באמצעות חשבון Google באמצעות אפליקציה או אתר שמתקשרים עם קצה עורפי השרת, ייתכן שיהיה עליך לזהות את המשתמש שמחובר עכשיו בשרת. כדי לעשות זאת באופן מאובטח, לאחר שמשתמש נכנס בהצלחה, שלח את אסימון מזהה לשרת שלך באמצעות HTTPS. לאחר מכן, מאמתים את התקינות בשרת של האסימון המזהה ולהשתמש בפרטי המשתמש הכלולים באסימון כדי ליצור סשן, או ליצור חשבון חדש.
שליחת האסימון המזהה לשרת
אחרי שמשתמש נכנס לחשבון, מקבלים את האסימון המזהה של המשתמש:
function onSignIn(googleUser) { var id_token = googleUser.getAuthResponse().id_token; ... }
לאחר מכן, שולחים את האסימון המזהה לשרת באמצעות בקשת HTTPS POST:
var xhr = new XMLHttpRequest(); xhr.open('POST', 'https://yourbackend.example.com/tokensignin'); xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded'); xhr.onload = function() { console.log('Signed in as: ' + xhr.responseText); }; xhr.send('idtoken=' + id_token);
אימות התקינות של האסימון המזהה
אחרי שמקבלים את האסימון המזהה באמצעות HTTPS POST, צריך לאמת את התקינות של האסימון.
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_verified and hd fields, 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
email does not contain a @gmail.com suffix and hd is absent, Google is not
authoritative and password or other challenge methods are recommended to verify
the user. email_verified can 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 tokeninfo
validation 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.
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, the aud claim, the iss claim, and the
exp claim.
If you need to validate that the ID token represents a Google Workspace or Cloud
organization account, you can verify the hd claim by checking the domain name
returned by the Payload.getHostedDomain() method. The domain of the
email claim is insufficient to ensure that the account is managed by a domain
or organization.
To validate an ID token in Node.js, use the Google Auth Library for Node.js. Install the library:
npm 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 verifyIdToken function verifies
the JWT signature, the aud claim, the exp claim,
and the iss claim.
If you need to validate that the ID token represents a Google Workspace or Cloud
organization account, you can check the hd claim, 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.
To validate an ID token in PHP, use the Google API Client Library for PHP. Install the library (for example, using Composer):
composer 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 verifyIdToken function verifies
the JWT signature, the aud claim, the exp claim,
and the iss claim.
If you need to validate that the ID token represents a Google Workspace or Cloud
organization account, you can check the hd claim, 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.
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_token function verifies the JWT
signature, the aud claim, and the exp claim.
You must also verify the hd
claim (if applicable) by examining the object that
verify_oauth2_token returns. If multiple clients access the
backend server, also manually verify the aud claim.
קריאה לנקודת הקצה של Tokeninfo
דרך קלה לאמת חתימה של אסימון מזהה לצורך ניפוי באגים היא
משתמשים בנקודת הקצה tokeninfo. קריאה לנקודת הקצה הזו כוללת
בקשת רשת נוספת שמבצעת את רוב האימות עבורכם בזמן שאתם בודקים
אימות וחילוץ מטען ייעודי (payload) בקוד שלכם. הוא לא מתאים לשימוש בסביבת ייצור
יכול להיות שבקשות עשויות להיות מווסתות או מושפעות משגיאות המתרחשות לסירוגין.
כדי לאמת אסימון מזהה באמצעות נקודת הקצה tokeninfo, צריך ליצור HTTPS
בקשת POST או GET לנקודת הקצה ומעבירים את האסימון המזהה
id_token.
לדוגמה, כדי לאמת את האסימון "XYZ123", שולחים את בקשת ה-GET הבאה:
https://oauth2.googleapis.com/tokeninfo?id_token=XYZ123
אם האסימון חתום כראוי והשדות iss ו-exp
להצהרות יש את הערכים המצופים, תקבלו תגובת HTTP 200,
מכיל את ההצהרות של אסימון מזהה בפורמט JSON.
זוהי דוגמה לתשובה:
{
// These six fields are included in all Google ID Tokens.
"iss": "https://accounts.google.com",
"sub": "110169484474386276334",
"azp": "1008719970978-hb24n2dstb40o45d4feuo2ukqmcc6381.apps.googleusercontent.com",
"aud": "1008719970978-hb24n2dstb40o45d4feuo2ukqmcc6381.apps.googleusercontent.com",
"iat": "1433978353",
"exp": "1433981953",
// These seven fields are only included when the user has granted the "profile" and
// "email" OAuth scopes to the application.
"email": "testuser@gmail.com",
"email_verified": "true",
"name" : "Test User",
"picture": "https://lh4.googleusercontent.com/-kYgzyAWpZzJ/ABCDEFGHI/AAAJKLMNOP/tIXL9Ir44LE/s99-c/photo.jpg",
"given_name": "Test",
"family_name": "User",
"locale": "en"
}
אם אתם צריכים לוודא שהאסימון המזהה מייצג חשבון Google Workspace, אתם יכולים לבדוק
ההצהרה hd, שמציינת את הדומיין המתארח של המשתמש. חובה להשתמש באפשרות הזו כאשר
הגבלת הגישה למשאב רק לחברים בדומיינים מסוימים. היעדר תביעה זו
מציין שהחשבון לא שייך לדומיין מתארח ב-Google Workspace.
יצירת חשבון או סשן
אחרי שמאמתים את האסימון, בודקים אם המשתמש כבר נמצא בחשבון המשתמש שלכם מסד נתונים. אם כן, צריך ליצור סשן מאומת בשביל המשתמש. אם המשתמש לא נמצא עדיין במסד הנתונים של המשתמשים, יש ליצור רשומת משתמש חדשה מהמידע במטען הייעודי (payload) של האסימון המזהה, וליצור סשן עבור המשתמש. אפשר לשלוח בקשה למשתמש לגבי פרטי פרופיל נוספים שדרושים לך כשמזהים משתמש חדש באפליקציה.
אבטחה של המשתמשים חשבונות עם הגנה על כל החשבונות
כאשר אתה מסתמך על כך ש-Google תעביר משתמש, תיהנו באופן אוטומטי מכל ואת התשתית של Google כדי להגן על נתוני המשתמש. אבל, לפעמים במקרה הלא סביר שבו חשבון Google של המשתמש ייפרץ או שמהווה אירוע אבטחה משמעותי, האפליקציה שלך עלולה גם להיות חשופה למתקפה. כדי להגן טוב יותר על חשבונות מאירועי אבטחה חמורים, השתמשו באפשרות פעולות חוצות-חשבונות הגנה לקבלת התראות אבטחה מ-Google. כשתקבלו את האירועים האלה, לקבל שקיפות לגבי שינויים חשובים באבטחת חשבון Google של המשתמש לאחר מכן תוכלו לבצע את הפעולות בשירות כדי לאבטח את החשבונות.