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

Bạn có thể cho phép người dùng của mình xác thực với Firebase bằng tài khoản GitHub của họ bằng cách tích hợp xác thực GitHub vào ứng dụng của bạn. Bạn có thể tích hợp 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 bằng cách thực hiện quy trình GitHub OAuth 2.0 theo cách thủ công và chuyển mã thông báo truy cập thu được cho Firebase.

Trước khi bắt đầu

  1. Thêm Firebase vào dự án JavaScript của bạn .
  2. Trong bảng điều khiển Firebase , hãy mở phần Auth .
  3. Trên tab Phương thức đăng nhập , bật nhà cung cấp GitHub .
  4. 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.
  5. Nhấp vào Lưu .

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

Nếu bạn đang xây dựng ứng dụng web, cách dễ nhất để xác thực người dùng của bạn bằng Firebase bằng tài khoản GitHub của họ là xử lý luồng đăng nhập bằng SDK JavaScript của Firebase. (Nếu bạn muốn xác thực người dùng trong Node.js hoặc môi trường không có 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ý luồng đăng nhập bằng SDK JavaScript Firebase, hãy làm theo các bước sau:

  1. Tạo một thể hiện của đối tượng nhà cung cấp GitHub:

    Web version 9

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

    Web version 8

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

    Web version 9

    provider.addScope('repo');

    Web version 8

    provider.addScope('repo');
    Xem tài liệu của nhà cung cấp xác thực .
  3. Tùy chọn : Chỉ định các tham số nhà cung cấp OAuth tùy 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ố tùy chỉnh, hãy gọi setCustomParameters trên nhà cung cấp đã khởi tạo với một đối tượng chứa khóa như được chỉ định bởi tài liệu của nhà cung cấp OAuth và giá trị tương ứng. Ví dụ:

    Web version 9

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

    Web version 8

    provider.setCustomParameters({
      'allow_signup': 'false'
    });
    Các tham số OAuth bắt buộc dành riêng không được phép và sẽ bị bỏ qua. Xem tài liệu tham khảo nhà cung cấp xác thực để biết thêm chi tiết.
  4. Xác thực với Firebase bằng đối tượng nhà cung cấp GitHub. Bạn có thể nhắc người dùng của mình đă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 bằng cách chuyển hướng đến trang đăng nhập. Phương pháp chuyển hướng được ưa thích 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 version 9

      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 version 8

      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 sử dụng để tìm nạp dữ liệu bổ sung bằng API GitHub.

      Đây cũng là nơi bạn có thể bắt và xử lý lỗi. Để biết danh sách các mã lỗi, hãy xem Tài liệu tham khảo 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 : Thực hiện theo các phương pháp hay nhất khi sử dụng `signInWithRedirect`.

      Web version 9

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

      Web version 8

      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 của bạn tải:

      Web version 9

      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 version 8

      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ể bắt và xử lý lỗi. Để biết danh sách các mã lỗi, hãy xem Tài liệu tham khảo 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 với Firebase bằng tài khoản GitHub bằng cách xử lý luồng đăng nhập bằng cách gọi các điểm cuối GitHub OAuth 2.0:

  1. Tích hợp 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 của nhà phát triển . Khi kết thúc quy trình đăng nhập GitHub, bạn sẽ nhận được mã thông báo truy cập OAuth 2.0.
  2. Nếu bạn cần đăng nhập trên ứng dụng Node.js, hãy gửi mã thông báo truy cập OAuth tới ứng dụng Node.js.
  3. Sau khi người dùng đăng nhập thành công bằng GitHub, hãy đổi mã thông báo truy cập OAuth 2.0 để lấy thông tin đăng nhập Firebase:

    Web version 9

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

    Web version 8

    var credential = firebase.auth.GithubAuthProvider.credential(token);
  4. Xác thực với Firebase bằng thông tin đăng nhập Firebase:

    Web version 9

    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 version 8

    // 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 mở rộng của Chrome

Nếu bạn đang tạo ứng dụng tiện ích mở rộng của Chrome, bạn phải thêm ID tiện ích mở rộng của Chrome:

  1. Mở dự án của bạn trong bảng điều khiển Firebase .
  2. Trong phần Xác thực , hãy mở trang Phương thức đăng nhập .
  3. Thêm một URI như sau vào danh sách Miền được ủy quyền:
    chrome-extension://CHROME_EXTENSION_ID

Chỉ các thao tác bật lên ( signInWithPopup , linkWithPopupreauthenticateWithPopup ) mới khả dụng đối với tiện ích mở rộng của Chrome vì tiện ích mở rộng của Chrome không thể sử dụng chuyển hướng HTTP. Bạn nên gọi các phương thức này từ tập lệnh trang nền thay vì cửa sổ bật lên hành động của trình duyệt, vì cửa sổ bật lên xác thực sẽ hủy cửa sổ bật lên hành động của trình duyệt. Các phương thức bật lên chỉ có thể được sử dụng trong các tiện ích mở rộng sử dụng Manifest V2 . Manifest V3 mới hơn chỉ cho phép các tập lệnh nền ở dạng công nhân dịch vụ, hoàn toàn không thể thực hiện các thao tác bật lên.

Trong tệp kê khai của tiện ích Chrome, hãy đảm bảo rằng bạn thêm URL https://apis.google.com vào danh sách cho phép của content_security_policy .

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 bạn, cách được đề xuất để biết trạng thái xác thực của người dùng là đặt một người quan sát trên đối tượng Auth thực. 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 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 thực 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 :

Web version 9

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

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

Web version 8

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