gwlb.inc 34.4 KB
Newer Older
Ad Schellevis's avatar
Ad Schellevis committed
1
<?php
2

Ad Schellevis's avatar
Ad Schellevis committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
/*
  Copyright (C) 2008 Bill Marquette, Seth Mos
  Copyright (C) 2010 Ermal Luçi
  All rights reserved.

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

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

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

  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  POSSIBILITY OF SUCH DAMAGE.
28
*/
Ad Schellevis's avatar
Ad Schellevis committed
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47

/* Returns an array of default values used for apinger.conf */
function return_apinger_defaults() {
	return array(
		"latencylow" => "200",
		"latencyhigh" => "500",
		"losslow" => "10",
		"losshigh" => "20",
		"interval" => "1",
		"down" => "10",
		"avg_delay_samples" => "10",
		"avg_loss_samples" => "50",
		"avg_loss_delay_samples" => "20");
}

/*
 * Creates monitoring configuration file and
 * adds appropriate static routes.
 */
48 49
function setup_gateways_monitor()
{
Franco Fichtner's avatar
Franco Fichtner committed
50
	global $config;
Ad Schellevis's avatar
Ad Schellevis committed
51

52 53 54
	@mkdir('/var/db/rrd', 0775);
	@chown('/var/db/rrd', 'nobody');

Ad Schellevis's avatar
Ad Schellevis committed
55 56 57
	$gateways_arr = return_gateways_array();
	if (!is_array($gateways_arr)) {
		log_error("No gateways to monitor. Apinger will not be run.");
58 59
		killbypid('/var/run/apinger.pid');
		@unlink('/var/run/apinger.status');
Ad Schellevis's avatar
Ad Schellevis committed
60 61 62 63 64 65
		return;
	}

	$apinger_default = return_apinger_defaults();
	$apingerconfig = <<<EOD

66
# OPNsense apinger configuration file. Automatically Generated!
Ad Schellevis's avatar
Ad Schellevis committed
67 68 69 70 71 72 73 74 75

## User and group the pinger should run as
user "root"
group "wheel"

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

## Location of the pid-file (default: "/var/run/apinger.pid")
76
pid_file "/var/run/apinger.pid"
Ad Schellevis's avatar
Ad Schellevis committed
77 78 79 80 81 82

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

status {
	## File where the status information should be written to
83
	file "/var/run/apinger.status"
Ad Schellevis's avatar
Ad Schellevis committed
84 85 86 87 88 89 90 91 92 93 94 95
	## Interval between file updates
	## when 0 or not set, file is written only when SIGUSR1 is received
	interval 5s
}

########################################
# RRDTool status gathering configuration
# Interval between RRD updates
rrd interval 60s;

## These parameters can be overridden in a specific alarm configuration
alarm default {
96 97
	command on "/usr/local/opnsense/service/configd_ctl.py -m 'dyndns reload %T' 'ipsecdns reload' 'openvpn reload %T'  'filter reload' "
	command off "/usr/local/opnsense/service/configd_ctl.py -m 'dyndns reload %T' 'ipsecdns reload' 'openvpn reload %T' 'filter reload' "
Ad Schellevis's avatar
Ad Schellevis committed
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
	combine 10s
}

## "Down" alarm definition.
## This alarm will be fired when target doesn't respond for 30 seconds.
alarm down "down" {
	time {$apinger_default['down']}s
}

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

## "Loss" alarm definition.
## This alarm will be fired when packet loss goes over 20%
## it will be canceled, when the loss drops below 10%
alarm loss "loss" {
	percent_low {$apinger_default['losslow']}
	percent_high {$apinger_default['losshigh']}
}

target default {
	## How often the probe should be sent
	interval {$apinger_default['interval']}s

	## How many replies should be used to compute average delay
	## for controlling "delay" alarms
	avg_delay_samples {$apinger_default['avg_delay_samples']}

	## How many probes should be used to compute average loss
	avg_loss_samples {$apinger_default['avg_loss_samples']}

	## The delay (in samples) after which loss is computed
	## without this delays larger than interval would be treated as loss
	avg_loss_delay_samples {$apinger_default['avg_loss_delay_samples']}

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

	## Location of the RRD
142
	#rrd file "/var/db/rrd/apinger-%t.rrd"
Ad Schellevis's avatar
Ad Schellevis committed
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
}

EOD;

	$monitor_ips = array();
	foreach($gateways_arr as $name => $gateway) {
		/* Do not monitor if such was requested */
		if (isset($gateway['monitor_disable']))
			continue;
		if (empty($gateway['monitor']) || !is_ipaddr($gateway['monitor'])) {
			if (is_ipaddr($gateway['gateway']))
				$gateway['monitor'] = $gateway['gateway'];
			else /* No chance to get an ip to monitor skip target. */
				continue;
		}

		/* if the monitor address is already used before, skip */
		if(in_array($gateway['monitor'], $monitor_ips))
			continue;

163 164
		/* Interface ip is needed since apinger will bind a socket to it.
		 * However the config GUI should already have checked this and when
Ad Schellevis's avatar
Ad Schellevis committed
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
		 * PPoE is used the IP address is set to "dynamic". So using is_ipaddrv4
		 * or is_ipaddrv6 to identify packet type would be wrong, especially as
		 * further checks (that can cope with the "dynamic" case) are present inside
		 * the if block. So using $gateway['ipprotocol'] is the better option.
		 */
		if ($gateway['ipprotocol'] == "inet") { // This is an IPv4 gateway...
			$gwifip = find_interface_ip($gateway['interface'], true);
			if (!is_ipaddrv4($gwifip))
				continue; //Skip this target

			/*
			 * If the gateway is the same as the monitor we do not add a
			 * route as this will break the routing table.
			 * Add static routes for each gateway with their monitor IP
			 * not strictly necessary but is a added level of protection.
			 */
			if (is_ipaddrv4($gateway['gateway']) && $gateway['monitor'] != $gateway['gateway']) {
				log_error("Removing static route for monitor {$gateway['monitor']} and adding a new route through {$gateway['gateway']}");
183 184
				mwexec("/sbin/route delete -host " . escapeshellarg($gateway['monitor']), true);
				mwexec("/sbin/route add -host " . escapeshellarg($gateway['monitor']) .
Ad Schellevis's avatar
Ad Schellevis committed
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
					" " . escapeshellarg($gateway['gateway']), true);
			}
		} else if ($gateway['ipprotocol'] == "inet6") { // This is an IPv6 gateway...
			if ($gateway['monitor'] == $gateway['gateway']) {
				/* link locals really need a different src ip */
				if (is_linklocal($gateway['gateway'])) {
					$gwifip = find_interface_ipv6_ll($gateway['interface'], true);
				} else {
					$gwifip = find_interface_ipv6($gateway['interface'], true);
				}
			} else {
				/* 'monitor' has been set, so makes sure it has precedence over
				 * 'gateway' in defining the source IP. Otherwise if 'gateway'
				 * is a local link and 'monitor' is global routable then the
				 * ICMP6 response would not find its way back home...
				 */
				$gwifip = find_interface_ipv6($gateway['interface'], true);
				if (is_linklocal($gateway['monitor'])) {
					if (!strstr($gateway['monitor'], '%')) {
						$gateway['monitor'] .= "%{$gateway['interface']}";
					}
				} else {
					// Monitor is a routable address, so use a routable address for the "src" part
					$gwifip = find_interface_ipv6($gateway['interface'], true);
				}
			}
211

Ad Schellevis's avatar
Ad Schellevis committed
212 213 214 215 216 217 218 219 220 221 222
			if (!is_ipaddrv6($gwifip))
				continue; //Skip this target

			/*
			 * If the gateway is the same as the monitor we do not add a
			 * route as this will break the routing table.
			 * Add static routes for each gateway with their monitor IP
			 * not strictly necessary but is a added level of protection.
			 */
			if (is_ipaddrv6($gateway['gateway']) && $gateway['monitor'] != $gateway['gateway']) {
				log_error("Removing static route for monitor {$gateway['monitor']} and adding a new route through {$gateway['gateway']}");
223 224
				mwexec("/sbin/route delete -host -inet6 " . escapeshellarg($gateway['monitor']), true);
				mwexec("/sbin/route add -host -inet6 " . escapeshellarg($gateway['monitor']) .
Ad Schellevis's avatar
Ad Schellevis committed
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
					" " . escapeshellarg($gateway['gateway']), true);
			}
		} else
			continue;

		$monitor_ips[] = $gateway['monitor'];
		$apingercfg = "target \"{$gateway['monitor']}\" {\n";
		$apingercfg .= "	description \"{$name}\"\n";
		$apingercfg .= "	srcip \"{$gwifip}\"\n";

		## How often the probe should be sent
		if (!empty($gateway['interval']) &&  is_numeric($gateway['interval'])) {
			$interval = intval($gateway['interval']);	# Restrict to Integer
			if ($interval <  1) $interval =  1;	# Minimum
			if ($interval != $apinger_default['interval'])	# If not default value
				$apingercfg .= "	interval " . $interval . "s\n";
		}

243
		## How many replies should be used to compute average delay
Ad Schellevis's avatar
Ad Schellevis committed
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
		## for controlling "delay" alarms
		if (!empty($gateway['avg_delay_samples']) && is_numeric($gateway['avg_delay_samples'])) {
			$avg_delay_samples = intval($gateway['avg_delay_samples']);	# Restrict to Integer
			if ($avg_delay_samples <  1) $avg_delay_samples =  1;	# Minimum
			if ($avg_delay_samples != $apinger_default['avg_delay_samples'])	# If not default value
				$apingercfg .= "	avg_delay_samples " . $avg_delay_samples . "\n";
		}

		## How many probes should be used to compute average loss
		if (!empty($gateway['avg_loss_samples']) && is_numeric($gateway['avg_loss_samples'])) {
			$avg_loss_samples = intval($gateway['avg_loss_samples']);	# Restrict to Integer
			if ($avg_loss_samples < 1) $avg_loss_samples = 1;	# Minimum
			if ($avg_loss_samples != $apinger_default['avg_loss_samples'])	# If not default value
				$apingercfg .= "	avg_loss_samples " . $avg_loss_samples . "\n";
		}

		## The delay (in samples) after which loss is computed
		## without this delays larger than interval would be treated as loss
		if (!empty($gateway['avg_loss_delay_samples']) && is_numeric($gateway['avg_loss_delay_samples'])) {
			$avg_loss_delay_samples = intval($gateway['avg_loss_delay_samples']);	# Restrict to Integer
			if ($avg_loss_delay_samples < 1) $avg_loss_delay_samples = 1;	# Minimum
			if ($avg_loss_delay_samples != $apinger_default['avg_loss_delay_samples'])	# If not default value
				$apingercfg .= "	avg_loss_delay_samples " . $avg_loss_delay_samples . "\n";
		}

		$alarms = "";
		$alarmscfg = "";
		$override = false;
		if (!empty($gateway['losslow'])) {
			$alarmscfg .= "alarm loss \"{$name}loss\" {\n";
			$alarmscfg .= "\tpercent_low {$gateway['losslow']}\n";
			$alarmscfg .= "\tpercent_high {$gateway['losshigh']}\n";
			$alarmscfg .= "}\n";
			$alarms .= "\"{$name}loss\"";
			$override = true;
		} else {
			if ($override == true)
				$alarms .= ",";
			$alarms .= "\"loss\"";
			$override = true;
		}
		if (!empty($gateway['latencylow'])) {
			$alarmscfg .= "alarm delay \"{$name}delay\" {\n";
			$alarmscfg .= "\tdelay_low {$gateway['latencylow']}ms\n";
			$alarmscfg .= "\tdelay_high {$gateway['latencyhigh']}ms\n";
			$alarmscfg .= "}\n";
			if ($override == true)
				$alarms .= ",";
			$alarms .= "\"{$name}delay\"";
			$override = true;
		} else {
			if ($override == true)
				$alarms .= ",";
			$alarms .= "\"delay\"";
			$override = true;
		}
		if (!empty($gateway['down'])) {
			$alarmscfg .= "alarm down \"{$name}down\" {\n";
			$alarmscfg .= "\ttime {$gateway['down']}s\n";
			$alarmscfg .= "}\n";
			if ($override == true)
				$alarms .= ",";
			$alarms .= "\"{$name}down\"";
			$override = true;
		} else {
			if ($override == true)
				$alarms .= ",";
			$alarms .= "\"down\"";
			$override = true;
		}
		if ($override == true)
			$apingercfg .= "\talarms override {$alarms};\n";

		if (isset($gateway['force_down']))
			$apingercfg .= "\tforce_down on\n";

320
		$apingercfg .= "	rrd file \"/var/db/rrd/{$gateway['name']}-quality.rrd\"\n";
Ad Schellevis's avatar
Ad Schellevis committed
321 322 323 324 325 326
		$apingercfg .= "}\n";
		$apingercfg .= "\n";

		$apingerconfig .= $alarmscfg;
		$apingerconfig .= $apingercfg;

327
		# Create gateway quality RRD with settings more suitable for OPNsense graph set,
328
		# since apinger uses default step (300; 5 minutes) and other settings that don't
329
		# match the OPNsense gateway quality graph set.
330
		create_gateway_quality_rrd("/var/db/rrd/{$gateway['name']}-quality.rrd");
Ad Schellevis's avatar
Ad Schellevis committed
331
	}
332
	@file_put_contents('/var/etc/apinger.conf', $apingerconfig);
Ad Schellevis's avatar
Ad Schellevis committed
333 334
	unset($apingerconfig);

335
	/* Restart apinger process */
336 337
	if (isvalidpid('/var/run/apinger.pid')) {
		killbypid('/var/run/apinger.pid', 'HUP');
338
	} else {
Ad Schellevis's avatar
Ad Schellevis committed
339
		/* start a new apinger process */
340
		@unlink('/var/run/apinger.status');
Ad Schellevis's avatar
Ad Schellevis committed
341
		sleep(1);
342
		mwexec_bg('/usr/local/sbin/apinger -c /var/etc/apinger.conf');
Ad Schellevis's avatar
Ad Schellevis committed
343
		sleep(1);
344
		killbypid('/var/run/apinger.pid', 'USR1');
Ad Schellevis's avatar
Ad Schellevis committed
345 346 347 348 349 350
	}

	return 0;
}

