Project

General

Profile

Download (48.2 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-2022 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
	if (!empty($syslogcfg)) {
217
		$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');
218
		$syslogconf = "# Automatically generated, do not edit!\n";
219

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

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

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

    
245
		$syslogconf .= "!radvd,routed,zebra,ospfd,ospf6d,bgpd,watchfrr,miniupnpd,igmpproxy\n";
246
		if (!config_path_enabled('syslog', 'disablelocallogging')) {
247
			$syslogconf .= "*.*								{$g['varlog_path']}/routing.log\n";
248
		}
249
		if (config_path_enabled('syslog', 'routing')) {
250
			$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "*.*");
251
		}
252

    
253
		$syslogconf .= "!ntp,ntpd,ntpdate\n";
254
		if (!config_path_enabled('syslog', 'disablelocallogging')) {
255
			$syslogconf .= "*.*								{$g['varlog_path']}/ntpd.log\n";
256
		}
257
		if (config_path_enabled('syslog', 'ntpd')) {
258
			$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "*.*");
259
		}
260

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

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

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

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

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

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

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

    
317
		$syslogconf .= "!dhcpd,dhcrelay,dhclient,dhcp6c,dhcpleases,dhcpleases6\n";
318
		if (!config_path_enabled('syslog', 'disablelocallogging')) {
319
			$syslogconf .= "*.*								{$g['varlog_path']}/dhcpd.log\n";
320
		}
321
		if (config_path_enabled('syslog', 'dhcp')) {
322
			$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "*.*");
323
		}
324

    
325
		$syslogconf .= "!hostapd\n";
326
		if (!config_path_enabled('syslog', 'disablelocallogging')) {
327
			$syslogconf .= "*.* 								{$g['varlog_path']}/wireless.log\n";
328
		}
329
		if (config_path_enabled('syslog', 'hostapd')) {
330
			$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "*.*");
331
		}
332

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

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

    
349
		$syslogconf .= "!-{$facilitylist}\n";
350
		if (!config_path_enabled('syslog', 'disablelocallogging')) {
351
			$syslogconf .= <<<EOD
352
local3.*							{$g['varlog_path']}/vpn.log
353
local5.*							{$g['varlog_path']}/nginx.log
354
*.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
355
auth.info;authpriv.info 					|exec /usr/local/sbin/sshguard -i /var/run/sshguard.pid
356
*.emerg								*
357

    
358
EOD;
359
		}
360
		if (config_path_enabled('syslog', 'vpn')) {
361
			$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "local3.*");
362
		}
363
		if (config_path_enabled('syslog', 'system')) {
364
			$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");
365
		}
366
		if (config_path_enabled('syslog', 'logall')) {
367
			// Make everything mean everything, including facilities excluded above.
368
			$syslogconf .= "!*\n";
369
			$syslogconf .= system_syslogd_get_remote_servers($syslogcfg, "*.*");
370
		}
371

    
372
		/* write syslog config to pfSense.conf */
373
		if (!@file_put_contents("{$g['varetc_path']}/syslog.d/pfSense.conf", $syslogconf)) {
374
			printf(gettext("Error: cannot open syslog config file in system_syslogd_start().%s"), "\n");
375
			unset($syslogconf);
376
			return 1;
377
		}
378
		unset($syslogconf);
379

    
380
		$sourceip = config_get_path('syslog/sourceip');
381
		if (!empty($sourceip)) {
382
			if (config_get_path('syslog/ipproto') == "ipv6") {
383
				$ifaddr = is_ipaddr($sourceip) ? $sourceip : get_interface_ipv6($sourceip);
384
				if (!is_ipaddr($ifaddr)) {
385
					$ifaddr = get_interface_ip($sourceip);
386
				}
387
			} else {
388
				$ifaddr = is_ipaddr($sourceip) ? $sourceip : get_interface_ip($sourceip);
389
				if (!is_ipaddr($ifaddr)) {
390
					$ifaddr = get_interface_ipv6($sourceip);
391
				}
392
			}
393
			if (is_ipaddr($ifaddr)) {
394
				$sourceip = "-b {$ifaddr}";
395
			}
396
		}
397

    
398
		$syslogd_extra = "-f {$g['etc_path']}/syslog.conf {$sourceip}";
399
	}
