This is the documentation for Wazuh 3.1. Check out the docs for the latest version of Wazuh!

Install Elastic Stack with Debian packages

The DEB package is suitable for Debian, Ubuntu and other Debian-based systems.

Note

Many of the commands described below need to be executed with root user privileges.

Preparation

  1. Oracle Java JRE is required by Logstash and Elasticsearch:
  1. For Debian:
# echo "deb http://ppa.launchpad.net/webupd8team/java/ubuntu xenial main" | tee /etc/apt/sources.list.d/webupd8team-java.list
# echo "deb-src http://ppa.launchpad.net/webupd8team/java/ubuntu xenial main" | tee -a /etc/apt/sources.list.d/webupd8team-java.list
# apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys EEA14886
  1. For Ubuntu:
# add-apt-repository ppa:webupd8team/java
  1. Once the repository is added, install Java JRE:
# apt-get update
# apt-get install oracle-java8-installer
  1. Install the Elastic repository and its GPG key:
# apt-get install curl apt-transport-https
# curl -s https://artifacts.elastic.co/GPG-KEY-elasticsearch | apt-key add -
# echo "deb https://artifacts.elastic.co/packages/6.x/apt stable main" | tee /etc/apt/sources.list.d/elastic-6.x.list
# apt-get update

Elasticsearch

Elasticsearch is a highly scalable full-text search and analytics engine. For more information, please see Elasticsearch.

  1. Install the Elasticsearch package:
# apt-get install elasticsearch=6.1.3
  1. Enable and start the Elasticsearch service:
  1. For Systemd:
# systemctl daemon-reload
# systemctl enable elasticsearch.service
# systemctl start elasticsearch.service
  1. For SysV Init:
# update-rc.d elasticsearch defaults 95 10
# service elasticsearch start
  1. Load Wazuh Elasticsearch templates:
# curl https://raw.githubusercontent.com/wazuh/wazuh/3.1/extensions/elasticsearch/wazuh-elastic6-template-alerts.json | curl -XPUT 'http://localhost:9200/_template/wazuh' -H 'Content-Type: application/json' -d @-
# curl https://raw.githubusercontent.com/wazuh/wazuh/3.1/extensions/elasticsearch/wazuh-elastic6-template-monitoring.json | curl -XPUT 'http://localhost:9200/_template/wazuh-agent' -H 'Content-Type: application/json' -d @-
  1. Insert the sample alert:
# curl https://raw.githubusercontent.com/wazuh/wazuh/3.1/extensions/elasticsearch/alert_sample.json | curl -XPUT "http://localhost:9200/wazuh-alerts-3.x-"`date +%Y.%m.%d`"/wazuh/sample" -H 'Content-Type: application/json' -d @-

Note

It is recommended that the default configuration be edited to improve the performance of Elasticsearch. To do so, please see Elasticsearch tuning.

Logstash

Logstash is the tool that collects, parses, and forwards data to Elasticsearch for indexing and storage of all logs generated by the Wazuh server. For more information please see Logstash.

  1. Install the Logstash package:
# apt-get install logstash=1:6.1.3-1
  1. Download the Wazuh configuration file for Logstash:
  1. Local configuration (only in a single-host architecture):
# curl -so /etc/logstash/conf.d/01-wazuh.conf https://raw.githubusercontent.com/wazuh/wazuh/3.1/extensions/logstash/01-wazuh-local.conf

Because the Logstash user needs to read the alerts.json file, please add it to OSSEC group by running:

# usermod -a -G ossec logstash
  1. Remote configuration (only in a distributed architecture):
# curl -so /etc/logstash/conf.d/01-wazuh.conf https://raw.githubusercontent.com/wazuh/wazuh/3.1/extensions/logstash/01-wazuh-remote.conf
  1. Enable and start the Logstash service:
  1. For Systemd:
# systemctl daemon-reload
# systemctl enable logstash.service
# systemctl start logstash.service
  1. For SysV Init:
# update-rc.d logstash defaults 95 10
# service logstash start

Note

If you are running Wazuh server and the Elastic Stack server on separate systems (distributed architecture), it is important to configure encryption between Filebeat and Logstash. To do so, please see Setting up SSL for Filebeat and Logstash.

Kibana

Kibana is a flexible and intuitive web interface for mining and visualizing the events and archives stored in Elasticsearch. Find more information at Kibana.

  1. Install the Kibana package:
# apt-get install kibana=6.1.3
  1. Install the Wazuh App plugin for Kibana:

a) Increase the default Node.js heap memory limit to prevent out of memory errors when installing the Wazuh App. Set the limit as follows:

# export NODE_OPTIONS="--max-old-space-size=3072"
  1. Install the Wazuh App:
# /usr/share/kibana/bin/kibana-plugin install https://packages.wazuh.com/wazuhapp/wazuhapp.zip

Warning

The Kibana plugin installation process may take several minutes. Please wait patiently.

Note

If you want to download a different Wazuh App plugin for another version of Wazuh or the Elastic Stack, check the table available at GitHub and use the appropriate installation command.

  1. Optional. Kibana will only listen on the loopback interface (localhost) by default. To set up Kibana to listen on all interfaces, edit the file /etc/kibana/kibana.yml uncommenting the setting server.host. Change the value to:
server.host: "0.0.0.0"

Note

It is recommended that an Nginx proxy be set up for Kibana in order to use SSL encryption and to enable authentication. Instructions to set up the proxy can be found at Setting up SSL and authentication for Kibana.

  1. Enable and start the Kibana service:
  1. For Systemd:
# systemctl daemon-reload
# systemctl enable kibana.service
# systemctl start kibana.service
  1. For SysV Init:
# update-rc.d kibana defaults 95 10
# service kibana start
  1. Disable the Elasticsearch repository:

It is recommended that the Elasticsearch repository be disabled in order to prevent an upgrade to a newer Elastic Stack version due to the possibility of undoing changes with the App. To do this, use the following command:

# sed -i -r '/deb https:\/\/artifacts.elastic.co\/packages\/6.x\/apt stable main/ s/^(.*)$/#\1/g' /etc/apt/sources.list.d/elastic-6.x.list

Connecting the Wazuh App with the API

Follow the next guide in order to connect the Wazuh App with the API: