runtimectx

Documentation

Index

• Constants
• Variables
• func GetMailClient(ctx context.Context) (mail.EmailClient, error)
• func GetNow() time.Time
• func GetOAuthConfig(ctx context.Context) (*config.AuthConfig, error)
• func GetPrivateKey(ctx context.Context) (*rsa.PrivateKey, error)
• func GetRequestHeaders(ctx context.Context) (map[string][]string, error)
• func GetSecret(ctx context.Context, secret string) (string, error)
• func GetSecrets(ctx context.Context) map[string]string
• func WithAuthConfig(ctx context.Context, config AuthConfig) context.Context
• func WithEnv(ctx context.Context, env KeelEnv) context.Context
• func WithIssuersFromEnv(ctx context.Context) context.Context
• func WithMailClient(ctx context.Context, client mail.EmailClient) context.Context
• func WithOAuthConfig(ctx context.Context, config *config.AuthConfig) context.Context
• func WithPrivateKey(ctx context.Context, privateKey *rsa.PrivateKey) context.Context
• func WithRequestHeaders(ctx context.Context, headers map[string][]string) context.Context
• func WithSecrets(ctx context.Context, secrets map[string]string) context.Context
• type AuthConfig
  • func GetAuthConfig(ctx context.Context) (*AuthConfig, error)
• type EnvKeyContextType
• type ExternalIssuer
• type KeelAuthConfig
• type KeelEnv
  • func GetEnv(ctx context.Context) KeelEnv

Constants

const (
	ContextIdentityField        = "identity"
	ContextIsAuthenticatedField = "isAuthenticated"
	ContextNowField             = "now"
	ContextEnvField             = "env"
	ContextSecretField          = "secret"
)

const ContextTarget string = "ctx"

const (
	ExternalIssuersEnvKey string = "KEEL_EXTERNAL_ISSUERS"
)

const (
	SecretContextKey secretContextKey = "secret"
)

Variables

var ContextFieldTypes = map[string]proto.Type{
	ContextIdentityField:        proto.Type_TYPE_MODEL,
	ContextIsAuthenticatedField: proto.Type_TYPE_BOOL,
	ContextNowField:             proto.Type_TYPE_DATETIME,
	ContextEnvField:             proto.Type_TYPE_OBJECT,
	ContextSecretField:          proto.Type_TYPE_SECRET,
}

Functions

func GetMailClient

func GetMailClient(ctx context.Context) (mail.EmailClient, error)

func GetNow

func GetNow() time.Time

func GetOAuthConfig

func GetOAuthConfig(ctx context.Context) (*config.AuthConfig, error)

func GetPrivateKey

func GetPrivateKey(ctx context.Context) (*rsa.PrivateKey, error)

func GetRequestHeaders

func GetRequestHeaders(ctx context.Context) (map[string][]string, error)

func GetSecret

func GetSecret(ctx context.Context, secret string) (string, error)

func GetSecrets

func GetSecrets(ctx context.Context) map[string]string

func WithAuthConfig

func WithAuthConfig(ctx context.Context, config AuthConfig) context.Context

func WithEnv

func WithEnv(ctx context.Context, env KeelEnv) context.Context

func WithIssuersFromEnv

func WithIssuersFromEnv(ctx context.Context) context.Context

Backwards compatibility with the previous env var config.

func WithMailClient

func WithMailClient(ctx context.Context, client mail.EmailClient) context.Context

func WithOAuthConfig

func WithOAuthConfig(ctx context.Context, config *config.AuthConfig) context.Context

func WithPrivateKey

func WithPrivateKey(ctx context.Context, privateKey *rsa.PrivateKey) context.Context

func WithRequestHeaders

func WithRequestHeaders(ctx context.Context, headers map[string][]string) context.Context

func WithSecrets

func WithSecrets(ctx context.Context, secrets map[string]string) context.Context

Types

type AuthConfig

type AuthConfig struct {
	// If enabled, will verify tokens using any OIDC compatible issuer
	AllowAnyIssuers bool             `json:"AllowAllIssuers"`
	Issuers         []ExternalIssuer `json:"issuers"`
	Keel            *KeelAuthConfig  `json:"keel"`
}

func GetAuthConfig

func GetAuthConfig(ctx context.Context) (*AuthConfig, error)

type EnvKeyContextType

type EnvKeyContextType string

type ExternalIssuer

type ExternalIssuer struct {
	Iss      string  `json:"iss"`
	Audience *string `json:"audience"`
}

type KeelAuthConfig

type KeelAuthConfig struct {
	// Allow new identities to be created through the authenticate endpoint
	AllowCreate bool `json:"allowCreate"`
	// In seconds
	TokenDuration int `json:"tokenDuration"`
}

type KeelEnv

type KeelEnv string

const (
	// The Test environment denotes any Keel environment that isn't production or staging. So this includes the
	// runtime inside of the Keel Test Framework runner, as well as the runtime locally (e.g 'keel run' in the CLI)
	KeelEnvTest       KeelEnv = "test"
	KeelEnvProduction KeelEnv = "production"
)

func GetEnv

func GetEnv(ctx context.Context) KeelEnv