1.7.10 • Published 11 months ago

@nocobase/plugin-auth v1.7.10

Weekly downloads
-
License
-
Repository
-
Last release
11 months ago

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 扩展组件
1.6.4

1 year ago

1.6.3

1 year ago

1.6.2

1 year ago

1.6.1

1 year ago

1.6.0

1 year ago

1.4.20

1 year ago

1.3.53

1 year ago

1.3.54

1 year ago

1.4.22

1 year ago

1.3.51

1 year ago

1.4.21

1 year ago

1.3.52

1 year ago

1.4.24

1 year ago

1.4.23

1 year ago

1.4.26

1 year ago

1.3.55

1 year ago

1.4.25

1 year ago

1.4.28

1 year ago

1.4.27

1 year ago

1.4.29

1 year ago

1.3.44-beta

2 years ago

1.7.9

11 months ago

1.7.8

11 months ago

1.7.7

11 months ago

1.4.31

1 year ago

1.7.6

11 months ago

1.4.30

1 year ago

1.7.5

11 months ago

1.4.33

1 year ago

1.7.4

11 months ago

1.4.32

1 year ago

1.4.34

1 year ago

1.3.49-beta

2 years ago

1.5.5

1 year ago

1.5.4

1 year ago

1.5.3

1 year ago

1.5.2

1 year ago

1.5.1

1 year ago

1.5.0

1 year ago

1.6.9

1 year ago

1.6.8

1 year ago

1.6.7

1 year ago

1.6.6

1 year ago

1.4.11

1 year ago

1.6.5

1 year ago

1.4.10

1 year ago

1.4.13

1 year ago

1.4.12

1 year ago

1.4.15

1 year ago

1.4.14

1 year ago

1.4.17

1 year ago

1.4.16

1 year ago

1.4.19

1 year ago

1.4.18

1 year ago

1.4.6

1 year ago

1.4.5

1 year ago

1.4.4

1 year ago

1.4.3

1 year ago

1.7.0-alpha.3

1 year ago

1.4.2

1 year ago

1.7.0-alpha.4

1 year ago

1.4.1

1 year ago

1.7.0-alpha.1

1 year ago

1.4.0

1 year ago

1.7.0-alpha.2

1 year ago

1.4.0-beta.9

1 year ago

1.4.0-beta.8

1 year ago

1.4.0-beta.7

1 year ago

1.4.0-beta.6

1 year ago

1.5.9

1 year ago

1.4.0-beta.5

1 year ago

1.5.8

1 year ago

1.4.0-beta.4

1 year ago

1.5.7

1 year ago

1.4.0-beta.3

1 year ago

1.5.6

1 year ago

1.4.0-beta.2

1 year ago

1.4.0-beta.1

1 year ago

1.8.0-alpha.2

12 months ago

1.8.0-alpha.3

11 months ago

1.8.0-alpha.1

12 months ago

1.8.0-alpha.6

11 months ago

1.8.0-alpha.4

11 months ago

1.8.0-alpha.5

11 months ago

1.4.9

1 year ago

1.4.8

1 year ago

1.4.7

1 year ago

1.7.0-beta.29

1 year ago

1.6.0-alpha.29

1 year ago

1.6.0-alpha.28

1 year ago

1.7.0-beta.27

1 year ago

1.7.0-beta.28

1 year ago

1.7.0-beta.25

1 year ago

1.7.0-beta.26

1 year ago

1.6.0-alpha.23

1 year ago

1.6.0-alpha.22

1 year ago

1.6.0-alpha.21

1 year ago

1.6.0-alpha.20

1 year ago

1.6.0-alpha.27

1 year ago

1.6.0-alpha.26

1 year ago

1.6.0-alpha.25

1 year ago

1.6.0-alpha.24

1 year ago

1.6.0-alpha.30

1 year ago

1.7.0-beta.23

1 year ago

1.7.0-beta.24

1 year ago

1.7.0-beta.21

1 year ago

1.7.0-beta.22

1 year ago

1.7.0-beta.20

1 year ago

1.6.0-alpha.19

1 year ago

