在 Android 上使用 Yahoo 驗證

您可以藉助 Firebase SDK 將網頁式一般 OAuth 登入整合到應用程式中,讓使用者執行端對端的登入流程,藉此讓使用者透過 OAuth 供應商 (例如 Yahoo) 進行 Firebase 驗證。

事前準備

如要使用 Yahoo 帳戶登入使用者,您必須先針對 Firebase 專案啟用 Yahoo 做為登入供應商:

  1. 將 Firebase 新增至您的 Android 專案

  2. Firebase 控制台,開啟「Auth」(驗證) 區段。
  3. 在「Sign in method」分頁中,啟用 Yahoo 供應商。
  4. 將該供應商的開發人員控制台中的用戶端 ID用戶端密鑰,新增至提供者設定:
    1. 如要註冊 Yahoo OAuth 用戶端,請按照 Yahoo 開發人員說明文件, 透過 Yahoo 註冊網頁應用程式

      請務必選取兩項 OpenID Connect API 權限:profileemail

    2. 向這些供應商註冊應用程式時,請務必將專案的 *.firebaseapp.com 網域註冊為應用程式的重新導向網域。
  5. 點選「Save」
  6. 如果您尚未指定應用程式的 SHA-1 指紋,請前往 Firebase 控制台的設定頁面指定。如要進一步瞭解如何取得應用程式的 SHA-1 指紋,請參閱「驗證用戶端」一文。

透過 Firebase SDK 處理登入流程

如果您要建構 Android 應用程式,最簡單的方法是使用 Firebase 帳戶以透過 Firebase 驗證使用者,最簡單的方法是使用 Firebase Android SDK 處理整個登入流程。

