2 ###############################################################################
4 # IPFire.org - A linux based firewall #
5 # Copyright (C) 2007-2019 IPFire Team <info@ipfire.org> #
7 # This program is free software: you can redistribute it and/or modify #
8 # it under the terms of the GNU General Public License as published by #
9 # the Free Software Foundation, either version 3 of the License, or #
10 # (at your option) any later version. #
12 # This program is distributed in the hope that it will be useful, #
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of #
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
15 # GNU General Public License for more details. #
17 # You should have received a copy of the GNU General Public License #
18 # along with this program. If not, see <http://www.gnu.org/licenses/>. #
20 ###############################################################################
23 use experimental
'smartmatch';
25 require '/var/ipfire/general-functions.pl';
26 require "${General::swroot}/lang.pl";
27 require "/usr/lib/firewall/firewall-lib.pl";
29 # Set to one to enable debugging mode.
32 my $IPTABLES = "iptables --wait";
35 my $CHAIN_INPUT = "INPUTFW";
36 my $CHAIN_FORWARD = "FORWARDFW";
37 my $CHAIN_OUTPUT = "OUTGOINGFW";
38 my $CHAIN = $CHAIN_FORWARD;
39 my $CHAIN_NAT_SOURCE = "NAT_SOURCE";
40 my $CHAIN_NAT_DESTINATION = "NAT_DESTINATION";
41 my $CHAIN_MANGLE_NAT_DESTINATION_FIX = "NAT_DESTINATION";
42 my @VALID_CHAINS = ($CHAIN_INPUT, $CHAIN_FORWARD, $CHAIN_OUTPUT);
43 my @ANY_ADDRESSES = ("0.0.0.0/0.0.0.0", "0.0.0.0/0", "0/0");
45 my @PROTOCOLS = ("tcp", "udp", "icmp", "igmp", "ah", "esp", "gre", "ipv6", "ipip");
46 my @PROTOCOLS_WITH_PORTS = ("tcp", "udp");
48 my @VALID_TARGETS = ("ACCEPT", "DROP", "REJECT");
52 my %defaultNetworks=();
56 my %configoutgoingfw=();
59 "GEOIPBLOCK_ENABLED" => "off"
64 my $configfwdfw = "${General::swroot}/firewall/config";
65 my $configinput = "${General::swroot}/firewall/input";
66 my $configoutgoing = "${General::swroot}/firewall/outgoing";
67 my $p2pfile = "${General::swroot}/firewall/p2protocols";
68 my $geoipfile = "${General::swroot}/firewall/geoipblock";
69 my $configgrp = "${General::swroot}/fwhosts/customgroups";
70 my $netsettings = "${General::swroot}/ethernet/settings";
72 &General
::readhash
("${General::swroot}/firewall/settings", \
%fwdfwsettings);
73 &General
::readhash
("${General::swroot}/optionsfw/settings", \
%fwoptions);
74 &General
::readhash
("$netsettings", \
%defaultNetworks);
75 &General
::readhasharray
($configfwdfw, \
%configfwdfw);
76 &General
::readhasharray
($configinput, \
%configinputfw);
77 &General
::readhasharray
($configoutgoing, \
%configoutgoingfw);
78 &General
::readhasharray
($configgrp, \
%customgrp);
80 # Check if the geoip settings file exists
81 if (-e
"$geoipfile") {
83 &General
::readhash
("$geoipfile", \
%geoipsettings);
86 # Get all GeoIP locations.
87 my @locations = &fwlib
::get_geoip_locations
();
89 my @log_limit_options = &make_log_limit_options
();
91 my $POLICY_INPUT_ALLOWED = 0;
92 my $POLICY_FORWARD_ALLOWED = ($fwdfwsettings{"POLICY"} eq "MODE2");
93 my $POLICY_OUTPUT_ALLOWED = ($fwdfwsettings{"POLICY1"} eq "MODE2");
95 my $POLICY_INPUT_ACTION = $fwoptions{"FWPOLICY2"};
96 my $POLICY_FORWARD_ACTION = $fwoptions{"FWPOLICY"};
97 my $POLICY_OUTPUT_ACTION = $fwoptions{"FWPOLICY1"};
106 # Prepare firewall rules.
107 if (! -z
"${General::swroot}/firewall/input"){
108 &buildrules
(\
%configinputfw);
110 if (! -z
"${General::swroot}/firewall/outgoing"){
111 &buildrules
(\
%configoutgoingfw);
113 if (! -z
"${General::swroot}/firewall/config"){
114 &buildrules
(\
%configfwdfw);
117 # Load P2P block rules.
120 # Load GeoIP block rules.
123 # Reload firewall policy.
124 run
("/usr/sbin/firewall-policy");
126 #Reload firewall.local if present
127 if ( -f
'/etc/sysconfig/firewall.local'){
128 run
("/etc/sysconfig/firewall.local reload");
133 # Executes or prints the given shell command.
142 print_error
("ERROR: $command");
150 print STDERR
"$message\n";
160 printf(" %2d: %s", $i++, $_);
168 return scalar @
$hash;
172 run
("$IPTABLES -F $CHAIN_INPUT");
173 run
("$IPTABLES -F $CHAIN_FORWARD");
174 run
("$IPTABLES -F $CHAIN_OUTPUT");
175 run
("$IPTABLES -t nat -F $CHAIN_NAT_SOURCE");
176 run
("$IPTABLES -t nat -F $CHAIN_NAT_DESTINATION");
177 run
("$IPTABLES -t mangle -F $CHAIN_MANGLE_NAT_DESTINATION_FIX");
183 # Search for targets that need to be specially handled when adding
184 # forwarding rules. Additional rules will automatically get inserted
185 # into the INPUT/OUTPUT chains for these targets.
186 my @special_input_targets = ();
187 if (!$POLICY_FORWARD_ALLOWED) {
188 push(@special_input_targets, "ACCEPT");
191 if ($POLICY_INPUT_ACTION eq "DROP") {
192 push(@special_input_targets, ("ACCEPT", "REJECT"));
193 } elsif ($POLICY_INPUT_ACTION eq "REJECT") {
194 push(@special_input_targets, ("ACCEPT", "DROP"));
197 my @special_output_targets = ();
198 if ($POLICY_OUTPUT_ALLOWED) {
199 push(@special_output_targets, ("DROP", "REJECT"));
201 push(@special_output_targets, "ACCEPT");
203 if ($POLICY_OUTPUT_ACTION eq "DROP") {
204 push(@special_output_targets, ("ACCEPT", "REJECT"));
205 } elsif ($POLICY_OUTPUT_ACTION eq "REJECT") {
206 push(@special_output_targets, ("ACCEPT", "DROP"));
210 foreach my $key (sort {$a <=> $b} keys %$hash) {
211 # Skip disabled rules.
212 next unless ($$hash{$key}[2] eq 'ON');
214 # Count number of elements in this line
215 my $elements = &count_elements
($$hash{$key});
218 print_rule
($$hash{$key});
221 # Check if the target is valid.
222 my $target = $$hash{$key}[0];
223 if (!$target ~~ @VALID_TARGETS) {
224 print_error
("Invalid target '$target' for rule $key");
228 # Check if the chain is valid.
229 my $chain = $$hash{$key}[1];
230 if (!$chain ~~ @VALID_CHAINS) {
231 print_error
("Invalid chain '$chain' in rule $key");
235 # Collect all sources.
236 my @sources = &fwlib
::get_addresses
($hash, $key, "src");
238 # Collect all destinations.
239 my @destinations = &fwlib
::get_addresses
($hash, $key, "tgt");
241 # True if the destination is the firewall itself.
242 my $destination_is_firewall = ($$hash{$key}[5] eq "ipfire");
244 # Check if logging should be enabled.
245 my $LOG = ($$hash{$key}[17] eq 'ON');
247 # Check if NAT is enabled and initialize variables, that we use for that.
248 my $NAT = ($$hash{$key}[28] eq 'ON');
251 $NAT_MODE = uc($$hash{$key}[31]);
254 # Set up time constraints.
255 my @time_options = ();
256 if ($$hash{$key}[18] eq 'ON') {
257 push(@time_options, ("-m", "time"));
259 # Select all days of the week this match is active.
261 if ($$hash{$key}[19] ne '') {
262 push (@weekdays, "Mon");
264 if ($$hash{$key}[20] ne '') {
265 push (@weekdays, "Tue");
267 if ($$hash{$key}[21] ne '') {
268 push (@weekdays, "Wed");
270 if ($$hash{$key}[22] ne '') {
271 push (@weekdays, "Thu");
273 if ($$hash{$key}[23] ne '') {
274 push (@weekdays, "Fri");
276 if ($$hash{$key}[24] ne '') {
277 push (@weekdays, "Sat");
279 if ($$hash{$key}[25] ne '') {
280 push (@weekdays, "Sun");
283 push(@time_options, ("--weekdays", join(",", @weekdays)));
286 # Convert start time.
287 my $time_start = &format_time
($$hash{$key}[26]);
289 push(@time_options, ("--timestart", $time_start));
293 my $time_stop = &format_time
($$hash{$key}[27]);
295 push(@time_options, ("--timestop", $time_stop));
299 # Concurrent connection limit
300 my @ratelimit_options = ();
302 if (($elements ge 34) && ($$hash{$key}[32] eq 'ON')) {
303 my $conn_limit = $$hash{$key}[33];
305 if ($conn_limit ge 1) {
306 push(@ratelimit_options, ("-m", "connlimit"));
308 # Use the the entire source IP address
309 push(@ratelimit_options, "--connlimit-saddr");
310 push(@ratelimit_options, ("--connlimit-mask", "32"));
313 push(@ratelimit_options, ("--connlimit-upto", $conn_limit));
318 if (($elements ge 37) && ($$hash{$key}[34] eq 'ON')) {
319 my $rate_limit = "$$hash{$key}[35]/$$hash{$key}[36]";
322 push(@ratelimit_options, ("-m", "limit"));
323 push(@ratelimit_options, ("--limit", $rate_limit));
327 # Check which protocols are used in this rule and so that we can
328 # later group rules by protocols.
329 my @protocols = &get_protocols
($hash, $key);
331 print_error
("Invalid protocol configuration for rule $key");
335 foreach my $protocol (@protocols) {
336 # Check if the given protocol is supported.
337 if (($protocol ne "all") && (!$protocol ~~ @PROTOCOLS)) {
338 print_error
("Protocol $protocol is not supported (rule $key)");
342 # Prepare protocol options (like ICMP types, ports, etc...).
343 my @protocol_options = &get_protocol_options
($hash, $key, $protocol, 0);
345 # Check if this protocol knows ports.
346 my $protocol_has_ports = ($protocol ~~ @PROTOCOLS_WITH_PORTS);
348 foreach my $src (@sources) {
349 # Skip invalid source.
350 next unless (defined $src);
354 my $source = @
$src[0];
355 if ($source ~~ @ANY_ADDRESSES) {
359 my $source_intf = @
$src[1];
361 foreach my $dst (@destinations) {
362 # Skip invalid rules.
363 next unless (defined $dst);
364 next if (!$dst || ($dst eq "none"));
366 # Sanitize destination.
367 my $destination = @
$dst[0];
368 if ($destination ~~ @ANY_ADDRESSES) {
372 my $destination_intf = @
$dst[1];
374 # Array with iptables arguments.
378 if ($protocol ne "all") {
379 push(@options, @protocol_options);
382 # Prepare source options.
383 my @source_options = ();
384 if ($source =~ /mac/) {
385 push(@source_options, $source);
386 } elsif ($source =~ /-m geoip/) {
387 push(@source_options, $source);
389 push(@source_options, ("-s", $source));
392 # Prepare destination options.
393 my @destination_options = ();
394 if ($destination =~ /-m geoip/) {
395 push(@destination_options, $destination);
396 } elsif ($destination) {
397 push(@destination_options, ("-d", $destination));
400 # Add source and destination interface to the filter rules.
401 # These are supposed to help filtering forged packets that originate
402 # from BLUE with an IP address from GREEN for instance.
403 my @source_intf_options = ();
405 push(@source_intf_options, ("-i", $source_intf));
408 my @destination_intf_options = ();
409 if ($destination_intf) {
410 push(@destination_intf_options, ("-o", $destination_intf));
413 # Add time constraint options.
414 push(@options, @time_options);
416 # Add ratelimiting option
417 push(@options, @ratelimit_options);
419 my $firewall_is_in_source_subnet = 1;
421 $firewall_is_in_source_subnet = &firewall_is_in_subnet
($source);
424 my $firewall_is_in_destination_subnet = 1;
426 $firewall_is_in_destination_subnet = &firewall_is_in_subnet
($destination);
431 my $nat_address = &fwlib
::get_nat_address
($$hash{$key}[29], $source);
433 # Skip NAT rules if the NAT address is unknown
434 # (i.e. no internet connection has been established, yet).
435 next unless ($nat_address);
438 if ($NAT_MODE eq "DNAT") {
439 my @nat_options = ();
440 if ($protocol ne "all") {
441 my @nat_protocol_options = &get_protocol_options
($hash, $key, $protocol, 1);
442 push(@nat_options, @nat_protocol_options);
444 push(@nat_options, @time_options);
446 # Make port-forwardings useable from the internal networks.
447 my @internal_addresses = &fwlib
::get_internal_firewall_ip_addresses
(1);
448 unless ($nat_address ~~ @internal_addresses) {
449 &add_dnat_mangle_rules
($nat_address, $source_intf, @nat_options);
452 push(@nat_options, @source_options);
453 push(@nat_options, ("-d", $nat_address));
456 if ($protocol_has_ports) {
457 $dnat_port = &get_dnat_target_port
($hash, $key);
460 my @nat_action_options = ();
462 # Use iptables REDIRECT
463 my $use_redirect = ($destination_is_firewall && !$destination && $protocol_has_ports && $dnat_port);
465 push(@nat_action_options, ("-j", "REDIRECT", "--to-ports", $dnat_port));
469 if ($destination_is_firewall && !$destination) {
470 $destination = &fwlib
::get_external_address
();
472 next unless ($destination);
474 my ($dnat_address, $dnat_mask) = split("/", $destination);
475 @destination_options = ("-d", $dnat_address);
477 if ($protocol_has_ports) {
478 my $dnat_port = &get_dnat_target_port
($hash, $key);
481 $dnat_address .= ":$dnat_port";
485 push(@nat_action_options, ("-j", "DNAT", "--to-destination", $dnat_address));
489 run
("$IPTABLES -t nat -A $CHAIN_NAT_DESTINATION @nat_options @log_limit_options -j LOG --log-prefix 'DNAT '");
491 run
("$IPTABLES -t nat -A $CHAIN_NAT_DESTINATION @nat_options @nat_action_options");
494 } elsif ($NAT_MODE eq "SNAT") {
495 my @snat_options = ( "-m", "policy", "--dir", "out", "--pol", "none" );
496 my @nat_options = @options;
498 # Get addresses for the configured firewall interfaces.
499 my @local_addresses = &fwlib
::get_internal_firewall_ip_addresses
(1);
501 # Check if the nat_address is one of the local addresses.
502 foreach my $local_address (@local_addresses) {
503 if ($nat_address eq $local_address) {
504 # Clear SNAT options.
512 push(@nat_options, @destination_intf_options);
513 push(@nat_options, @source_options);
514 push(@nat_options, @destination_options);
517 run
("$IPTABLES -t nat -A $CHAIN_NAT_SOURCE @nat_options @snat_options @log_limit_options -j LOG --log-prefix 'SNAT '");
519 run
("$IPTABLES -t nat -A $CHAIN_NAT_SOURCE @nat_options @snat_options -j SNAT --to-source $nat_address");
523 push(@options, @source_options);
524 push(@options, @destination_options);
526 # Insert firewall rule.
528 run
("$IPTABLES -A $chain @options @source_intf_options @destination_intf_options @log_limit_options -j LOG --log-prefix '$chain '");
530 run
("$IPTABLES -A $chain @options @source_intf_options @destination_intf_options -j $target");
532 # Handle forwarding rules and add corresponding rules for firewall access.
533 if ($chain eq $CHAIN_FORWARD) {
534 # If the firewall is part of the destination subnet and access to the destination network
535 # is granted/forbidden for any network that the firewall itself is part of, we grant/forbid access
536 # for the firewall, too.
537 if ($firewall_is_in_destination_subnet && ($target ~~ @special_input_targets)) {
539 run
("$IPTABLES -A $CHAIN_INPUT @options @source_intf_options @log_limit_options -j LOG --log-prefix '$CHAIN_INPUT '");
541 run
("$IPTABLES -A $CHAIN_INPUT @options @source_intf_options -j $target");
545 if ($firewall_is_in_source_subnet && ($target ~~ @special_output_targets)) {
547 run
("$IPTABLES -A $CHAIN_OUTPUT @options @destination_intf_options @log_limit_options -j LOG --log-prefix '$CHAIN_OUTPUT '");
549 run
("$IPTABLES -A $CHAIN_OUTPUT @options @destination_intf_options -j $target");
558 # Formats the given timestamp into the iptables format which is "hh:mm" UTC.
562 # Convert the given time into minutes.
563 my $minutes = &time_convert_to_minutes
($val);
565 # Move the timestamp into UTC.
566 $minutes += &time_utc_offset
();
568 # Make sure $minutes is between 00:00 and 23:59.
573 if ($minutes > 1440) {
578 return sprintf("%02d:%02d", $minutes / 60, $minutes % 60);
581 # Calculates the offsets in minutes from the local timezone to UTC.
582 sub time_utc_offset
{
583 my @localtime = localtime(time);
584 my @gmtime = gmtime(time);
586 return ($gmtime[2] * 60 + $gmtime[1] % 60) - ($localtime[2] * 60 + $localtime[1] % 60);
589 # Takes a timestamp like "14:00" and converts it into minutes since midnight.
590 sub time_convert_to_minutes
{
591 my ($hrs, $min) = split(":", shift);
593 return ($hrs * 60) + $min;
597 open(FILE
, "<$p2pfile") or die "Unable to read $p2pfile";
599 foreach my $p2pentry (<FILE
>) {
600 my @p2pline = split(/\;/, $p2pentry);
601 next unless ($p2pline[2] eq "off");
603 push(@protocols, "--$p2pline[1]");
607 run
("$IPTABLES -F P2PBLOCK");
609 run
("$IPTABLES -A P2PBLOCK -m ipp2p @protocols -j DROP");
614 # Flush iptables chain.
615 run
("$IPTABLES -F GEOIPBLOCK");
617 # If geoip blocking is not enabled, we are finished here.
618 if ($geoipsettings{'GEOIPBLOCK_ENABLED'} ne "on") {
619 # Exit submodule. Process remaining script.
623 # Loop through all supported geoip locations and
624 # create iptables rules, if blocking this country
626 foreach my $location (@locations) {
627 if(exists $geoipsettings{$location} && $geoipsettings{$location} eq "on") {
628 run
("$IPTABLES -A GEOIPBLOCK -m geoip --src-cc $location -j DROP");
637 my $uses_source_ports = ($$hash{$key}[7] eq "ON");
638 my $uses_services = ($$hash{$key}[11] eq "ON");
642 # Rules which don't have source ports or services (like ICMP, ESP, ...).
643 if (!$uses_source_ports && !$uses_services) {
644 push(@protocols, $$hash{$key}[8]);
646 # Rules which either use ports or services.
647 } elsif ($uses_source_ports || $uses_services) {
648 # Check if service group or service
649 if ($$hash{$key}[14] eq 'cust_srv') {
650 push(@protocols, &fwlib
::get_srv_prot
($$hash{$key}[15]));
652 } elsif($$hash{$key}[14] eq 'cust_srvgrp'){
653 my $protos = &fwlib
::get_srvgrp_prot
($$hash{$key}[15]);
654 push(@protocols, split(",", $protos));
657 # Fetch the protocol for this rule.
658 my $protocol = lc($$hash{$key}[8]);
660 # Fetch source and destination ports for this rule.
661 my $source_ports = $$hash{$key}[10];
662 my $destination_ports = $$hash{$key}[15];
664 # Check if ports are set for protocols which do not support ports.
665 if (!($protocol ~~ @PROTOCOLS_WITH_PORTS) && ($source_ports || $destination_ports)) {
666 print_error
("$protocol does not support ports");
670 push(@protocols, $protocol);
674 # Remove all empty elements
675 @protocols = map { $_ ?
$_ : () } @protocols;
677 # If no protocol has been defined, we assume "all".
679 push(@protocols, "all");
682 # Make all protocol names lowercase.
683 @protocols = map { lc } @protocols;
688 sub get_protocol_options
{
691 my $protocol = shift;
692 my $nat_options_wanted = shift;
695 # Nothing to do if no protocol is specified.
696 if ($protocol eq "all") {
699 push(@options, ("-p", $protocol));
702 if ($protocol ~~ @PROTOCOLS_WITH_PORTS) {
703 # Process source ports.
704 my $use_src_ports = ($$hash{$key}[7] eq "ON");
705 my $src_ports = $$hash{$key}[10];
707 if ($use_src_ports && $src_ports) {
708 push(@options, &format_ports
($src_ports, "src"));
711 # Process destination ports.
712 my $use_dst_ports = ($$hash{$key}[11] eq "ON");
713 my $use_dnat = (($$hash{$key}[28] eq "ON") && ($$hash{$key}[31] eq "dnat"));
715 if ($use_dst_ports) {
716 my $dst_ports_mode = $$hash{$key}[14];
717 my $dst_ports = $$hash{$key}[15];
719 if (($dst_ports_mode eq "TGT_PORT") && $dst_ports) {
720 if ($nat_options_wanted && $use_dnat && $$hash{$key}[30]) {
721 $dst_ports = $$hash{$key}[30];
723 push(@options, &format_ports
($dst_ports, "dst"));
725 } elsif ($dst_ports_mode eq "cust_srv") {
726 if ($protocol eq "ICMP") {
727 push(@options, ("--icmp-type", &fwlib
::get_srv_port
($dst_ports, 3, "ICMP")));
729 $dst_ports = &fwlib
::get_srv_port
($dst_ports, 1, uc($protocol));
730 push(@options, &format_ports
($dst_ports, "dst"));
733 } elsif ($dst_ports_mode eq "cust_srvgrp") {
734 push(@options, &fwlib
::get_srvgrp_port
($dst_ports, uc($protocol)));
739 # Check if a single ICMP type is selected.
740 if ($protocol eq "icmp") {
741 my $icmp_type = $$hash{$key}[9];
743 if (($icmp_type ne "All ICMP-Types") && $icmp_type) {
744 push(@options, ("--icmp-type", $icmp_type));
756 if ($type eq "src") {
758 } elsif ($type eq "dst") {
764 if ($ports =~ /\|/) {
766 push(@options, ("-m", "multiport"));
770 push(@options, ($arg, $ports));
776 sub get_dnat_target_port
{
780 if ($$hash{$key}[14] eq "TGT_PORT") {
781 my $port = $$hash{$key}[15];
782 my $external_port = $$hash{$key}[30];
784 if ($external_port && ($port ne $external_port)) {
785 return $$hash{$key}[15];
790 sub add_dnat_mangle_rules
{
791 my $nat_address = shift;
792 my $interface = shift;
796 foreach my $zone ("GREEN", "BLUE", "ORANGE") {
799 # Skip rule if not all required information exists.
800 next unless (exists $defaultNetworks{$zone . "_NETADDRESS"});
801 next unless (exists $defaultNetworks{$zone . "_NETMASK"});
803 next if ($interface && $interface ne $defaultNetworks{$zone . "_DEV"});
805 my @mangle_options = @options;
807 my $netaddress = $defaultNetworks{$zone . "_NETADDRESS"};
808 $netaddress .= "/" . $defaultNetworks{$zone . "_NETMASK"};
810 push(@mangle_options, ("-s", $netaddress, "-d", $nat_address));
811 push(@mangle_options, ("-j", "MARK", "--set-mark", $mark));
813 run
("$IPTABLES -t mangle -A $CHAIN_MANGLE_NAT_DESTINATION_FIX @mangle_options");
817 sub make_log_limit_options
{
818 my @options = ("-m", "limit");
820 # Maybe we should get this from the configuration.
823 # We limit log messages to $limit messages per second.
824 push(@options, ("--limit", "$limit/second"));
826 # And we allow bursts of 2x $limit.
827 push(@options, ("--limit-burst", $limit * 2));
832 sub firewall_is_in_subnet
{
835 # ORANGE is missing here, because nothing may ever access
836 # the firewall from this network.
837 my $address = &fwlib
::get_internal_firewall_ip_address
($subnet, 0);