1.7.0-beta.18

1 year ago

1.6.0-alpha.18

1 year ago

1.7.0-beta.19

1 year ago

1.6.0-alpha.17

1 year ago

1.7.0-beta.16

1 year ago

1.7.0-beta.17

1 year ago

1.7.0-beta.14

1 year ago

1.7.0-beta.15

1 year ago

1.6.0-alpha.12

1 year ago

1.6.0-alpha.11

1 year ago

1.6.0-alpha.10

1 year ago

1.6.0-alpha.16

1 year ago

1.6.0-alpha.15

1 year ago

1.6.0-alpha.14

1 year ago

1.6.0-alpha.13

1 year ago

1.7.0-beta.12

1 year ago

1.7.0-beta.13

1 year ago

1.7.0-beta.10

1 year ago

1.7.0-beta.11

1 year ago

1.6.0-alpha.1

1 year ago

1.6.0-alpha.5

1 year ago

1.6.0-alpha.4

1 year ago

1.6.0-alpha.3

1 year ago

1.6.0-alpha.2

1 year ago

1.6.0-alpha.9

1 year ago

1.6.0-alpha.8

1 year ago

1.6.0-alpha.7

1 year ago

1.6.0-alpha.6

1 year ago

1.3.47-beta

2 years ago

1.6.0-alpha.31

1 year ago

1.7.0-beta.34

12 months ago

1.7.0-beta.32

12 months ago

1.7.0-beta.33

12 months ago

1.7.0-beta.30

1 year ago

1.7.0-beta.31

1 year ago

1.4.0-alpha.0

2 years ago

1.4.0-alpha.1

2 years ago

1.4.0-alpha.2

2 years ago

1.4.0-alpha.3

2 years ago

1.4.0-alpha.8

2 years ago

1.4.0-alpha.9

2 years ago

1.4.0-alpha.4

2 years ago

1.4.0-alpha.5

2 years ago

1.4.0-alpha.6

2 years ago

1.4.0-alpha.7

2 years ago

1.4.0-alpha.17

1 year ago

1.4.0-alpha.15

1 year ago

1.4.0-alpha.16

1 year ago

1.7.3

11 months ago

1.4.0-alpha.13

1 year ago

1.7.2

11 months ago

1.4.0-alpha.14

1 year ago

1.7.1

12 months ago

1.4.0-alpha.11

1 year ago

1.7.0

12 months ago

1.4.0-alpha.12

1 year ago

1.4.0-alpha.10

1 year ago

1.5.0-beta.2

1 year ago

1.5.0-beta.1

1 year ago

1.5.0-beta.8

1 year ago

1.5.0-beta.7

1 year ago

1.5.0-beta.9

1 year ago

1.5.0-beta.4

1 year ago

1.5.0-beta.3

1 year ago

1.5.0-beta.6

1 year ago

1.5.0-beta.5

1 year ago

1.7.0-alpha.11

1 year ago

1.7.0-alpha.10

1 year ago

1.7.0-alpha.13

1 year ago

1.7.0-alpha.12

1 year ago

1.7.0-alpha.15

12 months ago

1.7.0-alpha.14

12 months ago

1.4.0-beta.10

1 year ago

1.4.0-beta.11

1 year ago

1.5.0-beta.34

1 year ago

1.5.0-beta.33

1 year ago

1.5.0-beta.32

1 year ago

1.5.0-beta.31

1 year ago

1.5.0-beta.30

1 year ago

1.3.43-beta

2 years ago

1.5.0-beta.29

1 year ago

1.5.0-beta.28

1 year ago

1.5.0-beta.27

1 year ago

1.5.0-beta.26

1 year ago

1.5.0-beta.25

1 year ago

1.5.0-beta.24

1 year ago

1.5.0-beta.23

1 year ago

1.5.0-beta.22

1 year ago

1.5.0-beta.21

1 year ago

1.5.0-beta.20

1 year ago

1.5.0-beta.19

1 year ago

1.5.0-beta.18

1 year ago

1.5.0-beta.17

1 year ago

1.5.0-beta.16

