config

package
v0.18.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 13, 2026 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Overview

Package config defines the necessary types to configure the application. An example config file config.yaml is provided in the repository.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WithContext added in v0.18.0

func WithContext(ctx *sessionmanager.Context, cfg *Config) *sessionmanager.Context

WithContext returns a sessionmanager.Context that carries cfg. Apps' Provision methods retrieve it via FromContext when they need top-level configuration that is not part of their own per-app config block (e.g. valkey credentials, audit endpoints).

Types

type App added in v0.18.0

type App struct {
	Mod      string        `yaml:"module"`
	Services []*ServiceCfg `yaml:"services"`
	// contains filtered or unexported fields
}

App is the per-entry configuration under the top-level apps: section. It implements sessionmanager.ExtensionConfig so it can be passed to LoadApp.

func (*App) Module added in v0.18.0

func (c *App) Module() string

func (*App) UnmarshalExtension added in v0.18.0

func (c *App) UnmarshalExtension(into sessionmanager.Module) error

type ClientAuth added in v0.5.0

type ClientAuth struct {
	// Type defines how to authenticate the client.
	// Supported types are:
	//   - mtls: Mutual TLS authentication
	//   - clientSecret: Client Secret authentication
	Type string `yaml:"type" default:"mtls"`
	// MTLS contains the mTLS configuration when Type is set to "mtls".
	MTLS *commoncfg.MTLS `yaml:"mTLS"`
	// ClientSecret contains the client secret source reference when Type is set to "clientSecret".
	ClientSecret commoncfg.SourceRef `yaml:"clientSecret"`

	// Deprecated: ClientID is no longer used in the application code, but is still required in the config
	// to backfill existing database entries during migration.
	// It will be removed in a future release once the migration has been applied in all environments.
	ClientID string `yaml:"clientID"`
}

type Config

type Config struct {
	commoncfg.BaseConfig `yaml:",inline"`

	HTTP HTTPServer `yaml:"http"`
	GRPC GRPCServer `yaml:"grpc"`

	Database       Database       `yaml:"database"`
	ValKey         ValKey         `yaml:"valkey"`
	Migrate        Migrate        `yaml:"migrate"`
	SessionManager SessionManager `yaml:"sessionManager"`
	Housekeeper    Housekeeper    `yaml:"housekeeper"`
	Trust          Trust          `yaml:"trust"`
	Credentials    Credentials    `yaml:"credentials"`

	// Apps configures long-running components that satisfy the sessionmanager.App
	// interface. The map key is an operator-chosen name. Each entry MUST set
	// "module:" to the registered module ID; remaining fields are passed to the
	// module via UnmarshalExtension.
	Apps map[string]*App `yaml:"apps"`
	// AppsOrder optionally overrides the start order of apps. Apps not listed
	// here are started in parser-defined order after the listed ones. At
	// shutdown, apps are stopped in the reverse of the order in which they were
	// successfully started.
	AppsOrder []string `yaml:"appsOrder"`
}

func FromContext added in v0.18.0

func FromContext(ctx context.Context) (*Config, bool)

FromContext returns the *Config previously attached via WithContext. The boolean is false when no config has been attached.

func Load added in v0.18.0

func Load(buildInfo string, paths ...string) (*Config, error)

type CookieSameSiteValue added in v0.10.0

type CookieSameSiteValue string
const (
	CookieSameSiteLax    CookieSameSiteValue = "Lax"
	CookieSameSiteStrict CookieSameSiteValue = "Strict"
	CookieSameSiteNone   CookieSameSiteValue = "None"
)

type CookieTemplate added in v0.10.0

type CookieTemplate struct {
	Name     string              `yaml:"name"`
	MaxAge   int                 `yaml:"maxAge"`
	Path     string              `yaml:"path"`
	Domain   string              `yaml:"domain"`
	Secure   bool                `yaml:"secure"`
	SameSite CookieSameSiteValue `yaml:"sameSite"`
	HTTPOnly bool                `yaml:"httpOnly"`
}

func (*CookieTemplate) ToCookie added in v0.10.0

func (ct *CookieTemplate) ToCookie(value string) *http.Cookie

type Credentials added in v0.18.0

type Credentials struct {
	Mod string `yaml:"module" default:"credentials.module.oauth2"`
	// contains filtered or unexported fields
}

Credentials is a thin top-level entry whose only purpose is to make the credentials module ID swappable. The actual auth-type/secret/mTLS data continues to live under sessionManager.clientAuth and the credentials module reads it via config.FromContext.

func (*Credentials) Module added in v0.18.0

func (c *Credentials) Module() string

func (*Credentials) UnmarshalExtension added in v0.18.0

func (c *Credentials) UnmarshalExtension(into sessionmanager.Module) error

type Database

type Database struct {
	Mod string `yaml:"module" default:"database.module.pgxpool"`
	// contains filtered or unexported fields
}

func (*Database) Module added in v0.18.0

func (c *Database) Module() string

func (*Database) UnmarshalExtension added in v0.18.0

