authentication

Documentation

Index

• func AddUserMiddleware(f func(*http.Request) User) mux.Middleware
• func ContextWithUser(ctx context.Context, user any) context.Context
• func LoginRequiredMiddleware(notAuth func(w http.ResponseWriter, r *http.Request)) mux.Middleware
• type User
  • func Retrieve(r *http.Request) User
  • func UserFromContext(ctx context.Context) User

Functions

func AddUserMiddleware

func AddUserMiddleware(f func(*http.Request) User) mux.Middleware

Add a user to the request.

func ContextWithUser

func ContextWithUser(ctx context.Context, user any) context.Context

ContextWithUser returns a new context with the given user.

func LoginRequiredMiddleware

func LoginRequiredMiddleware(notAuth func(w http.ResponseWriter, r *http.Request)) mux.Middleware

Middleware that only allows users who are authenticated to continue. By default, will call the notAuth function. Configure the AddUserMiddleware to change the default behavior.

Types

type User

type User interface {
	// Check if the user is authenticated
	IsAuthenticated() bool

	// Check if the user is an administator
	IsAdmin() bool
}

Default request user interface.

This interface can be used to check if the user is authenticated and if the user is an administrator.

If you want to use these middlewares, you should implement this interface.

func Retrieve

func Retrieve(r *http.Request) User

Helper function to get the user from the request.

func UserFromContext

func UserFromContext(ctx context.Context) User