[people/pmueller/ipfire-2.x.git] / src / initscripts / system / suricata

#!/bin/sh
########################################################################
# Begin $rc_base/init.d/suricata
#
# Description : Suricata Initscript
#
# Author      : Stefan Schantl <stefan.schantl@ipfire.org>
#
# Version     : 01.03
#
# Notes       :
#
########################################################################

. /etc/sysconfig/rc
. ${rc_functions}

PATH=/usr/local/sbin:/usr/local/bin:/bin:/usr/bin:/sbin:/usr/sbin; export PATH

eval $(/usr/local/bin/readhash /var/ipfire/suricata/settings)
eval $(/usr/local/bin/readhash /var/ipfire/ethernet/settings)

# Name of the firewall chains.
IPS_INPUT_CHAIN="IPS_INPUT"
IPS_FORWARD_CHAIN="IPS_FORWARD"
IPS_OUTPUT_CHAIN="IPS_OUTPUT"

# Optional options for the Netfilter queue.
NFQ_OPTS="--queue-bypass "

# Array containing the 4 possible network zones.
network_zones=( red green blue orange ovpn )

# Array to store the network zones weather the IPS is enabled for.
enabled_ips_zones=()

# Mark and Mask options.
REPEAT_MARK="0x80000000"
REPEAT_MASK="0x80000000"
BYPASS_MARK="0x40000000"
BYPASS_MASK="0x40000000"

# PID file of suricata.
PID_FILE="/var/run/suricata.pid"

# Function to get the amount of CPU cores of the system.
function get_cpu_count {
	CPUCOUNT=0

	# Loop through "/proc/cpuinfo" and count the amount of CPU cores.
	while read line; do
		[ "$line" ] && [ -z "${line%processor*}" ]  && ((CPUCOUNT++))
	done </proc/cpuinfo

	# Limit to a maximum of 16 cores, because suricata does not support more than
	# 16 netfilter queues at the moment.
	if [ $CPUCOUNT -gt "16" ]; then
		echo "16"
	else
		echo $CPUCOUNT
	fi
}

# Function to flush the firewall chains.
function flush_fw_chain {
	# Call iptables and flush the chains
	iptables -w -F "$IPS_INPUT_CHAIN"
	iptables -w -F "$IPS_FORWARD_CHAIN"
	iptables -w -F "$IPS_OUTPUT_CHAIN"
}

