Struct CsrfPlugin 

pub struct CsrfPlugin {
    key: Key,
    expires: u64,
    name: Template,
    phase: CsrfPhase,
}

Double-submit-cookie CSRF protection keyed by an HMAC secret.

In phase: request (default), unsafe methods must present matching header and cookie tokens carrying a valid signature; safe methods pass through (and get a token cookie, though a downstream upstream node will replace it — see the module docs). In phase: response the node only issues the token cookie, mirroring APISIX’s header_filter.

Fields

key: Key

HMAC-SHA256 key derived from the configured secret.

expires: u64

Token lifetime in seconds; 0 disables the expiry check.

name: Template

Cookie and header name carrying the token. Supports {{namespace.path}} references (no legacy $var interpolation — name never supported it, so this sweep must not start); rendered then lowercased for lookup at each use.

phase: CsrfPhase

Which side of the exchange this node handles.

Implementations

impl CsrfPlugin

pub fn from_config(config: &HashMap<String, Value>) -> Result<Self, String>

Builds the plugin from node config.

Accepted keys:

• key (string, required, non-empty): HMAC secret used to sign tokens.
• expires (integer seconds, default 7200): token lifetime; 0 disables the expiry check and makes the cookie a session cookie.
• name (string, default "featherbit-csrf-token"): cookie and request-header name carrying the token; supports {{namespace.path}} references (rendered then lowercased).
• phase (string, default request): request validates unsafe methods; response only issues the token cookie (place it after the upstream node).

type: csrf
config:
  key: edd1c9f034335f136f87ad84b625c8f1
  expires: 3600
  name: featherbit-csrf-token

fn sign(&self, random: &str, expires: u64) -> String

Computes the token signature: hex(HMAC-SHA256(key, random || expires)).

fn token_at(&self, ts: u64) -> String

Builds a token issued at timestamp ts: base64(json{random, expires: ts, sign}).

fn gen_token(&self) -> String

Generates a fresh token for the current time.

fn check_token(&self, token: &str) -> bool

Verifies a token’s structure, expiry, and signature.

fn rendered_name(&self, ctx: &Context) -> String

Renders and lowercases name for the current request (shared by the cookie name and the request-header lookup — see the module docs on the double-submit pattern using the same field for both).

fn set_cookie(&self, ctx: &mut Context)

Appends the token Set-Cookie header to the response.

Deviation: uses Max-Age instead of APISIX’s Expires date (omitted when expires is 0, yielding a session cookie).

fn reject( &self, ctx: Context, msg: &str, ) -> Result<PluginOutput, PluginExecutionError>

Builds the 401 rejection routed through the denied port.

Trait Implementations

impl Plugin for CsrfPlugin

fn plugin_type(&self) -> &str

Unique identifier for the plugin type (e.g., “proxy-rewrite”, “upstream”). This is also the key its PortSpec is registered under in port_spec.

fn execute<'life0, 'async_trait>( &'life0 self, ctx: Context, ) -> Pin<Box<dyn Future<Output = Result<PluginOutput, PluginExecutionError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Executes the plugin logic against the request/response context.

fn reads_response_body(&self) -> bool

Whether this configured instance reads context.response.body.

fn cache_target(&self) -> Option<CacheTarget>

The cache backend this node writes to, if it is a proxy-cache half.