2 ############################################################################
4 # This file is part of the IPFire Firewall. #
6 # IPFire is free software; you can redistribute it and/or modify #
7 # it under the terms of the GNU General Public License as published by #
8 # the Free Software Foundation; either version 2 of the License, or #
9 # (at your option) any later version. #
11 # IPFire is distributed in the hope that it will be useful, #
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of #
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
14 # GNU General Public License for more details. #
16 # You should have received a copy of the GNU General Public License #
17 # along with IPFire; if not, write to the Free Software #
18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA #
20 # Copyright (C) 2014 IPFire Team <info@ipfire.org>. #
22 ############################################################################
26 require "/var/ipfire/general-functions.pl";
30 # System ethernet configuration
31 our %ethernet_settings = ();
32 &General
::readhash
("${General::swroot}/ethernet/settings", \
%ethernet_settings);
34 # List of all possible network zones that can be configured
35 our @known_network_zones = ("red", "green", "orange", "blue");
37 # IPv4 netmask CIDR to dotted decimal notation conversion table
38 my %PREFIX2NETMASK = (
39 32 => "255.255.255.255",
40 31 => "255.255.255.254",
41 30 => "255.255.255.252",
42 29 => "255.255.255.248",
43 28 => "255.255.255.240",
44 27 => "255.255.255.224",
45 26 => "255.255.255.192",
46 25 => "255.255.255.128",
47 24 => "255.255.255.0",
48 23 => "255.255.254.0",
49 22 => "255.255.252.0",
50 21 => "255.255.248.0",
51 20 => "255.255.240.0",
52 19 => "255.255.224.0",
53 18 => "255.255.192.0",
54 17 => "255.255.128.0",
74 my %NETMASK2PREFIX = reverse(%PREFIX2NETMASK);
76 # Takes an IP address in dotted decimal notation and
77 # returns a 32 bit integer representing that IP addresss.
78 # Will return undef for invalid inputs.
82 # This function returns undef for undefined input.
83 if (!defined $address) {
87 my $address_bin = &Socket
::inet_pton
(AF_INET
, $address);
89 $address_bin = unpack('N', $address_bin);
95 # Does the reverse of ip2bin().
96 # Will return undef for invalid inputs.
98 my $address_bin = shift;
100 # This function returns undef for undefined input.
101 if (!defined $address_bin) {
105 my $address = pack('N', $address_bin);
107 $address = &Socket
::inet_ntop
(AF_INET
, $address);
113 # Takes two network addresses, compares them against each other
114 # and returns true if equal or false if not
116 my $network1 = shift;
117 my $network2 = shift;
119 my @bin1 = &network2bin
($network1);
120 my @bin2 = &network2bin
($network2);
122 if (!defined $bin1 || !defined $bin2) {
126 if ($bin1[0] == $bin2[0] && $bin1[1] == $bin2[1]) {
133 # Takes a network in either a.b.c.d/a.b.c.d or a.b.c.d/e notation
134 # and will return an 32 bit integer representing the start
135 # address and an other one representing the network mask.
139 my ($address, $netmask) = split(/\//, $network, 2);
141 if (&check_prefix
($netmask)) {
142 $netmask = &convert_prefix2netmask
($netmask);
145 my $address_bin = &ip2bin
($address);
146 my $netmask_bin = &ip2bin
($netmask);
148 if (!defined $address_bin || !defined $netmask_bin) {
152 my $network_start = $address_bin & $netmask_bin;
154 return ($network_start, $netmask_bin);
157 # Deletes leading zeros in ip address
160 my @ip = split (/\./, $address);
162 foreach my $octet (@ip) {
163 $octet = int($octet);
166 $address = join (".", @ip);
170 # Returns True for all valid IP addresses
171 sub check_ip_address
($) {
174 # Normalise the IP address and compare the result with
175 # the input - which should obviously the same.
176 my $normalised_address = &_normalise_ip_address
($address);
178 return ((defined $normalised_address) && ($address eq $normalised_address));
181 # Returns True for all valid prefixes.
182 sub check_prefix
($) {
185 return (exists $PREFIX2NETMASK{$prefix});
188 # Returns True for all valid subnet masks.
189 sub check_netmask
($) {
192 return (exists $NETMASK2PREFIX{$netmask});
195 # Returns True for all valid inputs like a.b.c.d/a.b.c.d.
196 sub check_ip_address_and_netmask
($$) {
199 my ($address, $netmask) = split(/\//, $network, 2);
201 # Check if the IP address is fine.
203 my $result = &check_ip_address
($address);
208 return &check_netmask
($netmask);
211 # Returns True for all valid subnets like a.b.c.d/e or a.b.c.d/a.b.c.d
212 sub check_subnet
($) {
215 my ($address, $network) = split(/\//, $subnet, 2);
217 # Check if the IP address is fine.
218 my $result = &check_ip_address
($address);
223 return &check_prefix
($network) || &check_netmask
($network);
226 # For internal use only. Will take an IP address and
227 # return it in a normalised style. Like 8.8.8.010 -> 8.8.8.8.
228 sub _normalise_ip_address
($) {
231 my $address_bin = &ip2bin
($address);
232 if (!defined $address_bin) {
236 return &bin2ip
($address_bin);
239 # Returns the prefix for the given subnet mask.
240 sub convert_netmask2prefix
($) {
243 if (exists $NETMASK2PREFIX{$netmask}) {
244 return $NETMASK2PREFIX{$netmask};
250 # Returns the subnet mask for the given prefix.
251 sub convert_prefix2netmask
($) {
254 if (exists $PREFIX2NETMASK{$prefix}) {
255 return $PREFIX2NETMASK{$prefix};
261 # Takes an IP address and an offset and
262 # will return the offset'th IP address.
263 sub find_next_ip_address
($$) {
267 my $address_bin = &ip2bin
($address);
268 $address_bin += $offset;
270 return &bin2ip
($address_bin);
273 # Returns the network address of the given network.
274 sub get_netaddress
($) {
276 my ($network_bin, $netmask_bin) = &network2bin
($network);
278 if (defined $network_bin) {
279 return &bin2ip
($network_bin);
285 # Returns the broadcast of the given network.
286 sub get_broadcast
($) {
288 my ($network_bin, $netmask_bin) = &network2bin
($network);
290 return &bin2ip
($network_bin ^ ~$netmask_bin);
293 # Returns True if $address is in $network.
294 sub ip_address_in_network
($$) {
298 my $address_bin = &ip2bin
($address);
299 return undef unless (defined $address_bin);
301 my ($network_bin, $netmask_bin) = &network2bin
($network);
304 my $broadcast_bin = $network_bin ^ (~$netmask_bin % 2 ** 32);
306 return (($address_bin >= $network_bin) && ($address_bin <= $broadcast_bin));
309 sub setup_upstream_proxy
() {
310 my %proxysettings = ();
311 &General
::readhash
("${General::swroot}/proxy/settings", \
%proxysettings);
313 if ($proxysettings{'UPSTREAM_PROXY'}) {
314 my $credentials = "";
316 if ($proxysettings{'UPSTREAM_USER'}) {
317 $credentials = $proxysettings{'UPSTREAM_USER'};
319 if ($proxysettings{'UPSTREAM_PASSWORD'}) {
320 $credentials .= ":" . $proxysettings{'UPSTREAM_PASSWORD'};
326 my $proxy = "http://" . $credentials . $proxysettings{'UPSTREAM_PROXY'};
328 $ENV{'http_proxy'} = $proxy;
329 $ENV{'https_proxy'} = $proxy;
330 $ENV{'ftp_proxy'} = $proxy;
334 my %wireless_status = ();
336 sub _get_wireless_status
($) {
339 if (!$wireless_status{$intf}) {
340 $wireless_status{$intf} = `iwconfig $intf`;
343 return $wireless_status{$intf};
346 sub wifi_get_essid
($) {
347 my $status = &_get_wireless_status
(shift);
349 my ($essid) = $status =~ /ESSID:\"(.*)\"/;
354 sub wifi_get_frequency
($) {
355 my $status = &_get_wireless_status
(shift);
357 my ($frequency) = $status =~ /Frequency:(\d+\.\d+ GHz)/;
362 sub wifi_get_access_point
($) {
363 my $status = &_get_wireless_status
(shift);
365 my ($access_point) = $status =~ /Access Point: ([0-9A-F:]+)/;
367 return $access_point;
370 sub wifi_get_bit_rate
($) {
371 my $status = &_get_wireless_status
(shift);
373 my ($bit_rate) = $status =~ /Bit Rate=(\d+ [GM]b\/s)/;
378 sub wifi_get_link_quality
($) {
379 my $status = &_get_wireless_status
(shift);
381 my ($cur, $max) = $status =~ /Link Quality=(\d+)\/(\d
+)/;
383 return $cur * 100 / $max;
386 sub wifi_get_signal_level
($) {
387 my $status = &_get_wireless_status
(shift);
389 my ($signal_level) = $status =~ /Signal level=(\-\d+ dBm)/;
391 return $signal_level;
394 sub get_hardware_address
($) {
395 my $ip_address = shift;
398 open(FILE
, "/proc/net/arp") or die("Could not read ARP table");
401 my ($ip_addr, $hwtype, $flags, $hwaddr, $mask, $device) = split(/\s+/, $_);
402 if ($ip_addr eq $ip_address) {
413 sub get_nic_property
{
415 my $property = shift;
418 open(FILE
, "/sys/class/net/$nicname/$property") or die("Could not read property");
430 return $mac =~ /^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$/;
437 $address = sprintf("$address:%02x", int(rand(255)));
443 sub get_mac_by_name
($) {
446 if ((!&valid_mac
($mac)) && ($mac ne "")) {
447 if (-e
"/sys/class/net/$mac/") {
448 $mac = get_nic_property
($mac, "address");
456 ## Function to get a list of all available network zones.
458 sub get_available_network_zones
() {
459 # Obtain the configuration type from the netsettings hash.
460 my $config_type = $ethernet_settings{'CONFIG_TYPE'};
462 # Hash which contains the conversation from the config mode
463 # to the existing network interface names. They are stored like
466 # Mode "0" red is a modem and green
467 # Mode "1" red is a netdev and green
468 # Mode "2" red, green and orange
469 # Mode "3" red, green and blue
470 # Mode "4" red, green, blue, orange
471 my %config_type_to_interfaces = (
472 "0" => [ "red", "green" ],
473 "1" => [ "red", "green" ],
474 "2" => [ "red", "green", "orange" ],
475 "3" => [ "red", "green", "blue" ],
476 "4" => [ "red", "green", "blue", "orange" ]
479 # Obtain and dereference the corresponding network interaces based on the read
480 # network config type.
481 my @network_zones = @
{ $config_type_to_interfaces{$config_type} };
484 return @network_zones;
488 ## Function to check if a network zone is available in the current configuration
490 sub is_zone_available
() {
493 # Make sure the zone is valid
494 die("Unknown network zone '$zone'") unless ($zone ~~ @known_network_zones);
496 # Get available zones and return result
497 my @available_zones = get_available_network_zones
();
498 return ($zone ~~ @available_zones);
502 ## Function to determine if the RED zone is in standard IP (or modem, PPP, VDSL, ...) mode
504 sub is_red_mode_ip
() {
505 # Obtain the settings from the netsettings hash
506 my $config_type = $ethernet_settings{'CONFIG_TYPE'};
507 my $red_type = $ethernet_settings{'RED_TYPE'};
509 # RED must be a network device (configuration 1-4) with dynamic or static IP
510 return (($config_type ~~ [1..4]) && ($red_type ~~ ["DHCP", "STATIC"]));
515 # Remove the next line to enable the testsuite
526 print "ASSERTION ERROR - $tst\n";
533 my $address1 = &ip2bin
("8.8.8.8");
534 assert
('ip2bin("8.8.8.8")', $address1 == 134744072);
536 my $address2 = &bin2ip
($address1);
537 assert
("bin2ip($address1)", $address2 eq "8.8.8.8");
539 # Check if valid IP addresses are correctly recognised.
540 foreach my $address ("1.2.3.4", "192.168.180.1", "127.0.0.1") {
541 if (!&check_ip_address
($address)) {
542 print "$address is not correctly recognised as a valid IP address!\n";
547 # Check if invalid IP addresses are correctly found.
548 foreach my $address ("456.2.3.4", "192.768.180.1", "127.1", "1", "a.b.c.d", "1.2.3.4.5", "1.2.3.4/12") {
549 if (&check_ip_address
($address)) {
550 print "$address is recognised as a valid IP address!\n";
555 $result = &check_ip_address_and_netmask
("192.168.180.0/255.255.255.0");
556 assert
('check_ip_address_and_netmask("192.168.180.0/255.255.255.0")', $result);
558 $result = &convert_netmask2prefix
("255.255.254.0");
559 assert
('convert_netmask2prefix("255.255.254.0")', $result == 23);
561 $result = &convert_prefix2netmask
(8);
562 assert
('convert_prefix2netmask(8)', $result eq "255.0.0.0");
564 $result = &find_next_ip_address
("1.2.3.4", 2);
565 assert
('find_next_ip_address("1.2.3.4", 2)', $result eq "1.2.3.6");
567 $result = &network_equal
("192.168.0.0/24", "192.168.0.0/255.255.255.0");
568 assert
('network_equal("192.168.0.0/24", "192.168.0.0/255.255.255.0")', $result);
570 $result = &network_equal
("192.168.0.0/24", "192.168.0.0/25");
571 assert
('network_equal("192.168.0.0/24", "192.168.0.0/25")', !$result);
573 $result = &network_equal
("192.168.0.0/24", "192.168.0.128/25");
574 assert
('network_equal("192.168.0.0/24", "192.168.0.128/25")', !$result);
576 $result = &network_equal
("192.168.0.1/24", "192.168.0.XXX/24");
577 assert
('network_equal("192.168.0.1/24", "192.168.0.XXX/24")', !$result);
579 $result = &ip_address_in_network
("10.0.1.4", "10.0.0.0/8");
580 assert
('ip_address_in_network("10.0.1.4", "10.0.0.0/8"', $result);
582 $result = &ip_address_in_network
("192.168.30.11", "192.168.30.0/255.255.255.0");
583 assert
('ip_address_in_network("192.168.30.11", "192.168.30.0/255.255.255.0")', $result);
585 $result = &ip_address_in_network
("192.168.30.11", "0.0.0.0/8");
586 assert
('ip_address_in_network("192.168.30.11", "0.0.0.0/8")', !$result);
588 print "Testsuite completed successfully!\n";