{{Warning|This manual is moved to https://help.mikrotik.com/docs/display/ROS/Filter}}
==Summary==
==Summary==
Line 57:
Line 57:
<p>
<p>
When processing a chain, rules are taken from the chain in the order they are listed there from top to bottom. If a packet matches the criteria of the rule, then the specified action is performed on it, and no more rules are processed in that chain (the exception is the passthrough action). If a packet has not matched any rule within the chain, then it is accepted.
When processing a chain, rules are taken from the chain in the order they are listed there from top to bottom. If a packet matches the criteria of the rule, then the specified action is performed on it, and no more rules are processed in that chain (the exception is the passthrough action). If a packet has not matched any rule within the built-in chain, then it is accepted.
</p>
</p>
Line 75:
Line 75:
<li> <var>add-src-to-address-list</var> - add source address to [[M:IP/Firewall/Address list | address list]] specified by <code>address-list</code> parameter
<li> <var>add-src-to-address-list</var> - add source address to [[M:IP/Firewall/Address list | address list]] specified by <code>address-list</code> parameter
<li> <var>drop</var> - silently drop the packet
<li> <var>drop</var> - silently drop the packet
<li> <var>fasttrack-connection</var> - process packets from a connection using FastPath by enabling [[Manual:IP/Fasttrack | FastTrack]] for the connection
<li> <var>jump</var> - jump to the user defined chain specified by the value of <code>jump-target</code> parameter
<li> <var>jump</var> - jump to the user defined chain specified by the value of <code>jump-target</code> parameter
<li> <var>log</var> - add a message to the system log containing following data: in-interface, out-interface, src-mac, protocol, src-ip:port->dst-ip:port and length of the packet. After packet is matched it is passed to next rule in the list, similar as <code>passthrough</code>
<li> <var>log</var> - add a message to the system log containing following data: in-interface, out-interface, src-mac, protocol, src-ip:port->dst-ip:port and length of the packet. After packet is matched it is passed to next rule in the list, similar as <code>passthrough</code>
<li> <var>passthrough</var> - ignore this rule and go to next one (useful for statistics).
<li> <var>passthrough</var> - if packet is matched by the rule, increase counter and go to next rule (useful for statistics)
<li> <var>reject</var> - drop the packet and send an ICMP reject message
<li> <var>reject</var> - drop the packet and send an ICMP reject message
<li> <var>return</var> - passes control back to the chain from where the jump took place
<li> <var>return</var> - passes control back to the chain from where the jump took place
<td>Name of the address list to be used. Applicable if action is <code>add-dst-to-address-list</code> or <code>add-src-to-address-list</code> </td>
<td>Time interval after which the address will be removed from the address list specified by <code>address-list</code> parameter. Used in conjunction with <code>add-dst-to-address-list</code> or <code>add-src-to-address-list</code> actions<br />
<ul class="bullets">
<li>Value of <var>none-dynamic</var> (<code>00:00:00</code>) will leave the address in the address list till reboot
<li>Value of <var>none-static</var> will leave the address in the address list forever and will be included in configuration export/backup
<td>Time interval after which the address will be removed from the address list specified by <code>address-list</code> parameter. Used in conjunction with <code>add-dst-to-address-list</code> or <code>add-src-to-address-list</code> actions<br />
<td>Restrict connection limit per address or address block</td>
<td>Matches connections per address or address block after given value is reached. Should be used together with connection-state=new and/or with tcp-flags=syn because matcher is very resource intensive.</td>
</tr>
</tr>
<tr>
<tr>
Line 113:
Line 122:
<td>Matches packets marked via mangle facility with particular connection mark. If <b>no-mark</b> is set, rule will match any unmarked connection.</td>
<td>Matches packets marked via mangle facility with particular connection mark. If <b>no-mark</b> is set, rule will match any unmarked connection.</td>
<td>Can match connections that are srcnatted, dstnatted or both. Note that connection-state=related connections connection-nat-state is determined by direction of the first packet. and if connection tracking needs to use dst-nat to deliver this connection to same hosts as main connection it will be in connection-nat-state=dstnat even if there are no dst-nat rules at all.</td>
<td><var><b>connection-state</b></var> (<em>estabilished | invalid | new | related</em>; Default: <b></b>)</td>
<td><var><b>connection-state</b></var> (<em>estabilished | invalid | new | related | untracked</em>; Default: <b></b>)</td>
<td>Interprets the connection tracking analysis data for a particular packet:
<td>Interprets the connection tracking analysis data for a particular packet:
<ul class="bullets">
<ul class="bullets">
<li> <var>established</var> - a packet which belongs to an existing connection
<li> <var>established</var> - a packet which belongs to an existing connection
<li> <var>invalid</var> - a packet which could not be identified for some reason
<li> <var>invalid</var> - a packet that does not have determined state in connection tracking (usually - severe out-of-order packets, packets with wrong sequence/ack number, or in case of resource overusage on router), for this reason invalid packet will not participate in NAT (as only connection-state=new packets do), and will still contain original source IP address when routed. We strongly suggest to drop all connection-state=invalid packets in firewall filter forward and input chains
<li> <var>new</var> - a packet which begins a new connection
<li> <var>new</var> - the packet has started a new connection, or otherwise associated with a connection which has not seen packets in both directions.
<li> <var>related</var> - a packet which is related to, but not part of an existing connection, such as ICMP errors or a packet which begins FTP data connection
<li> <var>related</var> - a packet which is related to, but not part of an existing connection, such as ICMP errors or a packet which begins FTP data connection
<li> <var>untracked</var> - packet which was set to bypass connection tracking in firewall [[M:IP/Firewall/Raw | RAW]] tables.
<td>Matches packets within given pps limit. As opposed to the <var>limit</var> matcher, every destination IP address / destination port has it's own limit. Parameters are written in following format: <code>count,time,burst,mode,expire</code>.
<td>Matches packets until a given rate is exceeded. Rate is defined as packets per time interval. As opposed to the <var>limit</var> matcher, every flow has it's own limit. Flow is defined by mode parameter. Parameters are written in following format: <code>count[/time],burst,mode[/expire]</code>.
<ul class="bullets">
<ul class="bullets">
<li><b>count</b> - maximum average packet rate measured in packets per <code>time</code> interval
<li><b>count</b> - packet count per time interval per flow to match
<li><b>time</b> - specifies the time interval in which the packet rate is measured
<li><b>time</b> - specifies the time interval in which the packet count per flow cannot be exceeded (optional, 1s will be used if not specified)
<li><b>burst</b> - number of packets which are not counted by packet rate
<li><b>burst</b> - initial number of packets per flow to match: this number gets recharged by one every <code>time</code>/<code>count</code>, up to this number
<li><b>mode</b> - the classifier for packet rate limiting
<li><b>mode</b> - this parameter specifies what unique fields define flow (src-address, dst-address, src-and-dst-address, dst-address-and-port, addresses-and-dst-port)
<li><b>expire</b> - specifies interval after which recored ip address /port will be deleted
<li><b>expire</b> - specifies interval after which flow with no packets will be allowed to be deleted (optional)
<td>Actual interface the packet has entered the router, if incoming interface is bridge</td>
<td>Actual interface the packet has entered the router, if incoming interface is bridge. Works only if '''use-ip-firewall''' is enabled in bridge settings.</td>
<td>Matches the policy used by IpSec. Value is written in following format: <code><b>direction, policy</b></code>. Direction is Used to select whether to match the policy used for decapsulation or the policy that will be used for encapsulation.
<ul>
<li><var>in</var> - valid in the PREROUTING, INPUT and FORWARD chains</li>
<li><var>out</var> - valid in the POSTROUTING, OUTPUT and FORWARD chains</li>
</ul>
<ul>
<li><var>ipsec</var> - matches if the packet is subject to IpSec processing;</li>
<li><var>none</var> - matches packet that is not subject to IpSec processing (for example, IpSec transport packet).</li>
</ul>
<p>For example, if router receives Ipsec encapsulated Gre packet, then rule <code>ipsec-policy=in,ipsec</code> will match Gre packet, but rule <code>ipsec-policy=in,none</code> will match ESP packet.</p></td>
<td>Matches packets within given pps limit. Parameters are written in following format: <code>count,time,burst</code>.
<td>Matches packets up to a limited rate (packet rate or bit rate). Rule using this matcher will match until this limit is reached. Parameters are written in following format: <code>count[/time],burst:mode</code>.
<ul class="bullets">
<ul class="bullets">
<li><b>count</b> - maximum average packet rate measured in packets per <code>time</code> interval
<li><b>count</b> - packet or bit count per time interval to match
<li><b>time</b> - specifies the time interval in which the packet rate is measured
<li><b>time</b> - specifies the time interval in which the packet or bit count cannot be exceeded (optional, 1s will be used if not specified)
<li><b>burst</b> - number of packets which are not counted by packet rate
<li><b>burst</b> - initial number of packets or bits to match: this number gets recharged every 10ms so burst should be at least 1/100 of rate per second
<td>Actual interface the packet is leaving the router, if outgoing interface is bridge</td>
<td>Actual interface the packet is leaving the router, if outgoing interface is bridge. Works only if '''use-ip-firewall''' is enabled in bridge settings.</td>
<td>Matches if any (source or destination) port matches the specified list of ports or port ranges. Applicable only if <code>protocol</code> is TCP or UDP</td>
<td>Matches if any (source or destination) port matches the specified list of ports or port ranges. Applicable only if <code>protocol</code> is TCP or UDP</td>
<td>Matches packet's priority after a new priority has been set. Priority may be derived from VLAN, WMM, DSCP, MPLS EXP bit or from priority that has been set using the <var>set-priority</var> action. [[WMM | Read more >>]]</td>
<td>Attempts to detect TCP and UDP scans. Parameters are in following format <code>WeightThreshold, DelayThreshold, LopPortWeight, HighPortWeight</code>
<td>Attempts to detect TCP and UDP scans. Parameters are in following format <code>WeightThreshold, DelayThreshold, LowPortWeight, HighPortWeight</code>
<ul class="bullets">
<ul class="bullets">
<li> <b>WeightThreshold</b> - total weight of the latest TCP/UDP packets with different destination ports coming from the same host to be treated as port scan sequence
<li> <b>WeightThreshold</b> - total weight of the latest TCP/UDP packets with different destination ports coming from the same host to be treated as port scan sequence
<li> <b>DelayThreshold</b> - delay for the packets with different destination ports coming from the same host to be treated as possible port scan subsequence
<li> <b>DelayThreshold</b> - delay for the packets with different destination ports coming from the same host to be treated as possible port scan subsequence
<li> <b>LowPortWeight</b> - weight of the packets with privileged (<=1024) destination port
<li> <b>LowPortWeight</b> - weight of the packets with privileged (<1024) destination port
<li> <b>HighPortWeight</b> - weight of the packet with non-priviliged destination port
<li> <b>HighPortWeight</b> - weight of the packet with non-priviliged destination port
<td>Matches packets which destination address is resolved in specific a routing table. More details can be found in the [[Manual:Routing_Table_Matcher | Routing Table Matcher]] page</td>
<td>Allows to match https traffic based on TLS SNI hostname. Accepts [https://en.wikipedia.org/wiki/Glob_(programming) GLOB syntax] for wildcard matching. Note that matcher will not be able to match hostname if TLS handshake frame is fragmented into multiple TCP segments (packets).</td>
</tr>
</tr>
<tr>
<tr>
Line 427:
Line 494:
==Basic examples==
==Basic examples==
===CLI Disctinctive===
<p>
There is a bit different interpretation in each section with the similar configuration. <br>
For example, with the following configuration line you will match packets where tcp-flags does not have SYN, but has ACK flags:
Lets say our private network is 192.168.0.0/24 and public (WAN) interface is ether1. We will set up firewall to allow connections to router itself only from our local network and drop the rest. Also we will allow ICMP protocol on any interface so that anyone can ping your router from internet.
Lets say our private network is 192.168.0.0/24 and public (WAN) interface is ether1. We will set up firewall to allow connections to router itself only from our local network and drop the rest. Also we will allow ICMP protocol on any interface so that anyone can ping your router from internet.
Line 448:
Line 529:
===Customer protection===
===Customer protection===
<p>
<p>
To protect the customer's network, we should check all traffic which goes through router and block unwanted. For icmp, tcp, udp traffic we will create chains, where will be droped all unwanted packets:
To protect the customer's network, we should check all traffic which goes through the router and block unwanted. For icmp, tcp, udp traffic we will create chains, where will be dropped all unwanted packets:
The firewall implements packet filtering and thereby provides security functions that are used to manage data flow to, from and through the router. Along with the Network Address Translation it serves as a tool for preventing unauthorized access to directly attached networks and the router itself as well as a filter for outgoing traffic.
Network firewalls keep outside threats away from sensitive data available inside the network. Whenever different networks are joined together, there is always a threat that someone from outside of your network will break into your LAN. Such break-ins may result in private data being stolen and distributed, valuable data being altered or destroyed, or entire hard drives being erased. Firewalls are used as a means of preventing or minimizing the security risks inherent in connecting to other networks. Properly configured firewall plays a key role in efficient and secure network infrastrure deployment.
MikroTik RouterOS has very powerful firewall implementation with features including:
stateful packet inspection
Layer-7 protocol detection
peer-to-peer protocols filtering
traffic classification by:
source MAC address
IP addresses (network or list) and address types (broadcast, local, multicast, unicast)
port or port range
IP protocols
protocol options (ICMP type and code fields, TCP flags, IP options and MSS)
interface the packet arrived from or left through
internal flow and connection marks
DSCP byte
packet content
rate at which packets arrive and sequence numbers
packet size
packet arrival time
and much more!
Chains
The firewall operates by means of firewall rules. Each rule consists of two parts - the matcher which matches traffic flow against given conditions and the action which defines what to do with the matched packet.
Firewall filtering rules are grouped together in chains. It allows a packet to be matched against one common criterion in one chain, and then passed over for processing against some other common criteria to another chain. For example a packet should be matched against the IP address:port pair. Of course, it could be achieved by adding as many rules with IP address:port match as required to the forward chain, but a better way could be to add one rule that matches traffic from a particular IP address, e.g.: /ip firewall filter add src-address=1.1.1.2/32 jump-target="mychain" and in case of successfull match passes control over the IP packet to some other chain, id est mychain in this example. Then rules that perform matching against separate ports can be added to mychain chain without specifying the IP addresses.
There are three predefined chains, which cannot be deleted:
input - used to process packets entering the router through one of the interfaces with the destination IP address which is one of the router's addresses. Packets passing through the router are not processed against the rules of the input chain
forward - used to process packets passing through the router
output - used to process packets originated from the router and leaving it through one of the interfaces. Packets passing through the router are not processed against the rules of the output chain
Packet flow diagrams illustrate how packets are processed in RouterOS.
When processing a chain, rules are taken from the chain in the order they are listed there from top to bottom. If a packet matches the criteria of the rule, then the specified action is performed on it, and no more rules are processed in that chain (the exception is the passthrough action). If a packet has not matched any rule within the built-in chain, then it is accepted.
Properties
Property
Description
action (action name; Default: accept)
Action to take if packet is matched by the rule:
accept - accept the packet. Packet is not passed to next firewall rule.
add-dst-to-address-list - add destination address to address list specified by address-list parameter
add-src-to-address-list - add source address to address list specified by address-list parameter
drop - silently drop the packet
fasttrack-connection - process packets from a connection using FastPath by enabling FastTrack for the connection
jump - jump to the user defined chain specified by the value of jump-target parameter
log - add a message to the system log containing following data: in-interface, out-interface, src-mac, protocol, src-ip:port->dst-ip:port and length of the packet. After packet is matched it is passed to next rule in the list, similar as passthrough
passthrough - if packet is matched by the rule, increase counter and go to next rule (useful for statistics)
reject - drop the packet and send an ICMP reject message
return - passes control back to the chain from where the jump took place
tarpit - captures and holds TCP connections (replies with SYN/ACK to the inbound TCP SYN packet)
Time interval after which the address will be removed from the address list specified by address-list parameter. Used in conjunction with add-dst-to-address-list or add-src-to-address-list actions
Value of none-dynamic (00:00:00) will leave the address in the address list till reboot
Value of none-static will leave the address in the address list forever and will be included in configuration export/backup
chain (name; Default: )
Specifies to which chain rule will be added. If the input does not match the name of an already defined chain, a new chain will be created.
comment (string; Default: )
Descriptive comment for the rule.
chain (name; Default: )
Specifies to which chain rule will be added. If the input does not match the name of an already defined chain, a new chain will be created.
comment (string; Default: )
Descriptive comment for the rule.
connection-bytes (integer-integer; Default: )
Matches packets only if a given amount of bytes has been transfered through the particular connection. 0 - means infinity, for example connection-bytes=2000000-0 means that the rule matches if more than 2MB has been transfered through the relevant connection
connection-limit (integer,netmask; Default: )
Matches connections per address or address block after given value is reached. Should be used together with connection-state=new and/or with tcp-flags=syn because matcher is very resource intensive.
connection-mark (no-mark | string; Default: )
Matches packets marked via mangle facility with particular connection mark. If no-mark is set, rule will match any unmarked connection.
connection-nat-state (srcnat | dstnat; Default: )
Can match connections that are srcnatted, dstnatted or both. Note that connection-state=related connections connection-nat-state is determined by direction of the first packet. and if connection tracking needs to use dst-nat to deliver this connection to same hosts as main connection it will be in connection-nat-state=dstnat even if there are no dst-nat rules at all.
Connection Rate is a firewall matcher that allow to capture traffic based on present speed of the connection. Read more >>
connection-state (estabilished | invalid | new | related | untracked; Default: )
Interprets the connection tracking analysis data for a particular packet:
established - a packet which belongs to an existing connection
invalid - a packet that does not have determined state in connection tracking (usually - severe out-of-order packets, packets with wrong sequence/ack number, or in case of resource overusage on router), for this reason invalid packet will not participate in NAT (as only connection-state=new packets do), and will still contain original source IP address when routed. We strongly suggest to drop all connection-state=invalid packets in firewall filter forward and input chains
new - the packet has started a new connection, or otherwise associated with a connection which has not seen packets in both directions.
related - a packet which is related to, but not part of an existing connection, such as ICMP errors or a packet which begins FTP data connection
untracked - packet which was set to bypass connection tracking in firewall RAW tables.
Matches packets from related connections based on information from their connection tracking helpers. A relevant connection helper must be enabled under /ip firewall service-port
content (string; Default: )
Match packets that contain specified text
dscp (integer: 0..63; Default: )
Matches DSCP IP header field.
dst-address (IP/netmask | IP range; Default: )
Matches packets which destination is equal to specified IP or falls into specified IP range.
dst-address-list (name; Default: )
Matches destination address of a packet against user-defined address list
dst-address-type (unicast | local | broadcast | multicast; Default: )
Matches destination address type:
unicast - IP address used for point to point transmission
local - if dst-address is assigned to one of router's interfaces
broadcast - packet is sent to all devices in subnet
multicast - packet is forwarded to defined group of devices
Matches packets until a given rate is exceeded. Rate is defined as packets per time interval. As opposed to the limit matcher, every flow has it's own limit. Flow is defined by mode parameter. Parameters are written in following format: count[/time],burst,mode[/expire].
count - packet count per time interval per flow to match
time - specifies the time interval in which the packet count per flow cannot be exceeded (optional, 1s will be used if not specified)
burst - initial number of packets per flow to match: this number gets recharged by one every time/count, up to this number
mode - this parameter specifies what unique fields define flow (src-address, dst-address, src-and-dst-address, dst-address-and-port, addresses-and-dst-port)
expire - specifies interval after which flow with no packets will be allowed to be deleted (optional)
dst-port (integer[-integer]: 0..65535; Default: )
List of destination port numbers or port number ranges
fragment (yes|no; Default: )
Matches fragmented packets. First (starting) fragment does not count. If connection tracking is enabled there will be no fragments as system automatically assembles every packet
from-client - matches packets that are coming from the HotSpot client
http - matches HTTP requests sent to the HotSpot server
local-dst - matches packets that are destined to the HotSpot server
to-client - matches packets that are sent to the HotSpot client
icmp-options (integer:integer; Default: )
Matches ICMP type:code fields
in-bridge-port (name; Default: )
Actual interface the packet has entered the router, if incoming interface is bridge. Works only if use-ip-firewall is enabled in bridge settings.
in-bridge-port-list (name; Default: )
Set of interfaces defined in interface list. Works the same as in-bridge-port
in-interface (name; Default: )
Interface the packet has entered the router
in-interface-list (name; Default: )
Set of interfaces defined in interface list. Works the same as in-interface
ingress-priority (integer: 0..63; Default: )
Matches the priority of an ingress packet. Priority may be derived from VLAN, WMM, DSCP or MPLS EXP bit. read more»
ipsec-policy (in | out, ipsec | none; Default: )
Matches the policy used by IpSec. Value is written in following format: direction, policy. Direction is Used to select whether to match the policy used for decapsulation or the policy that will be used for encapsulation.
in - valid in the PREROUTING, INPUT and FORWARD chains
out - valid in the POSTROUTING, OUTPUT and FORWARD chains
ipsec - matches if the packet is subject to IpSec processing;
none - matches packet that is not subject to IpSec processing (for example, IpSec transport packet).
For example, if router receives Ipsec encapsulated Gre packet, then rule ipsec-policy=in,ipsec will match Gre packet, but rule ipsec-policy=in,none will match ESP packet.
any - match packet with at least one of the ipv4 options
loose-source-routing - match packets with loose source routing option. This option is used to route the internet datagram based on information supplied by the source
no-record-route - match packets with no record route option. This option is used to route the internet datagram based on information supplied by the source
no-router-alert - match packets with no router alter option
no-source-routing - match packets with no source routing option
no-timestamp - match packets with no timestamp option
record-route - match packets with record route option
router-alert - match packets with router alter option
strict-source-routing - match packets with strict source routing option
timestamp - match packets with timestamp
jump-target (name; Default: )
Name of the target chain to jump to. Applicable only if action=jump
Matches packets up to a limited rate (packet rate or bit rate). Rule using this matcher will match until this limit is reached. Parameters are written in following format: count[/time],burst:mode.
count - packet or bit count per time interval to match
time - specifies the time interval in which the packet or bit count cannot be exceeded (optional, 1s will be used if not specified)
burst - initial number of packets or bits to match: this number gets recharged every 10ms so burst should be at least 1/100 of rate per second
mode - packet or bit mode
log-prefix (string; Default: )
Adds specified text at the beginning of every log message. Applicable if action=log
PCC matcher allows to divide traffic into equal streams with ability to keep packets with specific set of options in one particular stream. Read more >>
port (integer[-integer]: 0..65535; Default: )
Matches if any (source or destination) port matches the specified list of ports or port ranges. Applicable only if protocol is TCP or UDP
priority (integer: 0..63; Default:)
Matches packet's priority after a new priority has been set. Priority may be derived from VLAN, WMM, DSCP, MPLS EXP bit or from priority that has been set using the set-priority action. Read more >>
protocol (name or protocol ID; Default: tcp)
Matches particular IP protocol specified by protocol name or number
psd (integer,time,integer,integer; Default: )
Attempts to detect TCP and UDP scans. Parameters are in following format WeightThreshold, DelayThreshold, LowPortWeight, HighPortWeight
WeightThreshold - total weight of the latest TCP/UDP packets with different destination ports coming from the same host to be treated as port scan sequence
DelayThreshold - delay for the packets with different destination ports coming from the same host to be treated as possible port scan subsequence
LowPortWeight - weight of the packets with privileged (<1024) destination port
HighPortWeight - weight of the packet with non-priviliged destination port
Allows to create filter based on the packets' arrival time and date or, for locally generated packets, departure time and date
tls-host (string; Default: )
Allows to match https traffic based on TLS SNI hostname. Accepts GLOB syntax for wildcard matching. Note that matcher will not be able to match hostname if TLS handshake frame is fragmented into multiple TCP segments (packets).
ttl (integer: 0..255; Default: )
Matches packets TTL value
Stats
/ip firewall filter print stats will show additional read-only properties
Property
Description
bytes (integer)
Total amount of bytes matched by the rule
packets (integer)
Total amount of packets matched by the rule
By default print is equivalent to print static and shows only static rules.
There is a bit different interpretation in each section with the similar configuration.
For example, with the following configuration line you will match packets where tcp-flags does not have SYN, but has ACK flags:
Lets say our private network is 192.168.0.0/24 and public (WAN) interface is ether1. We will set up firewall to allow connections to router itself only from our local network and drop the rest. Also we will allow ICMP protocol on any interface so that anyone can ping your router from internet.
To protect the customer's network, we should check all traffic which goes through the router and block unwanted. For icmp, tcp, udp traffic we will create chains, where will be dropped all unwanted packets:
