Enable Google KMS and Azure Key Vault for publisher login tool (#696)
<!-- Provide a brief summary of your changes --> ## Motivation and Context This allows the private key used for DNS or HTTP based authentication to be stored securely in a cloud key management system. These services often provide HSM storage which makes it very hard to leak the private key. The full context is described in my design document here: https://github.com/modelcontextprotocol/registry/issues/482#issuecomment-3437117171 ## How Has This Been Tested? I have tested it against PROD using an Ed25519 key stored in Google KMS. I have added unit tests. I have tested both ECDSA P-384 and Ed25519 with Az KV and Google KMS against a locally running server. ## Breaking Changes None intended. ## 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 --> --------- Co-authored-by: adam jones <domdomegg+git@gmail.com>
This commit is contained in:
parent
3d375e6544
commit
88c2e1be16
1 changed files with 641 additions and 91 deletions
|
|
@ -8,8 +8,11 @@ import (
|
|||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
"github.com/modelcontextprotocol/registry/cmd/publisher/auth"
|
||||
"github.com/modelcontextprotocol/registry/cmd/publisher/auth/azurekeyvault"
|
||||
"github.com/modelcontextprotocol/registry/cmd/publisher/auth/googlekms"
|
||||
)
|
||||
|
||||
const (
|
||||
|
|
@ -19,6 +22,27 @@ const (
|
|||
|
||||
type CryptoAlgorithm auth.CryptoAlgorithm
|
||||
|
||||
type SignerType string
|
||||
|
||||
type LoginFlags struct {
|
||||
Domain string
|
||||
PrivateKey string
|
||||
RegistryURL string
|
||||
KvVault string
|
||||
KvKeyName string
|
||||
KmsResource string
|
||||
CryptoAlgorithm CryptoAlgorithm
|
||||
SignerType SignerType
|
||||
ArgOffset int
|
||||
}
|
||||
|
||||
const (
|
||||
InProcessSignerType SignerType = "in-process"
|
||||
AzureKeyVaultSignerType SignerType = "azure-key-vault"
|
||||
GoogleKMSSignerType SignerType = "google-kms"
|
||||
NoSignerType SignerType = "none"
|
||||
)
|
||||
|
||||
func (c *CryptoAlgorithm) String() string {
|
||||
return string(*c)
|
||||
}
|
||||
|
|
@ -32,56 +56,146 @@ func (c *CryptoAlgorithm) Set(v string) error {
|
|||
return fmt.Errorf("invalid algorithm: %q (allowed: ed25519, ecdsap384)", v)
|
||||
}
|
||||
|
||||
func parseLoginFlags(method string, args []string) (LoginFlags, error) {
|
||||
var flags LoginFlags
|
||||
loginFlags := flag.NewFlagSet("login", flag.ExitOnError)
|
||||
flags.CryptoAlgorithm = CryptoAlgorithm(auth.AlgorithmEd25519)
|
||||
flags.SignerType = NoSignerType
|
||||
flags.ArgOffset = 1
|
||||
loginFlags.StringVar(&flags.RegistryURL, "registry", DefaultRegistryURL, "Registry URL")
|
||||
|
||||
if method == "dns" || method == "http" {
|
||||
loginFlags.StringVar(&flags.Domain, "domain", "", "Domain name")
|
||||
if len(args) > 1 {
|
||||
switch args[1] {
|
||||
case string(AzureKeyVaultSignerType):
|
||||
flags.SignerType = AzureKeyVaultSignerType
|
||||
loginFlags.StringVar(&flags.KvVault, "vault", "", "The name of the Azure Key Vault resource")
|
||||
loginFlags.StringVar(&flags.KvKeyName, "key", "", "Name of the signing key in the Azure Key Vault")
|
||||
flags.ArgOffset = 2
|
||||
case string(GoogleKMSSignerType):
|
||||
flags.SignerType = GoogleKMSSignerType
|
||||
loginFlags.StringVar(&flags.KmsResource, "resource", "", "Google Cloud KMS resource name (e.g. projects/lotr/locations/global/keyRings/fellowship/cryptoKeys/frodo/cryptoKeyVersions/1)")
|
||||
flags.ArgOffset = 2
|
||||
}
|
||||
}
|
||||
if flags.SignerType == NoSignerType {
|
||||
flags.SignerType = InProcessSignerType
|
||||
loginFlags.StringVar(&flags.PrivateKey, "private-key", "", "Private key (hex)")
|
||||
loginFlags.Var(&flags.CryptoAlgorithm, "algorithm", "Cryptographic algorithm (ed25519, ecdsap384)")
|
||||
}
|
||||
}
|
||||
err := loginFlags.Parse(args[flags.ArgOffset:])
|
||||
if err == nil {
|
||||
flags.RegistryURL = strings.TrimRight(flags.RegistryURL, "/")
|
||||
}
|
||||
|
||||
return flags, err
|
||||
}
|
||||
|
||||
func createSigner(flags LoginFlags) (auth.Signer, error) {
|
||||
switch flags.SignerType {
|
||||
case AzureKeyVaultSignerType:
|
||||
return azurekeyvault.GetSignatureProvider(flags.KvVault, flags.KvKeyName)
|
||||
case GoogleKMSSignerType:
|
||||
return googlekms.GetSignatureProvider(flags.KmsResource)
|
||||
case InProcessSignerType:
|
||||
return auth.NewInProcessSigner(flags.PrivateKey, auth.CryptoAlgorithm(flags.CryptoAlgorithm))
|
||||
case NoSignerType:
|
||||
return nil, errors.New("no signing provider specified")
|
||||
default:
|
||||
return nil, errors.New("unknown signing provider specified")
|
||||
}
|
||||
}
|
||||
|
||||
func createAuthProvider(method, registryURL, domain string, signer auth.Signer) (auth.Provider, error) {
|
||||
switch method {
|
||||
case "github":
|
||||
return auth.NewGitHubATProvider(true, registryURL), nil
|
||||
case "github-oidc":
|
||||
return auth.NewGitHubOIDCProvider(registryURL), nil
|
||||
case "dns":
|
||||
if domain == "" {
|
||||
return nil, errors.New("dns authentication requires --domain")
|
||||
}
|
||||
return auth.NewDNSProvider(registryURL, domain, &signer), nil
|
||||
case "http":
|
||||
if domain == "" {
|
||||
return nil, errors.New("http authentication requires --domain")
|
||||
}
|
||||
return auth.NewHTTPProvider(registryURL, domain, &signer), nil
|
||||
case "none":
|
||||
return auth.NewNoneProvider(registryURL), nil
|
||||
default:
|
||||
return nil, fmt.Errorf("unknown authentication method: %s\nFor a list of available methods, run: mcp-publisher login", method)
|
||||
}
|
||||
}
|
||||
|
||||
func LoginCommand(args []string) error {
|
||||
if len(args) < 1 {
|
||||
return errors.New("authentication method required\n\nUsage: mcp-publisher login <method>\n\nMethods:\n github Interactive GitHub authentication\n github-oidc GitHub Actions OIDC authentication\n dns DNS-based authentication (requires --domain and --private-key)\n http HTTP-based authentication (requires --domain and --private-key)\n none Anonymous authentication (for testing)")
|
||||
return errors.New(`authentication method required
|
||||
|
||||
Usage: mcp-publisher login <method> [<signing provider>]
|
||||
|
||||
Methods:
|
||||
github Interactive GitHub authentication
|
||||
github-oidc GitHub Actions OIDC authentication
|
||||
dns DNS-based authentication (requires --domain)
|
||||
http HTTP-based authentication (requires --domain)
|
||||
none Anonymous authentication (for testing)
|
||||
|
||||
Signing providers:
|
||||
azure-key-vault Sign using Azure Key Vault
|
||||
google-kms Sign using Google Cloud KMS
|
||||
|
||||
The dns and http methods require a --private-key for in-process signing. For
|
||||
out-of-process signing, use one of the supported signing providers. Signing is
|
||||
needed for an authentication challenge with the registry.
|
||||
|
||||
The github and github-oidc methods do not support signing providers and
|
||||
authenticate using the GitHub as an identity provider.
|
||||
|
||||
Examples:
|
||||
|
||||
# Interactive GitHub login, using device code flow
|
||||
mcp-publisher login github
|
||||
|
||||
# Sign in using a specific Ed25519 private key for DNS authentication
|
||||
mcp-publisher login dns -algorithm ed25519 -domain example.com -private-key <64 hex chars>
|
||||
|
||||
# Sign in using a specific ECDSA P-384 private key for DNS authentication
|
||||
mcp-publisher login dns -algorithm ecdsap384 -domain example.com -private-key <96 hex chars>
|
||||
|
||||
# Sign in with gcloud CLI, use Google Cloud KMS for signing in DNS authentication
|
||||
gcloud auth application-default login
|
||||
mcp-publisher login dns google-kms -domain example.com -resource projects/lotr/locations/global/keyRings/fellowship/cryptoKeys/frodo/cryptoKeyVersions/1
|
||||
|
||||
# Sign in with az CLI, use Azure Key Vault for signing in HTTP authentication
|
||||
az login
|
||||
mcp-publisher login http azure-key-vault -domain example.com -vault myvault -key mysigningkey
|
||||
|
||||
`)
|
||||
}
|
||||
|
||||
method := args[0]
|
||||
|
||||
// Parse remaining flags based on method
|
||||
loginFlags := flag.NewFlagSet("login", flag.ExitOnError)
|
||||
var domain string
|
||||
var privateKey string
|
||||
var cryptoAlgorithm = CryptoAlgorithm(auth.AlgorithmEd25519)
|
||||
var registryURL string
|
||||
|
||||
loginFlags.StringVar(®istryURL, "registry", DefaultRegistryURL, "Registry URL")
|
||||
|
||||
if method == "dns" || method == "http" {
|
||||
loginFlags.StringVar(&domain, "domain", "", "Domain name")
|
||||
loginFlags.StringVar(&privateKey, "private-key", "", "Private key (hex)")
|
||||
loginFlags.Var(&cryptoAlgorithm, "algorithm", "Cryptographic algorithm (ed25519, ecdsap384)")
|
||||
}
|
||||
|
||||
if err := loginFlags.Parse(args[1:]); err != nil {
|
||||
flags, err := parseLoginFlags(method, args)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Create auth provider based on method
|
||||
var authProvider auth.Provider
|
||||
switch method {
|
||||
case "github":
|
||||
authProvider = auth.NewGitHubATProvider(true, registryURL)
|
||||
case "github-oidc":
|
||||
authProvider = auth.NewGitHubOIDCProvider(registryURL)
|
||||
case "dns":
|
||||
if domain == "" || privateKey == "" {
|
||||
return errors.New("dns authentication requires --domain and --private-key")
|
||||
var signer auth.Signer
|
||||
if flags.SignerType != NoSignerType {
|
||||
signer, err = createSigner(flags)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
authProvider = auth.NewDNSProvider(registryURL, domain, privateKey, auth.CryptoAlgorithm(cryptoAlgorithm))
|
||||
case "http":
|
||||
if domain == "" || privateKey == "" {
|
||||
return errors.New("http authentication requires --domain and --private-key")
|
||||
}
|
||||
authProvider = auth.NewHTTPProvider(registryURL, domain, privateKey, auth.CryptoAlgorithm(cryptoAlgorithm))
|
||||
case "none":
|
||||
authProvider = auth.NewNoneProvider(registryURL)
|
||||
default:
|
||||
return fmt.Errorf("unknown authentication method: %s\nFor a list of available methods, run: mcp-publisher login", method)
|
||||
}
|
||||
|
||||
// Perform login
|
||||
authProvider, err := createAuthProvider(method, flags.RegistryURL, flags.Domain, signer)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
ctx := context.Background()
|
||||
_, _ = fmt.Fprintf(os.Stdout, "Logging in with %s...\n", method)
|
||||
|
||||
|
|
@ -89,13 +203,11 @@ func LoginCommand(args []string) error {
|
|||
return fmt.Errorf("login failed: %w", err)
|
||||
}
|
||||
|
||||
// Get and save token
|
||||
token, err := authProvider.GetToken(ctx)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get token: %w", err)
|
||||
}
|
||||
|
||||
// Save token to file
|
||||
homeDir, err := os.UserHomeDir()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get home directory: %w", err)
|
||||
|
|
@ -105,7 +217,7 @@ func LoginCommand(args []string) error {
|
|||
tokenData := map[string]string{
|
||||
"token": token,
|
||||
"method": method,
|
||||
"registry": registryURL,
|
||||
"registry": flags.RegistryURL,
|
||||
}
|
||||
|
||||
jsonData, err := json.Marshal(tokenData)
|
||||
|
|
|
|||
Loading…
Reference in a new issue