func (c *Database) UnmarshalExtension(into sessionmanager.Module) error

type GRPCServer

type GRPCServer struct {
	commoncfg.GRPCServer `yaml:",inline"`

	ShutdownTimeout time.Duration `yaml:"shutdownTimeout" default:"5s"`
}

type HTTPServer

type HTTPServer struct {
	Address         string        `yaml:"address" default:":8080"`
	ShutdownTimeout time.Duration `yaml:"shutdownTimeout" default:"5s"`
}

type Housekeeper added in v0.13.0

type Housekeeper struct {
	// TriggerInterval defines how often the housekeeper jobs run.
	TriggerInterval time.Duration `yaml:"triggerInterval" default:"10m"`
	// ConcurrencyLimit defines the maximum number of sessions handled concurrently during housekeeping.
	ConcurrencyLimit int `yaml:"concurrencyLimit" default:"10"`
	// TokenRefreshTriggerInterval defines the duration before token expiry when a token refresh should be triggered.
	// This should at least match the TriggerInterval to ensure that expiring tokens are refreshed in time.
	TokenRefreshTriggerInterval time.Duration `yaml:"tokenRefreshTriggerInterval" default:"15m"`
}

type Migrate

type Migrate struct {
	Mod string `yaml:"module" default:"trust.migration.module.oidc"`
	// contains filtered or unexported fields
}

func (*Migrate) Module added in v0.18.0

func (c *Migrate) Module() string

func (*Migrate) UnmarshalExtension added in v0.18.0

func (c *Migrate) UnmarshalExtension(into sessionmanager.Module) error

type ServiceCfg added in v0.18.0

type ServiceCfg struct {
	Mod string `yaml:"module"`
	// contains filtered or unexported fields
}

ServiceCfg is a per-entry configuration under an App's services: list. It implements sessionmanager.ExtensionConfig so an App's Provision can pass it to ctx.LoadModule.

func (*ServiceCfg) Module added in v0.18.0

func (c *ServiceCfg) Module() string

func (*ServiceCfg) UnmarshalExtension added in v0.18.0

func (c *ServiceCfg) UnmarshalExtension(into sessionmanager.Module) error

type SessionManager

type SessionManager struct {
	IdleSessionTimeout time.Duration `yaml:"idleSessionTimeout" default:"90m"`
	SessionDuration    time.Duration `yaml:"sessionDuration" default:"12h"`

	// CallbackURL is the URL path for the OAuth2 callback endpoint, where we receive the authorization code.
	CallbackURL      string              `yaml:"callbackURL" default:"/sm/callback"`
	ClientAuth       ClientAuth          `yaml:"clientAuth"`
	CSRFSecret       commoncfg.SourceRef `yaml:"csrfSecret"`
	CSRFSecretParsed []byte              `yaml:"-"`
	// SessionCookieTemplate defines the template attributes for the session cookie.
	SessionCookieTemplate CookieTemplate `yaml:"sessionCookieTemplate"`
	// CSRFCookieTemplate defines the template attributes for the CSRF cookie.
	CSRFCookieTemplate CookieTemplate `yaml:"csrfCookieTemplate"`
	// LoginCSRFCookieTemplate defines the template attributes for the CSRF cookie.
	LoginCSRFCookieTemplate CookieTemplate `yaml:"loginCSRFCookieTemplate"`

	// AllowedRedirectBaseURLs defines the list of allowed base URLs for redirection
	// during the authorization flow and post logout. This is used to validate the redirect
	// URLs provided in the authorization request and post logout requests.
	AllowedRedirectBaseURLs []string `yaml:"allowedRedirectBaseURLs"`

	// AllowHttpScheme permits OIDC issuers served over plain http:// (e.g. a local
	// mock IdP such as Dex during development). Defaults to false so production
	// only trusts https:// issuers.
	AllowHttpScheme bool `yaml:"allowHttpScheme" default:"false"`
}

type Trust added in v0.18.0

type Trust struct {
	Mod string `yaml:"module" default:"trust.module.oidc"`
	// contains filtered or unexported fields
}

func (*Trust) Module added in v0.18.0

func (c *Trust) Module() string

func (*Trust) UnmarshalExtension added in v0.18.0

func (c *Trust) UnmarshalExtension(into sessionmanager.Module) error

type ValKey

type ValKey struct {
	Mod       string              `yaml:"module" default:"sessionstore.module.valkey"`
	Host      commoncfg.SourceRef `yaml:"host"`
	User      commoncfg.SourceRef `yaml:"user"`
	Password  commoncfg.SourceRef `yaml:"password"`
	Prefix    string              `yaml:"prefix"`
	SecretRef commoncfg.SecretRef `yaml:"secretRef"`
	// contains filtered or unexported fields
}

func (*ValKey) Module added in v0.18.0

func (c *ValKey) Module() string

func (*ValKey) UnmarshalExtension added in v0.18.0

func (c *ValKey) UnmarshalExtension(into sessionmanager.Module) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL