config

type AdminUser struct {
	Username string `json:"username" yaml:"username"`
	Key      Key    `json:"key" yaml:"key"`
}

type AdminUsers interface {
	All() []*AdminUser
	GetByUsername(username string) (*AdminUser, bool)
}

type AdminUsersExternalSource struct {
	KeysPath string `json:"keys_path" yaml:"keys_path"`
}

type AdminUsersList []*AdminUser

type Auth interface {
	GetType() AuthType
}

type AuthApiKey struct {
	Type AuthType `json:"type" yaml:"type"`
}

type AuthOAuth2 struct {
	Type                  AuthType    `json:"type" yaml:"type"`
	ClientId              StringValue `json:"client_id" yaml:"client_id"`
	ClientSecret          StringValue `json:"client_secret" yaml:"client_secret"`
	Scopes                []Scope     `json:"scopes" yaml:"scopes"`
	AuthorizationEndpoint string      `json:"authorization_endpoint" yaml:"authorization_endpoint"`
	TokenEndpoint         string      `json:"token_endpoint" yaml:"token_endpoint"`
}

type AuthType string

type C interface {
	// GetRoot gets the root of the configuration; the data loaded from a configuration file
	GetRoot() *Root

	// IsDebugMode tells the system if debug flags have been passed when running this service
	IsDebugMode() bool

	// MustGetService gets the service information for the specified service name
	MustGetService(serviceName ServiceId) Service

	// GetFallbackConnectorLogo gets a logo to use if not specified for a connector configuration
	GetFallbackConnectorLogo() string
}

type Connector struct {
	Id          string `json:"id" yaml:"id"`
	Version     uint64 `json:"version" yaml:"version"`
	DisplayName string `json:"display_name" yaml:"display_name"`
	Logo        Image  `json:"logo" yaml:"logo"`
	Description string `json:"description" yaml:"description"`
	Auth        Auth   `json:"auth" yaml:"auth"`
}

type Database interface {
	GetProvider() DatabaseProvider
}

type DatabaseProvider string

type DatabaseSqlite struct {
	Provider DatabaseProvider `json:"provider" yaml:"provider"`
	Path     string           `json:"path" yaml:"path"`
}

type ErrorPages struct {
	Unauthorized string `json:"unauthorized" yaml:"unauthorized"`
	Fallback     string `json:"fallback" yaml:"fallback"`
}

type HumanDuration struct {
	time.Duration
}

type Image interface {
	GetUrl() string
}

type ImageBase64 struct {
	MimeType string `json:"mime_type" yaml:"mime_type"`
	Base64   string `json:"base64" yaml:"base64"`
}

type ImagePublicUrl struct {
	PublicUrl string `json:"public_url" yaml:"public_url"`
}

type Key interface {
	// CanSign checks if the key can sign requests (either private key is present or shared key)
	CanSign() bool
	// CanVerifySignature checks if the key can be used to verify the signature of something (public key is present or shared key)
	CanVerifySignature() bool
}

type KeyData interface {
	// HasData checks if this value has data.
	HasData(ctx context.Context) bool

	// GetData retrieves the bytes of the key
	GetData(ctx context.Context) ([]byte, error)
}

type KeyDataBase64Val struct {
	Base64 string `json:"base64" yaml:"base64"`
}

type KeyDataEnvVar struct {
	EnvVar string `json:"env_var" yaml:"env_var"`
}

type KeyDataFile struct {
	Path string `json:"path" yaml:"path"`
}

type KeyDataRandomBytes struct {
	NumBytes int `json:"num_bytes" yaml:"num_bytes"`
	// contains filtered or unexported fields
}

type KeyDataRawVal struct {
	Raw []byte `json:"-" yaml:"-"`
}

type KeyDataValue struct {
	Value string `json:"value" yaml:"value"`
}

type KeyPublicPrivate struct {
	PublicKey  KeyData `json:"public_key" yaml:"public_key"`
	PrivateKey KeyData `json:"private_key" yaml:"private_key"`
}

type KeyShared struct {
	SharedKey KeyData `json:"shared_key" yaml:"shared_key"`
}

type OAuth struct {
	// InitiateToRedirectTtl is the time allowed between the oauth initiate API call, and the time when the browser
	// completes the redirect from the auth proxy public service. This value must be less than RoundTripTtl. This value
	// should be as small as possible as the handoff from the API to the redirect involves a one-time-use auth token
	// in the query parameters, which could be used to steal the session.
	InitiateToRedirectTtl HumanDuration `json:"initiate_to_redirect_ttl" yaml:"initiate_to_redirect_ttl"`

	// RoundTripTtl is the time we allow for the user to go through the oauth flow, from the initiate call, all the
	// way back to returning to AuthProxy to exchange the auth token for an access token. The purpose of this timeout
	// is to reduce the time that a redirect link from auth proxy would be valid for the purposes of phishing other
	// peoples credentials using this link as the basis.
	RoundTripTtl HumanDuration `json:"round_trip_ttl" yaml:"round_trip_ttl"`
}

