Getting Started

THIS IS A TECHNICAL PREVIEW, MANY THINGS MAY NOT WORK CORRECTLY

We GLADLY ACCEPT PULL REQUESTS- GET CREDIT FOR YOUR WORK!

$ docker pull csirtgadgets/verbose-robot
$ export CIF_TOKEN=`head -n 25000 /dev/urandom | openssl dgst -sha256`
$ docker run -e CIF_TOKEN="${CIF_TOKEN}" -it -d -p 5000:5000 --name verbose-robot csirtgadgets/verbose-robot
$ docker exec -it verbose-robot /bin/bash
$ cif -d -p
$ env | grep CIF_TOKEN

Are you getting value from CIF?

Did you learn something new? Something that would have taken you weeks or months to learn on your own?

Design Goals

• Performance (Leaner, Faster).
• Cleaner, Concise APIs, Platform Driven
• Realtime Streaming and Correlation (PUB/SUB/WebSockets)
• Machine Learning Integration (SKLearn|TensorFlow)
• Statistical Probability/Confidence Model
• Native CSIRTG-X Integration
• WebHooks Support (Slack)
• Graph Support (networkx)

Getting Help

• the Wiki
• Known Issues
• FAQ

Getting Involved

There are many ways to get involved with the project. If you have a new and exciting feature, or even a simple bugfix, simply fork the repo, create some simple test cases, generate a pull-request and give yourself credit!

If you've never worked on a GitHub project, this is a good piece for getting started.

• How To Contribute
• Project Page

COPYRIGHT AND LICENSE

Copyright (C) 2018 the CSIRT Gadgets

Free use of this software is granted under the terms of the Mozilla Public License (MPLv2).