pfSense

<?php

/*

	diag_testport.php

	Copyright (C) 2013 Jim P (jimp@pfsense.org)

	All rights reserved.

	Portions based on diag_ping.php

	part of m0n0wall (http://m0n0.ch/wall)

	Copyright (C) 2003-2005 Bob Zoller (bob@kludgebox.com) and Manuel Kasper <mk@neon1.net>.

	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.

*/

/*

	pfSense_BUILDER_BINARIES:	/usr/bin/nc

	pfSense_MODULE: routing

*/

##|+PRIV

##|*IDENT=page-diagnostics-testport

##|*NAME=Diagnostics: Test Port

##|*DESCR=Allow access to the 'Diagnostics: Test Port' page.

##|*MATCH=diag_testport.php*

##|-PRIV

// Calling netcat and parsing hte results has been moved to the if ($_POST) section so that the results are known

// before we draw the form and any resulting error messages will allear in the correct place

$allowautocomplete = true;

$pgtitle = array(gettext("Diagnostics"), gettext("Test Port"));

require("guiconfig.inc");

define('NC_TIMEOUT', 10);

$do_testport = false;

$retval = 1;

if ($_POST || $_REQUEST['host']) {

	unset($input_errors);

	/* input validation */

	$reqdfields = explode(" ", "host port");

	$reqdfieldsn = array(gettext("Host"),gettext("Port"));

	do_input_validation($_REQUEST, $reqdfields, $reqdfieldsn, $input_errors);

	if (!is_ipaddr($_REQUEST['host']) && !is_hostname($_REQUEST['host'])) {

		$input_errors[] = gettext("Please enter a valid IP or hostname.");

	}

	if (!is_port($_REQUEST['port'])) {

		$input_errors[] = gettext("Please enter a valid port number.");

	}

	if (($_REQUEST['srcport'] != "") && (!is_numeric($_REQUEST['srcport']) || !is_port($_REQUEST['srcport']))) {

		$input_errors[] = gettext("Please enter a valid source port number, or leave the field blank.");

	}

	if (is_ipaddrv4($_REQUEST['host']) && ($_REQUEST['ipprotocol'] == "ipv6")) {

		$input_errors[] = gettext("You cannot connect to an IPv4 address using IPv6.");

	}

	if (is_ipaddrv6($_REQUEST['host']) && ($_REQUEST['ipprotocol'] == "ipv4")) {

		$input_errors[] = gettext("You cannot connect to an IPv6 address using IPv4.");

	}

	if (!$input_errors) {

		$do_testport = true;

		$timeout = NC_TIMEOUT;

	}

	/* Save these request vars even if there were input errors. Then the fields are refilled for the user to correct. */

	$host = $_REQUEST['host'];

	$sourceip = $_REQUEST['sourceip'];

	$port = $_REQUEST['port'];

	$srcport = $_REQUEST['srcport'];

	$showtext = isset($_REQUEST['showtext']);

	$ipprotocol = $_REQUEST['ipprotocol'];

	if ( $do_testport ) {

?>

		<script type="text/javascript">

			//<![CDATA[

			window.onload=function(){

				document.getElementById("testportCaptured").wrap='off';

			}

			//]]>

		</script>

<?php

		$result = "";

		$ncoutput = "";

		$nc_base_cmd = '/usr/bin/nc';

		$nc_args = "-w " . escapeshellarg($timeout);

		if (!$showtext)

			$nc_args .= ' -z ';

		if (!empty($srcport))

			$nc_args .= ' -p ' . escapeshellarg($srcport) . ' ';

		/* Attempt to determine the interface address, if possible. Else try both. */

		if (is_ipaddrv4($host)) {

			$ifaddr = ($sourceip == "any") ? "" : get_interface_ip($sourceip);

			$nc_args .= ' -4';

		} elseif (is_ipaddrv6($host)) {

			if ($sourceip == "any")

				$ifaddr = '';

			else if (is_linklocal($sourceip))

				$ifaddr = $sourceip;

			else

				$ifaddr = get_interface_ipv6($sourceip);

			$nc_args .= ' -6';

		} else {

			switch ($ipprotocol) {

				case "ipv4":

					$ifaddr = get_interface_ip($sourceip);

					$nc_ipproto = ' -4';

					break;

				case "ipv6":

					$ifaddr = (is_linklocal($sourceip) ? $sourceip : get_interface_ipv6($sourceip));

					$nc_ipproto = ' -6';

					break;

				case "any":

					$ifaddr = get_interface_ip($sourceip);

					$nc_ipproto = (!empty($ifaddr)) ? ' -4' : '';

					if (empty($ifaddr)) {

						$ifaddr = (is_linklocal($sourceip) ? $sourceip : get_interface_ipv6($sourceip));

						$nc_ipproto = (!empty($ifaddr)) ? ' -6' : '';

					}

					break;

			}

			/* Netcat doesn't like it if we try to connect using a certain type of IP without specifying the family. */

			if (!empty($ifaddr)) {

				$nc_args .= $nc_ipproto;

			} elseif ($sourceip == "any") {

				switch ($ipprotocol) {

					case "ipv4":

						$nc_ipproto = ' -4';

						break;

					case "ipv6":

						$nc_ipproto = ' -6';

						break;

				}

				$nc_args .= $nc_ipproto;

			}

		}

		/* Only add on the interface IP if we managed to find one. */

		if (!empty($ifaddr)) {

			$nc_args .= ' -s ' . escapeshellarg($ifaddr) . ' ';

			$scope = get_ll_scope($ifaddr);

			if (!empty($scope) && !strstr($host, "%"))

				$host .= "%{$scope}";

		}

		$nc_cmd = "{$nc_base_cmd} {$nc_args} " . escapeshellarg($host) . ' ' . escapeshellarg($port) . ' 2>&1';

		exec($nc_cmd, $result, $retval);

	//	echo "NC CMD: {$nc_cmd}\n\n";

		if (!empty($result)) {

			if (is_array($result)) {

				foreach ($result as $resline) {

					$ncoutput .= htmlspecialchars($resline) . "\n";

				}

			} else {

				$ncoutput .= htmlspecialchars($result);

			}

		}

	}

}

