Skip to content

Latest commit

 

History

History
538 lines (325 loc) · 22.7 KB

step-by-step.rst

File metadata and controls

538 lines (325 loc) · 22.7 KB
Raw

Install Wazuh components step by step

  1. In the working directory where you placed wazuh-offline.tar.gz and wazuh-install-files.tar, execute the following command to decompress the installation files:

    # tar xf wazuh-offline.tar.gz
# tar xf wazuh-install-files.tar

    You can check the SHA512 of the decompressed package files in wazuh-offline/wazuh-packages/. Find the SHA512 checksums in the /installation-guide/packages-list.

Installing the Wazuh indexer

  1. Run the following commands to install the Wazuh indexer.

    RPM

    # rpm --import ./wazuh-offline/wazuh-files/GPG-KEY-WAZUH
# rpm -ivh ./wazuh-offline/wazuh-packages/wazuh-indexer*.rpm

    DEB

    # dpkg -i ./wazuh-offline/wazuh-packages/wazuh-indexer*.deb

  2. Run the following commands replacing <indexer-node-name> with the name of the Wazuh indexer node you are configuring as defined in config.yml. For example, node-1. This deploys the SSL certificates to encrypt communications between the Wazuh central components.

    # NODE_NAME=<indexer-node-name>
    # mkdir /etc/wazuh-indexer/certs
# mv -n wazuh-install-files/$NODE_NAME.pem /etc/wazuh-indexer/certs/indexer.pem
# mv -n wazuh-install-files/$NODE_NAME-key.pem /etc/wazuh-indexer/certs/indexer-key.pem
# mv wazuh-install-files/admin-key.pem /etc/wazuh-indexer/certs/
# mv wazuh-install-files/admin.pem /etc/wazuh-indexer/certs/
# cp wazuh-install-files/root-ca.pem /etc/wazuh-indexer/certs/
# chmod 500 /etc/wazuh-indexer/certs
# chmod 400 /etc/wazuh-indexer/certs/*
# chown -R wazuh-indexer:wazuh-indexer /etc/wazuh-indexer/certs

    Here you move the node certificate and key files, such as node-1.pem and node-1-key.pem, to their corresponding certs folder. They're specific to the node and are not required on the other nodes. However, note that the root-ca.pem certificate isn't moved but copied to the certs folder. This way, you can continue deploying it to other component folders in the next steps.

  3. Edit /etc/wazuh-indexer/opensearch.yml and replace the following values:

    1. network.host: Sets the address of this node for both HTTP and transport traffic. The node will bind to this address and will also use it as its publish address. Accepts an IP address or a hostname.

      Use the same node address set in config.yml to create the SSL certificates.

    2. node.name: Name of the Wazuh indexer node as defined in the config.yml file. For example, node-1.

    3. cluster.initial_master_nodes: List of the names of the master-eligible nodes. These names are defined in the config.yml file. Uncomment the node-2 and node-3 lines, change the names, or add more lines, according to your config.yml definitions.

      cluster.initial_master_nodes:
- "node-1"
- "node-2"
- "node-3"

    4. discovery.seed_hosts: List of the addresses of the master-eligible nodes. Each element can be either an IP address or a hostname. You may leave this setting commented if you are configuring the Wazuh indexer as a single-node. For multi-node configurations, uncomment this setting and set your master-eligible nodes addresses.

      discovery.seed_hosts:
  - "10.0.0.1"
  - "10.0.0.2"
  - "10.0.0.3"

    5. plugins.security.nodes_dn: List of the Distinguished Names of the certificates of all the Wazuh indexer cluster nodes. Uncomment the lines for node-2 and node-3 and change the common names (CN) and values according to your settings and your config.yml definitions.

      plugins.security.nodes_dn:
- "CN=node-1,OU=Wazuh,O=Wazuh,L=California,C=US"
- "CN=node-2,OU=Wazuh,O=Wazuh,L=California,C=US"
- "CN=node-3,OU=Wazuh,O=Wazuh,L=California,C=US"
  4. Enable and start the Wazuh indexer service.
  5. For multi-node clusters, repeat the previous steps on every Wazuh indexer node.

  6. When all Wazuh indexer nodes are running, run the Wazuh indexer indexer-init.sh script on any Wazuh indexer node to load the new certificates information and start the cluster.

    # bash /usr/share/wazuh-indexer/bin/indexer-init.sh -i <WAZUH_INDEXER_IP_ADDRESS>

  7. Run the following command to check that the installation is successful. Note that this command uses localhost, set your Wazuh indexer address if necessary.

    # curl -XGET https://localhost:9200 -u admin:admin -k

    Expand the output to see an example response.

    {
  "name" : "node-1",
  "cluster_name" : "wazuh-cluster",
  "cluster_uuid" : "095jEW-oRJSFKLz5wmo5PA",
  "version" : {
    "number" : "7.10.2",
    "build_type" : "rpm",
    "build_hash" : "db90a415ff2fd428b4f7b3f800a51dc229287cb4",
    "build_date" : "2023-06-03T06:24:25.112415503Z",
    "build_snapshot" : false,
    "lucene_version" : "9.6.0",
    "minimum_wire_compatibility_version" : "7.10.0",
    "minimum_index_compatibility_version" : "7.0.0"
  },
  "tagline" : "The OpenSearch Project: https://opensearch.org/"
}

