OpenID Connect

Google 的 OAuth 2.0 API 可用于身份验证和授权。本文档介绍了符合 OpenID Connect 规范并已获 OpenID 认证的 OAuth 2.0 身份验证实现。使用 OAuth 2.0 访问 Google API 中的文档也适用于此服务。如果您想以交互方式探索此协议，我们建议您使用 Google OAuth 2.0 Playground。如需获取关于 Stack Overflow 的帮助，请使用“google-oauth”标记您的问题。

设置 OAuth 2.0

在您的应用可以使用 Google 的 OAuth 2.0 身份验证系统进行用户登录之前，您必须在 Google API Console 中设置项目，以获取 OAuth 2.0 凭据、设置重定向 URI，以及（可选）自定义用户在用户意见征求屏幕上看到的品牌信息。您还可以使用 API Console 创建服务帐号、启用结算功能、设置过滤以及执行其他任务。如需了解详情，请参阅 Google API Console帮助。

获取 OAuth 2.0 凭据

您需要 OAuth 2.0 凭据（包括客户端 ID 和客户端密钥），才能对用户进行身份验证并获得 Google 的 API 的访问权限。

To view the client ID and client secret for a given OAuth 2.0 credential, click the following text: Select credential. In the window that opens, choose your project and the credential you want, then click View.

Or, view your client ID and client secret from the Credentials page in API Console:

1. Go to the Credentials page.
2. Click the name of your credential or the pencil (create) icon. Your client ID and secret are at the top of the page.

设置重定向 URI

您在 API Console 中设置的重定向 URI 将决定 Google 将身份验证请求发送到何处。

To create, view, or edit the redirect URIs for a given OAuth 2.0 credential, do the following:

1. Go to the Credentials page.
2. In the OAuth 2.0 client IDs section of the page, click a credential.
3. View or edit the redirect URIs.

If there is no OAuth 2.0 client IDs section on the Credentials page, then your project has no OAuth credentials. To create one, click Create credentials.

自定义用户意见征求屏幕

OAuth 2.0 身份验证界面为您的用户提供了权限请求页面，用于说明用户要释放的信息以及适用条款。例如，当用户登录时，系统可能会要求他们向您的应用授予对其电子邮件地址和基本帐号信息的访问权限。您可以使用 scope 参数请求访问此信息，此参数包含在应用的身份验证请求中。您还可以使用范围来请求访问其他 Google API。

用户同意屏幕还会显示品牌信息，例如产品名称、徽标和首页网址。您可以在 API Console中控制品牌信息。

要启用项目的同意屏幕：

1. 在Consent Screen page中打开Google API Console 。
2. If prompted, select a project, or create a new one.
3. 填写表格，然后点击保存 。

以下意见征求对话框显示了在请求中存在 OAuth 2.0 和 Google 云端硬盘范围组合时用户会看到的内容。（此通用对话框是使用 Google OAuth 2.0 Playground 生成的，因此它不包含将在 API Console中设置的品牌信息。）

访问服务

Google 和第三方提供了一些库，可用于处理对用户进行身份验证以及获取 Google API 访问权限的诸多实现细节。示例包括 Google Identity 服务和 Google 客户端库，后者适用于各种平台。

如果您选择不使用某个库，请按照本文档其余部分中的说明操作，文中介绍了底层可用库的 HTTP 请求流程。

对用户进行身份验证

对用户进行身份验证涉及获取 ID 令牌并对其进行验证。ID 令牌是 OpenID Connect 的标准化功能，用于在互联网上共享身份断言。

验证用户身份和获取 ID 令牌的最常用方法称为“服务器”流程和“隐式”流程。服务器流程允许应用的后端服务器使用浏览器或移动设备验证用户的身份。当客户端应用（通常是在浏览器中运行的 JavaScript 应用）需要直接访问 API，而不是通过后端服务器访问时，可使用隐式流程。

本文档介绍了如何执行服务器流程以对用户进行身份验证。由于在客户端处理和使用令牌存在安全风险，隐式流程更为复杂。如果您需要实现隐式流程，我们强烈建议您使用 Google Identity 服务。

服务器流程

请务必在 API Console中设置您的应用，使其能够使用这些协议并对用户进行身份验证。当用户尝试通过 Google 登录时，您需要执行以下操作：

1. 创建反伪造状态令牌
2. 向 Google 发送身份验证请求
3. 确认反伪造状态令牌
4. 使用 code 替换访问令牌和 ID 令牌
5. 从 ID 令牌中获取用户信息
6. 对用户进行身份验证

1. 创建防伪造状态令牌

