]>
git.ipfire.org Git - ipfire-2.x.git/blob - config/cfgroot/ids-functions.pl
2 ############################################################################
4 # This file is part of the IPFire Firewall. #
6 # IPFire is free software; you can redistribute it and/or modify #
7 # it under the terms of the GNU General Public License as published by #
8 # the Free Software Foundation; either version 2 of the License, or #
9 # (at your option) any later version. #
11 # IPFire is distributed in the hope that it will be useful, #
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of #
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
14 # GNU General Public License for more details. #
16 # You should have received a copy of the GNU General Public License #
17 # along with IPFire; if not, write to the Free Software #
18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA #
20 # Copyright (C) 2018 IPFire Team <info@ipfire.org>. #
22 ############################################################################
26 require '/var/ipfire/general-functions.pl';
27 require "${General::swroot}/lang.pl";
29 # Location and name of the tarball which contains the ruleset.
30 our $rulestarball = "/var/tmp/snortrules.tar.gz";
32 # File to store any errors, which also will be read and displayed by the wui.
33 our $storederrorfile = "/tmp/ids_storederror";
36 ## Function for checking if at least 300MB of free disk space are available
37 ## on the "/var" partition.
39 sub checkdiskspace
() {
40 # Call diskfree to gather the free disk space of /var.
41 my @df = `/bin/df -B M /var`;
43 # Loop through the output.
44 foreach my $line (@df) {
46 next if $line =~ m/^Filesystem/;
48 # Search for a line with the device information.
49 if ($line =~ m/dev/ ) {
50 # Split the line into single pieces.
51 my @values = split(' ', $line);
52 my ($filesystem, $blocks, $used, $available, $used_perenctage, $mounted_on) = @values;
54 # Check if the available disk space is more than 300MB.
55 if ($available < 300) {
56 # If there is not enough space, print out an error message.
57 my $errormessage = "$Lang::tr{'not enough disk space'} < 300MB, /var $available MB";
59 # Exit function and return the error message.
65 # Everything okay, return nothing.
70 ## This function is responsible for downloading the configured snort ruleset.
72 ## * At first it obtains from the stored snortsettings which ruleset should be downloaded.
73 ## * The next step is to get the download locations for all available rulesets.
74 ## * After that, the function will check if an upstream proxy should be used and grab the settings.
75 ## * The last step will be to generate the final download url, by obtaining the URL for the desired
76 ## ruleset, add the settings for the upstream proxy and final grab the rules tarball from the server.
81 &General
::readhash
("${General::swroot}/snort/settings", \
%snortsettings);
83 # Get all available ruleset locations.
84 my %rulesetsources=();
85 &General
::readhash
("${General::swroot}/snort/ruleset-sources.list", \
%rulesetsources);
89 &General
::readhash
("${General::swroot}/proxy/settings", \
%proxysettings);
91 # Load required perl module to handle the download.
94 # Init the download module.
95 my $downloader = LWP
::UserAgent
->new;
97 # Set timeout to 10 seconds.
98 $downloader->timeout(10);
100 # Check if an upstream proxy is configured.
101 if ($proxysettings{'UPSTREAM_PROXY'}) {
102 my ($peer, $peerport) = (/^(?:[a-zA-Z ]+\:\/\
/)?(?:[A-Za-z0-9\_\.\-]*?(?:\:[A-Za-z0-9\_\.\-]*?)?\@)?([a-zA-Z0-9\.\_\-]*?)(?:\:([0-9]{1,5}))?(?:\/.*?
)?
$/);
105 # Check if we got a peer.
107 $proxy_url = "http://";
109 # Check if the proxy requires authentication.
110 if (($proxysettings{'UPSTREAM_USER'}) && ($proxysettings{'UPSTREAM_PASSWORD'})) {
111 $proxy_url .= "$proxysettings{'UPSTREAM_USER'}\:$proxysettings{'UPSTREAM_PASSWORD'}\@";
114 # Add proxy server address and port.
115 $proxy_url .= "$peer\:$peerport";
117 # Break and return error message.
118 return "$Lang::tr{'could not download latest updates'}";
121 # Setup proxy settings.
122 $downloader->proxy('http', $proxy_url);
125 # Grab the right url based on the configured vendor.
126 my $url = $rulesetsources{$snortsettings{'RULES'}};
128 # Check if the vendor requires an oinkcode and add it if needed.
129 $url =~ s/\<oinkcode\>/$snortsettings{'OINKCODE'}/g;
131 # Abort if no url could be determined for the vendor.
133 # Abort and return errormessage.
134 return "$Lang::tr{'could not download latest updates'}";
137 # Pass the requested url to the downloader.
138 my $request = HTTP
::Request
->new(GET
=> $url);
140 # Perform the request and save the output into the "$rulestarball" file.
141 my $response = $downloader->request($request, $rulestarball);
143 # Check if there was any error.
144 unless ($response->is_success) {
145 # Return error message.
146 return "$response->status_line";
149 # If we got here, everything worked fine. Return nothing.
154 ## A tiny wrapper function to call the oinkmaster script.
157 # Load perl module to talk to the kernel syslog.
158 use Sys
::Syslog
qw(:DEFAULT setlogsock);
160 # Establish the connection to the syslog service.
161 openlog
('oinkmaster', 'cons,pid', 'user');
163 # Call oinkmaster to generate ruleset.
164 open(OINKMASTER
, "/usr/local/bin/oinkmaster.pl -v -s -u file://$rulestarball -C /var/ipfire/snort/oinkmaster.conf -o /etc/snort/rules|");
166 # Log output of oinkmaster to syslog.
167 while(<OINKMASTER
>) {
168 # The syslog function works best with an array based input,
169 # so generate one before passing the message details to syslog.
170 my @syslog = ("INFO", "$_");
172 # Send the log message.
176 # Close the pipe to oinkmaster process.
179 # Close the log handle.
184 ## Function to do all the logging stuff if the downloading or updating of the ruleset fails.
189 # Remove any newline.
192 # Call private function to write/store the error message in the storederrorfile.
193 &_store_error_message
($error);
197 ## Private function to write a given error message to the storederror file.
199 sub _store_error_message
($) {
202 # Remove any newline.
205 # Open file for writing.
206 open (ERRORFILE
, ">$storederrorfile") or die "Could not write to $storederrorfile. $!\n";
208 # Write error to file.
209 print ERRORFILE
"$message\n";