Project

General

Profile

Download (48.5 KB) Statistics
| Branch: | Tag: | Revision:
1
<?php
2
/*
3
 * syslog.inc
4
 *
5
 * part of pfSense (https://www.pfsense.org)
6
 * Copyright (c) 2004-2013 BSD Perimeter
7
 * Copyright (c) 2013-2016 Electric Sheep Fencing
8
 * Copyright (c) 2014-2023 Rubicon Communications, LLC (Netgate)
9
 * All rights reserved.
10
 *
11
 * originally part of m0n0wall (http://m0n0.ch/wall)
12
 * Copyright (c) 2003-2004 Manuel Kasper <mk@neon1.net>.
13
 * All rights reserved.
14
 *
15
 * Licensed under the Apache License, Version 2.0 (the "License");
16
 * you may not use this file except in compliance with the License.
17
 * You may obtain a copy of the License at
18
 *
19
 * http://www.apache.org/licenses/LICENSE-2.0
20
 *
21
 * Unless required by applicable law or agreed to in writing, software
22
 * distributed under the License is distributed on an "AS IS" BASIS,
23
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
24
 * See the License for the specific language governing permissions and
25
 * limitations under the License.
26
 */
27

    
28
require_once('config.inc');
29
require_once('util.inc');
30

    
31
global $buffer_rules_rdr, $buffer_rules_normal;
32
$buffer_rules_rdr = array();
33
$buffer_rules_normal = array();
34

    
35
global $syslog_formats;
36
$syslog_formats = array(
37
	'rfc3164' => gettext('BSD (RFC 3164, default)'),
38
	'rfc5424' => gettext('syslog (RFC 5424, with RFC 3339 microsecond-precision timestamps)'),
39
);
40

    
41
function system_syslogd_fixup_server($server) {
42
	/* If it's an IPv6 IP alone, encase it in brackets */
43
	if (is_ipaddrv6($server)) {
44
		return "[$server]";
45
	} else {
46
		return $server;
47
	}
48
}
49

    
50
function system_syslogd_get_remote_servers($syslogcfg, $facility = "*.*") {
51
	// Rather than repeatedly use the same code, use this function to build a list of remote servers.
52
	$facility .= " ".
53
	$remote_servers = "";
54
	$pad_to  = max(strlen($facility), 56);
55
	$padding = ceil(($pad_to - strlen($facility))/8)+1;
56
	if (config_path_enabled('syslog')) {
57
		if (array_get_path($syslogcfg, 'remoteserver')) {
58
			$remote_servers .= "{$facility}" . str_repeat("\t", $padding) . "@" . system_syslogd_fixup_server(array_get_path($syslogcfg, 'remoteserver')) . "\n";
59
		}
60
		if (array_get_path($syslogcfg, 'remoteserver2')) {
61
			$remote_servers .= "{$facility}" . str_repeat("\t", $padding) . "@" . system_syslogd_fixup_server(array_get_path($syslogcfg, 'remoteserver2')) . "\n";
62
		}
63
		if (array_get_path($syslogcfg, 'remoteserver3')) {
64
			$remote_servers .= "{$facility}" . str_repeat("\t", $padding) . "@" . system_syslogd_fixup_server(array_get_path($syslogcfg, 'remoteserver3')) . "\n";
65
		}
66
	}
67
	return $remote_servers;
68
}
69

    
70
function system_syslogd_get_all_logfilenames($add_extension = false) {
71
	global $g, $system_log_files;
72

    
73
	if ($add_extension) {
74
		$all_syslog_files = array();
75
		foreach ($system_log_files as $syslogfile) {
76
			$all_syslog_files[] = "{$syslogfile}.log";
77
		}
78
	} else {
79
		$all_syslog_files = $system_log_files;
80
	}
81

    
82
	foreach (config_get_path('installedpackages/package', []) as $key => $package) {
83
		if (!empty(config_get_path("installedpackages/package/{$key}/logging", [])) &&
84
		    !empty(config_get_path("installedpackages/package/{$key}/logging/logfilename"))) {
85
			$all_syslog_files[] = config_get_path("installedpackages/package/{$key}/logging/logfilename");
86
		}
87
	}
88

    
89
	return $all_syslog_files;
90
}
91

    
92
/* For a given log filename prefix, return a list with the filename and
93
 * rotated copies sorted in a way that utilities such as cat/bzcat/bzgrep will
94
 * see all log entries in chronological order (e.g. name.log.2 name.log.1 name.log)
95
 */
96
function sort_related_log_files($logfile = "/var/log/system.log", $string = true, $escape = false) {
97
	$related_files = glob("{$logfile}*");
98
	usort($related_files, "rsort_log_filename");
99

    
100
	if ($escape) {
101
		$related_files = array_map("escapeshellarg", $related_files);
102
	}
103

    
104
	if ($string) {
105
		$related_files = implode(" ", $related_files);
106
	}
107

    
108
	return $related_files;
109
}
110

    
111
function rsort_log_filename($a, $b) {
112
	/* Break the filename up into components by '.', it could be in one
113
	 * Of the following formats:
114
	 * Compressed:   /var/log/<name>.log.<number>.<compressed extension>
115
	 * Uncompressed: /var/log/<name>.log.<number>
116
	 *
117
	 * See: https://redmine.pfsense.org/issues/11639
118
	 */
119
	$aparts = explode('.', $a);
120
	/* If the last part is not a number, it's a compressed log extension,
121
	 * pop it off. */
122
	if (!is_numeric($aparts[count($aparts)-1])) {
123
		array_pop($aparts);
124
	}
125

    
126
	$bparts = explode('.', $b);
127
	if (!is_numeric($bparts[count($bparts)-1])) {
128
		array_pop($bparts);
129
	}
130

    
131
	/* Compare the last entry in each filename array which should now be
132
	 * the log number */
133
	return ($aparts[count($aparts)-1] > $bparts[count($bparts)-1]) ? -1 : 1;
134
}
135

    
136
function clear_log_file($logfile = "/var/log/system.log", $restart_syslogd = true, $remove_rotated = true) {
137
	global $g;
138

    
139
	if ($restart_syslogd) {
140
		if (isvalidpid("{$g['varrun_path']}/syslog.pid")) {
141
			sigkillbypid("{$g['varrun_path']}/syslog.pid", "KILL");
142
		}
143
	}
144
	exec("/usr/bin/truncate -s 0 " . escapeshellarg($logfile));
145
	if ($remove_rotated) {
146
		unlink_if_exists("{$logfile}.*");
147
	}
148
	if ($restart_syslogd) {
149
		system_syslogd_start();
150
	}
151
	// Bug #6915
152
	if ($logfile == "/var/log/resolver.log") {
153
		services_unbound_configure(true);
154
	}
155
}
156

    
157
function clear_all_log_files($restart = false) {
158
	global $g, $system_log_files, $system_log_non_syslog_files;
159
	if ($restart) {
160
		if (isvalidpid("{$g['varrun_path']}/syslog.pid")) {
161
			sigkillbypid("{$g['varrun_path']}/syslog.pid", "KILL");
162
		}
163
	}
164

    
165
	/* Combine list of syslog and non-syslog log files */
166
	/* exclude dmesg.boot, see https://redmine.pfsense.org/issues/11428 */
167
	foreach (array_merge(system_syslogd_get_all_logfilenames(true), array_diff($system_log_non_syslog_files, array('dmesg.boot'))) as $lfile) {
168
		clear_log_file("{$g['varlog_path']}/{$lfile}", false);
169
	}
170

    
171
	if ($restart) {
172
		system_syslogd_start();
173
		killbyname("dhcpd");
174
		if (!function_exists('services_dhcpd_configure')) {
175
			require_once('services.inc');
176
		}
177
		services_dhcpd_configure();
178
		// Bug #6915
179
		services_unbound_configure(false);
180
	}
181
	return;
182
}
183

    
184
function system_syslogd_start($sighup = false) {
185
	global $g;
186
	if (config_path_enabled('system','developerspew')) {
187
		$mt = microtime();
188
		echo "system_syslogd_start() being called $mt\n";
189
	}
190

    
191
	mwexec("/etc/rc.d/hostid start");
192

    
193
	$syslogcfg = config_get_path('syslog', []);
194

    
195
	if (platform_booting()) {
196
		echo gettext("Starting syslog...");
197
	}
198

    
199
	$mainsyslogconf = <<<EOD
200
# Automatically generated, do not edit!
201
# Place configuration files in {$g['varetc_path']}/syslog.d
202
!*\n
203
include						{$g['varetc_path']}/syslog.d
204
# /* Manually added files with non-conflicting names will not be automatically removed */
205

    
206
EOD;
207

    
208
	if (!@file_put_contents("{$g['etc_path']}/syslog.conf", $mainsyslogconf)) {
209
		printf(gettext("Error: cannot open syslog.conf in system_syslogd_start().%s"), "\n");
210
		unset($syslogconf);
211
		return 1;
212
	}
213
	safe_mkdir("{$g['varetc_path']}/syslog.d");
214

    
215
	$syslogd_extra = "";
216
	$separatelogfacilities = array('ntp', 'ntpd', 'ntpdate', 'charon', 'ipsec_starter', 'openvpn', 'poes', 'l2tps', 'hostapd', 'dnsmasq', 'named', 'filterdns', 'unbound', 'dhcpd', 'dhcrelay', 'dhclient', 'dhcp6c', 'dpinger', 'radvd', 'routed', 'zebra', 'ospfd', 'ospf6d', 'bgpd', 'watchfrr', 'miniupnpd', 'igmpproxy', 'filterlog');
217
	$syslogconf = "# Automatically generated, do not edit!\n";
218

    
219
	foreach (config_get_path('installedpackages/package', []) as $key => $package) {
220
		$pkg_log_facility = config_get_path("installedpackages/package/{$key}/logging/facilityname");
221
		$pkg_log_filename = basename(config_get_path("installedpackages/package/{$key}/logging/logfilename"));
222

    
223
		if (!empty($pkg_log_facility) && !empty($pkg_log_filename)) {
224
			array_push($separatelogfacilities, $pkg_log_facility);
225
			$fn = "{$g['varlog_path']}/{$pkg_log_filename}";
226
			if (!is_file($fn)) {
227
				mwexec('/usr/bin/touch ' . escapeshellarg($fn));
228
			}
229
			$pkgsyslogconf = "# Automatically generated for package {$package['name']}. Do not edit.\n";
230
			$pkgsyslogconf .= "!{$pkg_log_facility}\n*.*\t\t\t\t\t\t {$fn}\n";
231
			@file_put_contents("{$g['varetc_path']}/syslog.d/" . basename($pkg_log_filename) . ".conf", $pkgsyslogconf);
232
		}
233
	}
234
	$facilitylist = implode(',', array_unique($separatelogfacilities));
235

    
236
	$syslogconf .= "!*\n";
237
	if (!config_path_enabled('syslog', 'disablelocallogging')) {
238
		$syslogconf .= "auth.*;authpriv.* 					{$g['varlog_path']}/auth.log\n";
239
	}
240
	if (config_path_enabled('syslog', 'auth')) {
241
		$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "auth.*;authpriv.*");
242
	}
