@aomex/auth 3.27.4 → 3.28.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -0
- package/dist/index.d.ts +30 -13
- package/dist/index.js +65 -7
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,17 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# [3.28.0](https://github.com/aomex/aomex/compare/v3.27.4...v3.28.0) (2025-07-08)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Features
|
|
10
|
+
|
|
11
|
+
* **auth:** 增加权限认证 ([bb8d7ff](https://github.com/aomex/aomex/commit/bb8d7ff105126cb9c4e5171142ee07f6d56a8000))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
6
17
|
## [3.27.4](https://github.com/aomex/aomex/compare/v3.27.3...v3.27.4) (2025-06-29)
|
|
7
18
|
|
|
8
19
|
**Note:** Version bump only for package @aomex/auth
|
package/dist/index.d.ts
CHANGED
|
@@ -1,32 +1,49 @@
|
|
|
1
1
|
import { WebContext, OpenApiInjector, WebMiddleware } from '@aomex/web';
|
|
2
2
|
|
|
3
|
-
declare
|
|
4
|
-
|
|
3
|
+
declare class AuthError extends Error {
|
|
4
|
+
}
|
|
5
|
+
|
|
6
|
+
declare abstract class Strategy<Payload extends object | string | number, AuthorizeArgs extends any[] = any[]> {
|
|
7
|
+
protected abstract authenticate(ctx: WebContext): Payload | false | AuthError | Promise<Payload | false | AuthError>;
|
|
8
|
+
protected abstract authorize(payload: Payload, ...args: AuthorizeArgs): boolean | AuthError | Promise<boolean | AuthError>;
|
|
5
9
|
protected openapi(): OpenApiInjector;
|
|
6
10
|
}
|
|
7
11
|
|
|
8
|
-
declare namespace
|
|
12
|
+
declare namespace Auth {
|
|
9
13
|
interface Options<S extends {
|
|
10
|
-
[K: string]: Strategy<object | string>;
|
|
14
|
+
[K: string]: Strategy<object | string | number, any[]>;
|
|
11
15
|
}> {
|
|
12
16
|
strategies: S;
|
|
13
17
|
}
|
|
18
|
+
type DetermineAuthorizeArgs<S extends {
|
|
19
|
+
[K: string]: Strategy<object | string | number, any[]>;
|
|
20
|
+
}, StrategyName extends keyof S> = S[StrategyName] extends Strategy<any, infer Args> ? any[] extends Args ? [] : Args : never;
|
|
21
|
+
type DetermineMiddlewareProps<S extends {
|
|
22
|
+
[K: string]: Strategy<object | string | number, any[]>;
|
|
23
|
+
}, StrategyName extends keyof S> = {
|
|
24
|
+
readonly [K in StrategyName]: S[StrategyName] extends Strategy<infer P, any> ? P : never;
|
|
25
|
+
};
|
|
14
26
|
}
|
|
15
|
-
declare class
|
|
16
|
-
[K: string]: Strategy<object | string>;
|
|
27
|
+
declare class Auth<S extends {
|
|
28
|
+
[K: string]: Strategy<object | string | number, any[]>;
|
|
17
29
|
}> {
|
|
18
|
-
protected readonly options:
|
|
19
|
-
constructor(options:
|
|
30
|
+
protected readonly options: Auth.Options<S>;
|
|
31
|
+
constructor(options: Auth.Options<S>);
|
|
20
32
|
/**
|
|
21
33
|
* 获取策略实例
|
|
22
34
|
*/
|
|
23
35
|
strategy<StrategyName extends keyof S>(name: StrategyName): S[StrategyName];
|
|
24
36
|
/**
|
|
25
|
-
*
|
|
37
|
+
* 在已经身份认证(authenticate)的基础上进行访问权限认证,不满足时响应`403`状态码
|
|
38
|
+
*/
|
|
39
|
+
authorize<StrategyName extends keyof S>(name: StrategyName, ...args: Auth.DetermineAuthorizeArgs<S, StrategyName>): WebMiddleware<object>;
|
|
40
|
+
/**
|
|
41
|
+
* 对访问凭证(token,cookie,session等)进行身份确认,不满足时响应`401`状态码
|
|
26
42
|
*/
|
|
27
|
-
authenticate<StrategyName extends keyof S>(name: StrategyName): WebMiddleware<{
|
|
28
|
-
|
|
29
|
-
}
|
|
43
|
+
authenticate<StrategyName extends keyof S>(name: StrategyName): WebMiddleware<Auth.DetermineMiddlewareProps<S, StrategyName>> & {
|
|
44
|
+
authorize: (...args: Auth.DetermineAuthorizeArgs<S, StrategyName>) => WebMiddleware<Auth.DetermineMiddlewareProps<S, StrategyName>>;
|
|
45
|
+
};
|
|
46
|
+
protected internalAuthorize(ctx: WebContext, strategy: Strategy<any>, payload: any, authorizeArgs: any[]): Promise<undefined>;
|
|
30
47
|
}
|
|
31
48
|
|
|
32
|
-
export {
|
|
49
|
+
export { Auth, AuthError, Strategy };
|
package/dist/index.js
CHANGED
|
@@ -12,9 +12,15 @@ var Strategy = class {
|
|
|
12
12
|
}
|
|
13
13
|
};
|
|
14
14
|
|
|
15
|
-
// src/
|
|
15
|
+
// src/auth.ts
|
|
16
16
|
import { middleware } from "@aomex/common";
|
|
17
|
-
|
|
17
|
+
|
|
18
|
+
// src/auth-error.ts
|
|
19
|
+
var AuthError = class extends Error {
|
|
20
|
+
};
|
|
21
|
+
|
|
22
|
+
// src/auth.ts
|
|
23
|
+
var Auth = class {
|
|
18
24
|
constructor(options) {
|
|
19
25
|
this.options = options;
|
|
20
26
|
}
|
|
@@ -25,19 +31,46 @@ var Authentication = class {
|
|
|
25
31
|
return this.options.strategies[name];
|
|
26
32
|
}
|
|
27
33
|
/**
|
|
28
|
-
*
|
|
34
|
+
* 在已经身份认证(authenticate)的基础上进行访问权限认证,不满足时响应`403`状态码
|
|
29
35
|
*/
|
|
30
|
-
|
|
36
|
+
authorize(name, ...args) {
|
|
31
37
|
const strategy = this.strategy(name);
|
|
32
38
|
return middleware.web({
|
|
39
|
+
fn: async (ctx, next) => {
|
|
40
|
+
const payload = ctx[name];
|
|
41
|
+
await this.internalAuthorize(ctx, strategy, payload, args);
|
|
42
|
+
return next();
|
|
43
|
+
}
|
|
44
|
+
});
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* 对访问凭证(token,cookie,session等)进行身份确认,不满足时响应`401`状态码
|
|
48
|
+
*/
|
|
49
|
+
authenticate(name) {
|
|
50
|
+
const strategy = this.strategy(name);
|
|
51
|
+
let withAuthorize = false;
|
|
52
|
+
const authorizeArgs = [];
|
|
53
|
+
const md = middleware.web({
|
|
33
54
|
fn: async (ctx, next) => {
|
|
34
55
|
let payload = false;
|
|
35
56
|
try {
|
|
36
57
|
payload = await strategy["authenticate"](ctx);
|
|
37
58
|
} catch (e) {
|
|
38
|
-
|
|
59
|
+
if (e instanceof AuthError) {
|
|
60
|
+
return ctx.throw(401, e);
|
|
61
|
+
} else {
|
|
62
|
+
throw e;
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
if (payload instanceof AuthError) {
|
|
66
|
+
return ctx.throw(401, payload.message);
|
|
67
|
+
}
|
|
68
|
+
if (payload === false) {
|
|
69
|
+
return ctx.throw(401);
|
|
70
|
+
}
|
|
71
|
+
if (withAuthorize) {
|
|
72
|
+
await this.internalAuthorize(ctx, strategy, payload, authorizeArgs);
|
|
39
73
|
}
|
|
40
|
-
if (payload === false) return ctx.throw(401);
|
|
41
74
|
Object.defineProperty(ctx, name, {
|
|
42
75
|
get: () => payload
|
|
43
76
|
});
|
|
@@ -45,10 +78,35 @@ var Authentication = class {
|
|
|
45
78
|
},
|
|
46
79
|
openapi: strategy["openapi"]()
|
|
47
80
|
});
|
|
81
|
+
md.authorize = (...args) => {
|
|
82
|
+
withAuthorize = true;
|
|
83
|
+
authorizeArgs.push(...args);
|
|
84
|
+
return md;
|
|
85
|
+
};
|
|
86
|
+
return md;
|
|
87
|
+
}
|
|
88
|
+
async internalAuthorize(ctx, strategy, payload, authorizeArgs) {
|
|
89
|
+
let authorized = false;
|
|
90
|
+
try {
|
|
91
|
+
authorized = await strategy["authorize"](payload, ...authorizeArgs);
|
|
92
|
+
} catch (e) {
|
|
93
|
+
if (e instanceof AuthError) {
|
|
94
|
+
return ctx.throw(403, e);
|
|
95
|
+
} else {
|
|
96
|
+
throw e;
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
if (authorized instanceof AuthError) {
|
|
100
|
+
return ctx.throw(403, authorized.message);
|
|
101
|
+
}
|
|
102
|
+
if (!authorized) {
|
|
103
|
+
return ctx.throw(403);
|
|
104
|
+
}
|
|
48
105
|
}
|
|
49
106
|
};
|
|
50
107
|
export {
|
|
51
|
-
|
|
108
|
+
Auth,
|
|
109
|
+
AuthError,
|
|
52
110
|
Strategy
|
|
53
111
|
};
|
|
54
112
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/strategy.ts","../src/
|
|
1
|
+
{"version":3,"sources":["../src/strategy.ts","../src/auth.ts","../src/auth-error.ts"],"sourcesContent":["import { statuses, type OpenApiInjector, type WebContext } from '@aomex/web';\nimport type { AuthError } from './auth-error';\n\nexport abstract class Strategy<\n Payload extends object | string | number,\n AuthorizeArgs extends any[] = any[],\n> {\n protected abstract authenticate(\n ctx: WebContext,\n ): Payload | false | AuthError | Promise<Payload | false | AuthError>;\n\n protected abstract authorize(\n payload: Payload,\n ...args: AuthorizeArgs\n ): boolean | AuthError | Promise<boolean | AuthError>;\n\n protected openapi(): OpenApiInjector {\n return {\n postMethod(methodItem) {\n methodItem.responses[401] ||= {\n description: statuses.message[401]!,\n };\n },\n };\n }\n}\n","import type { WebContext, WebMiddleware } from '@aomex/web';\nimport { Strategy } from './strategy';\nimport { middleware } from '@aomex/common';\nimport { AuthError } from './auth-error';\n\nexport namespace Auth {\n export interface Options<\n S extends { [K: string]: Strategy<object | string | number, any[]> },\n > {\n strategies: S;\n }\n\n export type DetermineAuthorizeArgs<\n S extends { [K: string]: Strategy<object | string | number, any[]> },\n StrategyName extends keyof S,\n > =\n S[StrategyName] extends Strategy<any, infer Args>\n ? any[] extends Args\n ? []\n : Args\n : never;\n\n export type DetermineMiddlewareProps<\n S extends { [K: string]: Strategy<object | string | number, any[]> },\n StrategyName extends keyof S,\n > = {\n readonly [K in StrategyName]: S[StrategyName] extends Strategy<infer P, any>\n ? P\n : never;\n };\n}\n\nexport class Auth<S extends { [K: string]: Strategy<object | string | number, any[]> }> {\n constructor(protected readonly options: Auth.Options<S>) {}\n\n /**\n * 获取策略实例\n */\n public strategy<StrategyName extends keyof S>(name: StrategyName) {\n return this.options.strategies[name]! as S[StrategyName];\n }\n\n /**\n * 在已经身份认证(authenticate)的基础上进行访问权限认证,不满足时响应`403`状态码\n */\n public authorize<StrategyName extends keyof S>(\n name: StrategyName,\n ...args: Auth.DetermineAuthorizeArgs<S, StrategyName>\n ): WebMiddleware<object /* 身份认证时已经给过类型,仅授权不需要返回类型 */> {\n const strategy = this.strategy(name);\n\n return middleware.web<Auth.DetermineMiddlewareProps<S, StrategyName>>({\n fn: async (ctx, next) => {\n const payload = ctx[name];\n await this.internalAuthorize(ctx, strategy, payload, args);\n return next();\n },\n });\n }\n\n /**\n * 对访问凭证(token,cookie,session等)进行身份确认,不满足时响应`401`状态码\n */\n public authenticate<StrategyName extends keyof S>(\n name: StrategyName,\n ): WebMiddleware<Auth.DetermineMiddlewareProps<S, StrategyName>> & {\n authorize: (\n ...args: Auth.DetermineAuthorizeArgs<S, StrategyName>\n ) => WebMiddleware<Auth.DetermineMiddlewareProps<S, StrategyName>>;\n } {\n const strategy = this.strategy(name);\n let withAuthorize = false;\n const authorizeArgs: any[] = [];\n\n const md = middleware.web({\n fn: async (ctx, next) => {\n let payload: string | number | false | object | AuthError = false;\n try {\n payload = await strategy['authenticate'](ctx);\n } catch (e) {\n if (e instanceof AuthError) {\n return ctx.throw(401, e);\n } else {\n throw e;\n }\n }\n if (payload instanceof AuthError) {\n return ctx.throw(401, payload.message);\n }\n if (payload === false) {\n return ctx.throw(401);\n }\n if (withAuthorize) {\n await this.internalAuthorize(ctx, strategy, payload, authorizeArgs);\n }\n Object.defineProperty(ctx, name, {\n get: () => payload,\n });\n return next();\n },\n openapi: strategy['openapi'](),\n });\n\n // @ts-expect-error\n md.authorize = (...args: any[]) => {\n withAuthorize = true;\n authorizeArgs.push(...args);\n return md;\n };\n\n // @ts-expect-error\n return md;\n }\n\n protected async internalAuthorize(\n ctx: WebContext,\n strategy: Strategy<any>,\n payload: any,\n authorizeArgs: any[],\n ) {\n let authorized: AuthError | boolean = false;\n try {\n authorized = await strategy['authorize'](payload, ...authorizeArgs);\n } catch (e) {\n if (e instanceof AuthError) {\n return ctx.throw(403, e);\n } else {\n throw e;\n }\n }\n if (authorized instanceof AuthError) {\n return ctx.throw(403, authorized.message);\n }\n if (!authorized) {\n return ctx.throw(403);\n }\n }\n}\n","export class AuthError extends Error {}\n"],"mappings":";AAAA,SAAS,gBAAuD;AAGzD,IAAe,WAAf,MAGL;AAAA,EAUU,UAA2B;AACnC,WAAO;AAAA,MACL,WAAW,YAAY;AACrB,mBAAW,UAAU,GAAG,MAAM;AAAA,UAC5B,aAAa,SAAS,QAAQ,GAAG;AAAA,QACnC;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;;;ACvBA,SAAS,kBAAkB;;;ACFpB,IAAM,YAAN,cAAwB,MAAM;AAAC;;;ADgC/B,IAAM,OAAN,MAAiF;AAAA,EACtF,YAA+B,SAA0B;AAA1B;AAAA,EAA2B;AAAA;AAAA;AAAA;AAAA,EAKnD,SAAuC,MAAoB;AAChE,WAAO,KAAK,QAAQ,WAAW,IAAI;AAAA,EACrC;AAAA;AAAA;AAAA;AAAA,EAKO,UACL,SACG,MACiD;AACpD,UAAM,WAAW,KAAK,SAAS,IAAI;AAEnC,WAAO,WAAW,IAAoD;AAAA,MACpE,IAAI,OAAO,KAAK,SAAS;AACvB,cAAM,UAAU,IAAI,IAAI;AACxB,cAAM,KAAK,kBAAkB,KAAK,UAAU,SAAS,IAAI;AACzD,eAAO,KAAK;AAAA,MACd;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA,EAKO,aACL,MAKA;AACA,UAAM,WAAW,KAAK,SAAS,IAAI;AACnC,QAAI,gBAAgB;AACpB,UAAM,gBAAuB,CAAC;AAE9B,UAAM,KAAK,WAAW,IAAI;AAAA,MACxB,IAAI,OAAO,KAAK,SAAS;AACvB,YAAI,UAAwD;AAC5D,YAAI;AACF,oBAAU,MAAM,SAAS,cAAc,EAAE,GAAG;AAAA,QAC9C,SAAS,GAAG;AACV,cAAI,aAAa,WAAW;AAC1B,mBAAO,IAAI,MAAM,KAAK,CAAC;AAAA,UACzB,OAAO;AACL,kBAAM;AAAA,UACR;AAAA,QACF;AACA,YAAI,mBAAmB,WAAW;AAChC,iBAAO,IAAI,MAAM,KAAK,QAAQ,OAAO;AAAA,QACvC;AACA,YAAI,YAAY,OAAO;AACrB,iBAAO,IAAI,MAAM,GAAG;AAAA,QACtB;AACA,YAAI,eAAe;AACjB,gBAAM,KAAK,kBAAkB,KAAK,UAAU,SAAS,aAAa;AAAA,QACpE;AACA,eAAO,eAAe,KAAK,MAAM;AAAA,UAC/B,KAAK,MAAM;AAAA,QACb,CAAC;AACD,eAAO,KAAK;AAAA,MACd;AAAA,MACA,SAAS,SAAS,SAAS,EAAE;AAAA,IAC/B,CAAC;AAGD,OAAG,YAAY,IAAI,SAAgB;AACjC,sBAAgB;AAChB,oBAAc,KAAK,GAAG,IAAI;AAC1B,aAAO;AAAA,IACT;AAGA,WAAO;AAAA,EACT;AAAA,EAEA,MAAgB,kBACd,KACA,UACA,SACA,eACA;AACA,QAAI,aAAkC;AACtC,QAAI;AACF,mBAAa,MAAM,SAAS,WAAW,EAAE,SAAS,GAAG,aAAa;AAAA,IACpE,SAAS,GAAG;AACV,UAAI,aAAa,WAAW;AAC1B,eAAO,IAAI,MAAM,KAAK,CAAC;AAAA,MACzB,OAAO;AACL,cAAM;AAAA,MACR;AAAA,IACF;AACA,QAAI,sBAAsB,WAAW;AACnC,aAAO,IAAI,MAAM,KAAK,WAAW,OAAO;AAAA,IAC1C;AACA,QAAI,CAAC,YAAY;AACf,aAAO,IAAI,MAAM,GAAG;AAAA,IACtB;AAAA,EACF;AACF;","names":[]}
|