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 # Location where all config and settings files are stored.
33 our $settingsdir = "${General::swroot}/suricata";
35 # File where the main file for providers ruleset inclusion exists.
36 our $suricata_used_providers_file = "$settingsdir/suricata-used-providers.yaml";
38 # File for static ruleset inclusions.
39 our $suricata_default_rulefiles_file = "$settingsdir/suricata-default-rules.yaml";
41 # File where the addresses of the homenet are stored.
42 our $homenet_file = "$settingsdir/suricata-homenet.yaml";
44 # File where the addresses of the used DNS servers are stored.
45 our $dns_servers_file = "$settingsdir/suricata-dns-servers.yaml";
47 # File where the HTTP ports definition is stored.
48 our $http_ports_file = "$settingsdir/suricata-http-ports.yaml";
50 # File which contains includes for provider specific rule modifications.
51 our $oinkmaster_provider_includes_file = "$settingsdir/oinkmaster-provider-includes.conf";
53 # File which contains wheater the rules should be changed.
54 our $modify_sids_file = "$settingsdir/oinkmaster-modify-sids.conf";
56 # File which stores the configured IPS settings.
57 our $ids_settings_file = "$settingsdir/settings";
59 # File which stores the used and configured ruleset providers.
60 our $providers_settings_file = "$settingsdir/providers-settings";
62 # File which stores the configured settings for whitelisted addresses.
63 our $ignored_file = "$settingsdir/ignored";
65 # Location where the downloaded rulesets are stored.
66 our $dl_rules_path = "/var/tmp";
68 # File to store any errors, which also will be read and displayed by the wui.
69 our $storederrorfile = "/tmp/ids_storederror";
71 # File to lock the WUI, while the autoupdate script runs.
72 our $ids_page_lock_file = "/tmp/ids_page_locked";
74 # Location where the rulefiles are stored.
75 our $rulespath = "/var/lib/suricata";
77 # Location where the default rulefils are stored.
78 our $default_rulespath = "/usr/share/suricata/rules";
80 # Location where the addition config files are stored.
81 our $configspath = "/usr/share/suricata";
83 # Location of the classification file.
84 our $classification_file = "$configspath/classification.config";
86 # Location of the sid to msg mappings file.
87 our $sid_msg_file = "$rulespath/sid-msg.map";
89 # Location to store local rules. This file will not be touched.
90 our $local_rules_file = "$rulespath/local.rules";
92 # File which contains the rules to whitelist addresses on suricata.
93 our $whitelist_file = "$rulespath/whitelist.rules";
95 # File which contains a list of all supported ruleset sources.
96 # (Sourcefire, Emergingthreads, etc..)
97 our $rulesetsourcesfile = "$settingsdir/ruleset-sources";
99 # The pidfile of the IDS.
100 our $idspidfile = "/var/run/suricata.pid";
102 # Location of suricatactrl.
103 my $suricatactrl = "/usr/local/bin/suricatactrl";
105 # Prefix for each downloaded ruleset.
106 my $dl_rulesfile_prefix = "idsrules";
108 # Temporary directory where the rulesets will be extracted.
109 my $tmp_directory = "/tmp/ids_tmp";
111 # Temporary directory where the extracted rules files will be stored.
112 my $tmp_rules_directory = "$tmp_directory/rules";
114 # Temporary directory where the extracted additional config files will be stored.
115 my $tmp_conf_directory = "$tmp_directory/conf";
117 # Array with allowed commands of suricatactrl.
118 my @suricatactrl_cmds = ( 'start', 'stop', 'restart', 'reload', 'fix-rules-dir', 'cron' );
120 # Array with supported cron intervals.
121 my @cron_intervals = ('off', 'daily', 'weekly' );
123 # Array which contains the HTTP ports, which statically will be declared as HTTP_PORTS in the
125 my @http_ports = ('80', '81');
127 # Array which contains a list of rulefiles which always will be included if they exist.
128 my @static_included_rulefiles = ('local.rules', 'whitelist.rules');
130 # Array which contains a list of allways enabled application layer protocols.
131 my @static_enabled_app_layer_protos = ('app-layer', 'decoder', 'files', 'stream');
133 # Hash which allows to convert the download type (dl_type) to a file suffix.
134 my %dl_type_to_suffix = (
135 "archive" => ".tar.gz",
139 # Hash to translate an application layer protocol to the application name.
140 my %tr_app_layer_proto = (
142 "krb5" => "kerberos",
146 ## Function to check and create all IDS related files, if the does not exist.
148 sub check_and_create_filelayout
() {
149 # Check if the files exist and if not, create them.
150 unless (-f
"$oinkmaster_provider_includes_file") { &create_empty_file
($oinkmaster_provider_includes_file); }
151 unless (-f
"$modify_sids_file") { &create_empty_file
($modify_sids_file); }
152 unless (-f
"$suricata_used_providers_file") { &create_empty_file
($suricata_used_providers_file); }
153 unless (-f
"$suricata_default_rulefiles_file") { &create_empty_file
($suricata_default_rulefiles_file); }
154 unless (-f
"$ids_settings_file") { &create_empty_file
($ids_settings_file); }
155 unless (-f
"$providers_settings_file") { &create_empty_file
($providers_settings_file); }
156 unless (-f
"$whitelist_file" ) { &create_empty_file
($whitelist_file); }
160 ## Function to get a list of all available ruleset providers.
162 ## They will be returned as a sorted array.
164 sub get_ruleset_providers
() {
167 # Loop through the hash of providers.
168 foreach my $provider ( keys %IDS::Ruleset
::Providers
) {
169 # Add the provider to the array.
170 push(@providers, $provider);
173 # Sort and return the array.
174 return sort(@providers);
178 ## Function to get a list of all enabled ruleset providers.
180 ## They will be returned as an array.
182 sub get_enabled_providers
() {
183 my %used_providers = ();
185 # Array to store the enabled providers.
186 my @enabled_providers = ();
188 # Read-in the providers config file.
189 &General
::readhasharray
("$providers_settings_file", \
%used_providers);
191 # Loop through the hash of used_providers.
192 foreach my $id (keys %used_providers) {
193 # Skip disabled providers.
194 next unless ($used_providers{$id}[3] eq "enabled");
196 # Grab the provider handle.
197 my $provider = "$used_providers{$id}[0]";
199 # Add the provider to the array of enabled providers.
200 push(@enabled_providers, $provider);
204 return @enabled_providers;
208 ## Function for checking if at least 300MB of free disk space are available
209 ## on the "/var" partition.
211 sub checkdiskspace
() {
212 # Call diskfree to gather the free disk space of /var.
213 my @df = &General
::system_output
("/bin/df", "-B", "M", "/var");
215 # Loop through the output.
216 foreach my $line (@df) {
217 # Ignore header line.
218 next if $line =~ m/^Filesystem/;
220 # Search for a line with the device information.
221 if ($line =~ m/dev/ ) {
222 # Split the line into single pieces.
223 my @values = split(' ', $line);
224 my ($filesystem, $blocks, $used, $available, $used_perenctage, $mounted_on) = @values;
226 # Check if the available disk space is more than 300MB.
227 if ($available < 300) {
228 # Log error to syslog.
229 &_log_to_syslog
("Not enough free disk space on /var. Only $available MB from 300 MB available.");
231 # Exit function and return "1" - False.
237 # Everything okay, return nothing.
242 ## This function is responsible for downloading the configured IDS rulesets or if no one is specified
243 ## all configured rulesets will be downloaded.
245 ## * At first it gathers all configured ruleset providers, initialize the downloader and sets an
246 ## upstream proxy if configured.
247 ## * After that, the given ruleset or in case all rulesets should be downloaded, it will determine wether it
248 ## is enabled or not.
249 ## * The next step will be to generate the final download url, by obtaining the URL for the desired
250 ## ruleset, add the settings for the upstream proxy.
251 ## * Finally the function will grab all the rules files or tarballs from the servers.
253 sub downloadruleset
($) {
256 # If no provider is given default to "all".
259 # Hash to store the providers and access id's, for which rules should be downloaded.
260 my %sheduled_providers = ();
262 # Get used provider settings.
263 my %used_providers = ();
264 &General
::readhasharray
("$providers_settings_file", \
%used_providers);
266 # Check if a ruleset has been configured.
267 unless(%used_providers) {
268 # Log that no ruleset has been configured and abort.
269 &_log_to_syslog
("No ruleset provider has been configured.");
275 # Read proxysettings.
276 my %proxysettings=();
277 &General
::readhash
("${General::swroot}/proxy/settings", \
%proxysettings);
279 # Load required perl module to handle the download.
282 # Init the download module.
284 # Request SSL hostname verification and specify path
286 my $downloader = LWP
::UserAgent
->new(
288 SSL_ca_file
=> '/etc/ssl/cert.pem',
289 verify_hostname
=> 1,
293 # Set timeout to 10 seconds.
294 $downloader->timeout(10);
296 # Check if an upstream proxy is configured.
297 if ($proxysettings{'UPSTREAM_PROXY'}) {
300 $proxy_url = "http://";
302 # Check if the proxy requires authentication.
303 if (($proxysettings{'UPSTREAM_USER'}) && ($proxysettings{'UPSTREAM_PASSWORD'})) {
304 $proxy_url .= "$proxysettings{'UPSTREAM_USER'}\:$proxysettings{'UPSTREAM_PASSWORD'}\@";
307 # Add proxy server address and port.
308 $proxy_url .= $proxysettings{'UPSTREAM_PROXY'};
310 # Setup proxy settings.
311 $downloader->proxy(['http', 'https'], $proxy_url);
314 # Loop through the hash of configured providers.
315 foreach my $id ( keys %used_providers ) {
316 # Skip providers which are not enabled.
317 next if ($used_providers{$id}[3] ne "enabled");
319 # Obtain the provider handle.
320 my $provider_handle = $used_providers{$id}[0];
322 # Handle update off all providers.
323 if (($provider eq "all") || ($provider_handle eq "$provider")) {
324 # Add provider handle and it's id to the hash of sheduled providers.
325 $sheduled_providers{$provider_handle} = $id;
329 # Loop through the hash of sheduled providers.
330 foreach my $provider ( keys %sheduled_providers) {
331 # Log download/update of the ruleset.
332 &_log_to_syslog
("Downloading ruleset for provider: $provider.");
334 # Grab the download url for the provider.
335 my $url = $IDS::Ruleset
::Providers
{$provider}{'dl_url'};
337 # Check if the provider requires a subscription.
338 if ($IDS::Ruleset
::Providers
{$provider}{'requires_subscription'} eq "True") {
339 # Grab the previously stored access id for the provider from hash.
340 my $id = $sheduled_providers{$provider};
342 # Grab the subscription code.
343 my $subscription_code = $used_providers{$id}[1];
345 # Add the subscription code to the download url.
346 $url =~ s/\<subscription_code\>/$subscription_code/g;
350 # Abort if no url could be determined for the provider.
352 # Log error and abort.
353 &_log_to_syslog
("Unable to gather a download URL for the selected ruleset provider.");
357 # Variable to store the filesize of the remote object.
360 # The sourcfire (snort rules) does not allow to send "HEAD" requests, so skip this check
361 # for this webserver.
363 # Check if the ruleset source contains "snort.org".
364 unless ($url =~ /\.snort\.org/) {
365 # Pass the requrested url to the downloader.
366 my $request = HTTP
::Request
->new(HEAD
=> $url);
368 # Accept the html header.
369 $request->header('Accept' => 'text/html');
371 # Perform the request and fetch the html header.
372 my $response = $downloader->request($request);
374 # Check if there was any error.
375 unless ($response->is_success) {
377 my $error = $response->status_line();
380 &_log_to_syslog
("Unable to download the ruleset. \($error\)");
382 # Return "1" - false.
386 # Assign the fetched header object.
387 my $header = $response->headers();
389 # Grab the remote file size from the object and store it in the
391 $remote_filesize = $header->content_length;
394 # Load perl module to deal with temporary files.
397 # Generate temporary file name, located in "/var/tmp" and with a suffix of ".tmp".
398 my $tmp = File
::Temp
->new( SUFFIX
=> ".tmp", DIR
=> "/var/tmp/", UNLINK
=> 0 );
399 my $tmpfile = $tmp->filename();
401 # Pass the requested url to the downloader.
402 my $request = HTTP
::Request
->new(GET
=> $url);
404 # Perform the request and save the output into the tmpfile.
405 my $response = $downloader->request($request, $tmpfile);
407 # Check if there was any error.
408 unless ($response->is_success) {
410 my $error = $response->content;
413 &_log_to_syslog
("Unable to download the ruleset. \($error\)");
415 # Return "1" - false.
419 # Load perl stat module.
422 # Perform stat on the tmpfile.
423 my $stat = stat($tmpfile);
425 # Grab the local filesize of the downloaded tarball.
426 my $local_filesize = $stat->size;
428 # Check if both file sizes match.
429 if (($remote_filesize) && ($remote_filesize ne $local_filesize)) {
431 &_log_to_syslog
("Unable to completely download the ruleset. ");
432 &_log_to_syslog
("Only got $local_filesize Bytes instead of $remote_filesize Bytes. ");
434 # Delete temporary file.
437 # Return "1" - false.
441 # Genarate and assign file name and path to store the downloaded rules file.
442 my $dl_rulesfile = &_get_dl_rulesfile
($provider);
444 # Check if a file name could be obtained.
445 unless ($dl_rulesfile) {
447 &_log_to_syslog
("Unable to store the downloaded rules file. ");
449 # Delete downloaded temporary file.
452 # Return "1" - false.
456 # Load file copy module, which contains the move() function.
459 # Overwrite the may existing rulefile or tarball with the downloaded one.
460 move
("$tmpfile", "$dl_rulesfile");
462 # Delete temporary file.
465 # Set correct ownership for the tarball.
466 set_ownership
("$dl_rulesfile");
469 # If we got here, everything worked fine. Return nothing.
474 ## Function to extract a given ruleset.
476 ## In case the ruleset provider offers a plain file, it simply will
479 sub extractruleset
($) {
482 # Load perl module to deal with archives.
485 # Disable chown functionality when uncompressing files.
486 $Archive::Tar
::CHOWN
= "0";
488 # Load perl module to deal with files and path.
491 # Load perl module for file copying.
494 # Get full path and downloaded rulesfile for the given provider.
495 my $tarball = &_get_dl_rulesfile
($provider);
497 # Check if the file exists.
498 unless (-f
$tarball) {
499 &_log_to_syslog
("Could not find ruleset file: $tarball");
505 # Check if the temporary directories exist, otherwise create them.
506 mkdir("$tmp_directory") unless (-d
"$tmp_directory");
507 mkdir("$tmp_rules_directory") unless (-d
"$tmp_rules_directory");
508 mkdir("$tmp_conf_directory") unless (-d
"$tmp_conf_directory");
510 # Omit the type (dl_type) of the stored ruleset.
511 my $type = $IDS::Ruleset
::Providers
{$provider}{'dl_type'};
513 # Handle the different ruleset types.
514 if ($type eq "plain") {
515 # Generate destination filename an full path.
516 my $destination = "$tmp_rules_directory/$provider\-ruleset.rules";
518 # Copy the file into the temporary rules directory.
519 copy
($tarball, $destination);
521 } elsif ( $type eq "archive") {
522 # Initialize the tar module.
523 my $tar = Archive
::Tar
->new($tarball);
525 # Get the filelist inside the tarball.
526 my @packed_files = $tar->list_files;
528 # Loop through the filelist.
529 foreach my $packed_file (@packed_files) {
532 # Splitt the packed file into chunks.
533 my $file = fileparse
($packed_file);
535 # Handle msg-id.map file.
536 if ("$file" eq "sid-msg.map") {
537 # Set extract destination to temporary config_dir.
538 $destination = "$tmp_conf_directory/$provider\-sid-msg.map";
540 # Handle classification.conf
541 } elsif ("$file" eq "classification.config") {
542 # Set extract destination to temporary config_dir.
543 $destination = "$tmp_conf_directory/$provider\-classification.config";
545 # Handle rules files.
546 } elsif ($file =~ m/\.rules$/) {
549 # Splitt the filename into chunks.
550 my @filename = split("-", $file);
553 @filename = reverse(@filename);
555 # Get the amount of elements in the array.
556 my $elements = @filename;
558 # Remove last element of the hash.
559 # It contains the vendor name, which will be replaced.
560 if ($elements >= 3) {
561 # Remove last element from hash.
565 # Check if the last element of the filename does not
566 # contain the providers name.
567 if ($filename[-1] ne "$provider") {
568 # Add provider name as last element.
569 push(@filename, $provider);
572 # Reverse the array back.
573 @filename = reverse(@filename);
575 # Generate the name for the rulesfile.
576 $rulesfilename = join("-", @filename);
578 # Set extract destination to temporaray rules_dir.
579 $destination = "$tmp_rules_directory/$rulesfilename";
581 # Skip all other files.
585 # Check if the destination file exists.
586 unless(-e
"$destination") {
587 # Extract the file to the temporary directory.
588 $tar->extract_file("$packed_file", "$destination");
590 # Load perl module to deal with temporary files.
593 # Generate temporary file name, located in the temporary rules directory and a suffix of ".tmp".
594 my $tmp = File
::Temp
->new( SUFFIX
=> ".tmp", DIR
=> "$tmp_rules_directory", UNLINK
=> 0 );
595 my $tmpfile = $tmp->filename();
597 # Extract the file to the new temporary file name.
598 $tar->extract_file("$packed_file", "$tmpfile");
600 # Open the the existing file.
601 open(DESTFILE
, ">>", "$destination") or die "Could not open $destination. $!\n";
602 open(TMPFILE
, "<", "$tmpfile") or die "Could not open $tmpfile. $!\n";
604 # Loop through the content of the temporary file.
606 # Append the content line by line to the destination file.
610 # Close the file handles.
614 # Remove the temporary file.
622 ## A wrapper function to call the oinkmaster script, setup the rules structues and
623 ## call the functions to merge the additional config files. (classification, sid-msg, etc.).
626 # Check if the files in rulesdir have the correct permissions.
627 &_check_rulesdir_permissions
();
629 # Cleanup the rules directory before filling it with the new rulests.
630 &_cleanup_rulesdir
();
632 # Get all enabled providers.
633 my @enabled_providers = &get_enabled_providers
();
635 # Loop through the array of enabled providers.
636 foreach my $provider (@enabled_providers) {
637 # Call the extractruleset function.
638 &extractruleset
($provider);
641 # Load perl module to talk to the kernel syslog.
642 use Sys
::Syslog
qw(:DEFAULT setlogsock);
644 # Establish the connection to the syslog service.
645 openlog
('oinkmaster', 'cons,pid', 'user');
647 # Call oinkmaster to generate ruleset.
648 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";
650 # Log output of oinkmaster to syslog.
651 while(<OINKMASTER
>) {
652 # The syslog function works best with an array based input,
653 # so generate one before passing the message details to syslog.
654 my @syslog = ("INFO", "$_");
656 # Send the log message.
660 # Close the pipe to oinkmaster process.
663 # Close the log handle.
666 # Call function to merge the classification files.
667 &merge_classifications
(@enabled_providers);
669 # Call function to merge the sid to message mapping files.
670 &merge_sid_msg
(@enabled_providers);
672 # Cleanup temporary directory.
673 &cleanup_tmp_directory
();
677 ## Function to merge the classifications for a given amount of providers and write them
678 ## to the classifications file.
680 sub merge_classifications
(@
) {
683 # Hash to store all collected classifications.
684 my %classifications = ();
686 # Loop through the given array of providers.
687 foreach my $provider (@providers) {
688 # Generate full path to classification file.
689 my $classification_file = "$tmp_conf_directory/$provider\-classification.config";
691 # Skip provider if no classification file exists.
692 next unless (-f
"$classification_file");
694 # Open the classification file.
695 open(CLASSIFICATION
, $classification_file) or die "Could not open file $classification_file. $!\n";
697 # Loop through the file content.
698 while(<CLASSIFICATION
>) {
699 # Parse the file and grab the classification details.
700 if ($_ =~/.*config classification\: (.*)/) {
701 # Split the grabbed details.
702 my ($short_name, $short_desc, $priority) = split("\,", $1);
704 # Check if the grabbed classification is allready known and the priority value is greater
705 # than the stored one (which causes less priority in the IDS).
706 if (($classifications{$short_name}) && ($classifications{$short_name}[1] >= $priority)) {
707 #Change the priority value to the stricter one.
708 $classifications{$short_name} = [ "$classifications{$short_name}[0]", "$priority" ];
710 # Add the classification to the hash.
711 $classifications{$short_name} = [ "$short_desc", "$priority" ];
717 close(CLASSIFICATION
);
720 # Open classification file for writing.
721 open(FILE
, ">", "$classification_file") or die "Could not write to $classification_file. $!\n";
723 # Print notice about autogenerated file.
724 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n\n";
726 # Sort and loop through the hash of classifications.
727 foreach my $key (sort keys %classifications) {
728 # Assign some nice variable names for the items.
729 my $short_name = $key;
730 my $short_desc = $classifications{$key}[0];
731 my $priority = $classifications{$key}[1];
733 # Write the classification to the file.
734 print FILE
"config classification: $short_name,$short_desc,$priority\n";
742 ## Function to merge the "sid to message mapping" files of various given providers.
744 sub merge_sid_msg
(@
) {
747 # Hash which contains all the sid to message mappings.
750 # Loop through the array of given providers.
751 foreach my $provider (@providers) {
752 # Generate full path and filename.
753 my $sid_msg_file = "$tmp_conf_directory/$provider\-sid-msg.map";
755 # Skip provider if no sid to msg mapping file for this provider exists.
756 next unless (-f
$sid_msg_file);
759 open(MAPPING
, $sid_msg_file) or die "Could not open $sid_msg_file. $!\n";
761 # Loop through the file content.
766 # Skip lines which do not start with a number,
767 next unless ($_ =~ /^\d+/);
769 # Split line content and assign it to an array.
770 my @line = split(/ \|\| /, $_);
772 # Grab the first element (and remove it) from the line array.
773 # It contains the sid.
774 my $sid = shift(@line);
776 # Store the grabbed sid and the remain array as hash value.
777 # It still contains the messages, references etc.
778 $mappings{$sid} = [@line];
785 # Open mappings file for writing.
786 open(FILE
, ">", $sid_msg_file) or die "Could not write $sid_msg_file. $!\n";
788 # Write notice about autogenerated file.
789 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n\n";
791 # Loop through the hash of mappings.
792 foreach my $sid ( sort keys %mappings) {
793 # Grab data for the sid.
794 my @data = @
{$mappings{$sid}};
796 # Add the sid to the data array.
797 unshift(@data, $sid);
800 my $line = join(" \|\| ", @data);
802 print FILE
"$line\n";
811 ## A very tiny function to move an extracted ruleset from the temporary directory into
812 ## the rules directory.
814 sub move_tmp_ruleset
() {
818 # Do a directory listing of the temporary directory.
819 opendir DH
, $tmp_rules_directory;
821 # Loop over all files.
822 while(my $file = readdir DH
) {
823 # Move them to the rules directory.
824 move
"$tmp_rules_directory/$file" , "$rulespath/$file";
827 # Close directory handle.
832 ## Function to cleanup the temporary IDS directroy.
834 sub cleanup_tmp_directory
() {
835 # Load rmtree() function from file path perl module.
836 use File
::Path
'rmtree';
838 # Delete temporary directory and all containing files.
839 rmtree
([ "$tmp_directory" ]);
843 ## Function to do all the logging stuff if the downloading or updating of the ruleset fails.
848 # Remove any newline.
851 # Call private function to log the error message to syslog.
852 &_log_to_syslog
($error);
854 # Call private function to write/store the error message in the storederrorfile.
855 &_store_error_message
($error);
859 ## Function to log a given error message to the kernel syslog.
861 sub _log_to_syslog
($) {
864 # Load perl module to talk to the kernel syslog.
865 use Sys
::Syslog
qw(:DEFAULT setlogsock);
867 # The syslog function works best with an array based input,
868 # so generate one before passing the message details to syslog.
869 my @syslog = ("ERR", "<ERROR> $message");
871 # Establish the connection to the syslog service.
872 openlog
('oinkmaster', 'cons,pid', 'user');
874 # Send the log message.
877 # Close the log handle.
882 ## Private function to write a given error message to the storederror file.
884 sub _store_error_message
($) {
887 # Remove any newline.
890 # Open file for writing.
891 open (ERRORFILE
, ">$storederrorfile") or die "Could not write to $storederrorfile. $!\n";
893 # Write error to file.
894 print ERRORFILE
"$message\n";
899 # Set correct ownership for the file.
900 &set_ownership
("$storederrorfile");
904 ## Private function to get the path and filename for a downloaded ruleset by a given provider.
906 sub _get_dl_rulesfile
($) {
909 # Gather the download type for the given provider.
910 my $dl_type = $IDS::Ruleset
::Providers
{$provider}{'dl_type'};
912 # Obtain the file suffix for the download file type.
913 my $suffix = $dl_type_to_suffix{$dl_type};
915 # Check if a suffix has been found.
917 # Abort return - nothing.
921 # Generate the full filename and path for the stored rules file.
922 my $rulesfile = "$dl_rules_path/$dl_rulesfile_prefix-$provider$suffix";
924 # Return the generated filename.
929 ## Tiny function to delete the stored ruleset file or tarball for a given provider.
931 sub drop_dl_rulesfile
($) {
934 # Gather the full path and name of the stored rulesfile.
935 my $rulesfile = &_get_dl_rulesfile
($provider);
937 # Check if the given rulesfile exists.
939 # Delete the stored rulesfile.
940 unlink($rulesfile) or die "Could not delete $rulesfile. $!\n";
945 ## Tiny function to get/generate the full path and filename for the providers oinkmaster
946 ## modified sids file.
948 sub get_oinkmaster_provider_modified_sids_file
($) {
951 # Generate the filename.
952 my $filename = "$settingsdir/oinkmaster-$provider-modified-sids.conf";
954 # Return the filename.
959 ## Function to directly altering the oinkmaster provider includes file.
961 ## Requires tha acition "remove" or "add" and a provider handle.
963 sub alter_oinkmaster_provider_includes_file
($$) {
964 my ($action, $provider) = @_;
966 # Call function to get the path and name for the given providers
967 # oinkmaster modified sids file.
968 my $provider_modified_sids_file = &get_oinkmaster_provider_modified_sids_file
($provider);
970 # Open the file for reading..
971 open (FILE
, $oinkmaster_provider_includes_file) or die "Could not read $oinkmaster_provider_includes_file. $!\n";
973 # Read-in file content.
976 # Close file after reading.
979 # Re-open the file for writing.
980 open(FILE
, ">", $oinkmaster_provider_includes_file) or die "Could not write to $oinkmaster_provider_includes_file. $!\n";
982 # Loop through the file content.
983 foreach my $line (@lines) {
987 # Skip line if we found our given provider and the action should be remove.
988 next if (($line =~ /$provider/) && ($action eq "remove"));
990 # Write the read-in line back to the file.
991 print FILE
"$line\n";
994 # Check if the file exists and add the provider if requested.
995 if ((-f
$provider_modified_sids_file) && ($action eq "add")) {
996 print FILE
"include $provider_modified_sids_file\n";
1004 ## Function to read-in the given enabled or disables sids file.
1006 sub read_enabled_disabled_sids_file
($) {
1009 # Temporary hash to store the sids and their state. It will be
1010 # returned at the end of this function.
1013 # Open the given filename.
1014 open(FILE
, "$file") or die "Could not open $file. $!\n";
1016 # Loop through the file.
1022 next if ($_ =~ /^\s*$/);
1025 next if ($_ =~ /^\#/);
1027 # Splitt line into sid and state part.
1028 my ($state, $sid) = split(" ", $_);
1030 # Skip line if the sid is not numeric.
1031 next unless ($sid =~ /\d+/ );
1033 # Check if the sid was enabled.
1034 if ($state eq "enablesid") {
1035 # Add the sid and its state as enabled to the temporary hash.
1036 $temphash{$sid} = "enabled";
1037 # Check if the sid was disabled.
1038 } elsif ($state eq "disablesid") {
1039 # Add the sid and its state as disabled to the temporary hash.
1040 $temphash{$sid} = "disabled";
1041 # Invalid state - skip the current sid and state.
1055 ## Function to check if the IDS is running.
1057 sub ids_is_running
() {
1058 if(-f
$idspidfile) {
1059 # Open PID file for reading.
1060 open(PIDFILE
, "$idspidfile") or die "Could not open $idspidfile. $!\n";
1062 # Grab the process-id.
1063 my $pid = <PIDFILE
>;
1068 # Remove any newline.
1071 # Check if a directory for the process-id exists in proc.
1072 if(-d
"/proc/$pid") {
1073 # The IDS daemon is running return the process id.
1078 # Return nothing - IDS is not running.
1083 ## Function to call suricatactrl binary with a given command.
1085 sub call_suricatactrl
($) {
1086 # Get called option.
1087 my ($option, $interval) = @_;
1089 # Loop through the array of supported commands and check if
1090 # the given one is part of it.
1091 foreach my $cmd (@suricatactrl_cmds) {
1092 # Skip current command unless the given one has been found.
1093 next unless($cmd eq $option);
1095 # Check if the given command is "cron".
1096 if ($option eq "cron") {
1097 # Check if an interval has been given.
1099 # Check if the given interval is valid.
1100 foreach my $element (@cron_intervals) {
1101 # Skip current element until the given one has been found.
1102 next unless($element eq $interval);
1104 # Call the suricatactrl binary and pass the "cron" command
1105 # with the requrested interval.
1106 &General
::system("$suricatactrl", "$option", "$interval");
1108 # Return "1" - True.
1113 # If we got here, the given interval is not supported or none has been given. - Return nothing.
1116 # Call the suricatactrl binary and pass the requrested
1118 &General
::system("$suricatactrl", "$option");
1120 # Return "1" - True.
1125 # Command not found - return nothing.
1130 ## Function to create a new empty file.
1132 sub create_empty_file
($) {
1135 # Check if the given file exists.
1137 # Do nothing to prevent from overwriting existing files.
1141 # Open the file for writing.
1142 open(FILE
, ">$file") or die "Could not write to $file. $!\n";
1144 # Close file handle.
1152 ## Private function to check if the file permission of the rulespath are correct.
1153 ## If not, call suricatactrl to fix them.
1155 sub _check_rulesdir_permissions
() {
1156 # Check if the rulepath main directory is writable.
1157 unless (-W
$rulespath) {
1158 # If not call suricatctrl to fix it.
1159 &call_suricatactrl
("fix-rules-dir");
1162 # Open snort rules directory and do a directory listing.
1163 opendir(DIR
, $rulespath) or die $!;
1164 # Loop through the direcory.
1165 while (my $file = readdir(DIR
)) {
1166 # We only want files.
1167 next unless (-f
"$rulespath/$file");
1169 # Check if the file is writable by the user.
1170 if (-W
"$rulespath/$file") {
1171 # Everything is okay - go on to the next file.
1174 # There are wrong permissions, call suricatactrl to fix it.
1175 &call_suricatactrl
("fix-rules-dir");
1181 ## Private function to cleanup the directory which contains
1182 ## the IDS rules, before extracting and modifing the new ruleset.
1184 sub _cleanup_rulesdir
() {
1185 # Open rules directory and do a directory listing.
1186 opendir(DIR
, $rulespath) or die $!;
1188 # Loop through the direcory.
1189 while (my $file = readdir(DIR
)) {
1190 # We only want files.
1191 next unless (-f
"$rulespath/$file");
1193 # Skip rules file for whitelisted hosts.
1194 next if ("$rulespath/$file" eq $whitelist_file);
1196 # Skip rules file with local rules.
1197 next if ("$rulespath/$file" eq $local_rules_file);
1199 # Delete the current processed file, if not, exit this function
1200 # and return an error message.
1201 unlink("$rulespath/$file") or return "Could not delete $rulespath/$file. $!\n";
1209 ## Function to generate the file which contains the home net information.
1211 sub generate_home_net_file
() {
1214 # Read-in network settings.
1215 &General
::readhash
("${General::swroot}/ethernet/settings", \
%netsettings);
1217 # Get available network zones.
1218 my @network_zones = &Network
::get_available_network_zones
();
1220 # Temporary array to store network address and prefix of the configured
1224 # Loop through the array of available network zones.
1225 foreach my $zone (@network_zones) {
1226 # Check if the current processed zone is red.
1227 if($zone eq "red") {
1228 # Grab the IP-address of the red interface.
1229 my $red_address = &get_red_address
();
1231 # Check if an address has been obtained.
1233 # Generate full network string.
1234 my $red_network = join("/", $red_address, "32");
1236 # Add the red network to the array of networks.
1237 push(@networks, $red_network);
1240 # Check if the configured RED_TYPE is static.
1241 if ($netsettings{'RED_TYPE'} eq "STATIC") {
1242 # Get configured and enabled aliases.
1243 my @aliases = &get_aliases
();
1245 # Loop through the array.
1246 foreach my $alias (@aliases) {
1248 my $network = join("/", $alias, "32");
1250 # Add the generated network to the array of networks.
1251 push(@networks, $network);
1254 # Process remaining network zones.
1256 # Convert current zone name into upper case.
1259 # Generate key to access the required data from the netsettings hash.
1260 my $zone_netaddress = $zone . "_NETADDRESS";
1261 my $zone_netmask = $zone . "_NETMASK";
1263 # Obtain the settings from the netsettings hash.
1264 my $netaddress = $netsettings{$zone_netaddress};
1265 my $netmask = $netsettings{$zone_netmask};
1267 # Convert the subnetmask into prefix notation.
1268 my $prefix = &Network
::convert_netmask2prefix
($netmask);
1270 # Generate full network string.
1271 my $network = join("/", $netaddress,$prefix);
1273 # Check if the network is valid.
1274 if(&Network
::check_subnet
($network)) {
1275 # Add the generated network to the array of networks.
1276 push(@networks, $network);
1281 # Format home net declaration.
1282 my $line = "\"[" . join(',', @networks) . "]\"";
1284 # Open file to store the addresses of the home net.
1285 open(FILE
, ">$homenet_file") or die "Could not open $homenet_file. $!\n";
1287 # Print yaml header.
1288 print FILE
"%YAML 1.1\n";
1289 print FILE
"---\n\n";
1291 # Print notice about autogenerated file.
1292 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1294 # Print the generated and required HOME_NET declaration to the file.
1295 print FILE
"HOME_NET:\t$line\n";
1297 # Close file handle.
1302 # Function to generate and write the file which contains the configured and used DNS servers.
1304 sub generate_dns_servers_file
() {
1305 # Get the used DNS servers.
1306 my @nameservers = &General
::get_nameservers
();
1308 # Get network settings.
1310 &General
::readhash
("${General::swroot}/ethernet/settings", \
%netsettings);
1312 # Format dns servers declaration.
1315 # Check if the system has configured nameservers.
1317 # Add the GREEN address as DNS servers.
1318 push(@nameservers, $netsettings{'GREEN_ADDRESS'});
1320 # Check if a BLUE zone exists.
1321 if ($netsettings{'BLUE_ADDRESS'}) {
1322 # Add the BLUE address to the array of nameservers.
1323 push(@nameservers, $netsettings{'BLUE_ADDRESS'});
1326 # Generate the line which will be written to the DNS servers file.
1327 $line = join(",", @nameservers);
1329 # External net simply contains (any).
1330 $line = "\$EXTERNAL_NET";
1333 # Open file to store the used DNS server addresses.
1334 open(FILE
, ">$dns_servers_file") or die "Could not open $dns_servers_file. $!\n";
1336 # Print yaml header.
1337 print FILE
"%YAML 1.1\n";
1338 print FILE
"---\n\n";
1340 # Print notice about autogenerated file.
1341 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1343 # Print the generated DNS declaration to the file.
1344 print FILE
"DNS_SERVERS:\t\"[$line]\"\n";
1346 # Close file handle.
1351 # Function to generate and write the file which contains the HTTP_PORTS definition.
1353 sub generate_http_ports_file
() {
1356 # Read-in proxy settings
1357 &General
::readhash
("${General::swroot}/proxy/advanced/settings", \
%proxysettings);
1359 # Check if the proxy is enabled.
1360 if (( -e
"${General::swroot}/proxy/enable") || (-e
"${General::swroot}/proxy/enable_blue")) {
1361 # Add the proxy port to the array of HTTP ports.
1362 push(@http_ports, $proxysettings{'PROXY_PORT'});
1365 # Check if the transparent mode of the proxy is enabled.
1366 if ((-e
"${General::swroot}/proxy/transparent") || (-e
"${General::swroot}/proxy/transparent_blue")) {
1367 # Add the transparent proxy port to the array of HTTP ports.
1368 push(@http_ports, $proxysettings{'TRANSPARENT_PORT'});
1371 # Format HTTP_PORTS declaration.
1374 # Generate line which will be written to the http ports file.
1375 $line = join(",", @http_ports);
1377 # Open file to store the HTTP_PORTS.
1378 open(FILE
, ">$http_ports_file") or die "Could not open $http_ports_file. $!\n";
1380 # Print yaml header.
1381 print FILE
"%YAML 1.1\n";
1382 print FILE
"---\n\n";
1384 # Print notice about autogenerated file.
1385 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1387 # Print the generated HTTP_PORTS declaration to the file.
1388 print FILE
"HTTP_PORTS:\t\"[$line]\"\n";
1390 # Close file handle.
1395 ## Function to generate and write the file for used rulefiles file for a given provider.
1397 ## The function requires as first argument a provider handle, and as second an array with files.
1399 sub write_used_provider_rulefiles_file
($@
) {
1400 my ($provider, @files) = @_;
1402 # Get the path and file for the provider specific used rulefiles file.
1403 my $used_provider_rulesfile_file = &get_used_provider_rulesfile_file
($provider);
1405 # Open file for used rulefiles.
1406 open (FILE
, ">", "$used_provider_rulesfile_file") or die "Could not write to $used_provider_rulesfile_file. $!\n";
1408 # Write yaml header to the file.
1409 print FILE
"%YAML 1.1\n";
1410 print FILE
"---\n\n";
1412 # Write header to file.
1413 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1415 # Loop through the array of given files.
1416 foreach my $file (@files) {
1417 # Check if the given filename exists and write it to the file of used rulefiles.
1418 if(-f
"$rulespath/$file") {
1419 print FILE
" - $file\n";
1423 # Close file after writing.
1428 ## Function to write the main file for provider rulesfiles inclusions.
1430 ## This function requires an array of provider handles.
1432 sub write_main_used_rulefiles_file
(@
) {
1433 my (@providers) = @_;
1435 # Call function to write the static rulefiles file.
1436 &_write_default_rulefiles_file
();
1438 # Open file for used rulefils inclusion.
1439 open (FILE
, ">", "$suricata_used_providers_file") or die "Could not write to $suricata_used_providers_file. $!\n";
1441 # Write yaml header to the file.
1442 print FILE
"%YAML 1.1\n";
1443 print FILE
"---\n\n";
1445 # Write header to file.
1446 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1448 # Loop through the list of given providers.
1449 foreach my $provider (@providers) {
1450 # Call function to get the providers used rulefiles file.
1451 my $filename = &get_used_provider_rulesfile_file
($provider);
1453 # Check if the file exists and write it into the used rulefiles file.
1455 # Print the provider to the file.
1456 print FILE
"include\: $filename\n";
1460 # Close the filehandle after writing.
1464 sub _write_default_rulefiles_file
() {
1465 # Get enabled application layer protocols.
1466 my @enabled_app_layer_protos = &get_suricata_enabled_app_layer_protos
();
1469 open (FILE
, ">", $suricata_default_rulefiles_file) or die "Could not write to $suricata_default_rulefiles_file. $!\n";
1471 # Write yaml header to the file.
1472 print FILE
"%YAML 1.1\n";
1473 print FILE
"---\n\n";
1475 # Write notice about autogenerated file.
1476 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1478 # Loop through the array of static included rulesfiles.
1479 foreach my $file (@static_included_rulefiles) {
1480 # Check if the file exists.
1481 if (-f
"$rulespath/$file") {
1482 # Write the rulesfile name to the file.
1483 print FILE
" - $rulespath/$file\n";
1487 print FILE
"\n#Default rules for used application layer protocols.\n";
1488 foreach my $enabled_app_layer_proto (@enabled_app_layer_protos) {
1489 # Check if the current processed app layer proto needs to be translated
1490 # into an application name.
1491 if (exists($tr_app_layer_proto{$enabled_app_layer_proto})) {
1492 # Obtain the translated application name for this protocol.
1493 $enabled_app_layer_proto = $tr_app_layer_proto{$enabled_app_layer_proto};
1496 # Generate filename.
1497 my $rulesfile = "$default_rulespath/$enabled_app_layer_proto\.rules";
1499 # Check if such a file exists.
1500 if (-f
"$rulesfile") {
1501 # Write the rulesfile name to the file.
1502 print FILE
" - $rulesfile\n";
1505 # Generate filename with "events" in filename.
1506 $rulesfile = "$default_rulespath/$enabled_app_layer_proto\-events.rules";
1508 # Check if this file exists.
1509 if (-f
"$rulesfile" ) {
1510 # Write the rulesfile name to the file.
1511 print FILE
" - $rulesfile\n";
1515 # Close the file handle
1520 ## Tiny function to generate the full path and name for the used_provider_rulesfile file of a given provider.
1522 sub get_used_provider_rulesfile_file
($) {
1523 my ($provider) = @_;
1525 my $filename = "$settingsdir/suricata\-$provider\-used\-rulefiles.yaml";
1527 # Return the gernerated file.
1532 ## Function to generate and write the file for modify the ruleset.
1534 sub write_modify_sids_file
() {
1535 # Get configured settings.
1537 &General
::readhash
("$ids_settings_file", \
%idssettings);
1539 # Open modify sid's file for writing.
1540 open(FILE
, ">$modify_sids_file") or die "Could not write to $modify_sids_file. $!\n";
1542 # Write file header.
1543 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1545 # Check if the traffic only should be monitored.
1546 unless($idssettings{'MONITOR_TRAFFIC_ONLY'} eq 'on') {
1547 # Suricata is in IPS mode, which means that the rule actions have to be changed
1548 # from 'alert' to 'drop', however not all rules should be changed. Some rules
1549 # exist purely to set a flowbit which is used to convey other information, such
1550 # as a specific type of file being downloaded, to other rulewhich then check for
1551 # malware in that file. Rules which fall into the first category should stay as
1552 # alert since not all flows of that type contain malware.
1554 # These types of rulesfiles contain meta-data which gives the action that should
1555 # be used when in IPS mode. Do the following:
1557 # 1. Disable all rules and set the action to 'drop'
1558 # 2. Set the action back to 'alert' if the rule contains 'flowbits:noalert;'
1559 # This should give rules not in the policy a reasonable default if the user
1560 # manually enables them.
1561 # 3. Enable rules and set actions according to the meta-data strings.
1563 my $policy = 'balanced'; # Placeholder to allow policy to be changed.
1566 modifysid * "^#(?:alert|drop)(.+policy $policy-ips alert)" | "alert\${1}"
1567 modifysid * "^#(?:alert|drop)(.+policy $policy-ips drop)" | "drop\${1}"
1568 modifysid * "^(#?)(?:alert|drop)" | "\${1}drop"
1569 modifysid * "^(#?)drop(.+flowbits:noalert;)" | "\${1}alert\${2}"
1573 # Close file handle.
1578 ## Function to get the ruleset date for a given provider.
1580 ## The function simply return the creation date in a human read-able format
1581 ## of the stored providers rulesfile.
1583 sub get_ruleset_date
($) {
1584 my ($provider) = @_;
1588 # Load neccessary perl modules for file stat and to format the timestamp.
1590 use POSIX
qw( strftime );
1592 # Get the stored rulesfile for this provider.
1593 my $stored_rulesfile = &_get_dl_rulesfile
($provider);
1595 # Check if we got a file.
1596 if (-f
$stored_rulesfile) {
1597 # Call stat on the rulestarball.
1598 my $stat = stat("$stored_rulesfile");
1600 # Get timestamp the file creation.
1601 $mtime = $stat->mtime;
1604 # Check if the timestamp has not been grabbed.
1606 # Return N/A for Not available.
1610 # Convert into human read-able format.
1611 $date = strftime
('%Y-%m-%d %H:%M:%S', localtime($mtime));
1618 ## Function to gather the version of suricata.
1620 sub get_suricata_version
($) {
1623 # Execute piped suricata command and return the version information.
1624 open(SURICATA
, "suricata -V |") or die "Couldn't execute program: $!";
1626 # Grab and store the output of the piped program.
1627 my $version_string = <SURICATA
>;
1633 chomp($version_string);
1635 # Grab the version from the version string.
1636 $version_string =~ /([0-9]+([.][0-9]+)+)/;
1638 # Splitt the version into single chunks.
1639 my ($major_ver, $minor_ver, $patchlevel) = split(/\./, $1);
1641 # Check and return the requested version sheme.
1642 if ($format eq "major") {
1643 # Return the full version.
1644 return "$major_ver";
1645 } elsif ($format eq "minor") {
1646 # Return the major and minor part.
1647 return "$major_ver.$minor_ver";
1649 # Return the full version string.
1650 return "$major_ver.$minor_ver.$patchlevel";
1655 ## Function to get the enabled application layer protocols.
1657 sub get_suricata_enabled_app_layer_protos
() {
1658 # Array to store and return the enabled app layer protos.
1659 my @enabled_app_layer_protos = ();
1661 # Execute piped suricata command and return the list of
1662 # enabled application layer protocols.
1663 open(SURICATA
, "suricata --list-app-layer-protos |") or die "Could not execute program: $!";
1665 # Grab and store the list of enabled application layer protocols.
1666 my @output = <SURICATA
>;
1671 # Merge allways enabled static application layers protocols array.
1672 @enabled_app_layer_protos = @static_enabled_app_layer_protos;
1674 # Loop through the array which contains the output of suricata.
1675 foreach my $line (@output) {
1676 # Skip header line which starts with "===".
1677 next if ($line =~ /^\s*=/);
1679 # Skip info or warning lines.
1680 next if ($line =~ /\s*--/);
1685 # Add enabled app layer proto to the array.
1686 push(@enabled_app_layer_protos, $line);
1690 @enabled_app_layer_protos = sort(@enabled_app_layer_protos);
1693 return @enabled_app_layer_protos;
1697 ## Function to generate the rules file with whitelisted addresses.
1699 sub generate_ignore_file
() {
1702 # SID range 1000000-1999999 Reserved for Local Use
1703 # Put your custom rules in this range to avoid conflicts
1706 # Read-in ignoredfile.
1707 &General
::readhasharray
($IDS::ignored_file
, \
%ignored);
1709 # Open ignorefile for writing.
1710 open(FILE
, ">$IDS::whitelist_file") or die "Could not write to $IDS::whitelist_file. $!\n";
1712 # Config file header.
1713 print FILE
"# Autogenerated file.\n";
1714 print FILE
"# All user modifications will be overwritten.\n\n";
1716 # Add all user defined addresses to the whitelist.
1718 # Check if the hash contains any elements.
1719 if (keys (%ignored)) {
1720 # Loop through the entire hash and write the host/network
1721 # and remark to the ignore file.
1722 while ( (my $key) = each %ignored) {
1723 my $address = $ignored{$key}[0];
1724 my $remark = $ignored{$key}[1];
1725 my $status = $ignored{$key}[2];
1727 # Check if the status of the entry is "enabled".
1728 if ($status eq "enabled") {
1729 # Check if the address/network is valid.
1730 if ((&General
::validip
($address)) || (&General
::validipandmask
($address))) {
1731 # Write rule line to the file to pass any traffic from this IP
1732 print FILE
"pass ip $address any -> any any (msg:\"pass all traffic from/to $address\"\; bypass; sid:$sid\;)\n";
1745 ## Function to set correct ownership for single files and directories.
1748 sub set_ownership
($) {
1751 # User and group of the WUI.
1752 my $uname = "nobody";
1753 my $grname = "nobody";
1755 # The chown function implemented in perl requies the user and group as nummeric id's.
1756 my $uid = getpwnam($uname);
1757 my $gid = getgrnam($grname);
1759 # Check if the given target exists.
1761 # Stop the script and print error message.
1762 die "The $target does not exist. Cannot change the ownership!\n";
1765 # Check weather the target is a file or directory.
1767 # Change ownership ot the single file.
1768 chown($uid, $gid, "$target");
1769 } elsif (-d
$target) {
1770 # Do a directory listing.
1771 opendir(DIR
, $target) or die $!;
1772 # Loop through the direcory.
1773 while (my $file = readdir(DIR
)) {
1775 # We only want files.
1776 next unless (-f
"$target/$file");
1778 # Set correct ownership for the files.
1779 chown($uid, $gid, "$target/$file");
1784 # Change ownership of the directory.
1785 chown($uid, $gid, "$target");
1790 ## Function to read-in the aliases file and returns all configured and enabled aliases.
1793 # Location of the aliases file.
1794 my $aliases_file = "${General::swroot}/ethernet/aliases";
1796 # Array to store the aliases.
1799 # Check if the file is empty.
1800 if (-z
$aliases_file) {
1801 # Abort nothing to do.
1805 # Open the aliases file.
1806 open(ALIASES
, $aliases_file) or die "Could not open $aliases_file. $!\n";
1808 # Loop through the file content.
1809 while (my $line = <ALIASES
>) {
1813 # Splitt line content into single chunks.
1814 my ($address, $state, $remark) = split(/\,/, $line);
1816 # Check if the state of the current processed alias is "on".
1817 if ($state eq "on") {
1818 # Check if the address is valid.
1819 if(&Network
::check_ip_address
($address)) {
1820 # Add the alias to the array of aliases.
1821 push(@aliases, $address);
1826 # Close file handle.
1834 ## Function to grab the current assigned IP-address on red.
1836 sub get_red_address
() {
1837 # File, which contains the current IP-address of the red interface.
1838 my $file = "${General::swroot}/red/local-ipaddress";
1840 # Check if the file exists.
1842 # Open the given file.
1843 open(FILE
, "$file") or die "Could not open $file.";
1845 # Obtain the address from the first line of the file.
1846 my $address = <FILE
>;
1854 # Check if the grabbed address is valid.
1855 if (&General
::validip
($address)) {
1856 # Return the address.
1866 ## Function to get the used rules files of a given provider.
1868 sub read_used_provider_rulesfiles
($) {
1869 my ($provider) = @_;
1871 # Array to store the used rulefiles.
1872 my @used_rulesfiles = ();
1874 # Get the used rulesefile file for the provider.
1875 my $rulesfile_file = &get_used_provider_rulesfile_file
($provider);
1877 # Check if the a used rulesfile exists for this provider.
1878 if (-f
$rulesfile_file) {
1879 # Open the file or used rulefiles and read-in content.
1880 open(FILE
, $rulesfile_file) or die "Could not open $rulesfile_file. $!\n";
1883 # Assign the current line to a nice variable.
1890 next if ($line =~ /\#/);
1893 next if ($line =~ /^\s*$/);
1895 # Gather the rulefile.
1896 if ($line =~ /.*- (.*)/) {
1899 # Add the rulefile to the array of used rulesfiles.
1900 push(@used_rulesfiles, $rulefile);
1908 # Return the array of used rulesfiles.
1909 return @used_rulesfiles;
1913 ## Function to write the lock file for locking the WUI, while
1914 ## the autoupdate script runs.
1916 sub lock_ids_page
() {
1917 # Call subfunction to create the file.
1918 &create_empty_file
($ids_page_lock_file);
1922 ## Function to release the lock of the WUI, again.
1924 sub unlock_ids_page
() {
1926 unlink($ids_page_lock_file);