config

Documentation

Index

• Constants
• Variables
• type AuthConfig
  • func (c *AuthConfig) AccessTokenExpiry() time.Duration
  • func (c *AuthConfig) GetOAuthProviders() []Provider
  • func (c *AuthConfig) GetOidcProviders() []Provider
  • func (c *AuthConfig) GetOidcProvidersByIssuer(issuer string) ([]Provider, error)
  • func (c *AuthConfig) RefreshTokenExpiry() time.Duration
  • func (c *AuthConfig) RefreshTokenRotationEnabled() bool
• type Config
• type ConfigError
  • func (c ConfigError) Error() string
• type ConfigErrors
  • func Validate(config *ProjectConfig) *ConfigErrors
  • func (c ConfigErrors) Error() string
• type EnvironmentConfig
• type Input
• type ProjectConfig
  • func Load(dir string) (*ProjectConfig, error)
  • func LoadFromBytes(data []byte) (*ProjectConfig, error)
  • func (c *ProjectConfig) AllEnvironmentVariables() []string
  • func (c *ProjectConfig) AllSecrets() []string
  • func (p *ProjectConfig) GetEnvVars(env string) map[string]string
  • func (c *ProjectConfig) ValidateSecrets(localSecrets map[string]string) (bool, []string)
• type Provider
  • func (c *Provider) GetAuthorizationUrl() (string, error)
  • func (c *Provider) GetIssuer() (string, error)
  • func (c *Provider) GetTokenUrl() (string, error)
• type TokensConfig

Constants

const (
	// 24 hours is the default access token expiry period
	DefaultAccessTokenExpiry time.Duration = time.Hour * 24
	// 3 months is the default refresh token expiry period
	DefaultRefreshTokenExpiry time.Duration = time.Hour * 24 * 90
)

const (
	GoogleProvider        = "google"
	FacebookProvider      = "facebook"
	GitLabProvider        = "gitlab"
	OpenIdConnectProvider = "oidc"
	OAuthProvider         = "oauth"
)

const (
	ConfigDuplicateErrorString                       = "environment variable %s has a duplicate set in environment: %s"
	ConfigRequiredErrorString                        = "environment variable %s is required but not defined in the following environments: %s"
	ConfigIncorrectNamingErrorString                 = "%s must be written in upper snakecase"
	ConfigReservedNameErrorString                    = "environment variable %s cannot start with %s as it is reserved"
	ConfigAuthTokenExpiryMustBePositive              = "%s token lifespan cannot be negative or zero for field: %s"
	ConfigAuthProviderMissingFieldAtIndexErrorString = "auth provider at index %v is missing field: %s"
	ConfigAuthProviderMissingFieldErrorString        = "auth provider '%s' is missing field: %s"
	ConfigAuthProviderInvalidTypeErrorString         = "auth provider '%s' has invalid type '%s' which must be one of: %s"
	ConfigAuthProviderDuplicateErrorString           = "auth provider name '%s' has been defined more than once, but must be unique"
	ConfigAuthProviderInvalidHttpUrlErrorString      = "auth provider '%s' has missing or invalid https url for field: %s"
)

Variables

var (
	SupportedProviderTypes = []string{
		GoogleProvider,
		FacebookProvider,
		GitLabProvider,
		OpenIdConnectProvider,
		OAuthProvider,
	}
)

Types

type AuthConfig

type AuthConfig struct {
	Tokens    TokensConfig `yaml:"tokens"`
	Providers []Provider   `yaml:"providers"`
}

func (*AuthConfig) AccessTokenExpiry

func (c *AuthConfig) AccessTokenExpiry() time.Duration

AccessTokenExpiry retrieves the configured or default access token expiry

func (*AuthConfig) GetOAuthProviders

func (c *AuthConfig) GetOAuthProviders() []Provider

func (*AuthConfig) GetOidcProviders

func (c *AuthConfig) GetOidcProviders() []Provider

