This PR introduces client-side OAuth support. # Overall design philosophy The main new interface introduced to support client-side OAuth is the `OAuthHandler`. Contrary to its counter-parts in some other SDKs, it is intentionally small and generic so that it can support most of the OAuth authorization flow variants. The main `mcp` package purposefully delegates almost all auth handling to `OAuthHandler` implementations. This way, the `mcp` package continues to be largely OAuth agnostic. The `auth` package comes with a default `OAuthHandler` implementation – `AuthorizationCodeHandler`, which implements the authorization flow for the `authorization_code` grant type, as defined in the [MCP specification](https://modelcontextprotocol.io/specification/2025-11-25/basic/authorization). It is expected that the `OAuthHandler` implementation granularity will be roughly per grant type, as this parameter influences the authorization flow the most. # Detailed design ## `OAuthHandler` (auth/client.go) The main interface for the integration consists of two methods: ```go type OAuthHandler interface { // TokenSource returns a token source to be used for outgoing requests. // Returned token source might be nil. In that case, the transport will not // add any authorization headers to the request. TokenSource(context.Context) (oauth2.TokenSource, error) // Authorize is called when an HTTP request results in an error that may // be addressed by the authorization flow (currently 401 Unauthorized and 403 Forbidden). // It is responsible for performing the OAuth flow to obtain an access token. // The arguments are the request that failed and the response that was received for it. // The headers of the request are available, but the body will have already been consumed // when Authorize is called. // If the returned error is nil, TokenSource is expected to return a non-nil token source. // After a successful call to Authorize, the HTTP request will be retried by the transport. // The function is responsible for closing the response body. Authorize(context.Context, *http.Request, *http.Response) error } ``` `StreamableClientTransport` accepts this interface as a field and uses the `TokenSource` method to add an `Authorization: Bearer` header to outgoing requests to the MCP server. If the request fails with `401: Unauthorized` or `403: Forbidden`, the transport calls `Authorize` to perform the authorization flow. If `Authorize` returns a non-nil error, the request is retried once. `Authorize` errors do not result in termination of the client session (unless they happen during connection initialization), as some OAuth flows are multi-legged and it should be acceptable to retry for example when the authorization grant was received. *Note:* There was already an `OAuthHandler` type defined as part of a previous iteration of OAuth support. It was renamed to `OAuthHandlerLegacy`. This is the only backwards incompatible API change in the experimental client `auth` part (protected by the `mcp_go_client_oauth` Go build tag). The cost of replacing previous usages is deemed worthwhile to maintain clear naming, under the assumption that the experimental client `auth` part was not widely used. ## `AuthorizationCodeHandler` (auth/authorization_code.go) This is the `OAuthHandler` implementation that fulfills the [MCP specification](https://modelcontextprotocol.io/specification/2025-11-25/basic/authorization). In particular, in supports: - Protected Resource Metadata discovery and fetching - Authorization Server Metadata discovery and fetching - Client registration - OpenID Connect metadata document - Pre-registration - Dynamic Client Registration - PKCE - `client_secret_post`, `client_secret_basic` token endpoint auth methods - Automatic refresh of tokens ### Authorization Server redirect As part of the flow for the `authorization_code` grant type, the client needs to point the user to the authorization URL, so that they confirm the access request. This design proposes that it will be supported via a pluggable dependency that will initiate this process in an application-specific way: ```go type AuthorizationCodeHandler struct { ... // AuthorizationCodeFetcher is a required function called to initiate the authorization flow. // It is responsible for opening the URL in a browser for the user to start the authorization process. // It should return the authorization code and state once the Authorization Server // redirects back to the RedirectURL. AuthorizationCodeFetcher func(ctx context.Context, args *AuthorizationArgs) (*AuthorizationResult, error) ... } ``` The function is supposed perform any application specific logic to handle the redirect from the Authorization Server and return the resulting code and state. ## `oauthex` changes Some additional/adjusted building blocks that may be useful when creating `OAuthHandler` implementations are present in the `oauthex` package: - `auth_meta.go`: Authorization Server Metadata utilities: - `GetAuthServerMeta`: get Authorization Server Metadata from a URL - `dcr.go`: Dynamic Client Registration utilities (unchanged) - `resource_meta.go`: Protected Resource Metadata utilities: - `GetProtectedResourceMetadata`: get Protected Resource Metadata from a URL - `ParseWWWAuthenticate` – as per name (unchanged) - [deprecated] `GetProtectedResourceMetadataFromID` and `GetProtectedResourceMetadataFromHeader` in favor of more generic `GetProtectedResourceMetadata`. They will be kept under the Go build tag and removed one version of the SDK in the future.
320 lines
8.5 KiB
Go
320 lines
8.5 KiB
Go
// Copyright 2025 The Go MCP SDK Authors. All rights reserved.
|
|
// Use of this source code is governed by an MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
//go:build mcp_go_client_oauth
|
|
|
|
package oauthex
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"reflect"
|
|
"testing"
|
|
)
|
|
|
|
func TestSplitChallenges(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
input string
|
|
want []string
|
|
}{
|
|
{
|
|
name: "single challenge no params",
|
|
input: `Basic`,
|
|
want: []string{`Basic`},
|
|
},
|
|
{
|
|
name: "single challenge with params",
|
|
input: `Bearer realm="example.com", error="invalid_token"`,
|
|
want: []string{`Bearer realm="example.com", error="invalid_token"`},
|
|
},
|
|
{
|
|
name: "single challenge with comma in quoted string",
|
|
input: `Bearer realm="example, with comma"`,
|
|
want: []string{`Bearer realm="example, with comma"`},
|
|
},
|
|
{
|
|
name: "two challenges",
|
|
input: `Basic, Bearer realm="example"`,
|
|
want: []string{`Basic`, ` Bearer realm="example"`},
|
|
},
|
|
{
|
|
name: "multiple challenges complex",
|
|
input: `Newauth realm="apps", Basic, Bearer realm="example.com", error="invalid_token"`,
|
|
want: []string{`Newauth realm="apps"`, ` Basic`, ` Bearer realm="example.com", error="invalid_token"`},
|
|
},
|
|
{
|
|
name: "challenge with escaped quote",
|
|
input: `Bearer realm="example \"quoted\""`,
|
|
want: []string{`Bearer realm="example \"quoted\""`},
|
|
},
|
|
{
|
|
name: "empty input",
|
|
input: "",
|
|
want: []string{""},
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
got, err := splitChallenges(tt.input)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if !reflect.DeepEqual(got, tt.want) {
|
|
t.Errorf("splitChallenges() = %v, want %v", got, tt.want)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestSplitChallengesError(t *testing.T) {
|
|
if _, err := splitChallenges(`"Bearer"`); err == nil {
|
|
t.Fatal("got nil, want error")
|
|
}
|
|
}
|
|
|
|
func TestParseSingleChallenge(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
input string
|
|
want Challenge
|
|
wantErr bool
|
|
}{
|
|
{
|
|
name: "scheme only",
|
|
input: "Basic",
|
|
want: Challenge{
|
|
Scheme: "basic",
|
|
},
|
|
wantErr: false,
|
|
},
|
|
{
|
|
name: "scheme with one quoted param",
|
|
input: `Bearer realm="example.com"`,
|
|
want: Challenge{
|
|
Scheme: "bearer",
|
|
Params: map[string]string{"realm": "example.com"},
|
|
},
|
|
wantErr: false,
|
|
},
|
|
{
|
|
name: "scheme with one unquoted param",
|
|
input: `Bearer realm=example.com`,
|
|
want: Challenge{
|
|
Scheme: "bearer",
|
|
Params: map[string]string{"realm": "example.com"},
|
|
},
|
|
wantErr: false,
|
|
},
|
|
{
|
|
name: "scheme with multiple params",
|
|
input: `Bearer realm="example", error="invalid_token", error_description="The token expired"`,
|
|
want: Challenge{
|
|
Scheme: "bearer",
|
|
Params: map[string]string{
|
|
"realm": "example",
|
|
"error": "invalid_token",
|
|
"error_description": "The token expired",
|
|
},
|
|
},
|
|
wantErr: false,
|
|
},
|
|
{
|
|
name: "scheme with multiple unquoted params",
|
|
input: `Bearer realm=example, error=invalid_token, error_description=The token expired`,
|
|
want: Challenge{
|
|
Scheme: "bearer",
|
|
Params: map[string]string{
|
|
"realm": "example",
|
|
"error": "invalid_token",
|
|
"error_description": "The token expired",
|
|
},
|
|
},
|
|
wantErr: false,
|
|
},
|
|
{
|
|
name: "case-insensitive scheme and keys",
|
|
input: `BEARER ReAlM="example"`,
|
|
want: Challenge{
|
|
Scheme: "bearer",
|
|
Params: map[string]string{"realm": "example"},
|
|
},
|
|
wantErr: false,
|
|
},
|
|
{
|
|
name: "param with escaped quote",
|
|
input: `Bearer realm="example \"foo\" bar"`,
|
|
want: Challenge{
|
|
Scheme: "bearer",
|
|
Params: map[string]string{"realm": `example "foo" bar`},
|
|
},
|
|
wantErr: false,
|
|
},
|
|
{
|
|
name: "param without quotes (token)",
|
|
input: "Bearer realm=example.com",
|
|
want: Challenge{
|
|
Scheme: "bearer",
|
|
Params: map[string]string{"realm": "example.com"},
|
|
},
|
|
wantErr: false,
|
|
},
|
|
{
|
|
name: "malformed param - no value",
|
|
input: "Bearer realm=",
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "malformed param - unterminated quote",
|
|
input: `Bearer realm="example`,
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "malformed param - missing comma",
|
|
input: `Bearer realm="a" error="b"`,
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "malformed param - initial equal",
|
|
input: `Bearer ="a"`,
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "empty input",
|
|
input: "",
|
|
wantErr: true,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
got, err := parseSingleChallenge(tt.input)
|
|
if (err != nil) != tt.wantErr {
|
|
t.Errorf("parseSingleChallenge() error = %v, wantErr %v", err, tt.wantErr)
|
|
return
|
|
}
|
|
if !reflect.DeepEqual(got, tt.want) {
|
|
t.Errorf("parseSingleChallenge() = %v, want %v", got, tt.want)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestGetProtectedResourceMetadata(t *testing.T) {
|
|
ctx := context.Background()
|
|
t.Run("FromHeader", func(t *testing.T) {
|
|
h := &fakeResourceHandler{serveWWWAuthenticate: true}
|
|
server := httptest.NewTLSServer(h)
|
|
h.installHandlers(server.URL)
|
|
client := server.Client()
|
|
serverURL := server.URL + "/resource"
|
|
res, err := client.Get(serverURL)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if res.StatusCode != http.StatusUnauthorized {
|
|
t.Fatal("want unauth")
|
|
}
|
|
prm, err := GetProtectedResourceMetadataFromHeader(ctx, serverURL, res.Header, client)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if prm == nil {
|
|
t.Fatal("nil prm")
|
|
}
|
|
})
|
|
t.Run("FromID", func(t *testing.T) {
|
|
h := &fakeResourceHandler{serveWWWAuthenticate: false}
|
|
server := httptest.NewTLSServer(h)
|
|
h.installHandlers(server.URL)
|
|
client := server.Client()
|
|
prm, err := GetProtectedResourceMetadataFromID(ctx, server.URL, client)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if prm == nil {
|
|
t.Fatal("nil prm")
|
|
}
|
|
})
|
|
// Test that metadata URL and resource identifier are properly distinguished (issue #560).
|
|
t.Run("FromHeaderValidatesAgainstServerURL", func(t *testing.T) {
|
|
h := &fakeResourceHandler{serveWWWAuthenticate: true}
|
|
server := httptest.NewTLSServer(h)
|
|
h.installHandlers(server.URL)
|
|
client := server.Client()
|
|
serverURL := server.URL + "/resource"
|
|
res, err := client.Get(serverURL)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
// This should succeed because we validate against serverURL, not metadataURL
|
|
prm, err := GetProtectedResourceMetadataFromHeader(ctx, serverURL, res.Header, client)
|
|
if err != nil {
|
|
t.Fatalf("Expected validation to succeed, got error: %v", err)
|
|
}
|
|
if prm == nil {
|
|
t.Fatal("Expected non-nil prm")
|
|
}
|
|
if prm.Resource != serverURL {
|
|
t.Errorf("Expected resource %q, got %q", serverURL, prm.Resource)
|
|
}
|
|
})
|
|
t.Run("FromHeaderRejectsImpersonation", func(t *testing.T) {
|
|
h := &fakeResourceHandler{serveWWWAuthenticate: true, resourceOverride: "https://attacker.com/evil"}
|
|
server := httptest.NewTLSServer(h)
|
|
h.installHandlers(server.URL)
|
|
client := server.Client()
|
|
serverURL := server.URL + "/resource"
|
|
res, err := client.Get(serverURL)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
prm, err := GetProtectedResourceMetadataFromHeader(ctx, serverURL, res.Header, client)
|
|
if err == nil {
|
|
t.Fatal("Expected validation error for mismatched resource, got nil")
|
|
}
|
|
if prm != nil {
|
|
t.Fatal("Expected nil prm on validation failure")
|
|
}
|
|
})
|
|
}
|
|
|
|
type fakeResourceHandler struct {
|
|
http.ServeMux
|
|
serveWWWAuthenticate bool
|
|
resourceOverride string // If set, use this instead of correct resource (for testing validation)
|
|
}
|
|
|
|
func (h *fakeResourceHandler) installHandlers(serverURL string) {
|
|
path := "/.well-known/oauth-protected-resource"
|
|
url := serverURL + path
|
|
h.Handle("GET /resource", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
if h.serveWWWAuthenticate {
|
|
w.Header().Set("WWW-Authenticate", fmt.Sprintf(`Bearer resource_metadata="%s"`, url))
|
|
}
|
|
w.WriteHeader(http.StatusUnauthorized)
|
|
}))
|
|
h.Handle("GET "+path, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
w.Header().Set("Content-Type", "application/json")
|
|
// Per RFC 9728 section 3.3, the resource field should contain the actual resource identifier,
|
|
// which is the URL the client uses to access the resource (serverURL + "/resource" for WWW-Authenticate case).
|
|
// For the FromID test case, it's just the serverURL.
|
|
resource := serverURL
|
|
if h.serveWWWAuthenticate {
|
|
resource = serverURL + "/resource"
|
|
}
|
|
// Allow testing with custom resource values (e.g., impersonation attacks).
|
|
if h.resourceOverride != "" {
|
|
resource = h.resourceOverride
|
|
}
|
|
prm := &ProtectedResourceMetadata{Resource: resource}
|
|
if err := json.NewEncoder(w).Encode(prm); err != nil {
|
|
panic(err)
|
|
}
|
|
}))
|
|
}
|