update readme #12
Merged
update readme #12
Conversation
This file contains hidden or 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
Loco1982
requested changes
Mar 8, 2023
README.md
Outdated
|
|
||
| In this repo the fuzzers have the following structure: | ||
|
|
||
| ### if the fuzzer uses honggfuzz |
There was a problem hiding this comment.
Suggested change
| ### if the fuzzer uses honggfuzz | |
| ### Honggfuzz' fuzzer |
README.md
Outdated
| * The ***src*** folder contains the file main with the fuzzer | ||
| * The ***hfuzz_workspace*** folder contains a REPORT file with the report of the crashes the fuzzer found, this folder is updated each time the fuzzer finds a new crash and has the information about the crash along with the name of the input that triggered it. Also contains the input files that triggers the errors, the file names starts with SIGABRT | ||
|
|
||
| ### if the fuzzer uses cargofuzz |
There was a problem hiding this comment.
Suggested change
| ### if the fuzzer uses cargofuzz | |
| ### Cargofuzz' fuzzer |
README.md
Outdated
| ### if the fuzzer uses honggfuzz | ||
|
|
||
| * The ***src*** folder contains the file main with the fuzzer | ||
| * The ***hfuzz_workspace*** folder contains a REPORT file with the report of the crashes the fuzzer found, this folder is updated each time the fuzzer finds a new crash and has the information about the crash along with the name of the input that triggered it. Also contains the input files that triggers the errors, the file names starts with SIGABRT |
There was a problem hiding this comment.
Suggested change
| * The ***hfuzz_workspace*** folder contains a REPORT file with the report of the crashes the fuzzer found, this folder is updated each time the fuzzer finds a new crash and has the information about the crash along with the name of the input that triggered it. Also contains the input files that triggers the errors, the file names starts with SIGABRT | |
| * The ***hfuzz_workspace*** folder contains a REPORT file with the report of the crashes the fuzzer found, this folder is updated each time the fuzzer finds a new crash and has the information about the crash along with the name of the input that triggered it. Also contains the input files that trigger the errors, the file names start with SIGABRT |
README.md
Outdated
Comment on lines
29
to
31
| * the ***fuzz_targets*** contains the files with the fuzzers | ||
|
|
||
|
|
There was a problem hiding this comment.
Suggested change
| * the ***fuzz_targets*** contains the files with the fuzzers | |
| * the ***fuzz_targets*** contains the files with the fuzzers | |
It has one too many new lines
README.md
Outdated
| ## User Guide | ||
|
|
||
| ### 1. create the docker container | ||
| * Use the command `docker build -t ready-to-fuzz-image` inside this proyect to create a docker image named **ready-to-fuzz-image** from the dockerfile in the proyect. |
There was a problem hiding this comment.
Suggested change
| * Use the command `docker build -t ready-to-fuzz-image` inside this proyect to create a docker image named **ready-to-fuzz-image** from the dockerfile in the proyect. | |
| * Use the command `docker build -t ready-to-fuzz-image` inside this project to create a docker image named **ready-to-fuzz-image** from the dockerfile in the project. |
There was a problem hiding this comment.
It should say 'project' not 'proyect'
README.md
Outdated
| ## User Guide | ||
|
|
||
| ### 1. create the docker container | ||
| * Use the command `docker build -t ready-to-fuzz-image` inside this proyect to create a docker image named **ready-to-fuzz-image** from the dockerfile in the proyect. | ||
| * run the command `docker run -it --rm --cap-add=SYS_PTRACE --security-opt seccomp=unconfined ready-to-fuzz-image bash` to run the container from the image previusly created. |
There was a problem hiding this comment.
Suggested change
| * run the command `docker run -it --rm --cap-add=SYS_PTRACE --security-opt seccomp=unconfined ready-to-fuzz-image bash` to run the container from the image previusly created. | |
| * run the command `docker run -it --rm --cap-add=SYS_PTRACE --security-opt seccomp=unconfined ready-to-fuzz-image bash` to run the container from the image previously created. |
Loco1982
reviewed
Mar 8, 2023
README.md
Outdated
| * run the command `docker run -it --rm --cap-add=SYS_PTRACE --security-opt seccomp=unconfined ready-to-fuzz-image bash` to run the container from the image previusly created. | ||
|
|
||
| ### 2. Run a fuzzer | ||
|
|
||
| Depending on the fuzzer use the following commands: | ||
|
|
||
| ### If the Fuzzer Uses Honggfuzz | ||
|
|
||
| * to run it with total random data use: |
There was a problem hiding this comment.
Suggested change
| * to run it with total random data use: | |
| * to run it with totally random data use: |
There was a problem hiding this comment.
ups typo, fixed!
Loco1982
requested changes
Mar 8, 2023
README.md
Outdated
| ## User Guide | ||
|
|
||
| ### 1. create the docker container | ||
| * Use the command `docker build -t ready-to-fuzz-image` inside this proyect to create a docker image named **ready-to-fuzz-image** from the dockerfile in the proyect. |
There was a problem hiding this comment.
It should say 'project' not 'proyect'
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the proyect readme to contain the docker container section