/* return the status of the apinger targets as a array */
351 352
function return_gateways_status($byname = false)
{
353
	global $config;
Ad Schellevis's avatar
Ad Schellevis committed
354 355

	$apingerstatus = array();
356

Ad Schellevis's avatar
Ad Schellevis committed
357
	/* Always get the latest status from apinger */
358 359 360
	killbypid('/var/run/apinger.pid', 'USR1');
	if (file_exists('/var/run/apinger.status')) {
		$apingerstatus = file('/var/run/apinger.status');
361
	}
Ad Schellevis's avatar
Ad Schellevis committed
362 363

	$status = array();
364 365 366
	foreach ($apingerstatus as $line) {
		$info = explode('|', $line);
		if ($byname == false) {
Ad Schellevis's avatar
Ad Schellevis committed
367
			$target = $info[0];
368
		} else {
Ad Schellevis's avatar
Ad Schellevis committed
369
			$target = $info[2];
370
		}
Ad Schellevis's avatar
Ad Schellevis committed
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387

		$status[$target] = array();
		$status[$target]['monitorip'] = $info[0];
		$status[$target]['srcip'] = $info[1];
		$status[$target]['name'] = $info[2];
		$status[$target]['lastcheck'] = $info[5] ? date('r', $info[5]) : date('r');
		$status[$target]['delay'] = empty($info[6]) ? "0ms" : round($info[6], 1) ."ms" ;
		$status[$target]['loss'] = empty($info[7]) ? "0.0%" : round($info[7], 1) . "%";
		$status[$target]['status'] = trim($info[8]);
	}

	/* tack on any gateways that have monitoring disabled
	 * or are down, which could cause gateway groups to fail */
	$gateways_arr = return_gateways_array();
	foreach($gateways_arr as $gwitem) {
		if(!isset($gwitem['monitor_disable']))
			continue;
388
		if(!isset($gwitem['monitorip']) || !is_ipaddr($gwitem['monitorip'])) {
Ad Schellevis's avatar
Ad Schellevis committed
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
			$realif = $gwitem['interface'];
			$tgtip = get_interface_gateway($realif);
			if (!is_ipaddr($tgtip))
				$tgtip = "none";
			$srcip = find_interface_ip($realif);
		} else {
			$tgtip = $gwitem['monitorip'];
			$srcip = find_interface_ip($realif);
		}
		if($byname == true)
			$target = $gwitem['name'];
		else
			$target = $tgtip;

		/* failsafe for down interfaces */
		if($target == "none") {
			$target = $gwitem['name'];
			$status[$target]['name'] = $gwitem['name'];
			$status[$target]['lastcheck'] = date('r');
			$status[$target]['delay'] = "0.0ms";
			$status[$target]['loss'] = "100.0%";
			$status[$target]['status'] = "down";
		} else {
			$status[$target]['monitorip'] = $tgtip;
			$status[$target]['srcip'] = $srcip;
			$status[$target]['name'] = $gwitem['name'];
			$status[$target]['lastcheck'] = date('r');
			$status[$target]['delay'] = "0.0ms";
			$status[$target]['loss'] = "0.0%";
			$status[$target]['status'] = "none";
		}
	}
	return($status);
}