Installing the Wazuh server

Installing the Wazuh manager

  1. Run the following commands to import the Wazuh key and install the Wazuh manager.

    RPM

    # rpm --import ./wazuh-offline/wazuh-files/GPG-KEY-WAZUH
# rpm -ivh ./wazuh-offline/wazuh-packages/wazuh-manager*.rpm

    DEB

    # dpkg -i ./wazuh-offline/wazuh-packages/wazuh-manager*.deb
  2. Enable and start the Wazuh manager service.
  3. Run the following command to verify that the Wazuh manager status is active.

  4. Save the Wazuh indexer username and password into the Wazuh manager keystore using the wazuh-keystore tool:

    # /var/ossec/bin/wazuh-keystore -f indexer -k username -v <INDEXER_USERNAME>
# /var/ossec/bin/wazuh-keystore -f indexer -k password -v <INDEXER_PASSWORD>

    Note

    The default offline-installation credentials are admin:admin

Installing Filebeat

Filebeat must be installed and configured on the same server as the Wazuh manager.

  1. Run the following command to install Filebeat.

    RPM

    # rpm -ivh ./wazuh-offline/wazuh-packages/filebeat*.rpm

    DEB

    # dpkg -i ./wazuh-offline/wazuh-packages/filebeat*.deb

  2. Move a copy of the configuration files to the appropriate location. Ensure to type “yes” at the prompt to overwrite /etc/filebeat/filebeat.yml.

    # cp ./wazuh-offline/wazuh-files/filebeat.yml /etc/filebeat/ &&\
cp ./wazuh-offline/wazuh-files/wazuh-template.json /etc/filebeat/ &&\
chmod go+r /etc/filebeat/wazuh-template.json
  3. Edit the /etc/filebeat/filebeat.yml configuration file and replace the following value:

  4. Create a Filebeat keystore to securely store authentication credentials.

    # filebeat keystore create

  5. Add the username and password admin:admin to the secrets keystore.

    # echo admin | filebeat keystore add username --stdin --force
# echo admin | filebeat keystore add password --stdin --force

  6. Install the Wazuh module for Filebeat.

    # tar -xzf ./wazuh-offline/wazuh-files/wazuh-filebeat-0.2.tar.gz -C /usr/share/filebeat/module

  7. Replace <server-node-name> with your Wazuh server node certificate name, the same used in config.yml when creating the certificates. For example, wazuh-1. Then, move the certificates to their corresponding location.

    # NODE_NAME=<server-node-name>
    # mkdir /etc/filebeat/certs
# mv -n wazuh-install-files/$NODE_NAME.pem /etc/filebeat/certs/filebeat.pem
# mv -n wazuh-install-files/$NODE_NAME-key.pem /etc/filebeat/certs/filebeat-key.pem
# cp wazuh-install-files/root-ca.pem /etc/filebeat/certs/
# chmod 500 /etc/filebeat/certs
# chmod 400 /etc/filebeat/certs/*
# chown -R root:root /etc/filebeat/certs
  8. Enable and start the Filebeat service.

  9. Run the following command to make sure Filebeat is successfully installed.

    # filebeat test output

    Expand the output to see an example response.

    elasticsearch: https://127.0.0.1:9200...
  parse url... OK
  connection...
    parse host... OK
    dns lookup... OK
    addresses: 127.0.0.1
    dial up... OK
  TLS...
    security: server's certificate chain verification is enabled
    handshake... OK
    TLS version: TLSv1.3
    dial up... OK
  talk to server... OK
  version: 7.10.2

Your Wazuh server node is now successfully installed. Repeat the steps of this installation process stage for every Wazuh server node in your cluster, expand the Wazuh cluster configuration for multi-node deployment section below, and carry on then with configuring the Wazuh cluster. If you want a Wazuh server single-node cluster, everything is set and you can proceed directly with the Wazuh dashboard installation.

Wazuh cluster configuration for multi-node deployment

After completing the installation of the Wazuh server on every node, you need to configure one server node only as the master and the rest as workers.

Configuring the Wazuh server master node

  1. Edit the following settings in the /var/ossec/etc/ossec.conf configuration file.

  2. Restart the Wazuh manager.

