نوع پیوند «کارآمد» ورود به سیستم Google مبتنی بر OAuth، ورود به سیستم Google را به پیوند حساب مبتنی بر OAuth اضافه می کند. این پیوند بدون درز مبتنی بر صدا را برای کاربران Google فراهم میکند و همچنین پیوند حساب را برای کاربرانی که با هویت غیر Google در سرویس شما ثبتنام کردهاند، امکانپذیر میکند.
این نوع پیوند با Google Sign-In شروع می شود، که به شما امکان می دهد بررسی کنید که آیا اطلاعات نمایه Google کاربر در سیستم شما وجود دارد یا خیر. اگر اطلاعات کاربر در سیستم شما یافت نشد، یک جریان استاندارد OAuth شروع می شود. کاربر همچنین می تواند انتخاب کند که یک حساب کاربری جدید با اطلاعات نمایه Google خود ایجاد کند.
![](https://developers.google.cn/static/assistant/identity/images/gsi-oauth-flow.png?authuser=2&hl=fa)
برای انجام پیوند حساب با نوع پیوند ساده، این مراحل کلی را دنبال کنید:
- ابتدا از کاربر بخواهید که رضایت خود را برای دسترسی به نمایه Google خود اعلام کند.
- از اطلاعات موجود در پروفایل خود برای شناسایی کاربر استفاده کنید.
- اگر نتوانستید مطابق با کاربر Google در سیستم احراز هویت خود پیدا کنید، جریان بسته به اینکه پروژه Actions خود را در کنسول Actions پیکربندی کرده باشید تا اجازه ایجاد حساب کاربری از طریق صدا یا فقط در وب سایت خود را بدهد، ادامه می یابد.
- اگر اجازه ایجاد حساب از طریق صدا را میدهید، رمز شناسه دریافتی از Google را تأیید کنید. سپس می توانید یک کاربر بر اساس اطلاعات نمایه موجود در رمز شناسه ایجاد کنید.
- اگر اجازه ایجاد حساب از طریق صدا را ندهید، کاربر به مرورگری منتقل میشود تا بتواند صفحه مجوز شما را بارگیری کند و جریان ایجاد کاربر را تکمیل کند.
![اگر اجازه ایجاد حساب از طریق صدا را میدهید و نمیتوانید مطابق با نمایه Google در سیستم احراز هویت خود پیدا کنید، باید شناسه دریافتی از Google را تأیید کنید. سپس می توانید یک کاربر بر اساس اطلاعات نمایه موجود در رمز شناسه ایجاد کنید. اگر اجازه ایجاد حساب کاربری از طریق صدا را ندهید، کاربر به مرورگری منتقل میشود تا بتواند صفحه مجوز شما را بارگیری کند و جریان را تکمیل کند.](https://developers.google.cn/static/assistant/identity/images/gsi-oauth-flow-creation.png?authuser=2&hl=fa)
از ایجاد حساب کاربری از طریق صدا پشتیبانی کنید
اگر اجازه ایجاد حساب کاربری از طریق صدا را بدهید، دستیار از کاربر میپرسد که آیا میخواهد کارهای زیر را انجام دهد:
- یک حساب کاربری جدید در سیستم خود با استفاده از اطلاعات حساب Google آنها ایجاد کنید، یا
- اگر آنها یک حساب غیر Google موجود دارند، با حساب دیگری وارد سیستم احراز هویت خود شوید.
اگر میخواهید اصطکاک جریان ایجاد حساب را به حداقل برسانید، اجازه ایجاد حساب از طریق صدا توصیه میشود. کاربر فقط در صورتی باید جریان صدا را ترک کند که بخواهد با استفاده از یک حساب موجود غیر Google وارد سیستم شود.
ایجاد حساب از طریق صدا را ممنوع کنید
اگر ایجاد حساب کاربری از طریق صوتی را ممنوع کرده باشید، «دستیار» نشانی وب سایتی را که برای احراز هویت کاربر ارائه کردهاید باز میکند. اگر تعامل در دستگاهی انجام میشود که صفحهنمایش ندارد، «دستیار» کاربر را به تلفنی هدایت میکند تا جریان پیوند حساب را ادامه دهد.
عدم اجازه ایجاد توصیه می شود اگر:
شما نمیخواهید به کاربرانی که دارای حسابهای غیر Google هستند اجازه ایجاد یک حساب کاربری جدید بدهید و میخواهید در عوض به حسابهای کاربری موجود خود در سیستم احراز هویت شما پیوند دهند. برای مثال، اگر یک برنامه وفاداری ارائه میدهید، ممکن است بخواهید مطمئن شوید که کاربر امتیازهای جمعشده در حساب موجود خود را از دست نمیدهد.
شما باید کنترل کامل جریان ایجاد حساب را داشته باشید. به عنوان مثال، اگر نیاز دارید شرایط خدمات خود را در حین ایجاد حساب به کاربر نشان دهید، می توانید ایجاد را ممنوع کنید.
پیوند "کارآمد" ورود به سیستم Google مبتنی بر OAuth را پیاده سازی کنید
حسابها با جریانهای استاندارد صنعتی OAuth 2.0 مرتبط هستند. Actions on Google از جریان کد ضمنی و مجوز پشتیبانی می کند.
در جریان کد ضمنی، Google نقطه پایانی مجوز شما را در مرورگر کاربر باز میکند. پس از ورود موفقیت آمیز به سیستم، یک توکن دسترسی طولانی مدت به Google برمی گردانید. این نشانه دسترسی اکنون در هر درخواست ارسال شده از دستیار به Action شما گنجانده شده است.
در جریان کد مجوز، به دو نقطه پایانی نیاز دارید:
- نقطه پایانی مجوز ، که مسئول ارائه رابط کاربری ورود به سیستم به کاربرانی است که قبلاً وارد سیستم نشدهاند و رضایت دسترسی درخواستی را در قالب یک کد مجوز کوتاه مدت ثبت میکند.
- نقطه پایانی تبادل توکن ، که مسئول دو نوع مبادله است:
- یک کد مجوز را برای یک نشانه رفرش طولانی مدت و یک رمز دسترسی کوتاه مدت مبادله می کند. این تبادل زمانی اتفاق میافتد که کاربر از جریان پیوند حساب عبور کند.
- یک نشانه رفرش طولانی مدت را با یک توکن دسترسی کوتاه مدت مبادله می کند. این مبادله زمانی اتفاق میافتد که گوگل به یک توکن دسترسی جدید نیاز دارد، زیرا رمز دسترسی منقضی شده است.
اگرچه اجرای جریان کد ضمنی سادهتر است، اما گوگل توصیه میکند که توکنهای دسترسی صادر شده با استفاده از جریان ضمنی هرگز منقضی نمیشوند، زیرا استفاده از انقضای رمز با جریان ضمنی کاربر را مجبور میکند تا حساب خود را دوباره پیوند دهد. اگر به دلایل امنیتی نیاز به انقضای توکن دارید، باید قویاً از جریان کد تأیید استفاده کنید.
پروژه را پیکربندی کنید
برای پیکربندی پروژه خود برای استفاده از پیوند ساده، مراحل زیر را دنبال کنید:
- کنسول Actions را باز کنید و پروژه ای را که می خواهید استفاده کنید انتخاب کنید.
- روی تب Develop کلیک کنید و Account linking را انتخاب کنید.
- سوئیچ کنار Account linking را فعال کنید.
- در بخش ایجاد حساب ، بله را انتخاب کنید.
در نوع پیوند ، OAuth & Google Sign In و Implicit را انتخاب کنید.
در اطلاعات مشتری ، موارد زیر را انجام دهید:
- یک مقدار به Client ID صادر شده توسط Actions شما به Google اختصاص دهید تا درخواستهای ارسالی از Google را شناسایی کنید.
- آدرسهای اینترنتی را برای نقاط پایانی مجوز و مبادله رمز خود وارد کنید.
روی ذخیره کلیک کنید.
سرور OAuth خود را پیاده سازی کنید
برای پشتیبانی از جریان ضمنی OAuth 2.0، سرویس شما یک نقطه پایانی مجوز را توسط HTTPS در دسترس قرار می دهد. این نقطه پایانی مسئول احراز هویت و کسب رضایت از کاربران برای دسترسی به داده است. نقطه پایانی مجوز یک رابط کاربری برای ورود به سیستم به کاربرانی که قبلاً وارد سیستم نشدهاند ارائه میکند و رضایت را برای دسترسی درخواستی ثبت میکند.
وقتی Action شما نیاز به تماس با یکی از APIهای مجاز سرویس شما دارد، Google از این نقطه پایانی استفاده میکند تا از کاربران شما اجازه بگیرد تا از طرف آنها با این APIها تماس بگیرد.
یک جلسه جریان ضمنی OAuth 2.0 که توسط Google آغاز شده است دارای جریان زیر است:
- Google نقطه پایانی مجوز شما را در مرورگر کاربر باز می کند. اگر کاربر قبلاً وارد سیستم نشده باشد، به سیستم وارد میشود و اگر قبلاً مجوز نداده باشد، به Google اجازه میدهد با API شما به دادههای خود دسترسی داشته باشد.
- سرویس شما یک نشانه دسترسی ایجاد میکند و با هدایت مرورگر کاربر به Google با علامت دسترسی پیوست شده به درخواست، آن را به Google برمیگرداند.
- Google APIهای سرویس شما را فراخوانی میکند و رمز دسترسی را با هر درخواست پیوست میکند. سرویس شما تأیید میکند که نشانه دسترسی به Google مجوز دسترسی به API را میدهد و سپس تماس API را تکمیل میکند.
رسیدگی به درخواست های مجوز
هنگامی که Action شما باید پیوند حساب را از طریق جریان ضمنی OAuth 2.0 انجام دهد، Google کاربر را با درخواستی که شامل پارامترهای زیر است به نقطه پایانی مجوز شما میفرستد:
پارامترهای نقطه پایانی مجوز | |
---|---|
client_id | شناسه مشتری که به Google اختصاص داده اید. |
redirect_uri | آدرس اینترنتی که پاسخ این درخواست را به آن ارسال می کنید. |
state | یک مقدار حسابداری که بدون تغییر در URI تغییر مسیر به Google بازگردانده می شود. |
response_type | نوع مقداری که در پاسخ باید برگردانده شود. برای جریان ضمنی OAuth 2.0، نوع پاسخ همیشه token است. |
برای مثال، اگر نقطه پایانی مجوز شما در https://myservice.example.com/auth
موجود باشد، ممکن است یک درخواست به این صورت باشد:
GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token
برای اینکه نقطه پایانی مجوز شما به درخواستهای ورود به سیستم رسیدگی کند، مراحل زیر را انجام دهید:
برای جلوگیری از اعطای دسترسی به برنامه های مشتری ناخواسته یا پیکربندی نادرست، مقادیر
client_id
وredirect_uri
را تأیید کنید:- تأیید کنید که
client_id
با شناسه مشتری که به Google اختصاص داده اید مطابقت دارد. - تأیید کنید که URL مشخصشده توسط پارامتر
redirect_uri
شکل زیر را دارد:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
YOUR_PROJECT_ID شناسهای است که در صفحه تنظیمات پروژه در Actions Console یافت میشود.
- تأیید کنید که
بررسی کنید که آیا کاربر به سرویس شما وارد شده است یا خیر. اگر کاربر وارد سیستم نشده است، جریان ورود به سیستم یا ثبت نام سرویس خود را تکمیل کنید.
یک نشانه دسترسی ایجاد کنید که Google از آن برای دسترسی به API شما استفاده می کند. نشانه دسترسی میتواند هر مقدار رشتهای باشد، اما باید بهطور منحصربهفرد نشاندهنده کاربر و کلاینتی باشد که نشانه برای آن است و نباید قابل حدس زدن باشد.
یک پاسخ HTTP ارسال کنید که مرورگر کاربر را به URL مشخص شده توسط پارامتر
redirect_uri
هدایت می کند. تمام پارامترهای زیر را در قطعه URL وارد کنید:-
access_token
: نشانه دسترسی که ایجاد کردید -
token_type
:bearer
رشته -
state
: مقدار حالت اصلاح نشده از درخواست اصلی مثال زیر نمونه ای از URL به دست آمده است:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING
-
کنترلکننده تغییر مسیر OAuth 2.0 Google نشانه دسترسی را دریافت میکند و تأیید میکند که مقدار state
تغییر نکرده است. پس از اینکه Google یک رمز دسترسی برای سرویس شما به دست آورد، Google این رمز را به تماسهای بعدی به Action شما به عنوان بخشی از AppRequest متصل میکند.
处理自动关联
用户同意您的 Action 访问其 Google 个人资料后,Google 会发送一个请求,其中包含已签署的 Google 用户身份断言。该断言包含用户的 Google 帐号 ID、姓名和电子邮件地址等信息。您为项目配置的令牌交换端点会处理该请求。
如果您的身份验证系统中已存在相应的 Google 帐号,则令牌交换端点为用户返回一个令牌。如果 Google 帐号与现有用户不匹配,则令牌交换端点会返回 user_not_found
错误。
该请求的格式如下:
POST /token HTTP/1.1 Host: oauth2.example.com Content-Type: application/x-www-form-urlencoded grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&intent=get&assertion=JWT&consent_code=CONSENT_CODE&scope=SCOPES
您的令牌交换端点必须能够处理以下参数:
令牌端点参数 | |
---|---|
grant_type |
要交换的令牌的类型。对于这些请求,此参数的值为 urn:ietf:params:oauth:grant-type:jwt-bearer 。 |
intent |
对于这些请求,此参数的值为 `get`。 |
assertion |
一个 JSON Web 令牌 (JWT),可提供 Google 用户身份的已签名断言。JWT 包含用户的 Google 帐号 ID、名称和电子邮件地址等信息。 |
consent_code |
可选:如果存在,这是一个一次性代码,用于表明用户已同意您的 Action 访问指定范围。 |
scope |
可选:您已配置 Google 向用户请求的任何范围。 |
当您的令牌交换端点收到关联请求时,应执行以下操作:
تایید و رمزگشایی ادعای JWT
میتوانید با استفاده از کتابخانه رمزگشایی JWT برای زبان خود، ادعای JWT را تأیید و رمزگشایی کنید. از کلیدهای عمومی Google (در قالب JWK یا PEM موجود است) برای تأیید امضای توکن استفاده کنید.
هنگام رمزگشایی، ادعای JWT مانند مثال زیر است:
{ "sub": 1234567890, // The unique ID of the user's Google Account "iss": "https://accounts.google.com", // The assertion's issuer "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID "iat": 233366400, // Unix timestamp of the assertion's creation time "exp": 233370000, // Unix timestamp of the assertion's expiration time "name": "Jan Jansen", "given_name": "Jan", "family_name": "Jansen", "email": "jan@gmail.com", // If present, the user's email address "locale": "en_US" }
علاوه بر تأیید امضای رمز، تأیید کنید که صادرکننده ادعا (فیلد iss
) https://accounts.google.com
باشد و مخاطب (فیلد aud
) شناسه مشتری است که به Action شما اختصاص داده شده است.
检查您的身份验证系统中是否已经存在相关 Google 账号
检查是否满足以下任一条件:
- Google 帐号 ID(可在断言的
sub
字段中找到)位于您的用户数据库中。 - 断言中的电子邮件地址与用户数据库中的用户匹配。
如果满足任一条件,则表示用户已完成注册,您可以颁发访问令牌。
如果 Google 帐号 ID 和断言中指定的电子邮件地址均与您数据库中的用户不匹配,则表示该用户尚未注册。在这种情况下,您的令牌交换端点应回复 HTTP 401 错误,该错误会指定 error=user_not_found
,如以下示例所示:
HTTP/1.1 401 Unauthorized Content-Type: application/json;charset=UTF-8 { "error":"user_not_found", }当 Google 收到包含
user_not_found
错误的 401 错误响应时,Google 会调用您的令牌交换端点,将 intent
参数的值设为 create,并通过请求发送一个包含用户个人资料信息的 ID 令牌。
ایجاد حساب کاربری را از طریق Google Sign-In مدیریت کنید
هنگامی که کاربر نیاز به ایجاد یک حساب کاربری در سرویس شما دارد، Google درخواستی را به نقطه پایانی تبادل توکن شما میدهد که intent=create
مشخص میکند، مانند مثال زیر:
POST /token HTTP/1.1 Host: oauth2.example.com Content-Type: application/x-www-form-urlencoded response_type=token&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&scope=SCOPES&intent=create&consent_code=CONSENT_CODE&assertion=JWT[&NEW_ACCOUNT_INFO]
پارامتر assertion
حاوی یک رمز وب JSON (JWT) است که یک ادعای امضا شده از هویت کاربر Google را ارائه می دهد. JWT حاوی اطلاعاتی است که شامل شناسه حساب Google کاربر، نام و آدرس ایمیل کاربر است که می توانید از آنها برای ایجاد یک حساب کاربری جدید در سرویس خود استفاده کنید.
برای پاسخ به درخواستهای ایجاد حساب، نقطه پایانی تبادل توکن شما باید موارد زیر را انجام دهد:
تایید و رمزگشایی ادعای JWT
میتوانید با استفاده از کتابخانه رمزگشایی JWT برای زبان خود، ادعای JWT را تأیید و رمزگشایی کنید. از کلیدهای عمومی Google (در قالب JWK یا PEM موجود است) برای تأیید امضای توکن استفاده کنید.
هنگام رمزگشایی، ادعای JWT مانند مثال زیر است:
{ "sub": 1234567890, // The unique ID of the user's Google Account "iss": "https://accounts.google.com", // The assertion's issuer "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID "iat": 233366400, // Unix timestamp of the assertion's creation time "exp": 233370000, // Unix timestamp of the assertion's expiration time "name": "Jan Jansen", "given_name": "Jan", "family_name": "Jansen", "email": "jan@gmail.com", // If present, the user's email address "locale": "en_US" }
علاوه بر تأیید امضای رمز، تأیید کنید که صادرکننده ادعا (فیلد iss
) https://accounts.google.com
باشد و مخاطب (فیلد aud
) شناسه مشتری است که به Action شما اختصاص داده شده است.
اعتبارسنجی اطلاعات کاربر و ایجاد حساب جدید
بررسی کنید که آیا یکی از شرایط زیر درست است یا خیر:
- شناسه حساب Google که در قسمت
sub
ادعا یافت میشود، در پایگاه داده کاربر شما قرار دارد. - آدرس ایمیل در ادعا با کاربر در پایگاه داده کاربر شما مطابقت دارد.
اگر هر یک از این شرایط درست است، از کاربر بخواهید تا حساب موجود خود را با حساب Google خود با پاسخ دادن به درخواست با خطای HTTP 401 پیوند دهد و error=linking_error
و آدرس ایمیل کاربر را به عنوان login_hint
مشخص کند، مانند مثال زیر:
HTTP/1.1 401 Unauthorized Content-Type: application/json;charset=UTF-8 { "error":"linking_error", "login_hint":"foo@bar.com" }
اگر هیچ یک از این شرایط درست نیست، با استفاده از اطلاعات ارائه شده در JWT یک حساب کاربری جدید ایجاد کنید. حسابهای جدید معمولاً رمز عبور ندارند. توصیه میشود Google Sign In را به پلتفرمهای دیگر اضافه کنید تا کاربران بتوانند از طریق Google در سطوح برنامه شما وارد شوند. از طرف دیگر، میتوانید پیوندی را برای کاربر ایمیل کنید که جریان بازیابی رمز عبور شما را شروع میکند تا کاربر بتواند رمز عبوری برای ورود به سیستم در دیگر پلتفرمها تعیین کند.
هنگامی که ایجاد کامل شد، یک نشانه دسترسی را بازخوانی کنید و مقادیر موجود در یک شی JSON را در بدنه پاسخ HTTPS خود برگردانید، مانند مثال زیر:
{ "token_type": "Bearer", "access_token": "ACCESS_TOKEN", "expires_in": SECONDS_TO_EXPIRATION }
رابط کاربری صوتی را برای جریان احراز هویت طراحی کنید
بررسی کنید که آیا کاربر تأیید شده است و جریان پیوند حساب را شروع کنید
- پروژه Actions Builder خود را در Actions Console باز کنید.
- یک صحنه جدید برای شروع پیوند دادن حساب در Action خود ایجاد کنید:
- روی صحنه ها کلیک کنید.
- برای افزودن یک صحنه جدید، روی نماد افزودن (+) کلیک کنید.
- در صحنه جدید ایجاد شده، روی نماد افزودن add برای Conditions کلیک کنید.
- شرطی اضافه کنید که بررسی کند آیا کاربر مرتبط با مکالمه یک کاربر تأیید شده است یا خیر. اگر بررسی ناموفق باشد، Action شما نمیتواند پیوند حساب را در طول مکالمه انجام دهد و باید به ارائه دسترسی به عملکردی که نیازی به پیوند حساب ندارد بازگردد.
- در قسمت
Enter new expression
در Condition ، منطق زیر را وارد کنید:user.verificationStatus != "VERIFIED"
- در بخش انتقال ، صحنهای را انتخاب کنید که نیازی به پیوند دادن حساب ندارد یا صحنهای که نقطه ورود به عملکرد فقط مهمان است.
- در قسمت
- روی نماد افزودن add برای شرایط کلیک کنید.
- در صورتی که کاربر هویت مرتبطی نداشته باشد، شرطی را برای فعال کردن جریان پیوند حساب اضافه کنید.
- در قسمت
Enter new expression
در Condition ، منطق زیر را وارد کنید:user.verificationStatus == "VERIFIED"
- در بخش Transition ، صحنه سیستم پیوند حساب را انتخاب کنید.
- روی ذخیره کلیک کنید.
- در قسمت
پس از ذخیره، یک صحنه سیستم پیوند حساب جدید به نام <SceneName>_AccountLinking
به پروژه شما اضافه می شود.
صحنه پیوند حساب را سفارشی کنید
- در بخش صحنهها ، صحنه سیستم پیوند دهنده حساب را انتخاب کنید.
- روی Send prompt کلیک کنید و یک جمله کوتاه اضافه کنید تا به کاربر توضیح دهد که چرا Action باید به هویت او دسترسی داشته باشد (به عنوان مثال "برای ذخیره تنظیمات برگزیده").
- روی ذخیره کلیک کنید.
- در زیر شرایط ، روی اگر کاربر با موفقیت پیوند حساب را انجام دهد کلیک کنید.
- اگر کاربر موافقت کرد که حساب خود را پیوند دهد، نحوه جریان را پیکربندی کنید. به عنوان مثال، برای پردازش هرگونه منطق تجاری سفارشی مورد نیاز و انتقال به صحنه اصلی، با webhook تماس بگیرید.
- روی ذخیره کلیک کنید.
- در زیر شرایط ، روی اگر کاربر پیوند دادن حساب را لغو یا رد کرد، کلیک کنید.
- اگر کاربر با پیوند دادن حساب خود موافقت نکرد، نحوه جریان را پیکربندی کنید. به عنوان مثال، یک پیام تأیید ارسال کنید و به صحنههایی هدایت کنید که عملکردی را ارائه میکنند که نیازی به پیوند دادن حساب ندارد.
- روی ذخیره کلیک کنید.
- در قسمت Conditions ، روی If system or network error رخ می دهد کلیک کنید.
- اگر به دلیل خطاهای سیستم یا شبکه نمیتوان جریان پیوند حساب را تکمیل کرد، نحوه انجام جریان را پیکربندی کنید. به عنوان مثال، یک پیام تأیید ارسال کنید و به صحنههایی هدایت کنید که عملکردی را ارائه میکنند که نیازی به پیوند دادن حساب ندارد.
- روی ذخیره کلیک کنید.
رسیدگی به درخواست های دسترسی به داده ها
اگر درخواست دستیار حاوی یک نشانه دسترسی است ، ابتدا بررسی کنید که رمز دسترسی معتبر است و منقضی نشده است و سپس حساب کاربری مرتبط با رمز را از پایگاه داده حساب کاربری خود بازیابی کنید.