2017-11-11 17:18:44 +01:00
|
|
|
INSTALLATION INSTRUCTIONS
|
|
|
|
-------------------------
|
|
|
|
# For Ubuntu 16.04-server with Webmin preinstalled
|
|
|
|
|
|
|
|
# Assuming you created the subdomanin misp.yourserver.tld to where MISP will be installed
|
|
|
|
# and that the user "misp" is in the sudoers group
|
|
|
|
# and that you have already configured SSL with Lets Encrypt on the subdomain
|
|
|
|
|
|
|
|
|
|
|
|
1/ Minimal Ubuntu install
|
|
|
|
-------------------------
|
|
|
|
|
|
|
|
# Login as misp
|
|
|
|
|
|
|
|
# Make sure your system is up2date:
|
|
|
|
sudo apt-get update
|
|
|
|
sudo apt-get upgrade
|
|
|
|
|
|
|
|
|
|
|
|
2/ Install LAMP & dependencies
|
|
|
|
------------------------------
|
|
|
|
Once the system is installed you can perform the following steps:
|
|
|
|
|
|
|
|
# Install the dependencies: (some might already be installed)
|
2018-05-29 14:32:23 +02:00
|
|
|
sudo apt-get install curl gcc git gnupg-agent make python openssl redis-server sudo vim zip python3
|
2017-11-11 17:18:44 +01:00
|
|
|
|
|
|
|
# Stop MySQL and install MariaDB (a MySQL fork/alternative)
|
|
|
|
# MariaDB will replace MySQL and it will work with the latests versions of Webmin without modifications
|
|
|
|
# WARNING: Databases and data may be lost! It is assumed you are installing on a new server with no existing DBs
|
|
|
|
|
|
|
|
sudo service mysql stop
|
|
|
|
sudo apt-get install mariadb-client mariadb-server
|
|
|
|
|
|
|
|
# Secure the MariaDB installation (especially by setting a strong root password)
|
|
|
|
sudo mysql_secure_installation
|
|
|
|
|
|
|
|
|
|
|
|
# Install PHP and dependencies
|
2019-03-15 15:01:12 +01:00
|
|
|
sudo apt-get install libapache2-mod-php php php-cli php-crypt-gpg php-dev php-json php-mysql php-opcache php-readline php-redis php-xml php-gd
|
2017-11-11 17:18:44 +01:00
|
|
|
|
|
|
|
# Apply all changes
|
|
|
|
sudo systemctl restart apache2
|
|
|
|
|
|
|
|
3/ MISP code
|
|
|
|
------------
|
|
|
|
# Assuming you created the subdomanin misp.yourserver.tld
|
|
|
|
# Download MISP using git in the /home/misp/public_html/.
|
|
|
|
|
|
|
|
git clone https://github.com/MISP/MISP.git /home/misp/public_html/MISP
|
|
|
|
cd /home/misp/public_html/MISP
|
|
|
|
git checkout tags/$(git describe --tags `git rev-list --tags --max-count=1`)
|
|
|
|
# if the last shortcut doesn't work, specify the latest version manually
|
|
|
|
# example: git checkout tags/v2.4.XY
|
|
|
|
# the message regarding a "detached HEAD state" is expected behaviour
|
|
|
|
# (you only have to create a new branch, if you want to change stuff and do a pull request for example)
|
|
|
|
|
|
|
|
# Make git ignore filesystem permission differences
|
|
|
|
git config core.filemode false
|
|
|
|
|
|
|
|
# install Mitre's STIX and its dependencies by running the following commands:
|
2018-05-29 14:32:23 +02:00
|
|
|
sudo apt-get install python3-dev python3-pip libxml2-dev libxslt1-dev zlib1g-dev python-setuptools
|
2017-11-11 17:18:44 +01:00
|
|
|
cd /home/misp/public_html/MISP/app/files/scripts
|
|
|
|
git clone https://github.com/CybOXProject/python-cybox.git
|
|
|
|
git clone https://github.com/STIXProject/python-stix.git
|
|
|
|
cd /home/misp/public_html/MISP/app/files/scripts/python-cybox
|
2018-05-29 13:35:50 +02:00
|
|
|
sudo python3 setup.py install
|
2017-11-11 17:18:44 +01:00
|
|
|
cd /home/misp/public_html/MISP/app/files/scripts/python-stix
|
2018-05-29 13:35:50 +02:00
|
|
|
sudo python3 setup.py install
|
2017-11-11 17:18:44 +01:00
|
|
|
|
2018-10-25 11:37:02 +02:00
|
|
|
# install mixbox to accommodate the new STIX dependencies:
|
2017-11-11 17:18:44 +01:00
|
|
|
cd /home/misp/public_html/MISP/app/files/scripts/
|
|
|
|
git clone https://github.com/CybOXProject/mixbox.git
|
|
|
|
cd /home/misp/public_html/MISP/app/files/scripts/mixbox
|
2018-05-29 13:35:50 +02:00
|
|
|
sudo python3 setup.py install
|
2017-11-11 17:18:44 +01:00
|
|
|
|
2018-05-29 14:32:23 +02:00
|
|
|
# install PyMISP
|
|
|
|
cd /var/www/MISP/PyMISP
|
|
|
|
sudo python3 setup.py install
|
|
|
|
|
|
|
|
|
2017-11-11 17:18:44 +01:00
|
|
|
4/ CakePHP
|
|
|
|
-----------
|
|
|
|
# CakePHP is included as a submodule of MISP, execute the following commands to let git fetch it:
|
|
|
|
cd /home/misp/public_html/MISP
|
|
|
|
git submodule init
|
|
|
|
git submodule update
|
|
|
|
|
|
|
|
# Once done, install CakeResque along with its dependencies if you intend to use the built in background jobs:
|
|
|
|
cd /home/misp/public_html/MISP/app
|
|
|
|
php composer.phar require kamisama/cake-resque:4.1.2
|
|
|
|
php composer.phar config vendor-dir Vendor
|
|
|
|
php composer.phar install
|
|
|
|
|
|
|
|
# Enable CakeResque with php-redis
|
|
|
|
sudo phpenmod redis
|
|
|
|
|
|
|
|
# To use the scheduler worker for scheduled tasks, do the following:
|
|
|
|
cp -fa /home/misp/public_html/MISP/INSTALL/setup/config.php /home/misp/public_html/MISP/app/Plugin/CakeResque/Config/config.php
|
|
|
|
|
|
|
|
|
|
|
|
5/ Set the permissions
|
|
|
|
----------------------
|
|
|
|
|
|
|
|
# Check if the permissions are set correctly using the following commands:
|
|
|
|
sudo chmod -R 750 /home/misp/public_html/MISP
|
|
|
|
sudo chmod -R g+ws /home/misp/public_html/MISP/app/tmp
|
|
|
|
sudo chmod -R g+ws /home/misp/public_html/MISP/app/files
|
|
|
|
sudo chmod -R g+ws /home/misp/public_html/MISP/app/files/scripts/tmp
|
|
|
|
|
|
|
|
|
|
|
|
6/ Create a database and user
|
|
|
|
-----------------------------
|
|
|
|
# Enter the mysql shell
|
|
|
|
sudo mysql -u root -p
|
|
|
|
|
|
|
|
MariaDB [(none)]> create database misp;
|
|
|
|
MariaDB [(none)]> grant usage on *.* to misp@localhost identified by 'XXXXdbpasswordhereXXXXX';
|
|
|
|
MariaDB [(none)]> grant all privileges on misp.* to misp@localhost;
|
|
|
|
MariaDB [(none)]> flush privileges;
|
|
|
|
MariaDB [(none)]> exit
|
|
|
|
|
|
|
|
# Import the empty MISP database from MYSQL.sql
|
|
|
|
sh -c "mysql -u misp -p misp < /home/misp/public_html/MISP/INSTALL/MYSQL.sql"
|
|
|
|
# enter the password you set previously
|
|
|
|
|
|
|
|
|
|
|
|
7/ Apache configuration
|
|
|
|
-----------------------
|
|
|
|
# Most of it should have been done when you created the subdomain but add these changes as well
|
|
|
|
|
|
|
|
|
|
|
|
# Under <VirtualHost <IP, FQDN, or *>:80>
|
|
|
|
# ServerName <your.FQDN.here>
|
|
|
|
# add
|
|
|
|
|
|
|
|
Redirect permanent / https://<your.FQDN.here>
|
|
|
|
ServerSignature Off
|
|
|
|
|
|
|
|
# Closing tag </VirtualHost>
|
|
|
|
|
|
|
|
|
|
|
|
# Under <VirtualHost <IP, FQDN, or *>:443>
|
|
|
|
# ServerAdmin admin@<your.FQDN.here>
|
|
|
|
# ServerName <your.FQDN.here>
|
|
|
|
# etc...
|
|
|
|
# find the document root and change it as follows
|
|
|
|
|
|
|
|
DocumentRoot /home/misp/public_html/MISP/app/webroot
|
|
|
|
|
|
|
|
# The Directory tag should be changed to:
|
|
|
|
|
|
|
|
<Directory /home/misp/public_html/MISP/app/webroot>
|
|
|
|
|
|
|
|
# The rest should't require modifications. Restart Apache
|
|
|
|
|
|
|
|
sudo service apache2 restart
|
|
|
|
|
|
|
|
9/ MISP configuration
|
|
|
|
---------------------
|
|
|
|
# There are 4 sample configuration files in /home/misp/public_html/MISP/app/Config that need to be copied
|
|
|
|
cp -a /home/misp/public_html/MISP/app/Config/bootstrap.default.php /home/misp/public_html/MISP/app/Config/bootstrap.php
|
|
|
|
cp -a /home/misp/public_html/MISP/app/Config/database.default.php /home/misp/public_html/MISP/app/Config/database.php
|
|
|
|
cp -a /home/misp/public_html/MISP/app/Config/core.default.php /home/misp/public_html/MISP/app/Config/core.php
|
|
|
|
cp -a /home/misp/public_html/MISP/app/Config/config.default.php /home/misp/public_html/MISP/app/Config/config.php
|
|
|
|
|
|
|
|
# Configure the fields in the newly created files:
|
|
|
|
vim /home/misp/public_html/MISP/app/Config/database.php
|
|
|
|
# DATABASE_CONFIG has to be filled
|
|
|
|
# With the default values provided in section 6, this would look like:
|
|
|
|
# class DATABASE_CONFIG {
|
|
|
|
# public $default = array(
|
|
|
|
# 'datasource' => 'Database/Mysql',
|
|
|
|
# 'persistent' => false,
|
|
|
|
# 'host' => 'localhost',
|
|
|
|
# 'login' => 'misp', // grant usage on *.* to misp@localhost
|
|
|
|
# 'port' => 3306,
|
|
|
|
# 'password' => 'XXXXdbpasswordhereXXXXX', // identified by 'XXXXdbpasswordhereXXXXX';
|
|
|
|
# 'database' => 'misp', // create database misp;
|
|
|
|
# 'prefix' => '',
|
|
|
|
# 'encoding' => 'utf8',
|
|
|
|
# );
|
|
|
|
#}
|
|
|
|
|
|
|
|
# Important! Change the salt key in /var/www/MISP/app/Config/config.php
|
|
|
|
# The salt key must be a string at least 32 bytes long.
|
|
|
|
# The admin user account will be generated on the first login, make sure that the salt is changed before you create that user
|
|
|
|
# If you forget to do this step, and you are still dealing with a fresh installation, just alter the salt,
|
|
|
|
# delete the user from mysql and log in again using the default admin credentials (admin@admin.test / admin)
|
|
|
|
|
|
|
|
# Change base url in config.php
|
|
|
|
vim /home/misp/public_html/MISP/app/Config/config.php
|
|
|
|
# example: 'baseurl' => 'https://<your.FQDN.here>',
|
|
|
|
# alternatively, you can leave this field empty if you would like to use relative pathing in MISP
|
|
|
|
# 'baseurl' => '',
|
|
|
|
# 'email' => 'anemail@yourdomain.tld, set an email address that will be used for gpg
|
|
|
|
|
|
|
|
# and make sure the file permissions are still OK
|
|
|
|
chmod -R 750 /home/misp/public_html/MISP/app/Config
|
|
|
|
|
|
|
|
# Generate a GPG encryption key.
|
|
|
|
mkdir /home/misp/public_html/MISP/.gnupg
|
|
|
|
chmod 700 /home/misp/public_html/MISP/.gnupg
|
|
|
|
|
|
|
|
|
|
|
|
# If you get no satisfaction with your entropy install this:
|
|
|
|
sudo apt-get install haveged pv
|
|
|
|
|
|
|
|
#Generate entropy for the next step, open a new shell and run the following command:
|
|
|
|
haveged -n 0 | pv > /dev/null
|
|
|
|
|
|
|
|
# It should start saying something like "Writing unlimited bytes to stdout"
|
|
|
|
# let it run and go back to the previous shell
|
|
|
|
|
|
|
|
gpg --homedir /home/misp/public_html/MISP/.gnupg --gen-key
|
|
|
|
# The email address should match the one set in the config.php / set in the configuration menu in the administration menu configuration file
|
|
|
|
|
|
|
|
# You can now Ctrel+C the running haveged in the other shell
|
|
|
|
# and return to the "install" shell
|
|
|
|
|
|
|
|
# Export the public key to the webroot
|
|
|
|
sh -c "gpg --homedir /home/misp/public_html/MISP/.gnupg --export --armor YOUR-KEYS-EMAIL-HERE > /home/misp/public_html/MISP/app/webroot/gpg.asc"
|
|
|
|
|
|
|
|
# To make the background workers start on boot
|
|
|
|
chmod +x /home/misp/public_html/MISP/app/Console/worker/start.sh
|
|
|
|
sudo vim /etc/rc.local
|
|
|
|
# Add the following line before the last line (exit 0). Make sure that you replace www-data with your apache user:
|
|
|
|
sudo -u www-data bash /home/misp/public_html/MISP/app/Console/worker/start.sh
|
|
|
|
|
|
|
|
# Now log in using the webinterface:
|
|
|
|
# The default user/pass = admin@admin.test/admin
|
|
|
|
|
|
|
|
# Using the server settings tool in the admin interface (Administration -> Server Settings), set MISP up to your preference
|
|
|
|
# It is especially vital that no critical issues remain!
|
|
|
|
# start the workers by navigating to the workers tab and clicking restart all workers
|
|
|
|
|
|
|
|
# Don't forget to change the email, password and authentication key after installation.
|
|
|
|
|
|
|
|
# Once done, have a look at the diagnostics
|
|
|
|
|
|
|
|
# If any of the directories that MISP uses to store files is not writeable to the apache user, change the permissions
|
|
|
|
# you can do this by running the following commands:
|
|
|
|
|
|
|
|
sudo chmod -R 750 /home/misp/public_html/MISP/<directory path with an indicated issue>
|
|
|
|
sudo chown -R misp:misp /home/misp/public_html/MISP/<directory path with an indicated issue>
|
|
|
|
|
|
|
|
# Make sure that the STIX libraries and GnuPG work as intended, if not, refer to INSTALL.txt's paragraphs dealing with these two items
|
|
|
|
|
|
|
|
# If anything goes wrong, make sure that you check MISP's logs for errors:
|
|
|
|
# /home/misp/public_html/MISP/app/tmp/logs/error.log
|
|
|
|
# /home/misp/public_html/MISP/app/tmp/logs/resque-worker-error.log
|
|
|
|
# /home/misp/public_html/MISP/app/tmp/logs/resque-scheduler-error.log
|
|
|
|
# /home/misp/public_html/MISP/app/tmp/logs/resque-2015-01-01.log // where the actual date is the current date
|
|
|
|
|
|
|
|
|
|
|
|
Recommended actions
|
|
|
|
-------------------
|
|
|
|
- By default CakePHP exposes its name and version in email headers. Apply a patch to remove this behavior.
|
|
|
|
|
|
|
|
- You should really harden your OS
|
|
|
|
- You should really harden the configuration of Apache
|
|
|
|
- You should really harden the configuration of MySQL/MariaDB
|
|
|
|
- Keep your software up2date (OS, MISP, CakePHP and everything else)
|
|
|
|
- Log and audit
|
|
|
|
|
|
|
|
|
|
|
|
Optional features
|
2018-05-07 06:11:16 +02:00
|
|
|
-----------------
|
2017-11-11 17:18:44 +01:00
|
|
|
# MISP has a new pub/sub feature, using ZeroMQ. To enable it, simply run the following command
|
|
|
|
sudo pip install pyzmq
|
|
|
|
# ZeroMQ depends on the Python client for Redis
|
|
|
|
sudo pip install redis
|
2018-05-07 06:11:16 +02:00
|
|
|
|
2019-03-05 12:24:56 +01:00
|
|
|
# MISP has a feature for publishing events to Kafka. To enable it, simply run the following commands
|
|
|
|
apt-get install librdkafka-dev php-dev
|
|
|
|
pecl install rdkafka
|
|
|
|
find /etc -name php.ini | while read f; do echo 'extension=rdkafka.so' | tee -a "$f"; done
|
|
|
|
|
2018-05-07 06:11:16 +02:00
|
|
|
# For the experimental ssdeep correlations, run the following installation:
|
|
|
|
# installing ssdeep
|
|
|
|
wget http://downloads.sourceforge.net/project/ssdeep/ssdeep-2.13/ssdeep-2.13.tar.gz
|
|
|
|
tar zxvf ssdeep-2.13.tar.gz
|
|
|
|
cd ssdeep-2.13
|
|
|
|
./configure
|
|
|
|
make
|
|
|
|
sudo make install
|
|
|
|
ssdeep -h # test
|
|
|
|
|
|
|
|
#installing ssdeep_php
|
|
|
|
sudo pecl install ssdeep
|
|
|
|
|
|
|
|
# You should add "extension=ssdeep.so" to mods-available - Check /etc/php for your current version
|
|
|
|
echo "extension=ssdeep.so" | sudo tee /etc/php/7.2/mods-available/ssdeep.ini
|
|
|
|
sudo phpenmod ssdeep
|
|
|
|
sudo service apache2 restart
|
|
|
|
|
|
|
|
Optional features: misp-modules
|
|
|
|
-------------------------------
|
|
|
|
# If you want to add the misp modules functionality, follow the setup procedure described in misp-modules:
|
|
|
|
# https://github.com/MISP/misp-modules#how-to-install-and-start-misp-modules
|
|
|
|
# Then the enrichment, export and import modules can be enabled in MISP via the settings.
|