config

type Authz struct {

	// Allow will allow the specified roles access to this path and its children, in format: ${path}:${role},${role}.
	Allow []string

	// AllowAny will allow any authenticated request access to this path and its children.
	AllowAny []string

	// AllowAnyRole will allow any authenticated request that include a non empty role.
	AllowAnyRole []string

	// LogAllowed specifies to log allowed access.
	LogAllowed *bool

	// LogDenied specifies to log denied access.
	LogDenied *bool

	// CertMapper specifies location of the config file for certificate based identity.
	CertMapper string

	// APIKeyMapper specifies location of the config file for API-Key based identity.
	APIKeyMapper string

	// JWTMapper specifies location of the config file for JWT based identity.
	JWTMapper string
}

type AuthzConfig interface {
	// Allow will allow the specified roles access to this path and its children, in format: ${path}:${role},${role}.
	GetAllow() []string
	// AllowAny will allow any authenticated request access to this path and its children.
	GetAllowAny() []string
	// AllowAnyRole will allow any authenticated request that include a non empty role.
	GetAllowAnyRole() []string
	// LogAllowed specifies to log allowed access.
	GetLogAllowed() bool
	// LogDenied specifies to log denied access.
	GetLogDenied() bool
	// CertMapper specifies location of the config file for certificate based identity.
	GetCertMapper() string
	// APIKeyMapper specifies location of the config file for API-Key based identity.
	GetAPIKeyMapper() string
	// JWTMapper specifies location of the config file for JWT based identity.
	GetJWTMapper() string
}

type CORS struct {

	// Enabled specifies if the CORS is enabled.
	Enabled *bool

	// MaxAge indicates how long (in seconds) the results of a preflight request can be cached.
	MaxAge int

	// AllowedOrigins is a list of origins a cross-domain request can be executed from.
	AllowedOrigins []string

	// AllowedMethods is a list of methods the client is allowed to use with cross-domain requests.
	AllowedMethods []string

	// AllowedHeaders is list of non simple headers the client is allowed to use with cross-domain requests.
	AllowedHeaders []string

	// ExposedHeaders indicates which headers are safe to expose to the API of a CORS API specification.
	ExposedHeaders []string

	// AllowCredentials indicates whether the request can include user credentials.
	AllowCredentials *bool

	// OptionsPassthrough instructs preflight to let other potential next handlers to process the OPTIONS method.
	OptionsPassthrough *bool

	// Debug flag adds additional output to debug server side CORS issues.
	Debug *bool
}

type CORSConfig interface {
	// Enabled specifies if the CORS is enabled.
	GetEnabled() bool
	// MaxAge indicates how long (in seconds) the results of a preflight request can be cached.
	GetMaxAge() int
	// AllowedOrigins is a list of origins a cross-domain request can be executed from.
	GetAllowedOrigins() []string
	// AllowedMethods is a list of methods the client is allowed to use with cross-domain requests.
	GetAllowedMethods() []string
	// AllowedHeaders is list of non simple headers the client is allowed to use with cross-domain requests.
	GetAllowedHeaders() []string
	// ExposedHeaders indicates which headers are safe to expose to the API of a CORS API specification.
	GetExposedHeaders() []string
	// AllowCredentials indicates whether the request can include user credentials.
	GetAllowCredentials() bool
	// OptionsPassthrough instructs preflight to let other potential next handlers to process the OPTIONS method.
	GetOptionsPassthrough() bool
	// Debug flag adds additional output to debug server side CORS issues.
	GetDebug() bool
}

type Configuration struct {

	// Datacenter specifies the Datacenter where the instance is running.
	Datacenter string

	// Environment specifies the deployment environment.
	Environment string

	// ServiceName specifies the service name to be used in logs and folders names.
	ServiceName string

	// HTTP contains the config for the Public HTTP.
	HTTP HTTPServer

	// HTTPS contains the config for the HTTPS/JSON API Service.
	HTTPS HTTPServer

	// Authz contains configuration for the API authorization layer.
	Authz Authz

	// Audit contains configuration for the audit logger.
	Audit Logger

	// CryptoProv specifies the configuration for crypto providers.
	CryptoProv CryptoProv

	// Metrics specifies the metrics pipeline configuration.
	Metrics Metrics

	// Logger contains configuration for the logger.
	Logger Logger

	// LogLevels specifies the log levels per package.
	LogLevels []RepoLogLevel

	// RootCA specifies the location of PEM-encoded certificate.
	RootCA string
}

type Configurations struct {
	// Default contains the base configuration, this applies unless it override by a specifc named config
	Defaults Configuration

	// a map of hostname to named configuration
	Hosts map[string]string

	// a map of named configuration overrides
	Overrides map[string]Configuration
}

