googleapis--mcp-toolbox/internal/auth/auth.go

// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package auth

import (
	"context"
	"net/http"
)

// AuthServiceConfig is the interface for configuring authentication services.
type AuthServiceConfig interface {
	AuthServiceConfigType() string
	Initialize() (AuthService, error)
	IsMCPEnabled() bool
}

// AuthService is the interface for authentication services.
type AuthService interface {
	AuthServiceType() string
	GetName() string
	GetClaimsFromHeader(context.Context, http.Header) (map[string]any, error)
	ToConfig() AuthServiceConfig
}

// MCPAuthError represents an error during MCP authentication validation.
type MCPAuthError struct {
	Code           int
	Message        string
	ScopesRequired []string
}

func (e *MCPAuthError) Error() string { return e.Message }

// MCPAuthService is the interface for authentication services that support MCP auth.
type MCPAuthService interface {
	AuthService
	IsMCPEnabled() bool
	GetScopesRequired() []string
	GetAuthorizationServer() string
	ValidateMCPAuth(context.Context, http.Header) (map[string]any, error)
}