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
"$ignored_file") { &create_empty_file
($ignored_file); }
157 unless (-f
"$whitelist_file" ) { &create_empty_file
($whitelist_file); }
161 ## Function to get a list of all available ruleset providers.
163 ## They will be returned as a sorted array.
165 sub get_ruleset_providers
() {
168 # Loop through the hash of providers.
169 foreach my $provider ( keys %IDS::Ruleset
::Providers
) {
170 # Add the provider to the array.
171 push(@providers, $provider);
174 # Sort and return the array.
175 return sort(@providers);
179 ## Function to get a list of all enabled ruleset providers.
181 ## They will be returned as an array.
183 sub get_enabled_providers
() {
184 my %used_providers = ();
186 # Array to store the enabled providers.
187 my @enabled_providers = ();
189 # Read-in the providers config file.
190 &General
::readhasharray
("$providers_settings_file", \
%used_providers);
192 # Loop through the hash of used_providers.
193 foreach my $id (keys %used_providers) {
194 # Skip disabled providers.
195 next unless ($used_providers{$id}[3] eq "enabled");
197 # Grab the provider handle.
198 my $provider = "$used_providers{$id}[0]";
200 # Add the provider to the array of enabled providers.
201 push(@enabled_providers, $provider);
205 return @enabled_providers;
209 ## Function for checking if at least 300MB of free disk space are available
210 ## on the "/var" partition.
212 sub checkdiskspace
() {
213 # Call diskfree to gather the free disk space of /var.
214 my @df = &General
::system_output
("/bin/df", "-B", "M", "/var");
216 # Loop through the output.
217 foreach my $line (@df) {
218 # Ignore header line.
219 next if $line =~ m/^Filesystem/;
221 # Search for a line with the device information.
222 if ($line =~ m/dev/ ) {
223 # Split the line into single pieces.
224 my @values = split(' ', $line);
225 my ($filesystem, $blocks, $used, $available, $used_perenctage, $mounted_on) = @values;
227 # Check if the available disk space is more than 300MB.
228 if ($available < 300) {
229 # Log error to syslog.
230 &_log_to_syslog
("Not enough free disk space on /var. Only $available MB from 300 MB available.");
232 # Exit function and return "1" - False.
238 # Everything okay, return nothing.
243 ## This function is responsible for downloading the configured IDS rulesets or if no one is specified
244 ## all configured rulesets will be downloaded.
246 ## * At first it gathers all configured ruleset providers, initialize the downloader and sets an
247 ## upstream proxy if configured.
248 ## * After that, the given ruleset or in case all rulesets should be downloaded, it will determine wether it
249 ## is enabled or not.
250 ## * The next step will be to generate the final download url, by obtaining the URL for the desired
251 ## ruleset, add the settings for the upstream proxy.
252 ## * Finally the function will grab all the rules files or tarballs from the servers.
254 sub downloadruleset
($) {
257 # If no provider is given default to "all".
260 # Hash to store the providers and access id's, for which rules should be downloaded.
261 my %sheduled_providers = ();
263 # Get used provider settings.
264 my %used_providers = ();
265 &General
::readhasharray
("$providers_settings_file", \
%used_providers);
267 # Check if a ruleset has been configured.
268 unless(%used_providers) {
269 # Log that no ruleset has been configured and abort.
270 &_log_to_syslog
("No ruleset provider has been configured.");
276 # Read proxysettings.
277 my %proxysettings=();
278 &General
::readhash
("${General::swroot}/proxy/settings", \
%proxysettings);
280 # Load required perl module to handle the download.
283 # Init the download module.
284 my $downloader = LWP
::UserAgent
->new;
286 # Set timeout to 10 seconds.
287 $downloader->timeout(10);
289 # Check if an upstream proxy is configured.
290 if ($proxysettings{'UPSTREAM_PROXY'}) {
293 $proxy_url = "http://";
295 # Check if the proxy requires authentication.
296 if (($proxysettings{'UPSTREAM_USER'}) && ($proxysettings{'UPSTREAM_PASSWORD'})) {
297 $proxy_url .= "$proxysettings{'UPSTREAM_USER'}\:$proxysettings{'UPSTREAM_PASSWORD'}\@";
300 # Add proxy server address and port.
301 $proxy_url .= $proxysettings{'UPSTREAM_PROXY'};
303 # Setup proxy settings.
304 $downloader->proxy(['http', 'https'], $proxy_url);
307 # Loop through the hash of configured providers.
308 foreach my $id ( keys %used_providers ) {
309 # Skip providers which are not enabled.
310 next if ($used_providers{$id}[3] ne "enabled");
312 # Obtain the provider handle.
313 my $provider_handle = $used_providers{$id}[0];
315 # Handle update off all providers.
316 if (($provider eq "all") || ($provider_handle eq "$provider")) {
317 # Add provider handle and it's id to the hash of sheduled providers.
318 $sheduled_providers{$provider_handle} = $id;
322 # Loop through the hash of sheduled providers.
323 foreach my $provider ( keys %sheduled_providers) {
324 # Log download/update of the ruleset.
325 &_log_to_syslog
("Downloading ruleset for provider: $provider.");
327 # Grab the download url for the provider.
328 my $url = $IDS::Ruleset
::Providers
{$provider}{'dl_url'};
330 # Check if the provider requires a subscription.
331 if ($IDS::Ruleset
::Providers
{$provider}{'requires_subscription'} eq "True") {
332 # Grab the previously stored access id for the provider from hash.
333 my $id = $sheduled_providers{$provider};
335 # Grab the subscription code.
336 my $subscription_code = $used_providers{$id}[1];
338 # Add the subscription code to the download url.
339 $url =~ s/\<subscription_code\>/$subscription_code/g;
343 # Abort if no url could be determined for the provider.
345 # Log error and abort.
346 &_log_to_syslog
("Unable to gather a download URL for the selected ruleset provider.");
350 # Variable to store the filesize of the remote object.
353 # The sourcfire (snort rules) does not allow to send "HEAD" requests, so skip this check
354 # for this webserver.
356 # Check if the ruleset source contains "snort.org".
357 unless ($url =~ /\.snort\.org/) {
358 # Pass the requrested url to the downloader.
359 my $request = HTTP
::Request
->new(HEAD
=> $url);
361 # Accept the html header.
362 $request->header('Accept' => 'text/html');
364 # Perform the request and fetch the html header.
365 my $response = $downloader->request($request);
367 # Check if there was any error.
368 unless ($response->is_success) {
370 my $error = $response->status_line();
373 &_log_to_syslog
("Unable to download the ruleset. \($error\)");
375 # Return "1" - false.
379 # Assign the fetched header object.
380 my $header = $response->headers();
382 # Grab the remote file size from the object and store it in the
384 $remote_filesize = $header->content_length;
387 # Load perl module to deal with temporary files.
390 # Generate temporary file name, located in "/var/tmp" and with a suffix of ".tmp".
391 my $tmp = File
::Temp
->new( SUFFIX
=> ".tmp", DIR
=> "/var/tmp/", UNLINK
=> 0 );
392 my $tmpfile = $tmp->filename();
394 # Pass the requested url to the downloader.
395 my $request = HTTP
::Request
->new(GET
=> $url);
397 # Perform the request and save the output into the tmpfile.
398 my $response = $downloader->request($request, $tmpfile);
400 # Check if there was any error.
401 unless ($response->is_success) {
403 my $error = $response->content;
406 &_log_to_syslog
("Unable to download the ruleset. \($error\)");
408 # Return "1" - false.
412 # Load perl stat module.
415 # Perform stat on the tmpfile.
416 my $stat = stat($tmpfile);
418 # Grab the local filesize of the downloaded tarball.
419 my $local_filesize = $stat->size;
421 # Check if both file sizes match.
422 if (($remote_filesize) && ($remote_filesize ne $local_filesize)) {
424 &_log_to_syslog
("Unable to completely download the ruleset. ");
425 &_log_to_syslog
("Only got $local_filesize Bytes instead of $remote_filesize Bytes. ");
427 # Delete temporary file.
430 # Return "1" - false.
434 # Genarate and assign file name and path to store the downloaded rules file.
435 my $dl_rulesfile = &_get_dl_rulesfile
($provider);
437 # Check if a file name could be obtained.
438 unless ($dl_rulesfile) {
440 &_log_to_syslog
("Unable to store the downloaded rules file. ");
442 # Delete downloaded temporary file.
445 # Return "1" - false.
449 # Load file copy module, which contains the move() function.
452 # Overwrite the may existing rulefile or tarball with the downloaded one.
453 move
("$tmpfile", "$dl_rulesfile");
455 # Delete temporary file.
458 # Set correct ownership for the tarball.
459 set_ownership
("$dl_rulesfile");
462 # If we got here, everything worked fine. Return nothing.
467 ## Function to extract a given ruleset.
469 ## In case the ruleset provider offers a plain file, it simply will
472 sub extractruleset
($) {
475 # Load perl module to deal with archives.
478 # Load perl module to deal with files and path.
481 # Load perl module for file copying.
484 # Get full path and downloaded rulesfile for the given provider.
485 my $tarball = &_get_dl_rulesfile
($provider);
487 # Check if the file exists.
488 unless (-f
$tarball) {
489 &_log_to_syslog
("Could not find ruleset file: $tarball");
495 # Check if the temporary directories exist, otherwise create them.
496 mkdir("$tmp_directory") unless (-d
"$tmp_directory");
497 mkdir("$tmp_rules_directory") unless (-d
"$tmp_rules_directory");
498 mkdir("$tmp_conf_directory") unless (-d
"$tmp_conf_directory");
500 # Omit the type (dl_type) of the stored ruleset.
501 my $type = $IDS::Ruleset
::Providers
{$provider}{'dl_type'};
503 # Handle the different ruleset types.
504 if ($type eq "plain") {
505 # Generate destination filename an full path.
506 my $destination = "$tmp_rules_directory/$provider\-ruleset.rules";
508 # Copy the file into the temporary rules directory.
509 copy
($tarball, $destination);
511 } elsif ( $type eq "archive") {
512 # Initialize the tar module.
513 my $tar = Archive
::Tar
->new($tarball);
515 # Get the filelist inside the tarball.
516 my @packed_files = $tar->list_files;
518 # Loop through the filelist.
519 foreach my $packed_file (@packed_files) {
522 # Splitt the packed file into chunks.
523 my $file = fileparse
($packed_file);
525 # Handle msg-id.map file.
526 if ("$file" eq "sid-msg.map") {
527 # Set extract destination to temporary config_dir.
528 $destination = "$tmp_conf_directory/$provider\-sid-msg.map";
530 # Handle classification.conf
531 } elsif ("$file" eq "classification.config") {
532 # Set extract destination to temporary config_dir.
533 $destination = "$tmp_conf_directory/$provider\-classification.config";
535 # Handle rules files.
536 } elsif ($file =~ m/\.rules$/) {
539 # Splitt the filename into chunks.
540 my @filename = split("-", $file);
543 @filename = reverse(@filename);
545 # Get the amount of elements in the array.
546 my $elements = @filename;
548 # Remove last element of the hash.
549 # It contains the vendor name, which will be replaced.
550 if ($elements >= 3) {
551 # Remove last element from hash.
555 # Check if the last element of the filename does not
556 # contain the providers name.
557 if ($filename[-1] ne "$provider") {
558 # Add provider name as last element.
559 push(@filename, $provider);
562 # Reverse the array back.
563 @filename = reverse(@filename);
565 # Generate the name for the rulesfile.
566 $rulesfilename = join("-", @filename);
568 # Set extract destination to temporaray rules_dir.
569 $destination = "$tmp_rules_directory/$rulesfilename";
571 # Skip all other files.
575 # Extract the file to the temporary directory.
576 $tar->extract_file("$packed_file", "$destination");
582 ## A wrapper function to call the oinkmaster script, setup the rules structues and
583 ## call the functions to merge the additional config files. (classification, sid-msg, etc.).
586 # Check if the files in rulesdir have the correct permissions.
587 &_check_rulesdir_permissions
();
589 # Cleanup the rules directory before filling it with the new rulests.
590 &_cleanup_rulesdir
();
592 # Get all enabled providers.
593 my @enabled_providers = &get_enabled_providers
();
595 # Loop through the array of enabled providers.
596 foreach my $provider (@enabled_providers) {
597 # Call the extractruleset function.
598 &extractruleset
($provider);
601 # Load perl module to talk to the kernel syslog.
602 use Sys
::Syslog
qw(:DEFAULT setlogsock);
604 # Establish the connection to the syslog service.
605 openlog
('oinkmaster', 'cons,pid', 'user');
607 # Call oinkmaster to generate ruleset.
608 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";
610 # Log output of oinkmaster to syslog.
611 while(<OINKMASTER
>) {
612 # The syslog function works best with an array based input,
613 # so generate one before passing the message details to syslog.
614 my @syslog = ("INFO", "$_");
616 # Send the log message.
620 # Close the pipe to oinkmaster process.
623 # Close the log handle.
626 # Call function to merge the classification files.
627 &merge_classifications
(@enabled_providers);
629 # Call function to merge the sid to message mapping files.
630 &merge_sid_msg
(@enabled_providers);
632 # Cleanup temporary directory.
633 &cleanup_tmp_directory
();
637 ## Function to merge the classifications for a given amount of providers and write them
638 ## to the classifications file.
640 sub merge_classifications
(@
) {
643 # Hash to store all collected classifications.
644 my %classifications = ();
646 # Loop through the given array of providers.
647 foreach my $provider (@providers) {
648 # Generate full path to classification file.
649 my $classification_file = "$tmp_conf_directory/$provider\-classification.config";
651 # Skip provider if no classification file exists.
652 next unless (-f
"$classification_file");
654 # Open the classification file.
655 open(CLASSIFICATION
, $classification_file) or die "Could not open file $classification_file. $!\n";
657 # Loop through the file content.
658 while(<CLASSIFICATION
>) {
659 # Parse the file and grab the classification details.
660 if ($_ =~/.*config classification\: (.*)/) {
661 # Split the grabbed details.
662 my ($short_name, $short_desc, $priority) = split("\,", $1);
664 # Check if the grabbed classification is allready known and the priority value is greater
665 # than the stored one (which causes less priority in the IDS).
666 if (($classifications{$short_name}) && ($classifications{$short_name}[1] >= $priority)) {
667 #Change the priority value to the stricter one.
668 $classifications{$short_name} = [ "$classifications{$short_name}[0]", "$priority" ];
670 # Add the classification to the hash.
671 $classifications{$short_name} = [ "$short_desc", "$priority" ];
677 close(CLASSIFICATION
);
680 # Open classification file for writing.
681 open(FILE
, ">", "$classification_file") or die "Could not write to $classification_file. $!\n";
683 # Print notice about autogenerated file.
684 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n\n";
686 # Sort and loop through the hash of classifications.
687 foreach my $key (sort keys %classifications) {
688 # Assign some nice variable names for the items.
689 my $short_name = $key;
690 my $short_desc = $classifications{$key}[0];
691 my $priority = $classifications{$key}[1];
693 # Write the classification to the file.
694 print FILE
"config classification: $short_name,$short_desc,$priority\n";
702 ## Function to merge the "sid to message mapping" files of various given providers.
704 sub merge_sid_msg
(@
) {
707 # Hash which contains all the sid to message mappings.
710 # Loop through the array of given providers.
711 foreach my $provider (@providers) {
712 # Generate full path and filename.
713 my $sid_msg_file = "$tmp_conf_directory/$provider\-sid-msg.map";
715 # Skip provider if no sid to msg mapping file for this provider exists.
716 next unless (-f
$sid_msg_file);
719 open(MAPPING
, $sid_msg_file) or die "Could not open $sid_msg_file. $!\n";
721 # Loop through the file content.
726 # Skip lines which do not start with a number,
727 next unless ($_ =~ /^\d+/);
729 # Split line content and assign it to an array.
730 my @line = split(/ \|\| /, $_);
732 # Grab the first element (and remove it) from the line array.
733 # It contains the sid.
734 my $sid = shift(@line);
736 # Store the grabbed sid and the remain array as hash value.
737 # It still contains the messages, references etc.
738 $mappings{$sid} = [@line];
745 # Open mappings file for writing.
746 open(FILE
, ">", $sid_msg_file) or die "Could not write $sid_msg_file. $!\n";
748 # Write notice about autogenerated file.
749 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n\n";
751 # Loop through the hash of mappings.
752 foreach my $sid ( sort keys %mappings) {
753 # Grab data for the sid.
754 my @data = @
{$mappings{$sid}};
756 # Add the sid to the data array.
757 unshift(@data, $sid);
760 my $line = join(" \|\| ", @data);
762 print FILE
"$line\n";
771 ## A very tiny function to move an extracted ruleset from the temporary directory into
772 ## the rules directory.
774 sub move_tmp_ruleset
() {
778 # Do a directory listing of the temporary directory.
779 opendir DH
, $tmp_rules_directory;
781 # Loop over all files.
782 while(my $file = readdir DH
) {
783 # Move them to the rules directory.
784 move
"$tmp_rules_directory/$file" , "$rulespath/$file";
787 # Close directory handle.
792 ## Function to cleanup the temporary IDS directroy.
794 sub cleanup_tmp_directory
() {
795 # Load rmtree() function from file path perl module.
796 use File
::Path
'rmtree';
798 # Delete temporary directory and all containing files.
799 rmtree
([ "$tmp_directory" ]);
803 ## Function to do all the logging stuff if the downloading or updating of the ruleset fails.
808 # Remove any newline.
811 # Call private function to log the error message to syslog.
812 &_log_to_syslog
($error);
814 # Call private function to write/store the error message in the storederrorfile.
815 &_store_error_message
($error);
819 ## Function to log a given error message to the kernel syslog.
821 sub _log_to_syslog
($) {
824 # Load perl module to talk to the kernel syslog.
825 use Sys
::Syslog
qw(:DEFAULT setlogsock);
827 # The syslog function works best with an array based input,
828 # so generate one before passing the message details to syslog.
829 my @syslog = ("ERR", "<ERROR> $message");
831 # Establish the connection to the syslog service.
832 openlog
('oinkmaster', 'cons,pid', 'user');
834 # Send the log message.
837 # Close the log handle.
842 ## Private function to write a given error message to the storederror file.
844 sub _store_error_message
($) {
847 # Remove any newline.
850 # Open file for writing.
851 open (ERRORFILE
, ">$storederrorfile") or die "Could not write to $storederrorfile. $!\n";
853 # Write error to file.
854 print ERRORFILE
"$message\n";
859 # Set correct ownership for the file.
860 &set_ownership
("$storederrorfile");
864 ## Private function to get the path and filename for a downloaded ruleset by a given provider.
866 sub _get_dl_rulesfile
($) {
869 # Gather the download type for the given provider.
870 my $dl_type = $IDS::Ruleset
::Providers
{$provider}{'dl_type'};
872 # Obtain the file suffix for the download file type.
873 my $suffix = $dl_type_to_suffix{$dl_type};
875 # Check if a suffix has been found.
877 # Abort return - nothing.
881 # Generate the full filename and path for the stored rules file.
882 my $rulesfile = "$dl_rules_path/$dl_rulesfile_prefix-$provider$suffix";
884 # Return the generated filename.
889 ## Tiny function to delete the stored ruleset file or tarball for a given provider.
891 sub drop_dl_rulesfile
($) {
894 # Gather the full path and name of the stored rulesfile.
895 my $rulesfile = &_get_dl_rulesfile
($provider);
897 # Check if the given rulesfile exists.
899 # Delete the stored rulesfile.
900 unlink($rulesfile) or die "Could not delete $rulesfile. $!\n";
905 ## Tiny function to get/generate the full path and filename for the providers oinkmaster
906 ## modified sids file.
908 sub get_oinkmaster_provider_modified_sids_file
($) {
911 # Generate the filename.
912 my $filename = "$settingsdir/oinkmaster-$provider-modified-sids.conf";
914 # Return the filename.
919 ## Function to directly altering the oinkmaster provider includes file.
921 ## Requires tha acition "remove" or "add" and a provider handle.
923 sub alter_oinkmaster_provider_includes_file
($$) {
924 my ($action, $provider) = @_;
926 # Call function to get the path and name for the given providers
927 # oinkmaster modified sids file.
928 my $provider_modified_sids_file = &get_oinkmaster_provider_modified_sids_file
($provider);
930 # Open the file for reading..
931 open (FILE
, $oinkmaster_provider_includes_file) or die "Could not read $oinkmaster_provider_includes_file. $!\n";
933 # Read-in file content.
936 # Close file after reading.
939 # Re-open the file for writing.
940 open(FILE
, ">", $oinkmaster_provider_includes_file) or die "Could not write to $oinkmaster_provider_includes_file. $!\n";
942 # Loop through the file content.
943 foreach my $line (@lines) {
947 # Skip line if we found our given provider and the action should be remove.
948 next if (($line =~ /$provider/) && ($action eq "remove"));
950 # Write the read-in line back to the file.
951 print FILE
"$line\n";
954 # Check if the file exists and add the provider if requested.
955 if ((-f
$provider_modified_sids_file) && ($action eq "add")) {
956 print FILE
"include $provider_modified_sids_file\n";
964 ## Function to read-in the given enabled or disables sids file.
966 sub read_enabled_disabled_sids_file
($) {
969 # Temporary hash to store the sids and their state. It will be
970 # returned at the end of this function.
973 # Open the given filename.
974 open(FILE
, "$file") or die "Could not open $file. $!\n";
976 # Loop through the file.
982 next if ($_ =~ /^\s*$/);
985 next if ($_ =~ /^\#/);
987 # Splitt line into sid and state part.
988 my ($state, $sid) = split(" ", $_);
990 # Skip line if the sid is not numeric.
991 next unless ($sid =~ /\d+/ );
993 # Check if the sid was enabled.
994 if ($state eq "enablesid") {
995 # Add the sid and its state as enabled to the temporary hash.
996 $temphash{$sid} = "enabled";
997 # Check if the sid was disabled.
998 } elsif ($state eq "disablesid") {
999 # Add the sid and its state as disabled to the temporary hash.
1000 $temphash{$sid} = "disabled";
1001 # Invalid state - skip the current sid and state.
1015 ## Function to check if the IDS is running.
1017 sub ids_is_running
() {
1018 if(-f
$idspidfile) {
1019 # Open PID file for reading.
1020 open(PIDFILE
, "$idspidfile") or die "Could not open $idspidfile. $!\n";
1022 # Grab the process-id.
1023 my $pid = <PIDFILE
>;
1028 # Remove any newline.
1031 # Check if a directory for the process-id exists in proc.
1032 if(-d
"/proc/$pid") {
1033 # The IDS daemon is running return the process id.
1038 # Return nothing - IDS is not running.
1043 ## Function to call suricatactrl binary with a given command.
1045 sub call_suricatactrl
($) {
1046 # Get called option.
1047 my ($option, $interval) = @_;
1049 # Loop through the array of supported commands and check if
1050 # the given one is part of it.
1051 foreach my $cmd (@suricatactrl_cmds) {
1052 # Skip current command unless the given one has been found.
1053 next unless($cmd eq $option);
1055 # Check if the given command is "cron".
1056 if ($option eq "cron") {
1057 # Check if an interval has been given.
1059 # Check if the given interval is valid.
1060 foreach my $element (@cron_intervals) {
1061 # Skip current element until the given one has been found.
1062 next unless($element eq $interval);
1064 # Call the suricatactrl binary and pass the "cron" command
1065 # with the requrested interval.
1066 &General
::system("$suricatactrl", "$option", "$interval");
1068 # Return "1" - True.
1073 # If we got here, the given interval is not supported or none has been given. - Return nothing.
1076 # Call the suricatactrl binary and pass the requrested
1078 &General
::system("$suricatactrl", "$option");
1080 # Return "1" - True.
1085 # Command not found - return nothing.
1090 ## Function to create a new empty file.
1092 sub create_empty_file
($) {
1095 # Check if the given file exists.
1097 # Do nothing to prevent from overwriting existing files.
1101 # Open the file for writing.
1102 open(FILE
, ">$file") or die "Could not write to $file. $!\n";
1104 # Close file handle.
1112 ## Private function to check if the file permission of the rulespath are correct.
1113 ## If not, call suricatactrl to fix them.
1115 sub _check_rulesdir_permissions
() {
1116 # Check if the rulepath main directory is writable.
1117 unless (-W
$rulespath) {
1118 # If not call suricatctrl to fix it.
1119 &call_suricatactrl
("fix-rules-dir");
1122 # Open snort rules directory and do a directory listing.
1123 opendir(DIR
, $rulespath) or die $!;
1124 # Loop through the direcory.
1125 while (my $file = readdir(DIR
)) {
1126 # We only want files.
1127 next unless (-f
"$rulespath/$file");
1129 # Check if the file is writable by the user.
1130 if (-W
"$rulespath/$file") {
1131 # Everything is okay - go on to the next file.
1134 # There are wrong permissions, call suricatactrl to fix it.
1135 &call_suricatactrl
("fix-rules-dir");
1141 ## Private function to cleanup the directory which contains
1142 ## the IDS rules, before extracting and modifing the new ruleset.
1144 sub _cleanup_rulesdir
() {
1145 # Open rules directory and do a directory listing.
1146 opendir(DIR
, $rulespath) or die $!;
1148 # Loop through the direcory.
1149 while (my $file = readdir(DIR
)) {
1150 # We only want files.
1151 next unless (-f
"$rulespath/$file");
1153 # Skip rules file for whitelisted hosts.
1154 next if ("$rulespath/$file" eq $whitelist_file);
1156 # Skip rules file with local rules.
1157 next if ("$rulespath/$file" eq $local_rules_file);
1159 # Delete the current processed file, if not, exit this function
1160 # and return an error message.
1161 unlink("$rulespath/$file") or return "Could not delete $rulespath/$file. $!\n";
1169 ## Function to generate the file which contains the home net information.
1171 sub generate_home_net_file
() {
1174 # Read-in network settings.
1175 &General
::readhash
("${General::swroot}/ethernet/settings", \
%netsettings);
1177 # Get available network zones.
1178 my @network_zones = &Network
::get_available_network_zones
();
1180 # Temporary array to store network address and prefix of the configured
1184 # Loop through the array of available network zones.
1185 foreach my $zone (@network_zones) {
1186 # Check if the current processed zone is red.
1187 if($zone eq "red") {
1188 # Grab the IP-address of the red interface.
1189 my $red_address = &get_red_address
();
1191 # Check if an address has been obtained.
1193 # Generate full network string.
1194 my $red_network = join("/", $red_address, "32");
1196 # Add the red network to the array of networks.
1197 push(@networks, $red_network);
1200 # Check if the configured RED_TYPE is static.
1201 if ($netsettings{'RED_TYPE'} eq "STATIC") {
1202 # Get configured and enabled aliases.
1203 my @aliases = &get_aliases
();
1205 # Loop through the array.
1206 foreach my $alias (@aliases) {
1208 my $network = join("/", $alias, "32");
1210 # Add the generated network to the array of networks.
1211 push(@networks, $network);
1214 # Process remaining network zones.
1216 # Convert current zone name into upper case.
1219 # Generate key to access the required data from the netsettings hash.
1220 my $zone_netaddress = $zone . "_NETADDRESS";
1221 my $zone_netmask = $zone . "_NETMASK";
1223 # Obtain the settings from the netsettings hash.
1224 my $netaddress = $netsettings{$zone_netaddress};
1225 my $netmask = $netsettings{$zone_netmask};
1227 # Convert the subnetmask into prefix notation.
1228 my $prefix = &Network
::convert_netmask2prefix
($netmask);
1230 # Generate full network string.
1231 my $network = join("/", $netaddress,$prefix);
1233 # Check if the network is valid.
1234 if(&Network
::check_subnet
($network)) {
1235 # Add the generated network to the array of networks.
1236 push(@networks, $network);
1241 # Format home net declaration.
1242 my $line = "\"[" . join(',', @networks) . "]\"";
1244 # Open file to store the addresses of the home net.
1245 open(FILE
, ">$homenet_file") or die "Could not open $homenet_file. $!\n";
1247 # Print yaml header.
1248 print FILE
"%YAML 1.1\n";
1249 print FILE
"---\n\n";
1251 # Print notice about autogenerated file.
1252 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1254 # Print the generated and required HOME_NET declaration to the file.
1255 print FILE
"HOME_NET:\t$line\n";
1257 # Close file handle.
1262 # Function to generate and write the file which contains the configured and used DNS servers.
1264 sub generate_dns_servers_file
() {
1265 # Get the used DNS servers.
1266 my @nameservers = &General
::get_nameservers
();
1268 # Get network settings.
1270 &General
::readhash
("${General::swroot}/ethernet/settings", \
%netsettings);
1272 # Format dns servers declaration.
1275 # Check if the system has configured nameservers.
1277 # Add the GREEN address as DNS servers.
1278 push(@nameservers, $netsettings{'GREEN_ADDRESS'});
1280 # Check if a BLUE zone exists.
1281 if ($netsettings{'BLUE_ADDRESS'}) {
1282 # Add the BLUE address to the array of nameservers.
1283 push(@nameservers, $netsettings{'BLUE_ADDRESS'});
1286 # Generate the line which will be written to the DNS servers file.
1287 $line = join(",", @nameservers);
1289 # External net simply contains (any).
1290 $line = "\$EXTERNAL_NET";
1293 # Open file to store the used DNS server addresses.
1294 open(FILE
, ">$dns_servers_file") or die "Could not open $dns_servers_file. $!\n";
1296 # Print yaml header.
1297 print FILE
"%YAML 1.1\n";
1298 print FILE
"---\n\n";
1300 # Print notice about autogenerated file.
1301 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1303 # Print the generated DNS declaration to the file.
1304 print FILE
"DNS_SERVERS:\t\"[$line]\"\n";
1306 # Close file handle.
1311 # Function to generate and write the file which contains the HTTP_PORTS definition.
1313 sub generate_http_ports_file
() {
1316 # Read-in proxy settings
1317 &General
::readhash
("${General::swroot}/proxy/advanced/settings", \
%proxysettings);
1319 # Check if the proxy is enabled.
1320 if (( -e
"${General::swroot}/proxy/enable") || (-e
"${General::swroot}/proxy/enable_blue")) {
1321 # Add the proxy port to the array of HTTP ports.
1322 push(@http_ports, $proxysettings{'PROXY_PORT'});
1325 # Check if the transparent mode of the proxy is enabled.
1326 if ((-e
"${General::swroot}/proxy/transparent") || (-e
"${General::swroot}/proxy/transparent_blue")) {
1327 # Add the transparent proxy port to the array of HTTP ports.
1328 push(@http_ports, $proxysettings{'TRANSPARENT_PORT'});
1331 # Format HTTP_PORTS declaration.
1334 # Generate line which will be written to the http ports file.
1335 $line = join(",", @http_ports);
1337 # Open file to store the HTTP_PORTS.
1338 open(FILE
, ">$http_ports_file") or die "Could not open $http_ports_file. $!\n";
1340 # Print yaml header.
1341 print FILE
"%YAML 1.1\n";
1342 print FILE
"---\n\n";
1344 # Print notice about autogenerated file.
1345 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1347 # Print the generated HTTP_PORTS declaration to the file.
1348 print FILE
"HTTP_PORTS:\t\"[$line]\"\n";
1350 # Close file handle.
1355 ## Function to generate and write the file for used rulefiles file for a given provider.
1357 ## The function requires as first argument a provider handle, and as second an array with files.
1359 sub write_used_provider_rulefiles_file
($@
) {
1360 my ($provider, @files) = @_;
1362 # Get the path and file for the provider specific used rulefiles file.
1363 my $used_provider_rulesfile_file = &get_used_provider_rulesfile_file
($provider);
1365 # Open file for used rulefiles.
1366 open (FILE
, ">", "$used_provider_rulesfile_file") or die "Could not write to $used_provider_rulesfile_file. $!\n";
1368 # Write yaml header to the file.
1369 print FILE
"%YAML 1.1\n";
1370 print FILE
"---\n\n";
1372 # Write header to file.
1373 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1375 # Loop through the array of given files.
1376 foreach my $file (@files) {
1377 # Check if the given filename exists and write it to the file of used rulefiles.
1378 if(-f
"$rulespath/$file") {
1379 print FILE
" - $file\n";
1383 # Close file after writing.
1388 ## Function to write the main file for provider rulesfiles inclusions.
1390 ## This function requires an array of provider handles.
1392 sub write_main_used_rulefiles_file
(@
) {
1393 my (@providers) = @_;
1395 # Call function to write the static rulefiles file.
1396 &_write_default_rulefiles_file
();
1398 # Open file for used rulefils inclusion.
1399 open (FILE
, ">", "$suricata_used_providers_file") or die "Could not write to $suricata_used_providers_file. $!\n";
1401 # Write yaml header to the file.
1402 print FILE
"%YAML 1.1\n";
1403 print FILE
"---\n\n";
1405 # Write header to file.
1406 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1408 # Loop through the list of given providers.
1409 foreach my $provider (@providers) {
1410 # Call function to get the providers used rulefiles file.
1411 my $filename = &get_used_provider_rulesfile_file
($provider);
1413 # Check if the file exists and write it into the used rulefiles file.
1415 # Print the provider to the file.
1416 print FILE
"include\: $filename\n";
1420 # Close the filehandle after writing.
1424 sub _write_default_rulefiles_file
() {
1425 # Get enabled application layer protocols.
1426 my @enabled_app_layer_protos = &get_suricata_enabled_app_layer_protos
();
1429 open (FILE
, ">", $suricata_default_rulefiles_file) or die "Could not write to $suricata_default_rulefiles_file. $!\n";
1431 # Write yaml header to the file.
1432 print FILE
"%YAML 1.1\n";
1433 print FILE
"---\n\n";
1435 # Write notice about autogenerated file.
1436 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1438 # Loop through the array of static included rulesfiles.
1439 foreach my $file (@static_included_rulefiles) {
1440 # Check if the file exists.
1441 if (-f
"$rulespath/$file") {
1442 # Write the rulesfile name to the file.
1443 print FILE
" - $rulespath/$file\n";
1447 print FILE
"\n#Default rules for used application layer protocols.\n";
1448 foreach my $enabled_app_layer_proto (@enabled_app_layer_protos) {
1449 # Check if the current processed app layer proto needs to be translated
1450 # into an application name.
1451 if (exists($tr_app_layer_proto{$enabled_app_layer_proto})) {
1452 # Obtain the translated application name for this protocol.
1453 $enabled_app_layer_proto = $tr_app_layer_proto{$enabled_app_layer_proto};
1456 # Generate filename.
1457 my $rulesfile = "$default_rulespath/$enabled_app_layer_proto\.rules";
1459 # Check if such a file exists.
1460 if (-f
"$rulesfile") {
1461 # Write the rulesfile name to the file.
1462 print FILE
" - $rulesfile\n";
1465 # Generate filename with "events" in filename.
1466 $rulesfile = "$default_rulespath/$enabled_app_layer_proto\-events.rules";
1468 # Check if this file exists.
1469 if (-f
"$rulesfile" ) {
1470 # Write the rulesfile name to the file.
1471 print FILE
" - $rulesfile\n";
1475 # Close the file handle
1480 ## Tiny function to generate the full path and name for the used_provider_rulesfile file of a given provider.
1482 sub get_used_provider_rulesfile_file
($) {
1483 my ($provider) = @_;
1485 my $filename = "$settingsdir/suricata\-$provider\-used\-rulefiles.yaml";
1487 # Return the gernerated file.
1492 ## Function to generate and write the file for modify the ruleset.
1494 sub write_modify_sids_file
() {
1495 # Get configured settings.
1497 &General
::readhash
("$ids_settings_file", \
%idssettings);
1499 # Open modify sid's file for writing.
1500 open(FILE
, ">$modify_sids_file") or die "Could not write to $modify_sids_file. $!\n";
1502 # Write file header.
1503 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1505 # Check if the traffic only should be monitored.
1506 unless($idssettings{'MONITOR_TRAFFIC_ONLY'} eq 'on') {
1507 # Suricata is in IPS mode, which means that the rule actions have to be changed
1508 # from 'alert' to 'drop', however not all rules should be changed. Some rules
1509 # exist purely to set a flowbit which is used to convey other information, such
1510 # as a specific type of file being downloaded, to other rulewhich then check for
1511 # malware in that file. Rules which fall into the first category should stay as
1512 # alert since not all flows of that type contain malware.
1514 # These types of rulesfiles contain meta-data which gives the action that should
1515 # be used when in IPS mode. Do the following:
1517 # 1. Disable all rules and set the action to 'drop'
1518 # 2. Set the action back to 'alert' if the rule contains 'flowbits:noalert;'
1519 # This should give rules not in the policy a reasonable default if the user
1520 # manually enables them.
1521 # 3. Enable rules and set actions according to the meta-data strings.
1523 my $policy = 'balanced'; # Placeholder to allow policy to be changed.
1526 modifysid * "^#(?:alert|drop)(.+policy $policy-ips alert)" | "alert\${1}"
1527 modifysid * "^#(?:alert|drop)(.+policy $policy-ips drop)" | "drop\${1}"
1528 modifysid * "^(#?)(?:alert|drop)" | "\${1}drop"
1529 modifysid * "^(#?)drop(.+flowbits:noalert;)" | "\${1}alert\${2}"
1533 # Close file handle.
1538 ## Function to get the ruleset date for a given provider.
1540 ## The function simply return the creation date in a human read-able format
1541 ## of the stored providers rulesfile.
1543 sub get_ruleset_date
($) {
1544 my ($provider) = @_;
1548 # Load neccessary perl modules for file stat and to format the timestamp.
1550 use POSIX
qw( strftime );
1552 # Get the stored rulesfile for this provider.
1553 my $stored_rulesfile = &_get_dl_rulesfile
($provider);
1555 # Check if we got a file.
1556 if (-f
$stored_rulesfile) {
1557 # Call stat on the rulestarball.
1558 my $stat = stat("$stored_rulesfile");
1560 # Get timestamp the file creation.
1561 $mtime = $stat->mtime;
1564 # Check if the timestamp has not been grabbed.
1566 # Return N/A for Not available.
1570 # Convert into human read-able format.
1571 $date = strftime
('%Y-%m-%d %H:%M:%S', localtime($mtime));
1578 ## Function to gather the version of suricata.
1580 sub get_suricata_version
($) {
1583 # Execute piped suricata command and return the version information.
1584 open(SURICATA
, "suricata -V |") or die "Couldn't execute program: $!";
1586 # Grab and store the output of the piped program.
1587 my $version_string = <SURICATA
>;
1593 chomp($version_string);
1595 # Grab the version from the version string.
1596 $version_string =~ /([0-9]+([.][0-9]+)+)/;
1598 # Splitt the version into single chunks.
1599 my ($major_ver, $minor_ver, $patchlevel) = split(/\./, $1);
1601 # Check and return the requested version sheme.
1602 if ($format eq "major") {
1603 # Return the full version.
1604 return "$major_ver";
1605 } elsif ($format eq "minor") {
1606 # Return the major and minor part.
1607 return "$major_ver.$minor_ver";
1609 # Return the full version string.
1610 return "$major_ver.$minor_ver.$patchlevel";
1615 ## Function to get the enabled application layer protocols.
1617 sub get_suricata_enabled_app_layer_protos
() {
1618 # Array to store and return the enabled app layer protos.
1619 my @enabled_app_layer_protos = ();
1621 # Execute piped suricata command and return the list of
1622 # enabled application layer protocols.
1623 open(SURICATA
, "suricata --list-app-layer-protos |") or die "Could not execute program: $!";
1625 # Grab and store the list of enabled application layer protocols.
1626 my @output = <SURICATA
>;
1631 # Merge allways enabled static application layers protocols array.
1632 @enabled_app_layer_protos = @static_enabled_app_layer_protos;
1634 # Loop through the array which contains the output of suricata.
1635 foreach my $line (@output) {
1636 # Skip header line which starts with "===".
1637 next if ($line =~ /^\s*=/);
1639 # Skip info or warning lines.
1640 next if ($line =~ /\s*--/);
1645 # Add enabled app layer proto to the array.
1646 push(@enabled_app_layer_protos, $line);
1650 @enabled_app_layer_protos = sort(@enabled_app_layer_protos);
1653 return @enabled_app_layer_protos;
1657 ## Function to generate the rules file with whitelisted addresses.
1659 sub generate_ignore_file
() {
1662 # SID range 1000000-1999999 Reserved for Local Use
1663 # Put your custom rules in this range to avoid conflicts
1666 # Read-in ignoredfile.
1667 &General
::readhasharray
($IDS::ignored_file
, \
%ignored);
1669 # Open ignorefile for writing.
1670 open(FILE
, ">$IDS::whitelist_file") or die "Could not write to $IDS::whitelist_file. $!\n";
1672 # Config file header.
1673 print FILE
"# Autogenerated file.\n";
1674 print FILE
"# All user modifications will be overwritten.\n\n";
1676 # Add all user defined addresses to the whitelist.
1678 # Check if the hash contains any elements.
1679 if (keys (%ignored)) {
1680 # Loop through the entire hash and write the host/network
1681 # and remark to the ignore file.
1682 while ( (my $key) = each %ignored) {
1683 my $address = $ignored{$key}[0];
1684 my $remark = $ignored{$key}[1];
1685 my $status = $ignored{$key}[2];
1687 # Check if the status of the entry is "enabled".
1688 if ($status eq "enabled") {
1689 # Check if the address/network is valid.
1690 if ((&General
::validip
($address)) || (&General
::validipandmask
($address))) {
1691 # Write rule line to the file to pass any traffic from this IP
1692 print FILE
"pass ip $address any -> any any (msg:\"pass all traffic from/to $address\"\; bypass; sid:$sid\;)\n";
1705 ## Function to set correct ownership for single files and directories.
1708 sub set_ownership
($) {
1711 # User and group of the WUI.
1712 my $uname = "nobody";
1713 my $grname = "nobody";
1715 # The chown function implemented in perl requies the user and group as nummeric id's.
1716 my $uid = getpwnam($uname);
1717 my $gid = getgrnam($grname);
1719 # Check if the given target exists.
1721 # Stop the script and print error message.
1722 die "The $target does not exist. Cannot change the ownership!\n";
1725 # Check weather the target is a file or directory.
1727 # Change ownership ot the single file.
1728 chown($uid, $gid, "$target");
1729 } elsif (-d
$target) {
1730 # Do a directory listing.
1731 opendir(DIR
, $target) or die $!;
1732 # Loop through the direcory.
1733 while (my $file = readdir(DIR
)) {
1735 # We only want files.
1736 next unless (-f
"$target/$file");
1738 # Set correct ownership for the files.
1739 chown($uid, $gid, "$target/$file");
1744 # Change ownership of the directory.
1745 chown($uid, $gid, "$target");
1750 ## Function to read-in the aliases file and returns all configured and enabled aliases.
1753 # Location of the aliases file.
1754 my $aliases_file = "${General::swroot}/ethernet/aliases";
1756 # Array to store the aliases.
1759 # Check if the file is empty.
1760 if (-z
$aliases_file) {
1761 # Abort nothing to do.
1765 # Open the aliases file.
1766 open(ALIASES
, $aliases_file) or die "Could not open $aliases_file. $!\n";
1768 # Loop through the file content.
1769 while (my $line = <ALIASES
>) {
1773 # Splitt line content into single chunks.
1774 my ($address, $state, $remark) = split(/\,/, $line);
1776 # Check if the state of the current processed alias is "on".
1777 if ($state eq "on") {
1778 # Check if the address is valid.
1779 if(&Network
::check_ip_address
($address)) {
1780 # Add the alias to the array of aliases.
1781 push(@aliases, $address);
1786 # Close file handle.
1794 ## Function to grab the current assigned IP-address on red.
1796 sub get_red_address
() {
1797 # File, which contains the current IP-address of the red interface.
1798 my $file = "${General::swroot}/red/local-ipaddress";
1800 # Check if the file exists.
1802 # Open the given file.
1803 open(FILE
, "$file") or die "Could not open $file.";
1805 # Obtain the address from the first line of the file.
1806 my $address = <FILE
>;
1814 # Check if the grabbed address is valid.
1815 if (&General
::validip
($address)) {
1816 # Return the address.
1826 ## Function to get the used rules files of a given provider.
1828 sub read_used_provider_rulesfiles
($) {
1829 my ($provider) = @_;
1831 # Array to store the used rulefiles.
1832 my @used_rulesfiles = ();
1834 # Get the used rulesefile file for the provider.
1835 my $rulesfile_file = &get_used_provider_rulesfile_file
($provider);
1837 # Check if the a used rulesfile exists for this provider.
1838 if (-f
$rulesfile_file) {
1839 # Open the file or used rulefiles and read-in content.
1840 open(FILE
, $rulesfile_file) or die "Could not open $rulesfile_file. $!\n";
1843 # Assign the current line to a nice variable.
1850 next if ($line =~ /\#/);
1853 next if ($line =~ /^\s*$/);
1855 # Gather the rulefile.
1856 if ($line =~ /.*- (.*)/) {
1859 # Add the rulefile to the array of used rulesfiles.
1860 push(@used_rulesfiles, $rulefile);
1868 # Return the array of used rulesfiles.
1869 return @used_rulesfiles;
1873 ## Function to write the lock file for locking the WUI, while
1874 ## the autoupdate script runs.
1876 sub lock_ids_page
() {
1877 # Call subfunction to create the file.
1878 &create_empty_file
($ids_page_lock_file);
1882 ## Function to release the lock of the WUI, again.
1884 sub unlock_ids_page
() {
1886 unlink($ids_page_lock_file);