Skip to content

Commit a6b1166

Browse files
committed
Add adjustments to Data analysis documentation
1 parent fa0ea3d commit a6b1166

File tree

13 files changed

+54
-33
lines changed

13 files changed

+54
-33
lines changed
147 KB
Loading
150 KB
Loading
38 KB
Loading
25.4 KB
Loading
-183 KB
Loading

source/user-manual/ruleset/decoders/custom.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,9 @@ Check out this example on how to create new decoders and rules. The following lo
6868
Modify default decoders
6969
-----------------------
7070

71-
To modify a default decoder, you can rewrite its file in the ``/var/ossec/etc/decoders/`` directory on the Wazuh server, make the changes, and exclude the original decoder file from the loading list.
71+
Default decoders may not parse custom or non-standard log formats correctly, so modifying them ensures accurate analysis for your specific environment.
72+
73+
To modify a default decoder, you can rewrite its file in the ``/var/ossec/etc/decoders/`` directory on the Wazuh server, make the changes, and exclude the original decoder file from the loading list. This approach avoids editing core files, preventing conflicts during Wazuh updates, and allows tailored log processing to extract specific fields or handle unique application logs effectively.
7274

7375
For example, if you want to customize decoders in the ``/var/ossec/ruleset/decoders/0310-ssh_decoders.xml`` file, follow these steps:
7476

source/user-manual/ruleset/decoders/json-decoder.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Suricata event log:
5858
"host": "suricata.com"
5959
}
6060
61-
The JSON decoder extracts each field from the JSON log data for comparison against the rules, eliminating the need for a specific Suricata decoder.
61+
The JSON decoder extracts each field from the JSON log data for comparison against the rules, eliminating the need for a specific Suricata decoder. Ensure to convert the multiline JSON log above to single-line, just as seen from the output below.
6262

6363
We can now run the ``/var/ossec/bin/wazuh-logtest`` tool on the Wazuh server to test the log sample and have insights into the current decoding.
6464

source/user-manual/ruleset/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Below, we show the structure of the ruleset directory on the Wazuh server:
3434
└─ rules/
3535
3636
.. note::
37-
37+
3838
You can find all the out-of-the-box rules and decoders inside the ``/var/ossec/ruleset/ directory``. All files within this directory are overwritten or modified during the Wazuh upgrade process. Therefore, we do not recommend editing or adding your custom files here. Instead, we recommend making custom changes in the ``/var/ossec/etc/`` directory. Here, you can add your own decoders and rules files or use the default ``/var/ossec/etc/decoders/local_decoder.xml`` and ``/var/ossec/etc/rules/local_rules.xml`` files.
3939

4040
GitHub repository
@@ -50,7 +50,7 @@ In the repository, you will find:
5050

5151
- **Tools**
5252

53-
We provide useful tools such as the `wazuh-logtest </user-manual/reference/tools/wazuh-logtest>`__, which allows for testing rules and decoders before using them. This tool processes only log per line and is available in ``/var/ossec/bin/wazuh-logtest`` on the Wazuh server, along with various other binaries which help in managing the Wazuh server and agents. For more information you can take a look at `Wazuh tools </user-manual/reference/tools/index>`__ documentation.
53+
We provide useful tools such as the :doc:`wazuh-logtest </user-manual/reference/tools/wazuh-logtest>`, which allows for testing rules and decoders before using them. This tool processes only one-liner (no line breaks) logs and is available in ``/var/ossec/bin/wazuh-logtest`` on the Wazuh server, along with various other binaries which help in managing the Wazuh server and agents. For more information you can take a look at :doc:`Wazuh tools </user-manual/reference/tools/index>` documentation.
5454

5555
.. topic:: Content
5656

source/user-manual/ruleset/mitre.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
33
.. meta::
44
:description: The Wazuh integration with MITRE ATT&CK framework allows users to map alerts generated by Wazuh to specific tactics and techniques. Learn more in this section of the documentation.
5-
5+
66
MITRE ATT&CK framework
77
======================
88

@@ -47,6 +47,12 @@ Dashboard
4747

4848
The **MITRE ATT&CK Dashboard** tab provides an overview of the current state of your infrastructure with respect to known adversarial Tactics, Techniques, and Procedures (TTPs) in the MITRE ATT&CK framework. The dashboard displays key indicators such as the total number of events, alerts, and a summary of the top 10 TTPs detected within your environment. These indicators can be used to assess the effectiveness of existing security controls and identify areas that may require further attention. Additionally, you can customize the dashboard to display specific metrics that are most relevant to your organization's security posture.
4949

50+
.. thumbnail:: /images/manual/mitre/dashboard-tab2.png
51+
:title: Dashboard tab
52+
:alt: Dashboard tab
53+
:align: center
54+
:width: 80%
55+
5056
.. thumbnail:: /images/manual/mitre/dashboard-tab.png
5157
:title: Dashboard tab
5258
:alt: Dashboard tab
@@ -60,6 +66,12 @@ The **MITRE ATT&CK Events** tab provides detailed information about each event t
6066

6167
You can filter the events based on various criteria such as severity, event type, and detection method, and also sort them by different fields to locate relevant information quickly. Additionally, the tab provides access to additional details, such as the full event log message and any related alerts that may have been generated in response to the event.
6268

69+
.. thumbnail:: /images/manual/mitre/events-tab2.png
70+
:title: Events tab
71+
:alt: Events tab
72+
:align: center
73+
:width: 80%
74+
6375
.. thumbnail:: /images/manual/mitre/events-tab.png
6476
:title: Events tab
6577
:alt: Events tab
@@ -126,7 +138,7 @@ Windows 11
126138

127139
Perform the following steps to configure the Wazuh agent to capture Sysmon logs and send them to the Wazuh server for analysis.
128140

129-
#. Download `Sysmon <https://learn.microsoft.com/en-us/sysinternals/downloads/sysmon>`__ and the configuration file `sysmonconfig.xml <https://wazuh.com/resources/blog/emulation-of-attack-techniques-and-detection-with-wazuh/sysmonconfig.xml>`__.
141+
#. Download `Sysmon <https://learn.microsoft.com/en-us/sysinternals/downloads/sysmon>`__ and the configuration file `sysmonconfig.xml <https://wazuh.com/resources/blog/emulation-of-attack-techniques-and-detection-with-wazuh/sysmonconfig.xml>`__ in the same folder.
130142
#. Launch PowerShell with administrative privilege, and install Sysmon as follows:
131143

132144
.. code-block:: powershell

source/user-manual/ruleset/rules/custom.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
33
.. meta::
44
:description: Custom rules in Wazuh allow users to define specific conditions or patterns in log data that are relevant to their unique requirements. Learn more in this section of the documentation.
5-
5+
66
Custom rules
77
============
88

@@ -17,11 +17,11 @@ Adding custom rules
1717
-------------------
1818

1919
.. note::
20-
21-
Use ID numbers between 100000 and 120000 for custom rules.
20+
21+
Use ID numbers between 100000 and 120000 for custom rules to avoid conflicts with out-of-the-box system rules.
2222

2323
.. note::
24-
24+
2525
To make minor adjustments in your rules, use the ``/var/ossec/etc/rules/local_rules.xml`` file. We recommend creating new rule files in ``/var/ossec/etc/rules/`` directory for changes on a larger scale.
2626

2727
Check out this example on how to create new rules. The following log corresponds to a program called ``example``. We already created a custom decoder for this event in the :doc:`Custom decoder </user-manual/ruleset/decoders/custom>` section.

0 commit comments

Comments
 (0)