Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add guidance and conclusions to top of fuzz-introspector report #46

Closed
DavidKorczynski opened this issue Feb 22, 2022 · 5 comments
Closed

Add guidance and conclusions to top of fuzz-introspector report #46

DavidKorczynski opened this issue Feb 22, 2022 · 5 comments
Labels
enhancement New feature or request

Comments

@DavidKorczynski
Copy link
Contributor

Currently the fuzz-introspector report is focused around displaying a lot of data, but we don't provide a ton of conclusions about the health of the fuzzing of a project.

It would be nice to create some simple conclusions that are easily digestible by a developer, e.g.

  • "Your fuzzers have a lot of reachability but the coverage is not matching. You shuold debug the existing fuzzers to improve results"
  • "Your fuzzers are all explored well relative to their reachability, you shuold see into adding new fuzzers"
  • "This fuzzer is blocked at a specific point: you should try and debug it here"
  • "This part of your code is not reached at all, you should see into creating fuzzers that target this code".

This is quite similar in nature to how malware analysis reports will often have a set of heuristics at the top of it which makes it easy to get a holistic view into the malware analysis. We should create something similar for fuzz-introspector.
@DavidKorczynski
Copy link
Contributor Author

DavidKorczynski commented Feb 22, 2022 •
edited
Loading

The use of color schemes schemes could help convey meaning (about positive/negative). I am thinking of something similar to this from Cuckoo Sandbox

Screenshot from 2022-02-22 17-49-32

@Navidem Navidem added the enhancement New feature or request label Feb 22, 2022
DavidKorczynski added a commit that referenced this issue Feb 23, 2022
@DavidKorczynski
post-process: add skeleton for suggestion section
391885f 
Ref: #46
DavidKorczynski added a commit that referenced this issue Feb 23, 2022
@DavidKorczynski
post-process: add first conclusion example. More to come
34de464 
Ref: #46
DavidKorczynski added a commit that referenced this issue Feb 23, 2022
@DavidKorczynski
post-process: add info on runtime covered functions over reachable
20eb668 
This is also to be used in guidance, i.e. on whether some fuzz targets
should be explored for blockers.

Ref: #46
@AdamKorcz AdamKorcz mentioned this issue Feb 24, 2022
Merged
DavidKorczynski added a commit that referenced this issue Feb 24, 2022
@DavidKorczynski
post-process: refactor HTML report strings
fff02c3 
Split generation of HTML report into smaller components. This makes it
make flexibly, which will be used for generating HTML content at the top
of the HTML report that is based on analysis done at the end of the
generation, e.g. showing conclusions and guidance that is based on
results from the end of the analysis but the HTML content of the
guidance will be shown at the top of the report.

Ref: #46
DavidKorczynski added a commit that referenced this issue Feb 24, 2022
@DavidKorczynski
post-process: make conclusions easy to add and display
69a35d1 
Modularise the conclusions are created and displayed. The key idea is to
let analyses simply add conclusiones themselves and expect it to be
shown in the report.

Ref: #46
DavidKorczynski added a commit that referenced this issue Feb 24, 2022
@DavidKorczynski
post-process: add conclusion about complexity reachability
7f26c7d 
Ref: #46
@Navidem Navidem added this to the v1 milestone Feb 27, 2022
@oliverchang
Copy link
Contributor

Is there any work remaining here?

@DavidKorczynski
Copy link
Contributor Author

Is there any work remaining here?

We have conclusions added now and they look good I recon. However, we should re-iterate over the language in the conclusions and also refine the actual conclusions (what we consider good, how we phrase "this could be improved" and things of this nature). I left this issue open for these purposes.

@oliverchang
Copy link
Contributor

The current ones LGTM for v1. So removing the milestone.

@oliverchang oliverchang removed this from the v1 milestone Mar 29, 2022
@DavidKorczynski DavidKorczynski mentioned this issue Jun 28, 2022
Closed
@DavidKorczynski DavidKorczynski mentioned this issue Jul 26, 2022
Merged
@DavidKorczynski
Copy link
Contributor Author

Closed by #416

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@DavidKorczynski @oliverchang @Navidem