Skip to content

internal/testing: fake auth server #296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ module github.com/modelcontextprotocol/go-sdk
go 1.23.0

require (
github.com/golang-jwt/jwt/v5 v5.2.1
github.com/google/go-cmp v0.7.0
github.com/google/jsonschema-go v0.2.0
github.com/yosida95/uritemplate/v3 v3.0.2
Expand Down
2 changes: 2 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
github.com/golang-jwt/jwt/v5 v5.2.1 h1:OuVbFODueb089Lh128TAcimifWaLhJwVflnrgM17wHk=
github.com/golang-jwt/jwt/v5 v5.2.1/go.mod h1:pqrtFR0X4osieyHYxtmOUWsAWrfe1Q5UVIyoH402zdk=
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
github.com/google/jsonschema-go v0.2.0 h1:Uh19091iHC56//WOsAd1oRg6yy1P9BpSvpjOL6RcjLQ=
Expand Down
165 changes: 165 additions & 0 deletions internal/testing/fake_auth_server.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
package testing

import (
"crypto/sha256"
"encoding/base64"
"encoding/json"
"fmt"
"log"
"net/http"
"time"

"github.com/golang-jwt/jwt/v5"
)

const (
authServerPort = ":8080"
issuer = "http://localhost" + authServerPort
tokenExpiry = time.Hour
)

var jwtSigningKey = []byte("fake-secret-key")

type authCodeInfo struct {
codeChallenge string
redirectURI string
}

// FakeAuthServer is a fake OAuth2 authorization server.
type FakeAuthServer struct {
server *http.Server
authCodes map[string]authCodeInfo
}

func NewFakeAuthServer() *FakeAuthServer {
server := &FakeAuthServer{
authCodes: make(map[string]authCodeInfo),
}
mux := http.NewServeMux()
mux.HandleFunc("/.well-known/oauth-authorization-server", server.handleMetadata)
mux.HandleFunc("/authorize", server.handleAuthorize)
mux.HandleFunc("/token", server.handleToken)
server.server = &http.Server{
Addr: authServerPort,
Handler: mux,
}
return server
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of a complete fake server, would it be simpler to have a this package provide a ServeMux? In the case where you want a server, you can use httptest:

srv := httptest.NewServer(fakeauth.NewMux())

This pushes the start-a-server logic off to httptest, which already handles it, and doesn't seem substantially less convenient to use in tests.

}

func (s *FakeAuthServer) Start() {
go func() {
if err := s.server.ListenAndServe(); err != http.ErrServerClosed {
log.Fatalf("ListenAndServe(): %v", err)
}
}()
}

func (s *FakeAuthServer) Stop() {
if err := s.server.Close(); err != nil {
log.Printf("Failed to stop server: %v", err)
}
}

func (s *FakeAuthServer) handleMetadata(w http.ResponseWriter, r *http.Request) {
metadata := map[string]any{
"issuer": issuer,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of hardcoding http://localhost:8080 as the issuer, should this use r.URL to find either the name or the port?

RFC 8414 says the issuer is present to prevent "mix-up" attacks, but that's probably not much of a concern for a test-only implementation. To be extra cautious, however, maybe this could set the issuer to "http://localhost:" + r.URL.Port().

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

RFC 8414 requires most/all of the URLs here to have an "https" scheme. The test server uses HTTP. Not sure if this is going to be a problem in practice, but this might be something else using httptest would help with, since it handles setting up a test server with TLS support.

"authorization_endpoint": issuer + "/authorize",
"token_endpoint": issuer + "/token",
"jwks_uri": issuer + "/.well-known/jwks.json",
"scopes_supported": []string{"openid", "profile", "email"},
"response_types_supported": []string{"code"},
"grant_types_supported": []string{"authorization_code"},
"token_endpoint_auth_methods_supported": []string{"none"},
"code_challenge_methods_supported": []string{"S256"},
}
w.Header().Set("Content-Type", "application/json")
json.NewEncoder(w).Encode(metadata)
}

func (s *FakeAuthServer) handleAuthorize(w http.ResponseWriter, r *http.Request) {
query := r.URL.Query()
responseType := query.Get("response_type")
redirectURI := query.Get("redirect_uri")
codeChallenge := query.Get("code_challenge")
codeChallengeMethod := query.Get("code_challenge_method")

if responseType != "code" {
http.Error(w, "unsupported_response_type", http.StatusBadRequest)
return
}
if redirectURI == "" {
http.Error(w, "invalid_request", http.StatusBadRequest)
return
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might be missing something, but I believe redirect_uri is an optional parameter and only needs to be provided if a client has registered more than one redirect URI.

I'm going to guess that this fake auth server will only be used with clients that always provide a redirect_uri?

if codeChallenge == "" || codeChallengeMethod != "S256" {
http.Error(w, "invalid_request", http.StatusBadRequest)
return
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this check for the required client_id field? (It doesn't use it, but perhaps it would be useful to return an error to a client which fails to provide it?)


authCode := "fake-auth-code-" + fmt.Sprintf("%d", time.Now().UnixNano())
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unlikely though it is for a collision to happen here, perhaps this should include a counter or random component?

s.authCodes[authCode] = authCodeInfo{
codeChallenge: codeChallenge,
redirectURI: redirectURI,
}

redirectURL := fmt.Sprintf("%s?code=%s&state=%s", redirectURI, authCode, query.Get("state"))
http.Redirect(w, r, redirectURL, http.StatusFound)
}

func (s *FakeAuthServer) handleToken(w http.ResponseWriter, r *http.Request) {
r.ParseForm()
grantType := r.Form.Get("grant_type")
code := r.Form.Get("code")
redirectURI := r.Form.Get("redirect_uri")
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

redirect_uri was removed in OAuth 2.1:
https://www.ietf.org/archive/id/draft-ietf-oauth-v2-1-13.html#redirect-uri-in-token-request

If this needs to support OAuth 2.0 clients, I believe it should validate redirect_uri when present but not complain when it isn't present. I suspect there's more to be done to support OAuth 2.0, though--I haven't checked to see what else changes. If this is only supporting OAuth 2.1 (https://modelcontextprotocol.io/specification/draft/basic/authorization only mentions 2.1) then I think it can ignore redirect_uri.

codeVerifier := r.Form.Get("code_verifier")

if grantType != "authorization_code" {
http.Error(w, "unsupported_grant_type", http.StatusBadRequest)
return
}

authCodeInfo, ok := s.authCodes[code]
if !ok {
http.Error(w, "invalid_grant", http.StatusBadRequest)
return
}
delete(s.authCodes, code)

if authCodeInfo.redirectURI != redirectURI {
http.Error(w, "invalid_grant", http.StatusBadRequest)
return
}

// PKCE verification
hasher := sha256.New()
hasher.Write([]byte(codeVerifier))
calculatedChallenge := base64.RawURLEncoding.EncodeToString(hasher.Sum(nil))
if calculatedChallenge != authCodeInfo.codeChallenge {
http.Error(w, "invalid_grant", http.StatusBadRequest)
return
}

// Issue JWT
now := time.Now()
claims := jwt.MapClaims{
"iss": issuer,
"sub": "fake-user-id",
"aud": "fake-client-id",
"exp": now.Add(tokenExpiry).Unix(),
"iat": now.Unix(),
}
token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
accessToken, err := token.SignedString(jwtSigningKey)
if err != nil {
http.Error(w, "server_error", http.StatusInternalServerError)
return
}

tokenResponse := map[string]any{
"access_token": accessToken,
"token_type": "Bearer",
"expires_in": int(tokenExpiry.Seconds()),
}
w.Header().Set("Content-Type", "application/json")
json.NewEncoder(w).Encode(tokenResponse)
}