Skip to content
This repository has been archived by the owner on Jun 17, 2023. It is now read-only.
Wes edited this page Jul 2, 2016 · 42 revisions

Getting Started

Current master build status:

Circle CI

QuickStart

This assumes you have a proper Python dev already environment properly configured. If you need help getting started with this, checkout one of our installation guides.

$ tar -zxvf cif-3.x.x.tar.gz
$ cd cif-3.x.x
$ pip install -r requirements.txt
$ python setup.py develop
$ mkdir -p log && cp hacking/develop.conf hacking/local.conf
$ cif-store -d --token-create-admin cif.yml
$ cif-store -d --token-create-hunter cif-router.yml
$ cif-store -d --token-create-smrt csirtg-smrt.yml
$ supervisord -c hacking/local.conf

# new window
$ cif --config cif.yml -p
$ csirtg-smrt --config csirtg-smrt.yml --test -r rules/default/csirtg.yml -d
$ cif --config cif.yml --itype ipv4

Docker

Run

$ docker pull csirtgadgets/cif:latest
$ docker run --name cif -p 5000:5000 csirtgadgets/cif

Configure

  1. find the line that looks like the following:
2016-07-02 13:30:36,617 - INFO - cif.store[187][MainThread] - admin token created: 7f1b141e8c7b36ecb5171543d67d94fade9b7b3993616d7a1351c98d02564418edc39bdebe99f2a8
2016-07-02 13:30:36,618 - INFO - cif.store[295][MainThread] - token config generated: /etc/cif/cif.yml
  1. configure your local ~/.cif.yml with the key:
remote: http://localhost:5000  # if you're running docker on osx with docker-machine, change localhost to the 192.168.99.100 address
token: 7f1b141e8c7b36ecb5171543d67d94fade9b7b3993616d7a1351c98d02564418edc39bdebe99f2a8
  1. install the latest release of the python SDK

Getting Help

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.

Development

Some of the tools we use:

Some useful books:

Clone this wiki locally