YAML-based Plugins

MUTATION_ADD

This operator adds a new key attribute with the specified value. If the key attribute already exists, it duplicates it.

Example:

- action: MUTATION_ADD
  description: "Add a query parameter to the HTTP request"
  key: "mutated.http.query.param.id"
  field:
    kind: STRING
    value: "50"
- action: MUTATION_ADD
  description: "Add a query parameter to the HTTP request"
  key: "mutated.http.query.param.id"
  field:
    kind: STRING
    value: "100"

The above example suffixes the URL with two query params ?id=100& id=50 to check parameter pollution.

MUTATION_DELETE

This operator deletes an existing key attribute.

Example:

- action: MUTATION_DELETE
  description: "Delete the HTTP query parameter"
  key: "mutated.http.query.param.id"
  field:
    kind: STRING
    value: ""

The above example removes the query param id from the API request.

MUTATION_MODIFY

This operator modifies a key attribute if it exists; otherwise, it does nothing.

Example:

- action: MUTATION_MODIFY
  description: "Modify the HTTP query parameter"
  key: "mutated.http.query.param.id"
  field:
    kind: STRING
    value: "100"

The above example updates the query param id with the value 100 if it exists; otherwise it ignores the instruction.

MUTATION_SET

This operator sets the value of an existing key attribute or adds it if it does not exist.

Example:

- action: MUTATION_SET
  description: "Set the HTTP query parameter"
  key: "mutated.http.query.param.id"
  field:
    kind: STRING
    value: "100"

The above example sets the query param id to 100 if it exists; otherwise it creates a query param id with the same value.

MUTATION_REGEX_DELETE

This operator deletes all attributes that match the key/regular expression with value.

Example:

- action: MUTATION_REGEX_DELETE
  description: "Delete HTTP query parameters matching the regex pattern"
  key: "mutated\.http\.query\.param.*amount"
  field:
    kind: STRING
    value: ""

The above example deletes all query params ending with the string “amount”.

MUTATION_REGEX_MODIFY

This operator modifies all attributes that match the key/regular expression with value.

Example:

- action: MUTATION_REGEX_MODIFY
  description: "Modify HTTP query parameters matching the regex pattern"
  key: "mutated\.http\.query\.param.*amount"
  field:
    kind: STRING
    value: "100"

The above example modifies the query params ending with the string “amount” with the value 100, if it exists; otherwise, it ignores the instruction.

MUTATION_REGEX_SET

This operator sets all attributes that match the key/regular expression with value.

Example:

- action: MUTATION_REGEX_SET
  description: "Set HTTP query parameters matching the regex pattern"
  key: "mutated\.http\.query\.param.*amount"
  field:
    kind: STRING
    value: "100"

The above example sets the query params ending with the string “amount” with the value 100, if it exists; otherwise, it ignores the instruction.

LOGICAL_OPERATOR_AND

All assertion items in the assertion list need to be VULN(True) for the return value to be VULN(True).

LOGICAL_OPERATOR_OR

Any assertion item in the assertion list needs to be VULN(True) for the return value to be VULN(True).

MATCH_OPERATOR_EQUALS

This operator checks whether the mutated value matches the original value. If it does, the assertion evaluates to True/Vulnerable; otherwise, it evaluates to False/Not Vulnerable.

Example:

- lhs: "${mutated.http.response.code}"
  rhs: "${original.http.response.code}"
  operator: MATCH_OPERATOR_EQUALS
  key: "http.response.code"
  description: "Check if mutated HTTP response code equals the original HTTP response code"
  assertionType: IMMEDIATE

The above example evaluates to True if the response code received from the mutated request matches the response code received from the original request.

MATCH_OPERATOR_NOT_EQUALS

This operator checks whether the mutated value does not match the original value. If it does not, the assertion evaluates to True/Vulnerable; otherwise, it evaluates to False/Not Vulnerable.

Example:

