Xác thực bằng GitHub với JavaScript

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 xác thực GitHub vào ứng dụng. Bạn có thể tích hợp tính năng xác thực GitHub bằng cách sử dụng SDK Firebase để thực hiện quy trình đăng nhập hoặc thực hiện quy trình GitHub OAuth 2.0 theo cách thủ công và chuyển mã truy cập thu được đến Firebase.

Trước khi bắt đầu

  1. Thêm Firebase vào dự án JavaScript.
  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.

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 web, 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ý quy trình đăng nhập bằng SDK JavaScript Firebase. (Nếu muốn xác thực người dùng trong Node.js hoặc môi trường không phải trình duyệt khác, bạn phải xử lý quy trình đăng nhập theo cách thủ công.)

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

  1. Tạo một thực thể của đối tượng trình cung cấp GitHub:

    Web

    import { GithubAuthProvider } from "firebase/auth";
    
    const provider = new GithubAuthProvider();

    Web

    var provider = new firebase.auth.GithubAuthProvider();
  2. Không bắt buộc: Chỉ định các phạm vi OAuth 2.0 bổ sung mà bạn muốn yêu cầu từ trình cung cấp dịch vụ xác thực. Để thêm một phạm vi, hãy gọi addScope. Ví dụ:

    Web

    provider.addScope('repo');

    Web

    provider.addScope('repo');
    Xem tài liệu về trình cung cấp dịch vụ xác thực.
  3. Không bắt buộc: Chỉ định các thông số nhà cung cấp OAuth tuỳ chỉnh bổ sung mà bạn muốn gửi cùng với yêu cầu OAuth. Để thêm một tham số tuỳ chỉnh, hãy gọi setCustomParameters trên trình cung cấp đã khởi chạy bằng một đối tượng chứa khoá được chỉ định trong tài liệu của trình cung cấp OAuth và giá trị tương ứng. Ví dụ:

    Web

    provider.setCustomParameters({
      'allow_signup': 'false'
    });

    Web

    provider.setCustomParameters({
      'allow_signup': 'false'
    });
    Các tham số OAuth bắt buộc được đặt trước sẽ không được phép và sẽ bị bỏ qua. Hãy xem tài liệu tham khảo về trình cung cấp xác thực để biết thêm thông tin chi tiết.
  4. Xác thực bằng Firebase bằng đối tượng nhà cung cấp GitHub. Bạn có thể nhắc người dùng đăng nhập bằng tài khoản GitHub của họ bằng cách mở cửa sổ bật lên hoặc chuyển hướng đến trang đăng nhập. Phương thức chuyển hướng được ưu tiên trên thiết bị di động.
    • Để đăng nhập bằng cửa sổ bật lên, hãy gọi signInWithPopup:

      Web

      import { getAuth, signInWithPopup, GithubAuthProvider } from "firebase/auth";
      
      const auth = getAuth();
      signInWithPopup(auth, provider)
        .then((result) => {
          // This gives you a GitHub Access Token. You can use it to access the GitHub API.
          const credential = GithubAuthProvider.credentialFromResult(result);
          const token = credential.accessToken;
      
          // The signed-in user info.
          const user = result.user;
          // IdP data available using getAdditionalUserInfo(result)
          // ...
        }).catch((error) => {
          // Handle Errors here.
          const errorCode = error.code;
          const errorMessage = error.message;
          // The email of the user's account used.
          const email = error.customData.email;
          // The AuthCredential type that was used.
          const credential = GithubAuthProvider.credentialFromError(error);
          // ...
        });

      Web

      firebase
        .auth()
        .signInWithPopup(provider)
        .then((result) => {
          /** @type {firebase.auth.OAuthCredential} */
          var credential = result.credential;
      
          // This gives you a GitHub Access Token. You can use it to access the GitHub API.
          var token = credential.accessToken;
      
          // The signed-in user info.
          var user = result.user;
          // IdP data available in result.additionalUserInfo.profile.
            // ...
        }).catch((error) => {
          // Handle Errors here.
          var errorCode = error.code;
          var errorMessage = error.message;
          // The email of the user's account used.
          var email = error.email;
          // The firebase.auth.AuthCredential type that was used.
          var credential = error.credential;
          // ...
        });
      Ngoài ra, hãy lưu ý rằng bạn có thể truy xuất mã thông báo OAuth của nhà cung cấp GitHub. Mã này có thể được dùng để tìm nạp thêm dữ liệu bằng các API GitHub.

      Đây cũng là nơi bạn có thể phát hiện và xử lý lỗi. Để biết danh sách mã lỗi, hãy xem Tài liệu tham khảo về xác thực.

    • Để đăng nhập bằng cách chuyển hướng đến trang đăng nhập, hãy gọi signInWithRedirect: Làm theo các phương pháp hay nhất khi sử dụng `signInWithRedirect`.

      Web

      import { getAuth, signInWithRedirect } from "firebase/auth";
      
      const auth = getAuth();
      signInWithRedirect(auth, provider);

      Web

      firebase.auth().signInWithRedirect(provider);
      Sau đó, bạn cũng có thể truy xuất mã thông báo OAuth của nhà cung cấp GitHub bằng cách gọi getRedirectResult khi trang tải:

      Web

      import { getAuth, getRedirectResult, GithubAuthProvider } from "firebase/auth";
      
      const auth = getAuth();
      getRedirectResult(auth)
        .then((result) => {
          const credential = GithubAuthProvider.credentialFromResult(result);
          if (credential) {
            // This gives you a GitHub Access Token. You can use it to access the GitHub API.
            const token = credential.accessToken;
            // ...
          }
      
          // The signed-in user info.
          const user = result.user;
          // IdP data available using getAdditionalUserInfo(result)
          // ...
        }).catch((error) => {
          // Handle Errors here.
          const errorCode = error.code;
          const errorMessage = error.message;
          // The email of the user's account used.
          const email = error.customData.email;
          // The AuthCredential type that was used.
          const credential = GithubAuthProvider.credentialFromError(error);
          // ...
        });

      Web

      firebase.auth()
        .getRedirectResult()
        .then((result) => {
          if (result.credential) {
            /** @type {firebase.auth.OAuthCredential} */
            var credential = result.credential;
      
            // This gives you a GitHub Access Token. You can use it to access the GitHub API.
            var token = credential.accessToken;
            // ...
          }
      
          // The signed-in user info.
          var user = result.user;
          // IdP data available in result.additionalUserInfo.profile.
            // ...
        }).catch((error) => {
          // Handle Errors here.
          var errorCode = error.code;
          var errorMessage = error.message;
          // The email of the user's account used.
          var email = error.email;
          // The firebase.auth.AuthCredential type that was used.
          var credential = error.credential;
          // ...
        });
      Đây cũng là nơi bạn có thể phát hiện và xử lý lỗi. Để biết danh sách mã lỗi, hãy xem Tài liệu tham khảo về xác thực.

