تنفيذ خادم OAuth 2.0

يجب أن يتضمّن كل تكامل مع Cloud-to-cloud آلية لمصادقة المستخدمين.

تتيح لك المصادقة ربط حسابات المستخدمين على Google بحسابات المستخدمين في نظام المصادقة. يتيح لك ذلك تحديد المستخدمين عندما يتلقّى التنفيذ طلبًا من المنزل الذكي. لا تتوافق ميزة "المنزل الذكي من Google" إلا مع بروتوكول OAuth الذي يتضمّن مسار رمز المصادقة.

توضّح هذه الصفحة كيفية إعداد خادم OAuth 2.0 لكي يعمل مع عملية دمج Cloud-to-cloud.

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

In the authorization code flow, you need two endpoints:

• The authorization endpoint, which presents the sign-in UI to your users that aren't already signed in. The authorization endpoint also creates a short-lived authorization code to record users' consent to the requested access.

• The token exchange endpoint, which is responsible for two types of exchanges:

  1. Exchanges an authorization code for a long-lived refresh token and a short-lived access token. This exchange happens when the user goes through the account linking flow.
  2. Exchanges a long-lived refresh token for a short-lived access token. This exchange happens when Google needs a new access token because the one it had expired.

Design guidelines

This section describes the design requirements and recommendations for the user screen that you host for OAuth linking flows. After it's called by Google's app, your platform displays a sign in to Google page and account linking consent screen to the user. The user is directed back to Google's app after giving their consent to link accounts.

Requirements

1. You must communicate that the user’s account will be linked to Google, not a specific Google product like Google Home or Google Assistant.
2. You must have a Google authorization statement such as "By signing in, you are authorizing Google to control your devices." See the Google Device Control Authorization section of the Google Home Developer Policies.
3. You must open the Web OAuth linking page and ensure users have a clear method for signing in to their Google Account, such as fields for their username and password. Don't use the Google Sign-In (GSI) method that enables users to link without being taken to the Web OAuth Linking page. It is a violation of Google policy.
4. You must include at least one of the following items in the OAuth linking page to indicate the integration to which the user is linking:
   • Company logo
   • Company name
   • Integration name
   • App icon

Recommendations

We recommend that you do the following:

1. Display Google's Privacy Policy. Include a link to Google’s Privacy Policy on the consent screen.

2. Data to be shared. Use clear and concise language to tell the user what data of theirs Google requires and why.

3. Clear call-to-action. State a clear call-to-action on your consent screen, such as “Agree and link.” This is because users need to understand what data they're required to share with Google to link their accounts.

4. Ability to cancel. Provide a way for users to go back or cancel, if they choose not to link.

5. Clear sign-in process. Ensure that users have a clear method for signing in to their Google Account, such as fields for their username and password or Sign in with Google.

6. Ability to unlink. Offer a mechanism for users to unlink, such as a URL to their account settings on your platform. Alternatively, you can include a link to Google Account where users can manage their linked account.

7. Ability to change user account. Suggest a method for users to switch their account(s). This is especially beneficial if users tend to have multiple accounts.

   • If a user must close the consent screen to switch accounts, send a recoverable error to Google so the user can sign in to the desired account with OAuth linking.

8. Include your logo. Display your company logo on the consent screen. Use your style guidelines to place your logo. If you wish to also display Google's logo, see Logos and trademarks.

مسار رمز التفويض

يتضمّن تنفيذ خادم OAuth 2.0 لمسار رمز التفويض نقطتَي نهاية، وتوفّر خدمتك هاتين النقطتين من خلال HTTPS. نقطة النهاية الأولى هي نقطة نهاية التفويض، وهي المسؤولة عن العثور على موافقة المستخدمين أو الحصول عليها للوصول إلى البيانات. تعرض نقطة نهاية التفويض واجهة مستخدم لتسجيل الدخول للمستخدمين الذين لم يسجّلوا الدخول بعد، وتسجّل الموافقة على إذن الوصول المطلوب. نقطة النهاية الثانية هي نقطة نهاية تبادل الرموز المميزة، والتي تُستخدَم للحصول على سلاسل مشفّرة، تُعرف باسم الرموز المميزة، وتسمح للمستخدم بالوصول إلى خدمتك.

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

تتضمّن جلسة مسار رمز التفويض في OAuth 2.0 التي بدأتها Google الخطوات التالية:

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

التعامل مع طلبات التفويض

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

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

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&scope=REQUESTED_SCOPES&response_type=code

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

