]>
git.ipfire.org Git - people/pmueller/ipfire-2.x.git/blob - config/cfgroot/general-functions.pl
3 # This code is distributed under the terms of the GPL
5 # (c) The SmoothWall Team
6 # Copyright (C) 2002 Alex Hudson - getcgihash() rewrite
7 # Copyright (C) 2002 Bob Grant <bob@cache.ucr.edu> - validmac()
8 # Copyright (c) 2002/04/13 Steve Bootes - add alias section, helper functions
9 # Copyright (c) 2002/08/23 Mark Wormgoor <mark@wormgoor.com> validfqdn()
10 # Copyright (c) 2003/09/11 Darren Critchley <darrenc@telus.net> srtarray()
12 # $Id: general-functions.pl,v 1.1.2.26 2006/01/04 16:33:55 franck78 Exp $
21 use Net
::IPv4Addr
qw(:all);
22 $|=1; # line buffering
24 $General::version
= 'VERSION';
25 $General::swroot
= 'CONFIG_ROOT';
26 $General::noipprefix
= 'noipg-';
27 $General::adminmanualurl
= 'http://wiki.ipfire.org';
30 # log ("message") use default 'ipcop' tag
31 # log ("tag","message") use your tag
36 $tag = shift if (@_>1);
37 my $logmessage = $_[0];
38 $logmessage =~ /([\w\W]*)/;
40 system('logger', '-t', $tag, $logmessage);
50 # Some ipcop code expects that readhash 'complete' the hash if new entries
51 # are presents. Not clear it !!!
54 open(FILE
, $filename) or die "Unable to read file $filename";
59 ($var, $val) = split /=/, $_, 2;
65 # Untaint variables read from hash
66 # trim space from begin and end
69 $var =~ /([A-Za-z0-9_-]*)/;
86 # write cgi vars to the file.
87 open(FILE
, ">${filename}") or die "Unable to write file $filename";
89 foreach $var (keys %$hash)
91 if ( $var eq "__CGI__"){next;}
93 # Darren Critchley Jan 17, 2003 added the following because when submitting with a graphic, the x and y
94 # location of the mouse are submitted as well, this was being written to the settings file causing
95 # some serious grief! This skips the variable.x and variable.y
96 if (!($var =~ /(.x|.y)$/)) {
99 if (!($var =~ /^ACTION/)) {
100 print FILE
"${var}=${val}\n"; }
108 # This function replaces the given hash in the original hash by keeping the old
109 # content and just replacing the new content
111 my $filename = $_[0];
116 readhash
("${filename}", \
%oldhash);
118 foreach $var (keys %$newhash){
119 $oldhash{$var}=$newhash->{$var};
122 # write cgi vars to the file.
123 open(FILE
, ">${filename}") or die "Unable to write file $filename";
125 foreach $var (keys %oldhash)
127 if ( $var eq "__CGI__"){next;}
128 $val = $oldhash{$var};
129 # Darren Critchley Jan 17, 2003 added the following because when submitting with a graphic, the x and y
130 # location of the mouse are submitted as well, this was being written to the settings file causing
131 # some serious grief! This skips the variable.x and variable.y
132 if (!($var =~ /(.x|.y)$/)) {
135 if (!($var =~ /^ACTION/)) {
136 print FILE
"${var}=${val}\n"; }
144 my ($dev, $ino, $mode, $nlink, $uid, $gid, $rdev, $size,
145 $atime, $mtime, $ctime, $blksize, $blocks) = stat $_[0];
148 my $totalsecs = $now - $mtime;
149 my $days = int($totalsecs / 86400);
150 my $totalhours = int($totalsecs / 3600);
151 my $hours = $totalhours % 24;
152 my $totalmins = int($totalsecs / 60);
153 my $mins = $totalmins % 60;
154 my $secs = $totalsecs % 60;
156 return "${days}d ${hours}h ${mins}m ${secs}s";
163 if (!($ip =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/)) {
167 my @octets = ($1, $2, $3, $4);
172 if ($_ < 0 || $_ > 255) {
184 if (&validip
($mask)) {
186 # second part a number?
189 if (!($mask =~ /^\d+$/)) {
191 if ($mask >= 0 && $mask <= 32) {
198 my $ipormask = $_[0];
200 # see if it is a IP only.
201 if (&validip
($ipormask)) {
203 # split it into number and mask.
204 if (!($ipormask =~ /^(.*?)\/(.*?
)$/)) {
208 # first part not a ip?
209 if (!(&validip
($ip))) {
211 return &validmask
($mask);
216 #gets: Subnet in decimal (255.255.255.0)
217 #Gives: 24 (The cidr of network)
218 my ($byte1, $byte2, $byte3, $byte4) = split(/\./, $_[0].".0.0.0.0");
219 my $num = ($byte1 * 16777216) + ($byte2 * 65536) + ($byte3 * 256) + $byte4;
220 my $bin = unpack("B*", pack("N", $num));
221 my $count = ($bin =~ tr/1/1/);
227 #gets: Cidr of network (20-30 for ccd)
228 #Konverts 30 to 255.255.255.252 e.g
230 my $netmask = &Net
::IPv4Addr
::ipv4_cidr2msk
($cidr);
236 #Gets: Ip address or subnetmask in decimal oder CIDR
237 #Gives: What it gets only in CIDR format
242 if ($subnet =~ /^(.*?)\/(.*?
)$/) {
243 ($net,$mask) = split (/\//,$subnet);
249 #Subnet already in decimal and valid?
250 if ($mask=~/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/ &&(($1<=255 && $2<=$1 && $3<=$2 && $4<=$3 ))) {
251 for (my $i=8;$i<=32;$i++){
252 if (&General
::cidrtosub
($i) eq $mask){
253 if ($full == 0){return $mask;}else{
254 return $net."/".$mask;
259 #Subnet in binary format?
260 if ($mask=~/^(\d{1,2})$/ && (($1<=32 && $1>=8))){
261 if($full == 0){ return &General
::cidrtosub
($mask);}else{
262 return $net."/".&General
::cidrtosub
($mask);
273 #gets: Ip Address or subnetmask in decimal oder CIDR
274 #Gives: What it gets only in CIDR format
279 if ($subnet =~ /^(.*?)\/(.*?
)$/) {
280 ($net,$mask) = split (/\//,$subnet);
285 #Subnet in decimal and valid?
286 if ($mask=~/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/ &&(($1<=255 && $2<=$1 && $3<=$2 && $4<=$3 ))) {
287 for (my $i=8;$i<=32;$i++){
288 if (&General
::cidrtosub
($i) eq $mask){
289 if ($full == 0){return &General
::subtocidr
($mask);}else{
290 return $net."/".&General
::subtocidr
($mask);
295 #Subnet already in binary format?
296 if ($mask=~/^(\d{1,2})$/ && (($1<=32 && $1>=8))){
297 if($full == 0){ return $mask;}else{
298 return $net."/".$mask;
308 #Gets: IP, CIDR (10.10.10.0-255, 24)
310 my ($ccdip,$ccdsubnet) = @_;
311 my $ip_address_binary = inet_aton
( $ccdip );
312 my $netmask_binary = ~pack("N", (2**(32-$ccdsubnet))-1);
313 my $network_address = inet_ntoa
( $ip_address_binary & $netmask_binary );
314 return $network_address;
319 #Gets: IP in Form ("192.168.0.0/24")
320 #Gives: Broadcastaddress of network
322 my ($ccdip,$ccdsubnet) = split "/",$ccdnet;
323 my $ip_address_binary = inet_aton
( $ccdip );
324 my $netmask_binary = ~pack("N", (2**(32-$ccdsubnet))-1);
325 my $broadcast_address = inet_ntoa
( $ip_address_binary | ~$netmask_binary );
326 return $broadcast_address;
333 if ( $ip =~ /(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/ ) {
334 $ip_num = (($1*256**3) + ($2*256**2) + ($3*256) + $4);
338 $ip_num = (($1*256**3) + ($2*256**2) + ($3*256) + $4);
347 $ip_num=int($ip_num/256);
349 $ip_num=int($ip_num/256);
351 $ip_num=int($ip_num/256);
353 $ip="$o4.$o3.$o2.$o1";
359 my $decip=&ip2dec
($_[0]);
361 return &dec2ip
($decip);
366 my $decip=&ip2dec
($_[0]);
368 return &dec2ip
($decip);
373 #Gets: Ip address in 192.168.0.0/24 or 192.168.0.0/255.255.255.0 and checks if subnet valid
374 #Gives: True bzw 0 if success or false
378 if (!($ccdnet =~ /^(.*?)\/(.*?
)$/)) {
381 my ($ccdip,$ccdsubnet)=split (/\//, $ccdnet);
383 if ($ccdip=~/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/ &&(($1>0 && $1<=255 && $2>=0 && $2<=255 && $3>=0 && $3<=255 && $4<=255 ))) {
384 #Subnet in decimal and valid?
385 if ($ccdsubnet=~/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/ &&(($1<=255 && $2<=$1 && $3<=$2 && $4<=$3 ))) {
386 for (my $i=8;$i<=32;$i++){
387 if (&General
::cidrtosub
($i) eq $ccdsubnet){
391 #Subnet already in binary format?
392 }elsif ($ccdsubnet=~/^(\d{1,2})$/ && (($1<=32 && $1>=8))){
410 if ($_ >= 1 && $_ <= 65535) {
423 if ($_ == 53 || $_ == 222 || $_ == 444 || $_ == 81 ) {
425 elsif ($_ >= 1 && $_ <= 65535) {
432 my $checkmac = $_[0];
433 my $ot = '[0-9a-f]{2}'; # 2 Hex digits (one octet)
434 if ($checkmac !~ /^$ot:$ot:$ot:$ot:$ot:$ot$/i)
443 # Checks a hostname against RFC1035
444 my $hostname = $_[0];
446 # Each part should be at least two characters in length
447 # but no more than 63 characters
448 if (length ($hostname) < 1 || length ($hostname) > 63) {
450 # Only valid characters are a-z, A-Z, 0-9 and -
451 if ($hostname !~ /^[a-zA-Z0-9-\s]*$/) {
453 # First character can only be a letter or a digit
454 if (substr ($hostname, 0, 1) !~ /^[a-zA-Z0-9]*$/) {
456 # Last character can only be a letter or a digit
457 if (substr ($hostname, -1, 1) !~ /^[a-zA-Z0-9]*$/) {
466 # Checks a domain name against RFC1035
467 my $domainname = $_[0];
468 my @parts = split (/\./, $domainname); # Split hostname at the '.'
470 foreach $part (@parts) {
471 # Each part should be at least two characters in length
472 # but no more than 63 characters
473 if (length ($part) < 2 || length ($part) > 63) {
475 # Only valid characters are a-z, A-Z, 0-9 and -
476 if ($part !~ /^[a-zA-Z0-9-]*$/) {
478 # First character can only be a letter or a digit
479 if (substr ($part, 0, 1) !~ /^[a-zA-Z0-9]*$/) {
481 # Last character can only be a letter or a digit
482 if (substr ($part, -1, 1) !~ /^[a-zA-Z0-9]*$/) {
492 # Checks a fully qualified domain name against RFC1035
494 my @parts = split (/\./, $fqdn); # Split hostname at the '.'
495 if (scalar(@parts) < 2) { # At least two parts should
496 return 0;} # exist in a FQDN
497 # (i.e. hostname.domain)
498 foreach $part (@parts) {
499 # Each part should be at least one character in length
500 # but no more than 63 characters
501 if (length ($part) < 1 || length ($part) > 63) {
503 # Only valid characters are a-z, A-Z, 0-9 and -
504 if ($part !~ /^[a-zA-Z0-9-]*$/) {
506 # First character can only be a letter or a digit
507 if (substr ($part, 0, 1) !~ /^[a-zA-Z0-9]*$/) {
509 # Last character can only be a letter or a digit
510 if (substr ($part, -1, 1) !~ /^[a-zA-Z0-9]*$/) {
516 sub validportrange
# used to check a port range
518 my $port = $_[0]; # port values
519 $port =~ tr/-/:/; # replace all - with colons just in case someone used -
520 my $srcdst = $_[1]; # is it a source or destination port
522 if (!($port =~ /^(\d+)\:(\d+)$/)) {
524 if (!(&validport
($port))) {
525 if ($srcdst eq 'src'){
526 return $Lang::tr
{'source port numbers'};
528 return $Lang::tr
{'destination port numbers'};
534 my @ports = ($1, $2);
536 if ($srcdst eq 'src'){
537 return $Lang::tr
{'bad source range'};
539 return $Lang::tr
{'bad destination range'};
544 if (!(&validport
($_))) {
545 if ($srcdst eq 'src'){
546 return $Lang::tr
{'source port numbers'};
548 return $Lang::tr
{'destination port numbers'};
556 # Test if IP is within a subnet
557 # Call: IpInSubnet (Addr, Subnet, Subnet Mask)
558 # Subnet can be an IP of the subnet: 10.0.0.0 or 10.0.0.1
559 # Everything in dottted notation
563 my $ip = unpack('N', &Socket
::inet_aton
(shift));
564 my $start = unpack('N', &Socket
::inet_aton
(shift));
565 my $mask = unpack('N', &Socket
::inet_aton
(shift));
566 $start &= $mask; # base of subnet...
567 my $end = $start + ~$mask;
568 return (($ip >= $start) && ($ip <= $end));
572 # Return the following IP (IP+1) in dotted notation.
573 # Call: NextIP ('1.1.1.1');
578 return &Socket
::inet_ntoa
( pack("N", 1 + unpack('N', &Socket
::inet_aton
(shift))
584 return &Socket
::inet_ntoa
( pack("N", 4 + unpack('N', &Socket
::inet_aton
(shift))
590 my ($ip,$cidr) = &Net
::IPv4Addr
::ipv4_parse
(shift);
596 my ($ip,$cidr) = &Net
::IPv4Addr
::ipv4_parse
(shift);
597 my $netmask = &Net
::IPv4Addr
::ipv4_cidr2msk
($cidr);
598 return "$ip\/$netmask";
604 return 0 if ( $mail !~ /^[0-9a-zA-Z\.\-\_]+\@[0-9a-zA-Z\.\-]+$/ );
605 return 0 if ( $mail =~ /^[^0-9a-zA-Z]|[^0-9a-zA-Z]$/);
606 return 0 if ( $mail !~ /([0-9a-zA-Z]{1})\@./ );
607 return 0 if ( $mail !~ /.\@([0-9a-zA-Z]{1})/ );
608 return 0 if ( $mail =~ /.\.\-.|.\-\..|.\.\..|.\-\-./g );
609 return 0 if ( $mail =~ /.\.\_.|.\-\_.|.\_\..|.\_\-.|.\_\_./g );
610 return 0 if ( $mail !~ /\.([a-zA-Z]{2,4})$/ );
615 # Currently only vpnmain use this three procs (readhasharray, writehasharray, findhasharray)
616 # The 'key' used is numeric but is perfectly unneeded! This will to be removed so don't use
617 # this code. Vpnmain will be splitted in parts: x509/pki, connection ipsec, connection other,... .
620 my ($filename, $hash) = @_;
623 open(FILE
, $filename) or die "Unable to read file $filename";
626 my ($key, $rest, @temp);
628 ($key, $rest) = split (/,/, $_, 2);
629 if ($key =~ /^[0-9]+$/) {
630 @temp = split (/,/, $rest);
631 $hash->{$key} = \
@temp;
639 my ($filename, $hash) = @_;
640 my ($key, @temp, $i);
642 open(FILE
, ">$filename") or die "Unable to write to file $filename";
644 foreach $key (keys %$hash) {
645 if ($key =~ /^[0-9]+$/) {
647 foreach $i (0 .. $#{$hash->{$key}}) {
648 print FILE
",$hash->{$key}[$i]";
657 sub findhasharraykey
{
658 foreach my $i (1 .. 1000000) {
659 if ( ! exists $_[0]{$i}) {
666 # Darren Critchley - darrenc@telus.net - (c) 2003
667 # &srtarray(SortOrder, AlphaNumeric, SortDirection, ArrayToBeSorted)
668 # This subroutine will take the following parameters:
669 # ColumnNumber = the column which you want to sort on, starts at 1
670 # AlphaNumberic = a or n (lowercase) defines whether the sort should be alpha or numberic
671 # SortDirection = asc or dsc (lowercase) Ascending or Descending sort
672 # ArrayToBeSorted = the array that wants sorting
674 # Returns an array that is sorted to your specs
676 # If SortOrder is greater than the elements in array, then it defaults to the first element
679 my ($colno, $alpnum, $srtdir, @tobesorted) = @_;
685 my $ttlitems = scalar @tobesorted; # want to know the number of rows in the passed array
686 if ($ttlitems < 1){ # if no items, don't waste our time lets leave
687 return (@tobesorted);
689 my @tmp = split(/\,/,$tobesorted[0]);
690 $ttlitems = scalar @tmp; # this should be the number of elements in each row of the passed in array
692 # Darren Critchley - validate parameters
693 if ($colno > $ttlitems){$colno = '1';}
694 $colno--; # remove one from colno to deal with arrays starting at 0
695 if($colno < 0){$colno = '0';}
696 if ($alpnum ne '') { $alpnum = lc($alpnum); } else { $alpnum = 'a'; }
697 if ($srtdir ne '') { $srtdir = lc($srtdir); } else { $srtdir = 'src'; }
699 foreach $line (@tobesorted)
703 my @temp = split(/\,/,$line);
704 # Darren Critchley - juggle the fields so that the one we want to sort on is first
705 my $tmpholder = $temp[0];
706 $temp[0] = $temp[$colno];
707 $temp[$colno] = $tmpholder;
709 for ($ctr=0; $ctr < $ttlitems ; $ctr++) {
710 $newline=$newline . $temp[$ctr] . ",";
713 push(@tmparray,$newline);
716 if ($alpnum eq 'n') {
717 @tmparray = sort {$a <=> $b} @tmparray;
719 @tmparray = (sort @tmparray);
721 foreach $line (@tmparray)
725 my @temp = split(/\,/,$line);
726 my $tmpholder = $temp[0];
727 $temp[0] = $temp[$colno];
728 $temp[$colno] = $tmpholder;
730 for ($ctr=0; $ctr < $ttlitems ; $ctr++){
731 $newline=$newline . $temp[$ctr] . ",";
734 push(@srtedarray,$newline);
738 if ($srtdir eq 'dsc') {
739 @tmparray = reverse(@srtedarray);
742 return (@srtedarray);
748 &General
::readhash
("${General::swroot}/proxy/settings", \
%proxysettings);
749 if ($_=$proxysettings{'UPSTREAM_PROXY'}) {
750 my ($peer, $peerport) = (/^(?:[a-zA-Z ]+\:\/\
/)?(?:[A-Za-z0-9\_\.\-]*?(?:\:[A-Za-z0-9\_\.\-]*?)?\@)?([a-zA-Z0-9\.\_\-]*?)(?:\:([0-9]{1,5}))?(?:\/.*?
)?
$/);
751 Net
::SSLeay
::set_proxy
($peer,$peerport,$proxysettings{'UPSTREAM_USER'},$proxysettings{'UPSTREAM_PASSWORD'} );
753 my ($out, $response) = Net
::SSLeay
::get_http
( 'checkip.dyndns.org',
756 Net
::SSLeay
::make_headers
('User-Agent' => 'IPFire' )
758 if ($response =~ m
%HTTP/1\
.. 200 OK
%) {
759 $out =~ /Current IP Address: (\d+.\d+.\d+.\d+)/;
766 # Check if hostname.domain provided have IP provided
767 # use gethostbyname to verify that
773 # 1 IP matches host.domain
776 sub DyndnsServiceSync
($;$;$) {
778 my ($ip,$hostName,$domain) = @_;
781 #fix me no ip GROUP, what is the name ?
782 $hostName =~ s/$General::noipprefix//;
783 if ($hostName) { #may be empty
784 $hostName = "$hostName.$domain";
785 @addresses = gethostbyname($hostName);
788 if ($addresses[0] eq '') { # nothing returned ?
789 $hostName = $domain; # try resolving with domain only
790 @addresses = gethostbyname($hostName);
793 if ($addresses[0] ne '') { # got something ?
794 #&General::log("name:$addresses[0], alias:$addresses[1]");
795 # Build clear text list of IP
796 @addresses = map ( &Socket
::inet_ntoa
($_), @addresses[4..$#addresses]);
797 if (grep (/$ip/, @addresses)) {
804 # This sub returns the red IP used to compare in DyndnsServiceSync
808 &General
::readhash
("${General::swroot}/ddns/settings", \
%settings);
810 open(IP
, "${General::swroot}/red/local-ipaddress") or return 'unavailable';
815 if (&General
::IpInSubnet
($ip,'10.0.0.0','255.0.0.0') ||
816 &General
::IpInSubnet
($ip,'172.16.0.0.','255.240.0.0') ||
817 &General
::IpInSubnet
($ip,'192.168.0.0','255.255.0.0'))
819 if ($settings{'BEHINDROUTER'} eq 'FETCH_IP') {
820 my $RealIP = &General
::FetchPublicIp
;
821 $ip = (&General
::validip
($RealIP) ?
$RealIP : 'unavailable');
827 # Translate ICMP code to text
828 # ref: http://www.iana.org/assignments/icmp-parameters
829 sub GetIcmpDescription
($) {
831 my @icmp_description = (
835 'Destination Unreachable',
838 'Alternate Host Address',
841 'Router Advertisement',
842 'Router Solicitation', #10
847 'Information Request',
849 'Address Mask Request',
850 'Address Mask Reply',
851 'Reserved (for Security)',
852 'Reserved (for Robustness Experiment)', #20
863 'Datagram Conversion Error',
864 'Mobile Host Redirect',
865 'IPv6 Where-Are-You',
867 'Mobile Registration Request',
868 'Mobile Registration Reply',
869 'Domain Name Request',
874 if ($index>41) {return 'unknown'} else {return @icmp_description[$index]};