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 my %PREFIX2NETMASK = (
31 32 => "255.255.255.255",
32 31 => "255.255.255.254",
33 30 => "255.255.255.252",
34 29 => "255.255.255.248",
35 28 => "255.255.255.240",
36 27 => "255.255.255.224",
37 26 => "255.255.255.192",
38 25 => "255.255.255.128",
39 24 => "255.255.255.0",
40 23 => "255.255.254.0",
41 22 => "255.255.252.0",
42 21 => "255.255.248.0",
43 20 => "255.255.240.0",
44 19 => "255.255.224.0",
45 18 => "255.255.192.0",
46 17 => "255.255.128.0",
66 my %NETMASK2PREFIX = reverse(%PREFIX2NETMASK);
68 # Takes an IP address in dotted decimal notation and
69 # returns a 32 bit integer representing that IP addresss.
70 # Will return undef for invalid inputs.
74 # This function returns undef for undefined input.
75 if (!defined $address) {
79 my $address_bin = &Socket
::inet_pton
(AF_INET
, $address);
81 $address_bin = unpack('N', $address_bin);
87 # Does the reverse of ip2bin().
88 # Will return undef for invalid inputs.
90 my $address_bin = shift;
92 # This function returns undef for undefined input.
93 if (!defined $address_bin) {
97 my $address = pack('N', $address_bin);
99 $address = &Socket
::inet_ntop
(AF_INET
, $address);
105 # Takes a network in either a.b.c.d/a.b.c.d or a.b.c.d/e notation
106 # and will return an 32 bit integer representing the start
107 # address and an other one representing the network mask.
111 my ($address, $netmask) = split(/\//, $network, 2);
113 if (&check_prefix
($netmask)) {
114 $netmask = &convert_prefix2netmask
($netmask);
117 my $address_bin = &ip2bin
($address);
118 my $netmask_bin = &ip2bin
($netmask);
120 my $network_start = $address_bin & $netmask_bin;
122 return ($network_start, $netmask_bin);
125 # Returns True for all valid IP addresses
126 sub check_ip_address
($) {
129 # Normalise the IP address and compare the result with
130 # the input - which should obviously the same.
131 my $normalised_address = &_normalise_ip_address
($address);
133 return ((defined $normalised_address) && ($address eq $normalised_address));
136 # Returns True for all valid prefixes.
137 sub check_prefix
($) {
140 return (exists $PREFIX2NETMASK{$prefix});
143 # Returns True for all valid subnet masks.
144 sub check_netmask
($) {
147 return (exists $NETMASK2PREFIX{$netmask});
150 # Returns True for all valid inputs like a.b.c.d/a.b.c.d.
151 sub check_ip_address_and_netmask
($$) {
154 my ($address, $netmask) = split(/\//, $network, 2);
156 # Check if the IP address is fine.
158 my $result = &check_ip_address
($address);
163 return &check_netmask
($netmask);
166 # For internal use only. Will take an IP address and
167 # return it in a normalised style. Like 8.8.8.010 -> 8.8.8.8.
168 sub _normalise_ip_address
($) {
171 my $address_bin = &ip2bin
($address);
172 if (!defined $address_bin) {
176 return &bin2ip
($address_bin);
179 # Returns the prefix for the given subnet mask.
180 sub convert_netmask2prefix
($) {
183 if (exists $NETMASK2PREFIX{$netmask}) {
184 return $NETMASK2PREFIX{$netmask};
190 # Returns the subnet mask for the given prefix.
191 sub convert_prefix2netmask
($) {
194 if (exists $PREFIX2NETMASK{$prefix}) {
195 return $PREFIX2NETMASK{$prefix};
201 # Takes an IP address and an offset and
202 # will return the offset'th IP address.
203 sub find_next_ip_address
($$) {
207 my $address_bin = &ip2bin
($address);
208 $address_bin += $offset;
210 return &bin2ip
($address_bin);
213 # Returns the network address of the given network.
214 sub get_netaddress
($) {
216 my ($network_bin, $netmask_bin) = &network2bin
($network);
218 if (defined $network_bin) {
219 return &bin2ip
($network_bin);
225 # Returns the broadcast of the given network.
226 sub get_broadcast
($) {
228 my ($network_bin, $netmask_bin) = &network2bin
($network);
230 return &bin2ip
($network_bin ^ ~$netmask_bin);
233 # Returns True if $address is in $network.
234 sub ip_address_in_network
($$) {
238 my $address_bin = &ip2bin
($address);
239 return undef unless (defined $address_bin);
241 my ($network_bin, $netmask_bin) = &network2bin
($network);
244 my $broadcast_bin = $network_bin ^ ~$netmask_bin;
246 return (($address_bin ge $network_bin) && ($address_bin le $broadcast_bin));
249 sub setup_upstream_proxy
() {
250 my %proxysettings = ();
251 &General
::readhash
("${General::swroot}/proxy/settings", \
%proxysettings);
253 if ($proxysettings{'UPSTREAM_PROXY'}) {
254 my $credentials = "";
256 if ($proxysettings{'UPSTREAM_USER'}) {
257 $credentials = $proxysettings{'UPSTREAM_USER'};
259 if ($proxysettings{'UPSTREAM_PASSWORD'}) {
260 $credentials .= ":" . $proxysettings{'UPSTREAM_PASSWORD'};
266 my $proxy = "http://" . $credentials . $proxysettings{'UPSTREAM_PROXY'};
268 $ENV{'http_proxy'} = $proxy;
269 $ENV{'https_proxy'} = $proxy;
270 $ENV{'ftp_proxy'} = $proxy;
276 # Remove the next line to enable the testsuite
286 print "ASSERTION ERROR";
293 my $address1 = &ip2bin
("8.8.8.8");
294 assert
($address1 == 134744072);
296 my $address2 = &bin2ip
($address1);
297 assert
($address2 eq "8.8.8.8");
299 # Check if valid IP addresses are correctly recognised.
300 foreach my $address ("1.2.3.4", "192.168.180.1", "127.0.0.1") {
301 if (!&check_ip_address
($address)) {
302 print "$address is not correctly recognised as a valid IP address!\n";
307 # Check if invalid IP addresses are correctly found.
308 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") {
309 if (&check_ip_address
($address)) {
310 print "$address is recognised as a valid IP address!\n";
315 $result = &check_ip_address_and_netmask
("192.168.180.0/255.255.255.0");
318 $result = &convert_netmask2prefix
("255.255.254.0");
319 assert
($result == 23);
321 $result = &convert_prefix2netmask
(8);
322 assert
($result eq "255.0.0.0");
324 $result = &find_next_ip_address
("1.2.3.4", 2);
325 assert
($result eq "1.2.3.6");
327 $result = &ip_address_in_network
("10.0.1.4", "10.0.0.0/8");