pfSense

<?php

/*

 * firewall_nat.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 <[email protected]>.

 * 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-firewall-nat-portforward

##|*NAME=Firewall: NAT: Port Forward

##|*DESCR=Allow access to the 'Firewall: NAT: Port Forward' page.

##|*MATCH=firewall_nat.php*

##|-PRIV

require_once("guiconfig.inc");

require_once("util.inc");

require_once("functions.inc");

require_once("filter.inc");

require_once("shaper.inc");

require_once("itemid.inc");

require_once("firewall_nat.inc");

config_init_path('nat/rule');

$rdr_lcltype_flags = [SPECIALNET_IFADDR];

$rdr_srctype_flags = [SPECIALNET_ANY, SPECIALNET_CLIENTS, SPECIALNET_IFADDR, SPECIALNET_IFNET];

$rdr_dsttype_flags = [SPECIALNET_ANY, SPECIALNET_SELF, SPECIALNET_CLIENTS, SPECIALNET_IFADDR, SPECIALNET_IFNET, SPECIALNET_VIPS];

// Process $_POST/$_REQUEST =======================================================================

if ($_REQUEST['savemsg']) {

	$savemsg = $_REQUEST['savemsg'];

}

if (array_key_exists('order-store', $_REQUEST) && have_natpfruleint_access($natent['interface'])) {

	reorderNATrules($_POST);

} else if ($_POST['apply'] && have_natpfruleint_access($natent['interface'])) {

	$retval = applyNATrules();

} else if (($_POST['act'] == "del" || isset($_POST['del_x'])) && have_natpfruleint_access($natent['interface'])) {

	if (config_get_path("nat/rule/{$_POST['id']}") || (is_array($_POST['rule']) && count($_POST['rule']))) {

		deleteNATrule($_POST);

	}

} elseif (($_POST['act'] == "toggle" || isset($_POST['toggle_x'])) && have_natpfruleint_access($natent['interface'])) {

	if (config_get_path("nat/rule/{$_POST['id']}") || (is_array($_POST['rule']) && count($_POST['rule']))) {

		toggleNATrule($_POST);

	}

}

// Construct the page =============================================================================

$pgtitle = array(gettext("Firewall"), gettext("NAT"), gettext("Port Forward"));

$pglinks = array("", "@self", "@self");

include("head.inc");

if ($_POST['apply']) {

	print_apply_result_box($retval);

}

if (is_subsystem_dirty('natconf') && have_natpfruleint_access($natent['interface'])) {

	print_apply_box(gettext('The NAT configuration has been changed.') . '<br />' .

					gettext('The changes must be applied for them to take effect.'));

}

$tab_array = array();

$tab_array[] = array(gettext("Port Forward"), true, "firewall_nat.php");

$tab_array[] = array(gettext("1:1"), false, "firewall_nat_1to1.php");

$tab_array[] = array(gettext("Outbound"), false, "firewall_nat_out.php");

$tab_array[] = array(gettext("NPt"), false, "firewall_nat_npt.php");

display_top_tabs($tab_array);

$columns_in_table = 13;

?>

<!-- Allow table to scroll when dragging outside of the display window -->

<style>

.table-responsive {

    clear: both;

    overflow-x: visible;

    margin-bottom: 0px;

}

</style>

<form action="firewall_nat.php" method="post" name="iform">

	<div class="panel panel-default">

		<div class="panel-heading"><h2 class="panel-title"><?=gettext('Rules')?></h2></div>

		<div class="panel-body table-responsive">

			<table id="ruletable" class="table table-striped table-hover table-condensed">

				<thead>

					<tr>

						<th style="padding-left:10px;">  <input type="checkbox" id="selectAll" name="selectAll" /></th>

						<th><!-- Icon --></th>

						<th><!-- Rule type --></th>

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

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

						<th><?=gettext("Source Address")?></th>

						<th><?=gettext("Source Ports")?></th>

						<th><?=gettext("Dest. Address")?></th>

						<th><?=gettext("Dest. Ports")?></th>

						<th><?=gettext("NAT IP")?></th>

						<th><?=gettext("NAT Ports")?></th>

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

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

					</tr>

				</thead>

				<tbody class='user-entries'>

<?php

$nnats = $i = 0;

$separators = config_get_path('nat/separator');

// Get a list of separator rows and use it to call the display separator function only for rows which there are separator(s).

// More efficient than looping through the list of separators on every row.

$seprows = separator_rows($separators);

global $user_settings;

$show_system_alias_popup = (array_key_exists('webgui', $user_settings) && !$user_settings['webgui']['disablealiaspopupdetail']);

$system_alias_specialnet = get_specialnet('', [SPECIALNET_IFNET, SPECIALNET_GROUP]);

foreach (config_get_path('nat/rule', []) as $natent):

	// Display separator(s) for section beginning at rule n

	if ($seprows[$nnats]) {

		display_separator($separators, $nnats, $columns_in_table);

	}

	$localport = $natent['local-port'];

	list($dstbeginport, $dstendport) = explode("-", $natent['destination']['port']);

	if ($dstendport && is_port($localport)) {

		$localendport = $natent['local-port'] + $dstendport - $dstbeginport;

		$localport	 .= '-' . $localendport;

	}

	$alias = rule_columns_with_alias(

		$natent['source']['address'],

		pprint_port($natent['source']['port']),

		$natent['destination']['address'],

		pprint_port($natent['destination']['port']),

		$natent['target'],

		$localport

	);

	if (isset($natent['disabled'])) {

		$iconfn = "pass_d";

		$trclass = 'class="disabled"';

	} else {

		$iconfn = "pass";

		$trclass = '';

	}

?>

					<tr id="fr<?=$nnats;?>" <?=$trclass?> onClick="fr_toggle(<?=$nnats;?>)" ondblclick="document.location='firewall_nat_edit.php?id=<?=$i;?>';">

						<td >

<?php	if (have_natpfruleint_access($natent['interface'])): ?>

							<input type="checkbox" id="frc<?=$nnats;?>" onClick="fr_toggle(<?=$nnats;?>)" name="rule[]" value="<?=$i;?>"/>

<?php	endif; ?>

						</td>

						<td>

<?php	if (have_natpfruleint_access($natent['interface'])): ?>

							<a href="?act=toggle&amp;id=<?=$i?>" usepost>

								<i class="fa-solid fa-check" title="<?=gettext("click to toggle enabled/disabled status")?>"></i>

							</a>

<?php	endif; ?>

<?php 	if (isset($natent['nordr'])) { ?>

								&nbsp;<i class="fa-regular fa-hand text-danger" title="<?=gettext("Negated: This rule excludes NAT from a later rule")?>"></i>

<?php 	} ?>

						</td>

						<td>

<?php

	if ($natent['associated-rule-id'] == "pass"):

?>

							<i class="fa-solid fa-play" title="<?=gettext("All traffic matching this NAT entry is passed")?>"></i>

<?php

	elseif (!empty($natent['associated-rule-id'])):

?>

							<i class="fa-solid fa-random" title="<?=sprintf(gettext("Firewall rule ID %s is managed by this rule"), htmlspecialchars($natent['associated-rule-id']))?>"></i>

<?php

	endif;

?>

						</td>

						<td>

							<?=$textss?>

<?php

	if (!$natent['interface']) {

		echo htmlspecialchars(convert_friendly_interface_to_friendly_descr("wan"));

	} else {

		echo htmlspecialchars(convert_friendly_interface_to_friendly_descr($natent['interface']));

	}

?>

							<?=$textse?>

						</td>

						<td>

							<?=$textss?><?=strtoupper($natent['protocol'])?><?=$textse?>

						</td>

						<td>

							<?php if (isset($alias['src'])): ?>

								<a href="/firewall_aliases_edit.php?id=<?=$alias['src']?>" data-toggle="popover" data-trigger="hover focus" title="<?=gettext('Alias details')?>" data-content="<?=alias_info_popup($alias['src'])?>" data-html="true">

									<?=str_replace('_', '_<wbr>', htmlspecialchars(pprint_address($natent['source'], $rdr_srctype_flags)))?>

								</a>

							<?php elseif ($show_system_alias_popup && array_key_exists($natent['source']['network'], $system_alias_specialnet)): ?>

								<a data-toggle="popover" data-trigger="hover focus" title="<?=gettext('System alias details')?>" data-content="<?=system_alias_info_popup(strtoupper($natent['source']['network']) . '__NETWORK')?>" data-html="true">

									<?=str_replace('_', '_<wbr>', htmlspecialchars(pprint_address($natent['source'], $rdr_srctype_flags)))?>

								</a>

							<?php else: ?>

								<?=htmlspecialchars(pprint_address($natent['source'], $rdr_srctype_flags))?>

							<?php endif; ?>

						</td>

						<td>

<?php

	if (isset($alias['srcport'])):

?>

							<a href="/firewall_aliases_edit.php?id=<?=$alias['srcport']?>" data-toggle="popover" data-trigger="hover focus" title="<?=gettext('Alias details')?>" data-content="<?=alias_info_popup($alias['srcport'])?>" data-html="true">

<?php

	endif;

?>

							<?=str_replace('_', '_<wbr>', htmlspecialchars(pprint_port($natent['source']['port'])))?>

<?php

	if (isset($alias['srcport'])):

?>

							</a>

<?php

	endif;

?>

						</td>

						<td>

							<?php if (isset($alias['dst'])): ?>

								<a href="/firewall_aliases_edit.php?id=<?=$alias['dst']?>" data-toggle="popover" data-trigger="hover focus" title="<?=gettext('Alias details')?>" data-content="<?=alias_info_popup($alias['dst'])?>" data-html="true">

									<?=str_replace('_', '_<wbr>', htmlspecialchars(pprint_address($natent['destination'], $rdr_dsttype_flags)))?>

								</a>

							<?php elseif ($show_system_alias_popup && array_key_exists($natent['destination']['network'], $system_alias_specialnet)): ?>

								<a data-toggle="popover" data-trigger="hover focus" title="<?=gettext('System alias details')?>" data-content="<?=system_alias_info_popup(strtoupper($natent['destination']['network']) . '__NETWORK')?>" data-html="true">

									<?=str_replace('_', '_<wbr>', htmlspecialchars(pprint_address($natent['destination'], $rdr_dsttype_flags)))?>

								</a>

							<?php else: ?>

								<?=htmlspecialchars(pprint_address($natent['destination'], $rdr_dsttype_flags))?>

							<?php endif; ?>

						</td>

						<td>

<?php

	if (isset($alias['dstport'])):

?>

							<a href="/firewall_aliases_edit.php?id=<?=$alias['dstport']?>" data-toggle="popover" data-trigger="hover focus" title="<?=gettext('Alias details')?>" data-content="<?=alias_info_popup($alias['dstport'])?>" data-html="true">

<?php

	endif;

?>

							<?=str_replace('_', '_<wbr>', htmlspecialchars(pprint_port($natent['destination']['port'])))?>

<?php

	if (isset($alias['dstport'])):

?>

							</a>

<?php

	endif;

?>

						</td>

						<td>

							<?php if (isset($alias['target'])): ?>

								<a href="/firewall_aliases_edit.php?id=<?=$alias['target']?>" data-toggle="popover" data-trigger="hover focus" title="<?=gettext('Alias details')?>" data-content="<?=alias_info_popup($alias['target'])?>" data-html="true">

									<?=str_replace('_', '_<wbr>', htmlspecialchars(pprint_address(['network' => $natent['target']], $rdr_lcltype_flags)))?>

								</a>

							<?php else: ?>

								<?=htmlspecialchars(pprint_address(['network' => $natent['target']], $rdr_lcltype_flags))?>

							<?php endif; ?>

						</td>

						<td>

<?php

	if (isset($alias['targetport'])):

?>

							<a href="/firewall_aliases_edit.php?id=<?=$alias['targetport']?>" data-toggle="popover" data-trigger="hover focus" title="<?=gettext('Alias details')?>" data-content="<?=alias_info_popup($alias['targetport'])?>" data-html="true">

<?php

	endif;

?>

							<?=str_replace('_', '_<wbr>', htmlspecialchars(pprint_port($localport)))?>

<?php

	if (isset($alias['targetport'])):

?>

							</a>

<?php

	endif;

?>

						</td>

						<td>

							<?=htmlspecialchars($natent['descr'])?>

						</td>

						<td>

<?php	if (have_natpfruleint_access($natent['interface'])): ?>

							<a class="fa-solid fa-pencil" title="<?=gettext("Edit rule"); ?>" href="firewall_nat_edit.php?id=<?=$i?>"></a>

							<a class="fa-regular fa-clone"	  title="<?=gettext("Add a new NAT based on this one")?>" href="firewall_nat_edit.php?dup=<?=$i?>"></a>

							<a class="fa-solid fa-trash-can"	title="<?=gettext("Delete rule")?>" href="firewall_nat.php?act=del&amp;id=<?=$i?>" usepost></a>

<?php	else: ?>

							-

<?php	endif; ?>

						</td>

					</tr>

<?php

	$i++;

	$nnats++;

endforeach;

// There can be separator(s) after the last rule listed.

if ($seprows[$nnats]) {

	display_separator($separators, $nnats, $columns_in_table);

}

?>

				</tbody>

			</table>

		</div>

	</div>

<?php	if (have_natpfruleint_access($natent['interface'])): ?>

	<nav class="action-buttons">

		<a href="firewall_nat_edit.php?after=-1" class="btn btn-sm btn-success" title="<?=gettext('Add rule to the top of the list')?>">

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

			<?=gettext('Add')?>

		</a>

		<a href="firewall_nat_edit.php" class="btn btn-sm btn-success" title="<?=gettext('Add rule to the end of the list')?>">

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

			<?=gettext('Add')?>

		</a>

		<button id="del_x" name="del_x" type="submit" class="btn btn-danger btn-sm" disabled title="<?=gettext('Delete selected rules')?>">

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

			<?=gettext("Delete"); ?>

		</button>

		<button id="toggle_x" name="toggle_x" type="submit" class="btn btn-primary btn-sm" disabled value="<?=gettext("Toggle selected rules"); ?>" title="<?=gettext('Toggle selected rules')?>">

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

			<?=gettext("Toggle"); ?>

		</button>

		<button type="submit" id="order-store" name="order-store" class="btn btn-primary btn-sm" disabled title="<?=gettext('Save rule order')?>">

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

			<?=gettext("Save")?>

		</button>

		<button type="submit" id="addsep" name="addsep" class="btn btn-sm btn-warning" title="<?=gettext('Add separator')?>">

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

			<?=gettext("Separator")?>

		</button>

	</nav>

<?php	endif; ?>

</form>

<script type="text/javascript">

//<![CDATA[

//Need to create some variables here so that jquery/pfSenseHelpers.js can read them

iface = "<?=strtolower($if)?>";

cncltxt = '<?=gettext("Cancel")?>';

svtxt = '<?=gettext("Save")?>';

svbtnplaceholder = '<?=gettext("Enter a description, Save, then drag to final location.")?>';

configsection = "nat";

dirty = false;

events.push(function() {

<?php if(!config_path_enabled('system/webgui', 'roworderdragging')): ?>

	// Make rules sortable

	$('table tbody.user-entries').sortable({

		cursor: 'grabbing',

		update: function(event, ui) {

			$('#order-store').removeAttr('disabled');

			dirty = true;

			reindex_rules(ui.item.parent('tbody'));

			dirty = true;

		}

	});

<?php endif; ?>

	// Check all of the rule checkboxes so that their values are posted

	$('#order-store').click(function () {

	   $('[id^=frc]').prop('checked', true);

		// Save the separator bar configuration

		save_separators();

		// Suppress the "Do you really want to leave the page" message

		saving = true;

	});

	$('[id^=fr]').click(function () {

		buttonsmode('frc', ['del_x', 'toggle_x']);

	});

	// Globals

	saving = false;

	dirty = false;

	// provide a warning message if the user tries to change page before saving

	// Unfortunately the custom message is not supported in modern browsers, but he user wil lat

	// least see a generic warning message

	$(window).bind('beforeunload', function(){

		if (!saving && dirty) {

			return ("<?=gettext('One or more Port Forward rules have been moved but have not yet been saved')?>");

		} else {

			return undefined;

		}

	});

	$('#selectAll').click(function() {

		var checkedStatus = this.checked;

		$('#ruletable tbody tr').find('td:first :checkbox').each(function() {

		$(this).prop('checked', checkedStatus);

		});

		buttonsmode('frc', ['del_x', 'toggle_x']);

	});

});

//]]>

</script>

<?php

if (count(config_get_path('nat/rule', [])) > 0) {

?>

<!-- Legend -->

<div>

	<dl class="dl-horizontal responsive">

		<dt><?=gettext('Legend')?></dt>					<dd></dd>

		<dt><i class="fa-solid fa-play"></i></dt>			<dd><?=gettext('Pass')?></dd>

		<dt><i class="fa-solid fa-random"></i></dt>		<dd><?=gettext('Linked rule')?></dd>

	</dl>

</div>

<?php

}

include("foot.inc");