1 year ago

1.5.0-beta.15

1 year ago

1.5.0-beta.14

1 year ago

1.5.0-beta.13

1 year ago

1.5.0-beta.12

1 year ago

1.5.0-beta.11

1 year ago

1.5.0-beta.10

1 year ago

1.3.48-beta

2 years ago

1.3.45-beta

2 years ago

1.6.0-beta.8

1 year ago

1.6.0-beta.9

1 year ago

1.6.0-beta.4

1 year ago

1.6.0-beta.5

1 year ago

1.6.0-beta.6

1 year ago

1.6.0-beta.7

1 year ago

1.6.0-beta.1

1 year ago

1.6.0-beta.2

1 year ago

1.6.0-beta.3

1 year ago

1.8.0-beta.6

11 months ago

1.7.10

11 months ago

1.8.0-beta.1

12 months ago

1.8.0-beta.3

12 months ago

1.8.0-beta.2

12 months ago

1.8.0-beta.5

11 months ago

1.3.50-beta

2 years ago

1.8.0-beta.4

11 months ago

1.6.0-beta.17

1 year ago

1.6.0-beta.18

1 year ago

1.6.0-beta.15

1 year ago

1.6.0-beta.16

1 year ago

1.6.0-beta.19

1 year ago

1.6.0-beta.10

1 year ago

1.6.20

1 year ago

1.6.22

1 year ago

1.6.0-beta.13

1 year ago

1.6.21

1 year ago

1.6.0-beta.14

1 year ago

1.6.24

1 year ago

1.6.0-beta.11

1 year ago

1.6.23

1 year ago

1.6.0-beta.12

1 year ago

1.6.26

1 year ago

1.6.25

1 year ago

1.6.28

1 year ago

1.6.27

1 year ago

1.6.29

1 year ago

1.5.0-alpha.1

1 year ago

1.6.31

12 months ago

1.6.30

1 year ago

1.6.33

12 months ago

1.6.32

12 months ago

1.6.35

12 months ago

1.6.34

12 months ago

1.6.37

12 months ago

1.5.0-alpha.3

1 year ago

1.6.36

12 months ago

1.5.0-alpha.4

1 year ago

1.5.0-alpha.5

1 year ago

1.6.38

12 months ago

1.3.46-beta

2 years ago

1.7.0-beta.3

1 year ago

1.7.0-beta.4

1 year ago

1.7.0-beta.1

1 year ago

1.7.0-beta.2

1 year ago

1.7.0-beta.7

1 year ago

1.7.0-beta.8

1 year ago

1.7.0-beta.5

1 year ago

1.7.0-beta.6

1 year ago

1.7.0-beta.9

1 year ago

1.6.11

1 year ago

1.6.10

1 year ago

1.6.13

1 year ago

1.6.12

1 year ago

1.6.15

1 year ago

1.6.14

1 year ago

1.6.17

1 year ago

1.6.16

1 year ago

1.6.19

1 year ago

1.6.18

1 year ago

1.5.10

1 year ago

1.5.12

1 year ago

1.5.11

1 year ago

1.5.14

1 year ago

1.5.13

1 year ago

1.5.16

1 year ago

1.5.15

1 year ago

1.5.18

1 year ago

1.5.17

1 year ago

1.5.19

1 year ago

1.5.21

1 year ago

1.5.20

1 year ago

1.5.23

1 year ago

1.5.22

1 year ago

1.5.25

1 year ago

1.5.24

1 year ago

1.5.26

1 year ago

1.3.41-beta

2 years ago

1.3.42-beta

2 years ago

1.3.40-beta

2 years ago

1.3.38-beta

2 years ago

1.4.0-alpha

2 years ago

1.3.39-beta

2 years ago

1.3.37-beta

2 years ago

1.3.36-beta

2 years ago

1.3.34-beta

2 years ago

1.3.33-beta

2 years ago

1.3.35-beta

2 years ago

1.3.26-beta

2 years ago

1.3.31-beta

2 years ago

1.3.28-beta

2 years ago

1.3.27-beta

2 years ago

1.3.32-beta

