אימות האסימון של מזהה Google בצד השרת

אחרי ש-Google מחזירה את אסימון המזהה, הוא נשלח באמצעות בקשת שיטת HTTP POST, עם שם הפרמטר credential, לנקודת הקצה של ההתחברות.

בדוגמה הבאה בשפת Python מוצגים השלבים הרגילים לאימות ולשימוש באסימון המזהה:

1. מאמתים את האסימון של זיוף בקשות בין אתרים (CSRF). כששולחים את פרטי הכניסה לנקודת הקצה של ההתחברות, אנחנו משתמשים בתבנית של שליחת קובץ cookie כפול כדי למנוע התקפות CSRF. לפני כל שליחה, אנחנו יוצרים אסימון. לאחר מכן, האסימון מועבר גם לקובץ ה-cookie וגם לגוף הפוסט, כפי שמוצג בדוגמת הקוד הבאה:

   csrf_token_cookie = self.request.cookies.get('g_csrf_token')
   if not csrf_token_cookie:
       webapp2.abort(400, 'No CSRF token in Cookie.')
   csrf_token_body = self.request.get('g_csrf_token')
   if not csrf_token_body:
       webapp2.abort(400, 'No CSRF token in post body.')
   if csrf_token_cookie != csrf_token_body:
       webapp2.abort(400, 'Failed to verify double submit cookie.')
   

2. מאמתים את האסימון המזהה.

   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-Control header in the response to determine when you should retrieve them again.
   • The value of aud in 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 iss in the ID token is equal to accounts.google.com or https://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 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.

   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:

   • email has a @gmail.com suffix, this is a Gmail account.
   • email_verified is true and hd is 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.

   שימוש בספריית לקוח של Google API

   באמצעות אחת מספריות הלקוח של Google API (למשל, Java, Node.js, PHP, Python) היא הדרך המומלצת לאימות אסימונים מזהים של Google בסביבת הייצור.

   Java

   כדי לאמת אסימון מזהה ב-Java, משתמשים ב אובייקט GoogleIdTokenVerifier. לדוגמה:

   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
     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.");
   }

   השיטה GoogleIdTokenVerifier.verify() מאמתת את ה-JWT החתימה, ההצהרה aud, ההצהרה iss ו תלונה exp.

   אם אתם צריכים לאמת שהאסימון המזהה מייצג Google Workspace או Cloud חשבון ארגוני, אפשר לאמת את הצהרת הזמן לתפוגה hd על ידי בדיקת שם הדומיין שהוחזרו באמצעות השיטה Payload.getHostedDomain(). הדומיין של תלונה אחת (email) לא מספיקה כדי לוודא שהחשבון מנוהל על ידי דומיין או לארגון.

   Node.js

   כדי לאמת אסימון מזהה ב-Node.js, משתמשים בספריית Google Auth ל-Node.js. מתקינים את הספרייה:

   npm install google-auth-library --save

   לאחר מכן קוראים לפונקציה verifyIdToken(). לדוגמה:

   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();
     const userid = payload['sub'];
     // If the request specified a Google Workspace domain:
     // const domain = payload['hd'];
   }
   verify().catch(console.error);

   הפונקציה verifyIdToken מאמתת חתימת ה-JWT, הצהרת aud, ההצהרה exp, להצהרה iss.

   אם אתם צריכים לאמת שהאסימון המזהה מייצג Google Workspace או Cloud חשבון ארגוני, אפשר לבדוק את ההצהרה hd, שמציינת את המארח הדומיין של המשתמש. צריך להשתמש באפשרות הזו כשמגבילים את הגישה למשאב רק לחברים של דומיינים מסוימים. היעדר תביעה זו מצביע על כך שהחשבון לא שייך ל- דומיין באירוח Google.

   PHP

   כדי לאמת אסימון מזהה ב-PHP, משתמשים בספריית הלקוח של Google API ל-PHP. מתקינים את הספרייה (לדוגמה באמצעות Composer):

   composer require google/apiclient

   לאחר מכן קוראים לפונקציה verifyIdToken(). לדוגמה:

   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) {
     $userid = $payload['sub'];
     // If the request specified a Google Workspace domain
     //$domain = $payload['hd'];
   } else {
     // Invalid ID token
   }

   הפונקציה verifyIdToken מאמתת חתימת ה-JWT, הצהרת aud, ההצהרה exp, להצהרה iss.

   אם אתם צריכים לאמת שהאסימון המזהה מייצג Google Workspace או Cloud חשבון ארגוני, אפשר לבדוק את ההצהרה hd, שמציינת את המארח הדומיין של המשתמש. צריך להשתמש באפשרות הזו כשמגבילים את הגישה למשאב רק לחברים של דומיינים מסוימים. היעדר תביעה זו מצביע על כך שהחשבון לא שייך ל- דומיין באירוח Google.

   Python

   כדי לאמת אסימון מזהה ב-Python, משתמשים ב verify_oauth2_token מותאמת אישית. לדוגמה:

   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.
       userid = idinfo['sub']
   except ValueError:
       # Invalid token
       pass

   הפונקציה verify_oauth2_token מאמתת את ה-JWT חתימה, הצהרת aud וההצהרה exp. צריך לאמת גם את hd (אם רלוונטי) על ידי בחינת האובייקט אפשרות החזרה במחיר verify_oauth2_token. אם מספר לקוחות ניגשים אל שרת הקצה העורפי, צריך גם לאמת באופן ידני את ההצהרה aud.

3. אחרי שתאשרו את תקינות האסימון, תוכלו להשתמש במידע באסימון המזהה של Google כדי למצוא התאמה לסטטוס החשבון של האתר:

   • משתמש לא רשום: אתם יכולים להציג ממשק משתמש (UI) להרשמה שמאפשר למשתמש לספק פרטי פרופיל נוספים, אם צריך. הוא גם מאפשר למשתמש ליצור את החשבון החדש ואת סשן המשתמש המקושר ללא התראה.

   • חשבון קיים שכבר קיים באתר: אתם יכולים להציג דף אינטרנט שמאפשר למשתמש הקצה להזין את הסיסמה שלו ולקשר את החשבון הקודם לפרטי הכניסה שלו ל-Google. כך תוכלו לוודא שלמשתמש יש גישה לחשבון הקיים.

   • משתמש מאוחד חוזר: אפשר להיכנס לחשבון של המשתמש באופן אוטומטי.