-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
7238857 Add fuzzing for jsonrpc (Tobin C. Harding) 49b72c1 Import jsonrpc crate (Tobin C. Harding) 45addbd justfile: Add a docs build command (Tobin C. Harding) Pull request description: Import the `rust-jsonrpc` crate from https://github.com/apoelstra/rust-jsonrpc using current tip of master `59646e6 Merge apoelstra/rust-jsonrpc#119: Use rust-bitcoin-maintainer-tools and re-write CI` Full commit hash: 59646e6e6ac95f07998133b1709e4a1fa2dbc7bd Do so using the following commands: mkdir jsonrpc mkdir jsonrpc/contrib rsync -avz ../../rust-jsonrpc/master/README.md jsonrpc rsync -avz ../../rust-jsonrpc/master/src jsonrpc rsync -avz ../../rust-jsonrpc/master/contrib/test_vars.sh jsonrpc/contrib Then: - Update `contrib/crates.sh` to include `jsonrpc`. - Remove workspaces from `jsonrpc/Cargo.toml`. - Add `jsonrpc` to repository workspace. Finally import fuzzing, and fix up to mimic current `rust-bitcoin` setup. ACKs for top commit: apoelstra: ACK 7238857 successfully ran local tests Tree-SHA512: 309c214d50e78bcd67b49b8f68df91792100d95fda65a6ec700c422d28d64f41498e52f4eabeebcfae46685ee997ffb8c444180863d8f8003ed542a5ed80d174
- Loading branch information
Showing
26 changed files
with
2,762 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| # Automatically generated by fuzz/generate-files.sh | ||
| name: Fuzz | ||
| on: | ||
| schedule: | ||
| # 6am every day UTC, this correlates to: | ||
| # - 11pm PDT | ||
| # - 7am CET | ||
| # - 5pm AEDT | ||
| - cron: '00 06 * * *' | ||
|
|
||
| jobs: | ||
| fuzz: | ||
| if: ${{ !github.event.act }} | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| # We only get 20 jobs at a time, we probably don't want to go | ||
| # over that limit with fuzzing because of the hour run time. | ||
| fuzz_target: [ | ||
| minreq_http, | ||
| simple_http, | ||
| ] | ||
| steps: | ||
| - name: Install test dependencies | ||
| run: sudo apt-get update -y && sudo apt-get install -y binutils-dev libunwind8-dev libcurl4-openssl-dev libelf-dev libdw-dev cmake gcc libiberty-dev | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/cache@v4 | ||
| id: cache-fuzz | ||
| with: | ||
| path: | | ||
| ~/.cargo/bin | ||
| fuzz/target | ||
| target | ||
| key: cache-${{ matrix.target }}-${{ hashFiles('**/Cargo.toml','**/Cargo.lock') }} | ||
| - uses: dtolnay/rust-toolchain@stable | ||
| with: | ||
| toolchain: '1.65.0' | ||
| - name: fuzz | ||
| run: | | ||
| if [[ "${{ matrix.fuzz_target }}" =~ ^bitcoin ]]; then | ||
| export RUSTFLAGS='--cfg=hashes_fuzz --cfg=secp256k1_fuzz' | ||
| fi | ||
| echo "Using RUSTFLAGS $RUSTFLAGS" | ||
| cd fuzz && ./fuzz.sh "${{ matrix.fuzz_target }}" | ||
| - run: echo "${{ matrix.fuzz_target }}" >executed_${{ matrix.fuzz_target }} | ||
| - uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: executed_${{ matrix.fuzz_target }} | ||
| path: executed_${{ matrix.fuzz_target }} | ||
|
|
||
| verify-execution: | ||
| if: ${{ !github.event.act }} | ||
| needs: fuzz | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/download-artifact@v3 | ||
| - name: Display structure of downloaded files | ||
| run: ls -R | ||
| - run: find executed_* -type f -exec cat {} + | sort > executed | ||
| - run: source ./fuzz/fuzz-util.sh && listTargetNames | sort | diff - executed |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
|
|
||
| target | ||
| corpus | ||
| artifacts |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| [package] | ||
| name = "jsonrpc-fuzz" | ||
| edition = "2021" | ||
| rust-version = "1.63.0" | ||
| version = "0.0.1" | ||
| authors = ["Generated by fuzz/generate-files.sh"] | ||
| publish = false | ||
|
|
||
| [package.metadata] | ||
| cargo-fuzz = true | ||
|
|
||
| [dependencies] | ||
| honggfuzz = { version = "0.5.55", default-features = false } | ||
| jsonrpc = { path = "..", features = ["minreq_http"] } | ||
|
|
||
| serde = { version = "1.0.103", features = [ "derive" ] } | ||
| serde_json = "1.0" | ||
|
|
||
| [lints.rust] | ||
| unexpected_cfgs = { level = "deny", check-cfg = ['cfg(fuzzing)'] } | ||
|
|
||
| [[bin]] | ||
| name = "minreq_http" | ||
| path = "fuzz_targets/minreq_http.rs" | ||
|
|
||
| [[bin]] | ||
| name = "simple_http" | ||
| path = "fuzz_targets/simple_http.rs" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| # Note to devs | ||
|
|
||
| If you are considering adding fuzzing for the other crates take a look | ||
| at how we set up `fuzz_target` in `rust-bitcoin/fuzz`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| # Continuosly cycle over fuzz targets running each for 1 hour. | ||
| # It uses chrt SCHED_IDLE so that other process takes priority. | ||
| # | ||
| # For hfuzz options see https://github.com/google/honggfuzz/blob/master/docs/USAGE.md | ||
|
|
||
| set -e | ||
| REPO_DIR=$(git rev-parse --show-toplevel) | ||
| # shellcheck source=./fuzz-util.sh | ||
| source "$REPO_DIR/fuzz/fuzz-util.sh" | ||
|
|
||
| while : | ||
| do | ||
| for targetFile in $(listTargetFiles); do | ||
| targetName=$(targetFileToName "$targetFile") | ||
| echo "Fuzzing target $targetName ($targetFile)" | ||
|
|
||
| # fuzz for one hour | ||
| HFUZZ_RUN_ARGS='--run_time 3600' chrt -i 0 cargo hfuzz run "$targetName" | ||
| # minimize the corpus | ||
| HFUZZ_RUN_ARGS="-i hfuzz_workspace/$targetName/input/ -P -M" chrt -i 0 cargo hfuzz run "$targetName" | ||
| done | ||
| done |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| REPO_DIR=$(git rev-parse --show-toplevel) | ||
|
|
||
| # Sort order is effected by locale. See `man sort`. | ||
| # > Set LC_ALL=C to get the traditional sort order that uses native byte values. | ||
| export LC_ALL=C | ||
|
|
||
| listTargetFiles() { | ||
| pushd "$REPO_DIR/fuzz" > /dev/null || exit 1 | ||
| find fuzz_targets/ -type f -name "*.rs" | sort | ||
| popd > /dev/null || exit 1 | ||
| } | ||
|
|
||
| targetFileToName() { | ||
| echo "$1" \ | ||
| | sed 's/^fuzz_targets\///' \ | ||
| | sed 's/\.rs$//' \ | ||
| | sed 's/\//_/g' | ||
| } | ||
|
|
||
| targetFileToHFuzzInputArg() { | ||
| baseName=$(basename "$1") | ||
| dirName="${baseName%.*}" | ||
| if [ -d "hfuzz_input/$dirName" ]; then | ||
| echo "HFUZZ_INPUT_ARGS=\"-f hfuzz_input/$FILE/input\"" | ||
| fi | ||
| } | ||
|
|
||
| listTargetNames() { | ||
| for target in $(listTargetFiles); do | ||
| targetFileToName "$target" | ||
| done | ||
| } | ||
|
|
||
| # Utility function to avoid CI failures on Windows | ||
| checkWindowsFiles() { | ||
| incorrectFilenames=$(find . -type f -name "*,*" -o -name "*:*" -o -name "*<*" -o -name "*>*" -o -name "*|*" -o -name "*\?*" -o -name "*\**" -o -name "*\"*" | wc -l) | ||
| if [ "$incorrectFilenames" -gt 0 ]; then | ||
| echo "Bailing early because there is a Windows-incompatible filename in the tree." | ||
| exit 2 | ||
| fi | ||
| } | ||
|
|
||
| # Checks whether a fuzz case output some report, and dumps it in hex | ||
| checkReport() { | ||
| reportFile="hfuzz_workspace/$1/HONGGFUZZ.REPORT.TXT" | ||
| if [ -f "$reportFile" ]; then | ||
| cat "$reportFile" | ||
| for CASE in "hfuzz_workspace/$1/SIG"*; do | ||
| xxd -p -c10000 < "$CASE" | ||
| done | ||
| exit 1 | ||
| fi | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| #!/usr/bin/env bash | ||
| set -ex | ||
|
|
||
| REPO_DIR=$(git rev-parse --show-toplevel) | ||
|
|
||
| # shellcheck source=./fuzz-util.sh | ||
| source "$REPO_DIR/fuzz/fuzz-util.sh" | ||
|
|
||
| # Check that input files are correct Windows file names | ||
| checkWindowsFiles | ||
|
|
||
| if [ "$1" == "" ]; then | ||
| targetFiles="$(listTargetFiles)" | ||
| else | ||
| targetFiles=fuzz_targets/"$1".rs | ||
| fi | ||
|
|
||
| cargo --version | ||
| rustc --version | ||
|
|
||
| # Testing | ||
| cargo install --force honggfuzz --no-default-features | ||
| for targetFile in $targetFiles; do | ||
| targetName=$(targetFileToName "$targetFile") | ||
| echo "Fuzzing target $targetName ($targetFile)" | ||
| if [ -d "hfuzz_input/$targetName" ]; then | ||
| HFUZZ_INPUT_ARGS="-f hfuzz_input/$targetName/input\"" | ||
| else | ||
| HFUZZ_INPUT_ARGS="" | ||
| fi | ||
| RUSTFLAGS="--cfg=jsonrpc_fuzz" HFUZZ_RUN_ARGS="--run_time 30 --exit_upon_crash -v $HFUZZ_INPUT_ARGS" cargo hfuzz run "$targetName" | ||
|
|
||
| checkReport "$targetName" | ||
| done |
Oops, something went wrong.