Struct StaticPayloads 

pub struct StaticPayloads { /* private fields */ }

A static payload source that holds payloads directly in memory.

This is useful for users who generate payloads externally and want to use them with the attackstr ecosystem.

Thread Safety

StaticPayloads is Send and Sync.

Example

use attackstr::{StaticPayloads, Payload, PayloadSource};

let payloads = vec![
    Payload {
        text: "test".into(),
        category: "custom".into(),
        technique: "manual".into(),
        context: "default".into(),
        encoding: "raw".into(),
        cwe: None,
        severity: None,
        confidence: 1.0,
        expected_pattern: None,
        target_media_type: None,
    },
];

let mut source = StaticPayloads::new(payloads);
assert_eq!(source.payloads("custom").len(), 1);

Implementations

impl StaticPayloads

pub fn new(payloads: Vec<Payload>) -> Self

Create a new StaticPayloads from a vector of payloads.

Example:

use attackstr::{Payload, StaticPayloads};

let payloads = vec![Payload {
    text: "alert(1)".into(),
    category: "xss".into(),
    technique: "basic".into(),
    context: "default".into(),
    encoding: "raw".into(),
    cwe: None,
    severity: None,
    confidence: 1.0,
    expected_pattern: None,
    target_media_type: None,
}];

let source = StaticPayloads::new(payloads);
assert_eq!(source.all_payloads().len(), 1);

pub fn add(&mut self, payload: Payload)

Add a single payload to this source.

Example:

use attackstr::{Payload, StaticPayloads};

let mut source = StaticPayloads::default();
source.add(Payload {
    text: "test".into(),
    category: "custom".into(),
    technique: "manual".into(),
    context: "default".into(),
    encoding: "raw".into(),
    cwe: None,
    severity: None,
    confidence: 1.0,
    expected_pattern: None,
    target_media_type: None,
});
assert_eq!(source.all_payloads().len(), 1);

pub fn all_payloads(&self) -> &[Payload]

Get all payloads regardless of category.

Example:

use attackstr::StaticPayloads;

let source = StaticPayloads::default();
assert!(source.all_payloads().is_empty());

pub fn iter(&self) -> impl Iterator<Item = &Payload>

Iterate over all payloads in this source.

Example:

use attackstr::StaticPayloads;

let source = StaticPayloads::default();
assert_eq!(source.iter().count(), 0);

pub fn iter_category<'a>( &'a self, category: &'a str, ) -> impl Iterator<Item = &'a Payload> + 'a

Iterate over payloads for a single category.

Example:

use attackstr::{Payload, StaticPayloads};

let source = StaticPayloads::new(vec![Payload {
    text: "alert(1)".into(),
    category: "xss".into(),
    technique: "basic".into(),
    context: "default".into(),
    encoding: "raw".into(),
    cwe: None,
    severity: None,
    confidence: 1.0,
    expected_pattern: None,
    target_media_type: None,
}]);
assert_eq!(source.iter_category("xss").count(), 1);

Trait Implementations

impl Clone for StaticPayloads

fn clone(&self) -> StaticPayloads

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StaticPayloads

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StaticPayloads

fn default() -> StaticPayloads

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StaticPayloads

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StaticPayloads

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for StaticPayloads

impl From<Vec<Payload>> for StaticPayloads

fn from(payloads: Vec<Payload>) -> Self

Converts to this type from the input type.

impl PartialEq for StaticPayloads

fn eq(&self, other: &StaticPayloads) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PayloadSource for StaticPayloads

fn payloads(&mut self, category: &str) -> &[Payload]

Get all payloads for a given category.

fn categories(&self) -> Vec<&str>

Get all available category names.

fn payload_count(&self) -> usize

Get the total number of payloads across all categories.

impl Serialize for StaticPayloads

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StaticPayloads