aboutsummaryrefslogtreecommitdiff
path: root/docs/custom_mutators.md
diff options
context:
space:
mode:
authorhexcoder- <heiko@hexco.de>2020-12-08 17:46:29 +0100
committerhexcoder- <heiko@hexco.de>2020-12-08 17:46:29 +0100
commitcf0c49dec5341791d4a1f5f8f796dbce370696bf (patch)
tree7418dfe46b506a506627d6408848624d39476c89 /docs/custom_mutators.md
parent064e63962ff979219cd39ce71a6ef0fc15fd7911 (diff)
downloadAFLplusplus-cf0c49dec5341791d4a1f5f8f796dbce370696bf.tar.gz
typos/wording
Diffstat (limited to 'docs/custom_mutators.md')
-rw-r--r--docs/custom_mutators.md27
1 files changed, 14 insertions, 13 deletions
diff --git a/docs/custom_mutators.md b/docs/custom_mutators.md
index 6d3c9f38..a2c544e3 100644
--- a/docs/custom_mutators.md
+++ b/docs/custom_mutators.md
@@ -106,7 +106,7 @@ def introspection():
of fuzzing attempts with this input based on a few factors.
If however the custom mutator wants to set this number instead on how often
it is called for a specific queue entry, use this function.
- This function in mostly useful if **not** `AFL_CUSTOM_MUTATOR_ONLY` is used.
+ This function is most useful if `AFL_CUSTOM_MUTATOR_ONLY` is **not** used.
- `fuzz` (optional):
@@ -114,19 +114,19 @@ def introspection():
additional test case.
Note that this function is optional - but it makes sense to use it.
You would only skip this if `post_process` is used to fix checksums etc.
- so you are using it e.g. as a post processing library.
+ so if you are using it e.g. as a post processing library.
- `describe` (optional):
- When this function is called, is shall describe the current testcase,
+ When this function is called, it shall describe the current testcase,
generated by the last mutation. This will be called, for example,
- to give the written testcase a name after a crash ocurred.
+ to name the written testcase file after a crash occurred.
Using it can help to reproduce crashing mutations.
- `havoc_mutation` and `havoc_mutation_probability` (optional):
`havoc_mutation` performs a single custom mutation on a given input. This
- mutation is stacked with the other mutations in havoc. The other method,
+ mutation is stacked with other mutations in havoc. The other method,
`havoc_mutation_probability`, returns the probability that `havoc_mutation`
is called in havoc. By default, it is 6%.
@@ -182,7 +182,7 @@ trimmed input. Here's a quick API description:
on this input (e.g. if your input has n elements and you want to remove them
one by one, return n, if you do a binary search, return log(n), and so on).
- If your trimming algorithm doesn't allow you to determine the amount of
+ If your trimming algorithm doesn't allow to determine the amount of
(remaining) steps easily (esp. while running), then you can alternatively
return 1 here and always return 0 in `post_trim` until you are finished and
no steps remain. In that case, returning 1 in `post_trim` will end the
@@ -224,19 +224,20 @@ Optionally, the following environment variables are supported:
- `AFL_PYTHON_ONLY`
- Deprecated and removed, use `AFL_CUSTOM_MUTATOR_ONLY` instead
- trimming can cause the same test breakage like havoc and splice.
+ Deprecated and removed, use `AFL_CUSTOM_MUTATOR_ONLY` instead.
- `AFL_DEBUG`
- When combined with `AFL_NO_UI`, this causes the C trimming code to emit additional messages about the performance and actions of your custom trimmer. Use this to see if it works :)
+ When combined with `AFL_NO_UI`, this causes the C trimming code to emit
+ additional messages about the performance and actions of your custom
+ trimmer. Use this to see if it works :)
## 3) Usage
### Prerequisite
-For Python mutator, the python 3 or 2 development package is required. On
-Debian/Ubuntu/Kali this can be done:
+For Python mutators, the python 3 or 2 development package is required. On
+Debian/Ubuntu/Kali it can be installed like this:
```bash
sudo apt install python3-dev
@@ -254,13 +255,13 @@ In case your setup is different, set the necessary variables like this:
### Custom Mutator Preparation
-For C/C++ mutator, the source code must be compiled as a shared object:
+For C/C++ mutators, the source code must be compiled as a shared object:
```bash
gcc -shared -Wall -O3 example.c -o example.so
```
Note that if you specify multiple custom mutators, the corresponding functions will
be called in the order in which they are specified. e.g first `post_process` function of
-`example_first.so` will be called and then that of `example_second.so`
+`example_first.so` will be called and then that of `example_second.so`.
### Run