doc/userguide: spelling

pull/8828/head
Victor Julien 3 years ago
parent c0e02bf37b
commit c0d9b3c078

@ -75,7 +75,7 @@ threads for ``igb0`` and 4 capture threads for ``igb1``.
.. warning:: This multi threaded setup only works correctly if the NIC .. warning:: This multi threaded setup only works correctly if the NIC
has symmetric RSS hashing. If this is not the case, consider has symmetric RSS hashing. If this is not the case, consider
using the the 'lb' method below. using the 'lb' method below.
IPS IPS
~~~ ~~~

@ -126,7 +126,7 @@ snort.conf
Suricata Suricata
To set the user and group use the --user <username> and --group To set the user and group use the --user <username> and --group
<groupname> commandline options. <groupname> command-line options.
Snaplen Snaplen
~~~~~~~ ~~~~~~~
@ -188,7 +188,7 @@ suricata.yaml
default-log-dir: /var/log/suricata/ default-log-dir: /var/log/suricata/
This value is overridden by the -l commandline option. This value is overridden by the -l command-line option.
Packet acquisition Packet acquisition
------------------ ------------------

@ -868,7 +868,7 @@ per available CPU/CPU core.
- worker-cpu-set: - worker-cpu-set:
cpu: [ "all" ] cpu: [ "all" ]
mode: "exclusive" mode: "exclusive"
# Use explicitely 3 threads and don't compute number by using # Use explicitly 3 threads and don't compute number by using
# detect-thread-ratio variable: # detect-thread-ratio variable:
# threads: 3 # threads: 3
prio: prio:
@ -1182,7 +1182,7 @@ Suricata inspects traffic in a sliding window manner.
.. image:: suricata-yaml/inline_mode.png .. image:: suricata-yaml/inline_mode.png
**Example 13 Normal/IDS (reasembly on ACK'D data)** **Example 13 Normal/IDS (reassembly on ACK'D data)**
.. image:: suricata-yaml/Normal_ids_ack_d.png .. image:: suricata-yaml/Normal_ids_ack_d.png
@ -1488,7 +1488,7 @@ use of libhtp.
# detection change between runs. It is set to 'yes' by default. # detection change between runs. It is set to 'yes' by default.
#randomize-inspection-sizes: yes #randomize-inspection-sizes: yes
# If randomize-inspection-sizes is active, the value of various # If randomize-inspection-sizes is active, the value of various
# inspection size will be choosen in the [1 - range%, 1 + range%] # inspection size will be chosen in the [1 - range%, 1 + range%]
# range # range
# Default value of randomize-inspection-range is 10. # Default value of randomize-inspection-range is 10.
#randomize-inspection-range: 10 #randomize-inspection-range: 10
@ -1980,7 +1980,7 @@ be found in other capture interfaces. The individual items contain the usual con
such as `threads`/`copy-mode`/`checksum-checks` settings. Other capture interfaces, such as AF_PACKET, rely on the user that NICs are appropriately configured. such as `threads`/`copy-mode`/`checksum-checks` settings. Other capture interfaces, such as AF_PACKET, rely on the user that NICs are appropriately configured.
Configuration through kernel does not apply to applications running under DPDK. The application is solely responsible for the Configuration through kernel does not apply to applications running under DPDK. The application is solely responsible for the
initialization of NICs it is using. So, before the start of Suricata, NICs that Suricata uses, must undergo the process of initialization. initialization of NICs it is using. So, before the start of Suricata, NICs that Suricata uses, must undergo the process of initialization.
As a result, there are extra extra configuration options (how NICs can be configured) in the items (interfaces) of the `dpdk.interfaces` list. As a result, there are extra configuration options (how NICs can be configured) in the items (interfaces) of the `dpdk.interfaces` list.
At the start of the configuration process, all NIC offloads are disabled to prevent any packet modification. At the start of the configuration process, all NIC offloads are disabled to prevent any packet modification.
According to the configuration, checksum validation offload can be enabled to drop invalid packets. According to the configuration, checksum validation offload can be enabled to drop invalid packets.
Other offloads can not be currently enabled. Other offloads can not be currently enabled.

@ -32,7 +32,7 @@ Information that needs to be part of a commit (if applicable):
Pull Requests Pull Requests
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
A github pull request is actually just a pointer to a branch in your tree. Github provides a review interface that we use. A github pull request is actually just a pointer to a branch in your tree. GitHub provides a review interface that we use.
#. A branch can only be used in for an individual PR. #. A branch can only be used in for an individual PR.
#. A branch should not be updated after the pull request #. A branch should not be updated after the pull request

