Xác thực bằng GitHub trên Android

Bạn có thể cho phép người dùng xác thực bằng Firebase bằng tài khoản GitHub của họ bằng cách tích hợp tính năng Đăng nhập OAuth chung trên web vào ứng dụng của bạn bằng SDK Firebase để thực hiện quy trình đăng nhập toàn diện.

Trước khi bắt đầu

Để người dùng đăng nhập bằng tài khoản GitHub, trước tiên, bạn phải bật GitHub làm nhà cung cấp dịch vụ đăng nhập cho dự án Firebase:

  1. Nếu bạn chưa thực hiện, hãy thêm Firebase vào dự án Android.

  2. Trong bảng điều khiển Firebase, hãy mở phần Auth (Xác thực).
  3. Trên thẻ Phương thức đăng nhập, hãy bật trình cung cấp GitHub.
  4. Thêm Mã ứng dụng kháchMật khẩu ứng dụng khách từ bảng điều khiển dành cho nhà phát triển của nhà cung cấp đó vào cấu hình nhà cung cấp:
    1. Đăng ký ứng dụng làm ứng dụng dành cho nhà phát triển trên GitHub và lấy Mã ứng dụngKhoá bí mật của ứng dụng OAuth 2.0.
    2. Đảm bảo rằng URI chuyển hướng OAuth của Firebase (ví dụ: my-app-12345.firebaseapp.com/__/auth/handler) được đặt làm URL gọi lại uỷ quyền trong trang cài đặt của ứng dụng trên cấu hình của ứng dụng GitHub.
  5. Nhấp vào Lưu.
  6. Trong tệp Gradle (ở cấp ứng dụng) của mô-đun (thường là <project>/<app-module>/build.gradle.kts hoặc <project>/<app-module>/build.gradle), hãy thêm phần phụ thuộc cho thư viện Firebase Authentication dành cho Android. Bạn nên sử dụng Firebase Android BoM để kiểm soát việc tạo phiên bản thư viện.

    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:33.7.0"))
    
        // 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")
    }

    Bằng cách sử dụng Firebase Android BoM, ứng dụng của bạn sẽ luôn sử dụng những phiên bản tương thích của thư viện Android trên Firebase.

    (Phương án thay thế)  Thêm các phần phụ thuộc thư viện Firebase mà không sử dụng BoM

    Nếu chọn không sử dụng Firebase BoM, bạn phải chỉ định từng phiên bản thư viện Firebase trong dòng phần phụ thuộc của thư viện đó.

    Xin lưu ý rằng nếu sử dụng nhiều thư viện Firebase trong ứng dụng, bạn nên sử dụng BoM để quản lý các phiên bản thư viện, nhằm đảm bảo tất cả phiên bản đều tương thích.

    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")
    }
    Bạn đang tìm kiếm mô-đun thư viện dành riêng cho Kotlin? Kể từ tháng 10 năm 2023 (Firebase BoM 32.5.0), cả nhà phát triển Kotlin và Java đều có thể phụ thuộc vào mô-đun thư viện chính (để biết thông tin chi tiết, hãy xem Câu hỏi thường gặp về sáng kiến này).

  7. Nếu bạn chưa chỉ định vân tay số SHA-1 của ứng dụng, hãy thực hiện việc này trên trang Cài đặt của bảng điều khiển Firebase. Hãy tham khảo phần Xác thực ứng dụng để biết thông tin chi tiết về cách lấy vân tay số SHA-1 của ứng dụng.

Xử lý quy trình đăng nhập bằng SDK Firebase

Nếu bạn đang xây dựng một ứng dụng Android, cách dễ nhất để xác thực người dùng bằng Firebase thông qua tài khoản GitHub của họ là xử lý toàn bộ quy trình đăng nhập bằng SDK Android Firebase.