/* Return all configured gateways on the system */
Franco Fichtner's avatar
Franco Fichtner committed
425 426 427
function return_gateways_array($disabled = false, $localhost = false, $inactive = false)
{
	global $config;
Ad Schellevis's avatar
Ad Schellevis committed
428 429 430 431 432 433 434 435 436 437 438 439 440

	$gateways_arr = array();

	$found_defaultv4 = 0;
	$found_defaultv6 = 0;

	// Ensure the interface cache is up to date first
	$interfaces = get_interface_arr(true);
	$interfaces_v4 = array();
	$interfaces_v6 = array();

	$i = -1;
	/* Process/add all the configured gateways. */
441
	if (isset($config['gateways']['gateway_item'])) {
Ad Schellevis's avatar
Ad Schellevis committed
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
		foreach ($config['gateways']['gateway_item'] as $gateway) {
			/* Increment it here to do not skip items */
			$i++;

			if (empty($config['interfaces'][$gateway['interface']])) {
				if ($inactive === false)
					continue;
				else
					$gateway['inactive'] = true;
			}
			$wancfg = $config['interfaces'][$gateway['interface']];

			/* skip disabled interfaces */
			if ($disabled === false && (!isset($wancfg['enable']) || isset($gateway['disabled'])))
				continue;

			/* if the gateway is dynamic and we can find the IPv4, Great! */
			if (empty($gateway['gateway']) || $gateway['gateway'] == "dynamic") {
				if ($gateway['ipprotocol'] == "inet") {
					/* we know which interfaces is dynamic, this should be made a function */
					$gateway['gateway'] = get_interface_gateway($gateway['interface']);
					/* no IP address found, set to dynamic */
					if (!is_ipaddrv4($gateway['gateway']))
						$gateway['gateway'] = "dynamic";
					$gateway['dynamic'] = true;
				}

				/* if the gateway is dynamic and we can find the IPv6, Great! */
				else if ($gateway['ipprotocol'] == "inet6") {
					/* we know which interfaces is dynamic, this should be made a function, and for v6 too */
					$gateway['gateway'] = get_interface_gateway_v6($gateway['interface']);
					/* no IPv6 address found, set to dynamic */
					if (!is_ipaddrv6($gateway['gateway']))
						$gateway['gateway'] = "dynamic";
					$gateway['dynamic'] = true;
				}
			} else {
				/* getting this detection right is hard at this point because we still don't
				 * store the address family in the gateway item */
				if (is_ipaddrv4($gateway['gateway']))
					$gateway['ipprotocol'] = "inet";
				else if(is_ipaddrv6($gateway['gateway']))
					$gateway['ipprotocol'] = "inet6";
			}

			if (isset($gateway['monitor_disable']))
				$gateway['monitor_disable'] = true;
			else if (empty($gateway['monitor']))
				$gateway['monitor'] = $gateway['gateway'];

			$gateway['friendlyiface'] = $gateway['interface'];

			/* special treatment for tunnel interfaces */
			if ($gateway['ipprotocol'] == "inet6") {
				$gateway['interface'] = get_real_interface($gateway['interface'], "inet6", false, false);
				$interfaces_v6[$gateway['friendlyiface']] = $gateway['friendlyiface'];
			} else {
				$gateway['interface'] = get_real_interface($gateway['interface'], "all", false, false);
				$interfaces_v4[$gateway['friendlyiface']] = $gateway['friendlyiface'];
			}

			/* entry has a default flag, use it */
			if (isset($gateway['defaultgw'])) {
				if ($gateway['ipprotocol'] == "inet") {
					$gateway['defaultgw'] = true;
					$found_defaultv4 = 1;
				} else if ($gateway['ipprotocol'] == "inet6") {
					$gateway['defaultgw'] = true;
					$found_defaultv6 = 1;
				}
			}
			/* include the gateway index as the attribute */
			$gateway['attribute'] = $i;

			$gateways_arr[$gateway['name']] = $gateway;
		}
	}
	unset($gateway);

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

	/* Process/add dynamic v4 gateways. */
	foreach($iflist as $ifname => $friendly ) {
		if(! interface_has_gateway($ifname))
			continue;

		if (empty($config['interfaces'][$ifname]))
			continue;

		$ifcfg = &$config['interfaces'][$ifname];
		if(!isset($ifcfg['enable']))
			continue;

		if(!empty($ifcfg['ipaddr']) && is_ipaddrv4($ifcfg['ipaddr']))
			continue;

		if (isset($interfaces_v4[$ifname]))
			continue;

		$ctype = "";
		switch($ifcfg['ipaddr']) {
			case "dhcp":
			case "pppoe":
			case "pptp":
			case "ppp":
				$ctype = strtoupper($ifcfg['ipaddr']);
				break;
			default:
				if (substr($ifcfg['if'], 0, 4) ==  "ovpn") {
					// if current iface is an ovpn server endpoint then skip it
					if (substr($ifcfg['if'], 4, 1) == 's')
557
						continue 2;
Ad Schellevis's avatar
Ad Schellevis committed
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593

					$ctype = "VPNv4";
				}
				break;
		}
		$ctype = "_". strtoupper($ctype);

		$gateway = array();
		$gateway['dynamic'] = false;
		$gateway['ipprotocol'] = "inet";
		$gateway['gateway'] = get_interface_gateway($ifname, $gateway['dynamic']);
		$gateway['interface'] = get_real_interface($ifname);
		$gateway['friendlyiface'] = $ifname;
		$gateway['name'] = "{$friendly}{$ctype}";
		$gateway['attribute'] = "system";

		if (($gateway['dynamic'] === "default") && ($found_defaultv4 == 0)) {
			$gateway['defaultgw'] = true;
			$gateway['dynamic'] = true;
			$found_defaultv4 = 1;
		}
		/* Loopback dummy for dynamic interfaces without a IP */
		if (!is_ipaddrv4($gateway['gateway']) && $gateway['dynamic'] == true)
			$gateway['gateway'] = "dynamic";

		/* automatically skip known static and dynamic gateways we have a array entry for */
		foreach($gateways_arr as $gateway_item) {
			if ((($ifname == $gateway_item['friendlyiface'] && $friendly == $gateway_item['name'])&& ($gateway['ipprotocol'] == $gateway_item['ipprotocol'])) ||
				($ifname == $gateway_item['friendlyiface'] && $gateway_item['dynamic'] == true) && ($gateway['ipprotocol'] == $gateway_item['ipprotocol']))
					continue 2;
		}

		if (is_ipaddrv4($gateway['gateway']))
			$gateway['monitor'] = $gateway['gateway'];

		$gateway['descr'] = "Interface {$friendly}{$ctype} Gateway";
594
		$gateway['monitor_disable'] = true;
Ad Schellevis's avatar
Ad Schellevis committed
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
		$gateways_arr[$gateway['name']] = $gateway;
	}
	unset($gateway);

	/* Process/add dynamic v6 gateways. */
	foreach($iflist as $ifname => $friendly ) {
		/* If the user has disabled IPv6, they probably don't want any IPv6 gateways. */
		if (!isset($config['system']['ipv6allow']))
			break;

		if(! interface_has_gatewayv6($ifname))
			continue;

		if (empty($config['interfaces'][$ifname]))
			continue;

		$ifcfg = &$config['interfaces'][$ifname];
		if(!isset($ifcfg['enable']))
			continue;

		if(!empty($ifcfg['ipaddrv6']) && is_ipaddrv6($ifcfg['ipaddrv6']))
			continue;

		if(isset($interfaces_v6[$ifname]))
			continue;

		$ctype = "";
		switch($ifcfg['ipaddrv6']) {
			case "slaac":
			case "dhcp6":
			case "6to4":
			case "6rd":
				$ctype = strtoupper($ifcfg['ipaddrv6']);
				break;
			default:
				$tunnelif = substr($ifcfg['if'], 0, 3);
				if (substr($ifcfg['if'], 0, 4) ==  "ovpn") {
					// if current iface is an ovpn server endpoint then skip it
633 634
					if (substr($ifcfg['if'], 4, 1) == 's')
						continue 2;
Ad Schellevis's avatar
Ad Schellevis committed
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678

					$ctype = "VPNv6";
				} else if ($tunnelif == "gif" || $tunnelif == "gre")
					$ctype = "TUNNELv6";
				break;
		}
		$ctype = "_". strtoupper($ctype);

		$gateway = array();
		$gateway['dynamic'] = false;
		$gateway['ipprotocol'] = "inet6";
		$gateway['gateway'] = get_interface_gateway_v6($ifname, $gateway['dynamic']);
		$gateway['interface'] = get_real_interface($ifname, "inet6");
		switch($ifcfg['ipaddrv6']) {
			case "6rd":
			case "6to4":
				$gateway['dynamic'] = "default";
				break;
		}
		$gateway['friendlyiface'] = $ifname;
		$gateway['name'] = "{$friendly}{$ctype}";
		$gateway['attribute'] = "system";

		if (($gateway['dynamic'] === "default")  && ($found_defaultv6 == 0)) {
			$gateway['defaultgw'] = true;
			$gateway['dynamic'] = true;
			$found_defaultv6 = 1;
		}

		/* Loopback dummy for dynamic interfaces without a IP */
		if (!is_ipaddrv6($gateway['gateway']) && $gateway['dynamic'] == true)
			$gateway['gateway'] = "dynamic";

		/* automatically skip known static and dynamic gateways we have a array entry for */
		foreach($gateways_arr as $gateway_item) {
			if ((($ifname == $gateway_item['friendlyiface'] && $friendly == $gateway_item['name']) && ($gateway['ipprotocol'] == $gateway_item['ipprotocol'])) ||
				($ifname == $gateway_item['friendlyiface'] && $gateway_item['dynamic'] == true) && ($gateway['ipprotocol'] == $gateway_item['ipprotocol']))
					continue 2;
		}

		if (is_ipaddrv6($gateway['gateway']))
			$gateway['monitor'] = $gateway['gateway'];

		$gateway['descr'] = "Interface {$friendly}{$ctype} Gateway";
679
		$gateway['monitor_disable'] = true;
Ad Schellevis's avatar
Ad Schellevis committed
680 681 682 683 684 685 686 687 688 689 690
		$gateways_arr[$gateway['name']] = $gateway;
	}
	unset($gateway);

	/* FIXME: Should this be enabled.
	 * Some interface like wan might be default but have no info recorded
	 * the config. */
	/* this is a fallback if all else fails and we want to get packets out @smos */
	if ($found_defaultv4 == 0 || $found_defaultv6 == 0) {
		foreach ($gateways_arr as &$gateway) {
			if (($gateway['friendlyiface'] == "wan") && ($found_defaultv4 == 0) && (!isset($gateway['ipprotocol']) || ($gateway['ipprotocol'] == "inet"))) {
691
				if (file_exists("/tmp/{$gateway['interface']}_defaultgw")) {
Ad Schellevis's avatar
Ad Schellevis committed
692 693 694 695 696
					$gateway['defaultgw'] = true;
					$found_defaultv4 = 1;
				}
			}
			if (($gateway['friendlyiface'] == "wan") && ($found_defaultv6 == 0) && ($gateway['ipprotocol'] == "inet6")) {
697
				if (file_exists("/tmp/{$gateway['interface']}_defaultgwv6")) {
Ad Schellevis's avatar
Ad Schellevis committed
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
					$gateway['defaultgw'] = true;
					$found_defaultv6 = 1;
				}
			}
		}
	}

	if($localhost === true) {
		/* attach localhost for Null routes */
		$gwlo4 = array();
		$gwlo4['name'] = "Null4";
		$gwlo4['interface'] = "lo0";
		$gwlo4['ipprotocol'] = "inet";
		$gwlo4['gateway'] = "127.0.0.1";
		$gwlo6 = array();
		$gwlo6['name'] = "Null6";
		$gwlo6['interface'] = "lo0";
		$gwlo6['ipprotocol'] = "inet6";
		$gwlo6['gateway'] = "::1";
		$gateways_arr['Null4'] = $gwlo4;
		$gateways_arr['Null6'] = $gwlo6;
	}
	return($gateways_arr);
}

