Go to file
Hannah Ward a69f5506a9
fix: Typo in script name
2017-03-31 10:33:15 +01:00
OpenTAXII@257df63942 fix: Update opentaxii version 2017-03-29 11:57:49 +01:00
config fix: Update opentaxii version 2017-03-29 11:57:49 +01:00
misp_taxii_hooks fix: Removed duplicate checking - sometimes it just wouldn't upload 2017-01-16 16:10:46 +00:00
scripts new: Push to one or many collections 2017-03-31 10:24:32 +01:00
tests Squashed commit of the following: 2016-11-19 15:42:54 +00:00
.gitignore 2 way comms achieved! 2016-12-28 10:51:43 +00:00
.gitmodules Added base configuration files 2016-11-18 09:28:00 +00:00
.travis.yml fix: This time misp won't kill itself for low memory ;) 2017-01-13 14:08:41 +00:00
LICENSE Added readme 2016-11-18 11:57:01 +00:00
README.md Updated readme 2016-12-28 10:53:45 +00:00
setup.py fix: Typo in script name 2017-03-31 10:33:15 +01:00

README.md

MISP Taxii Server

Build Status

A set of configuration files to use with EclecticIQ's OpenTAXII implementation, along with a callback for when data is sent to the TAXII Server's inbox.

Installation

Download the repository with

git clone --recursive https://github.com/MISP/MISP-Taxii-Server

This will also download the OpenTAXII Server, which you should install with

cd OpenTAXII
sudo python3 setup.py install

You'll then need to set up your TAXII database. As you're using MISP, you'll likely already have a MySQL environment running.

Run the following commands to create your databases

mysql -u [database user] -p
# Enter Database password

mysql> create database taxiiauth;

mysql> create database taxiipersist;

mysql> grant all on taxiiauth.* to 'taxii'@'%' identified by 'some_password';

mysql> grant all on taxiipersist.* to 'taxii'@'%' identified by 'some_password';

mysql> exit;

Now, with that data edit config.yaml, and edit the db_connection parameters to match your environment. Change auth_api -> parameters -> secret whilst you're here as well.

If you wish, you can edit the taxii service definitions in services.yaml, or the collections to be created in collections.yaml; full documentation on how this is set up is available at OpenTaxii's docs.

Now it's time to create all your SQL tables. Luckily OpenTaxii comes with commands for this.

You're going to want to export your configuration file to a variable as well.

# An example of this config is in the config directory
export OPENTAXII_CONFIG=/path/to/config.yaml

opentaxii-create-services -c config/services.yaml
opentaxii-create-collections -c config/collections.yaml

# Create a user account
# Set the username and password to whatever you want
opentaxii-create-account -u root -p root

OpenTaxii is now ready to roll, we've just gotta do one or two more things.

Edit misp_taxii_hooks/hooks.py and add your MISP server's URL and API key.

Then, in the repository root directory, run

sudo python3 setup.py install

This will install the TAXII hooks to run when we have new data.

Now we should be ready to go!

opentaxii-run-dev

This should tell you that there is now a server running on localhost:9000 (maybe a different port if you changed it). If there are no errors, you're good!

If you want to test everything is working, run

taxii-push --path http://localhost:9000/services/inbox -f stix_sample.xml \
           --dest collection --username root --password root

Obviously replace anything that differs in your system.

The client should say "Content Block Pushed Succesfully" if all went well.

Now you have a TAXII server hooked up to MISP, you're able to send STIX files to the inbox and have them uploaded directly to MISP. So that's nice <3

There is also an experimental feature to push MISP events to the TAXII server when they're published - that's in scripts/push_published_to_taxii.py. It seems to work, but may occasionally re-upload duplicate events to MISP.

Planned features

  • Duplicate Detection