Catch up on highlights from Firebase at Google I/O 2023. Learn more

Xác thực bằng GitHub trên Nền tảng Apple

Bạn có thể cho phép người dùng của mình xác thực với Firebase bằng cách sử dụng các nhà cung cấp OAuth như GitHub bằng cách tích hợp Đăng nhập OAuth chung vào ứng dụng của bạn bằng SDK Firebase để thực hiện quy trình đăng nhập từ đầu đến cuối.

Trước khi bắt đầu

Để đăng nhập người dùng 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 của mình:

Sử dụng Trình quản lý gói Swift để cài đặt và quản lý các phần phụ thuộc của Firebase.

  1. Trong Xcode, khi dự án ứng dụng của bạn đang mở, hãy điều hướng đến File > Add Packages .
  2. Khi được nhắc, hãy thêm kho lưu trữ SDK nền tảng Apple của Firebase:
  3.   https://github.com/firebase/firebase-ios-sdk
  4. Chọn thư viện Xác thực Firebase.
  5. Khi hoàn tất, Xcode sẽ tự động bắt đầu giải quyết và tải xuống các phần phụ thuộc của bạn trong nền.

Bây giờ, thực hiện một số bước cấu hình:

  1. Trong bảng điều khiển Firebase , hãy mở phần Auth .
  2. Trên tab Phương thức đăng nhập , bật nhà cung cấp GitHub .
  3. Thêm Client IDClient Secret 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 của bạn dưới dạng ứng dụng dành cho nhà phát triển trên GitHub và nhận ID ứng dụng khách OAuth 2.0 và Bí mật ứng dụng khách .
    2. Đảm bảo rằng URI chuyển hướng OAuth Firebase của bạn (ví dụ: my-app-12345.firebaseapp.com/__/auth/handler ) được đặt làm URL gọi lại Ủy quyền trong trang cài đặt của ứng dụng trên cấu hình ứng dụng GitHub của bạn.
  4. Nhấp vào Lưu .

Xử lý luồng đăng nhập bằng SDK Firebase