2 years ago

1.3.29-beta

2 years ago

1.3.30-beta

2 years ago

1.3.25-beta

2 years ago

1.3.24-beta

2 years ago

1.3.23-beta

2 years ago

1.3.22-beta

2 years ago

1.3.21-beta

2 years ago

1.3.20-beta

2 years ago

1.3.17-beta

2 years ago

1.3.19-beta

2 years ago

1.3.18-beta

2 years ago

1.3.16-beta

2 years ago

1.3.15-beta

2 years ago

1.3.14-beta

2 years ago

1.3.13-beta

2 years ago

1.3.12-beta

2 years ago

1.3.11-beta

2 years ago

1.3.10-beta

2 years ago

1.3.7-beta

2 years ago

1.3.9-beta

2 years ago

1.3.8-beta

2 years ago

1.3.6-beta

2 years ago

1.3.5-beta

2 years ago

1.3.4-beta

2 years ago

1.3.3-beta

2 years ago

1.3.1-beta

2 years ago

1.3.2-beta

2 years ago

1.2.19-alpha

2 years ago

1.2.3-alpha

2 years ago

1.2.9-alpha

2 years ago

1.2.36-alpha

2 years ago

1.2.12-alpha

2 years ago

1.2.24-alpha

2 years ago

1.2.2-alpha

2 years ago

1.2.35-alpha

2 years ago

1.2.25-alpha

2 years ago

1.3.0-alpha

2 years ago

1.2.34-alpha

2 years ago

1.2.1-alpha

2 years ago

1.2.11-alpha

2 years ago

1.2.17-alpha

2 years ago

1.2.37-alpha

2 years ago

1.2.22-alpha

2 years ago

1.2.4-alpha

2 years ago

1.2.14-alpha

2 years ago

1.2.7-alpha

2 years ago

1.3.0-beta

2 years ago

1.2.39-alpha

2 years ago

1.2.6-alpha

2 years ago

1.2.21-alpha

2 years ago

1.2.16-alpha

2 years ago

1.2.32-alpha

2 years ago

1.2.27-alpha

2 years ago

1.0.0-alpha.16

2 years ago

1.0.0-alpha.17

2 years ago

1.2.15-alpha

2 years ago

1.2.28-alpha

2 years ago

1.2.5-alpha

2 years ago

1.2.38-alpha

2 years ago

1.2.29-alpha

2 years ago

1.2.26-alpha

2 years ago

1.0.1-alpha.2

2 years ago

1.0.1-alpha.1

2 years ago

1.2.8-alpha

2 years ago

1.0.1-alpha.3

2 years ago

1.2.20-alpha

2 years ago

1.2.10-alpha

2 years ago

1.2.30-alpha

2 years ago

1.2.13-alpha

2 years ago

1.2.0-alpha

2 years ago

1.2.23-alpha

2 years ago

1.2.33-alpha

2 years ago

1.0.0-alpha.15

2 years ago

1.0.0-alpha.14

2 years ago

1.0.0-alpha.13

2 years ago

1.0.0-alpha.12

2 years ago

1.0.0-alpha.10

2 years ago

1.0.0-alpha.11

2 years ago

1.0.0-alpha.9

2 years ago

1.0.0-alpha.8

2 years ago

1.0.0-alpha.6

2 years ago

1.0.0-alpha.5

2 years ago

1.0.0-alpha.4

2 years ago

1.0.0-alpha.3

2 years ago

1.0.0-alpha.2

2 years ago

1.0.0-alpha.1

2 years ago

0.21.0-alpha.16

2 years ago

0.21.0-alpha.15

2 years ago

0.21.0-alpha.14

2 years ago

0.21.0-alpha.13

2 years ago

0.21.0-alpha.12

2 years ago

0.21.0-alpha.11

2 years ago

0.21.0-alpha.10

2 years ago

0.21.0-alpha.9

2 years ago

0.21.0-alpha.8

2 years ago

0.21.0-alpha.7

2 years ago

0.21.0-alpha.6

2 years ago

0.21.0-alpha.5

2 years ago

