Project

General

Profile

Download (16.1 KB) Statistics
| Branch: | Tag: | Revision:
1
<?php
2
/* $Id$ */
3
/*
4
	util.inc
5
	part of m0n0wall (http://m0n0.ch/wall)
6

    
7
	Copyright (C) 2003-2004 Manuel Kasper <mk@neon1.net>.
8
	All rights reserved.
9

    
10
	Redistribution and use in source and binary forms, with or without
11
	modification, are permitted provided that the following conditions are met:
12

    
13
	1. Redistributions of source code must retain the above copyright notice,
14
	   this list of conditions and the following disclaimer.
15

    
16
	2. Redistributions in binary form must reproduce the above copyright
17
	   notice, this list of conditions and the following disclaimer in the
18
	   documentation and/or other materials provided with the distribution.
19

    
20
	THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
21
	INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
22
	AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23
	AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
24
	OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25
	SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26
	INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27
	CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28
	ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29
	POSSIBILITY OF SUCH DAMAGE.
30
*/
31

    
32
/* kill a process by pid file */
33
function killbypid($pidfile) {
34
	sigkillbypid($pidfile, "TERM");
35
}
36

    
37
function isvalidpid($pid) {
38
	$running = `ps -p $pid | wc -l`;
39
	if(intval($running) > 1)
40
		return true;
41
	else 
42
		return false;
43
}
44

    
45
function isvalidproc($proc) {
46
	$running = `ps awux | grep $proc | grep -v grep | wc -l`;
47
	if(intval($running) > 1)
48
		return true;
49
	else 
50
		return false;
51
}
52

    
53
/* sigkill a process by pid file */
54
/* return 1 for success and 0 for a failure */
55
function sigkillbypid($pidfile, $sig) {
56
	if (is_file($pidfile)) {
57
		$pid = trim(file_get_contents($pidfile));
58
		if(isvalidpid($pid))
59
			return mwexec("/bin/kill -s $sig {$pid}");
60
	}
61

    
62
	return 0;
63
}
64

    
65
/* kill a process by name */
66
function sigkillbyname($procname, $sig) {
67
	if(isvalidproc($procname))
68
		return mwexec("/usr/bin/killall -{$sig} " . escapeshellarg($procname));
69
}
70

    
71
/* kill a process by name */
72
function killbyname($procname) {
73
	if(isvalidproc($procname))
74
		mwexec("/usr/bin/killall " . escapeshellarg($procname));
75
}
76

    
77
/* return the subnet address given a host address and a subnet bit count */
78
function gen_subnet($ipaddr, $bits) {
79
	if (!is_ipaddr($ipaddr) || !is_numeric($bits))
80
		return "";
81

    
82
	return long2ip(ip2long($ipaddr) & gen_subnet_mask_long($bits));
83
}
84

    
85
/* return the highest (broadcast) address in the subnet given a host address and a subnet bit count */
86
function gen_subnet_max($ipaddr, $bits) {
87
	if (!is_ipaddr($ipaddr) || !is_numeric($bits))
88
		return "";
89

    
90
	return long2ip(ip2long($ipaddr) | ~gen_subnet_mask_long($bits));
91
}
92

    
93
/* returns a subnet mask (long given a bit count) */
94
function gen_subnet_mask_long($bits) {
95
	$sm = 0;
96
	for ($i = 0; $i < $bits; $i++) {
97
		$sm >>= 1;
98
		$sm |= 0x80000000;
99
	}
100
	return $sm;
101
}
102

    
103
/* same as above but returns a string */
104
function gen_subnet_mask($bits) {
105
	return long2ip(gen_subnet_mask_long($bits));
106
}
107

    
108
function is_numericint($arg) {
109
	return (preg_match("/[^0-9]/", $arg) ? false : true);
110
}
111

    
112
/* returns true if $ipaddr is a valid dotted IPv4 address */
113
function is_ipaddr($ipaddr) {
114
	if (!is_string($ipaddr))
115
		return false;
116

    
117
	$ip_long = ip2long($ipaddr);
118
	$ip_reverse = long2ip($ip_long);
119

    
120
	if ($ipaddr == $ip_reverse)
121
		return true;
122
	else
123
		return false;
124
}
125

    
126
/* returns true if $ipaddr is a valid dotted IPv4 address or an alias thereof */
127
function is_ipaddroralias($ipaddr) {
128

    
129
	global $aliastable, $config;
130

    
131
	if(is_array($config['aliases']['alias'])) {
132
		foreach($config['aliases']['alias'] as $alias) {
133
			if($alias['name'] == $ipaddr)
134
				return true;
135
		}
136
	}
137

    
138
	if (isset($aliastable[$ipaddr]) && is_ipaddr($aliastable[$ipaddr]))
139
		return true;
140
	else
141
		return is_ipaddr($ipaddr);
142

    
143
}
144

    
145
/* returns true if $ipaddr is a valid dotted IPv4 address or any alias */
146
function is_ipaddroranyalias($ipaddr) {
147

    
148
	global $aliastable;
149

    
150
	if (isset($aliastable[$ipaddr]))
151
		return true;
152
	else
153
		return is_ipaddr($ipaddr);
154
}
155

    
156
/* returns true if $subnet is a valid subnet in CIDR format */
157
function is_subnet($subnet) {
158
	if (!is_string($subnet))
159
		return false;
160

    
161
	list($hp,$np) = explode('/', $subnet);
162

    
163
	if (!is_ipaddr($hp))
164
		return false;
165

    
166
	if (!is_numeric($np) || ($np < 1) || ($np > 32))
167
		return false;
168

    
169
	return true;
170
}
171

    
172
/* returns true if $subnet is a valid subnet in CIDR format or an alias thereof */
173
function is_subnetoralias($subnet) {
174

    
175
	global $aliastable;
176

    
177
	if (isset($aliastable[$subnet]) && is_subnet($aliastable[$subnet]))
178
		return true;
179
	else
180
		return is_subnet($subnet);
181
}
182

    
183
/* returns true if $hostname is a valid hostname */
184
function is_hostname($hostname) {
185
	if (!is_string($hostname))
186
		return false;
187

    
188
	if (preg_match("/^([_a-z0-9\-]+\.?)+$/i", $hostname))
189
		return true;
190
	else
191
		return false;
192
}
193

    
194
/* returns true if $domain is a valid domain name */
195
function is_domain($domain) {
196
	if (!is_string($domain))
197
		return false;
198

    
199
	if (preg_match("/^([a-z0-9\-]+\.?)+$/i", $domain))
200
		return true;
201
	else
202
		return false;
203
}
204

    
205
/* returns true if $uname is a valid DynDNS username */
206
function is_dyndns_username($uname) {
207
	if (!is_string($uname))
208
		return false;
209

    
210
	if (preg_match("/[^a-z0-9\-.@_]/i", $uname))
211
		return false;
212
	else
213
		return true;
214
}
215

    
216
/* returns true if $macaddr is a valid MAC address */
217
function is_macaddr($macaddr) {
218
	if (!is_string($macaddr))
219
		return false;
220

    
221
	$maca = explode(":", $macaddr);
222
	if (count($maca) != 6)
223
		return false;
224

    
225
	foreach ($maca as $macel) {
226
		if (($macel === "") || (strlen($macel) > 2))
227
			return false;
228
		if (preg_match("/[^0-9a-f]/i", $macel))
229
			return false;
230
	}
231

    
232
	return true;
233
}
234

    
235
/* returns true if $name is a valid name for an alias */
236
/* returns NULL if a reserved word is used */
237
function is_validaliasname($name) {
238
	/* Array of reserved words */
239
	$reserved = array("port", "pass");
240
	if (in_array($name, $reserved, true))
241
		return; /* return NULL */
242

    
243
	if (!preg_match("/[^a-zA-Z0-9_]/", $name))
244
		return true;
245
	else
246
		return false;
247
}
248

    
249
/* returns true if $port is a valid TCP/UDP port */
250
function is_port($port) {
251
	if (!is_numericint($port))
252
		return false;
253

    
254
	if (($port < 1) || ($port > 65535))
255
		return false;
256
	else
257
		return true;
258
}
259

    
260
/* returns true if $portrange is a valid TCP/UDP portrange ("<port>:<port>") */
261
function is_portrange($portrange) {
262
        $ports = explode(":", $portrange);
263

    
264
        if(count($ports) == 2 && is_port($ports[0]) && is_port($ports[1]))
265
                return true;
266
        else
267
                return false;
268
}
269

    
270
/* returns true if $val is a valid shaper bandwidth value */
271
function is_valid_shaperbw($val) {
272
	return (preg_match("/^(\d+(?:\.\d+)?)([MKG]?b|%)$/", $val));
273
}
274

    
275
/* return the configured interfaces list. */
276
function get_configured_interface_list($only_opt = false, $withdisabled = false) {
277
	global $config;
278

    
279
	$iflist = array();
280

    
281
	/* if list */
282
        foreach($config['interfaces'] as $if => $ifdetail) {
283
		if ($only_opt == true && ($if == "wan" || $if == "lan"))
284
			continue;
285
		if ($if == "wan" || $if == "lan" || isset($ifdetail['enable']) || 
286
			$withdisabled == true) 
287
			$iflist[$if] = $if;
288
	}
289

    
290
	return $iflist;
291
			
292
}
293

    
294
/* return the configured interfaces list with their description. */
295
function get_configured_interface_with_descr($only_opt = false, $withdisabled = false) {
296
        global $config;
297

    
298
        $iflist = array();
299

    
300
        /* if list */
301
        foreach($config['interfaces'] as $if => $ifdetail) {
302
               	if ($only_opt == true && ($if == "wan" || $if == "lan"))
303
                        continue;
304
                if ($if == "wan" || $if == "lan" || isset($ifdetail['enable']) ||
305
			$withdisabled == true) {
306
			if($ifdetail['descr'] == "")
307
				$iflist[$if] = strtoupper($if);
308
                        else
309
				$iflist[$if] = $ifdetail['descr'];
310
		}
311
	}
312

    
313
        return $iflist;
314

    
315
}
316

    
317

    
318
/*
319
 *   get_interface_list() - Return a list of all physical interfaces
320
 *   along with MAC and status.
321
 *
322
 *   $mode = "active" - use ifconfig -lu
323
 *           "media"  - use ifconfig to check physical connection
324
 *			status (much slower)
325
 */