Để xử lý quy trình đăng nhập bằng SDK nền tảng Apple của Firebase, hãy làm theo các bước sau:

  1. Thêm lược đồ URL tùy chỉnh vào dự án Xcode của bạn:

    1. Mở cấu hình dự án của bạn: nhấp đúp vào tên dự án ở chế độ xem dạng cây bên trái. Chọn ứng dụng của bạn từ phần MỤC TIÊU , sau đó chọn tab Thông tin và mở rộng phần Loại URL .
    2. Nhấp vào nút + và thêm ID ứng dụng đã mã hóa của bạn làm lược đồ URL. Bạn có thể tìm ID ứng dụng đã mã hóa của mình trên trang Cài đặt chung của bảng điều khiển Firebase, trong phần dành cho ứng dụng iOS của bạn. Để trống các trường khác.

      Khi hoàn tất, cấu hình của bạn sẽ trông giống như sau (nhưng với các giá trị dành riêng cho ứng dụng của bạn):

      Ảnh chụp màn hình giao diện thiết lập lược đồ URL tùy chỉnh của Xcode

  2. Tạo phiên bản của OAuthProvider bằng cách sử dụng ID nhà cung cấp github.com .

    Nhanh

        var provider = OAuthProvider(providerID: "github.com")
        

    Mục tiêu-C

        FIROAuthProvider *provider = [FIROAuthProvider providerWithProviderID:@"github.com"];
        
  3. Tùy chọn : Chỉ định các tham số OAuth tùy chỉnh bổ sung mà bạn muốn gửi cùng với yêu cầu OAuth.

    Nhanh

        provider.customParameters = [
          "allow_signup": "false"
        ]
        

    Mục tiêu-C

        [provider setCustomParameters:@{@"allow_signup": @"false"}];
        

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

  4. Tùy chọn : Chỉ định các phạm vi OAuth 2.0 bổ sung ngoài cấu hình cơ bản mà bạn muốn yêu cầu từ nhà cung cấp 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 người dùng riêng tư từ API GitHub, thì bạn sẽ cần yêu cầu quyền truy cập API GitHub trong phần Quyền 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 sẵn trong quyền API của ứng dụng.

    Nhanh

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

    Mục tiêu-C

        // Request read access to a user's email addresses.
        // This must be preconfigured in the app's API permissions.
        [provider setScopes:@[@"user:email"]];
        

    Để tìm hiểu thêm, hãy tham khảo tài liệu về phạm vi GitHub .

  5. Tùy chọn : Nếu bạn muốn tùy chỉnh cách ứng dụng của bạn hiển thị SFSafariViewController hoặc UIWebView khi hiển thị reCAPTCHA cho người dùng, hãy tạo một lớp tùy chỉnh tuân theo giao thức AuthUIDelegate và chuyển lớp đó tới credentialWithUIDelegate .

  6. Xác thực với Firebase bằng đối tượng nhà cung cấp OAuth.

    Nhanh

        provider.getCredentialWith(nil) { credential, error in
          if error != nil {
            // Handle error.
          }
          if credential != nil {
            Auth().signIn(with: credential) { authResult, error in
              if error != nil {
                // Handle error.
              }
              // User is signed in.
              // IdP data available in authResult.additionalUserInfo.profile.
    
              guard let oauthCredential = authResult.credential as? OAuthCredential else { return }
              // GitHub OAuth access token can also be retrieved by:
              // oauthCredential.accessToken
              // GitHub OAuth ID token can be retrieved by calling:
              // oauthCredential.idToken
            }
          }
        }
        

    Mục tiêu-C

        [provider getCredentialWithUIDelegate:nil
                                   completion:^(FIRAuthCredential *_Nullable credential,
                                                NSError *_Nullable error) {
          if (error) {
           // Handle error.
          }
          if (credential) {
            [[FIRAuth auth] signInWithCredential:credential
                                      completion:^(FIRAuthDataResult *_Nullable authResult,
                                                NSError *_Nullable error) {
              if (error) {
                // Handle error.
              }
              // User is signed in.
              // IdP data available in authResult.additionalUserInfo.profile.
    
              FIROAuthCredential *oauthCredential = (FIROAuthCredential *)authResult.credential;
              // GitHub OAuth access token can also be retrieved by:
              // oauthCredential.accessToken
              // GitHub OAuth ID token can be retrieved by calling:
              // oauthCredential.idToken
            }];
          }
        }];
        

    Sử dụng mã thông báo truy cập OAuth, bạn có thể gọi API GitHub .

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

    https://api.github.com/user
    
  7. Mặc dù các ví dụ trên tập trung vào các luồng đăng nhập, nhưng bạn cũng có khả năng liên kết nhà cung cấp GitHub với người dùng hiện có. 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 một trong hai nhà cung cấp.

    Nhanh

        Auth().currentUser.link(withCredential: credential) { authResult, error in
          if error != nil {
            // Handle error.
          }
          // GitHub credential is linked to the current user.
          // IdP data available in authResult.additionalUserInfo.profile.
          // GitHub OAuth access token can also be retrieved by:
          // (authResult.credential as? OAuthCredential)?.accessToken
          // GitHub OAuth ID token can be retrieved by calling:
          // (authResult.credential as? OAuthCredential)?.idToken
        }
        

    Mục tiêu-C

        [[FIRAuth auth].currentUser
            linkWithCredential:credential
                    completion:^(FIRAuthDataResult * _Nullable authResult, NSError * _Nullable error) {
          if (error) {
            // Handle error.
          }
          // GitHub credential is linked to the current user.
          // IdP data available in authResult.additionalUserInfo.profile.
          // GitHub OAuth access token is can also be retrieved by:
          // ((FIROAuthCredential *)authResult.credential).accessToken
          // GitHub OAuth ID token can be retrieved by calling:
          // ((FIROAuthCredential *)authResult.credential).idToken
        }];
        
  8. Mẫu tương tự có thể được sử dụng với reauthenticateWithCredential có thể được sử dụng để truy xuất thông tin đăng nhập mới cho các hoạt động nhạy cảm yêu cầu đăng nhập gần đây.

    Nhanh

        Auth().currentUser.reauthenticateWithCredential(withCredential: credential) { authResult, error in
          if error != nil {
            // Handle error.
          }
          // User is re-authenticated with fresh tokens minted and
          // should be able to perform sensitive operations like account
          // deletion and email or password update.
          // IdP data available in result.additionalUserInfo.profile.
          // Additional OAuth access token is can also be retrieved by:
          // (authResult.credential as? OAuthCredential)?.accessToken
          // GitHub OAuth ID token can be retrieved by calling:
          // (authResult.credential as? OAuthCredential)?.idToken
        }
        

    Mục tiêu-C

        [[FIRAuth auth].currentUser
            reauthenticateWithCredential:credential
                              completion:^(FIRAuthDataResult * _Nullable authResult, NSError * _Nullable error) {
          if (error) {
            // Handle error.
          }
          // User is re-authenticated with fresh tokens minted and
          // should be able to perform sensitive operations like account
          // deletion and email or password update.
          // IdP data available in result.additionalUserInfo.profile.
          // Additional OAuth access token is can also be retrieved by:
          // ((FIROAuthCredential *)authResult.credential).accessToken
          // GitHub OAuth ID token can be retrieved by calling:
          // ((FIROAuthCredential *)authResult.credential).idToken
        }];
        

Bước tiếp theo

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

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

  • Trong Cơ sở dữ liệu thời gian thực Firebase và Quy tắc bảo mật bộ lưu trữ đám mây , bạn có thể lấy ID người dùng duy nhất của người dùng đã đăng nhập từ biến auth và sử dụng biến đó để 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 mình bằng nhiều nhà cung cấp xác thực bằng cách liên kết thông tin đăng nhập của nhà cung cấp xác thực với tài khoản người dùng hiện có.

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

Nhanh

let firebaseAuth = Auth.auth()
do {
  try firebaseAuth.signOut()
} catch let signOutError as NSError {
  print("Error signing out: %@", signOutError)
}

Mục tiêu-C

NSError *signOutError;
BOOL status = [[FIRAuth auth] signOut:&signOutError];
if (!status) {
  NSLog(@"Error signing out: %@", signOutError);
  return;
}

Bạn cũng có thể muốn thêm mã xử lý lỗi cho toàn bộ các lỗi xác thực. Xem Xử lý lỗi .