在 Android 上使用 GitHub 進行驗證

您可以讓使用者利用 GitHub 帳戶向 Firebase 進行驗證 使用 Firebase，將網頁式通用 OAuth 登入整合至您的應用程式 執行端對端登入流程的 SDK。

事前準備

如要使用 GitHub 帳戶登入使用者，您必須先啟用 GitHub 做為 用來登入 Firebase 專案的登入供應商：

  1. 如果還沒試過 將 Firebase 新增至您的 Android 專案。

  2. 在 Firebase 控制台中開啟「Auth」專區。
  3. 在「Sign in method」分頁中，啟用 GitHub 供應商。
  4. 將供應商開發人員主控台中的「用戶端 ID」和「用戶端密鑰」新增至 提供者設定：
    1. 註冊應用程式 下載為 GitHub 上的開發人員應用程式，並取得應用程式的 OAuth 2.0 用戶端 ID 和用戶端密鑰。
    2. 請確認您的 Firebase OAuth 重新導向 URI (例如 my-app-12345.firebaseapp.com/__/auth/handler) 在應用程式「設定」頁面的「授權回呼網址」中， GitHub 應用程式的設定。
  5. 按一下 [儲存]。

  6. 在模組 (應用程式層級) Gradle 檔案中 (通常為 <project>/<app-module>/build.gradle.kts 或 <project>/<app-module>/build.gradle)、 新增 Android Firebase Authentication 程式庫的依附元件。建議您使用 Firebase Android BoM敬上 管理程式庫版本管理 

    dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.5.1"))

    // Add the dependency for the Firebase Authentication library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-auth")
}

    只要使用 Firebase Android BoM， 應用程式一律會使用相容的 Firebase Android 程式庫版本。

    (替代做法) 新增 Firebase 程式庫依附元件，「不使用」 BoM

    如果選擇不使用 Firebase BoM，請指定各個 Firebase 程式庫版本 都屬於依附元件行

    請注意，如果您在應用程式中使用多個 Firebase 程式庫，強烈建議您 建議使用 BoM 管理程式庫版本，確保所有版本 相容。 

    dependencies {
    // Add the dependency for the Firebase Authentication library
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-auth:23.1.0")
}
    敬上     在尋找 Kotlin 專用的程式庫模組嗎？距離開始還有 2023 年 10 月 (Firebase BoM 32.5.0)，Kotlin 和 Java 開發人員皆可 依附於主要程式庫模組 (詳情請參閱 這項計畫的常見問題)。

  7. 如果您尚未指定應用程式的 SHA-1 指紋，請按照 設定頁面 Firebase控制台中就能保留這項資訊詳情請參閱 驗證用戶端 ，進一步瞭解如何取得應用程式的 SHA-1 指紋。

使用 Firebase SDK 處理登入流程

如要建構 Android 應用程式，最簡單的使用者驗證方式 與 Firebase 的系統登入 Firebase Android SDK 流程

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

  1. 使用其 建構工具，使用其 OAuthProvider 實例。 提供者 ID github.com

    Kotlin+KTX 

    val provider = OAuthProvider.newBuilder("github.com")
    GenericIdpActivity.kt

    Java 

    OAuthProvider.Builder provider = OAuthProvider.newBuilder("github.com");
    GenericIdpActivity.java

  2. 選用：指定您想要的其他自訂 OAuth 參數。 與 OAuth 要求一起傳送

    Kotlin+KTX 

    // Target specific email with login hint.
provider.addCustomParameter("login", "your-email@gmail.com")
    GenericIdpActivity.kt

    Java 

    // Target specific email with login hint.
provider.addCustomParameter("login", "your-email@gmail.com");
    GenericIdpActivity.java

    如需 GitHub 支援的參數，請參閱 GitHub OAuth 說明文件。 請注意，您無法透過 setCustomParameters()。這些參數都是 client_id response_type、redirect_uri、state、scope 和 response_mode：

  3. 選用：指定基本設定檔以外的其他 OAuth 2.0 範圍， 設為要向驗證服務供應商發出要求如果您的應用程式 需要透過 GitHub API 存取使用者的私人資料，您必須 要求存取 GitHub API 的 API 權限 GitHub 開發人員主控台。要求的 OAuth 範圍必須與 請前往應用程式的 API 權限頁面查看預先設定的資源。

    Kotlin+KTX 

    // Request read access to a user's email addresses.
// This must be preconfigured in the app's API permissions.
provider.scopes = listOf("user:email")
    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("user:email");
            }
        };
provider.setScopes(scopes);
    GenericIdpActivity.java

  4. 使用 OAuth 提供者物件向 Firebase 進行驗證。請注意，這不像 其他 FirebaseAuth 作業，系統會彈出 自訂 Chrome 分頁。 因此，請勿在 OnSuccessListener 中參照活動 以及您附加的 OnFailureListener。這些容器會在 作業就會啟動 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.
}
    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+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.
    }
    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

    成功完成後， 可以從傳回的 OAuthCredential 物件中擷取。

    使用 OAuth 存取權杖可讓您呼叫 GitHub API。

    例如，如要取得基本個人資料資訊 您可以呼叫 REST API 透過 Authorization 標頭傳遞存取權杖：

  5. 以上範例著重登入流程，不過您可以 能讓您使用 startActivityForLinkWithProvider。舉例來說 以便將兩者登入

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

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

後續步驟

使用者首次登入後，系統會建立新的使用者帳戶 也就是使用者的名稱和密碼 號碼或驗證提供者資訊，也就是使用者登入時使用的網址。這項新功能 帳戶儲存為 Firebase 專案的一部分，可用來識別 即可限制使用者登入專案中的所有應用程式

  • 在您的應用程式中，您可以透過 FirebaseUser 物件。詳情請參閱 管理使用者。

  • 在你的Firebase Realtime Database和Cloud Storage中 查看安全性規則 透過 auth 變數取得已登入使用者的不重複使用者 ID。 控管使用者可以存取的資料

您可以讓使用者透過多重驗證機制登入您的應用程式 將驗證供應商憑證連結至 現有的使用者帳戶

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

Kotlin+KTX

Firebase.auth.signOut()
MainActivity.kt

Java

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