Adds support for the Quay.io container registry to the OCI validator. This allows MCP servers hosted on Quay.io to be registered and validated by the official registry. ## Motivation and Context <!-- Why is this change needed? What problem does it solve? --> Quay.io is a major, trusted public OCI registry widely used by the cloud-native and open-source communities. Currently, attempting to publish a server using a Quay image results in an unsupported OCI registry error. This change enables developers to use Quay.io as a first-class hosting option for their MCP server images. ## How Has This Been Tested? <!-- Have you tested this in a real application? Which scenarios were tested? --> - **Unit Tests:** Updated `internal/validators/registries/oci_test.go` to transition Quay.io from a rejected test case to an allowed one. - **Pattern Matching:** Verified that the allowlist correctly handles both specific image identifiers and general pattern matching for the `quay.io` host. - **Local Validation:** Ran `make check` to ensure no regressions in the existing OCI validation logic. ## Breaking Changes <!-- Will users need to update their code or configurations? --> No. This is an additive change that expands the allowlist of supported registries. Existing configurations are unaffected. ## 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) - [x] 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 ## Additional context <!-- Add any other context, implementation notes, or design decisions --> The implementation follows the existing pattern for OCI registries: 1. Added a `RegistryURLQuay` constant to `pkg/model` for consistency. 2. Hardcoded `quay.io` into the `allowedOCIRegistries` map in the validator to minimize architectural complexity. 3. Updated all relevant documentation files (`package-types.mdx`, `generic-server-json.md`, and `official-registry-requirements.md`) to ensure the source of truth is updated across the project. 4. Validation remains scoped to public images; no private registry authentication was added for this host. Signed-off-by: Mikel Olasagasti Uranga <mikel@olasagasti.info> Co-authored-by: Radoslav Dimitrov <radoslav@stacklok.com>
165 lines
6.1 KiB
Go
165 lines
6.1 KiB
Go
package registries
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"log"
|
|
"net/http"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/google/go-containerregistry/pkg/authn"
|
|
"github.com/google/go-containerregistry/pkg/name"
|
|
"github.com/google/go-containerregistry/pkg/v1/remote"
|
|
"github.com/google/go-containerregistry/pkg/v1/remote/transport"
|
|
"github.com/modelcontextprotocol/registry/pkg/model"
|
|
)
|
|
|
|
var (
|
|
ErrMissingIdentifierForOCI = errors.New("package identifier is required for OCI packages")
|
|
ErrUnsupportedRegistry = errors.New("unsupported OCI registry")
|
|
)
|
|
|
|
// ErrRateLimited is returned when a registry rate limits our requests
|
|
var ErrRateLimited = errors.New("rate limited by registry")
|
|
|
|
// allowedOCIRegistries defines the list of supported OCI registries.
|
|
// This can be expanded in the future to support additional public registries.
|
|
var allowedOCIRegistries = map[string]bool{
|
|
// Docker Hub (and its various endpoints)
|
|
"docker.io": true,
|
|
"registry-1.docker.io": true, // Docker Hub API endpoint
|
|
"index.docker.io": true, // Docker Hub index
|
|
// GitHub Container Registry
|
|
"ghcr.io": true,
|
|
// Red Hat Quay
|
|
"quay.io": true,
|
|
// Microsoft Container Registry
|
|
"mcr.microsoft.com": true,
|
|
// Google Artifact Registry (*.pkg.dev pattern handled in isAllowedRegistry)
|
|
// Azure Container Registry (*.azurecr.io pattern handled in isAllowedRegistry)
|
|
}
|
|
|
|
// ValidateOCI validates that an OCI image contains the correct MCP server name annotation.
|
|
// Supports canonical OCI references including:
|
|
// - registry/namespace/image:tag
|
|
// - registry/namespace/image@sha256:digest
|
|
// - registry/namespace/image:tag@sha256:digest
|
|
// - namespace/image:tag (defaults to docker.io)
|
|
//
|
|
// Supported registries:
|
|
// - Docker Hub (docker.io)
|
|
// - GitHub Container Registry (ghcr.io)
|
|
// - Quay.io (quay.io)
|
|
// - Google Artifact Registry (*.pkg.dev)
|
|
// - Microsoft Container Registry (mcr.microsoft.com)
|
|
func ValidateOCI(ctx context.Context, pkg model.Package, serverName string) error {
|
|
if pkg.Identifier == "" {
|
|
return ErrMissingIdentifierForOCI
|
|
}
|
|
|
|
// Validate that old format fields are not present
|
|
if pkg.RegistryBaseURL != "" {
|
|
return fmt.Errorf("OCI packages must not have 'registryBaseUrl' field - use canonical reference in 'identifier' instead (e.g., 'docker.io/owner/image:1.0.0')")
|
|
}
|
|
if pkg.Version != "" {
|
|
return fmt.Errorf("OCI packages must not have 'version' field - include version in 'identifier' instead (e.g., 'docker.io/owner/image:1.0.0')")
|
|
}
|
|
if pkg.FileSHA256 != "" {
|
|
return fmt.Errorf("OCI packages must not have 'fileSha256' field")
|
|
}
|
|
|
|
// Parse the OCI reference using go-containerregistry's name package
|
|
// This handles all the complexity of reference parsing including defaults
|
|
ref, err := name.ParseReference(pkg.Identifier)
|
|
if err != nil {
|
|
return fmt.Errorf("invalid OCI reference: %w", err)
|
|
}
|
|
|
|
// Validate that the registry is in the allowlist
|
|
registry := ref.Context().RegistryStr()
|
|
if !isAllowedRegistry(registry) {
|
|
return fmt.Errorf("%w: %s", ErrUnsupportedRegistry, registry)
|
|
}
|
|
|
|
// Add explicit timeout to prevent hanging on slow registries
|
|
// Use a new context with timeout to avoid modifying the caller's context
|
|
timeoutCtx, cancel := context.WithTimeout(ctx, 30*time.Second)
|
|
defer cancel()
|
|
|
|
// Fetch the image using anonymous authentication (public images only)
|
|
// The go-containerregistry library handles:
|
|
// - OCI auth discovery via WWW-Authenticate headers
|
|
// - Token negotiation for different registries
|
|
// - Rate limiting and retries
|
|
// - Multi-arch manifest resolution
|
|
img, err := remote.Image(ref, remote.WithAuth(authn.Anonymous), remote.WithContext(timeoutCtx))
|
|
if err != nil {
|
|
// Check if this is a timeout error
|
|
if errors.Is(err, context.DeadlineExceeded) {
|
|
return fmt.Errorf("OCI image validation timed out after 30 seconds for '%s'. The registry may be slow or unreachable", pkg.Identifier)
|
|
}
|
|
|
|
// Check for specific HTTP status codes
|
|
var transportErr *transport.Error
|
|
if errors.As(err, &transportErr) {
|
|
switch transportErr.StatusCode {
|
|
case http.StatusTooManyRequests:
|
|
// Rate limited - skip validation to avoid blocking publishers
|
|
// This is intentional: we prioritize UX over strict validation during high traffic
|
|
log.Printf("Skipping OCI validation for %s due to rate limiting", pkg.Identifier)
|
|
return nil
|
|
case http.StatusNotFound:
|
|
return fmt.Errorf("OCI image '%s' does not exist in the registry", pkg.Identifier)
|
|
case http.StatusUnauthorized, http.StatusForbidden:
|
|
return fmt.Errorf("OCI image '%s' is private or requires authentication. Only public images are supported", pkg.Identifier)
|
|
}
|
|
}
|
|
return fmt.Errorf("failed to fetch OCI image: %w", err)
|
|
}
|
|
|
|
// Get the image config which contains labels
|
|
configFile, err := img.ConfigFile()
|
|
if err != nil {
|
|
return fmt.Errorf("failed to get image config: %w", err)
|
|
}
|
|
|
|
// Validate the MCP server name label
|
|
if configFile.Config.Labels == nil {
|
|
return fmt.Errorf("OCI image '%s' is missing required annotation. Add this to your Dockerfile: LABEL io.modelcontextprotocol.server.name=\"%s\"", pkg.Identifier, serverName)
|
|
}
|
|
|
|
mcpName, exists := configFile.Config.Labels["io.modelcontextprotocol.server.name"]
|
|
if !exists {
|
|
return fmt.Errorf("OCI image '%s' is missing required annotation. Add this to your Dockerfile: LABEL io.modelcontextprotocol.server.name=\"%s\"", pkg.Identifier, serverName)
|
|
}
|
|
|
|
if mcpName != serverName {
|
|
return fmt.Errorf("OCI image ownership validation failed. Expected annotation 'io.modelcontextprotocol.server.name' = '%s', got '%s'", serverName, mcpName)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// isAllowedRegistry checks if the given registry is in the allowlist.
|
|
// It handles registry aliases and wildcard patterns (e.g., *.pkg.dev for Artifact Registry).
|
|
func isAllowedRegistry(registry string) bool {
|
|
// Direct match
|
|
if allowedOCIRegistries[registry] {
|
|
return true
|
|
}
|
|
|
|
// Check for wildcard patterns
|
|
// Google Artifact Registry: *.pkg.dev (e.g., us-docker.pkg.dev, europe-west1-docker.pkg.dev)
|
|
if strings.HasSuffix(registry, ".pkg.dev") {
|
|
return true
|
|
}
|
|
|
|
// Azure Container Registry: *.azurecr.io
|
|
if strings.HasSuffix(registry, ".azurecr.io") {
|
|
return true
|
|
}
|
|
|
|
return false
|
|
}
|