אימות באמצעות קצה עורפי באמצעות אסימונים מזהים

לקוח הכניסה בהקשה אחת מאחזרת אסימון מזהה של 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, צריך לאמת את התקינות של האסימון.

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.

Using the email, email_verified and hd fields, you can determine if Google hosts and is authoritative for an email address. In the cases where Google is authoritative, the user is known to be the legitimate account owner, and you may skip password or other challenge methods.

Cases where Google is authoritative:

  • email has a @gmail.com suffix, this is a Gmail account.
  • email_verified is true and hd is set, this is a G Suite account.

Users may register for Google Accounts without using Gmail or G Suite. When email does not contain a @gmail.com suffix and hd is absent, Google is not authoritative and password or other challenge methods are recommended to verify the user. email_verified can also be true as Google initially verified the user when the Google account was created, however ownership of the third party email account may have since changed.

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 על ידי בדיקת שם הדומיין שהוחזרו באמצעות השיטה 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.

קריאה לנקודת הקצה של Tokeninfo

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