Repository navigation
Commit 19d67b7
committed
Redact the Authorization header from the errors the HTTP transport retains
## Motivation and Context
When the MCP server answers with an HTTP error, `MCP::Client::HTTP` raises `RequestHandlerError` with
Faraday's exception as `original_error`, which is also its `cause`. Faraday's `raise_error` middleware
keeps the request headers on that exception, bearer token included, and `Faraday::Error#inspect` prints them,
so the token reached any log line or error report that inspected the error, while the transport already keeps
credentials out of the URLs it quotes. The same exception escapes `close` unwrapped when the server refuses the `DELETE`.
The transport now replaces the value of the `Authorization` header in the retained request headers before
such an exception leaves it, on requests, notifications, and session termination alike. The request is complete by then,
and each request builds its own headers from the connection's defaults, so neither those defaults nor
a later request observes the change; the response headers, which carry the `WWW-Authenticate` challenge
the OAuth flow reads, are untouched.
The `GET` that resumes a stream the server closed early, and the `POST` that answers a request the server sent on such a stream,
run while the caller's request is still in flight and can fail the same way, so they are covered too.
A JSON middleware installed through the connection block raises `Faraday::ParsingError` on a malformed body,
with the `Faraday::Response` itself in place of the Hash `raise_error` builds, so the header is replaced there as well.
A middleware installed the same way may have replaced the request headers with a plain Hash or frozen them:
the header name is matched regardless of case, and a frozen object is swapped for a copy, so the redaction never raises
in place of the error it is redacting. Only the `Authorization` header is replaced; other request headers,
`Mcp-Session-Id` among them, stay as they were sent.
## How Has This Been Tested?
New tests in `test/mcp/client/http_test.rb` send a request, a notification, and a `DELETE` with a bearer token to
a server that answers with an error, and check that the retained error carries `[redacted]` in place of
the header and that `inspect` no longer contains the token. All three fail against the previous library.
Two more resume a stream the server closed early with a `GET` that fails, and answer a request the server sent on
that stream with a `POST` that fails, and check the same; both fail against the previous library.
One more answers a server request carried by an SSE body an adapter without streaming support hands over whole,
with a `POST` that fails, and checks the same; it fails against the previous library, and also when only
the answer's own redaction is removed.
Three more install a middleware that parses JSON bodies and answer with a malformed one, freeze the request headers,
or replace them with a plain Hash holding a lowercase `authorization` key, and check the same; all three fail against
the previous library.
One more, in `test/mcp/client/oauth/http_oauth_test.rb`, answers a bearer request with a 401 challenge and checks
that the OAuth flow still runs and the retried request carries the token it produced.
The challenge names a metadata URL off the well-known paths, which stay unstubbed, so a challenge lost with
the redaction would fail the flow.
## Breaking Changes
None. `original_error.response[:request][:headers]["Authorization"]` now reads `[redacted]`.1 parent d565e12 commit 19d67b7
3 files changed
Lines changed: 281 additions & 11 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
418 | 418 | | |
419 | 419 | | |
420 | 420 | | |
421 | | - | |
422 | | - | |
| 421 | + | |
| 422 | + | |
| 423 | + | |
| 424 | + | |
423 | 425 | | |
424 | 426 | | |
425 | 427 | | |
| |||
527 | 529 | | |
528 | 530 | | |
529 | 531 | | |
530 | | - | |
| 532 | + | |
531 | 533 | | |
532 | 534 | | |
533 | 535 | | |
| |||
555 | 557 | | |
556 | 558 | | |
557 | 559 | | |
558 | | - | |
| 560 | + | |
559 | 561 | | |
560 | 562 | | |
561 | 563 | | |
| |||
1050 | 1052 | | |
1051 | 1053 | | |
1052 | 1054 | | |
| 1055 | + | |
| 1056 | + | |
| 1057 | + | |
| 1058 | + | |
| 1059 | + | |
| 1060 | + | |
| 1061 | + | |
| 1062 | + | |
| 1063 | + | |
| 1064 | + | |
| 1065 | + | |
| 1066 | + | |
| 1067 | + | |
| 1068 | + | |
| 1069 | + | |
| 1070 | + | |
| 1071 | + | |
| 1072 | + | |
| 1073 | + | |
| 1074 | + | |
| 1075 | + | |
| 1076 | + | |
| 1077 | + | |
| 1078 | + | |
| 1079 | + | |
| 1080 | + | |
| 1081 | + | |
| 1082 | + | |
| 1083 | + | |
| 1084 | + | |
| 1085 | + | |
| 1086 | + | |
| 1087 | + | |
| 1088 | + | |
| 1089 | + | |
| 1090 | + | |
| 1091 | + | |
| 1092 | + | |
| 1093 | + | |
| 1094 | + | |
| 1095 | + | |
| 1096 | + | |
| 1097 | + | |
| 1098 | + | |
| 1099 | + | |
1053 | 1100 | | |
1054 | 1101 | | |
1055 | 1102 | | |
| |||
1162 | 1209 | | |
1163 | 1210 | | |
1164 | 1211 | | |
1165 | | - | |
| 1212 | + | |
1166 | 1213 | | |
1167 | 1214 | | |
1168 | 1215 | | |
| |||
1225 | 1272 | | |
1226 | 1273 | | |
1227 | 1274 | | |
1228 | | - | |
1229 | | - | |
1230 | | - | |
1231 | | - | |
1232 | | - | |
1233 | | - | |
| 1275 | + | |
| 1276 | + | |
| 1277 | + | |
| 1278 | + | |
| 1279 | + | |
| 1280 | + | |
| 1281 | + | |
| 1282 | + | |
1234 | 1283 | | |
1235 | 1284 | | |
1236 | 1285 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
417 | 417 | | |
418 | 418 | | |
419 | 419 | | |
| 420 | + | |
| 421 | + | |
| 422 | + | |
| 423 | + | |
| 424 | + | |
| 425 | + | |
| 426 | + | |
| 427 | + | |
| 428 | + | |
| 429 | + | |
| 430 | + | |
| 431 | + | |
| 432 | + | |
| 433 | + | |
| 434 | + | |
| 435 | + | |
| 436 | + | |
| 437 | + | |
| 438 | + | |
| 439 | + | |
| 440 | + | |
| 441 | + | |
| 442 | + | |
| 443 | + | |
| 444 | + | |
| 445 | + | |
| 446 | + | |
| 447 | + | |
| 448 | + | |
| 449 | + | |
| 450 | + | |
| 451 | + | |
| 452 | + | |
| 453 | + | |
| 454 | + | |
| 455 | + | |
| 456 | + | |
| 457 | + | |
| 458 | + | |
| 459 | + | |
| 460 | + | |
| 461 | + | |
| 462 | + | |
| 463 | + | |
| 464 | + | |
| 465 | + | |
| 466 | + | |
| 467 | + | |
| 468 | + | |
| 469 | + | |
| 470 | + | |
| 471 | + | |
| 472 | + | |
| 473 | + | |
| 474 | + | |
| 475 | + | |
| 476 | + | |
| 477 | + | |
| 478 | + | |
| 479 | + | |
| 480 | + | |
| 481 | + | |
| 482 | + | |
| 483 | + | |
| 484 | + | |
| 485 | + | |
| 486 | + | |
| 487 | + | |
| 488 | + | |
| 489 | + | |
| 490 | + | |
| 491 | + | |
| 492 | + | |
| 493 | + | |
| 494 | + | |
| 495 | + | |
| 496 | + | |
| 497 | + | |
| 498 | + | |
| 499 | + | |
| 500 | + | |
| 501 | + | |
| 502 | + | |
| 503 | + | |
| 504 | + | |
| 505 | + | |
| 506 | + | |
| 507 | + | |
| 508 | + | |
| 509 | + | |
| 510 | + | |
| 511 | + | |
| 512 | + | |
| 513 | + | |
| 514 | + | |
| 515 | + | |
| 516 | + | |
| 517 | + | |
| 518 | + | |
| 519 | + | |
| 520 | + | |
| 521 | + | |
| 522 | + | |
| 523 | + | |
| 524 | + | |
| 525 | + | |
| 526 | + | |
| 527 | + | |
| 528 | + | |
| 529 | + | |
| 530 | + | |
| 531 | + | |
| 532 | + | |
| 533 | + | |
| 534 | + | |
| 535 | + | |
| 536 | + | |
| 537 | + | |
| 538 | + | |
| 539 | + | |
| 540 | + | |
| 541 | + | |
| 542 | + | |
| 543 | + | |
| 544 | + | |
| 545 | + | |
| 546 | + | |
| 547 | + | |
| 548 | + | |
| 549 | + | |
| 550 | + | |
| 551 | + | |
| 552 | + | |
| 553 | + | |
| 554 | + | |
| 555 | + | |
| 556 | + | |
| 557 | + | |
| 558 | + | |
| 559 | + | |
| 560 | + | |
| 561 | + | |
| 562 | + | |
| 563 | + | |
| 564 | + | |
| 565 | + | |
| 566 | + | |
| 567 | + | |
| 568 | + | |
| 569 | + | |
| 570 | + | |
| 571 | + | |
| 572 | + | |
| 573 | + | |
| 574 | + | |
| 575 | + | |
| 576 | + | |
| 577 | + | |
| 578 | + | |
| 579 | + | |
| 580 | + | |
| 581 | + | |
| 582 | + | |
| 583 | + | |
| 584 | + | |
| 585 | + | |
| 586 | + | |
| 587 | + | |
420 | 588 | | |
421 | 589 | | |
422 | 590 | | |
| |||
2010 | 2178 | | |
2011 | 2179 | | |
2012 | 2180 | | |
| 2181 | + | |
| 2182 | + | |
| 2183 | + | |
| 2184 | + | |
| 2185 | + | |
| 2186 | + | |
| 2187 | + | |
| 2188 | + | |
| 2189 | + | |
| 2190 | + | |
| 2191 | + | |
| 2192 | + | |
| 2193 | + | |
| 2194 | + | |
| 2195 | + | |
| 2196 | + | |
| 2197 | + | |
| 2198 | + | |
| 2199 | + | |
| 2200 | + | |
| 2201 | + | |
2013 | 2202 | | |
2014 | 2203 | | |
2015 | 2204 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
308 | 308 | | |
309 | 309 | | |
310 | 310 | | |
| 311 | + | |
| 312 | + | |
| 313 | + | |
| 314 | + | |
| 315 | + | |
| 316 | + | |
| 317 | + | |
| 318 | + | |
| 319 | + | |
| 320 | + | |
| 321 | + | |
| 322 | + | |
| 323 | + | |
| 324 | + | |
| 325 | + | |
| 326 | + | |
| 327 | + | |
| 328 | + | |
| 329 | + | |
| 330 | + | |
| 331 | + | |
| 332 | + | |
| 333 | + | |
| 334 | + | |
| 335 | + | |
| 336 | + | |
| 337 | + | |
| 338 | + | |
| 339 | + | |
| 340 | + | |
| 341 | + | |
| 342 | + | |
311 | 343 | | |
312 | 344 | | |
313 | 345 | | |
| |||
0 commit comments