Skip to content

Commit db7ad29

Browse files
committed
Improve README
1 parent ce5d723 commit db7ad29

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# FIDIUS fidius-cvedb
22

3-
The FIDIUS CVE-DB Gem is used to create and run your own vulnerability database,
4-
or as an addition to the FIDIUS Command&Control Server to receive vulnerability
5-
information about target hosts. It uses the National Vulnerability Database
6-
(NVD [nvd.nist.gov](http://nvd.nist.gov/)) to gather vulnerability entries
7-
which are based on the Common Vulnerabilities and Exposures (CVE) identifiers.
3+
The FIDIUS CVE-DB Gem is used to run your own vulnerability database,
4+
based on the National Vulnerability Database (NVD
5+
[nvd.nist.gov](http://nvd.nist.gov/)). It can be used for projects
6+
that need access to vulnerability information, such as the Common
7+
Vulnerabilities and Exposures (CVE) identifiers.
88

9-
Therefore it includes rake tasks to download and parse XML files provided by the
9+
It includes rake tasks to download and parse XML files provided by the
1010
NVD, to store and update them in your personal database. Furthermore it includes
1111
ActiveRecord models, migrations and example database configuration to store
1212
Vulnerabilities easily.
1313

14-
This gem is developed in the context of the students project "FIDIUS" at the
15-
University of Bremen, for more information about FIDIUS visit
14+
This gem is being developed in the context of the student project "FIDIUS" at the
15+
Universitaet Bremen; for more information about FIDIUS visit
1616
[fidius.me](http://fidius.me/en).
1717

1818
## Installation
@@ -38,7 +38,7 @@ not work with Windows.
3838
## Configuration
3939

4040
The setup depends on the context you want to use the gem. It can be used in the
41-
context of the FIDIUS Command&Control Server, or in your own Rails-app. It might
41+
context of the FIDIUS Command&Control Server, or in your own Rails app. It might
4242
access an already existing database or migrate a new one.
4343

4444
0. Go to your Rails-app folder and run `fidius-cvedb --standalone` or
@@ -61,12 +61,12 @@ access an already existing database or migrate a new one.
6161
needed.
6262
3. When you set up your own database initialize it (note that it needs to be
6363
migrated before). Go to your Rails-app folder and run
64-
`rake nvd:initialize`. This will download all available informations from the
64+
`rake nvd:initialize`. This will download all available information from the
6565
NVD, parse and store it in your database. This takes about 3 hours, depending
6666
on your machine. To keep your database up-to-date run `rake nvd:update`
67-
regularly, e.g. as daily cronjob.
68-
4. Now you should be able to use the NVD Entries, to test this go to your
69-
console (`rails console` | `ruby script/console`) and get an Entry:
67+
regularly, e.g. as a daily cron job.
68+
4. Now you should be able to use the NVD entries, to test this go to your
69+
console (`rails console` | `ruby script/console`) and get an entry:
7070

7171
$ FIDIUS::CveDb::NvdEntry.first
7272

@@ -90,14 +90,14 @@ where _option_ may be:
9090
fidius-cvedb was written by
9191

9292
* FIDIUS Intrusion Detection with Intelligent User Support
93-
<[email protected]>, <http://fidius.me>
93+
<grp-fidius+cvedb@tzi.de>, <http://fidius.me>
9494
* in particular:
9595
* Andreas Bender <[email protected]>
9696
* Jens Färber <[email protected]>
9797

9898
If you have any questions, remarks, suggestion, improvements,
9999
etc. feel free to drop a line at the addresses given above.
100-
You might also join `#fidius` on Freenode or use the contact
100+
You might also join [`#fidius` on Freenode](irc://irc.freenode.net/fidius) or use the contact
101101
form on our [website](http://fidius.me/en/contact).
102102

103103

0 commit comments

Comments
 (0)