YuDai

取自古代身份验证令牌“鱼袋”

功能介绍

YuDai 是一款轻量级 OIDC 身份认证服务，实现了基于 TOKEN (隐式模式) 的登录逻辑，支持账户密码、手机号验证码、微信生态等相关登录方式，可作为 Casdoor 的轻量级替代。

OIDC 是一种用于身份验证和授权的开放式协议。它建立在OAuth 2.0基础上，并为第三方应用程序提供了一种方便的方法来验证用户身份并获取用户信息，例如名称、邮件地址等。OIDC还支持单点登录（SSO），以便用户只需在一个地方登录，就可以访问多个应用程序。

• 账户密码登录
• 手机验证码登录
• 微信小程序登录
• 微信公众号登录
• 微信扫码登录
• ...

为什么开发 YuDai

开发 YuDai 主要目的是：为 Fireboom 提供一款轻量级 OIDC 服务，满足 基于 Fireboom 开发 web/app/小程序时的简单登录需求，避免依赖 身份验证供应商，如 auth0 等，以及功能特别庞大的 OIDC 服务，如 Casdoor 等，降低系统的复杂度。

如何使用

安装：

# Linux
curl -o ./yudai https://yudai-bin.fireboom.io/build-env/yudai-linux
# Mac
curl -o ./yudai https://yudai-bin.fireboom.io/build-env/yudai-mac
# Windows
curl -o ./yudai.exe https://yudai-bin.fireboom.io/build-env/yudai-windows.exe

chmod +x ./yudai

数据库初始化

目前YuDai支持 mysql 和 postgres 数据库。

依赖如下表结构：

db schema：./docs/oidc.sql

or

prisma schema：./docs/oidc.prisma

有2种方式初始化数据库：自动迁移和脚本导入。

• 自动迁移：YuDai 服务启动后会自动同步表结构到数据库，详情见 代码
• 脚本导入：
  • db schema：使用命令行或 navicate 等工具导入
  • prisma schema：在 fireboom 控制台操作，详情见：数据建模 -> 数据建模-> 源码视图

插入默认用户：admin/password

INSERT INTO `user` ( `user_id`, `avatar`, `created_at`, `updated_at`, `name`, `password`, `password_salt`, `password_type`, `phone`, `country_code`)
VALUES
	('82313034-e97d-4c30-8e96-c524a772b530','','2024-01-04 03:25:26','2024-01-17 05:47:08','admin','43eec874a5751fe2f687e00ea0eedad9','ODdGvnwqpH','md5','18888888888','CN');

环境变量配置

YuDai 目前仅支持 环境变量 配置，后续将支持 .env 文件配置。

支持如下环境变量：

• YUDAI_PORT ：服务监听端口
• YUDAI_DB_URL ：数据库连接字符串
  • postgres：postgres://user:password@host:port/dbname?sslmode=disable
  • mysql：mysql://user:password@tcp(host:port)/dbname?charset=utf8mb4&parseTime=True&loc=Local

  更多参数查看文档postgres driver和mysql driver

• YUDAI_DB_PREFIX ：数据库表前缀，用来区分多个服务或者和业务表区分开
• YUDAI_PC_APP_ID ：微信pc扫码登录app_id
• YUDAI_PC_APP_SECRET ：微信pc扫码登录app_secret
• YUDAI_H5_APP_ID ：微信公众号h5登录app_id
• YUDAI_H5_APP_SECRET ：微信公众号h5登录app_secret
• YUDAI_APP_APP_ID ：微信app登录app_id
• YUDAI_APP_APP_SECRET ：微信app登录app_secret
• YUDAI_MINI_APP_ID ：微信小程序登录app_id
• YUDAI_MINI_APP_SECRET ：微信小程序登录app_secret

短信配置

YuDai 底层使用了仓库：https://github.com/casdoor/go-sms-sender，支持众多短信供应商，例如 阿里云、腾讯云等。

在 provider 表配置短信供应商：

INSERT INTO "provider" ("owner", "name", "created_at", "type", "client_id", "client_secret", "sign_name", "template_code") VALUES ('fireboom', 'provider_sms', '2023-01-17 01:22:33', 'Aliyun SMS', 'xxxxxxxxxxxxxxxx', 'xxxxxxxxxxxxxxxxxxxxxxxxxxx', 'app_name', 'temp_code');

• owner：供应商分组，默认用 fireboom

• name：供应商名称，默认用 provider_sms

• client_id：客户端 ID

• client_secret：客户端密钥

• sign_name：短信签名

• template_code：短信模板编码

详情参考短信发送代码

jwt 密钥生成

YuDai 服务第一次启动时，会在 cert 目录下生成文件： token_jwt_key.key 和 token_jwt_key.pem ，用于 JWT 签名和验证。

手动删除文件后，会重新生成，但会导致之前签发的 token 失效。因此在正式项目中，需要保持这两个文件不发生变化，例如 k8s 部署时，需要用 Volume 挂载这2个文件。

启动

