authenticator

Documentation

Index

• type Audiences
  • func (a Audiences) Has(taud string) bool
  • func (a Audiences) Intersect(tauds Audiences) Audiences
• type Password
• type PasswordFunc
  • func (f PasswordFunc) AuthenticatePassword(user, password string) (user.Info, bool, error)
• type Request
• type RequestFunc
  • func (f RequestFunc) AuthenticateRequest(req *http.Request) (user.Info, bool, error)
• type Token
• type TokenFunc
  • func (f TokenFunc) AuthenticateToken(token string) (user.Info, bool, error)

Types

type Audiences

type Audiences []string

Audiences is a container for the Audiences of a token.

func (Audiences) Has

func (a Audiences) Has(taud string) bool

Has checks if Audiences contains a specific audiences.

func (Audiences) Intersect

func (a Audiences) Intersect(tauds Audiences) Audiences

Intersect intersects Audiences with a target Audiences and returns all elements in both.

type Password

type Password interface {
	AuthenticatePassword(user, password string) (user.Info, bool, error)
}

Password checks a username and password against a backing authentication store and returns information about the user and true if successful, false if not successful, or an error if the username and password could not be checked

type PasswordFunc

type PasswordFunc func(user, password string) (user.Info, bool, error)

PasswordFunc is a function that implements the Password interface.

func (PasswordFunc) AuthenticatePassword

func (f PasswordFunc) AuthenticatePassword(user, password string) (user.Info, bool, error)

AuthenticatePassword implements authenticator.Password.

type Request

type Request interface {
	AuthenticateRequest(req *http.Request) (user.Info, bool, error)
}

Request attempts to extract authentication information from a request and returns information about the current user and true if successful, false if not successful, or an error if the request could not be checked.

type RequestFunc

type RequestFunc func(req *http.Request) (user.Info, bool, error)

RequestFunc is a function that implements the Request interface.

func (RequestFunc) AuthenticateRequest

func (f RequestFunc) AuthenticateRequest(req *http.Request) (user.Info, bool, error)

AuthenticateRequest implements authenticator.Request.

type Token

type Token interface {
	AuthenticateToken(token string) (user.Info, bool, error)
}

Token checks a string value against a backing authentication store and returns information about the current user and true if successful, false if not successful, or an error if the token could not be checked.

type TokenFunc

type TokenFunc func(token string) (user.Info, bool, error)

TokenFunc is a function that implements the Token interface.

func (TokenFunc) AuthenticateToken

func (f TokenFunc) AuthenticateToken(token string) (user.Info, bool, error)

AuthenticateToken implements authenticator.Token.