auth

Documentation

Index

• Constants
• type Auther
• type HookAuth
  • func (a *HookAuth) Auth(r *http.Request, usr users.Store, stg *settings.Settings, srv *settings.Server) (*users.User, error)
  • func (a *HookAuth) GetUser(d *users.User) *users.User
  • func (a *HookAuth) GetValues(s string)
  • func (a *HookAuth) LoginPage() bool
  • func (a *HookAuth) RunCommand() (string, error)
  • func (a *HookAuth) SaveUser() (*users.User, error)
• type JSONAuth
  • func (a JSONAuth) Auth(r *http.Request, usr users.Store, stg *settings.Settings, srv *settings.Server) (*users.User, error)
  • func (a JSONAuth) LoginPage() bool
• type NoAuth
  • func (a NoAuth) Auth(r *http.Request, usr users.Store, stg *settings.Settings, srv *settings.Server) (*users.User, error)
  • func (a NoAuth) LoginPage() bool
• type OAuthClient
  • func (o *OAuthClient) HandleAuthCallback(r *http.Request, usr users.Store, srv *settings.Server) (*users.User, error)
  • func (o *OAuthClient) InitAuthFlow(w http.ResponseWriter, r *http.Request)
  • func (o *OAuthClient) InitClient()
• type OIDCAuth
  • func (a OIDCAuth) Auth(r *http.Request, usr users.Store, _ *settings.Settings, srv *settings.Server) (*users.User, error)
  • func (a OIDCAuth) LoginPage() bool
• type ProxyAuth
  • func (a ProxyAuth) Auth(r *http.Request, usr users.Store, stg *settings.Settings, srv *settings.Server) (*users.User, error)
  • func (a ProxyAuth) LoginPage() bool
• type ReCaptcha
  • func (r *ReCaptcha) Ok(response string) (bool, error)
• type Storage
  • func NewStorage(back StorageBackend, userStore *users.Storage) *Storage
  • func (s *Storage) Get(t settings.AuthMethod) (Auther, error)
  • func (s *Storage) Save(a Auther) error
• type StorageBackend

Constants

const MethodHookAuth settings.AuthMethod = "hook"

MethodHookAuth is used to identify hook auth.

const MethodJSONAuth settings.AuthMethod = "json"

MethodJSONAuth is used to identify json auth.

const MethodNoAuth settings.AuthMethod = "noauth"

MethodNoAuth is used to identify no auth.

const MethodOIDCAuth settings.AuthMethod = "oidc"

MethodOIDCAuth is used to identify oidc auth.

const MethodProxyAuth settings.AuthMethod = "proxy"

MethodProxyAuth is used to identify no auth.

Types

type Auther

type Auther interface {
	// Auth is called to authenticate a request.
	Auth(r *http.Request, usr users.Store, stg *settings.Settings, srv *settings.Server) (*users.User, error)
	// LoginPage indicates if this auther needs a login page.
	LoginPage() bool
}

Auther is the authentication interface.

type HookAuth

type HookAuth struct {
	Users    users.Store        `json:"-"`
	Settings *settings.Settings `json:"-"`
	Server   *settings.Server   `json:"-"`
	Cred     hookCred           `json:"-"`
	Fields   hookFields         `json:"-"`
	Command  string             `json:"command"`
}

HookAuth is a hook implementation of an Auther.

func (*HookAuth) Auth

func (a *HookAuth) Auth(r *http.Request, usr users.Store, stg *settings.Settings, srv *settings.Server) (*users.User, error)

Auth authenticates the user via a json in content body.

func (*HookAuth) GetUser

func (a *HookAuth) GetUser(d *users.User) *users.User

GetUser returns a User filled with hook values or provided defaults

func (*HookAuth) GetValues

func (a *HookAuth) GetValues(s string)

GetValues creates a map with values from the key-value format string

func (*HookAuth) LoginPage

func (a *HookAuth) LoginPage() bool

LoginPage tells that hook auth requires a login page.

func (*HookAuth) RunCommand

func (a *HookAuth) RunCommand() (string, error)

RunCommand starts the hook command and returns the action

func (*HookAuth) SaveUser

func (a *HookAuth) SaveUser() (*users.User, error)

SaveUser updates the existing user or creates a new one when not found

