Project

General

Profile

Download (17.3 KB) Statistics
| Branch: | Tag: | Revision:
1
<?php
2
/*
3
    diag_packet_capture.php
4
	Copyright (C) 2013-2015 Electric Sheep Fencing, LP
5
	All rights reserved
6

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

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

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

    
17
	THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
18
	INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
19
	AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
20
	AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
21
	OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22
	SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23
	INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24
	CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25
	ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26
	POSSIBILITY OF SUCH DAMAGE.
27
*/
28

    
29
/*
30
	pfSense_BUILDER_BINARIES:	/bin/ps	/usr/bin/grep	/usr/sbin/tcpdump
31
	pfSense_MODULE:	routing
32
*/
33

    
34
##|+PRIV
35
##|*IDENT=page-diagnostics-packetcapture
36
##|*NAME=Diagnostics: Packet Capture page
37
##|*DESCR=Allow access to the 'Diagnostics: Packet Capture' page.
38
##|*MATCH=diag_packet_capture.php*
39
##|-PRIV
40

    
41
$allowautocomplete = true;
42

    
43
function fixup_host_logic($value) {
44
	return str_replace(array(" ", ",", "+", "|", "!"), array("", "and ", "and ", "or ", "not "), $value);
45
}
46
function strip_host_logic($value) {
47
	return str_replace(array(" ", ",", "+", "|", "!"), array("", "", "", "", ""), $value);
48
}
49
function get_host_boolean($value, $host) {
50
	$value = str_replace(array("!", $host), array("", ""), $value);
51
	$andor = "";
52
	switch (trim($value)) {
53
		case "|":
54
			$andor = "or ";
55
			break;
56
		case ",":
57
		case "+":
58
			$andor = "and ";
59
			break;
60
	}
61
	return $andor;
62
}
63
function has_not($value) {
64
	return strpos($value, '!') !== false;
65
}
66
function fixup_not($value) {
67
	return str_replace("!", "not ", $value);
68
}
69
function strip_not($value) {
70
	return ltrim(trim($value), '!');
71
}
72

    
73
function fixup_host($value, $position) {
74
	$host = strip_host_logic($value);
75
	$not = has_not($value) ? "not " : "";
76
	$andor = ($position > 0) ? get_host_boolean($value, $host) : "";
77
	if (is_ipaddr($host))
78
		return "{$andor}host {$not}" . $host;
79
	elseif (is_subnet($host))
80
		return "{$andor}net {$not}" . $host;
81
	else
82
		return "";
83
}
84

    
85
if ($_POST['downloadbtn'] == gettext("Download Capture"))
86
	$nocsrf = true;
87

    
88
$pgtitle = array(gettext("Diagnostics"), gettext("Packet Capture"));
89
require_once("guiconfig.inc");
90
require_once("pfsense-utils.inc");
91

    
92
$fp = "/root/";
93
$fn = "packetcapture.cap";
94
$snaplen = 0;//default packet length
95
$count = 100;//default number of packets to capture
96

    
97
$fams = array('ip', 'ip6');
98
$protos = array('icmp', 'icmp6', 'tcp', 'udp', 'arp', 'carp', 'esp',
99
		'!icmp', '!icmp6', '!tcp', '!udp', '!arp', '!carp', '!esp');
100

    
101
$input_errors = array();
102

    
103
$interfaces = get_configured_interface_with_descr();
104
if (isset($config['ipsec']['enable']))
105
	$interfaces['ipsec'] = "IPsec";