400

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

    
403
	foreach (config_get_path('installedpackages/package', []) as $key => $package) {
404
		$pkg_log_socket = config_get_path("installedpackages/package/{$key}/logging/logsocket");
405
		if (!empty($pkg_log_socket) &&
406
		    !in_array($pkg_log_socket, $log_sockets)) {
407
			$log_sockets[] = $package['logging']['logsocket'];
408
		}
409
	}
410

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

    
413
	$syslogd_sockets = "";
414
	foreach ($log_sockets as $log_socket) {
415
		// Ensure that the log directory exists
416
		$logpath = dirname($log_socket);
417
		safe_mkdir($logpath);
418
		$syslogd_sockets .= " -l {$log_socket}";
419
	}
420

    
421
	/* Setup log rotation */
422
	system_log_rotation_setup();
423

    
424
	/* If HUP was requested, but syslogd is not running, restart it instead. */
425
	if ($sighup && !isvalidpid("{$g['varrun_path']}/syslog.pid")) {
426
		$sighup = false;
427
	}
428

    
429
	$sshguard_whitelist = array();
430
	if (!empty(config_get_path('system/sshguard_whitelist'))) {
431
		$sshguard_whitelist = explode(' ',
432
		    config_get_path('system/sshguard_whitelist'));
433
	}
434

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

    
460
	if (!$sighup) {
461
		sigkillbyname("sshguard", "TERM");
462
		if (isvalidpid("{$g['varrun_path']}/syslog.pid")) {
463
			sigkillbypid("{$g['varrun_path']}/syslog.pid", "TERM");
464
			usleep(100000); // syslogd often doesn't respond to a TERM quickly enough for the starting of syslogd below to be successful
465
		}
466

    
467
		if (isvalidpid("{$g['varrun_path']}/syslog.pid")) {
468
			// if it still hasn't responded to the TERM, KILL it.
469
			sigkillbypid("{$g['varrun_path']}/syslog.pid", "KILL");
470
			usleep(100000);
471
		}
472

    
473
		$retval = mwexec_bg("/usr/sbin/syslogd {$syslogd_format} -s -c -c {$syslogd_sockets} -P {$g['varrun_path']}/syslog.pid {$syslogd_extra}");
474
	} else {
475
		$retval = sigkillbypid("{$g['varrun_path']}/syslog.pid", "HUP");
476
	}
477

    
478
	if (platform_booting()) {
479
		echo gettext("done.") . "\n";
480
	}
481

    
482
	return $retval;
