auth

Documentation

Index

• func ComparePassword(hashedPassword, password []byte) bool
• func CreatePassword(pw string) []byte
• func GenerateApplicationToken() string
• func GenerateClientToken() string
• func GetTokenID(ctx *gin.Context) string
• func GetUserID(ctx *gin.Context) uint
• func RegisterAuthentication(ctx *gin.Context, user *model.User, userID uint, tokenID string)
• type Auth
  • func (a *Auth) RequireAdmin() gin.HandlerFunc
  • func (a *Auth) RequireApplicationToken() gin.HandlerFunc
  • func (a *Auth) RequireClient() gin.HandlerFunc
• type Database

Functions

func ComparePassword

func ComparePassword(hashedPassword, password []byte) bool

ComparePassword compares a hashed password with its possible plaintext equivalent.

func CreatePassword

func CreatePassword(pw string) []byte

CreatePassword returns a hashed version of the given password.

func GenerateApplicationToken

func GenerateApplicationToken() string

GenerateApplicationToken generates an application token.

func GenerateClientToken

func GenerateClientToken() string

GenerateClientToken generates a client token.

func GetTokenID

func GetTokenID(ctx *gin.Context) string

GetTokenID returns the tokenID

func GetUserID

func GetUserID(ctx *gin.Context) uint

GetUserID returns the user id which was previously registered by RegisterAuthentication.

func RegisterAuthentication

func RegisterAuthentication(ctx *gin.Context, user *model.User, userID uint, tokenID string)

RegisterAuthentication registers the user id, user and or token.

Types

type Auth

type Auth struct {
	DB Database
}

Auth is the provider for authentication middleware

func (*Auth) RequireAdmin

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

RequireAdmin returns a gin middleware which requires a client token or basic authentication header to be supplied with the request. Also the authenticated user must be an administrator.

func (*Auth) RequireApplicationToken

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

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

func (*Auth) RequireClient

func (a *Auth) RequireClient() gin.HandlerFunc

RequireClient returns a gin middleware which requires a client token or basic authentication header to be supplied with the request.

type Database

type Database interface {
	GetApplicationByID(id string) *model.Application
	GetClientByID(id string) *model.Client
	GetUserByName(name string) *model.User
	GetUserByID(id uint) *model.User
}

The Database interface for encapsulating database access.