@nocobase/auth 0.10.0-alpha.4 → 0.10.1-alpha.1

package/lib/auth-manager.d.ts

@@ -2,12 +2,15 @@ import { Context, Next } from '@nocobase/actions';
 import { Model } from '@nocobase/database';
 import { Registry } from '@nocobase/utils';
 import { Auth, AuthExtend } from './auth';
+import { JwtOptions, JwtService } from './base/jwt-service';
+import { ITokenBlacklistService } from './base/token-blacklist-service';
 declare type Storer = {
     get: (name: string) => Promise<Model>;
 };
 declare type AuthManagerOptions = {
     authKey: string;
     default?: string;
+    jwt?: JwtOptions;
 };
 declare type AuthConfig = {
     auth: AuthExtend<Auth>;
@@ -16,8 +19,10 @@ export declare class AuthManager {
     protected options: AuthManagerOptions;
     protected authTypes: Registry<AuthConfig>;
     protected storer: Storer;
+    jwt: JwtService;
     constructor(options: AuthManagerOptions);
     setStorer(storer: Storer): void;
+    setTokenBlacklistService(service: ITokenBlacklistService): void;
     /**
      * registerTypes
      * @description Add a new authenticate type and the corresponding authenticator.

package/lib/auth-manager.js

@@ -11,6 +11,7 @@ function _utils() {
   };
   return data;
 }
+var _jwtService = require("./base/jwt-service");
 function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
 function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
 class AuthManager {
@@ -19,11 +20,16 @@ class AuthManager {
     this.authTypes = new (_utils().Registry)();
     // authenticators collection manager.
     this.storer = void 0;
+    this.jwt = void 0;
     this.options = options;
+    this.jwt = new _jwtService.JwtService(options.jwt);
   }
   setStorer(storer) {
     this.storer = storer;
   }
+  setTokenBlacklistService(service) {
+    this.jwt.blacklist = service;
+  }
   /**
    * registerTypes
    * @description Add a new authenticate type and the corresponding authenticator.
@@ -77,6 +83,10 @@ class AuthManager {
     var _this2 = this;
     return /*#__PURE__*/function () {
       var _ref = _asyncToGenerator(function* (ctx, next) {
+        const token = ctx.getBearerToken();
+        if (token && (yield ctx.app.authManager.jwt.blacklist.has(token))) {
+          return ctx.throw(401, ctx.t('token is not available'));
+        }
         const name = ctx.get(_this2.options.authKey) || _this2.options.default;
         let authenticator;
         try {

package/lib/base/auth.d.ts

@@ -1,16 +1,17 @@
+import { Collection, Model } from '@nocobase/database';
 import { Auth, AuthConfig } from '../auth';
 import { JwtService } from './jwt-service';
-import { Collection, Model } from '@nocobase/database';
 /**
  * BaseAuth
  * @description A base class with jwt provide some common methods.
  */
 export declare class BaseAuth extends Auth {
-    protected jwt: JwtService;
     protected userCollection: Collection;
     constructor(config: AuthConfig & {
         userCollection: Collection;
     });
+    get userRepository(): import("@nocobase/database").Repository<any, any>;
+    get jwt(): JwtService;
     set user(user: Model);
     get user(): Model;
     check(): Promise<any>;
@@ -19,4 +20,5 @@ export declare class BaseAuth extends Auth {
         user: Model<any, any>;
         token: string;
     }>;
+    signOut(): Promise<any>;
 }

package/lib/base/auth.js

@@ -5,7 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.BaseAuth = void 0;
 var _auth = require("../auth");
-var _jwtService = require("./jwt-service");
 function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
 function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
 /**
@@ -14,13 +13,16 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
  */
 class BaseAuth extends _auth.Auth {
   constructor(config) {
-    const options = config.options,
-      userCollection = config.userCollection;
+    const userCollection = config.userCollection;
     super(config);
-    this.jwt = void 0;
     this.userCollection = void 0;
     this.userCollection = userCollection;
-    this.jwt = new _jwtService.JwtService(options.jwt);
+  }
+  get userRepository() {
+    return this.userCollection.repository;
+  }
+  get jwt() {
+    return this.ctx.app.authManager.jwt;
   }
   set user(user) {
     this.ctx.state.currentUser = user;
@@ -37,13 +39,16 @@ class BaseAuth extends _auth.Auth {
       }
       try {
         const _yield$_this$jwt$deco = yield _this.jwt.decode(token),
-          userId = _yield$_this$jwt$deco.userId;
-        const user = yield _this.userCollection.repository.findOne({
+          userId = _yield$_this$jwt$deco.userId,
+          roleName = _yield$_this$jwt$deco.roleName;
+        if (roleName) {
+          _this.ctx.headers['x-role'] = roleName;
+        }
+        return yield _this.userRepository.findOne({
           filter: {
             id: userId
           }
         });
-        return user;
       } catch (err) {
         _this.ctx.logger.error(err);
         return null;
@@ -77,5 +82,15 @@ class BaseAuth extends _auth.Auth {
       };
     })();
   }
+  signOut() {
+    var _this3 = this;
+    return _asyncToGenerator(function* () {
+      const token = _this3.ctx.getBearerToken();
+      if (!token) {
+        return;
+      }
+      return yield _this3.jwt.block(token);
+    })();
+  }
 }
 exports.BaseAuth = BaseAuth;

package/lib/base/jwt-service.d.ts

@@ -1,12 +1,20 @@
+import jwt, { SignOptions } from 'jsonwebtoken';
+import { ITokenBlacklistService } from './token-blacklist-service';
 export interface JwtOptions {
     secret: string;
     expiresIn?: string;
 }
+export declare type SignPayload = Parameters<typeof jwt.sign>[0];
 export declare class JwtService {
     protected options: JwtOptions;
-    constructor(options: JwtOptions);
+    constructor(options?: JwtOptions);
+    blacklist: ITokenBlacklistService;
     private expiresIn;
     private secret;
-    sign(payload: any): string;
+    sign(payload: SignPayload, options?: SignOptions): string;
     decode(token: string): Promise<any>;
+    /**
+     * @description Block a token so that this token can no longer be used
+     */
+    block(token: string): Promise<any>;
 }

package/lib/base/jwt-service.js

@@ -12,15 +12,24 @@ function _jsonwebtoken() {
   return data;
 }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
+function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 class JwtService {
-  constructor(options) {
+  constructor(options = {
+    secret: process.env.APP_KEY
+  }) {
     this.options = void 0;
+    this.blacklist = void 0;
     this.options = options;
-    const _ref = options || {},
-      secret = _ref.secret,
-      expiresIn = _ref.expiresIn;
+    const secret = options.secret,
+      expiresIn = options.expiresIn;
     this.options = {
-      secret: secret || process.env.APP_KEY,
+      secret: secret,
       expiresIn: expiresIn || process.env.JWT_EXPIRES_IN || '7d'
     };
   }
@@ -30,10 +39,14 @@ class JwtService {
   secret() {
     return this.options.secret;
   }
-  sign(payload) {
-    return _jsonwebtoken().default.sign(payload, this.secret(), {
+  sign(payload, options) {
+    const opt = _objectSpread({
       expiresIn: this.expiresIn()
-    });
+    }, options);
+    if (opt.expiresIn === 'never') {
+      opt.expiresIn = '1000y';
+    }
+    return _jsonwebtoken().default.sign(payload, this.secret(), opt);
   }
   decode(token) {
     return new Promise((resolve, reject) => {
@@ -45,5 +58,26 @@ class JwtService {
       });
     });
   }
+  /**
+   * @description Block a token so that this token can no longer be used
+   */
+  block(token) {
+    var _this = this;
+    return _asyncToGenerator(function* () {
+      if (!_this.blacklist) {
+        return null;
+      }
+      try {
+        const _yield$_this$decode = yield _this.decode(token),
+          exp = _yield$_this$decode.exp;
+        return _this.blacklist.add({
+          token,
+          expiration: new Date(exp * 1000).toString()
+        });
+      } catch (_unused) {
+        return null;
+      }
+    })();
+  }
 }
 exports.JwtService = JwtService;

package/lib/base/token-blacklist-service.d.ts

@@ -0,0 +1,7 @@
+export interface ITokenBlacklistService {
+    has(token: string): Promise<boolean>;
+    add(values: {
+        token: string;
+        expiration: string | Date;
+    }): Promise<any>;
+}

package/lib/base/token-blacklist-service.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/lib/index.d.ts

@@ -1,4 +1,5 @@
-export * from './auth-manager';
+export * from './actions';
 export * from './auth';
+export * from './auth-manager';
 export * from './base/auth';
-export * from './actions';
+export * from './base/token-blacklist-service';

package/lib/index.js

@@ -3,14 +3,14 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-var _authManager = require("./auth-manager");
-Object.keys(_authManager).forEach(function (key) {
+var _actions = require("./actions");
+Object.keys(_actions).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _authManager[key]) return;
+  if (key in exports && exports[key] === _actions[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function get() {
-      return _authManager[key];
+      return _actions[key];
     }
   });
 });
@@ -25,6 +25,17 @@ Object.keys(_auth).forEach(function (key) {
     }
   });
 });
+var _authManager = require("./auth-manager");
+Object.keys(_authManager).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _authManager[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _authManager[key];
+    }
+  });
+});
 var _auth2 = require("./base/auth");
 Object.keys(_auth2).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
@@ -36,14 +47,14 @@ Object.keys(_auth2).forEach(function (key) {
     }
   });
 });