# Function to create the firewall rules to pass the traffic to suricata.
function generate_fw_rules {
	cpu_count=$(get_cpu_count)

	# Loop through the array of network zones.
	for zone in "${network_zones[@]}"; do
		# Convert zone into upper case.
		zone_upper=${zone^^}

		# Generate variable name for checking if the IDS is
		# enabled on the zone.
		enable_ids_zone="ENABLE_IDS_$zone_upper"

		# Check if the IDS is enabled for this network zone.
		if [ "${!enable_ids_zone}" == "on" ]; then
			# Check if the current processed zone is "red" and the configured type is PPPoE dialin.
			if [ "$zone" == "red" ] && [ "$RED_TYPE" == "PPPOE" ]; then
				# Set device name to ppp0.
				network_device="ppp0"
			elif [ "$zone" == "ovpn" ]; then
				# Get all virtual net devices because the RW server and each
				# N2N connection creates it's own tun device.
				for virt_dev in /sys/devices/virtual/net/*; do
					# Cut-off the directory.
					dev="${virt_dev##*/}"

					# Only process tun devices.
					if [[ $dev =~ "tun" ]]; then
						# Add the network device to the array of enabled zones.
						enabled_ips_zones+=( "$dev" )
					fi
				done

				# Process next zone.
				continue
			else
				# Generate variable name which contains the device name.
				zone_name="$zone_upper"
				zone_name+="_DEV"

				# Grab device name.
				network_device=${!zone_name}
			fi

			# Add the network device to the array of enabled zones.
			enabled_ips_zones+=( "$network_device" )
		fi
	done

	# Assign NFQ_OPTS
	NFQ_OPTIONS=$NFQ_OPTS

	# Check if there are multiple cpu cores available.
	if [ "$cpu_count" -gt "1" ]; then
		# Balance beetween all queues.
		NFQ_OPTIONS+="--queue-balance 0:$(($cpu_count-1))"
		NFQ_OPTIONS+=" --queue-cpu-fanout"
	else
		# Send all packets to queue 0.
		NFQ_OPTIONS+="--queue-num 0"
	fi

	# Flush the firewall chains.
	flush_fw_chain

	# Check if the array of enabled_ips_zones contains any elements.
	if [[ ${enabled_ips_zones[@]} ]]; then
		# Loop through the array and create firewall rules.
		for enabled_ips_zone in "${enabled_ips_zones[@]}"; do
			# Create rules queue input and output related traffic and pass it to the IPS.
			iptables -w -I "$IPS_INPUT_CHAIN" -i "$enabled_ips_zone" -m mark ! --mark "${REPEAT_MARK}/${REPEAT_MASK}" -j NFQUEUE $NFQ_OPTIONS
			iptables -w -I "$IPS_OUTPUT_CHAIN" -o "$enabled_ips_zone" -m mark ! --mark "${REPEAT_MARK}/${REPEAT_MASK}" -j NFQUEUE $NFQ_OPTIONS

			# Create rules which are required to handle forwarded traffic.
			for enabled_ips_zone_forward in "${enabled_ips_zones[@]}"; do
				iptables -w -I "$IPS_FORWARD_CHAIN" -i "$enabled_ips_zone" -o "$enabled_ips_zone_forward" -m mark ! --mark "${REPEAT_MARK}/${REPEAT_MASK}" -j NFQUEUE $NFQ_OPTIONS
			done
		done

		# Clear repeat bit, so that it does not confuse IPsec or QoS
		iptables -w -A "${IPS_INPUT_CHAIN}" -j MARK --set-xmark "0x0/${REPEAT_MASK}"
		iptables -w -A "${IPS_FORWARD_CHAIN}" -j MARK --set-xmark "0x0/${REPEAT_MASK}"
		iptables -w -A "${IPS_OUTPUT_CHAIN}" -j MARK --set-xmark "0x0/${REPEAT_MASK}"
	fi
}

