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

כשמשתמשים ב-Google Identity Services או בתהליך קוד ההרשאה של OAuth 2.0, ‏ Google מחזירה את אסימון הזהות באמצעות שיטת POST לנקודת הקצה של ההפניה האוטומטית. לחלופין, בתהליך המשתמע של OIDC נעשה שימוש בבקשת GET. לכן, האפליקציה שלכם אחראית להעביר את פרטי הכניסה האלה לשרת בצורה מאובטחת.

GET

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

    HTTP/1.1 302 Found
    Location: https://<REDIRECT_URI>#access_token=<ACCESS_TOKEN>&token_type=bearer&expires_in=<TIME_IN_SECONDS>&scope=<SCOPE>&state=<STATE_STRING>
POST

טוקן המזהה נשלח חזרה כשדה credential. בזמן ההכנה לשליחת האסימון המזהה לשרת, ספריית GIS מוסיפה באופן אוטומטי את g_csrf_token לקובץ ה-Cookie של הכותרת ולגוף הבקשה. דוגמה לבקשת POST:

POST /auth/token-verification HTTP/1.1
Host: example.com
Content-Type: application/json;charset=UTF-8
Cookie: g_csrf_token=<CSRF_TOKEN>
Origin: https://example.com
Content-Length: <LENGTH_OF_JSON_BODY>
    {
      "credential": "<ID_TOKEN>",
      "g_csrf_token": "<CSRF_TOKEN>",
      "client_id": "<CLIENT_ID>"
    }

  1. אימות של g_csrf_token כדי למנוע מתקפות של זיוף בקשות חוצה-אתרים (CSRF):

    • מחפשים את הערך של אסימון ה-CSRF בקובץ ה-Cookie‏ g_csrf_token.
    • מחפשים את הערך של אסימון ה-CSRF בגוף הבקשה. ספריית GIS כוללת את האסימון הזה בגוף בקשת ה-POST כפרמטר, שנקרא גם g_csrf_token.
    • השוואה בין שני ערכי טוקן
      • אם שני הערכים קיימים ותואמים לחלוטין, הבקשה נחשבת ללגיטימית ומקורה בדומיין שלכם.
      • אם הערכים לא קיימים או לא תואמים, השרת צריך לדחות את הבקשה. בבדיקה הזו מוודאים שהבקשה נוצרה מ-JavaScript שפועל בדומיין שלכם, כי רק לדומיין שלכם יש גישה לקובץ ה-Cookie‏ g_csrf_token.

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

    如需验证令牌是否有效，请确保满足以下条件：

    • ID 令牌已由 Google 正确签名。使用 Google 的公钥（以 JWK 或 PEM 格式提供）验证令牌的签名。这些密钥会定期轮换；请检查响应中的 Cache-Control 标头，以确定何时应再次检索这些密钥。
    • ID 令牌中的 aud 值等于您应用的某个客户端 ID。此检查是必要的，可防止向恶意应用发放的 ID 令牌被用于访问您应用后端服务器上有关同一用户的数据。
    • ID 令牌中 iss 的值等于 accounts.google.com 或 https://accounts.google.com。
    • ID 令牌的到期时间 (exp) 尚未到期。
    • 如果您需要验证 ID 令牌是否代表 Google Workspace 或 Cloud 组织账号，可以检查 hd 声明，该声明表示用户的托管网域。如果需要将对资源的访问权限限制为仅限特定网域的成员，则必须使用此方法。如果缺少此声明，则表示相应账号不属于 Google 托管网域。

    通过使用 email、email_verified 和 hd 字段，您可以确定 Google 是否托管某个电子邮件地址并对其具有权威性。如果 Google 是权威方，则表示用户是合法的账号所有者，您可以跳过密码或其他身份验证方法。

    Google 具有权威性的情况：

    • email 带有 @gmail.com 后缀，则表示这是 Gmail 账号。
    • email_verified 为 true 且设置了 hd，则为 Google Workspace 账号。

    用户可以注册 Google 账号，而无需使用 Gmail 或 Google Workspace。如果 email 不包含 @gmail.com 后缀且 hd 不存在，则 Google 不具有权威性，建议使用密码或其他质询方法来验证用户身份。email_verified 也可能为 true，因为 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. 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.");
}

    השיטה 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();
  // 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);

    הפונקציה 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) {
  // 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
}

    הפונקציה 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.
    # 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

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

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

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

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

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