Struct DataMaskPlugin 

pub struct DataMaskPlugin {
    rules: Vec<MaskRule>,
    max_body_size: usize,
}

Masks request query parameters, headers, and JSON body fields according to a list of rules. Masking is best-effort and never fails at execution time: bodies that are absent, non-JSON, or larger than max_body_size simply skip the body rules. The plugin only touches context.request; it never writes context.message or context.errors.

Fields

rules: Vec<MaskRule>

max_body_size: usize

Implementations

impl DataMaskPlugin

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

Builds the plugin from node config.

Accepted keys:

• request (array of rule objects, default []): each rule has
  • type (string, required): query, header, or body.
  • name (string, required): the query parameter / header name, or a dotted path into the JSON body (user.cards.0.number; numeric segments index arrays, a leading $. is tolerated).
  • action (string, required): remove, replace, or regex.
  • value (string): replacement value; required for replace and regex (for regex it may use $1 capture references).
  • regex (string): pattern; required for action: regex, compiled here at config load.
  • body_format (string): required for type: body; only json is supported (deviation: APISIX also accepts urlencoded).
• max_body_size (integer > 0, default 1048576): bodies larger than this skip body rules.

type: data-mask
config:
  request:
    - { type: header, name: authorization, action: replace, value: "***" }
    - { type: query, name: token, action: remove }
    - type: body
      body_format: json
      name: user.card_number
      action: regex
      regex: "^(\\d{4})\\d+(\\d{4})$"
      value: "$1********$2"

Trait Implementations

impl Plugin for DataMaskPlugin

fn plugin_type(&self) -> &str

Unique identifier for the plugin type (e.g., “proxy-rewrite”, “upstream”).

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

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

Executes the plugin logic against the request/response context.