- lhs: "${mutated.http.response.body.param1}"
  rhs: "${original.http.response.body.param1}"
  operator: MATCH_OPERATOR_NOT_EQUALS
  key: "http.response.body.param1"
  description: "Check if mutated HTTP response body param1 does not equal the original HTTP response body param1"
  assertionType: IMMEDIATE

The above example evaluates to True if param1 received in the body of the response received for the mutated request does not match param1 in the body of the response received from the original request.

MATCH_OPERATOR_MATCHES_REGEX

This operator checks whether the mutated value matches the regex. If it does, the assertion evaluates to True/Vulnerable; otherwise, it evaluates to False/Not Vulnerable.

Example:

- lhs: "${mutated.http.response.code}"
  rhs: r"^5\d\d"
  operator: MATCH_OPERATOR_MATCHES_REGEX
  key: "http.response.duration"
  description: "Check if mutated HTTP response code matches the regex pattern for 5xx status codes"
  assertionType: IMMEDIATE

The above example evaluates to True if the response code received for the mutated request matches the specified regular expression.

MATCH_OPERATOR_NOT_MATCHES_REGEX

This operator checks whether the mutated value does not match the regex. If it does not, the assertion evaluates to True/Vulnerable; otherwise, it evaluates to False/Not Vulnerable.

Example:

- lhs: "${mutated.http.response.code}"
  rhs: r"^5\d\d"
  operator: MATCH_OPERATOR_MATCHES_REGEX
  key: "http.response.duration"
  description: "Check if mutated HTTP response code matches the regex pattern for 5xx status codes"
  assertionType: IMMEDIATE

The above example evaluates to True if the response code received for the mutated request does not match the specified regular expression.

MATCH_OPERATOR_GREATER_THAN

This operator checks whether the mutated value is greater than the original value. If it is, the assertion evaluates to True/Vulnerable; otherwise, it evaluates to False/Not Vulnerable.

Example:

- lhs: "${mutated.http.response.duration}"
  rhs: "100"
  operator: MATCH_OPERATOR_GREATER_THAN
  key: "http.response.duration"
  description: "Check if mutated HTTP response duration is greater than 100ms"
  assertionType: IMMEDIATE

The above example evaluates to True if the time taken to receive a response to the mutated request takes longer than 100 ms.

MATCH_OPERATOR_GREATER_THAN_EQUALS

This operator checks whether the mutated value is greater than or equal to the original value. If it is, the assertion evaluates to True/Vulnerable; otherwise, it evaluates to False/Not Vulnerable.

Example:

- lhs: "${mutated.http.response.body.param1}"
  rhs: "100"
  operator: MATCH_OPERATOR_GREATER_THAN_EQUALS
  key: "http.response.body.param1"
  description: "Check if mutated HTTP response body param1 is greater than or equal to 100"
  assertionType: IMMEDIATE

The above example evaluates to True if param1 in the body of the response received for the mutated request has a value greater than or equal to 100.

MATCH_OPERATOR_LESS_THAN

This operator checks whether the mutated value is less than the original value. If it is, the assertion evaluates to True/Vulnerable; otherwise, it evaluates to False/Not Vulnerable.

Example:

- lhs: "${mutated.http.response.body.param1}"
  rhs: "100"
  operator: MATCH_OPERATOR_LESS_THAN
  key: "http.response.body.param1"
  description: "Check if mutated HTTP response body param1 is less than 100"
  assertionType: IMMEDIATE

The above example evaluates to True if param1 in the body of the response received for the mutated request has a value less than 100.

MATCH_OPERATOR_LESS_THAN_EQUALS

This operator checks whether the mutated value is less than or equal to the original value. If it is, the assertion evaluates to True/Vulnerable; otherwise, it evaluates to False/Not Vulnerable.

Example:

- lhs: "${mutated.http.response.body.param1}"
  rhs: "100"
  operator: MATCH_OPERATOR_LESS_THAN_EQUALS
  key: "http.response.body.param1"
  description: "Check if mutated HTTP response body param1 is less than or equal to 100"
  assertionType: IMMEDIATE

The above example evaluates to True if param1 in the body of the response received for the mutated request has a value less than or equal to 100.

