Unofficial E2guardian package for pfSense

pfsensation

Script by remzej
Original: https://forum.pfsense.org/index.php?topic=126309.msg727239#msg727239

Modified:

#!/usr/local/bin/php-cgi -q
/*
 * monitor_memory_usage.php
 *
 * part of pfSense (https://www.pfsense.org)
 * Copyright (c) 2011-2015 Rubicon Communications, LLC (Netgate)
 * All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
require_once('config.inc');
require_once('util.inc');
require_once('squid.inc');
require_once('e2guardian.inc');
global $config;

	// Monitor memory usage by remzej
	// Get SWAP usage funtion
	function swap_usage() {
		exec("/usr/sbin/swapinfo", $swap_info);
		$swap_used = "";
		foreach ($swap_info as $line) {
			if (preg_match('/(\d+)%$/', $line, $matches)) {
				$swap_used = $matches[1];
				break;
			}
		}
		return $swap_used;
	}

	// Get memory usage function
	function mem_usage() {
		$memory = "";
		exec("/sbin/sysctl -n vm.stats.vm.v_page_count vm.stats.vm.v_inactive_count " .
			"vm.stats.vm.v_cache_count vm.stats.vm.v_free_count", $memory);

		$totalMem = $memory[0];
		$availMem = $memory[1] + $memory[2] + $memory[3];
		$usedMem = $totalMem - $availMem;
		$memUsage = round(($usedMem * 100) / $totalMem, 0);

		return $memUsage;
	}
	
	// Get memory and SWAP usage value
	$memusage_pct = mem_usage();
	$swapusage_pct = swap_usage();

	// Display memory usage
	echo "Memory Usage: " . $memusage_pct . "%" . PHP_EOL;
	echo "SWAP Usage: " . $swapusage_pct . "%" . PHP_EOL;

	// If memory usage is above 90% and SWAP usage is above 75%, stop and restart squid services.  
	if ((($memusage_pct > 70) && ($swapusage_pct > 50)) || ($memusage_pct > 55) ) {
		// stop e2g service
		exec("/usr/local/sbin/e2guardian stop");
		// stop squid service
		squid_stop_monitor();
		if (is_service_running('squid')) {
			stop_service("squid");
		}
                // start e2g service
		exec("/usr/local/sbin/e2guardian start");
		// start squid service
                squid_restart_services();
		log_error(gettext(sprintf("[squid] Memory usage is $memusage_pct percent and SWAP usage is $swapusage_pct percent, stopping and restarting services.")));
	}
?>

Thanks! I see you left the code for Squid there too, is there really a need to kill off squid too? From what I've seen, restarting E2 Guardian works just fine.

empbilly

@pfsensation:

@empbilly:

Script by remzej
Original: https://forum.pfsense.org/index.php?topic=126309.msg727239#msg727239

Modified:

#!/usr/local/bin/php-cgi -q
/*
 * monitor_memory_usage.php
 *
 * part of pfSense (https://www.pfsense.org)
 * Copyright (c) 2011-2015 Rubicon Communications, LLC (Netgate)
 * All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
require_once('config.inc');
require_once('util.inc');
require_once('squid.inc');
require_once('e2guardian.inc');
global $config;

	// Monitor memory usage by remzej
	// Get SWAP usage funtion
	function swap_usage() {
		exec("/usr/sbin/swapinfo", $swap_info);
		$swap_used = "";
		foreach ($swap_info as $line) {
			if (preg_match('/(\d+)%$/', $line, $matches)) {
				$swap_used = $matches[1];
				break;
			}
		}
		return $swap_used;
	}

	// Get memory usage function
	function mem_usage() {
		$memory = "";
		exec("/sbin/sysctl -n vm.stats.vm.v_page_count vm.stats.vm.v_inactive_count " .
			"vm.stats.vm.v_cache_count vm.stats.vm.v_free_count", $memory);

		$totalMem = $memory[0];
		$availMem = $memory[1] + $memory[2] + $memory[3];
		$usedMem = $totalMem - $availMem;
		$memUsage = round(($usedMem * 100) / $totalMem, 0);

		return $memUsage;
	}
	
	// Get memory and SWAP usage value
	$memusage_pct = mem_usage();
	$swapusage_pct = swap_usage();

	// Display memory usage
	echo "Memory Usage: " . $memusage_pct . "%" . PHP_EOL;
	echo "SWAP Usage: " . $swapusage_pct . "%" . PHP_EOL;

	// If memory usage is above 90% and SWAP usage is above 75%, stop and restart squid services.  
	if ((($memusage_pct > 70) && ($swapusage_pct > 50)) || ($memusage_pct > 55) ) {
		// stop e2g service
		exec("/usr/local/sbin/e2guardian stop");
		// stop squid service
		squid_stop_monitor();
		if (is_service_running('squid')) {
			stop_service("squid");
		}
                // start e2g service
		exec("/usr/local/sbin/e2guardian start");
		// start squid service
                squid_restart_services();
		log_error(gettext(sprintf("[squid] Memory usage is $memusage_pct percent and SWAP usage is $swapusage_pct percent, stopping and restarting services.")));
	}
?>

Thanks! I see you left the code for Squid there too, is there really a need to kill off squid too? From what I've seen, restarting E2 Guardian works just fine.

So, I ended up just adding the e2g block. :D

pfsensation

I'm starting to experience system dumps again. Anyone else experiencing the same? Very strange… I've already clean installed.

marcelloc

@pfsensation:

I'm starting to experience system dumps again. Anyone else experiencing the same? Very strange… I've already clean installed.

I've compiled the binaries again with the little changes from previous 4.1.2_2 we were using to 4.1.3. I don't expect any change on process behavior from last update but I've compiled it anyway to keep this project with the latest updates from e2guardian.

pfsensation

@marcelloc:

@pfsensation:

I'm starting to experience system dumps again. Anyone else experiencing the same? Very strange… I've already clean installed.

I've compiled the binaries again with the little changes from previous 4.1.2_2 we were using to 4.1.3. I don't expect any change on process behavior from last update but I've compiled it anyway to keep this project with the latest updates from e2guardian.

https://pastebin.com/zdMs98Zy It's now crashing often again… Only thing that changed is I think at one point there was a unexpected loss of power to the machine. Could this be it?

pfsensation

Marcello can you take a look at the dump? Also how can I fully clean all files left over by E2Guardian? It's really annoying, I don't want to keep reinstalling pfSense…That sucks.

marcelloc

@pfsensation:

Also how can I fully clean all files left over by E2Guardian?

Uninstall the package will remove xml files and bsd package. /usr/local/etc/e2guardian will keep some files and e2guardian options will stay on xml.

marcelloc

Great news!

v5-testing has the ssl filtering

bedmakaveli

Hello guys,
here I am again :) .
After setting all up, and get E2guardian working correctly, I would love to redirect to the courtesy page also for https pages.
I've read a lot of posts without finding something clear.
I'm using explicit proxy setting, so i don't need the MITSSL, or at least I think so.
There is a way to redirect the https pages to the courtesy page visualized on blocked http traffic or should i lose my hopes?

Thanks marcelloc for all the work, I'll repay the efforts with a lot of coffes :)

PS: sorry for the repost, maybe here is the correct place for this kind of question :)

marcelloc

Take a look on report options. You can redirect to a external url or chance current template.

bedmakaveli

@marcelloc:

Take a look on report options. You can redirect to a external url or chance current template.

Thanks marcelloc for the reply.
But how can I redirect to the report page when I try to access to an https site?
It seems to work only for http sites.

marcelloc

@bedmakaveli:

@marcelloc:

Take a look on report options. You can redirect to a external url or chance current template.

Thanks marcelloc for the reply.
But how can I redirect to the report page when I try to access to an https site?
It seems to work only for http sites.

Intercepting SSL. You can setup it on group settings but you need to install certificate authority on clients.

bedmakaveli

@marcelloc:

@bedmakaveli:

@marcelloc:

Take a look on report options. You can redirect to a external url or chance current template.

Thanks marcelloc for the reply.
But how can I redirect to the report page when I try to access to an https site?
It seems to work only for http sites.

Intercepting SSL. You can setup it on group settings but you need to install certificate authority on clients.

Thanks Marcello, it works like a charm now. I've tried with a self signed CA.

Thanks again!

pfsensation

Hi Marcello,

I'm still getting crashes, can you please investigate this as there's no where else that will provide support for this setup… I'm currently on pfsense 2.4 with the latest version of E2 Guardian.

modinadar

Hello dear users of this forum. I have a question about this package. As much as I'm not trying to set up "Phrase Lists", it allways skips to sites with these words. Perhaps this is due to the fact that I use phrases from my language (Russian, I have not tried English words). I set up the mitm, it blocks everything well, "serach engines" works also only on English words, but it's not surprising. Simply Russian characters are encoded in some% as% dc% 5g … and so on. The only way for me to block using "Phrase lists", as I read on a Russian-language forum that the predecessor of Dansguardian knew how to do it, but there were difficulties with encodings. In general, it may be necessary to include some parameter in the configuration about which I do not know.
Sorry for my english, I used an interpreter.

pfsensation

Thanks to some brilliant help from the Pfsense community, I think my crashes are finally resolved with some bootloader.conf.local addons.

It'll be nice to see this package kept up to date, especially as V5 is coming out soon!

pfsensation

@modinadar:

Hello dear users of this forum. I have a question about this package. As much as I'm not trying to set up "Phrase Lists", it allways skips to sites with these words. Perhaps this is due to the fact that I use phrases from my language (Russian, I have not tried English words). I set up the mitm, it blocks everything well, "serach engines" works also only on English words, but it's not surprising. Simply Russian characters are encoded in some% as% dc% 5g … and so on. The only way for me to block using "Phrase lists", as I read on a Russian-language forum that the predecessor of Dansguardian knew how to do it, but there were difficulties with encodings. In general, it may be necessary to include some parameter in the configuration about which I do not know.
Sorry for my english, I used an interpreter.

For this matter you may be better off bringing it up in the E2 Guardian GitHub page. I believe there was an issue raised for Russian character encoding.

justroach

@pfsensation:

Thanks to some brilliant help from the Pfsense community, I think my crashes are finally resolved with some bootloader.conf.local addons.

Think you could share please?

pfsensation

@justroach:

@pfsensation:

Thanks to some brilliant help from the Pfsense community, I think my crashes are finally resolved with some bootloader.conf.local addons.

Think you could share please?

Are you having crashes too? If so do let us know more in terms of your specs.

Here's the lines I'm using currently.

kern.cam.boot_delay=10000
kern.ipc.nmbclusters=1000000
legal.intel_ipw.license_ack=1
legal.intel_iwi.license_ack=1
hw.re.enable_msix=0
hw.em.enable_msix=0
hw.pci.enable_msix=0
net.inet.tcp.tso=0
hw.em.fc_setting=0
hw.re.fc_setting=0

Do keep us informed so we can get these issues ironed out!

pfsensation

Those lines made the system more stable, but the system still seems to crash after about 7 days or so. I have fully confirmed that it's related to E2Guardian. As without E2 Guardian on a system with the same setup with all my other plugins, it's all good. The crash dump also shows E2 Guardian threads going a bit haywire. @Marcelloc please have a look into this, especially as new updates have been released by the E2 Guardian team.