authentication

Documentation

Index

• func GenerateApplicationToken(compat bool) string
• func GenerateNotExistingToken(generateToken func(bool) string, compat bool, ...) string
• func GetApplication(ctx *gin.Context) *model.Application
• func GetUser(ctx *gin.Context) *model.User
• type Authenticator
  • func (a *Authenticator) RequireAdmin() gin.HandlerFunc
  • func (a *Authenticator) RequireApplicationToken() gin.HandlerFunc
  • func (a *Authenticator) RequireUser() gin.HandlerFunc
• type Database

Functions

func GenerateApplicationToken

func GenerateApplicationToken(compat bool) string

GenerateApplicationToken generates a token for an application.

func GenerateNotExistingToken

func GenerateNotExistingToken(generateToken func(bool) string, compat bool, tokenExists func(token string) bool) string

GenerateNotExistingToken receives a token generation function and a function to check whether the token exists, returns a unique token.

func GetApplication

func GetApplication(ctx *gin.Context) *model.Application

GetApplication returns the application which was previously registered by the authentication middleware.

func GetUser

func GetUser(ctx *gin.Context) *model.User

GetUser returns the user which was previously registered by the authentication middleware.

Types

type Authenticator

type Authenticator struct {
	DB Database
}

Authenticator is the provider for authentication middleware.

func (*Authenticator) RequireAdmin

func (a *Authenticator) RequireAdmin() gin.HandlerFunc

RequireAdmin returns a Gin middleware which requires valid admin credentials to be supplied with the request.

func (*Authenticator) RequireApplicationToken

func (a *Authenticator) RequireApplicationToken() gin.HandlerFunc

RequireApplicationToken returns a Gin middleware which requires an application token to be supplied with the request.

func (*Authenticator) RequireUser

func (a *Authenticator) RequireUser() gin.HandlerFunc

RequireUser returns a Gin middleware which requires valid user credentials to be supplied with the request.

type Database

type Database interface {
	GetApplicationByToken(token string) (*model.Application, error)
	GetUserByName(name string) (*model.User, error)
}

The Database interface for encapsulating database access.