MATCH_OPERATOR_CONTAINS

This operator checks whether the mutated value contains the original value. If it does, the assertion evaluates to True/Vulnerable; otherwise, it evaluates to False/Not Vulnerable. It also supports various python data structures, such as list, set, and string.

Example:

- lhs: "${mutated.http.response.body.param1}"
  rhs: "Unauthorized"
  operator: MATCH_OPERATOR_NOT_CONTAINS
  key: "http.response.body.param1"
  description: "Check if mutated HTTP response body param1 does not contain the substring 'Unauthorized'"
  assertionType: IMMEDIATE

The above example evaluates to True if param1 in the body of the response received for the mutated request contains the key word “Unauthorized”.

MATCH_OPERATOR_NOT_CONTAINS

This operator checks whether the mutated value does not contain the original value. If it does not, the assertion evaluates to True/Vulnerable; otherwise, it evaluates to False/Not Vulnerable. It also supports various python data structures, such as list, set, and string.

Example:

- lhs: "${mutated.http.response.body}"
  rhs: "Bad request"
  operator: MATCH_OPERATOR_NOT_CONTAINS
  key: "http.response.body"
  description: "Check if mutated HTTP response body does not contain the substring 'Bad request'"
  assertionType: IMMEDIATE

The above example evaluates to True if the body of the response received for the mutated request does not contain the key word “Bad request”.

MATCH_OPERATOR_IN

This operator checks whether the mutated value is present in the original value. If it is, the assertion evaluates to True/Vulnerable; otherwise, it evaluates to False/Not Vulnerable.

Example:

- lhs: "${mutated.http.response.body}"
  rhs: "Bad request"
  operator: MATCH_OPERATOR_IN
  key: "http.response.body"
  description: "Check if mutated HTTP response body message is one of the values in the list ['FAILED', 'ERRORED']"
  assertionType: IMMEDIATE

The above example evaluates to True if the message in the body of the response received for the mutated request includes either “Failed” or “Errored”.

MATCH_OPERATOR_NOT_IN

This operator checks whether the mutated value is not present in the original value. If it is not, the assertion evaluates to True/Vulnerable; otherwise, it evaluates to False/Not Vulnerable.

Example:

- lhs: "${mutated.http.response.body.message}"
  rhs: ["FAILED", "ERRORED"]
  operator: MATCH_OPERATOR_NOT_IN
  key: "http.response.body"
  description: "Check if mutated HTTP response body message is not one of the values in the list ['FAILED', 'ERRORED']"
  assertionType: IMMEDIATE

The above example evaluates to True if the message in the body of the response received for the mutated request does not include either “Failed” or “Errored”.

MATCH_OPERATOR_KEYS_EQUALS

This operator checks whether the mutated value is not present in the original value. If it is not, the assertion evaluates to True/Vulnerable; otherwise, it evaluates to False/Not Vulnerable.

Example:

- lhs: "${mutated.http.response.body}"
  rhs: "${original.http.response.body}"
  operator: MATCH_OPERATOR_KEYS_EQUALS
  key: "http.response.body"
  description: "Check if the keys of the mutated HTTP response body are equal to those of the original HTTP response body, 
                with additional data, level=5, content-type=application/json"
  assertionType: IMMEDIATE
  data:
    level: 5
    content-type: "application/json"

The above example evaluates to True if the keys in the body of the response received for the mutated request has the same set of keys in the body of the response received for the original request - up to a depth of 5 for the JSON encoded tree

MATCH_OPERATOR_KEYS_NOT_EQUALS

This operator checks whether the mutated value is not present in the original value. If it is not, the assertion evaluates to True/Vulnerable; otherwise, it evaluates to False/Not Vulnerable.

Example:

- lhs: "${mutated.http.response.body}"
  rhs: "${original.http.response.body}"
  operator: MATCH_OPERATOR_KEYS_NOT_EQUALS
  key: "http.response.body"
  description: "Check if the keys of the mutated HTTP response body are not equal to those of the original HTTP response body, 
                with additional data, level=5, content-type=application/json"
  assertionType: IMMEDIATE
  data:
    level: 5
    content-type: "application/json"