case "$1" in
        start)
		# Get amount of CPU cores.
		cpu_count=$(get_cpu_count)

		# Numer of NFQUES.
		NFQUEUES="-q 0"

		if [ $cpu_count -gt "1" ]; then
			NFQUEUES+=":$(($cpu_count-1))"
		fi

		# Check if the IDS should be started.
		if [ "$ENABLE_IDS" == "on" ]; then
			# Start the IDS.
			boot_mesg "Starting Intrusion Detection System..."
			/usr/bin/suricata -c /etc/suricata/suricata.yaml -D $NFQUEUES >/dev/null 2>/dev/null
			evaluate_retval

			# Allow reading the pidfile.
			chmod 644 $PID_FILE

			# Flush the firewall chain
			flush_fw_chain

			# Generate firewall rules
			generate_fw_rules
		fi
	;;

        stop)
		boot_mesg "Stopping Intrusion Detection System..."
		killproc -p $PID_FILE /var/run

		# Flush firewall chain.
		flush_fw_chain

		# Sometimes suricata not correct shutdown. So killall.
		killall -KILL /usr/bin/suricata 2>/dev/null

		# Remove suricata control socket.
		rm /var/run/suricata/* >/dev/null 2>/dev/null

		# Trash remain pid file if still exists.
		rm -f $PID_FILE >/dev/null 2>/dev/null

		# Don't report returncode of rm if suricata was not started
		exit 0
        ;;
                
        status)
                statusproc /usr/bin/suricata
                ;;
                
        restart)
                $0 stop
                $0 start
                ;;
	reload)
		# Send SIGUSR2 to the suricata process to perform a reload
		# of the ruleset.
		kill -USR2 $(pidof suricata)

		# Flush the firewall chain.
		flush_fw_chain

		# Generate firewall rules.
		generate_fw_rules
		;;
                
        *)
                echo "Usage: $0 {start|stop|restart|reload|status}"
                exit 1
                ;;
esac

chmod 644 /var/log/suricata/* 2>/dev/null

# End $rc_base/init.d/suricata
Commit	Line	Data
d72b3e64 SS	1	#!/bin/sh
	2	########################################################################
	3	# Begin $rc_base/init.d/suricata
	4	#
	5	# Description : Suricata Initscript
	6	#
	7	# Author : Stefan Schantl <stefan.schantl@ipfire.org>
	8	#
1a65ea1b	9	# Version : 01.03
d72b3e64 SS	10	#
	11	# Notes :
	12	#
	13	########################################################################
	14
	15	. /etc/sysconfig/rc
	16	. ${rc_functions}
	17
	18	PATH=/usr/local/sbin:/usr/local/bin:/bin:/usr/bin:/sbin:/usr/sbin; export PATH
	19
d72b3e64	20	eval $(/usr/local/bin/readhash /var/ipfire/suricata/settings)
e8a28edb	21	eval $(/usr/local/bin/readhash /var/ipfire/ethernet/settings)
d72b3e64	22
9cf253e1 SS	23	# Name of the firewall chains.
	24	IPS_INPUT_CHAIN="IPS_INPUT"
	25	IPS_FORWARD_CHAIN="IPS_FORWARD"
	26	IPS_OUTPUT_CHAIN="IPS_OUTPUT"
3c2c5483 SS	27
	28	# Optional options for the Netfilter queue.
	29	NFQ_OPTS="--queue-bypass "
	30
	31	# Array containing the 4 possible network zones.
51b63b41	32	network_zones=( red green blue orange ovpn )
3c2c5483	33
9cf253e1 SS	34	# Array to store the network zones weather the IPS is enabled for.
	35	enabled_ips_zones=()
	36
3c2c5483	37	# Mark and Mask options.
4f07c279 MT	38	REPEAT_MARK="0x80000000"
4f07c279 MT	39	REPEAT_MASK="0x80000000"
11f7218f MT	40	BYPASS_MARK="0x40000000"
11f7218f MT	41	BYPASS_MASK="0x40000000"
3c2c5483	42
00a03114 SS	43	# PID file of suricata.
	44	PID_FILE="/var/run/suricata.pid"
	45
c9b07d6a SS	46	# Function to get the amount of CPU cores of the system.
	47	function get_cpu_count {
	48	CPUCOUNT=0
	49
	50	# Loop through "/proc/cpuinfo" and count the amount of CPU cores.
	51	while read line; do
	52	[ "$line" ] && [ -z "${line%processor*}" ] && ((CPUCOUNT++))
	53	done </proc/cpuinfo
	54
a8387f8d SS	55	# Limit to a maximum of 16 cores, because suricata does not support more than
	56	# 16 netfilter queues at the moment.
	57	if [ $CPUCOUNT -gt "16" ]; then
	58	echo "16"
	59	else
	60	echo $CPUCOUNT
	61	fi
c9b07d6a SS	62	}
c9b07d6a SS	63
9cf253e1	64	# Function to flush the firewall chains.
5e3067cb	65	function flush_fw_chain {
9cf253e1	66	# Call iptables and flush the chains
f78eb45c MT	67	iptables -w -F "$IPS_INPUT_CHAIN"
	68	iptables -w -F "$IPS_FORWARD_CHAIN"
	69	iptables -w -F "$IPS_OUTPUT_CHAIN"
5e3067cb SS	70	}
5e3067cb SS	71
c9b07d6a SS	72	# Function to create the firewall rules to pass the traffic to suricata.
	73	function generate_fw_rules {
	74	cpu_count=$(get_cpu_count)
	75
c9b07d6a SS	76	# Loop through the array of network zones.
	77	for zone in "${network_zones[@]}"; do
	78	# Convert zone into upper case.
	79	zone_upper=${zone^^}
	80
	81	# Generate variable name for checking if the IDS is
	82	# enabled on the zone.
	83	enable_ids_zone="ENABLE_IDS_$zone_upper"
	84
	85	# Check if the IDS is enabled for this network zone.
	86	if [ "${!enable_ids_zone}" == "on" ]; then
e8a28edb SS	87	# Check if the current processed zone is "red" and the configured type is PPPoE dialin.
	88	if [ "$zone" == "red" ] && [ "$RED_TYPE" == "PPPOE" ]; then
	89	# Set device name to ppp0.
	90	network_device="ppp0"
51b63b41 SS	91	elif [ "$zone" == "ovpn" ]; then
	92	# Get all virtual net devices because the RW server and each
	93	# N2N connection creates it's own tun device.
	94	for virt_dev in /sys/devices/virtual/net/*; do
	95	# Cut-off the directory.
	96	dev="${virt_dev##*/}"
	97
	98	# Only process tun devices.
	99	if [[ $dev =~ "tun" ]]; then
	100	# Add the network device to the array of enabled zones.
	101	enabled_ips_zones+=( "$dev" )
	102	fi
	103	done
	104
	105	# Process next zone.
	106	continue
