@nocobase/auth 2.1.0-beta.9 → 2.2.0-alpha.1

package/lib/actions.js

@@ -38,6 +38,7 @@ const actions = {
   }, "signIn"),
   signOut: /* @__PURE__ */ __name(async (ctx, next) => {
     await ctx.auth.signOut();
+    await ctx.app.emitAsync("auth:signOut", { ctx, auth: ctx.auth });
     await next();
   }, "signOut"),
   signUp: /* @__PURE__ */ __name(async (ctx, next) => {

package/lib/auth-manager.d.ts

@@ -17,6 +17,10 @@ export interface Authenticator {
     options: Record<string, any>;
     [key: string]: any;
 }
+export type BuiltInAuthenticator = Authenticator & {
+    name: string;
+    enabled?: boolean;
+};
 export interface Storer {
     get: (name: string) => Promise<Authenticator>;
 }
@@ -28,6 +32,7 @@ export type AuthManagerOptions = {
 type AuthConfig = {
     auth: AuthExtend<Auth>;
     title?: string;
+    hidden?: boolean;
     getPublicOptions?: (options: Record<string, any>) => Record<string, any>;
 };
 export declare class AuthManager {
@@ -39,8 +44,13 @@ export declare class AuthManager {
     protected options: AuthManagerOptions;
     protected authTypes: Registry<AuthConfig>;
     protected storer: Storer;
+    protected builtInAuthenticators: Map<string, BuiltInAuthenticator>;
     constructor(options: AuthManagerOptions);
     setStorer(storer: Storer): void;
+    registerBuiltInAuthenticator(authenticator: BuiltInAuthenticator): void;
+    unregisterBuiltInAuthenticator(name: string): void;
+    getBuiltInAuthenticator(name: string): BuiltInAuthenticator;
+    private createAuth;
     setTokenBlacklistService(service: ITokenBlacklistService): void;
     setTokenControlService(service: ITokenControlService): void;
     /**

package/lib/auth-manager.js

@@ -55,6 +55,7 @@ const _AuthManager = class _AuthManager {
   authTypes = new import_utils.Registry();
   // authenticators collection manager.
   storer;
+  builtInAuthenticators = /* @__PURE__ */ new Map();
   constructor(options) {
     this.options = options;
     const jwtOptions = options.jwt || {};
@@ -66,6 +67,30 @@ const _AuthManager = class _AuthManager {
   setStorer(storer) {
     this.storer = storer;
   }
+  registerBuiltInAuthenticator(authenticator) {
+    this.builtInAuthenticators.set(authenticator.name, {
+      enabled: true,
+      options: {},
+      ...authenticator
+    });
+  }
+  unregisterBuiltInAuthenticator(name) {
+    this.builtInAuthenticators.delete(name);
+  }
+  getBuiltInAuthenticator(name) {
+    const authenticator = this.builtInAuthenticators.get(name);
+    if (!(authenticator == null ? void 0 : authenticator.enabled)) {
+      return null;
+    }
+    return authenticator;
+  }
+  createAuth(authenticator, ctx) {
+    const { auth } = this.authTypes.get(authenticator.authType) || {};
+    if (!auth) {
+      throw new Error(`AuthType [${authenticator.authType}] is not found.`);
+    }
+    return new auth({ authenticator, options: authenticator.options, ctx });
+  }
   setTokenBlacklistService(service) {
     this.jwt.blacklist = service;
   }
@@ -84,7 +109,7 @@ const _AuthManager = class _AuthManager {
     this.authTypes.register(authType, authConfig);
   }
   listTypes() {
-    return Array.from(this.authTypes.getEntities()).map(([authType, authConfig]) => ({
+    return Array.from(this.authTypes.getEntities()).filter(([, authConfig]) => !authConfig.hidden).map(([authType, authConfig]) => ({
       name: authType,
       title: authConfig.title
     }));
@@ -99,6 +124,10 @@ const _AuthManager = class _AuthManager {
    * @return authenticator instance.
    */
   async get(name, ctx) {
+    const builtInAuthenticator = this.getBuiltInAuthenticator(name);
+    if (builtInAuthenticator) {
+      return this.createAuth(builtInAuthenticator, ctx);
+    }
     if (!this.storer) {
       throw new Error("AuthManager.storer is not set.");
     }
@@ -106,11 +135,7 @@ const _AuthManager = class _AuthManager {
     if (!authenticator) {
       throw new Error(`Authenticator [${name}] is not found.`);
     }
-    const { auth } = this.authTypes.get(authenticator.authType) || {};
-    if (!auth) {
-      throw new Error(`AuthType [${authenticator.authType}] is not found.`);
-    }
-    return new auth({ authenticator, options: authenticator.options, ctx });
+    return this.createAuth(authenticator, ctx);
   }
   /**
    * middleware
@@ -146,7 +171,7 @@ const _AuthManager = class _AuthManager {
     if (process.env.UNSAFE_USE_DEFAULT_JWT_SECRET === "true") {
       return process.env.APP_KEY;
     }
-    const jwtSecretPath = import_path.default.resolve(process.cwd(), "storage", "apps", "main", "jwt_secret.dat");
+    const jwtSecretPath = (0, import_utils.storagePathJoin)("apps", "main", "jwt_secret.dat");
     const jwtSecretExists = import_fs.default.existsSync(jwtSecretPath);
     if (jwtSecretExists) {
       const key2 = import_fs.default.readFileSync(jwtSecretPath);

package/lib/base/auth.js

@@ -87,7 +87,8 @@ const _BaseAuth = class _BaseAuth extends import_auth.Auth {
     if (!token) {
       this.ctx.throw(401, {
         message: this.ctx.t("Unauthenticated. Please sign in to continue.", { ns: localeNamespace }),
-        code: import_auth.AuthErrorCode.EMPTY_TOKEN
+        code: import_auth.AuthErrorCode.EMPTY_TOKEN,
+        logLevel: "trace"
       });
     }
     let tokenStatus;
@@ -153,7 +154,7 @@ const _BaseAuth = class _BaseAuth extends import_auth.Auth {
     if (tokenStatus === "valid" && Date.now() - iat * 1e3 > tokenPolicy.tokenExpirationTime) {
       tokenStatus = "expired";
     }
-    if (tokenStatus === "valid" && user.passwordChangeTz && iat * 1e3 < user.passwordChangeTz) {
+    if (user.passwordChangeTz && iat * 1e3 < user.passwordChangeTz) {
       this.ctx.throw(401, {
         message: this.ctx.t("User password changed, please signin again.", { ns: localeNamespace }),
         code: import_auth.AuthErrorCode.INVALID_TOKEN
@@ -241,7 +242,8 @@ const _BaseAuth = class _BaseAuth extends import_auth.Auth {
     return null;
   }
   async signNewToken(userId) {
-    const tokenInfo = await this.tokenController.add({ userId });
+    var _a;
+    const tokenInfo = await this.tokenController.add({ userId, authenticator: (_a = this.authenticator) == null ? void 0 : _a.name });
     const expiresIn = Math.floor((await this.tokenController.getConfig()).tokenExpirationTime / 1e3);
     const token = this.jwt.sign(
       {

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

@@ -20,6 +20,7 @@ export declare class JwtService {
     blacklist: ITokenBlacklistService;
     private expiresIn;
     private secret;
+    getSecret(): string | Buffer;
     sign(payload: SignPayload, options?: SignOptions): string;
     decode(token: string): Promise<JwtPayload>;
     /**

package/lib/base/jwt-service.js

@@ -57,6 +57,9 @@ const _JwtService = class _JwtService {
   secret() {
     return this.options.secret;
   }
+  getSecret() {
+    return this.secret();
+  }
   /* istanbul ignore next -- @preserve */
   sign(payload, options) {
     const opt = { expiresIn: this.expiresIn(), ...options };

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

@@ -18,6 +18,7 @@ export type NumericTokenPolicyConfig = {
 export type TokenInfo = {
     jti: string;
     userId: number;
+    authenticator?: string;
     issuedTime: EpochTimeStamp;
     signInTime: EpochTimeStamp;
     renewed: boolean;
@@ -30,8 +31,9 @@ export interface ITokenControlService {
         jti: string;
         issuedTime: EpochTimeStamp;
     }>;
-    add({ userId }: {
+    add({ userId, authenticator }: {
         userId: number;
+        authenticator?: string;
     }): Promise<TokenInfo>;
     removeSessionExpiredTokens(userId: number): Promise<any>;
 }

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@nocobase/auth",
-  "version": "2.1.0-beta.9",
+  "version": "2.2.0-alpha.1",
   "description": "",
   "license": "Apache-2.0",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "dependencies": {
-    "@nocobase/actions": "2.1.0-beta.9",
-    "@nocobase/cache": "2.1.0-beta.9",
-    "@nocobase/database": "2.1.0-beta.9",
-    "@nocobase/resourcer": "2.1.0-beta.9",
-    "@nocobase/utils": "2.1.0-beta.9",
+    "@nocobase/actions": "2.2.0-alpha.1",
+    "@nocobase/cache": "2.2.0-alpha.1",
+    "@nocobase/database": "2.2.0-alpha.1",
+    "@nocobase/resourcer": "2.2.0-alpha.1",
+    "@nocobase/utils": "2.2.0-alpha.1",
     "@types/jsonwebtoken": "^9.0.9",
     "jsonwebtoken": "^9.0.2"
   },
@@ -19,5 +19,5 @@
     "url": "git+https://github.com/nocobase/nocobase.git",
     "directory": "packages/auth"
   },
-  "gitHead": "c3a2875e4cbbb43b1f2361e6f9f5f84a7d3f3c3c"
+  "gitHead": "303663aba6c6eefa27e6a6435b4c0352074ec40f"
 }