Franco Fichtner's avatar
Franco Fichtner committed
723 724 725
function fixup_default_gateway($ipprotocol, $gateways_status, $gateways_arr)
{
	global $config;
Ad Schellevis's avatar
Ad Schellevis committed
726 727
	/*
	 * NOTE: The code below is meant to replace the default gateway when it goes down.
728
	 *	This facilitates services running on OPNsense itself and are not handled by a PBR to continue working.
Ad Schellevis's avatar
Ad Schellevis committed
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
	 */
	$upgw = "";
	$dfltgwdown = false;
	$dfltgwfound = false;
	foreach ($gateways_arr as $gwname => $gwsttng) {
		if (($gwsttng['ipprotocol'] == $ipprotocol) && isset($gwsttng['defaultgw'])) {
			$dfltgwfound = true;
			$dfltgwname = $gwname;
			if (!isset($gwsttng['monitor_disable']) && stristr($gateways_status[$gwname]['status'], "down"))
				$dfltgwdown = true;
		}
		/* Keep a record of the last up gateway */
		/* XXX: Blacklist lan for now since it might cause issues to those who have a gateway set for it */
		if (empty($upgw) && ($gwsttng['ipprotocol'] == $ipprotocol) && (isset($gwsttng['monitor_disable']) || !stristr($gateways_status[$gwname]['status'], "down")) && $gwsttng[$gwname]['friendlyiface'] != "lan")
			$upgw = $gwname;
		if ($dfltgwdown == true && !empty($upgw))
			break;
	}
	if ($dfltgwfound == false) {
		$gwname = convert_friendly_interface_to_friendly_descr("wan");
		if (!empty($gateways_status[$gwname]) && stristr($gateways_status[$gwname]['status'], "down"))
			$dfltgwdown = true;
	}
	if ($dfltgwdown == true && !empty($upgw)) {
		if ($gateways_arr[$upgw]['gateway'] == "dynamic")
			$gateways_arr[$upgw]['gateway'] = get_interface_gateway($gateways_arr[$upgw]['friendlyiface']);
		if (is_ipaddr($gateways_arr[$upgw]['gateway'])) {
			log_error("Default gateway down setting {$upgw} as default!");
			if(is_ipaddrv6($gateways_arr[$upgw]['gateway'])) {
				$inetfamily = "-inet6";
			} else {
				$inetfamily = "-inet";
			}
762 763
			mwexec("/sbin/route delete {$inetfamily} default {$gateways_arr[$upgw]['gateway']}");
			mwexec("/sbin/route add {$inetfamily} default {$gateways_arr[$upgw]['gateway']}");
Ad Schellevis's avatar
Ad Schellevis committed
764 765 766 767 768 769 770 771
		}
	} else {
		$defaultgw = trim(exec("/sbin/route -n get -{$ipprotocol} default | /usr/bin/awk '/gateway:/ {print $2}'"), " \n");
		if(is_ipaddrv6($gateways_arr[$dfltgwname]['gateway'])) {
			$inetfamily = "-inet6";
		} else {
			$inetfamily = "-inet";
		}
772
		if ($defaultgw != $gateways_arr[$dfltgwname]['gateway']) {
773 774
			mwexec("/sbin/route delete {$inetfamily} default {$gateways_arr[$dfltgwname]['gateway']}");
			mwexec("/sbin/route add {$inetfamily} default {$gateways_arr[$dfltgwname]['gateway']}");
775
		}
Ad Schellevis's avatar
Ad Schellevis committed
776 777 778 779 780 781 782
	}
}