106
foreach (array('server', 'client') as $mode) {
107
	if (is_array($config['openvpn']["openvpn-{$mode}"])) {
108
		foreach ($config['openvpn']["openvpn-{$mode}"] as $id => $setting) {
109
			if (!isset($setting['disable'])) {
110
				$interfaces['ovpn' . substr($mode, 0, 1) . $setting['vpnid']] = gettext("OpenVPN") . " ".$mode.": ".htmlspecialchars($setting['description']);
111
			}
112
		}
113
	}
114
}
115

    
116
if ($_POST) {
117
	$host = $_POST['host'];
118
	$selectedif = $_POST['interface'];
119
	$count = $_POST['count'];
120
	$snaplen = $_POST['snaplen'];
121
	$port = $_POST['port'];
122
	$detail = $_POST['detail'];
123
	$fam = $_POST['fam'];
124
	$proto = $_POST['proto'];
125

    
126
	if (!array_key_exists($selectedif, $interfaces)) {
127
		$input_errors[] = gettext("Invalid interface.");
128
	}
129
	if ($fam !== "" && $fam !== "ip" && $fam !== "ip6") {
130
		$input_errors[] = gettext("Invalid address family.");
131
	}
132
	if ($proto !== "" && !in_array(strip_not($proto), $protos)) {
133
		$input_errors[] = gettext("Invalid protocol.");
134
	}
135
	
136
	if ($host != "") {
137
		$host_string = str_replace(array(" ", "|", ","), array("", "#|", "#+"), $host);
138
		if (strpos($host_string, '#') === false) {
139
			$hosts = array($host);
140
		} else {
141
			$hosts = explode('#', $host_string);
142
		}
143
		foreach ($hosts as $h) {
144
			if (!is_subnet(strip_host_logic($h)) && !is_ipaddr(strip_host_logic($h))) {
145
				$input_errors[] = sprintf(gettext("A valid IP address or CIDR block must be specified. [%s]"), $h);
146
			}
147
		}
148
	}
149
	if ($port != "") {
150
		if (!is_port(strip_not($port))) {
151
			$input_errors[] = gettext("Invalid value specified for port.");
152
		}
153
	}
154
	if ($snaplen == "") {
155
		$snaplen = 0;
156
	} else {
157
		if (!is_numeric($snaplen) || $snaplen < 0) {
158
			$input_errors[] = gettext("Invalid value specified for packet length.");
159
		}
160
	}
161
	if ($count == "") {
162
		$count = 0;
163
	} else {
164
		if (!is_numeric($count) || $count < 0) {
165
			$input_errors[] = gettext("Invalid value specified for packet count.");
166
		}
167
	}
168

    
169
	if (!count($input_errors)) {
170
		$do_tcpdump = true;
171

    
172
		conf_mount_rw();
173

    
174
		if ($_POST['promiscuous']) {
175
			//if promiscuous mode is checked
176
			$disablepromiscuous = "";
177
		} else {
178
			//if promiscuous mode is unchecked
179
			$disablepromiscuous = "-p";
180
		}
181

    
182
		if ($_POST['dnsquery']) {
183
			//if dns lookup is checked
184
			$disabledns = "";
185
		} else {
186
			//if dns lookup is unchecked
187
			$disabledns = "-n";
188
		}
189

    
190
		if ($_POST['startbtn'] != "" ) {
191
			$action = gettext("Start");
192

    
193
			//delete previous packet capture if it exists
194
			if (file_exists($fp.$fn))
195
				unlink ($fp.$fn);
196

    
197
		} elseif ($_POST['stopbtn']!= "") {
198
			$action = gettext("Stop");
199
			$processes_running = trim(shell_exec("/bin/ps axw -O pid= | /usr/bin/grep tcpdump | /usr/bin/grep {$fn} | /usr/bin/egrep -v '(pflog|grep)'"));
200

    
201
			//explode processes into an array, (delimiter is new line)
202
			$processes_running_array = explode("\n", $processes_running);
203

    
204
			//kill each of the packetcapture processes
205
			foreach ($processes_running_array as $process) {
206
				$process_id_pos = strpos($process, ' ');
207
				$process_id = substr($process, 0, $process_id_pos);
208
				exec("kill $process_id");
209
			}
210

    
211
		} elseif ($_POST['downloadbtn']!= "") {
212
			//download file
213
			$fs = filesize($fp.$fn);
214
			header("Content-Type: application/octet-stream");
215
			header("Content-Disposition: attachment; filename=$fn");
216
			header("Content-Length: $fs");
217
			readfile($fp.$fn);
218
			exit;
219
		}
220
	}
221
} else {
222
	$do_tcpdump = false;
223
}
224

    
225
include("head.inc"); ?>
226

    
227
<body link="#000000" vlink="#0000CC" alink="#0000CC">
228

    
229
<?php
230
include("fbegin.inc");
231
?>
232

    
233
<?php if ($input_errors) print_input_errors($input_errors); ?>
234

    
235
<table width="100%" border="0" cellpadding="0" cellspacing="0" summary="diag packet capture">
236
	<tr><td>
237
	<form action="diag_packet_capture.php" method="post" name="iform" id="iform">
238
	<table width="100%" border="0" cellpadding="6" cellspacing="0" summary="table">
239
		<tr>
240
			<td colspan="3" valign="top" class="listtopic"><?=gettext("Packet capture");?></td>
