pfSense

<?php

/* $Id$ */

/*

	diag_logs_settings.php

	Copyright (C) 2004-2009 Scott Ullrich

	Copyright (C) 2013-2015 Electric Sheep Fencing, LP

	All rights reserved.

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

	Copyright (C) 2003-2004 Manuel Kasper <mk@neon1.net>.

	All rights reserved.

	Redistribution and use in source and binary forms, with or without

	modification, are permitted provided that the following conditions are met:

	1. Redistributions of source code must retain the above copyright notice,

	   this list of conditions and the following disclaimer.

	2. Redistributions in binary form must reproduce the above copyright

	   notice, this list of conditions and the following disclaimer in the

	   documentation and/or other materials provided with the distribution.

	THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,

	INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY

	AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE

	AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,

	OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

	SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

	INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

	CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

	ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

	POSSIBILITY OF SUCH DAMAGE.

*/

/*

	pfSense_MODULE: system

*/

##|+PRIV

##|*IDENT=page-diagnostics-logs-settings

##|*NAME=Diagnostics: Logs: Settings page

##|*DESCR=Allow access to the 'Diagnostics: Logs: Settings' page.

##|*MATCH=diag_logs_settings.php*

##|-PRIV

require("guiconfig.inc");

require_once("functions.inc");

require_once("filter.inc");

require_once("shaper.inc");

$pconfig['reverse'] = isset($config['syslog']['reverse']);

$pconfig['nentries'] = $config['syslog']['nentries'];

$pconfig['remoteserver'] = $config['syslog']['remoteserver'];

$pconfig['remoteserver2'] = $config['syslog']['remoteserver2'];

$pconfig['remoteserver3'] = $config['syslog']['remoteserver3'];

$pconfig['sourceip'] = $config['syslog']['sourceip'];

$pconfig['ipproto'] = $config['syslog']['ipproto'];

$pconfig['filter'] = isset($config['syslog']['filter']);

$pconfig['dhcp'] = isset($config['syslog']['dhcp']);

$pconfig['portalauth'] = isset($config['syslog']['portalauth']);

$pconfig['vpn'] = isset($config['syslog']['vpn']);

$pconfig['apinger'] = isset($config['syslog']['apinger']);

$pconfig['relayd'] = isset($config['syslog']['relayd']);

$pconfig['hostapd'] = isset($config['syslog']['hostapd']);

$pconfig['logall'] = isset($config['syslog']['logall']);

$pconfig['system'] = isset($config['syslog']['system']);

$pconfig['enable'] = isset($config['syslog']['enable']);

$pconfig['logdefaultblock'] = !isset($config['syslog']['nologdefaultblock']);

$pconfig['logdefaultpass'] = isset($config['syslog']['nologdefaultpass']);

$pconfig['logbogons'] = !isset($config['syslog']['nologbogons']);

$pconfig['logprivatenets'] = !isset($config['syslog']['nologprivatenets']);

$pconfig['loglighttpd'] = !isset($config['syslog']['nologlighttpd']);

$pconfig['rawfilter'] = isset($config['syslog']['rawfilter']);

$pconfig['filterdescriptions'] = $config['syslog']['filterdescriptions'];

$pconfig['disablelocallogging'] = isset($config['syslog']['disablelocallogging']);

$pconfig['logfilesize'] = $config['syslog']['logfilesize'];

if (!$pconfig['nentries'])

	$pconfig['nentries'] = 50;

function is_valid_syslog_server($target) {

	return (is_ipaddr($target)

		|| is_ipaddrwithport($target)

		|| is_hostname($target)

		|| is_hostnamewithport($target));

}