326
function get_interface_list($mode = "active", $keyby = "physical", $vfaces = "") {
327
        global $config;
328
	$upints = array();
329
        /* get a list of virtual interface types */
330
        if(!$vfaces) {
331
		$vfaces = array (
332
				'bridge',
333
				'ppp',
334
				'sl',
335
				'gif',
336
				'gre',
337
				'faith',
338
				'lo',
339
				'ng',
340
				'vlan',
341
				'pflog',
342
				'pfsync',
343
				'enc',
344
				'tun',
345
				'carp',
346
				'lagg',
347
				'plip'
348
		);
349
	}
350
	switch($mode) {
351
	case "active":
352
                $upints = explode(" ", trim(shell_exec("/sbin/ifconfig -lu")));
353
        	break;
354
	case "media":
355
                $intlist = explode(" ", trim(shell_exec("/sbin/ifconfig -l")));
356
                $ifconfig = "";
357
                exec("/sbin/ifconfig -a", $ifconfig);
358
                $regexp = '/(' . implode('|', $intlist) . '):\s/';
359
                $ifstatus = preg_grep('/status:/', $ifconfig);
360
		foreach($ifstatus as $status) {
361
			$int = array_shift($intlist);
362
                	if(stristr($status, "active")) $upints[] = $int;
363
		}
364
		break;
365
	}
366
        /* build interface list with netstat */
367
        $linkinfo = "";
368
        exec("/usr/bin/netstat -inW -f link | awk '{ print $1, $4 }'", $linkinfo);
369
        array_shift($linkinfo);
370
	/* build ip address list with netstat */
371
	$ipinfo = "";
372
	exec("/usr/bin/netstat -inW -f inet | awk '{ print $1, $4 }'", $ipinfo);
373
	array_shift($ipinfo);
374
	foreach($linkinfo as $link) {
375
		$friendly = "";
376
                $alink = explode(" ", $link);
377
                $ifname = rtrim(trim($alink[0]), '*');
378
                /* trim out all numbers before checking for vfaces */
379
		if (!in_array(array_shift(preg_split('/\d/', $ifname)), $vfaces)) {
380
			$toput = array(
381
					"mac" => trim($alink[1]),
382
					"up" => in_array($ifname, $upints)
383
				);
384
			foreach($ipinfo as $ip) {
385
				$aip = explode(" ", $ip);
386
				if($aip[0] == $ifname) {
387
					$toput['ipaddr'] = $aip[1];
388
				}
389
			}
390
			foreach($config['interfaces'] as $name => $int) {
391
				if($int['if'] == $ifname) $friendly = $name;
392
			}
393
			switch($keyby) {
394
			case "physical":
395
				if($friendly != "") {
396
					$toput['friendly'] = $friendly;
397
				}
398
				$iflist[$ifname] = $toput;
399
				break;
400
			case "friendly":
401
				if($friendly != "") {
402
					$toput['if'] = $ifname;
403
					$iflist[$friendly] = $toput;
404
				}
405
				break;
406
			}
407
                }
408
        }
409
        return $iflist;
410
}
411

    
412
/* wrapper for exec() */
413
function mwexec($command) {
414

    
415
	global $g;
416
	$oarr = "";
417
	$retval = "";
418
	if ($g['debug']) {
419
		if (!$_SERVER['REMOTE_ADDR'])
420
			echo "mwexec(): $command\n";
421
		exec("$command > /dev/null 2>&1", $oarr, $retval);
422
	} else {
423
		exec("$command > /dev/null 2>&1", $oarr, $retval);
424
	}
425

    
426
	return $retval;
427
}
428

    
429
/* wrapper for exec() in background */
430
function mwexec_bg($command) {
431

    
432
	global $g;
433

    
434
	if ($g['debug']) {
435
		if (!$_SERVER['REMOTE_ADDR'])
436
			echo "mwexec(): $command\n";
437
	}
438

    
439
	exec("nohup $command > /dev/null 2>&1 &");
440
}
441

    
442
/* unlink a file, if it exists */
443
function unlink_if_exists($fn) {
444
	$to_do = glob($fn);
445
	if(is_array($to_do)) {
446
		foreach($to_do as $filename)
447
			@unlink($filename);
448
	} else {
449
		@unlink($fn);
450
	}
451
}
452
/* make a global alias table (for faster lookups) */
453
function alias_make_table($config) {
454

    
455
	global $aliastable;
456

    
457
	$aliastable = array();
458

    
459
	if (is_array($config['aliases']['alias'])) {
460
		foreach ($config['aliases']['alias'] as $alias) {
461
			if ($alias['name'])
462
				$aliastable[$alias['name']] = $alias['address'];
463
		}
464
	}
465
}
466
/* check if an alias exists */
467
function is_alias($name) {
468

    
469
	global $aliastable;
470

    
471
	return isset($aliastable[$name]);
472
}
473

    
474
function alias_expand_value($name) {
475

    
476
	global $aliastable, $config;
477
	$newaddress = "";
478
	$firstentry = true;
479
	if($config['aliases']['alias'])
480
		foreach($config['aliases']['alias'] as $alias) {
481
			if($alias['name'] == $name) {
482
				if($alias['type'] == "openvpn") {
483
					$vpn_address_split = split(" ", $alias['address']);
484
					foreach($vpn_address_split as $vpnsplit) {
485
						foreach($config['openvpn']['user'] as $openvpn) {
486
							if($openvpn['name'] == $vpnsplit) {
487
								if($firstentry == false) 
488
									$newaddress .= " ";
489
								$newaddress .= $openvpn['ip'];
490
								$firstentry = false;
491
							}
492
						}
493
					}
494
				} else {
495
					$newaddress = $alias['address'];
496
				}
497
			}
498
		}
499
		return $newaddress;
500
}
501

    
502
/* expand a host or network alias, if necessary */
503
function alias_expand($name) {
504

    
505
	global $aliastable;
506

    
507
	if (isset($aliastable[$name]))
508
		return "\${$name}";
509
	else if (is_ipaddr($name) || is_subnet($name))
510
		return "{$name}";
511
	else
512
		return null;
513
}
514

    
515
/* expand a host alias, if necessary */
516
function alias_expand_host($name) {
517
	global $aliastable;
518

    
519
	if (isset($aliastable[$name])) {
520
		$ip_arr = explode(" ", $aliastable[$name]);
521
		foreach($ip_arr as $ip) {
522
			if (!is_ipaddr($ip))
523
				return null;
524
		}
525
		return $aliastable[$name];
526
	} else if (is_ipaddr($name))
527
		return $name;
528
	else
529
		return null;
530
}
531

    
532
/* expand a network alias, if necessary */
533
function alias_expand_net($name) {
534

    
535
	global $aliastable;
536

    
537
	if (isset($aliastable[$name]) && is_subnet($aliastable[$name]))
538
		return $aliastable[$name];
539
	else if (is_subnet($name))
540
		return $name;
541
	else
542
		return null;
543
}
544

    
545
/* find out whether two subnets overlap */
546
function check_subnets_overlap($subnet1, $bits1, $subnet2, $bits2) {
547

    
548
	if (!is_numeric($bits1))
549
		$bits1 = 32;
550
	if (!is_numeric($bits2))
551
		$bits2 = 32;
552

    
553
	if ($bits1 < $bits2)
554
		$relbits = $bits1;
555
	else
556
		$relbits = $bits2;
557

    
558
	$sn1 = gen_subnet_mask_long($relbits) & ip2long($subnet1);
559
	$sn2 = gen_subnet_mask_long($relbits) & ip2long($subnet2);
560

    
561
	if ($sn1 == $sn2)
562
		return true;
563
	else
564
		return false;
565
}
566

    
567
/* compare two IP addresses */
568
function ipcmp($a, $b) {
569
	if (ip2long($a) < ip2long($b))
570
		return -1;
571
	else if (ip2long($a) > ip2long($b))
572
		return 1;
573
	else
574
		return 0;
575
}
576

    
577
/* return true if $addr is in $subnet, false if not */
578
function ip_in_subnet($addr,$subnet) {
579
	list($ip, $mask) = explode('/', $subnet);
580
	$mask = 0xffffffff << (32 - $mask);
581
	return ((ip2long($addr) & $mask) == (ip2long($ip) & $mask));
582
}
583

    
584
/* verify (and remove) the digital signature on a file - returns 0 if OK */
585
function verify_digital_signature($fname) {
586

    
587
	global $g;
588

    
589
	return mwexec("/usr/local/sbin/gzsig verify {$g['etc_path']}/pubkey.pem < " . escapeshellarg($fname));
590

    
591
}
592

    
593
/* obtain MAC address given an IP address by looking at the ARP table */
594
function arp_get_mac_by_ip($ip) {
595
	mwexec("/sbin/ping -c 1 -t 1 {$ip}");
596
	$arpoutput = "";
597
	exec("/usr/sbin/arp -n {$ip}", $arpoutput);
598

    
599
	if ($arpoutput[0]) {
600
		$arpi = explode(" ", $arpoutput[0]);
601
		$macaddr = $arpi[3];
602
		if (is_macaddr($macaddr))
603
			return $macaddr;
604
		else
605
			return false;
606
	}
607

    
608
	return false;
609
}
610

    
611
/* return a fieldname that is safe for xml usage */
612
function xml_safe_fieldname($fieldname) {
613
	$replace = array('/', '-', ' ', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')',
614
			 '_', '+', '=', '{', '}', '[', ']', '|', '/', '<', '>', '?',
615
			 ':', ',', '.', '\'', '\\'
616
		);
617
	return strtolower(str_replace($replace, "", $fieldname));
618
}
619

    
620
function mac_format($clientmac) {
621
    $mac =explode(":", $clientmac);
622

    
623
    global $config;
624

    
625
    $mac_format = $config['captiveportal']['radmac_format'] ? $config['captiveportal']['radmac_format'] : false;
626

    
627
    switch($mac_format) {
628

    
629
        case 'singledash':
630
        return "$mac[0]$mac[1]$mac[2]-$mac[3]$mac[4]$mac[5]";
631

    
632
        case 'ietf':
633
        return "$mac[0]-$mac[1]-$mac[2]-$mac[3]-$mac[4]-$mac[5]";
634

    
635
        case 'cisco':
636
        return "$mac[0]$mac[1].$mac[2]$mac[3].$mac[4]$mac[5]";
637

    
638
        case 'unformatted':
639
        return "$mac[0]$mac[1]$mac[2]$mac[3]$mac[4]$mac[5]";
640

    
641
        default:
642
        return $clientmac;
643
    }
644
}
645

    
646
function resolve_retry($hostname, $retries = 5) {
647

    
648
       if (is_ipaddr($hostname))
649
               return $hostname;
650

    
651
       for ($i = 0; $i < $retries; $i++) {
652
               $ip = gethostbyname($hostname);
653

    
654
               if ($ip && $ip != $hostname) {
655
                       /* success */
656
                       return $ip;
657
               }
658

    
659
               sleep(1);
660
       }
661

    
662
       return false;
663
}
664

    
665
function format_bytes($bytes) {
666
	if ($bytes >= 1073741824) {
667
		return sprintf("%.2f GB", $bytes/1073741824);
668
	} else if ($bytes >= 1048576) {
669
		return sprintf("%.2f MB", $bytes/1048576);
670
	} else if ($bytes >= 1024) {
671
		return sprintf("%.0f KB", $bytes/1024);
672
	} else {
673
		return sprintf("%d bytes", $bytes);
674
	}
675
}
676

    
677
?>
(31-31/37)