Back to

Package oauth

Latest Go to latest

The latest major version is v3.

Published: Apr 29, 2020 | License: Apache-2.0 | Module:


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"`

Config is the configuration for the OAuth server.

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 {

	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(ctx context.Context, store Store, config Config) Server

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.
	// ClientStore is needed for getting the OAuth client.
	// OAuth is needed for OAuth authorizations.

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.

Package Files

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier