Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
j--- committed Apr 30, 2021
1 parent bf2feaa commit 5b26a14
Showing 1 changed file with 27 additions and 6 deletions.
33 changes: 27 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,31 @@
# SSVC
Stakeholder-Specific Vulnerability Categorization

The Stakeholder-specific Vulnerability Categorization (SSVC) is a system for prioritizing actions during vulnerability management.
SSVC aims to avoid one-size-fits-all solutions in favor of a modular decision-making system with clearly defined and tested parts that vulnerability managers can select and use as appropriate to their context.

# What's here

SSVC is mostly conceptual tools for vulnerability management.
These conceptual tools (how to make decisions, what should go into a decision, how to document and communicate decisions clearly, etc.) are described here.

`doc/*`

Draft and final versions of reports. See [`doc/README.md`](doc/README.md) for
more info.

`doc/pdfs/*.pdf`

Final versions of both reports referenced below can be found in this directory.
Static versions of issued reports are stored in this directory.

`data/*.csv`

Also included in are the two lookup tables as csv files which `ssvc.py`
reads in. These are just one row per possible path through the trees as
described in the paper. Changing the "outcome" column in this table will
change what the module above recommends.
The data folder contains detailed data files that define suggested prioritization results based on each combination of information on a vulnerability work item.
Also included in data are the lookup tables as csv files which `ssvc.py`
reads in.
These files define one row per possible path through the trees as
described in the paper.
The tools in the `src` folder provide an interface to work with these data files.
Customizing the "outcome" column in this csv is the primary recommended way that stakehodlers might adapt SSVC to their environment.


`src/ssvc.py`
Expand All @@ -34,6 +42,19 @@ but it worked well enough for what was needed at the time.
Directory with SSVC calculator using D3 graph.
See [`ssvc-calc/README.md`](ssvc-calc/README.md) for more info.

## Citing SSVC

To reference SSVC in an academic publication, please refer to the version presented at the 2020 Workshop on Economics of Information Security (WEIS):

@inproceedings{spring2020ssvc,
title={Prioritizing vulnerability response: {A} stakeholder-specific vulnerability categorization},
author={Jonathan M Spring and Eric Hatleback and Allen D. Householder and Art Manion and Deana Shick},
address={Brussels, Belgium},
year={2020},
month = dec,
booktitle = {Workshop on the Economics of Information Security}
}

## References

1. Spring, J., Hatleback, E., Householder, A., Manion, A., and Shick, D. "Prioritizing Vulnerability Response: A Stakeholder-Specific Vulnerability Categorization." White Paper, Software Engineering Institute, Carnegie Mellon University (2019). https://resources.sei.cmu.edu/library/asset-view.cfm?assetid=636379
Expand Down

0 comments on commit 5b26a14

Please sign in to comment.