Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

在 Android 上使用 OpenID Connect 進行驗證

如果您已升級至 Firebase Authentication with Identity Platform，可以使用符合 OpenID Connect (OIDC) 標準的自選提供者，透過 Firebase 驗證使用者。因此，您可以使用 Firebase 原生不支援的身分提供者。

事前準備

如要使用 OIDC 提供者登入使用者，請先從提供者收集一些資訊：

用戶端 ID：供應商專屬的字串，用於識別您的應用程式。供應商可能會為您支援的每個平台指派不同的用戶端 ID。這是您供應商核發 ID 權杖中的 aud 聲明值之一。
用戶端密鑰：供應商用來確認用戶端 ID 擁有權的密鑰字串。每個用戶端 ID 都需要相符的用戶端密鑰。 (只有在使用授權碼流程時才需要這個值，強烈建議您使用授權碼流程。)
簽發者：用於識別供應商的字串。這個值必須是網址，附加 /.well-known/openid-configuration 後，即為供應商 OIDC 探索文件的位置。舉例來說，如果發行者是 https://auth.example.com，探索文件必須位於 https://auth.example.com/.well-known/openid-configuration。

取得上述資訊後，請為 Firebase 專案啟用 OpenID Connect 做為登入供應商：

將 Firebase 新增至 Android 專案。
如果尚未升級至 Firebase Authentication with Identity Platform，請先升級。只有升級後的專案才能使用 OpenID Connect 驗證。
在 Firebase 控制台的「登入供應商」頁面中，按一下「新增供應商」，然後按一下「OpenID Connect」。
選取要使用授權碼流程或隱含授權流程。

如果供應商支援，您應一律使用程式碼流程。隱含流程的安全性較低，強烈建議不要使用。
為這個供應商命名。記下系統產生的供應商 ID，例如 oidc.example-provider。在應用程式中加入登入程式碼時，您需要這個 ID。
指定用戶端 ID 和用戶端密碼，以及供應商的簽發者字串。這些值必須與供應商指派給您的值完全一致。
儲存變更。

使用 Firebase SDK 處理登入流程

如果您要建構 Android 應用程式，使用 OIDC 供應商透過 Firebase 驗證使用者身分最簡單的方法，就是使用 Firebase Android SDK 處理整個登入流程。

如要使用 Firebase Android SDK 處理登入流程，請按照下列步驟操作：

使用 Builder 建構 OAuthProvider 的執行個體，並提供供應商的 ID

Kotlin

val providerBuilder = OAuthProvider.newBuilder("oidc.example-provider")GenericIdpActivity.kt

Java

OAuthProvider.Builder providerBuilder = OAuthProvider.newBuilder("oidc.example-provider");GenericIdpActivity.java

選用：指定要隨 OAuth 要求傳送的其他自訂 OAuth 參數。
Kotlin
// Target specific email with login hint. providerBuilder.addCustomParameter("login_hint", "user@example.com")
GenericIdpActivity.kt
Java
// Target specific email with login hint. providerBuilder.addCustomParameter("login_hint", "user@example.com");
GenericIdpActivity.java
請洽詢 OIDC 供應商，瞭解他們支援的參數。請注意，您無法使用 setCustomParameters() 傳遞 Firebase 必要參數。這些參數包括 client_id、response_type、redirect_uri、state、scope 和 response_mode。

選用：指定基本設定檔以外的其他 OAuth 2.0 範圍，以便向驗證供應商提出要求。

Kotlin

// Request read access to a user's email addresses.
// This must be preconfigured in the app's API permissions.
providerBuilder.scopes = listOf("mail.read", "calendars.read")GenericIdpActivity.kt

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>() {
            {
                add("mail.read");
                add("calendars.read");
            }
        };
providerBuilder.setScopes(scopes);GenericIdpActivity.java

請洽詢 OIDC 供應商，瞭解他們使用的範圍。