YUDAI_DB_URL="mysql://root:123456@tcp(localhost:3306)/oidc?charset=utf8mb4&parseTime=True&loc=Local" 
./yudai

启动后日志：

   ____    __
  / __/___/ /  ___
 / _// __/ _ \/ _ \
/___/\__/_//_/\___/ v4.10.2
High performance, minimalist Go web framework
https://echo.labstack.com
____________________________________O/_______
                                    O\
⇨ http server started on [::]:9825

前端如何使用

YuDai 是 REST 风格的服务，所有接口见文档docs/swagger.json。

例如，前端请求登录接口：/api/login

curl --location --request POST 'http://localhost:9825/api/login' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--data-raw '{
    "loginType": "password",
    "username": "admin",
    "password": "password",
    "phone": "string",
    "code": "string",
    "platform": "string",
    "exclusive": true
}'

验证成功后会返回:

{
  "msg": "Login Success",
  "code": 200,
  "success": true,
  "data": {
    "accessToken": "xxxx",
    "refreshToken": "xxxx",
    "expireIn": 1709991576
  }
}

最佳实践可以参考：https://github.com/fireboomio/amis-admin/blob/dev/src/routes/login/index.tsx

如何和 fireboom 结合

YuDai 与 fireboom 的最佳实践可参考该项目：https://github.com/fireboomio/amis-admin

配置身份认证器

将 YuDai 作为 fireboom 的身份认证器， 让 fireboom 可以验证 由 YuDai 签发的 token。

在 fireboom 控制台，点击“身份认证”-> “+”，新建身份认证器。

参考上图填写：

• 供应商id : 任意填写，默认 casdoor
• Issuer：YuDai 的 api 端点，默认为：http://localhost:9825 ; 支持环境变量，OIDC_API_URL 默认值为：http://oidc:9825
• 基于cookie： YuDai 不支持，请 关闭
• 基于token：开启
• jwks：选择 URL 模式

配置后，保存到该文件：https://github.com/fireboomio/amis-admin/blob/dev/backend/store/authentication/casdoor.json

{
  "name": "casdoor",
  "enabled": true,
  "createTime": "2023-09-14T17:03:03.516456935+08:00",
  "updateTime": "2023-09-14T17:04:52.827399338+08:00",
  "deleteTime": "",
  "issuer": {
    "kind": 1,
    "environmentVariableName": "OIDC_API_URL" 
  },
  "oidcConfigEnabled": false,
  "oidcConfig": {
    "issuer": null,
    "clientId": {
      "kind": 0
    },
    "clientSecret": {
      "kind": 0
    },
    "queryParameters": null
  },
  "jwksProviderEnabled": true,
  "jwksProvider": {
    "jwksJson": null,
    "userInfoCacheTtlSeconds": 0
  }
}

fireboom 根据 Issuer 生成服务发现地址：http://127.0.0.1:9825/.well-known/openid-configuration

服务发现地址返回很多数据，包括但不限于：

• 用户端点：userinfo_endpoint
• jwks访问url：jwks_uri

配置 REST 数据源

该步骤可以省略，省略后前端直接访问 9825 端口

将 YuDai 作为 fireboom 的 rest api 数据源，以便 fireboom 代理 YuDai 的 rest api。

代理后的接口见目录：https://github.com/fireboomio/amis-admin/blob/dev/backend/store/operation/user/casdoor

代理后，“登录接口”的访问地址为：

curl 'http://localhost:9991/operations/user/casdoor/login' \
  -X POST  \
  -H 'Content-Type: application/json' \
  --data-raw '{"code":null,"password":null,"phone":null,"platform":null,"username":null,"loginType":null}' \
  --compressed

在 fireboom 控制台，点击“数据源”-> “+” -> “REST API”，新建 rest 数据源。

• 名称：数据源名称，默认 casdoor
• 指定 OAS：YuDai 的 swagger 文档，见 docs/oidc.json
• Rest 端点：YuDai 的 api 端点，默认为：http://localhost:9825；支持环境变量，OIDC_API_URL 默认值为： http://oidc:9825

配置后见如下文件：https://github.com/fireboomio/amis-admin/blob/dev/backend/store/datasource/casdoor.json

{
  "name": "casdoor",
  "enabled": true,
  "createTime": "2023-09-18T10:45:49.51069+08:00",
  "updateTime": "2023-09-18T10:45:52.006846+08:00",
  "deleteTime": "",
  "cacheEnabled": false,
  "kind": 1,
  "customRest": {
    "oasFilepath": "casdoor.json",
    "baseUrl": {
      "kind": 1,
      "environmentVariableName": "OIDC_API_URL"
    },
    "headers": {
    },
    "responseExtractor": {
      "statusCodeJsonpath": "code",
      "errorMessageJsonpath": "msg"
    }
  },
  "customGraphql": null,
  "customDatabase": null
}

更多详情，查看fireboom 文档

未来计划

• pgsql支持
• cookie模式支持
• 更多社交账户支持，如抖音小程序登录