type CryptoProv struct {

	// Default specifies the location of the configuration file for default provider.
	Default string

	// Providers specifies the list of locations of the configuration files.
	Providers []string
}

type Duration time.Duration

type Factory struct {
	// contains filtered or unexported fields
}

type HTTPServer struct {

	// ServiceName specifies name of the service: HTTP|HTTPS|WebAPI.
	ServiceName string

	// Disabled specifies if the service is disabled.
	Disabled *bool

	// VIPName is the FQ name of the VIP to the cluster [this is used when building the cert requests].
	VIPName string

	// BindAddr is the address that the HTTPS service should be exposed on
	BindAddr string

	// ServerTLS provides TLS config for server.
	ServerTLS TLSInfo

	// PackageLogger if set, specifies name of the package logger.
	PackageLogger string

	// AllowProfiling if set, will allow for per request CPU/Memory profiling triggered by the URI QueryString.
	AllowProfiling *bool

	// ProfilerDir specifies the directories where per-request profile information is written, if not set will write to a TMP dir.
	ProfilerDir string

	// Services is a list of services to enable for this HTTP Service.
	Services []string

	// HeartbeatSecs specifies heartbeat interval in seconds [30 secs is a minimum].
	HeartbeatSecs int

	// CORS contains configuration for CORS.
	CORS CORS
}

type HTTPServerConfig interface {
	// ServiceName specifies name of the service: HTTP|HTTPS|WebAPI.
	GetServiceName() string
	// Disabled specifies if the service is disabled.
	GetDisabled() bool
	// VIPName is the FQ name of the VIP to the cluster [this is used when building the cert requests].
	GetVIPName() string
	// BindAddr is the address that the HTTPS service should be exposed on
	GetBindAddr() string
	// ServerTLS provides TLS config for server.
	GetServerTLSCfg() *TLSInfo
	// PackageLogger if set, specifies name of the package logger.
	GetPackageLogger() string
	// AllowProfiling if set, will allow for per request CPU/Memory profiling triggered by the URI QueryString.
	GetAllowProfiling() bool
	// ProfilerDir specifies the directories where per-request profile information is written, if not set will write to a TMP dir.
	GetProfilerDir() string
	// Services is a list of services to enable for this HTTP Service.
	GetServices() []string
	// HeartbeatSecs specifies heartbeat GetHeartbeatSecserval in seconds [30 secs is a minimum].
	GetHeartbeatSecs() int
	// GetCORSCfg contains configuration for GetCORSCfg.
	GetCORSCfg() *CORS
}

type HostSelection struct {
	// Hostname returns the hostname from the configuration that was used
	// this may return a fully qualified hostname, when just a name was specified
	Hostname string
	// Override contains the name of the override section, if there was one found
	// [based on the Hostname]
	Override string
}

type Logger struct {

	// Directory contains where to store the log files.
	Directory string

	// MaxAgeDays controls how old files are before deletion.
	MaxAgeDays int

	// MaxSizeMb contols how large a single log file can be before its rotated.
	MaxSizeMb int
}

type LoggerConfig interface {
	// Directory contains where to store the log files.
	GetDirectory() string
	// MaxAgeDays controls how old files are before deletion.
	GetMaxAgeDays() int
	// MaxSizeMb contols how large a single log file can be before its rotated.
	GetMaxSizeMb() int
}

type Metrics struct {

	// Provider specifies the metrics provider.
	Provider string
}

type RepoLogLevel struct {

	// Repo specifies the repo name, or '*' for all repos [Global].
	Repo string

	// Package specifies the package name.
	Package string

	// Level specifies the log level for the repo [ERROR,WARNING,NOTICE,INFO,DEBUG,TRACE].
	Level string
}

type TLSInfo struct {

	// CertFile specifies location of the cert.
	CertFile string

	// KeyFile specifies location of the key.
	KeyFile string

	// TrustedCAFile specifies location of the trusted Root file.
	TrustedCAFile string

	// ClientCertAuth controls client auth: NoClientCert|RequestClientCert|RequireAnyClientCert|VerifyClientCertIfGiven|RequireAndVerifyClientCert
	ClientCertAuth string
}

type TLSInfoConfig interface {
	// CertFile specifies location of the cert.
	GetCertFile() string
	// KeyFile specifies location of the key.
	GetKeyFile() string
	// TrustedCAFile specifies location of the trusted Root file.
	GetTrustedCAFile() string
	// ClientCertAuth controls client auth: NoClientCert|RequestClientCert|RequireAnyClientCert|VerifyClientCertIfGiven|RequireAndVerifyClientCert
	GetClientCertAuth() string
}