tachybase_todo/packages/plugins/auth
jack zhang 5df3b0e75d
refactor!: plugins build and plugins load (#2253)
* refactor: plugin build and plugin template

* refactor: plugins' deps

* refactor: plugins bugs

* feat: add plugin static middleware

* fix: bugs

* refactor: frontend plugin add from remote

* refactor: delete useless app/client/plugins

* fix: requirejs move to local

* fix: tests case

* refactor: add src/client and src/server dir check

* fix: lodash tree shaking

* refactor: add BUILD_TIP

* refactor: add file size tip

* fix: bugs

* fix: bug

* fix: change china-division

* fix: change plugins response

* fix: recover dynamicImport

* fix: change server src entry

* fix: test error

* fix: plugins sourcemap => false

* fix: production file error

* refactor: change build tools to vite and tsup

* fix: yarn.lock

* fix: bugs

* fix: server build bugs

* fix: delete .fatherrc.ts

* fix: bug

* fix: bug

* fix: bugs

* fix: bugs

* fix: bugs

* refactor: add plugin d.ts

* refactor: delete fatherrc

* refactor: delete father scripts

* refactor: build bug

* fix: bug

* fix: deps adjust

* fix: add build tips

* fix: bug

* refactor: ignore plugins when build client

* docs: update doc

* refactor: docs and build

* fix: bug

* refactor: build deps

* fix: add USER_REMOTE_PLUGIN env

* feat: add plugin static cache

* feat: add build deps cache

* fix: bugs

* test: add test

* fix: add plugin depden on plugin tip

* fix: adjust shouldDevDependencies

* fix: deps

* fix: ajust deps

* fix: mobile style error

* fix: map error

* fix: test

* fix: bug

* feat: lodash and dayjs import from themself

* feat: @emotion/css 、ahooks and lodash to global

* fix: theme-editor plugin error

* fix: review

* feat: move all plugins' dependencies to devDependencies

* feat: change build

* feat: add devPlugins

* fix: bug

* fix: bugs

* fix: bugs

* fix: bugs

* feat: build bugs

* fix: bugs

* fix: bugs

* fix: review

* fix: bug

* fix: change deps build

* fix: bugs

* fix: bug

* fix: bug

* fix: bugs

* fix: bug

* fix: bug

* fix: multi language

* fix: dist

* fix: cronstrue

* fix: getPackageClientStaticUrl

* fix: antd dayjs locale

* fix: plugin' d.ts import from dist

* fix: multi language

* fix: build types error

* fix: requireModule

* fix: plugin lifecycle

* fix: client resource

* fix: improve code

* fix: locale

* feat: custom build

* fix: require locale

* fix: improve code

* fix: improve code

* fix: skip preset

* fix: collection undefined

* feat: yarn build

* fix: remove enabled

* fix: update dockerfile

* fix: formily version

* docs: update v12 changelog

* fix: devDependencies

* feat: @nocobase/app

* feat: generateAppDir

* fix: improve code

* fix: 0.11.1-alpha.5

* fix: missing @nocobase/client

* fix: error

* fix: add .npmignore

* feat: upgrade antd version

* fix: dependencies

* fix: peerDependencies

* fix: remove china-division dep

* fix: toposort deps

* fix: update dockerfile

* fix: plugin template

* fix: app client outputPath

* feat: update docs

* fix: nginx server root

* fix: storage/.app-dev

* fix: getChinaDivisionData

* feat: plugin info

* feat: update docs

* fix: docs menu

---------

Co-authored-by: chenos <chenlinxh@gmail.com>
2023-08-02 00:07:52 +08:00
..
src refactor!: plugins build and plugins load (#2253) 2023-08-02 00:07:52 +08:00
.npmignore refactor!: plugins build and plugins load (#2253) 2023-08-02 00:07:52 +08:00
client.d.ts refactor!: plugins build and plugins load (#2253) 2023-08-02 00:07:52 +08:00
client.js refactor!: plugins build and plugins load (#2253) 2023-08-02 00:07:52 +08:00
package.json refactor!: plugins build and plugins load (#2253) 2023-08-02 00:07:52 +08:00
README.md feat(auth): support custom authentication (#2007) 2023-06-07 23:46:42 +08:00
server.d.ts refactor!: plugins build and plugins load (#2253) 2023-08-02 00:07:52 +08:00
server.js refactor!: plugins build and plugins load (#2253) 2023-08-02 00:07:52 +08:00

Auth

提供基础认证功能和扩展认证器管理功能。

使用方法

认证器管理

页面:系统设置 - 认证

内置认证器

  • 名称basic
  • 认证类型:邮箱密码登录

增加认证器

Add new - 选择认证类型

启用/禁用

Actions - Edit - 勾选/取消Enabled

配置认证器

Actions - Edit

开发一个登录插件

接口

Nocobase内核提供了扩展登录方式的接入和管理。扩展登录插件的核心逻辑处理需要继承内核的Auth类,并对相应的标准接口进行实现。 参考core/auth/auth.ts

import { Auth } from '@nocobase/auth';

class CustomAuth extends Auth {
  set user(user) {}
  get user() {}
  
  async check() {}
  async signIn() {}
}

多数情况下扩展的用户登录方式也将沿用现有的jwt逻辑来生成用户访问API的凭证插件也可以继承BaseAuth类以便复用部分逻辑代码,如check, signIn接口。

import { BaseAuth } from '@nocobase/auth';

class CustomAuth extends BaseAuth {
  constructor(config: AuthConfig) {
    const userCollection = config.ctx.db.getCollection('users');
    super({ ...config, userCollection });
  }
  
  async validate() {}
}

用户数据

@nocobase/plugin-auth插件提供了usersAuthenticators表来建立users和authenticators即用户和认证方式的关联。
通常情况下,扩展登录方式用usersusersAuthenticators来存储相应的用户数据即可特殊情况下才需要自己新增Collection.
users存储的是最基础的用户数据,邮箱、昵称和密码。
usersAuthenticators存储扩展登录方式数据

  • uuid: 该种认证方式的用户唯一标识如手机号、微信openid等
  • meta: JSON字段其他需要保存的信息
  • userId: 用户id
  • authenticator认证器名字

对于用户操作,Authenticator模型也提供了几个封装的方法,可以在CustomAuth类中通过this.authenticator[方法名]使用:

  • findUser(uuid: string): UserModel - 查询用户
  • newUser(uuid: string, values?: any): UserModel - 创建新用户
  • findOrCreateUser(uuid: string, userValues?: any): UserModel - 查找或创建新用户

注册

扩展的登录方式需要向内核注册。

async load() {
  this.app.authManager.registerTypes('custom-auth-type', {
    auth: CustomAuth,
  });
}

客户端API

OptionsComponentProvider

可供用户配置的认证器配置项

  • authType 认证方式
  • component 配置组件
<OptionsComponentProvider authType="custom-auth-type" component={Options} /> 

Options组件使用的值是authenticatoroptions字段,如果有需要暴露在前端的配置,应该放在options.public字段中。authenticators:publicList接口会返回options.public字段的值。

SigninPageProvider

自定义登录页界面

  • authType 认证方式
  • tabTitle 登录页tab标题
  • component 登录页组件

SignupPageProvider

自定义注册页界面

  • authType 认证方式
  • component 注册页组件

SigninPageExtensionProvider

自定义登录页下方的扩展内容

  • authType 认证方式
  • component 扩展组件