אימות באמצעות שרת קצה עורפי

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

שליחת האסימון המזהה לשרת שלכם

אחרי שמשתמש נכנס בהצלחה, מקבלים את האסימון המזהה של המשתמש:

function onSignIn(googleUser) {
  var id_token = googleUser.getAuthResponse().id_token;
  ...
}

לאחר מכן, שולחים את האסימון המזהה לשרת באמצעות בקשת HTTPS POST:

var xhr = new XMLHttpRequest();
xhr.open('POST', 'https://yourbackend.example.com/tokensignin');
xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
xhr.onload = function() {
  console.log('Signed in as: ' + xhr.responseText);
};
xhr.send('idtoken=' + id_token);

אימות התקינות של האסימון המזהה

אחרי שהאסימון המזהה מתקבל באמצעות HTTPS POST, צריך לאמת את תקינות האסימון.

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.

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 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

כדי לאמת אסימון מזהה ב-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

כדי לאמת אסימון מזהה ב-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.

Calling the tokeninfo endpoint

An easy way to validate an ID token signature for debugging is to use the tokeninfo endpoint. Calling this endpoint involves an additional network request that does most of the validation for you while you test proper validation and payload extraction in your own code. It is not suitable for use in production code as requests may be throttled or otherwise subject to intermittent errors.

To validate an ID token using the tokeninfo endpoint, make an HTTPS POST or GET request to the endpoint, and pass your ID token in the id_token parameter. For example, to validate the token "XYZ123", make the following GET request:

https://oauth2.googleapis.com/tokeninfo?id_token=XYZ123

If the token is properly signed and the iss and exp claims have the expected values, you will get a HTTP 200 response, where the body contains the JSON-formatted ID token claims. Here's an example response:

{
 // 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"
}

If you need to validate that the ID token represents a Google Workspace 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 Workspace hosted domain.

יצירת חשבון או סשן

אחרי אימות האסימון, צריך לבדוק אם המשתמש כבר נמצא במסד הנתונים של המשתמשים. במקרה כזה, יש ליצור סשן מאומת עבור המשתמש. אם המשתמש עדיין לא נמצא במסד הנתונים של המשתמשים, צריך ליצור רשומת משתמש חדשה מהמידע שבמטען הייעודי (payload) של אסימון המזהה וליצור סשן למשתמש הזה. כשמאתרים משתמש חדש שנוצר באפליקציה, אפשר לבקש מהמשתמש את כל פרטי הפרופיל הנוספים הנדרשים.

אבטחת חשבונות המשתמשים באמצעות הגנה על חשבונות שונים

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