אימות האסימון של מזהה 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. מאמתים את האסימון המזהה.

   כדי לוודא שהאסימון תקין, צריך לוודא שהקריטריונים הבאים מתקיימים:

   • טוקן המזהה חתום בצורה תקינה על ידי Google. משתמשים במפתחות הציבוריים של Google (זמינים בפורמט JWK או PEM) כדי לאמת את חתימת האסימון. המפתחות האלה מתחלפים באופן קבוע. כדי לדעת מתי צריך לאחזר אותם שוב, צריך לבדוק את הכותרת Cache-Control בתשובה.
   • הערך של aud בטוקן ה-ID שווה לאחד ממזהי הלקוח של האפליקציה. הבדיקה הזו נחוצה כדי למנוע שימוש באסימונים מזהים שהונפקו לאפליקציה זדונית כדי לגשת לנתונים על אותו משתמש בשרת העורפי של האפליקציה שלכם.
   • הערך של iss בטוקן המזהה שווה ל-accounts.google.com או ל-https://accounts.google.com.
   • תאריך התפוגה (exp) של טוקן המזהה עוד לא חלף.
   • אם אתם צריכים לוודא שטוקן ה-ID מייצג חשבון ארגוני ב-Google Workspace או ב-Cloud, אתם יכולים לבדוק את טענת hd, שמציינת את הדומיין המארח של המשתמש. חובה להשתמש בהגדרה הזו כשרוצים להגביל את הגישה למשאב רק לחברים בדומיינים מסוימים. אם התביעה הזו לא מופיעה, סימן שהחשבון לא שייך לדומיין שמארח את Google.

   באמצעות השדות email, email_verified ו-hd, אפשר לקבוע אם Google מארחת כתובת אימייל ומוגדרת כסמכותית לגביה. במקרים שבהם Google היא הסמכות, המשתמש מזוהה כבעל החשבון הלגיטימי, ואפשר לדלג על הסיסמה או על שיטות אחרות לאימות.

   מקרים שבהם Google היא הסמכות:

   • ‫email יש סיומת @gmail.com, זה חשבון Gmail.
   • ‫email_verified נכון ו-hd מוגדר, זהו חשבון Google Workspace.

   משתמשים יכולים להירשם לחשבונות Google בלי להשתמש ב-Gmail או ב-Google Workspace. אם email לא מכיל את הסיומת @gmail.com ו-hd לא מופיע, Google לא מהימנה ומומלץ להשתמש בסיסמה או בשיטות אחרות לאימות כדי לאמת את המשתמש. יכול להיות שגם email_verified נכון, כי Google אימתה את המשתמש בהתחלה כשחשבון Google נוצר, אבל יכול להיות שהבעלות על חשבון האימייל של הצד השלישי השתנתה מאז.

   במקום לכתוב קוד משלכם כדי לבצע את שלבי האימות האלה, מומלץ מאוד להשתמש בספריית לקוח של Google API עבור הפלטפורמה שלכם, או בספריית JWT למטרות כלליות. למטרות פיתוח וניפוי באגים, אפשר להתקשר אל נקודת הקצה שלנו לאימות tokeninfo.

   שימוש בספריית לקוח של 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. כך תוכלו לוודא שלמשתמש יש גישה לחשבון הקיים.

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