您可以借助 Firebase Authentication 让您的用户使用其电子邮件地址和密码进行 Firebase 身份验证,还可以管理您的应用的基于密码的账号。
准备工作
- 将 Firebase 添加至您的 C++ 项目。
- 如果您尚未将应用关联至您的 Firebase 项目,请从 Firebase 控制台执行此操作。
- 启用电子邮件地址/密码登录方法:
- 在 Firebase 控制台中,打开 Auth 部分。
- 在登录方法标签页中,启用电子邮件地址/密码登录方法,然后点击保存。
访问 firebase::auth::Auth
类
Auth
类是所有 API 调用都需要通过的门户,- 添加 Auth 和 App 头文件:
#include "firebase/app.h" #include "firebase/auth.h"
- 在您的初始化代码中,创建一个
firebase::App
类。#if defined(__ANDROID__) firebase::App* app = firebase::App::Create(firebase::AppOptions(), my_jni_env, my_activity); #else firebase::App* app = firebase::App::Create(firebase::AppOptions()); #endif // defined(__ANDROID__)
- 获取您的
firebase::App
对应的firebase::auth::Auth
类。App
和Auth
是一对一的映射关系。firebase::auth::Auth* auth = firebase::auth::Auth::GetAuth(app);
创建一个基于密码的账号
如需创建一个带有密码的新用户账号,请在您的应用的登录代码中完成以下步骤:
- 在新用户使用您的应用注册表单注册时,完成您的应用要求的所有新账号验证步骤,例如验证新账号的密码是否输入正确并且符合您的密码复杂度要求。
- 将新用户的电子邮件地址和密码传递给
Auth::CreateUserWithEmailAndPassword
方法,以创建一个新账号:firebase::Future<firebase::auth::AuthResult> result = auth->CreateUserWithEmailAndPassword(email, password);
- 如果您的程序有定期(如每秒 30 次或 60 次)运行的更新循环,则您可以在每次更新时利用
Auth::CreateUserWithEmailAndPasswordLastResult
检查一次结果:firebase::Future<firebase::auth::AuthResult> result = auth->CreateUserWithEmailAndPasswordLastResult(); if (result.status() == firebase::kFutureStatusComplete) { if (result.error() == firebase::auth::kAuthErrorNone) { const firebase::auth::AuthResult auth_result = *result.result(); printf("Create user succeeded for email %s\n", auth_result.user.email().c_str()); } else { printf("Created user failed with error '%s'\n", result.error_message()); } }
或者,如果您的程序是由事件驱动的,您可能需要注册一个针对 Future 的回调。
让用户使用电子邮件地址和密码登录
使用密码让用户登录的步骤与创建新账号的步骤类似。在您的应用的登录函数中,执行以下操作:
- 当用户登录到您的应用时,将该用户的电子邮件地址和密码传递给
firebase::auth::Auth::SignInWithEmailAndPassword
:firebase::Future<firebase::auth::AuthResult> result = auth->SignInWithEmailAndPassword(email, password);
- 如果您的程序有定期(如每秒 30 次或 60 次)运行的更新循环,则您可以在每次更新时利用
Auth::SignInWithEmailAndPasswordLastResult
检查一次结果:firebase::Future<firebase::auth::AuthResult> result = auth->SignInWithEmailAndPasswordLastResult(); if (result.status() == firebase::kFutureStatusComplete) { if (result.error() == firebase::auth::kAuthErrorNone) { const firebase::auth::AuthResult auth_result = *result.result(); printf("Sign in succeeded for email %s\n", auth_result.user.email().c_str()); } else { printf("Sign in failed with error '%s'\n", result.error_message()); } }
或者,如果您的程序是由事件驱动的,您可能需要注册一个针对 Future 的回调。
注册一个针对 Future 的回调
某些程序会有Update
函数,其调用频率为每秒 30 次或 60 次。许多游戏都采用这种模型。这些程序可以调用 LastResult
函数来轮询异步调用结果。但是,如果您的程序是由事件驱动的,则更建议您注册回调函数。
回调函数会在 Future 完成后被调用。
void OnCreateCallback(const firebase::Future<firebase::auth::User*>& result, void* user_data) { // The callback is called when the Future enters the `complete` state. assert(result.status() == firebase::kFutureStatusComplete); // Use `user_data` to pass-in program context, if you like. MyProgramContext* program_context = static_cast<MyProgramContext*>(user_data); // Important to handle both success and failure situations. if (result.error() == firebase::auth::kAuthErrorNone) { firebase::auth::User* user = *result.result(); printf("Create user succeeded for email %s\n", user->email().c_str()); // Perform other actions on User, if you like. firebase::auth::User::UserProfile profile; profile.display_name = program_context->display_name; user->UpdateUserProfile(profile); } else { printf("Created user failed with error '%s'\n", result.error_message()); } } void CreateUser(firebase::auth::Auth* auth) { // Callbacks work the same for any firebase::Future. firebase::Future<firebase::auth::AuthResult> result = auth->CreateUserWithEmailAndPasswordLastResult(); // `&my_program_context` is passed verbatim to OnCreateCallback(). result.OnCompletion(OnCreateCallback, &my_program_context); }如果您愿意,回调函数也可以是一个 lambda。
void CreateUserUsingLambda(firebase::auth::Auth* auth) { // Callbacks work the same for any firebase::Future. firebase::Future<firebase::auth::AuthResult> result = auth->CreateUserWithEmailAndPasswordLastResult(); // The lambda has the same signature as the callback function. result.OnCompletion( [](const firebase::Future<firebase::auth::User*>& result, void* user_data) { // `user_data` is the same as &my_program_context, below. // Note that we can't capture this value in the [] because std::function // is not supported by our minimum compiler spec (which is pre C++11). MyProgramContext* program_context = static_cast<MyProgramContext*>(user_data); // Process create user result... (void)program_context; }, &my_program_context); }
建议:设置密码政策
您可以强制实施密码复杂度要求,从而提高账号安全性。
如需为项目配置密码政策,请打开 Firebase 控制台的“身份验证设置”页面上的密码政策标签页:
Firebase Authentication 密码政策支持以下密码要求:
必须包含小写字符
必须包含大写字符
必须包含数字字符
必须包含非字母数字字符
以下字符符合非字母数字字符要求:
^ $ * . [ ] { } ( ) ? " ! @ # % & / \ , > < ' : ; | _ ~
最小密码长度(介于 6 到 30 个字符之间;默认为 6)
最大密码长度(上限为 4096 个字符)
您可以通过两种模式启用密码政策强制执行:
要求:尝试登录会失败,直到用户将密码更新为符合您的政策的密码。
通知:允许用户使用不符合要求的密码登录。使用此模式时,您应检查用户的密码是否符合客户端的政策,并以某种方式提示用户更新密码(如果密码不符合政策)。
新用户始终需要选择符合您政策的密码。
如果您有活跃用户,我们建议您不要启用“登录时强制升级”,除非您打算禁止密码不符合政策的用户访问您的应用。请改用通知模式,让用户使用当前密码登录,并告知他们密码不符合哪些要求。
推荐做法:启用电子邮件枚举保护
如果您必须注册一个电子邮件地址(例如,当使用电子邮件地址和密码登录时)但未注册,或者如果电子邮件地址不应该被使用(例如,当更改用户的电子邮件地址时)但已注册,一些将电子邮件地址作为参数的 Firebase Authentication 方法会抛出具体的错误。虽然这对于向用户建议具体的补救措施非常有用,但恶意操作者也可能会滥用该功能,以发现用户注册的电子邮件地址。
为了降低这种风险,我们建议您使用 Google Cloud gcloud
工具为您的项目启用电子邮件枚举保护。请注意,启用此功能会更改 Firebase Authentication 的错误报告行为:请确保您的应用不依赖于更具体的错误。
后续步骤
在用户首次登录后,系统会创建一个新的用户账号,并将其与该用户登录时使用的凭据(即用户名和密码、电话号码或者身份验证提供方信息)相关联。此新账号存储在您的 Firebase 项目中,无论用户采用何种方式登录,您项目中的每个应用都可以使用此账号来识别用户。
-
在您的应用中,您可以从
firebase::auth::User
对象获取用户的基本个人资料信息:firebase::auth::User user = auth->current_user(); if (user.is_valid()) { std::string name = user.display_name(); std::string email = user.email(); std::string photo_url = user.photo_url(); // The user's ID, unique to the Firebase project. // Do NOT use this value to authenticate with your backend server, // if you have one. Use firebase::auth::User::Token() instead. std::string uid = user.uid(); }
在您的 Firebase Realtime Database 和 Cloud Storage 安全规则中,您可以从
auth
变量获取已登录用户的唯一用户 ID,然后利用此 ID 来控制用户可以访问哪些数据。
您可以通过将身份验证提供方凭据关联至现有用户账号,让用户可以使用多个身份验证提供方登录您的应用。
如需将用户退出登录,请调用 SignOut()
:
auth->SignOut();