Skip to content

Commit 71ff4c1

Browse files
committed
Modify README
1 parent eb6c8ea commit 71ff4c1

File tree

1 file changed

+48
-9
lines changed

1 file changed

+48
-9
lines changed

readme.md

Lines changed: 48 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,62 @@
1-
# CVSSlib [![Build Status](https://travis-ci.org/ctxis/cvsslib.svg?branch=master)](https://travis-ci.org/ctxis/cvsslib)
1+
# Robot Vulnerability Scoring System (RVSS) Python 3 reference implementation.
22

3-
Originally forked from https://github.com/ctxis/cvsslib.
3+
*Work inspired by https://github.com/ctxis/cvsslib.*
44

5-
A Python 3 library for calculating CVSS v2 and CVSS v3 vectors, with tests. Examples on how to use
6-
the library is shown below, and there is some documentation on the internals within the `docs` directory. The library
7-
is designed to be completely extendable, so it is possible to implement your own custom scoring systems (or those of your clients)
8-
and have it work with the same API, and with the same bells and whistles.
5+
----
96

10-
**Python 3 only**
7+
- **Current version**: 1.0
8+
- **License**: GPLv3
9+
10+
----
11+
12+
This repository provides a Python 3 (*only Python 3*) library for calculating robot vulnerability scores. The library extends `cvsslib` to support the following scoring systems:
13+
- CVSSv2
14+
- CVSSv3
15+
- RVSSv1
16+
17+
From the original README:
18+
19+
> Examples on how to use the library is shown below, and there is some documentation on the internals within the `docs` directory. The library is designed to be completely extendable, so it is possible to implement your own custom scoring systems (or those of your clients) and have it work with the same API, and with the same bells and whistles.
20+
21+
## How to cite our work
22+
```
23+
TODO
24+
```
1125

1226
## Install
1327
```bash
1428
python3 setup.py install
1529
```
1630

31+
## Try it out
32+
#### RVSSv1
33+
```bash
34+
$ rvss RVSS:1.0/AV:AN/AC:L/PR:N/UI:N/Y:O/S:U/C:N/I:L/A:N/H:H
35+
Base Score: 7.3
36+
Temporal: 7.3
37+
Environment: 7.3
38+
```
39+
40+
#### CVSSv3
41+
```bash
42+
$ rvss CVSS:3.0/AV:A/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H
43+
Base Score: 8.8
44+
Temporal: 8.8
45+
Environment: 8.8
46+
```
47+
48+
#### CVSSv2
49+
```bash
50+
$ rvss CVSS:2.0/AV:L/AC:M/Au:N/C:N/I:P/A:C/E:POC/RL:W/RC:UR/CDP:LM/TD:H/CR:M/IR:L/AR:H
51+
Base Score: 5.4
52+
Temporal: 4.4
53+
Environment: 6.9
54+
```
55+
56+
1757
## API
1858

19-
It's pretty simple to use. `cvsslib` has a `cvss2` and `cvss3` sub modules that contains all of the enums
20-
and calculation code. There are also some functions to manipulate vectors that take these cvss modules
59+
It's pretty simple to use. `cvsslib` has a `cvss2`, `cvss3` and `rvss` sub modules that contains all of the enums and calculation code. There are also some functions to manipulate vectors that take these cvss modules
2160
as arguments. E.G:
2261

2362
```python

0 commit comments

Comments
 (0)