config

Documentation

Overview

File for all the secret key file parsing and initializiation

Index

• func CheckGenerateKeys(secretPath string) (string, error)
• func GenerateKeyString() (string, error)
• func GetPublicKey(keyStr string) (string, error)
• func InjectSecret(secret string, appConfig *CommonConfiguration)
• func IsExpiredKey(fileContent string) (bool, error)
• type CommonConfiguration
  • func (config *CommonConfiguration) ParseAndSetJWT(unvalidatedToken string) error
• type CustomClaims
  • func (c *CustomClaims) Valid() error
  • func (c *CustomClaims) VerifyIssuer(issuer string) bool
  • func (c *CustomClaims) VerifySubject(subject string) bool
• type ValidJWT
  • func ValidateAndCreateJWT(unvalidatedToken string) (*ValidJWT, error)

Functions

func CheckGenerateKeys

func CheckGenerateKeys(secretPath string) (string, error)

func GenerateKeyString

func GenerateKeyString() (string, error)

func GetPublicKey

func GetPublicKey(keyStr string) (string, error)

func InjectSecret

func InjectSecret(secret string, appConfig *CommonConfiguration)

func IsExpiredKey

func IsExpiredKey(fileContent string) (bool, error)

Types

type CommonConfiguration

type CommonConfiguration struct {
	DefaultLimitsCPU     string        `yaml:"defaultLimitsCPU"      env:"DEFAULT_LIMITS_CPU"      env-default:"100m"`
	DefaultLimitsMemory  string        `yaml:"defaultLimitsMemory"   env:"DEFAULT_LIMITS_MEMORY"   env-default:"128Mi"`
	DefaultRequestsCPU   string        `yaml:"defaultRequestsCPU"    env:"DEFAULT_REQUESTS_CPU"    env-default:"50m"`
	DefaultRequestMemory string        `yaml:"defaultRequestMemory"  env:"DEFAULT_REQUESTS_MEMORY" env-default:"64Mi"`
	DefaultVolumeSize    string        `yaml:"defaultVolumeSize"     env:"DEFAULT_VOLUME_SIZE"     env-default:"1G"`
	DefaultTag           string        `yaml:"defaultTag"            env:"DEFAULT_TAG"             env-default:"latest"`
	DefaultTimeout       time.Duration `yaml:"defaultTimeout"        env:"DEFAULT_TIMEOUT"         env-default:"5s"`
	GrpcKeepalive        time.Duration `yaml:"grpcKeepalive"         env:"GRPC_KEEPALIVE"          env-default:"60s"`
	Name                 string        `yaml:"name"                  env:"NAME"                    env-default:"dagent-go"`
	Debug                bool          `yaml:"debug"                 env:"DEBUG"                   env-default:"false"`
	ImportContainerImage string        `yaml:"importContainerImage"  env:"IMPORT_CONTAINER_IMAGE"  env-default:"rclone/rclone:1.57.0"`
	IngressRootDomain    string        `yaml:"ingressRootDomain"     env:"INGRESS_ROOT_DOMAIN"     env-default:""`
	ReadHeaderTimeout    time.Duration `yaml:"readHeaderTimeout"     env:"READ_HEADER_TIMEOUT"     env-default:"15s"`
	// DefaultRegistry container registry used for container name expansion
	DefaultRegistry string `yaml:"registry"             env:"DEFAULT_REGISTRY"                 env-default:"index.docker.io"`
	// GRPC token is set separately, because nested structures are not yet suppported in cleanenv
	GrpcToken *ValidJWT
	// injected from crane/dagent
	SecretPrivateKey string
}

Configuration defaults

Convention is we have all the options here, but where defaults should be different we handle it on application level, every time we need a parameter we call into a function in a package which calls here, then we populate the options which should be different if not defined otherwise.

Using custom types allows to set the value from the environment variable you need to implement the Setter interface on the field level.

Similar to JSON/YAML deserializing application startup -> load Configuration (read environment variables) -> unwrap variables (custom type) the last step is a public SetValue function defined on the custom type

Example: ValidJWT Link: https://github.com/ilyakaznacheev/cleanenv#custom-value-setter

func (*CommonConfiguration) ParseAndSetJWT

func (config *CommonConfiguration) ParseAndSetJWT(unvalidatedToken string) error

type CustomClaims

type CustomClaims struct {
	jwt.RegisteredClaims
}

func (*CustomClaims) Valid

func (c *CustomClaims) Valid() error

func (*CustomClaims) VerifyIssuer

func (c *CustomClaims) VerifyIssuer(issuer string) bool

func (*CustomClaims) VerifySubject

func (c *CustomClaims) VerifySubject(subject string) bool

type ValidJWT

type ValidJWT struct {
	Issuer           string
	Subject          string
	IssuedAt         time.Time
	StringifiedToken string
}

func ValidateAndCreateJWT

func ValidateAndCreateJWT(unvalidatedToken string) (*ValidJWT, error)