pfSense

<?php

/*

 * interfaces_assign.php

 *

 * part of pfSense (https://www.pfsense.org)

 * Copyright (c) 2004-2013 BSD Perimeter

 * Copyright (c) 2013-2016 Electric Sheep Fencing

 * Copyright (c) 2014-2024 Rubicon Communications, LLC (Netgate)

 * All rights reserved.

 *

 * originally based on m0n0wall (http://m0n0.ch/wall)

 * Copyright (c) 2003-2004 Manuel Kasper <mk@neon1.net>.

 * Written by Jim McBeath based on existing m0n0wall files

 * All rights reserved.

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 * http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

##|+PRIV

##|*IDENT=page-interfaces-assignnetworkports

##|*NAME=Interfaces: Interface Assignments

##|*DESCR=Allow access to the 'Interfaces: Interface Assignments' page.

##|*MATCH=interfaces_assign.php*

##|-PRIV

//$timealla = microtime(true);

$pgtitle = array(gettext("Interfaces"), gettext("Interface Assignments"));

$shortcut_section = "interfaces";

require_once("guiconfig.inc");

require_once("functions.inc");

require_once("filter.inc");

require_once("shaper.inc");

require_once("ipsec.inc");

require_once("vpn.inc");

require_once("openvpn.inc");

require_once("captiveportal.inc");

require_once("rrd.inc");

require_once("interfaces_fast.inc");

global $friendlyifnames;

/*moved most gettext calls to here, we really don't want to be repeatedly calling gettext() within loops if it can be avoided.*/

$gettextArray = array('add'=>gettext('Add'),'addif'=>gettext('Add interface'),'delete'=>gettext('Delete'),'deleteif'=>gettext('Delete interface'),'edit'=>gettext('Edit'),'on'=>gettext('on'));

/*

	In this file, "port" refers to the physical port name,

	while "interface" refers to LAN, WAN, or OPTn.

*/

/* get list without VLAN interfaces */

$portlist = get_interface_list();

/*another *_fast function from interfaces_fast.inc. These functions are basically the same as the

ones they're named after, except they (usually) take an array and (always) return an array. This means that they only

need to be called once per script run, the returned array contains all the data necessary for repeated use */

$friendlyifnames = convert_real_interface_to_friendly_interface_name_fast();

/* add wireless clone interfaces */

foreach (config_get_path('wireless/clone', []) as $clone) {

	$portlist[$clone['cloneif']] = $clone;

	$portlist[$clone['cloneif']]['iswlclone'] = true;

}

/* add VLAN interfaces */

//$timea = microtime(true);

foreach (config_get_path('vlans/vlan', []) as $vlan) {

	$portlist[$vlan['vlanif']] = $vlan;

	$portlist[$vlan['vlanif']]['isvlan'] = true;

}

/* add Bridge interfaces */

foreach (config_get_path('bridges/bridged', []) as $bridge) {

	$portlist[$bridge['bridgeif']] = $bridge;

	$portlist[$bridge['bridgeif']]['isbridge'] = true;

}

/* add GIF interfaces */

foreach (config_get_path('gifs/gif', []) as $gif) {

	$portlist[$gif['gifif']] = $gif;

	$portlist[$gif['gifif']]['isgif'] = true;

}

/* add GRE interfaces */

foreach (config_get_path('gres/gre', []) as $gre) {

	$portlist[$gre['greif']] = $gre;

	$portlist[$gre['greif']]['isgre'] = true;

}

/* add LAGG interfaces */

foreach (config_get_path('laggs/lagg', []) as $lagg) {

	$portlist[$lagg['laggif']] = $lagg;

	$portlist[$lagg['laggif']]['islagg'] = true;

	/* LAGG members cannot be assigned */

	$lagifs = explode(',', $lagg['members']);

	foreach ($lagifs as $lagif) {

		if (isset($portlist[$lagif])) {

			unset($portlist[$lagif]);

		}

	}

}

/* add QinQ interfaces */