include("head.inc");

// Handle the display of all messages here wher the user can readily see them

if ($input_errors)

	print_input_errors($input_errors);

else {

	// New page

	if(empty($result) && $retval != 0 && !$showtext) {	    

	    print('<div class="alert alert-warning" role="alert">This page allows you to perform a simple TCP connection test to determine if a host is up and accepting connections on a given port.' .

	          ' This test does not function for UDP since there is no way to reliably determine if a UDP port accepts connections in this manner.</div>');

	}

	// Good host & port

	if($retval == 0 && $do_testport == 1)	{

		if(!$showtext)

			print('<div class="alert alert-success" role="alert">'.gettext("Port test to host: " . $host . " Port: " . $port . " successful").'</div>');

		else

			print('<div class="alert alert-success" role="alert">'.gettext("Port test to host: " . $host . " Port: " . $port . " successful") . '. Any text received from teh host will be shown below the form.</div>');

	}

	// netcat exit value != 0

	if($retval != 0 && !empty($result))

		if($showtext)

			print('<div class="alert alert-danger" role="alert">'.gettext('No output received, or connection failed. Try with "Show Remote Text" unchecked first.').'</div>');

		else

			print('<div class="alert alert-danger" role="alert">'.gettext('Connection failed.').'</div>');

}

require('classes/Form.class.php');

$form = new Form(new Form_Button(

	'Submit',

	'Test'

));

$section = new Form_Section('Test Port');

$section->addInput(new Form_Input(

	'host',

	'Hostname',

	'text',

	$host,

	['placeholder' => 'Hostname to look up.']

));

$section->addInput(new Form_Input(

	'port',

	'Port',

	'text',

	$port,

	['placeholder' => 'Port to test.']

));

$section->addInput(new Form_Input(

	'srcport',

	'Source Port',

	'text',

	$srcport,

	['placeholder' => 'Typically left blank.']

));

$section->addInput(new Form_Checkbox(

	'showtext',

	'Remote text',

	'Show remote text',

	$showtext

))->setHelp("Shows the text given by the server when connecting to the port. If checked it will take 10+ seconds to display in a panel below this form.");

$section->addInput(new Form_Select(

	'sourceip',

	'Source Address',

	$sourceip,

	array_merge(array('' => 'Any'), get_possible_traffic_source_addresses(true))

))->setHelp('Select source address for the trace');

$section->addInput(new Form_Select(

	'ipproto',

	'IP Protocol',

	$ipprotocol,

	array('ipv4' => 'IPv4', 'ipv6' => 'IPv6')

))->setHelp("If you force IPv4 or IPv6 and use a hostname that does not contain a result using that protocol, it will result in an error." .

					" For example if you force IPv4 and use a hostname that only returns an AAAA IPv6 IP address, it will not work.");

$form->add($section);

print $form;

if($ncoutput && !empty($result) && $showtext && $retval == 0): ?>

	<div class="panel panel-default">

		<div class="panel-heading">

			<h2 class="panel-title">Received Remote Text</h2>

		</div>

		<div class="panel-body">

			<pre><?= $ncoutput ?></pre>

		</div>

	</div>

<?php endif;

include("foot.inc");