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
Travis Master | |
Travis Unstable |
Version | Status | Notes |
---|---|---|
2.4.88 | deprecated | |
2.4.89 | deprecated | |
2.4.90 | deprecated | |
2.4.91 | deprecated | |
2.4.92 | deprecated | |
2.4.93 | current | |
2.4.94 | current | Default Version |
2.4.95 | available but not recommended | MISP Pull mechanism is currently not working. The ticket to that issue can be found here: MISP/MISP#3613 (comment) |
Integrated MISP Modules since 2.4.92:
- pyzmq
- pymisp
- ssdeep
- pydeep
- python-magic
- lief
- maec
See https://github.com/DCSO/MISP-dockerized-server for more details like available and supported tags.
Name | Travis | Commit | Docker Size & Layers | Latest Docker Version |
---|---|---|---|---|
misp-dockerized-proxy | ||||
misp-dockerized-server | ||||
misp-dockerized-robot | ||||
misp-dockerized-postfix | ||||
misp-dockerized-misp-modules |
The following connections must be available for installation:
URL | Direction | Protocol | Destination Port | Notes |
---|---|---|---|---|
https://github.com/DCSO/MISP-dockerized | outgoing | TCP | 443 | DCSO MISP-dockerized Main Repository. |
https://dockerhub.dcso.de/v2/* | outgoing | TCP | 443 | DCSO Docker Registry, if you want to pull the Images from this Registry. |
https://misp.dcso.de/* | outgoing | TCP | 443 | DCSO MISP Instance, only required for DCSO Customers. |
If you want to use the hub.docker.com
public Docker Registry, the following additionall repositories are required:
URL | Direction | Protocol | Destination Port | Notes |
---|---|---|---|---|
https://*.docker.io | outgoing | TCP | 443 | Public Docker Registry, if you want to pull the Images from hub.docker.com. |
https://*.docker.com | outgoing | TCP | 443 | Public Docker Registry, if you want to pull the Images from hub.docker.com. |
If you want to build your Docker Container by yourself, the following additionall repositories are required:
URL | Direction | Protocol | Destination Port | Notes |
---|---|---|---|---|
https://github.com/DCSO/MISP-dockerized-server | outgoing | TCP | 443 | DCSO MISP-dockerized Server Repository. |
https://github.com/DCSO/MISP-dockerized-postfix | outgoing | TCP | 443 | DCSO MISP-dockerized Postfix Repository. |
https://github.com/DCSO/MISP-dockerized-robot | outgoing | TCP | 443 | DCSO MISP-dockerized Robot Repository. |
https://github.com/DCSO/MISP-dockerized-proxy | outgoing | TCP | 443 | DCSO MISP-dockerized Proxy Repository. |
https://github.com/DCSO/MISP-dockerized-misp-modules | outgoing | TCP | 443 | DCSO MISP-dockerized MISP-Modules Repository. |
https://github.com/CybOXProject/python-cybox | outgoing | TCP | 443 | Github Repository for Python-Cybox. |
https://github.com/STIXProject/python-stix | outgoing | TCP | 443 | Github Repository for Python-Stix. |
https://github.com/CybOXProject/mixbox | outgoing | TCP | 443 | Github Repository for Mixbox. |
* The list is not complete. |
We are working on a Kubernetes support, but it will take some time.
For the Installation of MISP dockerized you need at least:
Component | minimum Version |
---|---|
Docker | 17.03.0-ce |
Git | newest Version from Distribution |
$> git clone https://github.com/DCSO/MISP-dockerized.git
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 requirements 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 and build the configuration files and configure the whole environment, simply enter:
$> make install
MISP dockerized comes with a requirements helper script that checks if all components are installed and all requirements are met, e.G. is the user part of the docker group and has the appropriate permission on the github repository folder.
$> make requirements
If you want to do it manual: MISP dockerized comes with a build script that creates all required config files. Simply start:
$> make build-config
The build script downloads our misp-robot and starts him with the internal build script. Therefore you can't find the script directly in the github repository.
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 and running MISP Instance!
Gratulation! Your MISP Environment is deployed!
Now you can setup and configure your MISP Environment as normal.
If you need Help look here: https://www.circl.lu/doc/misp/
Special for Quick Start in MISP: https://www.circl.lu/doc/misp/quick-start/
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:
$> 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
$> make restore
$ systemctl enable docker.service
To delete everything e.g. to start from scratch you can use this:
$> make delete
This delete the MISP images, network, containers and volumes.
Warning
make delete
deletes all volumes, leading to a loss of all your data. Make sure you have saved everything before you run it.
First, create a systemd drop-in directory for the docker service:
$> mkdir /etc/systemd/system/docker.service.d
Now create a file called /etc/systemd/system/docker.service.d/http-proxy.conf that adds the HTTP_PROXY environment variable:
[Service]
Environment="HTTP_PROXY=http://proxy.example.com:80/"
If you have internal Docker registries that you need to contact without proxying you can specify them via the NO_PROXY environment variable:
Environment="HTTP_PROXY=http://proxy.example.com:80/"
Environment="NO_PROXY=localhost,127.0.0.0/8,docker-registry.somecorporation.com"
Flush changes:
$> sudo systemctl daemon-reload
Verify that the configuration has been loaded:
$> sudo systemctl show --property Environment docker
Environment=HTTP_PROXY=http://proxy.example.com:80/
Restart Docker:
$> sudo systemctl restart docker
If was possible, all logfiles are forwarded to docker log mechanism. Therefore you can do:
docker logs -f misp-server
or any other container name.
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 start
. After that restore all your volumes as described at Backup and Recovery
.
To access the container e.g. to change MISP config.php or proxy config, you can use:
docker exec -it dcso/[container] bash
Container variants: misp-robot
misp-server
misp-proxy
(for the ubuntu version only)
For the misp-proxy if you have alpine version:
docker exec -it misp-proxy sh
To Delete all local Images:
docker system prune -a
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
- MISP-Modules
- Wiki
- FAQ's
- 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