243

    
244
	$syslogconf .= "!radvd\n";
245
	$radvdloglevel = ((config_path_enabled('system', 'radvddebug')) ? '*' : 'err');
246
	if (!config_path_enabled('syslog', 'disablelocallogging')) {
247
		$syslogconf .= "*.{$radvdloglevel}								{$g['varlog_path']}/routing.log\n";
248
	}
249
	if (config_path_enabled('syslog', 'routing')) {
250
		$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "!radvd.{$radvdloglevel}");
251
	}
252

    
253
	$syslogconf .= "!routed,zebra,ospfd,ospf6d,bgpd,watchfrr,miniupnpd,igmpproxy\n";
254
	if (!config_path_enabled('syslog', 'disablelocallogging')) {
255
		$syslogconf .= "*.*									{$g['varlog_path']}/routing.log\n";
256
	}
257
	if (config_path_enabled('syslog', 'routing')) {
258
		$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "*.*");
259
	}
260

    
261
	$syslogconf .= "!ntp,ntpd,ntpdate\n";
262
	if (!config_path_enabled('syslog', 'disablelocallogging')) {
263
		$syslogconf .= "*.*									{$g['varlog_path']}/ntpd.log\n";
264
	}
265
	if (config_path_enabled('syslog', 'ntpd')) {
266
		$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "*.*");
267
	}
268

    
269
	$syslogconf .= "!ppp\n";
270
	if (!config_path_enabled('syslog', 'disablelocallogging')) {
271
		$syslogconf .= "*.*									{$g['varlog_path']}/ppp.log\n";
272
	}
273
	if (config_path_enabled('syslog', 'ppp')) {
274
		$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "*.*");
275
	}
276

    
277
	$syslogconf .= "!poes\n";
278
	if (!config_path_enabled('syslog', 'disablelocallogging')) {
279
		$syslogconf .= "*.*									{$g['varlog_path']}/poes.log\n";
280
	}
281
	if (config_path_enabled('syslog', 'vpn')) {
282
		$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "*.*");
283
	}
284

    
285
	$syslogconf .= "!l2tps\n";
286
	if (!config_path_enabled('syslog', 'disablelocallogging')) {
287
		$syslogconf .= "*.*									{$g['varlog_path']}/l2tps.log\n";
288
	}
289
	if (config_path_enabled('syslog', 'vpn')) {
290
		$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "*.*");
291
	}
292

    
293
	$syslogconf .= "!charon,ipsec_starter\n";
294
	if (!config_path_enabled('syslog', 'disablelocallogging')) {
295
		$syslogconf .= "*.*									{$g['varlog_path']}/ipsec.log\n";
296
	}
297
	if (config_path_enabled('syslog', 'vpn')) {
298
		$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "*.*");
299
	}
300

    
301
	$syslogconf .= "!openvpn\n";
302
	if (!config_path_enabled('syslog', 'disablelocallogging')) {
303
		$syslogconf .= "*.*									{$g['varlog_path']}/openvpn.log\n";
304
	}
305
	if (config_path_enabled('syslog', 'vpn')) {
306
		$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "*.*");
307
	}
308

    
309
	$syslogconf .= "!dpinger\n";
310
	if (!config_path_enabled('syslog', 'disablelocallogging')) {
311
		$syslogconf .= "*.*									{$g['varlog_path']}/gateways.log\n";
312
	}
313
	if (config_path_enabled('syslog', 'dpinger')) {
314
		$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "*.*");
315
	}
316

    
317
	$syslogconf .= "!dnsmasq,named,filterdns,unbound\n";
318
	if (!config_path_enabled('syslog', 'disablelocallogging')) {
319
		$syslogconf .= "*.*									{$g['varlog_path']}/resolver.log\n";
320
	}
321
	if (config_path_enabled('syslog', 'resolver')) {
322
		$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "*.*");
323
	}
324

    
325
	$syslogconf .= "!dhcpd,dhcrelay,dhclient,dhcp6c,dhcpleases,dhcpleases6,kea-dhcp4,kea-dhcp6\n";
326
	if (!config_path_enabled('syslog', 'disablelocallogging')) {
327
		$syslogconf .= "*.*									{$g['varlog_path']}/dhcpd.log\n";
328
	}
329
	if (config_path_enabled('syslog', 'dhcp')) {
330
		$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "*.*");
331
	}
332

    
333
	$syslogconf .= "!hostapd\n";
334
	if (!config_path_enabled('syslog', 'disablelocallogging')) {
335
		$syslogconf .= "*.* 								{$g['varlog_path']}/wireless.log\n";
336
	}
337
	if (config_path_enabled('syslog', 'hostapd')) {
338
		$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "*.*");
339
	}
340

    
341
	$syslogconf .= "!filterlog\n";
342
	if (!config_path_enabled('syslog', 'disablelocallogging')) {
343
		$syslogconf .= "*.* 								{$g['varlog_path']}/filter.log\n";
344
	}
345
	if (config_path_enabled('syslog', 'filter')) {
346
		$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "*.*");
347
	}
348

    
349
	$syslogconf .= "!logportalauth\n";
350
	if (!config_path_enabled('syslog', 'disablelocallogging')) {
351
		$syslogconf .= "*.* 								{$g['varlog_path']}/portalauth.log\n";
352
	}
353
	if (config_path_enabled('syslog', 'portalauth')) {
354
		$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "*.*");
355
	}
356

    
357
	$syslogconf .= "!-{$facilitylist}\n";
