Skip to content

Commit

Permalink
Add details about loading mutator values from custom file
Browse files Browse the repository at this point in the history
  • Loading branch information
en-milie committed Mar 8, 2024
1 parent 8ecfd33 commit 3d3dd38
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
16 changes: 16 additions & 0 deletions docs/getting-started/mutators.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,22 @@ where:
- `type` is one of `TRAIL, INSERT, PREFIX, REPLACE, REPLACE_BODY, IN_BODY`
- `values` an array of possible values that will be used by the mutator for random selection

If `values` is a simple string (not an array as above) it will be interpreted as a file location and try to load the fuzz values from that file. An example:

```yaml
name: xss mutator from file
type: replace
values: /my/full/path/to/xss.txt
```

CATS will load all values from `/my/full/path/to/xss.txt` and randomly select when fuzzing.

:::caution
The path to the file with fuzz values must be relative to where you run CATS from, not the location where the custom fuzzer file is.
Or you can use an absolute path.
:::


This is what each `type` means:

- `trail` will trail a valid field value with the one generated by the mutator
Expand Down
2 changes: 1 addition & 1 deletion docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ CATS is:
- **📖 Simple to Learn**: flat learning curve, with intuitive configuration and syntax
- **⚡️ Fast**: automatic process for writing, running and reporting

By using a simple and minimal syntax, with a flat learning curve, CATS (**C**ontract **A**uto-generated **T**ests for **S**wagger) enables you to generate thousands of API tests within minutes with **no coding effort**.
By using a simple and minimal syntax, with a flat learning curve, CATS (**C**ontract **A**API **T**esting **S**ecurity) enables you to generate thousands of API tests within minutes with **no coding effort**.
All tests are **generated, run and reported automatically** based on a pre-defined set of **100+ Fuzzers**.
The Fuzzers cover a wide range of boundary testing and negative scenarios from random large Unicode values to well crafted, context dependant values based on the request data types and constraints.
Even more, you can **leverage** the fact that **CATS** generates request payloads dynamically and **write simple end-to-end functional tests**.
Expand Down

0 comments on commit 3d3dd38

Please sign in to comment.