您必须防范请求伪造攻击，确保用户的安全。第一步是创建一个唯一的会话令牌，用于保存应用与用户客户端之间的状态。您稍后会将此唯一会话令牌与 Google OAuth 登录服务返回的身份验证响应进行匹配，以验证用户发出的是请求而不是恶意攻击者。这些令牌通常称为跨站请求伪造 (CSRF) 令牌。

状态令牌的一个较好选择是使用 30 个左右的字符串使用高质量的随机数生成器构建。另一个哈希是使用在后端保密的密钥签名一些会话状态变量而生成的。

以下代码演示了如何生成唯一的会话令牌。

// Create a state token to prevent request forgery.
// Store it in the session for later validation.
$state = bin2hex(random_bytes(128/8));
$app['session']->set('state', $state);
// Set the client ID, token state, and application name in the HTML while
// serving it.
return $app['twig']->render('index.html', array(
    'CLIENT_ID' => CLIENT_ID,
    'STATE' => $state,
    'APPLICATION_NAME' => APPLICATION_NAME
));

// Create a state token to prevent request forgery.
// Store it in the session for later validation.
String state = new BigInteger(130, new SecureRandom()).toString(32);
request.session().attribute("state", state);
// Read index.html into memory, and set the client ID,
// token state, and application name in the HTML before serving it.
return new Scanner(new File("index.html"), "UTF-8")
    .useDelimiter("\\A").next()
    .replaceAll("[{]{2}\\s*CLIENT_ID\\s*[}]{2}", CLIENT_ID)
    .replaceAll("[{]{2}\\s*STATE\\s*[}]{2}", state)
    .replaceAll("[{]{2}\\s*APPLICATION_NAME\\s*[}]{2}",
    APPLICATION_NAME);

# Create a state token to prevent request forgery.
# Store it in the session for later validation.
state = hashlib.sha256(os.urandom(1024)).hexdigest()
session['state'] = state
# Set the client ID, token state, and application name in the HTML while
# serving it.
response = make_response(
    render_template('index.html',
                    CLIENT_ID=CLIENT_ID,
                    STATE=state,
                    APPLICATION_NAME=APPLICATION_NAME))

2. 向 Google 发送身份验证请求

下一步是使用适当的 URI 参数生成 HTTPS GET 请求。请注意，在此过程中的所有步骤均使用 HTTPS（而不是 HTTP）；HTTP 连接会被拒绝。您应该使用 authorization_endpoint 元数据值从发现文档中检索基本 URI。以下讨论假定基本 URI 为 https://accounts.google.com/o/oauth2/v2/auth。

对于基本请求，请指定以下参数：

• client_id（从 API Console Credentials page中获取）。
• response_type，其在基本的授权代码流请求中应为 code。（如需了解详情，请访问 response_type。）
• scope，它在基本请求中应为 openid email。（如需了解详情，请访问 scope。）
• redirect_uri 应该是您服务器上用于接收 Google 响应的 HTTP 端点。其值必须与您在 API Console Credentials page中配置的 OAuth 2.0 客户端的某个已获授权的重定向 URI 完全一致。如果此值与已获授权的 URI 不匹配，则请求将失败并显示 redirect_uri_mismatch 错误。
• state 应包含防伪造唯一会话令牌的值，以及在用户返回应用时恢复上下文所需的任何其他信息（例如起始网址）。（如需了解详情，请访问 state。）
• nonce 是您的应用生成的一个随机值，如果存在重放保护，该值可以启用。
• login_hint 可以是用户的电子邮件地址，也可以是 sub 字符串，相当于用户的 Google ID。如果您未提供 login_hint 且用户当前已登录，意见征求屏幕上会显示请求批准将用户电子邮件地址发布到应用的请求。（如需了解详情，请访问 login_hint。）
• 使用 hd 参数为与 Google Cloud 组织关联的特定网域的用户优化 OpenID Connect 流程。（如需了解详情，请访问 hd。）

下面是一个完整的 OpenID Connect 身份验证 URI 示例，其中有换行符和空格，便于阅读：

https://accounts.google.com/o/oauth2/v2/auth?
 response_type=code&
 client_id=424911365001.apps.googleusercontent.com&
 scope=openid%20email&
 redirect_uri=https%3A//oauth2.example.com/code&
 state=security_token%3D138r5719ru3e1%26url%3Dhttps%3A%2F%2Foauth2-login-demo.example.com%2FmyHome&
 login_hint=jsmith@example.com&
 nonce=0394852-3190485-2490358&
 hd=example.com

如果您的应用请求了解有关其的任何新信息，或者您的应用请求了之前未批准的帐号访问权限，则需征得用户同意。

