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.
This commit is contained in:
Koichi ITO
parent
41fbf05d26
commit
8ad80dd0b4
1 changed files with 583 additions and 24 deletions
|
|
@ -7,6 +7,23 @@ module MCP
|
|||
class Client
|
||||
module OAuth
|
||||
class ClientCredentialsProviderTest < Minitest::Test
|
||||
# Every parameter the flow sets on a token request, spelled out rather than read from
|
||||
# `Flow::RESERVED_TOKEN_REQUEST_PARAMS`, so a key dropped from that constant fails here.
|
||||
RESERVED_TOKEN_REQUEST_PARAMS = [
|
||||
"grant_type",
|
||||
"client_id",
|
||||
"client_secret",
|
||||
"client_assertion",
|
||||
"client_assertion_type",
|
||||
"scope",
|
||||
"resource",
|
||||
"code",
|
||||
"code_verifier",
|
||||
"redirect_uri",
|
||||
"refresh_token",
|
||||
"assertion",
|
||||
].freeze
|
||||
|
||||
def test_initialize_stores_credentials_as_client_information
|
||||
provider = ClientCredentialsProvider.new(client_id: "cc-client", client_secret: "cc-secret")
|
||||
|
||||
|
|
@ -160,6 +177,90 @@ module MCP
|
|||
assert_equal("cc-client", claims["sub"])
|
||||
assert_equal("https://auth.example.com", claims["aud"])
|
||||
end
|
||||
|
||||
def test_token_request_params_is_nil_by_default
|
||||
provider = ClientCredentialsProvider.new(client_id: "cc-client", client_secret: "cc-secret")
|
||||
|
||||
assert_nil(provider.token_request_params)
|
||||
end
|
||||
|
||||
def test_initialize_keeps_a_frozen_copy_of_token_request_params
|
||||
params = { "audience" => +"https://api.example.com" }
|
||||
provider = ClientCredentialsProvider.new(client_id: "cc-client", client_secret: "cc-secret", token_request_params: params)
|
||||
|
||||
params["audience"] << "/changed"
|
||||
params["organization"] = "org_123"
|
||||
|
||||
assert_equal({ "audience" => "https://api.example.com" }, provider.token_request_params)
|
||||
assert_predicate(provider.token_request_params, :frozen?)
|
||||
assert_predicate(provider.token_request_params["audience"], :frozen?)
|
||||
end
|
||||
|
||||
def test_initialize_rejects_token_request_params_that_the_sdk_sets_itself
|
||||
RESERVED_TOKEN_REQUEST_PARAMS.each do |key|
|
||||
error = assert_raises(Flow::InvalidTokenRequestParamsError, "should reject #{key.inspect}") do
|
||||
ClientCredentialsProvider.new(client_id: "cc-client", client_secret: "cc-secret", token_request_params: { key => "x" })
|
||||
end
|
||||
|
||||
assert_includes(error.message, key.inspect)
|
||||
end
|
||||
end
|
||||
|
||||
def test_initialize_rejects_token_request_params_that_are_not_a_hash_of_strings
|
||||
["audience=x", { audience: "x" }, { "audience" => 1 }, { "audience" => nil }].each do |params|
|
||||
assert_raises(Flow::InvalidTokenRequestParamsError, "should reject #{params.inspect}") do
|
||||
ClientCredentialsProvider.new(client_id: "cc-client", client_secret: "cc-secret", token_request_params: params)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def test_initialize_rejects_token_request_params_that_compare_keys_by_identity
|
||||
# Two equal keys are two entries in such a Hash and would silently collapse into one when copied.
|
||||
error = assert_raises(Flow::InvalidTokenRequestParamsError) do
|
||||
ClientCredentialsProvider.new(
|
||||
client_id: "cc-client",
|
||||
client_secret: "cc-secret",
|
||||
token_request_params: { "audience" => "x" }.compare_by_identity,
|
||||
)
|
||||
end
|
||||
|
||||
assert_match(/identity/, error.message)
|
||||
end
|
||||
|
||||
def test_initialize_copies_keys_that_hash_would_share_with_the_caller
|
||||
# `Hash` copies and freezes only keys whose class is exactly `String`; a subclass key would otherwise
|
||||
# stay shared with the caller, and a later `replace` would turn it into a reserved name.
|
||||
key = Class.new(String).new("audience")
|
||||
provider = ClientCredentialsProvider.new(client_id: "cc-client", client_secret: "cc-secret", token_request_params: { key => "x" })
|
||||
|
||||
key.replace("grant_type")
|
||||
|
||||
assert_equal({ "audience" => "x" }, provider.token_request_params)
|
||||
refute_same(key, provider.token_request_params.keys.first)
|
||||
assert_predicate(provider.token_request_params.keys.first, :frozen?)
|
||||
end
|
||||
|
||||
def test_initialize_keeps_empty_token_request_params_as_a_frozen_empty_hash
|
||||
provider = ClientCredentialsProvider.new(client_id: "cc-client", client_secret: "cc-secret", token_request_params: {})
|
||||
|
||||
assert_equal({}, 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
|
||||
|
||||
assert_raises(Flow::InvalidTokenRequestParamsError) do
|
||||
ClientCredentialsProvider.new(
|
||||
client_id: "cc-client",
|
||||
client_secret: "cc-secret",
|
||||
storage: storage,
|
||||
token_request_params: { "grant_type" => "password" },
|
||||
)
|
||||
end
|
||||
|
||||
assert_nil(storage.client_information)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
|
|||
Loading…
Reference in a new issue