foreach (config_get_path('qinqs/qinqentry', []) as $qinq) {

	$portlist["{$qinq['vlanif']}"]['descr'] = "VLAN {$qinq['tag']} on {$qinq['if']}";

	$portlist["{$qinq['vlanif']}"]['isqinq'] = true;

	/* QinQ members */

	$qinqifs = explode(' ', $qinq['members']);

	foreach ($qinqifs as $qinqif) {

		$portlist["{$qinq['vlanif']}.{$qinqif}"]['descr'] = "QinQ {$qinqif} on VLAN {$qinq['tag']} on {$qinq['if']}";

		$portlist["{$qinq['vlanif']}.{$qinqif}"]['isqinq'] = true;

	}

}

/* add PPP interfaces */

foreach (config_get_path('ppps/ppp', []) as $ppp) {

	$portname = $ppp['if'];

	$portlist[$portname] = $ppp;

	$portlist[$portname]['isppp'] = true;

	$ports_base = basename($ppp['ports']);

	if (isset($ppp['descr'])) {

		$portlist[$portname]['descr'] = strtoupper($ppp['if']). "({$ports_base}) - {$ppp['descr']}";

	} else if (isset($ppp['username'])) {

		$portlist[$portname]['descr'] = strtoupper($ppp['if']). "({$ports_base}) - {$ppp['username']}";

	} else {

		$portlist[$portname]['descr'] = strtoupper($ppp['if']). "({$ports_base})";

	}

}

$ovpn_descrs = array();

foreach (['server', 'client'] as $openvpn_mode) {

	foreach (config_get_path("openvpn/openvpn-{$openvpn_mode}", []) as $openvpn_settings) {

		$portname = openvpn_name($openvpn_mode, $openvpn_settings);

		$portlist[$portname] = $openvpn_settings;

		$ovpn_descrs[$openvpn_settings['vpnid']] = $openvpn_settings['description'];

	}

}

global $ipsec_descrs;

$ipsec_descrs = interface_ipsec_vti_list_all();

foreach ($ipsec_descrs as $ifname => $ifdescr) {

	$portlist[$ifname] = array('descr' => $ifdescr);

}

$ifdescrs = interface_assign_description_fast($portlist,$friendlyifnames);

