bootstrap

Documentation

Index

• Constants
• func LoadSignerFromFile(fn string) (string, crypto.Signer, error)
• func LoadValidatorFromFile(fn string) (string, crypto.PublicKey, error)
• func RegisterIdentityManager(name string, f IdentityManagerFactory) error
• func WithSchemeAndHost(u, base *url.URL) *url.URL
• type APIType
• type Bootstrap
  • func Boot(ctx context.Context, settings *Settings, cfg *config.Config) (Bootstrap, error)
• type Config
• type IdentityManagerFactory
• type Settings

Constants

const (
	DefaultSigningKeyID   = "default"
	DefaultSigningKeyBits = 2048

	DefaultGuestIdentityManagerName = "guest"
)

Defaults.

Functions

func LoadSignerFromFile

func LoadSignerFromFile(fn string) (string, crypto.Signer, error)

LoadSignerFromFile loads a private-key for signing

Supports JSON (JWK/JWS) and PEM

func LoadValidatorFromFile

func LoadValidatorFromFile(fn string) (string, crypto.PublicKey, error)

LoadValidatorFromFile loads a public-key used for validation.

Supported formats are JSON-JWK and PEM

func RegisterIdentityManager

func RegisterIdentityManager(name string, f IdentityManagerFactory) error

func WithSchemeAndHost

func WithSchemeAndHost(u, base *url.URL) *url.URL

Types

type APIType

type APIType string

API types.

const (
	APITypeKonnect APIType = "konnect"
	APITypeSignin  APIType = "signin"
)

type Bootstrap

type Bootstrap interface {
	Config() *Config
	Managers() *managers.Managers

	MakeURIPath(api APIType, subpath string) string
}

Bootstrap is a data structure to hold configuration required to start konnectd.

func Boot

func Boot(ctx context.Context, settings *Settings, cfg *config.Config) (Bootstrap, error)

Boot is the main entry point to bootstrap the service after validating the given configuration. The resulting Bootstrap struct can be used to retrieve configured identity-managers and their respective http-handlers and config.

This function should be used by consumers which want to embed this project as a library.

type Config

type Config struct {
	Config   *config.Config
	Settings *Settings

	SignInFormURI            *url.URL
	SignedOutURI             *url.URL
	AuthorizationEndpointURI *url.URL
	EndSessionEndpointURI    *url.URL

	TLSClientConfig *tls.Config

	IssuerIdentifierURI *url.URL

	IdentifierClientDisabled          bool
	IdentifierClientPath              string
	IdentifierRegistrationConf        string
	IdentifierAuthoritiesConf         string
	IdentifierScopesConf              string
	IdentifierDefaultBannerLogo       []byte
	IdentifierDefaultSignInPageText   *string
	IdentifierDefaultUsernameHintText *string
	IdentifierUILocales               []string

	EncryptionSecret []byte
	SigningMethod    jwt.SigningMethod
	SigningKeyID     string
	Signers          map[string]crypto.Signer
	Validators       map[string]crypto.PublicKey

	AccessTokenDurationSeconds        uint64
	IDTokenDurationSeconds            uint64
	RefreshTokenDurationSeconds       uint64
	DyamicClientSecretDurationSeconds uint64
}

Config is a typed application config which represents the active bootstrap configuration.

type IdentityManagerFactory

type IdentityManagerFactory func(Bootstrap) (identity.Manager, error)

type Settings

type Settings struct {
	Iss                               string
	IdentityManager                   string
	URIBasePath                       string
	SignInURI                         string
	SignedOutURI                      string
	AuthorizationEndpointURI          string
	EndsessionEndpointURI             string
	Insecure                          bool
	TrustedProxy                      []string
	AllowScope                        []string
	AllowClientGuests                 bool
	AllowDynamicClientRegistration    bool
	EncryptionSecretFile              string
	Listen                            string
	IdentifierClientDisabled          bool
	IdentifierClientPath              string
	IdentifierRegistrationConf        string
	IdentifierScopesConf              string
	IdentifierDefaultBannerLogo       string
	IdentifierDefaultSignInPageText   string
	IdentifierDefaultUsernameHintText string
	IdentifierUILocales               []string
	SigningKid                        string
	SigningMethod                     string
	SigningPrivateKeyFiles            []string
	ValidationKeysPath                string
	CookieBackendURI                  string
	CookieNames                       []string
	AccessTokenDurationSeconds        uint64
	IDTokenDurationSeconds            uint64
	RefreshTokenDurationSeconds       uint64
	DyamicClientSecretDurationSeconds uint64
}

Settings is a typed application config which represents the user accessible boostrap settings params.