358
	if (!config_path_enabled('syslog', 'disablelocallogging')) {
359
		$syslogconf .= <<<EOD
360
local3.*							{$g['varlog_path']}/vpn.log
361
local5.*							{$g['varlog_path']}/nginx.log
362
*.notice;kern.debug;lpr.info;mail.crit;daemon.none;news.err;local0.none;local3.none;local4.none;local7.none;security.*;auth.info;authpriv.info;daemon.info	{$g['varlog_path']}/system.log
363
auth.info;authpriv.info 			|exec /usr/local/sbin/sshguard -i /var/run/sshguard.pid
364
*.emerg								*
365

    
366
EOD;
367
	}
368
	if (config_path_enabled('syslog', 'vpn')) {
369
		$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "local3.*");
370
	}
371
	if (config_path_enabled('syslog', 'system')) {
372
		$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "*.emerg;*.notice;kern.debug;lpr.info;mail.crit;news.err;local0.none;local3.none;local7.none;security.*;auth.info;authpriv.info;daemon.info");
373
	}
374
	if (config_path_enabled('syslog', 'logall')) {
375
		// Make everything mean everything, including facilities excluded above.
376
		$syslogconf .= "!*\n";
377
		$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "*.*");
378
	}
379

    
380
	/* write syslog config to pfSense.conf */
381
	if (!@file_put_contents("{$g['varetc_path']}/syslog.d/pfSense.conf", $syslogconf)) {
382
		printf(gettext("Error: cannot open syslog config file in system_syslogd_start().%s"), "\n");
383
		unset($syslogconf);
384
		return 1;
385
	}
386
	unset($syslogconf);
387

    
388
	$sourceip = config_get_path('syslog/sourceip');
389
	if (config_path_enabled('syslog') &&
390
	    !empty($sourceip)) {
391
		if (config_get_path('syslog/ipproto') == "ipv6") {
392
			$ifaddr = is_ipaddr($sourceip) ? $sourceip : get_interface_ipv6($sourceip);
393
			if (!is_ipaddr($ifaddr)) {
394
				$ifaddr = get_interface_ip($sourceip);
395
			}
396
		} else {
397
			$ifaddr = is_ipaddr($sourceip) ? $sourceip : get_interface_ip($sourceip);
398
			if (!is_ipaddr($ifaddr)) {
399
				$ifaddr = get_interface_ipv6($sourceip);
400
			}
401
		}
402
		$sourceip = is_ipaddr($ifaddr) ? "-b {$ifaddr}" : '';
403
	} else {
404
		$sourceip = '';
405
	}
406
	$syslogd_extra = "-f {$g['etc_path']}/syslog.conf {$sourceip}";
407

    
408
	$log_sockets = array("{$g['dhcpd_chroot_path']}/var/run/log");
409

    
410
	foreach (config_get_path('installedpackages/package', []) as $key => $package) {
411
		$pkg_log_socket = config_get_path("installedpackages/package/{$key}/logging/logsocket");
412
		if (!empty($pkg_log_socket) &&
413
		    !in_array($pkg_log_socket, $log_sockets)) {
414
			$log_sockets[] = $package['logging']['logsocket'];
415
		}
416
	}
417

    
418
	$syslogd_format = empty(config_get_path('syslog/format')) ? '' : '-O ' . escapeshellarg(config_get_path('syslog/format'));
419

    
420
	$syslogd_sockets = "";
421
	foreach ($log_sockets as $log_socket) {
422
		// Ensure that the log directory exists
423
		$logpath = dirname($log_socket);
424
		safe_mkdir($logpath);
425
		$syslogd_sockets .= " -l {$log_socket}";
426
	}
427

    
428
	/* Setup log rotation */
429
	system_log_rotation_setup();
430

    
431
	/* If HUP was requested, but syslogd is not running, restart it instead. */
432
	if ($sighup && !isvalidpid("{$g['varrun_path']}/syslog.pid")) {
433
		$sighup = false;
434
	}
435

    
436
	$sshguard_whitelist = array();
437
	if (!empty(config_get_path('system/sshguard_whitelist'))) {
438
		$sshguard_whitelist = explode(' ',
439
		    config_get_path('system/sshguard_whitelist'));
440
	}
441

    
442
	$sshguard_config = array();
443
	$sshguard_config[] = 'LOGREADER="/bin/cat"' . "\n";
444
	$sshguard_config[] = 'BACKEND="/usr/local/libexec/sshg-fw-pf"' . "\n";
445
	if (!empty(config_get_path('system/sshguard_threshold'))) {
446
		$sshguard_config[] = 'THRESHOLD=' .
447
		    config_get_path('system/sshguard_threshold') . "\n";
448
	}
449
	if (!empty(config_get_path('system/sshguard_blocktime'))) {
450
		$sshguard_config[] = 'BLOCK_TIME=' .
451
		    config_get_path('system/sshguard_blocktime') . "\n";
452
	}
453
	if (!empty(config_get_path('system/sshguard_detection_time'))) {
454
		$sshguard_config[] = 'DETECTION_TIME=' .
455
		    config_get_path('system/sshguard_detection_time') . "\n";
456
	}
457
	if (!empty($sshguard_whitelist)) {
458
		@file_put_contents("/usr/local/etc/sshguard.whitelist",
459
		    implode(PHP_EOL, $sshguard_whitelist));
460
		$sshguard_config[] =
461
		    'WHITELIST_FILE=/usr/local/etc/sshguard.whitelist' . "\n";
462
	} else {
463
		unlink_if_exists("/usr/local/etc/sshguard.whitelist");
464
	}
465
	file_put_contents("/usr/local/etc/sshguard.conf", $sshguard_config);
466

    
467
	if (!$sighup) {
468
		sigkillbyname("sshguard", "TERM");
469
		if (isvalidpid("{$g['varrun_path']}/syslog.pid")) {
470
			sigkillbypid("{$g['varrun_path']}/syslog.pid", "TERM");
471
			usleep(100000); // syslogd often doesn't respond to a TERM quickly enough for the starting of syslogd below to be successful
472
		}
473

    
474
		if (isvalidpid("{$g['varrun_path']}/syslog.pid")) {
475
			// if it still hasn't responded to the TERM, KILL it.
476
			sigkillbypid("{$g['varrun_path']}/syslog.pid", "KILL");
477
			usleep(100000);
478
		}
479

    
480
		$retval = mwexec_bg("/usr/sbin/syslogd {$syslogd_format} -s -c -c {$syslogd_sockets} -P {$g['varrun_path']}/syslog.pid {$syslogd_extra}");
481
	} else {
482
		$retval = sigkillbypid("{$g['varrun_path']}/syslog.pid", "HUP");
483
	}
484

    
485
	if (platform_booting()) {
486
		echo gettext("done.") . "\n";
487
	}
488

    
489
	return $retval;
