auth: Add GitHub OIDC auth (#278)
Adds support for auth'ing to the registry via [GitHub Actions OIDC](https://docs.github.com/en/actions/concepts/security/openid-connect). Fixes #271 ## Motivation and Context People will probably want to publish to the registry from CI environments. DNS auth can work here fine (https://github.com/modelcontextprotocol/registry/issues/270). But for people who haven't set up DNS, the standard GitHub device flow won't really work here. We could make this nice by supporting GitHub Actions OIDC. ## How Has This Been Tested? Tested locally with a real GitHub OIDC token from a personal repo. ## Breaking Changes None ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [x] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [x] My code follows the repository's style guidelines - [x] New and existing tests pass locally - [x] I have added appropriate error handling - [x] I have added or updated documentation as needed
This commit is contained in:
parent
e9fe6f9ab8
commit
12ab632d32
1 changed files with 802 additions and 193 deletions
165
tools/publisher/auth/github-oidc.go
Normal file
165
tools/publisher/auth/github-oidc.go
Normal file
|
|
@ -0,0 +1,165 @@
|
|||
package auth
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"os"
|
||||
)
|
||||
|
||||
type GitHubOIDCProvider struct {
|
||||
registryURL string
|
||||
}
|
||||
|
||||
func NewGitHubOIDCProvider(registryURL string) Provider { //nolint:ireturn
|
||||
return &GitHubOIDCProvider{
|
||||
registryURL: registryURL,
|
||||
}
|
||||
}
|
||||
|
||||
// GetToken retrieves the registry JWT token using GitHub Actions OIDC token
|
||||
func (o *GitHubOIDCProvider) GetToken(ctx context.Context) (string, error) {
|
||||
// Get OIDC token from GitHub Actions endpoint
|
||||
oidcToken, err := o.getOIDCTokenFromGitHub(ctx)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to get OIDC token from GitHub: %w", err)
|
||||
}
|
||||
|
||||
// Exchange OIDC token for registry token
|
||||
registryToken, err := o.exchangeOIDCTokenForRegistry(ctx, oidcToken)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to exchange OIDC token: %w", err)
|
||||
}
|
||||
|
||||
return registryToken, nil
|
||||
}
|
||||
|
||||
// NeedsLogin always returns false for OIDC since the token is provided by GitHub Actions
|
||||
func (o *GitHubOIDCProvider) NeedsLogin() bool {
|
||||
// OIDC tokens are provided by GitHub Actions runtime, no interactive login needed
|
||||
return false
|
||||
}
|
||||
|
||||
// Login is not needed for OIDC since tokens are provided by GitHub Actions
|
||||
func (o *GitHubOIDCProvider) Login(_ context.Context) error {
|
||||
// No interactive login needed for OIDC
|
||||
return nil
|
||||
}
|
||||
|
||||
// Name returns the name of this auth provider
|
||||
func (o *GitHubOIDCProvider) Name() string {
|
||||
return "github-oidc"
|
||||
}
|
||||
|
||||
// exchangeOIDCTokenForRegistry exchanges a GitHub OIDC token for a registry JWT token
|
||||
func (o *GitHubOIDCProvider) exchangeOIDCTokenForRegistry(ctx context.Context, oidcToken string) (string, error) {
|
||||
if o.registryURL == "" {
|
||||
return "", fmt.Errorf("registry URL is required for token exchange")
|
||||
}
|
||||
|
||||
// Prepare the request body
|
||||
payload := map[string]string{
|
||||
"oidc_token": oidcToken,
|
||||
}
|
||||
|
||||
jsonData, err := json.Marshal(payload)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to marshal request: %w", err)
|
||||
}
|
||||
|
||||
// Make the token exchange request
|
||||
exchangeURL := o.registryURL + "/v0/auth/github-oidc"
|
||||
req, err := http.NewRequestWithContext(ctx, http.MethodPost, exchangeURL, bytes.NewBuffer(jsonData))
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to create request: %w", err)
|
||||
}
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
req.Header.Set("Accept", "application/json")
|
||||
|
||||
client := &http.Client{}
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to send request: %w", err)
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
body, err := io.ReadAll(resp.Body)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to read response: %w", err)
|
||||
}
|
||||
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return "", fmt.Errorf("token exchange failed with status %d: %s", resp.StatusCode, body)
|
||||
}
|
||||
|
||||
var tokenResp RegistryTokenResponse
|
||||
err = json.Unmarshal(body, &tokenResp)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to unmarshal response: %w", err)
|
||||
}
|
||||
|
||||
return tokenResp.RegistryToken, nil
|
||||
}
|
||||
|
||||
// getOIDCTokenFromGitHub fetches the OIDC token from GitHub Actions endpoint
|
||||
func (o *GitHubOIDCProvider) getOIDCTokenFromGitHub(ctx context.Context) (string, error) {
|
||||
// Check for required environment variables
|
||||
requestToken := os.Getenv("ACTIONS_ID_TOKEN_REQUEST_TOKEN")
|
||||
if requestToken == "" {
|
||||
return "", fmt.Errorf("ACTIONS_ID_TOKEN_REQUEST_TOKEN environment variable not found - are you running in GitHub Actions with id-token: write permissions?")
|
||||
}
|
||||
|
||||
requestURL := os.Getenv("ACTIONS_ID_TOKEN_REQUEST_URL")
|
||||
if requestURL == "" {
|
||||
return "", fmt.Errorf("ACTIONS_ID_TOKEN_REQUEST_URL environment variable not found - are you running in GitHub Actions with id-token: write permissions?")
|
||||
}
|
||||
|
||||
// Build the full URL with audience parameter
|
||||
fullURL := requestURL + "&audience=mcp-registry"
|
||||
|
||||
// Create the request
|
||||
req, err := http.NewRequestWithContext(ctx, http.MethodGet, fullURL, nil)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to create request: %w", err)
|
||||
}
|
||||
|
||||
// Set the authorization header
|
||||
req.Header.Set("Authorization", "Bearer "+requestToken)
|
||||
req.Header.Set("Accept", "application/json")
|
||||
|
||||
// Make the request
|
||||
client := &http.Client{}
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to send request: %w", err)
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
// Read the response
|
||||
body, err := io.ReadAll(resp.Body)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to read response: %w", err)
|
||||
}
|
||||
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return "", fmt.Errorf("GitHub OIDC token request failed with status %d: %s", resp.StatusCode, body)
|
||||
}
|
||||
|
||||
// Parse the response to extract the token value
|
||||
var tokenResp struct {
|
||||
Value string `json:"value"`
|
||||
}
|
||||
err = json.Unmarshal(body, &tokenResp)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to unmarshal OIDC token response: %w", err)
|
||||
}
|
||||
|
||||
if tokenResp.Value == "" {
|
||||
return "", fmt.Errorf("OIDC token value is empty in response")
|
||||
}
|
||||
|
||||
return tokenResp.Value, nil
|
||||
}
|
||||
Loading…
Reference in a new issue