type JSONAuth

type JSONAuth struct {
	ReCaptcha *ReCaptcha `json:"recaptcha" yaml:"recaptcha"`
}

JSONAuth is a json implementation of an Auther.

func (JSONAuth) Auth

func (a JSONAuth) Auth(r *http.Request, usr users.Store, stg *settings.Settings, srv *settings.Server) (*users.User, error)

Auth authenticates the user via a json in content body.

func (JSONAuth) LoginPage

func (a JSONAuth) LoginPage() bool

LoginPage tells that json auth doesn't require a login page.

type NoAuth

type NoAuth struct{}

NoAuth is no auth implementation of auther.

func (NoAuth) Auth

func (a NoAuth) Auth(r *http.Request, usr users.Store, stg *settings.Settings, srv *settings.Server) (*users.User, error)

Auth uses authenticates user 1.

func (NoAuth) LoginPage

func (a NoAuth) LoginPage() bool

LoginPage tells that no auth doesn't require a login page.

type OAuthClient

type OAuthClient struct {
	ClientID               string                `json:"clientID"`
	ClientSecret           string                `json:"clientSecret"`
	Issuer                 string                `json:"issuer"`
	RedirectURL            string                `json:"redirectURL"`
	RedirectURLAppendQuery bool                  `json:"redirectURLAppendQuery"`
	OAuth2Config           oauth2.Config         `json:"-"`
	Verifier               *oidc.IDTokenVerifier `json:"-"`
}

OAuthClient describes the oidc connector parameters.

func (*OAuthClient) HandleAuthCallback

func (o *OAuthClient) HandleAuthCallback(r *http.Request, usr users.Store, srv *settings.Server) (*users.User, error)

HandleAuthCallback manages code exchange and obtains the id token.

func (*OAuthClient) InitAuthFlow

func (o *OAuthClient) InitAuthFlow(w http.ResponseWriter, r *http.Request)

InitAuthFlow triggers the oidc authentication flow.

func (*OAuthClient) InitClient

func (o *OAuthClient) InitClient()

InitClient configures the connector via oidc discovery.

type OIDCAuth

type OIDCAuth struct {
	OIDC *OAuthClient `json:"oidc" yaml:"oidc"`
}

OIDCAuth is an Open ID Connect auther implementation.

func (OIDCAuth) Auth

func (a OIDCAuth) Auth(r *http.Request, usr users.Store, _ *settings.Settings, srv *settings.Server) (*users.User, error)

Auth is executed when the identity provider enters the callback phase of an oauth code flow.

func (OIDCAuth) LoginPage

func (a OIDCAuth) LoginPage() bool

LoginPage tells that oidc auth doesn't require a login page.

type ProxyAuth

type ProxyAuth struct {
	Header string `json:"header"`
}

ProxyAuth is a proxy implementation of an auther.

func (ProxyAuth) Auth

func (a ProxyAuth) Auth(r *http.Request, usr users.Store, stg *settings.Settings, srv *settings.Server) (*users.User, error)

Auth authenticates the user via an HTTP header.

func (ProxyAuth) LoginPage

func (a ProxyAuth) LoginPage() bool

LoginPage tells that proxy auth doesn't require a login page.

type ReCaptcha

type ReCaptcha struct {
	Host   string `json:"host"`
	Key    string `json:"key"`
	Secret string `json:"secret"`
}

ReCaptcha identifies a recaptcha connection.

func (*ReCaptcha) Ok

func (r *ReCaptcha) Ok(response string) (bool, error)

Ok checks if a reCaptcha responde is correct.

type Storage

type Storage struct {
	// contains filtered or unexported fields
}

Storage is a auth storage.

func NewStorage

func NewStorage(back StorageBackend, userStore *users.Storage) *Storage

NewStorage creates a auth storage from a backend.

func (*Storage) Get

func (s *Storage) Get(t settings.AuthMethod) (Auther, error)

Get wraps a StorageBackend.Get.

func (*Storage) Save

func (s *Storage) Save(a Auther) error

Save wraps a StorageBackend.Save.

type StorageBackend

type StorageBackend interface {
	Get(settings.AuthMethod) (Auther, error)
	Save(Auther) error
}

StorageBackend is a storage backend for auth storage.