tms-koa-account

tms-koa-account

tms-koa账号管理控制器插件。

• 支持账号的增删改查操作
• 支持基于 token 的认证功能
• 支持验证码校验服务

tms-koa 用户认证方法

在tms-koa的配置文件./config/app.js中设置

models/authenticate.js

export default {
  auth: {
    client: {
      npm: {
        disabled: false,
        id: 'tms-koa-account/dist/models',
        // module: '',
        authentication: 'authenticate.js',
        register: 'register.js',
      },
    },
  },
}

字段	说明	类型	必填
client.npm.id	第三方模块	string	Y
client.npm.module	登录注册方法的独立模块文件	string	N\Y
client.npm.authentication	登录函数（如果没有 module，应为模块文件，如果有 module，为具体方法名）	string	N\Y
client.npm.register	注册函数（如果没有 module，应为模块文件，如果有 module，为具体方法名）	string	N

账号管理配置文件

配置文件./config/account.js

export default {
  disabled: false,
  admin: { username: 'admin', password: 'admin', expiresIn: 4500 },
  accounts: [
    {
      id: 1,
      username: 'user1',
      password: 'user1',
      isAdmin: true,
      allowMultiLogin: true,
      expiresIn: 7200,
    },
  ],
  mongodb: {
    disabled: true,
    name: 'master',
    database: 'tms_account',
    collection: 'account',
    schema: { test: { type: 'string', title: '测试' } }, // 集合中要保留的账号信息字段
  },
  // redis: {
  //   name: master
  // }
  // accountBeforeEach: "./accountBeforeEach.js", // 登录、注册 前置步骤，如：对账号密码解密等
  // accountBeforeEach: (ctx) => {
  //   const { decodeAccountV1 } = require('tms-koa-account/models/crypto')
  //   const rst = decodeAccountV1(ctx)
  //   if (rst[0] === false)
  //     return Promise.reject(rst[1])
  //   return Promise.resolve({ username: rst[1].username, password: rst[1].password })
  // },
  authConfig: {
    pwdErrMaxNum: 5, // int 密码错误次数限制 0 不限制
    authLockDUR: 20, // int 登录锁定时长 （秒）
    pwdStrengthCheck: {
      min: 8, // 密码最小长度
      max: 20, // 密码最大长度
      pwdBlack: ['P@ssw0rd'], // 密码黑名单
      containProjects: {
        mustCheckNum: 3,
        contains: ['digits', 'uppercase', 'lowercase', 'symbols'],
      }, // 是否包含数字、大写字母、小写字母、特殊字符, 至少满足其中length项
      hasSpaces: false, // 是否允许包含空格
      hasAccount: false, // 是否允许包含账号
      hasKeyBoardContinuousChar: false,
      // hasKeyBoardContinuousCharSize: 4
    },
  },
}

字段	说明	类型	必填
admin	管理员账号	object	否
存储在 mongodb
mongodb	存储账号数据的 MongoDB 设置	object	否
mongodb.name	tms-koa配置的MongoDB连接名称。	object	否
mongodb.database	存放用户账号的数据库。	string	否
mongodb.collection	存放用户账号的集合名称。	string	否
mongodb.schema	账号集合中中要保留的账号信息字段	object	否
存储在文件中
accounts	存储账号数据的数据	object[]	否
其他
accountBeforeEach	登录、注册 前置步骤，如：对账号密码解密等	string\function	否
authConfig	登录或注册时的检查	object	否

注意：mongodb设置优先于accounts方式。

authConfig 字段说明

字段	说明	类型	必填
pwdErrMaxNum	密码错误次数限制 0 不限制	int	否
authLockDUR	密码错误次数超限后登录锁定时长（秒）	int	否
pwdStrengthCheck	注册时密码强度校验	object	否

pwdStrengthCheck 字段说明

字段	说明	类型	必填
min	密码最小长度	int	否
max	密码最大长度	int	否
pwdBlack	密码黑名单	object[]	否
containProjects	密码中需要包含的字符类型	object	否
hasSpaces	密码中是否可以包含空格	boolean	否
hasAccount	密码中是否可以包含账号	boolean	否
hasKeyBoardContinuousChar	密码中是否可以包含连续键盘字符	boolean	否
hasKeyBoardContinuousCharSize	判断密码中包含连续键盘字符的长度	boolean	否

mongodb优先于accounts设置。

密码强度校验类

const { PasswordProcess } = require('../models/processpwd')
const pwdProcess = new PasswordProcess(password)
pwdProcess.options = { account }
const checkRst = pwdProcess.pwdStrengthCheck()

账号对象固定字段

字段	说明	类型	必填
_id	系统自动生成 id	ObjectId	是
username	用户账户名，不可重复	string	是
nickname	用户昵称	string	是
password	系统自动加密	string	是
salt	系统自动生成	string	是
pwdErrNum	密码错误次数	int	否
authLockExp	授权锁截止时间	string	否
isAdmin	是否为管理员	boolean	否
allowMultiLogin	是否允许多点登录。只在 token 由 redis 管理的情况下有效。	boolean	否

演示

密码

登录

curl -H "Content-Type: application/json" -X POST -d '{ "username": "admin", "password":"admin" }' http://localhost:3001/auth/authenticate

curl -H "Content-Type: application/json" -X POST -d '{ "appid":"oauth","captchaid":"oauth001","code":"a1z9","username": "admin", "password":"admin" }' http://localhost:3001/auth/authenticate

获取用户列表

curl 'http://localhost:3001/api/account/admin/list?access_token='

创建账号

curl -H "Content-Type: application/json" -X POST -d '{"username": "user1", "password":"1a2b3c@TMS", "nickname": "user1" }' 'http://localhost:3009/api/account/admin/create?access_token='

用户注册

curl -H "Content-Type: application/json" -X POST -d '{"username":"user1","password":"user1","appid":"oauth","captchaid":"aly21","code":"aabb"}' 'http://localhost:3009/auth/register'

启动 tms-koa-account 服务

配置

./config/app.js

export default {
  port: process.env.APP_PORT2 || 3002,
  name: 'tms-koa-account-demo2',
  router: {
    auth: {
      // prefix: 'auth' // 接口调用url的前缀
    },
  },
}

./config/account.js

同上【账号管理配置文件】

启动服务

const log4js = require('log4js')
log4js.configure({
  appenders: {
    consoleout: { type: 'console' },
  },
  categories: {
    default: { appenders: ['consoleout'], level: 'debug' },
  },
})

const { TmsKoaAccount } = require('tms-koa-account')

const tmsKoaAccount = new TmsKoaAccount()

tmsKoaAccount.startup()

TMS_KOA_ACCOUNT API

加密模块

tms-koa-account/models/crypto.js

示例

const { Crypto, encodeAccountV1, decodeAccountV1 } = require('./models/crypto')

const username = 'user135'
const password = '8811aa,,'
// const key = "1234567890123adc"

// const endcode = Crypto.encrypt.v1(password, key)
// console.log(endcode) // [ true, 'bcuH42HRi0ZzUj7n5cQy9g==' ]
// const decode = Crypto.decrypt.v1(endcode[1], key)
// console.log(decode) // [ true, '8811aa,,' ]

// 加密
const endcode2 = encodeAccountV1({ username, password })
console.log(endcode2) // [true,{username: 'LFkb4u6uwxRJE3e0+ic8tg==',password: '+aYVOV0aTvgGgo+X/gTv4Q=='}]
// 解密
const decode2 = decodeAccountV1({
  request: {
    body: { username: endcode2[1].username, password: endcode2[1].password },
    query: {},
  },
})
console.log(decode2) // [ true, { username: 'user135', password: '8811aa,,' } ]