如要透過 Firebase Android SDK 處理登入流程,請按照下列步驟操作:

  1. 使用 Builder 做為提供者 ID yahoo.com,建構 OAuthProvider 的執行個體。

    Kotlin+KTX

    val provider = OAuthProvider.newBuilder("yahoo.com")

    Java

    OAuthProvider.Builder provider = OAuthProvider.newBuilder("yahoo.com");

  2. 選用:指定要與 OAuth 要求一併傳送的其他自訂 OAuth 參數。

    Kotlin+KTX

    // Prompt user to re-authenticate to Yahoo.
    provider.addCustomParameter("prompt", "login")
    
    // Localize to French.
    provider.addCustomParameter("language", "fr")

    Java

    // Prompt user to re-authenticate to Yahoo.
    provider.addCustomParameter("prompt", "login");
    
    // Localize to French.
    provider.addCustomParameter("language", "fr");

    如需 Yahoo 支援的參數,請參閱 Yahoo OAuth 說明文件。請注意,您無法透過 setCustomParameters() 傳遞 Firebase 必要參數。這些參數分別是 client_idredirect_uriresponse_typescopestate

  3. 選用:指定您要向驗證供應商要求取得的其他 OAuth 2.0 範圍,同時超過 profileemail。如果您的應用程式需要透過 Yahoo API 存取使用者私人資料,您必須前往 Yahoo Developer Console 的「API 權限」頁面要求 Yahoo API 的權限。要求的 OAuth 範圍必須與應用程式 API 權限中的預先設定範圍完全相符。舉例來說,如果應用程式要求讀取/寫入存取權,並在應用程式的 API 權限中預先設定,則必須傳遞 sdct-w,而不是唯讀 OAuth 範圍 sdct-r。否則流程將會失敗,且使用者會看到錯誤訊息。

    Kotlin+KTX

    // Request read access to a user's email addresses.
    // This must be preconfigured in the app's API permissions.
    provider.scopes = listOf("mail-r", "sdct-w")

    Java

    // Request read access to a user's email addresses.
    // This must be preconfigured in the app's API permissions.
    List<String> scopes =
            new ArrayList<String>() {
                {
                    // Request access to Yahoo Mail API.
                    add("mail-r");
                    // This must be preconfigured in the app's API permissions.
                    add("sdct-w");
                }
            };
    provider.setScopes(scopes);
    詳情請參閱 Yahoo 範圍說明文件

  4. 使用 OAuth 提供者物件進行 Firebase 驗證。請注意,與其他 FirebaseAuth 作業不同,系統會彈出自訂 Chrome 分頁來控管 UI。因此,請勿在您附加的 OnSuccessListeners 和 OnFailureListeners 中參照您的活動,因為作業在作業啟動 UI 時將立即中斷連線。

    請先檢查是否已收到回覆。如果您透過這種方式登入,活動會在背景中保留,這表示系統可以在登入流程中取回活動。為確保使用者不會遇到這種情況,請檢查結果是否已存在。

    如要查看是否有待處理的結果,請呼叫 getPendingAuthResult

    Kotlin+KTX

    val pendingResultTask = firebaseAuth.pendingAuthResult
    if (pendingResultTask != null) {
        // There's something already here! Finish the sign-in for your user.
        pendingResultTask
            .addOnSuccessListener {
                // User is signed in.
                // IdP data available in
                // authResult.getAdditionalUserInfo().getProfile().
                // The OAuth access token can also be retrieved:
                // ((OAuthCredential)authResult.getCredential()).getAccessToken().
                // The OAuth secret can be retrieved by calling:
                // ((OAuthCredential)authResult.getCredential()).getSecret().
            }
            .addOnFailureListener {
                // Handle failure.
            }
    } else {
        // There's no pending result so you need to start the sign-in flow.
        // See below.
    }

    Java

    Task<AuthResult> pendingResultTask = firebaseAuth.getPendingAuthResult();
    if (pendingResultTask != null) {
        // There's something already here! Finish the sign-in for your user.
        pendingResultTask
                .addOnSuccessListener(
                        new OnSuccessListener<AuthResult>() {
                            @Override
                            public void onSuccess(AuthResult authResult) {
                                // User is signed in.
                                // IdP data available in
                                // authResult.getAdditionalUserInfo().getProfile().
                                // The OAuth access token can also be retrieved:
                                // ((OAuthCredential)authResult.getCredential()).getAccessToken().
                                // The OAuth secret can be retrieved by calling:
                                // ((OAuthCredential)authResult.getCredential()).getSecret().
                            }
                        })
                .addOnFailureListener(
                        new OnFailureListener() {
                            @Override
                            public void onFailure(@NonNull Exception e) {
                                // Handle failure.
                            }
                        });
    } else {
        // There's no pending result so you need to start the sign-in flow.
        // See below.
    }

    如要啟動登入流程,請呼叫 startActivityForSignInWithProvider

    Kotlin+KTX

    firebaseAuth
        .startActivityForSignInWithProvider(activity, provider.build())
        .addOnSuccessListener {
            // User is signed in.
            // IdP data available in
            // authResult.getAdditionalUserInfo().getProfile().
            // The OAuth access token can also be retrieved:
            // ((OAuthCredential)authResult.getCredential()).getAccessToken().
            // The OAuth secret can be retrieved by calling:
            // ((OAuthCredential)authResult.getCredential()).getSecret().
        }
        .addOnFailureListener {
            // Handle failure.
        }

    Java

    firebaseAuth
            .startActivityForSignInWithProvider(/* activity= */ this, provider.build())
            .addOnSuccessListener(
                    new OnSuccessListener<AuthResult>() {
                        @Override
                        public void onSuccess(AuthResult authResult) {
                            // User is signed in.
                            // IdP data available in
                            // authResult.getAdditionalUserInfo().getProfile().
                            // The OAuth access token can also be retrieved:
                            // ((OAuthCredential)authResult.getCredential()).getAccessToken().
                            // The OAuth secret can be retrieved by calling:
                            // ((OAuthCredential)authResult.getCredential()).getSecret().
                        }
                    })
            .addOnFailureListener(
                    new OnFailureListener() {
                        @Override
                        public void onFailure(@NonNull Exception e) {
                            // Handle failure.
                        }
                    });

    成功完成後,就能從傳回的 OAuthCredential 物件中擷取與提供者相關聯的 OAuth 存取權杖。

    您可以使用 OAuth 存取權杖呼叫 Yahoo API

    其中 YAHOO_USER_UID 是 Yahoo 使用者 ID,可從 firebaseAuth.getCurrentUser().getProviderData().get(0).getUid() 欄位或 authResult.getAdditionalUserInfo().getProfile() 剖析。

  5. 雖然上述範例以登入流程為主,但您也可以使用 startActivityForLinkWithProvider 將 Yahoo 供應商連結至現有使用者。舉例來說,您可以將多個提供者連結至同一使用者,讓他們能夠使用任一提供者登入。

    Kotlin+KTX

    // The user is already signed-in.
    val firebaseUser = firebaseAuth.currentUser!!
    firebaseUser
        .startActivityForLinkWithProvider(activity, provider.build())
        .addOnSuccessListener {
            // Provider credential is linked to the current user.
            // IdP data available in
            // authResult.getAdditionalUserInfo().getProfile().
            // The OAuth access token can also be retrieved:
            // authResult.getCredential().getAccessToken().
            // The OAuth secret can be retrieved by calling:
            // authResult.getCredential().getSecret().
        }
        .addOnFailureListener {
            // Handle failure.
        }

    Java

    // The user is already signed-in.
    FirebaseUser firebaseUser = firebaseAuth.getCurrentUser();
    
    firebaseUser
            .startActivityForLinkWithProvider(/* activity= */ this, provider.build())
            .addOnSuccessListener(
                    new OnSuccessListener<AuthResult>() {
                        @Override
                        public void onSuccess(AuthResult authResult) {
                            // Provider credential is linked to the current user.
                            // IdP data available in
                            // authResult.getAdditionalUserInfo().getProfile().
                            // The OAuth access token can also be retrieved:
                            // authResult.getCredential().getAccessToken().
                            // The OAuth secret can be retrieved by calling:
                            // authResult.getCredential().getSecret().
                        }
                    })
            .addOnFailureListener(
                    new OnFailureListener() {
                        @Override
                        public void onFailure(@NonNull Exception e) {
                            // Handle failure.
                        }
                    });

  6. 相同的模式可與 startActivityForReauthenticateWithProvider 搭配使用,用於針對需要近期登入的敏感作業擷取新的憑證。

    Kotlin+KTX

    // The user is already signed-in.
    val firebaseUser = firebaseAuth.currentUser!!
    firebaseUser
        .startActivityForReauthenticateWithProvider(activity, provider.build())
        .addOnSuccessListener {
            // User is re-authenticated with fresh tokens and
            // should be able to perform sensitive operations
            // like account deletion and email or password
            // update.
        }
        .addOnFailureListener {
            // Handle failure.
        }

    Java

    // The user is already signed-in.
    FirebaseUser firebaseUser = firebaseAuth.getCurrentUser();
    
    firebaseUser
            .startActivityForReauthenticateWithProvider(/* activity= */ this, provider.build())
            .addOnSuccessListener(
                    new OnSuccessListener<AuthResult>() {
                        @Override
                        public void onSuccess(AuthResult authResult) {
                            // User is re-authenticated with fresh tokens and
                            // should be able to perform sensitive operations
                            // like account deletion and email or password
                            // update.
                        }
                    })
            .addOnFailureListener(
                    new OnFailureListener() {
                        @Override
                        public void onFailure(@NonNull Exception e) {
                            // Handle failure.
                        }
                    });

後續步驟

使用者首次登入後,系統會建立新的使用者帳戶,並連結至用來登入的使用者憑證,也就是使用者名稱與密碼、電話號碼或驗證提供者資訊。這個新帳戶以 Firebase 專案的形式儲存,無論使用者以何種方式登入,都能從專案中的每個應用程式識別使用者。

  • 在應用程式中,您可以從 FirebaseUser 物件取得使用者的基本個人資料。請參閱「 管理使用者」一文。

  • 在 Firebase 即時資料庫和 Cloud Storage 安全性規則中,您可以從 auth 變數取得已登入使用者的專屬 ID,並使用該 ID 控管使用者可存取的資料。

您可以將驗證提供者憑證連結至現有的使用者帳戶,讓使用者透過多個驗證提供者登入您的應用程式。

如要登出使用者,請呼叫 signOut

Kotlin+KTX

Firebase.auth.signOut()

Java

FirebaseAuth.getInstance().signOut();