2 ########################################################################
3 # Begin $rc_base/init.d/suricata
5 # Description : Suricata Initscript
7 # Author : Stefan Schantl <stefan.schantl@ipfire.org>
13 ########################################################################
18 PATH
=/usr
/local
/sbin
:/usr
/local
/bin
:/bin
:/usr
/bin
:/sbin
:/usr
/sbin
; export PATH
20 eval $
(/usr
/local
/bin
/readhash
/var
/ipfire
/suricata
/settings
)
21 eval $
(/usr
/local
/bin
/readhash
/var
/ipfire
/ethernet
/settings
)
23 # Name of the firewall chains.
24 IPS_INPUT_CHAIN
="IPS_INPUT"
25 IPS_FORWARD_CHAIN
="IPS_FORWARD"
26 IPS_OUTPUT_CHAIN
="IPS_OUTPUT"
28 # Optional options for the Netfilter queue.
29 NFQ_OPTS
="--queue-bypass "
31 # Array containing the 4 possible network zones.
32 network_zones
=( red green blue orange ovpn
)
34 # Array to store the network zones weather the IPS is enabled for.
37 # Mark and Mask options.
41 # PID file of suricata.
42 PID_FILE
="/var/run/suricata.pid"
44 # Function to get the amount of CPU cores of the system.
45 function get_cpu_count
{
48 # Loop through "/proc/cpuinfo" and count the amount of CPU cores.
50 [ "$line" ] && [ -z "${line%processor*}" ] && ((CPUCOUNT
++))
53 # Limit to a maximum of 16 cores, because suricata does not support more than
54 # 16 netfilter queues at the moment.
55 if [ $CPUCOUNT -gt "16" ]; then
62 # Function to flush the firewall chains.
63 function flush_fw_chain
{
64 # Call iptables and flush the chains
65 iptables
-F "$IPS_INPUT_CHAIN"
66 iptables
-F "$IPS_FORWARD_CHAIN"
67 iptables
-F "$IPS_OUTPUT_CHAIN"
70 # Function to create the firewall rules to pass the traffic to suricata.
71 function generate_fw_rules
{
72 cpu_count
=$
(get_cpu_count
)
74 # Loop through the array of network zones.
75 for zone
in "${network_zones[@]}"; do
76 # Convert zone into upper case.
79 # Generate variable name for checking if the IDS is
80 # enabled on the zone.
81 enable_ids_zone
="ENABLE_IDS_$zone_upper"
83 # Check if the IDS is enabled for this network zone.
84 if [ "${!enable_ids_zone}" == "on" ]; then
85 # Check if the current processed zone is "red" and the configured type is PPPoE dialin.
86 if [ "$zone" == "red" ] && [ "$RED_TYPE" == "PPPOE" ]; then
87 # Set device name to ppp0.
89 elif [ "$zone" == "ovpn" ]; then
90 # Get all virtual net devices because the RW server and each
91 # N2N connection creates it's own tun device.
92 for virt_dev
in /sys
/devices
/virtual
/net
/*; do
93 # Cut-off the directory.
96 # Only process tun devices.
97 if [[ $dev =~
"tun" ]]; then
98 # Add the network device to the array of enabled zones.
99 enabled_ips_zones
+=( "$dev" )
106 # Generate variable name which contains the device name.
107 zone_name
="$zone_upper"
111 network_device
=${!zone_name}
114 # Add the network device to the array of enabled zones.
115 enabled_ips_zones
+=( "$network_device" )
120 NFQ_OPTIONS
=$NFQ_OPTS
122 # Check if there are multiple cpu cores available.
123 if [ "$cpu_count" -gt "1" ]; then
124 # Balance beetween all queues.
125 NFQ_OPTIONS
+="--queue-balance 0:$(($cpu_count-1))"
126 NFQ_OPTIONS
+=" --queue-cpu-fanout"
128 # Send all packets to queue 0.
129 NFQ_OPTIONS
+="--queue-num 0"
132 # Flush the firewall chains.
135 # Check if the array of enabled_ips_zones contains any elements.
136 if [[ ${enabled_ips_zones[@]} ]]; then
137 # Loop through the array and create firewall rules.
138 for enabled_ips_zone
in "${enabled_ips_zones[@]}"; do
139 # Create rules queue input and output related traffic and pass it to the IPS.
140 iptables
-I "$IPS_INPUT_CHAIN" -i "$enabled_ips_zone" -m mark
! --mark "$MARK"/"$MASK" -j NFQUEUE
$NFQ_OPTIONS
141 iptables
-I "$IPS_OUTPUT_CHAIN" -o "$enabled_ips_zone" -m mark
! --mark "$MARK"/"$MASK" -j NFQUEUE
$NFQ_OPTIONS
143 # Create rules which are required to handle forwarded traffic.
144 for enabled_ips_zone_forward
in "${enabled_ips_zones[@]}"; do
145 iptables
-I "$IPS_FORWARD_CHAIN" -i "$enabled_ips_zone" -o "$enabled_ips_zone_forward" -m mark
! --mark "$MARK"/"$MASK" -j NFQUEUE
$NFQ_OPTIONS
149 # Clear repeat bit, so that it does not confuse IPsec or QoS
150 iptables
-A "${IPS_INPUT_CHAIN}" -j MARK
--set-xmark "0x0/${MASK}"
151 iptables
-A "${IPS_FORWARD_CHAIN}" -j MARK
--set-xmark "0x0/${MASK}"
152 iptables
-A "${IPS_OUTPUT_CHAIN}" -j MARK
--set-xmark "0x0/${MASK}"
158 # Get amount of CPU cores.
159 cpu_count
=$
(get_cpu_count
)
164 if [ $cpu_count -gt "1" ]; then
165 NFQUEUES
+=":$(($cpu_count-1))"
168 # Check if the IDS should be started.
169 if [ "$ENABLE_IDS" == "on" ]; then
171 boot_mesg
"Starting Intrusion Detection System..."
172 /usr
/bin
/suricata
-c /etc
/suricata
/suricata.yaml
-D $NFQUEUES >/dev
/null
2>/dev
/null
175 # Allow reading the pidfile.
178 # Flush the firewall chain
181 # Generate firewall rules
187 boot_mesg
"Stopping Intrusion Detection System..."
188 killproc
-p $PID_FILE /var
/run
190 # Flush firewall chain.
193 # Remove suricata control socket.
194 rm /var
/run
/suricata
/* >/dev
/null
2>/dev
/null
196 # Trash remain pid file if still exists.
197 rm -f $PID_FILE >/dev
/null
2>/dev
/null
199 # Don't report returncode of rm if suricata was not started
204 statusproc
/usr
/bin
/suricata
212 # Send SIGUSR2 to the suricata process to perform a reload
214 kill -USR2 $
(pidof suricata
)
216 # Flush the firewall chain.
219 # Generate firewall rules.
224 echo "Usage: $0 {start|stop|restart|reload|status}"
229 chmod 644 /var
/log
/suricata
/* 2>/dev
/null
231 # End $rc_base/init.d/suricata