अपने सर्वर साइड पर मौजूद Google आईडी टोकन की पुष्टि करें

Google Identity Services या OAuth 2.0 ऑथराइज़ेशन कोड फ़्लो का इस्तेमाल करते समय, Google, रीडायरेक्ट एंडपॉइंट को POST तरीके का इस्तेमाल करके आईडी टोकन भेजता है. इसके अलावा, ओआईडीसी इंप्लिसिट फ़्लो, GET अनुरोध का इस्तेमाल करता है. इसलिए, आपके ऐप्लिकेशन की यह ज़िम्मेदारी है कि वह मिले हुए इन क्रेडेंशियल को सुरक्षित तरीके से आपके सर्वर पर भेजे.

GET

यह इंप्लिसिट फ़्लो है. इसमें आईडी टोकन, यूआरएल फ़्रैगमेंट में वापस भेजा जाता है. इसे क्लाइंट-साइड JavaScript को पार्स करना होता है. आपका ऐप्लिकेशन, पुष्टि करने के अपने तरीके लागू करने के लिए ज़िम्मेदार है. इससे यह पक्का किया जा सकता है कि अनुरोध असली है और सीएसआरएफ़ जैसे हमलों को रोका जा सकता है. 

    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 को हेडर कुकी और अनुरोध के मुख्य हिस्से में अपने-आप जोड़ देती है. 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 की पुष्टि करना, ताकि किसी दूसरी साइट से किए गए फ़र्ज़ी अनुरोधों (सीएसआरएफ़) वाले हमलों को रोका जा सके:

    • g_csrf_token कुकी से CSRF टोकन की वैल्यू एक्सट्रैक्ट करें.
    • अनुरोध के मुख्य हिस्से से सीएसआरएफ़ टोकन की वैल्यू निकालें. GIS लाइब्रेरी, इस टोकन को POST अनुरोध के मुख्य हिस्से में पैरामीटर के तौर पर शामिल करती है. इसे g_csrf_token भी कहा जाता है.
    • दोनों टोकन वैल्यू की तुलना करें
      • अगर दोनों वैल्यू मौजूद हैं और पूरी तरह से मेल खाती हैं, तो अनुरोध को सही माना जाता है. साथ ही, यह माना जाता है कि अनुरोध आपके डोमेन से किया गया है.
      • अगर वैल्यू मौजूद नहीं हैं या मैच नहीं करती हैं, तो सर्वर को अनुरोध अस्वीकार करना होगा. इस जांच से यह पक्का किया जाता है कि अनुरोध, आपके डोमेन पर चल रहे JavaScript से शुरू किया गया था. ऐसा इसलिए, क्योंकि सिर्फ़ आपका डोमेन ही g_csrf_token कुकी को ऐक्सेस कर सकता है.

  2. आईडी टोकन की पुष्टि करें.

    यह पुष्टि करने के लिए कि टोकन मान्य है, पक्का करें कि ये शर्तें पूरी हों:

    • आईडी टोकन पर Google के सही तरीके से हस्ताक्षर किए गए हैं. टोकन के हस्ताक्षर की पुष्टि करने के लिए, Google की सार्वजनिक कुंजियों का इस्तेमाल करें. ये कुंजियां, JWK या PEM फ़ॉर्मैट में उपलब्ध हैं. इन कुंजियों को समय-समय पर बदला जाता है. जवाब में मौजूद Cache-Control हेडर की जांच करके यह पता लगाएं कि आपको इन्हें फिर से कब पाना चाहिए.
    • आईडी टोकन में मौजूद aud की वैल्यू, आपके ऐप्लिकेशन के किसी एक क्लाइंट आईडी के बराबर है. इस जांच से, किसी नुकसान पहुंचाने वाले ऐप्लिकेशन को जारी किए गए आईडी टोकन को आपके ऐप्लिकेशन के बैकएंड सर्वर पर मौजूद, उसी उपयोगकर्ता के डेटा को ऐक्सेस करने से रोका जा सकता है.
    • आईडी टोकन में मौजूद iss की वैल्यू, accounts.google.com या https://accounts.google.com के बराबर है.
    • आईडी टोकन के खत्म होने का समय (exp) अभी नहीं हुआ है.
    • अगर आपको यह पुष्टि करनी है कि आईडी टोकन, Google Workspace या Cloud Identity संगठन खाते को दिखाता है, तो hd दावा देखें. इससे उपयोगकर्ता के होस्ट किए गए डोमेन का पता चलता है. इसका इस्तेमाल तब किया जाना चाहिए, जब किसी संसाधन का ऐक्सेस सिर्फ़ कुछ डोमेन के सदस्यों तक सीमित करना हो. इस दावे के न होने का मतलब है कि खाता, Google के होस्ट किए गए डोमेन का नहीं है.

    email, email_verified, और hd फ़ील्ड का इस्तेमाल करके, यह पता लगाया जा सकता है कि Google किसी ईमेल पते को होस्ट करता है और उसके लिए आधिकारिक है या नहीं. ऐसे मामलों में जहां Google के पास पुष्टि करने का अधिकार है, वहां उपयोगकर्ता को खाते का असली मालिक माना जाता है. ऐसे में, आपको पासवर्ड या पुष्टि करने के अन्य तरीकों को आज़माने की ज़रूरत नहीं होती.

    ऐसे मामले जिनमें Google के पास आधिकारिक जानकारी होती है:

    • email में @gmail.com सफ़िक्स है, तो यह एक Gmail खाता है.
    • email_verified सही है और hd सेट है, तो यह Google Workspace खाता है.

    उपयोगकर्ता, Gmail या Google Workspace का इस्तेमाल किए बिना Google खातों के लिए रजिस्टर कर सकते हैं. जब email में @gmail.com सफ़िक्स नहीं होता है और hd मौजूद नहीं होता है, तो Google भरोसेमंद नहीं होता है. ऐसे में, उपयोगकर्ता की पुष्टि करने के लिए पासवर्ड या चुनौती के अन्य तरीकों का इस्तेमाल करने का सुझाव दिया जाता है. email_verified की वैल्यू सही भी हो सकती है, क्योंकि Google ने खाता बनाते समय उपयोगकर्ता की पुष्टि की थी. हालांकि, तीसरे पक्ष के ईमेल खाते का मालिकाना हक तब से बदल गया हो सकता है.

    हमारा सुझाव है कि पुष्टि करने के इन चरणों को पूरा करने के लिए, खुद कोड लिखने के बजाय, अपने प्लैटफ़ॉर्म के लिए Google API क्लाइंट लाइब्रेरी या सामान्य तौर पर इस्तेमाल होने वाली JWT लाइब्रेरी का इस्तेमाल करें. डेवलपमेंट और डीबग करने के लिए, tokeninfo पुष्टि करने वाले एंडपॉइंट को कॉल किया जा सकता है.

    Using a Google API Client Library

    Using one of the Google API Client Libraries (e.g. Java, Node.js, PHP, Python) is the recommended way to validate Google ID tokens in a production environment.

    Java

    To validate an ID token in Java, use the GoogleIdTokenVerifier object. For example:

    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.");
}

    The GoogleIdTokenVerifier.verify() method verifies the JWT signature, the aud claim, the iss claim, and the exp claim.

    If you need to validate that the ID token represents a Google Workspace or Cloud organization account, you can verify the hd claim by checking the domain name returned by the Payload.getHostedDomain() method. The domain of the email claim is insufficient to ensure that the account is managed by a domain or organization.

    Node.js

    To validate an ID token in Node.js, use the Google Auth Library for Node.js. Install the library: 

    npm install google-auth-library --save
     Then, call the verifyIdToken() function. For example:

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

    The verifyIdToken function verifies the JWT signature, the aud claim, the exp claim, and the iss claim.

    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.

    PHP

    To validate an ID token in PHP, use the Google API Client Library for PHP. Install the library (for example, using Composer): 

    composer require google/apiclient
     Then, call the verifyIdToken() function. For example:

    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
}

    The verifyIdToken function verifies the JWT signature, the aud claim, the exp claim, and the iss claim.

    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.

    Python

    To validate an ID token in Python, use the verify_oauth2_token function. For example:

    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

    The verify_oauth2_token function verifies the JWT signature, the aud claim, and the exp claim. You must also verify the hd claim (if applicable) by examining the object that verify_oauth2_token returns. If multiple clients access the backend server, also manually verify the aud claim.

  3. टोकन की पुष्टि हो जाने के बाद, अपनी साइट के खाते की स्थिति का पता लगाने के लिए, Google आईडी टोकन में मौजूद जानकारी का इस्तेमाल किया जा सकता है:

    • बिना रजिस्टर किया गया उपयोगकर्ता: आपके पास साइन-अप यूज़र इंटरफ़ेस (यूआई) दिखाने का विकल्प होता है. इससे उपयोगकर्ता, ज़रूरत पड़ने पर प्रोफ़ाइल की ज़्यादा जानकारी दे सकता है. इससे उपयोगकर्ता को नया खाता और लॉग-इन किए गए उपयोगकर्ता का सेशन साइलेंट मोड में बनाने की अनुमति भी मिलती है.

    • आपकी साइट पर पहले से मौजूद खाता: आपके पास ऐसा वेब पेज दिखाने का विकल्प होता है जिस पर उपयोगकर्ता अपना पासवर्ड डाल सके. साथ ही, लेगसी खाते को अपने Google क्रेडेंशियल से लिंक कर सके. इससे यह पुष्टि होती है कि उपयोगकर्ता के पास मौजूदा खाते का ऐक्सेस है.

    • फ़ेडरेट किया गया कोई ऐसा उपयोगकर्ता जो पहले भी साइन इन कर चुका है: इस उपयोगकर्ता को बिना किसी प्रॉम्प्ट के साइन इन किया जा सकता है.