middleware

Documentation

Overview

Package middleware contains application specific gin middleware functions.

Package middleware defines shared middleware for handlers.

Index

• Constants
• func ConfigureCSRF(ctx context.Context, config *config.ServerConfig, h *render.Renderer) mux.MiddlewareFunc
• func PopulateTemplateVariables(ctx context.Context, config *config.ServerConfig) mux.MiddlewareFunc
• func RequireAPIKey(ctx context.Context, cache *cache.Cache, db *database.Database, ...) mux.MiddlewareFunc
• func RequireAdmin(ctx context.Context, h *render.Renderer) mux.MiddlewareFunc
• func RequireAuth(ctx context.Context, client *auth.Client, db *database.Database, ...) mux.MiddlewareFunc
• func RequireRealm(ctx context.Context, db *database.Database, h *render.Renderer) mux.MiddlewareFunc
• func RequireRealmAdmin(ctx context.Context, h *render.Renderer) mux.MiddlewareFunc
• func RequireSession(ctx context.Context, store sessions.Store, h *render.Renderer) func(http.Handler) http.Handler

Constants

const (
	// APIKeyHeader is the authorization header required for APIKey protected requests.
	APIKeyHeader = "X-API-Key"
)

Functions

func ConfigureCSRF

func ConfigureCSRF(ctx context.Context, config *config.ServerConfig, h *render.Renderer) mux.MiddlewareFunc

ConfigureCSRF injects the CSRF handling and populates the global template map with the csrfToken and csrfTemplate.

func PopulateTemplateVariables

func PopulateTemplateVariables(ctx context.Context, config *config.ServerConfig) mux.MiddlewareFunc

PopulateTemplateVariables populates the template variables with common information and bootstraps the map for more values to be set by other middlewares.

func RequireAPIKey

func RequireAPIKey(ctx context.Context, cache *cache.Cache, db *database.Database, h *render.Renderer, allowedTypes []database.APIUserType) mux.MiddlewareFunc

RequireAPIKey reads the X-API-Key header and validates it is a real authorized app. It also ensures currentAuthorizedApp is set in the template map.

func RequireAdmin

func RequireAdmin(ctx context.Context, h *render.Renderer) mux.MiddlewareFunc

RequireAdmin requires the current user is a global administrator. It must come after RequireAuth so that a user is set on the context.

func RequireAuth

func RequireAuth(ctx context.Context, client *auth.Client, db *database.Database, h *render.Renderer, ttl time.Duration) mux.MiddlewareFunc

RequireAuth requires a user to be logged in. It also ensures that currentUser is set in the template map. It fetches a user from the session and stores the full record in the request context.

func RequireRealm

func RequireRealm(ctx context.Context, db *database.Database, h *render.Renderer) mux.MiddlewareFunc

RequireRealm requires a realm to exist in the session. It also ensures the realm is set as currentRealm in the template map. It must come after RequireAuth so that a user is set on the context.

func RequireRealmAdmin

func RequireRealmAdmin(ctx context.Context, h *render.Renderer) mux.MiddlewareFunc

RequireRealmAdmin verifies the user is an admin of the current realm. It must come after RequireAuth and RequireRealm so that a user and realm are set on the context.

func RequireSession

func RequireSession(ctx context.Context, store sessions.Store, h *render.Renderer) func(http.Handler) http.Handler

RequireSession retrieves or creates a new session and stores it on the request's context for future retrieval. It also ensures the flash data is populated in the template map. Any handler that wants to utilize sessions should use this middleware.