483
}
484

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

    
501
function system_log_get_cat() {
502
	global $system_log_compression_types;
503
	return $system_log_compression_types[system_log_get_compression()]['cat'];
504
}
505

    
506
/* Setup newsyslog log rotation */
507
function system_log_rotation_setup() {
508
	global $g, $system_log_files, $system_log_compression_types;
509
	$syslogcfg = config_get_path('syslog', []);
510

    
511
	$mainnewsyslogconf = <<<EOD
512
# Automatically generated, do not edit!
513
# Place configuration files in {$g['varetc_path']}/newsyslog.conf.d
514
<include> {$g['varetc_path']}/newsyslog.conf.d/*
515
# /* Manually added files with non-conflicting names will not be automatically removed */
516

    
517
EOD;
518

    
519
	file_put_contents("{$g['etc_path']}/newsyslog.conf", $mainnewsyslogconf);
520
	safe_mkdir("{$g['varetc_path']}/newsyslog.conf.d");
521

    
522
	if (!empty($syslogcfg)) {
523
		$log_size = config_get_path('syslog/logfilesize', $g['default_log_size']);
524
		$log_size = ($log_size < (2**32)/2) ? $log_size : $g['default_log_size'];
525
		$log_size = (int)$log_size/1024;
526

    
527
		$rotatecount = config_get_path('syslog/rotatecount', 7);
528
		$rotatecount = is_numericint($rotatecount) ? $rotatecount : 7;
529

    
530
		$compression_flag = $system_log_compression_types[system_log_get_compression()]['flag'];
531

    
532
		$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');
533
		$newsyslogconf = <<<EOD
534
/var/log/userlog		root:wheel	600	3	{$log_size}	*	B
535
/var/log/utx.log		root:wheel	644	3	{$log_size}	*	B
536

    
537
EOD;
538

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

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

    
567
		foreach($system_log_files as $logfile) {
568
			$local_log_size = (int) config_get_path("syslog/" . basename($logfile, '.log') . "/logfilesize", 0);
569
			$local_log_size = ($local_log_size > 0) ? $local_log_size / 1024 : $log_size;
570
			$local_rotate_count = (int) config_get_path("syslog/" . basename($logfile, '.log') . "/rotatecount", $rotatecount);
571

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

    
575
		if (!@file_put_contents("{$g['varetc_path']}/newsyslog.conf.d/pfSense.conf", $newsyslogconf)) {
576
			printf(gettext("Error: cannot open syslog config file in system_log_rotation_setup().%s"), "\n");
577
		}
578
		unset($newsyslogconf);
579
	}
580
}
581

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

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

    
641
	if ($format == 'none') {
642
		return($logarr);
643
	}
644

    
645
	$rows = 0;
646
	foreach ($logarr as $logent) {
647
		$rows++;
648
		$entry_date_time = "";
649

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

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

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

    
696
	return($rows);
697
}
698

    
699
/* format filter logs */
700
function conv_log_filter($logfile, $nentries, $tail = 500, $filtertext = "", $filterinterface = null) {
701
	global $g, $pattern;
702

    
703
	/* Make sure this is a number before using it in a system call */
704
	if (!(is_numeric($tail))) {
705
		return;
706
	}
707

    
708
	/* Safety belt to ensure we get enough lines for filtering without overloading the parsing code */
709
	if ($filtertext) {
710
		$tail = 10000;
711
	}
712

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

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

    
731
# Common Regular Expression Patterns
732
	$base_patterns = array(
733
		'rfc3164' => array('start_pattern' => "^"),
734
		'rfc5424' => array('start_pattern' => "^<[0-9]{1,3}>[0-9]*\ "),
735
	);
736

    
737
	/* bsd log date */
738
	$base_patterns['rfc3164']['date_pattern'] = "\([a-zA-Z]{3}\ +[0-9]{1,2}\ +[0-9]{2}:[0-9]{2}:[0-9]{2}\)";
739
	/* RFC3339 Extended format date */
740
	$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]))\)";
741

    
742
	/* hostname only, might not be present */
743
	$base_patterns['rfc3164']['host_pattern'] = "\(.*?\)";
744
	/* FQDN, always present */
745
	$base_patterns['rfc5424']['host_pattern'] = "\(\S+?\)";
746

    
747
	/* name[pid]:, pid may not be present */
748
	$base_patterns['rfc3164']['process_pattern'] = "\(.*?\)\(?::\ +\)?";
749
	/* name alone, nothing special */
750
	$base_patterns['rfc5424']['process_pattern'] = "\(\S+?\)\ ";
751

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

    
757
	/* match anything from here on */
758
	$base_patterns['rfc3164']['log_message_pattern'] = "\(.*\)";
759
	$base_patterns['rfc5424']['log_message_pattern'] = "\(.*\)";
760

    
761
	$patterns = array(
762
		'rfc3164' => $base_patterns['rfc3164']['start_pattern'],
763
		'rfc5424' => $base_patterns['rfc5424']['start_pattern'],
764
	);
765

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

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

    
828
	# Remove escapes and fix up the pattern for preg_match.
829
	$patterns['rfc3164'] = '/' . str_replace(array('\(', '\)', '\[', '\]'), array('(', ')', '[', ']'), $patterns['rfc3164']) . '/';
830
	$patterns['rfc5424'] = '/' . str_replace(array('\(', '\)', '\[', '\]'), array('(', ')', '[', ']'), $patterns['rfc5424']) . '/';
831

    
832
	$filterlog = array();
833
	$counter = 0;
834

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

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

    
887
	return ($reverse) ? $filterlog : array_reverse($filterlog);