/*
 * Return an array with all gateway groups with name as key
 * All gateway groups will be processed before returning the array.
 */
Franco Fichtner's avatar
Franco Fichtner committed
783 784 785
function return_gateway_groups_array()
{
	global $config;
Ad Schellevis's avatar
Ad Schellevis committed
786 787 788 789 790 791 792 793 794 795

	/* fetch the current gateways status */
	$gateways_status = return_gateways_status(true);
	$gateways_arr = return_gateways_array();
	$gateway_groups_array = array();

	if (isset($config['system']['gw_switch_default'])) {
		fixup_default_gateway("inet", $gateways_status, $gateways_arr);
		fixup_default_gateway("inet6", $gateways_status, $gateways_arr);
	}
796
	if (isset($config['gateways']['gateway_group'])) {
Ad Schellevis's avatar
Ad Schellevis committed
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
		$carplist = get_configured_carp_interface_list();
		foreach ($config['gateways']['gateway_group'] as $group) {
			/* create array with group gateways members separated by tier */
			$tiers = array();
			$backupplan = array();
			$gwvip_arr = array();
			foreach ($group['item'] as $item) {
				list($gwname, $tier, $vipname) = explode("|", $item);

				if (is_ipaddr($carplist[$vipname])) {
					if (!is_array($gwvip_arr[$group['name']]))
						$gwvip_arr[$group['name']] = array();
					$gwvip_arr[$group['name']][$gwname] = $vipname;
				}

				/* Do it here rather than reiterating again the group in case no member is up. */
				if (!is_array($backupplan[$tier]))
					$backupplan[$tier] = array();
				$backupplan[$tier][] = $gwname;

				/* check if the gateway is available before adding it to the array */
				if (is_array($gateways_status[$gwname])) {
					$status = $gateways_status[$gwname];
					$gwdown = false;
821
					if (stristr($status['status'], 'down')) {
822
						$msg = sprintf(gettext('MONITOR: %s is down, removing from routing group %s'), $gwname, $group['name']);
Ad Schellevis's avatar
Ad Schellevis committed
823
						$gwdown = true;
824
					} elseif (stristr($status['status'], 'loss') && strstr($group['trigger'], 'loss')) {
Ad Schellevis's avatar
Ad Schellevis committed
825
						/* packet loss */
826
						$msg = sprintf(gettext('MONITOR: %s has packet loss, removing from routing group %s'), $gwname, $group['name']);
Ad Schellevis's avatar
Ad Schellevis committed
827
						$gwdown = true;
828
					} elseif (stristr($status['status'], 'delay') && strstr($group['trigger'] , 'latency')) {
Ad Schellevis's avatar
Ad Schellevis committed
829
						/* high latency */
830
						$msg = sprintf(gettext('MONITOR: %s has high latency, removing from routing group %s'), $gwname, $group['name']);
Ad Schellevis's avatar
Ad Schellevis committed
831 832 833 834 835 836 837 838 839 840 841 842
						$gwdown = true;
					}
					if ($gwdown == true) {
						log_error($msg);
						notify_via_growl($msg);
						notify_via_smtp($msg);
					} else {
						/* Online add member */
						if (!is_array($tiers[$tier]))
							$tiers[$tier] = array();
						$tiers[$tier][] = $gwname;
					}
843
				} elseif (isset($gateways_arr[$gwname]['monitor_disable'])) {
Ad Schellevis's avatar
Ad Schellevis committed
844
					$tiers[$tier][] = $gwname;
845
				}
Ad Schellevis's avatar
Ad Schellevis committed
846 847 848 849
			}
			$tiers_count = count($tiers);
			if ($tiers_count == 0) {
				/* Oh dear, we have no members! Engage Plan B */
850
				if (!file_exists('/var/run/booting')) {
851
					$msg = sprintf(gettext('Gateways status could not be determined, considering all as up/active. (Group: %s)'), $group['name']);
Ad Schellevis's avatar
Ad Schellevis committed
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
					log_error($msg);
					notify_via_growl($msg);
					//notify_via_smtp($msg);
				}
				$tiers = $backupplan;
			}
			/* sort the tiers array by the tier key */
			ksort($tiers);

			/* we do not really foreach the tiers as we stop after the first tier */
			foreach ($tiers as $tieridx => $tier) {
				/* process all gateways in this tier */
				foreach ($tier as $member) {
					/* determine interface gateway */
					if (isset($gateways_arr[$member])) {
						$gateway = $gateways_arr[$member];
						$int = $gateway['interface'];
						$gatewayip = "";
						if(is_ipaddr($gateway['gateway']))
							$gatewayip = $gateway['gateway'];
						else if (!empty($int))
							$gatewayip = get_interface_gateway($gateway['friendlyiface']);

						if (!empty($int)) {
							$gateway_groups_array[$group['name']]['ipprotocol'] = $gateway['ipprotocol'];
							if (is_ipaddr($gatewayip)) {
								$groupmember = array();
								$groupmember['int']  = $int;
								$groupmember['gwip']  = $gatewayip;
								$groupmember['weight']  = isset($gateway['weight']) ? $gateway['weight'] : 1;
								if (is_array($gwvip_arr[$group['name']])&& !empty($gwvip_arr[$group['name']][$member]))
									$groupmember['vip'] = $gwvip_arr[$group['name']][$member];
								$gateway_groups_array[$group['name']][] = $groupmember;
							}
						}
					}
				}
				/* we should have the 1st available tier now, exit stage left */
				if (count($gateway_groups_array[$group['name']]) > 0)
					break;
				else
					log_error("GATEWAYS: Group {$group['name']} did not have any gateways up on tier {$tieridx}!");
			}
		}
	}

	return ($gateway_groups_array);
}

