@deque/axe-auth 1.1.0-next.8e9934f2 → 1.1.0-next.9310ae44
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/credits.json +11 -0
- package/dist/cli/commonArgs.d.ts +11 -58
- package/dist/cli/commonArgs.js +8 -35
- package/dist/cli/confirm.js +0 -3
- package/dist/cli/errors.d.ts +2 -9
- package/dist/cli/errors.js +2 -9
- package/dist/cli/types.d.ts +10 -50
- package/dist/commands/login.d.ts +1 -4
- package/dist/commands/login.js +4 -13
- package/dist/commands/logout.js +0 -2
- package/dist/commands/token.js +0 -4
- package/dist/index.js +5 -12
- package/dist/oauth/authorizationURL.d.ts +1 -6
- package/dist/oauth/authorizationURL.js +2 -6
- package/dist/oauth/authorize.d.ts +12 -50
- package/dist/oauth/authorize.js +2 -4
- package/dist/oauth/discoverOIDC.d.ts +10 -27
- package/dist/oauth/discoverOIDC.js +17 -46
- package/dist/oauth/discoverSSOConfig.d.ts +2 -12
- package/dist/oauth/errors.d.ts +2 -0
- package/dist/oauth/getValidAccessToken.d.ts +9 -44
- package/dist/oauth/getValidAccessToken.js +7 -16
- package/dist/oauth/openBrowser.d.ts +14 -3
- package/dist/oauth/openBrowser.js +22 -5
- package/dist/oauth/refreshTokens.js +0 -3
- package/dist/oauth/tokenResponse.d.ts +6 -38
- package/dist/oauth/tokenResponse.js +7 -27
- package/dist/oauth/tokenStore.d.ts +58 -3
- package/dist/oauth/tokenStore.js +374 -31
- package/package.json +14 -3
|
@@ -9,13 +9,7 @@ const LOOPBACK_HOSTS = new Set(["localhost", "127.0.0.1", "[::1]"]);
|
|
|
9
9
|
function optionalString(v) {
|
|
10
10
|
return (0, predicates_1.isNonEmptyString)(v) ? v : undefined;
|
|
11
11
|
}
|
|
12
|
-
/**
|
|
13
|
-
* Throws `DISCOVERY_FAILED` if `url` is not safe to transmit OAuth
|
|
14
|
-
* secrets over. `https:` is always fine; `http:` is only fine for
|
|
15
|
-
* loopback hosts, or for any host when `allowInsecurePermitted` is
|
|
16
|
-
* `true`. `label` describes the URL being checked ("issuer URL",
|
|
17
|
-
* "token_endpoint", etc.) and appears in the error message.
|
|
18
|
-
*/
|
|
12
|
+
/** Throws `DISCOVERY_FAILED` if `url` is not safe to transmit OAuth secrets over. */
|
|
19
13
|
function assertSecureURL(url, label, allowInsecurePermitted) {
|
|
20
14
|
let parsed;
|
|
21
15
|
try {
|
|
@@ -40,10 +34,9 @@ function assertSecureURL(url, label, allowInsecurePermitted) {
|
|
|
40
34
|
throw new errors_1.OAuthFlowError("DISCOVERY_FAILED", `Unsupported ${label} scheme '${parsed.protocol}'; expected https: or http: (loopback only).`);
|
|
41
35
|
}
|
|
42
36
|
function buildDiscoveryURL(issuerURL) {
|
|
43
|
-
//
|
|
44
|
-
//
|
|
45
|
-
//
|
|
46
|
-
// defense in depth keeps the contract obvious from the code.
|
|
37
|
+
// URL parsing (rather than concat) so the path lands on `pathname`
|
|
38
|
+
// even if the input has a query string or fragment. `normalizeIssuerURL`
|
|
39
|
+
// strips those, but defense in depth.
|
|
47
40
|
const normalized = new URL((0, issuerURL_1.normalizeIssuerURL)(issuerURL));
|
|
48
41
|
normalized.search = "";
|
|
49
42
|
normalized.hash = "";
|
|
@@ -71,21 +64,10 @@ function parseConfiguration(body, url) {
|
|
|
71
64
|
};
|
|
72
65
|
}
|
|
73
66
|
/**
|
|
74
|
-
* `code_challenge_methods_supported` is OPTIONAL in OIDC discovery
|
|
75
|
-
* absence
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
* explicitly declared it does not support the flow we need. Fail fast
|
|
79
|
-
* with an actionable message instead of letting the user hit a generic
|
|
80
|
-
* OAuth error several steps deeper into the flow.
|
|
81
|
-
*
|
|
82
|
-
* An empty list (`[]`) is treated the same as a populated list missing
|
|
83
|
-
* `S256`: the server has explicitly advertised zero supported methods,
|
|
84
|
-
* which is incompatible.
|
|
85
|
-
*
|
|
86
|
-
* Called from `discoverOIDC` after issuer verification so that a
|
|
87
|
-
* tampered discovery doc surfaces the more security-critical issuer
|
|
88
|
-
* mismatch first.
|
|
67
|
+
* `code_challenge_methods_supported` is OPTIONAL in OIDC discovery —
|
|
68
|
+
* absence is fine (older providers don't advertise). But when the
|
|
69
|
+
* list is present and excludes `S256` (the only method this CLI
|
|
70
|
+
* uses, per RFC 7636), fail fast with an actionable message.
|
|
89
71
|
*/
|
|
90
72
|
function assertPKCESupport(body, url) {
|
|
91
73
|
const methods = body.code_challenge_methods_supported;
|
|
@@ -96,27 +78,16 @@ function assertPKCESupport(body, url) {
|
|
|
96
78
|
throw new errors_1.OAuthFlowError("DISCOVERY_FAILED", `OpenID configuration at ${url} advertises code_challenge_methods_supported = ${JSON.stringify(methods)}, but axe-auth requires S256 (PKCE per RFC 7636). The OAuth client used by axe-auth needs PKCE enabled, or you may be on an axe server version that predates OAuth-based MCP authentication.`);
|
|
97
79
|
}
|
|
98
80
|
/**
|
|
99
|
-
* Fetches and parses the
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
105
|
-
* whether you intend to perform identity validation. This library
|
|
106
|
-
* itself does not perform OIDC identity validation (no id_token /
|
|
107
|
-
* nonce / signature checks); callers needing OIDC-strength identity
|
|
108
|
-
* assurance should layer that on top.
|
|
109
|
-
*
|
|
110
|
-
* Verifies that the server's claimed `issuer` matches the URL the
|
|
111
|
-
* caller passed in, per OIDC Discovery §3 / defence against a hostile
|
|
112
|
-
* discovery response redirecting `authorization_endpoint` and
|
|
113
|
-
* `token_endpoint` to attacker-controlled hosts.
|
|
81
|
+
* Fetches and parses the OIDC discovery document. Fails fast (no
|
|
82
|
+
* retry) so the caller does not open a browser against an unreachable
|
|
83
|
+
* authorization server. Verifies the server's claimed `issuer` matches
|
|
84
|
+
* the input URL per OIDC Discovery §3 — without this, a hostile
|
|
85
|
+
* discovery response could redirect the authorization and token
|
|
86
|
+
* endpoints to attacker hosts.
|
|
114
87
|
*
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
* hostname (or issuer path) advertised in their discovery document.
|
|
119
|
-
* Trailing slashes tolerated.
|
|
88
|
+
* Uses the OIDC well-known path as a convention; does not perform
|
|
89
|
+
* OIDC-strength identity validation (no id_token / nonce / signature
|
|
90
|
+
* checks). Callers needing identity assurance should layer that on top.
|
|
120
91
|
*/
|
|
121
92
|
async function discoverOIDC(issuerURL, options = {}) {
|
|
122
93
|
const allowInsecure = options.allowInsecureIssuer ?? false;
|
|
@@ -1,9 +1,4 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Subset of the axe server's `/api/sso-config` response that this
|
|
3
|
-
* package consumes. The full response may carry additional fields
|
|
4
|
-
* (e.g. `publicClientId` for the SPA frontend); we ignore everything
|
|
5
|
-
* except what the CLI needs to drive its OAuth flow.
|
|
6
|
-
*/
|
|
1
|
+
/** Subset of `/api/sso-config` this package consumes. */
|
|
7
2
|
export interface SSOConfig {
|
|
8
3
|
/** Keycloak base URL, e.g. `https://auth.example.com`. */
|
|
9
4
|
url: string;
|
|
@@ -16,12 +11,7 @@ export interface SSOConfig {
|
|
|
16
11
|
export interface DiscoverSSOConfigOptions {
|
|
17
12
|
/** Aborts the underlying fetch when fired. */
|
|
18
13
|
signal?: AbortSignal;
|
|
19
|
-
/**
|
|
20
|
-
* Permit non-HTTPS axe server URLs whose host is not a loopback
|
|
21
|
-
* literal. Loopback hosts (`localhost`, `127.0.0.1`, `[::1]`) are
|
|
22
|
-
* always allowed over http; this flag is the opt-in for non-loopback
|
|
23
|
-
* http (corporate dev / reverse-proxy setups). Default `false`.
|
|
24
|
-
*/
|
|
14
|
+
/** Permit non-HTTPS axe server URLs whose host is not a loopback literal. Default `false`. */
|
|
25
15
|
allowInsecure?: boolean;
|
|
26
16
|
}
|
|
27
17
|
/**
|
package/dist/oauth/errors.d.ts
CHANGED
|
@@ -41,6 +41,8 @@ export type OAuthFlowErrorCode =
|
|
|
41
41
|
| "TOKEN_EXCHANGE_FAILED"
|
|
42
42
|
/** System keychain is unavailable (e.g. no D-Bus secret service on Linux). */
|
|
43
43
|
| "KEYRING_UNAVAILABLE"
|
|
44
|
+
/** OAuth blob is too large for the OS keystore (Windows Credential Manager: 2560 UTF-16 chars per entry, MAX_CHUNKS chunks max). The keystore itself is healthy; the IDP is issuing tokens with too many claims. */
|
|
45
|
+
| "TOKEN_TOO_LARGE"
|
|
44
46
|
/** Authorization endpoint returned by discovery cannot be used (e.g. already carries an OAuth-required param). Server misconfiguration. */
|
|
45
47
|
| "INVALID_AUTHORIZATION_ENDPOINT"
|
|
46
48
|
/** No usable stored credentials; the user needs to run `login` to re-authenticate. Covers empty / corrupt / version-mismatched store and refresh tokens the authorization server has revoked. */
|
|
@@ -1,60 +1,25 @@
|
|
|
1
1
|
import { type LoadResult, type TokenStore } from "./tokenStore";
|
|
2
2
|
/** Options for `getValidAccessToken`. */
|
|
3
3
|
export interface GetValidAccessTokenOptions {
|
|
4
|
-
/**
|
|
5
|
-
* OIDC issuer URL (same value passed to `authorize`). Must match
|
|
6
|
-
* the stored entry's `issuerURL`; mismatch throws
|
|
7
|
-
* `OAuthFlowError("NOT_AUTHENTICATED", ...)` rather than refreshing
|
|
8
|
-
* the wrong issuer's tokens at the requested endpoint.
|
|
9
|
-
*/
|
|
4
|
+
/** OIDC issuer URL. Must match the stored entry's `issuerURL`; mismatch throws NOT_AUTHENTICATED. */
|
|
10
5
|
issuerURL: string;
|
|
11
|
-
/**
|
|
12
|
-
* OAuth client identifier. Must match the stored entry's
|
|
13
|
-
* `clientId`; see the note on `issuerURL` for the mismatch
|
|
14
|
-
* behavior.
|
|
15
|
-
*/
|
|
6
|
+
/** OAuth client identifier. Must match the stored entry's `clientId`; same mismatch behavior as `issuerURL`. */
|
|
16
7
|
clientId: string;
|
|
17
8
|
/**
|
|
18
|
-
* How close to expiry
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
* expiry (which may differ by a few seconds of clock skew) and
|
|
22
|
-
* prevents a token from expiring mid-request after we hand it out.
|
|
23
|
-
*
|
|
24
|
-
* Assumes the access-token TTL is much larger than the buffer. With
|
|
25
|
-
* TTLs ≤ `expiryBufferMs`, every call will trigger a refresh.
|
|
9
|
+
* How close to expiry preemptive refresh kicks in, in ms. Default
|
|
10
|
+
* 60_000. Buffer covers clock skew vs. the server. Assumes
|
|
11
|
+
* access-token TTL ≫ this; otherwise every call refreshes.
|
|
26
12
|
*/
|
|
27
13
|
expiryBufferMs?: number;
|
|
28
|
-
/**
|
|
29
|
-
* Override for the token store. Defaults to a fresh
|
|
30
|
-
* `KeyringTokenStore()` (single keychain entry per machine).
|
|
31
|
-
*/
|
|
14
|
+
/** Override for the token store. */
|
|
32
15
|
tokenStore?: TokenStore;
|
|
33
|
-
/**
|
|
34
|
-
* Pre-loaded result of `tokenStore.load()`. When provided, the
|
|
35
|
-
* function skips its own keychain read and uses this value
|
|
36
|
-
* instead — lets a caller that already loaded the entry (the CLI
|
|
37
|
-
* dispatcher does, to derive `parseCommonArgs` defaults) avoid a
|
|
38
|
-
* redundant second read on the hot path. The same `tokenStore` is
|
|
39
|
-
* still used for the post-refresh `save()` and the
|
|
40
|
-
* `invalid_grant` `clear()`.
|
|
41
|
-
*/
|
|
16
|
+
/** Pre-loaded `tokenStore.load()` result so the dispatcher's keychain read isn't repeated. */
|
|
42
17
|
loadedEntry?: LoadResult;
|
|
43
18
|
/** Aborts discovery + the refresh POST when fired. */
|
|
44
19
|
signal?: AbortSignal;
|
|
45
|
-
/**
|
|
46
|
-
* Forwarded to discovery. Loopback issuers are always permitted
|
|
47
|
-
* over http; this flag is the opt-in for non-loopback http.
|
|
48
|
-
*/
|
|
20
|
+
/** Forwarded to discovery; permits non-loopback http. */
|
|
49
21
|
allowInsecureIssuer?: boolean;
|
|
50
|
-
/**
|
|
51
|
-
* Called for soft warnings that are not errors but warrant user
|
|
52
|
-
* attention (e.g. a fresh `TokenSet` could not be written to the
|
|
53
|
-
* keychain, stranding the rotated refresh token — see the hazard
|
|
54
|
-
* note in the body of `getValidAccessToken`). The default prints
|
|
55
|
-
* to stderr only when stderr is a TTY. Pass a custom handler to
|
|
56
|
-
* route warnings through your own UI, or `() => {}` to suppress.
|
|
57
|
-
*/
|
|
22
|
+
/** Called for soft warnings (e.g. rotated tokens couldn't be persisted — see HAZARD note in the body). Default prints to stderr only when stderr is a TTY. */
|
|
58
23
|
onWarning?: (message: string) => void;
|
|
59
24
|
/** Source of `now`. Defaults to `Date.now`. Injected for test determinism. */
|
|
60
25
|
now?: () => number;
|
|
@@ -59,21 +59,15 @@ async function getValidAccessToken(options) {
|
|
|
59
59
|
throw notAuthenticated(`Stored credentials are from an unsupported schema version (v:${loaded.storedVersion}). Run \`axe-auth login\` to re-authenticate.`);
|
|
60
60
|
}
|
|
61
61
|
}
|
|
62
|
-
//
|
|
63
|
-
//
|
|
64
|
-
//
|
|
65
|
-
// pair. Refreshing those tokens against a different
|
|
66
|
-
// discovery/token endpoint would land an unrelated refresh token
|
|
67
|
-
// at the wrong server and leak it. Refuse rather than silently
|
|
68
|
-
// proceed so direct library callers (the CLI's verbs warn + route
|
|
69
|
-
// before getting here) get a clear signal.
|
|
62
|
+
// Refuse on issuer/client mismatch: refreshing tokens at a
|
|
63
|
+
// different endpoint would leak the refresh token to the wrong
|
|
64
|
+
// server.
|
|
70
65
|
if (loaded.entry.issuerURL !== issuerURL ||
|
|
71
66
|
loaded.entry.clientId !== clientId) {
|
|
72
67
|
throw notAuthenticated(`Stored credentials are for issuer ${loaded.entry.issuerURL} (client ${loaded.entry.clientId}), but the requested issuer is ${issuerURL} (client ${clientId}). Run \`axe-auth login\` to re-authenticate.`);
|
|
73
68
|
}
|
|
74
69
|
const tokens = loaded.entry.tokens;
|
|
75
70
|
if (now() + expiryBufferMs < tokens.expiresAt) {
|
|
76
|
-
// Still fresh — no network call, no store write.
|
|
77
71
|
return tokens.accessToken;
|
|
78
72
|
}
|
|
79
73
|
if (!tokens.refreshToken) {
|
|
@@ -95,13 +89,10 @@ async function getValidAccessToken(options) {
|
|
|
95
89
|
}
|
|
96
90
|
catch (err) {
|
|
97
91
|
if (isInvalidGrant(err)) {
|
|
98
|
-
//
|
|
99
|
-
//
|
|
100
|
-
//
|
|
101
|
-
//
|
|
102
|
-
// the actionable "please run login" signal. Note the clear
|
|
103
|
-
// failure via onWarning; the next run will see the stale
|
|
104
|
-
// tokens, try to refresh, and land back here.
|
|
92
|
+
// Best-effort clear: if the clear itself fails, still surface
|
|
93
|
+
// NOT_AUTHENTICATED so the user gets the "please run login"
|
|
94
|
+
// signal — the next run will refresh, land back here, and
|
|
95
|
+
// retry the clear.
|
|
105
96
|
try {
|
|
106
97
|
await tokenStore.clear();
|
|
107
98
|
}
|
|
@@ -7,13 +7,24 @@ export interface OpenBrowserOptions {
|
|
|
7
7
|
platform?: NodeJS.Platform;
|
|
8
8
|
/** Override for `child_process.spawn`. Used by tests. */
|
|
9
9
|
spawnFn?: SpawnFn;
|
|
10
|
+
/**
|
|
11
|
+
* Override for `process.env.BROWSER`. The de-facto convention shared
|
|
12
|
+
* with `xdg-open` and Python's `webbrowser`: when set, it names the
|
|
13
|
+
* command to invoke instead of the platform default. Parsed shlex-style
|
|
14
|
+
* (POSIX shell tokenization) so values like `firefox --new-window` or
|
|
15
|
+
* `/path/with\ spaces/firefox` work as expected. An empty or missing
|
|
16
|
+
* value falls back to the platform default.
|
|
17
|
+
*/
|
|
18
|
+
browserEnv?: string;
|
|
10
19
|
}
|
|
11
20
|
/**
|
|
12
21
|
* Launches the system browser at `url` in a detached child process.
|
|
13
|
-
*
|
|
14
|
-
*
|
|
22
|
+
* Honors `$BROWSER` when set, falling back to the platform default
|
|
23
|
+
* (`open` / `xdg-open` / `cmd start`). Returns synchronously once the
|
|
24
|
+
* child is spawned — completion of the browser load is intentionally
|
|
25
|
+
* not awaited.
|
|
15
26
|
*
|
|
16
27
|
* @param url Absolute URL to open.
|
|
17
|
-
* @param options Platform/spawn overrides; only exposed for tests.
|
|
28
|
+
* @param options Platform/spawn/env overrides; only exposed for tests.
|
|
18
29
|
*/
|
|
19
30
|
export declare function openBrowser(url: string, options?: OpenBrowserOptions): void;
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.openBrowser = openBrowser;
|
|
4
4
|
const node_child_process_1 = require("node:child_process");
|
|
5
|
+
const shlex_1 = require("shlex");
|
|
5
6
|
const errors_1 = require("./errors");
|
|
6
7
|
// On Windows `start` is a cmd.exe builtin, not a standalone binary.
|
|
7
8
|
// The empty `""` pair is a positional placeholder for the window
|
|
@@ -26,7 +27,11 @@ function windowsCommand(url) {
|
|
|
26
27
|
args: ["/c", "start", '""', url.replace(/[&|^<>"%\r\n]/g, (c) => `^${c}`)],
|
|
27
28
|
};
|
|
28
29
|
}
|
|
29
|
-
function browserCommand(platform, url) {
|
|
30
|
+
function browserCommand(platform, url, browserOverride) {
|
|
31
|
+
if (browserOverride && browserOverride.length > 0) {
|
|
32
|
+
const [command, ...extraArgs] = browserOverride;
|
|
33
|
+
return { command, args: [...extraArgs, url] };
|
|
34
|
+
}
|
|
30
35
|
switch (platform) {
|
|
31
36
|
case "darwin":
|
|
32
37
|
return { command: "open", args: [url] };
|
|
@@ -47,16 +52,28 @@ function browserCommand(platform, url) {
|
|
|
47
52
|
}
|
|
48
53
|
/**
|
|
49
54
|
* Launches the system browser at `url` in a detached child process.
|
|
50
|
-
*
|
|
51
|
-
*
|
|
55
|
+
* Honors `$BROWSER` when set, falling back to the platform default
|
|
56
|
+
* (`open` / `xdg-open` / `cmd start`). Returns synchronously once the
|
|
57
|
+
* child is spawned — completion of the browser load is intentionally
|
|
58
|
+
* not awaited.
|
|
52
59
|
*
|
|
53
60
|
* @param url Absolute URL to open.
|
|
54
|
-
* @param options Platform/spawn overrides; only exposed for tests.
|
|
61
|
+
* @param options Platform/spawn/env overrides; only exposed for tests.
|
|
55
62
|
*/
|
|
56
63
|
function openBrowser(url, options = {}) {
|
|
57
64
|
const platform = options.platform ?? process.platform;
|
|
58
65
|
const spawnFn = options.spawnFn ?? node_child_process_1.spawn;
|
|
59
|
-
const
|
|
66
|
+
const browserEnv = options.browserEnv ?? process.env.BROWSER;
|
|
67
|
+
let browserOverride;
|
|
68
|
+
if (browserEnv && browserEnv.length > 0) {
|
|
69
|
+
try {
|
|
70
|
+
browserOverride = (0, shlex_1.split)(browserEnv);
|
|
71
|
+
}
|
|
72
|
+
catch (cause) {
|
|
73
|
+
throw new errors_1.OAuthFlowError("BROWSER_LAUNCH_FAILED", `Failed to parse $BROWSER (${browserEnv}). Open this URL manually:\n${url}`, { cause });
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
const { command, args } = browserCommand(platform, url, browserOverride);
|
|
60
77
|
let child;
|
|
61
78
|
try {
|
|
62
79
|
child = spawnFn(command, args, {
|
|
@@ -53,9 +53,6 @@ async function refreshTokens(options) {
|
|
|
53
53
|
await (0, tokenResponse_1.throwTokenEndpointError)(response, "Token refresh");
|
|
54
54
|
}
|
|
55
55
|
const fresh = await (0, tokenResponse_1.parseTokenResponse)(response, issuedAt, options.tokenEndpoint);
|
|
56
|
-
// Preserve the input refresh token if the server didn't rotate.
|
|
57
|
-
// Keycloak rotates by default; others (e.g. Okta with some
|
|
58
|
-
// configs) don't.
|
|
59
56
|
return {
|
|
60
57
|
...fresh,
|
|
61
58
|
refreshToken: fresh.refreshToken ?? options.refreshToken,
|
|
@@ -1,18 +1,4 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Tokens returned by a successful token-endpoint call (authorization
|
|
3
|
-
* code exchange, refresh-token grant, etc.).
|
|
4
|
-
*
|
|
5
|
-
* `refreshToken` is optional because not all flows return one. On
|
|
6
|
-
* authorization-code exchange it's absent if the caller did not
|
|
7
|
-
* request `offline_access` (or the provider equivalent); on refresh
|
|
8
|
-
* some providers rotate tokens (return a new one) while others don't
|
|
9
|
-
* (the caller should keep the existing refresh token).
|
|
10
|
-
*
|
|
11
|
-
* `grantedScope` reflects the authorization server's `scope` response
|
|
12
|
-
* field when present. RFC 6749 §5.1 says `scope` is required in the
|
|
13
|
-
* response when the granted set differs from the requested set; many
|
|
14
|
-
* servers send it unconditionally.
|
|
15
|
-
*/
|
|
1
|
+
/** Tokens returned by a successful token-endpoint call. */
|
|
16
2
|
export interface TokenSet {
|
|
17
3
|
/** Access token for authenticated API calls. */
|
|
18
4
|
accessToken: string;
|
|
@@ -24,31 +10,13 @@ export interface TokenSet {
|
|
|
24
10
|
grantedScope?: string;
|
|
25
11
|
}
|
|
26
12
|
/**
|
|
27
|
-
* Reads a non-2xx response body and throws
|
|
28
|
-
* `
|
|
29
|
-
* `error` / `error_description` surfaced in both message and details
|
|
30
|
-
* when present. Shared by both the authorization-code exchange and
|
|
31
|
-
* refresh-token paths since the error contract is identical.
|
|
32
|
-
*
|
|
33
|
-
* @param context Short human-readable description of which call
|
|
34
|
-
* failed ("Token exchange", "Token refresh", etc.). Appears in the
|
|
35
|
-
* error message.
|
|
13
|
+
* Reads a non-2xx response body and throws `TOKEN_EXCHANGE_FAILED`
|
|
14
|
+
* with the OAuth `error` / `error_description` surfaced when present.
|
|
36
15
|
*/
|
|
37
16
|
export declare function throwTokenEndpointError(response: Response, context: string): Promise<never>;
|
|
38
17
|
/**
|
|
39
|
-
* Parses a 2xx response
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
* `expires_in`, Bearer `token_type`) and converts the relative
|
|
43
|
-
* `expires_in` into an absolute `expiresAt` using `issuedAt`.
|
|
44
|
-
*
|
|
45
|
-
* @param response The HTTP response (must be 2xx; caller handles
|
|
46
|
-
* error statuses via `throwTokenEndpointError`).
|
|
47
|
-
* @param issuedAt The timestamp captured just before the network
|
|
48
|
-
* call. Slightly conservative — the token actually expires
|
|
49
|
-
* `expires_in` seconds from when the server issued it, so the
|
|
50
|
-
* effective usable window is `expires_in - RTT`, which errs toward
|
|
51
|
-
* "expires sooner" rather than "expires later."
|
|
52
|
-
* @param endpointURL URL used for error messages.
|
|
18
|
+
* Parses a 2xx response from an RFC 6749 §5.1 token endpoint into a
|
|
19
|
+
* `TokenSet`. `issuedAt` is the timestamp captured just before the
|
|
20
|
+
* network call; the resulting `expiresAt` is conservative by ~RTT.
|
|
53
21
|
*/
|
|
54
22
|
export declare function parseTokenResponse(response: Response, issuedAt: number, endpointURL: string): Promise<TokenSet>;
|
|
@@ -4,10 +4,8 @@ exports.throwTokenEndpointError = throwTokenEndpointError;
|
|
|
4
4
|
exports.parseTokenResponse = parseTokenResponse;
|
|
5
5
|
const errors_1 = require("./errors");
|
|
6
6
|
const predicates_1 = require("./predicates");
|
|
7
|
-
// RFC 6749 §5.1
|
|
8
|
-
//
|
|
9
|
-
// numeric strings. Accept both; reject anything non-positive or
|
|
10
|
-
// non-finite.
|
|
7
|
+
// RFC 6749 §5.1 doesn't pin the JSON type and some providers send
|
|
8
|
+
// numeric strings; accept both, reject non-positive or non-finite.
|
|
11
9
|
function parseExpiresIn(v) {
|
|
12
10
|
if (typeof v === "number" && Number.isFinite(v) && v > 0)
|
|
13
11
|
return v;
|
|
@@ -37,15 +35,8 @@ function parseErrorBody(body) {
|
|
|
37
35
|
};
|
|
38
36
|
}
|
|
39
37
|
/**
|
|
40
|
-
* Reads a non-2xx response body and throws
|
|
41
|
-
* `
|
|
42
|
-
* `error` / `error_description` surfaced in both message and details
|
|
43
|
-
* when present. Shared by both the authorization-code exchange and
|
|
44
|
-
* refresh-token paths since the error contract is identical.
|
|
45
|
-
*
|
|
46
|
-
* @param context Short human-readable description of which call
|
|
47
|
-
* failed ("Token exchange", "Token refresh", etc.). Appears in the
|
|
48
|
-
* error message.
|
|
38
|
+
* Reads a non-2xx response body and throws `TOKEN_EXCHANGE_FAILED`
|
|
39
|
+
* with the OAuth `error` / `error_description` surfaced when present.
|
|
49
40
|
*/
|
|
50
41
|
async function throwTokenEndpointError(response, context) {
|
|
51
42
|
const body = await response.text().catch(() => "");
|
|
@@ -63,20 +54,9 @@ async function throwTokenEndpointError(response, context) {
|
|
|
63
54
|
throw new errors_1.OAuthFlowError("TOKEN_EXCHANGE_FAILED", `${context} failed with HTTP ${response.status}${suffix}`, Object.keys(details).length > 0 ? { details } : undefined);
|
|
64
55
|
}
|
|
65
56
|
/**
|
|
66
|
-
* Parses a 2xx response
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
* `expires_in`, Bearer `token_type`) and converts the relative
|
|
70
|
-
* `expires_in` into an absolute `expiresAt` using `issuedAt`.
|
|
71
|
-
*
|
|
72
|
-
* @param response The HTTP response (must be 2xx; caller handles
|
|
73
|
-
* error statuses via `throwTokenEndpointError`).
|
|
74
|
-
* @param issuedAt The timestamp captured just before the network
|
|
75
|
-
* call. Slightly conservative — the token actually expires
|
|
76
|
-
* `expires_in` seconds from when the server issued it, so the
|
|
77
|
-
* effective usable window is `expires_in - RTT`, which errs toward
|
|
78
|
-
* "expires sooner" rather than "expires later."
|
|
79
|
-
* @param endpointURL URL used for error messages.
|
|
57
|
+
* Parses a 2xx response from an RFC 6749 §5.1 token endpoint into a
|
|
58
|
+
* `TokenSet`. `issuedAt` is the timestamp captured just before the
|
|
59
|
+
* network call; the resulting `expiresAt` is conservative by ~RTT.
|
|
80
60
|
*/
|
|
81
61
|
async function parseTokenResponse(response, issuedAt, endpointURL) {
|
|
82
62
|
let parsed;
|
|
@@ -1,5 +1,16 @@
|
|
|
1
1
|
import { type KeyringEntryFactory } from "./keyringBinding";
|
|
2
2
|
import type { TokenSet } from "./tokenResponse";
|
|
3
|
+
/**
|
|
4
|
+
* Whether `KeyringTokenStore` should split the stored blob across
|
|
5
|
+
* multiple keychain entries on this platform. Windows-only: Credential
|
|
6
|
+
* Manager has a 2560-byte per-entry cap that large OAuth tokens
|
|
7
|
+
* routinely exceed. macOS Keychain and Linux libsecret have no
|
|
8
|
+
* comparable limit, and on macOS each entry is independently lockable
|
|
9
|
+
* (chunking there would multiply per-entry ACL prompts). Exported
|
|
10
|
+
* (parameterized for tests) so the chunking path can be exercised
|
|
11
|
+
* deterministically.
|
|
12
|
+
*/
|
|
13
|
+
export declare function shouldChunkForKeyring(platform?: NodeJS.Platform): boolean;
|
|
3
14
|
/**
|
|
4
15
|
* Current on-disk blob schema version. Exported so consumers can
|
|
5
16
|
* display "stored v:N, expected v:M" diagnostics when `load()` returns
|
|
@@ -100,17 +111,61 @@ export type BlobChainResult = {
|
|
|
100
111
|
* and `MIGRATORS` and applies the latest-shape check on top.
|
|
101
112
|
*/
|
|
102
113
|
export declare function parseAndMigrateBlob(raw: string | null, expectedVersion?: number, migrators?: ReadonlyMap<number, (old: unknown) => unknown | null>): BlobChainResult;
|
|
114
|
+
/**
|
|
115
|
+
* Builds the user-facing keychain error message: the underlying
|
|
116
|
+
* cause's text plus a per-platform hint. Platform is a parameter
|
|
117
|
+
* (defaulting to `process.platform`) so tests can drive each branch
|
|
118
|
+
* without mocking the runtime; mirrors the pattern in
|
|
119
|
+
* `platformKeyringHint`.
|
|
120
|
+
*/
|
|
121
|
+
export declare function keyringErrorMessage(op: string, cause: unknown, platform?: NodeJS.Platform): string;
|
|
122
|
+
/**
|
|
123
|
+
* Returns a per-platform hint appended to keychain error messages so
|
|
124
|
+
* users see actionable guidance for their OS instead of generic or
|
|
125
|
+
* Linux-only advice. Exported (but not re-exported from the package
|
|
126
|
+
* index) so tests can exercise each branch without mocking
|
|
127
|
+
* `process.platform`.
|
|
128
|
+
*/
|
|
129
|
+
export declare function platformKeyringHint(platform?: NodeJS.Platform): string;
|
|
103
130
|
/**
|
|
104
131
|
* `TokenStore` backed by the operating system's native keychain via
|
|
105
132
|
* `@napi-rs/keyring` (macOS Keychain, Windows Credential Manager, Linux
|
|
106
|
-
* Secret Service).
|
|
107
|
-
*
|
|
108
|
-
*
|
|
133
|
+
* Secret Service). On macOS and Linux the blob lives in a single entry
|
|
134
|
+
* keyed by the fixed `credentials` account name. On Windows the blob
|
|
135
|
+
* is split across `credentials.0`, `credentials.1`, … entries to fit
|
|
136
|
+
* under Credential Manager's 2560-byte (1280 UTF-16 char) per-entry
|
|
137
|
+
* cap; see `shouldChunkForKeyring`.
|
|
138
|
+
*
|
|
139
|
+
* The blob carries its own issuer/client coordinates so verbs can
|
|
140
|
+
* recover full config without per-issuer keying.
|
|
109
141
|
*/
|
|
110
142
|
export declare class KeyringTokenStore implements TokenStore {
|
|
111
143
|
#private;
|
|
144
|
+
/**
|
|
145
|
+
* @param entryFactory Injection seam for `@napi-rs/keyring` entries.
|
|
146
|
+
* Defaults to the production lazy-resolved factory; tests pass a
|
|
147
|
+
* recording / faking variant.
|
|
148
|
+
*/
|
|
112
149
|
constructor(entryFactory?: KeyringEntryFactory);
|
|
150
|
+
/**
|
|
151
|
+
* @internal Test seam. Constructs a store with an explicit chunking
|
|
152
|
+
* decision instead of the platform-determined default, so the
|
|
153
|
+
* chunked path can be exercised on macOS/Linux CI and the unchunked
|
|
154
|
+
* path on Windows CI. Production code must use the regular
|
|
155
|
+
* constructor and let `shouldChunkForKeyring()` decide — passing
|
|
156
|
+
* `chunked: true` on macOS would write data that the regular
|
|
157
|
+
* constructor wouldn't be able to read.
|
|
158
|
+
*/
|
|
159
|
+
static forTesting(entryFactory: KeyringEntryFactory, chunked: boolean): KeyringTokenStore;
|
|
113
160
|
save(entry: StoredEntry): Promise<void>;
|
|
114
161
|
load(): Promise<LoadResult>;
|
|
115
162
|
clear(): Promise<void>;
|
|
116
163
|
}
|
|
164
|
+
/**
|
|
165
|
+
* Splits `blob` into the N parts that `KeyringTokenStore.#saveChunked`
|
|
166
|
+
* writes to `credentials.0..N-1`. Chunk 0 is prefixed with `<N>\n` so
|
|
167
|
+
* the reader can learn N from a single getPassword call. Each chunk
|
|
168
|
+
* stays under `CHUNK_LIMIT` UTF-16 characters; throws if the blob would
|
|
169
|
+
* require more than `MAX_CHUNKS` chunks. Exported for tests.
|
|
170
|
+
*/
|
|
171
|
+
export declare function chunkBlobForKeyring(blob: string): string[];
|