從 GoogleAuthUtil 和 Plus.API 遷移

如果您過去使用 GoogleAuthUtil.getTokenPlus.API 整合 Google 登入,請改用最新的 Sign-In API,以提升安全性並提供更優異的使用者體驗。

從存取權杖反模式遷移

請勿將使用 GoogleAuthUtil.getToken 取得的存取權杖傳送到後端伺服器做為身分斷言,因為您無法輕鬆驗證是否已將權杖核發至後端,導致您容易從攻擊者處插入存取權杖。

舉例來說,如果您的 Android 程式碼類似以下範例,則應將應用程式遷移至目前的最佳做法。

Android 代碼

在這個範例中,存取權杖要求會使用 oauth2: 加上範圍字串做為 GoogleAuthUtil.getToken 呼叫 (oauth2:https://www.googleapis.com/auth/plus.login) 的 scope 參數。

請使用 ID 權杖流程或驗證碼流程,不要使用透過 GoogleAuthUtil.getToken 取得的存取權杖進行驗證。

遷移至 ID 權杖流程

如果您只需要提供使用者 ID、電子郵件地址、姓名或個人資料相片的網址,請使用 ID 權杖流程

如要遷移至 ID 權杖流程,請進行下列變更:

Android 用戶端

  • 視需要移除「GET_ACCOUNTS」(聯絡人) 權限
  • 使用 GoogleSignInOptions.Builder.requestIdToken(...) 設定,將任何使用 GoogleAuthUtilPlus.APIAccountPicker.newChooseAccountIntent()AccountManager.newChooseAccountIntent() 的程式碼切換為 Auth.GOOGLE_SIGN_IN_API

伺服器端

  • ID 權杖驗證建立新端點
  • 遷移用戶端應用程式後,關閉舊端點

遷移至伺服器驗證碼流程

如果伺服器需要存取其他 Google API (例如 Google 雲端硬碟、YouTube 或聯絡人),請使用伺服器驗證碼流程

如要遷移至伺服器驗證碼流程,請進行下列變更:

Android 用戶端

  • 視需要移除「GET_ACCOUNTS」(聯絡人) 權限
  • 使用 GoogleSignInOptions.Builder.requestServerAuthCode(...) 設定,將任何使用 GoogleAuthUtilPlus.APIAccountPicker.newChooseAccountIntent()AccountManager.newChooseAccountIntent() 的程式碼切換為 Auth.GOOGLE_SIGN_IN_API

伺服器端

您仍然可以在舊端點與新端點之間共用 API 存取邏輯。舉例來說:

GoogleTokenResponse tokenResponse = new GoogleAuthorizationCodeTokenRequest(...);
String accessToken = tokenResponse.getAccessToken();
String refreshToken = tokenResponse.getRefreshToken();
Long expiresInSeconds = tokenResponse.getExpiresInSeconds();

// Shared by your old and new implementation, old endpoint can pass null for refreshToken
private void driveAccess(String refreshToken, String accessToken, Long expiresInSeconds) {
   GoogleCredential credential = new GoogleCredential.Builder()
           .setTransPort(...)
           ...
           .build();
   credential.setAccessToken(accessToken);
   credential.setExpiresInSeconds(expiresInSeconds);
   credential.setRefreshToken(refreshToken);
}

從 GoogleAuthUtil ID 權杖遷移流程

如果您使用 GoogleAuthUtil 取得 ID 權杖,則應遷移至新的 Sign-In API ID 權杖流程

舉例來說,如果您的 Android 程式碼類似以下範例,則應遷移:

Android 代碼

在這個範例中,ID 權杖要求會使用 audience:server:client_id 加上網路伺服器的用戶端 ID,做為 GoogleAuthUtil.getToken 呼叫 (audience:server:client_id:9414861317621.apps.googleusercontent.com) 的「範圍」參數。

新的 Sign-In API ID 權杖流程有以下優點:

  • 簡單易用的單鍵登入體驗
  • 您的伺服器無需額外網路呼叫,就能取得使用者設定檔資訊。

如要遷移至 ID 權杖流程,請進行下列變更:

Android 用戶端

  • 視需要移除「GET_ACCOUNTS」(聯絡人) 權限
  • 使用 GoogleSignInOptions.Builder.requestIdToken(...) 設定,將任何使用 GoogleAuthUtilPlus.APIAccountPicker.newChooseAccountIntent()AccountManager.newChooseAccountIntent() 的程式碼切換為 Auth.GOOGLE_SIGN_IN_API

伺服器端

新版登入 API 問題 ID 權杖,符合 OpenID Connect 規格,與使用已淘汰格式的 GoogleAuthUtil.getToken 不同。具體來說,核發者現在是 https://accounts.google.com,並使用 https 結構定義。

遷移過程中,您的伺服器需要驗證新舊 Android 用戶端的 ID 權杖。如要驗證兩種權杖格式,請對照您使用的用戶端程式庫進行變更 (如有使用):

  • Java (Google API 用戶端程式庫):升級至 1.21.0 以上版本
  • PHP (Google API 用戶端程式庫):如果您使用 v1,請升級至 1.1.6 以上版本;如果您使用 v2,請升級至 2.0.0-RC1 以上版本
  • Node.js:請升級至 0.9.7 以上版本
  • Python 或您自己的實作:接受以下兩個核發者:https://accounts.google.comaccounts.google.com

從 GoogleAuthUtil 伺服器驗證碼流程遷移

如果您使用 GoogleAuthUtil 取得伺服器驗證碼,則應遷移至新的 Sign-In API 驗證碼流程

舉例來說,如果您的 Android 程式碼類似以下範例,則應遷移:

Android 代碼

在這個範例中,伺服器驗證碼要求使用 oauth2:server:client_id + 網路伺服器的用戶端 ID 做為 GoogleAuthUtil.getToken 呼叫 (oauth2:server:client_id:9414861317621.apps.googleusercontent.com) 的 scope 參數。

新版 Sign-In API 驗證碼流程的優點如下:

  • 簡單易用的單鍵登入體驗
  • 按照下方的遷移指南操作時,當您進行驗證碼交換時,伺服器可以取得包含使用者個人資料的 ID 權杖

如要遷移至新驗證碼流程,請進行下列變更:

Android 用戶端

  • 視需要移除「GET_ACCOUNTS」(聯絡人) 權限
  • 使用 GoogleSignInOptions.Builder.requestServerAuthCode(...) 設定,將任何使用 GoogleAuthUtilPlus.APIAccountPicker.newChooseAccountIntent()AccountManager.newChooseAccountIntent() 的程式碼切換為 Auth.GOOGLE_SIGN_IN_API

伺服器端

保留目前的程式碼,但建立 GoogleAuthorizationCodeTokenRequest 物件時,將 https://oauth2.googleapis.com/token 指定為權杖伺服器端點,這樣您就能透過使用者的電子郵件地址、使用者 ID 和設定檔資訊取得 ID 權杖,不需要其他網路呼叫。此端點可完全回溯相容,而下列程式碼適用於從新舊 Android 用戶端實作項目擷取的伺服器驗證碼。

GoogleTokenResponse tokenResponse = new GoogleAuthorizationCodeTokenRequest(
                transport,
                jsonFactory,
                // Use below for tokenServerEncodedUrl parameter
                "https://oauth2.googleapis.com/token",
                clientSecrets.getDetails().getClientId(),
                clientSecrets.getDetails().getClientSecret(),
                authCode,
                REDIRECT_URI)
               .execute();

...

// You can also get an ID token from auth code exchange.
GoogleIdToken googleIdToken = tokenResponse.parseIdToken();
GoogleIdTokenVerifier verifier = new GoogleIdTokenVerifier.Builder(transport, jsonFactory)
        .setAudience(Arrays.asList(SERVER_CLIENT_ID))
        .setIssuer("https://accounts.google.com")
        .build();
// Refer to ID token documentation to see how to get data from idToken object.
GoogleIdToken idToken = verifier.verify(idTokenString);
...