0.21.0-alpha.4

2 years ago

0.21.0-alpha.3

2 years ago

0.21.0-alpha.2

2 years ago

0.21.0-alpha.1

2 years ago

0.20.0-alpha.17

2 years ago

0.20.0-alpha.16

2 years ago

0.20.0-alpha.15

2 years ago

0.20.0-alpha.14

2 years ago

0.20.0-alpha.12

2 years ago

0.20.0-alpha.13

2 years ago

0.20.0-alpha.11

2 years ago

0.20.0-alpha.9

2 years ago

0.20.0-alpha.10

2 years ago

0.19.0-alpha.10

2 years ago

0.20.0-alpha.8

2 years ago

0.20.0-alpha.7

2 years ago

0.20.0-alpha.6

2 years ago

0.20.0-alpha.4

2 years ago

0.20.0-alpha.5

2 years ago

0.20.0-alpha.3

2 years ago

0.20.0-alpha.1

2 years ago

0.20.0-alpha.2

2 years ago

0.19.0-alpha.9

2 years ago

0.19.0-alpha.8

2 years ago

0.19.0-alpha.7

2 years ago

0.19.0-alpha.6

2 years ago

0.19.0-alpha.5

2 years ago

0.19.0-alpha.4

2 years ago

0.19.0-alpha.3

2 years ago

0.19.0-alpha.2

2 years ago

0.19.0-alpha.1

2 years ago

0.18.0-alpha.9

2 years ago

0.18.0-alpha.3

2 years ago

0.18.0-alpha.5

2 years ago

0.18.0-alpha.6

2 years ago

0.18.0-alpha.7

2 years ago

0.18.0-alpha.8

2 years ago

0.18.0-alpha.2

2 years ago

0.18.0-alpha.1

2 years ago

0.17.0-alpha.7

2 years ago

0.17.0-alpha.6

2 years ago

0.17.0-alpha.4

2 years ago

0.17.0-alpha.5

2 years ago

0.17.0-alpha.3

2 years ago

0.17.0-alpha.2

2 years ago

0.17.0-alpha.1

2 years ago

0.16.0-alpha.6

2 years ago

0.12.0-alpha.1

3 years ago

0.12.0-alpha.2

3 years ago

0.12.0-alpha.3

3 years ago

0.12.0-alpha.4

3 years ago

0.12.0-alpha.5

3 years ago

0.10.1-alpha.1

3 years ago

0.14.0-alpha.5

3 years ago

0.14.0-alpha.4

3 years ago

0.14.0-alpha.3

3 years ago

0.14.0-alpha.2

3 years ago

0.14.0-alpha.8

3 years ago

0.14.0-alpha.7

3 years ago

0.13.0-alpha.10

3 years ago

0.14.0-alpha.6

3 years ago

0.16.0-alpha.1

2 years ago

0.16.0-alpha.3

2 years ago

0.16.0-alpha.5

2 years ago

0.14.0-alpha.1

3 years ago

0.16.0-alpha.4

2 years ago

0.11.1-alpha.1

3 years ago

0.11.1-alpha.2

3 years ago

0.11.1-alpha.3

3 years ago

0.11.1-alpha.4

3 years ago

0.11.1-alpha.5

3 years ago

0.11.0-alpha.1

3 years ago

0.13.0-alpha.9

3 years ago

0.13.0-alpha.8

3 years ago

0.13.0-alpha.7

3 years ago

0.13.0-alpha.6

3 years ago

0.13.0-alpha.5

3 years ago

0.13.0-alpha.4

3 years ago

0.13.0-alpha.3

3 years ago

0.13.0-alpha.2

3 years ago

0.13.0-alpha.1

3 years ago

0.15.0-alpha.5

2 years ago

0.15.0-alpha.3

2 years ago

0.15.0-alpha.4

2 years ago

0.15.0-alpha.1

3 years ago

0.15.0-alpha.2

3 years ago

0.10.0-alpha.5

3 years ago

0.10.0-alpha.3

3 years ago

0.10.0-alpha.4

3 years ago

0.10.0-alpha.2

3 years ago