Project

General

Profile

Download (16.5 KB) Statistics
| Branch: | Tag: | Revision:
1
<?php
2
/*
3
  Copyright (C) 2008 Bill Marquette, Seth Mos
4
  Copyright (C) 2010 Ermal Lu?i
5
  All rights reserved.
6

    
7
  Redistribution and use in source and binary forms, with or without
8
  modification, are permitted provided that the following conditions are met:
9

    
10
  1. Redistributions of source code must retain the above copyright notice,
11
  this list of conditions and the following disclaimer.
12

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

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

    
28
	pfSense_BUILDER_BINARIES:	/usr/bin/killall	/sbin/route	/usr/local/sbin/apinger
29
	pfSense_MODULE:	routing
30

    
31
 */
32

    
33
/*
34
 * Creates monitoring configuration file and
35
 * adds apropriate static routes.
36
 */
37
function setup_gateways_monitor() {
38
	global $config, $g;
39

    
40
	$gateways_arr = return_gateways_array();
41
	if (!is_array($gateways_arr)) {
42
		log_error("No gateways to monitor. Apinger will not be run.");
43
		killbypid("{$g['varrun_path']}/apinger.pid");
44
		@unlink("{$g['tmp_path']}/apinger.status");
45
		return;
46
	}
47

    
48
	/* Default settings. Probably should move to globals.inc? */
49
	$a_settings = array();
50
	$a_settings['latencylow'] = "200";
51
	$a_settings['latencyhigh'] = "500";
52
	$a_settings['losslow'] = "10";
53
	$a_settings['losshigh'] = "20";
54

    
55
	$fd = fopen("{$g['varetc_path']}/apinger.conf", "w");
56
	$apingerconfig = <<<EOD
57

    
58
# pfSense apinger configuration file. Automatically Generated!
59

    
60
## User and group the pinger should run as
61
user "root"
62
group "wheel"
63

    
64
## Mailer to use (default: "/usr/lib/sendmail -t")
65
#mailer "/var/qmail/bin/qmail-inject" 
66

    
67
## Location of the pid-file (default: "/var/run/apinger.pid")
68
pid_file "{$g['varrun_path']}/apinger.pid"
69

    
70
## Format of timestamp (%s macro) (default: "%b %d %H:%M:%S")
71
#timestamp_format "%Y%m%d%H%M%S"
72

    
73
status {
74
	## File where the status information whould be written to
75
	file "{$g['tmp_path']}/apinger.status"
76
	## Interval between file updates
77
	## when 0 or not set, file is written only when SIGUSR1 is received
78
	interval 5s
79
}
80

    
81
########################################
82
# RRDTool status gathering configuration
83
# Interval between RRD updates
84
rrd interval 60s;
85

    
86
## These parameters can be overriden in a specific alarm configuration
87
alarm default { 
88
	command on "/usr/local/sbin/pfSctl -c 'filter reload'"
89
	command off "/usr/local/sbin/pfSctl -c 'filter reload'"
90
	combine 10s
91
}
92

    
93
## "Down" alarm definition. 
94
## This alarm will be fired when target doesn't respond for 30 seconds.
95
alarm down "down" {
96
	time 10s
97
}
98

    
99
## "Delay" alarm definition. 
100
## This alarm will be fired when responses are delayed more than 200ms
101
## it will be canceled, when the delay drops below 100ms
102
alarm delay "delay" {
103
	delay_low {$a_settings['latencylow']}ms
104
	delay_high {$a_settings['latencyhigh']}ms
105
}
106

    
107
## "Loss" alarm definition. 
108
## This alarm will be fired when packet loss goes over 20%
109
## it will be canceled, when the loss drops below 10%
110
alarm loss "loss" {
111
	percent_low {$a_settings['losslow']}
112
	percent_high {$a_settings['losshigh']}
113
}
114

    
115
target default {
116
	## How often the probe should be sent	
117
	interval 1s
118
	
119
	## How many replies should be used to compute average delay 
120
	## for controlling "delay" alarms
121
	avg_delay_samples 10
122
	
123
	## How many probes should be used to compute average loss
124
	avg_loss_samples 50
125

    
126
	## The delay (in samples) after which loss is computed
127
	## without this delays larger than interval would be treated as loss
128
	avg_loss_delay_samples 20
129

    
130
	## Names of the alarms that may be generated for the target
131
	alarms "down","delay","loss"
132

    
133
	## Location of the RRD
134
	#rrd file "{$g['vardb_path']}/rrd/apinger-%t.rrd"
135
}
136

    
137
EOD;
138

    
139
	foreach($gateways_arr as $name => $gateway) {
140
		if (empty($gateway['monitor']) || !is_ipaddr($gateway['monitor'])) {
141
			if (is_ipaddr($gateway['gateway']))
142
				$gateway['monitor'] = $gateway['gateway'];
143
			else /* No chance to get an ip to monitor skip target. */
144
				continue;
145
		}
146

    
147
		/* Interface ip is needed since apinger will bind a socket to it. */
148
		$gwifip = find_interface_ip($gateway['interface'], true);
149
		if (!is_ipaddr($gwifip))
150
			continue; //Skip this target
151

    
152
		$apingercfg = "target \"{$gateway['monitor']}\" {\n";
153
		$apingercfg .= "	description \"{$name}\"\n";
154
		$apingercfg .= "	srcip \"{$gwifip}\"\n";
155
		$alarms = "";
156
		$alarmscfg = "";
157
		$override = false;
158
		if (!empty($gateway['lowloss'])) {
159
			$alarmscfg .= "alarm loss \"{$name}loss\" {\n";
160
			$alarmscfg .= "\tpercent_low {$gateway['losslow']}\n";
161
       			$alarmscfg .= "\tpercent_high {$gateway['losshigh']}\n";
162
			$alarmscfg .= "}\n";
163
			$alarms .= "\"{$name}loss\"";
164
			$override = true;
165
		} else {
166
			if ($override == true)
167
				$alarms .= ",";
168
			$alarms .= "\"loss\"";
169
			$override = true;
170
		}
171
		if (!empty($gateway['latencylow'])) {
172
			$alarmscfg .= "alarm delay \"{$name}delay\" {\n";
173
			$alarmscfg .= "\tdelay_low {$gateway['latencylow']}ms\n";
174
			$alarmscfg .= "\tdelay_high {$gateway['latencyhigh']}ms\n";
175
			$alarmscfg .= "}\n";
176
			if ($override == true)
177
				$alarms .= ",";
178
			$alarms .= "\"{$name}delay\"";
179
			$override = true;
180
		} else {
181
			if ($override == true)
182
				$alarms .= ",";
183
			$alarms .= "\"delay\"";
184
			$override = true;
185
		}
186
		if (!empty($gateway['down'])) {
187
			$alarmscfg .= "alarm down \"{$name}down\" {\n";
188
			$alarmscfg .= "\ttime {$gateway['down']}s\n";
189
			$alarmscfg .= "}\n";
190
			if ($override == true)
191
				$alarms .= ",";
192
			$alarms .= "\"{$name}down\"";
193
			$override = true;
194
		} else {
195
			if ($override == true)
196
				$alarms .= ",";
197
			$alarms .= "\"down\"";
198
			$override = true;
199
		}
200
		if ($override == true)
201
			$apingercfg .= "\talarms override {$alarms};\n";
202

    
203
		$apingercfg .= "	rrd file \"{$g['vardb_path']}/rrd/{$gateway['name']}-quality.rrd\"\n";
204
		$apingercfg .= "}\n";
205
		$apingercfg .= "\n";
206
		/*
207
		 * If the gateway is the same as the monitor we do not add a
208
		 * route as this will break the routing table.
209
		 * Add static routes for each gateway with their monitor IP
210
		 * not strictly necessary but is a added level of protection.
211
		 */
212
		if (is_ipaddr($gateway['gateway']) && $gateway['monitor'] != $gateway['gateway']) {
213
			log_error("Removing static route for monitor {$gateway['monitor']} and adding a new route through {$gateway['gateway']}");
214
			mwexec("/sbin/route delete -host " . escapeshellarg($gateway['monitor']), true);
215
			mwexec("/sbin/route add -host " . escapeshellarg($gateway['monitor']) .
216
				" " . escapeshellarg($gateway['gateway']));
217
		}
218

    
219
		$apingerconfig .= $alarmscfg;
220
		$apingerconfig .= $apingercfg;
221
	}
222
	fwrite($fd, $apingerconfig);
223
	fclose($fd);
224

    
225
	killbypid("{$g['varrun_path']}/apinger.pid");
226
	if (is_dir("{$g['tmp_path']}"))
227
		chmod("{$g['tmp_path']}", 01777);
228
	if (!is_dir("{$g['vardb_path']}/rrd"))
229
		mkdir("{$g['vardb_path']}/rrd", 0775);
230

    
231
	@chown("{$g['vardb_path']}/rrd", "nobody");
232

    
233
	/* start a new apinger process */
234
	@unlink("{$g['tmp_path']}/apinger.status");
235
	mwexec_bg("/usr/local/sbin/apinger -c {$g['varetc_path']}/apinger.conf");
236

    
237
	return 0;
238
}
239

    
240
/* return the status of the apinger targets as a array */
241
function return_gateways_status($byname = false) {
242
	global $config, $g;
243

    
244
	$apingerstatus = array();
245
	if (file_exists("{$g['tmp_path']}/apinger.status")) {
246
		$apingerstatus = file("{$g['tmp_path']}/apinger.status");
247
	}
248

    
249
	$status = array();
250
	foreach($apingerstatus as $line) {
251
		$info = explode("|", $line);
252
		if ($byname == false)
253
			$target = $info[0];
254
		else
255
			$target = $info[2];
256
		$status[$target]['monitorip'] = $info[0];
257
		$status[$target]['srcip'] = $info[1];
258
		$status[$target]['name'] = $info[2];
259
		$status[$target]['lastcheck'] = $info[5] ? date('r', $info[5]) : date('r');
260
		$status[$target]['delay'] = empty($info[6]) ? 0 : $info[6];
261
		$status[$target]['loss'] = empty($info[7]) ? "0.0%" : $info[7] . "";
262
		$status[$target]['status'] = trim($info[8]);
263
	}
264

    
265
	return($status);
266
}
267

    
268
/* Return all configured gateways on the system */
269
function return_gateways_array($disabled = false) {
270
	global $config, $g;
271

    
272
	$gateways_arr = array();
273

    
274
	$i = 0;
275
	/* Process/add all the configured gateways. */
276
	if (is_array($config['gateways']['gateway_item'])) {
277
		foreach($config['gateways']['gateway_item'] as $gateway) {
278
			if(empty($gateway['gateway']) || $gateway['gateway'] == "dynamic") {
279
				$gateway['gateway'] = get_interface_gateway($gateway['interface']);
280
				/* no IP address found, set to dynamic */
281
				if(! is_ipaddr($gateway['gateway']))
282
					$gateway['gateway'] = "dynamic";
283
				$gateway['dynamic'] = true;
284
			}
285
			if(empty($gateway['monitor']))
286
				$gateway['monitor'] = $gateway['gateway'];
287

    
288
			$gateway['friendlyiface'] = $gateway['interface'];
289
			$gateway['interface'] = get_real_interface($gateway['interface']);
290
			/* Some interface like wan might be default but have no info recorded 
291
			 * the config.
292
			 */
293
			if ($gateway['friendlyiface'] == "wan" && !isset($gateway['defaultgw'])) {
294
				if (file_exists("{$g['tmp_path']}/{$gateway['interface']}_defaultgw"))
295
					$gateway['defaultgw'] = true;
296
			}
297
			/* include the gateway index as the attribute */
298
			$gateway['attribute'] = $i;
299

    
300
			$gateways_arr[$gateway['name']] = $gateway;
301
			$i++;
302
		}
303
	} 
304

    
305
	/* Loop through all interfaces with a gateway and add it to a array */
306
	if ($disabled == false)
307
		$iflist = get_configured_interface_with_descr();
308
	else
309
		$iflist = get_configured_interface_with_descr(false, true);
310

    
311
	/* Process/add dynamic gateways. */
312
	foreach($iflist as $ifname => $friendly ) {
313
		if(! interface_has_gateway($ifname))
314
			continue;
315

    
316
		$ifcfg = $config['interfaces'][$ifname];
317
		if (!empty($ifcfg['ipaddr']) && is_ipaddr($ifcfg['ipaddr']))
318
			continue;
319

    
320
		$gateway = array();
321
		$gateway['dynamic'] = false;
322
		$gateway['gateway'] = get_interface_gateway($ifname, $gateway['dynamic']);
323
		$gateway['interface'] = get_real_interface($ifname);
324
		$gateway['friendlyiface'] = $ifname;
325
		$gateway['name'] = $friendly;
326
		$gateway['attribute'] = "system";
327
	
328
		if ($gateway['dynamic'] == "default") {
329
			$gateway['defaultgw'] = true;
330
			$gateway['dynamic'] = true;
331
		}
332
		/* Loopback dummy for dynamic interfaces without a IP */
333
		if (!is_ipaddr($gateway['gateway']) && $gateway['dynamic'] == true)
334
			$gateway['gateway'] = "dynamic";
335

    
336
		/* automatically skip known static and dynamic gateways we have a array entry for */
337
		foreach($gateways_arr as $gateway_item) {
338
			if ($ifname == $gateway_item['friendlyiface'] && $friendly == $gateway_item['name'])
339
					continue 2;
340
		}
341

    
342
		if (is_ipaddr($gateway['gateway']))
343
			$gateway['monitor'] = $gateway['gateway'];
344

    
345
		$gateway['descr'] = "Interface {$friendly} Dynamic Gateway";
346
		$gateways_arr[$friendly] = $gateway;
347
	}
348

    
349
	return($gateways_arr);
350
}
351

    
352
/*
353
 * Return an array with all gateway groups with name as key
354
 * All gateway groups will be processed before returning the array.
355
 */
