config

Documentation

Index

• func GetEnvMapping() map[string]string
• type AgentConfig
• type AgentFactsConfig
• type AuditConfig
• type CacheConfig
• type CaptureConfig
• type CircuitBreakerConfig
• type Config
  • func Load(path string) (*Config, error)
  • func (c *Config) MaskSensitive() *Config
  • func (c *Config) String() string
• type ConnectionPoolConfig
• type EvaluationConfig
• type FileConfig
• type HealthConfig
• type ListenConfig
• type LoggingConfig
• type MetricsConfig
• type PolicyConfig
• type RetryConfig
• type SecurityConfig
• type ServerConfig
• type TLSConfig
• type UpstreamConfig

Functions

func GetEnvMapping

func GetEnvMapping() map[string]string

GetEnvMapping returns a map of configuration paths to environment variable names.

Types

type AgentConfig

type AgentConfig struct {
	ID           string   `yaml:"id"`
	Name         string   `yaml:"name"`
	Capabilities []string `yaml:"capabilities"`
	Model        string   `yaml:"model"`
	Publisher    string   `yaml:"publisher"`
	Tags         []string `yaml:"tags"`
}

AgentConfig defines the default agent identity (used when AgentFacts not provided).

type AgentFactsConfig

type AgentFactsConfig struct {
	Mode           string        `yaml:"mode"` // disabled, optional, required
	MaxAge         time.Duration `yaml:"max_age"`
	ClockSkew      time.Duration `yaml:"clock_skew"`
	AllowedDIDs    []string      `yaml:"allowed_dids"`
	VerifyLogProof bool          `yaml:"verify_log_proof"`
	Cache          CacheConfig   `yaml:"cache"`
}

AgentFactsConfig defines AgentFacts verification settings.

type AuditConfig

type AuditConfig struct {
	Enabled       bool          `yaml:"enabled"`
	DBPath        string        `yaml:"db_path"`        // SQLite database path
	BufferSize    int           `yaml:"buffer_size"`    // Max records to buffer
	FlushInterval time.Duration `yaml:"flush_interval"` // How often to flush
	RetentionDays int           `yaml:"retention_days"` // Days to keep records (0 = forever)
	Capture       CaptureConfig `yaml:"capture"`
}

AuditConfig defines audit logging settings.

type CacheConfig

type CacheConfig struct {
	Enabled    bool          `yaml:"enabled"`
	TTL        time.Duration `yaml:"ttl"`
	MaxEntries int           `yaml:"max_entries"`
}

CacheConfig defines caching settings.

type CaptureConfig

type CaptureConfig struct {
	RequestArguments bool `yaml:"request_arguments"`
	ResponseSummary  bool `yaml:"response_summary"`
}

CaptureConfig defines what to capture in audit logs.

type CircuitBreakerConfig

type CircuitBreakerConfig struct {
	Enabled   bool          `yaml:"enabled"`
	Threshold int           `yaml:"threshold"`
	Timeout   time.Duration `yaml:"timeout"`
}

CircuitBreakerConfig defines circuit breaker settings.

type Config

type Config struct {
	Version    string           `yaml:"version"`
	Server     ServerConfig     `yaml:"server"`
	Upstream   UpstreamConfig   `yaml:"upstream"`
	Agent      AgentConfig      `yaml:"agent"`
	AgentFacts AgentFactsConfig `yaml:"agentfacts"`
	Policy     PolicyConfig     `yaml:"policy"`
	Audit      AuditConfig      `yaml:"audit"`
	Metrics    MetricsConfig    `yaml:"metrics"`
	Health     HealthConfig     `yaml:"health"`
	Logging    LoggingConfig    `yaml:"logging"`
	TLS        TLSConfig        `yaml:"tls"`
}

Config is the root configuration structure for the MCP MCP Proxy.

func Load

func Load(path string) (*Config, error)

Load reads and parses the configuration from a YAML file, then applies environment variable overrides.

func (*Config) MaskSensitive

func (c *Config) MaskSensitive() *Config

MaskSensitive returns a copy of the config with sensitive values masked.

func (*Config) String

func (c *Config) String() string

String returns a string representation of the config for logging. Sensitive values are masked.

type ConnectionPoolConfig

type ConnectionPoolConfig struct {
	MaxIdle     int           `yaml:"max_idle"`
	MaxOpen     int           `yaml:"max_open"`
	IdleTimeout time.Duration `yaml:"idle_timeout"`
}

ConnectionPoolConfig defines connection pool settings.

type EvaluationConfig