Để xử lý quy trình đăng nhập bằng SDK Firebase cho Android, hãy làm theo các bước sau:

  1. Tạo một thực thể của OAuthProvider bằng cách sử dụng Builder (Trình tạo) của thực thể đó với mã nhận dạng nhà cung cấp github.com

    Kotlin

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

    Java

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

  2. Không bắt buộc: Chỉ định các thông số OAuth tuỳ chỉnh bổ sung mà bạn muốn gửi cùng với yêu cầu OAuth.

    Kotlin

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

    Java

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

    Để biết các tham số mà GitHub hỗ trợ, hãy xem tài liệu về GitHub OAuth. Xin lưu ý rằng bạn không thể truyền các tham số bắt buộc của Firebase bằng setCustomParameters(). Các tham số này là client_id, response_type, redirect_uri, state, scoperesponse_mode.

  3. Không bắt buộc: Chỉ định các phạm vi OAuth 2.0 khác ngoài hồ sơ cơ bản mà bạn muốn yêu cầu từ nhà cung cấp dịch vụ xác thực. Nếu ứng dụng của bạn yêu cầu quyền truy cập vào dữ liệu riêng tư của người dùng từ các API GitHub, bạn cần yêu cầu quyền truy cập vào các API GitHub trong phần Quyền truy cập API trong bảng điều khiển dành cho nhà phát triển GitHub. Phạm vi OAuth được yêu cầu phải khớp chính xác với phạm vi được định cấu hình trước trong quyền API của ứng dụng.

    Kotlin

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

    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);

  4. Xác thực bằng Firebase bằng đối tượng nhà cung cấp OAuth. Xin lưu ý rằng không giống như các thao tác khác của FirebaseAuth, thao tác này sẽ kiểm soát giao diện người dùng của bạn bằng cách bật lên một Thẻ tuỳ chỉnh của Chrome. Do đó, đừng tham chiếu Hoạt động của bạn trong OnSuccessListenerOnFailureListener mà bạn đính kèm vì các hoạt động này sẽ tách ngay khi thao tác bắt đầu giao diện người dùng.

    Trước tiên, bạn nên kiểm tra xem bạn đã nhận được phản hồi hay chưa. Việc đăng nhập thông qua phương thức này sẽ đưa Hoạt động của bạn vào chế độ nền, tức là hệ thống có thể thu hồi hoạt động đó trong quy trình đăng nhập. Để đảm bảo rằng bạn không yêu cầu người dùng thử lại nếu điều này xảy ra, bạn nên kiểm tra xem có kết quả nào không.

    Để kiểm tra xem có kết quả nào đang chờ xử lý hay không, hãy gọi 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.
    }

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

    Để bắt đầu quy trình đăng nhập, hãy gọi 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.
        }

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

    Sau khi hoàn tất, bạn có thể truy xuất mã thông báo truy cập OAuth liên kết với nhà cung cấp từ đối tượng OAuthCredential được trả về.

    Bằng cách sử dụng mã truy cập OAuth, bạn có thể gọi GitHub API.

    Ví dụ: để lấy thông tin hồ sơ cơ bản, bạn có thể gọi API REST, truyền mã truy cập trong tiêu đề Authorization:

  5. Mặc dù các ví dụ trên tập trung vào quy trình đăng nhập, nhưng bạn cũng có thể liên kết nhà cung cấp GitHub với một người dùng hiện có bằng cách sử dụng startActivityForLinkWithProvider. Ví dụ: bạn có thể liên kết nhiều nhà cung cấp với cùng một người dùng để cho phép họ đăng nhập bằng bất kỳ nhà cung cấp nào.

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

    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. Bạn có thể sử dụng cùng một mẫu với startActivityForReauthenticateWithProvider để truy xuất thông tin xác thực mới cho các thao tác nhạy cảm cần đăng nhập gần đây.

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

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

Các bước tiếp theo

Sau khi người dùng đăng nhập lần đầu, một tài khoản người dùng mới sẽ được tạo và liên kết với thông tin xác thực (tức là tên người dùng và mật khẩu, số điện thoại hoặc thông tin về nhà cung cấp xác thực) mà người dùng đã đăng nhập. Tài khoản mới này được lưu trữ trong dự án Firebase và có thể được dùng để xác định người dùng trên mọi ứng dụng trong dự án, bất kể người dùng đăng nhập như thế nào.

  • Trong ứng dụng, bạn có thể lấy thông tin hồ sơ cơ bản của người dùng từ đối tượng FirebaseUser. Xem phần Quản lý người dùng.

  • Trong Quy tắc bảo mật Firebase Realtime DatabaseCloud Storage, bạn có thể lấy mã nhận dạng người dùng riêng biệt của người dùng đã đăng nhập từ biến auth và sử dụng mã nhận dạng đó để kiểm soát dữ liệu mà người dùng có thể truy cập.

Bạn có thể cho phép người dùng đăng nhập vào ứng dụng của bạn bằng nhiều trình cung cấp dịch vụ xác thực bằng cách liên kết thông tin xác thực của trình cung cấp dịch vụ xác thực với một tài khoản người dùng hiện có.

Để đăng xuất người dùng, hãy gọi signOut:

Kotlin

Firebase.auth.signOut()

Java

FirebaseAuth.getInstance().signOut();