function lookup_gateway_ip_by_name($name) {

	$gateways_arr = return_gateways_array(false, true);
	foreach ($gateways_arr as $gname => $gw) {
		if ($gw['name'] === $name || $gname === $name)
			return $gw['gateway'];
	}

	return false;
}

function lookup_gateway_interface_by_name($name) {

	$gateways_arr = return_gateways_array(false, true);
	if (!empty($gateways_arr[$name])) {
		$interfacegw = $gateways_arr[$name]['friendlyiface'];
		return ($interfacegw);
	}

	return (false);
}

Franco Fichtner's avatar
Franco Fichtner committed
923 924 925
function get_interface_gateway($interface, &$dynamic = false)
{
	global $config;
Ad Schellevis's avatar
Ad Schellevis committed
926 927 928

	$gw = NULL;

929 930
	if (isset($config['interfaces'][$interface])) {
		$gwcfg = $config['interfaces'][$interface];
931
		if (!empty($gwcfg['gateway']) && isset($config['gateways']['gateway_item'])) {
932 933 934 935 936
			foreach($config['gateways']['gateway_item'] as $gateway) {
				if(($gateway['name'] == $gwcfg['gateway']) && (is_ipaddrv4($gateway['gateway']))) {
					$gw = $gateway['gateway'];
					break;
				}
Ad Schellevis's avatar
Ad Schellevis committed
937 938 939
			}
		}

940 941 942 943
		// for dynamic interfaces we handle them through the $interface_router file.
		if (!is_ipaddrv4($gw) && !is_ipaddrv4($gwcfg['ipaddr'])) {
			$realif = get_real_interface($interface);
			if (file_exists("/tmp/{$realif}_router")) {
944
				$gw = trim(file_get_contents("/tmp/{$realif}_router"), " \n");
945 946 947 948 949
				$dynamic = true;
			}
			if (file_exists("/tmp/{$realif}_defaultgw")) {
				$dynamic = "default";
			}
Ad Schellevis's avatar
Ad Schellevis committed
950 951 952 953 954 955 956
		}
	}

	/* return gateway */
	return ($gw);
}

