ruby-sdk/test/mcp/client/oauth/cross_app_access_provider_test.rb
Koichi ITO 8ad80dd0b4 Let a provider add parameters to the token requests it makes
## Motivation and Context

`ClientCredentialsProvider` builds a fixed `client_credentials` token request: `grant_type`, `scope`,
`resource`, and the client authentication that `Flow#post_to_token_endpoint` adds. An authorization server
that requires further parameters, such as Auth0's `audience`, cannot be used through `oauth:` at all,
and giving up `oauth:` also gives up the bearer header and the 401-driven retry that the transport provides.

RFC 6749 Section 8.2 allows extension parameters on the token request, and the TypeScript SDK lets
a provider shape its token request through `prepareTokenRequest`. `ClientCredentialsProvider.new` now takes
`token_request_params:`, a Hash of String keys and values added to every token request the provider makes,
and `Flow#post_to_token_endpoint` reads the same name by duck typing, so a `Provider` or `CrossAppAccessProvider`
subclass that defines the method gets the same treatment on its authorization code exchange, refresh,
or `jwt-bearer` request.
`Provider.new` and `CrossAppAccessProvider.new` take the same keyword, held by `StorageBackedProvider` like
`authorization_request_validator`, so every bundled provider refuses a bad value before anything is stored.

The parameters go underneath the flow's own, so the SDK's values always win, and a key the SDK sets itself
(`Flow::RESERVED_TOKEN_REQUEST_PARAMS`) is refused rather than silently overridden: with `ArgumentError`
from the constructor, before any `client_information` is written, and again with `ArgumentError` from the flow,
before the token request is sent. Only Strings are accepted because `URI.encode_www_form` encodes other scalars
and Arrays in ways the caller did not write, and the provider keeps a frozen copy so a later change to
the caller's Hash cannot alter what is sent.
A Hash comparing keys by identity is refused too, since two equal keys are two entries there, sent twice
by a provider method or silently collapsed into one by the copy. The flow raises `ArgumentError` rather than
`AuthorizationError` because `MCP::Client::HTTP` treats a failed refresh as a reason to run the interactive flow,
which would then fail the same way after the user signed in.
Both refusals raise `Flow::InvalidTokenRequestParamsError`, a subclass of `ArgumentError`, so a caller can tell them
from an unknown keyword, and the copy duplicates keys as well as values, since `Hash` copies only keys
whose class is exactly `String`.

Fixes #554.

## How Has This Been Tested?

New tests cover every token request the parameters can ride (the `client_credentials` grant under
all three client authentication methods, the authorization code exchange, refresh, and `jwt-bearer`),
both refusal boundaries (the constructors of all three providers, and the flow for a provider defining the method),
and the transport surfacing a refused hook from a refresh attempt without starting the interactive flow.
All of them fail against the previous library.

## Breaking Changes

None. The keyword is optional and the hook is opt-in; a provider that does not define `token_request_params` sends
the same requests as before.
2026-09-17 13:26:52 +09:00

130 lines
4.3 KiB
Ruby

# frozen_string_literal: true
require "test_helper"
require "mcp/client/oauth"
module MCP
class Client
module OAuth
class CrossAppAccessProviderTest < Minitest::Test
def build_provider(assertion_provider: ->(**) { "id-jag" })
CrossAppAccessProvider.new(
client_id: "xaa-client",
client_secret: "xaa-secret",
assertion_provider: assertion_provider,
)
end
def test_initialize_stores_credentials_with_basic_auth_method
provider = build_provider
info = provider.client_information
assert_equal("xaa-client", info["client_id"])
assert_equal("xaa-secret", info["client_secret"])
assert_equal("client_secret_basic", info["token_endpoint_auth_method"])
end
def test_authorization_flow_is_jwt_bearer
assert_equal(:jwt_bearer, build_provider.authorization_flow)
end
def test_jwt_bearer_assertion_passes_audience_and_resource_through
received = nil
provider = build_provider(
assertion_provider: ->(audience:, resource:) {
received = { audience: audience, resource: resource }
"id-jag-assertion"
},
)
assertion = provider.jwt_bearer_assertion(
audience: "https://auth.example.com",
resource: "https://srv.example.com/mcp",
)
assert_equal("id-jag-assertion", assertion)
assert_equal(
{ audience: "https://auth.example.com", resource: "https://srv.example.com/mcp" },
received,
)
end
def test_initialize_rejects_missing_client_id
assert_raises(CrossAppAccessProvider::InvalidConfigurationError) do
CrossAppAccessProvider.new(
client_id: " ",
client_secret: "xaa-secret",
assertion_provider: ->(**) { "id-jag" },
)
end
end
def test_initialize_rejects_missing_client_secret
# SEP-990 authenticates the jwt-bearer grant with client_secret_basic.
assert_raises(CrossAppAccessProvider::InvalidConfigurationError) do
CrossAppAccessProvider.new(
client_id: "xaa-client",
client_secret: nil,
assertion_provider: ->(**) { "id-jag" },
)
end
end
def test_initialize_rejects_non_callable_assertion_provider
assert_raises(CrossAppAccessProvider::InvalidConfigurationError) do
CrossAppAccessProvider.new(
client_id: "xaa-client",
client_secret: "xaa-secret",
assertion_provider: "not callable",
)
end
end
def test_token_helpers_delegate_to_storage
provider = build_provider
provider.save_tokens("access_token" => "xaa-token")
assert_equal("xaa-token", provider.access_token)
provider.clear_tokens!
assert_nil(provider.tokens)
end
def test_token_request_params_is_nil_by_default
assert_nil(build_provider.token_request_params)
end
def test_initialize_keeps_a_frozen_copy_of_token_request_params
params = { "audience" => +"https://api.example.com" }
provider = CrossAppAccessProvider.new(
client_id: "xaa-client",
client_secret: "xaa-secret",
assertion_provider: ->(**) { "id-jag" },
token_request_params: params,
)
params["audience"] << "/changed"
assert_equal({ "audience" => "https://api.example.com" }, provider.token_request_params)
assert_predicate(provider.token_request_params, :frozen?)
end
def test_initialize_writes_no_client_information_when_token_request_params_are_rejected
storage = InMemoryStorage.new
error = assert_raises(Flow::InvalidTokenRequestParamsError) do
CrossAppAccessProvider.new(
client_id: "xaa-client",
client_secret: "xaa-secret",
assertion_provider: ->(**) { "id-jag" },
storage: storage,
token_request_params: { "assertion" => "x" },
)
end
assert_includes(error.message, '"assertion"')
assert_nil(storage.client_information)
end
end
end
end
end