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

אחרי ש-Google מחזירה אסימון מזהה, הוא נשלח לנקודת הקצה (endpoint) שלכם להתחברות באמצעות בקשת method POST של HTTP, עם שם הפרמטר 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 באסימון המזהה שווה לאחד מהערכים של האפליקציה מזהי לקוח. הבדיקה הזו נחוצה כדי למנוע אסימונים מזהים שהונפקו על ידי תוכנה זדונית שמשמשות לגישה לנתונים על אותו משתמש בשרת הקצה העורפי של האפליקציה.
   • הערך של iss באסימון המזהה שווה ל- accounts.google.com או https://accounts.google.com.
   • מועד התפוגה (exp) של האסימון המזהה לא עבר.
   • אם אתם צריכים לאמת שהאסימון המזהה מייצג Google Workspace או Cloud חשבון ארגוני, אפשר לבדוק את ההצהרה hd, שמציינת את המארח הדומיין של המשתמש. צריך להשתמש באפשרות הזו כשמגבילים את הגישה למשאב רק לחברים בדומיין דומיינים מסוימים. היעדר תביעה זו מצביע על כך שהחשבון לא שייך דומיין באירוח Google.

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

   מקרים שבהם Google היא מהימן:

   • ל-email יש סיומת @gmail.com. זהו חשבון Gmail.
   • email_verified מוגדר כ-True ו-hd מוגדר. זהו חשבון G Suite.

   משתמשים יכולים להירשם לחשבונות Google בלי להשתמש ב-Gmail או ב-G Suite. מתי 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 CLIENT_ID of the app that accesses the backend:
       .setAudience(Collections.singletonList(CLIENT_ID))
       // Or, if multiple clients access the backend:
       //.setAudience(Arrays.asList(CLIENT_ID_1, CLIENT_ID_2, 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: CLIENT_ID,  // Specify the CLIENT_ID of the app that accesses the backend
         // Or, if multiple clients access the backend:
         //[CLIENT_ID_1, CLIENT_ID_2, 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' => $CLIENT_ID]);  // Specify the 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 CLIENT_ID of the app that accesses the backend:
       idinfo = id_token.verify_oauth2_token(token, requests.Request(), CLIENT_ID)
   
       # Or, if multiple clients access the backend server:
       # idinfo = id_token.verify_oauth2_token(token, requests.Request())
       # if idinfo['aud'] not in [CLIENT_ID_1, CLIENT_ID_2, 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.

   נקודת מפתח: אסימון המזהה מוחזר בשדה credential, במקום בשדה g_csrf_token.

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

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

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

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

נקודה חשובה: השתמשו רק בשדה אסימון מזהה של Google sub כמזהה של המשתמש, כי הוא ייחודי בכל חשבונות Google ואף פעם לא עושים בו שימוש חוזר. צריך לאחסן את השדה sub ולשייך אותו למשתמש במערכת לניהול החשבונות. אפשר להשתמש בכתובת האימייל מהאסימון המזהה כדי לבדוק אם למשתמש יש חשבון קיים, אבל לא להשתמש בכתובת אימייל כמזהה כי לחשבון Google יכולות להיות כמה כתובות אימייל בנקודות זמן שונות.