356
function return_gateway_groups_array() {
357
	global $config, $g;
358

    
359
	/* fetch the current gateways status */
360
	$gateways_status = return_gateways_status(true);
361
	$gateways_arr = return_gateways_array();
362
	$gateway_groups_array = array();
363

    
364
	if (is_array($config['gateways']['gateway_group'])) {
365
		foreach($config['gateways']['gateway_group'] as $group) {
366
			/* create array with group gateways members seperated by tier */
367
			$tiers = array();
368
			$backupplan = array();
369
			foreach($group['item'] as $item) {
370
				$itemsplit = explode("|", $item);
371
				$tier = $itemsplit[1];
372
				$gwname = $itemsplit[0];
373

    
374
				/* Do it here rather than reiterating again the group in case no member is up. */
375
				$backupplan[$tier][] = $gwname;
376

    
377
				/* check if the gateway is available before adding it to the array */
378
				if (!empty($gateways_status[$gwname])) {
379
					$status = $gateways_status[$gwname];
380
					$gwdown = false;
381
					if (stristr($status['status'], "down")) {
382
						$msg = "MONITOR: {$gwname} has high latency, removing from routing group";
383
						$gwdown = true;
384
					} else if (stristr($status['status'], "loss") && strstr($group['trigger'], "loss")) {
385
						/* packet loss */
386
						$msg = "MONITOR: {$gwname} has packet loss, removing from routing group";
387
						$gwdown = true;
388
					} else if (stristr($status['status'], "delay") && strstr($group['trigger'] , "latency")) {
389
						/* high latency */
390
						$msg = "MONITOR: {$gwname} has high latency, removing from routing group";
391
						$gwdown = true;
392
					}
393
					if ($gwdown == true) {
394
						log_error($msg);
395
						notify_via_growl($msg);
396
					} else
397
						/* Online add member */
398
						$tiers[$tier][] = $gwname;
399
				}
400
			}
401
			$tiers_count = count($tiers);
402
			if($tiers_count == 0) {
403
				/* Oh dear, we have no members! Engage Plan B */
404
				$msg = "Gateways status could not be determined, considering all as up/active.";
405
				log_error($msg);
406
				notify_via_growl($msg);
407
				$tiers = $backupplan;
408
			}
409
			/* sort the tiers array by the tier key */
410
			ksort($tiers);
411

    
412
			/* we do not really foreach the tiers as we stop after the first tier */
413
			foreach($tiers as $tier) {
414
				/* process all gateways in this tier */
415
				foreach($tier as $member) {
416
					/* determine interface gateway */
417
					if (isset($gateways_arr[$member])) {
418
						$gateway = $gateways_arr[$member];
419
						$int = $gateway['interface'];
420
						$gatewayip = "";
421
						if(is_ipaddr($gateway['gateway'])) 
422
							$gatewayip = $gateway['gateway'];
423
						else if ($int <> "")
424
							$gatewayip = get_interface_gateway($gateway['friendlyiface']);
425
					
426
						if (($int <> "") && is_ipaddr($gatewayip)) {
427
							$groupmember = array();
428
							$groupmember['int']  = $int;
429
							$groupmember['gwip']  = $gatewayip;
430
							$groupmember['weight']  = isset($gateway['weight']) ? $gateway['weight'] : 1;
431
							$gateway_groups_array[$group['name']][] = $groupmember;
432
						}
433
					}
434
				}
435
				/* we should have the 1st available tier now, exit stage left */
436
				break;
437
			}
438
		}
439
	}
440
	return ($gateway_groups_array);
441
}
442

    
443
/* Update DHCP WAN Interface ip address in gateway group item */
444
function dhclient_update_gateway_groups_defaultroute($interface = "wan") {
445
	global $config, $g;
446
	foreach($config['gateways']['gateway_item'] as & $gw) {	
447
		if($gw['interface'] == $interface) {
448
			$current_gw = get_interface_gateway($interface);
449
			if($gw['gateway'] <> $current_gw) {
450
				$gw['gateway'] = $current_gw;
451
				$changed = true;
452
			}
453
		}
454
	}
455
	if($changed && $current_gw)
456
		write_config("Updating gateway group gateway for $interface - new gateway is $current_gw");
457
}
458

    
459
function lookup_gateway_ip_by_name($name) {
460

    
461
	$gateways_arr = return_gateways_array();
462
        foreach ($gateways_arr as $gname => $gw) {
463
                if ($gw['name'] == $name || $gname == $name)
464
                        return $gw['gateway'];
465
        }
466

    
467
	return false;
468
}
469

    
470
function lookup_gateway_monitor_ip_by_name($name) {
471

    
472
        $gateways_arr = return_gateways_array();
473
	if (!empty($gateways_arr[$name])) {
474
		$gateway = $gateways_arr[$name];
475
		if(!is_ipaddr($gateway['monitor']))
476
			return $gateway['gateway'];
477

    
478
		return $gateway['monitor'];
479
        }
480

    
481
        return (false);
482
}
483

    
484
function lookup_gateway_interface_by_name($name) {
485

    
486
        $gateways_arr = return_gateways_array();
487
	if (!empty($gateways_arr[$name])) {
488
		$interfacegw = $gateway['interface'];
489
		return ($interfacegw);
490
        }
491

    
492
        return (false);
493
}
494

    
495
function get_interface_gateway($interface, &$dynamic = false) {
496
        global $config, $g;
497

    
498
        $gw = NULL;
499

    
500
        $gwcfg = $config['interfaces'][$interface];
501
        if (!empty($gwcfg['gateway']) && is_array($config['gateways']['gateway_item'])) {
502
               	foreach($config['gateways']['gateway_item'] as $gateway) {
503
                        if ($gateway['name'] == $gwcfg['gateway']) {
504
                                $gw = $gateway['gateway'];
505
				break;
506
			}
507
                }
508
	}
509

    
510
        // for dynamic interfaces we handle them through the $interface_router file.
511
        if (!is_ipaddr($gw) && !is_ipaddr($gwcfg['ipaddr'])) {
512
                $realif = get_real_interface($interface);
513
                if (file_exists("{$g['tmp_path']}/{$realif}_router")) {
514
                        $gw = trim(file_get_contents("{$g['tmp_path']}/{$realif}_router"), " \n");
515
					$dynamic = true;
516
                }
517
                if (file_exists("{$g['tmp_path']}/{$realif}_defaultgw"))
518
					$dynamic = "default";
519
			
520
				
521
        }
522

    
523
        /* return gateway */
524
        return ($gw);
525
}
526

    
527
?>
(21-21/54)