跳到主要内容

自定义登录

开发者可以使用自定义登录，在自己的服务器或者云函数内，为用户签发带有自定义身份 ID 的自定义登录凭证 Ticket，随后用户端 SDK 便可以使用 Ticket 登录 CloudBase。

版本说明
  • 登录鉴权(v2) 适用于 @cloudbase/js-sdk@2.x 版本
  • 如您使用的 SDK 版本为 1.x，请参考 登录鉴权(v1)
  • v2 版本暂不支持公众号登录方式，如需使用该方式，请用 v1 版本

本文将以 V2 版本进行介绍

适用场景​

自定义登录一般用于下面几种场景：

  • 开发者希望将自有的账号体系与云开发 CloudBase 账号进行一对一关联；
  • 开发者希望自行接管鉴权流程。

步骤概览​

自定义登录需要以下几个步骤：

  1. 获取 CloudBase 自定义登录私钥；
  2. 使用 CloudBase 服务端 SDK，通过私钥签发出 Ticket，并返回至用户端；
  3. 用户端 SDK 使用 Ticket 登录 CloudBase。

前置动作​

获取自定义登录私钥​

  1. 前往 云开发/身份认证
  2. 在登录方式列表中，选择自定义登录方式，点击"去设置"启用自定义登录，再点击私钥下载

云开发下载私钥

私钥是一份携带有 JSON 数据的文件，请将下载或复制的私钥文件保存到您的服务器或者云函数中，假设路径为 /path/to/your/tcb_custom_login.json 。

注意
  1. 私钥文件是证明管理员身份的重要凭证，请务必妥善保存，避免泄漏；
  2. 每次生成私钥文件都会使之前生成的私钥文件在 2 小时后失效。

签发 Ticket​

调用 CloudBase 服务端 SDK，在初始化时传入自定义登录私钥，随后便可以签发出 Ticket，并返回至用户端。

const cloudbase = require("@cloudbase/node-sdk");

// 1. 初始化 SDK
const app = cloudbase.init({
    env: "your-env-id",
    // 传入自定义登录私钥
    credentials: require("/path/to/your/tcb_custom_login.json")
});

// 2. 开发者自定义的用户唯一身份标识
const customUserId = "your-customUserId";

// 3. 创建ticket
const ticket = app.auth().createTicket(customUserId);

// 4. 将ticket返回至客户端
return ticket;
注意

customUserId 必须满足以下需求：

  • 4-32 位字符；
  • 字符只能是大小写英文字母、数字、以及 _-#@(){}[]:.,<>+#~ 中的字符。
提示

开发者也可以编写一个云函数用于生成 Ticket，并为其设置 HTTP 访问服务，随后用户端便可以通过 HTTP 请求的形式获取 Ticket，详细的方案请参阅 使用 HTTP 访问云函数。

注册流程​

使用自定义登录时，用户管理完全由开发者自行处理。在 CloudBase 中，自定义登录不需要单独的注册流程，用户在第一次使用自定义登录时会自动创建对应的 CloudBase 用户。

注册流程主要包括：

  1. 在您的用户系统中创建用户账号
  2. 使用 CloudBase 服务端 SDK 为该用户签发 Ticket
  3. 客户端使用 Ticket 完成首次登录（此时 CloudBase 会自动创建对应用户）

登录流程​

用户端应用获取到 Ticket 之后，便可以调用 客户端 SDK 的方法登录 CloudBase：

Auth.setCustomSignFunc 用于获取自定义登录的ticket

import cloudbase from '@cloudbase/js-sdk';

const app = cloudbase.init({
    env: 'your-env-id'
});

const auth = app.auth();

async function login() {
    const loginState = auth.hasLoginState();
    // 1. 建议登录前检查当前是否已经登录
    if (!loginState) {
        // 2. 请求开发者自有服务接口获取ticket
        await auth.setCustomSignFunc(() => {
            // 获取 ticket 并返回
            return Promise.resolve( /* ticket */ );
        })
        // 3. 登录 CloudBase
        await auth.signInWithCustomTicket();
    }
}

login();

整体流程示意如下：

自定义登录

常见问题​

自定义登录一定需要自己假设用于创建 Ticket 的服务器吗？

自定义登录必须有一个创建 Ticket 的服务，但是开发者并非一定要自己搭建服务器。

开发者还可以编写一个云函数来创建 Ticket，然后客户端使用 HTTP 请求调用这个云函数获取 Ticket，详细请参阅 使用 HTTP 访问云函数。