241
		</tr>
242
		<tr>
243
			<td width="17%" valign="top" class="vncellreq"><?=gettext("Interface");?></td>
244
			<td width="32%" class="vtable">
245
			<select name="interface">
246
			<?php
247
			?>
248
			<?php foreach ($interfaces as $iface => $ifacename): ?>
249
				<option value="<?=$iface;?>" <?php if ($selectedif == $iface) echo "selected=\"selected\""; ?>>
250
				<?php echo $ifacename;?>
251
				</option>
252
			<?php endforeach; ?>
253
			</select>
254
			<br /><?=gettext("Select the interface on which to capture traffic.");?>
255
			</td>
256
		</tr>
257
		<tr>
258
			<td width="17%" valign="top" class="vncellreq"><?=gettext("Promiscuous");?></td>
259
			<td width="51%" class="vtable">
260
			<input name="promiscuous" type="checkbox"<?php if($_POST['promiscuous']) echo " checked=\"checked\""; ?> />
261
			<br /><?=gettext("If checked, the");?> <a target="_blank" href="http://www.freebsd.org/cgi/man.cgi?query=tcpdump&amp;apropos=0&amp;sektion=0&amp;manpath=FreeBSD+8.3-stable&amp;arch=default&amp;format=html"><?= gettext("packet capture")?></a> <?= gettext("will be performed using promiscuous mode.");?>
262
			<br /><b><?=gettext("Note");?>: </b><?=gettext("Some network adapters do not support or work well in promiscuous mode.");?>
263
			</td>
264
		</tr>
265
		<tr>
266
			<td width="17%" valign="top" class="vncellreq"><?=gettext("Address Family");?></td>
267
			<td colspan="2" width="83%" class="vtable">
268
			<select name="fam">
269
				<option value="">Any</option>
270
				<option value="ip" <?php if ($fam == "ip") echo "selected=\"selected\""; ?>>IPv4 Only</option>
271
				<option value="ip6" <?php if ($fam == "ip6") echo "selected=\"selected\""; ?>>IPv6 Only</option>
272
			</select>
273
			<br /><?=gettext("Select the type of traffic to be captured, either Any, IPv4 only or IPv6 only.");?>
274
			</td>
275
		</tr>
276
		<tr>
277
			<td width="17%" valign="top" class="vncellreq"><?=gettext("Protocol");?></td>
278
			<td colspan="2" width="83%" class="vtable">
279
			<select name="proto">
280
				<option value="">Any</option>
281
				<option value="icmp" <?php if ($proto == "icmp") echo "selected=\"selected\""; ?>>ICMP</option>
282
				<option value="!icmp" <?php if ($proto == "!icmp") echo "selected=\"selected\""; ?>>Exclude ICMP</option>
283
				<option value="icmp6" <?php if ($proto == "icmp6") echo "selected=\"selected\""; ?>>ICMPv6</option>
284
				<option value="!icmp6" <?php if ($proto == "!icmp6") echo "selected=\"selected\""; ?>>Exclude ICMPv6</option>
285
				<option value="tcp" <?php if ($proto == "tcp") echo "selected=\"selected\""; ?>>TCP</option>
286
				<option value="!tcp" <?php if ($proto == "!tcp") echo "selected=\"selected\""; ?>>Exclude TCP</option>
287
				<option value="udp" <?php if ($proto == "udp") echo "selected=\"selected\""; ?>>UDP</option>
288
				<option value="!udp" <?php if ($proto == "!udp") echo "selected=\"selected\""; ?>>Exclude UDP</option>
289
				<option value="arp" <?php if ($proto == "arp") echo "selected=\"selected\""; ?>>ARP</option>
290
				<option value="!arp" <?php if ($proto == "!arp") echo "selected=\"selected\""; ?>>Exclude ARP</option>
291
				<option value="carp" <?php if ($proto == "carp") echo "selected=\"selected\""; ?>>CARP (VRRP)</option>
292
				<option value="!carp" <?php if ($proto == "!carp") echo "selected=\"selected\""; ?>>Exclude CARP (VRRP)</option>
293
				<option value="esp" <?php if ($proto == "esp") echo "selected=\"selected\""; ?>>ESP</option>
294
			</select>
295
			<br /><?=gettext("Select the protocol to capture, or Any.");?>
296
			</td>
297
		</tr>
298
		<tr>