if (isset($_REQUEST['add']) && isset($_REQUEST['if_add'])) {

	/* Be sure this port is not being used */

	$portused = false;

	foreach (config_get_path('interfaces', []) as $ifdata) {

		if ($ifdata['if'] == $_REQUEST['if_add']) {

			$portused = true;

			break;

		}

	}

	if ($portused === false) {

		/* find next free optional interface number */

		if (!config_get_path('interfaces/lan')) {

			$newifname = "lan";

			$descr = "LAN";

		} else {

			$interface_count = count(config_get_path('interfaces', []));

			for ($i = 1; $i <= $interface_count; $i++) {

				if (!config_get_path("interfaces/opt{$i}")) {

					break;

				}

			}

			$newifname = 'opt' . $i;

			$descr = "OPT" . $i;

		}

		config_set_path("interfaces/{$newifname}", [

			'descr' => $descr,

			'if' => $_POST['if_add']

		]);

		if (preg_match(g_get('wireless_regex'), $_POST['if_add'])) {

			config_set_path("interfaces/{$newifname}/wireless", []);

			$new_if_config = config_get_path("interfaces/{$newifname}");

			interface_sync_wireless_clones($new_if_config, false);

			config_set_path("interfaces/{$newifname}", $new_if_config);

		}

		$if_config = config_get_path('interfaces', []);

		uksort($if_config, "compare_interface_friendly_names");

		config_set_path('interfaces', $if_config);

		write_config("New interface assigned");

		filter_configure();

		$action_msg = gettext("Interface has been added.");

		$class = "success";

	}

} else if (isset($_POST['apply'])) {

	if (file_exists("/var/run/interface_mismatch_reboot_needed")) {

		system_reboot();

		$rebootingnow = true;

	} else {

		write_config("Interfaces assignment settings changed");

		$changes_applied = true;

		$retval = 0;

		$retval |= filter_configure();

	}

} else if (isset($_POST['Submit'])) {

	unset($input_errors);

	/* input validation */

	/* Build a list of the port names so we can see how the interfaces map */

	$portifmap = array();

	foreach ($portlist as $portname => $portinfo) {

		$portifmap[$portname] = array();

	}

	/* Go through the list of ports selected by the user,

	build a list of port-to-interface mappings in portifmap */

	foreach ($_POST as $ifname => $ifport) {

		if (($ifname == 'lan') || ($ifname == 'wan') || (substr($ifname, 0, 3) == 'opt')) {

			if (array_key_exists($ifport, $portlist)) {

				$portifmap[$ifport][] = strtoupper($ifname);

			} else {

				$input_errors[] = sprintf(gettext('Cannot set port %1$s because the submitted interface does not exist.'), $ifname);

			}

		}

	}

	/* Deliver error message for any port with more than one assignment */

	foreach ($portifmap as $portname => $ifnames) {

		if (count($ifnames) > 1) {

			$errstr = sprintf(gettext('Port %1$s '.

				' was assigned to %2$s' .

				' interfaces:'), $portname, count($ifnames));

			foreach ($portifmap[$portname] as $ifn) {

				$errstr .= " " . convert_friendly_interface_to_friendly_descr(strtolower($ifn)) . " (" . $ifn . ")";

			}

			$input_errors[] = $errstr;

		} else if (count($ifnames) == 1 && preg_match('/^bridge[0-9]/', $portname)) {

			foreach (config_get_path('bridges/bridged', []) as $bridge) {

				if ($bridge['bridgeif'] != $portname) {

					continue;

				}

				$members = explode(",", strtoupper($bridge['members']));

				foreach ($members as $member) {

					if ($member == $ifnames[0]) {

						$input_errors[] = sprintf(gettext('Cannot set port %1$s to interface %2$s because this interface is a member of %3$s.'), $portname, $member, $portname);

						break;

					}

				}

			}

		}

	}

	foreach (config_get_path('vlans/vlan', []) as $vlan) {

		if (does_interface_exist($vlan['if']) == false) {

			$input_errors[] = sprintf(gettext('Vlan parent interface %1$s does not exist anymore so vlan id %2$s cannot be created please fix the issue before continuing.'), $vlan['if'], $vlan['tag']);

		}

	}

	if (!$input_errors) {

		/* No errors detected, so update the config */

		$filter_reload = false;

		foreach ($_POST as $ifname => $ifport) {

			if (($ifname == 'lan') || ($ifname == 'wan') || (substr($ifname, 0, 3) == 'opt')) {

				if (!is_array($ifport)) {

					$reloadif = false;

					if (!empty(config_get_path("interfaces/{$ifname}/if")) && config_get_path("interfaces/{$ifname}/if") <> $ifport) {

						interface_bring_down($ifname);

						/* Mark this to be reconfigured in any case. */

						$reloadif = true;

						$filter_reload = true;

						$gateway_monitor_reload = true;

					}

					$this_if_config = config_get_path("interfaces/{$ifname}");

					$this_if_config['if'] = $ifport;

					if (isset($portlist[$ifport]['isppp'])) {

						$this_if_config['ipaddr'] = $portlist[$ifport]['type'];

					}

					if ((substr($ifport, 0, 3) == 'gre') ||

					    (substr($ifport, 0, 5) == 'gif')) {

						unset($this_if_config['ipaddr']);

						unset($this_if_config['subnet']);

						unset($this_if_config['ipaddrv6']);

						unset($this_if_config['subnetv6']);

					}

					/* check for wireless interfaces, set or clear ['wireless'] */

					if (preg_match(g_get('wireless_regex'), $ifport)) {

						if (!is_array($this_if_config['wireless'])) {

							$this_if_config['wireless'] = array();

						}

					} else {

						unset($this_if_config['wireless']);

					}

					/* make sure there is a descr for all interfaces */

					if (!isset($this_if_config['descr'])) {

						$this_if_config['descr'] = strtoupper($ifname);

					}

					config_set_path("interfaces/{$ifname}", $this_if_config);

					if ($reloadif == true) {

						if (preg_match(g_get('wireless_regex'), $ifport)) {

							interface_sync_wireless_clones($this_if_config, false);

							config_set_path("interfaces/{$ifname}", $this_if_config);

						}

						/* Reload all for the interface. */

						interface_configure($ifname, true);

						$filter_reload = true;

					}

				}

			}

		}

		/* regenerated ruleset after re-assigning the interface,

		 * see https://redmine.pfsense.org/issues/12949 */

		if ($filter_reload) {

			filter_configure();

		}

		if ($gateway_monitor_reload) {

			setup_gateways_monitor();

		}

		write_config("Interfaces assignment settings changed");

		enable_rrd_graphing();

	}

} else {

	unset($delbtn);

	if (!empty($_POST['del']) && is_string(key($_POST['del']))) {

		$delbtn = key($_POST['del']);

	}

	if (isset($delbtn)) {

		$id = $delbtn;

		if (link_interface_to_group($id)) {

			$input_errors[] = gettext("The interface is part of a group. Please remove it from the group to continue");

		} else if (link_interface_to_bridge($id)) {

			$input_errors[] = gettext("The interface is part of a bridge. Please remove it from the bridge to continue");

		} else if (!empty(link_interface_to_tunnelif($id, 'gre'))) {

			$input_errors[] = gettext("The interface is part of a gre tunnel. Please delete the tunnel to continue");

		} else if (!empty(link_interface_to_tunnelif($id, 'gif'))) {

			$input_errors[] = gettext("The interface is part of a gif tunnel. Please delete the tunnel to continue");

		} else if (interface_has_queue($id)) {

			$input_errors[] = gettext("The interface has a traffic shaper queue configured.\nPlease remove all queues on the interface to continue.");

		} else {

			config_del_path("interfaces/{$id}/enable");

			$realid = get_real_interface($id);

			interface_bring_down($id);

			config_del_path("interfaces/{$id}");	/* delete the specified OPTn or LAN*/

			if (is_array(config_get_path("dhcpd/{$id}"))) {

				config_del_path("dhcpd/{$id}");

				services_dhcpd_configure('inet');

			}

			if (is_array(config_get_path("dhcpdv6/{$id}"))) {

				config_del_path("dhcpdv6/{$id}");

				services_dhcpd_configure('inet6');

			}

			foreach (config_get_path('filter/rule', []) as $x => $rule) {

				if ($rule['interface'] == $id) {

					config_del_path("filter/rule/{$x}");

				}

			}

			foreach (config_get_path('nat/rule', []) as $x => $rule) {

				if ($rule['interface'] == $id) {

					config_del_path("nat/rule/{$x}/interface");

				}

			}

			write_config(gettext('Interface assignment deleted'));

			/* If we are in firewall/routing mode (not single interface)

			 * then ensure that we are not running DHCP on the wan which

			 * will make a lot of ISPs unhappy.

			 */

			if (config_path_enabled('interfaces', 'lan')

				&& config_path_enabled('dhcpd', 'wan')) {

					config_del_path('dhcpd/wan');

			}

			link_interface_to_vlans($realid, "update");

			filter_configure();

			$action_msg = gettext("Interface has been deleted.");

			$class = "success";

		}

	}

}

