guard

Documentation

Index

• func IsNativeRBACGuard(name string) bool
• func Redirect(url string, status int) error
• func RedirectTo(url string) error
• func Respond(result response.Response) error
• func ResponseResult(err error) (response.Response, bool)
• func RunGuards(ctx Context, names []string, registry Registry) error
• func RunGuardsWithAuth(ctx Context, names []string, registry Registry, provider auth.Provider) error
• func WriteNoStoreFailure(writer http.ResponseWriter, err error)
• type Context
  • func NewContext(request *http.Request, session map[string]any) Context
• type Func
  • func NativeRBACGuard(name string, provider auth.Provider) Func
• type RedirectError
  • func (err RedirectError) Error() string
• type Registry
• type ResponseError
  • func (err ResponseError) Error() string

Functions

func IsNativeRBACGuard

func IsNativeRBACGuard(name string) bool

IsNativeRBACGuard reports whether name is a built-in role or permission guard.

func Redirect

func Redirect(url string, status int) error

Redirect returns an error that generated guard handling translates into a no-store local redirect with the provided 3xx status.

func RedirectTo

func RedirectTo(url string) error

RedirectTo returns an error that generated guard handling translates into a no-store local redirect.

func Respond

func Respond(result response.Response) error

Respond returns an error that generated guard handling translates into a no-store runtime response.

func ResponseResult

func ResponseResult(err error) (response.Response, bool)

ResponseResult extracts a generated guard response error.

func RunGuards

func RunGuards(ctx Context, names []string, registry Registry) error

RunGuards executes guard IDs in declaration order.

func RunGuardsWithAuth

func RunGuardsWithAuth(ctx Context, names []string, registry Registry, provider auth.Provider) error

RunGuardsWithAuth executes guard IDs in declaration order and resolves native RBAC guard IDs such as role:admin and permission:posts.write through provider.

func WriteNoStoreFailure

func WriteNoStoreFailure(writer http.ResponseWriter, err error)

WriteNoStoreFailure writes a generated guard failure response. Ordinary guard errors fail closed with 403; guard response helpers keep the same no-store cache policy while allowing explicit redirects or response shapes.

Types

type Context

type Context struct {
	Context context.Context
	Request *http.Request
	Session map[string]any
}

Context is passed to generated request-time guard functions.

func NewContext

func NewContext(request *http.Request, session map[string]any) Context

NewContext creates the first-slice request context for generated guards.

type Func

type Func func(Context) error

Func authorizes one generated request-time route or endpoint access check.

func NativeRBACGuard

func NativeRBACGuard(name string, provider auth.Provider) Func

NativeRBACGuard returns a guard for a native role or permission guard ID.

type RedirectError

type RedirectError struct {
	URL    string
	Status int
}

RedirectError asks generated guard handling to issue a safe local redirect.

func (RedirectError) Error

func (err RedirectError) Error() string

type Registry

type Registry map[string]Func

Registry resolves guard IDs to executable guard functions.

type ResponseError

type ResponseError struct {
	Result response.Response
}

ResponseError asks generated guard handling to write a runtime response.

func (ResponseError) Error

func (err ResponseError) Error() string