-var _actions = require("./actions");
-Object.keys(_actions).forEach(function (key) {
+var _tokenBlacklistService = require("./base/token-blacklist-service");
+Object.keys(_tokenBlacklistService).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _actions[key]) return;
+  if (key in exports && exports[key] === _tokenBlacklistService[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function get() {
-      return _actions[key];
+      return _tokenBlacklistService[key];
     }
   });
 });

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "@nocobase/auth",
-  "version": "0.10.0-alpha.4",
+  "version": "0.10.1-alpha.1",
   "description": "",
   "license": "Apache-2.0",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "dependencies": {
-    "@nocobase/actions": "0.10.0-alpha.4",
-    "@nocobase/database": "0.10.0-alpha.4",
-    "@nocobase/resourcer": "0.10.0-alpha.4",
-    "@nocobase/utils": "0.10.0-alpha.4"
+    "@nocobase/actions": "0.10.1-alpha.1",
+    "@nocobase/database": "0.10.1-alpha.1",
+    "@nocobase/resourcer": "0.10.1-alpha.1",
+    "@nocobase/utils": "0.10.1-alpha.1"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nocobase/nocobase.git",
     "directory": "packages/auth"
   },
-  "gitHead": "62dacadb2a83d30cb36dda9074f2f3a072a37484"
+  "gitHead": "8f415f5e0ee2e72d681f9ab16af5911b52c374a9"
 }