Franco Fichtner's avatar
Franco Fichtner committed
957 958 959
function get_interface_gateway_v6($interface, &$dynamic = false)
{
	global $config;
Ad Schellevis's avatar
Ad Schellevis committed
960 961 962 963 964 965 966 967 968 969 970 971 972

	$gw = NULL;
	$gwcfg = $config['interfaces'][$interface];
	if (!empty($gwcfg['gatewayv6']) && is_array($config['gateways']['gateway_item'])) {
		foreach($config['gateways']['gateway_item'] as $gateway) {
			if(($gateway['name'] == $gwcfg['gatewayv6']) && (is_ipaddrv6($gateway['gateway']))) {
				$gw = $gateway['gateway'];
				break;
			}
		}
	}

	// for dynamic interfaces we handle them through the $interface_router file.
973
	if (!is_ipaddrv6($gw) && ( !isset($gwcfg['ipaddrv6']) || !is_ipaddrv6($gwcfg['ipaddrv6']))) {
Ad Schellevis's avatar
Ad Schellevis committed
974
			$realif = get_real_interface($interface);
975 976
			if (file_exists("/tmp/{$realif}_routerv6")) {
				$gw = trim(file_get_contents("/tmp/{$realif}_routerv6"), " \n");
Ad Schellevis's avatar
Ad Schellevis committed
977 978
				$dynamic = true;
			}
979
			if (file_exists("/tmp/{$realif}_defaultgwv6"))
Ad Schellevis's avatar
Ad Schellevis committed
980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
				$dynamic = "default";

	}
	/* return gateway */
	return ($gw);
}

