OpenID Connect

Google 的 OAuth 2.0 API 可用於驗證和授權作業。本文說明我們實作的 OAuth 2.0 驗證機制，符合 OpenID Connect 規格，且已獲得 OpenID 認證。使用 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中的品牌資訊。

To enable your project's consent screen:

1. Open the Consent Screen page in the Google API Console.
2. If prompted, select a project, or create a new one.
3. Fill out the form and click Save.

以下同意對話方塊顯示，當要求中同時包含 OAuth 2.0 和 Google 雲端硬碟範圍時，使用者會看到什麼內容。(這個通用對話方塊是使用 Google OAuth 2.0 Playground 產生的，因此不包含 API Console中會設定的品牌資訊)。

存取服務

Google 和第三方提供的程式庫可用於處理許多驗證使用者和取得 Google API 存取權的實作細節。例如 Google 身分識別服務和 Google 用戶端程式庫，可用於各種平台。

如果您選擇不使用程式庫，請按照本文其餘部分的指示操作，其中說明瞭可用程式庫的 HTTP 要求流程。

驗證使用者

驗證使用者時，您必須取得 ID 權杖並驗證。ID 憑證是 OpenID Connect 的標準化功能，專門用於在網路上分享身分斷言。

驗證使用者並取得 ID 權杖最常見的方法稱為「伺服器」流程和「隱含」流程。伺服器流程可讓應用程式的後端伺服器驗證使用瀏覽器或行動裝置的使用者身分。當用戶端應用程式 (通常是瀏覽器中執行的 JavaScript 應用程式) 需要直接存取 API，而非透過其後端伺服器存取時，就會使用隱含流程。

本文說明如何執行驗證使用者的伺服器流程。由於在用戶端處理和使用權杖時存在安全風險，因此隱含式流程會變得更加複雜。如果您需要導入隱含的工作流程，強烈建議您使用 Google 身分識別服務。

伺服器流程

請務必在 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 中繼資料值，從Discovery 文件擷取基礎 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 應為伺服器上的 HTTP 端點，可接收 Google 的回應。這個值必須與您在 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 Workspace 或 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 Token)，也就是經過加密簽署的 Base64 編碼 JSON 物件。通常，您必須先驗證 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 權杖授予哪個用戶端。

ID 權杖屬於敏感資訊，如果遭到攔截，可能會遭到濫用。您必須確保這些符記以安全無虞的方式處理，也就是只能透過 HTTPS 傳輸，且只能透過 POST 資料或要求標頭傳輸。如果您將 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 權杖包含 hd 要求，且與與 Google Cloud 機構相關聯的已接受網域相符。

步驟 2 到 5 只涉及字串和日期比較，這類操作相當簡單，因此我們不會在此詳述。

第一步較為複雜，涉及加密編譯簽名檢查。如要進行偵錯，您可以使用 Google 的 tokeninfo 端點，與在伺服器或裝置上執行的本機處理作業進行比較。假設 ID 權杖的值為 XYZ123。接著，您會解除 URI https://oauth2.googleapis.com/tokeninfo?id_token=XYZ123 的參照。如果權杖簽名有效，回應會是已解碼 JSON 物件形式的 JWT 酬載。

tokeninfo 端點可用於偵錯，但如果是用於實際工作環境，請從金鑰端點擷取 Google 的公開金鑰，並在本機執行驗證。您應使用 jwks_uri 中繼資料值，從Discovery 文件擷取鍵 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 中繼資料值，從 Discovery 文件擷取 userinfo 端點。如 OpenID Connect Standard Claims 和 Discovery 文件的 claims_supported 中繼資料值所述，userinfo 回應會包含使用者相關資訊。使用者或其機構可能會選擇提供或隱藏特定欄位，因此您可能無法取得授權存取範圍內的每個欄位資訊。

探索文件

OpenID Connect 通訊協定要求使用多個端點來驗證使用者，以及要求憑證、使用者資訊和公開金鑰等資源。

為了簡化實作並提高彈性，OpenID Connect 允許使用「探索文件」，這是位於已知位置的 JSON 文件，其中包含鍵/值組合，可提供 OpenID Connect 提供者的設定詳細資料，包括授權、權杖、撤銷、使用者資訊和公開金鑰端點的 URI。您可以從下列位置擷取 Google OpenID Connect 服務的探索文件：

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

如要使用 Google 的 OpenID Connect 服務，您必須將探索文件 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"
  ]
}

您可以快取探索文件中的值，避免進行 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 程式庫
• Google Toolbox for Mac 的 OAuth 2.0 控制器

OpenID Connect 法規遵循

Google 的 OAuth 2.0 驗證系統支援 OpenID Connect Core 規格的必要功能。任何用於 OpenID Connect 的用戶端都應與這項服務互通 (OpenID 要求物件除外)。