// ---------------------------------------------------------------------------// OAuth 2.0 helpers — generic, isomorphic building blocks.//// Thin wrappers around `oauth4webapi` (stateless; pure Web Crypto +// `fetch`, no deps; runs unchanged in Node, CF Workers, and browsers).// Each public helper is a single `Effect.tryPromise` call that delegates// the RFC work to the library and normalises the failure surface into// `OAuth2Error`.//// What stays hand-rolled:// - `OAuth2Error` — our tagged error; we want a stable shape across// every token-endpoint call// - `shouldRefreshToken` — skew check, trivial// - `buildAuthorizationUrl` — the library doesn't expose a raw// authorization-URL builder (it prefers PAR); a 30-line manual// construction keeps the call sync and lets callers opt out of PAR// --------------------------------------------------------------------------- import { Data, Effect, Option, Predicate, Schema } from "effect";import * as oauth from "oauth4webapi"; // ---------------------------------------------------------------------------// Errors// --------------------------------------------------------------------------- export class OAuth2Error extends Data.TaggedError("OAuth2Error")<{ readonly message: string; /** * RFC 6749 §5.2 error code, when the token endpoint returned one * (`invalid_grant`, `invalid_client`, `unauthorized_client`, ...). * Callers use this to distinguish terminal failures (a refresh token * the AS no longer honours → re-auth required) from transient ones. */ readonly error?: string; readonly cause?: unknown;}> {} // ---------------------------------------------------------------------------// Token response shape (RFC 6749 §5.1)// --------------------------------------------------------------------------- export type OAuth2TokenResponse = { readonly access_token: string; readonly token_type?: string; readonly refresh_token?: string; readonly expires_in?: number; readonly scope?: string; readonly idTokenIdentityLabel?: string;}; // ---------------------------------------------------------------------------// Constants// --------------------------------------------------------------------------- /** Refresh tokens this many ms before expiry to avoid mid-request expiration. */export const OAUTH2_REFRESH_SKEW_MS = 60_000; /** Default token-endpoint timeout. */export const OAUTH2_DEFAULT_TIMEOUT_MS = 20_000; export interface OAuthEndpointUrlPolicy { readonly allowHttp?: boolean;} export const isLoopbackHttpUrl = (value: string): boolean => { if (!URL.canParse(value)) return false; const url = new URL(value); if (url.protocol !== "http:") return false; const hostname = url.hostname.toLowerCase(); return ( hostname === "localhost" || hostname === "0.0.0.0" || hostname === "::1" || hostname === "[::1]" || hostname.startsWith("127.") );}; export const isSupportedOAuthEndpointUrl = ( value: string, policy: OAuthEndpointUrlPolicy = {},): boolean => { if (!URL.canParse(value)) return false; const url = new URL(value); return ( url.protocol === "https:" || isLoopbackHttpUrl(value) || (url.protocol === "http:" && policy.allowHttp === true) );}; export const assertSupportedOAuthEndpointUrl = ( value: string, label = "OAuth endpoint URL", policy: OAuthEndpointUrlPolicy = {},): string => { if (isSupportedOAuthEndpointUrl(value, policy)) return value; // oxlint-disable-next-line executor/no-try-catch-or-throw, executor/no-error-constructor -- boundary: synchronous assertion helper used by URL constructors and Effect.try wrappers throw new TypeError(`${label} must use https: or loopback http:`);}; // ---------------------------------------------------------------------------// PKCE (RFC 7636) — straight delegation to `oauth4webapi`// --------------------------------------------------------------------------- export const createPkceCodeVerifier = (): string => oauth.generateRandomCodeVerifier(); export const createPkceCodeChallenge = (verifier: string): Promise<string> => oauth.calculatePKCECodeChallenge(verifier); /** RFC 6749 `state` — an unguessable correlation token minted by `oauth.start` * and redeemed by `oauth.complete`. */export const createOAuthState = (): string => oauth.generateRandomState(); // ---------------------------------------------------------------------------// Authorization URL builder// --------------------------------------------------------------------------- export type BuildAuthorizationUrlInput = { readonly authorizationUrl: string; readonly clientId: string; readonly redirectUrl: string; readonly scopes: readonly string[]; readonly state: string; /** Pre-computed base64url S256 challenge (from `createPkceCodeChallenge`). */ readonly codeChallenge: string; /** Separator between scopes. RFC 6749 says space; some providers use comma. */ readonly scopeSeparator?: string; /** RFC 8707 Resource Indicator. MCP Authorization 2025-06-18 §"Resource * Parameter Implementation" requires clients to send this on every * authorization request, regardless of AS support. */ readonly resource?: string; /** Provider-specific extras (e.g. Google's `access_type=offline`). */ readonly extraParams?: Readonly<Record<string, string>>; readonly endpointUrlPolicy?: OAuthEndpointUrlPolicy;}; /** Build an RFC 6749 §4.1.1 authorization URL. Sync; pre-computed * challenge lets this stay out of the Promise world. */export const buildAuthorizationUrl = (input: BuildAuthorizationUrlInput): string => { const url = new URL( assertSupportedOAuthEndpointUrl( input.authorizationUrl, "Authorization URL", input.endpointUrlPolicy, ), ); // Benign default kept by design: a single space is the RFC 6749 scope // separator. Callers targeting a legacy comma-separated provider pass // `scopeSeparator` explicitly (see the field's JSDoc). const separator = input.scopeSeparator ?? " "; url.searchParams.set("client_id", input.clientId); url.searchParams.set("redirect_uri", input.redirectUrl); url.searchParams.set("response_type", "code"); if (input.scopes.length > 0) { url.searchParams.set("scope", input.scopes.join(separator)); } url.searchParams.set("state", input.state); url.searchParams.set("code_challenge_method", "S256"); url.searchParams.set("code_challenge", input.codeChallenge); if (input.resource) { url.searchParams.set("resource", input.resource); } if (input.extraParams) { for (const [k, v] of Object.entries(input.extraParams)) { url.searchParams.set(k, v); } } return url.toString();}; /** Provider-specific authorize-URL extras that are NOT RFC 6749 params, so the * generic flow must add them per-provider (keyed off the authorization host). * * Google: `access_type=offline` + `prompt=consent` are required to receive (and * keep receiving, across reconnects / scope changes) a REFRESH TOKEN — without * them Google issues an access-token-only grant that dies in ~1h and a * re-consent can silently keep the old scope set. Do not add * `include_granted_scopes=true` here: with historical grants on the same Google * consent app, Google folds those unrelated scopes into the new consent flow and * can fail inside accounts.google.com before returning to our callback. */export const providerAuthorizeExtras = ( authorizationUrl: string,): Readonly<Record<string, string>> => { // oxlint-disable-next-line executor/no-try-catch-or-throw -- boundary: URL() throws on invalid input → no provider extras try { const host = new URL(authorizationUrl).host.toLowerCase(); if (host === "accounts.google.com") { return { access_type: "offline", prompt: "consent" }; } } catch { // Unparseable authorization URL — let buildAuthorizationUrl surface the error. } return {};}; // ---------------------------------------------------------------------------// Regional token-endpoint rebind//// Some authorization servers publish a single static metadata document that// advertises one region's token endpoint, but issue authorization codes that// are only redeemable at the *regional* host the user's org actually lives on.// The region comes back on the callback as a non-standard `domain` (or `site`)// query param: Datadog returns `domain=us5.datadoghq.com` while its metadata// statically advertises `app.datadoghq.com`. Redeeming the code at the// advertised host then fails with `invalid_grant`.//// `rebindTokenEndpointHostToCallbackDomain` swaps ONLY the hostname of the// configured token URL to the callback-supplied host, and ONLY when that host// is a sibling subdomain of the configured one (same parent after stripping the// leftmost DNS label, e.g. `app.datadoghq.com` and `us5.datadoghq.com` both// reduce to `datadoghq.com`). The token request carries the client secret, the// code, and the PKCE verifier, so an attacker-influenced `domain` must never be// able to point it at an arbitrary origin. Anything that fails the sibling// check, fails to parse, or isn't https falls back to the configured URL// unchanged.// --------------------------------------------------------------------------- const hostnameFromCallbackDomain = (callbackDomain: string): string | undefined => { const trimmed = callbackDomain.trim(); if (trimmed.length === 0) return undefined; // Datadog sends `domain` as a bare host and `site` as a full origin; accept // either by tolerating an optional scheme, then taking only the hostname. const candidate = trimmed.includes("://") ? trimmed : `https://${trimmed}`; if (!URL.canParse(candidate)) return undefined; const url = new URL(candidate); // A legitimate regional host carries no port, credentials, or path. if (url.port !== "" || url.username !== "" || url.password !== "") return undefined; if (url.pathname !== "/" && url.pathname !== "") return undefined; return url.hostname.toLowerCase();}; /** Parent domain after stripping the leftmost DNS label, or `undefined` when * the host has no sibling space (a single label, or a parent that is a bare * TLD). `app.datadoghq.com` -> `datadoghq.com`; `foo.com` -> undefined. */const siblingParentDomainOf = (hostname: string): string | undefined => { const labels = hostname.split("."); if (labels.length < 3) return undefined; const parent = labels.slice(1).join("."); // Require the parent to itself be multi-label so a 2-label configured host // can never rebind across an entire TLD (e.g. foo.com -> bar.com). return parent.includes(".") ? parent : undefined;}; export const rebindTokenEndpointHostToCallbackDomain = ( configuredTokenUrl: string, callbackDomain: string | null | undefined,): string => { if (!callbackDomain) return configuredTokenUrl; if (!URL.canParse(configuredTokenUrl)) return configuredTokenUrl; const configured = new URL(configuredTokenUrl); if (configured.protocol !== "https:") return configuredTokenUrl; const targetHost = hostnameFromCallbackDomain(callbackDomain); if (!targetHost) return configuredTokenUrl; const configuredHost = configured.hostname.toLowerCase(); if (targetHost === configuredHost) return configuredTokenUrl; const configuredParent = siblingParentDomainOf(configuredHost); const targetParent = siblingParentDomainOf(targetHost); if (!configuredParent || !targetParent || configuredParent !== targetParent) { return configuredTokenUrl; } const rebound = new URL(configuredTokenUrl); rebound.hostname = targetHost; return rebound.toString();}; // ---------------------------------------------------------------------------// Error mapping — `oauth4webapi`'s `process*Response` failure shapes are// either a WWW-Authenticate challenge or an RFC 6749 §5.2 error body,// both exposed via `.error` / `.error_description`. Probing the envelope// preserves RFC 6749 error-code semantics (e.g., mapping `invalid_grant`// to reauth-required) across wrappers.// --------------------------------------------------------------------------- const isOAuth2Error = Predicate.isTagged("OAuth2Error") as (cause: unknown) => cause is OAuth2Error; const responseFromOAuthErrorCause = (cause: unknown): Response | undefined => { if (cause instanceof Response) return cause; if (typeof cause !== "object" || cause === null) return undefined; const envelope = cause as { readonly cause?: unknown; readonly response?: unknown; }; if (envelope.response instanceof Response) return envelope.response; if (envelope.cause instanceof Response) return envelope.cause; return undefined;}; const redactTokenEndpointBody = (body: string): string => body .replaceAll( /("(?:access_token|refresh_token|id_token|client_secret)"\s*:\s*")[^"]*(")/gi, "$1[redacted]$2", ) .replaceAll( /((?:access_token|refresh_token|id_token|client_secret|code)=)[^&\s]*/gi, "$1[redacted]", ); const tokenEndpointHttpSummary = async (response: Response): Promise<string> => { const status = `HTTP ${response.status}${response.statusText ? ` ${response.statusText}` : ""}`; const contentType = response.headers.get("content-type"); const url = response.url ? ` from ${response.url}` : ""; const parts = [`${status}${url}`]; if (contentType) parts.push(`content-type ${contentType}`); const preview = await bodyPreviewFromResponse(response); if (preview) parts.push(`body: ${preview}`); return parts.join("; ");}; const bodyPreviewFromResponse = async (response: Response): Promise<string | undefined> => { const text = await Promise.resolve() .then(() => response.clone().text()) .then( (value) => value.trim(), () => "", ); if (!text) return undefined; const redacted = redactTokenEndpointBody(text.replaceAll(/\s+/g, " ")); return redacted.length > 500 ? `${redacted.slice(0, 500)}...` : redacted;}; // RFC 6749 §5.2's closed set. Only these are ever recovered from a// non-conform body: a free-text match against an open set would let an// arbitrary error message masquerade as an AS verdict.const RFC6749_TOKEN_ERROR_CODES = [ "invalid_request", "invalid_client", "invalid_grant", "unauthorized_client", "unsupported_grant_type", "invalid_scope",] as const; const rfc6749CodeFromCandidate = (candidate: unknown): string | undefined => { if (typeof candidate !== "string") return undefined; const trimmed = candidate.trim(); return RFC6749_TOKEN_ERROR_CODES.find( (code) => trimmed === code || trimmed.startsWith(`${code} `) || trimmed.startsWith(`${code}:`), );}; /** Recover the AS's §5.2 verdict from an error body oauth4webapi refused to * parse. Some ASes wrap the code in a non-conform envelope — Datadog answers * refresh grants with `{"errors": ["invalid_grant - Invalid or expired * refresh token or code verifier."]}` — and without this probe a definitive * `invalid_grant` (dead refresh token, reconnect required) is classified as * a transient failure and retried forever instead of surfacing a re-auth. */const oauthErrorCodeFromNonConformBody = (text: string): string | undefined => { const parsed: unknown = (() => { // oxlint-disable-next-line executor/no-try-catch-or-throw -- boundary: probing an untrusted upstream body that already failed spec parsing; a parse failure just means "no recoverable code" try { // oxlint-disable-next-line executor/no-json-parse -- boundary: same untrusted-body probe; the value is only structurally inspected against the closed §5.2 code set, never decoded into domain types return JSON.parse(text) as unknown; } catch { return undefined; } })(); if (typeof parsed !== "object" || parsed === null) return undefined; const envelope = parsed as { readonly error?: unknown; readonly errors?: unknown }; const direct = rfc6749CodeFromCandidate(envelope.error); if (direct) return direct; if (Array.isArray(envelope.errors)) { for (const entry of envelope.errors) { const code = rfc6749CodeFromCandidate(entry); if (code) return code; } } return undefined;}; const toOAuth2Error = (cause: unknown): OAuth2Error => { if (isOAuth2Error(cause)) return cause; if (typeof cause === "object" && cause !== null) { const c = cause as { error?: unknown; error_description?: unknown; message?: unknown; }; const code = typeof c.error === "string" ? c.error : undefined; const description = typeof c.error_description === "string" ? c.error_description : typeof c.message === "string" ? c.message : undefined; return new OAuth2Error({ message: `OAuth token exchange failed: ${description ?? code ?? "unknown error"}`, error: code, cause, }); } return new OAuth2Error({ message: "OAuth token exchange failed", cause, });}; const toOAuth2ErrorWithHttpSummary = (cause: unknown): Effect.Effect<OAuth2Error> => { if (isOAuth2Error(cause)) return Effect.succeed(cause); const base = toOAuth2Error(cause); const response = responseFromOAuthErrorCause(cause); if (!response) return Effect.succeed(base); return Effect.promise(async () => { const summary = await tokenEndpointHttpSummary(response); // A 4xx the spec parser refused may still carry the AS's verdict in a // non-conform envelope; recover it so classification (invalid_grant → // reauth-required) sees the code instead of a code-less "transient". const recovered = base.error === undefined && response.status >= 400 && response.status < 500 ? oauthErrorCodeFromNonConformBody( await Promise.resolve() .then(() => response.clone().text()) .then( (value) => value, () => "", ), ) : undefined; return new OAuth2Error({ message: `${base.message} (${summary})`, error: base.error ?? recovered, cause, }); });}; const failOAuth2WithHttpSummary = (cause: unknown): Effect.Effect<never, OAuth2Error> => toOAuth2ErrorWithHttpSummary(cause).pipe(Effect.flatMap((error) => Effect.fail(error))); /** Trace one token-endpoint round trip. This is the ONLY place a token request * can be observed: oauth4webapi drives the raw global `fetch`, not Effect's * HttpClient, so no `http.client` span exists underneath — without this span * the AS's latency and refusal rate are invisible. * * Attribute discipline: hostname (never the full URL — some providers carry * tenant ids in the path), the grant literal, the auth method, and on failure * the AS's RFC 6749 §5.2 code. Never the OAuth2Error message (it embeds the * response URL and a body preview), never token or code material. */const withTokenRequestSpan = (input: { readonly grantType: "authorization_code" | "client_credentials" | "refresh_token"; readonly tokenUrl: string; readonly clientAuth: ClientAuthMethod | undefined; readonly hasResource: boolean; }) => <A>(effect: Effect.Effect<A, OAuth2Error>): Effect.Effect<A, OAuth2Error> => effect.pipe( Effect.tapError((error) => Effect.annotateCurrentSpan({ ...(error.error !== undefined ? { "executor.oauth.error_code": error.error } : {}), }), ), Effect.withSpan("executor.oauth.token_request", { attributes: { "executor.oauth.grant_type": input.grantType, "executor.oauth.token_host": hostnameForTelemetry(input.tokenUrl), "executor.oauth.client_auth": input.clientAuth ?? DEFAULT_CLIENT_AUTH_METHOD, "executor.oauth.has_resource": input.hasResource, }, }), ); /** The hostname alone — a malformed URL yields "invalid" rather than leaking * whatever string failed to parse. */const hostnameForTelemetry = (url: string): string => URL.parse(url)?.hostname ?? "invalid"; // ---------------------------------------------------------------------------// oauth4webapi adapter helpers// --------------------------------------------------------------------------- export type ClientAuthMethod = "body" | "basic"; /** * The token-endpoint client-auth transport used when a caller doesn't specify * one. `"body"` is `client_secret_post` (the secret in the form body) — the * method our DCR registers (`token_endpoint_auth_method: client_secret_post`) * and the one every confidential client in the v2 model uses. EXPLICIT and * documented rather than a hidden inline `?? "body"`: callers that need * `client_secret_basic` pass `clientAuth: "basic"`. For PUBLIC clients (no * secret) the method is irrelevant — `pickClientAuth` returns `None()`. */export const DEFAULT_CLIENT_AUTH_METHOD: ClientAuthMethod = "body"; const asFromTokenUrl = ( tokenUrl: string, endpointUrlPolicy: OAuthEndpointUrlPolicy = {},): oauth.AuthorizationServer => { assertSupportedOAuthEndpointUrl(tokenUrl, "Token URL", endpointUrlPolicy); const url = new URL(tokenUrl); return { issuer: `${url.protocol}//${url.host}`, token_endpoint: tokenUrl, };}; const asFromTokenUrlAndIssuer = ( tokenUrl: string, issuerUrl: string | null | undefined, options: {Lines 1–500 of 983. Load more
// --------------------------------------------------------------------------- // OAuth 2.0 helpers — generic, isomorphic building blocks. // // Thin wrappers around `oauth4webapi` (stateless; pure Web Crypto + // `fetch`, no deps; runs unchanged in Node, CF Workers, and browsers). // Each public helper is a single `Effect.tryPromise` call that delegates // the RFC work to the library and normalises the failure surface into // `OAuth2Error`. // // What stays hand-rolled: // - `OAuth2Error` — our tagged error; we want a stable shape across // every token-endpoint call // - `shouldRefreshToken` — skew check, trivial // - `buildAuthorizationUrl` — the library doesn't expose a raw // authorization-URL builder (it prefers PAR); a 30-line manual // construction keeps the call sync and lets callers opt out of PAR // --------------------------------------------------------------------------- import { Data, Effect, Option, Predicate, Schema } from "effect"; import * as oauth from "oauth4webapi"; // --------------------------------------------------------------------------- // Errors // --------------------------------------------------------------------------- export class OAuth2Error extends Data.TaggedError("OAuth2Error")<{ readonly message: string; /** * RFC 6749 §5.2 error code, when the token endpoint returned one * (`invalid_grant`, `invalid_client`, `unauthorized_client`, ...). * Callers use this to distinguish terminal failures (a refresh token * the AS no longer honours → re-auth required) from transient ones. */ readonly error?: string; readonly cause?: unknown; }> {} // --------------------------------------------------------------------------- // Token response shape (RFC 6749 §5.1) // --------------------------------------------------------------------------- export type OAuth2TokenResponse = { readonly access_token: string; readonly token_type?: string; readonly refresh_token?: string; readonly expires_in?: number; readonly scope?: string; readonly idTokenIdentityLabel?: string; }; // --------------------------------------------------------------------------- // Constants // --------------------------------------------------------------------------- /** Refresh tokens this many ms before expiry to avoid mid-request expiration. */ export const OAUTH2_REFRESH_SKEW_MS = 60_000; /** Default token-endpoint timeout. */ export const OAUTH2_DEFAULT_TIMEOUT_MS = 20_000; export interface OAuthEndpointUrlPolicy { readonly allowHttp?: boolean; } export const isLoopbackHttpUrl = (value: string): boolean => { if (!URL.canParse(value)) return false; const url = new URL(value); if (url.protocol !== "http:") return false; const hostname = url.hostname.toLowerCase(); return ( hostname === "localhost" || hostname === "0.0.0.0" || hostname === "::1" || hostname === "[::1]" || hostname.startsWith("127.") ); }; export const isSupportedOAuthEndpointUrl = ( value: string, policy: OAuthEndpointUrlPolicy = {}, ): boolean => { if (!URL.canParse(value)) return false; const url = new URL(value); return ( url.protocol === "https:" || isLoopbackHttpUrl(value) || (url.protocol === "http:" && policy.allowHttp === true) ); }; export const assertSupportedOAuthEndpointUrl = ( value: string, label = "OAuth endpoint URL", policy: OAuthEndpointUrlPolicy = {}, ): string => { if (isSupportedOAuthEndpointUrl(value, policy)) return value; // oxlint-disable-next-line executor/no-try-catch-or-throw, executor/no-error-constructor -- boundary: synchronous assertion helper used by URL constructors and Effect.try wrappers throw new TypeError(`${label} must use https: or loopback http:`); }; // --------------------------------------------------------------------------- // PKCE (RFC 7636) — straight delegation to `oauth4webapi` // --------------------------------------------------------------------------- export const createPkceCodeVerifier = (): string => oauth.generateRandomCodeVerifier(); export const createPkceCodeChallenge = (verifier: string): Promise<string> => oauth.calculatePKCECodeChallenge(verifier); /** RFC 6749 `state` — an unguessable correlation token minted by `oauth.start` * and redeemed by `oauth.complete`. */ export const createOAuthState = (): string => oauth.generateRandomState(); // --------------------------------------------------------------------------- // Authorization URL builder // --------------------------------------------------------------------------- export type BuildAuthorizationUrlInput = { readonly authorizationUrl: string; readonly clientId: string; readonly redirectUrl: string; readonly scopes: readonly string[]; readonly state: string; /** Pre-computed base64url S256 challenge (from `createPkceCodeChallenge`). */ readonly codeChallenge: string; /** Separator between scopes. RFC 6749 says space; some providers use comma. */ readonly scopeSeparator?: string; /** RFC 8707 Resource Indicator. MCP Authorization 2025-06-18 §"Resource * Parameter Implementation" requires clients to send this on every * authorization request, regardless of AS support. */ readonly resource?: string; /** Provider-specific extras (e.g. Google's `access_type=offline`). */ readonly extraParams?: Readonly<Record<string, string>>; readonly endpointUrlPolicy?: OAuthEndpointUrlPolicy; }; /** Build an RFC 6749 §4.1.1 authorization URL. Sync; pre-computed * challenge lets this stay out of the Promise world. */ export const buildAuthorizationUrl = (input: BuildAuthorizationUrlInput): string => { const url = new URL( assertSupportedOAuthEndpointUrl( input.authorizationUrl, "Authorization URL", input.endpointUrlPolicy, ), ); // Benign default kept by design: a single space is the RFC 6749 scope // separator. Callers targeting a legacy comma-separated provider pass // `scopeSeparator` explicitly (see the field's JSDoc). const separator = input.scopeSeparator ?? " "; url.searchParams.set("client_id", input.clientId); url.searchParams.set("redirect_uri", input.redirectUrl); url.searchParams.set("response_type", "code"); if (input.scopes.length > 0) { url.searchParams.set("scope", input.scopes.join(separator)); } url.searchParams.set("state", input.state); url.searchParams.set("code_challenge_method", "S256"); url.searchParams.set("code_challenge", input.codeChallenge); if (input.resource) { url.searchParams.set("resource", input.resource); } if (input.extraParams) { for (const [k, v] of Object.entries(input.extraParams)) { url.searchParams.set(k, v); } } return url.toString(); }; /** Provider-specific authorize-URL extras that are NOT RFC 6749 params, so the * generic flow must add them per-provider (keyed off the authorization host). * * Google: `access_type=offline` + `prompt=consent` are required to receive (and * keep receiving, across reconnects / scope changes) a REFRESH TOKEN — without * them Google issues an access-token-only grant that dies in ~1h and a * re-consent can silently keep the old scope set. Do not add * `include_granted_scopes=true` here: with historical grants on the same Google * consent app, Google folds those unrelated scopes into the new consent flow and * can fail inside accounts.google.com before returning to our callback. */ export const providerAuthorizeExtras = ( authorizationUrl: string, ): Readonly<Record<string, string>> => { // oxlint-disable-next-line executor/no-try-catch-or-throw -- boundary: URL() throws on invalid input → no provider extras try { const host = new URL(authorizationUrl).host.toLowerCase(); if (host === "accounts.google.com") { return { access_type: "offline", prompt: "consent" }; } } catch { // Unparseable authorization URL — let buildAuthorizationUrl surface the error. } return {}; }; // --------------------------------------------------------------------------- // Regional token-endpoint rebind // // Some authorization servers publish a single static metadata document that // advertises one region's token endpoint, but issue authorization codes that // are only redeemable at the *regional* host the user's org actually lives on. // The region comes back on the callback as a non-standard `domain` (or `site`) // query param: Datadog returns `domain=us5.datadoghq.com` while its metadata // statically advertises `app.datadoghq.com`. Redeeming the code at the // advertised host then fails with `invalid_grant`. // // `rebindTokenEndpointHostToCallbackDomain` swaps ONLY the hostname of the // configured token URL to the callback-supplied host, and ONLY when that host // is a sibling subdomain of the configured one (same parent after stripping the // leftmost DNS label, e.g. `app.datadoghq.com` and `us5.datadoghq.com` both // reduce to `datadoghq.com`). The token request carries the client secret, the // code, and the PKCE verifier, so an attacker-influenced `domain` must never be // able to point it at an arbitrary origin. Anything that fails the sibling // check, fails to parse, or isn't https falls back to the configured URL // unchanged. // --------------------------------------------------------------------------- const hostnameFromCallbackDomain = (callbackDomain: string): string | undefined => { const trimmed = callbackDomain.trim(); if (trimmed.length === 0) return undefined; // Datadog sends `domain` as a bare host and `site` as a full origin; accept // either by tolerating an optional scheme, then taking only the hostname. const candidate = trimmed.includes("://") ? trimmed : `https://${trimmed}`; if (!URL.canParse(candidate)) return undefined; const url = new URL(candidate); // A legitimate regional host carries no port, credentials, or path. if (url.port !== "" || url.username !== "" || url.password !== "") return undefined; if (url.pathname !== "/" && url.pathname !== "") return undefined; return url.hostname.toLowerCase(); }; /** Parent domain after stripping the leftmost DNS label, or `undefined` when * the host has no sibling space (a single label, or a parent that is a bare * TLD). `app.datadoghq.com` -> `datadoghq.com`; `foo.com` -> undefined. */ const siblingParentDomainOf = (hostname: string): string | undefined => { const labels = hostname.split("."); if (labels.length < 3) return undefined; const parent = labels.slice(1).join("."); // Require the parent to itself be multi-label so a 2-label configured host // can never rebind across an entire TLD (e.g. foo.com -> bar.com). return parent.includes(".") ? parent : undefined; }; export const rebindTokenEndpointHostToCallbackDomain = ( configuredTokenUrl: string, callbackDomain: string | null | undefined, ): string => { if (!callbackDomain) return configuredTokenUrl; if (!URL.canParse(configuredTokenUrl)) return configuredTokenUrl; const configured = new URL(configuredTokenUrl); if (configured.protocol !== "https:") return configuredTokenUrl; const targetHost = hostnameFromCallbackDomain(callbackDomain); if (!targetHost) return configuredTokenUrl; const configuredHost = configured.hostname.toLowerCase(); if (targetHost === configuredHost) return configuredTokenUrl; const configuredParent = siblingParentDomainOf(configuredHost); const targetParent = siblingParentDomainOf(targetHost); if (!configuredParent || !targetParent || configuredParent !== targetParent) { return configuredTokenUrl; } const rebound = new URL(configuredTokenUrl); rebound.hostname = targetHost; return rebound.toString(); }; // --------------------------------------------------------------------------- // Error mapping — `oauth4webapi`'s `process*Response` failure shapes are // either a WWW-Authenticate challenge or an RFC 6749 §5.2 error body, // both exposed via `.error` / `.error_description`. Probing the envelope // preserves RFC 6749 error-code semantics (e.g., mapping `invalid_grant` // to reauth-required) across wrappers. // --------------------------------------------------------------------------- const isOAuth2Error = Predicate.isTagged("OAuth2Error") as (cause: unknown) => cause is OAuth2Error; const responseFromOAuthErrorCause = (cause: unknown): Response | undefined => { if (cause instanceof Response) return cause; if (typeof cause !== "object" || cause === null) return undefined; const envelope = cause as { readonly cause?: unknown; readonly response?: unknown; }; if (envelope.response instanceof Response) return envelope.response; if (envelope.cause instanceof Response) return envelope.cause; return undefined; }; const redactTokenEndpointBody = (body: string): string => body .replaceAll( /("(?:access_token|refresh_token|id_token|client_secret)"\s*:\s*")[^"]*(")/gi, "$1[redacted]$2", ) .replaceAll( /((?:access_token|refresh_token|id_token|client_secret|code)=)[^&\s]*/gi, "$1[redacted]", ); const tokenEndpointHttpSummary = async (response: Response): Promise<string> => { const status = `HTTP ${response.status}${response.statusText ? ` ${response.statusText}` : ""}`; const contentType = response.headers.get("content-type"); const url = response.url ? ` from ${response.url}` : ""; const parts = [`${status}${url}`]; if (contentType) parts.push(`content-type ${contentType}`); const preview = await bodyPreviewFromResponse(response); if (preview) parts.push(`body: ${preview}`); return parts.join("; "); }; const bodyPreviewFromResponse = async (response: Response): Promise<string | undefined> => { const text = await Promise.resolve() .then(() => response.clone().text()) .then( (value) => value.trim(), () => "", ); if (!text) return undefined; const redacted = redactTokenEndpointBody(text.replaceAll(/\s+/g, " ")); return redacted.length > 500 ? `${redacted.slice(0, 500)}...` : redacted; }; // RFC 6749 §5.2's closed set. Only these are ever recovered from a // non-conform body: a free-text match against an open set would let an // arbitrary error message masquerade as an AS verdict. const RFC6749_TOKEN_ERROR_CODES = [ "invalid_request", "invalid_client", "invalid_grant", "unauthorized_client", "unsupported_grant_type", "invalid_scope", ] as const; const rfc6749CodeFromCandidate = (candidate: unknown): string | undefined => { if (typeof candidate !== "string") return undefined; const trimmed = candidate.trim(); return RFC6749_TOKEN_ERROR_CODES.find( (code) => trimmed === code || trimmed.startsWith(`${code} `) || trimmed.startsWith(`${code}:`), ); }; /** Recover the AS's §5.2 verdict from an error body oauth4webapi refused to * parse. Some ASes wrap the code in a non-conform envelope — Datadog answers * refresh grants with `{"errors": ["invalid_grant - Invalid or expired * refresh token or code verifier."]}` — and without this probe a definitive * `invalid_grant` (dead refresh token, reconnect required) is classified as * a transient failure and retried forever instead of surfacing a re-auth. */ const oauthErrorCodeFromNonConformBody = (text: string): string | undefined => { const parsed: unknown = (() => { // oxlint-disable-next-line executor/no-try-catch-or-throw -- boundary: probing an untrusted upstream body that already failed spec parsing; a parse failure just means "no recoverable code" try { // oxlint-disable-next-line executor/no-json-parse -- boundary: same untrusted-body probe; the value is only structurally inspected against the closed §5.2 code set, never decoded into domain types return JSON.parse(text) as unknown; } catch { return undefined; } })(); if (typeof parsed !== "object" || parsed === null) return undefined; const envelope = parsed as { readonly error?: unknown; readonly errors?: unknown }; const direct = rfc6749CodeFromCandidate(envelope.error); if (direct) return direct; if (Array.isArray(envelope.errors)) { for (const entry of envelope.errors) { const code = rfc6749CodeFromCandidate(entry); if (code) return code; } } return undefined; }; const toOAuth2Error = (cause: unknown): OAuth2Error => { if (isOAuth2Error(cause)) return cause; if (typeof cause === "object" && cause !== null) { const c = cause as { error?: unknown; error_description?: unknown; message?: unknown; }; const code = typeof c.error === "string" ? c.error : undefined; const description = typeof c.error_description === "string" ? c.error_description : typeof c.message === "string" ? c.message : undefined; return new OAuth2Error({ message: `OAuth token exchange failed: ${description ?? code ?? "unknown error"}`, error: code, cause, }); } return new OAuth2Error({ message: "OAuth token exchange failed", cause, }); }; const toOAuth2ErrorWithHttpSummary = (cause: unknown): Effect.Effect<OAuth2Error> => { if (isOAuth2Error(cause)) return Effect.succeed(cause); const base = toOAuth2Error(cause); const response = responseFromOAuthErrorCause(cause); if (!response) return Effect.succeed(base); return Effect.promise(async () => { const summary = await tokenEndpointHttpSummary(response); // A 4xx the spec parser refused may still carry the AS's verdict in a // non-conform envelope; recover it so classification (invalid_grant → // reauth-required) sees the code instead of a code-less "transient". const recovered = base.error === undefined && response.status >= 400 && response.status < 500 ? oauthErrorCodeFromNonConformBody( await Promise.resolve() .then(() => response.clone().text()) .then( (value) => value, () => "", ), ) : undefined; return new OAuth2Error({ message: `${base.message} (${summary})`, error: base.error ?? recovered, cause, }); }); }; const failOAuth2WithHttpSummary = (cause: unknown): Effect.Effect<never, OAuth2Error> => toOAuth2ErrorWithHttpSummary(cause).pipe(Effect.flatMap((error) => Effect.fail(error))); /** Trace one token-endpoint round trip. This is the ONLY place a token request * can be observed: oauth4webapi drives the raw global `fetch`, not Effect's * HttpClient, so no `http.client` span exists underneath — without this span * the AS's latency and refusal rate are invisible. * * Attribute discipline: hostname (never the full URL — some providers carry * tenant ids in the path), the grant literal, the auth method, and on failure * the AS's RFC 6749 §5.2 code. Never the OAuth2Error message (it embeds the * response URL and a body preview), never token or code material. */ const withTokenRequestSpan = (input: { readonly grantType: "authorization_code" | "client_credentials" | "refresh_token"; readonly tokenUrl: string; readonly clientAuth: ClientAuthMethod | undefined; readonly hasResource: boolean; }) => <A>(effect: Effect.Effect<A, OAuth2Error>): Effect.Effect<A, OAuth2Error> => effect.pipe( Effect.tapError((error) => Effect.annotateCurrentSpan({ ...(error.error !== undefined ? { "executor.oauth.error_code": error.error } : {}), }), ), Effect.withSpan("executor.oauth.token_request", { attributes: { "executor.oauth.grant_type": input.grantType, "executor.oauth.token_host": hostnameForTelemetry(input.tokenUrl), "executor.oauth.client_auth": input.clientAuth ?? DEFAULT_CLIENT_AUTH_METHOD, "executor.oauth.has_resource": input.hasResource, }, }), ); /** The hostname alone — a malformed URL yields "invalid" rather than leaking * whatever string failed to parse. */ const hostnameForTelemetry = (url: string): string => URL.parse(url)?.hostname ?? "invalid"; // --------------------------------------------------------------------------- // oauth4webapi adapter helpers // --------------------------------------------------------------------------- export type ClientAuthMethod = "body" | "basic"; /** * The token-endpoint client-auth transport used when a caller doesn't specify * one. `"body"` is `client_secret_post` (the secret in the form body) — the * method our DCR registers (`token_endpoint_auth_method: client_secret_post`) * and the one every confidential client in the v2 model uses. EXPLICIT and * documented rather than a hidden inline `?? "body"`: callers that need * `client_secret_basic` pass `clientAuth: "basic"`. For PUBLIC clients (no * secret) the method is irrelevant — `pickClientAuth` returns `None()`. */ export const DEFAULT_CLIENT_AUTH_METHOD: ClientAuthMethod = "body"; const asFromTokenUrl = ( tokenUrl: string, endpointUrlPolicy: OAuthEndpointUrlPolicy = {}, ): oauth.AuthorizationServer => { assertSupportedOAuthEndpointUrl(tokenUrl, "Token URL", endpointUrlPolicy); const url = new URL(tokenUrl); return { issuer: `${url.protocol}//${url.host}`, token_endpoint: tokenUrl, }; }; const asFromTokenUrlAndIssuer = ( tokenUrl: string, issuerUrl: string | null | undefined, options: {