MISP dockerized is a project designed to provide an easy-to-use and easy-to-install'out of the box' MISP instance that includes everything you need to run MISP with minimal host-side requirements.
MISP dockerized uses MISP (Open Source Threat Intelligence Platform - https://github.com/MISP/MISP), which is maintend and developed by the MISP project team (https://www.misp-project.org/)
THIS PROJECT IS IN BETA PHASE
For the Installation of MISP dockerized you need at least:
Component | least Version |
---|---|
Docker | 17.03.0-ce |
Docker-compose* | 1.13.1+ |
Git | newest Version from Distribution |
*We need at lest docker-compose file version 3.1: https://docs.docker.com/compose/compose-file/#compose-and-docker-compatibility-matrix
For the Installation the followed Connections need to available:
URL | Direction | Protocol | Destination Port |
---|---|---|---|
hub.docker.com | outgoing | TCP | 443 |
github.com* | outgoing | TCP | 443 |
*if you want to use ssh or git protocol you need the following ports for github.com:
- ssh:// - default port 22
- git:// - default port 9418
- http:// - default port 80
- https:// - default port 443
This contains:
- all required docker container
- misp-redis
- based on official redis
- misp-db
- based on official mariadb
- misp-proxy
- based on ubuntu:16.04
- misp-server
- based on ubuntu:16.04
- misp-robot
- based on ubuntu:16.04
- misp-redis
This contains:
- scripts
- tools
- dockerfile to manually build docker container without docker registry
After cloning the repository change the branch to the required, for example:
$> git clone https://github.com/DCSO/MISP-dockerized.git && git checkout 2.4.88
MISP dockerized comes with a build script that creates all required config files. Simply start:
$> make build-config
Before you start the container, you have to setup the TLS certificates and the Diffie-Hellman file.
Please make sure that the certificate and key are in PEM-Format - recognizable in the first line:
"-----BEGIN CERTIFICATE-----"
or
"-----BEGIN RSA PRIVATE KEY-----"
when opening it in an editor like 'vim' or 'nano'
If all prerequsites are fulfilled, you can deploy them as follows:
- Copy the Certificate Key File to
./config/ssl/key.pem
- Copy the Certificate Chain file to
./config/ssl/cert.pem
- (OPTIONAL) During installation Diffie-Hellman Params will be freshly build, but if you still want to create them yourself, use the following command 1 or copy your existing one to
./config/ssl/dhparams.pem
To start the deployment process, simply enter:
$> make deploy
After deployment, you now have a simple basic MISP installation without any further configuration. To configure the instance with all specified parameters, use the following command:
$> make configure
After these step, you now should have a configured running MISP Instance!
To back up your instance, MISP dockerized comes with a backup and restore script that will do the job for you. To create a backup start:
$> ./scripts/backup_restore backup [service]
or
$> make backup-[service] for example: make backup-all
[service]
is the service you want to create a backup. you can chose between redis|mysql|server|proxy|all
Works similar to the backup process. Just run the backup and restore script
$> ./scripts/backup_restore restore
or
$> make restore
$ systemctl enable docker.service
If you want to rebuild all containers e.g. if you change the docker-compose file, you can do this with make
&> make rebuild
To delete everything e.g. to start from scratch you can use this:
&> make delete
Warning
make delete
and make rebuild
delete all volumes, leading to a loss of all your data. Make sure you have saved everything before you run it.
If you want to start from scratch or reinitialse your MISP instance, make sure you have delete everything. Clone the repository and start the container deployment with make install
. After that restore all your volumes as described at Backup and Recovery
and restart your container with
$> docker-compose restart misp-server misp-redis misp-db misp-proxy
To access the container e.g. to change MISP config.php or proxy config, you can use:
docker exec -it [container] bin/bash/
To Delete all local Images:
docker rmi $(docker images -q)
To delete only all non-tagged (dangling) Images:
docker rmi $(docker images -f "dangling=true" -q)
List Logs
docker logs -f misp-server
Currently the following things are not yet implemented but are planned
- GnuPG Support
- Postfix
- MISP-Modules
- https://mariadb.com/kb/en/library/installing-and-using-mariadb-via-docker/
- https://hub.docker.com/r/_/mariadb/
This software is released under a BSD 3-Clause license. Please have a look at the LICENSE file included in the repository.
Copyright (c) 2018, DCSO Deutsche Cyber-Sicherheitsorganisation GmbH