使用 OAuth 供應商物件向 Firebase 進行驗證。請注意，與其他 FirebaseAuth 作業不同，這項作業會彈出 Custom Chrome Tab，接管您的 UI。因此，請勿在您附加的 OnSuccessListener 和 OnFailureListener 中參照 Activity，因為作業啟動 UI 時，這些項目會立即分離。

請先確認是否已收到回覆。使用這種方法登入時，系統會將活動移至背景，也就是說，系統可以在登入流程中回收活動。為確保使用者不會在發生這種情況時重試，您應檢查是否已存在結果。

如要檢查是否有待處理的結果，請呼叫 getPendingAuthResult：

Kotlin

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.
}GenericIdpActivity.kt

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.
}GenericIdpActivity.java

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

Kotlin

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.
    }GenericIdpActivity.kt

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.
                    }
                });GenericIdpActivity.java

雖然上述範例著重於登入流程，但您也可以使用 startActivityForLinkWithProvider，將 OIDC 提供者連結至現有使用者。舉例來說，您可以將多個供應商連結至同一位使用者，讓使用者透過任一供應商登入。

Kotlin

// 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.
    }GenericIdpActivity.kt

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.
                    }
                });GenericIdpActivity.java

您可以使用 startActivityForReauthenticateWithProvider 採用相同模式，擷取需要最近登入的敏感作業的新憑證。

Kotlin

// 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.
    }GenericIdpActivity.kt

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.
                    }
                });GenericIdpActivity.java

手動處理登入流程

如果您已在應用程式中實作 OpenID Connect 登入流程，可以直接使用 ID 權杖向 Firebase 進行驗證：

Kotlin

val providerId = "oidc.example-provider" // As registered in Firebase console.
val credential = oAuthCredential(providerId) {
    setIdToken(idToken) // ID token from OpenID Connect flow.
}
Firebase.auth
    .signInWithCredential(credential)
    .addOnSuccessListener { authResult ->
        // User is signed in.

        // IdP data available in:
        //    authResult.additionalUserInfo.profile
    }
    .addOnFailureListener { e ->
        // Handle failure.
    }GenericIdpActivity.kt

Java

AuthCredential credential = OAuthProvider
        .newCredentialBuilder("oidc.example-provider")  // As registered in Firebase console.
        .setIdToken(idToken)  // ID token from OpenID Connect flow.
        .build();
FirebaseAuth.getInstance()
        .signInWithCredential(credential)
        .addOnSuccessListener(new OnSuccessListener<AuthResult>() {
            @Override
            public void onSuccess(AuthResult authResult) {
                // User is signed in.

                // IdP data available in:
                //    authResult.getAdditionalUserInfo().getProfile()
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                // Handle failure.
            }
        });GenericIdpActivity.java

後續步驟

使用者首次登入後，系統會建立新的使用者帳戶，並連結至使用者登入時使用的憑證 (即使用者名稱和密碼、電話號碼或驗證供應商資訊)。這個新帳戶會儲存在 Firebase 專案中，可用於識別專案中每個應用程式的使用者，無論使用者登入方式為何。

在應用程式中，您可以從 FirebaseUser 物件取得使用者的基本個人資料資訊。請參閱「管理使用者」。
在 Firebase Realtime Database 和 Cloud Storage 安全規則中，您可以從 auth 變數取得已登入使用者的專屬使用者 ID，並使用該 ID 控制使用者可存取的資料。

您可以將驗證供應商憑證連結至現有使用者帳戶，允許使用者透過多個驗證供應商登入應用程式。

如要登出使用者，請呼叫 signOut：

Kotlin

Firebase.auth.signOut()MainActivity.kt

Java

FirebaseAuth.getInstance().signOut();MainActivity.java

在 Android 上使用 OpenID Connect 進行驗證 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

事前準備

使用 Firebase SDK 處理登入流程

Kotlin

Java

Kotlin

Java

Kotlin

Java

Kotlin

Java

Kotlin

Java

Kotlin

Java

Kotlin

Java

手動處理登入流程

Kotlin

Java

後續步驟

Kotlin

Java

在 Android 上使用 OpenID Connect 進行驗證