299
			<td width="17%" valign="top" class="vncellreq"><?=gettext("Host Address");?></td>
300
			<td colspan="2" width="83%" class="vtable">
301
			<input name="host" class="formfld host" id="host" size="20" value="<?=htmlspecialchars($host);?>" />
302
			<br /><?=gettext("This value is either the Source or Destination IP address or subnet in CIDR notation. The packet capture will look for this address in either field.");?>
303
			<br /><?=gettext("Matching can be negated by preceding the value with \"!\". Multiple IP addresses or CIDR subnets may be specified. Comma (\",\") separated values perform a boolean \"and\". Separating with a pipe (\"|\") performs a boolean \"or\".");?>
304
			<br /><?=gettext("If you leave this field blank, all packets on the specified interface will be captured.");?>
305
			</td>
306
		</tr>
307
		<tr>
308
			<td width="17%" valign="top" class="vncellreq"><?=gettext("Port");?></td>
309
			<td colspan="2" width="83%" class="vtable">
310
			<input name="port" class="formfld unknown" id="port" size="5" value="<?=$port;?>" />
311
			<br /><?=gettext("The port can be either the source or destination port. The packet capture will look for this port in either field.");?>
312
			<br /><?=gettext("Leave blank if you do not want to filter by port.");?>
313
			</td>
314
		</tr>
315
		<tr>
316
			<td width="17%" valign="top" class="vncellreq"><?=gettext("Packet Length");?></td>
317
			<td colspan="2" width="83%" class="vtable">
318
			<input name="snaplen" class="formfld unknown" id="snaplen" size="5" value="<?=$snaplen;?>" />
319
			<br /><?=gettext("The Packet length is the number of bytes of each packet that will be captured. Default value is 0, which will capture the entire frame regardless of its size.");?>
320
			</td>
321
		</tr>
322
		<tr>
323
			<td width="17%" valign="top" class="vncellreq"><?=gettext("Count");?></td>
324
			<td colspan="2" width="83%" class="vtable">
325
			<input name="count" class="formfld unknown" id="count" size="5" value="<?=$count;?>" />
326
			<br /><?=gettext("This is the number of packets the packet capture will grab. Default value is 100.") . "<br />" . gettext("Enter 0 (zero) for no count limit.");?>
327
			</td>
328
		</tr>
329
		<tr>
330
			<td width="17%" valign="top" class="vncellreq"><?=gettext("Level of Detail");?></td>
331
			<td colspan="2" width="83%" class="vtable">
332
			<select name="detail" class="formselect" id="detail" size="1">
333
				<option value="normal" <?php if ($detail == "normal") echo "selected=\"selected\""; ?>><?=gettext("Normal");?></option>
334
				<option value="medium" <?php if ($detail == "medium") echo "selected=\"selected\""; ?>><?=gettext("Medium");?></option>
335
				<option value="high"   <?php if ($detail == "high")   echo "selected=\"selected\""; ?>><?=gettext("High");?></option>
336
				<option value="full"   <?php if ($detail == "full")   echo "selected=\"selected\""; ?>><?=gettext("Full");?></option>
337
			</select>
338
			<br /><?=gettext("This is the level of detail that will be displayed after hitting 'Stop' when the packets have been captured.") .  "<br /><b>" .
339
					gettext("Note:") . "</b> " .
340
					gettext("This option does not affect the level of detail when downloading the packet capture.");?>
341
			</td>
342
		</tr>
343
		<tr>
344
			<td width="17%" valign="top" class="vncellreq"><?=gettext("Reverse DNS Lookup");?></td>
345
			<td colspan="2" width="83%" class="vtable">
346
			<input name="dnsquery" type="checkbox" <?php if($_POST['dnsquery']) echo " checked=\"checked\""; ?> />
347
			<br /><?=gettext("This check box will cause the packet capture to perform a reverse DNS lookup associated with all IP addresses.");?>
348
			<br /><b><?=gettext("Note");?>: </b><?=gettext("This option can cause delays for large packet captures.");?>
349
			</td>
350
		</tr>
351
		<tr>
352
			<td width="17%" valign="top">&nbsp;</td>
353
			<td colspan="2" width="83%">
354
<?php
355

    
356
			/* check to see if packet capture tcpdump is already running */
357
			$processcheck = (trim(shell_exec("/bin/ps axw -O pid= | /usr/bin/grep tcpdump | /usr/bin/grep {$fn} | /usr/bin/egrep -v '(pflog|grep)'")));