3. 确认反伪造状态令牌

系统会将响应发送到您在请求中指定的 redirect_uri。所有响应都在查询字符串中返回，如下所示：

https://oauth2.example.com/code?state=security_token%3D138r5719ru3e1%26url%3Dhttps%3A%2F%2Foa2cb.example.com%2FmyHome&code=4/P7q7W91a-oMsCeLvIaQm6bTrgtp7&scope=openid%20email%20https://www.googleapis.com/auth/userinfo.email

在服务器上，您必须确认从 Google 收到的 state 与您在第 1 步中创建的会话令牌一致。这种往返验证有助于确保用户（而不是恶意脚本）发出请求。

以下代码演示了如何确认您在第 1 步中创建的会话令牌：

// Ensure that there is no request forgery going on, and that the user
// sending us this connect request is the user that was supposed to.
if ($request->get('state') != ($app['session']->get('state'))) {
  return new Response('Invalid state parameter', 401);
}

// Ensure that there is no request forgery going on, and that the user
// sending us this connect request is the user that was supposed to.
if (!request.queryParams("state").equals(
    request.session().attribute("state"))) {
  response.status(401);
  return GSON.toJson("Invalid state parameter.");
}

# Ensure that the request is not a forgery and that the user sending
# this connect request is the expected user.
if request.args.get('state', '') != session['state']:
  response = make_response(json.dumps('Invalid state parameter.'), 401)
  response.headers['Content-Type'] = 'application/json'
  return response

4. 使用 code 替换访问令牌和 ID 令牌

响应中包含 code 参数，您的服务器可以用它来换取访问令牌和 ID 令牌。您的服务器通过发送 HTTPS POST 请求进行此交换。POST 请求会发送到令牌端点，您应该使用 token_endpoint 元数据值从发现文档中检索该令牌。以下讨论假定端点为 https://oauth2.googleapis.com/token。该请求必须在 POST 正文中包含以下参数：

实际请求可能如以下示例所示：

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

code=4/P7q7W91a-oMsCeLvIaQm6bTrgtp7&
client_id=your-client-id&
client_secret=your-client-secret&
redirect_uri=https%3A//oauth2.example.com/code&
grant_type=authorization_code

此请求的成功响应包含以下 JSON 数组中的字段：

5. 从 ID 令牌中获取用户信息

ID 令牌是 JWT（JSON Web 令牌），即加密签名的 Base64 编码的 JSON 对象。通常，在使用 ID 令牌之前，请务必先验证 ID 令牌，但由于您是通过无中间中介 HTTPS 渠道直接与 Google 通信，并使用客户端密钥向 Google 进行身份验证，因此您可以确信自己收到的令牌确实来自 Google，且有效。如果您的服务器将 ID 令牌传递给应用的其他组件，请务必确保其他组件先验证令牌，然后再使用。

由于大多数 API 库将验证与解码 base64url 编码的值和解析 JSON 的工作结合使用，因此，在访问 ID 令牌中的声明时，您最终仍可能验证令牌。

ID 令牌的载荷

ID 令牌是包含一组名称/值对的 JSON 对象。下面是一个采用可读性的格式示例：

{
  "iss": "https://accounts.google.com",
  "azp": "1234987819200.apps.googleusercontent.com",
  "aud": "1234987819200.apps.googleusercontent.com",
  "sub": "10769150350006150715113082367",
  "at_hash": "HK6E_P6Dh8Y93mRNtsDB1Q",
  "hd": "example.com",
  "email": "jsmith@example.com",
  "email_verified": "true",
  "iat": 1353601026,
  "exp": 1353604926,
  "nonce": "0394852-3190485-2490358"
}

Google ID 令牌可能包含以下字段（称为声明）：

6. 对用户进行身份验证

从 ID 令牌中获取用户信息后，您应查询应用的用户数据库。 如果数据库中已存在该用户，且 Google API 响应能够满足所有登录要求，您应启动该用户的应用会话。

如果您的用户数据库中不存在该用户，则应将用户重定向到新用户注册流程。您可以根据从 Google 收到的信息自动注册用户，或者至少可以在您的注册表单中预先填写许多必填字段。除了 ID 令牌中的信息之外，您还可以在我们的用户个人资料端点上获取其他用户个人资料信息。

高级主题

以下各部分详细介绍了 Google OAuth 2.0 API。本文面向对身份验证和授权有高级要求的开发者。

访问其他 Google API

