@autional/shared 0.1.0-rc.63 → 0.1.0-rc.65

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@autional/shared",
3
- "version": "0.1.0-rc.63",
3
+ "version": "0.1.0-rc.65",
4
4
  "description": "Autional shared layer — API client, auth, types, hooks, utils",
5
5
  "license": "AGPL-3.0",
6
6
  "main": "./src/index.ts",
@@ -12,6 +12,9 @@
12
12
  "./slug-from-url": "./src/auth/slug-from-url.ts",
13
13
  "./portal": "./src/portal/registry.ts",
14
14
  "./fetch": "./src/api/fetch-client.ts",
15
+ "./jwt": "./src/auth/jwt-payload.ts",
16
+ "./pkce": "./src/auth/pkce.ts",
17
+ "./console-auth": "./src/console-auth/claims.ts",
15
18
  "./generated/api": "./src/generated/api.ts",
16
19
  "./generated/types": "./src/generated/types.ts",
17
20
  "./generated/queries": "./src/generated/queries.ts",
@@ -0,0 +1,44 @@
1
+ import { describe, expect, it } from 'vitest';
2
+ import { decodeJwtPayload } from '@autional/shared/jwt';
3
+ import { generatePKCE } from '@autional/shared/pkce';
4
+
5
+ /**
6
+ * 子路径导出的意义:站点(配置中心/密钥中心)要复用 JWT 解码与 PKCE,
7
+ * 但不该为此引入整包 index(axios/react-query/zustand/生成类型 130 个模块)。
8
+ * 这两个模块都零 import。
9
+ */
10
+ describe('@autional/shared 的 /jwt 与 /pkce 子路径', () => {
11
+ it('/jwt 解 base64url 载荷(含 -/_ 归一)', () => {
12
+ // {"sub":"u1","exp":4102444800,"tenant_id":"t-1"} —— 用 base64url(含 -/_)编码
13
+ const payload = decodeJwtPayload(
14
+ 'eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ1MSIsImV4cCI6NDEwMjQ0NDgwMCwidGVuYW50X2lkIjoidC0xIn0.sig',
15
+ );
16
+ expect(payload).toMatchObject({ sub: 'u1', tenant_id: 't-1' });
17
+ });
18
+
19
+ it('/jwt 对坏输入返回 null(不抛)', () => {
20
+ expect(decodeJwtPayload('not-a-jwt')).toBeNull();
21
+ });
22
+
23
+ it('/pkce 生成 RFC 7636 的 verifier/challenge 对', async () => {
24
+ const pair = await generatePKCE();
25
+ // verifier ∈ 43–128 字符、字符集 A-Za-z0-9-._~
26
+ expect(pair.verifier).toMatch(/^[A-Za-z0-9\-._~]{43,128}$/);
27
+ // S256 challenge = base64url(sha256(verifier)),固定 43 字符
28
+ expect(pair.challenge).toMatch(/^[A-Za-z0-9_-]{43}$/);
29
+
30
+ const another = await generatePKCE();
31
+ expect(another.verifier).not.toBe(pair.verifier);
32
+ });
33
+
34
+ it('两个模块都不引入运行时依赖(源码级断言)', async () => {
35
+ const fs = await import('node:fs/promises');
36
+ for (const rel of ['../jwt-payload.ts', '../pkce.ts']) {
37
+ const src = await fs.readFile(new URL(rel, import.meta.url), 'utf8');
38
+ const imports = src
39
+ .split(/\r?\n/)
40
+ .filter((line) => /^\s*import\s/.test(line) || /^\s*\} from\s+['"]/.test(line));
41
+ expect(imports, rel).toEqual([]);
42
+ }
43
+ });
44
+ });
@@ -0,0 +1,138 @@
1
+ import { describe, expect, it } from 'vitest';
2
+ import {
3
+ expiresAtFromToken,
4
+ pickClaimRoles,
5
+ pickClaimString,
6
+ sessionExpiryAt,
7
+ userFromClaims,
8
+ } from '@autional/shared/console-auth';
9
+
10
+ /**
11
+ * 这层是从配置中心/密钥中心的 `lib/auth.ts` 里**逐字**抽出来的:
12
+ * 两站曾各写一份,任何一边改了回落顺序,顶栏显示就不一致。
13
+ * 测试按「两站原本的行为」锁定,改这里等于改两站。
14
+ */
15
+
16
+ /** 造一个 payload 可解的最小 JWT(不验签,只取声明)。 */
17
+ function jwt(payload: Record<string, unknown>): string {
18
+ const b64 = (obj: unknown) =>
19
+ Buffer.from(JSON.stringify(obj))
20
+ .toString('base64')
21
+ .replace(/\+/g, '-')
22
+ .replace(/\//g, '_')
23
+ .replace(/=+$/, '');
24
+ return `${b64({ alg: 'none' })}.${b64(payload)}.sig`;
25
+ }
26
+
27
+ describe('pickClaimString', () => {
28
+ it('取第一个非空字符串,并去首尾空白', () => {
29
+ expect(pickClaimString({ a: ' x ', b: 'y' }, 'a', 'b')).toBe('x');
30
+ });
31
+
32
+ it('跳过空串/空白/非字符串', () => {
33
+ expect(pickClaimString({ a: '', b: ' ', c: 42, d: 'ok' }, 'a', 'b', 'c', 'd')).toBe('ok');
34
+ });
35
+
36
+ it('全都不命中返回空串', () => {
37
+ expect(pickClaimString({}, 'zzz')).toBe('');
38
+ expect(pickClaimString(null, 'zzz')).toBe('');
39
+ });
40
+ });
41
+
42
+ describe('pickClaimRoles', () => {
43
+ it('数组形式只保留字符串项', () => {
44
+ expect(pickClaimRoles({ roles: ['admin', 1, 'ops'] })).toEqual(['admin', 'ops']);
45
+ });
46
+
47
+ it('字符串形式按逗号/空白拆分', () => {
48
+ expect(pickClaimRoles({ role: 'admin, ops viewer' })).toEqual(['admin', 'ops', 'viewer']);
49
+ });
50
+
51
+ it('认 authorities(不同签发方口径)', () => {
52
+ expect(pickClaimRoles({ authorities: ['ROLE_A'] })).toEqual(['ROLE_A']);
53
+ });
54
+
55
+ it('无角色声明返回空数组', () => {
56
+ expect(pickClaimRoles({})).toEqual([]);
57
+ expect(pickClaimRoles(null)).toEqual([]);
58
+ });
59
+ });
60
+
61
+ describe('userFromClaims', () => {
62
+ it('声明齐全时逐字段映射', () => {
63
+ const user = userFromClaims(
64
+ {
65
+ sub: 'u-1',
66
+ name: '张三',
67
+ email: 'z@example.com',
68
+ tenant_id: 't-9',
69
+ app_id: 'app-3',
70
+ roles: ['admin'],
71
+ },
72
+ '兜底',
73
+ );
74
+ expect(user).toEqual({
75
+ sub: 'u-1',
76
+ name: '张三',
77
+ email: 'z@example.com',
78
+ tenantId: 't-9',
79
+ appId: 'app-3',
80
+ roles: ['admin'],
81
+ });
82
+ });
83
+
84
+ it('展示名回落顺序:name → preferred_username → nickname → email', () => {
85
+ expect(userFromClaims({ sub: 'u', preferred_username: 'pu' }, '兜底').name).toBe('pu');
86
+ expect(userFromClaims({ sub: 'u', nickname: 'nick' }, '兜底').name).toBe('nick');
87
+ expect(userFromClaims({ sub: 'u', email: 'e@x' }, '兜底').name).toBe('e@x');
88
+ });
89
+
90
+ it('无展示名时用 sub 尾 6 位(不能用兜底文案,否则顶栏出现「已 已登录用户」)', () => {
91
+ expect(userFromClaims({ sub: 'abcdefghij' }, '已登录用户').name).toBe('…efghij');
92
+ });
93
+
94
+ it('连 sub 都没有才用调用方兜底', () => {
95
+ expect(userFromClaims({}, '已登录用户').name).toBe('已登录用户');
96
+ });
97
+
98
+ it('租户/应用兼容驼峰与下划线', () => {
99
+ const user = userFromClaims({ sub: 'u', tenantId: 't1', appId: 'a1' }, 'x');
100
+ expect(user.tenantId).toBe('t1');
101
+ expect(user.appId).toBe('a1');
102
+ });
103
+ });
104
+
105
+ describe('expiresAtFromToken', () => {
106
+ it('优先用 JWT exp(秒 → 毫秒)', () => {
107
+ const exp = 1_900_000_000;
108
+ expect(expiresAtFromToken(jwt({ exp }), 60)).toBe(exp * 1000);
109
+ });
110
+
111
+ it('无 exp 时用 expires_in', () => {
112
+ const before = Date.now();
113
+ const at = expiresAtFromToken(jwt({ sub: 'u' }), 120);
114
+ expect(at).toBeGreaterThanOrEqual(before + 120_000 - 50);
115
+ expect(at).toBeLessThanOrEqual(Date.now() + 120_000 + 50);
116
+ });
117
+
118
+ it('两者都缺时用调用方兜底(各站不同:配置中心 5 分钟 / 密钥中心 30 分钟)', () => {
119
+ const before = Date.now();
120
+ const at = expiresAtFromToken('', undefined, 30 * 60_000);
121
+ expect(at).toBeGreaterThanOrEqual(before + 30 * 60_000 - 50);
122
+ });
123
+
124
+ it('坏的 token 不抛错,走兜底', () => {
125
+ expect(() => expiresAtFromToken('not-a-jwt', 10)).not.toThrow();
126
+ });
127
+ });
128
+
129
+ describe('sessionExpiryAt', () => {
130
+ it('令牌带 exp 时以 exp 为准(覆盖旧存储的估算值)', () => {
131
+ const exp = 1_900_000_000;
132
+ expect(sessionExpiryAt(jwt({ exp }), 1)).toBe(exp * 1000);
133
+ });
134
+
135
+ it('令牌无 exp 时回落记录值', () => {
136
+ expect(sessionExpiryAt(jwt({ sub: 'u' }), 12345)).toBe(12345);
137
+ });
138
+ });
@@ -0,0 +1,110 @@
1
+ /**
2
+ * 控制台会话的声明映射(JWT claims → 会话用户 / 过期时刻)。
3
+ *
4
+ * 为什么放在 shared:
5
+ * 配置中心与密钥中心的 `lib/auth.ts` 曾各自维护一份**逐字相同**的实现
6
+ * (`pickString` / `pickRoles` / `userFromClaims` / `expiresAtFromToken`)。
7
+ * 同一决策写两遍必然漂移——本项目已经出现过「一处改了 name 回落、另一处没改」
8
+ * 导致顶栏显示不一致的先例。这里收敛成唯一真源。
9
+ *
10
+ * 边界:本模块**只做纯映射**,不含流程(登录/续期/登出仍在各站,因为两站的
11
+ * 存储位置、吊销策略、瞬时故障处置各不相同,强行合并会把事故修复揉成开关)。
12
+ */
13
+ import { decodeJwtPayload } from '../auth/jwt-payload';
14
+
15
+ /** 控制台会话里的用户形状(各站以此结构扩展或直接引用)。 */
16
+ export interface ConsoleSessionUser {
17
+ /** JWT sub / OIDC subject */
18
+ sub: string;
19
+ /** 展示名(name / preferred_username / nickname / email 依次回落,最后用 sub 尾段或调用方兜底) */
20
+ name: string;
21
+ email: string;
22
+ /** 令牌内租户;空 = 需要站点的 VITE_TENANT_ID 或由后端拒绝 */
23
+ tenantId: string;
24
+ /** 令牌内应用;空 = 平台应用 */
25
+ appId: string;
26
+ roles: string[];
27
+ }
28
+
29
+ /** 取第一个非空字符串声明(去首尾空白)。 */
30
+ export function pickClaimString(source: Record<string, unknown> | null, ...keys: string[]): string {
31
+ if (!source) return '';
32
+ for (const key of keys) {
33
+ const value = source[key];
34
+ if (typeof value === 'string' && value.trim() !== '') return value.trim();
35
+ }
36
+ return '';
37
+ }
38
+
39
+ /**
40
+ * 取角色声明:兼容数组(`roles: ['a','b']`)与字符串(`role: 'a b'` / `'a,b'`)。
41
+ * 三种键名都认(roles / role / authorities),因为不同签发方口径不同。
42
+ */
43
+ export function pickClaimRoles(source: Record<string, unknown> | null): string[] {
44
+ if (!source) return [];
45
+ for (const key of ['roles', 'role', 'authorities']) {
46
+ const value = source[key];
47
+ if (Array.isArray(value)) return value.filter((v): v is string => typeof v === 'string');
48
+ if (typeof value === 'string' && value !== '') return value.split(/[,\s]+/).filter(Boolean);
49
+ }
50
+ return [];
51
+ }
52
+
53
+ /**
54
+ * 从声明构造会话用户。
55
+ *
56
+ * 展示名回落顺序:name → preferred_username → nickname → email → `…<sub 尾 6 位>` → fallbackName。
57
+ * 之所以保留 `…尾段` 而不是直接用兜底文案:兜底文案(如「已登录用户」)会在顶栏
58
+ * 拼成「已 已登录用户」这种既重复又不提供身份的文案。
59
+ */
60
+ export function userFromClaims(
61
+ claims: Record<string, unknown> | null,
62
+ fallbackName: string,
63
+ ): ConsoleSessionUser {
64
+ const sub = pickClaimString(claims, 'sub', 'user_id', 'userId');
65
+ const name =
66
+ pickClaimString(claims, 'name', 'preferred_username', 'nickname', 'email') ||
67
+ (sub ? `…${sub.slice(-6)}` : fallbackName);
68
+ return {
69
+ sub,
70
+ name,
71
+ email: pickClaimString(claims, 'email'),
72
+ tenantId: pickClaimString(claims, 'tenant_id', 'tenantId', 'tenant'),
73
+ appId: pickClaimString(claims, 'app_id', 'appId', 'application_id'),
74
+ roles: pickClaimRoles(claims),
75
+ };
76
+ }
77
+
78
+ /**
79
+ * 过期时刻(epoch ms)。
80
+ *
81
+ * 优先级:access_token 的 `exp`(服务端真实 TTL,权威) → `expires_in` → 兜底值。
82
+ * 用 `exp` 而不是只信 `expires_in`:`expires_in` 是相对秒数,落到本地时钟后
83
+ * 一旦设备时钟偏移就会提前/滞后掉登录。
84
+ *
85
+ * @param fallbackMs `exp` 与 `expires_in` 都缺时的兜底有效期;各站不同(配置中心 5 分钟、密钥中心 30 分钟)。
86
+ */
87
+ export function expiresAtFromToken(
88
+ accessToken: string,
89
+ expiresIn?: number,
90
+ fallbackMs: number = 5 * 60_000,
91
+ ): number {
92
+ const claims = accessToken ? decodeJwtPayload(accessToken) : null;
93
+ const exp = claims && typeof claims.exp === 'number' ? claims.exp : 0;
94
+ if (exp > 0) return exp * 1000;
95
+ const sec = Number(expiresIn);
96
+ if (Number.isFinite(sec) && sec > 0) return Date.now() + sec * 1000;
97
+ return Date.now() + fallbackMs;
98
+ }
99
+
100
+ /**
101
+ * 会话的真实过期时刻:优先 JWT `exp`,回落到会话里记录的 `expiresAt`。
102
+ *
103
+ * 用于兼容「旧存储按 expires_in 估算、与真实 exp 有偏差」的会话,
104
+ * 避免续期判断卡在错误的时间点上。
105
+ */
106
+ export function sessionExpiryAt(accessToken: string, recordedExpiresAt: number): number {
107
+ const claims = accessToken ? decodeJwtPayload(accessToken) : null;
108
+ const exp = claims && typeof claims.exp === 'number' ? claims.exp * 1000 : 0;
109
+ return exp > 0 ? exp : recordedExpiresAt;
110
+ }