if ($_POST['resetlogs'] == gettext("Reset Log Files")) {

	clear_all_log_files();

	$savemsg .= gettext("The log files have been reset.");

} elseif ($_POST) {

	unset($input_errors);

	$pconfig = $_POST;

	/* input validation */

	if ($_POST['enable'] && !is_valid_syslog_server($_POST['remoteserver'])) {

		$input_errors[] = gettext("A valid IP address/hostname or IP/hostname:port must be specified for remote syslog server #1.");

	}

	if ($_POST['enable'] && $_POST['remoteserver2'] && !is_valid_syslog_server($_POST['remoteserver2'])) {

		$input_errors[] = gettext("A valid IP address/hostname or IP/hostname:port must be specified for remote syslog server #2.");

	}

	if ($_POST['enable'] && $_POST['remoteserver3'] && !is_valid_syslog_server($_POST['remoteserver3'])) {

		$input_errors[] = gettext("A valid IP address/hostname or IP/hostname:port must be specified for remote syslog server #3.");

	}

	if (($_POST['nentries'] < 5) || ($_POST['nentries'] > 2000)) {

		$input_errors[] = gettext("Number of log entries to show must be between 5 and 2000.");

	}

	if (isset($_POST['logfilesize']) && (strlen($_POST['logfilesize']) > 0)) {

		if (!is_numeric($_POST['logfilesize']) || ($_POST['logfilesize'] < 100000)) {

			$input_errors[] = gettext("Log file size must be numeric and greater than or equal to 100000.");

		}

	}

	if (!$input_errors) {

		$config['syslog']['reverse'] = $_POST['reverse'] ? true : false;

		$config['syslog']['nentries'] = (int)$_POST['nentries'];

		$pconfig['nentries'] = $config['syslog']['nentries'];

		if (isset($_POST['logfilesize']) && (strlen($_POST['logfilesize']) > 0)) {

			$config['syslog']['logfilesize'] = (int)$_POST['logfilesize'];

			$pconfig['logfilesize'] = $config['syslog']['logfilesize'];

		} else {

			unset($config['syslog']['logfilesize']);

		}

		$config['syslog']['remoteserver'] = $_POST['remoteserver'];

		$config['syslog']['remoteserver2'] = $_POST['remoteserver2'];

		$config['syslog']['remoteserver3'] = $_POST['remoteserver3'];

		$config['syslog']['sourceip'] = $_POST['sourceip'];

		$config['syslog']['ipproto'] = $_POST['ipproto'];

		$config['syslog']['filter'] = $_POST['filter'] ? true : false;

		$config['syslog']['dhcp'] = $_POST['dhcp'] ? true : false;

		$config['syslog']['portalauth'] = $_POST['portalauth'] ? true : false;

		$config['syslog']['vpn'] = $_POST['vpn'] ? true : false;

		$config['syslog']['apinger'] = $_POST['apinger'] ? true : false;

		$config['syslog']['relayd'] = $_POST['relayd'] ? true : false;

		$config['syslog']['hostapd'] = $_POST['hostapd'] ? true : false;

		$config['syslog']['logall'] = $_POST['logall'] ? true : false;

		$config['syslog']['system'] = $_POST['system'] ? true : false;

		$config['syslog']['disablelocallogging'] = $_POST['disablelocallogging'] ? true : false;

		$config['syslog']['enable'] = $_POST['enable'] ? true : false;

		$oldnologdefaultblock = isset($config['syslog']['nologdefaultblock']);

		$oldnologdefaultpass = isset($config['syslog']['nologdefaultpass']);

		$oldnologbogons = isset($config['syslog']['nologbogons']);

		$oldnologprivatenets = isset($config['syslog']['nologprivatenets']);

		$oldnologlighttpd = isset($config['syslog']['nologlighttpd']);

		$config['syslog']['nologdefaultblock'] = $_POST['logdefaultblock'] ? false : true;

		$config['syslog']['nologdefaultpass'] = $_POST['logdefaultpass'] ? true : false;

		$config['syslog']['nologbogons'] = $_POST['logbogons'] ? false : true;

		$config['syslog']['nologprivatenets'] = $_POST['logprivatenets'] ? false : true;

		$config['syslog']['nologlighttpd'] = $_POST['loglighttpd'] ? false : true;

		$config['syslog']['rawfilter'] = $_POST['rawfilter'] ? true : false;

		if (is_numeric($_POST['filterdescriptions']) && $_POST['filterdescriptions'] > 0)

			$config['syslog']['filterdescriptions'] = $_POST['filterdescriptions'];

		else

			unset($config['syslog']['filterdescriptions']);

		if($config['syslog']['enable'] == false) {

			unset($config['syslog']['remoteserver']);

			unset($config['syslog']['remoteserver2']);

			unset($config['syslog']['remoteserver3']);

		}

		write_config();

		$retval = 0;

		$retval = system_syslogd_start();

		if (($oldnologdefaultblock !== isset($config['syslog']['nologdefaultblock']))

			|| ($oldnologdefaultpass !== isset($config['syslog']['nologdefaultpass']))

			|| ($oldnologbogons !== isset($config['syslog']['nologbogons']))

			|| ($oldnologprivatenets !== isset($config['syslog']['nologprivatenets'])))

			$retval |= filter_configure();

		$savemsg = get_std_save_message($retval);

		if ($oldnologlighttpd !== isset($config['syslog']['nologlighttpd'])) {

			ob_flush();

			flush();

			log_error(gettext("webConfigurator configuration has changed. Restarting webConfigurator."));

			send_event("service restart webgui");

			$savemsg .= "<br />" . gettext("WebGUI process is restarting.");

		}

		filter_pflog_start(true);

	}

}