/* Create a list of unused ports */

$unused_portlist = array();

$portArray = array_keys($portlist);

$ifaceArray = array_column(config_get_path('interfaces', []),'if');

$unused = array_diff($portArray,$ifaceArray);

$unused = array_flip($unused);

$unused_portlist = array_intersect_key($portlist,$unused);//*/

unset($unused,$portArray,$ifaceArray);

include("head.inc");

if (file_exists("/var/run/interface_mismatch_reboot_needed")) {

	if ($_POST) {

		if ($rebootingnow) {

			$action_msg = gettext("The system is now rebooting. Please wait.");

			$class = "success";

		} else {

			$applymsg = gettext("Reboot is needed. Please apply the settings in order to reboot.");

			$class = "warning";

		}

	} else {

		$action_msg = gettext("Interface mismatch detected. Please resolve the mismatch, save and then click 'Apply Changes'. The firewall will reboot afterwards.");

		$class = "warning";

	}

}

if (file_exists("/tmp/reload_interfaces")) {

	echo "<p>\n";

	print_apply_box(gettext("The interface configuration has been changed.") . "<br />" . gettext("The changes must be applied for them to take effect."));

	echo "<br /></p>\n";

} elseif ($applymsg) {

	print_apply_box($applymsg);

} elseif ($action_msg) {

	print_info_box($action_msg, $class);

} elseif ($changes_applied) {

	print_apply_result_box($retval);

}

pfSense_handle_custom_code("/usr/local/pkg/interfaces_assign/pre_input_errors");

