ربط حساب Google باستخدام OAuth

يتم ربط الحسابات باستخدام مسار رمز التفويض المتوافق مع معيار OAuth 2.0 المتّبع في المجال.

بروتوكول OAuth 2.1 وPKCE للوكلاء

بالنسبة إلى وكلاء الذكاء الاصطناعي غير الاحتفاظي الحالة ومسارات العرض المتعدّد، يُنصح بفرض استخدام OAuth 2.1.

  • مفتاح الحماية لتبادل الرموز (PKCE): يجب استخدامه لتأمين مسار رمز التفويض، ما يمنع هجمات الاعتراض.
  • بدون تدفق ضمني: يعرض التدفق الضمني رموز الدخول في عنوان URL، ما يشكّل خطرًا أمنيًا على بيئات الوكيل.

يجب أن تتيح خدمتك نقاط نهاية الترخيص وتبادل الرموز المميزة المتوافقة مع OAuth 2.0/2.1.

إنشاء المشروع

لإنشاء مشروعك لاستخدام ميزة ربط الحسابات، اتّبِع الخطوات التالية:

  1. انتقِل إلى وحدة التحكم في واجهة Google API.
  2. انقر على إنشاء مشروع.
  3. أدخِل اسمًا أو اقبل الاقتراح الذي تم إنشاؤه.
  4. أكِّد أي حقول متبقية أو عدِّلها.
  5. انقر على إنشاء.

للاطّلاع على رقم تعريف مشروعك، اتّبِع الخطوات التالية:

  1. انتقِل إلى وحدة التحكم في واجهة Google API.
  2. ابحث عن مشروعك في الجدول على الصفحة المقصودة. يظهر رقم تعريف المشروع في العمود المعرّف.

تتضمّن عملية ربط حساب Google شاشة طلب الموافقة التي تُطلع المستخدمين على التطبيق الذي يطلب الوصول إلى بياناتهم، ونوع البيانات التي يطلبها، والبنود السارية. عليك ضبط شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth قبل إنشاء معرّف عميل لواجهة Google API.

  1. افتح صفحة شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth في وحدة تحكّم Google APIs.
  2. إذا طُلب منك ذلك، اختَر المشروع الذي أنشأته للتو.

  3. في صفحة "شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth"، املأ النموذج وانقر على الزر "حفظ".

    اسم التطبيق: اسم التطبيق الذي يطلب الموافقة. يجب أن يوضّح الاسم تطبيقك بدقة وأن يكون متوافقًا مع اسم التطبيق الذي يظهر للمستخدمين في أماكن أخرى. سيظهر اسم التطبيق على شاشة طلب الموافقة على ربط الحساب.

    شعار التطبيق: صورة تظهر على شاشة طلب الموافقة وتساعد المستخدمين في التعرّف على تطبيقك. يظهر الشعار على شاشة طلب الموافقة على ربط الحساب وعلى إعدادات الحساب.

    عنوان البريد الإلكتروني المخصّص للدعم: يمكن للمستخدمين التواصل معك من خلاله لطرح أسئلة حول موافقتهم.

    نطاقات واجهات Google API: تتيح النطاقات لتطبيقك الوصول إلى بيانات المستخدم على Google الخاصة بالمستخدم. بالنسبة إلى حالة استخدام ربط حساب Google، يكون النطاق التلقائي (البريد الإلكتروني، والملف الشخصي، وopenid) كافيًا، ولا تحتاج إلى إضافة أي نطاقات حساسة. من أفضل الممارسات عمومًا طلب النطاقات بشكل تدريجي، عند الحاجة إلى إذن الوصول، بدلاً من طلبها مسبقًا. مزيد من المعلومات

    النطاقات المعتمَدة: لحمايتك وحماية المستخدمين، لا تسمح Google إلا للتطبيقات التي تتم مصادقتها باستخدام OAuth باستخدام النطاقات المعتمَدة. يجب أن تكون روابط تطبيقاتك مستضافة على نطاقات معتمَدة. مزيد من المعلومات

    رابط الصفحة الرئيسية للتطبيق: الصفحة الرئيسية لتطبيقك يجب أن تتم استضافته على نطاق معتمَد.

    رابط سياسة الخصوصية للتطبيق: يظهر على شاشة طلب الموافقة على ربط حساب Google. يجب أن تتم استضافته على نطاق معتمَد.

    رابط بنود خدمة التطبيق (اختياري): يجب أن تتم استضافته على نطاق معتمَد.

    الشكل 1 شاشة الموافقة على ربط حساب Google بتطبيق وهمي، Tunery

  4. تحقَّق من "حالة التحقّق"، وإذا كان طلبك بحاجة إلى التحقّق، انقر على الزر "إرسال طلب التحقّق" لإرسال طلبك. يُرجى الاطّلاع على متطلبات إثبات الأهلية في OAuth للحصول على التفاصيل.

