التحقّق من الرمز المميّز لمعرّف Google على جهة الخادم

عند استخدام "خدمات هوية Google" أو مسار رمز التفويض في 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 إلى ملف تعريف الارتباط في العنوان ونص الطلب. في ما يلي مثال على طلب 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 المميز من ملف تعريف الارتباط 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، يمكنك التحقّق من مطالبة hd التي تشير إلى النطاق المستضاف للمستخدم. يجب استخدام هذا الخيار عند حصر الوصول إلى أحد الموارد على أعضاء نطاقات معيّنة فقط. يشير عدم توفّر هذا الادعاء إلى أنّ الحساب لا ينتمي إلى نطاق مستضاف على Google.

    باستخدام الحقول email وemail_verified وhd، يمكنك تحديد ما إذا كانت Google تستضيف عنوان بريد إلكتروني وتتحكّم فيه. في الحالات التي تكون فيها Google هي الجهة الموثوقة، يكون المستخدم هو مالك الحساب الشرعي، ويمكنك تخطّي كلمة المرور أو طرق التحقّق الأخرى.

    الحالات التي تكون فيها Google هي الجهة الموثوقة:

    • إذا كان عنوان البريد الإلكتروني ينتهي باللاحقة @gmail.com، فهذا يعني أنّه حساب Gmail.email
    • إذا كانت قيمة email_verified صحيحة وتم ضبط hd، يكون هذا حسابًا على Google Workspace.

    يمكن للمستخدمين التسجيل للحصول على حسابات Google بدون استخدام Gmail أو Google Workspace. عندما لا يحتوي email على لاحقة @gmail.com ولا يتوفّر hd، لا تكون Google هي الجهة الموثوقة، ويُنصح باستخدام كلمة المرور أو طرق أخرى للتحقّق من هوية المستخدم. يمكن أن يكون email_verified صحيحًا أيضًا لأنّ Google تحقّقت في البداية من هوية المستخدم عند إنشاء حساب 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. يؤكّد هذا الإجراء أنّ المستخدم لديه إذن بالوصول إلى الحساب الحالي.

    • مستخدم موحّد العِرف يعود إلى التطبيق: يمكنك تسجيل دخول المستخدم بدون أي إجراء من جانبه.