@deque/axe-auth 1.1.0-next.9bc60204 → 1.1.0-next.adf1ee93
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/oauth/errors.d.ts +2 -0
- package/dist/oauth/openBrowser.d.ts +14 -3
- package/dist/oauth/openBrowser.js +22 -5
- package/dist/oauth/tokenStore.d.ts +47 -3
- package/dist/oauth/tokenStore.js +364 -17
- package/package.json +4 -1
package/credits.json
CHANGED
|
@@ -27,6 +27,17 @@
|
|
|
27
27
|
"publisher": "Stephen Mathieson",
|
|
28
28
|
"email": "me@stephenmathieson.com"
|
|
29
29
|
},
|
|
30
|
+
"shlex@3.0.0": {
|
|
31
|
+
"name": "shlex",
|
|
32
|
+
"version": "3.0.0",
|
|
33
|
+
"licenses": "MIT",
|
|
34
|
+
"path": "/home/runner/work/axe-mcp-server/axe-mcp-server/node_modules/.pnpm/shlex@3.0.0/node_modules/shlex",
|
|
35
|
+
"licenseText": "MIT License\n\nCopyright (c) 2018 Ryan Govostes\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n",
|
|
36
|
+
"licenseFile": "/home/runner/work/axe-mcp-server/axe-mcp-server/node_modules/.pnpm/shlex@3.0.0/node_modules/shlex/LICENSE",
|
|
37
|
+
"repository": "https://github.com/rgov/node-shlex",
|
|
38
|
+
"publisher": "Ryan Govostes",
|
|
39
|
+
"copyright": "Copyright (c) 2018 Ryan Govostes"
|
|
40
|
+
},
|
|
30
41
|
"ts-dedent@2.2.0": {
|
|
31
42
|
"name": "ts-dedent",
|
|
32
43
|
"version": "2.2.0",
|
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. */
|
|
@@ -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, {
|
|
@@ -1,5 +1,13 @@
|
|
|
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 because of
|
|
6
|
+
* Credential Manager's 2560 UTF-16 character per-entry cap. Exported
|
|
7
|
+
* (parameterized for tests) so the chunking path can be exercised
|
|
8
|
+
* deterministically.
|
|
9
|
+
*/
|
|
10
|
+
export declare function shouldChunkForKeyring(platform?: NodeJS.Platform): boolean;
|
|
3
11
|
/**
|
|
4
12
|
* Current on-disk blob schema version. Exported so consumers can
|
|
5
13
|
* display "stored v:N, expected v:M" diagnostics when `load()` returns
|
|
@@ -100,17 +108,53 @@ export type BlobChainResult = {
|
|
|
100
108
|
* and `MIGRATORS` and applies the latest-shape check on top.
|
|
101
109
|
*/
|
|
102
110
|
export declare function parseAndMigrateBlob(raw: string | null, expectedVersion?: number, migrators?: ReadonlyMap<number, (old: unknown) => unknown | null>): BlobChainResult;
|
|
111
|
+
/**
|
|
112
|
+
* Returns a per-platform hint appended to keychain error messages so
|
|
113
|
+
* users see actionable guidance for their OS instead of generic or
|
|
114
|
+
* Linux-only advice. Exported (but not re-exported from the package
|
|
115
|
+
* index) so tests can exercise each branch without mocking
|
|
116
|
+
* `process.platform`.
|
|
117
|
+
*/
|
|
118
|
+
export declare function platformKeyringHint(platform?: NodeJS.Platform): string;
|
|
103
119
|
/**
|
|
104
120
|
* `TokenStore` backed by the operating system's native keychain via
|
|
105
121
|
* `@napi-rs/keyring` (macOS Keychain, Windows Credential Manager, Linux
|
|
106
|
-
* Secret Service).
|
|
107
|
-
*
|
|
108
|
-
*
|
|
122
|
+
* Secret Service). On macOS and Linux the blob lives in a single entry
|
|
123
|
+
* keyed by the fixed `credentials` account name. On Windows the blob
|
|
124
|
+
* is split across `credentials.0`, `credentials.1`, … entries to fit
|
|
125
|
+
* under Credential Manager's 2560 UTF-16 character per-entry cap; see
|
|
126
|
+
* `shouldChunkForKeyring`.
|
|
127
|
+
*
|
|
128
|
+
* The blob carries its own issuer/client coordinates so verbs can
|
|
129
|
+
* recover full config without per-issuer keying.
|
|
109
130
|
*/
|
|
110
131
|
export declare class KeyringTokenStore implements TokenStore {
|
|
111
132
|
#private;
|
|
133
|
+
/**
|
|
134
|
+
* @param entryFactory Injection seam for `@napi-rs/keyring` entries.
|
|
135
|
+
* Defaults to the production lazy-resolved factory; tests pass a
|
|
136
|
+
* recording / faking variant.
|
|
137
|
+
*/
|
|
112
138
|
constructor(entryFactory?: KeyringEntryFactory);
|
|
139
|
+
/**
|
|
140
|
+
* @internal Test seam. Constructs a store with an explicit chunking
|
|
141
|
+
* decision instead of the platform-determined default, so the
|
|
142
|
+
* chunked path can be exercised on macOS/Linux CI and the unchunked
|
|
143
|
+
* path on Windows CI. Production code must use the regular
|
|
144
|
+
* constructor and let `shouldChunkForKeyring()` decide — passing
|
|
145
|
+
* `chunked: true` on macOS would write data that the regular
|
|
146
|
+
* constructor wouldn't be able to read.
|
|
147
|
+
*/
|
|
148
|
+
static forTesting(entryFactory: KeyringEntryFactory, chunked: boolean): KeyringTokenStore;
|
|
113
149
|
save(entry: StoredEntry): Promise<void>;
|
|
114
150
|
load(): Promise<LoadResult>;
|
|
115
151
|
clear(): Promise<void>;
|
|
116
152
|
}
|
|
153
|
+
/**
|
|
154
|
+
* Splits `blob` into the N parts that `KeyringTokenStore.#saveChunked`
|
|
155
|
+
* writes to `credentials.0..N-1`. Chunk 0 is prefixed with `<N>\n` so
|
|
156
|
+
* the reader can learn N from a single getPassword call. Each chunk
|
|
157
|
+
* stays under `CHUNK_LIMIT` UTF-16 characters; throws if the blob would
|
|
158
|
+
* require more than `MAX_CHUNKS` chunks. Exported for tests.
|
|
159
|
+
*/
|
|
160
|
+
export declare function chunkBlobForKeyring(blob: string): string[];
|
package/dist/oauth/tokenStore.js
CHANGED
|
@@ -1,7 +1,10 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.KeyringTokenStore = exports.STORED_BLOB_VERSION = void 0;
|
|
4
|
+
exports.shouldChunkForKeyring = shouldChunkForKeyring;
|
|
4
5
|
exports.parseAndMigrateBlob = parseAndMigrateBlob;
|
|
6
|
+
exports.platformKeyringHint = platformKeyringHint;
|
|
7
|
+
exports.chunkBlobForKeyring = chunkBlobForKeyring;
|
|
5
8
|
const errors_1 = require("./errors");
|
|
6
9
|
const keyringBinding_1 = require("./keyringBinding");
|
|
7
10
|
// On macOS: Keychain generic password item with the service name below.
|
|
@@ -9,16 +12,45 @@ const keyringBinding_1 = require("./keyringBinding");
|
|
|
9
12
|
// Exposed as a human-readable string because these all surface the service
|
|
10
13
|
// name in OS UIs (Keychain Access, credmgr.exe, seahorse).
|
|
11
14
|
const SERVICE_NAME = "axe-auth";
|
|
12
|
-
// Single keychain entry per machine
|
|
13
|
-
//
|
|
14
|
-
//
|
|
15
|
-
//
|
|
15
|
+
// Single keychain entry per machine on macOS / Linux. (Windows splits
|
|
16
|
+
// across `credentials.0`, `credentials.1`, … — see `CHUNK_LIMIT`
|
|
17
|
+
// below.) The blob it holds is fully self-describing (issuerURL,
|
|
18
|
+
// clientId, allowInsecureIssuer, plus the tokens), so verbs that
|
|
19
|
+
// don't pass `--server` / `--realm` / `--client-id` can resolve their
|
|
20
|
+
// config from the entry.
|
|
16
21
|
//
|
|
17
22
|
// Account name is human-readable so users investigating the entry in
|
|
18
23
|
// macOS Keychain Access (or `secret-tool` on Linux, credmgr on
|
|
19
24
|
// Windows) can tell what it is. Not versioned: the schema version
|
|
20
|
-
// lives inside the blob and migrators handle the upgrade path.
|
|
25
|
+
// lives inside the blob and migrators handle the upgrade path. Note:
|
|
26
|
+
// Windows entries hold base64-encoded JSON rather than the raw JSON
|
|
27
|
+
// macOS / Linux store, so a Windows user inspecting their Credential
|
|
28
|
+
// Manager will see opaque base64; that's a side effect of chunking.
|
|
21
29
|
const ACCOUNT_NAME = "credentials";
|
|
30
|
+
// Windows Credential Manager caps stored values at 2560 UTF-16 code
|
|
31
|
+
// units, which large OAuth access-token JWTs (many groups/roles
|
|
32
|
+
// claims) routinely exceed. On Windows we work around this by
|
|
33
|
+
// splitting the JSON blob across multiple entries with account names
|
|
34
|
+
// `credentials.0`, `credentials.1`, … . `CHUNK_LIMIT` leaves margin
|
|
35
|
+
// under the platform cap; `MAX_CHUNKS` is a safety bound — we should
|
|
36
|
+
// never get close in practice, even with maximally-claimed tokens.
|
|
37
|
+
//
|
|
38
|
+
// macOS Keychain and Linux libsecret have no comparable limit, so
|
|
39
|
+
// chunking there would just multiply per-entry ACL prompts (each
|
|
40
|
+
// keychain entry is independently lockable on macOS) for no gain.
|
|
41
|
+
// Chunking is therefore Windows-only, gated by `shouldChunkForKeyring`.
|
|
42
|
+
const CHUNK_LIMIT = 2500;
|
|
43
|
+
const MAX_CHUNKS = 32;
|
|
44
|
+
/**
|
|
45
|
+
* Whether `KeyringTokenStore` should split the stored blob across
|
|
46
|
+
* multiple keychain entries on this platform. Windows-only because of
|
|
47
|
+
* Credential Manager's 2560 UTF-16 character per-entry cap. Exported
|
|
48
|
+
* (parameterized for tests) so the chunking path can be exercised
|
|
49
|
+
* deterministically.
|
|
50
|
+
*/
|
|
51
|
+
function shouldChunkForKeyring(platform = process.platform) {
|
|
52
|
+
return platform === "win32";
|
|
53
|
+
}
|
|
22
54
|
/**
|
|
23
55
|
* Current on-disk blob schema version. Exported so consumers can
|
|
24
56
|
* display "stored v:N, expected v:M" diagnostics when `load()` returns
|
|
@@ -153,32 +185,150 @@ function parseAndMigrateBlob(raw, expectedVersion = exports.STORED_BLOB_VERSION,
|
|
|
153
185
|
return { ok: true, blob: current };
|
|
154
186
|
}
|
|
155
187
|
function wrapKeyringError(op, cause) {
|
|
156
|
-
|
|
188
|
+
// Pass-through pre-wrapped OAuthFlowErrors so we don't double-wrap
|
|
189
|
+
// our own error type. The most common source today is
|
|
190
|
+
// `defaultEntryFactory` throwing `KEYRING_UNAVAILABLE` when the
|
|
191
|
+
// native binding can't be loaded — relabelling that as another
|
|
192
|
+
// `KEYRING_UNAVAILABLE` with a duplicate message and a possibly
|
|
193
|
+
// misleading platform hint helps nobody.
|
|
194
|
+
if (cause instanceof errors_1.OAuthFlowError) {
|
|
195
|
+
throw cause;
|
|
196
|
+
}
|
|
197
|
+
const causeMessage = cause instanceof Error ? cause.message : String(cause);
|
|
198
|
+
throw new errors_1.OAuthFlowError("KEYRING_UNAVAILABLE", `System keychain ${op} failed: ${causeMessage}. ${platformKeyringHint()}`, { cause });
|
|
199
|
+
}
|
|
200
|
+
/**
|
|
201
|
+
* Returns a per-platform hint appended to keychain error messages so
|
|
202
|
+
* users see actionable guidance for their OS instead of generic or
|
|
203
|
+
* Linux-only advice. Exported (but not re-exported from the package
|
|
204
|
+
* index) so tests can exercise each branch without mocking
|
|
205
|
+
* `process.platform`.
|
|
206
|
+
*/
|
|
207
|
+
function platformKeyringHint(platform = process.platform) {
|
|
208
|
+
switch (platform) {
|
|
209
|
+
case "darwin":
|
|
210
|
+
return "On macOS this usually means Keychain Access denied or cancelled the prompt.";
|
|
211
|
+
case "win32":
|
|
212
|
+
return "On Windows this usually means Credential Manager rejected the operation.";
|
|
213
|
+
case "linux":
|
|
214
|
+
return "On Linux this usually means no D-Bus Secret Service is running (e.g. GNOME Keyring or KWallet).";
|
|
215
|
+
default:
|
|
216
|
+
return `Underlying platform: ${platform}.`;
|
|
217
|
+
}
|
|
218
|
+
}
|
|
219
|
+
/**
|
|
220
|
+
* Parses chunk 0's `<N>\n<rest>` header. Returns the chunk count and
|
|
221
|
+
* the data part following the newline, or `null` for any malformed /
|
|
222
|
+
* out-of-range / non-canonically-encoded header. Centralised here
|
|
223
|
+
* (rather than open-coded twice in `#loadChunked` and
|
|
224
|
+
* `#previousChunkN`) so the canonical-encoding contract has one
|
|
225
|
+
* authoritative implementation.
|
|
226
|
+
*/
|
|
227
|
+
function parseChunkHeader(first) {
|
|
228
|
+
const newlineIdx = first.indexOf("\n");
|
|
229
|
+
if (newlineIdx <= 0)
|
|
230
|
+
return null;
|
|
231
|
+
const nStr = first.slice(0, newlineIdx);
|
|
232
|
+
const n = parseInt(nStr, 10);
|
|
233
|
+
// Reject non-canonical encodings ("01", " 3", "3abc"). parseInt is
|
|
234
|
+
// permissive about those; we want a single canonical encoding so
|
|
235
|
+
// two different headers can't decode to the same N.
|
|
236
|
+
if (!Number.isInteger(n) || n < 1 || n > MAX_CHUNKS || String(n) !== nStr) {
|
|
237
|
+
return null;
|
|
238
|
+
}
|
|
239
|
+
return { n, rest: first.slice(newlineIdx + 1) };
|
|
157
240
|
}
|
|
158
241
|
/**
|
|
159
242
|
* `TokenStore` backed by the operating system's native keychain via
|
|
160
243
|
* `@napi-rs/keyring` (macOS Keychain, Windows Credential Manager, Linux
|
|
161
|
-
* Secret Service).
|
|
162
|
-
*
|
|
163
|
-
*
|
|
244
|
+
* Secret Service). On macOS and Linux the blob lives in a single entry
|
|
245
|
+
* keyed by the fixed `credentials` account name. On Windows the blob
|
|
246
|
+
* is split across `credentials.0`, `credentials.1`, … entries to fit
|
|
247
|
+
* under Credential Manager's 2560 UTF-16 character per-entry cap; see
|
|
248
|
+
* `shouldChunkForKeyring`.
|
|
249
|
+
*
|
|
250
|
+
* The blob carries its own issuer/client coordinates so verbs can
|
|
251
|
+
* recover full config without per-issuer keying.
|
|
164
252
|
*/
|
|
165
253
|
class KeyringTokenStore {
|
|
166
|
-
#
|
|
254
|
+
#entryFactory;
|
|
255
|
+
#chunked;
|
|
256
|
+
/**
|
|
257
|
+
* @param entryFactory Injection seam for `@napi-rs/keyring` entries.
|
|
258
|
+
* Defaults to the production lazy-resolved factory; tests pass a
|
|
259
|
+
* recording / faking variant.
|
|
260
|
+
*/
|
|
167
261
|
constructor(entryFactory = keyringBinding_1.defaultEntryFactory) {
|
|
168
|
-
this.#
|
|
262
|
+
this.#entryFactory = entryFactory;
|
|
263
|
+
this.#chunked = shouldChunkForKeyring();
|
|
264
|
+
}
|
|
265
|
+
/**
|
|
266
|
+
* @internal Test seam. Constructs a store with an explicit chunking
|
|
267
|
+
* decision instead of the platform-determined default, so the
|
|
268
|
+
* chunked path can be exercised on macOS/Linux CI and the unchunked
|
|
269
|
+
* path on Windows CI. Production code must use the regular
|
|
270
|
+
* constructor and let `shouldChunkForKeyring()` decide — passing
|
|
271
|
+
* `chunked: true` on macOS would write data that the regular
|
|
272
|
+
* constructor wouldn't be able to read.
|
|
273
|
+
*/
|
|
274
|
+
static forTesting(entryFactory, chunked) {
|
|
275
|
+
const store = new KeyringTokenStore(entryFactory);
|
|
276
|
+
store.#chunked = chunked;
|
|
277
|
+
return store;
|
|
278
|
+
}
|
|
279
|
+
#entry(account) {
|
|
280
|
+
return this.#entryFactory(SERVICE_NAME, account);
|
|
169
281
|
}
|
|
170
282
|
async save(entry) {
|
|
171
|
-
|
|
172
|
-
|
|
283
|
+
const jsonBlob = JSON.stringify(entryToBlob(entry));
|
|
284
|
+
if (this.#chunked) {
|
|
285
|
+
// Encode + chunk OUTSIDE the try/catch so a TOKEN_TOO_LARGE from
|
|
286
|
+
// `chunkBlobForKeyring` surfaces unchanged. The keychain
|
|
287
|
+
// operations stay inside the try and get wrapped as
|
|
288
|
+
// KEYRING_UNAVAILABLE if they fail.
|
|
289
|
+
const encoded = Buffer.from(jsonBlob, "utf8").toString("base64");
|
|
290
|
+
const parts = chunkBlobForKeyring(encoded);
|
|
291
|
+
try {
|
|
292
|
+
this.#saveChunked(parts);
|
|
293
|
+
}
|
|
294
|
+
catch (cause) {
|
|
295
|
+
wrapKeyringError("write", cause);
|
|
296
|
+
}
|
|
173
297
|
}
|
|
174
|
-
|
|
175
|
-
|
|
298
|
+
else {
|
|
299
|
+
try {
|
|
300
|
+
this.#entry(ACCOUNT_NAME).setPassword(jsonBlob);
|
|
301
|
+
}
|
|
302
|
+
catch (cause) {
|
|
303
|
+
wrapKeyringError("write", cause);
|
|
304
|
+
}
|
|
176
305
|
}
|
|
177
306
|
}
|
|
178
307
|
async load() {
|
|
179
308
|
let raw;
|
|
180
309
|
try {
|
|
181
|
-
|
|
310
|
+
if (this.#chunked) {
|
|
311
|
+
const result = this.#loadChunked();
|
|
312
|
+
if (result.kind === "present") {
|
|
313
|
+
raw = result.blob;
|
|
314
|
+
}
|
|
315
|
+
else if (result.kind === "empty") {
|
|
316
|
+
// First-time-upgrade fallback: a Windows dev who upgraded
|
|
317
|
+
// across the chunking change has data at the bare
|
|
318
|
+
// `credentials` account but no chunks yet. Read that legacy
|
|
319
|
+
// entry; the next save() migrates it. Note we only fall
|
|
320
|
+
// back when chunked data is *empty* — when chunked data is
|
|
321
|
+
// *corrupt* we surface that directly rather than restoring
|
|
322
|
+
// potentially stale legacy data underneath the corruption.
|
|
323
|
+
raw = this.#entry(ACCOUNT_NAME).getPassword();
|
|
324
|
+
}
|
|
325
|
+
else {
|
|
326
|
+
return { ok: false, reason: "corrupt" };
|
|
327
|
+
}
|
|
328
|
+
}
|
|
329
|
+
else {
|
|
330
|
+
raw = this.#entry(ACCOUNT_NAME).getPassword();
|
|
331
|
+
}
|
|
182
332
|
}
|
|
183
333
|
catch (cause) {
|
|
184
334
|
wrapKeyringError("read", cause);
|
|
@@ -192,11 +342,208 @@ class KeyringTokenStore {
|
|
|
192
342
|
}
|
|
193
343
|
async clear() {
|
|
194
344
|
try {
|
|
195
|
-
this.#
|
|
345
|
+
if (this.#chunked) {
|
|
346
|
+
this.#clearChunked();
|
|
347
|
+
}
|
|
348
|
+
else {
|
|
349
|
+
this.#entry(ACCOUNT_NAME).deletePassword();
|
|
350
|
+
}
|
|
196
351
|
}
|
|
197
352
|
catch (cause) {
|
|
198
353
|
wrapKeyringError("delete", cause);
|
|
199
354
|
}
|
|
200
355
|
}
|
|
356
|
+
/**
|
|
357
|
+
* Writes `parts` (the output of `chunkBlobForKeyring`) to entries
|
|
358
|
+
* `credentials.0..N-1`.
|
|
359
|
+
*
|
|
360
|
+
* Writes are in **reverse index order** — chunks N-1..1, then chunk
|
|
361
|
+
* 0 with the new header last. Chunk 0's header is what reads use to
|
|
362
|
+
* learn N, so until it's overwritten the previous chunk 0 still
|
|
363
|
+
* references the previous N chunks.
|
|
364
|
+
*
|
|
365
|
+
* Crash recovery is partial, not total. Reverse order helps in one
|
|
366
|
+
* case: when N_new > N_old and the crash happens before chunk 0 is
|
|
367
|
+
* rewritten — writes to indices >= N_old don't disturb old data,
|
|
368
|
+
* the previous chunk 0 still references the previous N chunks, and
|
|
369
|
+
* the prior session survives. The typical refresh case (N_new ==
|
|
370
|
+
* N_old) overwrites chunks 1..N-1 with new data while chunk 0 is
|
|
371
|
+
* still old, so a crash there reads as corrupt and the user
|
|
372
|
+
* re-auths. Reverse order is therefore a marginal improvement over
|
|
373
|
+
* forward order, not a guarantee.
|
|
374
|
+
*
|
|
375
|
+
* Cleanup sweeps `[N_new, N_old)` (bounded by the previous chunk
|
|
376
|
+
* count read from the old chunk 0 header before we overwrite it).
|
|
377
|
+
* For a typical token refresh (same N) this is zero deletes; the
|
|
378
|
+
* full safety sweep up to MAX_CHUNKS only runs as a defensive
|
|
379
|
+
* recovery when the previous N can't be determined. Orphans at
|
|
380
|
+
* indices >= max(N_new, N_old) from interrupted resize-up writes
|
|
381
|
+
* persist until the next `clear()` does the full sweep.
|
|
382
|
+
*
|
|
383
|
+
* Concurrency: this method is not safe to run concurrently against
|
|
384
|
+
* the same OS keychain. Two writers can interleave at chunk
|
|
385
|
+
* boundaries and produce a Frankenstein blob. axe-auth runs as a
|
|
386
|
+
* short-lived CLI so this is unlikely in practice, but a long-lived
|
|
387
|
+
* process refreshing in the background while the CLI is invoked
|
|
388
|
+
* could trip it.
|
|
389
|
+
*/
|
|
390
|
+
#saveChunked(parts) {
|
|
391
|
+
// Read previous N before any writes so the cleanup sweep is
|
|
392
|
+
// bounded. If the previous chunk 0 is missing or its header is
|
|
393
|
+
// unparseable we have no upper bound, so fall back to the full
|
|
394
|
+
// safety range as a one-time defensive recovery.
|
|
395
|
+
const previousN = this.#previousChunkN();
|
|
396
|
+
for (let i = parts.length - 1; i >= 1; i--) {
|
|
397
|
+
this.#entry(`${ACCOUNT_NAME}.${i}`).setPassword(parts[i]);
|
|
398
|
+
}
|
|
399
|
+
this.#entry(`${ACCOUNT_NAME}.0`).setPassword(parts[0]);
|
|
400
|
+
// Best-effort sweep: writes have already succeeded, so a sweep
|
|
401
|
+
// failure shouldn't roll back the save. The next save's bounded
|
|
402
|
+
// sweep cleans up anything we miss here. Same reasoning for the
|
|
403
|
+
// legacy delete below.
|
|
404
|
+
const sweepEnd = previousN ?? MAX_CHUNKS;
|
|
405
|
+
for (let i = parts.length; i < sweepEnd; i++) {
|
|
406
|
+
try {
|
|
407
|
+
this.#entry(`${ACCOUNT_NAME}.${i}`).deletePassword();
|
|
408
|
+
}
|
|
409
|
+
catch {
|
|
410
|
+
// Sweep is best-effort; the next save handles leftovers.
|
|
411
|
+
}
|
|
412
|
+
}
|
|
413
|
+
// Clear any pre-chunking single-entry blob from a previous
|
|
414
|
+
// axe-auth release. This is a forever-tax (one extra
|
|
415
|
+
// deletePassword per save even after the migration is done)
|
|
416
|
+
// because we have no per-machine "migration completed" flag;
|
|
417
|
+
// adding one would mean another keychain entry to manage. The
|
|
418
|
+
// cost is one Credential Manager call per refresh — negligible
|
|
419
|
+
// relative to the OAuth round-trip.
|
|
420
|
+
try {
|
|
421
|
+
this.#entry(ACCOUNT_NAME).deletePassword();
|
|
422
|
+
}
|
|
423
|
+
catch {
|
|
424
|
+
// Best-effort; the next save attempts again.
|
|
425
|
+
}
|
|
426
|
+
}
|
|
427
|
+
/**
|
|
428
|
+
* Reads the chunk-count header from `credentials.0` so `#saveChunked`
|
|
429
|
+
* can bound its cleanup sweep. Returns `null` when chunk 0 is
|
|
430
|
+
* missing, when the header is malformed, or when the encoded N is
|
|
431
|
+
* out of range — every "I don't know the previous count" case
|
|
432
|
+
* collapses to a full safety sweep at the call site.
|
|
433
|
+
*/
|
|
434
|
+
#previousChunkN() {
|
|
435
|
+
const first = this.#entry(`${ACCOUNT_NAME}.0`).getPassword();
|
|
436
|
+
if (first === null)
|
|
437
|
+
return null;
|
|
438
|
+
return parseChunkHeader(first)?.n ?? null;
|
|
439
|
+
}
|
|
440
|
+
/**
|
|
441
|
+
* Reverse of `#saveChunked`. Returns a discriminated result so the
|
|
442
|
+
* caller can distinguish "no data" from "data is malformed" without
|
|
443
|
+
* reaching for sentinel strings.
|
|
444
|
+
*/
|
|
445
|
+
#loadChunked() {
|
|
446
|
+
const first = this.#entry(`${ACCOUNT_NAME}.0`).getPassword();
|
|
447
|
+
if (first === null)
|
|
448
|
+
return { kind: "empty" };
|
|
449
|
+
const header = parseChunkHeader(first);
|
|
450
|
+
if (!header)
|
|
451
|
+
return { kind: "corrupt" };
|
|
452
|
+
const parts = [header.rest];
|
|
453
|
+
for (let i = 1; i < header.n; i++) {
|
|
454
|
+
const part = this.#entry(`${ACCOUNT_NAME}.${i}`).getPassword();
|
|
455
|
+
if (part === null)
|
|
456
|
+
return { kind: "corrupt" };
|
|
457
|
+
parts.push(part);
|
|
458
|
+
}
|
|
459
|
+
// `Buffer.from(_, 'base64')` is permissive — invalid characters
|
|
460
|
+
// are silently dropped rather than throwing. Garbage base64
|
|
461
|
+
// produces garbage UTF-8, which falls through to the upstream
|
|
462
|
+
// JSON.parse and surfaces as `corrupt` from
|
|
463
|
+
// `parseAndMigrateBlob`. So no try/catch is needed here.
|
|
464
|
+
const blob = Buffer.from(parts.join(""), "base64").toString("utf8");
|
|
465
|
+
return { kind: "present", blob };
|
|
466
|
+
}
|
|
467
|
+
#clearChunked() {
|
|
468
|
+
// Sweep the whole safety range rather than break-on-first-missing
|
|
469
|
+
// so chunk holes (from interrupted writes or manual tampering)
|
|
470
|
+
// still get cleaned up. Logout is rare enough that the
|
|
471
|
+
// unconditional sweep cost is irrelevant.
|
|
472
|
+
//
|
|
473
|
+
// Per-entry errors are caught locally so a single throw doesn't
|
|
474
|
+
// strand the remaining chunks (or the legacy entry) in the
|
|
475
|
+
// keychain. After all attempts, we surface the first failure so
|
|
476
|
+
// the user still sees that logout didn't fully complete.
|
|
477
|
+
let firstError = null;
|
|
478
|
+
for (let i = 0; i < MAX_CHUNKS; i++) {
|
|
479
|
+
try {
|
|
480
|
+
this.#entry(`${ACCOUNT_NAME}.${i}`).deletePassword();
|
|
481
|
+
}
|
|
482
|
+
catch (cause) {
|
|
483
|
+
firstError ??= cause;
|
|
484
|
+
}
|
|
485
|
+
}
|
|
486
|
+
// And the pre-chunking single-entry blob, in case a Windows dev
|
|
487
|
+
// had axe-auth installed before chunking shipped.
|
|
488
|
+
try {
|
|
489
|
+
this.#entry(ACCOUNT_NAME).deletePassword();
|
|
490
|
+
}
|
|
491
|
+
catch (cause) {
|
|
492
|
+
firstError ??= cause;
|
|
493
|
+
}
|
|
494
|
+
if (firstError !== null) {
|
|
495
|
+
throw firstError;
|
|
496
|
+
}
|
|
497
|
+
}
|
|
201
498
|
}
|
|
202
499
|
exports.KeyringTokenStore = KeyringTokenStore;
|
|
500
|
+
/**
|
|
501
|
+
* Splits `blob` into the N parts that `KeyringTokenStore.#saveChunked`
|
|
502
|
+
* writes to `credentials.0..N-1`. Chunk 0 is prefixed with `<N>\n` so
|
|
503
|
+
* the reader can learn N from a single getPassword call. Each chunk
|
|
504
|
+
* stays under `CHUNK_LIMIT` UTF-16 characters; throws if the blob would
|
|
505
|
+
* require more than `MAX_CHUNKS` chunks. Exported for tests.
|
|
506
|
+
*/
|
|
507
|
+
function chunkBlobForKeyring(blob) {
|
|
508
|
+
// N depends on the header length, which depends on N. Solve by
|
|
509
|
+
// iterating until the chunk count stabilises (converges in <= a
|
|
510
|
+
// couple of steps for any realistic blob). The safety counter is
|
|
511
|
+
// belt-and-suspenders against a future tweak (different
|
|
512
|
+
// CHUNK_LIMIT, different header format) accidentally introducing
|
|
513
|
+
// oscillation; an unbounded loop here would hang `axe-auth login`
|
|
514
|
+
// with no error.
|
|
515
|
+
let n = Math.max(1, Math.ceil(blob.length / CHUNK_LIMIT));
|
|
516
|
+
let safety = 0;
|
|
517
|
+
while (true) {
|
|
518
|
+
if (++safety > 8) {
|
|
519
|
+
throw new Error(`chunkBlobForKeyring: chunk count failed to converge after ${safety} iterations (blob length ${blob.length})`);
|
|
520
|
+
}
|
|
521
|
+
const headerLen = String(n).length + 1; // "<N>\n"
|
|
522
|
+
const chunk0Capacity = CHUNK_LIMIT - headerLen;
|
|
523
|
+
if (chunk0Capacity <= 0) {
|
|
524
|
+
throw new Error(`chunkBlobForKeyring: chunk count ${n} leaves no room for data`);
|
|
525
|
+
}
|
|
526
|
+
const remaining = Math.max(0, blob.length - chunk0Capacity);
|
|
527
|
+
const next = 1 + Math.ceil(remaining / CHUNK_LIMIT);
|
|
528
|
+
if (next === n)
|
|
529
|
+
break;
|
|
530
|
+
n = next;
|
|
531
|
+
}
|
|
532
|
+
if (n > MAX_CHUNKS) {
|
|
533
|
+
// Surfaced as a distinct error code (rather than KEYRING_UNAVAILABLE)
|
|
534
|
+
// because the keystore is healthy — the failure is that the IDP's
|
|
535
|
+
// token has too many claims to fit. Wrapping this as a keychain
|
|
536
|
+
// error would attach a misleading "Credential Manager rejected"
|
|
537
|
+
// platform hint via `wrapKeyringError`'s default path.
|
|
538
|
+
throw new errors_1.OAuthFlowError("TOKEN_TOO_LARGE", `OAuth token blob would require ${n} keyring entries (max ${MAX_CHUNKS}). The IDP may be issuing tokens with unusually many claims; talk to the realm administrator.`);
|
|
539
|
+
}
|
|
540
|
+
const headerLen = String(n).length + 1;
|
|
541
|
+
const chunk0Capacity = CHUNK_LIMIT - headerLen;
|
|
542
|
+
const parts = [`${n}\n${blob.slice(0, chunk0Capacity)}`];
|
|
543
|
+
let pos = chunk0Capacity;
|
|
544
|
+
while (pos < blob.length) {
|
|
545
|
+
parts.push(blob.slice(pos, pos + CHUNK_LIMIT));
|
|
546
|
+
pos += CHUNK_LIMIT;
|
|
547
|
+
}
|
|
548
|
+
return parts;
|
|
549
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@deque/axe-auth",
|
|
3
|
-
"version": "1.1.0-next.
|
|
3
|
+
"version": "1.1.0-next.adf1ee93",
|
|
4
4
|
"description": "CLI authentication utility for Deque services",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE",
|
|
6
6
|
"type": "commonjs",
|
|
@@ -25,11 +25,14 @@
|
|
|
25
25
|
"dependencies": {
|
|
26
26
|
"@napi-rs/keyring": "^1.2.0",
|
|
27
27
|
"remove-trailing-slash": "^0.1.1",
|
|
28
|
+
"shlex": "^3.0.0",
|
|
28
29
|
"ts-dedent": "^2.2.0"
|
|
29
30
|
},
|
|
30
31
|
"devDependencies": {
|
|
32
|
+
"@hono/node-server": "^1.19.14",
|
|
31
33
|
"@types/node": "^22.13.10",
|
|
32
34
|
"c8": "^10.1.3",
|
|
35
|
+
"hono": "^4.12.16",
|
|
33
36
|
"tsx": "^4.20.6",
|
|
34
37
|
"typescript": "^5.9.3"
|
|
35
38
|
},
|