func (*AuthConfig) GetOidcProvidersByIssuer

func (c *AuthConfig) GetOidcProvidersByIssuer(issuer string) ([]Provider, error)

GetOidcProvidersByIssuer gets all OpenID Connect providers by issuer url. It's possible that multiple providers from the same issuer are configured.

func (*AuthConfig) RefreshTokenExpiry

func (c *AuthConfig) RefreshTokenExpiry() time.Duration

RefreshTokenExpiry retrieves the configured or default refresh token expiry

func (*AuthConfig) RefreshTokenRotationEnabled

func (c *AuthConfig) RefreshTokenRotationEnabled() bool

RefreshTokenRotationEnabled retrieves the configured or default refresh token rotation

type Config

type Config struct{}

Config is the configuration for the Keel runtime

type ConfigError

type ConfigError struct {
	Type    string `json:"type,omitempty"`
	Message string `json:"message,omitempty"`
}

func (ConfigError) Error

func (c ConfigError) Error() string

type ConfigErrors

type ConfigErrors struct {
	Errors []*ConfigError `json:"errors"`
}

func Validate

func Validate(config *ProjectConfig) *ConfigErrors

func (ConfigErrors) Error

func (c ConfigErrors) Error() string

type EnvironmentConfig

type EnvironmentConfig struct {
	Default     []Input `yaml:"default"`
	Development []Input `yaml:"development"`
	Staging     []Input `yaml:"staging"`
	Production  []Input `yaml:"production"`
	Test        []Input `yaml:"test"`
}

EnvironmentConfig is the configuration for a keel environment default, staging, production

type Input

type Input struct {
	Name     string   `yaml:"name"`
	Value    string   `yaml:"value,omitempty"`
	Required []string `yaml:"required,omitempty"`
}

Input is the configuration for a keel environment variable or secret

type ProjectConfig

type ProjectConfig struct {
	Environment EnvironmentConfig `yaml:"environment"`
	Secrets     []Input           `yaml:"secrets"`
	Auth        AuthConfig        `yaml:"auth"`
	DisableAuth bool              `yaml:"disableKeelAuth"`
}

ProjectConfig is the configuration for a keel project

func Load

func Load(dir string) (*ProjectConfig, error)

func LoadFromBytes

func LoadFromBytes(data []byte) (*ProjectConfig, error)

func (*ProjectConfig) AllEnvironmentVariables

func (c *ProjectConfig) AllEnvironmentVariables() []string

AllEnvironmentVariables returns a slice of all of the unique environment variable key names defined across all environments

func (*ProjectConfig) AllSecrets

func (c *ProjectConfig) AllSecrets() []string

func (*ProjectConfig) GetEnvVars

func (p *ProjectConfig) GetEnvVars(env string) map[string]string

func (*ProjectConfig) ValidateSecrets

func (c *ProjectConfig) ValidateSecrets(localSecrets map[string]string) (bool, []string)

type Provider

type Provider struct {
	Type             string `yaml:"type"`
	Name             string `yaml:"name"`
	ClientId         string `yaml:"clientId"`
	IssuerUrl        string `yaml:"issuerUrl"`
	TokenUrl         string `yaml:"tokenUrl"`
	AuthorizationUrl string `yaml:"authorizationUrl"`
}

func (*Provider) GetAuthorizationUrl

func (c *Provider) GetAuthorizationUrl() (string, error)

func (*Provider) GetIssuer

func (c *Provider) GetIssuer() (string, error)

func (*Provider) GetTokenUrl

func (c *Provider) GetTokenUrl() (string, error)

type TokensConfig

type TokensConfig struct {
	AccessTokenExpiry           *int  `yaml:"accessTokenExpiry,omitempty"`
	RefreshTokenExpiry          *int  `yaml:"refreshTokenExpiry,omitempty"`
	RefreshTokenRotationEnabled *bool `yaml:"refreshTokenRotationEnabled,omitempty"`
}