@svadmin/sso 0.8.8 → 0.10.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/package.json +2 -2
- package/src/auth-helpers.ts +114 -0
- package/src/auth-provider.ts +78 -24
- package/src/index.ts +13 -1
- package/src/presets.ts +25 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@svadmin/sso",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.10.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "OIDC/OAuth2 SSO AuthProvider plugin for svadmin — supports Okta, Azure AD, Cognito, Keycloak, Google",
|
|
6
6
|
"license": "MIT",
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"!src/**/setupTest.*"
|
|
36
36
|
],
|
|
37
37
|
"peerDependencies": {
|
|
38
|
-
"@svadmin/core": "^0.
|
|
38
|
+
"@svadmin/core": "^0.26.0"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
41
|
"typescript": "^5.7.0"
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 浏览器端 OIDC/OAuth2 认证辅助函数。
|
|
3
|
+
*
|
|
4
|
+
* 提供 PKCE 生成、OIDC Discovery 端点解析、重定向校验、
|
|
5
|
+
* 反向代理 origin 恢复等通用工具。
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
/** 将 Uint8Array 编码为 base64url 格式 (纯 Web API) */
|
|
9
|
+
function base64url(array: Uint8Array): string {
|
|
10
|
+
let binary = "";
|
|
11
|
+
for (const byte of array) binary += String.fromCharCode(byte);
|
|
12
|
+
return btoa(binary).replace(/\+/g, "-").replace(/\//g, "_").replace(/=+$/, "");
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
/** 生成随机的 OAuth state 值 */
|
|
16
|
+
export function generateState(): string {
|
|
17
|
+
const array = new Uint8Array(16);
|
|
18
|
+
crypto.getRandomValues(array);
|
|
19
|
+
return base64url(array);
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
/** 生成 PKCE code verifier */
|
|
23
|
+
export function generateVerifier(): string {
|
|
24
|
+
const array = new Uint8Array(32);
|
|
25
|
+
crypto.getRandomValues(array);
|
|
26
|
+
return base64url(array);
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
/** 基于 code verifier 算得 code challenge (S256) */
|
|
30
|
+
export async function generateChallenge(verifier: string): Promise<string> {
|
|
31
|
+
const encoder = new TextEncoder();
|
|
32
|
+
const data = encoder.encode(verifier);
|
|
33
|
+
const hash = await crypto.subtle.digest("SHA-256", data);
|
|
34
|
+
return base64url(new Uint8Array(hash));
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* 校验 returnTo 重定向地址,防止开放重定向漏洞。
|
|
39
|
+
* 只允许同源相对路径(必须以 / 开头且非 // 开头)。
|
|
40
|
+
*/
|
|
41
|
+
export function isValidReturnTo(url: string): boolean {
|
|
42
|
+
if (!url) return false;
|
|
43
|
+
if (url.includes("\\")) return false;
|
|
44
|
+
return /^\/[^/].*/.test(url) || url === "/";
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/** 从反向代理头恢复公网 origin */
|
|
48
|
+
export function getForwardedOrigin(req: Request, fallbackUrl: URL): string {
|
|
49
|
+
const forwardedProto = req.headers.get("x-forwarded-proto")?.split(",")[0]?.trim();
|
|
50
|
+
const forwardedHost = req.headers.get("x-forwarded-host")?.split(",")[0]?.trim();
|
|
51
|
+
const host = forwardedHost || req.headers.get("host") || fallbackUrl.host;
|
|
52
|
+
const protocol = (forwardedProto || fallbackUrl.protocol.replace(/:$/, "")).replace(/:$/, "");
|
|
53
|
+
return `${protocol}://${host}`;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
interface OidcDiscoveryDocument {
|
|
57
|
+
authorization_endpoint?: string;
|
|
58
|
+
token_endpoint?: string;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/** 通过 OIDC Discovery 解析授权端点 URL */
|
|
62
|
+
export async function resolveAuthorizeUrl(
|
|
63
|
+
issuer: string,
|
|
64
|
+
overrideUrl = "",
|
|
65
|
+
fetcher: typeof fetch = fetch,
|
|
66
|
+
): Promise<string> {
|
|
67
|
+
const normalizedIssuer = issuer.replace(/\/$/, "");
|
|
68
|
+
const normalizedOverride = overrideUrl.trim();
|
|
69
|
+
|
|
70
|
+
if (normalizedOverride) return normalizedOverride;
|
|
71
|
+
|
|
72
|
+
if (normalizedIssuer) {
|
|
73
|
+
try {
|
|
74
|
+
const response = await fetcher(`${normalizedIssuer}/.well-known/openid-configuration`);
|
|
75
|
+
if (response.ok) {
|
|
76
|
+
const discovery = await response.json() as OidcDiscoveryDocument;
|
|
77
|
+
if (discovery.authorization_endpoint) return discovery.authorization_endpoint;
|
|
78
|
+
}
|
|
79
|
+
} catch {
|
|
80
|
+
// 忽略 discovery 失败,走 fallback
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
if (normalizedIssuer) return `${normalizedIssuer}/oauth/authorize`;
|
|
85
|
+
|
|
86
|
+
return "";
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
/** 通过 OIDC Discovery 解析 token 端点 URL */
|
|
90
|
+
export async function resolveTokenUrl(
|
|
91
|
+
issuer: string,
|
|
92
|
+
overrideUrlOrFetcher: string | typeof fetch = "",
|
|
93
|
+
fetcherOverride: typeof fetch = fetch,
|
|
94
|
+
): Promise<string> {
|
|
95
|
+
const normalizedIssuer = issuer.replace(/\/$/, "");
|
|
96
|
+
const fetcher = typeof overrideUrlOrFetcher === "function" ? overrideUrlOrFetcher : fetcherOverride;
|
|
97
|
+
const overrideUrl = typeof overrideUrlOrFetcher === "string" ? overrideUrlOrFetcher : "";
|
|
98
|
+
const normalizedOverride = overrideUrl.trim();
|
|
99
|
+
|
|
100
|
+
if (normalizedOverride) return normalizedOverride;
|
|
101
|
+
if (!normalizedIssuer) return "";
|
|
102
|
+
|
|
103
|
+
try {
|
|
104
|
+
const response = await fetcher(`${normalizedIssuer}/.well-known/openid-configuration`);
|
|
105
|
+
if (response.ok) {
|
|
106
|
+
const discovery = await response.json() as OidcDiscoveryDocument;
|
|
107
|
+
if (discovery.token_endpoint) return discovery.token_endpoint;
|
|
108
|
+
}
|
|
109
|
+
} catch {
|
|
110
|
+
// 忽略 discovery 失败
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
return `${normalizedIssuer}/oauth/token`;
|
|
114
|
+
}
|
package/src/auth-provider.ts
CHANGED
|
@@ -32,14 +32,14 @@
|
|
|
32
32
|
import type { AuthProvider, Identity } from '@svadmin/core';
|
|
33
33
|
|
|
34
34
|
// Safe base64url decode for JWT payloads
|
|
35
|
-
function decodeJwtPayload(token: string):
|
|
35
|
+
function decodeJwtPayload(token: string): Record<string, unknown> | null {
|
|
36
36
|
if (!token) return null;
|
|
37
37
|
const parts = token.split('.');
|
|
38
38
|
if (parts.length < 2) return null;
|
|
39
39
|
const payloadStr = parts[1];
|
|
40
40
|
const padded = payloadStr + '='.repeat((4 - (payloadStr.length % 4)) % 4);
|
|
41
41
|
const binString = atob(padded.replace(/-/g, '+').replace(/_/g, '/'));
|
|
42
|
-
const bytes = Uint8Array.from(binString, (m) => m.codePointAt(0)
|
|
42
|
+
const bytes = Uint8Array.from(binString, (m) => m.codePointAt(0) ?? 0);
|
|
43
43
|
return JSON.parse(new TextDecoder().decode(bytes));
|
|
44
44
|
}
|
|
45
45
|
|
|
@@ -65,6 +65,8 @@ export interface SSOConfig {
|
|
|
65
65
|
autoRefresh?: boolean;
|
|
66
66
|
/** Seconds before expiry to trigger refresh. Default: 60 */
|
|
67
67
|
refreshBuffer?: number;
|
|
68
|
+
/** Additional authorization request parameters, e.g. audience or prompt. */
|
|
69
|
+
authorizationParams?: Record<string, string>;
|
|
68
70
|
/**
|
|
69
71
|
* Manual OAuth2 endpoints for providers that don't support OIDC discovery
|
|
70
72
|
* (e.g., GitHub). When provided, OIDC auto-discovery is skipped.
|
|
@@ -83,6 +85,10 @@ export interface TokenStorage {
|
|
|
83
85
|
removeItem: (key: string) => void;
|
|
84
86
|
}
|
|
85
87
|
|
|
88
|
+
export interface SSOAuthProvider extends AuthProvider {
|
|
89
|
+
getAccessToken: () => Promise<string | null>;
|
|
90
|
+
}
|
|
91
|
+
|
|
86
92
|
interface OIDCConfig {
|
|
87
93
|
authorization_endpoint: string;
|
|
88
94
|
token_endpoint: string;
|
|
@@ -143,7 +149,7 @@ function getStorage(config: SSOConfig): TokenStorage {
|
|
|
143
149
|
/**
|
|
144
150
|
* Create an OIDC/OAuth2 SSO AuthProvider.
|
|
145
151
|
*/
|
|
146
|
-
export function createSSOAuthProvider(config: SSOConfig):
|
|
152
|
+
export function createSSOAuthProvider(config: SSOConfig): SSOAuthProvider {
|
|
147
153
|
const scopes = config.scopes ?? ['openid', 'profile', 'email'];
|
|
148
154
|
const autoRefresh = config.autoRefresh ?? true;
|
|
149
155
|
const refreshBuffer = config.refreshBuffer ?? 60;
|
|
@@ -198,7 +204,8 @@ export function createSSOAuthProvider(config: SSOConfig): AuthProvider {
|
|
|
198
204
|
if (!tokens.expires_at || !tokens.refresh_token) return;
|
|
199
205
|
const now = Math.floor(Date.now() / 1000);
|
|
200
206
|
const delay = Math.max(0, (tokens.expires_at - now - refreshBuffer)) * 1000;
|
|
201
|
-
|
|
207
|
+
const refreshToken = tokens.refresh_token;
|
|
208
|
+
refreshTimer = setTimeout(() => refreshAccessToken(refreshToken), delay);
|
|
202
209
|
}
|
|
203
210
|
|
|
204
211
|
async function refreshAccessToken(refreshToken: string): Promise<void> {
|
|
@@ -216,6 +223,10 @@ export function createSSOAuthProvider(config: SSOConfig): AuthProvider {
|
|
|
216
223
|
});
|
|
217
224
|
if (!res.ok) { clearTokens(); return; }
|
|
218
225
|
const data = await res.json();
|
|
226
|
+
if (!data.access_token) {
|
|
227
|
+
clearTokens();
|
|
228
|
+
return;
|
|
229
|
+
}
|
|
219
230
|
const newTokens: TokenSet = {
|
|
220
231
|
access_token: data.access_token,
|
|
221
232
|
id_token: data.id_token,
|
|
@@ -248,6 +259,7 @@ export function createSSOAuthProvider(config: SSOConfig): AuthProvider {
|
|
|
248
259
|
});
|
|
249
260
|
if (!res.ok) throw new Error(`Token exchange failed: ${res.status}`);
|
|
250
261
|
const data = await res.json();
|
|
262
|
+
if (!data.access_token) throw new Error('Token exchange failed: missing access_token');
|
|
251
263
|
const tokens: TokenSet = {
|
|
252
264
|
access_token: data.access_token,
|
|
253
265
|
id_token: data.id_token,
|
|
@@ -281,28 +293,33 @@ export function createSSOAuthProvider(config: SSOConfig): AuthProvider {
|
|
|
281
293
|
if (typeof window === 'undefined') {
|
|
282
294
|
return { success: false, error: { message: 'SSO login requires a browser environment' } };
|
|
283
295
|
}
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
296
|
+
try {
|
|
297
|
+
const cfg = await discover();
|
|
298
|
+
const { verifier, challenge } = await createPKCEChallenge();
|
|
299
|
+
const state = generateRandomString(32);
|
|
287
300
|
|
|
288
|
-
|
|
289
|
-
|
|
301
|
+
storage.setItem(`${STORAGE_PREFIX}pkce_verifier`, verifier);
|
|
302
|
+
storage.setItem(`${STORAGE_PREFIX}state`, state);
|
|
290
303
|
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
304
|
+
const params = new URLSearchParams({
|
|
305
|
+
response_type: 'code',
|
|
306
|
+
client_id: config.clientId,
|
|
307
|
+
redirect_uri: config.redirectUri,
|
|
308
|
+
scope: scopes.join(' '),
|
|
309
|
+
state,
|
|
310
|
+
code_challenge: challenge,
|
|
311
|
+
code_challenge_method: 'S256',
|
|
312
|
+
...config.authorizationParams,
|
|
313
|
+
});
|
|
300
314
|
|
|
301
|
-
|
|
302
|
-
|
|
315
|
+
// Redirect to authorization endpoint
|
|
316
|
+
window.location.href = `${cfg.authorization_endpoint}?${params}`;
|
|
303
317
|
|
|
304
|
-
|
|
305
|
-
|
|
318
|
+
// Won't actually reach here due to redirect
|
|
319
|
+
return { success: true };
|
|
320
|
+
} catch (err) {
|
|
321
|
+
return { success: false, error: { message: err instanceof Error ? err.message : 'SSO login failed' } };
|
|
322
|
+
}
|
|
306
323
|
},
|
|
307
324
|
|
|
308
325
|
async logout() {
|
|
@@ -339,12 +356,26 @@ export function createSSOAuthProvider(config: SSOConfig): AuthProvider {
|
|
|
339
356
|
|
|
340
357
|
// Handle callback — exchange authorization code for tokens
|
|
341
358
|
const url = new URL(window.location.href);
|
|
359
|
+
const callbackError = url.searchParams.get('error');
|
|
360
|
+
if (callbackError) {
|
|
361
|
+
clearTokens();
|
|
362
|
+
return {
|
|
363
|
+
authenticated: false,
|
|
364
|
+
error: {
|
|
365
|
+
message: url.searchParams.get('error_description') ?? callbackError,
|
|
366
|
+
name: callbackError,
|
|
367
|
+
},
|
|
368
|
+
logout: true,
|
|
369
|
+
};
|
|
370
|
+
}
|
|
371
|
+
|
|
342
372
|
const code = url.searchParams.get('code');
|
|
343
373
|
const state = url.searchParams.get('state');
|
|
344
374
|
|
|
345
375
|
if (code) {
|
|
346
376
|
const savedState = storage.getItem(`${STORAGE_PREFIX}state`);
|
|
347
|
-
if (state
|
|
377
|
+
if (!state || !savedState || state !== savedState) {
|
|
378
|
+
clearTokens();
|
|
348
379
|
return { authenticated: false, error: { message: 'State mismatch' } };
|
|
349
380
|
}
|
|
350
381
|
try {
|
|
@@ -352,7 +383,7 @@ export function createSSOAuthProvider(config: SSOConfig): AuthProvider {
|
|
|
352
383
|
// Clean URL
|
|
353
384
|
url.searchParams.delete('code');
|
|
354
385
|
url.searchParams.delete('state');
|
|
355
|
-
window.history.replaceState({}, '', url.pathname);
|
|
386
|
+
window.history.replaceState({}, '', `${url.pathname}${url.search}${url.hash}`);
|
|
356
387
|
return { authenticated: true };
|
|
357
388
|
} catch (err) {
|
|
358
389
|
return { authenticated: false, error: { message: String(err) } };
|
|
@@ -409,6 +440,7 @@ export function createSSOAuthProvider(config: SSOConfig): AuthProvider {
|
|
|
409
440
|
if (tokens.id_token) {
|
|
410
441
|
try {
|
|
411
442
|
const payload = decodeJwtPayload(tokens.id_token);
|
|
443
|
+
if (!payload) return null;
|
|
412
444
|
return payload.roles ?? payload.groups ?? payload.permissions ?? null;
|
|
413
445
|
} catch {
|
|
414
446
|
return null;
|
|
@@ -418,6 +450,22 @@ export function createSSOAuthProvider(config: SSOConfig): AuthProvider {
|
|
|
418
450
|
return null;
|
|
419
451
|
},
|
|
420
452
|
|
|
453
|
+
async getAccessToken() {
|
|
454
|
+
const tokens = getTokens();
|
|
455
|
+
if (!tokens) return null;
|
|
456
|
+
|
|
457
|
+
if (tokens.expires_at && tokens.expires_at < Math.floor(Date.now() / 1000)) {
|
|
458
|
+
if (!tokens.refresh_token) {
|
|
459
|
+
clearTokens();
|
|
460
|
+
return null;
|
|
461
|
+
}
|
|
462
|
+
await refreshAccessToken(tokens.refresh_token);
|
|
463
|
+
return getTokens()?.access_token ?? null;
|
|
464
|
+
}
|
|
465
|
+
|
|
466
|
+
return tokens.access_token;
|
|
467
|
+
},
|
|
468
|
+
|
|
421
469
|
async onError(error) {
|
|
422
470
|
if (typeof error === 'object' && error !== null && 'statusCode' in error) {
|
|
423
471
|
const statusCode = (error as { statusCode: number }).statusCode;
|
|
@@ -425,6 +473,12 @@ export function createSSOAuthProvider(config: SSOConfig): AuthProvider {
|
|
|
425
473
|
return { logout: true, redirectTo: '/login' };
|
|
426
474
|
}
|
|
427
475
|
}
|
|
476
|
+
if (typeof error === 'object' && error !== null && 'status' in error) {
|
|
477
|
+
const status = (error as { status: number }).status;
|
|
478
|
+
if (status === 401 || status === 403) {
|
|
479
|
+
return { logout: true, redirectTo: '/login' };
|
|
480
|
+
}
|
|
481
|
+
}
|
|
428
482
|
return {};
|
|
429
483
|
},
|
|
430
484
|
};
|
package/src/index.ts
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
*/
|
|
9
9
|
|
|
10
10
|
export { createSSOAuthProvider } from './auth-provider';
|
|
11
|
-
export type { SSOConfig, TokenStorage } from './auth-provider';
|
|
11
|
+
export type { SSOAuthProvider, SSOConfig, TokenStorage } from './auth-provider';
|
|
12
12
|
|
|
13
13
|
// Social login presets
|
|
14
14
|
export {
|
|
@@ -18,5 +18,17 @@ export {
|
|
|
18
18
|
createGitLabAuth,
|
|
19
19
|
createKeycloakAuth,
|
|
20
20
|
createAuth0Auth,
|
|
21
|
+
createSupauthAuth,
|
|
21
22
|
} from './presets';
|
|
22
23
|
export type { PresetOptions } from './presets';
|
|
24
|
+
|
|
25
|
+
// Auth helpers (PKCE, OIDC discovery, redirect validation)
|
|
26
|
+
export {
|
|
27
|
+
generateState,
|
|
28
|
+
generateVerifier,
|
|
29
|
+
generateChallenge,
|
|
30
|
+
isValidReturnTo,
|
|
31
|
+
getForwardedOrigin,
|
|
32
|
+
resolveAuthorizeUrl,
|
|
33
|
+
resolveTokenUrl,
|
|
34
|
+
} from './auth-helpers';
|
package/src/presets.ts
CHANGED
|
@@ -177,3 +177,28 @@ export function createAuth0Auth(
|
|
|
177
177
|
// ─── Type exports ────────────────────────────────────────────
|
|
178
178
|
|
|
179
179
|
export type { PresetOptions };
|
|
180
|
+
|
|
181
|
+
// ─── Supauth / GoTrue ────────────────────────────────────────
|
|
182
|
+
|
|
183
|
+
/**
|
|
184
|
+
* Supauth OIDC Sign-In (GoTrue-compatible identity provider).
|
|
185
|
+
*
|
|
186
|
+
* Compatible with SupaCloud, SupaOAuth, and any GoTrue-based auth backend.
|
|
187
|
+
* Uses standard OIDC Authorization Code Flow with PKCE.
|
|
188
|
+
*
|
|
189
|
+
* @param issuer - Supauth issuer URL (e.g., 'https://auth.example.com')
|
|
190
|
+
* @param clientId - OAuth2 Client ID
|
|
191
|
+
*/
|
|
192
|
+
export function createSupauthAuth(
|
|
193
|
+
clientId: string,
|
|
194
|
+
opts?: PresetOptions & { issuer?: string },
|
|
195
|
+
) {
|
|
196
|
+
const issuer = opts?.issuer ?? '';
|
|
197
|
+
return createSSOAuthProvider({
|
|
198
|
+
issuer,
|
|
199
|
+
clientId,
|
|
200
|
+
scopes: ['openid', 'profile', 'email'],
|
|
201
|
+
redirectUri: resolveRedirectUri(opts),
|
|
202
|
+
...opts,
|
|
203
|
+
});
|
|
204
|
+
}
|