status-im/nim-drchaos
2
0
Fork 0
mirror of https://github.com/status-im/nim-drchaos.git synced 2025-02-22 15:48:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Don't be stupid

Browse Source
This commit is contained in:
Antonis Geralis 2022-09-09 00:06:24 +03:00
parent 56fb715ce7
commit 73c3c50bbf
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,10 +1,10 @@
# Dr. Chaos # drchaos
Fuzzing is an automated bug finding technique, where randomized inputs are fed to a target Fuzzing is an automated bug finding technique, where randomized inputs are fed to a target
program in order to get it to crash. With fuzzing, you can increase your test coverage to program in order to get it to crash. With fuzzing, you can increase your test coverage to
find edge cases and trigger bugs more effectively. find edge cases and trigger bugs more effectively.
Dr. Chaos extends the Nim interface to LLVM/Clang libFuzzer, an in-process, drchaos extends the Nim interface to LLVM/Clang libFuzzer, an in-process,
coverage-guided, evolutionary fuzzing engine. And adds support for coverage-guided, evolutionary fuzzing engine. And adds support for
[structured fuzzing](https://github.com/google/fuzzing/blob/master/docs/structure-aware-fuzzing.md). [structured fuzzing](https://github.com/google/fuzzing/blob/master/docs/structure-aware-fuzzing.md).
The user should define the input type, as a parameter to the target function and the The user should define the input type, as a parameter to the target function and the
@ -66,7 +66,7 @@ func fuzzTarget(x: ContentNode) =
defaultMutator(fuzzTarget) defaultMutator(fuzzTarget)
``` ```
Dr. Chaos will generate millions of inputs and run `fuzzTarget` under a few seconds. drchaos will generate millions of inputs and run `fuzzTarget` under a few seconds.
More articulate examples, such as fuzzing a graph library are in the `examples/` directory. More articulate examples, such as fuzzing a graph library are in the `examples/` directory.
Defining a `==` proc for the input type is necessary. `proc default(_: typedesc[T]): T` can also Defining a `==` proc for the input type is necessary. `proc default(_: typedesc[T]): T` can also
@ -163,15 +163,15 @@ must also be defined. `drchaos/common` exports read/write procs that assist with
- References with cycles. A `.noFuzz` custom pragma will be added soon for cursors. - References with cycles. A `.noFuzz` custom pragma will be added soon for cursors.
- Object variants work only with the lastest memory management model `--mm:arc/orc`. - Object variants work only with the lastest memory management model `--mm:arc/orc`.
## Why choose Dr. Chaos ## Why choose drchaos
Dr. Chaos has several advantages over frameworks derived from drchaos has several advantages over frameworks derived from
[FuzzDataProvider](https://github.com/google/fuzzing/blob/master/docs/split-inputs.md) [FuzzDataProvider](https://github.com/google/fuzzing/blob/master/docs/split-inputs.md)
which struggle with dynamic types that in particular are nested. For a better explanation which struggle with dynamic types that in particular are nested. For a better explanation
read an article written by the author of read an article written by the author of
[Fuzzcheck](https://github.com/loiclec/fuzzcheck-rs/blob/main/articles/why_not_bytes.md). [Fuzzcheck](https://github.com/loiclec/fuzzcheck-rs/blob/main/articles/why_not_bytes.md).
## Bugs found with help of the library ## Bugs found with the help of drchaos
### Nim reference implementation ### Nim reference implementation