e8a28edb SS	107	else
	108	# Generate variable name which contains the device name.
	109	zone_name="$zone_upper"
	110	zone_name+="_DEV"
	111
	112	# Grab device name.
	113	network_device=${!zone_name}
	114	fi
c9b07d6a	115
9cf253e1 SS	116	# Add the network device to the array of enabled zones.
9cf253e1 SS	117	enabled_ips_zones+=( "$network_device" )
c9b07d6a SS	118	fi
c9b07d6a SS	119	done
5d04cfe7	120
9cf253e1 SS	121	# Assign NFQ_OPTS
	122	NFQ_OPTIONS=$NFQ_OPTS
	123
	124	# Check if there are multiple cpu cores available.
	125	if [ "$cpu_count" -gt "1" ]; then
	126	# Balance beetween all queues.
	127	NFQ_OPTIONS+="--queue-balance 0:$(($cpu_count-1))"
	128	NFQ_OPTIONS+=" --queue-cpu-fanout"
	129	else
	130	# Send all packets to queue 0.
	131	NFQ_OPTIONS+="--queue-num 0"
	132	fi
	133
	134	# Flush the firewall chains.
	135	flush_fw_chain
	136
	137	# Check if the array of enabled_ips_zones contains any elements.
	138	if [[ ${enabled_ips_zones[@]} ]]; then
	139	# Loop through the array and create firewall rules.
	140	for enabled_ips_zone in "${enabled_ips_zones[@]}"; do
	141	# Create rules queue input and output related traffic and pass it to the IPS.
4f07c279 MT	142	iptables -w -I "$IPS_INPUT_CHAIN" -i "$enabled_ips_zone" -m mark ! --mark "${REPEAT_MARK}/${REPEAT_MASK}" -j NFQUEUE $NFQ_OPTIONS
4f07c279 MT	143	iptables -w -I "$IPS_OUTPUT_CHAIN" -o "$enabled_ips_zone" -m mark ! --mark "${REPEAT_MARK}/${REPEAT_MASK}" -j NFQUEUE $NFQ_OPTIONS
9cf253e1 SS	144
	145	# Create rules which are required to handle forwarded traffic.
	146	for enabled_ips_zone_forward in "${enabled_ips_zones[@]}"; do