888
}
889

    
890
function match_filter_line($flent, $filtertext = "") {
891
	if (!$filtertext) {
892
		return true;
893
	}
894
	$filtertext = escape_filter_regex(str_replace(' ', '\s+', $filtertext));
895
	return @preg_match("/{$filtertext}/i", implode(" ", array_values($flent)));
896
}
897

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

    
931
// Case Insensitive in_array function
932
function in_arrayi($needle, $haystack) {
933
	return in_array(strtolower($needle), array_map('strtolower', $haystack));
934
}
935

    
936
function parse_vpn_login_log_line($line) {
937
	global $g, $pattern;
938

    
939
	$flent = array();
940
	$log_split = "";
941

    
942
	if (!preg_match($pattern, $line, $log_split))
943
		return "";
944

    
945
	list($all, $flent['time'], $flent['host'], $flent['process'], $flent['action'], $flent['type'], $flent['ip_address'], $flent['user']) = $log_split;
946
	$flent['time'] = str_replace('T', ' ', $flent['time']);
947

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

    
959
function parse_vpn_service_log_line($line) {
960
	global $g, $pattern;
961

    
962
	$flent = array();
963
	$log_split = "";
964

    
965
	if (!preg_match($pattern, $line, $log_split))
966
		return "";
967

    
968
	list($all, $flent['time'], $flent['host'], $flent['type'], $flent['pid'], $flent['message']) = $log_split;
969
	$flent['time'] = str_replace('T', ' ', $flent['time']);
970

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

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

    
996
function parse_unknown_log_line($line) {
997
	global $g, $pattern;
998

    
999
	$flent = array();
1000
	$log_split = "";
1001

    
1002
	if (!preg_match($pattern, $line, $log_split)) {
1003
		return "";
1004
	}
1005

    
1006
	list($all, $flent['time'], $flent['message']) = $log_split;
1007
	$flent['time'] = str_replace('T', ' ', $flent['time']);
1008

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

    
1020
function parse_system_log_line($line) {
1021
	global $g, $pattern;
1022

    
1023
	$flent = array();
1024
	$log_split = "";
1025

    
1026
	if (!preg_match($pattern, $line, $log_split)) {
1027
		return "";
1028
	}
1029

    
1030
	list($all, $flent['time'], $flent['host'], $flent['process'], $flent['pid'], $flent['message']) = $log_split;
1031
	$flent['time'] = str_replace('T', ' ', $flent['time']);
1032

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

    
1044
function parse_firewall_log_line($line) {
1045
	global $g;
1046

    
1047
	$flent = array();
1048
	$log_split = "";
1049

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

    
1058
	if (!preg_match($pattern, $line, $log_split)) {
1059
		return "";
1060
	}
1061

    
1062
	list($all, $flent['time'], $host, $rule) = $log_split;
1063
	$flent['time'] = str_replace('T', ' ', $flent['time']);
1064

    
1065
	$rule_data = explode(",", $rule);
1066
	$field = 0;
1067

    
1068
	$flent['rulenum'] = $rule_data[$field++];
1069
	$flent['subrulenum'] = $rule_data[$field++];
1070
	$flent['anchor'] = $rule_data[$field++];
1071
	$flent['tracker'] = $rule_data[$field++];
1072
	$flent['realint'] = $rule_data[$field++];
1073
	$flent['interface'] = convert_real_interface_to_friendly_descr($flent['realint']);
1074
	$flent['reason'] = $rule_data[$field++];
1075
	$flent['act'] = $rule_data[$field++];
1076
	$flent['direction'] = $rule_data[$field++];
1077
	$flent['version'] = $rule_data[$field++];
1078

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

    
1097
		$flent['length'] = $rule_data[$field++];
1098
		$flent['srcip'] = $rule_data[$field++];
1099
		$flent['dstip'] = $rule_data[$field++];
1100

    
1101
		if ($flent['protoid'] == '6' || $flent['protoid'] == '17') { // TCP or UDP
1102
			$flent['srcport'] = $rule_data[$field++];
1103
			$flent['dstport'] = $rule_data[$field++];
1104

    
1105
			$flent['src'] = $flent['srcip'] . ':' . $flent['srcport'];
1106
			$flent['dst'] = $flent['dstip'] . ':' . $flent['dstport'];
1107

    
1108
			$flent['datalen'] = $rule_data[$field++];
1109
			if ($flent['protoid'] == '6') { // TCP
1110
				$flent['tcpflags'] = $rule_data[$field++];
1111
				$flent['seq'] = $rule_data[$field++];
1112
				$flent['ack'] = $rule_data[$field++];
1113
				$flent['window'] = $rule_data[$field++];
1114
				$flent['urg'] = $rule_data[$field++];
1115
				$flent['options'] = explode(";", $rule_data[$field++]);
1116
			}
1117
		} else if ($flent['protoid'] == '1' || $flent['protoid'] == '58') {	// ICMP (IPv4 & IPv6)
1118
			$flent['src'] = $flent['srcip'];
1119
			$flent['dst'] = $flent['dstip'];
1120

    
1121
			$flent['icmp_type'] = $rule_data[$field++];
1122

    
1123
			switch ($flent['icmp_type']) {
1124
				case "request":
1125
				case "reply":
1126
					$flent['icmp_id'] = $rule_data[$field++];
1127
					$flent['icmp_seq'] = $rule_data[$field++];
1128
					break;
1129
				case "unreachproto":
1130
					$flent['icmp_dstip'] = $rule_data[$field++];
1131
					$flent['icmp_protoid'] = $rule_data[$field++];
1132
					break;
1133
				case "unreachport":
1134
					$flent['icmp_dstip'] = $rule_data[$field++];
1135
					$flent['icmp_protoid'] = $rule_data[$field++];
1136
					$flent['icmp_port'] = $rule_data[$field++];
1137
					break;
1138
				case "unreach":
1139
				case "timexceed":
1140
				case "paramprob":
1141
				case "redirect":
1142
				case "maskreply":
1143
					$flent['icmp_descr'] = $rule_data[$field++];
1144
					break;
1145
				case "needfrag":
1146
					$flent['icmp_dstip'] = $rule_data[$field++];
1147
					$flent['icmp_mtu'] = $rule_data[$field++];
1148
					break;
1149
				case "tstamp":
1150
					$flent['icmp_id'] = $rule_data[$field++];
1151
					$flent['icmp_seq'] = $rule_data[$field++];
1152
					break;
1153
				case "tstampreply":
1154
					$flent['icmp_id'] = $rule_data[$field++];
1155
					$flent['icmp_seq'] = $rule_data[$field++];
1156
					$flent['icmp_otime'] = $rule_data[$field++];
1157
					$flent['icmp_rtime'] = $rule_data[$field++];
1158
					$flent['icmp_ttime'] = $rule_data[$field++];
1159
					break;
1160
				default :
1161
					$flent['icmp_descr'] = $rule_data[$field++];
1162
					break;
1163
			}
1164

    
1165
		} else if ($flent['protoid'] == '2') { // IGMP
1166
			$flent['src'] = $flent['srcip'];
1167
			$flent['dst'] = $flent['dstip'];
1168
		} else if ($flent['protoid'] == '112') { // CARP
1169
			$flent['type'] = $rule_data[$field++];
1170
			$flent['ttl'] = $rule_data[$field++];
1171
			$flent['vhid'] = $rule_data[$field++];
1172
			$flent['version'] = $rule_data[$field++];
1173
			$flent['advskew'] = $rule_data[$field++];
1174
			$flent['advbase'] = $rule_data[$field++];
1175
			$flent['src'] = $flent['srcip'];
1176
			$flent['dst'] = $flent['dstip'];
1177
		}
1178
	} else {
1179
		if ($g['debug']) {
1180
			log_error(sprintf(gettext("There was a error parsing rule number: %s. Please report to mailing list or forum."), $flent['rulenum']));
1181
		}
1182
		return "";
1183
	}
1184

    
1185
	/* If there is a src, a dst, and a time, then the line should be usable/good */
1186
	if (!((trim($flent['src']) == "") || (trim($flent['dst']) == "") || (trim($flent['time']) == ""))) {
1187
		return $flent;
1188
	} else {
1189
		if ($g['debug']) {
1190
			log_error(sprintf(gettext("There was a error parsing rule: %s. Please report to mailing list or forum."), $line));
1191
		}
1192
		return "";
1193
	}
1194
}
1195

    
1196
function get_port_with_service($port, $proto) {
1197
	if (!$port || !is_port($port)) {
1198
		return '';
1199
	}
1200

    
1201
	$service = getservbyport($port, $proto);
1202
	$portstr = "";
1203
	if ($service) {
1204
		$portstr = sprintf('<span title="' . gettext('Service %1$s/%2$s: %3$s') . '">' . htmlspecialchars($port) . '</span>', $port, $proto, $service);
1205
	} else {
1206
		$portstr = htmlspecialchars($port);
1207
	}
1208
	return ':' . $portstr;
1209
}
1210

    
1211
function find_rule_by_number($rulenum, $trackernum, $type="block") {
1212
	global $g;
1213

    
1214
	/* Passing arbitrary input to grep could be a Very Bad Thing(tm) */
1215
	if (!is_numeric($rulenum) || !is_numeric($trackernum) || !in_array($type, array('pass', 'block', 'match', 'rdr'))) {
1216
		return;
1217
	}
1218

    
1219
	if ($trackernum == "0") {
1220
		$lookup_pattern = "^@{$rulenum}\([0-9]+\)[[:space:]]{$type}[[:space:]].*[[:space:]]log[[:space:]]";
1221
	} else {
1222
		$lookup_pattern = "^@[0-9]+[[:space:]]{$type}[[:space:]].*[[:space:]]log[[:space:]].*[[:space:]]ridentifier[[:space:]]{$trackernum}";
1223
	}
1224

    
1225
	/* At the moment, miniupnpd is the only thing I know of that
1226
	   generates logging rdr rules */
1227
	unset($buffer);
1228
	if ($type == "rdr") {
1229
		$_gb = exec("/sbin/pfctl -vvPsn -a \"miniupnpd\" | /usr/bin/egrep " . escapeshellarg("^@{$rulenum}"), $buffer);
1230
	} else {
1231
		$_gb = exec("/sbin/pfctl -vvPsr | /usr/bin/egrep " . escapeshellarg($lookup_pattern), $buffer);
1232
	}
1233
	if (is_array($buffer)) {
1234
		return $buffer[0];
1235
	}
1236

    
1237
	return "";
1238
}
1239

    
1240
function buffer_rules_load() {
1241
	global $g, $buffer_rules_rdr, $buffer_rules_normal;
1242
	unset($buffer, $buffer_rules_rdr, $buffer_rules_normal);
1243
	/* Redeclare globals after unset to work around PHP */
1244
	global $buffer_rules_rdr, $buffer_rules_normal;
1245
	$buffer_rules_rdr = array();
1246
	$buffer_rules_normal = array();
1247

    
1248
	$_gb = exec("/sbin/pfctl -vvPsn -a \"miniupnpd\" | /usr/bin/grep '^@'", $buffer);
1249
	if (is_array($buffer)) {
1250
		foreach ($buffer as $line) {
1251
			list($key, $value) = explode (" ", $line, 2);
1252
			$buffer_rules_rdr[$key] = $value;
1253
		}
1254
	}
1255

    
1256
	$rules = pfSense_get_pf_rules();
1257
	if (is_array($rules)) {
1258
		foreach ($rules as $rule) {
1259
			$key = sprintf("%d", $rule['tracker']);
1260
			$buffer_rules_normal[$key] = $rule['label'];
1261
		}
1262
	}
1263
	unset($_gb, $buffer);
1264
}
1265

    
1266
function buffer_rules_clear() {
1267
	unset($GLOBALS['buffer_rules_normal']);
1268
	unset($GLOBALS['buffer_rules_rdr']);
1269
}
1270

    
1271
function find_rule_by_number_buffer($rulenum, $trackernum, $type) {
1272
	global $g, $buffer_rules_rdr, $buffer_rules_normal;
1273

    
1274
	if ($trackernum == "0") {
1275
		$lookup_key = "@{$rulenum}";
1276
	} else {
1277
		$lookup_key = $trackernum;
1278
	}
1279

    
1280
	if ($type == "rdr") {
1281
		$ruleString = $buffer_rules_rdr[$lookup_key];
1282
		//TODO: get the correct 'description' part of a RDR log line. currently just first 30 characters..
1283
		$rulename = substr($ruleString, 0, 30);
1284
	} else {
1285
		$ruleString = $buffer_rules_normal[$lookup_key];
1286
		$rulename = str_replace("USER_RULE: ", '<i class="fa fa-user"></i> ', $ruleString);
1287
	}
1288
	return "{$rulename} ({$lookup_key})";
1289
}
1290

    
1291
function find_action_image($action) {
1292
	global $g;
1293
	if ((strstr(strtolower($action), "p")) || (strtolower($action) == "rdr")) {
1294
		return "fa-check-circle-o";
1295
	} else if (strstr(strtolower($action), "r")) {
1296
		return "fa-times-circle-o";
1297
	} else {
1298
		return "fa-ban";
1299
	}
1300
}
1301

    
1302
/* AJAX specific handlers */
1303
function handle_ajax() {
1304
	if ($_REQUEST['lastsawtime'] && $_REQUEST['logfile']) {
1305

    
1306
		$lastsawtime = getGETPOSTsettingvalue('lastsawtime', null);
1307
		$logfile = getGETPOSTsettingvalue('logfile', null);
1308
		$nentries = getGETPOSTsettingvalue('nentries', null);
1309
		$type = getGETPOSTsettingvalue('type', null);
1310
		$filter = getGETPOSTsettingvalue('filter', null);
1311
		$interfacefilter = getGETPOSTsettingvalue('interfacefilter', null);
1312

    
1313
		if (!empty(trim($filter)) || is_numeric($filter)) {
1314
			$filter = json_decode($filter, true);	# Filter Fields Array or Filter Text
1315
		}
1316

    
1317
		/* compare lastsawrule's time stamp to filter logs.
1318
		 * afterwards return the newer records so that client
1319
		 * can update AJAX interface screen.
1320
		 */
1321
		$new_rules = "";
1322

    
1323
		$filterlog = conv_log_filter($logfile, $nentries, $nentries + 100, $filter, $interfacefilter);
1324

    
1325
		/* We need this to always be in forward order for the AJAX update to work properly */
1326
		/* Since the lines are in reverse order, flip them around if needed based on the user's preference */
1327
		# First get the "General Logging Options" (global) chronological order setting.  Then apply specific log override if set.
1328
		$reverse = config_path_enabled('syslog', 'reverse');
1329
		$specific_log = basename($logfile, '.log') . '_settings';
1330
		$cronorder = config_get_path("syslog/{$specific_log}/cronorder");
1331
		if ($cronorder == 'forward') {
1332
			$reverse = false;
1333
		}
1334
		if ($cronorder == 'reverse') {
1335
			$reverse = true;
1336
		}
1337

    
1338
		$filterlog = ($reverse) ? array_reverse($filterlog) : $filterlog;
1339

    
1340
		foreach ($filterlog as $log_row) {
1341
			$row_time = strtotime($log_row['time']);
1342
			if ($row_time > $lastsawtime) {
1343
				if ($log_row['proto'] == "TCP") {
1344
					$log_row['proto'] .= ":{$log_row['tcpflags']}";
1345
				}
1346

    
1347
				if ($log_row['act'] == "block") {
1348
					$icon_act = "fa-times text-danger";
1349
				} else {
1350
					$icon_act = "fa-check text-success";
1351
				}
1352

    
1353
				$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>';
1354
				$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";
1355
			}
1356
		}
1357
		echo $new_rules;
1358
		exit;
1359
	}
1360
}
1361

    
1362
/* Compatibility stubs for old clog functions until packages catch up.
1363
 * Remove once packages all use the new function names. */
1364
function dump_clog_no_table($logfile, $tail, $withorig = true, $grepfor = "", $grepinvert = "") {
1365
	return dump_log($logfile, $tail, $withorig, $grepfor, $grepinvert, $format = 'notable');
1366
}
1367
function dump_log_no_table($logfile, $tail, $withorig = true, $grepfor = "", $grepinvert = "") {
1368
	return dump_log($logfile, $tail, $withorig, $grepfor, $grepinvert, $format = 'notable');
1369
}
1370
function dump_clog($logfile, $tail, $withorig = true, $grepfor = "", $grepinvert = "") {
1371
	return dump_log($logfile, $tail, $withorig, $grepfor, $grepinvert);
1372
}
1373
function return_clog($logfile, $tail, $withorig = true, $grepfor = "", $grepinvert = "", $grepreverse = false) {
1374
	return dump_log($logfile, $tail, $withorig, $grepfor, $grepinvert, $format = 'none', $grepreverse);
1375
}
1376
function return_log($logfile, $tail, $withorig = true, $grepfor = "", $grepinvert = "", $grepreverse = false) {
1377
	return dump_log($logfile, $tail, $withorig, $grepfor, $grepinvert, $format = 'none', $grepreverse);
1378
}
(49-49/62)