تنفيذ خادم OAuth

OAuth 2.0 服务器的 授权代码流程实现包含两个端点，您的服务通过 HTTPS 提供这两个端点。第一个端点是授权端点，负责查找用户或征得用户同意以获取数据访问权限。授权端点会向尚未登录的用户显示登录界面，并记录用户对所请求访问权限的同意情况。第二个端点是令牌交换端点，用于获取加密字符串（称为令牌），这些令牌授权用户访问您的服务。

当 Google 应用需要调用您服务的某个 API 时，Google 会同时使用这些端点，以获取用户授权代表他们调用这些 API。

Google 账号关联：OAuth 授权代码流程

以下序列图详细介绍了用户、Google 和您服务的端点之间的交互。

用户 Google 应用 / 浏览器 Google 服务器 您的授权 端点 您的令牌 端点 1. 用户发起关联 2. 重定向到授权端点 (GET) client_id、redirect_uri、state、scope 3. 显示登录和同意界面 4. 用户进行身份验证并授予同意 5. 重定向回 Google (GET) code, state 6. 处理重定向并传递代码/状态 7. 令牌交换 (POST) grant_type=authorization_code、code 8. 返回令牌 (200 OK) access_token、refresh_token 9. 存储用户令牌 10. 访问用户资源
图 1.Google 账号关联的 OAuth 2.0 授权代码流程中的事件序列。

角色和职责

下表定义了 Google 账号关联 (GAL) OAuth 流程中参与者的角色和职责。请注意，在 GAL 中，Google 充当 OAuth 客户端 ，而您的服务充当 身份/服务提供方 。

参与者 / 组件 GAL 角色 职责
Google 应用 / 服务器 OAuth 客户端 发起流程，接收授权代码，将其交换为 令牌，并安全地存储这些令牌以访问您服务的 API。
您的授权端点 授权服务器 对用户进行身份验证，并征得用户同意与 Google 分享其数据访问权限。
您的令牌交换端点 授权服务器 验证授权代码和刷新令牌，并向 Google 服务器颁发访问 令牌。
Google 重定向 URI 回调端点 接收来自您的授权服务的用户重定向，其中包含 code 和 state 值。

由 Google 发起的 OAuth 2.0 授权代码流程会话具有以下流程：

  1. Google 在用户的浏览器中打开您的授权端点。如果流程是在仅支持语音的设备上为 Action 启动的，Google 会将执行转移到手机。
  2. 用户登录（如果尚未登录），并授予 Google 权限以使用您的 API 访问其数据（如果尚未授予权限）。
  3. 您的服务会创建 授权代码并将其返回给 Google。为此，请将用户的浏览器重定向回 Google，并将授权代码附加到请求中。
  4. Google 会将授权代码发送到您的令牌交换端点，该端点会验证代码的真实性并返回 访问令牌和 刷新令牌。访问令牌是一种短期令牌，您的服务会将其作为访问 API 的凭据。刷新令牌是一种长期令牌，Google 可以存储该令牌，并在访问令牌过期时使用它来获取新的访问令牌。
  5. 用户完成账号关联流程后，Google 发送的每个后续请求都包含访问令牌。