358

    
359
			if ($processcheck != "")
360
				$processisrunning = true;
361
			else
362
				$processisrunning = false;
363

    
364
			if (($action == gettext("Stop") or $action == "") and $processisrunning != true)
365
				echo "<input type=\"submit\" name=\"startbtn\" value=\"" . gettext("Start") . "\" />&nbsp;";
366
			else {
367
				echo "<input type=\"submit\" name=\"stopbtn\" value=\"" . gettext("Stop") . "\" />&nbsp;";
368
			}
369
			if (file_exists($fp.$fn) and $processisrunning != true) {
370
				echo "<input type=\"submit\" name=\"viewbtn\" value=\"" . gettext("View Capture") . "\" />&nbsp;";
371
				echo "<input type=\"submit\" name=\"downloadbtn\" value=\"" . gettext("Download Capture") . "\" />";
372
				echo "<br />" . gettext("The packet capture file was last updated:") . " " . date("F jS, Y g:i:s a.", filemtime($fp.$fn));
373
			}
374
?>
375
			</td>
376
		</tr>
377
	</table>
378
	</form>
379
	<table width="100%" border="0" cellpadding="6" cellspacing="0" summary="results">
380
		<tr>
381
		<td valign="top" colspan="2">
382
<?php
383
		echo "<font face=\"terminal\" size=\"2\">";
384
		if ($processisrunning == true)
385
			echo("<strong>" . gettext("Packet Capture is running.") . "</strong><br />");
386

    
387
		if ($do_tcpdump) {
388
			$matches = array();
389

    
390
			if (in_array($fam, $fams))
391
				$matches[] = $fam;
392

    
393
			if (in_array($proto, $protos)) {
394
				$matches[] = fixup_not($proto);
395
			}
396

    
397
			if ($port != "")
398
				$matches[] = "port ".fixup_not($port);
399

    
400
			if ($host != "") {
401
				$hostmatch = "";
402
				$hostcount = 0;
403
				foreach ($hosts as $h) {
404
					$h = fixup_host($h, $hostcount++);
405
					if (!empty($h))
406
						$hostmatch .= " " . $h;
407
				}
408
				if (!empty($hostmatch))
409
					$matches[] = "({$hostmatch})";
410
			}
411

    
412
			if ($count != "0" ) {
413
				$searchcount = "-c " . $count;
414
			} else {
415
				$searchcount = "";
416
			}
417

    
418
			$selectedif = convert_friendly_interface_to_real_interface_name($selectedif);
419

    
420
			if ($action == gettext("Start")) {
421
				$matchstr = implode($matches, " and ");
422
				echo("<strong>" . gettext("Packet Capture is running.") . "</strong><br />");
423
				$cmd = "/usr/sbin/tcpdump -i {$selectedif} {$disablepromiscuous} {$searchcount} -s {$snaplen} -w {$fp}{$fn} " . escapeshellarg($matchstr);
424
				// Debug
425
				//echo $cmd;
426
				mwexec_bg ($cmd);
427
			} else {
428
				//action = stop
429
				echo("<strong>" . gettext("Packet Capture stopped.") . "<br /><br />" . gettext("Packets Captured:") . "</strong><br />");
430
?>
431
				<script type="text/javascript">
432
				//<![CDATA[
433
				window.onload=function(){
434
					document.getElementById("packetsCaptured").wrap='off';
435
				}
436
				//]]>
437
				</script>
438
				<textarea id="packetsCaptured" style="width:98%" name="code" rows="15" cols="66" readonly="readonly">
439
<?php
440
				$detail_args = "";
441
				switch ($detail) {
442
				case "full":
443
					$detail_args = "-vv -e";
444
					break;
445
				case "high":
446
					$detail_args = "-vv";
447
					break;
448
				case "medium":
449
					$detail_args = "-v";
450
					break;
451
				case "normal":
452
				default:
453
					$detail_args = "-q";
454
					break;
455
				}
456
				system("/usr/sbin/tcpdump {$disabledns} {$detail_args} -r {$fp}{$fn}");
457

    
458
				conf_mount_ro();
459
?>
460
				</textarea>
461
<?php
462
			}
463
		}
464
?>
465
		&nbsp;</font>
466
		</td>
467
		</tr>
468
	</table>
469
	</td></tr>
470
</table>
471

    
472
<?php
473
include("fend.inc");
474
?>
475
</body>
476
</html>
(39-39/252)