Configuring the Wazuh server worker nodes

  2. Restart the Wazuh manager.

Repeat these configuration steps for every Wazuh server worker node in your cluster.

Testing Wazuh server cluster

To verify that the Wazuh cluster is enabled and all the nodes are connected, execute the following command:

# /var/ossec/bin/cluster_control -l

An example output of the command looks as follows:

NAME         TYPE    VERSION  ADDRESS
master-node  master  |WAZUH_CURRENT|   10.0.0.3
worker-node1 worker  |WAZUH_CURRENT|   10.0.0.4
worker-node2 worker  |WAZUH_CURRENT|   10.0.0.5

Note that 10.0.0.3, 10.0.0.4, 10.0.0.5 are example IPs.

Installing the Wazuh dashboard

  1. Run the following commands to install the Wazuh dashboard.

    RPM

    # rpm --import ./wazuh-offline/wazuh-files/GPG-KEY-WAZUH
# rpm -ivh ./wazuh-offline/wazuh-packages/wazuh-dashboard*.rpm

    DEB

    # dpkg -i ./wazuh-offline/wazuh-packages/wazuh-dashboard*.deb

  2. Replace <dashboard-node-name> with your Wazuh dashboard node name, the same used in config.yml to create the certificates. For example, dashboard. Then, move the certificates to their corresponding location.

    # NODE_NAME=<dashboard-node-name>
    # mkdir /etc/wazuh-dashboard/certs
# mv -n wazuh-install-files/$NODE_NAME.pem /etc/wazuh-dashboard/certs/dashboard.pem
# mv -n wazuh-install-files/$NODE_NAME-key.pem /etc/wazuh-dashboard/certs/dashboard-key.pem
# cp wazuh-install-files/root-ca.pem /etc/wazuh-dashboard/certs/
# chmod 500 /etc/wazuh-dashboard/certs
# chmod 400 /etc/wazuh-dashboard/certs/*
# chown -R wazuh-dashboard:wazuh-dashboard /etc/wazuh-dashboard/certs
  3. Edit the /etc/wazuh-dashboard/opensearch_dashboards.yml file and replace the following values:
    1. server.host: This setting specifies the host of the back end server. To allow remote users to connect, set the value to the IP address or DNS name of the Wazuh dashboard. The value 0.0.0.0 will accept all the available IP addresses of the host.

    2. opensearch.hosts: The URLs of the Wazuh indexer instances to use for all your queries. The Wazuh dashboard can be configured to connect to multiple Wazuh indexer nodes in the same cluster. The addresses of the nodes can be separated by commas. For example, ["https://10.0.0.2:9200", "https://10.0.0.3:9200","https://10.0.0.4:9200"]

      server.host: 0.0.0.0
server.port: 443
opensearch.hosts: https://localhost:9200
opensearch.ssl.verificationMode: certificate
  4. Enable and start the Wazuh dashboard.
  5. Run the following command to verify the Wazuh dashboard service is active.

  6. Access the web interface.

    • URL: https://<wazuh_server_ip>
    • Username: admin
    • Password: admin

    Note

    Upon the first access to the Wazuh dashboard, the browser shows a warning message stating that the certificate was not issued by a trusted authority. An exception can be added in the advanced options of the web browser or, for increased security, the root-ca.pem file previously generated can be imported to the certificate manager of the browser. Alternatively, a certificate from a trusted authority can be configured.

  7. Go to Dashboard management > Server APIs to add a new server API connection. Click on Add API connection button and fill the form with the following values.

image

Securing your Wazuh installation

You have now installed and configured all the Wazuh central components. We recommend changing the default credentials to protect your infrastructure from possible attacks.

Select your deployment type and follow the instructions to change the default passwords for both the Wazuh API and the Wazuh indexer users.

All-in-one deployment

  1. Use the Wazuh passwords tool to change all the internal users passwords.

    # /usr/share/wazuh-indexer/plugins/opensearch-security/tools/wazuh-passwords-tool.sh --change-all --admin-user wazuh --admin-password wazuh
    INFO: The password for user admin is yWOzmNA.?Aoc+rQfDBcF71KZp?1xd7IO
INFO: The password for user kibanaserver is nUa+66zY.eDF*2rRl5GKdgLxvgYQA+wo
INFO: The password for user kibanaro is 0jHq.4i*VAgclnqFiXvZ5gtQq1D5LCcL
INFO: The password for user logstash is hWW6U45rPoCT?oR.r.Baw2qaWz2iH8Ml
INFO: The password for user readall is PNt5K+FpKDMO2TlxJ6Opb2D0mYl*I7FQ
INFO: The password for user snapshotrestore is +GGz2noZZr2qVUK7xbtqjUup049tvLq.
WARNING: Wazuh indexer passwords changed. Remember to update the password in the Wazuh dashboard and Filebeat nodes if necessary, and restart the services.
INFO: The password for Wazuh API user wazuh is JYWz5Zdb3Yq+uOzOPyUU4oat0n60VmWI
INFO: The password for Wazuh API user wazuh-wui is +fLddaCiZePxh24*?jC0nyNmgMGCKE+2
INFO: Updated wazuh-wui user password in wazuh dashboard. Remember to restart the service.

