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-2019 IPFire Team <info@ipfire.org> #
22 ############################################################################
28 require '/var/ipfire/general-functions.pl';
29 require "${General::swroot}/network-functions.pl";
30 require "${General::swroot}/suricata/ruleset-sources";
32 # Load perl module to deal with Archives.
35 # Load perl module to deal with files and path.
38 # Load module to move files.
41 # Load module to recursely remove files and a folder.
42 use File
::Path
qw(rmtree);
44 # Load module to get file stats.
47 # Load module to deal with temporary files.
50 # Load module to deal with the date formats used by the HTTP protocol.
53 # Load the libwwwperl User Agent module.
56 # Load function from posix module to format time strings.
57 use POSIX qw
(strftime
);
59 # Load module to talk to the kernel log daemon.
60 use Sys
::Syslog
qw(:DEFAULT setlogsock);
62 # Location where all config and settings files are stored.
63 our $settingsdir = "${General::swroot}/suricata";
65 # File where the main file for providers ruleset inclusion exists.
66 our $suricata_used_providers_file = "$settingsdir/suricata-used-providers.yaml";
68 # File for static ruleset inclusions.
69 our $suricata_default_rulefiles_file = "$settingsdir/suricata-default-rules.yaml";
71 # File where the addresses of the homenet are stored.
72 our $homenet_file = "$settingsdir/suricata-homenet.yaml";
74 # File where the addresses of the used DNS servers are stored.
75 our $dns_servers_file = "$settingsdir/suricata-dns-servers.yaml";
77 # File where the HTTP ports definition is stored.
78 our $http_ports_file = "$settingsdir/suricata-http-ports.yaml";
80 # File which contains includes for provider specific rule modifications.
81 our $oinkmaster_provider_includes_file = "$settingsdir/oinkmaster-provider-includes.conf";
83 # File which contains wheater the rules should be changed.
84 our $modify_sids_file = "$settingsdir/oinkmaster-modify-sids.conf";
86 # File which stores the configured IPS settings.
87 our $ids_settings_file = "$settingsdir/settings";
89 # File which stores the used and configured ruleset providers.
90 our $providers_settings_file = "$settingsdir/providers-settings";
92 # File which stores the configured settings for whitelisted addresses.
93 our $ignored_file = "$settingsdir/ignored";
95 # Location where the downloaded rulesets are stored.
96 our $dl_rules_path = "/var/tmp";
98 # File to store any errors, which also will be read and displayed by the wui.
99 our $storederrorfile = "/tmp/ids_storederror";
101 # File to lock the WUI, while the autoupdate script runs.
102 our $ids_page_lock_file = "/tmp/ids_page_locked";
104 # Location where the rulefiles are stored.
105 our $rulespath = "/var/lib/suricata";
107 # Location where the default rulefils are stored.
108 our $default_rulespath = "/usr/share/suricata/rules";
110 # Location where the addition config files are stored.
111 our $configspath = "/usr/share/suricata";
113 # Location of the classification file.
114 our $classification_file = "$configspath/classification.config";
116 # Location of the sid to msg mappings file.
117 our $sid_msg_file = "$rulespath/sid-msg.map";
119 # Location to store local rules. This file will not be touched.
120 our $local_rules_file = "$rulespath/local.rules";
122 # File which contains the rules to whitelist addresses on suricata.
123 our $whitelist_file = "$rulespath/whitelist.rules";
125 # File which contains a list of all supported ruleset sources.
126 # (Sourcefire, Emergingthreads, etc..)
127 our $rulesetsourcesfile = "$settingsdir/ruleset-sources";
129 # The pidfile of the IDS.
130 our $idspidfile = "/var/run/suricata.pid";
132 # Location of suricatactrl.
133 my $suricatactrl = "/usr/local/bin/suricatactrl";
135 # Prefix for each downloaded ruleset.
136 my $dl_rulesfile_prefix = "idsrules";
138 # Temporary directory where the rulesets will be extracted.
139 my $tmp_directory = "/tmp/ids_tmp";
141 # Temporary directory where the extracted rules files will be stored.
142 my $tmp_rules_directory = "$tmp_directory/rules";
144 # Temporary directory where the extracted additional config files will be stored.
145 my $tmp_conf_directory = "$tmp_directory/conf";
147 # Array with allowed commands of suricatactrl.
148 my @suricatactrl_cmds = ( 'start', 'stop', 'restart', 'reload', 'fix-rules-dir', 'cron' );
150 # Array with supported cron intervals.
151 my @cron_intervals = ('off', 'daily', 'weekly' );
153 # Array which contains the HTTP ports, which statically will be declared as HTTP_PORTS in the
155 my @http_ports = ('80', '81');
157 # Array which contains a list of rulefiles which always will be included if they exist.
158 my @static_included_rulefiles = ('local.rules', 'whitelist.rules');
160 # Array which contains a list of allways enabled application layer protocols.
161 my @static_enabled_app_layer_protos = ('app-layer', 'decoder', 'files', 'stream');
163 # Hash which allows to convert the download type (dl_type) to a file suffix.
164 my %dl_type_to_suffix = (
165 "archive" => ".tar.gz",
169 # Hash to translate an application layer protocol to the application name.
170 my %tr_app_layer_proto = (
172 "krb5" => "kerberos",
176 ## Function to check and create all IDS related files, if the does not exist.
178 sub check_and_create_filelayout
() {
179 # Check if the files exist and if not, create them.
180 unless (-f
"$oinkmaster_provider_includes_file") { &create_empty_file
($oinkmaster_provider_includes_file); }
181 unless (-f
"$modify_sids_file") { &create_empty_file
($modify_sids_file); }
182 unless (-f
"$suricata_used_providers_file") { &create_empty_file
($suricata_used_providers_file); }
183 unless (-f
"$suricata_default_rulefiles_file") { &create_empty_file
($suricata_default_rulefiles_file); }
184 unless (-f
"$ids_settings_file") { &create_empty_file
($ids_settings_file); }
185 unless (-f
"$providers_settings_file") { &create_empty_file
($providers_settings_file); }
186 unless (-f
"$whitelist_file" ) { &create_empty_file
($whitelist_file); }
190 ## Function to get a list of all available ruleset providers.
192 ## They will be returned as a sorted array.
194 sub get_ruleset_providers
() {
197 # Loop through the hash of providers.
198 foreach my $provider ( keys %IDS::Ruleset
::Providers
) {
199 # Add the provider to the array.
200 push(@providers, $provider);
203 # Sort and return the array.
204 return sort(@providers);
208 ## Function to get a list of all enabled ruleset providers.
210 ## They will be returned as an array.
212 sub get_enabled_providers
() {
213 my %used_providers = ();
215 # Array to store the enabled providers.
216 my @enabled_providers = ();
218 # Read-in the providers config file.
219 &General
::readhasharray
("$providers_settings_file", \
%used_providers);
221 # Loop through the hash of used_providers.
222 foreach my $id (keys %used_providers) {
223 # Skip disabled providers.
224 next unless ($used_providers{$id}[3] eq "enabled");
226 # Grab the provider handle.
227 my $provider = "$used_providers{$id}[0]";
229 # Add the provider to the array of enabled providers.
230 push(@enabled_providers, $provider);
234 return @enabled_providers;
238 ## Function for checking if at least 300MB of free disk space are available
239 ## on the "/var" partition.
241 sub checkdiskspace
() {
242 # Call diskfree to gather the free disk space of /var.
243 my @df = &General
::system_output
("/bin/df", "-B", "M", "/var");
245 # Loop through the output.
246 foreach my $line (@df) {
247 # Ignore header line.
248 next if $line =~ m/^Filesystem/;
250 # Search for a line with the device information.
251 if ($line =~ m/dev/ ) {
252 # Split the line into single pieces.
253 my @values = split(' ', $line);
254 my ($filesystem, $blocks, $used, $available, $used_perenctage, $mounted_on) = @values;
256 # Check if the available disk space is more than 300MB.
257 if ($available < 300) {
258 # Log error to syslog.
259 &_log_to_syslog
("Not enough free disk space on /var. Only $available MB from 300 MB available.");
261 # Exit function and return "1" - False.
267 # Everything okay, return nothing.
272 ## This function is responsible for downloading the ruleset for a given provider.
274 ## * At first it initialize the downloader and sets an upstream proxy if configured.
275 ## * The next step will be to generate the final download url, by obtaining the URL for the desired
276 ## ruleset and add the settings for the upstream proxy.
277 ## * Finally the function will grab the rule file or tarball from the server.
278 ## It tries to reduce the amount of download by using the "If-Modified-Since" HTTP header.
280 sub downloadruleset
($) {
283 # The amount of download attempts before giving up and
285 my $max_dl_attempts = 3;
287 # Read proxysettings.
288 my %proxysettings=();
289 &General
::readhash
("${General::swroot}/proxy/settings", \
%proxysettings);
291 # Init the download module.
293 # Request SSL hostname verification and specify path
295 my $downloader = LWP
::UserAgent
->new(
297 SSL_ca_file
=> '/etc/ssl/cert.pem',
298 verify_hostname
=> 1,
302 # Set timeout to 10 seconds.
303 $downloader->timeout(10);
305 # Check if an upstream proxy is configured.
306 if ($proxysettings{'UPSTREAM_PROXY'}) {
309 $proxy_url = "http://";
311 # Check if the proxy requires authentication.
312 if (($proxysettings{'UPSTREAM_USER'}) && ($proxysettings{'UPSTREAM_PASSWORD'})) {
313 $proxy_url .= "$proxysettings{'UPSTREAM_USER'}\:$proxysettings{'UPSTREAM_PASSWORD'}\@";
316 # Add proxy server address and port.
317 $proxy_url .= $proxysettings{'UPSTREAM_PROXY'};
319 # Setup proxy settings.
320 $downloader->proxy(['http', 'https'], $proxy_url);
323 # Log download/update of the ruleset.
324 &_log_to_syslog
("Downloading ruleset for provider: $provider.");
326 # Grab the download url for the provider.
327 my $url = $IDS::Ruleset
::Providers
{$provider}{'dl_url'};
329 # Check if the provider requires a subscription.
330 if ($IDS::Ruleset
::Providers
{$provider}{'requires_subscription'} eq "True") {
331 # Grab the subscription code.
332 my $subscription_code = &get_subscription_code
($provider);
334 # Add the subscription code to the download url.
335 $url =~ s/\<subscription_code\>/$subscription_code/g;
339 # Abort if no url could be determined for the provider.
341 # Log error and abort.
342 &_log_to_syslog
("Unable to gather a download URL for the selected ruleset provider.");
346 # Pass the requested URL to the downloader.
347 my $request = HTTP
::Request
->new(GET
=> $url);
349 # Generate temporary file name, located in "/var/tmp" and with a suffix of ".tmp".
350 # The downloaded file will be stored there until some sanity checks are performed.
351 my $tmp = File
::Temp
->new( SUFFIX
=> ".tmp", DIR
=> "/var/tmp/", UNLINK
=> 0 );
352 my $tmpfile = $tmp->filename();
354 # Call function to get the final path and filename for the downloaded file.
355 my $dl_rulesfile = &_get_dl_rulesfile
($provider);
357 # Check if the rulesfile already exits, because it has been downloaded in the past.
359 # In this case we are requesting the server if the remote file has been changed or not.
360 # This will be done by sending the modification time in a special HTTP header.
361 if (-f
$dl_rulesfile) {
362 # Call stat on the file.
363 my $stat = stat($dl_rulesfile);
365 # Omit the mtime of the existing file.
366 my $mtime = $stat->mtime;
368 # Convert the timestamp into right format.
369 my $http_date = time2str
($mtime);
371 # Add the If-Modified-Since header to the request to ask the server if the
372 # file has been modified.
373 $request->header( 'If-Modified-Since' => "$http_date" );
379 # Download and retry on failure.
380 while ($dl_attempt <= $max_dl_attempts) {
381 # Perform the request and save the output into the tmpfile.
382 $response = $downloader->request($request, $tmpfile);
384 # Check if the download was successfull.
385 if($response->is_success) {
389 # Check if the server responds with 304 (Not Modified).
390 } elsif ($response->code == 304) {
392 &_log_to_syslog
("Ruleset is up-to-date, no update required.");
394 # Nothing to do, the ruleset is up-to-date.
397 # Check if we ran out of download re-tries.
398 } elsif ($dl_attempt eq $max_dl_attempts) {
400 my $error = $response->content;
403 &_log_to_syslog
("Unable to download the ruleset. \($error\)");
405 # Return "1" - false.
409 # Remove temporary file, if one exists.
410 unlink("$tmpfile") if (-e
"$tmpfile");
412 # Increase download attempt counter.
416 # Obtain the connection headers.
417 my $headers = $response->headers;
419 # Get the timestamp from header, when the file has been modified the
421 my $last_modified = $headers->last_modified;
423 # Get the remote size of the downloaded file.
424 my $remote_filesize = $headers->content_length;
426 # Perform stat on the tmpfile.
427 my $stat = stat($tmpfile);
429 # Grab the local filesize of the downloaded tarball.
430 my $local_filesize = $stat->size;
432 # Check if both file sizes match.
433 if (($remote_filesize) && ($remote_filesize ne $local_filesize)) {
435 &_log_to_syslog
("Unable to completely download the ruleset. ");
436 &_log_to_syslog
("Only got $local_filesize Bytes instead of $remote_filesize Bytes. ");
438 # Delete temporary file.
441 # Return "1" - false.
445 # Check if a file name could be obtained.
446 unless ($dl_rulesfile) {
448 &_log_to_syslog
("Unable to store the downloaded rules file. ");
450 # Delete downloaded temporary file.
453 # Return "1" - false.
457 # Overwrite the may existing rulefile or tarball with the downloaded one.
458 move
("$tmpfile", "$dl_rulesfile");
460 # Check if we got a last-modified value from the server.
461 if ($last_modified) {
462 # Assign the last-modified timestamp as mtime to the
464 utime(time(), "$last_modified", "$dl_rulesfile");
467 # Delete temporary file.
470 # Set correct ownership for the tarball.
471 set_ownership
("$dl_rulesfile");
473 # If we got here, everything worked fine. Return nothing.
478 ## Function to extract a given ruleset.
480 ## In case the ruleset provider offers a plain file, it simply will
483 sub extractruleset
($) {
486 # Disable chown functionality when uncompressing files.
487 $Archive::Tar
::CHOWN
= "0";
489 # Get full path and downloaded rulesfile for the given provider.
490 my $tarball = &_get_dl_rulesfile
($provider);
492 # Check if the file exists.
493 unless (-f
$tarball) {
494 &_log_to_syslog
("Could not find ruleset file: $tarball");
500 # Check if the temporary directories exist, otherwise create them.
501 mkdir("$tmp_directory") unless (-d
"$tmp_directory");
502 mkdir("$tmp_rules_directory") unless (-d
"$tmp_rules_directory");
503 mkdir("$tmp_conf_directory") unless (-d
"$tmp_conf_directory");
505 # Omit the type (dl_type) of the stored ruleset.
506 my $type = $IDS::Ruleset
::Providers
{$provider}{'dl_type'};
508 # Handle the different ruleset types.
509 if ($type eq "plain") {
510 # Generate destination filename an full path.
511 my $destination = "$tmp_rules_directory/$provider\-ruleset.rules";
513 # Copy the file into the temporary rules directory.
514 copy
($tarball, $destination);
516 } elsif ( $type eq "archive") {
517 # Initialize the tar module.
518 my $tar = Archive
::Tar
->new($tarball);
520 # Get the filelist inside the tarball.
521 my @packed_files = $tar->list_files;
523 # Loop through the filelist.
524 foreach my $packed_file (@packed_files) {
527 # Splitt the packed file into chunks.
528 my $file = fileparse
($packed_file);
530 # Handle msg-id.map file.
531 if ("$file" eq "sid-msg.map") {
532 # Set extract destination to temporary config_dir.
533 $destination = "$tmp_conf_directory/$provider\-sid-msg.map";
535 # Handle classification.conf
536 } elsif ("$file" eq "classification.config") {
537 # Set extract destination to temporary config_dir.
538 $destination = "$tmp_conf_directory/$provider\-classification.config";
540 # Handle rules files.
541 } elsif ($file =~ m/\.rules$/) {
542 # Skip rule files which are not located in the rules directory or archive root.
543 next unless(($packed_file =~ /^rules\//) || ($packed_file !~ /\
//));
545 # Skip deleted.rules.
547 # Mostly they have been taken out for correctness or performance reasons and therfore
548 # it is not a great idea to enable any of them.
549 next if($file =~ m/deleted.rules$/);
553 # Splitt the filename into chunks.
554 my @filename = split("-", $file);
557 @filename = reverse(@filename);
559 # Get the amount of elements in the array.
560 my $elements = @filename;
562 # Remove last element of the hash.
563 # It contains the vendor name, which will be replaced.
564 if ($elements >= 3) {
565 # Remove last element from hash.
569 # Check if the last element of the filename does not
570 # contain the providers name.
571 if ($filename[-1] ne "$provider") {
572 # Add provider name as last element.
573 push(@filename, $provider);
576 # Reverse the array back.
577 @filename = reverse(@filename);
579 # Generate the name for the rulesfile.
580 $rulesfilename = join("-", @filename);
582 # Set extract destination to temporaray rules_dir.
583 $destination = "$tmp_rules_directory/$rulesfilename";
585 # Skip all other files.
589 # Check if the destination file exists.
590 unless(-e
"$destination") {
591 # Extract the file to the temporary directory.
592 $tar->extract_file("$packed_file", "$destination");
594 # Generate temporary file name, located in the temporary rules directory and a suffix of ".tmp".
595 my $tmp = File
::Temp
->new( SUFFIX
=> ".tmp", DIR
=> "$tmp_rules_directory", UNLINK
=> 0 );
596 my $tmpfile = $tmp->filename();
598 # Extract the file to the new temporary file name.
599 $tar->extract_file("$packed_file", "$tmpfile");
601 # Open the the existing file.
602 open(DESTFILE
, ">>", "$destination") or die "Could not open $destination. $!\n";
603 open(TMPFILE
, "<", "$tmpfile") or die "Could not open $tmpfile. $!\n";
605 # Loop through the content of the temporary file.
607 # Append the content line by line to the destination file.
611 # Close the file handles.
615 # Remove the temporary file.
623 ## A wrapper function to call the oinkmaster script, setup the rules structues and
624 ## call the functions to merge the additional config files. (classification, sid-msg, etc.).
627 # Check if the files in rulesdir have the correct permissions.
628 &_check_rulesdir_permissions
();
630 # Cleanup the rules directory before filling it with the new rulests.
631 &_cleanup_rulesdir
();
633 # Get all enabled providers.
634 my @enabled_providers = &get_enabled_providers
();
636 # Loop through the array of enabled providers.
637 foreach my $provider (@enabled_providers) {
638 # Call the extractruleset function.
639 &extractruleset
($provider);
642 # Establish the connection to the syslog service.
643 openlog
('oinkmaster', 'cons,pid', 'user');
645 # Call oinkmaster to generate ruleset.
646 open(OINKMASTER
, "/usr/local/bin/oinkmaster.pl -s -u dir://$tmp_rules_directory -C $settingsdir/oinkmaster.conf -o $rulespath 2>&1 |") or die "Could not execute oinkmaster $!\n";
648 # Log output of oinkmaster to syslog.
649 while(<OINKMASTER
>) {
650 # The syslog function works best with an array based input,
651 # so generate one before passing the message details to syslog.
652 my @syslog = ("INFO", "$_");
654 # Send the log message.
658 # Close the pipe to oinkmaster process.
661 # Close the log handle.
664 # Call function to merge the classification files.
665 &merge_classifications
(@enabled_providers);
667 # Call function to merge the sid to message mapping files.
668 &merge_sid_msg
(@enabled_providers);
670 # Cleanup temporary directory.
671 &cleanup_tmp_directory
();
675 ## Function to merge the classifications for a given amount of providers and write them
676 ## to the classifications file.
678 sub merge_classifications
(@
) {
681 # Hash to store all collected classifications.
682 my %classifications = ();
684 # Loop through the given array of providers.
685 foreach my $provider (@providers) {
686 # Generate full path to classification file.
687 my $classification_file = "$tmp_conf_directory/$provider\-classification.config";
689 # Skip provider if no classification file exists.
690 next unless (-f
"$classification_file");
692 # Open the classification file.
693 open(CLASSIFICATION
, $classification_file) or die "Could not open file $classification_file. $!\n";
695 # Loop through the file content.
696 while(<CLASSIFICATION
>) {
697 # Parse the file and grab the classification details.
698 if ($_ =~/.*config classification\: (.*)/) {
699 # Split the grabbed details.
700 my ($short_name, $short_desc, $priority) = split("\,", $1);
702 # Check if the grabbed classification is allready known and the priority value is greater
703 # than the stored one (which causes less priority in the IDS).
704 if (($classifications{$short_name}) && ($classifications{$short_name}[1] >= $priority)) {
705 #Change the priority value to the stricter one.
706 $classifications{$short_name} = [ "$classifications{$short_name}[0]", "$priority" ];
708 # Add the classification to the hash.
709 $classifications{$short_name} = [ "$short_desc", "$priority" ];
715 close(CLASSIFICATION
);
718 # Open classification file for writing.
719 open(FILE
, ">", "$classification_file") or die "Could not write to $classification_file. $!\n";
721 # Print notice about autogenerated file.
722 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n\n";
724 # Sort and loop through the hash of classifications.
725 foreach my $key (sort keys %classifications) {
726 # Assign some nice variable names for the items.
727 my $short_name = $key;
728 my $short_desc = $classifications{$key}[0];
729 my $priority = $classifications{$key}[1];
731 # Write the classification to the file.
732 print FILE
"config classification: $short_name,$short_desc,$priority\n";
740 ## Function to merge the "sid to message mapping" files of various given providers.
742 sub merge_sid_msg
(@
) {
745 # Hash which contains all the sid to message mappings.
748 # Loop through the array of given providers.
749 foreach my $provider (@providers) {
750 # Generate full path and filename.
751 my $sid_msg_file = "$tmp_conf_directory/$provider\-sid-msg.map";
753 # Skip provider if no sid to msg mapping file for this provider exists.
754 next unless (-f
$sid_msg_file);
757 open(MAPPING
, $sid_msg_file) or die "Could not open $sid_msg_file. $!\n";
759 # Loop through the file content.
764 # Skip lines which do not start with a number,
765 next unless ($_ =~ /^\d+/);
767 # Split line content and assign it to an array.
768 my @line = split(/ \|\| /, $_);
770 # Grab the first element (and remove it) from the line array.
771 # It contains the sid.
772 my $sid = shift(@line);
774 # Store the grabbed sid and the remain array as hash value.
775 # It still contains the messages, references etc.
776 $mappings{$sid} = [@line];
783 # Open mappings file for writing.
784 open(FILE
, ">", $sid_msg_file) or die "Could not write $sid_msg_file. $!\n";
786 # Write notice about autogenerated file.
787 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n\n";
789 # Loop through the hash of mappings.
790 foreach my $sid ( sort keys %mappings) {
791 # Grab data for the sid.
792 my @data = @
{$mappings{$sid}};
794 # Add the sid to the data array.
795 unshift(@data, $sid);
798 my $line = join(" \|\| ", @data);
800 print FILE
"$line\n";
809 ## A very tiny function to move an extracted ruleset from the temporary directory into
810 ## the rules directory.
812 sub move_tmp_ruleset
() {
813 # Do a directory listing of the temporary directory.
814 opendir DH
, $tmp_rules_directory;
816 # Loop over all files.
817 while(my $file = readdir DH
) {
818 # Move them to the rules directory.
819 move
"$tmp_rules_directory/$file" , "$rulespath/$file";
822 # Close directory handle.
827 ## Function to cleanup the temporary IDS directroy.
829 sub cleanup_tmp_directory
() {
831 # Delete temporary directory and all containing files.
832 rmtree
([ "$tmp_directory" ]);
836 ## Function to do all the logging stuff if the downloading or updating of the ruleset fails.
841 # Remove any newline.
844 # Call private function to log the error message to syslog.
845 &_log_to_syslog
($error);
847 # Call private function to write/store the error message in the storederrorfile.
848 &_store_error_message
($error);
852 ## Function to log a given error message to the kernel syslog.
854 sub _log_to_syslog
($) {
857 # The syslog function works best with an array based input,
858 # so generate one before passing the message details to syslog.
859 my @syslog = ("ERR", "<ERROR> $message");
861 # Establish the connection to the syslog service.
862 openlog
('oinkmaster', 'cons,pid', 'user');
864 # Send the log message.
867 # Close the log handle.
872 ## Private function to write a given error message to the storederror file.
874 sub _store_error_message
($) {
877 # Remove any newline.
880 # Open file for writing.
881 open (ERRORFILE
, ">$storederrorfile") or die "Could not write to $storederrorfile. $!\n";
883 # Write error to file.
884 print ERRORFILE
"$message\n";
889 # Set correct ownership for the file.
890 &set_ownership
("$storederrorfile");
894 ## Private function to get the path and filename for a downloaded ruleset by a given provider.
896 sub _get_dl_rulesfile
($) {
899 # Gather the download type for the given provider.
900 my $dl_type = $IDS::Ruleset
::Providers
{$provider}{'dl_type'};
902 # Obtain the file suffix for the download file type.
903 my $suffix = $dl_type_to_suffix{$dl_type};
905 # Check if a suffix has been found.
907 # Abort return - nothing.
911 # Generate the full filename and path for the stored rules file.
912 my $rulesfile = "$dl_rules_path/$dl_rulesfile_prefix-$provider$suffix";
914 # Return the generated filename.
919 ## Tiny function to delete the stored ruleset file or tarball for a given provider.
921 sub drop_dl_rulesfile
($) {
924 # Gather the full path and name of the stored rulesfile.
925 my $rulesfile = &_get_dl_rulesfile
($provider);
927 # Check if the given rulesfile exists.
929 # Delete the stored rulesfile.
930 unlink($rulesfile) or die "Could not delete $rulesfile. $!\n";
935 ## Tiny function to get/generate the full path and filename for the providers oinkmaster
936 ## modified sids file.
938 sub get_oinkmaster_provider_modified_sids_file
($) {
941 # Generate the filename.
942 my $filename = "$settingsdir/oinkmaster-$provider-modified-sids.conf";
944 # Return the filename.
949 ## Function to directly altering the oinkmaster provider includes file.
951 ## Requires tha acition "remove" or "add" and a provider handle.
953 sub alter_oinkmaster_provider_includes_file
($$) {
954 my ($action, $provider) = @_;
956 # Call function to get the path and name for the given providers
957 # oinkmaster modified sids file.
958 my $provider_modified_sids_file = &get_oinkmaster_provider_modified_sids_file
($provider);
960 # Open the file for reading..
961 open (FILE
, $oinkmaster_provider_includes_file) or die "Could not read $oinkmaster_provider_includes_file. $!\n";
963 # Read-in file content.
966 # Close file after reading.
969 # Re-open the file for writing.
970 open(FILE
, ">", $oinkmaster_provider_includes_file) or die "Could not write to $oinkmaster_provider_includes_file. $!\n";
972 # Loop through the file content.
973 foreach my $line (@lines) {
977 # Skip line if we found our given provider and the action should be remove.
978 next if (($line =~ /$provider/) && ($action eq "remove"));
980 # Write the read-in line back to the file.
981 print FILE
"$line\n";
984 # Check if the file exists and add the provider if requested.
985 if ((-f
$provider_modified_sids_file) && ($action eq "add")) {
986 print FILE
"include $provider_modified_sids_file\n";
994 ## Function to read-in the given enabled or disables sids file.
996 sub read_enabled_disabled_sids_file
($) {
999 # Temporary hash to store the sids and their state. It will be
1000 # returned at the end of this function.
1003 # Open the given filename.
1004 open(FILE
, "$file") or die "Could not open $file. $!\n";
1006 # Loop through the file.
1012 next if ($_ =~ /^\s*$/);
1015 next if ($_ =~ /^\#/);
1017 # Splitt line into sid and state part.
1018 my ($state, $sid) = split(" ", $_);
1020 # Skip line if the sid is not numeric.
1021 next unless ($sid =~ /\d+/ );
1023 # Check if the sid was enabled.
1024 if ($state eq "enablesid") {
1025 # Add the sid and its state as enabled to the temporary hash.
1026 $temphash{$sid} = "enabled";
1027 # Check if the sid was disabled.
1028 } elsif ($state eq "disablesid") {
1029 # Add the sid and its state as disabled to the temporary hash.
1030 $temphash{$sid} = "disabled";
1031 # Invalid state - skip the current sid and state.
1045 ## Function to check if the IDS is running.
1047 sub ids_is_running
() {
1048 if(-f
$idspidfile) {
1049 # Open PID file for reading.
1050 open(PIDFILE
, "$idspidfile") or die "Could not open $idspidfile. $!\n";
1052 # Grab the process-id.
1053 my $pid = <PIDFILE
>;
1058 # Remove any newline.
1061 # Check if a directory for the process-id exists in proc.
1062 if(-d
"/proc/$pid") {
1063 # The IDS daemon is running return the process id.
1068 # Return nothing - IDS is not running.
1073 ## Function to call suricatactrl binary with a given command.
1075 sub call_suricatactrl
($) {
1076 # Get called option.
1077 my ($option, $interval) = @_;
1079 # Loop through the array of supported commands and check if
1080 # the given one is part of it.
1081 foreach my $cmd (@suricatactrl_cmds) {
1082 # Skip current command unless the given one has been found.
1083 next unless($cmd eq $option);
1085 # Check if the given command is "cron".
1086 if ($option eq "cron") {
1087 # Check if an interval has been given.
1089 # Check if the given interval is valid.
1090 foreach my $element (@cron_intervals) {
1091 # Skip current element until the given one has been found.
1092 next unless($element eq $interval);
1094 # Call the suricatactrl binary and pass the "cron" command
1095 # with the requrested interval.
1096 &General
::system("$suricatactrl", "$option", "$interval");
1098 # Return "1" - True.
1103 # If we got here, the given interval is not supported or none has been given. - Return nothing.
1106 # Call the suricatactrl binary and pass the requrested
1108 &General
::system("$suricatactrl", "$option");
1110 # Return "1" - True.
1115 # Command not found - return nothing.
1120 ## Function to create a new empty file.
1122 sub create_empty_file
($) {
1125 # Check if the given file exists.
1127 # Do nothing to prevent from overwriting existing files.
1131 # Open the file for writing.
1132 open(FILE
, ">$file") or die "Could not write to $file. $!\n";
1134 # Close file handle.
1142 ## Private function to check if the file permission of the rulespath are correct.
1143 ## If not, call suricatactrl to fix them.
1145 sub _check_rulesdir_permissions
() {
1146 # Check if the rulepath main directory is writable.
1147 unless (-W
$rulespath) {
1148 # If not call suricatctrl to fix it.
1149 &call_suricatactrl
("fix-rules-dir");
1152 # Open snort rules directory and do a directory listing.
1153 opendir(DIR
, $rulespath) or die $!;
1154 # Loop through the direcory.
1155 while (my $file = readdir(DIR
)) {
1156 # We only want files.
1157 next unless (-f
"$rulespath/$file");
1159 # Check if the file is writable by the user.
1160 if (-W
"$rulespath/$file") {
1161 # Everything is okay - go on to the next file.
1164 # There are wrong permissions, call suricatactrl to fix it.
1165 &call_suricatactrl
("fix-rules-dir");
1171 ## Private function to cleanup the directory which contains
1172 ## the IDS rules, before extracting and modifing the new ruleset.
1174 sub _cleanup_rulesdir
() {
1175 # Open rules directory and do a directory listing.
1176 opendir(DIR
, $rulespath) or die $!;
1178 # Loop through the direcory.
1179 while (my $file = readdir(DIR
)) {
1180 # We only want files.
1181 next unless (-f
"$rulespath/$file");
1183 # Skip rules file for whitelisted hosts.
1184 next if ("$rulespath/$file" eq $whitelist_file);
1186 # Skip rules file with local rules.
1187 next if ("$rulespath/$file" eq $local_rules_file);
1189 # Delete the current processed file, if not, exit this function
1190 # and return an error message.
1191 unlink("$rulespath/$file") or return "Could not delete $rulespath/$file. $!\n";
1199 ## Function to generate the file which contains the home net information.
1201 sub generate_home_net_file
() {
1204 # Read-in network settings.
1205 &General
::readhash
("${General::swroot}/ethernet/settings", \
%netsettings);
1207 # Get available network zones.
1208 my @network_zones = &Network
::get_available_network_zones
();
1210 # Temporary array to store network address and prefix of the configured
1214 # Loop through the array of available network zones.
1215 foreach my $zone (@network_zones) {
1216 # Check if the current processed zone is red.
1217 if($zone eq "red") {
1218 # Grab the IP-address of the red interface.
1219 my $red_address = &get_red_address
();
1221 # Check if an address has been obtained.
1223 # Generate full network string.
1224 my $red_network = join("/", $red_address, "32");
1226 # Add the red network to the array of networks.
1227 push(@networks, $red_network);
1230 # Check if the configured RED_TYPE is static.
1231 if ($netsettings{'RED_TYPE'} eq "STATIC") {
1232 # Get configured and enabled aliases.
1233 my @aliases = &get_aliases
();
1235 # Loop through the array.
1236 foreach my $alias (@aliases) {
1238 my $network = join("/", $alias, "32");
1240 # Add the generated network to the array of networks.
1241 push(@networks, $network);
1244 # Process remaining network zones.
1246 # Convert current zone name into upper case.
1249 # Generate key to access the required data from the netsettings hash.
1250 my $zone_netaddress = $zone . "_NETADDRESS";
1251 my $zone_netmask = $zone . "_NETMASK";
1253 # Obtain the settings from the netsettings hash.
1254 my $netaddress = $netsettings{$zone_netaddress};
1255 my $netmask = $netsettings{$zone_netmask};
1257 # Convert the subnetmask into prefix notation.
1258 my $prefix = &Network
::convert_netmask2prefix
($netmask);
1260 # Generate full network string.
1261 my $network = join("/", $netaddress,$prefix);
1263 # Check if the network is valid.
1264 if(&Network
::check_subnet
($network)) {
1265 # Add the generated network to the array of networks.
1266 push(@networks, $network);
1271 # Format home net declaration.
1272 my $line = "\"[" . join(',', @networks) . "]\"";
1274 # Open file to store the addresses of the home net.
1275 open(FILE
, ">$homenet_file") or die "Could not open $homenet_file. $!\n";
1277 # Print yaml header.
1278 print FILE
"%YAML 1.1\n";
1279 print FILE
"---\n\n";
1281 # Print notice about autogenerated file.
1282 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1284 # Print the generated and required HOME_NET declaration to the file.
1285 print FILE
"HOME_NET:\t$line\n";
1287 # Close file handle.
1292 # Function to generate and write the file which contains the configured and used DNS servers.
1294 sub generate_dns_servers_file
() {
1295 # Get the used DNS servers.
1296 my @nameservers = &General
::get_nameservers
();
1298 # Get network settings.
1300 &General
::readhash
("${General::swroot}/ethernet/settings", \
%netsettings);
1302 # Format dns servers declaration.
1305 # Check if the system has configured nameservers.
1307 # Add the GREEN address as DNS servers.
1308 push(@nameservers, $netsettings{'GREEN_ADDRESS'});
1310 # Check if a BLUE zone exists.
1311 if ($netsettings{'BLUE_ADDRESS'}) {
1312 # Add the BLUE address to the array of nameservers.
1313 push(@nameservers, $netsettings{'BLUE_ADDRESS'});
1316 # Generate the line which will be written to the DNS servers file.
1317 $line = join(",", @nameservers);
1319 # External net simply contains (any).
1320 $line = "\$EXTERNAL_NET";
1323 # Open file to store the used DNS server addresses.
1324 open(FILE
, ">$dns_servers_file") or die "Could not open $dns_servers_file. $!\n";
1326 # Print yaml header.
1327 print FILE
"%YAML 1.1\n";
1328 print FILE
"---\n\n";
1330 # Print notice about autogenerated file.
1331 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1333 # Print the generated DNS declaration to the file.
1334 print FILE
"DNS_SERVERS:\t\"[$line]\"\n";
1336 # Close file handle.
1341 # Function to generate and write the file which contains the HTTP_PORTS definition.
1343 sub generate_http_ports_file
() {
1346 # Read-in proxy settings
1347 &General
::readhash
("${General::swroot}/proxy/advanced/settings", \
%proxysettings);
1349 # Check if the proxy is enabled.
1350 if (( -e
"${General::swroot}/proxy/enable") || (-e
"${General::swroot}/proxy/enable_blue")) {
1351 # Add the proxy port to the array of HTTP ports.
1352 push(@http_ports, $proxysettings{'PROXY_PORT'});
1355 # Check if the transparent mode of the proxy is enabled.
1356 if ((-e
"${General::swroot}/proxy/transparent") || (-e
"${General::swroot}/proxy/transparent_blue")) {
1357 # Add the transparent proxy port to the array of HTTP ports.
1358 push(@http_ports, $proxysettings{'TRANSPARENT_PORT'});
1361 # Format HTTP_PORTS declaration.
1364 # Generate line which will be written to the http ports file.
1365 $line = join(",", @http_ports);
1367 # Open file to store the HTTP_PORTS.
1368 open(FILE
, ">$http_ports_file") or die "Could not open $http_ports_file. $!\n";
1370 # Print yaml header.
1371 print FILE
"%YAML 1.1\n";
1372 print FILE
"---\n\n";
1374 # Print notice about autogenerated file.
1375 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1377 # Print the generated HTTP_PORTS declaration to the file.
1378 print FILE
"HTTP_PORTS:\t\"[$line]\"\n";
1380 # Close file handle.
1385 ## Function to generate and write the file for used rulefiles file for a given provider.
1387 ## The function requires as first argument a provider handle, and as second an array with files.
1389 sub write_used_provider_rulefiles_file
($@
) {
1390 my ($provider, @files) = @_;
1392 # Get the path and file for the provider specific used rulefiles file.
1393 my $used_provider_rulesfile_file = &get_used_provider_rulesfile_file
($provider);
1395 # Open file for used rulefiles.
1396 open (FILE
, ">", "$used_provider_rulesfile_file") or die "Could not write to $used_provider_rulesfile_file. $!\n";
1398 # Write yaml header to the file.
1399 print FILE
"%YAML 1.1\n";
1400 print FILE
"---\n\n";
1402 # Write header to file.
1403 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1405 # Loop through the array of given files.
1406 foreach my $file (@files) {
1407 # Check if the given filename exists and write it to the file of used rulefiles.
1408 if(-f
"$rulespath/$file") {
1409 print FILE
" - $file\n";
1413 # Close file after writing.
1418 ## Function to write the main file for provider rulesfiles inclusions.
1420 ## This function requires an array of provider handles.
1422 sub write_main_used_rulefiles_file
(@
) {
1423 my (@providers) = @_;
1425 # Call function to write the static rulefiles file.
1426 &_write_default_rulefiles_file
();
1428 # Open file for used rulefils inclusion.
1429 open (FILE
, ">", "$suricata_used_providers_file") or die "Could not write to $suricata_used_providers_file. $!\n";
1431 # Write yaml header to the file.
1432 print FILE
"%YAML 1.1\n";
1433 print FILE
"---\n\n";
1435 # Write header to file.
1436 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1438 # Loop through the list of given providers.
1439 foreach my $provider (@providers) {
1440 # Call function to get the providers used rulefiles file.
1441 my $filename = &get_used_provider_rulesfile_file
($provider);
1443 # Check if the file exists and write it into the used rulefiles file.
1445 # Print the provider to the file.
1446 print FILE
"include\: $filename\n";
1450 # Close the filehandle after writing.
1454 sub _write_default_rulefiles_file
() {
1455 # Get enabled application layer protocols.
1456 my @enabled_app_layer_protos = &get_suricata_enabled_app_layer_protos
();
1459 open (FILE
, ">", $suricata_default_rulefiles_file) or die "Could not write to $suricata_default_rulefiles_file. $!\n";
1461 # Write yaml header to the file.
1462 print FILE
"%YAML 1.1\n";
1463 print FILE
"---\n\n";
1465 # Write notice about autogenerated file.
1466 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1468 # Loop through the array of static included rulesfiles.
1469 foreach my $file (@static_included_rulefiles) {
1470 # Check if the file exists.
1471 if (-f
"$rulespath/$file") {
1472 # Write the rulesfile name to the file.
1473 print FILE
" - $rulespath/$file\n";
1477 print FILE
"\n#Default rules for used application layer protocols.\n";
1478 foreach my $enabled_app_layer_proto (@enabled_app_layer_protos) {
1479 # Check if the current processed app layer proto needs to be translated
1480 # into an application name.
1481 if (exists($tr_app_layer_proto{$enabled_app_layer_proto})) {
1482 # Obtain the translated application name for this protocol.
1483 $enabled_app_layer_proto = $tr_app_layer_proto{$enabled_app_layer_proto};
1486 # Generate filename.
1487 my $rulesfile = "$default_rulespath/$enabled_app_layer_proto\.rules";
1489 # Check if such a file exists.
1490 if (-f
"$rulesfile") {
1491 # Write the rulesfile name to the file.
1492 print FILE
" - $rulesfile\n";
1495 # Generate filename with "events" in filename.
1496 $rulesfile = "$default_rulespath/$enabled_app_layer_proto\-events.rules";
1498 # Check if this file exists.
1499 if (-f
"$rulesfile" ) {
1500 # Write the rulesfile name to the file.
1501 print FILE
" - $rulesfile\n";
1505 # Close the file handle
1510 ## Tiny function to generate the full path and name for the used_provider_rulesfile file of a given provider.
1512 sub get_used_provider_rulesfile_file
($) {
1513 my ($provider) = @_;
1515 my $filename = "$settingsdir/suricata\-$provider\-used\-rulefiles.yaml";
1517 # Return the gernerated file.
1522 ## Function to generate and write the file for modify the ruleset.
1524 sub write_modify_sids_file
() {
1525 # Get configured settings.
1527 &General
::readhash
("$ids_settings_file", \
%idssettings);
1529 # Open modify sid's file for writing.
1530 open(FILE
, ">$modify_sids_file") or die "Could not write to $modify_sids_file. $!\n";
1532 # Write file header.
1533 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1535 # Check if the traffic only should be monitored.
1536 unless($idssettings{'MONITOR_TRAFFIC_ONLY'} eq 'on') {
1537 # Suricata is in IPS mode, which means that the rule actions have to be changed
1538 # from 'alert' to 'drop', however not all rules should be changed. Some rules
1539 # exist purely to set a flowbit which is used to convey other information, such
1540 # as a specific type of file being downloaded, to other rulewhich then check for
1541 # malware in that file. Rules which fall into the first category should stay as
1542 # alert since not all flows of that type contain malware.
1544 # These types of rulesfiles contain meta-data which gives the action that should
1545 # be used when in IPS mode. Do the following:
1547 # 1. Disable all rules and set the action to 'drop'
1548 # 2. Set the action back to 'alert' if the rule contains 'flowbits:noalert;'
1549 # This should give rules not in the policy a reasonable default if the user
1550 # manually enables them.
1551 # 3. Enable rules and set actions according to the meta-data strings.
1553 my $policy = 'balanced'; # Placeholder to allow policy to be changed.
1556 modifysid * "^#(?:alert|drop)(.+policy $policy-ips alert)" | "alert\${1}"
1557 modifysid * "^#(?:alert|drop)(.+policy $policy-ips drop)" | "drop\${1}"
1558 modifysid * "^(#?)(?:alert|drop)" | "\${1}drop"
1559 modifysid * "^(#?)drop(.+flowbits:noalert;)" | "\${1}alert\${2}"
1563 # Close file handle.
1568 ## Function to get the subscription code of a configured provider.
1570 sub get_subscription_code
($) {
1571 my ($provider) = @_;
1573 my %configured_providers = ();
1575 # Read-in providers settings file.
1576 &General
::readhasharray
($providers_settings_file, \
%configured_providers);
1578 # Loop through the hash of configured providers.
1579 foreach my $id (keys %configured_providers) {
1580 # Assign nice human-readable values to the data fields.
1581 my $provider_handle = $configured_providers{$id}[0];
1582 my $subscription_code = $configured_providers{$id}[1];
1584 # Check if the current processed provider is the requested one.
1585 if ($provider_handle eq $provider) {
1586 # Return the obtained subscription code.
1587 return $subscription_code;
1591 # No subscription code found - return nothing.
1596 ## Function to get the ruleset date for a given provider.
1598 ## The function simply return the creation date in a human read-able format
1599 ## of the stored providers rulesfile.
1601 sub get_ruleset_date
($) {
1602 my ($provider) = @_;
1606 # Get the stored rulesfile for this provider.
1607 my $stored_rulesfile = &_get_dl_rulesfile
($provider);
1609 # Check if we got a file.
1610 if (-f
$stored_rulesfile) {
1611 # Call stat on the rulestarball.
1612 my $stat = stat("$stored_rulesfile");
1614 # Get timestamp the file creation.
1615 $mtime = $stat->mtime;
1618 # Check if the timestamp has not been grabbed.
1620 # Return N/A for Not available.
1624 # Convert into human read-able format.
1625 $date = strftime
('%Y-%m-%d %H:%M:%S', localtime($mtime));
1632 ## Function to gather the version of suricata.
1634 sub get_suricata_version
($) {
1637 # Execute piped suricata command and return the version information.
1638 open(SURICATA
, "suricata -V |") or die "Couldn't execute program: $!";
1640 # Grab and store the output of the piped program.
1641 my $version_string = <SURICATA
>;
1647 chomp($version_string);
1649 # Grab the version from the version string.
1650 $version_string =~ /([0-9]+([.][0-9]+)+)/;
1652 # Splitt the version into single chunks.
1653 my ($major_ver, $minor_ver, $patchlevel) = split(/\./, $1);
1655 # Check and return the requested version sheme.
1656 if ($format eq "major") {
1657 # Return the full version.
1658 return "$major_ver";
1659 } elsif ($format eq "minor") {
1660 # Return the major and minor part.
1661 return "$major_ver.$minor_ver";
1663 # Return the full version string.
1664 return "$major_ver.$minor_ver.$patchlevel";
1669 ## Function to get the enabled application layer protocols.
1671 sub get_suricata_enabled_app_layer_protos
() {
1672 # Array to store and return the enabled app layer protos.
1673 my @enabled_app_layer_protos = ();
1675 # Execute piped suricata command and return the list of
1676 # enabled application layer protocols.
1677 open(SURICATA
, "suricata --list-app-layer-protos |") or die "Could not execute program: $!";
1679 # Grab and store the list of enabled application layer protocols.
1680 my @output = <SURICATA
>;
1685 # Merge allways enabled static application layers protocols array.
1686 @enabled_app_layer_protos = @static_enabled_app_layer_protos;
1688 # Loop through the array which contains the output of suricata.
1689 foreach my $line (@output) {
1690 # Skip header line which starts with "===".
1691 next if ($line =~ /^\s*=/);
1693 # Skip info or warning lines.
1694 next if ($line =~ /\s*--/);
1699 # Add enabled app layer proto to the array.
1700 push(@enabled_app_layer_protos, $line);
1704 @enabled_app_layer_protos = sort(@enabled_app_layer_protos);
1707 return @enabled_app_layer_protos;
1711 ## Function to generate the rules file with whitelisted addresses.
1713 sub generate_ignore_file
() {
1716 # SID range 1000000-1999999 Reserved for Local Use
1717 # Put your custom rules in this range to avoid conflicts
1720 # Read-in ignoredfile.
1721 &General
::readhasharray
($IDS::ignored_file
, \
%ignored);
1723 # Open ignorefile for writing.
1724 open(FILE
, ">$IDS::whitelist_file") or die "Could not write to $IDS::whitelist_file. $!\n";
1726 # Config file header.
1727 print FILE
"# Autogenerated file.\n";
1728 print FILE
"# All user modifications will be overwritten.\n\n";
1730 # Add all user defined addresses to the whitelist.
1732 # Check if the hash contains any elements.
1733 if (keys (%ignored)) {
1734 # Loop through the entire hash and write the host/network
1735 # and remark to the ignore file.
1736 while ( (my $key) = each %ignored) {
1737 my $address = $ignored{$key}[0];
1738 my $remark = $ignored{$key}[1];
1739 my $status = $ignored{$key}[2];
1741 # Check if the status of the entry is "enabled".
1742 if ($status eq "enabled") {
1743 # Check if the address/network is valid.
1744 if ((&General
::validip
($address)) || (&General
::validipandmask
($address))) {
1745 # Write rule line to the file to pass any traffic from this IP
1746 print FILE
"pass ip $address any -> any any (msg:\"pass all traffic from/to $address\"\; bypass; sid:$sid\;)\n";
1759 ## Function to set correct ownership for single files and directories.
1762 sub set_ownership
($) {
1765 # User and group of the WUI.
1766 my $uname = "nobody";
1767 my $grname = "nobody";
1769 # The chown function implemented in perl requies the user and group as nummeric id's.
1770 my $uid = getpwnam($uname);
1771 my $gid = getgrnam($grname);
1773 # Check if the given target exists.
1775 # Stop the script and print error message.
1776 die "The $target does not exist. Cannot change the ownership!\n";
1779 # Check weather the target is a file or directory.
1781 # Change ownership ot the single file.
1782 chown($uid, $gid, "$target");
1783 } elsif (-d
$target) {
1784 # Do a directory listing.
1785 opendir(DIR
, $target) or die $!;
1786 # Loop through the direcory.
1787 while (my $file = readdir(DIR
)) {
1789 # We only want files.
1790 next unless (-f
"$target/$file");
1792 # Set correct ownership for the files.
1793 chown($uid, $gid, "$target/$file");
1798 # Change ownership of the directory.
1799 chown($uid, $gid, "$target");
1804 ## Function to read-in the aliases file and returns all configured and enabled aliases.
1807 # Location of the aliases file.
1808 my $aliases_file = "${General::swroot}/ethernet/aliases";
1810 # Array to store the aliases.
1813 # Check if the file is empty.
1814 if (-z
$aliases_file) {
1815 # Abort nothing to do.
1819 # Open the aliases file.
1820 open(ALIASES
, $aliases_file) or die "Could not open $aliases_file. $!\n";
1822 # Loop through the file content.
1823 while (my $line = <ALIASES
>) {
1827 # Splitt line content into single chunks.
1828 my ($address, $state, $remark) = split(/\,/, $line);
1830 # Check if the state of the current processed alias is "on".
1831 if ($state eq "on") {
1832 # Check if the address is valid.
1833 if(&Network
::check_ip_address
($address)) {
1834 # Add the alias to the array of aliases.
1835 push(@aliases, $address);
1840 # Close file handle.
1848 ## Function to grab the current assigned IP-address on red.
1850 sub get_red_address
() {
1851 # File, which contains the current IP-address of the red interface.
1852 my $file = "${General::swroot}/red/local-ipaddress";
1854 # Check if the file exists.
1856 # Open the given file.
1857 open(FILE
, "$file") or die "Could not open $file.";
1859 # Obtain the address from the first line of the file.
1860 my $address = <FILE
>;
1868 # Check if the grabbed address is valid.
1869 if (&General
::validip
($address)) {
1870 # Return the address.
1880 ## Function to get the used rules files of a given provider.
1882 sub read_used_provider_rulesfiles
($) {
1883 my ($provider) = @_;
1885 # Array to store the used rulefiles.
1886 my @used_rulesfiles = ();
1888 # Get the used rulesefile file for the provider.
1889 my $rulesfile_file = &get_used_provider_rulesfile_file
($provider);
1891 # Check if the a used rulesfile exists for this provider.
1892 if (-f
$rulesfile_file) {
1893 # Open the file or used rulefiles and read-in content.
1894 open(FILE
, $rulesfile_file) or die "Could not open $rulesfile_file. $!\n";
1897 # Assign the current line to a nice variable.
1904 next if ($line =~ /\#/);
1907 next if ($line =~ /^\s*$/);
1909 # Gather the rulefile.
1910 if ($line =~ /.*- (.*)/) {
1913 # Add the rulefile to the array of used rulesfiles.
1914 push(@used_rulesfiles, $rulefile);
1922 # Return the array of used rulesfiles.
1923 return @used_rulesfiles;
1927 ## Function to write the lock file for locking the WUI, while
1928 ## the autoupdate script runs.
1930 sub lock_ids_page
() {
1931 # Call subfunction to create the file.
1932 &create_empty_file
($ids_page_lock_file);
1936 ## Function to release the lock of the WUI, again.
1938 sub unlock_ids_page
() {
1940 unlink($ids_page_lock_file);