@ -180,7 +180,7 @@ for each pull request. So, when you address the first feedback, you will work in
"geoip-feature-123-v2" and so on. "geoip-feature-123-v2" and so on.
For more details check: `Creating a branch to do your changes <https://redmine. For more details check: `Creating a branch to do your changes <https://redmine.
openinfosecfoundation.org/projects/suricata/wiki/Github_work_flow#Creating-a- openinfosecfoundation.org/projects/suricata/wiki/GitHub_work_flow#Creating-a-
branch-to-do-your-changes>`_ branch-to-do-your-changes>`_

@ -28,4 +28,4 @@ Adding Fuzz Targets
Oss-Fuzz Oss-Fuzz
-------- --------
Suricata is continuesly fuzz tested in Oss-Fuzz. See https://github.com/google/oss-fuzz/tree/master/projects/suricata Suricata is continuously fuzz tested in Oss-Fuzz. See https://github.com/google/oss-fuzz/tree/master/projects/suricata

@ -33,7 +33,7 @@ If you want more info about the unittests, regular debug mode can help. This is
--enable-debug --enable-debug
Then, set the debug level from the commandline:: Then, set the debug level from the command-line::
SC_LOG_LEVEL=Debug suricata -u SC_LOG_LEVEL=Debug suricata -u

@ -114,7 +114,7 @@ is completed (NFS, SMB), it is possible to create a level of abstraction to hand
This is controlled by implementing progress states. In Suricata, those will be enums that are incremented as the parsing This is controlled by implementing progress states. In Suricata, those will be enums that are incremented as the parsing
progresses. A state will start at 0. The higher its value, the closer the transaction would be to completion. Due to how progresses. A state will start at 0. The higher its value, the closer the transaction would be to completion. Due to how
the engine tracks detection accross states, there is an upper limit of 48 to the state progress (it must be < 48). the engine tracks detection across states, there is an upper limit of 48 to the state progress (it must be < 48).
The engine interacts with transactions' state using a set of callbacks the parser registers. State is defined per flow direction (``STREAM_TOSERVER`` / ``STREAM_TOCLIENT``). The engine interacts with transactions' state using a set of callbacks the parser registers. State is defined per flow direction (``STREAM_TOSERVER`` / ``STREAM_TOCLIENT``).

@ -85,7 +85,7 @@ A protocol parser, like modbus, could permit to set a different
store-depth value and use it rather than ``file-store.stream-depth``. store-depth value and use it rather than ``file-store.stream-depth``.
Using the SHA256 for file names allows for automatic de-duplication of Using the SHA256 for file names allows for automatic de-duplication of
extracted files. However, the timestamp of a pre-existing file will be extracted files. However, the timestamp of a preexisting file will be
updated if the same files is extracted again, similar to the `touch` updated if the same files is extracted again, similar to the `touch`
command. command.

@ -579,7 +579,7 @@ Example:
function log (args) function log (args)
asked_domain = TlsGetSNI() asked_domain = TlsGetSNI()
if string.find(asked_domain, "badguys") then if string.find(asked_domain, "badguys") then
-- ok connection to bad guys let's do someting -- ok connection to bad guys let's do something
end end
end end

@ -18,7 +18,7 @@ generate alerts based on rules. **suricata** will generate traffic logs.
When used with live traffic **suricata** can be passive or active. Active When used with live traffic **suricata** can be passive or active. Active
modes are: inline in a L2 bridge setup, inline with L3 integration with modes are: inline in a L2 bridge setup, inline with L3 integration with
host filewall (NFQ, IPFW, WinDivert), or out of band using active responses. host firewall (NFQ, IPFW, WinDivert), or out of band using active responses.
OPTIONS OPTIONS
-------------- --------------