使用 OAuth 2.0 进行身份验证的好处之一是，您的应用可以在验证用户身份的同时，获得代表用户使用其他 Google API（例如 YouTube、Google 云端硬盘、日历或通讯录）的权限。为此，请在您发送给 Google 的身份验证请求中包含您需要的其他范围。例如，如需向身份验证请求添加用户的年龄段，请传递范围参数 openid email https://www.googleapis.com/auth/profile.agerange.read。同意屏幕会相应地提示用户。从 Google 接收的访问令牌可让您访问与请求和授予访问权限的范围相关的所有 API。

刷新令牌

在 API 访问权限请求中，您可以请求在 code 交换期间返回刷新令牌。刷新令牌可让您的应用连续访问 Google API，而用户并未出现在您的应用中。如需请求刷新令牌，请在身份验证请求中将 access_type 参数设置为 offline。

注意事项：

• 请务必在安全永久地存储刷新令牌，因为您只能在首次执行代码交换流程时获取刷新令牌。
• 颁发的刷新令牌有限制：每个客户端/用户组合各有一个限制，所有客户端的每位用户都对应一个刷新令牌。如果您的应用请求刷新令牌过多，可能会受到这些限制的影响，在这种情况下，较旧的刷新令牌将停止工作。

如需了解详情，请参阅刷新访问令牌（离线访问）。

提示重新征得用户同意

您可以通过在身份验证请求中将 prompt 参数设置为 consent 来提示用户重新授权您的应用。当添加 prompt=consent 时，每当您的应用请求访问权限范围授权时，系统都会显示同意屏幕，即使之前已向您的 Google API 项目授予了所有范围也是如此。因此，仅在必要时包含 prompt=consent。

如需详细了解 prompt 参数，请参阅身份验证 URI 参数表中的 prompt。

身份验证 URI 参数

下表更全面地介绍了 Google OAuth 2.0 身份验证 API 接受的参数。

验证 ID 令牌

您需要验证服务器上的所有 ID 令牌，除非您知道它们直接来自 Google。例如，您的服务器必须验证从客户端应用接收的任何 ID 令牌是否真实可信。

以下是您可能会将 ID 令牌发送至服务器的常见情况：

• 发送 ID 令牌和需要进行身份验证的请求。ID 令牌告知您发出请求的特定用户以及授予此 ID 令牌的客户端。

ID 令牌属于敏感信息，如果被拦截，可能会被误用。您必须确保仅通过 HTTPS 并仅在 POST 数据中或在请求标头中传输这些令牌，从而安全地处理这些令牌。如果您将 ID 令牌存储在服务器上，则还必须安全地存储这些令牌。

ID ID 令牌的优势在于，您可以根据应用的不同组件传递 ID 令牌。这些组件可以将 ID 令牌用作轻量级身份验证机制来验证应用和用户。但您必须先验证 ID 令牌中的信息，或将其作为用户身份验证的断言，然后才能使用。

验证 ID 令牌需要执行以下几个步骤：

1. 验证 ID 令牌是否已由发卡机构正确签名。Google 颁发的令牌使用在 Discovery 文档的 jwks_uri 元数据值中指定的 URI 处发现的某个证书进行签名。
2. 验证 ID 令牌中 iss 声明的值等于 https://accounts.google.com 或 accounts.google.com。
3. 验证 ID 令牌中 aud 声明的值等于应用的客户端 ID。
4. 验证 ID 令牌的过期时间（exp 版权主张）尚未过去。
5. 如果您在请求中指定了 hd 参数值，请验证 ID 令牌是否有与 Google Cloud 组织相关联的接受的网域匹配的 hd 声明。

第 2 步到第 5 步仅涉及非常简单的字符串和日期比较，因此我们在这里不做详细说明。

第一步更为复杂，涉及加密签名检查。为了进行调试，您可以使用 Google 的 tokeninfo 端点与在您的服务器或设备上实现的本地处理进行比较。假设您的 ID 令牌的值为 XYZ123。然后，您要对 URI https://oauth2.googleapis.com/tokeninfo?id_token=XYZ123 进行解引用。如果令牌签名有效，则响应为其解码的 JSON 对象形式的 JWT 载荷。

tokeninfo 端点对于调试非常有用，但对于生产环境，请从密钥端点检索 Google 的公钥，并在本地执行验证。您应该使用 jwks_uri 元数据值从发现文档中检索密钥 URI。对调试端点的请求可能会受到限制或以其他方式出现间歇性错误。

由于 Google 很少更改公钥，因此您可以使用 HTTP 响应的缓存指令缓存这些公钥；在绝大多数情况下，执行本地验证的效率要高于使用 tokeninfo 端点。此验证需要检索和解析证书，并进行适当的加密调用以检查签名。幸运的是，有一些经过精心调试的库支持各种语言（请参阅 jwt.io）。