实现方案

请按照以下步骤实现授权代码流程。

第 1 步：处理授权请求

当 Google 发起账号关联时，它会将用户重定向到您的授权端点。如需了解详细的协议合同和参数要求，请参阅授权端点。

如需处理请求，请执行以下操作：

  1. 验证请求：

    • 确认 client_id 与分配给 Google 的客户端 ID 相匹配。
    • 确认 redirect_uri 与预期的 Google 重定向 网址： none https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID相匹配
    • 验证 response_type 是否为 code。

  2. 对用户进行身份验证：

    • 检查用户是否已登录您的服务。
    • 如果用户未登录，请提示他们完成您的登录或注册流程。

  3. 生成授权代码：

    • 创建与用户和客户端关联的唯一且难以猜测的授权代码。
    • 将代码设置为在约 10 分钟后过期。

  4. 重定向回 Google：

    • 将浏览器重定向到 redirect_uri 中提供的网址。
    • 附加以下查询参数：
      • code：您生成的授权代码。
      • state：从 Google 收到的未修改的状态值。

第 2 步：处理令牌交换请求

您的令牌交换端点会处理两种类型的请求：将代码交换为令牌，以及刷新过期的访问令牌。如需了解详细的协议合同和参数要求，请参阅令牌交换端点。

A. 将授权代码交换为令牌

当 Google 收到授权代码时，它会调用您的令牌交换端点 (POST) 以检索令牌。

  1. 验证请求：

    • 验证 client_id 和 client_secret。
    • 验证授权代码是否有效且未过期。
    • 确认 redirect_uri 与第 1 步中使用的值相匹配。
    • 如果验证失败，则返回 HTTP 400 Bad Request，并返回 {"error": "invalid_grant"}。

  2. 颁发令牌：

    • 生成长期有效的 refresh_token 和短期有效的 access_token（通常为 1 小时）。
    • 返回 HTTP 200 OK，并返回标准 JSON 令牌响应。

B. 刷新访问令牌

当访问令牌过期时，Google 会使用刷新令牌请求新的访问令牌。

  1. 验证请求：

    • 验证 client_id、client_secret 和 refresh_token。
    • 如果验证失败，则返回 HTTP 400 Bad Request，并返回 {"error": "invalid_grant"}。

  2. 颁发新的访问令牌：

    • 生成新的短期有效的 access_token。
    • 返回 HTTP 200 OK，并返回 JSON 令牌响应（可以选择包含新的刷新令牌）。
التعامل مع طلبات معلومات المستخدم

نقطة نهاية userinfo هي مورد OAuth 2.0 محمي يعرض مطالبات بشأن المستخدم المرتبط. يُعد تنفيذ نقطة نهاية userinfo واستضافتها اختياريًا، باستثناء حالات الاستخدام التالية:

بعد استرداد رمز الدخول بنجاح من نقطة نهاية الرمز المميّز، ترسل Google طلبًا إلى نقطة نهاية معلومات المستخدم لاسترداد معلومات الملف الشخصي الأساسية عن المستخدم المرتبط.

عناوين طلبات نقطة نهاية userinfo
Authorization header رمز الدخول من النوع "الحامل".

على سبيل المثال، إذا كانت نقطة نهاية userinfo متاحة على https://myservice.example.com/userinfo، قد يظهر الطلب على النحو التالي:

GET /userinfo HTTP/1.1
Host: myservice.example.com
Authorization: Bearer ACCESS_TOKEN