@ -1442,7 +1442,7 @@ The optional "client" field is a sub-object that may contain the following:
* "capabilities": List of any of the following: "support_errinfo_pdf", "want_32bpp_session", "support_statusinfo_pdu", "strong_asymmetric_keys", "valid_connection_type", "support_monitor_layout_pdu", "support_netchar_autodetect", "support_dynvc_gfx_protocol", "support_dynamic_time_zone", "support_heartbeat_pdu". * "capabilities": List of any of the following: "support_errinfo_pdf", "want_32bpp_session", "support_statusinfo_pdu", "strong_asymmetric_keys", "valid_connection_type", "support_monitor_layout_pdu", "support_netchar_autodetect", "support_dynvc_gfx_protocol", "support_dynamic_time_zone", "support_heartbeat_pdu".
* "id": Client product id string. * "id": Client product id string.
* "connection_hint": Possible values are "modem", "low_broadband", "satellite", "high_broadband", "wan", "lan", "autodetect". * "connection_hint": Possible values are "modem", "low_broadband", "satellite", "high_broadband", "wan", "lan", "autodetect".
* "physical_width": Numeric phyical width of display. * "physical_width": Numeric physical width of display.
* "physical_height": Numeric physical height of display. * "physical_height": Numeric physical height of display.
* "desktop_orientation": Numeric angle of orientation. * "desktop_orientation": Numeric angle of orientation.
* "scale_factor": Numeric scale factor of desktop. * "scale_factor": Numeric scale factor of desktop.
@ -2163,7 +2163,7 @@ Some of the possible request messages are:
Examples Examples
~~~~~~~~ ~~~~~~~~
The two ``pgsql`` events in this example reprensent a rejected ``SSL handshake`` and a following connection request where the authentication method indicated by the backend was ``md5``:: The two ``pgsql`` events in this example represent a rejected ``SSL handshake`` and a following connection request where the authentication method indicated by the backend was ``md5``::
{ {
"timestamp": "2021-11-24T16:56:19.435242+0000", "timestamp": "2021-11-24T16:56:19.435242+0000",

@ -75,7 +75,7 @@ Metadata::
# Include the decoded application layer (ie. http, dns) # Include the decoded application layer (ie. http, dns)
#app-layer: true #app-layer: true
# Log the the current state of the flow record. # Log the current state of the flow record.
#flow: true #flow: true
#rule: #rule:

@ -1,7 +1,7 @@
Syslog Alerting Compatibility Syslog Alerting Compatibility
============================= =============================
Suricata can alert via sylog which is a very handy feature for central log collection, compliance, and reporting to a SIEM. Instructions on setting this up can be found in the .yaml file in the section where you can configure what type of alert (and other) logging you would like. Suricata can alert via syslog which is a very handy feature for central log collection, compliance, and reporting to a SIEM. Instructions on setting this up can be found in the .yaml file in the section where you can configure what type of alert (and other) logging you would like.
However, there are different syslog daemons and there can be parsing issues with the syslog format a SIEM expects and what syslog format Suricata sends. The syslog format from Suricata is dependent on the syslog daemon running on the Suricata sensor but often the format it sends is not the format the SIEM expects and cannot parse it properly. However, there are different syslog daemons and there can be parsing issues with the syslog format a SIEM expects and what syslog format Suricata sends. The syslog format from Suricata is dependent on the syslog daemon running on the Suricata sensor but often the format it sends is not the format the SIEM expects and cannot parse it properly.

@ -55,7 +55,7 @@ outputs:
# Include the decoded application layer (ie. http, dns) # Include the decoded application layer (ie. http, dns)
app-layer: true app-layer: true
# Log the the current state of the flow record. # Log the current state of the flow record.
flow: true flow: true
rule: rule:

@ -1,7 +1,7 @@
Performance Analysis Performance Analysis
==================== ====================
There are many potential causes for for performance issues. In this section we There are many potential causes for performance issues. In this section we
will guide you through some options. The first part will cover basic steps and will guide you through some options. The first part will cover basic steps and
introduce some helpful tools. The second part will cover more in-depth introduce some helpful tools. The second part will cover more in-depth
explanations and corner cases. explanations and corner cases.
@ -117,7 +117,7 @@ https://en.wikipedia.org/wiki/IEEE_802.1ad) most implementations only add
0x8100 on each layer. If the first seen layer has the same VLAN tag but the 0x8100 on each layer. If the first seen layer has the same VLAN tag but the
inner one has different VLAN tags it will still end up in the same queue in inner one has different VLAN tags it will still end up in the same queue in
**cluster_qm** mode. This was observed with the i40e driver up to 2.8.20 and **cluster_qm** mode. This was observed with the i40e driver up to 2.8.20 and
the firmare version up to 7.00, feel free to report if newer versions have the firmware version up to 7.00, feel free to report if newer versions have
fixed this (see https://suricata.io/support/). fixed this (see https://suricata.io/support/).

@ -82,7 +82,7 @@ socket system using x710:
The commands above can be reviewed in detail in the help or manpages of the The commands above can be reviewed in detail in the help or manpages of the
``ethtool``. In brief the sequence makes sure the NIC is reset, the number of ``ethtool``. In brief the sequence makes sure the NIC is reset, the number of
RSS queues is set to 16, load balancing is enabled for the NIC, a low entropy RSS queues is set to 16, load balancing is enabled for the NIC, a low entropy
toepiltz key is inserted to allow for symmetric hashing, receive offloading is toeplitz key is inserted to allow for symmetric hashing, receive offloading is
disabled, the adaptive control is disabled for lowest possible latency and disabled, the adaptive control is disabled for lowest possible latency and
last but not least, the ring rx descriptor size is set to 1024. last but not least, the ring rx descriptor size is set to 1024.
Make sure the RSS hash function is Toeplitz: Make sure the RSS hash function is Toeplitz:

@ -27,7 +27,7 @@ Using Hyperscan
To use the hyperscan support edit your suricata.yaml. Change the mpm-algo and spm-algo values to 'hs'. To use the hyperscan support edit your suricata.yaml. Change the mpm-algo and spm-algo values to 'hs'.
Alternatively, use this commandline option: --set mpm-algo=hs --set spm-algo=hs Alternatively, use this command-line option: --set mpm-algo=hs --set spm-algo=hs

@ -18,7 +18,7 @@ Example::
not host 1.2.3.4 not host 1.2.3.4
Capture filters are specified on the commandline after all other options:: Capture filters are specified on the command-line after all other options::
suricata -i eth0 -v not host 1.2.3.4 suricata -i eth0 -v not host 1.2.3.4
suricata -i eno1 -c suricata.yaml tcp or udp suricata -i eno1 -c suricata.yaml tcp or udp

@ -158,4 +158,4 @@ Tools to plot graphs
Some people made nice tools to plot graphs of the statistics file. Some people made nice tools to plot graphs of the statistics file.
* `ipython and matplotlib script <https://github.com/regit/suri-stats>`_ * `ipython and matplotlib script <https://github.com/regit/suri-stats>`_
* `Monitoring with Zabbix or other <http://christophe.vandeplas.com/2013/11/suricata-monitoring-with-zabbix-or-other.html>`_ and `Code on Github <https://github.com/cvandeplas/suricata_stats>`_ * `Monitoring with Zabbix or other <http://christophe.vandeplas.com/2013/11/suricata-monitoring-with-zabbix-or-other.html>`_ and `Code on GitHub <https://github.com/cvandeplas/suricata_stats>`_

@ -3,7 +3,7 @@ Bypass Keyword
Suricata has a ``bypass`` keyword that can be used in signatures to exclude traffic from further evaluation. Suricata has a ``bypass`` keyword that can be used in signatures to exclude traffic from further evaluation.
The ``bypass`` keyword is useful in cases where there is a large flow expected (e.g. Netflix, Spotify, Youtube). The ``bypass`` keyword is useful in cases where there is a large flow expected (e.g. Netflix, Spotify, YouTube).
The ``bypass`` keyword is considered a post-match keyword. The ``bypass`` keyword is considered a post-match keyword.

@ -25,7 +25,7 @@ Match on DNS requests and responses with **opcode** 4::
dns.opcode:4; dns.opcode:4;
Match on DNS requests whre the **opcode** is NOT 0:: Match on DNS requests where the **opcode** is NOT 0::
dns.opcode:!0; dns.opcode:!0;

@ -652,7 +652,7 @@ Example of icmp_seq in a rule:
icmpv4.hdr icmpv4.hdr
^^^^^^^^^^ ^^^^^^^^^^
Sitcky buffer to match on the whole ICMPv4 header. Sticky buffer to match on the whole ICMPv4 header.
icmpv6.hdr icmpv6.hdr
^^^^^^^^^^ ^^^^^^^^^^

@ -66,7 +66,7 @@ Example of sid in a signature:
<gid>` (``gid``). <gid>` (``gid``).
As Suricata-update currently considers the rule's ``sid`` only (cf. `Bug#5447 As Suricata-update currently considers the rule's ``sid`` only (cf. `Bug#5447
<https://redmine.openinfosecfoundation.org/issues/5447>`_), it is adviseable <https://redmine.openinfosecfoundation.org/issues/5447>`_), it is advisable
to opt for a completely unique ``sid`` altogether. to opt for a completely unique ``sid`` altogether.
rev (revision) rev (revision)

@ -157,7 +157,7 @@ Example::
``endswith`` is a short hand notation for:: ``endswith`` is a short hand notation for::
content:".php"; isdatat:!1,relative; content:".php"; isdataat:!1,relative;
``endswith`` cannot be mixed with ``offset``, ``within`` or ``endswith`` cannot be mixed with ``offset``, ``within`` or
``distance`` for the same pattern. ``distance`` for the same pattern.

Loading…
Cancel
Save