ruby-sdk/docs
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Koichi ITO 47eb74aa7a Validate the issuer of legacy authorization server metadata
## Motivation and Context

On the legacy 2025-03-26 path, taken when a server publishes no Protected Resource Metadata,
the authorization server metadata is fetched from the MCP server's origin, which that spec names
as the authorization base URL, but its `issuer` was never compared with that origin.
RFC 8414 Section 3.3 requires the comparison, the 2025-03-26 spec makes RFC 8414 a MUST for clients,
and the TypeScript and Python SDKs both compare on this path, tolerating only a trailing slash.
The flow nevertheless used the unverified `issuer` as the authorization server's identity everywhere:
tokens were stamped with it, stored client information was matched against it, the `private_key_jwt`
and ID-JAG assertions took it as their audience, and `authorization_request_validator` was shown it.

A server on that path could therefore claim any issuer. Claiming the one that minted the stored tokens made
`refresh!` send the refresh token and the stored client secret to the server's own token endpoint, claiming
the one that issued stored client information made the flow reuse those credentials there, and a validator
allow-listing the claimed issuer approved the request.

The legacy path now applies the same check as the modern one: the document's `issuer` must be the origin,
rendered with or without a trailing slash, and any other document is refused before registration, redirect,
or token request. A server without a metadata document still gets the spec's default endpoints.

## How Has This Been Tested?

New tests in `test/mcp/client/oauth/flow_test.rb` serve legacy metadata at the MCP server origin that claims
`https://auth.example.com` and check that the flow, a refresh of tokens issued by that server,
and a flow holding client information bound to it are all refused before any request, with the validator never asked
and the credentials never presented. Metadata naming the origin, with or without a trailing slash and with
endpoints under a path prefix, completes the flow, including the RFC 9207 `iss` check. The former test
of a path-prefix issuer now expects the refusal. The refusal tests fail against the previous library.

## Breaking Changes

A server without Protected Resource Metadata whose authorization server metadata names an issuer other than
its origin is refused instead of used. The TypeScript and Python SDKs already refuse such a server,
and the 2025-03-26 spec places the metadata at the origin.
2026-09-17 13:37:54 +09:00
..
_client Validate the issuer of legacy authorization server metadata 2026-09-17 13:37:54 +09:00
_extensions [Doc] Align the Docs Page Names With the MCP Specification 2026-08-22 18:07:38 +09:00
_includes [Doc] Replace the theme attribution in the nav footer 2026-08-24 16:45:55 +09:00
_preview Add a rake docs:preview task serving the docs site locally 2026-08-25 12:36:54 +09:00
_sass Move the Documentation From README.md to the Documentation Site 2026-08-21 13:24:04 +09:00
_server [Doc] State the Listen Stream Delivery Semantics 2026-09-13 17:10:12 +09:00
assets Move the Documentation From README.md to the Documentation Site 2026-08-21 13:24:04 +09:00
latest Add API documentation with GitHub Pages deployment 2025-11-21 12:21:38 -06:00
_config.yml Move the Documentation From README.md to the Documentation Site 2026-08-21 13:24:04 +09:00
CNAME [Doc] Add CNAME file to preserve custom domain across deployments 2026-03-30 13:27:58 +09:00
examples.md Move the Documentation From README.md to the Documentation Site 2026-08-21 13:24:04 +09:00
favicon.svg Move the Documentation From README.md to the Documentation Site 2026-08-21 13:24:04 +09:00
Gemfile Add a rake docs:preview task serving the docs site locally 2026-08-25 12:36:54 +09:00
index.md [Doc] Align the Docs Page Names With the MCP Specification 2026-08-22 18:07:38 +09:00
installation.md [Doc] Explain when the HTTP client needs event_stream_parser 2026-09-06 03:22:32 +09:00
protocol-versions.md [Doc] Align the Docs Page Names With the MCP Specification 2026-08-22 18:07:38 +09:00