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

אזהרה: בקרוב נוציא משימוש את התכונה 'הקשה אחת' ל-Android. כדי לשמור על האבטחה ועל נוחות השימוש של האפליקציה, צריך לעבור עוד היום ל-Credential Manager. במנהל פרטי הכניסה יש תמיכה במפתחות גישה, בסיסמה ובאימות זהות (Federated) (כמו כניסה באמצעות חשבון Google), אבטחה חזקה יותר וחוויית משתמש עקבית יותר.

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

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

מתבצעת קריאה לנקודת הקצה של פרטי האסימון

דרך קלה לאמת חתימה של אסימון מזהה לצורך ניפוי באגים היא להשתמש בנקודת הקצה 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": "[e-mail]",
 "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"
}

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

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

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

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

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

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