Xử lý quy trình đăng nhập theo cách thủ công

Bạn cũng có thể xác thực bằng Firebase bằng tài khoản GitHub bằng cách xử lý quy trình đăng nhập bằng cách gọi các điểm cuối OAuth 2.0 của GitHub:

  1. Tích hợp tính năng xác thực GitHub vào ứng dụng của bạn bằng cách làm theo tài liệu dành cho nhà phát triển. Khi quy trình đăng nhập vào GitHub kết thúc, bạn sẽ nhận được mã truy cập OAuth 2.0.
  2. Nếu bạn cần đăng nhập vào một ứng dụng Node.js, hãy gửi mã thông báo truy cập OAuth đến ứng dụng Node.js.
  3. Sau khi người dùng đăng nhập thành công bằng GitHub, hãy trao đổi mã truy cập OAuth 2.0 lấy thông tin xác thực Firebase:

    Web

    import { GithubAuthProvider } from "firebase/auth";
    
    const credential = GithubAuthProvider.credential(token);

    Web

    var credential = firebase.auth.GithubAuthProvider.credential(token);
  4. Xác thực bằng Firebase bằng thông tin xác thực Firebase:

    Web

    import { getAuth, signInWithCredential } from "firebase/auth";
    
    // Sign in with the credential from the user.
    const auth = getAuth();
    signInWithCredential(auth, credential)
      .then((result) => {
        // Signed in 
        // ...
      })
      .catch((error) => {
        // Handle Errors here.
        const errorCode = error.code;
        const errorMessage = error.message;
        // The email of the user's account used.
        const email = error.customData.email;
        // ...
      });

    Web

    // Sign in with the credential from the user.
    firebase.auth()
      .signInWithCredential(credential)
      .then((result) => {
        // Signed in 
        // ...
      })
      .catch((error) => {
        // Handle Errors here.
        const errorCode = error.code;
        const errorMessage = error.message;
        // The email of the user's account used.
        const email = error.email;
        // ...
      });

Xác thực bằng Firebase trong tiện ích Chrome

Nếu bạn đang xây dựng một ứng dụng tiện ích Chrome, hãy xem Hướng dẫn về tài liệu ngoài màn hình.

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 dịch vụ 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 nên biết trạng thái xác thực của người dùng bằng cách đặt trình quan sát trên đối tượng Auth. Sau đó, 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 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 duy nhấ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:

Web

import { getAuth, signOut } from "firebase/auth";

const auth = getAuth();
signOut(auth).then(() => {
  // Sign-out successful.
}).catch((error) => {
  // An error happened.
});

Web

firebase.auth().signOut().then(() => {
  // Sign-out successful.
}).catch((error) => {
  // An error happened.
});