type Redis interface {
	GetProvider() RedisProvider
}

type RedisMiniredis struct {
	Provider RedisProvider `json:"provider" yaml:"provider"`
}

type RedisProvider string

type RedisReal struct {
	Provider RedisProvider `json:"provider" yaml:"provider"`

	// The network type, either tcp or unix.
	// Default is tcp.
	Network string `json:"network" yaml:"network"`

	// host:port address.
	Address string `json:"address" yaml:"address"`

	// Protocol 2 or 3. Use the version to negotiate RESP version with redis-server.
	// Default is 3.
	Protocol int `json:"protocol" yaml:"protocol"`

	// Use the specified Username to authenticate the current connection
	// with one of the connections defined in the ACL list when connecting
	// to a Redis 6.0 instance, or greater, that is using the Redis ACL system.
	Username StringValue `json:"username" yaml:"username"`

	// Optional password. Must match the password specified in the
	// requirepass server configuration option (if connecting to a Redis 5.0 instance, or lower),
	// or the User Password when connecting to a Redis 6.0 instance, or greater,
	// that is using the Redis ACL system.
	Password StringValue `json:"password" yaml:"password"`

	// Database to be selected after connecting to the server.
	DB int `json:"db" yaml:"db"`
}

type Root struct {
	AdminApi   ServiceAdminApi `json:"admin_api" yaml:"admin_api"`
	Api        ServiceApi      `json:"api" yaml:"api"`
	Public     ServicePublic   `json:"public" yaml:"public"`
	SystemAuth SystemAuth      `json:"system_auth" yaml:"system_auth"`
	Database   Database        `json:"database" yaml:"database"`
	Redis      Redis           `json:"redis" yaml:"redis"`
	Oauth      OAuth           `json:"oauth" yaml:"oauth"`
	ErrorPages ErrorPages      `json:"error_pages" yaml:"error_pages"`
	Connectors []Connector     `json:"connectors" yaml:"connectors"`
}

type Scope struct {
	Id       string `json:"id" yaml:"id"`
	Required bool   `json:"required" yaml:"required"`
	Reason   string `json:"reason" yaml:"reason"`
}

type Service interface {
	Port() uint64
	IsHttps() bool
	Domain() string
	GetBaseUrl() string
	SupportsSession() bool
	GetId() ServiceId
}

type ServiceAdminApi struct {
	PortVal    uint64 `json:"port" yaml:"port"`
	DomainVal  string `json:"domain" yaml:"domain"`
	IsHttpsVal bool   `json:"https" yaml:"https"`
}

type ServiceApi struct {
	PortVal    uint64 `json:"port" yaml:"port"`
	DomainVal  string `json:"domain" yaml:"domain"`
	IsHttpsVal bool   `json:"https" yaml:"https"`
}

type ServiceId string

type ServicePublic struct {
	PortVal    uint64 `json:"port" yaml:"port"`
	DomainVal  string `json:"domain" yaml:"domain"`
	IsHttpsVal bool   `json:"https" yaml:"https"`
}

type StringValue interface {
	// HasValue checks if this value has data.
	HasValue(ctx context.Context) bool

	// GetValue retrieves the bytes of the key
	GetValue(ctx context.Context) (string, error)
}

type StringValueBase64 struct {
	Base64 string `json:"base64" yaml:"base64"`
}

type StringValueDirect struct {
	Value string `json:"value" yaml:"value"`
}

type StringValueEnvVar struct {
	EnvVar string `json:"env_var" yaml:"env_var"`
}

type StringValueFile struct {
	Path string `json:"path" yaml:"path"`
}

type SystemAuth struct {
	JwtSigningKey       Key           `json:"jwt_signing_key" yaml:"jwt_signing_key"`
	JwtIssuerVal        string        `json:"jwt_issuer" yaml:"jwt_issuer"`
	JwtTokenDurationVal time.Duration `json:"jwt_token_duration" yaml:"jwt_token_duration"`
	CookieDomain        string        `json:"cookie_domain" yaml:"cookie_domain"`
	CookieDurationVal   time.Duration `json:"cookie_duration" yaml:"cookie_duration"`
	DisableXSRF         bool          `json:"disable_xsrf" yaml:"disable_xsrf"`
	AdminUsers          AdminUsers    `json:"admin_users" yaml:"admin_users"`
	GlobalAESKey        KeyData       `json:"global_aes_key" yaml:"global_aes_key"`
}