registry/internal/auth/jwt.go
Radoslav Dimitrov 099a2d702e
Deduplicate server JSON structs between publisher and registry (#318)
<!-- Provide a brief summary of your changes -->

## Motivation and Context
<!-- Why is this change needed? What problem does it solve? -->

The following PR eliminates duplicate struct definitions by migrating
the publisher tool to use canonical types from pkg/model, creating a
single source of truth across the codebase. The publisher tool
previously had its own copies of structs that were duplicated, ie.
ServerJSON, Package, Repository, VersionDetail, EnvironmentVariable,
RuntimeArgument and a few others which was not optimal


**Changes in the PR:**
- Refactored the structs to single canonical types located at pkg/model
- Refactor the implementation to use/build canonical structures directly
  - Remove all duplicate definitions (5 structs eliminated)
- Publisher now uses model.ServerJSON, model.Package, model.Repository,
etc.
- Renamed some of the structs to better reflect their use case, i.e.
ServerJSON instead of ServerDetail
- Fixes an issue where the Remote property was missing from the previous
publisher copy of the Server

**Benefits:**
  - Single source of truth - Schema changes in one place
  - Type safety - Compiler catches mismatches
  - Enhanced validation - Field constraints and bson tags
  - Zero breaking changes - Same CLI interface and JSON output
  - Future-proof - New canonical fields automatically available

Supersedes: #217 and #240

## How Has This Been Tested?
<!-- Have you tested this in a real application? Which scenarios were
tested? -->

Locally

## Breaking Changes
<!-- Will users need to update their code or configurations? -->
No

## Types of changes
<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->
- [x] Bug fix (non-breaking change which fixes an issue)
- [ ] 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. -->
- [ ] I have read the [MCP
Documentation](https://modelcontextprotocol.io)
- [ ] My code follows the repository's style guidelines
- [ ] New and existing tests pass locally
- [ ] I have added appropriate error handling
- [ ] I have added or updated documentation as needed

## Additional context
<!-- Add any other context, implementation notes, or design decisions
-->

---------

Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
2025-08-28 14:58:15 +01:00

166 lines
4.7 KiB
Go

package auth
import (
"context"
"crypto/ed25519"
"encoding/hex"
"fmt"
"strings"
"time"
"github.com/golang-jwt/jwt/v5"
"github.com/modelcontextprotocol/registry/internal/config"
)
// PermissionAction represents the type of action that can be performed
type PermissionAction string
const (
PermissionActionPublish PermissionAction = "publish"
// Intended for admins taking moderation actions only, at least for now
PermissionActionEdit PermissionAction = "edit"
)
type Permission struct {
Action PermissionAction `json:"action"` // The action type (publish or edit)
ResourcePattern string `json:"resource"` // e.g., "io.github.username/*"
}
// JWTClaims represents the claims for the Registry JWT token
type JWTClaims struct {
jwt.RegisteredClaims
// Authentication method used to obtain this token
AuthMethod Method `json:"auth_method"`
AuthMethodSubject string `json:"auth_method_sub"`
Permissions []Permission `json:"permissions"`
}
type TokenResponse struct {
RegistryToken string `json:"registry_token"`
ExpiresAt int `json:"expires_at"`
}
// JWTManager handles JWT token operations
type JWTManager struct {
privateKey ed25519.PrivateKey
publicKey ed25519.PublicKey
tokenDuration time.Duration
}
func NewJWTManager(cfg *config.Config) *JWTManager {
seed, err := hex.DecodeString(cfg.JWTPrivateKey)
if err != nil {
panic(fmt.Sprintf("JWTPrivateKey must be a valid hex-encoded string: %v", err))
}
// Require a valid Ed25519 seed (32 bytes)
if len(seed) != ed25519.SeedSize {
panic(fmt.Sprintf("JWTPrivateKey seed must be exactly %d bytes for Ed25519, got %d bytes", ed25519.SeedSize, len(seed)))
}
// Generate the full Ed25519 key pair from the seed
privateKey := ed25519.NewKeyFromSeed(seed)
publicKey := privateKey.Public().(ed25519.PublicKey)
return &JWTManager{
privateKey: privateKey,
publicKey: publicKey,
tokenDuration: 5 * time.Minute, // 5-minute tokens as per requirements
}
}
// GenerateToken generates a new Registry JWT token
func (j *JWTManager) GenerateTokenResponse(_ context.Context, claims JWTClaims) (*TokenResponse, error) {
// Check whether they have global permissions (used by admins)
hasGlobalPermissions := false
for _, perm := range claims.Permissions {
if perm.ResourcePattern == "*" {
hasGlobalPermissions = true
break
}
}
// Check permissions against denylist, provided they are not an admin
if !hasGlobalPermissions {
for _, blockedNamespace := range BlockedNamespaces {
if j.HasPermission(blockedNamespace+"/test", PermissionActionPublish, claims.Permissions) {
return nil, fmt.Errorf("your namespace is blocked. raise an issue at https://github.com/modelcontextprotocol/registry/ if you think this is a mistake")
}
}
}
if claims.IssuedAt == nil {
claims.IssuedAt = jwt.NewNumericDate(time.Now())
}
if claims.ExpiresAt == nil {
claims.ExpiresAt = jwt.NewNumericDate(time.Now().Add(j.tokenDuration))
}
if claims.NotBefore == nil {
claims.NotBefore = jwt.NewNumericDate(time.Now())
}
if claims.Issuer == "" {
claims.Issuer = "mcp-registry"
}
// Create token with claims
token := jwt.NewWithClaims(&jwt.SigningMethodEd25519{}, claims)
// Sign token with Ed25519 private key
tokenString, err := token.SignedString(j.privateKey)
if err != nil {
return nil, fmt.Errorf("failed to sign token: %w", err)
}
return &TokenResponse{
RegistryToken: tokenString,
ExpiresAt: int(claims.ExpiresAt.Unix()),
}, nil
}
// ValidateToken validates a Registry JWT token and returns the claims
func (j *JWTManager) ValidateToken(_ context.Context, tokenString string) (*JWTClaims, error) {
// Parse token
// This also validates expiry
token, err := jwt.ParseWithClaims(
tokenString,
&JWTClaims{},
func(_ *jwt.Token) (interface{}, error) { return j.publicKey, nil },
jwt.WithValidMethods([]string{"EdDSA"}),
jwt.WithExpirationRequired(),
)
// Validate token
if err != nil {
return nil, fmt.Errorf("failed to parse token: %w", err)
}
if !token.Valid {
return nil, fmt.Errorf("invalid token")
}
// Extract claims
claims, ok := token.Claims.(*JWTClaims)
if !ok {
return nil, fmt.Errorf("invalid token claims")
}
return claims, nil
}
func (j *JWTManager) HasPermission(resource string, action PermissionAction, permissions []Permission) bool {
for _, perm := range permissions {
if perm.Action == action && isResourceMatch(resource, perm.ResourcePattern) {
return true
}
}
return false
}
func isResourceMatch(resource, pattern string) bool {
if pattern == "*" {
return true
}
if strings.HasSuffix(pattern, "*") {
return strings.HasPrefix(resource, strings.TrimSuffix(pattern, "*"))
}
return resource == pattern
}