/* Check a IP address against a gateway IP or name
 * to verify it's address family */
function validate_address_family($ipaddr, $gwname) {
	$v4ip = false;
	$v6ip = false;
	$v4gw = false;
	$v6gw = false;

	if(is_ipaddrv4($ipaddr))
		$v4ip = true;
	if(is_ipaddrv6($ipaddr))
		$v6ip = true;
	if(is_ipaddrv4($gwname))
		$v4gw = true;
	if(is_ipaddrv6($gwname))
		$v6gw = true;

	if($v4ip && $v4gw)
		return true;
	if($v6ip && $v6gw)
		return true;

	/* still no match, carry on, lookup gateways */
	if(is_ipaddrv4(lookup_gateway_ip_by_name($gwname)))
		$v4gw = true;
	if(is_ipaddrv6(lookup_gateway_ip_by_name($gwname)))
		$v6gw = true;

	$gw_array = return_gateways_array();
	if(is_array($gw_array[$gwname])) {
		switch($gw_array[$gwname]['ipprotocol']) {
			case "inet":
				$v4gw = true;
				break;
			case "inet6":
				$v6gw = true;
				break;
		}
	}

	if($v4ip && $v4gw)
		return true;
	if($v6ip && $v6gw)
		return true;

	return false;
}

1035

Ad Schellevis's avatar
Ad Schellevis committed
1036
?>