$pgtitle = array(gettext("Status"), gettext("System logs"), gettext("Settings"));

include("head.inc");

$logfilesizeHelp =	gettext("Logs are held in constant-size circular log files. This field controls how large each log file is, and thus how many entries may exist inside the log. By default this is approximately 500KB per log file, and there are nearly 20 such log files.") .

					'<br /><br />' .

					gettext("NOTE: Log sizes are changed the next time a log file is cleared or deleted. To immediately increase the size of the log files, you must first save the options to set the size, then clear all logs using the \"Reset Log Files\" option farther down this page. ") .

					gettext("Be aware that increasing this value increases every log file size, so disk usage will increase significantly.") . '<br /><br />' .

					gettext("Disk space currently used by log files is: ") . exec("/usr/bin/du -sh /var/log | /usr/bin/awk '{print $1;}'") .

					gettext(" Remaining disk space for log files: ") . exec("/bin/df -h /var/log | /usr/bin/awk '{print $4;}'");

$remoteloghelp =	gettext("This option will allow the logging daemon to bind to a single IP address, rather than all IP addresses.") .

					gettext("If you pick a single IP, remote syslog severs must all be of that IP type. If you wish to mix IPv4 and IPv6 remote syslog servers, you must bind to all interfaces.") .

					"<br /><br />" .

					gettext("NOTE: If an IP address cannot be located on the chosen interface, the daemon will bind to all addresses.");

if ($input_errors)

	print_input_errors($input_errors);

else if ($savemsg)

	print_info_box($savemsg);

$tab_array = array();

$tab_array[] = array(gettext("System"), false, "diag_logs.php");

$tab_array[] = array(gettext("Firewall"), false, "diag_logs_filter.php");

$tab_array[] = array(gettext("DHCP"), false, "diag_logs.php?logfile=dhcpd");

$tab_array[] = array(gettext("Portal Auth"), false, "diag_logs.php?logfile=portalauth");

$tab_array[] = array(gettext("IPsec"), false, "diag_logs.php?logfile=ipsec");

$tab_array[] = array(gettext("PPP"), false, "diag_logs.php?logfile=ppp");

$tab_array[] = array(gettext("VPN"), false, "diag_logs_vpn.php");

$tab_array[] = array(gettext("Load Balancer"), false, "diag_logs.php?logfile=relayd");

$tab_array[] = array(gettext("OpenVPN"), false, "diag_logs.php?logfile=openvpn");

$tab_array[] = array(gettext("NTP"), false, "diag_logs.php?logfile=ntpd");

$tab_array[] = array(gettext("Settings"), true, "diag_logs_settings.php");

display_top_tabs($tab_array);

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

$form = new Form(new Form_Button(

	'Submit',

	gettext("Save")

));

$section = new Form_Section('General Logging Options');

$section->addInput(new Form_Checkbox(

	'reverse',

	'Forward/Reverse Display',

	'Show log entries in reverse order (newest entries on top)',

	$pconfig['reverse']

));

$section->addInput(new Form_Input(

	'nentries',

	'GUI Log Entries',

	'text',

	$pconfig['nentries'],

	['placeholder' => '']

))->setHelp('This is only the number of log entries displayed in the GUI. It does not affect how many entries are contained in the actual log files.');

$section->addInput(new Form_Input(

	'logfilesize',

	'Log file size (Bytes)',

	'text',

	$pconfig['logfilesize'],

	['placeholder' => 'Bytes']

))->setHelp($logfilesizeHelp);

$section->addInput(new Form_Checkbox(

	'logdefaultblock',

	'Log firewall default blocks',

	'Log packets matched from the default block rules in the ruleset',

	$pconfig['logdefaultblock']

))->setHelp('Packets that are blocked by the implicit default block rule will not be logged if you uncheck this option. Per-rule logging options are still respected.');

$section->addInput(new Form_Checkbox(

	'logdefaultpass',

	null,

	'Log packets matched from the default pass rules put in the ruleset',

	$pconfig['logdefaultpass']

))->setHelp('Packets that are allowed by the implicit default pass rule will be logged if you check this option. Per-rule logging options are still respected. ');

$section->addInput(new Form_Checkbox(

	'logbogons',

	null,

	'Log packets blocked by \'Block Bogon Networks\' rules',

	$pconfig['logbogons']

));

$section->addInput(new Form_Checkbox(

	'logprivatenets',

	null,

	'Log packets blocked by \'Block Private Networks\' rules',

	$pconfig['logprivatenets']

));