The above example evaluates to True if the keys in the body of the response received for the mutated request does not have the same set of keys in the body of the response received for the original request - up to a depth of 5 for the JSON encoded tree

MATCH_OPERATOR_FUZZY_EQUALS

This operator checks whether the mutated and original values match up to the specified threshold. If they do, the assertion evaluates to True/Vulnerable; otherwise, it evaluates to False/Not Vulnerable.

Example:

- lhs: "${mutated.http.response.body}"
  rhs: "${original.http.response.body}"
  operator: MATCH_OPERATOR_FUZZY_EQUALS
  key: "http.response.body"
  description: "Check if the mutated HTTP response body is approximately equal to the original HTTP response body with a fuzzy matching threshold of 0.8,
                and additional data, level=5, content-type=application/json"
  assertionType: IMMEDIATE
  data:
    level: 5
    content-type: "application/json"

The above example evaluates to True if the body of the response received for the mutated request matches (at least up to the threshold value of 80%) with the response received for the original request - up to a depth of 5 for the JSON encoded tree.

MATCH_OPERATOR_FUZZY_NOT_EQUALS

This operator checks whether the mutated and original values do not match up to the specified threshold. If they do not, the assertion evaluates to True/Vulnerable; otherwise, it evaluates to False/Not Vulnerable.

Example:

- lhs: "${mutated.http.response.body}"
  rhs: "${original.http.response.body}"
  operator: MATCH_OPERATOR_FUZZY_NOT_EQUALS
  key: "http.response.body"
  description: "Check if the mutated HTTP response body is not approximately equal to the original HTTP response body with a fuzzy matching threshold of 0.8,
                and additional data, level=5, content-type=application/json"
  assertionType: IMMEDIATE
  data:
    level: 5
    content-type: "application/json"

The above example evaluates to True if the body of the response received for the mutated request does not match (at least up to the threshold value of 80%) with the response received for the original request - up to a depth of 5 for the JSON encoded tree.

MATCH_OPERATOR_FUZZY_KEYS_EQUALS

This operator checks whether the mutated and original values are JSON/URL-encoded parseable and the keys match up to the specified threshold. If they do, the assertion evaluates to True/Vulnerable; otherwise, it evaluates to False/Not Vulnerable.

Example:

- lhs: "${mutated.http.response.body}"
  rhs: "${original.http.response.body}"
  operator: MATCH_OPERATOR_FUZZY_KEYS_EQUALS
  key: "http.response.body"
  description: "Check if the keys of the mutated HTTP response body are approximately equal to those of the original HTTP response body with a fuzzy matching threshold of 0.8,
                and additional data, level=5, content-type=application/json"
  assertionType: IMMEDIATE
  data:
    level: 5
    content-type: "application/json"

The above example evaluates to True if the keys in the body of the response received for the mutated request matches (at least up to the threshold value of 80%) with the keys in the body of the response received for the original request - up to a depth of 5 for the JSON encoded tree.

MATCH_OPERATOR_FUZZY_KEYS_NOT_EQUALS

This operator checks whether the mutated and original values are JSON/URL-encoded parseable and the keys match up to the specified threshold. If they do, the assertion evaluates to False/Not Vulnerable; otherwise, it evaluates to True/Vulnerable.

Example:

- lhs: "${mutated.http.response.body}"
  rhs: "${original.http.response.body}"
  operator: MATCH_OPERATOR_FUZZY_KEYS_NOT_EQUALS
  key: "http.response.body"
  description: "Check if the keys of the mutated HTTP response body are not approximately equal to those of the original HTTP response body with a fuzzy matching threshold of 0.8,
                and additional data, level=5, content-type=application/json"
  assertionType: IMMEDIATE
  data:
    level: 5
    content-type: "application/json"

The above example evaluates to True if the keys in the body of the response received for the mutated request does not match (at least up to the threshold value of 80%) with the keys in the body of the response received for the original request - up to a depth of 5 for the JSON encoded tree.

