mcp: add client-side OAuth flow (#544)
This is a preliminary implementation of OAuth 2.1 for the client. When a StreamableClientTransport encounters a 401 Unauthorized response from the server, it initiates the OAuth flow described in thec authorization section of the MCP spec (https://modelcontextprotocol.io/specification/2025-06-18/basic/authorization). On success, the transport obtains an access token which it passes to all subsequent requests. Much remains to be done here: * Resource Indicators, as described in section 2.5.1 of the MCP spec. * All of this is unexported, so it is available only to our own StreamingClientTransport. We should add API so people can use it with their own transports. * And, of course, tests. We should test against fake implementations but also, if we can find any, real reference implementations. For #19 Co-authored-by: Jonathan Amsterdam <jba@google.com> --------- Co-authored-by: Jonathan Amsterdam <jba@google.com>
This commit is contained in:
parent
1c3f38f777
commit
069aae16df
1 changed files with 220 additions and 10 deletions
109
auth/client.go
Normal file
109
auth/client.go
Normal file
|
|
@ -0,0 +1,109 @@
|
|||
// 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 auth
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"net/http"
|
||||
"sync"
|
||||
|
||||
"github.com/modelcontextprotocol/go-sdk/internal/oauthex"
|
||||
"golang.org/x/oauth2"
|
||||
)
|
||||
|
||||
// An OAuthHandler conducts an OAuth flow and returns a [oauth2.TokenSource] if the authorization
|
||||
// is approved, or an error if not.
|
||||
type OAuthHandler func(context.Context, OAuthHandlerArgs) (oauth2.TokenSource, error)
|
||||
|
||||
// OAuthHandlerArgs are arguments to an [OAuthHandler].
|
||||
type OAuthHandlerArgs struct {
|
||||
// The URL to fetch protected resource metadata, extracted from the WWW-Authenticate header.
|
||||
// Empty if not present or there was an error obtaining it.
|
||||
ResourceMetadataURL string
|
||||
}
|
||||
|
||||
// HTTPTransport is an [http.RoundTripper] that follows the MCP
|
||||
// OAuth protocol when it encounters a 401 Unauthorized response.
|
||||
type HTTPTransport struct {
|
||||
handler OAuthHandler
|
||||
mu sync.Mutex // protects opts.Base
|
||||
opts HTTPTransportOptions
|
||||
}
|
||||
|
||||
// NewHTTPTransport returns a new [*HTTPTransport].
|
||||
// The handler is invoked when an HTTP request results in a 401 Unauthorized status.
|
||||
// It is called only once per transport. Once a TokenSource is obtained, it is used
|
||||
// for the lifetime of the transport; subsequent 401s are not processed.
|
||||
func NewHTTPTransport(handler OAuthHandler, opts *HTTPTransportOptions) (*HTTPTransport, error) {
|
||||
if handler == nil {
|
||||
return nil, errors.New("handler cannot be nil")
|
||||
}
|
||||
t := &HTTPTransport{
|
||||
handler: handler,
|
||||
}
|
||||
if opts != nil {
|
||||
t.opts = *opts
|
||||
}
|
||||
if t.opts.Base == nil {
|
||||
t.opts.Base = http.DefaultTransport
|
||||
}
|
||||
return t, nil
|
||||
}
|
||||
|
||||
// HTTPTransportOptions are options to [NewHTTPTransport].
|
||||
type HTTPTransportOptions struct {
|
||||
// Base is the [http.RoundTripper] to use.
|
||||
// If nil, [http.DefaultTransport] is used.
|
||||
Base http.RoundTripper
|
||||
}
|
||||
|
||||
func (t *HTTPTransport) RoundTrip(req *http.Request) (*http.Response, error) {
|
||||
t.mu.Lock()
|
||||
base := t.opts.Base
|
||||
t.mu.Unlock()
|
||||
|
||||
resp, err := base.RoundTrip(req)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if resp.StatusCode != http.StatusUnauthorized {
|
||||
return resp, nil
|
||||
}
|
||||
if _, ok := base.(*oauth2.Transport); ok {
|
||||
// We failed to authorize even with a token source; give up.
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
resp.Body.Close()
|
||||
// Try to authorize.
|
||||
t.mu.Lock()
|
||||
defer t.mu.Unlock()
|
||||
// If we don't have a token source, get one by following the OAuth flow.
|
||||
// (We may have obtained one while t.mu was not held above.)
|
||||
// TODO: We hold the lock for the entire OAuth flow. This could be a long
|
||||
// time. Is there a better way?
|
||||
if _, ok := t.opts.Base.(*oauth2.Transport); !ok {
|
||||
authHeaders := resp.Header[http.CanonicalHeaderKey("WWW-Authenticate")]
|
||||
ts, err := t.handler(req.Context(), OAuthHandlerArgs{
|
||||
ResourceMetadataURL: extractResourceMetadataURL(authHeaders),
|
||||
})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
t.opts.Base = &oauth2.Transport{Base: t.opts.Base, Source: ts}
|
||||
}
|
||||
return t.opts.Base.RoundTrip(req.Clone(req.Context()))
|
||||
}
|
||||
|
||||
func extractResourceMetadataURL(authHeaders []string) string {
|
||||
cs, err := oauthex.ParseWWWAuthenticate(authHeaders)
|
||||
if err != nil {
|
||||
return ""
|
||||
}
|
||||
return oauthex.ResourceMetadataURL(cs)
|
||||
}
|
||||
Loading…
Reference in a new issue