require "${General::swroot}/network-functions.pl";
require "${General::swroot}/suricata/ruleset-sources";
+# Load perl module to deal with Archives.
+use Archive::Tar;
+
+# Load perl module to deal with files and path.
+use File::Basename;
+
+# Load module to move files.
+use File::Copy;
+
+# Load module to recursely remove files and a folder.
+use File::Path qw(rmtree);
+
+# Load module to get file stats.
+use File::stat;
+
+# Load module to deal with temporary files.
+use File::Temp;
+
+# Load module to deal with the date formats used by the HTTP protocol.
+use HTTP::Date;
+
+# Load the libwwwperl User Agent module.
+use LWP::UserAgent;
+
+# Load function from posix module to format time strings.
+use POSIX qw (strftime);
+
+# Load module to talk to the kernel log daemon.
+use Sys::Syslog qw(:DEFAULT setlogsock);
+
# Location where all config and settings files are stored.
our $settingsdir = "${General::swroot}/suricata";
-# File where the used rulefiles are stored.
-our $used_rulefiles_file = "$settingsdir/suricata-used-rulefiles.yaml";
+# File where the main file for providers ruleset inclusion exists.
+our $suricata_used_providers_file = "$settingsdir/suricata-used-providers.yaml";
+
+# File for static ruleset inclusions.
+our $suricata_default_rulefiles_file = "$settingsdir/suricata-default-rules.yaml";
# File where the addresses of the homenet are stored.
our $homenet_file = "$settingsdir/suricata-homenet.yaml";
# File where the HTTP ports definition is stored.
our $http_ports_file = "$settingsdir/suricata-http-ports.yaml";
-# File which contains the enabled sids.
-our $enabled_sids_file = "$settingsdir/oinkmaster-enabled-sids.conf";
-
-# File which contains the disabled sids.
-our $disabled_sids_file = "$settingsdir/oinkmaster-disabled-sids.conf";
+# File which contains includes for provider specific rule modifications.
+our $oinkmaster_provider_includes_file = "$settingsdir/oinkmaster-provider-includes.conf";
# File which contains wheater the rules should be changed.
our $modify_sids_file = "$settingsdir/oinkmaster-modify-sids.conf";
# File which stores the configured IPS settings.
our $ids_settings_file = "$settingsdir/settings";
-# DEPRECATED - File which stores the configured rules-settings.
-our $rules_settings_file = "$settingsdir/rules-settings";
-
# File which stores the used and configured ruleset providers.
our $providers_settings_file = "$settingsdir/providers-settings";
# File which stores the configured settings for whitelisted addresses.
our $ignored_file = "$settingsdir/ignored";
-# DEPRECATED - Location and name of the tarball which contains the ruleset.
-our $rulestarball = "/var/tmp/idsrules.tar.gz";
-
# Location where the downloaded rulesets are stored.
our $dl_rules_path = "/var/tmp";
# Location where the rulefiles are stored.
our $rulespath = "/var/lib/suricata";
+# Location where the default rulefils are stored.
+our $default_rulespath = "/usr/share/suricata/rules";
+
+# Location where the addition config files are stored.
+our $configspath = "/usr/share/suricata";
+
# Location of the classification file.
-our $classification_file = "$rulespath/classification.config";
+our $classification_file = "$configspath/classification.config";
# Location of the sid to msg mappings file.
our $sid_msg_file = "$rulespath/sid-msg.map";
# http_ports_file.
my @http_ports = ('80', '81');
+# Array which contains a list of rulefiles which always will be included if they exist.
+my @static_included_rulefiles = ('local.rules', 'whitelist.rules');
+
+# Array which contains a list of allways enabled application layer protocols.
+my @static_enabled_app_layer_protos = ('app-layer', 'decoder', 'files', 'stream');
+
# Hash which allows to convert the download type (dl_type) to a file suffix.
my %dl_type_to_suffix = (
"archive" => ".tar.gz",
"plain" => ".rules",
);
+# Hash to translate an application layer protocol to the application name.
+my %tr_app_layer_proto = (
+ "ikev2" => "ipsec",
+ "krb5" => "kerberos",
+);
+
#
## Function to check and create all IDS related files, if the does not exist.
#
sub check_and_create_filelayout() {
# Check if the files exist and if not, create them.
- unless (-f "$enabled_sids_file") { &create_empty_file($enabled_sids_file); }
- unless (-f "$disabled_sids_file") { &create_empty_file($disabled_sids_file); }
+ unless (-f "$oinkmaster_provider_includes_file") { &create_empty_file($oinkmaster_provider_includes_file); }
unless (-f "$modify_sids_file") { &create_empty_file($modify_sids_file); }
- unless (-f "$used_rulefiles_file") { &create_empty_file($used_rulefiles_file); }
+ unless (-f "$suricata_used_providers_file") { &create_empty_file($suricata_used_providers_file); }
+ unless (-f "$suricata_default_rulefiles_file") { &create_empty_file($suricata_default_rulefiles_file); }
unless (-f "$ids_settings_file") { &create_empty_file($ids_settings_file); }
unless (-f "$providers_settings_file") { &create_empty_file($providers_settings_file); }
- unless (-f "$ignored_file") { &create_empty_file($ignored_file); }
unless (-f "$whitelist_file" ) { &create_empty_file($whitelist_file); }
}
}
#
-## This function is responsible for downloading the configured IDS rulesets or if no one is specified
-## all configured rulesets will be downloaded.
+## This function is responsible for downloading the ruleset for a given provider.
##
-## * At first it gathers all configured ruleset providers, initialize the downloader and sets an
-## upstream proxy if configured.
-## * After that, the given ruleset or in case all rulesets should be downloaded, it will determine wether it
-## is enabled or not.
+## * At first it initialize the downloader and sets an upstream proxy if configured.
## * The next step will be to generate the final download url, by obtaining the URL for the desired
-## ruleset, add the settings for the upstream proxy.
-## * Finally the function will grab all the rules files or tarballs from the servers.
+## ruleset and add the settings for the upstream proxy.
+## * Finally the function will grab the rule file or tarball from the server.
+## It tries to reduce the amount of download by using the "If-Modified-Since" HTTP header.
+#
+## Return codes:
+##
+## * "no url" - If no download URL could be gathered for the provider.
+## * "not modified" - In case the already stored rules file is up to date.
+## * "incomplete download" - When the remote file size differs from the downloaded file size.
+## * "$error" - The error message generated from the LWP::User Agent module.
#
sub downloadruleset ($) {
my ($provider) = @_;
- # If no provider is given default to "all".
- $provider //= 'all';
-
- # Hash to store the providers and access id's, for which rules should be downloaded.
- my %sheduled_providers = ();
-
- # Get used provider settings.
- my %used_providers = ();
- &General::readhasharray("$providers_settings_file", \%used_providers);
-
- # Check if a ruleset has been configured.
- unless(%used_providers) {
- # Log that no ruleset has been configured and abort.
- &_log_to_syslog("No ruleset provider has been configured.");
-
- # Return "1".
- return 1;
- }
+ # The amount of download attempts before giving up and
+ # logging an error.
+ my $max_dl_attempts = 3;
# Read proxysettings.
my %proxysettings=();
&General::readhash("${General::swroot}/proxy/settings", \%proxysettings);
- # Load required perl module to handle the download.
- use LWP::UserAgent;
-
# Init the download module.
- my $downloader = LWP::UserAgent->new;
+ #
+ # Request SSL hostname verification and specify path
+ # to the CA file.
+ my $downloader = LWP::UserAgent->new(
+ ssl_opts => {
+ SSL_ca_file => '/etc/ssl/cert.pem',
+ verify_hostname => 1,
+ }
+ );
# Set timeout to 10 seconds.
$downloader->timeout(10);
$downloader->proxy(['http', 'https'], $proxy_url);
}
- # Loop through the hash of configured providers.
- foreach my $id ( keys %used_providers ) {
- # Skip providers which are not enabled.
- next if ($used_providers{$id}[3] ne "enabled");
-
- # Obtain the provider handle.
- my $provider_handle = $used_providers{$id}[0];
-
- # Handle update off all providers.
- if (($provider eq "all") || ($provider_handle eq "$provider")) {
- # Add provider handle and it's id to the hash of sheduled providers.
- $sheduled_providers{$provider_handle} = $id;
- }
- }
-
- # Loop through the hash of sheduled providers.
- foreach my $provider ( keys %sheduled_providers) {
- # Grab the download url for the provider.
- my $url = $IDS::Ruleset::Providers{$provider}{'dl_url'};
-
- # Check if the provider requires a subscription.
- if ($IDS::Ruleset::Providers{$provider}{'requires_subscription'} eq "True") {
- # Grab the previously stored access id for the provider from hash.
- my $id = $sheduled_providers{$provider};
+ # Log download/update of the ruleset.
+ &_log_to_syslog("Downloading ruleset for provider: $provider.");
- # Grab the subscription code.
- my $subscription_code = $used_providers{$id}[1];
+ # Grab the download url for the provider.
+ my $url = $IDS::Ruleset::Providers{$provider}{'dl_url'};
- # Add the subscription code to the download url.
- $url =~ s/\<subscription_code\>/$subscription_code/g;
+ # Check if the provider requires a subscription.
+ if ($IDS::Ruleset::Providers{$provider}{'requires_subscription'} eq "True") {
+ # Grab the subscription code.
+ my $subscription_code = &get_subscription_code($provider);
- }
+ # Add the subscription code to the download url.
+ $url =~ s/\<subscription_code\>/$subscription_code/g;
- # Abort if no url could be determined for the provider.
- unless ($url) {
- # Log error and abort.
- &_log_to_syslog("Unable to gather a download URL for the selected ruleset provider.");
- return 1;
- }
+ }
- # Variable to store the filesize of the remote object.
- my $remote_filesize;
+ # Abort if no url could be determined for the provider.
+ unless ($url) {
+ # Log error and abort.
+ &_log_to_syslog("Unable to gather a download URL for the selected ruleset provider.");
+ return "no url";
+ }
- # The sourcfire (snort rules) does not allow to send "HEAD" requests, so skip this check
- # for this webserver.
- #
- # Check if the ruleset source contains "snort.org".
- unless ($url =~ /\.snort\.org/) {
- # Pass the requrested url to the downloader.
- my $request = HTTP::Request->new(HEAD => $url);
+ # Pass the requested URL to the downloader.
+ my $request = HTTP::Request->new(GET => $url);
- # Accept the html header.
- $request->header('Accept' => 'text/html');
+ # Generate temporary file name, located in "/var/tmp" and with a suffix of ".tmp".
+ # The downloaded file will be stored there until some sanity checks are performed.
+ my $tmp = File::Temp->new( SUFFIX => ".tmp", DIR => "/var/tmp/", UNLINK => 0 );
+ my $tmpfile = $tmp->filename();
- # Perform the request and fetch the html header.
- my $response = $downloader->request($request);
+ # Call function to get the final path and filename for the downloaded file.
+ my $dl_rulesfile = &_get_dl_rulesfile($provider);
- # Check if there was any error.
- unless ($response->is_success) {
- # Obtain error.
- my $error = $response->status_line();
+ # Check if the rulesfile already exits, because it has been downloaded in the past.
+ #
+ # In this case we are requesting the server if the remote file has been changed or not.
+ # This will be done by sending the modification time in a special HTTP header.
+ if (-f $dl_rulesfile) {
+ # Call stat on the file.
+ my $stat = stat($dl_rulesfile);
- # Log error message.
- &_log_to_syslog("Unable to download the ruleset. \($error\)");
+ # Omit the mtime of the existing file.
+ my $mtime = $stat->mtime;
- # Return "1" - false.
- return 1;
- }
+ # Convert the timestamp into right format.
+ my $http_date = time2str($mtime);
- # Assign the fetched header object.
- my $header = $response->headers();
+ # Add the If-Modified-Since header to the request to ask the server if the
+ # file has been modified.
+ $request->header( 'If-Modified-Since' => "$http_date" );
+ }
- # Grab the remote file size from the object and store it in the
- # variable.
- $remote_filesize = $header->content_length;
- }
+ my $dl_attempt = 1;
+ my $response;
- # Load perl module to deal with temporary files.
- use File::Temp;
+ # Download and retry on failure.
+ while ($dl_attempt <= $max_dl_attempts) {
+ # Perform the request and save the output into the tmpfile.
+ $response = $downloader->request($request, $tmpfile);
- # Generate temporary file name, located in "/var/tmp" and with a suffix of ".tmp".
- my $tmp = File::Temp->new( SUFFIX => ".tmp", DIR => "/var/tmp/", UNLINK => 0 );
- my $tmpfile = $tmp->filename();
+ # Check if the download was successfull.
+ if($response->is_success) {
+ # Break loop.
+ last;
- # Pass the requested url to the downloader.
- my $request = HTTP::Request->new(GET => $url);
+ # Check if the server responds with 304 (Not Modified).
+ } elsif ($response->code == 304) {
+ # Log to syslog.
+ &_log_to_syslog("Ruleset is up-to-date, no update required.");
- # Perform the request and save the output into the tmpfile.
- my $response = $downloader->request($request, $tmpfile);
+ # Return "not modified".
+ return "not modified";
- # Check if there was any error.
- unless ($response->is_success) {
+ # Check if we ran out of download re-tries.
+ } elsif ($dl_attempt eq $max_dl_attempts) {
# Obtain error.
my $error = $response->content;
# Log error message.
&_log_to_syslog("Unable to download the ruleset. \($error\)");
- # Return "1" - false.
- return 1;
+ # Return the error message from response..
+ return "$error";
}
- # Load perl stat module.
- use File::stat;
+ # Remove temporary file, if one exists.
+ unlink("$tmpfile") if (-e "$tmpfile");
- # Perform stat on the tmpfile.
- my $stat = stat($tmpfile);
-
- # Grab the local filesize of the downloaded tarball.
- my $local_filesize = $stat->size;
+ # Increase download attempt counter.
+ $dl_attempt++;
+ }
- # Check if both file sizes match.
- if (($remote_filesize) && ($remote_filesize ne $local_filesize)) {
- # Log error message.
- &_log_to_syslog("Unable to completely download the ruleset. ");
- &_log_to_syslog("Only got $local_filesize Bytes instead of $remote_filesize Bytes. ");
+ # Obtain the connection headers.
+ my $headers = $response->headers;
- # Delete temporary file.
- unlink("$tmpfile");
+ # Get the timestamp from header, when the file has been modified the
+ # last time.
+ my $last_modified = $headers->last_modified;
- # Return "1" - false.
- return 1;
- }
+ # Get the remote size of the downloaded file.
+ my $remote_filesize = $headers->content_length;
- # Genarate and assign file name and path to store the downloaded rules file.
- my $dl_rulesfile = &_get_dl_rulesfile($provider);
+ # Perform stat on the tmpfile.
+ my $stat = stat($tmpfile);
- # Check if a file name could be obtained.
- unless ($dl_rulesfile) {
- # Log error message.
- &_log_to_syslog("Unable to store the downloaded rules file. ");
+ # Grab the local filesize of the downloaded tarball.
+ my $local_filesize = $stat->size;
- # Delete downloaded temporary file.
- unlink("$tmpfile");
+ # Check if both file sizes match.
+ if (($remote_filesize) && ($remote_filesize ne $local_filesize)) {
+ # Log error message.
+ &_log_to_syslog("Unable to completely download the ruleset. ");
+ &_log_to_syslog("Only got $local_filesize Bytes instead of $remote_filesize Bytes. ");
- # Return "1" - false.
- }
+ # Delete temporary file.
+ unlink("$tmpfile");
- # Load file copy module, which contains the move() function.
- use File::Copy;
+ # Return "1" - false.
+ return "incomplete download";
+ }
- # Overwrite the may existing rulefile or tarball with the downloaded one.
- move("$tmpfile", "$dl_rulesfile");
+ # Check if a file name could be obtained.
+ unless ($dl_rulesfile) {
+ # Log error message.
+ &_log_to_syslog("Unable to store the downloaded rules file. ");
- # Delete temporary file.
+ # Delete downloaded temporary file.
unlink("$tmpfile");
- # Set correct ownership for the tarball.
- set_ownership("$dl_rulesfile");
+ # Return "1" - false.
+ return 1;
+ }
+
+ # Overwrite the may existing rulefile or tarball with the downloaded one.
+ move("$tmpfile", "$dl_rulesfile");
+
+ # Check if we got a last-modified value from the server.
+ if ($last_modified) {
+ # Assign the last-modified timestamp as mtime to the
+ # rules file.
+ utime(time(), "$last_modified", "$dl_rulesfile");
}
+ # Delete temporary file.
+ unlink("$tmpfile");
+
+ # Set correct ownership for the tarball.
+ set_ownership("$dl_rulesfile");
+
# If we got here, everything worked fine. Return nothing.
return;
}
#
## Function to extract a given ruleset.
+##
+## In case the ruleset provider offers a plain file, it simply will
+## be copied.
#
sub extractruleset ($) {
my ($provider) = @_;
- # Load perl module to deal with archives.
- use Archive::Tar;
-
- # Load perl module to deal with files and path.
- use File::Basename;
+ # Disable chown functionality when uncompressing files.
+ $Archive::Tar::CHOWN = "0";
# Get full path and downloaded rulesfile for the given provider.
my $tarball = &_get_dl_rulesfile($provider);
# Check if the file exists.
unless (-f $tarball) {
- &_log_to_syslog("Could not extract ruleset file: $tarball");
+ &_log_to_syslog("Could not find ruleset file: $tarball");
# Return nothing.
return;
mkdir("$tmp_rules_directory") unless (-d "$tmp_rules_directory");
mkdir("$tmp_conf_directory") unless (-d "$tmp_conf_directory");
- # Initialize the tar module.
- my $tar = Archive::Tar->new($tarball);
+ # Omit the type (dl_type) of the stored ruleset.
+ my $type = $IDS::Ruleset::Providers{$provider}{'dl_type'};
+
+ # Handle the different ruleset types.
+ if ($type eq "plain") {
+ # Generate destination filename an full path.
+ my $destination = "$tmp_rules_directory/$provider\-ruleset.rules";
+
+ # Copy the file into the temporary rules directory.
+ copy($tarball, $destination);
+
+ } elsif ( $type eq "archive") {
+ # Initialize the tar module.
+ my $tar = Archive::Tar->new($tarball);
+
+ # Get the filelist inside the tarball.
+ my @packed_files = $tar->list_files;
+
+ # Loop through the filelist.
+ foreach my $packed_file (@packed_files) {
+ my $destination;
+
+ # Splitt the packed file into chunks.
+ my $file = fileparse($packed_file);
+
+ # Handle msg-id.map file.
+ if ("$file" eq "sid-msg.map") {
+ # Set extract destination to temporary config_dir.
+ $destination = "$tmp_conf_directory/$provider\-sid-msg.map";
- # Get the filelist inside the tarball.
- my @packed_files = $tar->list_files;
+ # Handle classification.conf
+ } elsif ("$file" eq "classification.config") {
+ # Set extract destination to temporary config_dir.
+ $destination = "$tmp_conf_directory/$provider\-classification.config";
- # Loop through the filelist.
- foreach my $packed_file (@packed_files) {
- my $destination;
+ # Handle rules files.
+ } elsif ($file =~ m/\.rules$/) {
+ # Skip rule files which are not located in the rules directory or archive root.
+ next unless(($packed_file =~ /^rules\//) || ($packed_file !~ /\//));
- # Splitt the packed file into chunks.
- my $file = fileparse($packed_file);
+ # Skip deleted.rules.
+ #
+ # Mostly they have been taken out for correctness or performance reasons and therfore
+ # it is not a great idea to enable any of them.
+ next if($file =~ m/deleted.rules$/);
- # Handle msg-id.map file.
- if ("$file" eq "sid-msg.map") {
- # Set extract destination to temporary config_dir.
- $destination = "$tmp_conf_directory/$provider\-sid-msg.map";
- # Handle classification.conf
- } elsif ("$file" eq "classification.config") {
- # Set extract destination to temporary config_dir.
- $destination = "$tmp_conf_directory/$provider\-classification.config";
- # Handle rules files.
- } elsif ($file =~ m/\.rules$/) {
- my $rulesfilename;
+ my $rulesfilename;
- # Splitt the filename into chunks.
- my @filename = split("-", $file);
+ # Splitt the filename into chunks.
+ my @filename = split("-", $file);
- # Reverse the array.
- @filename = reverse(@filename);
+ # Reverse the array.
+ @filename = reverse(@filename);
- # Get the amount of elements in the array.
- my $elements = @filename;
+ # Get the amount of elements in the array.
+ my $elements = @filename;
- # Remove last element of the hash.
- # It contains the vendor name, which will be replaced.
- if ($elements >= 3) {
+ # Remove last element of the hash.
+ # It contains the vendor name, which will be replaced.
+ if ($elements >= 3) {
# Remove last element from hash.
- pop(@filename);
- }
+ pop(@filename);
+ }
+
+ # Check if the last element of the filename does not
+ # contain the providers name.
+ if ($filename[-1] ne "$provider") {
+ # Add provider name as last element.
+ push(@filename, $provider);
+ }
- # Check if the last element of the filename does not
- # contain the providers name.
- if ($filename[-1] ne "$provider") {
- # Add provider name as last element.
- push(@filename, $provider);
+ # Reverse the array back.
+ @filename = reverse(@filename);
+
+ # Generate the name for the rulesfile.
+ $rulesfilename = join("-", @filename);
+
+ # Set extract destination to temporaray rules_dir.
+ $destination = "$tmp_rules_directory/$rulesfilename";
+ } else {
+ # Skip all other files.
+ next;
}
- # Reverse the array back.
- @filename = reverse(@filename);
+ # Check if the destination file exists.
+ unless(-e "$destination") {
+ # Extract the file to the temporary directory.
+ $tar->extract_file("$packed_file", "$destination");
+ } else {
+ # Generate temporary file name, located in the temporary rules directory and a suffix of ".tmp".
+ my $tmp = File::Temp->new( SUFFIX => ".tmp", DIR => "$tmp_rules_directory", UNLINK => 0 );
+ my $tmpfile = $tmp->filename();
+
+ # Extract the file to the new temporary file name.
+ $tar->extract_file("$packed_file", "$tmpfile");
+
+ # Open the the existing file.
+ open(DESTFILE, ">>", "$destination") or die "Could not open $destination. $!\n";
+ open(TMPFILE, "<", "$tmpfile") or die "Could not open $tmpfile. $!\n";
+
+ # Loop through the content of the temporary file.
+ while (<TMPFILE>) {
+ # Append the content line by line to the destination file.
+ print DESTFILE "$_";
+ }
- # Generate the name for the rulesfile.
- $rulesfilename = join("-", @filename);
+ # Close the file handles.
+ close(TMPFILE);
+ close(DESTFILE);
- # Set extract destination to temporaray rules_dir.
- $destination = "$tmp_rules_directory/$rulesfilename";
- } else {
- # Skip all other files.
- next;
+ # Remove the temporary file.
+ unlink("$tmpfile");
+ }
}
-
- # Extract the file to the temporary directory.
- $tar->extract_file("$packed_file", "$destination");
}
}
## call the functions to merge the additional config files. (classification, sid-msg, etc.).
#
sub oinkmaster () {
- # Load perl module for file copying.
- use File::Copy;
-
# Check if the files in rulesdir have the correct permissions.
&_check_rulesdir_permissions();
# Loop through the array of enabled providers.
foreach my $provider (@enabled_providers) {
- # Omit the type (dl_type) of the stored ruleset.
- my $type = $IDS::Ruleset::Providers{$provider}{'dl_type'};
-
- # Handle the different ruleset types.
- if ($type eq "archive") {
- # Call the extractruleset function.
- &extractruleset($provider);
- } elsif ($type eq "plain") {
- # Generate filename and full path for the stored rulesfile.
- my $dl_rulesfile = &_get_dl_rulesfile($provider);
-
- # Generate destination filename an full path.
- my $destination = "$tmp_rules_directory/$provider\-ruleset.rules";
-
- # Copy the file into the temporary rules directory.
- copy($dl_rulesfile, $destination);
- } else {
- # Skip unknown type.
- next;
- }
+ # Call the extractruleset function.
+ &extractruleset($provider);
}
- # Load perl module to talk to the kernel syslog.
- use Sys::Syslog qw(:DEFAULT setlogsock);
-
# Establish the connection to the syslog service.
openlog('oinkmaster', 'cons,pid', 'user');
## the rules directory.
#
sub move_tmp_ruleset() {
- # Load perl module.
- use File::Copy;
-
# Do a directory listing of the temporary directory.
opendir DH, $tmp_rules_directory;
## Function to cleanup the temporary IDS directroy.
#
sub cleanup_tmp_directory () {
- # Load rmtree() function from file path perl module.
- use File::Path 'rmtree';
# Delete temporary directory and all containing files.
rmtree([ "$tmp_directory" ]);
sub _log_to_syslog ($) {
my ($message) = @_;
- # Load perl module to talk to the kernel syslog.
- use Sys::Syslog qw(:DEFAULT setlogsock);
-
# The syslog function works best with an array based input,
# so generate one before passing the message details to syslog.
my @syslog = ("ERR", "<ERROR> $message");
}
}
+#
+## Tiny function to get/generate the full path and filename for the providers oinkmaster
+## modified sids file.
+#
+sub get_oinkmaster_provider_modified_sids_file ($) {
+ my ($provider) = @_;
+
+ # Generate the filename.
+ my $filename = "$settingsdir/oinkmaster-$provider-modified-sids.conf";
+
+ # Return the filename.
+ return $filename;
+}
+
+#
+## Function to directly altering the oinkmaster provider includes file.
+##
+## Requires tha acition "remove" or "add" and a provider handle.
+#
+sub alter_oinkmaster_provider_includes_file ($$) {
+ my ($action, $provider) = @_;
+
+ # Call function to get the path and name for the given providers
+ # oinkmaster modified sids file.
+ my $provider_modified_sids_file = &get_oinkmaster_provider_modified_sids_file($provider);
+
+ # Open the file for reading..
+ open (FILE, $oinkmaster_provider_includes_file) or die "Could not read $oinkmaster_provider_includes_file. $!\n";
+
+ # Read-in file content.
+ my @lines = <FILE>;
+
+ # Close file after reading.
+ close(FILE);
+
+ # Re-open the file for writing.
+ open(FILE, ">", $oinkmaster_provider_includes_file) or die "Could not write to $oinkmaster_provider_includes_file. $!\n";
+
+ # Loop through the file content.
+ foreach my $line (@lines) {
+ # Remove newlines.
+ chomp($line);
+
+ # Skip line if we found our given provider and the action should be remove.
+ next if (($line =~ /$provider/) && ($action eq "remove"));
+
+ # Write the read-in line back to the file.
+ print FILE "$line\n";
+ }
+
+ # Check if the file exists and add the provider if requested.
+ if ((-f $provider_modified_sids_file) && ($action eq "add")) {
+ print FILE "include $provider_modified_sids_file\n";
+ }
+
+ # Close file handle.
+ close(FILE);
+}
+
+#
+## Function to read-in the given enabled or disables sids file.
+#
+sub read_enabled_disabled_sids_file($) {
+ my ($file) = @_;
+
+ # Temporary hash to store the sids and their state. It will be
+ # returned at the end of this function.
+ my %temphash;
+
+ # Open the given filename.
+ open(FILE, "$file") or die "Could not open $file. $!\n";
+
+ # Loop through the file.
+ while(<FILE>) {
+ # Remove newlines.
+ chomp $_;
+
+ # Skip blank lines.
+ next if ($_ =~ /^\s*$/);
+
+ # Skip coments.
+ next if ($_ =~ /^\#/);
+
+ # Splitt line into sid and state part.
+ my ($state, $sid) = split(" ", $_);
+
+ # Skip line if the sid is not numeric.
+ next unless ($sid =~ /\d+/ );
+
+ # Check if the sid was enabled.
+ if ($state eq "enablesid") {
+ # Add the sid and its state as enabled to the temporary hash.
+ $temphash{$sid} = "enabled";
+ # Check if the sid was disabled.
+ } elsif ($state eq "disablesid") {
+ # Add the sid and its state as disabled to the temporary hash.
+ $temphash{$sid} = "disabled";
+ # Invalid state - skip the current sid and state.
+ } else {
+ next;
+ }
+ }
+
+ # Close filehandle.
+ close(FILE);
+
+ # Return the hash.
+ return %temphash;
+}
+
#
## Function to check if the IDS is running.
#
}
#
-## Function to generate and write the file for used rulefiles.
+## Function to generate and write the file for used rulefiles file for a given provider.
+##
+## The function requires as first argument a provider handle, and as second an array with files.
#
-sub write_used_rulefiles_file(@) {
- my @files = @_;
+sub write_used_provider_rulefiles_file($@) {
+ my ($provider, @files) = @_;
+
+ # Get the path and file for the provider specific used rulefiles file.
+ my $used_provider_rulesfile_file = &get_used_provider_rulesfile_file($provider);
# Open file for used rulefiles.
- open (FILE, ">$used_rulefiles_file") or die "Could not write to $used_rulefiles_file. $!\n";
+ open (FILE, ">", "$used_provider_rulesfile_file") or die "Could not write to $used_provider_rulesfile_file. $!\n";
# Write yaml header to the file.
print FILE "%YAML 1.1\n";
# Write header to file.
print FILE "#Autogenerated file. Any custom changes will be overwritten!\n";
- # Allways use the whitelist.
- print FILE " - whitelist.rules\n";
-
# Loop through the array of given files.
foreach my $file (@files) {
# Check if the given filename exists and write it to the file of used rulefiles.
close(FILE);
}
+#
+## Function to write the main file for provider rulesfiles inclusions.
+##
+## This function requires an array of provider handles.
+#
+sub write_main_used_rulefiles_file (@) {
+ my (@providers) = @_;
+
+ # Call function to write the static rulefiles file.
+ &_write_default_rulefiles_file();
+
+ # Open file for used rulefils inclusion.
+ open (FILE, ">", "$suricata_used_providers_file") or die "Could not write to $suricata_used_providers_file. $!\n";
+
+ # Write yaml header to the file.
+ print FILE "%YAML 1.1\n";
+ print FILE "---\n\n";
+
+ # Write header to file.
+ print FILE "#Autogenerated file. Any custom changes will be overwritten!\n";
+
+ # Loop through the list of given providers.
+ foreach my $provider (@providers) {
+ # Call function to get the providers used rulefiles file.
+ my $filename = &get_used_provider_rulesfile_file($provider);
+
+ # Check if the file exists and write it into the used rulefiles file.
+ if (-f $filename) {
+ # Print the provider to the file.
+ print FILE "include\: $filename\n";
+ }
+ }
+
+ # Close the filehandle after writing.
+ close(FILE);
+}
+
+sub _write_default_rulefiles_file () {
+ # Get enabled application layer protocols.
+ my @enabled_app_layer_protos = &get_suricata_enabled_app_layer_protos();
+
+ # Open file.
+ open (FILE, ">", $suricata_default_rulefiles_file) or die "Could not write to $suricata_default_rulefiles_file. $!\n";
+
+ # Write yaml header to the file.
+ print FILE "%YAML 1.1\n";
+ print FILE "---\n\n";
+
+ # Write notice about autogenerated file.
+ print FILE "#Autogenerated file. Any custom changes will be overwritten!\n";
+
+ # Loop through the array of static included rulesfiles.
+ foreach my $file (@static_included_rulefiles) {
+ # Check if the file exists.
+ if (-f "$rulespath/$file") {
+ # Write the rulesfile name to the file.
+ print FILE " - $rulespath/$file\n";
+ }
+ }
+
+ print FILE "\n#Default rules for used application layer protocols.\n";
+ foreach my $enabled_app_layer_proto (@enabled_app_layer_protos) {
+ # Check if the current processed app layer proto needs to be translated
+ # into an application name.
+ if (exists($tr_app_layer_proto{$enabled_app_layer_proto})) {
+ # Obtain the translated application name for this protocol.
+ $enabled_app_layer_proto = $tr_app_layer_proto{$enabled_app_layer_proto};
+ }
+
+ # Generate filename.
+ my $rulesfile = "$default_rulespath/$enabled_app_layer_proto\.rules";
+
+ # Check if such a file exists.
+ if (-f "$rulesfile") {
+ # Write the rulesfile name to the file.
+ print FILE " - $rulesfile\n";
+ }
+
+ # Generate filename with "events" in filename.
+ $rulesfile = "$default_rulespath/$enabled_app_layer_proto\-events.rules";
+
+ # Check if this file exists.
+ if (-f "$rulesfile" ) {
+ # Write the rulesfile name to the file.
+ print FILE " - $rulesfile\n";
+ }
+ }
+
+ # Close the file handle
+ close(FILE);
+}
+
+#
+## Tiny function to generate the full path and name for the used_provider_rulesfile file of a given provider.
+#
+sub get_used_provider_rulesfile_file ($) {
+ my ($provider) = @_;
+
+ my $filename = "$settingsdir/suricata\-$provider\-used\-rulefiles.yaml";
+
+ # Return the gernerated file.
+ return $filename;
+}
+
#
## Function to generate and write the file for modify the ruleset.
#
close(FILE);
}
+#
+## Function to get the subscription code of a configured provider.
+#
+sub get_subscription_code($) {
+ my ($provider) = @_;
+
+ my %configured_providers = ();
+
+ # Read-in providers settings file.
+ &General::readhasharray($providers_settings_file, \%configured_providers);
+
+ # Loop through the hash of configured providers.
+ foreach my $id (keys %configured_providers) {
+ # Assign nice human-readable values to the data fields.
+ my $provider_handle = $configured_providers{$id}[0];
+ my $subscription_code = $configured_providers{$id}[1];
+
+ # Check if the current processed provider is the requested one.
+ if ($provider_handle eq $provider) {
+ # Return the obtained subscription code.
+ return $subscription_code;
+ }
+ }
+
+ # No subscription code found - return nothing.
+ return;
+}
+
+#
+## Function to get the ruleset date for a given provider.
+##
+## The function simply return the creation date in a human read-able format
+## of the stored providers rulesfile.
+#
+sub get_ruleset_date($) {
+ my ($provider) = @_;
+ my $date;
+ my $mtime;
+
+ # Get the stored rulesfile for this provider.
+ my $stored_rulesfile = &_get_dl_rulesfile($provider);
+
+ # Check if we got a file.
+ if (-f $stored_rulesfile) {
+ # Call stat on the rulestarball.
+ my $stat = stat("$stored_rulesfile");
+
+ # Get timestamp the file creation.
+ $mtime = $stat->mtime;
+ }
+
+ # Check if the timestamp has not been grabbed.
+ unless ($mtime) {
+ # Return N/A for Not available.
+ return "N/A";
+ }
+
+ # Convert into human read-able format.
+ $date = strftime('%Y-%m-%d %H:%M:%S', localtime($mtime));
+
+ # Return the date.
+ return $date;
+}
+
#
## Function to gather the version of suricata.
#
}
}
+#
+## Function to get the enabled application layer protocols.
+#
+sub get_suricata_enabled_app_layer_protos() {
+ # Array to store and return the enabled app layer protos.
+ my @enabled_app_layer_protos = ();
+
+ # Execute piped suricata command and return the list of
+ # enabled application layer protocols.
+ open(SURICATA, "suricata --list-app-layer-protos |") or die "Could not execute program: $!";
+
+ # Grab and store the list of enabled application layer protocols.
+ my @output = <SURICATA>;
+
+ # Close pipe.
+ close(SURICATA);
+
+ # Merge allways enabled static application layers protocols array.
+ @enabled_app_layer_protos = @static_enabled_app_layer_protos;
+
+ # Loop through the array which contains the output of suricata.
+ foreach my $line (@output) {
+ # Skip header line which starts with "===".
+ next if ($line =~ /^\s*=/);
+
+ # Skip info or warning lines.
+ next if ($line =~ /\s*--/);
+
+ # Remove newlines.
+ chomp($line);
+
+ # Add enabled app layer proto to the array.
+ push(@enabled_app_layer_protos, $line);
+ }
+
+ # Sort the array.
+ @enabled_app_layer_protos = sort(@enabled_app_layer_protos);
+
+ # Return the array.
+ return @enabled_app_layer_protos;
+}
+
#
## Function to generate the rules file with whitelisted addresses.
#
# Check if the address/network is valid.
if ((&General::validip($address)) || (&General::validipandmask($address))) {
# Write rule line to the file to pass any traffic from this IP
- print FILE "pass ip $address any -> any any (msg:\"pass all traffic from/to $address\"\; sid:$sid\;)\n";
+ print FILE "pass ip $address any -> any any (msg:\"pass all traffic from/to $address\"\; bypass; sid:$sid\;)\n";
# Increment sid.
$sid++;
}
#
-## Function to get all used rulesfiles files.
+## Function to get the used rules files of a given provider.
#
-sub get_used_rulesfiles() {
+sub read_used_provider_rulesfiles($) {
+ my ($provider) = @_;
+
# Array to store the used rulefiles.
my @used_rulesfiles = ();
- # Check if the used rulesfile is empty.
- unless (-z $used_rulefiles_file) {
+ # Get the used rulesefile file for the provider.
+ my $rulesfile_file = &get_used_provider_rulesfile_file($provider);
+
+ # Check if the a used rulesfile exists for this provider.
+ if (-f $rulesfile_file) {
# Open the file or used rulefiles and read-in content.
- open(FILE, $used_rulefiles_file) or die "Could not open $used_rulefiles_file. $!\n";
+ open(FILE, $rulesfile_file) or die "Could not open $rulesfile_file. $!\n";
while (<FILE>) {
# Assign the current line to a nice variable.