Skip to content

Commit 21ed280

Browse files
authored
Visualizer add to docs, update README (#52)
1 parent 5c71cbe commit 21ed280

File tree

5 files changed

+59
-6
lines changed

5 files changed

+59
-6
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99

1010
⚠️ Code and data for the [ICLR 2025 Paper](https://arxiv.org/pdf/2405.17238) can be found in the v1 branch, license and citation below.
1111

12+
## 📰 News
13+
* **[Jul. 10, 2025]**: IRIS v2 released, added support for 7 new CWEs.
14+
1215
## 👋 Overview
1316
### IRIS
1417
IRIS is a neurosymbolic framework that combines LLMs with static analysis for security vulnerability detection. IRIS uses LLMs to generate source and sink specifications and to filter false positive vulnerable paths.
@@ -89,10 +92,53 @@ export PATH="$PWD/codeql:$PATH"
8992

9093
**Note:** Also adjust the environment variable `CODEQL_QUERY_VERSION` in `src/config.py` according to the instructions therein. For instance, for CodeQL v2.15.0, this should be `0.8.0`.
9194

95+
### Visualizer
96+
97+
IRIS comes with a visualizer to view the SARIF output files. More detailed instructions can be found in the [docs](https://iris-sast.github.io/iris/features/visualizer.html).
98+
99+
![iris visualizer](docs/assets/visualizer.png)
100+
101+
#### Usage:
102+
103+
1. **Configure paths**: Edit `config.json` to point to your outputs and source directories
104+
2. **Start the server**: Run `python3 server.py`
105+
3. **Open in browser**: Navigate to `http://localhost:8000`
106+
4. **Select a project**: Choose a project from the dropdown to load its analysis results
107+
5. **Filter and explore**: Use the CWE and model filters to explore specific vulnerabilities
108+
109+
92110
## 💫 Contributions
93111
We welcome any contributions, pull requests, or issues!
94112
If you would like to contribute, please either file a new pull request or issue. We'll be sure to follow up shortly!
95113

114+
## 🤝 Our Team
115+
116+
IRIS is a collaborative effort between researchers at Cornell University and the University of Pennsylvania. Please reach out to us if you have questions about IRIS.
117+
118+
### Students
119+
120+
[Claire Wang](https://clairewang.net), University of Pennsylvania
121+
122+
[Amartya Das](https://github.com/IcebladeLabs), Ward Melville High School
123+
124+
[Derin Gezgin](https://deringezgin.github.io/), Connecticut College
125+
126+
[Zhengdong (Forest) Huang](https://github.com/FrostyHec), Southern University of Science and Technology
127+
128+
[Nevena Stojkovic](https://www.linkedin.com/in/nevena-stojkovic-3b7a69335), Massachusetts Institute of Technology
129+
130+
### Faculty
131+
132+
[Ziyang Li](https://liby99.github.io), Johns Hopkins University, previously PhD student at the University of Pennsylvania
133+
134+
[Saikat Dutta](https://www.cs.cornell.edu/~saikatd), Cornell University
135+
136+
[Mayur Naik](https://www.cis.upenn.edu/~mhnaik), University of Pennsylvania
137+
138+
<img src="https://github.com/user-attachments/assets/37969a67-a3fd-4b4f-9be4-dfeed28d2b48" width="175" height="175" alt="Cornell University" />
139+
140+
<img src="https://github.com/user-attachments/assets/362abdfb-4ca4-46b2-b003-b185ce4d20af" width="300" height="200" alt="University of Pennsylvania"/>
141+
96142
## ✍️ Citation & license
97143
MIT license. Check `LICENSE.md`.
98144

docs/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
# Features
1818
- [Supported CWEs](features/cwes.md)
1919
- [Supported Models](features/models.md)
20+
- [Visualizer](features/visualizer.md)
2021

2122
# Development
2223
- [Adding CWEs](development/adding-cwes.md)

docs/about/team.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,25 @@
22

33
IRIS is a collaborative effort between researchers at the University of Pennsylvania and Cornell University. Please reach out to us if you have questions about IRIS.
44

5-
[Claire Wang](https://clairewang.net), UPenn
5+
### Students
6+
7+
[Claire Wang](https://clairewang.net), University of Pennsylvania
68

79
[Amartya Das](https://github.com/IcebladeLabs), Ward Melville High School
810

911
[Derin Gezgin](https://deringezgin.github.io/), Connecticut College
1012

11-
[Zhengdong (Forest) Huang](https://github.com/FrostyHec), SUSTech
13+
[Zhengdong (Forest) Huang](https://github.com/FrostyHec), Southern University of Science and Technology
14+
15+
[Nevena Stojkovic](https://www.linkedin.com/in/nevena-stojkovic-3b7a69335), Massachusetts Institute of Technology
1216

13-
[Nevena Stojkovic](https://www.linkedin.com/in/nevena-stojkovic-3b7a69335), MIT
17+
### Faculty
1418

15-
[Ziyang Li](https://liby99.github.io), Johns Hopkins University, previously PhD student at UPenn
19+
[Ziyang Li](https://liby99.github.io), Johns Hopkins University, previously PhD student at the University of Pennsylvania
1620

17-
[Saikat Dutta](https://www.cs.cornell.edu/~saikatd), Cornell
21+
[Saikat Dutta](https://www.cs.cornell.edu/~saikatd), Cornell University
1822

19-
[Mayur Naik](https://www.cis.upenn.edu/~mhnaik), UPenn
23+
[Mayur Naik](https://www.cis.upenn.edu/~mhnaik), University of Pennsylvania
2024

2125
<img src="https://github.com/user-attachments/assets/37969a67-a3fd-4b4f-9be4-dfeed28d2b48" width="175" height="175" alt="Cornell University" />
2226

docs/assets/visualizer.png

52 KB
Loading

visualizer/README.md renamed to docs/features/visualizer.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
A web-based visualizer for IRIS static analysis results stored in SARIF format.
44

5+
![iris visualizer](../assets/visualizer.png)
6+
57
## Features
68

79
- Interactive visualization of IRIS analysis results

0 commit comments

Comments
 (0)