Skip to content

Commit caba0b3

Browse files
authored
Merge pull request #8942 from wazuh/enhancement/idr359-update-vuln-detection
added indexer connector configuration
2 parents 9c52e66 + 6ef5811 commit caba0b3

File tree

7 files changed

+105
-252
lines changed

7 files changed

+105
-252
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ All notable changes to this project will be documented in this file.
1010
### Changed
1111

1212
- **Post-release**: Updated the upgrade guide for Wazuh central components. ([#8934](https://github.com/wazuh/wazuh-documentation/pull/8934)) ([#8941](https://github.com/wazuh/wazuh-documentation/pull/8941)) ([#8944](https://github.com/wazuh/wazuh-documentation/pull/8944))
13+
- **Post-release**: Added indexer connector configuration steps to vulnerability detection documentation and removed troubleshooting section. ([#8942](https://github.com/wazuh/wazuh-documentation/pull/8942))
1314

1415
## [v4.13.0]
1516

source/_static/js/redirects.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@ removedUrls['x.y'] = [
6969

7070
/* *** RELEASE 4.13 ****/
7171

72+
removedUrls['4.13'] = [
73+
'/user-manual/capabilities/vulnerability-detection/troubleshooting.html',
74+
'/user-manual/capabilities/vulnerability-detection/FAQ.html',
75+
'/user-manual/capabilities/vulnerability-detection/known-issues.html',
76+
];
77+
7278
/* Pages added in 4.13 */
7379

7480
newUrls['4.13'] = [

source/user-manual/capabilities/vulnerability-detection/FAQ.rst

Lines changed: 0 additions & 102 deletions
This file was deleted.

source/user-manual/capabilities/vulnerability-detection/configuring-scans.rst

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,103 @@ Where:
2424
- ``<index-status>`` enables the indexing of vulnerability inventory data. The default value is ``yes``. The allowed values are ``yes`` and ``no``.
2525
- ``<feed-update-interval>`` specifies the time interval for periodic feed updates. The default value is ``60m`` (one hour), the minimum allowed. The allowed value is a positive number that contains a suffix character indicating a time unit, such as ``s`` (seconds), ``m`` (minutes), ``h`` (hours), and ``d`` (days).
2626

27+
The detected vulnerabilities are forwarded to the Wazuh indexer for querying, visualization, and deeper analysis using the :doc:`indexer connector </user-manual/reference/ossec-conf/indexer>` setting. The indexer connector setting is enabled by default in the ``/var/ossec/etc/ossec.conf`` file of the Wazuh manager.
28+
29+
The indexer connector may be missing if the Wazuh manager is using an old configuration file or if vulnerability detection was disabled during installation. In such cases, follow the steps below to add the indexer connector setting.
30+
31+
#. Add the indexer connector configuration block below to the ``/var/ossec/etc/ossec.conf`` file on the Wazuh manager:
32+
33+
.. code-block:: xml
34+
35+
<indexer>
36+
<enabled>yes</enabled>
37+
<hosts>
38+
<host>https://0.0.0.0:9200</host>
39+
</hosts>
40+
<ssl>
41+
<certificate_authorities>
42+
<ca>/etc/filebeat/certs/root-ca.pem</ca>
43+
</certificate_authorities>
44+
<certificate>/etc/filebeat/certs/filebeat.pem</certificate>
45+
<key>/etc/filebeat/certs/filebeat-key.pem</key>
46+
</ssl>
47+
</indexer>
48+
49+
Ensure:
50+
51+
- The ``<hosts>`` section contains the IP address or hostname of your Wazuh indexer node. You can find this value in the Filebeat configuration file at ``/etc/filebeat/filebeat.yml``.
52+
- The ``<ca>``, ``<certificate>``, and ``<key>`` names match the files located in ``/etc/filebeat/certs/``.
53+
54+
#. If you are running a Wazuh indexer cluster infrastructure, add a ``<host>`` entry for each one of your Wazuh indexer nodes. For example, in a two-node configuration:
55+
56+
.. code-block:: xml
57+
58+
<hosts>
59+
<host>https://10.0.0.1:9200</host>
60+
<host>https://10.0.0.2:9200</host>
61+
</hosts>
62+
63+
The Wazuh server will prioritize reporting to the first Wazuh indexer node in the list and switch to the next available node if the first one becomes unavailable.
64+
65+
#. Save the Wazuh indexer username and password into the Wazuh manager keystore using the :doc:`Wazuh-keystore </user-manual/reference/tools/wazuh-keystore>` tool:
66+
67+
.. code-block:: console
68+
69+
# echo '<WAZUH_INDEXER_USERNAME>' | /var/ossec/bin/wazuh-keystore -f indexer -k username
70+
# echo '<WAZUH_INDEXER_PASSWORD>' | /var/ossec/bin/wazuh-keystore -f indexer -k password
71+
72+
If you have forgotten your Wazuh indexer password, refer to the :doc:`password management guide </user-manual/user-administration/password-management>` to reset it.
73+
74+
#. Run the command below to verify the connection to the Wazuh indexer using the curl command from the Wazuh server. Enter the Wazuh indexer password when prompted:
75+
76+
.. code-block:: console
77+
78+
# curl --cacert <ROOT_CA> --cert <CERTIFICATE_PEM> --key <CERTIFICATE_KEY> -u <WAZUH_INDEXER_USER> -XGET https://<INDEXER_IP_ADDRESS>:9200/_cluster/health
79+
80+
Where:
81+
82+
- ``<ROOT_CA>``, ``<CERTIFICATE_PEM>``, ``<CERTIFICATE_KEY>``: Certificate paths.
83+
- ``<WAZUH_INDEXER_USER>``: Admin username of the Wazuh indexer.
84+
- ``<INDEXER_IP_ADDRESS>``: IP address of the Wazuh indexer.
85+
86+
If this command fails, the vulnerability detector module won't be able to connect to the Wazuh indexer.
87+
88+
To check if the issue is related to certificates, bypass certificate verification using the ``-k`` option. Enter the Wazuh indexer password when prompted:
89+
90+
.. code-block:: console
91+
92+
# curl -k -u <WAZUH_INDEXER_USERNAME> -XGET https://<INDEXER_IP_ADDRESS>:9200/_cluster/health
93+
94+
A successful connection returns a result similar to the following:
95+
96+
.. code-block:: json
97+
98+
{
99+
"cluster_name": "opensearch",
100+
"status": "green",
101+
"timed_out": false,
102+
"number_of_nodes": 1,
103+
"number_of_data_nodes": 1,
104+
"discovered_master": true,
105+
"discovered_cluster_manager": true,
106+
"active_primary_shards": 9,
107+
"active_shards": 9,
108+
"relocating_shards": 0,
109+
"initializing_shards": 0,
110+
"unassigned_shards": 0,
111+
"delayed_unassigned_shards": 0,
112+
"number_of_pending_tasks": 0,
113+
"number_of_in_flight_fetch": 0,
114+
"task_max_waiting_in_queue_millis": 0,
115+
"active_shards_percent_as_number": 100.0
116+
}
117+
118+
#. Restart the Wazuh manager to apply the configuration:
119+
120+
.. code-block:: console
121+
122+
# sudo systemctl restart wazuh-manager
123+
27124
.. note::
28125

29126
To enable vulnerability detection on the Wazuh manager, modify the ``internal_options.conf`` file at ``/var/ossec/etc/internal_options.conf``. Set the parameter ``vulnerability-detection.disable_scan_manager`` from ``1`` to ``0``. This change allows the Vulnerability Detection module to include the Wazuh manager host in its scans. After updating the configuration, restart the Wazuh manager to ensure the changes take effect.

source/user-manual/capabilities/vulnerability-detection/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,4 @@ The Wazuh agent collects a list of installed applications (software inventory da
2121
:maxdepth: 2
2222

2323
how-it-works
24-
configuring-scans
25-
troubleshooting
24+
configuring-scans

source/user-manual/capabilities/vulnerability-detection/known-issues.rst

Lines changed: 0 additions & 133 deletions
This file was deleted.

source/user-manual/capabilities/vulnerability-detection/troubleshooting.rst

Lines changed: 0 additions & 15 deletions
This file was deleted.

0 commit comments

Comments
 (0)