@deque/axe-auth 1.1.0-next.5c407e02 → 1.1.0-next.689a4b1a
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/README.md +58 -17
- package/credits.json +53 -0
- package/dist/cli/commonArgs.d.ts +35 -0
- package/dist/cli/commonArgs.help.d.ts +2 -0
- package/dist/cli/commonArgs.help.js +20 -0
- package/dist/cli/commonArgs.js +63 -0
- package/dist/cli/confirm.d.ts +17 -0
- package/dist/cli/confirm.js +53 -0
- package/dist/cli/errors.d.ts +13 -0
- package/dist/cli/errors.js +30 -0
- package/dist/cli/testUtils.d.ts +52 -0
- package/dist/cli/testUtils.js +100 -0
- package/dist/cli/types.d.ts +39 -0
- package/dist/cli/types.js +2 -0
- package/dist/commands/login.d.ts +41 -0
- package/dist/commands/login.help.d.ts +2 -0
- package/dist/commands/login.help.js +41 -0
- package/dist/commands/login.js +108 -0
- package/dist/commands/logout.d.ts +24 -0
- package/dist/commands/logout.help.d.ts +2 -0
- package/dist/commands/logout.help.js +38 -0
- package/dist/commands/logout.js +68 -0
- package/dist/commands/token.d.ts +21 -0
- package/dist/commands/token.help.d.ts +2 -0
- package/dist/commands/token.help.js +41 -0
- package/dist/commands/token.js +40 -0
- package/dist/index.js +107 -22
- package/dist/oauth/authorizationURL.d.ts +1 -6
- package/dist/oauth/authorizationURL.js +2 -6
- package/dist/oauth/authorize.d.ts +13 -43
- package/dist/oauth/authorize.js +11 -8
- package/dist/oauth/discoverOIDC.d.ts +10 -27
- package/dist/oauth/discoverOIDC.js +33 -32
- package/dist/oauth/discoverSSOConfig.d.ts +37 -0
- package/dist/oauth/discoverSSOConfig.js +105 -0
- package/dist/oauth/errors.d.ts +2 -0
- package/dist/oauth/getValidAccessToken.d.ts +11 -27
- package/dist/oauth/getValidAccessToken.js +23 -14
- package/dist/oauth/index.d.ts +2 -1
- package/dist/oauth/keyringBinding.d.ts +22 -0
- package/dist/oauth/keyringBinding.js +41 -0
- package/dist/oauth/openBrowser.d.ts +14 -3
- package/dist/oauth/openBrowser.js +22 -5
- package/dist/oauth/refreshTokens.js +2 -3
- package/dist/oauth/revokeToken.d.ts +28 -0
- package/dist/oauth/revokeToken.js +63 -0
- package/dist/oauth/tokenExchange.js +2 -0
- package/dist/oauth/tokenResponse.d.ts +6 -38
- package/dist/oauth/tokenResponse.js +7 -27
- package/dist/oauth/tokenStore.d.ts +116 -23
- package/dist/oauth/tokenStore.js +459 -90
- package/dist/userAgent.d.ts +12 -0
- package/dist/userAgent.js +18 -0
- package/docs/architecture.md +201 -0
- package/docs/callback-page.md +24 -0
- package/docs/callback-server.md +21 -0
- package/docs/oauth-flow.md +15 -0
- package/package.json +21 -5
|
@@ -2,64 +2,34 @@ import type { TokenSet } from "./tokenResponse";
|
|
|
2
2
|
import { type TokenStore } from "./tokenStore";
|
|
3
3
|
/** Options for `authorize`. */
|
|
4
4
|
export interface AuthorizeOptions {
|
|
5
|
-
/**
|
|
6
|
-
* Authorization-server URL the discovery document claims as its
|
|
7
|
-
* `issuer`. For Keycloak, callers build this as
|
|
8
|
-
* `${serverURL}/realms/${realm}`. For other providers it is the
|
|
9
|
-
* hostname (or issuer path) advertised in their discovery document.
|
|
10
|
-
*/
|
|
5
|
+
/** Issuer URL the OIDC discovery document advertises (e.g. `${serverURL}/realms/${realm}` for Keycloak). */
|
|
11
6
|
issuerURL: string;
|
|
12
7
|
/** OAuth client ID registered with the authorization server. */
|
|
13
8
|
clientId: string;
|
|
14
|
-
/**
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
* want a refresh token typically pass `["offline_access"]`; Google
|
|
18
|
-
* uses `access_type=offline` as a separate query param and
|
|
19
|
-
* therefore needs an empty scope list plus that param threaded
|
|
20
|
-
* through elsewhere.
|
|
21
|
-
*/
|
|
9
|
+
/** Persisted alongside the tokens so future verbs can re-discover `/api/sso-config` without flags. */
|
|
10
|
+
walnutURL: string;
|
|
11
|
+
/** OAuth scopes to request. Keycloak callers typically pass `["offline_access"]` for a refresh token. */
|
|
22
12
|
scopes: readonly string[];
|
|
23
13
|
/** Max time to wait for the loopback callback, in milliseconds. */
|
|
24
14
|
timeoutMs?: number;
|
|
25
15
|
/** Aborts the in-flight discovery, callback wait, and token exchange. */
|
|
26
16
|
signal?: AbortSignal;
|
|
27
|
-
/**
|
|
28
|
-
* Override for the token persistence layer. Defaults to
|
|
29
|
-
* `KeyringTokenStore` keyed by the normalized issuer URL.
|
|
30
|
-
*/
|
|
17
|
+
/** Override for the token persistence layer. */
|
|
31
18
|
tokenStore?: TokenStore;
|
|
32
19
|
/** Override for the system browser launcher. Injected for tests. */
|
|
33
20
|
openBrowser?: (url: string) => void;
|
|
34
|
-
/**
|
|
35
|
-
* Called with the authorization URL just before the browser launch.
|
|
36
|
-
* The default prints to stderr only when stderr is a TTY, so a
|
|
37
|
-
* parent CLI consuming this library as a dependency does not
|
|
38
|
-
* double-print. Pass a custom handler to route the URL through your
|
|
39
|
-
* own UI, or `() => {}` to suppress entirely.
|
|
40
|
-
*/
|
|
21
|
+
/** Called with the authorization URL just before the browser launch. Default prints to stderr only when stderr is a TTY. */
|
|
41
22
|
onAuthorizationUrl?: (url: string) => void;
|
|
42
23
|
/**
|
|
43
|
-
* Called for soft warnings
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
* Non-TTY callers who want warning visibility (log files, parent
|
|
51
|
-
* CLIs, background workers) should pass an explicit handler.
|
|
52
|
-
* Dropped warnings have no visible symptom at the time they fire —
|
|
53
|
-
* users only discover the consequence later (e.g. being prompted to
|
|
54
|
-
* re-authenticate at the next session).
|
|
24
|
+
* Called for soft warnings (e.g. requested `offline_access` but the
|
|
25
|
+
* server returned no refresh token, or the browser failed to
|
|
26
|
+
* launch). Default prints to stderr only when stderr is a TTY.
|
|
27
|
+
* Non-TTY callers who want warning visibility should pass an
|
|
28
|
+
* explicit handler — dropped warnings have no symptom at the time
|
|
29
|
+
* they fire; users discover the consequence later.
|
|
55
30
|
*/
|
|
56
31
|
onWarning?: (message: string) => void;
|
|
57
|
-
/**
|
|
58
|
-
* Forwarded to the discovery step. Loopback hosts (`localhost` /
|
|
59
|
-
* `127.0.0.1` / `[::1]`) are always permitted over http; this flag
|
|
60
|
-
* is the opt-in for non-loopback http issuers and for non-loopback
|
|
61
|
-
* http endpoints returned by discovery. Default `false`.
|
|
62
|
-
*/
|
|
32
|
+
/** Forwarded to discovery; permits non-loopback http issuers + endpoints. */
|
|
63
33
|
allowInsecureIssuer?: boolean;
|
|
64
34
|
}
|
|
65
35
|
/**
|
package/dist/oauth/authorize.js
CHANGED
|
@@ -38,11 +38,9 @@ function defaultOnWarning(message) {
|
|
|
38
38
|
* @throws {OAuthCallbackError} For loopback/callback-server failures.
|
|
39
39
|
*/
|
|
40
40
|
async function authorize(options) {
|
|
41
|
-
const { issuerURL, clientId, scopes, timeoutMs, signal, tokenStore = new tokenStore_1.KeyringTokenStore(
|
|
42
|
-
// Discovery
|
|
43
|
-
//
|
|
44
|
-
// strictly more useful than a browser tab pointing at a
|
|
45
|
-
// wrong/unreachable URL.
|
|
41
|
+
const { issuerURL, clientId, walnutURL, scopes, timeoutMs, signal, tokenStore = new tokenStore_1.KeyringTokenStore(), openBrowser = openBrowser_1.openBrowser, onAuthorizationUrl = defaultOnAuthorizationUrl, onWarning = defaultOnWarning, allowInsecureIssuer, } = options;
|
|
42
|
+
// Discovery before browser-launch so a bad URL surfaces as a
|
|
43
|
+
// throw rather than a wrong/unreachable browser tab.
|
|
46
44
|
const config = await (0, discoverOIDC_1.discoverOIDC)(issuerURL, {
|
|
47
45
|
signal,
|
|
48
46
|
allowInsecureIssuer,
|
|
@@ -98,14 +96,19 @@ async function authorize(options) {
|
|
|
98
96
|
// came back, warn. Prefer the server's reported `grantedScope`
|
|
99
97
|
// when present (RFC 6749 §5.1) since the provider's consent
|
|
100
98
|
// screen may have dropped the scope.
|
|
101
|
-
if (scopes.includes("offline_access") &&
|
|
102
|
-
tokens.refreshToken === undefined) {
|
|
99
|
+
if (scopes.includes("offline_access") && !tokens.refreshToken) {
|
|
103
100
|
const grantedSuffix = tokens.grantedScope
|
|
104
101
|
? ` (server granted: ${tokens.grantedScope})`
|
|
105
102
|
: "";
|
|
106
103
|
onWarning(`'offline_access' was requested but no refresh_token was returned${grantedSuffix}. Cross-session refresh will not be available.`);
|
|
107
104
|
}
|
|
108
|
-
await tokenStore.save(
|
|
105
|
+
await tokenStore.save({
|
|
106
|
+
tokens,
|
|
107
|
+
issuerURL,
|
|
108
|
+
clientId,
|
|
109
|
+
allowInsecureIssuer: allowInsecureIssuer ?? false,
|
|
110
|
+
walnutURL,
|
|
111
|
+
});
|
|
109
112
|
return tokens;
|
|
110
113
|
}
|
|
111
114
|
finally {
|
|
@@ -15,36 +15,19 @@ export interface OIDCConfiguration {
|
|
|
15
15
|
export interface DiscoverOIDCOptions {
|
|
16
16
|
/** Aborts the underlying fetch when fired. */
|
|
17
17
|
signal?: AbortSignal;
|
|
18
|
-
/**
|
|
19
|
-
* Permit non-HTTPS issuer URLs whose host is not a loopback literal.
|
|
20
|
-
* Loopback hosts (`localhost`, `127.0.0.1`, `[::1]`) are always
|
|
21
|
-
* allowed over http since they cannot be intercepted remotely; this
|
|
22
|
-
* flag is for corporate dev setups or reverse-proxy scenarios where
|
|
23
|
-
* http is the only available path. Default `false`.
|
|
24
|
-
*/
|
|
18
|
+
/** Permit non-HTTPS issuer URLs whose host is not a loopback literal. Default `false`. */
|
|
25
19
|
allowInsecureIssuer?: boolean;
|
|
26
20
|
}
|
|
27
21
|
/**
|
|
28
|
-
* Fetches and parses the
|
|
29
|
-
*
|
|
30
|
-
*
|
|
22
|
+
* Fetches and parses the OIDC discovery document. Fails fast (no
|
|
23
|
+
* retry) so the caller does not open a browser against an unreachable
|
|
24
|
+
* authorization server. Verifies the server's claimed `issuer` matches
|
|
25
|
+
* the input URL per OIDC Discovery §3 — without this, a hostile
|
|
26
|
+
* discovery response could redirect the authorization and token
|
|
27
|
+
* endpoints to attacker hosts.
|
|
31
28
|
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
* itself does not perform OIDC identity validation (no id_token /
|
|
36
|
-
* nonce / signature checks); callers needing OIDC-strength identity
|
|
37
|
-
* assurance should layer that on top.
|
|
38
|
-
*
|
|
39
|
-
* Verifies that the server's claimed `issuer` matches the URL the
|
|
40
|
-
* caller passed in, per OIDC Discovery §3 / defence against a hostile
|
|
41
|
-
* discovery response redirecting `authorization_endpoint` and
|
|
42
|
-
* `token_endpoint` to attacker-controlled hosts.
|
|
43
|
-
*
|
|
44
|
-
* @param issuerURL Authorization-server URL the discovery document
|
|
45
|
-
* claims as its `issuer`. For Keycloak, callers build this as
|
|
46
|
-
* `${serverURL}/realms/${realm}`. For other providers it is the
|
|
47
|
-
* hostname (or issuer path) advertised in their discovery document.
|
|
48
|
-
* Trailing slashes tolerated.
|
|
29
|
+
* Uses the OIDC well-known path as a convention; does not perform
|
|
30
|
+
* OIDC-strength identity validation (no id_token / nonce / signature
|
|
31
|
+
* checks). Callers needing identity assurance should layer that on top.
|
|
49
32
|
*/
|
|
50
33
|
export declare function discoverOIDC(issuerURL: string, options?: DiscoverOIDCOptions): Promise<OIDCConfiguration>;
|
|
@@ -4,17 +4,12 @@ exports.discoverOIDC = discoverOIDC;
|
|
|
4
4
|
const errors_1 = require("./errors");
|
|
5
5
|
const issuerURL_1 = require("./issuerURL");
|
|
6
6
|
const predicates_1 = require("./predicates");
|
|
7
|
+
const userAgent_1 = require("../userAgent");
|
|
7
8
|
const LOOPBACK_HOSTS = new Set(["localhost", "127.0.0.1", "[::1]"]);
|
|
8
9
|
function optionalString(v) {
|
|
9
10
|
return (0, predicates_1.isNonEmptyString)(v) ? v : undefined;
|
|
10
11
|
}
|
|
11
|
-
/**
|
|
12
|
-
* Throws `DISCOVERY_FAILED` if `url` is not safe to transmit OAuth
|
|
13
|
-
* secrets over. `https:` is always fine; `http:` is only fine for
|
|
14
|
-
* loopback hosts, or for any host when `allowInsecurePermitted` is
|
|
15
|
-
* `true`. `label` describes the URL being checked ("issuer URL",
|
|
16
|
-
* "token_endpoint", etc.) and appears in the error message.
|
|
17
|
-
*/
|
|
12
|
+
/** Throws `DISCOVERY_FAILED` if `url` is not safe to transmit OAuth secrets over. */
|
|
18
13
|
function assertSecureURL(url, label, allowInsecurePermitted) {
|
|
19
14
|
let parsed;
|
|
20
15
|
try {
|
|
@@ -39,10 +34,9 @@ function assertSecureURL(url, label, allowInsecurePermitted) {
|
|
|
39
34
|
throw new errors_1.OAuthFlowError("DISCOVERY_FAILED", `Unsupported ${label} scheme '${parsed.protocol}'; expected https: or http: (loopback only).`);
|
|
40
35
|
}
|
|
41
36
|
function buildDiscoveryURL(issuerURL) {
|
|
42
|
-
//
|
|
43
|
-
//
|
|
44
|
-
//
|
|
45
|
-
// 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.
|
|
46
40
|
const normalized = new URL((0, issuerURL_1.normalizeIssuerURL)(issuerURL));
|
|
47
41
|
normalized.search = "";
|
|
48
42
|
normalized.hash = "";
|
|
@@ -70,27 +64,30 @@ function parseConfiguration(body, url) {
|
|
|
70
64
|
};
|
|
71
65
|
}
|
|
72
66
|
/**
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
*
|
|
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.
|
|
71
|
+
*/
|
|
72
|
+
function assertPKCESupport(body, url) {
|
|
73
|
+
const methods = body.code_challenge_methods_supported;
|
|
74
|
+
if (!Array.isArray(methods))
|
|
75
|
+
return;
|
|
76
|
+
if (methods.includes("S256"))
|
|
77
|
+
return;
|
|
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.`);
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
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.
|
|
88
87
|
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
* hostname (or issuer path) advertised in their discovery document.
|
|
93
|
-
* 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.
|
|
94
91
|
*/
|
|
95
92
|
async function discoverOIDC(issuerURL, options = {}) {
|
|
96
93
|
const allowInsecure = options.allowInsecureIssuer ?? false;
|
|
@@ -98,7 +95,10 @@ async function discoverOIDC(issuerURL, options = {}) {
|
|
|
98
95
|
const url = buildDiscoveryURL(issuerURL);
|
|
99
96
|
let response;
|
|
100
97
|
try {
|
|
101
|
-
response = await fetch(url, {
|
|
98
|
+
response = await fetch(url, {
|
|
99
|
+
headers: { "User-Agent": userAgent_1.USER_AGENT },
|
|
100
|
+
signal: options.signal,
|
|
101
|
+
});
|
|
102
102
|
}
|
|
103
103
|
catch (cause) {
|
|
104
104
|
throw new errors_1.OAuthFlowError("DISCOVERY_FAILED", `Could not reach the authentication server at ${url}. Check the URL and your network connection.`, { cause });
|
|
@@ -139,5 +139,6 @@ async function discoverOIDC(issuerURL, options = {}) {
|
|
|
139
139
|
if (config.endSessionEndpoint) {
|
|
140
140
|
assertSecureURL(config.endSessionEndpoint, "end_session_endpoint", allowInsecure);
|
|
141
141
|
}
|
|
142
|
+
assertPKCESupport(body, url);
|
|
142
143
|
return config;
|
|
143
144
|
}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/** Subset of `/api/sso-config` this package consumes. */
|
|
2
|
+
export interface SSOConfig {
|
|
3
|
+
/** Keycloak base URL, e.g. `https://auth.example.com`. */
|
|
4
|
+
url: string;
|
|
5
|
+
/** Keycloak realm name. */
|
|
6
|
+
realm: string;
|
|
7
|
+
/** OAuth client ID for the axe-auth CLI. */
|
|
8
|
+
mcpClientId: string;
|
|
9
|
+
}
|
|
10
|
+
/** Options for `discoverSSOConfig`. */
|
|
11
|
+
export interface DiscoverSSOConfigOptions {
|
|
12
|
+
/** Aborts the underlying fetch when fired. */
|
|
13
|
+
signal?: AbortSignal;
|
|
14
|
+
/** Permit non-HTTPS axe server URLs whose host is not a loopback literal. Default `false`. */
|
|
15
|
+
allowInsecure?: boolean;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Fetches and parses the axe server's `/api/sso-config` discovery
|
|
19
|
+
* endpoint. Used by `axe-auth login` to derive the OAuth issuer URL,
|
|
20
|
+
* realm, and CLI-specific client ID from the axe server URL the user
|
|
21
|
+
* supplied (or the SaaS prod default), so users no longer have to know
|
|
22
|
+
* the underlying Keycloak coordinates.
|
|
23
|
+
*
|
|
24
|
+
* Distinguishes three failure shapes for the operator-relevant cases:
|
|
25
|
+
*
|
|
26
|
+
* - `mcpClientId` field absent: the axe server deployment predates the
|
|
27
|
+
* field entirely. Surfaces as "needs upgrading".
|
|
28
|
+
* - `mcpClientId` is `null`: the axe server version supports the field
|
|
29
|
+
* but the operator has not configured `KEYCLOAK_MCP_PUBLIC_CLIENT_ID`.
|
|
30
|
+
* Surfaces as "ask the operator to configure".
|
|
31
|
+
* - any non-empty string: returned as-is.
|
|
32
|
+
*
|
|
33
|
+
* Other failure modes (unreachable, non-2xx, malformed JSON, missing
|
|
34
|
+
* `url` / `realm`) all map to `DISCOVERY_FAILED` with a descriptive
|
|
35
|
+
* message. The caller is expected to surface these errors verbatim.
|
|
36
|
+
*/
|
|
37
|
+
export declare function discoverSSOConfig(serverURL: string, options?: DiscoverSSOConfigOptions): Promise<SSOConfig>;
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.discoverSSOConfig = discoverSSOConfig;
|
|
4
|
+
const errors_1 = require("./errors");
|
|
5
|
+
const predicates_1 = require("./predicates");
|
|
6
|
+
const userAgent_1 = require("../userAgent");
|
|
7
|
+
const LOOPBACK_HOSTS = new Set(["localhost", "127.0.0.1", "[::1]"]);
|
|
8
|
+
function assertSecureServerURL(serverURL, allowInsecure) {
|
|
9
|
+
let parsed;
|
|
10
|
+
try {
|
|
11
|
+
parsed = new URL(serverURL);
|
|
12
|
+
}
|
|
13
|
+
catch {
|
|
14
|
+
throw new errors_1.OAuthFlowError("DISCOVERY_FAILED", `axe server URL is not a valid URL: ${serverURL}`);
|
|
15
|
+
}
|
|
16
|
+
if (parsed.protocol === "https:")
|
|
17
|
+
return parsed;
|
|
18
|
+
if (parsed.protocol === "http:") {
|
|
19
|
+
const hostname = parsed.host.toLowerCase().replace(/:\d+$/, "");
|
|
20
|
+
if (LOOPBACK_HOSTS.has(hostname))
|
|
21
|
+
return parsed;
|
|
22
|
+
if (allowInsecure)
|
|
23
|
+
return parsed;
|
|
24
|
+
throw new errors_1.OAuthFlowError("DISCOVERY_FAILED", `Refusing to use axe server URL over http:// against non-loopback host ${parsed.host}. Use https:// or pass --allow-insecure-issuer to override (only do this on trusted networks).`);
|
|
25
|
+
}
|
|
26
|
+
throw new errors_1.OAuthFlowError("DISCOVERY_FAILED", `Unsupported axe server URL scheme '${parsed.protocol}'; expected https: or http: (loopback only).`);
|
|
27
|
+
}
|
|
28
|
+
function buildSSOConfigURL(parsed) {
|
|
29
|
+
const copy = new URL(parsed.toString());
|
|
30
|
+
copy.search = "";
|
|
31
|
+
copy.hash = "";
|
|
32
|
+
copy.pathname = `${copy.pathname.replace(/\/+$/, "")}/api/sso-config`;
|
|
33
|
+
return copy.toString();
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Fetches and parses the axe server's `/api/sso-config` discovery
|
|
37
|
+
* endpoint. Used by `axe-auth login` to derive the OAuth issuer URL,
|
|
38
|
+
* realm, and CLI-specific client ID from the axe server URL the user
|
|
39
|
+
* supplied (or the SaaS prod default), so users no longer have to know
|
|
40
|
+
* the underlying Keycloak coordinates.
|
|
41
|
+
*
|
|
42
|
+
* Distinguishes three failure shapes for the operator-relevant cases:
|
|
43
|
+
*
|
|
44
|
+
* - `mcpClientId` field absent: the axe server deployment predates the
|
|
45
|
+
* field entirely. Surfaces as "needs upgrading".
|
|
46
|
+
* - `mcpClientId` is `null`: the axe server version supports the field
|
|
47
|
+
* but the operator has not configured `KEYCLOAK_MCP_PUBLIC_CLIENT_ID`.
|
|
48
|
+
* Surfaces as "ask the operator to configure".
|
|
49
|
+
* - any non-empty string: returned as-is.
|
|
50
|
+
*
|
|
51
|
+
* Other failure modes (unreachable, non-2xx, malformed JSON, missing
|
|
52
|
+
* `url` / `realm`) all map to `DISCOVERY_FAILED` with a descriptive
|
|
53
|
+
* message. The caller is expected to surface these errors verbatim.
|
|
54
|
+
*/
|
|
55
|
+
async function discoverSSOConfig(serverURL, options = {}) {
|
|
56
|
+
const allowInsecure = options.allowInsecure ?? false;
|
|
57
|
+
const parsed = assertSecureServerURL(serverURL, allowInsecure);
|
|
58
|
+
const url = buildSSOConfigURL(parsed);
|
|
59
|
+
let response;
|
|
60
|
+
try {
|
|
61
|
+
response = await fetch(url, {
|
|
62
|
+
headers: { "User-Agent": userAgent_1.USER_AGENT },
|
|
63
|
+
signal: options.signal,
|
|
64
|
+
});
|
|
65
|
+
}
|
|
66
|
+
catch (cause) {
|
|
67
|
+
throw new errors_1.OAuthFlowError("DISCOVERY_FAILED", `Could not reach the axe server at ${url}. Check the --server URL and your network connection.`, { cause });
|
|
68
|
+
}
|
|
69
|
+
if (!response.ok) {
|
|
70
|
+
throw new errors_1.OAuthFlowError("DISCOVERY_FAILED", `axe server at ${url} responded with HTTP ${response.status}. Check the --server URL.`);
|
|
71
|
+
}
|
|
72
|
+
let body;
|
|
73
|
+
try {
|
|
74
|
+
body = await response.json();
|
|
75
|
+
}
|
|
76
|
+
catch (cause) {
|
|
77
|
+
throw new errors_1.OAuthFlowError("DISCOVERY_FAILED", `axe server at ${url} did not return valid JSON.`, { cause });
|
|
78
|
+
}
|
|
79
|
+
if (body === null || typeof body !== "object" || Array.isArray(body)) {
|
|
80
|
+
throw new errors_1.OAuthFlowError("DISCOVERY_FAILED", `axe server at ${url} returned a non-object response body.`);
|
|
81
|
+
}
|
|
82
|
+
const raw = body;
|
|
83
|
+
const missing = [];
|
|
84
|
+
if (!(0, predicates_1.isNonEmptyString)(raw.url))
|
|
85
|
+
missing.push("url");
|
|
86
|
+
if (!(0, predicates_1.isNonEmptyString)(raw.realm))
|
|
87
|
+
missing.push("realm");
|
|
88
|
+
if (missing.length > 0) {
|
|
89
|
+
throw new errors_1.OAuthFlowError("DISCOVERY_FAILED", `${url} is missing required field(s): ${missing.join(", ")}`);
|
|
90
|
+
}
|
|
91
|
+
if (!("mcpClientId" in raw)) {
|
|
92
|
+
throw new errors_1.OAuthFlowError("DISCOVERY_FAILED", `axe server at ${serverURL} does not advertise OAuth-based MCP authentication. The deployment may need to be upgraded to a version that supports the axe-auth CLI.`);
|
|
93
|
+
}
|
|
94
|
+
if (raw.mcpClientId === null) {
|
|
95
|
+
throw new errors_1.OAuthFlowError("DISCOVERY_FAILED", `axe server at ${serverURL} has not been configured for OAuth-based MCP authentication. Ask your operator to set the KEYCLOAK_MCP_PUBLIC_CLIENT_ID environment variable on the axe server.`);
|
|
96
|
+
}
|
|
97
|
+
if (!(0, predicates_1.isNonEmptyString)(raw.mcpClientId)) {
|
|
98
|
+
throw new errors_1.OAuthFlowError("DISCOVERY_FAILED", `axe server at ${serverURL} returned a malformed mcpClientId (expected a non-empty string).`);
|
|
99
|
+
}
|
|
100
|
+
return {
|
|
101
|
+
url: raw.url,
|
|
102
|
+
realm: raw.realm,
|
|
103
|
+
mcpClientId: raw.mcpClientId,
|
|
104
|
+
};
|
|
105
|
+
}
|
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,41 +1,25 @@
|
|
|
1
|
-
import { type TokenStore } from "./tokenStore";
|
|
1
|
+
import { type LoadResult, type TokenStore } from "./tokenStore";
|
|
2
2
|
/** Options for `getValidAccessToken`. */
|
|
3
3
|
export interface GetValidAccessTokenOptions {
|
|
4
|
-
/** OIDC issuer URL
|
|
4
|
+
/** OIDC issuer URL. Must match the stored entry's `issuerURL`; mismatch throws NOT_AUTHENTICATED. */
|
|
5
5
|
issuerURL: string;
|
|
6
|
-
/** OAuth client identifier. */
|
|
6
|
+
/** OAuth client identifier. Must match the stored entry's `clientId`; same mismatch behavior as `issuerURL`. */
|
|
7
7
|
clientId: string;
|
|
8
8
|
/**
|
|
9
|
-
* How close to expiry
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
* expiry (which may differ by a few seconds of clock skew) and
|
|
13
|
-
* prevents a token from expiring mid-request after we hand it out.
|
|
14
|
-
*
|
|
15
|
-
* Assumes the access-token TTL is much larger than the buffer. With
|
|
16
|
-
* 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.
|
|
17
12
|
*/
|
|
18
13
|
expiryBufferMs?: number;
|
|
19
|
-
/**
|
|
20
|
-
* Override for the token store. Defaults to `KeyringTokenStore`
|
|
21
|
-
* keyed by `issuerURL`.
|
|
22
|
-
*/
|
|
14
|
+
/** Override for the token store. */
|
|
23
15
|
tokenStore?: TokenStore;
|
|
16
|
+
/** Pre-loaded `tokenStore.load()` result so the dispatcher's keychain read isn't repeated. */
|
|
17
|
+
loadedEntry?: LoadResult;
|
|
24
18
|
/** Aborts discovery + the refresh POST when fired. */
|
|
25
19
|
signal?: AbortSignal;
|
|
26
|
-
/**
|
|
27
|
-
* Forwarded to discovery. Loopback issuers are always permitted
|
|
28
|
-
* over http; this flag is the opt-in for non-loopback http.
|
|
29
|
-
*/
|
|
20
|
+
/** Forwarded to discovery; permits non-loopback http. */
|
|
30
21
|
allowInsecureIssuer?: boolean;
|
|
31
|
-
/**
|
|
32
|
-
* Called for soft warnings that are not errors but warrant user
|
|
33
|
-
* attention (e.g. a fresh `TokenSet` could not be written to the
|
|
34
|
-
* keychain, stranding the rotated refresh token — see the hazard
|
|
35
|
-
* note in the body of `getValidAccessToken`). The default prints
|
|
36
|
-
* to stderr only when stderr is a TTY. Pass a custom handler to
|
|
37
|
-
* route warnings through your own UI, or `() => {}` to suppress.
|
|
38
|
-
*/
|
|
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. */
|
|
39
23
|
onWarning?: (message: string) => void;
|
|
40
24
|
/** Source of `now`. Defaults to `Date.now`. Injected for test determinism. */
|
|
41
25
|
now?: () => number;
|
|
@@ -47,24 +47,30 @@ function notAuthenticated(message, cause) {
|
|
|
47
47
|
* keyed by issuer.
|
|
48
48
|
*/
|
|
49
49
|
async function getValidAccessToken(options) {
|
|
50
|
-
const { issuerURL, clientId, expiryBufferMs = DEFAULT_EXPIRY_BUFFER_MS, tokenStore = new tokenStore_1.KeyringTokenStore(
|
|
51
|
-
const loaded = await tokenStore.load();
|
|
50
|
+
const { issuerURL, clientId, expiryBufferMs = DEFAULT_EXPIRY_BUFFER_MS, tokenStore = new tokenStore_1.KeyringTokenStore(), loadedEntry, signal, allowInsecureIssuer, onWarning = defaultOnWarning, now = Date.now, } = options;
|
|
51
|
+
const loaded = loadedEntry ?? (await tokenStore.load());
|
|
52
52
|
if (!loaded.ok) {
|
|
53
53
|
switch (loaded.reason) {
|
|
54
54
|
case "empty":
|
|
55
|
-
throw notAuthenticated(
|
|
55
|
+
throw notAuthenticated("No stored credentials. Run `axe-auth login` first.");
|
|
56
56
|
case "corrupt":
|
|
57
57
|
throw notAuthenticated("Stored credentials are unreadable. Run `axe-auth login` to re-authenticate.");
|
|
58
58
|
case "version-mismatch":
|
|
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
|
-
|
|
62
|
+
// Refuse on issuer/client mismatch: refreshing tokens at a
|
|
63
|
+
// different endpoint would leak the refresh token to the wrong
|
|
64
|
+
// server.
|
|
65
|
+
if (loaded.entry.issuerURL !== issuerURL ||
|
|
66
|
+
loaded.entry.clientId !== clientId) {
|
|
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.`);
|
|
68
|
+
}
|
|
69
|
+
const tokens = loaded.entry.tokens;
|
|
63
70
|
if (now() + expiryBufferMs < tokens.expiresAt) {
|
|
64
|
-
// Still fresh — no network call, no store write.
|
|
65
71
|
return tokens.accessToken;
|
|
66
72
|
}
|
|
67
|
-
if (tokens.refreshToken
|
|
73
|
+
if (!tokens.refreshToken) {
|
|
68
74
|
throw notAuthenticated("Access token has expired and no refresh token is available. Run `axe-auth login` to re-authenticate.");
|
|
69
75
|
}
|
|
70
76
|
const config = await (0, discoverOIDC_1.discoverOIDC)(issuerURL, {
|
|
@@ -83,13 +89,10 @@ async function getValidAccessToken(options) {
|
|
|
83
89
|
}
|
|
84
90
|
catch (err) {
|
|
85
91
|
if (isInvalidGrant(err)) {
|
|
86
|
-
//
|
|
87
|
-
//
|
|
88
|
-
//
|
|
89
|
-
//
|
|
90
|
-
// the actionable "please run login" signal. Note the clear
|
|
91
|
-
// failure via onWarning; the next run will see the stale
|
|
92
|
-
// 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.
|
|
93
96
|
try {
|
|
94
97
|
await tokenStore.clear();
|
|
95
98
|
}
|
|
@@ -113,7 +116,13 @@ async function getValidAccessToken(options) {
|
|
|
113
116
|
// useful, and warn the caller so "why does the next run need me to
|
|
114
117
|
// log in again?" has a breadcrumb.
|
|
115
118
|
try {
|
|
116
|
-
await tokenStore.save(
|
|
119
|
+
await tokenStore.save({
|
|
120
|
+
tokens: fresh,
|
|
121
|
+
issuerURL: loaded.entry.issuerURL,
|
|
122
|
+
clientId: loaded.entry.clientId,
|
|
123
|
+
allowInsecureIssuer: loaded.entry.allowInsecureIssuer,
|
|
124
|
+
walnutURL: loaded.entry.walnutURL,
|
|
125
|
+
});
|
|
117
126
|
}
|
|
118
127
|
catch (err) {
|
|
119
128
|
onWarning(`Refreshed tokens could not be saved: ${err instanceof Error ? err.message : String(err)}. The current call will succeed, but the next invocation will require re-authentication.`);
|
package/dist/oauth/index.d.ts
CHANGED
|
@@ -10,6 +10,7 @@ export { refreshTokens } from "./refreshTokens";
|
|
|
10
10
|
export type { RefreshTokensOptions } from "./refreshTokens";
|
|
11
11
|
export type { TokenSet } from "./tokenResponse";
|
|
12
12
|
export { KeyringTokenStore, STORED_BLOB_VERSION } from "./tokenStore";
|
|
13
|
-
export type {
|
|
13
|
+
export type { LoadResult, StoredEntry, TokenStore } from "./tokenStore";
|
|
14
|
+
export type { KeyringEntry, KeyringEntryFactory } from "./keyringBinding";
|
|
14
15
|
export { discoverOIDC } from "./discoverOIDC";
|
|
15
16
|
export type { OIDCConfiguration, DiscoverOIDCOptions } from "./discoverOIDC";
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/** Minimal keyring-entry surface consumed by the package's stores. */
|
|
2
|
+
export interface KeyringEntry {
|
|
3
|
+
/** Writes the password for this entry. */
|
|
4
|
+
setPassword(password: string): void;
|
|
5
|
+
/** Reads the current password, or returns `null` if none is set. */
|
|
6
|
+
getPassword(): string | null;
|
|
7
|
+
/** Deletes the password and returns `true` if one existed. */
|
|
8
|
+
deletePassword(): boolean;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* Factory for `KeyringEntry` values. Injection seam for tests;
|
|
12
|
+
* production callers use the default that constructs
|
|
13
|
+
* `@napi-rs/keyring` entries lazily.
|
|
14
|
+
*/
|
|
15
|
+
export type KeyringEntryFactory = (service: string, account: string) => KeyringEntry;
|
|
16
|
+
/**
|
|
17
|
+
* Default `KeyringEntryFactory`. Resolves `@napi-rs/keyring` lazily
|
|
18
|
+
* so platforms without a prebuilt binding only see a
|
|
19
|
+
* `KEYRING_UNAVAILABLE` on first store construction, not on module
|
|
20
|
+
* import.
|
|
21
|
+
*/
|
|
22
|
+
export declare const defaultEntryFactory: KeyringEntryFactory;
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.defaultEntryFactory = void 0;
|
|
4
|
+
const node_module_1 = require("node:module");
|
|
5
|
+
const errors_1 = require("./errors");
|
|
6
|
+
const requireFromHere = (0, node_module_1.createRequire)(__filename);
|
|
7
|
+
// Lazy-resolved Entry constructor. Importing @napi-rs/keyring at the
|
|
8
|
+
// top of this module would run its native binding loader at
|
|
9
|
+
// module-load time, throwing before any of our OAuthFlowError code
|
|
10
|
+
// catches it and preventing the module from being imported at all on
|
|
11
|
+
// platforms without a prebuilt. We defer the require into
|
|
12
|
+
// `defaultEntryFactory`, which turns that import-time failure into a
|
|
13
|
+
// `KEYRING_UNAVAILABLE` surfaced on the first store construction —
|
|
14
|
+
// not on first save/load/clear, since callers construct stores
|
|
15
|
+
// eagerly as default-arg expressions. Runtime keychain errors
|
|
16
|
+
// (missing D-Bus Secret Service, macOS Keychain denial, etc.) are a
|
|
17
|
+
// separate concern and surface later, inside save/load/clear.
|
|
18
|
+
let cachedEntryCtor = null;
|
|
19
|
+
function resolveEntryCtor() {
|
|
20
|
+
if (cachedEntryCtor)
|
|
21
|
+
return cachedEntryCtor;
|
|
22
|
+
try {
|
|
23
|
+
const mod = requireFromHere("@napi-rs/keyring");
|
|
24
|
+
cachedEntryCtor = mod.Entry;
|
|
25
|
+
return cachedEntryCtor;
|
|
26
|
+
}
|
|
27
|
+
catch (cause) {
|
|
28
|
+
throw new errors_1.OAuthFlowError("KEYRING_UNAVAILABLE", `Could not load @napi-rs/keyring. A prebuilt native binding for this platform may be missing.`, { cause });
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Default `KeyringEntryFactory`. Resolves `@napi-rs/keyring` lazily
|
|
33
|
+
* so platforms without a prebuilt binding only see a
|
|
34
|
+
* `KEYRING_UNAVAILABLE` on first store construction, not on module
|
|
35
|
+
* import.
|
|
36
|
+
*/
|
|
37
|
+
const defaultEntryFactory = (service, account) => {
|
|
38
|
+
const Ctor = resolveEntryCtor();
|
|
39
|
+
return new Ctor(service, account);
|
|
40
|
+
};
|
|
41
|
+
exports.defaultEntryFactory = defaultEntryFactory;
|