UI changes:
For audit reports, also add them in the reports/ directory.
We only include medium, high, and critical severity bugs from audits.
For each bug, we need to do the following:
- Create a directory
dataset/dsl/project/bug-id where dsl is the DSL used by the project (e.g., plonky3), project is the project name (e.g., SP1), bug-id is the ID that should be source-bug, where source could be the security company (e.g., zksecurity) or a competition or the handle of a security researcher, and bug is the bug name with underscores instead of spaces.
- Copy the contents of the template into the new directory:
cp template/* dataset/dsl/project/bug-id
- Fill all the details in the
zkbugs_config.json file. Note that id is source-report-id where report-i is the id for the bug in the report (e.g., 1)
- If it is possible to reproduce the bug with a test case, then fill the rest of the files (look at
circom-template for an example). In any case, in zkbugs_get_sources.sh add the code to clone the code in the specific commit where the code was vulnerable.
SP1:
risc0:
Zisk:
openvm:
zksync-airbender:
jolt:
Pico and Ziren: Nothing yet
UI changes:
ZKVMfield to both reports and bugs. It should be a boolean flag.ZKVMflag.zkbugs_get_sources.shcommands in all issues.For audit reports, also add them in the
reports/directory.We only include medium, high, and critical severity bugs from audits.
For each bug, we need to do the following:
dataset/dsl/project/bug-idwheredslis the DSL used by the project (e.g., plonky3),projectis the project name (e.g., SP1),bug-idis the ID that should besource-bug, wheresourcecould be the security company (e.g., zksecurity) or a competition or the handle of a security researcher, andbugis the bug name with underscores instead of spaces.cp template/* dataset/dsl/project/bug-idzkbugs_config.jsonfile. Note that id issource-report-idwhere report-i is the id for the bug in the report (e.g.,1)circom-templatefor an example). In any case, inzkbugs_get_sources.shadd the code to clone the code in the specific commit where the code was vulnerable.SP1:
risc0:
Zisk:
openvm:
zksync-airbender:
jolt:
Pico and Ziren: Nothing yet