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 xác thực GitHub vào ứng dụng của bạn. Bạn có thể tích hợp GitHub xác thực bằng cách sử dụng Firebase SDK để thực hiện quy trình đăng nhập, hoặc bằng cách thực hiện luồng GitHub OAuth 2.0 theo cách thủ công và chuyển kết quả mã truy cập vào Firebase.
Trước khi bắt đầu
- Thêm Firebase vào dự án JavaScript của bạn.
- Trong bảng điều khiển Firebase, hãy mở phần Xác thực.
- Trên thẻ Phương thức đăng nhập, hãy bật nhà cung cấp GitHub.
- Thêm Mã ứng dụng khách và Mậ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 của nhà cung cấp:
- Đăng ký ứng dụng của bạn dưới dạng ứ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 của ứng dụng và Mật khẩu ứng dụng khách.
- Đảm bảo URI chuyển hướng OAuth trong Firebase (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 của ứng dụng GitHub.
- 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 thông qua tài khoản GitHub của họ là xử lý quy trình đăng nhập bằng Firebase JavaScript SDK. (Nếu bạn 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 các bước:
- Tạo một thực thể của đối tượng nhà cung cấp GitHub:
import { GithubAuthProvider } from "firebase/auth";
const provider = new GithubAuthProvider();var provider = new firebase.auth.GithubAuthProvider();
- 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 phạm vi, hãy gọi
addScope
. Ví dụ:provider.addScope('repo');
provider.addScope('repo');
- Không bắt buộc: Chỉ định các thông số bổ sung 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 thông số tùy chỉnh, hãy gọi
setCustomParameters
trên trình cung cấp đã khởi tạo có 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ụ:provider.setCustomParameters({
'allow_signup': 'false'
});provider.setCustomParameters({
'allow_signup': 'false'
}); - 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 bằng cách chuyển hướng đến trang đăng nhập. Phương thức chuyển hướng là
đượ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
: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);
// ...
});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;
// ...
});Đâ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 tính năng "signInWith chuyển hướng".import { getAuth, signInWithRedirect } from "firebase/auth";
const auth = getAuth();
signInWithRedirect(auth, provider);firebase.auth().signInWithRedirect(provider);
getRedirectResult
khi trang của bạn tải: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);
// ...
});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;
// ...
});
- Để đăng nhập bằng cửa sổ bật lên, hãy gọi
Xử lý Lỗi thông tin đăng nhập khác nhau của tài khoản
Nếu bạn đã bật chế độ cài đặt Một tài khoản cho mỗi địa chỉ email trong bảng điều khiển của Firebase,
khi người dùng cố gắng đăng nhập vào một nhà cung cấp (chẳng hạn như GitHub) bằng một email đã
cho một nhà cung cấp khác của người dùng Firebase (chẳng hạn như Google), thì lỗi
auth/account-exists-with-different-credential
được gửi cùng với
Đối tượng AuthCredential
(mã truy cập GitHub). Để hoàn tất quá trình đăng nhập vào
nhà cung cấp dự định, trước tiên người dùng phải đăng nhập vào nhà cung cấp hiện tại (Google) và sau đó liên kết với
AuthCredential
cũ (mã truy cập GitHub).
Chế độ cửa sổ bật lên
Nếu sử dụng signInWithPopup
, bạn có thể xử lý
auth/account-exists-with-different-credential
lỗi với mã như sau
ví dụ:
import {
getAuth,
linkWithCredential,
signInWithPopup,
GitHubAuthProvider,
} from "firebase/auth";
try {
// Step 1: User tries to sign in using GitHub.
let result = await signInWithPopup(getAuth(), new GitHubAuthProvider());
} catch (error) {
// Step 2: User's email already exists.
if (error.code === "auth/account-exists-with-different-credential") {
// The pending GitHub credential.
let pendingCred = error.credential;
// Step 3: Save the pending credential in temporary storage,
// Step 4: Let the user know that they already have an account
// but with a different provider, and let them choose another
// sign-in method.
}
}
// ...
try {
// Step 5: Sign the user in using their chosen method.
let result = await signInWithPopup(getAuth(), userSelectedProvider);
// Step 6: Link to the GitHub credential.
// TODO: implement `retrievePendingCred` for your app.
let pendingCred = retrievePendingCred();
if (pendingCred !== null) {
// As you have access to the pending credential, you can directly call the
// link method.
let user = await linkWithCredential(result.user, pendingCred);
}
// Step 7: Continue to app.
} catch (error) {
// ...
}
Chế độ chuyển hướng
Lỗi này được xử lý theo cách tương tự trong chế độ chuyển hướng, chỉ khác là thông tin đăng nhập phải được lưu vào bộ nhớ đệm giữa các lần chuyển hướng trang (ví dụ: sử dụng bộ nhớ phiên).
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 bằng cách xử lý quy trình đăng nhập bằng cách gọi các điểm cuối GitHub 2.0:
- Tích hợp phương thức 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.
- Nếu bạn cần đăng nhập vào ứng dụng Node.js, hãy gửi quyền truy cập OAuth cho ứng dụng Node.js.
- Sau khi người dùng đăng nhập thành công bằng GitHub, hãy trao đổi OAuth 2.0
mã truy cập cho thông tin đăng nhập Firebase:
import { GithubAuthProvider } from "firebase/auth";
const credential = GithubAuthProvider.credential(token);var credential = firebase.auth.GithubAuthProvider.credential(token);
- Xác thực bằng Firebase bằng thông tin đăng nhập Firebase:
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;
// ...
});// 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 một tiện ích của Chrome
Nếu bạn đang xây dựng ứ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
Tuỳ chỉnh miền chuyển hướng để đăng nhập GitHub
Khi tạo dự án, Firebase sẽ cung cấp một miền con duy nhất cho dự án của bạn:
https://my-app-12345.firebaseapp.com
.
Cơ chế này cũng sẽ được dùng làm cơ chế chuyển hướng cho việc đăng nhập bằng OAuth. Miền đó cần phải được phép đối với tất cả các nhà cung cấp OAuth được hỗ trợ. Tuy nhiên, điều này có nghĩa là người dùng có thể thấy rằng miền trong khi đăng nhập vào GitHub trước khi chuyển hướng trở lại ứng dụng: Tiếp tục truy cập: https://my-app-12345.firebaseapp.com.
Để tránh hiển thị miền con, bạn có thể thiết lập miền tuỳ chỉnh bằng Firebase Hosting:
- Làm theo các bước từ 1 đến 3 trong Thiết lập miền của bạn cho Hosting. Khi bạn xác minh quyền sở hữu miền của bạn, Hosting cung cấp chứng chỉ SSL cho miền tuỳ chỉnh của bạn.
- Thêm miền tuỳ chỉnh của bạn vào danh sách các miền được uỷ quyền trong
Bảng điều khiển Firebase:
auth.custom.domain.com
. - Trong bảng điều khiển dành cho nhà phát triển GitHub hoặc trang thiết lập OAuth, hãy thêm URL của trang chuyển hướng vào danh sách cho phép,
bạn có thể truy cập vào tệp này trên miền tuỳ chỉnh của mình:
https://auth.custom.domain.com/__/auth/handler
. - Khi bạn khởi chạy thư viện JavaScript, hãy chỉ định miền tuỳ chỉnh của bạn bằng
Trường
authDomain
:var config = {
apiKey: '...',
// Changed from 'my-app-12345.firebaseapp.com'.
authDomain: 'auth.custom.domain.com',
databaseURL: 'https://my-app-12345.firebaseio.com',
projectId: 'my-app-12345',
storageBucket: 'my-app-12345.appspot.com',
messagingSenderId: '1234567890'
};
firebase.initializeApp(config);
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à được liên kết với thông tin đăng nhập—tức là tên người dùng và mật khẩu, số điện thoại số hoặc thông tin của nhà cung cấp dịch vụ xác thực – người dùng đã đăng nhập. Thông tin mới này được lưu trữ như một phần của dự án Firebase và có thể được dùng để xác định một 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 mình, bạn nên sử dụng cách để biết trạng thái xác thực của người dùng đặt trình quan sát trên đối tượng
Auth
. Sau đó, bạn có thể lấy thông tin thông tin hồ sơ cơ bản của đối tượngUser
. Xem Quản lý người dùng. Trong Firebase Realtime Database và Cloud Storage của bạn Quy tắc bảo mật, 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
, để kiểm soát loại 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 phương thức 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 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
:
import { getAuth, signOut } from "firebase/auth";
const auth = getAuth();
signOut(auth).then(() => {
// Sign-out successful.
}).catch((error) => {
// An error happened.
});
firebase.auth().signOut().then(() => {
// Sign-out successful.
}).catch((error) => {
// An error happened.
});