MATCH_OPERATOR_VALUES_DIFFERENCE

This operator checks if the absolute difference between the mutated and original value is a certain amount.

Example:

- lhs: "${mutated.http.request.query.param.id}"
  rhs: "${mutated.http.response.param.id}"
  operator: MATCH_OPERATOR_VALUES_DIFFERENCE
  key: "http.request.query.param.id"
  description: "Check the difference between the mutated HTTP request query param id and the mutated HTTP response param id,
                with additional data, level=5, content-type=application/json, amount=100"
  assertionType: IMMEDIATE
  data:
    level: 5
    content-type: "application/json"

The above example evaluates to True if the query param id of the mutated request differs from the response parameter id by a value of 100.

MATCH_OPERATOR_VALUES_SEARCH

This operator searches for the original value in the mutated value. The mutated value can be a dictionary or a URL-encoded payload. The level specified in this operator signifies the max depth till which Traceable should look at in the tree structure like JSON. If the original value is found in the mutated one, the assertion evaluates to True/Vulnerable; otherwise, it evaluates to False/Not Vulnerable.

Example:

- lhs: "${mutated.http.response.body}"
  rhs: "15"
  operator: MATCH_OPERATOR_VALUES_SEARCH
  key: "http.request.query.param.id"
  description: "Check if the value '15' is present in the mutated HTTP response body, with additional data: level=5, content-type=application/json"
  assertionType: IMMEDIATE
  data:
    level: 5
    content-type: "application/json"

The above example evaluates to True if the body of the response received for the mutated request contains the value 15 - up to the depth 5 for the JSON encoded tree.

MATCH_OPERATOR_VALUES_NOT_SEARCH

This operator searches for the original value in the mutated value. The mutated value can be a dictionary or a URL-encoded payload. The level specified in this operator signifies the max depth till which Traceable should look at in the tree structure like JSON. If the original value is not found in the mutated one, the assertion evaluates to True/Vulnerable; otherwise, it evaluates to False/Not Vulnerable.

Example:

- lhs: "${mutated.http.response.body}"
  rhs: "${mutated.http.request.query.param.id}"
  operator: MATCH_OPERATOR_VALUES_NOT_SEARCH
  key: "http.response.body"
  description: "Check if the mutated HTTP request query param id is not present in the mutated HTTP response body, with additional data: level=5, content-type=application/json"
  assertionType: IMMEDIATE
  data:
    level: 5
    content-type: "application/json"

The above example evaluates to True if the body of the response received for the mutated request does not contain the query param id of the original request - up to a depth of 5 for the JSON encoded tree.

MATCH_OPERATOR_REGEXLOOKUP_EQUALS

This operator works in two steps:

1. Lookup for all attributes matching the mutated regex and use them in step 2.

2. If all attributes matched in step 1, match the original value, return True/Vulnerable; otherwise, return False/Not Vulnerable.

Example:

- lhs: "mutated.http.response.body.*.carid"
  rhs: "15"
  operator: MATCH_OPERATOR_REGEXLOOKUP_EQUALS
  key: "http.response.body"
  description: "Check if the value '15' is equal to any value found in 'mutated.http.response.body' that matches the regex pattern for 'carid'"
  assertionType: IMMEDIATE

The above example evaluates to True if all parameters that match the specified regex in response to the mutated request contains the value 15.

MATCH_OPERATOR_REGEXLOOKUP_NOT_EQUALS

This operator works in two steps:

1. Lookup for all attributes matching the mutated regex and use them in step 2.

2. If all attributes matched in step 1, do not match the original value, return True/Vulnerable; otherwise, return False/Not Vulnerable.

Example:

- lhs: "mutated.http.response.body.*.carid"
  rhs: "15"
  operator: MATCH_OPERATOR_REGEXLOOKUP_NOT_EQUALS
  key: "http.response.body"
  description: "Check if the value '15' is not equal to any value found in 'mutated.http.response.body' that matches the regex pattern for 'carid'"
  assertionType: IMMEDIATE