1. تأكَّد من أنّ client_id يطابق معرّف العميل الذي خصّصته لـ Google، وأنّ redirect_uri يطابق عنوان URL لإعادة التوجيه الذي قدّمته Google لخدمتك. عمليات التحقّق هذه مهمة لمنع منح إذن الوصول إلى تطبيقات عميل غير مقصودة أو تم إعدادها بشكل غير صحيح. إذا كنت تتيح مسارات متعددة لبروتوكول OAuth 2.0، عليك أيضًا التأكّد من أنّ قيمة response_type هي code.
2. تحقَّق مما إذا كان المستخدم قد سجّل الدخول إلى خدمتك. إذا لم يكن المستخدم مسجّلاً الدخول، أكمِل خطوات تسجيل الدخول أو الاشتراك في خدمتك.
3. أنشئ رمز تفويض لتستخدمه Google للوصول إلى واجهة برمجة التطبيقات. يمكن أن يكون رمز التفويض أي قيمة سلسلة، ولكن يجب أن يمثّل بشكل فريد المستخدم والعميل الذي تم إصدار الرمز المميز له ووقت انتهاء صلاحية الرمز، ويجب ألا يكون قابلاً للتخمين. عادةً ما تصدر رموز تفويض تنتهي صلاحيتها بعد 10 دقائق تقريبًا.
4. تأكَّد من أنّ عنوان URL الذي تحدّده المَعلمة redirect_uri يتّخذ الشكل التالي:

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
     https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
     

5. إعادة توجيه متصفّح المستخدم إلى عنوان URL المحدّد بواسطة المَعلمة redirect_uri. أدرِج رمز التفويض الذي أنشأته للتو وقيمة الحالة الأصلية غير المعدّلة عند إعادة التوجيه من خلال إلحاق المَعلمتَين code وstate. في ما يلي مثال على عنوان URL الناتج:

   https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING

التعامل مع طلبات تبديل الرموز المميّزة

تتولّى نقطة نهاية تبادل الرموز المميّزة في خدمتك مسؤولية نوعَين من عمليات تبادل الرموز المميّزة:

• استبدال رموز التفويض برموز الدخول ورموز إعادة التحميل
• استبدال رموز إعادة التحميل برموز الدخول

تتضمّن طلبات استبدال الرموز المميّزة المَعلمات التالية:

ضبط طريقة إرسال Google لبيانات الاعتماد إلى الخادم

استنادًا إلى طريقة التنفيذ، يتوقّع خادم التفويض تلقّي بيانات اعتماد العميل إما في نص الطلب أو في عنوان الطلب.

ترسل Google بيانات الاعتماد في نص الطلب تلقائيًا. إذا كان خادم التفويض يتطلّب أن تكون بيانات اعتماد العميل في عنوان الطلب، عليك ضبط عملية الدمج Cloud-to-cloud وفقًا لذلك:

الانتقال إلى Developer Console

1. من قائمة المشاريع، انقر على فتح بجانب المشروع الذي تريد العمل عليه.

2. ضمن نقل البيانات من السحابة الإلكترونية إلى السحابة الإلكترونية، اختَر تطوير.

3. انقر على فتح بجانب عملية الدمج.

4. انتقِل إلى قسم الأذونات (اختياري)، ثم ضَع علامة في المربّع إرسال Google لمعرّف العميل والمفتاح السري عبر عنوان المصادقة الأساسية لبروتوكول HTTP.

5. انقر على حفظ لحفظ التغييرات.

تبديل رموز التفويض برموز الدخول ورموز إعادة التحميل

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

بالنسبة إلى هذه الطلبات، تكون قيمة grant_type هي authorization_code، وتكون قيمة code هي قيمة رمز التفويض الذي سبق أن منحته إلى Google. في ما يلي مثال على طلب تبديل رمز تفويض برمز دخول ورمز مميز لإعادة التحميل:

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=authorization_code&code=AUTHORIZATION_CODE&redirect_uri=REDIRECT_URI

لتبديل رموز التفويض برمز دخول مميّز ورمز إعادة تحميل، تستجيب نقطة نهاية تبادل الرموز المميزة لطلبات POST من خلال تنفيذ الخطوات التالية:

1. تأكَّد من أنّ client_id يحدّد مصدر الطلب كمصدر معتمَد، وأنّ client_secret يتطابق مع القيمة المتوقّعة.
2. تأكَّد من أنّ رمز التفويض صالح ولم تنتهِ صلاحيته، وأنّ معرّف العميل المحدّد في الطلب يتطابق مع معرّف العميل المرتبط برمز التفويض.
3. تأكَّد من أنّ عنوان URL الذي تحدّده المَعلمة redirect_uri مطابق للقيمة المستخدَمة في طلب التفويض الأوّلي.
4. إذا تعذّر عليك إثبات صحة كل المعايير المذكورة أعلاه، عليك عرض الخطأ HTTP 400 Bad Request مع {"error": "invalid_grant"} كنص أساسي.
5. في ما عدا ذلك، استخدِم رقم تعريف المستخدم من رمز التفويض لإنشاء رمز مميّز لإعادة التحميل ورمز مميّز للدخول. يمكن أن تكون هذه الرموز المميّزة أي قيمة سلسلة، ولكن يجب أن تمثّل المستخدم والعميل اللذين تم إصدار الرمز المميّز لهما بشكل فريد، ويجب ألا يكون من السهل تخمينها. بالنسبة إلى رموز الدخول، سجِّل أيضًا وقت انتهاء صلاحية الرمز، والذي يكون عادةً بعد ساعة من إصدار الرمز. لا تنتهي صلاحية رموز إعادة التحميل.
6. أدرِج عنصر JSON التالي في نص استجابة HTTPS:

   {
   "token_type": "Bearer",
   "access_token": "ACCESS_TOKEN",
   "refresh_token": "REFRESH_TOKEN",
   "expires_in": SECONDS_TO_EXPIRATION
   }

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

