roll back fuzzing install script, documentation instead (#439)

This commit is contained in:
kaczmarczyck
2022-03-08 03:09:48 +01:00
committed by GitHub
parent 7c1ddcda0a
commit bf3d65dc79
2 changed files with 30 additions and 1 deletions

View File

@@ -64,3 +64,32 @@ a few things you can personalize:
* Whether you want to use batch attestation.
* Whether you want to use signature counters.
* Various constants to adapt to different hardware.
### Testing and Fuzzing
You might want to test your changes before deploying them. To run unit tests,
make sure that at least the `std` feature is included, e.g.:
```shell
cargo test --features=std,with_ctap1
```
Alternatively, you can simply call our test script to also test all libraries,
run clippy, check formatting and more:
```shell
./run_desktop_tests.sh
```
OpenSK is fuzzed with the [OSS-Fuzz](https://github.com/google/oss-fuzz)
project. You can also run fuzzing locally. First install:
```shell
cargo +stable install cargo-fuzz --version 0.10.2
```
Then choose a fuzz target from `fuzz/fuzz_targets/`, e.g.:
```shell
cargo fuzz run fuzz_target_process_ctap1
```

View File

@@ -20,4 +20,4 @@ done_text="$(tput bold)DONE.$(tput sgr0)"
set -e
# Install cargo-fuzz library.
cargo +stable install cargo-fuzz --version 0.10.2
cargo +stable install cargo-fuzz