diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/README.md | 62 |
1 files changed, 0 insertions, 62 deletions
diff --git a/src/README.md b/src/README.md deleted file mode 100644 index dc5b771..0000000 --- a/src/README.md +++ /dev/null @@ -1,62 +0,0 @@ -# soc_collector -- Gathering vulnerability information and presenting it - -## The oneliner - -The collector answers the fundamental question constantly posed by all -SOC personnel ever: Can I go for lunch now? - -## The elevator pitch - -Your're working as a Security Operations Center engineer and your job -is to, one, know when any part of your infrastructure is vulnerable -and, two, if it is, do something smart about it. - -The collector compiles data from vulnerability scanners and stores it -in a database. You query the collector for the current vulnerability -status of your network infrastructure. - -Without a summary of your vulnerability status and ability to quickly -deepen your knowledge of a given system, your chances of ever eating -lunch with a clear conscience are slim. - -## The user interface - -TODO - -## The gory^Wtechnical details - -TODO - -## The name - -The "soc" part means Security Operations Center. - -The "collector" part is correct but misleading since `soc_collector` -also processes and presents. - -## The license - -This code is licensed under the 2-Clause BSD License, see LICENSE for -the full text. - -## How to test it out - -The collector has been tested on Debian 10 (Buster). Other Unix -systems should be possible to host it as well. - -On a Debian system, first install the dependencies. - - sudo apt install python3 python3-pip python3-leveldb - pip3 install falcon - -Start the demo HTTP server. - - python3 src/wsgi.py - -Submit some data. - - echo '[{"a":"räksmörgås","domain":"foo.se"},{"bar":"Baz"}]' | curl -s -u admin:admin --data-binary @- http://localhost:8000/sc/v0/add - -Get the same data back. - - curl -s -u foo.se: http://localhost:8000/sc/v0/get | json_pp -json_opt utf8,pretty |