oauth

Documentation

Index

• type Config
• type ConfigProvider
  • func StaticConfigProvider(conf Config) ConfigProvider
• type FrontendConfig
• type Server
  • func NewServer(c *component.Component, store Store, configProvider ConfigProvider) (Server, error)
• type StackConfig
• type Store
• type UIConfig

Types

type Config

type Config struct {
	Mount       string   `name:"mount" description:"Path on the server where the OAuth server will be served"`
	UI          UIConfig `name:"ui"`
	CSRFAuthKey []byte   `name:"-"`
}

Config is the configuration for the OAuth server.

type ConfigProvider

type ConfigProvider func(context.Context) Config

ConfigProvider returns the server configuration based on the context.

func StaticConfigProvider

func StaticConfigProvider(conf Config) ConfigProvider

StaticConfigProvider is a provider that always returns the same config.

type FrontendConfig

type FrontendConfig struct {
	Language    string `json:"language" name:"-"`
	StackConfig `json:"stack_config" name:",squash"`
}

FrontendConfig is the configuration for the OAuth frontend.

type Server

type Server interface {
	web.Registerer

	Login(c echo.Context) error
	CurrentUser(c echo.Context) error
	Logout(c echo.Context) error
	Authorize(authorizePage echo.HandlerFunc) echo.HandlerFunc
	Token(c echo.Context) error
}

Server is the interface for the OAuth server.

func NewServer

func NewServer(c *component.Component, store Store, configProvider ConfigProvider) (Server, error)

NewServer returns a new OAuth server on top of the given store.

type StackConfig

type StackConfig struct {
	IS webui.APIConfig `json:"is" name:"is"`
}

StackConfig is the configuration of the stack components.

type Store

type Store interface {
	// UserStore and UserSessionStore are needed for user login/logout.
	store.UserStore
	store.UserSessionStore
	// ClientStore is needed for getting the OAuth client.
	store.ClientStore
	// OAuth is needed for OAuth authorizations.
	store.OAuthStore
}

Store used by the OAuth server.

type UIConfig

type UIConfig struct {
	webui.TemplateData `name:",squash"`
	FrontendConfig     `name:",squash"`
}

UIConfig is the combined configuration for the OAuth UI.