4f07c279	147	iptables -w -I "$IPS_FORWARD_CHAIN" -i "$enabled_ips_zone" -o "$enabled_ips_zone_forward" -m mark ! --mark "${REPEAT_MARK}/${REPEAT_MASK}" -j NFQUEUE $NFQ_OPTIONS
9cf253e1 SS	148	done
	149	done
	150
	151	# Clear repeat bit, so that it does not confuse IPsec or QoS
4f07c279 MT	152	iptables -w -A "${IPS_INPUT_CHAIN}" -j MARK --set-xmark "0x0/${REPEAT_MASK}"
	153	iptables -w -A "${IPS_FORWARD_CHAIN}" -j MARK --set-xmark "0x0/${REPEAT_MASK}"
	154	iptables -w -A "${IPS_OUTPUT_CHAIN}" -j MARK --set-xmark "0x0/${REPEAT_MASK}"
9cf253e1	155	fi
c9b07d6a SS	156	}
c9b07d6a SS	157
d72b3e64 SS	158	case "$1" in
	159	start)
	160	# Get amount of CPU cores.
c9b07d6a SS	161	cpu_count=$(get_cpu_count)
	162
	163	# Numer of NFQUES.
1a65ea1b	164	NFQUEUES="-q 0"
c9b07d6a	165
1a65ea1b SS	166	if [ $cpu_count -gt "1" ]; then
	167	NFQUEUES+=":$(($cpu_count-1))"
	168	fi
d72b3e64	169
3c2c5483 SS	170	# Check if the IDS should be started.
3c2c5483 SS	171	if [ "$ENABLE_IDS" == "on" ]; then
3c2c5483 SS	172	# Start the IDS.
3c2c5483 SS	173	boot_mesg "Starting Intrusion Detection System..."
af006569	174	/usr/bin/suricata -c /etc/suricata/suricata.yaml -D $NFQUEUES >/dev/null 2>/dev/null
3c2c5483	175	evaluate_retval
00a03114 SS	176
	177	# Allow reading the pidfile.
	178	chmod 644 $PID_FILE
c9b07d6a SS	179
	180	# Flush the firewall chain
	181	flush_fw_chain
	182
	183	# Generate firewall rules
	184	generate_fw_rules
3c2c5483	185	fi
d72b3e64 SS	186	;;
	187
	188	stop)
	189	boot_mesg "Stopping Intrusion Detection System..."
00a03114	190	killproc -p $PID_FILE /var/run
d72b3e64	191
3c2c5483	192	# Flush firewall chain.
c9b07d6a	193	flush_fw_chain
3c2c5483	194
57fda8c8 AF	195	# Sometimes suricata not correct shutdown. So killall.
	196	killall -KILL /usr/bin/suricata 2>/dev/null
	197
	198	# Remove suricata control socket.
d72b3e64 SS	199	rm /var/run/suricata/* >/dev/null 2>/dev/null
d72b3e64 SS	200
62910a28 SS	201	# Trash remain pid file if still exists.
	202	rm -f $PID_FILE >/dev/null 2>/dev/null
	203
d72b3e64 SS	204	# Don't report returncode of rm if suricata was not started
	205	exit 0
	206	;;
	207
	208	status)
	209	statusproc /usr/bin/suricata
	210	;;
	211
	212	restart)
	213	$0 stop
	214	$0 start
	215	;;
6187da50 SS	216	reload)
	217	# Send SIGUSR2 to the suricata process to perform a reload
	218	# of the ruleset.
	219	kill -USR2 $(pidof suricata)
c9b07d6a SS	220
	221	# Flush the firewall chain.
	222	flush_fw_chain
	223
	224	# Generate firewall rules.
	225	generate_fw_rules
6187da50	226	;;
d72b3e64 SS	227
d72b3e64 SS	228	*)
6187da50	229	echo "Usage: $0 {start\|stop\|restart\|reload\|status}"
d72b3e64 SS	230	exit 1
	231	;;
	232	esac
	233
	234	chmod 644 /var/log/suricata/* 2>/dev/null
	235
	236	# End $rc_base/init.d/suricata