Class ExpressRbacMiddleware

Express middleware implementing Quatrain RBAC route guards, FLS context injection and tarpit delays.

Hierarchy (View Summary)

AbstractRbacMiddleware<
    ExpressLikeRequest,
    ExpressLikeResponse,
    ExpressLikeNextFunction,
>
- ExpressRbacMiddleware

Index

Constructors

Properties

Methods

createRequestContext extractRoute extractUser handleAccessDenied handler

Constructors

constructor

new ExpressRbacMiddleware(
engine: any,
options?: ExpressRbacOptions,
): ExpressRbacMiddleware
Parameters
- engine: any
- options: ExpressRbacOptions = {}
Returns ExpressRbacMiddleware
Overrides AbstractRbacMiddleware.constructor
- Defined in middlewares/ExpressRbacMiddleware.ts:52

Properties

`Readonly`engine

engine: RbacPolicyEngine

Methods

createRequestContext

createRequestContext(user: RbacUserContext | null): RbacRequestContext
Factory method building a scoped RbacRequestContext helper for controllers and templates.
Parameters
- user: RbacUserContext | null
  Current user context (or null for anonymous guest).
Returns RbacRequestContext
RbacRequestContext instance.
Inherited from AbstractRbacMiddleware.createRequestContext
- Defined in middlewares/AbstractRbacMiddleware.ts:46

extractRoute

extractRoute(req: ExpressLikeRequest): { method: HttpMethod; uri: string }
Normalizes the target URI and HTTP method from the Express-like request.
Parameters
- req: ExpressLikeRequest
  The Express-like request.
Returns { method: HttpMethod; uri: string }
Object containing the normalized URI and HTTP method.
Overrides AbstractRbacMiddleware.extractRoute
- Defined in middlewares/ExpressRbacMiddleware.ts:77

extractUser

extractUser(
req: ExpressLikeRequest,
): RbacUserContext | Promise<RbacUserContext | null> | null
Extracts the authenticated user context from the Express-like request.
Parameters
- req: ExpressLikeRequest
  The Express-like request.
Returns RbacUserContext | Promise<RbacUserContext | null> | null
The resolved RbacUserContext or null if unauthenticated.
Overrides AbstractRbacMiddleware.extractUser
- Defined in middlewares/ExpressRbacMiddleware.ts:64

handleAccessDenied

handleAccessDenied(
    _req: ExpressLikeRequest,
    res: ExpressLikeResponse,
    reason: "unauthenticated" | "forbidden" | "tarpit_blocked",
): ExpressLikeResponse
Generates a standard JSON response when access is denied.
Parameters
- _req: ExpressLikeRequest
  The Express-like request.
- res: ExpressLikeResponse
  The Express-like response.
- reason: "unauthenticated" | "forbidden" | "tarpit_blocked"
  Denial rationale ('unauthenticated' | 'forbidden' | 'tarpit_blocked').
Returns ExpressLikeResponse
Overrides AbstractRbacMiddleware.handleAccessDenied
- Defined in middlewares/ExpressRbacMiddleware.ts:91

handler

handler(): (
    req: ExpressLikeRequest,
    res: ExpressLikeResponse,
    next: ExpressLikeNextFunction,
) => Promise<void | ExpressLikeResponse>
Generates standard Express middleware handler function.

Returns (
    req: ExpressLikeRequest,
    res: ExpressLikeResponse,
    next: ExpressLikeNextFunction,
) => Promise<void | ExpressLikeResponse>
- Defined in middlewares/ExpressRbacMiddleware.ts:117