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 với 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 Firebase SDK để 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 của bạn.
  2. Trong bảng điều khiển của Firebase, hãy mở phần Xác thực.
  3. Trên thẻ Phương thức đăng nhập, hãy bật nhà cung cấp GitHub.
  4. Thêm Mã ứng dụng khách và Mật khẩu ứng dụng khách trong 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 của nhà cung cấp:
    1. Đăng ký ứng dụng của bạn với tư cách là một ứng dụng của nhà phát triển trên GitHub và lấy Mã ứng dụng khách OAuth 2.0 và Bí mật ứng dụng khách của ứng dụng.
    2. Đảm bảo URI chuyển hướng OAuth trong Firebase (ví dụ: my-app-12345.firebaseapp.com/__/auth/handler) được đặt thành URL gọi lại ủy 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 Firebase SDK

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

    API mô-đun web

    import { GithubAuthProvider } from "firebase/auth";

const provider = new GithubAuthProvider();
    auth_github_provider_create.js

    API không gian tên trên web

    var provider = new firebase.auth.GithubAuthProvider();
    github.js
  2. Không bắt buộc: Chỉ định các phạm vi OAuth 2.0 khác mà bạn muốn yêu cầu từ 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ụ:

    API mô-đun web

    provider.addScope('repo');
    auth_github_provider_scopes.js

    API không gian tên trên web

    provider.addScope('repo');
    github.js
    Hãy xem tài liệu về 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ố khác của trình cung cấp OAuth tuỳ chỉnh mà bạn muốn gửi cùng với yêu cầu OAuth. Để thêm một thông số tuỳ chỉnh, hãy gọi setCustomParameters trên trình cung cấp đã khởi tạo bằng một đối tượng chứa khoá như được chỉ định trong tài liệu về trình cung cấp OAuth và giá trị tương ứng. Ví dụ:

    API mô-đun web

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

    API không gian tên trên web

    provider.setCustomParameters({
  'allow_signup': 'false'
});
    github.js
    Các tham số OAuth bắt buộc đặt trước không được phép và sẽ bị bỏ qua. Vui lòng xem tài liệu tham khảo về nhà cung cấp dịch vụ xác thực để biết thêm chi tiết.
  4. Xác thực bằng Firebase sử dụ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ở một 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:

      API mô-đun 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);
    // ...
  });
      auth_github_signin_popup.js

      API không gian tên trên 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;
    // ...
  });
      github.js
      Ngoài ra, xin 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 API GitHub.

      Đây cũng là nơi bạn có thể phát hiện và xử lý các lỗi. Để biết danh sách 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: Làm theo các phương pháp hay nhất khi sử dụng phương thức "signInWith chuyển hướng".

      API mô-đun web

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

const auth = getAuth();
signInWithRedirect(auth, provider);
      auth_signin_redirect.js

      API không gian tên trên web

      firebase.auth().signInWithRedirect(provider);
      index.js
      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:

      API mô-đun 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);
    // ...
  });
      auth_github_signin_redirect_result.js

      API không gian tên trên 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;
    // ...
  });
      github.js
      Đây cũng là nơi bạn có thể phát hiện và xử lý các lỗi. Để biết danh sách 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 thông qua tài khoản GitHub thông qua việc xử lý quy trình đăng nhập bằng cách gọi điểm cuối GitHub 2.0:

  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 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ã truy cập OAuth 2.0.
  2. Nếu bạn cần đăng nhập vào ứng dụng Node.js, hãy gửi mã 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 đổi mã truy cập OAuth 2.0 lấy thông tin đăng nhập Firebase:

    API mô-đun web

    import { GithubAuthProvider } from "firebase/auth";

const credential = GithubAuthProvider.credential(token);
    auth_github_provider_credential.js

    API không gian tên trên web

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

    API mô-đun 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;
    // ...
  });
    auth_signin_credential.js

    API không gian tên trên 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;
    // ...
  });
    index.js

Xác thực bằng Firebase trong một tiện ích của Chrome

Nếu bạn đang tạo một ứng dụng tiện ích của 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 tiên, 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 đăng nhập (chẳng hạn như tên người dùng và mật khẩu, số điện thoại hoặc thông tin của 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ữ như một phần 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 của bạn, bất kể người dùng đăng nhập bằng cách nào.

  • Trong ứng dụng của bạn, bạn nên đặt trình quan sát trên đối tượng Auth để biết trạng thái xác thực của người dùng. 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. Hãy xem phần Quản lý người dùng.

  • Trong Quy tắc bảo mật của Cloud Storage và Cơ sở dữ liệu theo thời gian thực của Firebase, 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 rồi sử dụng mã này để kiểm soát những 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 thông qua nhiều nhà cung cấp dịch vụ xác thực bằng cách liên kết thông tin đăng nhập của 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 một người dùng, hãy gọi signOut:

API mô-đun web

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

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

API không gian tên trên web

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