config

type Auth struct {
	// Enabled - checks this first before reading your provider config
	Enabled bool `yaml:"enabled"`
	// JWTSigningKey contains a 32 byte array to sign with the HmacSha256 algorithms
	JWTSigningKey []byte `yaml:"jwtSigningKey"`
	// A list of auth providers. Currently enables only the first provider in the list.
	Providers []AuthProvider `yaml:"providers"`
}

type AuthProvider struct {
	// Label for the provider (optional)
	Label string `yaml:"label"`
	// Type of the auth provider, currently only OIDC is supported
	Type string `yaml:"type"`
	// OIDC .well-known/openid-configuration URL, ex. https://accounts.google.com/
	ProviderURL string `yaml:"providerUrl"`
	// IssuerURL is only needed when it differs from the ProviderURL (optional)
	IssuerURL string `yaml:"issuerUrl"`
	// ClientID of the oauth2 provider
	ClientID string `yaml:"clientId"`
	// ClientSecret is the private key that authenticates your integration when requesting an OAuth token (optional when using PKCE)
	ClientSecret string `yaml:"clientSecret"`
	// Scopes for authentication, typically [openid, profile, email]
	Scopes []string `yaml:"scopes"`
	// CallbackURL after a successful auth, e.g. https://localhost:8080/oauth/callback
	CallbackURL string `yaml:"callbackUrl"`
	// Options added as URL query params when redirecting to auth provider. Can be used to configure custom auth flows such as Auth0 invitation flow.
	Options map[string]interface{} `yaml:"options"`
}

type CORS struct {
	// AllowOrigins is a list of allowed origin to indicate whether the response can be shared with
	// requesting code from the given origin
	AllowOrigins []string `yaml:"allowOrigins"`
	// CookieInsecure allows CSRF cookie to be sent to servers that the browser considers
	// unsecured. Useful for cases where the connection is secured via VPN rather than
	// HTTPS directly.
	CookieInsecure bool `yaml:"cookieInsecure"`
}

type Config struct {
	// RefreshInterval holds often to reload the config
	RefreshInterval time.Duration `yaml:"refreshInterval"`

	// Server contains the echo server settings
	Server Server `yaml:"server"`

	// Auth contains the authentication provider(s)
	Auth Auth `yaml:"auth"`

	// Authz contains the authorization settings
	Authz fga.Config `yaml:"authz"`

	// DB contains the database configuration
	DB DB `yaml:"auth"`

	// Logger contains the logger used by echo functions
	Logger *zap.SugaredLogger `yaml:"logger"`
}

type ConfigProvider interface {
	// GetConfig returns the server configuration
	GetConfig() (*Config, error)
}

type ConfigProviderWithRefresh struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

type DB struct {
	// Debug to print debug database logs
	Debug bool
	// SQL Driver name from dialect.Driver
	DriverName string
	// MultiWrite enabled writing to two databases
	MultiWrite bool
	// Primary write database source (required)
	PrimaryDBSource string
	// Secondary write databsae source (optional)
	SecondaryDBSource string
	// CacheTTL to have results cached for subsequent requests
	CacheTTL time.Duration
}

type Server struct {
	// Debug enables echo's Debug option.
	Debug bool `yaml:"debug"`
	// Dev enables echo's dev mode options.
	Dev bool `yaml:"dev"`
	// Listen sets the listen address to serve the echo server on.
	Listen string
	// ShutdownGracePeriod sets the grace period for in flight requests before shutting down.
	ShutdownGracePeriod time.Duration `yaml:"shutdownGracePeriod"`
	// ReadTimeout sets the maximum duration for reading the entire request including the body.
	ReadTimeout time.Duration `yaml:"readTimeout"`
	// WriteTimeout sets the maximum duration before timing out writes of the response.
	WriteTimeout time.Duration `yaml:"writeTimeout"`
	// IdleTimeout sets the maximum amount of time to wait for the next request when keep-alives are enabled.
	IdleTimeout time.Duration `yaml:"idleTimeout"`
	// ReadHeaderTimeout sets the amount of time allowed to read request headers.
	ReadHeaderTimeout time.Duration `yaml:"readHeaderTimeout"`
	// TLS contains the tls configuration settings
	TLS TLS `yaml:"tls"`
	// CORS contains settings to allow cross origin settings and insecure cookies
	CORS CORS `yaml:"cors"`
	// Routes contains the handler functions
	Routes []http.Handler `yaml:"routes"`
	// Middleware to enable on the echo server
	Middleware []echo.MiddlewareFunc `yaml:"middleware"`
	// Handler contains the required settings for REST handlers including ready checks and JWT keys
	Handler handlers.Handler `yaml:"checks"`
	// Token contains the token config settings
	Token tokens.Config `yaml:"token"`
}

type TLS struct {
	// Config contains the tls.Config settings
	Config *tls.Config `yaml:"config"`
	// Enabled turns on TLS settings for the server
	Enabled bool
	// CertFile location for the TLS server
	CertFile string
	// CertKey file location for the TLS server
	CertKey string
	// AutoCert generates the cert with letsencrypt, this does not work on localhost
	AutoCert bool
}