if ($input_errors) {

	print_input_errors($input_errors);

}

$tab_array = array();

$tab_array[] = array(gettext("Interface Assignments"), true, "interfaces_assign.php");

$tab_array[] = array(gettext("Interface Groups"), false, "interfaces_groups.php");

$tab_array[] = array(gettext("Wireless"), false, "interfaces_wireless.php");

$tab_array[] = array(gettext("VLANs"), false, "interfaces_vlan.php");

$tab_array[] = array(gettext("QinQs"), false, "interfaces_qinq.php");

$tab_array[] = array(gettext("PPPs"), false, "interfaces_ppps.php");

$tab_array[] = array(gettext("GREs"), false, "interfaces_gre.php");

$tab_array[] = array(gettext("GIFs"), false, "interfaces_gif.php");

$tab_array[] = array(gettext("Bridges"), false, "interfaces_bridge.php");

$tab_array[] = array(gettext("LAGGs"), false, "interfaces_lagg.php");

display_top_tabs($tab_array);

/*Generate the port select box only once.

Not indenting the HTML to produce smaller code

and faster page load times */

$portselect='';

foreach ($portlist as $portname => $portinfo) {

	$portselect.='<option value="'.$portname.'"';

	$portselect.=">".$ifdescrs[$portname]."</option>\n";

}

?>

<form action="interfaces_assign.php" method="post">

	<div class="table-responsive">

	<table class="table table-striped table-hover">

	<thead>

		<tr>

			<th><?=gettext("Interface")?></th>

			<th><?=gettext("Network port")?></th>

			<th>&nbsp;</th>

		</tr>

	</thead>

	<tbody>

<?php

	$i=0;

	foreach (config_get_path('interfaces', []) as $ifname => $iface):

		if ($iface['descr']) {

			$ifdescr = $iface['descr'];

		} else {

			$ifdescr = strtoupper($ifname);

		}

?>

		<tr>

			<td><a href="/interfaces.php?if=<?=$ifname?>"><?=$ifdescr?></a></td>

			<td>

				<select name="<?=$ifname?>" id="<?=$ifname?>" class="form-control">

<?php

/*port select menu generation loop replaced with pre-prepared select menu to reduce page generation time */

echo str_replace('value="'.$iface['if'].'">','value="'.$iface['if'].'" selected>',$portselect);

?>

				</select>

			</td>

			<td>

<?php if ($ifname != 'wan'):?>

				<button type="submit" name="del[<?=$ifname?>]" class="btn btn-danger btn-sm" title="<?=$gettextArray['deleteif']?>">

					<i class="fa-solid fa-trash-can icon-embed-btn"></i>

					<?=$gettextArray["delete"]?>

				</button>

<?php endif;?>

			</td>

		</tr>

<?php $i++;

endforeach;

	if (count(config_get_path('interfaces', [])) < count($portlist)):

?>

		<tr>

			<th>

				<?=gettext("Available network ports:")?>

			</th>

			<td>

				<select name="if_add" id="if_add" class="form-control">

<?php

/* HTML not indented to save on transmission/render time */

foreach ($unused_portlist as $portname => $portinfo):?>

<option value="<?=$portname?>" <?=($portname == $iface['if']) ? ' selected': ''?>><?=$ifdescrs[$portname]?></option>

<?php endforeach;

?>

				</select>

			</td>

			<td>

				<button type="submit" name="add" title="<?=gettext("Add selected interface")?>" value="add interface" class="btn btn-success btn-sm" >

					<i class="fa-solid fa-plus icon-embed-btn"></i>

					<?=$gettextArray["add"]?>

				</button>

			</td>

		</tr>

<?php endif;?>

		</tbody>

	</table>

	</div>

	<button name="Submit" type="submit" class="btn btn-primary" value="<?=gettext('Save')?>"><i class="fa-solid fa-save icon-embed-btn"></i><?=gettext('Save')?></button>

</form>

<br />

<?php

print_info_box(gettext("Interfaces that are configured as members of a lagg(4) interface will not be shown.") .

    '<br/><br/>' .

    gettext("Wireless interfaces must be created on the Wireless tab before they can be assigned."), 'info', false);

?>

<?php include("foot.inc")?>