获取用户个人资料信息

若要获取关于用户的其他个人资料信息，您可以使用访问令牌（您的应用在身份验证流程期间收到的访问令牌）和 OpenID Connect 标准：

1. 为了符合 OpenID 标准，您必须在身份验证请求中包含 openid profile 范围值。

   如果您希望包含用户的电子邮件地址，可以指定额外的范围值 email。 要同时指定 profile 和 email，您可以在身份验证请求 URI 中添加以下参数：

   scope=openid%20profile%20email

2. 将访问令牌添加到授权标头，并向 userinfo 端点发出 HTTPS GET 请求，您应使用 userinfo_endpoint 元数据值从发现文档中检索该请求。userinfo 响应包含用户的相关信息，如 OpenID Connect Standard Claims 和 Discovery 文档的 claims_supported 元数据值中所述。用户或其组织可以选择提供或拒绝某些字段，因此您可能无法获取已获授权的访问权限范围的每个字段的相关信息。

探索文档

OpenID Connect 协议要求使用多个端点来验证用户身份以及请求资源（包括令牌、用户信息和公钥）。

为了简化实现并提高灵活性，OpenID Connect 允许使用“Discovery”文档，此 JSON 文档位于一个知名的键值对位置，其中包含有关 OpenID Connect 提供方配置的详细信息，包括授权、令牌、撤消、userinfo 和公钥端点的 URI。可以从以下位置检索 Google OpenID Connect 服务的发现文档：

https://accounts.google.com/.well-known/openid-configuration

要使用 Google 的 OpenID Connect 服务，您应该将 Discovery 文档 URI (https://accounts.google.com/.well-known/openid-configuration) 硬编码到您的应用中。您的应用会提取文档，在响应中应用缓存规则，然后根据需要从文档中检索端点 URI。例如，为了对用户进行身份验证，您的代码将检索 authorization_endpoint 元数据值（以下示例中的 https://accounts.google.com/o/oauth2/v2/auth）作为发送到 Google 的身份验证请求的基本 URI。

以下是此类文档的示例；字段名称为 OpenID Connect Discovery 1.0 中指定的字段名称（如需了解具体含义，请参阅该文档）。 这些值仅作说明之用，并且可能会更改，尽管复制自实际的 Google Discovery 文档的最新版本：

{
  "issuer": "https://accounts.google.com",
  "authorization_endpoint": "https://accounts.google.com/o/oauth2/v2/auth",
  "device_authorization_endpoint": "https://oauth2.googleapis.com/device/code",
  "token_endpoint": "https://oauth2.googleapis.com/token",
  "userinfo_endpoint": "https://openidconnect.googleapis.com/v1/userinfo",
  "revocation_endpoint": "https://oauth2.googleapis.com/revoke",
  "jwks_uri": "https://www.googleapis.com/oauth2/v3/certs",
  "response_types_supported": [
    "code",
    "token",
    "id_token",
    "code token",
    "code id_token",
    "token id_token",
    "code token id_token",
    "none"
  ],
  "subject_types_supported": [
    "public"
  ],
  "id_token_signing_alg_values_supported": [
    "RS256"
  ],
  "scopes_supported": [
    "openid",
    "email",
    "profile"
  ],
  "token_endpoint_auth_methods_supported": [
    "client_secret_post",
    "client_secret_basic"
  ],
  "claims_supported": [
    "aud",
    "email",
    "email_verified",
    "exp",
    "family_name",
    "given_name",
    "iat",
    "iss",
    "locale",
    "name",
    "picture",
    "sub"
  ],
  "code_challenge_methods_supported": [
    "plain",
    "S256"
  ]
}

您可以缓存 Discovery 文档中的值，以避免 HTTP 往返。使用标准 HTTP 缓存标头，应予以尊重。

客户端库

以下客户端库通过与热门框架集成来简化 OAuth 2.0 的实现流程：

• 适用于 Java 的 Google API 客户端库
• 适用于 Python 的 Google API 客户端库
• .NET 版 Google API 客户端库
• 适用于 Ruby 的 Google API 客户端库
• 适用于 PHP 的 Google API 客户端库
• 适用于 Google Web Toolkit 的 OAuth 2.0 库
• 适用于 Mac OAuth 2.0 控制器的 Google 工具箱

OpenID Connect 合规性

Google 的 OAuth 2.0 身份验证系统支持 OpenID Connect Core 规范中的所需功能。任何旨在与 OpenID Connect 结合使用的客户端都应与此服务互操作（OpenID 请求对象除外）。