لتتمكّن نقطة نهاية معلومات المستخدم من معالجة الطلبات، عليك اتّباع الخطوات التالية:

  1. يمكنك استخراج رمز الدخول من عنوان التفويض ومعلومات الإرجاع للمستخدم المرتبط برمز الدخول.
  2. إذا كان رمز الدخول غير صالح، يمكنك عرض الخطأ HTTP 401 "غير مصرح به" مع استخدام عنوان الاستجابة WWW-Authenticate. في ما يلي مثال على استجابة خطأ في معلومات المستخدم: 
    HTTP/1.1 401 Unauthorized
WWW-Authenticate: error="invalid_token",
error_description="The Access Token expired"
    إذا تم عرض رسالة الخطأ 401 "غير مصرّح به" أو أي استجابة أخرى غير ناجحة للخطأ أثناء عملية الربط، لن تتمكّن من استرداد الخطأ، وسيتم تجاهل الرمز المميّز الذي تم استرداده وسيضطر المستخدم إلى بدء عملية الربط مرة أخرى.

  3. إذا كان رمز الدخول صالحًا، يتم عرض الاستجابة HTTP 200 مع كائن JSON التالي في نص HTTPS. الرد: 

    {
"sub": "USER_UUID",
"email": "EMAIL_ADDRESS",
"given_name": "FIRST_NAME",
"family_name": "LAST_NAME",
"name": "FULL_NAME",
"picture": "PROFILE_PICTURE",
}
     إذا عرضت نقطة نهاية معلومات المستخدم استجابة نجاح HTTP 200، يتم تسجيل الرمز المميز الذي تم استرداده والمطالبات مقابل حساب المستخدم على Google.

    استجابة نقطة نهاية لمعلومات المستخدم
    sub معرّف فريد يعرّف المستخدِم في نظامك.
    email عنوان البريد الإلكتروني للمستخدم.
    given_name اختياري: الاسم الأول للمستخدم.
    family_name اختياري: اسم العائلة للمستخدم.
    name اختياري: اسم المستخدم الكامل.
    picture اختياري: صورة الملف الشخصي للمستخدم.

التحقّق من صحة عملية التنفيذ

يمكنك التحقّق من صحة التنفيذ باستخدام أداة مساحة بروتوكول OAuth 2.0.

في الأداة، اتّبِع الخطوات التالية:

  1. انقر على الإعداد لفتح نافذة "إعدادات OAuth 2.0".
  2. في حقل مسار OAuth، اختَر من جهة العميل.
  3. في حقل نقاط نهاية OAuth، اختَر مخصّص.
  4. حدِّد نقطة نهاية OAuth 2.0 ومعرّف العميل الذي خصّصته لـ Google في الحقلَين المناسبَين.
  5. في قسم الخطوة 1، لا تحدّد أي نطاقات Google. بدلاً من ذلك، اترك هذا الحقل فارغًا أو اكتب نطاقًا صالحًا لخادمك (أو سلسلة عشوائية إذا كنت لا تستخدم نطاقات OAuth). عند الانتهاء، انقر على تفويض واجهات برمجة التطبيقات.
  6. في القسمَين الخطوة 2 والخطوة 3، اتّبِع مسار OAuth 2.0 وتأكَّد من أنّ كل خطوة تعمل على النحو المطلوب.

يمكنك التحقّق من صحة عملية التنفيذ باستخدام أداة عرض توضيحي لربط حساب Google.

في الأداة، اتّبِع الخطوات التالية:

  1. انقر على الزر تسجيل الدخول باستخدام حساب Google.
  2. اختَر الحساب الذي تريد ربطه.
  3. أدخِل رقم تعريف الخدمة.
  4. يمكنك اختياريًا إدخال نطاق واحد أو أكثر ستطلب الوصول إليه.
  5. انقر على بدء العرض التوضيحي.
  6. أكِّد أنّه يمكنك الموافقة على طلب ربط الحساب ورفضه عندما يُطلب منك ذلك.
  7. تأكَّد من إعادة توجيهك إلى منصتك.