type EvaluationConfig struct {
	Timeout             time.Duration `yaml:"timeout"`
	StrictBuiltinErrors bool          `yaml:"strict_builtin_errors"`
}

EvaluationConfig defines policy evaluation settings.

type FileConfig

type FileConfig struct {
	Path       string `yaml:"path"`
	MaxSize    int    `yaml:"max_size"` // MB
	MaxBackups int    `yaml:"max_backups"`
	MaxAge     int    `yaml:"max_age"` // days
}

FileConfig defines log file settings.

type HealthConfig

type HealthConfig struct {
	Enabled       bool   `yaml:"enabled"`
	Address       string `yaml:"address"`
	Port          int    `yaml:"port"`
	LivenessPath  string `yaml:"liveness_path"`
	ReadinessPath string `yaml:"readiness_path"`
}

HealthConfig defines health check endpoint settings.

type ListenConfig

type ListenConfig struct {
	Address string `yaml:"address"`
	Port    int    `yaml:"port"`
}

ListenConfig defines the server listen address.

type LoggingConfig

type LoggingConfig struct {
	Level  string     `yaml:"level"`  // debug, info, warn, error
	Format string     `yaml:"format"` // json, text
	Output string     `yaml:"output"` // stdout, stderr, file
	File   FileConfig `yaml:"file"`
}

LoggingConfig defines logging settings.

type MetricsConfig

type MetricsConfig struct {
	Enabled bool   `yaml:"enabled"`
	Address string `yaml:"address"`
	Port    int    `yaml:"port"`
	Path    string `yaml:"path"`
}

MetricsConfig defines Prometheus metrics settings.

type PolicyConfig

type PolicyConfig struct {
	Enabled         bool             `yaml:"enabled"`
	Mode            string           `yaml:"mode"` // audit, enforce
	PolicyDir       string           `yaml:"policy_dir"`
	JSONPolicyDir   string           `yaml:"json_policy_dir"` // Directory for JSON policy definitions
	DataFile        string           `yaml:"data_file"`
	WatchForChanges bool             `yaml:"watch_for_changes"`
	Environment     string           `yaml:"environment"` // development, staging, production
	Cache           CacheConfig      `yaml:"cache"`
	Evaluation      EvaluationConfig `yaml:"evaluation"`
}

PolicyConfig defines the OPA policy engine settings.

type RetryConfig

type RetryConfig struct {
	Enabled      bool          `yaml:"enabled"`
	MaxAttempts  int           `yaml:"max_attempts"`
	InitialDelay time.Duration `yaml:"initial_delay"`
	MaxDelay     time.Duration `yaml:"max_delay"`
	Backoff      string        `yaml:"backoff"` // exponential, linear, constant
}

RetryConfig defines retry behavior for upstream connections.

type SecurityConfig

type SecurityConfig struct {
	// CORS settings
	CORSAllowedOrigins []string `yaml:"cors_allowed_origins"` // Empty = block all, ["*"] = allow all
	// Security headers
	EnableSecurityHeaders bool `yaml:"enable_security_headers"`
}

SecurityConfig defines security-related settings.

type ServerConfig

type ServerConfig struct {
	Listen           ListenConfig   `yaml:"listen"`
	Transport        string         `yaml:"transport"` // sse, stdio, http
	ReadTimeout      time.Duration  `yaml:"read_timeout"`
	WriteTimeout     time.Duration  `yaml:"write_timeout"`
	IdleTimeout      time.Duration  `yaml:"idle_timeout"`
	GracefulShutdown time.Duration  `yaml:"graceful_shutdown"`
	MaxConnections   int            `yaml:"max_connections"`
	Security         SecurityConfig `yaml:"security"`
}

ServerConfig defines the proxy server settings.

type TLSConfig

type TLSConfig struct {
	Enabled    bool   `yaml:"enabled"`
	CertFile   string `yaml:"cert_file"`
	KeyFile    string `yaml:"key_file"`
	CAFile     string `yaml:"ca_file"`
	MinVersion string `yaml:"min_version"`
	ClientAuth string `yaml:"client_auth"` // none, request, require
}

TLSConfig defines TLS settings.

type UpstreamConfig

type UpstreamConfig struct {
	URL            string               `yaml:"url"`
	Transport      string               `yaml:"transport"`
	Timeout        time.Duration        `yaml:"timeout"`
	ConnectionPool ConnectionPoolConfig `yaml:"connection_pool"`
	Retry          RetryConfig          `yaml:"retry"`
	CircuitBreaker CircuitBreakerConfig `yaml:"circuit_breaker"`
}

UpstreamConfig defines the upstream MCP server connection settings.