summaryrefslogtreecommitdiffstats
path: root/usr/local/www/diag_testport.php
blob: fbc448a2eb0f9b4e697b49b3e7aac65eaf475679 (plain)
1
2
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
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
<?php
/*
	diag_testport.php
	Copyright (C) 2013 Jim P (jimp@pfsense.org)
	Copyright (C) 2013-2015 Electric Sheep Fencing, LP
	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

$allowautocomplete = true;

$pgtitle = array(gettext("Diagnostics"), gettext("Test Port"));
require("guiconfig.inc");

define('NC_TIMEOUT', 10);
$do_testport = false;

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'];
}

include("head.inc"); ?>
<body link="#0000CC" vlink="#0000CC" alink="#0000CC">
<?php include("fbegin.inc"); ?>
<table width="100%" border="0" cellpadding="0" cellspacing="0" summary="diag test port">
<tr><td>
<?php echo gettext("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."); ?>
<br /><br />
<?php echo gettext("No data is transmitted to the remote host during this test, it will only attempt to open a connection and optionally display the data sent back from the server."); ?>
<br /><br /><br />
<?php if ($input_errors) print_input_errors($input_errors); ?>
	<form action="diag_testport.php" method="post" name="iform" id="iform">
	<table width="100%" border="0" cellpadding="6" cellspacing="0" summary="main area">
		<tr>
			<td colspan="2" valign="top" class="listtopic"><?=gettext("Test Port"); ?></td>
		</tr>
		<tr>
			<td width="22%" valign="top" class="vncellreq"><?=gettext("Host"); ?></td>
			<td width="78%" class="vtable">
				<?=$mandfldhtml;?>
				<input name="host" type="text" class="formfld unknown" id="host" size="20" value="<?=htmlspecialchars($host);?>" />
			</td>
		</tr>
		<tr>
			<td width="22%" valign="top" class="vncellreq"><?= gettext("Port"); ?></td>
			<td width="78%" class="vtable">
				<input name="port" type="text" class="formfld unknown" id="port" size="10" value="<?=htmlspecialchars($port);?>" />
			</td>
		</tr>
		<tr>
			<td width="22%" valign="top" class="vncell"><?= gettext("Source Port"); ?></td>
			<td width="78%" class="vtable">
				<input name="srcport" type="text" class="formfld unknown" id="srcport" size="10" value="<?=htmlspecialchars($srcport);?>" />
				<br /><br /><?php echo gettext("This should typically be left blank."); ?>
			</td>
		</tr>
		<tr>
			<td width="22%" valign="top" class="vncell"><?= gettext("Show Remote Text"); ?></td>
			<td width="78%" class="vtable">
				<input name="showtext" type="checkbox" id="showtext" <?php if ($showtext) echo "checked=\"checked\"" ?> />
				<br /><br /><?php echo gettext("Shows the text given by the server when connecting to the port. Will take 10+ seconds to display if checked."); ?>
			</td>
		</tr>
		<tr>
			<td width="22%" valign="top" class="vncell"><?=gettext("Source Address"); ?></td>
			<td width="78%" class="vtable">
				<select name="sourceip" class="formselect">
					<option value="">Any</option>
				<?php   $sourceips = get_possible_traffic_source_addresses(true);
					foreach ($sourceips as $sipvalue => $sipname):
						$selected = "";
						if (!link_interface_to_bridge($sipvalue) && ($sipvalue == $sourceip)) {
							$selected = "selected=\"selected\"";
						}
				?>
					<option value="<?=$sipvalue;?>" <?=$selected;?>>
						<?=htmlspecialchars($sipname);?>
					</option>
				<?php endforeach; ?>
				</select>
			</td>
		</tr>
		<tr>
			<td width="22%" valign="top" class="vncell"><?=gettext("IP Protocol"); ?></td>
			<td width="78%" class="vtable">
			<select name="ipprotocol" class="formfld">
				<option value="any" <?php if ("any" == $ipprotocol) echo "selected=\"selected\""; ?>>
					Any
				</option>
				<option value="ipv4" <?php if ($ipprotocol == "ipv4") echo "selected=\"selected\""; ?>>
					<?=gettext("IPv4");?>
				</option>
				<option value="ipv6" <?php if ($ipprotocol == "ipv6") echo "selected=\"selected\""; ?>>
					<?=gettext("IPv6");?>
				</option>
			</select>
			<br /><br />
			<?php echo gettext("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."); ?>
			</td>
		</tr>
		<tr>
			<td width="22%" valign="top">&nbsp;</td>
			<td width="78%">
				<input name="Submit" type="submit" class="formbtn" value="<?=gettext("Test"); ?>" />
			</td>
		</tr>
		<tr>
			<td valign="top" colspan="2">
			<?php if ($do_testport) {
				echo "<font face=\"terminal\" size=\"2\">";
				echo "<strong>" . gettext("Port Test Results") . ":</strong><br />";
			?>
				<script type="text/javascript">
				//<![CDATA[
				window.onload=function() {
					document.getElementById("testportCaptured").wrap='off';
				}
				//]]>
				</script>
			<?php
				echo "<textarea id=\"testportCaptured\" style=\"width:98%\" name=\"code\" rows=\"15\" cols=\"66\" readonly=\"readonly\">";
				$result = "";
				$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 ($showtext) {
						echo gettext("No output received, or connection failed. Try with \"Show Remote Text\" unchecked first.");
					} else {
						echo gettext("Connection failed (Refused/Timeout)");
					}
				} else {
					if (is_array($result)) {
						foreach ($result as $resline) {
							echo htmlspecialchars($resline) . "\n";
						}
					} else {
						echo htmlspecialchars($result);
					}
				}
				echo '</textarea>&nbsp;</font>' ;
			}
			?>
			</td>
		</tr>
	</table>
</form>
</td></tr></table>
<?php include("fend.inc"); ?>
</body>
</html>
OpenPOWER on IntegriCloud