mirror of
https://github.com/opnsense/docs
synced 2024-11-17 03:25:33 +00:00
287 lines
14 KiB
ReStructuredText
287 lines
14 KiB
ReStructuredText
==================================
|
||
Inline Intrusion Prevention System
|
||
==================================
|
||
|
||
The inline IPS system of OPNsense is based on Suricata and utilizes Netmap to
|
||
enhance performance and minimize cpu utilization. This deep packet inspection
|
||
system is very powerful and can be used to mitigate security threats at wire speed.
|
||
|
||
----------------------
|
||
Choosing an interface
|
||
----------------------
|
||
|
||
You can configure our system on different interfaces, one of the questions asked most is which interface to choose.
|
||
Since a lot of people use IPv4, usually combined with :doc:`/manual/nat`, it's quite important to use the right interface.
|
||
If your capturing traffic on a "wan" type interface, you will see only traffic "post nat", which means all traffic is
|
||
originated from your firewall and not from the actual machine behind it likely triggering the alert.
|
||
|
||
Rules for an ID[P]S system usually need to have a clear understanding about the internal network, this information is
|
||
lost when capturing packets behind nat.
|
||
|
||
Without trying to explain all the details of an IDS rule (the people at Suricata are way better in doing `that <https://suricata.readthedocs.io/en/suricata-5.0.2/rules/index.html>`__ ),
|
||
a small example of one of the ET-Open rules usually helps understanding the importance of your home network.
|
||
|
||
.. code-block:: sh
|
||
|
||
alert tls $HOME_NET any -> $EXTERNAL_NET any (msg:"ET TROJAN Observed Glupteba CnC Domain in TLS SNI"; flow:established,to_server; tls_sni; content:"myinfoart.xyz"; depth:13; isdataat:!1,relative; metadata: former_category MALWARE; reference:md5,4cc43c345aa4d6e8fd2d0b6747c3d996; classtype:trojan-activity; sid:2029751; rev:2; metadata:affected_product Windows_XP_Vista_7_8_10_Server_32_64_Bit, attack_target Client_Endpoint, deployment Perimeter, signature_severity Major, created_at 2020_03_30, updated_at 2020_03_30;)
|
||
|
||
|
||
The :code:`$HOME_NET` can be configured, but usually is a static net defined in RFC1918, using advanced mode you can choose an external
|
||
address here, but keep in mind you won't know which machine was really involved in the attack and it should really be a static address or network.
|
||
|
||
:code:`$EXTERNAL_NET` is defined as being not the home net, which explains why you shouldn't select all traffic as home, since none of
|
||
the rules will likely match.
|
||
|
||
Since the firewall is dropping inbound packets by default, it usually doesn't improve security using WAN anyway
|
||
(when in IPS mode, it would drop the packet that would otherwise also be dropped).
|
||
|
||
|
||
.. Note::
|
||
|
||
IDS mode is available on almost all (virtual) network types, IPS mode as explained in General setup only
|
||
for supported physical adapters.
|
||
|
||
|
||
---------------
|
||
General setup
|
||
---------------
|
||
|
||
The settings page contains the standard options to get your IDPS system up and running.
|
||
|
||
=====================================================================================================================
|
||
|
||
==================================== ===============================================================================
|
||
Enabled Enable suricata
|
||
IPS mode When enabled, the system can drop suspicious packets. In order for this to
|
||
work, your network card needs to support netmap.
|
||
The action for a rule needs to be "drop" in order to discard the packet,
|
||
this can be configured per rule or ruleset (using an input filter)
|
||
Promiscuous mode Listen to traffic in promiscuous mode. (all packets in stead of only the
|
||
ones addressed to this network interface)
|
||
Enable syslog alerts Send alerts to syslog, using fast log format
|
||
Enable eve syslog output Send alerts in eve format to syslog, using log level info.
|
||
This will not change the alert logging used by the product itself.
|
||
Drop logs will only be send to the internal logger,
|
||
due to restrictions in suricata.
|
||
Pattern matcher Controls the pattern matcher algorithm.
|
||
Aho–Corasick is the default. On supported platforms, Hyperscan is the best option.
|
||
On commodity hardware if Hyperscan is not available the suggested setting is "Aho–Corasick Ken Steele variant" as it performs better than "Aho–Corasick".
|
||
Interfaces Interfaces to protect. When in IPS mode, this need to be real interfaces
|
||
supporting netmap. (when using VLAN's, enable IPS on the parent)
|
||
Rotate log Log rotating frequency, also used for the internal event logging
|
||
(see Alert tab)
|
||
Save logs Number of logs to keep
|
||
==================================== ===============================================================================
|
||
|
||
|
||
.. Tip::
|
||
|
||
When using an external reporting tool, you can use syslog to ship your eve log easily. Just enable "Enable eve syslog output" and
|
||
create a target in :menuselection:`System --> Settings --> Logging / Targets`. (filter application "suricata" and level "info")
|
||
|
||
|
||
.. Note::
|
||
|
||
When using IPS mode make sure all hardware offloading features are disabled in the interface settings (:menuselection:`Interfaces -> Settings`),
|
||
pre 20.7 "VLAN Hardware Filtering" wasn't disabled which may cause issues for some network cards.
|
||
|
||
----------------
|
||
Advanced options
|
||
----------------
|
||
|
||
Some less frequently used options are hidden under the "advanced" toggle.
|
||
|
||
=====================================================================================================================
|
||
|
||
==================================== ===============================================================================
|
||
Home networks Define custom home networks, when different than an RFC1918 network.
|
||
In some cases, people tend to enable IDPS on a wan interface behind NAT
|
||
(Network Address Translation), in which case Suricata would only see
|
||
translated addresses in stead of internal ones. Using this option, you can
|
||
define which addresses Suricata should consider local.
|
||
default packet size With this option, you can set the size of the packets on your network.
|
||
It is possible that bigger packets have to be processed sometimes.
|
||
The engine can still process these bigger packets,
|
||
but processing it will lower the performance.
|
||
==================================== ===============================================================================
|
||
|
||
---------------------------
|
||
Download rulesets
|
||
---------------------------
|
||
|
||
When enabling IDPS for the first time the system is active without any rules to detect or block malicious traffic.
|
||
The download tab contains all rulesets available on the system (which can be expanded using plugins).
|
||
|
||
In this section you will find a list of rulesets as being provided by different parties and when (if installed) they
|
||
where last downloaded on the system. In previous versions (pre 21.1) you could select a "filter" here to alter the
|
||
default behavior of installed rules from alert to block. As of 21.1 this functionality will be covered by **Policies**
|
||
, a separate function within the IDPS module, which offers more fine grained control over the rulesets.
|
||
|
||
|
||
.. Note::
|
||
|
||
When migrating from a version before 21.1 the filters from the download rulesets page will automatically be
|
||
migrated to policies.
|
||
|
||
|
||
---------------------------
|
||
Policies
|
||
---------------------------
|
||
|
||
The **policy** menu item contains a grid where you can define policies to apply to installed rules. Here you can
|
||
add, update or remove policies as well as disabling them.
|
||
Policies help control which rules you want to use in which manner and are the prefered method to change behaviour.
|
||
Although you can still update separate rules in the rules tab, adding a lot of custom overwrites there is more sensitive
|
||
to change and has the risk of slowing down the user-interface.
|
||
|
||
A policy entry contains 3 different sections. First some general information, such as the description and if the
|
||
rule is enabled as well as a priority. Overlapping policies are taken care of in sequence, the first match with the lowest
|
||
priority number is the one to use.
|
||
|
||
Secondly there are the matching criterias, these contain the **rulesets** a policy applies on as well as the action
|
||
configured on a rule (disabled by default, alert or drop), finally there is the **rules** section containing the
|
||
metadata collected from the installed rules, these contain options as affected product (Android, Adobe flash, ...) and
|
||
deployment (datacenter, perimeter).
|
||
|
||
The last option to select is the new action to use, either disable selected rules, only alert on them or drop traffic
|
||
when matched.
|
||
|
||
.. Note::
|
||
|
||
The options in the **rules** section depend on the vendor, when no metadata is provided in the source rule, none
|
||
can be used at our end.
|
||
|
||
|
||
---------------------------
|
||
Installed rules
|
||
---------------------------
|
||
|
||
The rules tab offers an easy to use grid to find the installed rules and their purpose, using the selector
|
||
on top one can filter rules using the same metadata properties available in the policies view.
|
||
|
||
.. Tip::
|
||
|
||
After applying rule changes, the rule action and status (enabled/disabled) are set, to easily find the policy which
|
||
was used on the rule, check the matched_policy option in the filter. Manual (single rule) changes are being marked as
|
||
policy **"__manual__"**
|
||
|
||
|
||
---------------
|
||
Finger Printing
|
||
---------------
|
||
OPNsense includes a very polished solution to block protected sites based on
|
||
their SSL fingerprint, you can add rules manually in the "User defined tab".
|
||
|
||
|
||
---------------------------
|
||
Alerts
|
||
---------------------------
|
||
|
||
In the alerts tab you can view the alerts triggered by our IDPS system, use the info button here to
|
||
collect details about the detected event or threat.
|
||
|
||
---------------------------
|
||
Available rulesets
|
||
---------------------------
|
||
|
||
...................................
|
||
Emerging Threats ETOpen Ruleset
|
||
...................................
|
||
The ETOpen Ruleset is an excellent anti-malware IDS/IPS ruleset that enables
|
||
users with cost constraints to significantly enhance their existing network-based
|
||
malware detection. The ETOpen Ruleset is not a full coverage ruleset, and may not
|
||
be sufficient for many regulated environments and should not be used as a
|
||
standalone ruleset.
|
||
|
||
OPNsense has integrated support for ET Open rules.
|
||
For details and Guidelines see: http://doc.emergingthreats.net/bin/view/Main/EmergingFAQ
|
||
For rules documentation: http://doc.emergingthreats.net/
|
||
|
||
...................................
|
||
ET Pro Telemetry edition
|
||
...................................
|
||
|
||
Proofpoint offers a free alternative for the well known ET Pro ruleset, more information about this product can be
|
||
found via the link below.
|
||
|
||
|
||
.. toctree::
|
||
:maxdepth: 2
|
||
:titlesonly:
|
||
:glob:
|
||
|
||
etpro_telemetry
|
||
|
||
|
||
|
||
...................................
|
||
Abuse.ch
|
||
...................................
|
||
Abuse.ch offer several blacklist for protecting against fraudulent networks.
|
||
OPNsense has integrated support for:
|
||
|
||
...................................
|
||
SSL Blacklist
|
||
...................................
|
||
|
||
SSL Blacklist (SSLBL) is a project maintained by abuse.ch. The goal is to provide
|
||
a list of "bad" SSL certificates identified by abuse.ch to be associated with
|
||
malware or botnet activities. SSLBL relies on SHA1 fingerprints of malicious SSL
|
||
certificates and offers various blacklists.
|
||
|
||
See for details: https://sslbl.abuse.ch/
|
||
|
||
...................................
|
||
Feodo Tracker
|
||
...................................
|
||
|
||
Feodo (also known as Cridex or Bugat) is a Trojan used to commit ebanking fraud and steal sensitive information from the victims computer, such as credit card details or credentials. At the moment, Feodo Tracker is tracking four versions of Feodo, and they are labeled by Feodo Tracker as version A, version B, version C and version D:
|
||
|
||
* **Version A**
|
||
*Hosted on compromised webservers running an nginx proxy on port 8080 TCP
|
||
forwarding all botnet traffic to a tier 2 proxy node. Botnet traffic usually
|
||
directly hits these hosts on port 8080 TCP without using a domain name.*
|
||
* **Version B**
|
||
*Hosted on servers rented and operated by cybercriminals for the exclusive
|
||
purpose of hosting a Feodo botnet controller. Usually taking advantage of a
|
||
domain name within ccTLD .ru. Botnet traffic usually hits these domain names
|
||
using port 80 TCP.*
|
||
* **Version C**
|
||
*Successor of Feodo, completely different code. Hosted on the same botnet
|
||
infrastructure as Version A (compromised webservers, nginx on port 8080 TCP
|
||
or port 7779 TCP, no domain names) but using a different URL structure.
|
||
This Version is also known as Geodo and Emotet.*
|
||
* **Version D**
|
||
*Successor of Cridex. This version is also known as Dridex*
|
||
|
||
See for details: https://feodotracker.abuse.ch/
|
||
|
||
...................................
|
||
URLHaus List
|
||
...................................
|
||
With OPNsense version 18.1.7 we inroduced the URLHaus List from abuse.ch which collects
|
||
compromised sites distributing malware.
|
||
|
||
See for details: https://urlhaus.abuse.ch/
|
||
|
||
...................................
|
||
App detection rules
|
||
...................................
|
||
With OPNsense version 18.1.11 we introduced the app detection ruleset.
|
||
Since about 80 percent of traffic are web applications these rules are focused on
|
||
blocking web services and the URLs behind them.
|
||
|
||
If you want to contribute to the ruleset see: https://github.com/opnsense/rules
|
||
|
||
-------
|
||
How-tos
|
||
-------
|
||
|
||
.. toctree::
|
||
:maxdepth: 2
|
||
:titlesonly:
|
||
:glob:
|
||
|
||
how-tos/ips-feodo
|
||
how-tos/ips-sslfingerprint
|