Skip to main content

Module forward_auth

Module forward_auth 

Source
Expand description

Forward-authentication plugin (forward-auth).

Delegates the access decision for each request to an external HTTP authorization service. The plugin issues a callout carrying the original request’s forwarding metadata (X-Forwarded-*) plus any configured client headers; a 2xx reply lets the request continue (optionally copying selected auth-response headers onto the request forwarded upstream), while a non-2xx reply rejects the request, mirroring the auth service’s status/body/headers back to the client. A callout failure either degrades open or rejects with a configurable status, depending on allow_degradation.

Ports the APISIX forward-auth plugin onto featherbit’s shared outbound HTTP client.

Structs§

ForwardAuthPlugin
Sends each request to an external authorization endpoint and routes on its verdict: 2xx continues (success port), non-2xx or (non-degrading) callout failure rejects (error port).