$section->addInput(new Form_Checkbox(

	'loglighttpd',

	'Web Server Log',

	'Log errors from the web server process',

	$pconfig['loglighttpd']

))->setHelp('If this is checked, errors from the lighttpd web server process for the GUI or Captive Portal will appear in the main system log');

$section->addInput(new Form_Checkbox(

	'rawfilter',

	'Raw Logs',

	'Show raw filter logs)',

	$pconfig['rawfilter']

))->setHelp(gettext('If this is checked, filter logs are shown as generated by the packet filter, without any formatting. This will reveal more detailed information, but it is more difficult to read'));

$section->addInput(new Form_Select(

	'filterdescriptions',

	'Where to show rule descriptions',

	!isset($pconfig['filterdescriptions']) ? '0':$pconfig['filterdescriptions'],

	array(

		'0' => 'Dont load descriptions',

		'1' => 'Display as column',

		'2' => 'Display as second row'

	)

))->setHelp('Show the applied rule description below or in the firewall log rows' . '<br />' .

			'Displaying rule descriptions for all lines in the log might affect performance with large rule sets');

$section->addInput(new Form_Checkbox(

	'disablelocallogging',

	'Local Logging',

	$g['platform'] == 'pfSense' ? "Disable writing log files to the local disk" : "Disable writing log files to the local RAM disk",

	$pconfig['disablelocallogging']

));

$section->addInput(new Form_Button(

	'resetlogs',

	'Reset Log Files'

))->addClass('btn-danger btn-xs')->setHelp('Clears all local log files and reinitializes them as empty logs. This also restarts the DHCP daemon. Use the Save button first if you have made any setting changes.');

$form->add($section);

$section = new Form_Section('Remote Logging Options');

$section->addClass('toggle-remote');

$section->addInput(new Form_Checkbox(

	'enable',

	'Enable Remote Logging',

	'Send log messages to remote syslog server',

	$pconfig['enable']

))->toggles('.toggle-remote .panel-body .form-group:not(:first-child)');

$section->addInput(new Form_Select(

	'sourceip',

	'Source Address',

	link_interface_to_bridge($pconfig['sourceip']) ? null : $pconfig['sourceip'],

	get_possible_traffic_source_addresses(false)

))->setHelp($remoteloghelp);

$section->addInput(new Form_Select(

	'ipproto',

	'IP Protocol',

	$ipproto,

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

))->setHelp('This option is only used when a non-default address is chosen as the source above. This option only expresses a preference; If an IP address of the selected type is not found on the chosen interface, the other type will be tried.');

// Group colapses/appears based on 'enable' checkbox above

$group = new Form_Group('Remote log servers');

$group->add(new Form_Input(

	'remoteserver',

	'Server 1',

	'text',

	$pconfig['remoteserver'],

	['placeholder' => 'IP[:port]']

));

$group->add(new Form_Input(

	'remoteserver2',

	'Server 2',

	'text',

	$pconfig['remoteserver2'],

	['placeholder' => 'IP[:port]']

));

$group->add(new Form_Input(

	'remoteserver3',

	'Server 3',

	'text',

	$pconfig['remoteserver3'],

	['placeholder' => 'IP[:port]']

));

$section->add($group);

$group = new Form_Group('Remote Syslog Contents');

$group->add(new Form_Checkbox(

	'system',

	null,

	'System Events',

	$pconfig['system']

));

$group->add(new Form_Checkbox(

	'filter',

	null,

	'Firewall Events',

	$pconfig['filter']

));

$group->add(new Form_Checkbox(

	'dhcp',

	null,

	'DHCP service events',

	$pconfig['dhcp']

));

$group->add(new Form_Checkbox(

	'portalauth',

	null,

	'Portal Auth events',

	$pconfig['portalauth']

));

$group->add(new Form_Checkbox(

	'vpn',

	null,

	'VPN (PPTP, IPsec, OpenVPN) events',

	$pconfig['vpn']

));

$group->add(new Form_Checkbox(

	'apinger',

	null,

	'Gateway Monitor events',

	$pconfig['apinger']

));

$group->add(new Form_Checkbox(

	'relayd',

	null,

	'Server Load Balancer events',

	$pconfig['relayd']

));

$group->add(new Form_Checkbox(

	'hostapd',

	null,

	'Wireless events',

	$pconfig['hostapd']

));

$group->setHelp('syslog sends UDP datagrams to port 514 on the specified remote '.

	'syslog server, unless another port is specified. Be sure to set syslogd on '.

	'the remote server to accept syslog messages from pfSense.');

$section->add($group);

$form->add($section);

print $form;

include("foot.inc");