middleware

Documentation

Index

• func ContextMiddleware(con interface{}, findUserFunc FindUser, config *_conf.Config) func(http.Handler) http.Handler
• func GetUser(ctx context.Context) interface{}
• func JwtToUser(jwtStr string, findUserFunc FindUser, con interface{}, config *_conf.Config) (interface{}, error)
• func LoginRequired(con interface{}, findUserFunc FindUser, conf *config.Config) func(http.Handler) http.Handler
• func SetUser(r *http.Request, user interface{}) *http.Request
• type Error
• type FindUser

Functions

func ContextMiddleware

func ContextMiddleware(
	con interface{},
	findUserFunc FindUser,
	config *_conf.Config,
) func(http.Handler) http.Handler

ContextMiddleware adds the authenticated user to http.Request.Context. if there's the token in the specified header / cookie in config.

func GetUser

func GetUser(ctx context.Context) interface{}

GetUser get user from context

func JwtToUser

func JwtToUser(
	jwtStr string,
	findUserFunc FindUser,
	con interface{},
	config *_conf.Config,
) (interface{}, error)

JwtToUser converts jwStr to the corresponding user.

func LoginRequired

func LoginRequired(
	con interface{},
	findUserFunc FindUser,
	conf *config.Config,
) func(http.Handler) http.Handler

LoginRequired enforces user authentication. If the user is not authenticated, it returns 401 (Not Authenticated).

func SetUser

func SetUser(
	r *http.Request,
	user interface{},
) *http.Request

SetUser set user to context

Types

type Error

type Error struct {
	Message string `json:"message,omitempty"`
}

Error represents an error.

type FindUser

type FindUser func(con interface{}, username string) (interface{}, error)

FindUser represents a function to find a user by username,