claire71 commited on
Commit
0ce286a
·
verified ·
1 Parent(s): 121fe9c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +6 -58
README.md CHANGED
@@ -16,9 +16,9 @@ tags:
16
 
17
  This repository contains the dataset CWE-Bench-Java presented in the paper [LLM-Assisted Static Analysis for Detecting Security Vulnerabilities](https://arxiv.org/abs/2405.17238). At a high level, this dataset contains 120 CVEs spanning 4 CWEs, namely path-traversal, OS-command injection, cross-site scripting, and code-injection. Each CVE includes the buggy and fixed source code of the project, along with the information of the fixed files and functions. We provide the seed information for each CVE in this repository, as well as advisories.
18
 
19
- CWE-Bench-Java Github Repository (https://github.com/iris-sast/cwe-bench-java) - The CWE-Bench-Java repository contains more details about the benchmark, and how to reproduce the benchmark for the paper. For any feedback, please open an issue.
20
 
21
- IRIS Paper Github Repository (https://github.com/iris-sast/iris) - The IRIS repository contains instructions on reproducing the paper.
22
 
23
  ## Dataset Details
24
 
@@ -133,21 +133,17 @@ Each row in `data/fix_info.csv` looks like the following.
133
  - `signature`: the signature of the method. Note that we might have multiple overloaded methods with the same name but with different signatures
134
 
135
 
136
- ### Dataset Sources [optional]
137
 
138
  An extension of this dataset can be found on the Github repository, which provides utilities to fetch and build the relevant projects, and a simple website visualizer.
139
 
140
  - **Curated by:** Ziyang Li, Saikat Dutta
141
- - **Funded by [optional]:** [More Information Needed]
142
- - **Shared by [optional]:** [More Information Needed]
143
- - **Language(s) (NLP):** [More Information Needed]
144
  - **License:** MIT
145
 
146
  <!-- Provide the basic links for the dataset. -->
147
 
148
  - **Repository:** [CWE-Bench-Java](https://github.com/iris-sast/cwe-bench-java/tree/master)
149
  - **Paper [optional]:** [LLM-Assisted Static Analysis for Detecting Security Vulnerabilities](https://arxiv.org/abs/2405.17238)
150
- - **Demo [optional]:** [More Information Needed]
151
 
152
  ## Uses
153
 
@@ -178,8 +174,6 @@ An extension of this dataset can be found on the Github repository, which provid
178
  - Attackers could analyze vulnerable code examples to understand how to exploit similar software weaknesses
179
  - Detailed information about vulnerabilities might aid in crafting targeted attacks against unpatched software versions.
180
 
181
- [More Information Needed]
182
-
183
  ### Curation Rationale
184
 
185
  The dataset was created to provide a high-quality benchmark for evaluating the ability of IRIS to detect and fix real-world vulnerabilities in Java code.
@@ -203,34 +197,6 @@ This dataset bridges that gap with reproducible, well-labeled examples tied to C
203
  - Class and method boundaries using AST analysis
204
  - Patch validation was performed via manual review and automated testing where possible.
205
 
206
- [More Information Needed]
207
-
208
- #### Who are the source data producers?
209
-
210
- <!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
211
-
212
- ### Annotations [optional]
213
-
214
- <!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
215
-
216
- #### Annotation process
217
-
218
- <!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
219
-
220
- [More Information Needed]
221
-
222
- #### Who are the annotators?
223
-
224
- <!-- This section describes the people or systems who created the annotations. -->
225
-
226
- [More Information Needed]
227
-
228
- #### Personal and Sensitive Information
229
-
230
- <!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
231
-
232
- [More Information Needed]
233
-
234
  ## Bias, Risks, and Limitations
235
 
236
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
@@ -240,13 +206,7 @@ This dataset bridges that gap with reproducible, well-labeled examples tied to C
240
  - Biased toward open-source: Enterprise and closed-source vulnerabilities are excluded, limiting the scope of evaluation.
241
  - Manually vetted, which introduces potential human error or subjective judgment in what counts as the “core fix.”
242
 
243
- ### Recommendations
244
-
245
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
246
-
247
- Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
248
-
249
- ## Citation [optional]
250
 
251
  <!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
252
  Consider citing our paper:
@@ -263,15 +223,7 @@ Consider citing our paper:
263
  }
264
  ```
265
 
266
- **BibTeX:**
267
-
268
- [More Information Needed]
269
-
270
- **APA:**
271
-
272
- [More Information Needed]
273
-
274
- ## Glossary [optional]
275
 
276
  <!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
277
 
@@ -281,10 +233,6 @@ Consider citing our paper:
281
  - Static Analysis: Code analysis technique that examines source code without executing it.
282
  - Patch: A set of changes to a program designed to fix a known issue or vulnerability
283
 
284
- ## More Information [optional]
285
-
286
- [More Information Needed]
287
-
288
  ## Dataset Card Authors
289
 
290
  - Ziyang Li (University of Pennsylvania)
@@ -296,4 +244,4 @@ Consider citing our paper:
296
 
297
  ## Dataset Card Contact
298
 
299
- [More Information Needed]
 
16
 
17
  This repository contains the dataset CWE-Bench-Java presented in the paper [LLM-Assisted Static Analysis for Detecting Security Vulnerabilities](https://arxiv.org/abs/2405.17238). At a high level, this dataset contains 120 CVEs spanning 4 CWEs, namely path-traversal, OS-command injection, cross-site scripting, and code-injection. Each CVE includes the buggy and fixed source code of the project, along with the information of the fixed files and functions. We provide the seed information for each CVE in this repository, as well as advisories.
18
 
19
+ **CWE-Bench-Java Github Repository** (https://github.com/iris-sast/cwe-bench-java) - The CWE-Bench-Java repository contains more details about the benchmark, and how to reproduce the benchmark for the paper. For any feedback, please open an issue.
20
 
21
+ **IRIS Paper Github Repository** (https://github.com/iris-sast/iris) - The IRIS repository contains instructions on reproducing the paper.
22
 
23
  ## Dataset Details
24
 
 
133
  - `signature`: the signature of the method. Note that we might have multiple overloaded methods with the same name but with different signatures
134
 
135
 
136
+ ### Dataset Sources
137
 
138
  An extension of this dataset can be found on the Github repository, which provides utilities to fetch and build the relevant projects, and a simple website visualizer.
139
 
140
  - **Curated by:** Ziyang Li, Saikat Dutta
 
 
 
141
  - **License:** MIT
142
 
143
  <!-- Provide the basic links for the dataset. -->
144
 
145
  - **Repository:** [CWE-Bench-Java](https://github.com/iris-sast/cwe-bench-java/tree/master)
146
  - **Paper [optional]:** [LLM-Assisted Static Analysis for Detecting Security Vulnerabilities](https://arxiv.org/abs/2405.17238)
 
147
 
148
  ## Uses
149
 
 
174
  - Attackers could analyze vulnerable code examples to understand how to exploit similar software weaknesses
175
  - Detailed information about vulnerabilities might aid in crafting targeted attacks against unpatched software versions.
176
 
 
 
177
  ### Curation Rationale
178
 
179
  The dataset was created to provide a high-quality benchmark for evaluating the ability of IRIS to detect and fix real-world vulnerabilities in Java code.
 
197
  - Class and method boundaries using AST analysis
198
  - Patch validation was performed via manual review and automated testing where possible.
199
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
200
  ## Bias, Risks, and Limitations
201
 
202
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
206
  - Biased toward open-source: Enterprise and closed-source vulnerabilities are excluded, limiting the scope of evaluation.
207
  - Manually vetted, which introduces potential human error or subjective judgment in what counts as the “core fix.”
208
 
209
+ ## Citation
 
 
 
 
 
 
210
 
211
  <!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
212
  Consider citing our paper:
 
223
  }
224
  ```
225
 
226
+ ## Glossary
 
 
 
 
 
 
 
 
227
 
228
  <!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
229
 
 
233
  - Static Analysis: Code analysis technique that examines source code without executing it.
234
  - Patch: A set of changes to a program designed to fix a known issue or vulnerability
235
 
 
 
 
 
236
  ## Dataset Card Authors
237
 
238
  - Ziyang Li (University of Pennsylvania)
 
244
 
245
  ## Dataset Card Contact
246
 
247
+ For any feedback, questions, concerns - please [open an issue](https://github.com/iris-sast/cwe-bench-java/issues) on the CWE-Bench-Java Github repository.