לקוח הכניסה בהקשה אחת מאחזר אסימון של מזהה Google כשהמשתמש בוחר חשבון Google. אסימון מזהה הוא הצהרה חתומה של זהות המשתמש, שמכילה גם את פרטי הפרופיל הבסיסיים של המשתמש, כולל כתובת אימייל שאומתה על ידי Google.
כשיש אסימונים מזהים, אפשר להשתמש בהם כדי לבצע אימות מאובטח בקצה העורפי של האפליקציה או כדי לרשום את המשתמש באופן אוטומטי לחשבון חדש, בלי לאמת את כתובת האימייל של המשתמש.
כדי להיכנס או לרשום משתמש באמצעות אסימון מזהה, צריך לשלוח את האסימון לקצה העורפי של האפליקציה. בצד העורפי, מאמתים את האסימון באמצעות ספריית לקוח של Google API או ספריית JWT לשימוש כללי. אם המשתמש לא נכנס לאפליקציה שלכם עם חשבון Google הזה בעבר, עליכם ליצור חשבון חדש.
אם בחרתם להשתמש ב-nonce כדי למנוע התקפות שליחה מחדש, השתמשו ב-getNonce כדי לשלוח אותו יחד עם האסימון המזהה לשרת הקצה העורפי, ולבדוק את הערך הצפוי. מומלץ מאוד להשתמש חד-פעמי (nonce) כדי לשפר את הבטיחות והאבטחה של המשתמשים.
קבלת אסימון מזהה מאובייקט פרטי הכניסה
אחרי שמאחזרים את פרטי הכניסה של משתמש, בודקים אם האובייקט של פרטי הכניסה כולל אסימון מזהה. אם כן, שלח אותו לקצה העורפי שלך.
Java
public class YourActivity extends AppCompatActivity { // ... private static final int REQ_ONE_TAP = 2; // Can be any integer unique to the Activity. private boolean showOneTapUI = true; // ... @Override protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) { super.onActivityResult(requestCode, resultCode, data); switch (requestCode) { case REQ_ONE_TAP: try { SignInCredential credential = oneTapClient.getSignInCredentialFromIntent(data); String idToken = credential.getGoogleIdToken(); if (idToken != null) { // Got an ID token from Google. Use it to authenticate // with your backend. Log.d(TAG, "Got ID token."); } } catch (ApiException e) { // ... } break; } } }
Kotlin
class YourActivity : AppCompatActivity() { // ... private val REQ_ONE_TAP = 2 // Can be any integer unique to the Activity private var showOneTapUI = true // ... override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) { super.onActivityResult(requestCode, resultCode, data) when (requestCode) { REQ_ONE_TAP -> { try { val credential = oneTapClient.getSignInCredentialFromIntent(data) val idToken = credential.googleIdToken when { idToken != null -> { // Got an ID token from Google. Use it to authenticate // with your backend. Log.d(TAG, "Got ID token.") } else -> { // Shouldn't happen. Log.d(TAG, "No ID token!") } } } catch (e: ApiException) { // ... } } } // ... }
אימות התקינות של האסימון המזהה
אחרי שמקבלים את האסימון המזהה באמצעות HTTPS POST, צריך לאמת את תקינות האסימון.
כדי לוודא שהאסימון חוקי, צריך לוודא את הפרטים הבאים קריטריונים:
- האסימון המזהה חתום כראוי על ידי 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, משתמשים באובייקט 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
באמצעות בדיקת שם הדומיין
שהוחזר על ידי method Payload.getHostedDomain()
. הדומיין שצוין
בתלונה ב-email
לא מספיק כדי להבטיח שהחשבון מנוהל על ידי דומיין
או ארגון.
כדי לאמת אסימון מזהה ב-Node.js, צריך להשתמש בספריית האימות של Google עבור 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, משתמשים בספריית הלקוח של 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, משתמשים בפונקציה 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
.
מתבצעת קריאה לנקודת הקצה של פרטי האסימון
דרך קלה לאמת חתימה של אסימון מזהה לצורך ניפוי באגים היא
להשתמש בנקודת הקצה 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 של המשתמש ותהיה לך אפשרות לבצע פעולות בשירות שלך כדי לאבטח את החשבונות.