Skip to content
This repository has been archived by the owner on May 14, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ahouseholder authored May 14, 2024
1 parent a8eefd0 commit 537efa2
Showing 1 changed file with 10 additions and 26 deletions.
36 changes: 10 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
> [!Important]
> With the introduction of the [VINCE API](https://github.com/CERTCC/VINCE/tree/main/api_examples), the
> [CERT Vulnerability Data Archive](https://github.com/CERTCC/Vulnerability-Data-Archive) has been archived and
> these tools are no longer supported. We're leaving them available as an archive repository for those who might still
> want to parse the archived data.
# Vulnerability Data Archive Tools

This is our attempt at providing a simple means of interacting with the [CERT Vulnerability Data Archive](https://github.com/CERTCC-Vulnerability-Analysis/Vulnerability-Data-Archive). At this time we have no plans to provide any full-fledged applications. Instead we are offering a simple `VulDb()` Python class that can load the vulnerability data contained in the archive. It's up to you to decide how to use it. Anyone with some basic Python skills should be able to make use of this package.
This is our attempt at providing a simple means of interacting with the [CERT Vulnerability Data Archive](https://github.com/CERTCC/Vulnerability-Data-Archive). At this time we have no plans to provide any full-fledged applications. Instead we are offering a simple `VulDb()` Python class that can load the vulnerability data contained in the archive. It's up to you to decide how to use it. Anyone with some basic Python skills should be able to make use of this package.

# Getting Started

Expand All @@ -14,7 +20,7 @@ $ pip install virtualenv
Get the Vulnerability Data Archive Tools:

```
git clone https://github.com/CERTCC-Vulnerability-Analysis/Vulnerability-Data-Archive-Tools.git
git clone https://github.com/CERTCC/Vulnerability-Data-Archive-Tools.git
```

So we'll assume that you now have the code in `./Vulnerability-Data-Archive-Tools`
Expand Down Expand Up @@ -59,25 +65,12 @@ Install the CERT Vulnerability Data Archive Tools package:
You can clone the Vulnerability Data Archive using git:

```
git clone https://github.com/CERTCC-Vulnerability-Analysis/Vulnerability-Data-Archive.git
git clone https://github.com/CERTCC/Vulnerability-Data-Archive.git
```

Or just download and unzip this:

<https://github.com/CERTCC-Vulnerability-Analysis/Vulnerability-Data-Archive/archive/master.zip>

### Older versions of this data

*Skip this section if you got the data from github as described immediately above.*

If you happen to have the JSON files from <https://www.cert.org/download/vul_data_archive/> and you would rather use those, just put the `CERT_vul_reports.json` and `CERT_vendor_records.json` directories in a directory and run:

```
cert_vuldata_splitexport --inpath=path/to/data --outpath=path/to/output
```

Then you should be able to run the demo below on that data. We recommend you use the data from github though.

<https://github.com/CERTCC/Vulnerability-Data-Archive/archive/master.zip>


# Using the Tools
Expand Down Expand Up @@ -145,12 +138,3 @@ This is where your creativity comes in. Want to see all the vuls we cataloged wi
# a VulDb object is basically a dict
for vu_id, record in vulrecords.iteritems():
do_something_with(record)

## Tell Us About It

Did you find something interesting in the data? Did you come up with some cool way of slicing it or remixing it and you want to share? You can tweet us [@certcc](https://twitter.com/certcc). Or send mail to [cert@cert.org](mailto:cert@cert.org?subject=INFO%23365908%20Vulnerability%20Data%20Archive%20Feedback).

If you find a problem with the data or the tools, please create an issue report in the appropriate repository.

Please be aware though that we offer no formal support, however we may respond to questions and
feedback sent to [cert@cert.org](mailto:cert@cert.org?subject=INFO%23365908%20Vulnerability%20Data%20Archive%20Feedback) with the tag INFO#365908 in the subject.

0 comments on commit 537efa2

Please sign in to comment.