config/cfgroot/network-functions.pl

   1 #!/usr/bin/perl -w
   2 ############################################################################
   3 #                                                                          #
   4 # This file is part of the IPFire Firewall.                                #
   5 #                                                                          #
   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.                                      #
  10 #                                                                          #
  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.                             #
  15 #                                                                          #
  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 #
  19 #                                                                          #
  20 # Copyright (C) 2014 IPFire Team <info@ipfire.org>.                        #
  21 #                                                                          #
  22 ############################################################################
  23
  24 package Network;
  25
  26 require "/var/ipfire/general-functions.pl";
  27
  28 use Socket;
  29
  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",
  47         16 => "255.255.0.0",
  48         15 => "255.254.0.0",
  49         14 => "255.252.0.0",
  50         13 => "255.248.0.0",
  51         12 => "255.240.0.0",
  52         11 => "255.224.0.0",
  53         10 => "255.192.0.0",
  54          9 => "255.128.0.0",
  55          8 => "255.0.0.0",
  56          7 => "254.0.0.0",
  57          6 => "252.0.0.0",
  58          5 => "248.0.0.0",
  59          4 => "240.0.0.0",
  60          3 => "224.0.0.0",
  61          2 => "192.0.0.0",
  62          1 => "128.0.0.0",
  63          0 => "0.0.0.0"
  64 );
  65
  66 my %NETMASK2PREFIX = reverse(%PREFIX2NETMASK);
  67
  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.
  71 sub ip2bin($) {
  72         my $address = shift;
  73
  74         # This function returns undef for undefined input.
  75         if (!defined $address) {
  76                 return undef;
  77         }
  78
  79         my $address_bin = &Socket::inet_pton(AF_INET, $address);
  80         if ($address_bin) {
  81                 $address_bin = unpack('N', $address_bin);
  82         }
  83
  84         return $address_bin;
  85 }
  86
  87 # Does the reverse of ip2bin().
  88 # Will return undef for invalid inputs.
  89 sub bin2ip($) {
  90         my $address_bin = shift;
  91
  92         # This function returns undef for undefined input.
  93         if (!defined $address_bin) {
  94                 return undef;
  95         }
  96
  97         my $address = pack('N', $address_bin);
  98         if ($address) {
  99                 $address = &Socket::inet_ntop(AF_INET, $address);
 100         }
 101
 102         return $address;
 103 }
 104
 105 #Takes two network addresses and compares them against each other
 106 #returns true if equal or false if not
 107 sub network_equal{
 108         my $network1 = shift;
 109         my $network2 = shift;
 110         my $bin1 = &network2bin($network1);
 111         my $bin2 = &network2bin($network2);
 112         if ($bin1 eq $bin2){
 113                 return 1;
 114         }
 115         return 0;
 116 }
 117
 118 # Takes a network in either a.b.c.d/a.b.c.d or a.b.c.d/e notation
 119 # and will return an 32 bit integer representing the start
 120 # address and an other one representing the network mask.
 121 sub network2bin($) {
 122         my $network = shift;
 123
 124         my ($address, $netmask) = split(/\//, $network, 2);
 125
 126         if (&check_prefix($netmask)) {
 127                 $netmask = &convert_prefix2netmask($netmask);
 128         }
 129
 130         my $address_bin = &ip2bin($address);
 131         my $netmask_bin = &ip2bin($netmask);
 132
 133         my $network_start = $address_bin & $netmask_bin;
 134
 135         return ($network_start, $netmask_bin);
 136 }
 137
 138 # Deletes leading zeros in ip address
 139 sub ip_remove_zero{
 140         my $address = shift;
 141         my @ip = split (/\./, $address);
 142
 143         foreach my $octet (@ip) {
 144                 $octet = int($octet);
 145         }
 146
 147         $address = join (".", @ip);
 148
 149         return $address;
 150 }
 151 # Returns True for all valid IP addresses
 152 sub check_ip_address($) {
 153         my $address = shift;
 154
 155         # Normalise the IP address and compare the result with
 156         # the input - which should obviously the same.
 157         my $normalised_address = &_normalise_ip_address($address);
 158
 159         return ((defined $normalised_address) && ($address eq $normalised_address));
 160 }
 161
 162 # Returns True for all valid prefixes.
 163 sub check_prefix($) {
 164         my $prefix = shift;
 165
 166         return (exists $PREFIX2NETMASK{$prefix});
 167 }
 168
 169 # Returns True for all valid subnet masks.
 170 sub check_netmask($) {
 171         my $netmask = shift;
 172
 173         return (exists $NETMASK2PREFIX{$netmask});
 174 }
 175
 176 # Returns True for all valid inputs like a.b.c.d/a.b.c.d.
 177 sub check_ip_address_and_netmask($$) {
 178         my $network = shift;
 179
 180         my ($address, $netmask) = split(/\//, $network, 2);
 181
 182         # Check if the IP address is fine.
 183         #
 184         my $result = &check_ip_address($address);
 185         unless ($result) {
 186                 return $result;
 187         }
 188
 189         return &check_netmask($netmask);
 190 }
 191
 192 # Returns True for all valid subnets like a.b.c.d/e or a.b.c.d/a.b.c.d
 193 sub check_subnet($) {
 194         my $subnet = shift;
 195
 196         my ($address, $network) = split(/\//, $subnet, 2);
 197
 198         # Check if the IP address is fine.
 199         my $result = &check_ip_address($address);
 200         unless ($result) {
 201                 return $result;
 202         }
 203
 204         return &check_prefix($network) || &check_netmask($network);
 205 }
 206
 207 # For internal use only. Will take an IP address and
 208 # return it in a normalised style. Like 8.8.8.010 -> 8.8.8.8.
 209 sub _normalise_ip_address($) {
 210         my $address = shift;
 211
 212         my $address_bin = &ip2bin($address);
 213         if (!defined $address_bin) {
 214                 return undef;
 215         }
 216
 217         return &bin2ip($address_bin);
 218 }
 219
 220 # Returns the prefix for the given subnet mask.
 221 sub convert_netmask2prefix($) {
 222         my $netmask = shift;
 223
 224         if (exists $NETMASK2PREFIX{$netmask}) {
 225                 return $NETMASK2PREFIX{$netmask};
 226         }
 227
 228         return undef;
 229 }
 230
 231 # Returns the subnet mask for the given prefix.
 232 sub convert_prefix2netmask($) {
 233         my $prefix = shift;
 234
 235         if (exists $PREFIX2NETMASK{$prefix}) {
 236                 return $PREFIX2NETMASK{$prefix};
 237         }
 238
 239         return undef;
 240 }
 241
 242 # Takes an IP address and an offset and
 243 # will return the offset'th IP address.
 244 sub find_next_ip_address($$) {
 245         my $address = shift;
 246         my $offset = shift;
 247
 248         my $address_bin = &ip2bin($address);
 249         $address_bin += $offset;
 250
 251         return &bin2ip($address_bin);
 252 }
 253
 254 # Returns the network address of the given network.
 255 sub get_netaddress($) {
 256         my $network = shift;
 257         my ($network_bin, $netmask_bin) = &network2bin($network);
 258
 259         if (defined $network_bin) {
 260                 return &bin2ip($network_bin);
 261         }
 262
 263         return undef;
 264 }
 265
 266 # Returns the broadcast of the given network.
 267 sub get_broadcast($) {
 268         my $network = shift;
 269         my ($network_bin, $netmask_bin) = &network2bin($network);
 270
 271         return &bin2ip($network_bin ^ ~$netmask_bin);
 272 }
 273
 274 # Returns True if $address is in $network.
 275 sub ip_address_in_network($$) {
 276         my $address = shift;
 277         my $network = shift;
 278
 279         my $address_bin = &ip2bin($address);
 280         return undef unless (defined $address_bin);
 281
 282         my ($network_bin, $netmask_bin) = &network2bin($network);
 283
 284         # Find end address
 285         my $broadcast_bin = $network_bin ^ (~$netmask_bin % 2 ** 32);
 286
 287         return (($address_bin ge $network_bin) && ($address_bin le $broadcast_bin));
 288 }
 289
 290 sub setup_upstream_proxy() {
 291         my %proxysettings = ();
 292         &General::readhash("${General::swroot}/proxy/settings", \%proxysettings);
 293
 294         if ($proxysettings{'UPSTREAM_PROXY'}) {
 295                 my $credentials = "";
 296
 297                 if ($proxysettings{'UPSTREAM_USER'}) {
 298                         $credentials = $proxysettings{'UPSTREAM_USER'};
 299
 300                         if ($proxysettings{'UPSTREAM_PASSWORD'}) {
 301                                 $credentials .= ":" . $proxysettings{'UPSTREAM_PASSWORD'};
 302                         }
 303
 304                         $credentials .= "@";
 305                 }
 306
 307                 my $proxy = "http://" . $credentials . $proxysettings{'UPSTREAM_PROXY'};
 308
 309                 $ENV{'http_proxy'} = $proxy;
 310                 $ENV{'https_proxy'} = $proxy;
 311                 $ENV{'ftp_proxy'} = $proxy;
 312         }
 313 }
 314
 315 1;
 316
 317 # Remove the next line to enable the testsuite
 318 __END__
 319
 320 sub assert($) {
 321         my $ret = shift;
 322
 323         if ($ret) {
 324                 return;
 325         }
 326
 327         print "ASSERTION ERROR";
 328         exit(1);
 329 }
 330
 331 sub testsuite() {
 332         my $result;
 333
 334         my $address1 = &ip2bin("8.8.8.8");
 335         assert($address1 == 134744072);
 336
 337         my $address2 = &bin2ip($address1);
 338         assert($address2 eq "8.8.8.8");
 339
 340         # Check if valid IP addresses are correctly recognised.
 341         foreach my $address ("1.2.3.4", "192.168.180.1", "127.0.0.1") {
 342                 if (!&check_ip_address($address)) {
 343                         print "$address is not correctly recognised as a valid IP address!\n";
 344                         exit 1;
 345                 };
 346         }
 347
 348         # Check if invalid IP addresses are correctly found.
 349         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") {
 350                 if (&check_ip_address($address)) {
 351                         print "$address is recognised as a valid IP address!\n";
 352                         exit 1;
 353                 };
 354         }
 355
 356         $result = &check_ip_address_and_netmask("192.168.180.0/255.255.255.0");
 357         assert($result);
 358
 359         $result = &convert_netmask2prefix("255.255.254.0");
 360         assert($result == 23);
 361
 362         $result = &convert_prefix2netmask(8);
 363         assert($result eq "255.0.0.0");
 364
 365         $result = &find_next_ip_address("1.2.3.4", 2);
 366         assert($result eq "1.2.3.6");
 367
 368         $result = &ip_address_in_network("10.0.1.4", "10.0.0.0/8");
 369         assert($result);
 370
 371         $result = &ip_address_in_network("192.168.30.11", "192.168.30.0/255.255.255.0");
 372         assert($result);
 373
 374         return 0;
 375 }
 376
 377 &testsuite();