نمای کلی
Google Sign-In مبتنی بر OAuth پیوند ساده، Google Sign-In را در بالای پیوند OAuth اضافه می کند. این یک تجربه پیوند یکپارچه را برای کاربران Google فراهم می کند، و همچنین ایجاد حساب را فعال می کند، که به کاربر اجازه می دهد با استفاده از حساب Google خود یک حساب جدید در سرویس شما ایجاد کند.
برای انجام پیوند حساب با OAuth و Google Sign-In، این مراحل کلی را دنبال کنید:
- ابتدا از کاربر بخواهید که رضایت خود را برای دسترسی به نمایه Google خود اعلام کند.
- از اطلاعات موجود در نمایه آنها برای بررسی وجود حساب کاربری استفاده کنید.
- برای کاربران موجود، حساب ها را پیوند دهید.
- اگر نتوانستید مطابق با کاربر Google در سیستم احراز هویت خود پیدا کنید، رمز شناسه دریافتی از Google را تأیید کنید. سپس می توانید یک کاربر بر اساس اطلاعات نمایه موجود در رمز شناسه ایجاد کنید.
شکل 1 . پیوند دادن حساب در تلفن کاربر با پیوند ساده
الزامات برای پیوند ساده
- جریان اصلی پیوند OAuth وب را پیاده سازی کنید. سرویس شما باید از مجوزهای منطبق با OAuth 2.0 و نقاط پایانی تبادل توکن پشتیبانی کند.
- نقطه پایانی مبادله رمز شما باید از اظهارات JSON Web Token (JWT) پشتیبانی کند و
check
را اجرا کند،create
، و مقاصدget
.
سرور OAuth خود را پیاده سازی کنید
نقطه پایانی مبادله رمز شما باید از check
، create
، get
هدف پشتیبانی کند. در زیر مراحل تکمیل شده از طریق جریان پیوند حساب را نشان می دهد و نشان می دهد که چه زمانی مقاصد مختلف فراخوانی می شوند:
- آیا کاربر در سیستم احراز هویت شما حساب کاربری دارد؟ (کاربر با انتخاب YES یا NO تصمیم می گیرد)
- بله : آیا کاربر از ایمیل مرتبط با حساب Google خود برای ورود به پلت فرم شما استفاده می کند؟ (کاربر با انتخاب YES یا NO تصمیم می گیرد)
- بله: آیا کاربر یک حساب منطبق در سیستم احراز هویت شما دارد؟ (
check intent
برای تایید فراخوانی می شود)- بله:
get intent
فراخوانی میشود و اگر get intent با موفقیت برمیگردد، حساب پیوند داده میشود. - نه: ایجاد حساب جدید؟ (کاربر با انتخاب YES یا NO تصمیم می گیرد)
- YES:
create intent
فراخوانی می شود و در صورت بازگشت موفقیت آمیز ایجاد intent، حساب پیوند داده می شود. - خیر: جریان Web OAuth فعال میشود، کاربر به مرورگر خود هدایت میشود و به کاربر این امکان داده میشود که با ایمیل دیگری پیوند دهد.
- YES:
- بله:
- خیر: جریان Web OAuth فعال میشود، کاربر به مرورگر خود هدایت میشود و به کاربر این امکان داده میشود که با ایمیل دیگری پیوند دهد.
- بله: آیا کاربر یک حساب منطبق در سیستم احراز هویت شما دارد؟ (
- خیر: آیا کاربر یک حساب منطبق در سیستم احراز هویت شما دارد؟ (
check intent
برای تایید فراخوانی می شود)- بله:
get intent
فراخوانی میشود و اگر get intent با موفقیت برمیگردد، حساب پیوند داده میشود. - خیر:
create intent
فراخوانی می شود و در صورت بازگشت موفقیت آمیز ایجاد intent، حساب پیوند داده می شود.
- بله:
- بله : آیا کاربر از ایمیل مرتبط با حساب Google خود برای ورود به پلت فرم شما استفاده می کند؟ (کاربر با انتخاب YES یا NO تصمیم می گیرد)
حساب کاربری موجود را بررسی کنید (نیت را بررسی کنید)
پس از رضایت کاربر برای دسترسی به نمایه Google خود، Google درخواستی را ارسال می کند که حاوی تأییدیه امضا شده هویت کاربر Google است. این ادعا حاوی اطلاعاتی است که شامل شناسه حساب Google، نام و آدرس ایمیل کاربر است. نقطه پایانی تبادل توکن که برای پروژه شما پیکربندی شده است، آن درخواست را مدیریت می کند.
اگر حساب Google مربوطه از قبل در سیستم احراز هویت شما وجود داشته باشد، نقطه پایانی مبادله رمز شما با account_found=true
پاسخ میدهد. اگر حساب Google با کاربر موجود مطابقت نداشته باشد، نقطه پایانی تبادل رمز شما یک خطای HTTP 404 Not Found با account_found=false
را برمیگرداند.
درخواست دارای فرم زیر است:
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=check&assertion=JWT &scope=SCOPES &client_id=GOOGLE_CLIENT_ID &client_secret=GOOGLE_CLIENT_SECRET
نقطه پایانی تبادل توکن شما باید بتواند پارامترهای زیر را مدیریت کند:
پارامترهای نقطه پایانی رمز | |
---|---|
intent | برای این درخواست ها، مقدار این پارامتر check می شود. |
grant_type | نوع توکن رد و بدل شده برای این درخواستها، این پارامتر دارای مقدار urn:ietf:params:oauth:grant-type:jwt-bearer . |
assertion | یک نشانه وب JSON (JWT) که تأیید امضا شده ای از هویت کاربر Google ارائه می دهد. JWT حاوی اطلاعاتی است که شامل شناسه حساب Google، نام و آدرس ایمیل کاربر است. |
client_id | شناسه مشتری که به Google اختصاص داده اید. |
client_secret | راز مشتری که به Google اختصاص داده اید. |
برای پاسخ به درخواستهای قصد check
، نقطه پایانی مبادله رمز شما باید مراحل زیر را انجام دهد:
- تایید و رمزگشایی ادعای JWT.
- بررسی کنید که آیا حساب Google از قبل در سیستم احراز هویت شما وجود دارد یا خیر.
验证和解码 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
"email_verified": true, // true, if Google has verified the email address
"hd": "example.com", // If present, the host domain of the user's GSuite email address
// If present, a URL to user's profile picture
"picture": "https://lh3.googleusercontent.com/a-/AOh14GjlTnZKHAeb94A-FmEbwZv7uJD986VOF1mJGb2YYQ",
"locale": "en_US" // User's locale, from browser or phone settings
}
除了验证令牌的签名之外,还要验证断言的
颁发者(iss
字段)为 https://accounts.google.com
,
(aud
字段)是分配给您的客户端 ID,并且令牌未过期
(exp
字段)。
使用 email
、email_verified
和 hd
字段,您可以确定
Google 负责托管电子邮件地址,并对其具有权威性。如果 Google
权威性 - 用户当前被认定为合法账号所有者
您可以跳过密码或其他验证方法。否则,这些方法
可用于在关联之前验证账号。
Google 具有权威性的情形:
email
的后缀为@gmail.com
,这是一个 Gmail 账号。email_verified
为 true 且hd
已设置,这是 G Suite 账号。
用户无需使用 Gmail 或 G Suite 即可注册 Google 账号。时间
email
不包含 @gmail.com
后缀,且 hd
不存在 Google 不
建议使用权威凭据和密码或其他验证方法进行验证
用户。email_verified
可能为 true,因为 Google 最初验证了
创建 Google 账号后,该用户会获得第三方的所有权,
后,电子邮件账号可能已更改。
بررسی کنید که آیا حساب Google از قبل در سیستم احراز هویت شما وجود دارد یا خیر
بررسی کنید که آیا یکی از شرایط زیر درست است یا خیر:
- شناسه حساب Google که در قسمت
sub
ادعا یافت میشود، در پایگاه داده کاربر شما قرار دارد. - آدرس ایمیل در ادعا با کاربر در پایگاه داده کاربر شما مطابقت دارد.
اگر هر یک از شرایط صحیح باشد، کاربر قبلاً ثبت نام کرده است. در این صورت، پاسخی مانند زیر را برگردانید:
HTTP/1.1 200 Success Content-Type: application/json;charset=UTF-8 { "account_found":"true", }
اگر نه شناسه حساب Google و نه آدرس ایمیل مشخص شده در ادعا با کاربر موجود در پایگاه داده شما مطابقت ندارد، کاربر هنوز ثبت نام نکرده است. در این مورد، نقطه پایانی تبادل توکن شما باید با یک خطای HTTP 404 پاسخ دهد که "account_found": "false"
، مانند مثال زیر:
HTTP/1.1 404 Not found Content-Type: application/json;charset=UTF-8 { "account_found":"false", }
处理自动链接(获取 intent)
在用户同意访问其 Google 个人资料后,Google 会发送 请求,其中包含 Google 用户身份的已签名断言。通过 断言包含的信息包括用户的 Google 账号 ID、 姓名和电子邮件地址为您的 Google Cloud 控制台配置的令牌交换端点 项目处理该请求。
如果您的身份验证中已有相应的 Google 账号
系统,您的令牌交换端点将为用户返回一个令牌。如果
Google 账号与现有用户不匹配,您的令牌交换端点
返回 linking_error
错误和可选的 login_hint
。
请求的格式如下:
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 &scope=SCOPES &client_id=GOOGLE_CLIENT_ID &client_secret=GOOGLE_CLIENT_SECRET
您的令牌交换端点必须能够处理以下参数:
令牌端点参数 | |
---|---|
intent |
对于这些请求,此参数的值为 get 。 |
grant_type |
所交换的令牌的类型。对于这类请求
参数的值为 urn:ietf:params:oauth:grant-type:jwt-bearer 。 |
assertion |
一个 JSON Web 令牌 (JWT),提供 Google 用户身份。JWT 包含的信息包括用户 Google 账号 ID、姓名和电子邮件地址。 |
scope |
可选:您已将 Google 配置为向其请求访问权限的任何范围 用户。 |
client_id |
您分配给 Google 的客户 ID。 |
client_secret |
您分配给 Google 的客户端密钥。 |
如需响应 get
intent 请求,您的令牌交换端点必须执行以下步骤:
- 验证和解码 JWT 断言。
- 检查您的身份验证系统中是否已存在该 Google 账号。
验证和解码 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
"email_verified": true, // true, if Google has verified the email address
"hd": "example.com", // If present, the host domain of the user's GSuite email address
// If present, a URL to user's profile picture
"picture": "https://lh3.googleusercontent.com/a-/AOh14GjlTnZKHAeb94A-FmEbwZv7uJD986VOF1mJGb2YYQ",
"locale": "en_US" // User's locale, from browser or phone settings
}
除了验证令牌的签名之外,还要验证断言的
颁发者(iss
字段)为 https://accounts.google.com
,
(aud
字段)是分配给您的客户端 ID,并且令牌未过期
(exp
字段)。
使用 email
、email_verified
和 hd
字段,您可以确定
Google 负责托管电子邮件地址,并对其具有权威性。如果 Google
权威性 - 用户当前被认定为合法账号所有者
您可以跳过密码或其他验证方法。否则,这些方法
可用于在关联之前验证账号。
Google 具有权威性的情形:
email
的后缀为@gmail.com
,这是一个 Gmail 账号。email_verified
为 true 且hd
已设置,这是 G Suite 账号。
用户无需使用 Gmail 或 G Suite 即可注册 Google 账号。时间
email
不包含 @gmail.com
后缀,且 hd
不存在 Google 不
建议使用权威凭据和密码或其他验证方法进行验证
用户。email_verified
可能为 true,因为 Google 最初验证了
创建 Google 账号后,该用户会获得第三方的所有权,
后,电子邮件账号可能已更改。
检查您的身份验证系统中是否已存在该 Google 账号
请检查以下任一条件是否成立:
- Google 账号 ID(可在断言的
sub
字段中找到)位于您的用户中 数据库。 - 断言中的电子邮件地址与用户数据库中的用户匹配。
如果找到了用户的账号,请发出访问令牌,并在 HTTPS 响应正文的 JSON 对象中返回相应值,如以下示例所示:
{
"token_type": "Bearer",
"access_token": "ACCESS_TOKEN ",
"expires_in":SECONDS_TO_EXPIRATION
}
在某些情况下,基于 ID 令牌的账号关联可能会失败。如果
因为任何原因,您的令牌交换端点都需要以 HTTP 响应
指定 error=linking_error
的 401 错误,如以下示例所示:
HTTP/1.1 401 Unauthorized Content-Type: application/json;charset=UTF-8 { "error":"linking_error", "login_hint":"foo@bar.com" }
当 Google 收到包含 linking_error
的 401 错误响应时,会发送
使用 login_hint
作为参数将用户发送到您的授权端点。通过
用户在浏览器中使用 OAuth 关联流程完成账号关联。
通过 Google 登录功能处理账号创建(创建 intent)
当用户需要在您的服务中创建账号时,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&assertion=JWT &client_id=GOOGLE_CLIENT_ID &client_secret=GOOGLE_CLIENT_SECRET
您的令牌交换端点必须能够处理以下参数:
令牌端点参数 | |
---|---|
intent |
对于这些请求,此参数的值为 create 。 |
grant_type |
所交换的令牌的类型。对于这类请求
参数的值为 urn:ietf:params:oauth:grant-type:jwt-bearer 。 |
assertion |
一个 JSON Web 令牌 (JWT),提供 Google 用户身份。JWT 包含的信息包括用户 Google 账号 ID、姓名和电子邮件地址。 |
client_id |
您分配给 Google 的客户 ID。 |
client_secret |
您分配给 Google 的客户端密钥。 |
assertion
参数中的 JWT 包含用户的 Google 账号 ID。
姓名和电子邮件地址,可用于在 Gmail 中创建新账号
服务。
如需响应 create
intent 请求,您的令牌交换端点必须执行以下步骤:
- 验证和解码 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
"email_verified": true, // true, if Google has verified the email address
"hd": "example.com", // If present, the host domain of the user's GSuite email address
// If present, a URL to user's profile picture
"picture": "https://lh3.googleusercontent.com/a-/AOh14GjlTnZKHAeb94A-FmEbwZv7uJD986VOF1mJGb2YYQ",
"locale": "en_US" // User's locale, from browser or phone settings
}
除了验证令牌的签名之外,还要验证断言的
颁发者(iss
字段)为 https://accounts.google.com
,
(aud
字段)是分配给您的客户端 ID,并且令牌未过期
(exp
字段)。
使用 email
、email_verified
和 hd
字段,您可以确定
Google 负责托管电子邮件地址,并对其具有权威性。如果 Google
权威性 - 用户当前被认定为合法账号所有者
您可以跳过密码或其他验证方法。否则,这些方法
可用于在关联之前验证账号。
Google 具有权威性的情形:
email
的后缀为@gmail.com
,这是一个 Gmail 账号。email_verified
为 true 且hd
已设置,这是 G Suite 账号。
用户无需使用 Gmail 或 G Suite 即可注册 Google 账号。时间
email
不包含 @gmail.com
后缀,且 hd
不存在 Google 不
建议使用权威凭据和密码或其他验证方法进行验证
用户。email_verified
可能为 true,因为 Google 最初验证了
创建 Google 账号后,该用户会获得第三方的所有权,
后,电子邮件账号可能已更改。
验证用户信息并创建新账号
请检查以下任一条件是否成立:
- Google 账号 ID(可在断言的
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" }
当 Google 收到包含 linking_error
的 401 错误响应时,会发送
使用 login_hint
作为参数将用户发送到您的授权端点。通过
用户在浏览器中使用 OAuth 关联流程完成账号关联。
如果以上两个条件都不满足,请使用相应信息创建一个新的用户账号 。新账号通常不会设置密码。时间是 建议您将 Google 登录功能添加到其他平台,以便用户 使用 Google 账号登录。或者 可以通过电子邮件向用户发送链接,启动密码恢复流程,以允许 用户设置密码,以便在其他平台上登录。
创建完成后,发出一个访问令牌 并在 HTTPS 响应的正文,如以下示例所示:
{
"token_type": "Bearer",
"access_token": "ACCESS_TOKEN ",
"expires_in":SECONDS_TO_EXPIRATION
}
Google API Client ID خود را دریافت کنید
در طول فرآیند ثبت نام پیوند حساب، باید شناسه مشتری Google API خود را ارائه دهید.
برای دریافت شناسه مشتری API خود با استفاده از پروژه ای که هنگام تکمیل مراحل OAuth Linking ایجاد کرده اید. برای این کار مراحل زیر را انجام دهید:
یک پروژه Google APIs ایجاد یا انتخاب کنید.
اگر پروژه شما شناسه مشتری برای نوع برنامه وب ندارد، برای ایجاد آن روی Create Client کلیک کنید. مطمئن شوید که دامنه سایت خود را در کادر مبداهای مجاز جاوا اسکریپت قرار دهید. هنگامی که آزمایشهای محلی یا توسعه را انجام میدهید، باید هر دو
http://localhost
وhttp://localhost:<port_number>
را به قسمت Authorized JavaScript origins اضافه کنید.
اعتبار بخشیدن به اجرای شما
您可以使用 OAuth 2.0 Playground 工具验证您的实现。
在该工具中,执行以下步骤:
- 点击配置 以打开 OAuth 2.0 配置窗口。
- 在 OAuth flow 字段中,选择 Client-side(客户端)。
- 在 OAuth 端点字段中,选择自定义。
- 在相应字段中指定您的 OAuth 2.0 端点和您分配给 Google 的客户端 ID。
- 在第 1 步部分,不要选择任何 Google 范围。请将此字段留空或输入对服务器有效的范围(如果您不使用 OAuth 范围,则可以输入任意字符串)。完成后,点击授权 API。
- 在 Step 2 和 Step 3 部分中,完成 OAuth 2.0 流程,并验证每个步骤是否按预期运行。
您可以使用 Google 账号关联演示版工具验证您的实现。
在该工具中,执行以下步骤:
- 点击使用 Google 账号登录按钮。
- 选择您要关联的账号。
- 输入服务 ID。
- (可选)输入您要请求访问权限的一个或多个范围。
- 点击开始演示。
- 当系统提示时,请确认您同意或拒绝关联请求。
- 确认您已被重定向到您的平台。