Skip to content

Commit 6d46336

Browse files
fix(observability): redact credential URL params in spans and type them as Redacted (pingdotgg#27986)
Co-authored-by: Claude Opus 5.5 <[email protected]>
1 parent 11df0cb commit 6d46336

11 files changed

Lines changed: 120 additions & 45 deletions

File tree

‎apps/server/src/auth/EnvironmentAuth.test.ts‎

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -703,40 +703,44 @@ it.layer(NodeServices.layer)("EnvironmentAuth.layer", (it) => {
703703
);
704704

705705
const rpc = yield* serverAuth.issueWebSocketTicket(session, { use: "rpc" });
706-
const bare = yield* Effect.flip(upgrade(rpc.ticket, "rpc"));
706+
const bare = yield* Effect.flip(upgrade(Redacted.value(rpc.ticket), "rpc"));
707707
expect(bare._tag).toBe("ServerAuthInvalidCredentialError");
708708
const signed = yield* upgrade(
709-
rpc.ticket,
709+
Redacted.value(rpc.ticket),
710710
"rpc",
711-
key.sign({ method: "GET", url: socketUrl, token: rpc.ticket, iat }),
711+
key.sign({ method: "GET", url: socketUrl, token: Redacted.value(rpc.ticket), iat }),
712712
);
713713
expect(signed.sessionId).toBe(session.sessionId);
714714

715715
const wrongKey = yield* Effect.flip(
716716
upgrade(
717-
rpc.ticket,
717+
Redacted.value(rpc.ticket),
718718
"rpc",
719-
other.sign({ method: "GET", url: socketUrl, token: rpc.ticket, iat }),
719+
other.sign({ method: "GET", url: socketUrl, token: Redacted.value(rpc.ticket), iat }),
720720
),
721721
);
722722
expect(wrongKey._tag).toBe("ServerAuthInvalidCredentialError");
723723
const onMedia = yield* Effect.flip(
724724
upgrade(
725-
rpc.ticket,
725+
Redacted.value(rpc.ticket),
726726
"media",
727-
key.sign({ method: "GET", url: socketUrl, token: rpc.ticket, iat }),
727+
key.sign({ method: "GET", url: socketUrl, token: Redacted.value(rpc.ticket), iat }),
728728
),
729729
);
730730
expect(onMedia._tag).toBe("ServerAuthInvalidCredentialError");
731731

732732
const media = yield* serverAuth.issueWebSocketTicket(session, { use: "media" });
733-
expect((yield* upgrade(media.ticket, "media")).sessionId).toBe(session.sessionId);
734-
const mediaOnRpc = yield* Effect.flip(upgrade(media.ticket, "rpc"));
733+
expect((yield* upgrade(Redacted.value(media.ticket), "media")).sessionId).toBe(
734+
session.sessionId,
735+
);
736+
const mediaOnRpc = yield* Effect.flip(upgrade(Redacted.value(media.ticket), "rpc"));
735737
expect(mediaOnRpc._tag).toBe("ServerAuthInvalidCredentialError");
736738

737739
// Clients that predate ticket binding still connect with the unbound ticket they mint.
738740
const legacy = yield* serverAuth.issueWebSocketTicket(session);
739-
expect((yield* upgrade(legacy.ticket, "rpc")).sessionId).toBe(session.sessionId);
741+
expect((yield* upgrade(Redacted.value(legacy.ticket), "rpc")).sessionId).toBe(
742+
session.sessionId,
743+
);
740744
}).pipe(
741745
Effect.provide(layerEnvironmentAuth({ desktopBootstrapToken: "desktop-bootstrap-token" })),
742746
),
@@ -757,10 +761,10 @@ it.layer(NodeServices.layer)("EnvironmentAuth.layer", (it) => {
757761
const rpc = yield* serverAuth.issueWebSocketTicket(session, { use: "rpc" });
758762
const request = {
759763
method: "GET",
760-
url: `/ws?wsTicket=${rpc.ticket}&dpop=${key.sign({
764+
url: `/ws?wsTicket=${Redacted.value(rpc.ticket)}&dpop=${key.sign({
761765
method: "GET",
762766
url: "http://192.168.1.50:3773/ws",
763-
token: rpc.ticket,
767+
token: Redacted.value(rpc.ticket),
764768
iat: Math.floor((yield* DateTime.now).epochMilliseconds / 1_000),
765769
})}`,
766770
cookies: {},

‎apps/server/src/auth/EnvironmentAuth.ts‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ import * as Duration from "effect/Duration";
3131
import * as Effect from "effect/Effect";
3232
import * as Layer from "effect/Layer";
3333
import * as Option from "effect/Option";
34+
import * as Redacted from "effect/Redacted";
3435
import * as Schema from "effect/Schema";
3536
import * as HttpServerRequest from "effect/http/HttpServerRequest";
3637

@@ -568,8 +569,11 @@ type BootstrapExchangeResult = {
568569

569570
const AUTHORIZATION_PREFIX = "Bearer ";
570571
const DPOP_AUTHORIZATION_PREFIX = "DPoP ";
571-
const WEBSOCKET_TICKET_QUERY_PARAM = "wsTicket";
572-
const WEBSOCKET_PROOF_QUERY_PARAM = "dpop";
572+
const WebSocketUpgradeQuery = Schema.Struct({
573+
wsTicket: Schema.optionalKey(Schema.RedactedFromValue(Schema.String)),
574+
dpop: Schema.optionalKey(Schema.RedactedFromValue(Schema.String)),
575+
});
576+
const decodeWebSocketUpgradeQuery = Schema.decodeEffect(WebSocketUpgradeQuery);
573577

574578
const bySessionPriority = (left: AuthClientSession, right: AuthClientSession) => {
575579
const leftCanManage = left.scopes.includes(AuthAccessWriteScope);
@@ -1215,7 +1219,7 @@ export const make = Effect.gen(function* () {
12151219
Effect.map(
12161220
(issued) =>
12171221
({
1218-
ticket: issued.token,
1222+
ticket: Redacted.make(issued.token),
12191223
expiresAt: DateTime.toUtc(issued.expiresAt),
12201224
}) satisfies AuthWebSocketTicketResult,
12211225
),
@@ -1231,7 +1235,10 @@ export const make = Effect.gen(function* () {
12311235
Effect.fn("EnvironmentAuth.authenticateWebSocketUpgrade")(function* (request, use) {
12321236
const requestUrl = HttpServerRequest.toURL(request);
12331237
if (Option.isSome(requestUrl)) {
1234-
const websocketTicket = requestUrl.value.searchParams.get(WEBSOCKET_TICKET_QUERY_PARAM);
1238+
const query = yield* decodeWebSocketUpgradeQuery(
1239+
Object.fromEntries(requestUrl.value.searchParams),
1240+
).pipe(Effect.orDie);
1241+
const websocketTicket = query.wsTicket && Redacted.value(query.wsTicket);
12351242
if (websocketTicket && websocketTicket.trim().length > 0) {
12361243
const session = yield* sessions
12371244
.verifyWebSocketToken(websocketTicket)
@@ -1245,10 +1252,7 @@ export const make = Effect.gen(function* () {
12451252
// WebSocket clients cannot set headers, so the proof travels in the query.
12461253
// The proof hashes the ticket; consuming its jti prevents replay after first use.
12471254
// Only encrypted transport prevents an active interceptor from racing that use.
1248-
const proof =
1249-
request.headers.dpop ??
1250-
requestUrl.value.searchParams.get(WEBSOCKET_PROOF_QUERY_PARAM) ??
1251-
undefined;
1255+
const proof = request.headers.dpop ?? (query.dpop && Redacted.value(query.dpop));
12521256
if (!proof) {
12531257
return yield* new ServerAuthInvalidCredentialError({
12541258
diagnostic: "DPoP-bound WebSocket ticket requires a DPoP proof.",

‎apps/server/src/auth/McpOAuth.ts‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ import * as Crypto from "effect/Crypto";
2323
import * as Effect from "effect/Effect";
2424
import * as Layer from "effect/Layer";
2525
import * as Option from "effect/Option";
26+
import * as Redacted from "effect/Redacted";
2627
import * as Ref from "effect/Ref";
2728
import * as Schema from "effect/Schema";
2829
import { HttpServerRequest } from "effect/http";
@@ -162,15 +163,15 @@ export class McpOAuthRedirectError extends Schema.TaggedError<McpOAuthRedirectEr
162163
error: Schema.Literals(["invalid_request", "unsupported_response_type", "invalid_target"]),
163164
description: Schema.String,
164165
redirectUri: Schema.String,
165-
state: Schema.optional(Schema.String),
166+
state: Schema.optional(Schema.RedactedFromValue(Schema.String)),
166167
},
167168
) {}
168169

169170
export interface AuthorizationRequest {
170171
readonly client: McpOAuthClient;
171172
readonly redirectUri: string;
172173
readonly codeChallenge: string;
173-
readonly state: string | undefined;
174+
readonly state: Redacted.Redacted<string> | undefined;
174175
readonly resource: string;
175176
readonly issuer: string;
176177
}
@@ -220,10 +221,15 @@ export class McpOAuth extends Context.Service<
220221
}
221222
>()("t3/auth/McpOAuth") {}
222223

223-
const redirectWith = (redirectUri: string, params: Record<string, string | undefined>) => {
224+
const redirectWith = (
225+
redirectUri: string,
226+
params: Record<string, string | Redacted.Redacted<string> | undefined>,
227+
) => {
224228
const url = new URL(redirectUri);
225229
for (const [name, value] of Object.entries(params)) {
226-
if (value !== undefined) url.searchParams.set(name, value);
230+
if (value !== undefined) {
231+
url.searchParams.set(name, Redacted.isRedacted(value) ? Redacted.value(value) : value);
232+
}
227233
}
228234
return url.toString();
229235
};
@@ -484,8 +490,9 @@ const make = Effect.gen(function* () {
484490
if (token.grant_type !== "authorization_code") {
485491
return yield* fail("unsupported_grant_type", "Only authorization_code is supported.");
486492
}
487-
const { code, redirect_uri: redirectUri, client_id: clientId } = token;
488-
const verifier = token.code_verifier;
493+
const { redirect_uri: redirectUri, client_id: clientId } = token;
494+
const code = token.code && Redacted.value(token.code);
495+
const verifier = token.code_verifier && Redacted.value(token.code_verifier);
489496
if (!code || !redirectUri || !clientId || !verifier) {
490497
return yield* fail(
491498
"invalid_request",

‎apps/server/src/auth/mcpOAuthHttp.ts‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
import {
22
AuthMcpApprovalError,
3-
type AuthMcpAuthorizationRequest,
3+
AuthMcpAuthorizationRequest,
44
AuthMcpClientAccess,
55
EnvironmentHttpApi,
66
mcpClientScopes,
77
} from "@t3tools/contracts";
88
import * as Effect from "effect/Effect";
99
import * as Result from "effect/Result";
10+
import * as Schema from "effect/Schema";
1011
import { HttpServerRequest, HttpServerResponse } from "effect/http";
1112
import * as HttpEffect from "effect/http/HttpEffect";
1213
import * as HttpApiBuilder from "effect/http-api/HttpApiBuilder";
@@ -33,6 +34,7 @@ const noStore = HttpEffect.appendPreResponseHandler((_request, response) =>
3334
);
3435

3536
const requestUrls = Effect.map(HttpServerRequest.HttpServerRequest, McpOAuth.requestUrls);
37+
const decodeAuthorizationRequest = Schema.decodeEffect(AuthMcpAuthorizationRequest);
3638

3739
/**
3840
* An unverified client or redirect is reported, never redirected; any other problem goes back to
@@ -86,8 +88,11 @@ export const layer = HttpApiBuilder.group(
8688
Effect.gen(function* () {
8789
const urls = yield* requestUrls;
8890
const url = new URL(request.url, urls.issuer);
91+
const authorizationRequest = yield* decodeAuthorizationRequest(
92+
Object.fromEntries(url.searchParams),
93+
).pipe(Effect.orDie);
8994
const authorization = yield* oauth
90-
.validateAuthorization({ urls, request: Object.fromEntries(url.searchParams) })
95+
.validateAuthorization({ urls, request: authorizationRequest })
9196
.pipe(Effect.result);
9297
const headers = { "cache-control": "no-store", "referrer-policy": "no-referrer" };
9398
if (Result.isSuccess(authorization)) {

‎apps/server/src/peer/PeerLinks.ts‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import * as Base64Url from "effect/encoding/Base64Url";
2121
import * as Hex from "effect/encoding/Hex";
2222
import * as Layer from "effect/Layer";
2323
import * as Option from "effect/Option";
24+
import * as Redacted from "effect/Redacted";
2425
import * as Result from "effect/Result";
2526
import * as Schema from "effect/Schema";
2627
import * as SqlClient from "effect/sql/SqlClient";
@@ -263,7 +264,7 @@ const make = Effect.gen(function* () {
263264
redirect_uri: LINK_REDIRECT_URI,
264265
code_challenge: challenge,
265266
code_challenge_method: "S256",
266-
state,
267+
state: Redacted.make(state),
267268
resource,
268269
},
269270
decision: { _tag: "pairing-code", access: input.access, code: input.pairingCode },
@@ -297,10 +298,10 @@ const make = Effect.gen(function* () {
297298
.token({
298299
payload: {
299300
grant_type: "authorization_code",
300-
code,
301+
code: Redacted.make(code),
301302
redirect_uri: LINK_REDIRECT_URI,
302303
client_id: registered.client_id,
303-
code_verifier: verifier,
304+
code_verifier: Redacted.make(verifier),
304305
resource,
305306
},
306307
})

‎apps/web/src/components/auth/ConnectAgentSurface.tsx‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import {
33
type AuthMcpApprovalDetails,
44
AuthMcpApprovalError,
55
AuthMcpClientAccess,
6-
type AuthMcpAuthorizationRequest,
6+
AuthMcpAuthorizationRequest,
77
} from "@t3tools/contracts";
88
import { Radio as RadioPrimitive } from "@base-ui/react/radio";
99
import { isLoopbackHost } from "@t3tools/shared/preview";
@@ -76,8 +76,10 @@ function runApproval<A>(
7676
).catch((): Answer<A> => ({ kind: "error", message: UNREACHABLE }));
7777
}
7878

79+
const decodeAuthorizationRequest = Schema.decodeSync(AuthMcpAuthorizationRequest);
80+
7981
function readAuthorizationRequest(): AuthMcpAuthorizationRequest {
80-
return Object.fromEntries(new URL(window.location.href).searchParams);
82+
return decodeAuthorizationRequest(Object.fromEntries(new URL(window.location.href).searchParams));
8183
}
8284

8385
/** Sessions can grant only scopes they hold. */

‎packages/client-runtime/src/authorization/remote.ts‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import { encodeOAuthScope } from "@t3tools/shared/oauthScope";
1212
import { hashTelemetryId } from "@t3tools/shared/telemetryId";
1313
import * as Effect from "effect/Effect";
1414
import * as Option from "effect/Option";
15+
import * as Redacted from "effect/Redacted";
1516
import { environmentEndpointUrl } from "../environment/endpoint.ts";
1617
import * as ClientCapabilities from "../platform/capabilities.ts";
1718
import {
@@ -290,7 +291,7 @@ export const resolveRemoteWebSocketConnectionUrl = Effect.fn(
290291
});
291292

292293
const url = rpcSocketUrl(input.wsBaseUrl);
293-
url.searchParams.set("wsTicket", issued.ticket);
294+
url.searchParams.set("wsTicket", Redacted.value(issued.ticket));
294295
appendClientConnectionParams(
295296
url,
296297
input.clientMetadata,
@@ -343,9 +344,9 @@ export const resolveRemoteDpopWebSocketConnectionUrl = Effect.fn(
343344
const upgradeProof = yield* input.createProof({
344345
method: "GET",
345346
url: `${url.protocol === "wss:" ? "https:" : "http:"}//${url.host}${url.pathname}`,
346-
accessToken: issued.ticket,
347+
accessToken: Redacted.value(issued.ticket),
347348
});
348-
url.searchParams.set("wsTicket", issued.ticket);
349+
url.searchParams.set("wsTicket", Redacted.value(issued.ticket));
349350
url.searchParams.set("dpop", upgradeProof);
350351
appendClientConnectionParams(
351352
url,

‎packages/client-runtime/src/state/deviceHubAccess.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
* stream.
66
*/
77
import * as Effect from "effect/Effect";
8+
import * as Redacted from "effect/Redacted";
89
import type { HttpClient } from "effect/http";
910

1011
import * as RemoteEnvironmentAuthorization from "../authorization/service.ts";
@@ -47,7 +48,7 @@ export const resolveDeviceHubAccess = Effect.fn("clientRuntime.state.resolveDevi
4748
return {
4849
httpBase,
4950
wsBase,
50-
query: { wsTicket: ticket.ticket },
51+
query: { wsTicket: Redacted.value(ticket.ticket) },
5152
credentials: false,
5253
};
5354
},

‎packages/contracts/src/auth.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ export const AuthAccessTokenResult = Schema.Struct({
238238
export type AuthAccessTokenResult = typeof AuthAccessTokenResult.Type;
239239

240240
export const AuthWebSocketTicketResult = Schema.Struct({
241-
ticket: TrimmedNonEmptyString,
241+
ticket: Schema.RedactedFromValue(TrimmedNonEmptyString),
242242
expiresAt: Schema.DateTimeUtc,
243243
});
244244
export type AuthWebSocketTicketResult = typeof AuthWebSocketTicketResult.Type;
@@ -490,7 +490,7 @@ export const AuthMcpAuthorizationRequest = Schema.Struct({
490490
redirect_uri: Schema.optionalKey(Schema.String),
491491
code_challenge: Schema.optionalKey(Schema.String),
492492
code_challenge_method: Schema.optionalKey(Schema.String),
493-
state: Schema.optionalKey(Schema.String),
493+
state: Schema.optionalKey(Schema.RedactedFromValue(Schema.String)),
494494
resource: Schema.optionalKey(Schema.String),
495495
});
496496
export type AuthMcpAuthorizationRequest = typeof AuthMcpAuthorizationRequest.Type;
@@ -539,10 +539,10 @@ export class AuthMcpApprovalError extends Schema.TaggedError<AuthMcpApprovalErro
539539

540540
export const AuthMcpTokenRequest = Schema.Struct({
541541
grant_type: Schema.optionalKey(Schema.String),
542-
code: Schema.optionalKey(Schema.String),
542+
code: Schema.optionalKey(Schema.RedactedFromValue(Schema.String)),
543543
redirect_uri: Schema.optionalKey(Schema.String),
544544
client_id: Schema.optionalKey(Schema.String),
545-
code_verifier: Schema.optionalKey(Schema.String),
545+
code_verifier: Schema.optionalKey(Schema.RedactedFromValue(Schema.String)),
546546
resource: Schema.optionalKey(Schema.String),
547547
}).pipe(HttpApiSchema.asFormUrlEncoded());
548548
export type AuthMcpTokenRequest = typeof AuthMcpTokenRequest.Type;
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
import { describe, expect, it } from "@effect/vitest";
2+
import * as Effect from "effect/Effect";
3+
import * as Tracer from "effect/Tracer";
4+
import * as HttpClient from "effect/http/HttpClient";
5+
import * as HttpClientResponse from "effect/http/HttpClientResponse";
6+
7+
import * as HttpObservability from "./httpObservability.ts";
8+
9+
describe("HttpObservability.layer", () => {
10+
it.effect("redacts credential query parameters on HTTP client spans", () => {
11+
const spans: Array<Tracer.NativeSpan> = [];
12+
const tracer = Tracer.make({
13+
span: (options) => {
14+
const span = new Tracer.NativeSpan(options);
15+
spans.push(span);
16+
return span;
17+
},
18+
});
19+
const client = HttpClient.make((request) =>
20+
Effect.succeed(HttpClientResponse.fromWeb(request, new Response("ok"))),
21+
);
22+
return Effect.gen(function* () {
23+
yield* client.get("https://example.com/ws?wsTicket=secret&clientOs=linux&dpop=proof");
24+
const span = spans.find((candidate) => candidate.kind === "client")!;
25+
expect(span.attributes.get("url.full")).toBe(
26+
"https://example.com/ws?wsTicket=REDACTED&clientOs=linux&dpop=REDACTED",
27+
);
28+
expect(span.attributes.get("url.query")).toBe(
29+
"wsTicket=REDACTED&clientOs=linux&dpop=REDACTED",
30+
);
31+
}).pipe(Effect.provide(HttpObservability.layer), Effect.withTracer(tracer));
32+
});
33+
});

0 commit comments

Comments
 (0)