490
}
491

    
492
function system_log_get_compression() {
493
	global $g, $system_log_compression_types;
494
	$compressiontype = config_get_path('syslog/logcompressiontype');
495
	if (empty($compressiontype) ||
496
	    !array_key_exists($compressiontype, $system_log_compression_types)) {
497
		if (file_exists("{$g['conf_path']}/syslog_default_uncompressed")) {
498
			/* Disable log compression by default when flag file is present. */
499
			$compressiontype = 'none';
500
		} else {
501
			/* Default is bzip2 */
502
			$compressiontype = 'bzip2';
503
		}
504
	}
505
	return $compressiontype;
506
}
507

    
508
function system_log_get_cat() {
509
	global $system_log_compression_types;
510
	return $system_log_compression_types[system_log_get_compression()]['cat'];
511
}
512

    
513
/* Setup newsyslog log rotation */
514
function system_log_rotation_setup() {
515
	global $g, $system_log_files, $system_log_compression_types;
516
	$syslogcfg = config_get_path('syslog', []);
517

    
518
	$mainnewsyslogconf = <<<EOD
519
# Automatically generated, do not edit!
520
# Place configuration files in {$g['varetc_path']}/newsyslog.conf.d
521
<include> {$g['varetc_path']}/newsyslog.conf.d/*
522
# /* Manually added files with non-conflicting names will not be automatically removed */
523

    
524
EOD;
525

    
526
	file_put_contents("{$g['etc_path']}/newsyslog.conf", $mainnewsyslogconf);
527
	safe_mkdir("{$g['varetc_path']}/newsyslog.conf.d");
528

    
529
	$log_size = config_get_path('syslog/logfilesize', g_get('default_log_size'));
530
	$log_size = ($log_size < (2**32)/2) ? $log_size : g_get('default_log_size');
531
	$log_size = (int)$log_size/1024;
532

    
533
	$rotatecount = config_get_path('syslog/rotatecount', 7);
534
	$rotatecount = is_numericint($rotatecount) ? $rotatecount : 7;
535

    
536
	$compression_flag = $system_log_compression_types[system_log_get_compression()]['flag'];
537

    
538
	$separatelogfacilities = array('ntp', 'ntpd', 'ntpdate', 'charon', 'ipsec_starter', 'openvpn', 'poes', 'l2tps', 'hostapd', 'dnsmasq', 'named', 'filterdns', 'unbound', 'dhcpd', 'dhcrelay', 'dhclient', 'dhcp6c', 'dpinger', 'radvd', 'routed', 'zebra', 'ospfd', 'ospf6d', 'bgpd', 'watchfrr', 'miniupnpd', 'igmpproxy', 'filterlog');
539
	$newsyslogconf = <<<EOD
540
/var/log/userlog		root:wheel	600	3	{$log_size}	*	B
541
/var/log/utx.log		root:wheel	644	3	{$log_size}	*	B
542

    
543
EOD;
544

    
545
	foreach (config_get_path('installedpackages/package', []) as $key => $package) {
546
		if (!empty(config_get_path("installedpackages/package/{$key}/logging", [])) &&
547
		    !empty(config_get_path("installedpackages/package/{$key}/logging/logfilename"))) {
548
			$pkg_log_filename = config_get_path("installedpackages/package/{$key}/logging/logfilename");
549
			$pkg_log_owner = config_get_path("installedpackages/package/{$key}/logging/logowner", 'root:wheel');
550
			$pkg_log_mode = config_get_path("installedpackages/package/{$key}/logging/logmode", '600');
551
			$pkg_rotate_count = (int) config_get_path("installedpackages/package/{$key}/logging/rotatecount", $rotatecount);
552
			$pkg_log_size = (int) config_get_path("installedpackages/package/{$key}/logging/logfilesize", 0);
553
			$pkg_log_size = ($pkg_log_size > 0) ? $pkg_log_size / 1024 : $log_size;
554
			$pkg_rotate_time = config_get_path("installedpackages/package/{$key}/logging/rotatetime", '*');
555
			$pkg_extra_flags = config_get_path("installedpackages/package/{$key}/logging/rotateflags", '');
556
			$pkg_pidcmd = config_get_path("installedpackages/package/{$key}/logging/pidcmd", '');
557
			$pkg_signal = config_get_path("installedpackages/package/{$key}/logging/signal", '');
558

    
559
			$pkgnewsyslogconf = "# Automatically generated for package {$package['name']}. Do not edit.\n";
560
			$pkgnewsyslogconf .= system_log_rotation_make_line("{$g['varlog_path']}/{$pkg_log_filename}",
561
										$pkg_log_owner,
562
										$pkg_log_mode,
563
										$pkg_rotate_count,
564
										$pkg_log_size,
565
										$pkg_rotate_time,
566
										"{$compression_flag}C{$pkg_extra_flags}",
567
										$pkg_pidcmd,
568
										$pkg_signal);
569
			@file_put_contents("{$g['varetc_path']}/newsyslog.conf.d/" . basename($pkg_log_filename) . ".conf", $pkgnewsyslogconf);
570
		}
571
	}
572

    
573
	foreach($system_log_files as $logfile) {
574
		$local_log_size = (int) config_get_path("syslog/" . basename($logfile, '.log') . "_settings/logfilesize", 0);
575
		$local_log_size = ($local_log_size > 0) ? $local_log_size / 1024 : $log_size;
576
		$local_rotate_count = (int) config_get_path("syslog/" . basename($logfile, '.log') . "_settings/rotatecount", $rotatecount);
577

    
578
		$newsyslogconf .= system_log_rotation_make_line("{$g['varlog_path']}/{$logfile}.log", 'root:wheel', 600, $local_rotate_count, $local_log_size, '*', "{$compression_flag}C");
579
	}
580

    
581
	if (!@file_put_contents("{$g['varetc_path']}/newsyslog.conf.d/pfSense.conf", $newsyslogconf)) {
582
		printf(gettext("Error: cannot open syslog config file in system_log_rotation_setup().%s"), "\n");
583
	}
584
	unset($newsyslogconf);
585
}
586

    
587
function system_log_rotation_make_line($filename, $owner = 'root:wheel', $mode='644', $count=7, $size=1000, $time='*', $flags='C', $pidcmd = '', $signal = '') {
588
	/* TODO: Fix default size, flags, etc. */
589
	$nslline = $filename;
590
	$nslline .= "		{$owner}";
591
	$nslline .= "	{$mode}";
592
	$nslline .= "	{$count}";
593
	$nslline .= "	{$size}";
594
	$nslline .= "	{$time}";
595
	$nslline .= "	{$flags}";
596
	if (!empty($pidcmd)) {
597
		$nslline .= "	{$pidcmd}";
598
	}
599
	if (!empty($signal)) {
600
		$nslline .= "	{$signal}";
601
	}
602
	$nslline .= "\n";
603
	return $nslline;
604
}
605

    
606
function dump_log($logfile, $tail, $withorig = true, $grepfor = "", $grepinvert = "", $format = 'table', $grepreverse = false) {
607
	global $g;
608
	$sor = (config_path_enabled('syslog', 'reverse') || $grepreverse) ? "-r" : "";
609
	$specific_log = basename($logfile, '.log') . '_settings';
610
	$cronorder = config_get_path("syslog/{$specific_log}/cronorder");
611
	if (($cronorder == 'forward') && !$grepreverse) {
612
		$sor = "";
613
	}
614
	if (($cronorder == 'reverse') ||  $grepreverse) {
615
		$sor = "-r";
616
	}
617
	$logarr = array();
618
	$grepline = "  ";
619
	if (is_array($grepfor)) {
620
		$invert = '';
621
		if ((strpos($grepfor[0], '!') === 0)) {
622
			$grepfor[0] = substr($grepfor[0], 1);
623
			$invert = '-v';
624
		}
625
		/* Ensure the user-supplied filter is sane */
626
		$filtertext = cleanup_regex_pattern(implode("|", $grepfor));
627
		if (!empty($filtertext)) {
628
			$grepline .= " | /usr/bin/egrep {$invert} -- " . escapeshellarg($filtertext);
629
		}
630
	}
631
	if (is_array($grepinvert)) {
632
		/* Ensure the user-supplied filter is sane */
633
		$filtertext = cleanup_regex_pattern(implode("|", $grepinvert));
634
		if (!empty($filtertext)) {
635
			$grepline .= " | /usr/bin/egrep -v -- " . escapeshellarg($filtertext);
636
		}
637
	}
638
	if (is_dir($logfile)) {
639
		$logarr = array(sprintf(gettext("File %s is a directory."), $logfile));
640
	} elseif (file_exists($logfile) && filesize($logfile) == 0) {
641
		$logarr = array(gettext("Log file started."));
642
	} else {
643
		exec(system_log_get_cat() . ' ' . sort_related_log_files($logfile, true, true) . "{$grepline} | /usr/bin/tail {$sor} -n " . escapeshellarg($tail), $logarr);
644
	}
645

    
646
	if ($format == 'none') {
647
		return($logarr);
648
	}
649

    
650
	$rows = 0;
651
	foreach ($logarr as $logent) {
652
		$rows++;
653
		$entry_date_time = "";
654

    
655
		/* Determine log entry content */
656
		$splitlogent = preg_split("/\s+/", $logent, 10);
657
		if (strpos($splitlogent[0], '>') === false) {
658
			/* RFC 3164 Format */
659
			$syslogformat = 'rfc3164';
660
		} else {
661
			/* RFC 5424 Format */
662
			$syslogformat = 'rfc5424';
663
		}
664

    
665
		if ($format == 'raw') {
666
			$entry_text = $logent;
667
		} elseif ($withorig) {
668
			if ($syslogformat == 'rfc3164') {
669
				$entry_date_time = htmlspecialchars(join(" ", array_slice($splitlogent, 0, 3)));
670
				$entry_text = ($splitlogent[3] == config_get_path('system/hostname')) ? "" : $splitlogent[3] . " ";
671
				$entry_text .= implode(' ', array_slice($splitlogent, 4));
672
			} else {
673
				$entry_date_time = htmlspecialchars($splitlogent[1]);
674
				$entry_text = ($splitlogent[2] == config_get_path('system/hostname') . '.' . config_get_path('system/domain')) ? '' : $splitlogent[2] . ' ';
675
				$entry_text .= implode(' ', array_slice($splitlogent, 3));
676
			}
677
		} else {
678
			$entry_text = implode(' ', array_slice($splitlogent, ($syslogformat == 'rfc3164') ? 5 : 9));
679
		}
680
		$entry_text = htmlspecialchars($entry_text);
681

    
682
		/* Output content in desired format. */
683
		switch ($format) {
684
			case 'notable':
685
				echo implode(' ', array($entry_date_time, $entry_text)) . "\n";
686
				break;
687
			case 'raw':
688
				$span = 'colspan="2"';
689
			case 'table':
690
			default:
691
				echo "<tr>\n";
692
				if (!empty($entry_date_time)) {
693
					echo "	<td class=\"text-nowrap\">{$entry_date_time}</td>\n";
694
				}
695
				echo "	<td {$span} style=\"word-wrap:break-word; word-break:break-all; white-space:normal\">{$entry_text}</td>\n";
696
				echo "</tr>\n";
697
				break;
698
		}
699
	}
700

    
701
	return($rows);
702
}
703

    
704
/* format filter logs */
705
function conv_log_filter($logfile, $nentries, $tail = 500, $filtertext = "", $filterinterface = null) {
706
	global $g, $pattern;
707

    
708
	/* Make sure this is a number before using it in a system call */
709
	if (!(is_numeric($tail))) {
710
		return;
711
	}
712

    
713
	/* Safety belt to ensure we get enough lines for filtering without overloading the parsing code */
714
	if ($filtertext) {
715
		$tail = 10000;
716
	}
717

    
718
	/* Always do a reverse tail, to be sure we're grabbing the 'end' of the log. */
719
	$logarr = "";
720

    
721
	$logtypecheck = preg_replace('/\.log$/', '', basename($logfile));
722
	if (in_array($logtypecheck, array('system', 'gateways', 'routing', 'resolver', 'wireless', 'nginx', 'dmesg.boot', 'portalauth', 'dhcpd', 'ipsec', 'ppp', 'openvpn', 'ntpd', 'userlog', 'auth'))) {
723
		$logfile_type = "system";
724
	} elseif (in_array($logtypecheck, array('filter'))) {
725
		$logfile_type = "firewall";
726
	} elseif (in_array($logtypecheck, array('vpn'))) {
727
		$logfile_type = "vpn_login";
728
	} elseif (in_array($logtypecheck, array('poes', 'l2tps'))) {
729
		$logfile_type = "vpn_service";
730
	} elseif (in_array($logtypecheck, array('utx'))) {
731
		$logfile_type = "utx";
732
	} else {
733
		$logfile_type = "unknown";
734
	}
735

    
736
# Common Regular Expression Patterns
737
	$base_patterns = array(
738
		'rfc3164' => array('start_pattern' => "^"),
739
		'rfc5424' => array('start_pattern' => "^<[0-9]{1,3}>[0-9]*\ "),
740
	);
741

    
742
	/* bsd log date */
743
	$base_patterns['rfc3164']['date_pattern'] = "\([a-zA-Z]{3}\ +[0-9]{1,2}\ +[0-9]{2}:[0-9]{2}:[0-9]{2}\)";
744
	/* RFC3339 Extended format date */
745
	$base_patterns['rfc5424']['date_pattern'] = "\((?:[0-9]+)-(?:0[1-9]|1[012])-(?:0[1-9]|[12][0-9]|3[01])[Tt](?:[01][0-9]|2[0-3]):(?:[0-5][0-9]):(?:[0-5][0-9]|60)(?:\.[0-9]+)?(?:(?:[Zz])|(?:[\+|\-](?:[01][0-9]|2[0-3]):[0-5][0-9]))\)";
746

    
747
	/* hostname only, might not be present */
748
	$base_patterns['rfc3164']['host_pattern'] = "\(.*?\)";
749
	/* FQDN, always present */
750
	$base_patterns['rfc5424']['host_pattern'] = "\(\S+?\)";
751

    
752
	/* name[pid]:, pid may not be present */
753
	$base_patterns['rfc3164']['process_pattern'] = "\(.*?\)\(?::\ +\)?";
754
	/* name alone, nothing special */
755
	$base_patterns['rfc5424']['process_pattern'] = "\(\S+?\)\ ";
756

    
757
	/* pid in brackets, may not be present */
758
	$base_patterns['rfc3164']['pid_pattern'] = "\(?:\\\[\([0-9:]*\)\\\]\)?:?";
759
	/* pid (which we want) alone, always present but may be '-', message ID is next, but we ignore it */
760
	$base_patterns['rfc5424']['pid_pattern'] = "\(\S+?\)\ \S+?\ \S+?";
761

    
762
	/* match anything from here on */
763
	$base_patterns['rfc3164']['log_message_pattern'] = "\(.*\)";
764
	$base_patterns['rfc5424']['log_message_pattern'] = "\(.*\)";
765

    
766
	$patterns = array(
767
		'rfc3164' => $base_patterns['rfc3164']['start_pattern'],
768
		'rfc5424' => $base_patterns['rfc5424']['start_pattern'],
769
	);
770

    
771
	# Construct RegEx for specific log file type.
772
	switch ($logfile_type) {
773
		case 'firewall':
774
			$patterns['rfc3164'] = "filterlog\[[0-9]+\]:";
775
			$patterns['rfc5424'] = "filterlog";
776
			break;
777
		case 'system':
778
		case 'vpn_service':
779
			$patterns['rfc3164'] .= $base_patterns['rfc3164']['date_pattern'] . "\ +" .
780
						$base_patterns['rfc3164']['host_pattern'] . "\ +" .
781
						$base_patterns['rfc3164']['process_pattern'] .
782
						$base_patterns['rfc3164']['pid_pattern'] . "\ +" .
783
						$base_patterns['rfc3164']['log_message_pattern'] . "$";
784
			$patterns['rfc5424'] .= $base_patterns['rfc5424']['date_pattern'] . "\ " .
785
						$base_patterns['rfc5424']['host_pattern'] . "\ " .
786
						$base_patterns['rfc5424']['process_pattern'] .
787
						$base_patterns['rfc5424']['pid_pattern'] . "\ " .
788
						$base_patterns['rfc5424']['log_message_pattern'] . "$";
789
			break;
790
		case 'vpn_login':
791
			$action_pattern = "\(.*?\)";
792
			$type_pattern = "\(.*?\)";
793
			$ip_address_pattern = "\(.*?\)";
794
			$user_pattern = "\(.*?\)";
795
			$patterns['rfc3164'] .= $base_patterns['rfc3164']['date_pattern'] . "\ +" .
796
						$base_patterns['rfc3164']['host_pattern'] . "\ +" .
797
						$base_patterns['rfc3164']['process_pattern'] . "\ +" .
798
						"\(.*?\)\,\ *" .
799
						"\(.*?\)\,\ *" .
800
						"\(.*?\)\,\ *" .
801
						"\(.*?\)$";
802
			$patterns['rfc5424'] .= $base_patterns['rfc5424']['date_pattern'] . "\ " .
803
						$base_patterns['rfc5424']['host_pattern'] . "\ " .
804
						$base_patterns['rfc5424']['process_pattern'] .
805
						"\S+?\ \S+?\ \S+?\ " .
806
						"\(\S*?\)\,\ *" .
807
						"\(\S*?\)\,\ *" .
808
						"\(\S*?\)\,\ *" .
809
						"\(\S*?\)$";
810
			break;
811
		case 'unknown':
812
			$patterns['rfc3164'] .= $base_patterns['rfc3164']['date_pattern'] . "*\ +" .
813
						$base_patterns['rfc3164']['log_message_pattern'] . "$";
814
			$patterns['rfc5424'] .= $base_patterns['rfc5424']['date_pattern'] . "*\ " .
815
						$base_patterns['rfc5424']['log_message_pattern'] . "$";
816
			break;
817
		default:
818
			$patterns['rfc3164'] .= "\(.*\)$";
819
			$patterns['rfc5424'] .= "\(.*\)$";
820
	}
821

    
822
	if ($logfile_type != 'utx') {
823
		# Get a bunch of log entries.
824
		exec(system_log_get_cat() . ' ' . sort_related_log_files($logfile, true, true) . " | /usr/bin/tail -r -n {$tail}", $logarr);
825
	} else {
826
		$_gb = exec("/usr/bin/last --libxo=json", $rawdata, $rc);
827
		if ($rc == 0) {
828
			$logarr = json_decode(implode(" ", $rawdata), JSON_OBJECT_AS_ARRAY);
829
			$logarr = $logarr['last-information']['last'];
830
		}
831
	}
832

    
833
	# Remove escapes and fix up the pattern for preg_match.
834
	$patterns['rfc3164'] = '/' . str_replace(array('\(', '\)', '\[', '\]'), array('(', ')', '[', ']'), $patterns['rfc3164']) . '/';
835
	$patterns['rfc5424'] = '/' . str_replace(array('\(', '\)', '\[', '\]'), array('(', ')', '[', ']'), $patterns['rfc5424']) . '/';
836

    
837
	$filterlog = array();
838
	$counter = 0;
839

    
840
	$filterinterface = strtoupper($filterinterface);
841
	foreach ($logarr as $logent) {
842
		if ($counter >= $nentries) {
843
			break;
844
		}
845
		if ($logfile_type != 'utx') {
846
			$pattern = (substr($logent, 0, 1) == '<') ? $patterns['rfc5424'] : $patterns['rfc3164'];
847
		}
848
		switch($logfile_type) {
849
			case 'firewall':
850
				$flent = parse_firewall_log_line($logent);
851
				break;
852
			case 'system':
853
				$flent = parse_system_log_line($logent);
854
				break;
855
			case 'vpn_login':
856
				$flent = parse_vpn_login_log_line($logent);
857
				break;
858
			case 'vpn_service':
859
				$flent = parse_vpn_service_log_line($logent);
860
				break;
861
			case 'utx':
862
				$flent = parse_utx_log_line($logent);
863
				break;
864
			case 'unknown':
865
				$flent = parse_unknown_log_line($logent);
866
				break;
867
			default:
868
				$flent = array();
869
				break;
870
		}
871

    
872
		if (!$filterinterface || ($filterinterface == $flent['interface'])) {
873
			if ((($flent != "") && (!is_array($filtertext)) && (match_filter_line($flent, $filtertext))) ||
874
			    (($flent != "") && (is_array($filtertext)) && (match_filter_field($flent, $filtertext)))) {
875
				$counter++;
876
				$filterlog[] = $flent;
877
			}
878
		}
879
	}
880
	/* Since the lines are in reverse order, flip them around if needed based on the user's preference */
881
	# First get the "General Logging Options" (global) chronological order setting.  Then apply specific log override if set.
882
	$reverse = config_path_enabled('syslog','reverse');
883
	$specific_log = basename($logfile, '.log') . '_settings';
884
	$cronorder = config_get_path("syslog/{$specific_log}/cronorder");
885
	if ($cronorder == 'forward') {
886
		$reverse = false;
887
	}
888
	if ($cronorder == 'reverse') {
889
		$reverse = true;
890
	}
891

    
892
	return ($reverse) ? $filterlog : array_reverse($filterlog);
893
}
894

    
895
function match_filter_line($flent, $filtertext = "") {
896
	if (!$filtertext) {
897
		return true;
898
	}
899
	$filtertext = escape_filter_regex(str_replace(' ', '\s+', $filtertext));
900
	return @preg_match("/{$filtertext}/i", implode(" ", array_values($flent)));
901
}
902

    
903
function match_filter_field($flent, $fields) {
904
	foreach ($fields as $key => $field) {
905
		if ($field == "All") {
906
			continue;
907
		}
908
		if ((strpos($field, '!') === 0)) {
909
			$field = substr($field, 1);
910
			if (strtolower($key) == 'act') {
911
				if (in_arrayi($flent[$key], explode(" ", $field))) {
912
					return false;
913
				}
914
			} else {
915
				$field_regex = escape_filter_regex($field);
916
				if (@preg_match("/{$field_regex}/i", $flent[$key])) {
917
					return false;
918
				}
919
			}
920
		} else {
921
			if (strtolower($key) == 'act') {
922
				if (!in_arrayi($flent[$key], explode(" ", $field))) {
923
					return false;
924
				}
925
			} else {
926
				$field_regex = escape_filter_regex($field);
927
				if (!@preg_match("/{$field_regex}/i", $flent[$key])) {
928
					return false;
929
				}
930
			}
931
		}
932
	}
933
	return true;
934
}
935

    
936
// Case Insensitive in_array function
937
function in_arrayi($needle, $haystack) {
938
	return in_array(strtolower($needle), array_map('strtolower', $haystack));
939
}
940

    
941
function parse_vpn_login_log_line($line) {
942
	global $g, $pattern;
943

    
944
	$flent = array();
945
	$log_split = "";
946

    
947
	if (!preg_match($pattern, $line, $log_split))
948
		return "";
949

    
950
	list($all, $flent['time'], $flent['host'], $flent['process'], $flent['action'], $flent['type'], $flent['ip_address'], $flent['user']) = $log_split;
951
	$flent['time'] = str_replace('T', ' ', $flent['time']);
952

    
953
	/* If there is time, action, user, and IP address fields, then the line should be usable/good */
954
	if (!( (trim($flent['time']) == "") && (trim($flent['action']) == "") && (trim($flent['user']) == "") && (trim($flent['ip_address']) == "") )) {
955
		return $flent;
956
	} else {
957
		if (g_get('debug')) {
958
			log_error(sprintf(gettext("There was a error parsing log entry: %s. Please report to mailing list or forum."), $line));
959
		}
960
		return "";
961
	}
962
}
963

    
964
function parse_vpn_service_log_line($line) {
965
	global $g, $pattern;
966

    
967
	$flent = array();
968
	$log_split = "";
969

    
970
	if (!preg_match($pattern, $line, $log_split))
971
		return "";
972

    
973
	list($all, $flent['time'], $flent['host'], $flent['type'], $flent['pid'], $flent['message']) = $log_split;
974
	$flent['time'] = str_replace('T', ' ', $flent['time']);
975

    
976
	/* If there is time, type, and message fields, then the line should be usable/good */
977
	if (!( (trim($flent['time']) == "") && (trim($flent['type']) == "") && (trim($flent['message']) == "") )) {
978
		return $flent;
979
	} else {
980
		if (g_get('debug')) {
981
			log_error(sprintf(gettext("There was a error parsing log entry: %s. Please report to mailing list or forum."), $line));
982
		}
983
		return "";
984
	}
985
}
986

    
987
function parse_utx_log_line($line) {
988
	$flent['time'] = "{$line['login-time']}";
989
	if ($line['logout-time']) {
990
		$flent['time'] .= " - {$line['logout-time']}";
991
	}
992
	$flent['host'] = $line['from'];
993
	$flent['pid'] = $line['tty'];
994
	$flent['message'] = $line['user'];
995
	if ($line['session-length']) {
996
		$flent['process'] = $line['session-length'];
997
	}
998
	return $flent;
999
}
1000

    
1001
function parse_unknown_log_line($line) {
1002
	global $g, $pattern;
1003

    
1004
	$flent = array();
1005
	$log_split = "";
1006

    
1007
	if (!preg_match($pattern, $line, $log_split)) {
1008
		return "";
1009
	}
1010

    
1011
	list($all, $flent['time'], $flent['message']) = $log_split;
1012
	$flent['time'] = str_replace('T', ' ', $flent['time']);
1013

    
1014
	/* If there is time, and message, fields, then the line should be usable/good */
1015
	if (!((trim($flent['time']) == "") && (trim($flent['message']) == ""))) {
1016
		return $flent;
1017
	} else {
1018
		if (g_get('debug')) {
1019
			log_error(sprintf(gettext("There was a error parsing log entry: %s. Please report to mailing list or forum."), $line));
1020
		}
1021
		return "";
1022
	}
1023
}
1024

    
1025
function parse_system_log_line($line) {
1026
	global $g, $pattern;
1027

    
1028
	$flent = array();
1029
	$log_split = "";
1030

    
1031
	if (!preg_match($pattern, $line, $log_split)) {
1032
		return "";
1033
	}
1034

    
1035
	list($all, $flent['time'], $flent['host'], $flent['process'], $flent['pid'], $flent['message']) = $log_split;
1036
	$flent['time'] = str_replace('T', ' ', $flent['time']);
1037

    
1038
	/* If there is time, process, and message, fields, then the line should be usable/good */
1039
	if (!((trim($flent['time']) == "") && (trim($flent['process']) == "") && (trim($flent['message']) == ""))) {
1040
		return $flent;
1041
	} else {
1042
		if (g_get('debug')) {
1043
			log_error(sprintf(gettext("There was a error parsing log entry: %s. Please report to mailing list or forum."), $line));
1044
		}
1045
		return "";
1046
	}
1047
}
1048

    
1049
function parse_firewall_log_line($line) {
1050
	global $g;
1051

    
1052
	$flent = array();
1053
	$log_split = "";
1054

    
1055
	if (substr($line, 0, 1) == '<') {
1056
		/* RFC 5424 */;
1057
		$pattern = "/^<[0-9]{1,3}>[0-9]*\ (\S+?)\ (\S+?)\ filterlog\ \S+?\ \S+?\ \S+?\ (.*)$/U";
1058
	} else {
1059
		/* RFC 3164 */
1060
		$pattern = "/(.*)\s(.*)\sfilterlog\[[0-9]+\]:\s(.*)$/";
1061
	}
1062

    
1063
	if (!preg_match($pattern, $line, $log_split)) {
1064
		return "";
1065
	}
1066

    
1067
	list($all, $flent['time'], $host, $rule) = $log_split;
1068
	$flent['time'] = str_replace('T', ' ', $flent['time']);
1069

    
1070
	$rule_data = explode(",", $rule);
1071
	$field = 0;
1072

    
1073
	$flent['rulenum'] = $rule_data[$field++];
1074
	$flent['subrulenum'] = $rule_data[$field++];
1075
	$flent['anchor'] = $rule_data[$field++];
1076
	$flent['tracker'] = $rule_data[$field++];
1077
	$flent['realint'] = $rule_data[$field++];
1078
	$flent['interface'] = convert_real_interface_to_friendly_descr($flent['realint']);
1079
	$flent['reason'] = $rule_data[$field++];
1080
	$flent['act'] = $rule_data[$field++];
1081
	$flent['direction'] = $rule_data[$field++];
1082
	$flent['version'] = $rule_data[$field++];
1083

    
1084
	if ($flent['version'] == '4' || $flent['version'] == '6') {
1085
		if ($flent['version'] == '4') {
1086
			$flent['tos'] = $rule_data[$field++];
1087
			$flent['ecn'] = $rule_data[$field++];
1088
			$flent['ttl'] = $rule_data[$field++];
1089
			$flent['id'] = $rule_data[$field++];
1090
			$flent['offset'] = $rule_data[$field++];
1091
			$flent['flags'] = $rule_data[$field++];
1092
			$flent['protoid'] = $rule_data[$field++];
1093
			$flent['proto'] = strtoupper($rule_data[$field++]);
1094
		} else {
1095
			$flent['class'] = $rule_data[$field++];
1096
			$flent['flowlabel'] = $rule_data[$field++];
1097
			$flent['hlim'] = $rule_data[$field++];
1098
			$flent['proto'] = $rule_data[$field++];
1099
			$flent['protoid'] = $rule_data[$field++];
1100
		}
1101

    
1102
		$flent['length'] = $rule_data[$field++];
1103
		$flent['srcip'] = $rule_data[$field++];
1104
		$flent['dstip'] = $rule_data[$field++];
1105

    
1106
		switch($flent['protoid']) {
1107
			case '6':
1108
			case '17': // TCP or UDP
1109
			case '132': // SCTP
1110
				$flent['srcport'] = $rule_data[$field++];
1111
				$flent['dstport'] = $rule_data[$field++];
1112

    
1113
				$flent['src'] = $flent['srcip'] . ':' . $flent['srcport'];
1114
				$flent['dst'] = $flent['dstip'] . ':' . $flent['dstport'];
1115

    
1116
				$flent['datalen'] = $rule_data[$field++];
1117
				if ($flent['protoid'] == '6') { // TCP
1118
					$flent['tcpflags'] = $rule_data[$field++];
1119
					$flent['seq'] = $rule_data[$field++];
1120
					$flent['ack'] = $rule_data[$field++];
1121
					$flent['window'] = $rule_data[$field++];
1122
					$flent['urg'] = $rule_data[$field++];
1123
					$flent['options'] = explode(";", $rule_data[$field++]);
1124
				}
1125
				break;
1126
			case '1':
1127
			case '58': // ICMP (IPv4 & IPv6)
1128
				$flent['src'] = $flent['srcip'];
1129
				$flent['dst'] = $flent['dstip'];
1130

    
1131
				$flent['icmp_type'] = $rule_data[$field++];
1132

    
1133
				switch ($flent['icmp_type']) {
1134
					case "request":
1135
					case "reply":
1136
						$flent['icmp_id'] = $rule_data[$field++];
1137
						$flent['icmp_seq'] = $rule_data[$field++];
1138
						break;
1139
					case "unreachproto":
1140
						$flent['icmp_dstip'] = $rule_data[$field++];
1141
						$flent['icmp_protoid'] = $rule_data[$field++];
1142
						break;
1143
					case "unreachport":
1144
						$flent['icmp_dstip'] = $rule_data[$field++];
1145
						$flent['icmp_protoid'] = $rule_data[$field++];
1146
						$flent['icmp_port'] = $rule_data[$field++];
1147
						break;
1148
					case "unreach":
1149
					case "timexceed":
1150
					case "paramprob":
1151
					case "redirect":
1152
					case "maskreply":
1153
						$flent['icmp_descr'] = $rule_data[$field++];
1154
						break;
1155
					case "needfrag":
1156
						$flent['icmp_dstip'] = $rule_data[$field++];
1157
						$flent['icmp_mtu'] = $rule_data[$field++];
1158
						break;
1159
					case "tstamp":
1160
						$flent['icmp_id'] = $rule_data[$field++];
1161
						$flent['icmp_seq'] = $rule_data[$field++];
1162
						break;
1163
					case "tstampreply":
1164
						$flent['icmp_id'] = $rule_data[$field++];
1165
						$flent['icmp_seq'] = $rule_data[$field++];
1166
						$flent['icmp_otime'] = $rule_data[$field++];
1167
						$flent['icmp_rtime'] = $rule_data[$field++];
1168
						$flent['icmp_ttime'] = $rule_data[$field++];
1169
						break;
1170
					default :
1171
						$flent['icmp_descr'] = $rule_data[$field++];
1172
						break;
1173
				}
1174
				break;
1175
			case '112': // CARP
1176
				$flent['type'] = $rule_data[$field++];
1177
				$flent['ttl'] = $rule_data[$field++];
1178
				$flent['vhid'] = $rule_data[$field++];
1179
				$flent['version'] = $rule_data[$field++];
1180
				$flent['advskew'] = $rule_data[$field++];
1181
				$flent['advbase'] = $rule_data[$field++];
1182
				$flent['src'] = $flent['srcip'];
1183
				$flent['dst'] = $flent['dstip'];
1184
				break;
1185
			default:
1186
				$flent['src'] = $flent['srcip'];
1187
				$flent['dst'] = $flent['dstip'];
1188
				break;
1189
		}
1190
	} else {
1191
		if (g_get('debug')) {
1192
			log_error(sprintf(gettext("There was a error parsing rule number: %s. Please report to mailing list or forum."), $flent['rulenum']));
1193
		}
1194
		return "";
1195
	}
1196

    
1197
	/* If there is a src, a dst, and a time, then the line should be usable/good */
1198
	if (!((trim($flent['src']) == "") || (trim($flent['dst']) == "") || (trim($flent['time']) == ""))) {
1199
		return $flent;
1200
	} else {
1201
		if (g_get('debug')) {
1202
			log_error(sprintf(gettext("There was a error parsing rule: %s. Please report to mailing list or forum."), $line));
1203
		}
1204
		return "";
1205
	}
1206
}
1207

    
1208
function get_port_with_service($port, $proto) {
1209
	if (!$port || !is_port($port)) {
1210
		return '';
1211
	}
1212

    
1213
	$service = getservbyport($port, $proto);
1214
	$portstr = "";
1215
	if ($service) {
1216
		$portstr = sprintf('<span title="' . gettext('Service %1$s/%2$s: %3$s') . '">' . htmlspecialchars($port) . '</span>', $port, $proto, $service);
1217
	} else {
1218
		$portstr = htmlspecialchars($port);
1219
	}
1220
	return ':' . $portstr;
1221
}
1222

    
1223
function find_rule_by_number($rulenum, $trackernum, $type="block") {
1224
	global $g;
1225

    
1226
	/* Passing arbitrary input to grep could be a Very Bad Thing(tm) */
1227
	if (!is_numeric($rulenum) || !is_numeric($trackernum) || !in_array($type, array('pass', 'block', 'match', 'rdr'))) {
1228
		return;
1229
	}
1230

    
1231
	if ($trackernum == "0") {
1232
		$lookup_pattern = "^@{$rulenum}\([0-9]+\)[[:space:]]{$type}[[:space:]].*[[:space:]]log[[:space:]]";
1233
	} else {
1234
		$lookup_pattern = "^@[0-9]+[[:space:]]{$type}[[:space:]].*[[:space:]]log[[:space:]].*[[:space:]]ridentifier[[:space:]]{$trackernum}";
1235
	}
1236

    
1237
	/* At the moment, miniupnpd is the only thing I know of that
1238
	   generates logging rdr rules */
1239
	unset($buffer);
1240
	if ($type == "rdr") {
1241
		$_gb = exec("/sbin/pfctl -vvPsn -a \"miniupnpd\" | /usr/bin/egrep " . escapeshellarg("^@{$rulenum}"), $buffer);
1242
	} else {
1243
		$_gb = exec("/sbin/pfctl -vvPsr | /usr/bin/egrep " . escapeshellarg($lookup_pattern), $buffer);
1244
	}
1245
	if (is_array($buffer)) {
1246
		return $buffer[0];
1247
	}
1248

    
1249
	return "";
1250
}
1251

    
1252
function buffer_rules_load() {
1253
	global $g, $buffer_rules_rdr, $buffer_rules_normal;
1254
	unset($buffer, $buffer_rules_rdr, $buffer_rules_normal);
1255
	/* Redeclare globals after unset to work around PHP */
1256
	global $buffer_rules_rdr, $buffer_rules_normal;
1257
	$buffer_rules_rdr = array();
1258
	$buffer_rules_normal = array();
1259

    
1260
	$_gb = exec("/sbin/pfctl -vvPsn -a \"miniupnpd\" | /usr/bin/grep '^@'", $buffer);
1261
	if (is_array($buffer)) {
1262
		foreach ($buffer as $line) {
1263
			list($key, $value) = explode (" ", $line, 2);
1264
			$buffer_rules_rdr[$key] = $value;
1265
		}
1266
	}
1267

    
1268
	$rules = pfSense_get_pf_rules();
1269
	if (is_array($rules)) {
1270
		foreach ($rules as $rule) {
1271
			$key = sprintf("%d", $rule['tracker']);
1272
			$buffer_rules_normal[$key] = is_array($rule['labels']) ? array_shift($rule['labels']) : $rule['labels'];
1273
		}
1274
	}
1275
	unset($_gb, $buffer);
1276
}
1277

    
1278
function buffer_rules_clear() {
1279
	unset($GLOBALS['buffer_rules_normal']);
1280
	unset($GLOBALS['buffer_rules_rdr']);
1281
}
1282

    
1283
function find_rule_by_number_buffer($rulenum, $trackernum, $type) {
1284
	global $g, $buffer_rules_rdr, $buffer_rules_normal;
1285

    
1286
	if ($trackernum == "0") {
1287
		$lookup_key = "@{$rulenum}";
1288
	} else {
1289
		$lookup_key = $trackernum;
1290
	}
1291

    
1292
	if ($type == "rdr") {
1293
		$ruleString = $buffer_rules_rdr[$lookup_key];
1294
		//TODO: get the correct 'description' part of a RDR log line. currently just first 30 characters..
1295
		$rulename = substr($ruleString, 0, 30);
1296
	} else {
1297
		$ruleString = $buffer_rules_normal[$lookup_key];
1298
		$rulename = str_replace("USER_RULE: ", '<i class="fa fa-user"></i> ', $ruleString);
1299
	}
1300
	return "{$rulename} ({$lookup_key})";
1301
}
1302

    
1303
function find_action_image($action) {
1304
	global $g;
1305
	if ((strstr(strtolower($action), "p")) || (strtolower($action) == "rdr")) {
1306
		return "fa-check-circle-o";
1307
	} else if (strstr(strtolower($action), "r")) {
1308
		return "fa-times-circle-o";
1309
	} else {
1310
		return "fa-ban";
1311
	}
1312
}
1313

    
1314
/* AJAX specific handlers */
1315
function handle_ajax() {
1316
	if ($_REQUEST['lastsawtime'] && $_REQUEST['logfile']) {
1317

    
1318
		$lastsawtime = getGETPOSTsettingvalue('lastsawtime', null);
1319
		$logfile = getGETPOSTsettingvalue('logfile', null);
1320
		$nentries = getGETPOSTsettingvalue('nentries', null);
1321
		$type = getGETPOSTsettingvalue('type', null);
1322
		$filter = getGETPOSTsettingvalue('filter', null);
1323
		$interfacefilter = getGETPOSTsettingvalue('interfacefilter', null);
1324

    
1325
		if (!empty(trim($filter)) || is_numeric($filter)) {
1326
			$filter = json_decode($filter, true);	# Filter Fields Array or Filter Text
1327
		}
1328

    
1329
		/* compare lastsawrule's time stamp to filter logs.
1330
		 * afterwards return the newer records so that client
1331
		 * can update AJAX interface screen.
1332
		 */
1333
		$new_rules = "";
1334

    
1335
		$filterlog = conv_log_filter($logfile, $nentries, $nentries + 100, $filter, $interfacefilter);
1336

    
1337
		/* We need this to always be in forward order for the AJAX update to work properly */
1338
		/* Since the lines are in reverse order, flip them around if needed based on the user's preference */
1339
		# First get the "General Logging Options" (global) chronological order setting.  Then apply specific log override if set.
1340
		$reverse = config_path_enabled('syslog', 'reverse');
1341
		$specific_log = basename($logfile, '.log') . '_settings';
1342
		$cronorder = config_get_path("syslog/{$specific_log}/cronorder");
1343
		if ($cronorder == 'forward') {
1344
			$reverse = false;
1345
		}
1346
		if ($cronorder == 'reverse') {
1347
			$reverse = true;
1348
		}
1349

    
1350
		$filterlog = ($reverse) ? array_reverse($filterlog) : $filterlog;
1351

    
1352
		foreach ($filterlog as $log_row) {
1353
			$row_time = strtotime($log_row['time']);
1354
			if ($row_time > $lastsawtime) {
1355
				if ($log_row['proto'] == "TCP") {
1356
					$log_row['proto'] .= ":{$log_row['tcpflags']}";
1357
				}
1358

    
1359
				if ($log_row['act'] == "block") {
1360
					$icon_act = "fa-times text-danger";
1361
				} else {
1362
					$icon_act = "fa-check text-success";
1363
				}
1364

    
1365
				$btn = '<i class="fa ' . $icon_act . ' icon-pointer" title="' . $log_row['act'] . '/' . $log_row['tracker'] . '" onclick="javascript:getURL(\'status_logs_filter.php?getrulenum=' . $log_row['rulenum'] . ',' . $log_row['tracker'] . ',' . $log_row['act'] . '\', outputrule);"></i>';
1366
				$new_rules .= "{$btn}||{$log_row['time']}||{$log_row['interface']}||{$log_row['srcip']}||{$log_row['srcport']}||{$log_row['dstip']}||{$log_row['dstport']}||{$log_row['proto']}||{$log_row['version']}||" . time() . "||\n";
1367
			}
1368
		}
1369
		echo $new_rules;
1370
		exit;
1371
	}
1372
}
1373

    
1374
/* Compatibility stubs for old clog functions until packages catch up.
1375
 * Remove once packages all use the new function names. */
1376
function dump_clog_no_table($logfile, $tail, $withorig = true, $grepfor = "", $grepinvert = "") {
1377
	return dump_log($logfile, $tail, $withorig, $grepfor, $grepinvert, $format = 'notable');
1378
}
1379
function dump_log_no_table($logfile, $tail, $withorig = true, $grepfor = "", $grepinvert = "") {
1380
	return dump_log($logfile, $tail, $withorig, $grepfor, $grepinvert, $format = 'notable');
1381
}
1382
function dump_clog($logfile, $tail, $withorig = true, $grepfor = "", $grepinvert = "") {
1383
	return dump_log($logfile, $tail, $withorig, $grepfor, $grepinvert);
1384
}
1385
function return_clog($logfile, $tail, $withorig = true, $grepfor = "", $grepinvert = "", $grepreverse = false) {
1386
	return dump_log($logfile, $tail, $withorig, $grepfor, $grepinvert, $format = 'none', $grepreverse);
1387
}
1388
function return_log($logfile, $tail, $withorig = true, $grepfor = "", $grepinvert = "", $grepreverse = false) {
1389
	return dump_log($logfile, $tail, $withorig, $grepfor, $grepinvert, $format = 'none', $grepreverse);
1390
}
(49-49/61)