要让您的用户能够通过 OAuth 提供方(如 Yahoo)进行 Firebase 身份验证,您可以使用 Firebase SDK 执行端到端登录流程,将通用 OAuth 登录机制集成到您的应用中。
准备工作
如需让用户能够通过 Yahoo 帐号登录,您必须先启用 Yahoo 作为您的 Firebase 项目的登录服务提供方:
- 将 Firebase 添加至您的 JavaScript 项目。
- 在 Firebase 控制台中,打开 Auth 部分。
- 在 Sign in method(登录方法)标签页中,启用 Yahoo 提供方。
- 将该提供方的开发者控制台中的客户端 ID 和客户端密钥添加至提供方配置:
-
如需注册 Yahoo OAuth 客户端,请按照有关如何通过 Yahoo 注册 Web 应用的 Yahoo 开发者文档进行操作。
请务必选择以下两种 OpenID Connect API 权限:
profile
和email
。 - 向这些提供方注册应用时,请务必将项目的
*.firebaseapp.com
网域注册为应用的重定向网域。
-
- 点击保存。
使用 Firebase SDK 处理登录流程
如果您是在构建 Web 应用,想要通过用户的 Yahoo 帐号对其进行 Firebase 身份验证,最简单的方法是使用 Firebase JavaScript SDK 来处理整个登录流程。
如需要使用 Firebase JavaScript SDK 处理登录流程,请按以下步骤操作:
使用提供方 ID yahoo.com 创建一个 OAuthProvider 实例。
Web 模块化 API
import { OAuthProvider } from "firebase/auth"; const provider = new OAuthProvider('yahoo.com');
Web 命名空间型 API
var provider = new firebase.auth.OAuthProvider('yahoo.com');
可选:指定您希望通过 OAuth 请求发送的其他自定义 OAuth 参数。
Web 模块化 API
provider.setCustomParameters({ // Prompt user to re-authenticate to Yahoo. prompt: 'login', // Localize to French. language: 'fr' });
Web 命名空间型 API
provider.setCustomParameters({ // Prompt user to re-authenticate to Yahoo. prompt: 'login', // Localize to French. language: 'fr' });
如需查看 Yahoo 支持的参数,请参阅 Yahoo OAuth 文档。请注意,您不能使用
setCustomParameters()
传递 Firebase 必需的参数。这些参数包括 client_id、redirect_uri、response_type、scope 和 state。可选:指定您希望向身份验证提供方申请的
profile
和email
之外的 OAuth 2.0 范围。如果您的应用需要通过 Yahoo API 访问用户私人数据,您需要在 Yahoo 开发者控制台的 API 权限下申请 Yahoo API 权限。申请的 OAuth 范围必须与应用的 API 权限中预配置的范围完全匹配。例如,如果您申请了对用户通讯录的读写权限,并已在应用的 API 权限中预配置相应权限,则必须传递sdct-w
而不是只读 OAuth 范围sdct-r
。否则将导致流程失败,并向最终用户显示错误消息。Web 模块化 API
// Request access to Yahoo Mail API. provider.addScope('mail-r'); // Request read/write access to user contacts. // This must be preconfigured in the app's API permissions. provider.addScope('sdct-w');
Web 命名空间型 API
// Request access to Yahoo Mail API. provider.addScope('mail-r'); // Request read/write access to user contacts. // This must be preconfigured in the app's API permissions. provider.addScope('sdct-w');
如需了解详情,请参阅 Yahoo 范围文档。
使用 OAuth 提供方对象进行 Firebase 身份验证。您可以打开弹出式窗口或将用户重定向至登录页面,提示用户使用自己的 Yahoo 帐号登录。在移动设备上最好使用重定向方法。
如需使用弹出式窗口登录,请调用
signInWithPopup
:Web 模块化 API
import { getAuth, signInWithPopup, OAuthProvider } from "firebase/auth"; const auth = getAuth(); signInWithPopup(auth, provider) .then((result) => { // IdP data available in result.additionalUserInfo.profile // ... // Yahoo OAuth access token and ID token can be retrieved by calling: const credential = OAuthProvider.credentialFromResult(result); const accessToken = credential.accessToken; const idToken = credential.idToken; }) .catch((error) => { // Handle error. });
Web 命名空间型 API
firebase.auth().signInWithPopup(provider) .then((result) => { // IdP data available in result.additionalUserInfo.profile // ... /** @type {firebase.auth.OAuthCredential} */ const credential = result.credential; // Yahoo OAuth access token and ID token can be retrieved by calling: var accessToken = credential.accessToken; var idToken = credential.idToken; }) .catch((error) => { // Handle error. });
如需重定向到登录页面进行登录,请调用
signInWithRedirect
:
使用
signInWithRedirect
、linkWithRedirect
或reauthenticateWithRedirect
时,请遵循最佳实践。firebase.auth().signInWithRedirect(provider);
用户完成登录并返回到页面后,您可以调用
getRedirectResult
获取登录结果。Web 模块化 API
import { getAuth, signInWithRedirect } from "firebase/auth"; const auth = getAuth(); signInWithRedirect(auth, provider);
Web 命名空间型 API
firebase.auth().signInWithRedirect(provider);
成功完成后,可以从返回的
firebase.auth.UserCredential
对象检索与提供方关联的 OAuth ID 令牌和访问令牌。使用 OAuth 访问令牌,您可以调用 Yahoo API。
例如,如需获取基本个人资料,可调用以下 REST API:
curl -i -H "Authorization: Bearer ACCESS_TOKEN" https://social.yahooapis.com/v1/user/YAHOO_USER_UID/profile?format=json
其中,
YAHOO_USER_UID
是 Yahoo 用户的 ID,可以从firebase.auth().currentUser.providerData[0].uid
字段或result.additionalUserInfo.profile
检索。以上示例侧重的是登录流程。除此之外,您也可以使用
linkWithPopup
/linkWithRedirect
将 Yahoo 提供方与现有用户相关联。例如,您可以将多个提供方与同一个用户关联,以便用户使用任一提供方进行登录。Web 模块化 API
import { getAuth, linkWithPopup, OAuthProvider } from "firebase/auth"; const provider = new OAuthProvider('yahoo.com'); const auth = getAuth(); linkWithPopup(auth.currentUser, provider) .then((result) => { // Yahoo credential is linked to the current user. // IdP data available in result.additionalUserInfo.profile. // Get the OAuth access token and ID Token const credential = OAuthProvider.credentialFromResult(result); const accessToken = credential.accessToken; const idToken = credential.idToken; }) .catch((error) => { // Handle error. });
Web 命名空间型 API
var provider = new firebase.auth.OAuthProvider('yahoo.com'); firebase.auth().currentUser.linkWithPopup(provider) .then((result) => { // Yahoo credential is linked to the current user. // IdP data available in result.additionalUserInfo.profile. // Yahoo OAuth access token can be retrieved by calling: // result.credential.accessToken // Yahoo OAuth ID token can be retrieved by calling: // result.credential.idToken }) .catch((error) => { // Handle error. });
上述模式同样适用于
reauthenticateWithPopup
/reauthenticateWithRedirect
。对于要求用户必须在近期内登录过才能执行的敏感操作,可使用它来检索新的凭据。Web 模块化 API
import { getAuth, reauthenticateWithPopup, OAuthProvider } from "firebase/auth"; const provider = new OAuthProvider('yahoo.com'); const auth = getAuth(); reauthenticateWithPopup(auth.currentUser, provider) .then((result) => { // 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. // Get the OAuth access token and ID Token const credential = OAuthProvider.credentialFromResult(result); const accessToken = credential.accessToken; const idToken = credential.idToken; }) .catch((error) => { // Handle error. });
Web 命名空间型 API
var provider = new firebase.auth.OAuthProvider('yahoo.com'); firebase.auth().currentUser.reauthenticateWithPopup(provider) .then((result) => { // 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. // Yahoo OAuth access token can be retrieved by calling: // result.credential.accessToken // Yahoo OAuth ID token can be retrieved by calling: // result.credential.idToken }) .catch((error) => { // Handle error. });
在 Chrome 扩展程序中进行 Firebase 身份验证
如果您是在构建 Chrome 扩展程序应用,则必须添加 Chrome 扩展程序 ID:
- 在 Firebase 控制台中打开您的项目。
- 在 Authentication 部分中,打开登录方法页面。
- 向“已获授权的网域”列表添加格式如下的 URI:
chrome-extension://CHROME_EXTENSION_ID
由于 Chrome 扩展程序无法使用 HTTP 重定向,因此只能使用弹出式操作方式(signInWithPopup
、linkWithPopup
和 reauthenticateWithPopup
)。您应该从后台页面脚本而不是弹出式窗口(浏览器操作)中调用这些方法,因为身份验证的弹出式窗口将取消浏览器操作的弹出式窗口。弹出式操作方式只能在使用 Manifest V2 的扩展程序中使用。较新的 Manifest V3 只允许采用 Service Worker 形式的后台脚本,无法执行弹出式操作方式。
在 Chrome 扩展程序的清单文件中,确保将 https://apis.google.com
网址加入 content_security_policy
许可名单中。
后续步骤
在用户首次登录后,系统会创建一个新的用户帐号,并将其与该用户登录时使用的凭据(即用户名和密码、电话号码或者身份验证提供方信息)相关联。此新帐号存储在您的 Firebase 项目中,无论用户采用何种方式登录,您项目中的每个应用都可以使用此帐号来识别用户。
-
在您的应用中,建议通过在
Auth
对象上设置观测者 (observer) 来了解用户的身份验证状态。然后,您便可从User
对象获取用户的基本个人资料信息。请参阅管理用户。 在您的 Firebase Realtime Database 和 Cloud Storage 安全规则中,您可以从
auth
变量获取已登录用户的唯一用户 ID,然后利用此 ID 来控制用户可以访问哪些数据。
您可以将多个身份验证提供方凭据与一个现有用户帐号关联,让用户可以使用多个身份验证提供方登录您的应用。
如需让用户退出登录,请调用 signOut
:
Web 模块化 API
import { getAuth, signOut } from "firebase/auth"; const auth = getAuth(); signOut(auth).then(() => { // Sign-out successful. }).catch((error) => { // An error happened. });
Web 命名空间型 API
firebase.auth().signOut().then(() => { // Sign-out successful. }).catch((error) => { // An error happened. });