استبدال رموز إعادة التحميل برموز الدخول

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

بالنسبة إلى هذه الطلبات، تكون قيمة grant_type هي refresh_token، وتكون قيمة refresh_token هي قيمة الرمز المميز لإعادة التحميل الذي سبق أن منحته إلى Google. في ما يلي مثال على طلب استبدال رمز مميز لإعادة التحميل برمز مميز للدخول:

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=refresh_token&refresh_token=REFRESH_TOKEN

لاستبدال رمز مميّز لإعادة التحميل برمز دخول مميّز، يجب أن يستجيب نقطة نهاية استبدال الرمز المميز لطلبات POST من خلال تنفيذ الخطوات التالية:

1. تأكَّد من أنّ client_id يحدّد مصدر الطلب على أنّه Google، ومن أنّ client_secret يتطابق مع القيمة المتوقّعة.
2. تأكَّد من أنّ رمز التحديث صالح، وأنّ معرّف العميل المحدّد في الطلب يتطابق مع معرّف العميل المرتبط برمز التحديث.
3. إذا تعذّر عليك إثبات صحة كل المعايير المذكورة أعلاه، عليك عرض الخطأ HTTP 400 Bad Request مع {"error": "invalid_grant"} كنص أساسي.
4. في ما عدا ذلك، استخدِم رقم تعريف المستخدم من الرمز المميز لإعادة التحميل لإنشاء رمز دخول. يمكن أن تكون هذه الرموز المميزة أي قيمة سلسلة، ولكن يجب أن تمثّل المستخدم والعميل اللذين تم إصدار الرمز المميز لهما بشكل فريد، ويجب ألا يمكن تخمينها. بالنسبة إلى رموز الدخول، سجِّل أيضًا وقت انتهاء صلاحية الرمز، والذي يبلغ عادةً ساعة واحدة بعد إصدار الرمز.
5. أدرِج عنصر JSON التالي في نص استجابة HTTPS:

   {
   "token_type": "Bearer",
   "access_token": "ACCESS_TOKEN",
   "expires_in": SECONDS_TO_EXPIRATION
   }

Handle userinfo requests

The userinfo endpoint is an OAuth 2.0 protected resource that return claims about the linked user. Implementing and hosting the userinfo endpoint is optional, except for the following use cases:

• Linked Account Sign-In with Google One Tap.
• Frictionless subscription on AndroidTV.

After the access token has been successfully retrieved from your token endpoint, Google sends a request to your userinfo endpoint to retrieve basic profile information about the linked user.

For example, if your userinfo endpoint is available at https://myservice.example.com/userinfo, a request might look like the following:

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

For your userinfo endpoint to handle requests, do the following steps:

1. Extract access token from the Authorization header and return information for the user associated with the access token.
2. If the access token is invalid, return an HTTP 401 Unauthorized error with using the WWW-Authenticate Response Header. Below is an example of a userinfo error response:

   HTTP/1.1 401 Unauthorized
   WWW-Authenticate: error="invalid_token",
   error_description="The Access Token expired"
   

   If a 401 Unauthorized, or any other unsuccessful error response is returned during the linking process, the error will be non-recoverable, the retrieved token will be discarded and the user will have to initiate the linking process again.

3. If the access token is valid, return and HTTP 200 response with the following JSON object in the body of the HTTPS response:

   {
   "sub": "USER_UUID",
   "email": "EMAIL_ADDRESS",
   "given_name": "FIRST_NAME",
   "family_name": "LAST_NAME",
   "name": "FULL_NAME",
   "picture": "PROFILE_PICTURE",
   }

   If your userinfo endpoint returns an HTTP 200 success response, the retrieved token and claims are registered against the user's Google account.

   userinfo endpoint response
   sub	A unique ID that identifies the user in your system.
   email	Email address of the user.
   given_name	Optional: First name of the user.
   family_name	Optional: Last name of the user.
   name	Optional: Full name of the user.
   picture	Optional: Profile picture of the user.