The above example evaluates to True if all parameters that match the specified regex in response to the mutated request does not contain the value 15.

MATCH_OPERATOR_REGEXLOOKUP_MATCHES_REGEX

This operator works in two steps:

1. Lookup for all attributes matching the mutated regex and use them in step 2.

2. If all attributes matched in step 1, match the original regex, return True/Vulnerable; otherwise, return False/Not Vulnerable.

Example:

- lhs: "mutated.http.response.body.*.carid"
  rhs: "141[a-z0-9]{1,10}411"
  operator: MATCH_OPERATOR_REGEXLOOKUP_MATCHES_REGEX
  key: "http.response.body"
  description: "Check if any value found in 'mutated.http.response.body' that matches the regex pattern for 'carid' matches the regex pattern '141[a-z0-9]{1,10}411'"
  assertionType: IMMEDIATE

The above example evaluates to True if all parameters that match the specified regex in response to the mutated request contains a value of that matches the regex ("141[a-z0-9]{1,10}411").

MATCH_OPERATOR_REGEXLOOKUP_NOT_MATCHES_REGEX

This operator works in two steps:

1. Lookup for all attributes matching the mutated regex and use them in step 2.

2. If all attributes matched in step 1, do not match the original regex, return True/Vulnerable; otherwise, return False/Not Vulnerable.

Example:

- lhs: "mutated.http.response.body.*.carid"
  rhs: "141[a-z0-9]{1,10}411"
  operator: MATCH_OPERATOR_REGEXLOOKUP_NOT_MATCHES_REGEX
  key: "http.response.body"
  description: "Check if no value found in 'mutated.http.response.body' that matches the regex pattern for 'carid' matches the regex '141[a-z0-9]{1,10}411'"
  assertionType: IMMEDIATE

The above example evaluates to True if all parameters that match the specified regex in response to the mutated request does not contain a value of that matches the regex ("141[a-z0-9]{1,10}411").

MATCH_OPERATOR_ALWAYS_TRUE

This operator always returns True/Vulnerable. It is mostly useful when you are writing plugins and want to test dummy assertions.

Example:

- lhs: "xyz"
  rhs: "abc"
  operator: MATCH_OPERATOR_ALWAYS_TRUE
  key: "test.true"
  description: "Assertion that always evaluates to true, regardless of the values of lhs and rhs."
  assertionType: IMMEDIATE

MATCH_OPERATOR_ALWAYS_FALSE

This operator always returns False/Not Vulnerable. It is mostly useful when you are writing plugins and want to test dummy assertions.

Example:

- lhs: "xyz"
  rhs: "abc"
  operator: MATCH_OPERATOR_ALWAYS_FALSE
  key: "test.false"
  description: "Assertion that always evaluates to false, regardless of the values of lhs and rhs."
  assertionType: IMMEDIATE

MATCH_OPERATOR_COLLABORATOR_LOOKUP_CONTAINS

This operator is used for SSRF-based scans, where if the application reaches out to Traceable collaborator, it looks out for the presence of test id in the payload received by the collaborator.

Example:

- lhs: "${mutated.test.id}"
  rhs: "${mutated.test.id}"
  operator: MATCH_OPERATOR_COLLABORATOR_LOOKUP_CONTAINS
  key: "http.response.body"
  description: "Check if the value '${mutated.test.id}' is contained within the value '${mutated.test.id}'"
  assertionType: IMMEDIATE

The above example evaluates to True if the payload (from the application) received by the collaborator contains the test id.

MATCH_OPERATOR_RAW

This operator executes raw lambda code supplying it with mutated and original values. If lambda returns True, it is marked as Vulnerable, else Not Vulnerable.

Example:

- lhs: "${mutated.tls.protocol.ciphers}"
  rhs: "RSA"
  operator: MATCH_OPERATOR_RAW
  key: "tls.protocol.ciphers"
  description: "Check if the value 'RSA' is present in the mutated TLS protocol ciphers, using a custom lambda function for validation."
  assertionType: IMMEDIATE