Distributed deployment

  1. On any Wazuh indexer node, use the Wazuh passwords tool to change the passwords of the Wazuh indexer users.

    # /usr/share/wazuh-indexer/plugins/opensearch-security/tools/wazuh-passwords-tool.sh --change-all
    INFO: Wazuh API admin credentials not provided, Wazuh API passwords not changed.
INFO: The password for user admin is wcAny.XUwOVWHFy.+7tW9l8gUW1L8N3j
INFO: The password for user kibanaserver is qy6fBrNOI4fD9yR9.Oj03?pihN6Ejfpp
INFO: The password for user kibanaro is Nj*sSXSxwntrx3O7m8ehrgdHkxCc0dna
INFO: The password for user logstash is nQg1Qw0nIQFZXUJc8r8+zHVrkelch33h
INFO: The password for user readall is s0iWAei?RXObSDdibBfzSgXdhZCD9kH4
INFO: The password for user snapshotrestore is Mb2EHw8SIc1d.oz.nM?dHiPBGk7s?UZB
WARNING: Wazuh indexer passwords changed. Remember to update the password in the Wazuh dashboard and Filebeat nodes if necessary, and restart the services.

  2. On your Wazuh server master node, change the default password of the admin users: wazuh and wazuh-wui. Note that the commands below use localhost, set your Wazuh manager IP address if necessary.

    1. Get an authorization TOKEN.

      # TOKEN=$(curl -u wazuh-wui:wazuh-wui -k -X GET "https://localhost:55000/security/user/authenticate?raw=true")

    2. Change the wazuh user credentials (ID 1). Select a password between 8 and 64 characters long, it should contain at least one uppercase and one lowercase letter, a number, and a symbol. See PUT /security/users/{user_id} <operation/api.controllers.security_controller.update_user> to learn more.

      curl -k -X PUT "https://localhost:55000/security/users/1" -H "Authorization: Bearer $TOKEN" -H 'Content-Type: application/json' -d' 
{
  "password": "SuperS3cretPassword!"
}'
      {"data": {"affected_items": [{"id": 1, "username": "wazuh", "allow_run_as": true, "roles": [1]}], "total_affected_items": 1, "total_failed_items": 0, "failed_items": []}, "message": "User was successfully updated", "error": 0}

    3. Change the wazuh-wui user credentials (ID 2).

      curl -k -X PUT "https://localhost:55000/security/users/2" -H "Authorization: Bearer $TOKEN" -H 'Content-Type: application/json' -d' 
{
  "password": "SuperS3cretPassword!"
}'
      {"data": {"affected_items": [{"id": 2, "username": "wazuh-wui", "allow_run_as": true, "roles": [1]}], "total_affected_items": 1, "total_failed_items": 0, "failed_items": []}, "message": "User was successfully updated", "error": 0}

    See the Securing the Wazuh API </user-manual/api/securing-api> section for additional security configurations.

    Note

    Remember to store these passwords securely.

  3. On all your Wazuh server nodes, run the following command to update the admin password in the Filebeat keystore. Replace <admin-password> with the random password generated in the first step.

    # echo <admin-password> | filebeat keystore add password --stdin --force

  4. Restart Filebeat to apply the change.

    Note

    Repeat steps 3 and 4 on every Wazuh server node.

  5. On your Wazuh dashboard node, run the following command to update the kibanaserver password in the Wazuh dashboard keystore. Replace <kibanaserver-password> with the random password generated in the first step.

    # echo <kibanaserver-password> | /usr/share/wazuh-dashboard/bin/opensearch-dashboards-keystore --allow-root add -f --stdin opensearch.password
  6. Restart the Wazuh dashboard to apply the changes.

  7. On the Wazuh dashboard, go to Dashboard management > Server APIs to update the API host password. Click on the edit button of the secured server API entry and replace the Password field. Then click on the Apply button to save.

    image

Next steps

Once the Wazuh environment is ready, Wazuh agents can be installed on every endpoint to be monitored. To install the Wazuh agents and start monitoring the endpoints, see the Wazuh agent </installation-guide/wazuh-agent/index> installation section. If you need to install them offline, you can check the appropriate agent package to download for your monitored system in the Wazuh agent packages list <wazuh_agent_packages_list> section.

To uninstall all the Wazuh central components, see the /user-manual/uninstall/index section.