]>
Commit | Line | Data |
---|---|---|
8dcebe53 SS |
1 | #!/usr/bin/perl -w |
2 | ############################################################################ | |
3 | # # | |
4 | # This file is part of the IPFire Firewall. # | |
5 | # # | |
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. # | |
10 | # # | |
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. # | |
15 | # # | |
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 # | |
19 | # # | |
fd2dccaa | 20 | # Copyright (C) 2018-2019 IPFire Team <info@ipfire.org> # |
8dcebe53 SS |
21 | # # |
22 | ############################################################################ | |
23 | ||
e55fa2f7 SS |
24 | use strict; |
25 | ||
8dcebe53 SS |
26 | package IDS; |
27 | ||
28 | require '/var/ipfire/general-functions.pl'; | |
abffcc99 | 29 | require "${General::swroot}/network-functions.pl"; |
35bc92a3 | 30 | require "${General::swroot}/suricata/ruleset-sources"; |
8dcebe53 | 31 | |
7d895608 | 32 | # Load perl module to deal with Archives. |
ee16b227 | 33 | use Archive::Peek::Libarchive; |
7d895608 SS |
34 | |
35 | # Load perl module to deal with files and path. | |
36 | use File::Basename; | |
37 | ||
38 | # Load module to move files. | |
39 | use File::Copy; | |
40 | ||
41 | # Load module to recursely remove files and a folder. | |
42 | use File::Path qw(rmtree); | |
43 | ||
44 | # Load module to get file stats. | |
45 | use File::stat; | |
46 | ||
47 | # Load module to deal with temporary files. | |
48 | use File::Temp; | |
49 | ||
061391e7 SS |
50 | # Load module to deal with the date formats used by the HTTP protocol. |
51 | use HTTP::Date; | |
52 | ||
7d895608 SS |
53 | # Load the libwwwperl User Agent module. |
54 | use LWP::UserAgent; | |
55 | ||
56 | # Load function from posix module to format time strings. | |
57 | use POSIX qw (strftime); | |
58 | ||
59 | # Load module to talk to the kernel log daemon. | |
60 | use Sys::Syslog qw(:DEFAULT setlogsock); | |
61 | ||
02844177 | 62 | # Location where all config and settings files are stored. |
164eab66 | 63 | our $settingsdir = "${General::swroot}/suricata"; |
02844177 | 64 | |
ddaf8ae1 | 65 | # File where the main file for providers ruleset inclusion exists. |
8d6714ed | 66 | our $suricata_used_rulesfiles_file = "$settingsdir/suricata-used-rulesfiles.yaml"; |
88eb5626 | 67 | |
b02e30fd SS |
68 | # File where the addresses of the homenet are stored. |
69 | our $homenet_file = "$settingsdir/suricata-homenet.yaml"; | |
70 | ||
30ee98e9 SS |
71 | # File where the addresses of the used DNS servers are stored. |
72 | our $dns_servers_file = "$settingsdir/suricata-dns-servers.yaml"; | |
73 | ||
e698090e SS |
74 | # File where the HTTP ports definition is stored. |
75 | our $http_ports_file = "$settingsdir/suricata-http-ports.yaml"; | |
76 | ||
b02e30fd SS |
77 | # File which stores the configured IPS settings. |
78 | our $ids_settings_file = "$settingsdir/settings"; | |
79 | ||
a8d36d3e SS |
80 | # File which stores the used and configured ruleset providers. |
81 | our $providers_settings_file = "$settingsdir/providers-settings"; | |
82 | ||
b02e30fd SS |
83 | # File which stores the configured settings for whitelisted addresses. |
84 | our $ignored_file = "$settingsdir/ignored"; | |
85 | ||
990d111d SS |
86 | # File which stores HTTP Etags for providers which supports them |
87 | # for cache management. | |
88 | our $etags_file = "$settingsdir/etags"; | |
89 | ||
788a71f5 | 90 | # Location where the downloaded rulesets are stored. |
b570d35c | 91 | our $dl_rules_path = "/var/cache/suricata"; |
788a71f5 | 92 | |
3983aebd | 93 | # File to store any errors, which also will be read and displayed by the wui. |
77910792 | 94 | our $storederrorfile = "/tmp/ids_storederror"; |
3983aebd | 95 | |
8076deba SS |
96 | # File to lock the WUI, while the autoupdate script runs. |
97 | our $ids_page_lock_file = "/tmp/ids_page_locked"; | |
98 | ||
298ef5ba | 99 | # Location where the rulefiles are stored. |
21cab141 | 100 | our $rulespath = "/var/lib/suricata"; |
298ef5ba | 101 | |
43d12991 SS |
102 | # Location where the default rulefils are stored. |
103 | our $default_rulespath = "/usr/share/suricata/rules"; | |
104 | ||
6983a96e SS |
105 | # Location where the addition config files are stored. |
106 | our $configspath = "/usr/share/suricata"; | |
107 | ||
23b56052 | 108 | # Location of the classification file. |
6983a96e | 109 | our $classification_file = "$configspath/classification.config"; |
23b56052 | 110 | |
8bd74e12 SS |
111 | # Location of the sid to msg mappings file. |
112 | our $sid_msg_file = "$rulespath/sid-msg.map"; | |
113 | ||
612bb2df SS |
114 | # Location to store local rules. This file will not be touched. |
115 | our $local_rules_file = "$rulespath/local.rules"; | |
116 | ||
b02e30fd SS |
117 | # File which contains the rules to whitelist addresses on suricata. |
118 | our $whitelist_file = "$rulespath/whitelist.rules"; | |
119 | ||
bce84f39 SS |
120 | # File which contains a list of all supported ruleset sources. |
121 | # (Sourcefire, Emergingthreads, etc..) | |
122 | our $rulesetsourcesfile = "$settingsdir/ruleset-sources"; | |
123 | ||
796eea21 SS |
124 | # The pidfile of the IDS. |
125 | our $idspidfile = "/var/run/suricata.pid"; | |
126 | ||
5240a809 SS |
127 | # Location of suricatactrl. |
128 | my $suricatactrl = "/usr/local/bin/suricatactrl"; | |
129 | ||
788a71f5 SS |
130 | # Prefix for each downloaded ruleset. |
131 | my $dl_rulesfile_prefix = "idsrules"; | |
132 | ||
4f513522 SS |
133 | # Temporary directory to download the rules files. |
134 | my $tmp_dl_directory = "/var/tmp"; | |
135 | ||
0fbfffea SS |
136 | # Temporary directory where the rulesets will be extracted. |
137 | my $tmp_directory = "/tmp/ids_tmp"; | |
138 | ||
6c9d3eee SS |
139 | # Temporary directory where the extracted rules files will be stored. |
140 | my $tmp_rules_directory = "$tmp_directory/rules"; | |
141 | ||
142 | # Temporary directory where the extracted additional config files will be stored. | |
143 | my $tmp_conf_directory = "$tmp_directory/conf"; | |
144 | ||
5240a809 | 145 | # Array with allowed commands of suricatactrl. |
a15c9b16 | 146 | my @suricatactrl_cmds = ( 'start', 'stop', 'restart', 'reload', 'fix-rules-dir' ); |
5240a809 | 147 | |
e698090e SS |
148 | # Array which contains the HTTP ports, which statically will be declared as HTTP_PORTS in the |
149 | # http_ports_file. | |
150 | my @http_ports = ('80', '81'); | |
151 | ||
88eb5626 | 152 | # Array which contains a list of rulefiles which always will be included if they exist. |
bb39fac4 SS |
153 | my @static_included_rulefiles = ('local.rules', 'whitelist.rules'); |
154 | ||
155 | # Array which contains a list of allways enabled application layer protocols. | |
156 | my @static_enabled_app_layer_protos = ('app-layer', 'decoder', 'files', 'stream'); | |
88eb5626 | 157 | |
788a71f5 SS |
158 | # Hash which allows to convert the download type (dl_type) to a file suffix. |
159 | my %dl_type_to_suffix = ( | |
160 | "archive" => ".tar.gz", | |
161 | "plain" => ".rules", | |
162 | ); | |
163 | ||
43d12991 SS |
164 | # Hash to translate an application layer protocol to the application name. |
165 | my %tr_app_layer_proto = ( | |
166 | "ikev2" => "ipsec", | |
167 | "krb5" => "kerberos", | |
168 | ); | |
169 | ||
b02e30fd SS |
170 | # |
171 | ## Function to check and create all IDS related files, if the does not exist. | |
172 | # | |
173 | sub check_and_create_filelayout() { | |
174 | # Check if the files exist and if not, create them. | |
8d6714ed | 175 | unless (-f "$suricata_used_rulesfiles_file") { &create_empty_file($suricata_used_rulesfiles_file); } |
b02e30fd | 176 | unless (-f "$ids_settings_file") { &create_empty_file($ids_settings_file); } |
a8d36d3e | 177 | unless (-f "$providers_settings_file") { &create_empty_file($providers_settings_file); } |
b02e30fd SS |
178 | unless (-f "$whitelist_file" ) { &create_empty_file($whitelist_file); } |
179 | } | |
180 | ||
70cc1315 SS |
181 | # |
182 | ## Function to get a list of all available ruleset providers. | |
183 | ## | |
184 | ## They will be returned as a sorted array. | |
185 | # | |
186 | sub get_ruleset_providers() { | |
187 | my @providers; | |
188 | ||
189 | # Loop through the hash of providers. | |
190 | foreach my $provider ( keys %IDS::Ruleset::Providers ) { | |
191 | # Add the provider to the array. | |
192 | push(@providers, $provider); | |
193 | } | |
194 | ||
195 | # Sort and return the array. | |
196 | return sort(@providers); | |
197 | } | |
198 | ||
5e20d6cb SS |
199 | # |
200 | ## Function to get a list of all enabled ruleset providers. | |
201 | ## | |
202 | ## They will be returned as an array. | |
203 | # | |
204 | sub get_enabled_providers () { | |
205 | my %used_providers = (); | |
206 | ||
207 | # Array to store the enabled providers. | |
208 | my @enabled_providers = (); | |
209 | ||
210 | # Read-in the providers config file. | |
211 | &General::readhasharray("$providers_settings_file", \%used_providers); | |
212 | ||
213 | # Loop through the hash of used_providers. | |
214 | foreach my $id (keys %used_providers) { | |
215 | # Skip disabled providers. | |
216 | next unless ($used_providers{$id}[3] eq "enabled"); | |
217 | ||
218 | # Grab the provider handle. | |
219 | my $provider = "$used_providers{$id}[0]"; | |
220 | ||
221 | # Add the provider to the array of enabled providers. | |
222 | push(@enabled_providers, $provider); | |
223 | } | |
224 | ||
225 | # Return the array. | |
226 | return @enabled_providers; | |
227 | } | |
228 | ||
e0eb5bc7 SS |
229 | # |
230 | ## Function to get a hash of provider handles and their configured modes (IDS/IPS). | |
231 | # | |
232 | sub get_providers_mode () { | |
233 | my %used_providers = (); | |
234 | ||
235 | # Hash to store the providers and their configured modes. | |
236 | my %providers_mode = (); | |
237 | ||
238 | # Read-in the providers config file. | |
239 | &General::readhasharray("$providers_settings_file", \%used_providers); | |
240 | ||
241 | # Loop through the hash of used_providers. | |
242 | foreach my $id (keys %used_providers) { | |
243 | # Skip disabled providers. | |
244 | next unless ($used_providers{$id}[3] eq "enabled"); | |
245 | ||
246 | # Grab the provider handle. | |
247 | my $provider = "$used_providers{$id}[0]"; | |
248 | ||
249 | # Grab the provider mode. | |
250 | my $mode = "$used_providers{$id}[4]"; | |
251 | ||
252 | # Fall back to IDS if no mode could be obtained. | |
253 | unless($mode) { | |
254 | $mode = "IDS"; | |
255 | } | |
256 | ||
257 | # Add details to provider_modes hash. | |
258 | $providers_mode{$provider} = $mode; | |
259 | } | |
260 | ||
261 | # Return the hash. | |
262 | return %providers_mode; | |
263 | } | |
264 | ||
8dcebe53 SS |
265 | # |
266 | ## Function for checking if at least 300MB of free disk space are available | |
267 | ## on the "/var" partition. | |
268 | # | |
269 | sub checkdiskspace () { | |
270 | # Call diskfree to gather the free disk space of /var. | |
81631920 | 271 | my @df = &General::system_output("/bin/df", "-B", "M", "/var"); |
8dcebe53 SS |
272 | |
273 | # Loop through the output. | |
274 | foreach my $line (@df) { | |
275 | # Ignore header line. | |
276 | next if $line =~ m/^Filesystem/; | |
277 | ||
278 | # Search for a line with the device information. | |
279 | if ($line =~ m/dev/ ) { | |
280 | # Split the line into single pieces. | |
281 | my @values = split(' ', $line); | |
282 | my ($filesystem, $blocks, $used, $available, $used_perenctage, $mounted_on) = @values; | |
283 | ||
284 | # Check if the available disk space is more than 300MB. | |
285 | if ($available < 300) { | |
65e3aef5 SS |
286 | # Exit function and return the available disk space. |
287 | return $available; | |
8dcebe53 SS |
288 | } |
289 | } | |
290 | } | |
291 | ||
292 | # Everything okay, return nothing. | |
293 | return; | |
294 | } | |
295 | ||
eea2670b | 296 | # |
0f2c5211 | 297 | ## This function is responsible for downloading the ruleset for a given provider. |
eea2670b | 298 | ## |
0f2c5211 | 299 | ## * At first it initialize the downloader and sets an upstream proxy if configured. |
b3c2c336 | 300 | ## * The next step will be to generate the final download url, by obtaining the URL for the desired |
0f2c5211 SS |
301 | ## ruleset and add the settings for the upstream proxy. |
302 | ## * Finally the function will grab the rule file or tarball from the server. | |
303 | ## It tries to reduce the amount of download by using the "If-Modified-Since" HTTP header. | |
eea2670b | 304 | # |
e26edcc1 SS |
305 | ## Return codes: |
306 | ## | |
307 | ## * "no url" - If no download URL could be gathered for the provider. | |
308 | ## * "not modified" - In case the already stored rules file is up to date. | |
309 | ## * "incomplete download" - When the remote file size differs from the downloaded file size. | |
310 | ## * "$error" - The error message generated from the LWP::User Agent module. | |
311 | # | |
b3c2c336 SS |
312 | sub downloadruleset ($) { |
313 | my ($provider) = @_; | |
314 | ||
e71804fb SS |
315 | # The amount of download attempts before giving up and |
316 | # logging an error. | |
317 | my $max_dl_attempts = 3; | |
318 | ||
eea2670b SS |
319 | # Read proxysettings. |
320 | my %proxysettings=(); | |
321 | &General::readhash("${General::swroot}/proxy/settings", \%proxysettings); | |
322 | ||
eea2670b | 323 | # Init the download module. |
954dbdad SS |
324 | # |
325 | # Request SSL hostname verification and specify path | |
326 | # to the CA file. | |
327 | my $downloader = LWP::UserAgent->new( | |
328 | ssl_opts => { | |
329 | SSL_ca_file => '/etc/ssl/cert.pem', | |
330 | verify_hostname => 1, | |
331 | } | |
332 | ); | |
eea2670b SS |
333 | |
334 | # Set timeout to 10 seconds. | |
335 | $downloader->timeout(10); | |
336 | ||
337 | # Check if an upstream proxy is configured. | |
338 | if ($proxysettings{'UPSTREAM_PROXY'}) { | |
eea2670b SS |
339 | my $proxy_url; |
340 | ||
40407aee | 341 | $proxy_url = "http://"; |
eea2670b | 342 | |
40407aee PM |
343 | # Check if the proxy requires authentication. |
344 | if (($proxysettings{'UPSTREAM_USER'}) && ($proxysettings{'UPSTREAM_PASSWORD'})) { | |
345 | $proxy_url .= "$proxysettings{'UPSTREAM_USER'}\:$proxysettings{'UPSTREAM_PASSWORD'}\@"; | |
eea2670b SS |
346 | } |
347 | ||
40407aee PM |
348 | # Add proxy server address and port. |
349 | $proxy_url .= $proxysettings{'UPSTREAM_PROXY'}; | |
350 | ||
eea2670b | 351 | # Setup proxy settings. |
6994f001 | 352 | $downloader->proxy(['http', 'https'], $proxy_url); |
eea2670b SS |
353 | } |
354 | ||
0f2c5211 SS |
355 | # Grab the download url for the provider. |
356 | my $url = $IDS::Ruleset::Providers{$provider}{'dl_url'}; | |
b3c2c336 | 357 | |
0f2c5211 SS |
358 | # Check if the provider requires a subscription. |
359 | if ($IDS::Ruleset::Providers{$provider}{'requires_subscription'} eq "True") { | |
360 | # Grab the subscription code. | |
361 | my $subscription_code = &get_subscription_code($provider); | |
b3c2c336 | 362 | |
0f2c5211 SS |
363 | # Add the subscription code to the download url. |
364 | $url =~ s/\<subscription_code\>/$subscription_code/g; | |
b3c2c336 | 365 | |
0f2c5211 | 366 | } |
f264adda | 367 | |
52a557a8 SS |
368 | # Abort and return "no url", if no url could be determined for the provider. |
369 | return "no url" unless ($url); | |
96da5803 | 370 | |
0f2c5211 SS |
371 | # Pass the requested URL to the downloader. |
372 | my $request = HTTP::Request->new(GET => $url); | |
061391e7 | 373 | |
4f513522 | 374 | # Generate temporary file name, located in the tempoary download directory and with a suffix of ".tmp". |
0f2c5211 | 375 | # The downloaded file will be stored there until some sanity checks are performed. |
4f513522 | 376 | my $tmp = File::Temp->new( SUFFIX => ".tmp", DIR => "$tmp_dl_directory/", UNLINK => 0 ); |
0f2c5211 | 377 | my $tmpfile = $tmp->filename(); |
061391e7 | 378 | |
0f2c5211 SS |
379 | # Call function to get the final path and filename for the downloaded file. |
380 | my $dl_rulesfile = &_get_dl_rulesfile($provider); | |
061391e7 | 381 | |
0f2c5211 SS |
382 | # Check if the rulesfile already exits, because it has been downloaded in the past. |
383 | # | |
384 | # In this case we are requesting the server if the remote file has been changed or not. | |
385 | # This will be done by sending the modification time in a special HTTP header. | |
386 | if (-f $dl_rulesfile) { | |
387 | # Call stat on the file. | |
388 | my $stat = stat($dl_rulesfile); | |
061391e7 | 389 | |
0f2c5211 SS |
390 | # Omit the mtime of the existing file. |
391 | my $mtime = $stat->mtime; | |
061391e7 | 392 | |
0f2c5211 SS |
393 | # Convert the timestamp into right format. |
394 | my $http_date = time2str($mtime); | |
96da5803 | 395 | |
0f2c5211 SS |
396 | # Add the If-Modified-Since header to the request to ask the server if the |
397 | # file has been modified. | |
398 | $request->header( 'If-Modified-Since' => "$http_date" ); | |
399 | } | |
96da5803 | 400 | |
990d111d SS |
401 | # Read-in Etags file for known Etags if the file is present. |
402 | my %etags = (); | |
403 | &General::readhash("$etags_file", \%etags) if (-f $etags_file); | |
404 | ||
405 | # Check if an Etag for the current provider is stored. | |
406 | if ($etags{$provider}) { | |
407 | # Grab the stored tag. | |
408 | my $etag = $etags{$provider}; | |
409 | ||
410 | # Add an "If-None-Match header to the request to ask the server if the | |
411 | # file has been modified. | |
412 | $request->header( 'If-None-Match' => $etag ); | |
413 | } | |
414 | ||
0f2c5211 SS |
415 | my $dl_attempt = 1; |
416 | my $response; | |
155b3b56 | 417 | |
0f2c5211 SS |
418 | # Download and retry on failure. |
419 | while ($dl_attempt <= $max_dl_attempts) { | |
420 | # Perform the request and save the output into the tmpfile. | |
421 | $response = $downloader->request($request, $tmpfile); | |
061391e7 | 422 | |
0f2c5211 SS |
423 | # Check if the download was successfull. |
424 | if($response->is_success) { | |
425 | # Break loop. | |
426 | last; | |
061391e7 | 427 | |
0f2c5211 SS |
428 | # Check if the server responds with 304 (Not Modified). |
429 | } elsif ($response->code == 304) { | |
38cf5814 SS |
430 | # Remove temporary file, if one exists. |
431 | unlink("$tmpfile") if (-e "$tmpfile"); | |
432 | ||
e26edcc1 SS |
433 | # Return "not modified". |
434 | return "not modified"; | |
e71804fb | 435 | |
0f2c5211 SS |
436 | # Check if we ran out of download re-tries. |
437 | } elsif ($dl_attempt eq $max_dl_attempts) { | |
438 | # Obtain error. | |
439 | my $error = $response->content; | |
e71804fb | 440 | |
38cf5814 SS |
441 | # Remove temporary file, if one exists. |
442 | unlink("$tmpfile") if (-e "$tmpfile"); | |
443 | ||
e26edcc1 SS |
444 | # Return the error message from response.. |
445 | return "$error"; | |
155b3b56 | 446 | } |
96da5803 | 447 | |
0f2c5211 SS |
448 | # Remove temporary file, if one exists. |
449 | unlink("$tmpfile") if (-e "$tmpfile"); | |
de1199e2 | 450 | |
0f2c5211 SS |
451 | # Increase download attempt counter. |
452 | $dl_attempt++; | |
453 | } | |
061391e7 | 454 | |
0f2c5211 SS |
455 | # Obtain the connection headers. |
456 | my $headers = $response->headers; | |
de1199e2 | 457 | |
0f2c5211 SS |
458 | # Get the timestamp from header, when the file has been modified the |
459 | # last time. | |
460 | my $last_modified = $headers->last_modified; | |
96da5803 | 461 | |
0f2c5211 SS |
462 | # Get the remote size of the downloaded file. |
463 | my $remote_filesize = $headers->content_length; | |
25b6545a | 464 | |
990d111d SS |
465 | # Grab the Etag from response it the server provides one. |
466 | if ($response->header('Etag')) { | |
467 | # Add the Etag to the etags hash. | |
468 | $etags{$provider} = $response->header('Etag'); | |
469 | ||
470 | # Write the etags file. | |
471 | &General::writehash($etags_file, \%etags); | |
472 | } | |
473 | ||
0f2c5211 SS |
474 | # Perform stat on the tmpfile. |
475 | my $stat = stat($tmpfile); | |
eea2670b | 476 | |
0f2c5211 SS |
477 | # Grab the local filesize of the downloaded tarball. |
478 | my $local_filesize = $stat->size; | |
88daf7eb | 479 | |
0f2c5211 SS |
480 | # Check if both file sizes match. |
481 | if (($remote_filesize) && ($remote_filesize ne $local_filesize)) { | |
0f2c5211 SS |
482 | # Delete temporary file. |
483 | unlink("$tmpfile"); | |
96da5803 | 484 | |
0f2c5211 | 485 | # Return "1" - false. |
e26edcc1 | 486 | return "incomplete download"; |
0f2c5211 | 487 | } |
96da5803 | 488 | |
0f2c5211 SS |
489 | # Overwrite the may existing rulefile or tarball with the downloaded one. |
490 | move("$tmpfile", "$dl_rulesfile"); | |
ae226132 | 491 | |
0f2c5211 SS |
492 | # Check if we got a last-modified value from the server. |
493 | if ($last_modified) { | |
494 | # Assign the last-modified timestamp as mtime to the | |
495 | # rules file. | |
496 | utime(time(), "$last_modified", "$dl_rulesfile"); | |
96da5803 SS |
497 | } |
498 | ||
0f2c5211 SS |
499 | # Delete temporary file. |
500 | unlink("$tmpfile"); | |
501 | ||
502 | # Set correct ownership for the tarball. | |
503 | set_ownership("$dl_rulesfile"); | |
504 | ||
eea2670b SS |
505 | # If we got here, everything worked fine. Return nothing. |
506 | return; | |
507 | } | |
8dcebe53 | 508 | |
0fbfffea SS |
509 | # |
510 | ## Function to extract a given ruleset. | |
1b5aec1b SS |
511 | ## |
512 | ## In case the ruleset provider offers a plain file, it simply will | |
513 | ## be copied. | |
0fbfffea SS |
514 | # |
515 | sub extractruleset ($) { | |
516 | my ($provider) = @_; | |
517 | ||
0fbfffea SS |
518 | # Get full path and downloaded rulesfile for the given provider. |
519 | my $tarball = &_get_dl_rulesfile($provider); | |
520 | ||
521 | # Check if the file exists. | |
522 | unless (-f $tarball) { | |
1b5aec1b | 523 | &_log_to_syslog("Could not find ruleset file: $tarball"); |
0fbfffea SS |
524 | |
525 | # Return nothing. | |
526 | return; | |
527 | } | |
528 | ||
0fbfffea SS |
529 | # Check if the temporary directories exist, otherwise create them. |
530 | mkdir("$tmp_directory") unless (-d "$tmp_directory"); | |
6c9d3eee SS |
531 | mkdir("$tmp_rules_directory") unless (-d "$tmp_rules_directory"); |
532 | mkdir("$tmp_conf_directory") unless (-d "$tmp_conf_directory"); | |
0fbfffea | 533 | |
1b5aec1b SS |
534 | # Omit the type (dl_type) of the stored ruleset. |
535 | my $type = $IDS::Ruleset::Providers{$provider}{'dl_type'}; | |
0fbfffea | 536 | |
1b5aec1b SS |
537 | # Handle the different ruleset types. |
538 | if ($type eq "plain") { | |
539 | # Generate destination filename an full path. | |
540 | my $destination = "$tmp_rules_directory/$provider\-ruleset.rules"; | |
0fbfffea | 541 | |
1b5aec1b SS |
542 | # Copy the file into the temporary rules directory. |
543 | copy($tarball, $destination); | |
0fbfffea | 544 | |
1b5aec1b SS |
545 | } elsif ( $type eq "archive") { |
546 | # Initialize the tar module. | |
ee16b227 | 547 | my $tar = Archive::Peek::Libarchive->new(filename => $tarball); |
0fbfffea | 548 | |
ee16b227 SS |
549 | # Loop through the archive |
550 | $tar->iterate( sub { | |
551 | my ($packed_file, $content) = @_; | |
1b5aec1b | 552 | my $destination; |
0fbfffea | 553 | |
1b5aec1b SS |
554 | # Splitt the packed file into chunks. |
555 | my $file = fileparse($packed_file); | |
0fbfffea | 556 | |
1b5aec1b SS |
557 | # Handle msg-id.map file. |
558 | if ("$file" eq "sid-msg.map") { | |
559 | # Set extract destination to temporary config_dir. | |
560 | $destination = "$tmp_conf_directory/$provider\-sid-msg.map"; | |
0fbfffea | 561 | |
1b5aec1b SS |
562 | # Handle classification.conf |
563 | } elsif ("$file" eq "classification.config") { | |
564 | # Set extract destination to temporary config_dir. | |
565 | $destination = "$tmp_conf_directory/$provider\-classification.config"; | |
0fbfffea | 566 | |
1b5aec1b SS |
567 | # Handle rules files. |
568 | } elsif ($file =~ m/\.rules$/) { | |
f349c960 | 569 | # Skip rule files which are not located in the rules directory or archive root. |
ee16b227 | 570 | return unless(($packed_file =~ /^rules\//) || ($packed_file =~ /^$provider-rules\//) || ($packed_file !~ /\//)); |
f349c960 | 571 | |
10beae64 SS |
572 | # Skip deleted.rules. |
573 | # | |
574 | # Mostly they have been taken out for correctness or performance reasons and therfore | |
575 | # it is not a great idea to enable any of them. | |
ee16b227 | 576 | return if($file =~ m/deleted.rules$/); |
10beae64 | 577 | |
1b5aec1b | 578 | my $rulesfilename; |
0fbfffea | 579 | |
1b5aec1b SS |
580 | # Splitt the filename into chunks. |
581 | my @filename = split("-", $file); | |
0fbfffea | 582 | |
1b5aec1b SS |
583 | # Reverse the array. |
584 | @filename = reverse(@filename); | |
0fbfffea | 585 | |
1b5aec1b SS |
586 | # Get the amount of elements in the array. |
587 | my $elements = @filename; | |
0fbfffea | 588 | |
1b5aec1b SS |
589 | # Remove last element of the hash. |
590 | # It contains the vendor name, which will be replaced. | |
591 | if ($elements >= 3) { | |
592 | # Remove last element from hash. | |
593 | pop(@filename); | |
594 | } | |
595 | ||
596 | # Check if the last element of the filename does not | |
597 | # contain the providers name. | |
598 | if ($filename[-1] ne "$provider") { | |
599 | # Add provider name as last element. | |
600 | push(@filename, $provider); | |
601 | } | |
602 | ||
603 | # Reverse the array back. | |
604 | @filename = reverse(@filename); | |
605 | ||
606 | # Generate the name for the rulesfile. | |
607 | $rulesfilename = join("-", @filename); | |
608 | ||
609 | # Set extract destination to temporaray rules_dir. | |
610 | $destination = "$tmp_rules_directory/$rulesfilename"; | |
611 | } else { | |
612 | # Skip all other files. | |
ee16b227 | 613 | return; |
1b5aec1b SS |
614 | } |
615 | ||
2b12a010 SS |
616 | # Check if the destination file exists. |
617 | unless(-e "$destination") { | |
ee16b227 SS |
618 | # Open filehandle to write the content to a new file. |
619 | open(FILE, ">", "$destination") or die "Could not open $destination. $!\n"; | |
2b12a010 | 620 | } else { |
ee16b227 SS |
621 | # Open filehandle to append the content to the existing file. |
622 | open(FILE, ">>", "$destination") or die "Could not open $destination. $!\n"; | |
623 | } | |
2b12a010 | 624 | |
ee16b227 SS |
625 | # Write the extracted file content to the filehandle. |
626 | print FILE "$content" if ($content); | |
2b12a010 | 627 | |
ee16b227 SS |
628 | # Close the file handle. |
629 | close(FILE); | |
630 | }); | |
0fbfffea SS |
631 | } |
632 | } | |
633 | ||
25f5cb0d | 634 | # |
b953677b SS |
635 | ## A wrapper function to call the oinkmaster script, setup the rules structues and |
636 | ## call the functions to merge the additional config files. (classification, sid-msg, etc.). | |
25f5cb0d SS |
637 | # |
638 | sub oinkmaster () { | |
330759d8 SS |
639 | # Check if the files in rulesdir have the correct permissions. |
640 | &_check_rulesdir_permissions(); | |
641 | ||
b953677b | 642 | # Cleanup the rules directory before filling it with the new rulests. |
883820bd SS |
643 | &_cleanup_rulesdir(); |
644 | ||
0130e0d1 | 645 | # Get all enabled providers. |
e31458de | 646 | my @enabled_providers = &get_enabled_providers(); |
b953677b | 647 | |
0130e0d1 SS |
648 | # Loop through the array of enabled providers. |
649 | foreach my $provider (@enabled_providers) { | |
1b5aec1b SS |
650 | # Call the extractruleset function. |
651 | &extractruleset($provider); | |
b953677b SS |
652 | } |
653 | ||
79446948 SS |
654 | # Call function to process the ruleset and do all modifications. |
655 | &process_ruleset(@enabled_providers); | |
b953677b | 656 | |
b953677b SS |
657 | # Call function to merge the classification files. |
658 | &merge_classifications(@enabled_providers); | |
659 | ||
660 | # Call function to merge the sid to message mapping files. | |
661 | &merge_sid_msg(@enabled_providers); | |
662 | ||
663 | # Cleanup temporary directory. | |
16b2d281 | 664 | &cleanup_tmp_directory(); |
25f5cb0d SS |
665 | } |
666 | ||
5a6c7bbe SS |
667 | # |
668 | ## Function to alter the ruleset. | |
669 | # | |
670 | sub process_ruleset(@) { | |
671 | my (@providers) = @_; | |
672 | ||
673 | # Hash to store the configured provider modes. | |
674 | my %providers_mode = &get_providers_mode(); | |
675 | ||
676 | # Array to store the extracted rulefile from the temporary rules directory. | |
677 | my @extracted_rulefiles; | |
678 | ||
679 | # Get names of the extracted raw rulefiles. | |
680 | opendir(DIR, $tmp_rules_directory) or die "Could not read from $tmp_rules_directory. $!\n"; | |
681 | while (my $file = readdir(DIR)) { | |
682 | # Ignore single and double dotted files. | |
683 | next if $file =~ /^\.\.?$/; | |
684 | ||
685 | # Add file to the array of extracted files. | |
686 | push(@extracted_rulefiles, $file); | |
687 | } | |
688 | ||
689 | # Close directory handle. | |
690 | closedir(DIR); | |
691 | ||
692 | # Loop through the array of providers. | |
693 | foreach my $provider (@providers) { | |
694 | # Hash to store the obtained SIDs and REV of each provider. | |
695 | my %rules = (); | |
696 | ||
697 | # Hash which holds modifications to apply to the rules. | |
698 | my %modifications = (); | |
699 | ||
700 | # Loop through the array of extraced rulefiles. | |
701 | foreach my $file (@extracted_rulefiles) { | |
702 | # Skip file if it does not belong to the current processed provider. | |
703 | next unless ($file =~ m/^$provider/); | |
704 | ||
705 | # Open the rulefile. | |
706 | open(FILE, "$tmp_rules_directory/$file") or die "Could not read $tmp_rules_directory/$file. $!\n"; | |
707 | ||
708 | # Loop through the file content. | |
709 | while (my $line = <FILE>) { | |
710 | # Skip blank lines. | |
711 | next if ($line =~ /^\s*$/); | |
712 | ||
713 | # Call function to get the sid and rev of the rule. | |
714 | my ($sid, $rev) = &_get_sid_and_rev($line); | |
715 | ||
716 | # Skip rule if a sid with a higher rev already has added to the rules hash. | |
717 | next if ($rev le $rules{$sid}); | |
718 | ||
719 | # Add the new or rule with higher rev to the hash of rules. | |
720 | $rules{$sid} = $rev; | |
721 | } | |
722 | ||
723 | # Close file handle. | |
724 | close(FILE); | |
725 | } | |
726 | ||
727 | # Get filename which contains the ruleset modifications for this provider. | |
728 | my $modification_file = &get_provider_ruleset_modifications_file($provider); | |
729 | ||
730 | # Read file which holds the modifications of the ruleset for the current provider. | |
731 | &General::readhash($modification_file, \%modifications) if (-f $modification_file); | |
732 | ||
733 | # Loop again through the array of extracted rulesfiles. | |
734 | foreach my $file (@extracted_rulefiles) { | |
735 | # Skip the file if it does not belong to the current provider. | |
736 | next unless ($file =~ m/^$provider/); | |
737 | ||
738 | # Open the rulefile for writing. | |
739 | open(RULEFILE, ">", "$rulespath/$file") or die "Could not write to file $rulespath/$file. $!\n"; | |
740 | ||
741 | # Open the rulefile for reading. | |
742 | open(TMP_RULEFILE, "$tmp_rules_directory/$file") or die "Could not read $tmp_rules_directory/$file. $!\n"; | |
743 | ||
744 | # Loop through the raw temporary rulefile. | |
745 | while (my $line = <TMP_RULEFILE>) { | |
746 | # Get the sid and rev of the rule. | |
747 | my ($sid, $rev) = &_get_sid_and_rev($line); | |
748 | ||
749 | # Check if the current rule is obsoleted by a newer one. | |
750 | # | |
751 | # In this case the rev number in the rules hash is higher than the current one. | |
752 | next if ($rev lt $rules{$sid}); | |
753 | ||
754 | # Check if the rule should be enabled or disabled. | |
2deba6bf | 755 | if ($modifications{$sid} eq "enabled") { |
5a6c7bbe SS |
756 | # Drop the # at the start of the line. |
757 | $line =~ s/^\#//; | |
2deba6bf | 758 | } elsif ($modifications{$sid} eq "disabled") { |
5a6c7bbe SS |
759 | # Add a # at the start of the line to disable the rule. |
760 | $line = "#$line" unless ($line =~ /^#/); | |
761 | } | |
762 | ||
763 | # Check if the Provider is set so IPS mode. | |
764 | if ($providers_mode{$provider} eq "IPS") { | |
765 | # Replacements for sourcefire rules. | |
766 | $line =~ s/^#\s*(?:alert|drop)(.+policy balanced-ips alert)/alert${1}/; | |
767 | $line =~ s/^#\s*(?:alert|drop)(.+policy balanced-ips drop)/drop${1}/; | |
768 | ||
769 | # Replacements for generic rules. | |
770 | $line =~ s/^(#?)\s*(?:alert|drop)/${1}drop/; | |
771 | $line =~ s/^(#?)\s*drop(.+flowbits:noalert;)/${1}alert${2}/; | |
772 | } | |
773 | ||
774 | # Write line / rule to the target rule file. | |
775 | print RULEFILE "$line"; | |
776 | } | |
777 | ||
778 | # Close filehandles. | |
779 | close(RULEFILE); | |
780 | close(TMP_RULEFILE); | |
781 | } | |
782 | } | |
783 | } | |
784 | ||
23b56052 SS |
785 | # |
786 | ## Function to merge the classifications for a given amount of providers and write them | |
787 | ## to the classifications file. | |
788 | # | |
789 | sub merge_classifications(@) { | |
790 | my @providers = @_; | |
791 | ||
792 | # Hash to store all collected classifications. | |
793 | my %classifications = (); | |
794 | ||
795 | # Loop through the given array of providers. | |
796 | foreach my $provider (@providers) { | |
797 | # Generate full path to classification file. | |
6c9d3eee | 798 | my $classification_file = "$tmp_conf_directory/$provider\-classification.config"; |
23b56052 SS |
799 | |
800 | # Skip provider if no classification file exists. | |
801 | next unless (-f "$classification_file"); | |
802 | ||
803 | # Open the classification file. | |
804 | open(CLASSIFICATION, $classification_file) or die "Could not open file $classification_file. $!\n"; | |
805 | ||
806 | # Loop through the file content. | |
807 | while(<CLASSIFICATION>) { | |
808 | # Parse the file and grab the classification details. | |
809 | if ($_ =~/.*config classification\: (.*)/) { | |
810 | # Split the grabbed details. | |
811 | my ($short_name, $short_desc, $priority) = split("\,", $1); | |
812 | ||
813 | # Check if the grabbed classification is allready known and the priority value is greater | |
814 | # than the stored one (which causes less priority in the IDS). | |
815 | if (($classifications{$short_name}) && ($classifications{$short_name}[1] >= $priority)) { | |
816 | #Change the priority value to the stricter one. | |
817 | $classifications{$short_name} = [ "$classifications{$short_name}[0]", "$priority" ]; | |
818 | } else { | |
819 | # Add the classification to the hash. | |
820 | $classifications{$short_name} = [ "$short_desc", "$priority" ]; | |
821 | } | |
822 | } | |
823 | } | |
824 | ||
825 | # Close the file. | |
826 | close(CLASSIFICATION); | |
827 | } | |
828 | ||
829 | # Open classification file for writing. | |
830 | open(FILE, ">", "$classification_file") or die "Could not write to $classification_file. $!\n"; | |
831 | ||
832 | # Print notice about autogenerated file. | |
833 | print FILE "#Autogenerated file. Any custom changes will be overwritten!\n\n"; | |
834 | ||
835 | # Sort and loop through the hash of classifications. | |
836 | foreach my $key (sort keys %classifications) { | |
837 | # Assign some nice variable names for the items. | |
838 | my $short_name = $key; | |
839 | my $short_desc = $classifications{$key}[0]; | |
840 | my $priority = $classifications{$key}[1]; | |
841 | ||
842 | # Write the classification to the file. | |
843 | print FILE "config classification: $short_name,$short_desc,$priority\n"; | |
844 | } | |
845 | ||
846 | # Close file handle. | |
847 | close(FILE); | |
848 | } | |
849 | ||
8bd74e12 SS |
850 | # |
851 | ## Function to merge the "sid to message mapping" files of various given providers. | |
852 | # | |
853 | sub merge_sid_msg (@) { | |
854 | my @providers = @_; | |
855 | ||
856 | # Hash which contains all the sid to message mappings. | |
857 | my %mappings = (); | |
858 | ||
859 | # Loop through the array of given providers. | |
860 | foreach my $provider (@providers) { | |
861 | # Generate full path and filename. | |
6c9d3eee | 862 | my $sid_msg_file = "$tmp_conf_directory/$provider\-sid-msg.map"; |
8bd74e12 SS |
863 | |
864 | # Skip provider if no sid to msg mapping file for this provider exists. | |
865 | next unless (-f $sid_msg_file); | |
866 | ||
867 | # Open the file. | |
868 | open(MAPPING, $sid_msg_file) or die "Could not open $sid_msg_file. $!\n"; | |
869 | ||
870 | # Loop through the file content. | |
871 | while (<MAPPING>) { | |
872 | # Remove newlines. | |
873 | chomp($_); | |
874 | ||
875 | # Skip lines which do not start with a number, | |
876 | next unless ($_ =~ /^\d+/); | |
877 | ||
878 | # Split line content and assign it to an array. | |
879 | my @line = split(/ \|\| /, $_); | |
880 | ||
881 | # Grab the first element (and remove it) from the line array. | |
882 | # It contains the sid. | |
883 | my $sid = shift(@line); | |
884 | ||
885 | # Store the grabbed sid and the remain array as hash value. | |
886 | # It still contains the messages, references etc. | |
887 | $mappings{$sid} = [@line]; | |
888 | } | |
889 | ||
890 | # Close file handle. | |
891 | close(MAPPING); | |
892 | } | |
893 | ||
894 | # Open mappings file for writing. | |
895 | open(FILE, ">", $sid_msg_file) or die "Could not write $sid_msg_file. $!\n"; | |
896 | ||
897 | # Write notice about autogenerated file. | |
898 | print FILE "#Autogenerated file. Any custom changes will be overwritten!\n\n"; | |
899 | ||
900 | # Loop through the hash of mappings. | |
901 | foreach my $sid ( sort keys %mappings) { | |
902 | # Grab data for the sid. | |
903 | my @data = @{$mappings{$sid}}; | |
904 | ||
905 | # Add the sid to the data array. | |
906 | unshift(@data, $sid); | |
907 | ||
908 | # Generate line. | |
909 | my $line = join(" \|\| ", @data); | |
910 | ||
911 | print FILE "$line\n"; | |
912 | ||
913 | } | |
914 | ||
915 | # Close file handle. | |
916 | close(FILE); | |
917 | } | |
918 | ||
50f348f6 SS |
919 | # |
920 | ## A very tiny function to move an extracted ruleset from the temporary directory into | |
921 | ## the rules directory. | |
922 | # | |
923 | sub move_tmp_ruleset() { | |
50f348f6 SS |
924 | # Do a directory listing of the temporary directory. |
925 | opendir DH, $tmp_rules_directory; | |
926 | ||
927 | # Loop over all files. | |
928 | while(my $file = readdir DH) { | |
929 | # Move them to the rules directory. | |
930 | move "$tmp_rules_directory/$file" , "$rulespath/$file"; | |
931 | } | |
932 | ||
933 | # Close directory handle. | |
934 | closedir DH; | |
935 | } | |
936 | ||
16b2d281 SS |
937 | # |
938 | ## Function to cleanup the temporary IDS directroy. | |
939 | # | |
940 | sub cleanup_tmp_directory () { | |
16b2d281 SS |
941 | |
942 | # Delete temporary directory and all containing files. | |
943 | rmtree([ "$tmp_directory" ]); | |
944 | } | |
945 | ||
3983aebd SS |
946 | # |
947 | ## Function to do all the logging stuff if the downloading or updating of the ruleset fails. | |
948 | # | |
949 | sub log_error ($) { | |
950 | my ($error) = @_; | |
951 | ||
952 | # Remove any newline. | |
953 | chomp($error); | |
954 | ||
eb5592c1 SS |
955 | # Call private function to log the error message to syslog. |
956 | &_log_to_syslog($error); | |
957 | ||
3983aebd SS |
958 | # Call private function to write/store the error message in the storederrorfile. |
959 | &_store_error_message($error); | |
960 | } | |
961 | ||
eb5592c1 SS |
962 | # |
963 | ## Function to log a given error message to the kernel syslog. | |
964 | # | |
965 | sub _log_to_syslog ($) { | |
966 | my ($message) = @_; | |
967 | ||
eb5592c1 SS |
968 | # The syslog function works best with an array based input, |
969 | # so generate one before passing the message details to syslog. | |
970 | my @syslog = ("ERR", "<ERROR> $message"); | |
971 | ||
972 | # Establish the connection to the syslog service. | |
973 | openlog('oinkmaster', 'cons,pid', 'user'); | |
974 | ||
975 | # Send the log message. | |
976 | syslog(@syslog); | |
977 | ||
978 | # Close the log handle. | |
979 | closelog(); | |
980 | } | |
981 | ||
3983aebd SS |
982 | # |
983 | ## Private function to write a given error message to the storederror file. | |
984 | # | |
985 | sub _store_error_message ($) { | |
986 | my ($message) = @_; | |
987 | ||
988 | # Remove any newline. | |
989 | chomp($message); | |
990 | ||
991 | # Open file for writing. | |
992 | open (ERRORFILE, ">$storederrorfile") or die "Could not write to $storederrorfile. $!\n"; | |
993 | ||
994 | # Write error to file. | |
995 | print ERRORFILE "$message\n"; | |
996 | ||
997 | # Close file. | |
998 | close (ERRORFILE); | |
3c59b1fa SS |
999 | |
1000 | # Set correct ownership for the file. | |
1001 | &set_ownership("$storederrorfile"); | |
3983aebd SS |
1002 | } |
1003 | ||
788a71f5 SS |
1004 | # |
1005 | ## Private function to get the path and filename for a downloaded ruleset by a given provider. | |
1006 | # | |
1007 | sub _get_dl_rulesfile($) { | |
1008 | my ($provider) = @_; | |
1009 | ||
738ee720 SS |
1010 | # Abort if the requested provider is not known. |
1011 | return unless($IDS::Ruleset::Providers{$provider}); | |
c62121c7 | 1012 | |
738ee720 SS |
1013 | # Try to gather the download type for the given provider. |
1014 | my $dl_type = $IDS::Ruleset::Providers{$provider}{'dl_type'}; | |
1015 | ||
1016 | # Check if a download type could be grabbed. | |
1017 | if ($dl_type) { | |
c62121c7 SS |
1018 | # Obtain the file suffix for the download file type. |
1019 | my $suffix = $dl_type_to_suffix{$dl_type}; | |
1020 | ||
1021 | # Check if a suffix has been found. | |
1022 | unless ($suffix) { | |
1023 | # Abort return - nothing. | |
1024 | return; | |
1025 | } | |
788a71f5 | 1026 | |
c62121c7 SS |
1027 | # Generate the full filename and path for the stored rules file. |
1028 | my $rulesfile = "$dl_rules_path/$dl_rulesfile_prefix-$provider$suffix"; | |
788a71f5 | 1029 | |
c62121c7 SS |
1030 | # Return the generated filename. |
1031 | return $rulesfile; | |
788a71f5 | 1032 | |
c62121c7 SS |
1033 | } else { |
1034 | # A downloaded ruleset for a provider which is not supported anymore is requested. | |
1035 | # | |
1036 | # Try to enumerate the downloaded ruleset file. | |
1037 | foreach my $dl_type (keys %dl_type_to_suffix) { | |
1038 | # Get the file suffix for the supported type. | |
1039 | my $suffix = $dl_type_to_suffix{$dl_type}; | |
788a71f5 | 1040 | |
c62121c7 SS |
1041 | # Generate possible ruleset file name. |
1042 | my $rulesfile = "$dl_rules_path/$dl_rulesfile_prefix-$provider$suffix"; | |
1043 | ||
1044 | # Check if such a file exists. | |
1045 | if (-f $rulesfile) { | |
1046 | # Downloaded rulesfile found - Return the filename. | |
1047 | return $rulesfile; | |
1048 | } | |
1049 | } | |
1050 | } | |
1051 | ||
1052 | # If we got here, no rulesfile could be determined - return nothing. | |
1053 | return; | |
788a71f5 SS |
1054 | } |
1055 | ||
e246285a SS |
1056 | # |
1057 | ## Private function to obtain the sid and rev of a rule. | |
1058 | # | |
1059 | ## Returns an array with the sid as first and the rev as second value. | |
1060 | # | |
1061 | sub _get_sid_and_rev ($) { | |
1062 | my ($line) = @_; | |
1063 | ||
1064 | my @ret; | |
1065 | ||
1066 | # Use regex to obtain the sid and rev. | |
1067 | if ($line =~ m/.*sid:\s*(.*?);.*rev:\s*(.*?);/) { | |
1068 | # Add the sid and rev to the array. | |
1069 | push(@ret, $1); | |
1070 | push(@ret, $2); | |
1071 | } | |
1072 | ||
1073 | # Return the array. | |
1074 | return @ret; | |
1075 | } | |
1076 | ||
61b92664 SS |
1077 | # |
1078 | ## Tiny function to delete the stored ruleset file or tarball for a given provider. | |
1079 | # | |
1080 | sub drop_dl_rulesfile ($) { | |
1081 | my ($provider) = @_; | |
1082 | ||
1083 | # Gather the full path and name of the stored rulesfile. | |
1084 | my $rulesfile = &_get_dl_rulesfile($provider); | |
1085 | ||
1086 | # Check if the given rulesfile exists. | |
1087 | if (-f $rulesfile) { | |
1088 | # Delete the stored rulesfile. | |
1089 | unlink($rulesfile) or die "Could not delete $rulesfile. $!\n"; | |
1090 | } | |
1091 | } | |
1092 | ||
796eea21 SS |
1093 | # |
1094 | ## Function to check if the IDS is running. | |
1095 | # | |
1096 | sub ids_is_running () { | |
1097 | if(-f $idspidfile) { | |
1098 | # Open PID file for reading. | |
1099 | open(PIDFILE, "$idspidfile") or die "Could not open $idspidfile. $!\n"; | |
1100 | ||
1101 | # Grab the process-id. | |
1102 | my $pid = <PIDFILE>; | |
1103 | ||
1104 | # Close filehandle. | |
1105 | close(PIDFILE); | |
1106 | ||
1107 | # Remove any newline. | |
1108 | chomp($pid); | |
1109 | ||
1110 | # Check if a directory for the process-id exists in proc. | |
1111 | if(-d "/proc/$pid") { | |
1112 | # The IDS daemon is running return the process id. | |
1113 | return $pid; | |
1114 | } | |
1115 | } | |
1116 | ||
1117 | # Return nothing - IDS is not running. | |
1118 | return; | |
1119 | } | |
1120 | ||
5240a809 SS |
1121 | # |
1122 | ## Function to call suricatactrl binary with a given command. | |
1123 | # | |
1124 | sub call_suricatactrl ($) { | |
1125 | # Get called option. | |
ed06bc81 | 1126 | my ($option, $interval) = @_; |
5240a809 SS |
1127 | |
1128 | # Loop through the array of supported commands and check if | |
1129 | # the given one is part of it. | |
1130 | foreach my $cmd (@suricatactrl_cmds) { | |
1131 | # Skip current command unless the given one has been found. | |
1132 | next unless($cmd eq $option); | |
1133 | ||
a15c9b16 SS |
1134 | # Call the suricatactrl binary and pass the requrested |
1135 | # option to it. | |
1136 | &General::system("$suricatactrl", "$option"); | |
ed06bc81 | 1137 | |
a15c9b16 SS |
1138 | # Return "1" - True. |
1139 | return 1; | |
5240a809 SS |
1140 | } |
1141 | ||
1142 | # Command not found - return nothing. | |
1143 | return; | |
1144 | } | |
1145 | ||
308ba5e7 SS |
1146 | # |
1147 | ## Function to create a new empty file. | |
1148 | # | |
1149 | sub create_empty_file($) { | |
1150 | my ($file) = @_; | |
1151 | ||
1152 | # Check if the given file exists. | |
1153 | if(-e $file) { | |
1154 | # Do nothing to prevent from overwriting existing files. | |
1155 | return; | |
1156 | } | |
1157 | ||
1158 | # Open the file for writing. | |
1159 | open(FILE, ">$file") or die "Could not write to $file. $!\n"; | |
1160 | ||
1161 | # Close file handle. | |
1162 | close(FILE); | |
1163 | ||
1164 | # Return true. | |
1165 | return 1; | |
1166 | } | |
1167 | ||
330759d8 SS |
1168 | # |
1169 | ## Private function to check if the file permission of the rulespath are correct. | |
1170 | ## If not, call suricatactrl to fix them. | |
1171 | # | |
1172 | sub _check_rulesdir_permissions() { | |
e568796b SS |
1173 | # Check if the rulepath main directory is writable. |
1174 | unless (-W $rulespath) { | |
1175 | # If not call suricatctrl to fix it. | |
1176 | &call_suricatactrl("fix-rules-dir"); | |
1177 | } | |
1178 | ||
330759d8 SS |
1179 | # Open snort rules directory and do a directory listing. |
1180 | opendir(DIR, $rulespath) or die $!; | |
1181 | # Loop through the direcory. | |
1182 | while (my $file = readdir(DIR)) { | |
1183 | # We only want files. | |
1184 | next unless (-f "$rulespath/$file"); | |
1185 | ||
1186 | # Check if the file is writable by the user. | |
1187 | if (-W "$rulespath/$file") { | |
1188 | # Everything is okay - go on to the next file. | |
1189 | next; | |
1190 | } else { | |
1191 | # There are wrong permissions, call suricatactrl to fix it. | |
1192 | &call_suricatactrl("fix-rules-dir"); | |
1193 | } | |
1194 | } | |
1195 | } | |
1196 | ||
b59cdbee SS |
1197 | # |
1198 | ## Private function to cleanup the directory which contains | |
1199 | ## the IDS rules, before extracting and modifing the new ruleset. | |
1200 | # | |
1201 | sub _cleanup_rulesdir() { | |
8cf04a16 SS |
1202 | # Open rules directory and do a directory listing. |
1203 | opendir(DIR, $rulespath) or die $!; | |
1204 | ||
1205 | # Loop through the direcory. | |
1206 | while (my $file = readdir(DIR)) { | |
1207 | # We only want files. | |
1208 | next unless (-f "$rulespath/$file"); | |
1209 | ||
fefb5173 SS |
1210 | # Skip rules file for whitelisted hosts. |
1211 | next if ("$rulespath/$file" eq $whitelist_file); | |
1212 | ||
612bb2df SS |
1213 | # Skip rules file with local rules. |
1214 | next if ("$rulespath/$file" eq $local_rules_file); | |
1215 | ||
8cf04a16 | 1216 | # Delete the current processed file, if not, exit this function |
b59cdbee | 1217 | # and return an error message. |
1201c1e7 | 1218 | unlink("$rulespath/$file") or return "Could not delete $rulespath/$file. $!\n"; |
b59cdbee SS |
1219 | } |
1220 | ||
4ce42488 | 1221 | # Return nothing; |
b59cdbee SS |
1222 | return; |
1223 | } | |
1224 | ||
b02e30fd SS |
1225 | # |
1226 | ## Function to generate the file which contains the home net information. | |
1227 | # | |
1228 | sub generate_home_net_file() { | |
1229 | my %netsettings; | |
1230 | ||
1231 | # Read-in network settings. | |
1232 | &General::readhash("${General::swroot}/ethernet/settings", \%netsettings); | |
1233 | ||
1234 | # Get available network zones. | |
abffcc99 | 1235 | my @network_zones = &Network::get_available_network_zones(); |
b02e30fd SS |
1236 | |
1237 | # Temporary array to store network address and prefix of the configured | |
1238 | # networks. | |
1239 | my @networks; | |
1240 | ||
1241 | # Loop through the array of available network zones. | |
1242 | foreach my $zone (@network_zones) { | |
bcbc9897 SS |
1243 | # Check if the current processed zone is red. |
1244 | if($zone eq "red") { | |
1245 | # Grab the IP-address of the red interface. | |
1246 | my $red_address = &get_red_address(); | |
b02e30fd | 1247 | |
bcbc9897 SS |
1248 | # Check if an address has been obtained. |
1249 | if ($red_address) { | |
1250 | # Generate full network string. | |
1251 | my $red_network = join("/", $red_address, "32"); | |
b02e30fd | 1252 | |
bcbc9897 SS |
1253 | # Add the red network to the array of networks. |
1254 | push(@networks, $red_network); | |
1255 | } | |
23c0347a | 1256 | |
23c0347a SS |
1257 | # Check if the configured RED_TYPE is static. |
1258 | if ($netsettings{'RED_TYPE'} eq "STATIC") { | |
1259 | # Get configured and enabled aliases. | |
1260 | my @aliases = &get_aliases(); | |
1261 | ||
1262 | # Loop through the array. | |
1263 | foreach my $alias (@aliases) { | |
1264 | # Add "/32" prefix. | |
1265 | my $network = join("/", $alias, "32"); | |
1266 | ||
1267 | # Add the generated network to the array of networks. | |
1268 | push(@networks, $network); | |
1269 | } | |
1270 | } | |
bcbc9897 SS |
1271 | # Process remaining network zones. |
1272 | } else { | |
1273 | # Convert current zone name into upper case. | |
1274 | $zone = uc($zone); | |
1275 | ||
1276 | # Generate key to access the required data from the netsettings hash. | |
1277 | my $zone_netaddress = $zone . "_NETADDRESS"; | |
1278 | my $zone_netmask = $zone . "_NETMASK"; | |
1279 | ||
1280 | # Obtain the settings from the netsettings hash. | |
1281 | my $netaddress = $netsettings{$zone_netaddress}; | |
1282 | my $netmask = $netsettings{$zone_netmask}; | |
1283 | ||
1284 | # Convert the subnetmask into prefix notation. | |
1285 | my $prefix = &Network::convert_netmask2prefix($netmask); | |
1286 | ||
1287 | # Generate full network string. | |
1288 | my $network = join("/", $netaddress,$prefix); | |
1289 | ||
1290 | # Check if the network is valid. | |
1291 | if(&Network::check_subnet($network)) { | |
1292 | # Add the generated network to the array of networks. | |
1293 | push(@networks, $network); | |
1294 | } | |
23c0347a | 1295 | } |
b02e30fd SS |
1296 | } |
1297 | ||
1298 | # Format home net declaration. | |
7479c993 | 1299 | my $line = "\"[" . join(',', @networks) . "]\""; |
b02e30fd SS |
1300 | |
1301 | # Open file to store the addresses of the home net. | |
1302 | open(FILE, ">$homenet_file") or die "Could not open $homenet_file. $!\n"; | |
1303 | ||
1304 | # Print yaml header. | |
1305 | print FILE "%YAML 1.1\n"; | |
1306 | print FILE "---\n\n"; | |
1307 | ||
1308 | # Print notice about autogenerated file. | |
1309 | print FILE "#Autogenerated file. Any custom changes will be overwritten!\n"; | |
1310 | ||
1311 | # Print the generated and required HOME_NET declaration to the file. | |
1312 | print FILE "HOME_NET:\t$line\n"; | |
1313 | ||
1314 | # Close file handle. | |
1315 | close(FILE); | |
1316 | } | |
1317 | ||
30ee98e9 SS |
1318 | # |
1319 | # Function to generate and write the file which contains the configured and used DNS servers. | |
1320 | # | |
1321 | sub generate_dns_servers_file() { | |
12c49915 SS |
1322 | # Get the used DNS servers. |
1323 | my @nameservers = &General::get_nameservers(); | |
30ee98e9 | 1324 | |
7b97359b SS |
1325 | # Get network settings. |
1326 | my %netsettings; | |
1327 | &General::readhash("${General::swroot}/ethernet/settings", \%netsettings); | |
1328 | ||
30ee98e9 | 1329 | # Format dns servers declaration. |
b76118c3 | 1330 | my $line = ""; |
30ee98e9 | 1331 | |
12c49915 SS |
1332 | # Check if the system has configured nameservers. |
1333 | if (@nameservers) { | |
7b97359b SS |
1334 | # Add the GREEN address as DNS servers. |
1335 | push(@nameservers, $netsettings{'GREEN_ADDRESS'}); | |
1336 | ||
1337 | # Check if a BLUE zone exists. | |
1338 | if ($netsettings{'BLUE_ADDRESS'}) { | |
1339 | # Add the BLUE address to the array of nameservers. | |
1340 | push(@nameservers, $netsettings{'BLUE_ADDRESS'}); | |
1341 | } | |
1342 | ||
1343 | # Generate the line which will be written to the DNS servers file. | |
b76118c3 | 1344 | $line = join(",", @nameservers); |
12c49915 | 1345 | } else { |
7b97359b | 1346 | # External net simply contains (any). |
99cadb74 | 1347 | $line = "\$EXTERNAL_NET"; |
fd2dccaa | 1348 | } |
30ee98e9 | 1349 | |
30ee98e9 SS |
1350 | # Open file to store the used DNS server addresses. |
1351 | open(FILE, ">$dns_servers_file") or die "Could not open $dns_servers_file. $!\n"; | |
1352 | ||
1353 | # Print yaml header. | |
1354 | print FILE "%YAML 1.1\n"; | |
1355 | print FILE "---\n\n"; | |
1356 | ||
1357 | # Print notice about autogenerated file. | |
1358 | print FILE "#Autogenerated file. Any custom changes will be overwritten!\n"; | |
1359 | ||
1360 | # Print the generated DNS declaration to the file. | |
b76118c3 | 1361 | print FILE "DNS_SERVERS:\t\"[$line]\"\n"; |
30ee98e9 SS |
1362 | |
1363 | # Close file handle. | |
1364 | close(FILE); | |
1365 | } | |
1366 | ||
e698090e SS |
1367 | # |
1368 | # Function to generate and write the file which contains the HTTP_PORTS definition. | |
1369 | # | |
1370 | sub generate_http_ports_file() { | |
1371 | my %proxysettings; | |
1372 | ||
1373 | # Read-in proxy settings | |
1374 | &General::readhash("${General::swroot}/proxy/advanced/settings", \%proxysettings); | |
1375 | ||
1376 | # Check if the proxy is enabled. | |
1377 | if (( -e "${General::swroot}/proxy/enable") || (-e "${General::swroot}/proxy/enable_blue")) { | |
1378 | # Add the proxy port to the array of HTTP ports. | |
1379 | push(@http_ports, $proxysettings{'PROXY_PORT'}); | |
1380 | } | |
1381 | ||
1382 | # Check if the transparent mode of the proxy is enabled. | |
1383 | if ((-e "${General::swroot}/proxy/transparent") || (-e "${General::swroot}/proxy/transparent_blue")) { | |
1384 | # Add the transparent proxy port to the array of HTTP ports. | |
1385 | push(@http_ports, $proxysettings{'TRANSPARENT_PORT'}); | |
1386 | } | |
1387 | ||
1388 | # Format HTTP_PORTS declaration. | |
1389 | my $line = ""; | |
1390 | ||
1391 | # Generate line which will be written to the http ports file. | |
1392 | $line = join(",", @http_ports); | |
1393 | ||
1394 | # Open file to store the HTTP_PORTS. | |
1395 | open(FILE, ">$http_ports_file") or die "Could not open $http_ports_file. $!\n"; | |
1396 | ||
1397 | # Print yaml header. | |
1398 | print FILE "%YAML 1.1\n"; | |
1399 | print FILE "---\n\n"; | |
1400 | ||
1401 | # Print notice about autogenerated file. | |
1402 | print FILE "#Autogenerated file. Any custom changes will be overwritten!\n"; | |
1403 | ||
1404 | # Print the generated HTTP_PORTS declaration to the file. | |
1405 | print FILE "HTTP_PORTS:\t\"[$line]\"\n"; | |
1406 | ||
1407 | # Close file handle. | |
1408 | close(FILE); | |
1409 | } | |
1410 | ||
b02e30fd | 1411 | # |
8d6714ed | 1412 | ## Function to write the file that contains the rulefiles which are loaded by suricaa. |
ddaf8ae1 | 1413 | ## |
8d6714ed | 1414 | ## This function requires an array of used provider handles. |
ddaf8ae1 | 1415 | # |
8d6714ed | 1416 | sub write_used_rulefiles_file (@) { |
ddaf8ae1 SS |
1417 | my (@providers) = @_; |
1418 | ||
8d6714ed | 1419 | # Get the enabled application layer protocols. |
43d12991 SS |
1420 | my @enabled_app_layer_protos = &get_suricata_enabled_app_layer_protos(); |
1421 | ||
8d6714ed SS |
1422 | # Open the file. |
1423 | open (FILE, ">", $suricata_used_rulesfiles_file) or die "Could not write to $suricata_used_rulesfiles_file. $!\n"; | |
88eb5626 | 1424 | |
88eb5626 SS |
1425 | print FILE "%YAML 1.1\n"; |
1426 | print FILE "---\n\n"; | |
1427 | ||
1428 | # Write notice about autogenerated file. | |
1429 | print FILE "#Autogenerated file. Any custom changes will be overwritten!\n"; | |
1430 | ||
1431 | # Loop through the array of static included rulesfiles. | |
1432 | foreach my $file (@static_included_rulefiles) { | |
1433 | # Check if the file exists. | |
1434 | if (-f "$rulespath/$file") { | |
1435 | # Write the rulesfile name to the file. | |
43d12991 SS |
1436 | print FILE " - $rulespath/$file\n"; |
1437 | } | |
1438 | } | |
1439 | ||
1440 | print FILE "\n#Default rules for used application layer protocols.\n"; | |
1441 | foreach my $enabled_app_layer_proto (@enabled_app_layer_protos) { | |
1442 | # Check if the current processed app layer proto needs to be translated | |
1443 | # into an application name. | |
1444 | if (exists($tr_app_layer_proto{$enabled_app_layer_proto})) { | |
43d12991 SS |
1445 | # Obtain the translated application name for this protocol. |
1446 | $enabled_app_layer_proto = $tr_app_layer_proto{$enabled_app_layer_proto}; | |
1447 | } | |
1448 | ||
1449 | # Generate filename. | |
1450 | my $rulesfile = "$default_rulespath/$enabled_app_layer_proto\.rules"; | |
1451 | ||
1452 | # Check if such a file exists. | |
1453 | if (-f "$rulesfile") { | |
1454 | # Write the rulesfile name to the file. | |
1455 | print FILE " - $rulesfile\n"; | |
1456 | } | |
1457 | ||
1458 | # Generate filename with "events" in filename. | |
1459 | $rulesfile = "$default_rulespath/$enabled_app_layer_proto\-events.rules"; | |
1460 | ||
1461 | # Check if this file exists. | |
1462 | if (-f "$rulesfile" ) { | |
1463 | # Write the rulesfile name to the file. | |
1464 | print FILE " - $rulesfile\n"; | |
88eb5626 SS |
1465 | } |
1466 | } | |
1467 | ||
8d6714ed SS |
1468 | # Loop through the array of enabled providers. |
1469 | foreach my $provider (@providers) { | |
e41ee3e0 SS |
1470 | # Skip unsupported providers. |
1471 | next unless ($IDS::Ruleset::Providers{$provider}); | |
1472 | ||
8d6714ed SS |
1473 | # Get the used rulefile for this provider. |
1474 | my @used_rulesfiles = &get_provider_used_rulesfiles($provider); | |
1475 | ||
1476 | # Check if there are | |
1477 | if(@used_rulesfiles) { | |
1478 | # Add notice to the file. | |
1479 | print FILE "\n#Used Rulesfiles for provider $provider.\n"; | |
1480 | ||
1481 | # Loop through the array of used rulefiles. | |
1482 | foreach my $enabled_rulesfile (@used_rulesfiles) { | |
1483 | # Generate name and full path to the rulesfile. | |
1484 | my $rulesfile = "$rulespath/$enabled_rulesfile"; | |
1485 | ||
1486 | # Write the ruelsfile name to the file. | |
1487 | print FILE " - $rulesfile\n"; | |
1488 | } | |
1489 | } | |
1490 | } | |
1491 | ||
88eb5626 SS |
1492 | # Close the file handle |
1493 | close(FILE); | |
1494 | } | |
1495 | ||
ddaf8ae1 | 1496 | # |
8d6714ed | 1497 | ## Tiny function to generate the full path and name for the file which stores the used rulefiles of a given provider. |
ddaf8ae1 | 1498 | # |
8d6714ed | 1499 | sub get_provider_used_rulesfiles_file ($) { |
ddaf8ae1 SS |
1500 | my ($provider) = @_; |
1501 | ||
8d6714ed | 1502 | my $filename = "$settingsdir/$provider\-used\-rulesfiles"; |
ddaf8ae1 SS |
1503 | |
1504 | # Return the gernerated file. | |
1505 | return $filename; | |
1506 | } | |
1507 | ||
518cbdd3 SS |
1508 | # |
1509 | ## Tiny function to generate the full path and name for the file which stores the modifications of a ruleset. | |
1510 | # | |
1511 | sub get_provider_ruleset_modifications_file($) { | |
1512 | my ($provider) = @_; | |
1513 | ||
1514 | my $filename = "$settingsdir/$provider\-modifications"; | |
1515 | ||
1516 | # Return the filename. | |
1517 | return $filename; | |
1518 | } | |
1519 | ||
235e3e92 SS |
1520 | # |
1521 | ## Function to get the subscription code of a configured provider. | |
1522 | # | |
1523 | sub get_subscription_code($) { | |
1524 | my ($provider) = @_; | |
1525 | ||
1526 | my %configured_providers = (); | |
1527 | ||
1528 | # Read-in providers settings file. | |
1529 | &General::readhasharray($providers_settings_file, \%configured_providers); | |
1530 | ||
1531 | # Loop through the hash of configured providers. | |
1532 | foreach my $id (keys %configured_providers) { | |
1533 | # Assign nice human-readable values to the data fields. | |
1534 | my $provider_handle = $configured_providers{$id}[0]; | |
1535 | my $subscription_code = $configured_providers{$id}[1]; | |
1536 | ||
1537 | # Check if the current processed provider is the requested one. | |
1538 | if ($provider_handle eq $provider) { | |
1539 | # Return the obtained subscription code. | |
1540 | return $subscription_code; | |
1541 | } | |
1542 | } | |
1543 | ||
1544 | # No subscription code found - return nothing. | |
1545 | return; | |
1546 | } | |
1547 | ||
f580aa8c SS |
1548 | # |
1549 | ## Function to get the ruleset date for a given provider. | |
1550 | ## | |
1551 | ## The function simply return the creation date in a human read-able format | |
1552 | ## of the stored providers rulesfile. | |
1553 | # | |
1554 | sub get_ruleset_date($) { | |
1555 | my ($provider) = @_; | |
fc685a36 | 1556 | my $date; |
c68bcbb2 | 1557 | my $mtime; |
f580aa8c | 1558 | |
f580aa8c SS |
1559 | # Get the stored rulesfile for this provider. |
1560 | my $stored_rulesfile = &_get_dl_rulesfile($provider); | |
1561 | ||
c68bcbb2 | 1562 | # Check if we got a file. |
cad087c7 | 1563 | if (-f $stored_rulesfile) { |
c68bcbb2 SS |
1564 | # Call stat on the rulestarball. |
1565 | my $stat = stat("$stored_rulesfile"); | |
f580aa8c | 1566 | |
c68bcbb2 SS |
1567 | # Get timestamp the file creation. |
1568 | $mtime = $stat->mtime; | |
1569 | } | |
f580aa8c | 1570 | |
057e8953 SS |
1571 | # Check if the timestamp has not been grabbed. |
1572 | unless ($mtime) { | |
1573 | # Return N/A for Not available. | |
1574 | return "N/A"; | |
1575 | } | |
1576 | ||
f580aa8c | 1577 | # Convert into human read-able format. |
fc685a36 SS |
1578 | $date = strftime('%Y-%m-%d %H:%M:%S', localtime($mtime)); |
1579 | ||
f580aa8c SS |
1580 | # Return the date. |
1581 | return $date; | |
1582 | } | |
1583 | ||
04a0d07c SS |
1584 | # |
1585 | ## Function to gather the version of suricata. | |
1586 | # | |
1587 | sub get_suricata_version($) { | |
1588 | my ($format) = @_; | |
1589 | ||
1590 | # Execute piped suricata command and return the version information. | |
1591 | open(SURICATA, "suricata -V |") or die "Couldn't execute program: $!"; | |
1592 | ||
1593 | # Grab and store the output of the piped program. | |
1594 | my $version_string = <SURICATA>; | |
1595 | ||
1596 | # Close pipe. | |
1597 | close(SURICATA); | |
1598 | ||
1599 | # Remove newlines. | |
1600 | chomp($version_string); | |
1601 | ||
fd2dccaa | 1602 | # Grab the version from the version string. |
04a0d07c SS |
1603 | $version_string =~ /([0-9]+([.][0-9]+)+)/; |
1604 | ||
1605 | # Splitt the version into single chunks. | |
1606 | my ($major_ver, $minor_ver, $patchlevel) = split(/\./, $1); | |
1607 | ||
1608 | # Check and return the requested version sheme. | |
1609 | if ($format eq "major") { | |
1610 | # Return the full version. | |
1611 | return "$major_ver"; | |
1612 | } elsif ($format eq "minor") { | |
1613 | # Return the major and minor part. | |
1614 | return "$major_ver.$minor_ver"; | |
1615 | } else { | |
1616 | # Return the full version string. | |
1617 | return "$major_ver.$minor_ver.$patchlevel"; | |
fd2dccaa | 1618 | } |
04a0d07c SS |
1619 | } |
1620 | ||
bb39fac4 SS |
1621 | # |
1622 | ## Function to get the enabled application layer protocols. | |
1623 | # | |
1624 | sub get_suricata_enabled_app_layer_protos() { | |
1625 | # Array to store and return the enabled app layer protos. | |
1626 | my @enabled_app_layer_protos = (); | |
1627 | ||
1628 | # Execute piped suricata command and return the list of | |
1629 | # enabled application layer protocols. | |
1630 | open(SURICATA, "suricata --list-app-layer-protos |") or die "Could not execute program: $!"; | |
1631 | ||
1632 | # Grab and store the list of enabled application layer protocols. | |
1633 | my @output = <SURICATA>; | |
1634 | ||
1635 | # Close pipe. | |
1636 | close(SURICATA); | |
1637 | ||
1638 | # Merge allways enabled static application layers protocols array. | |
1639 | @enabled_app_layer_protos = @static_enabled_app_layer_protos; | |
1640 | ||
1641 | # Loop through the array which contains the output of suricata. | |
1642 | foreach my $line (@output) { | |
1643 | # Skip header line which starts with "===". | |
1644 | next if ($line =~ /^\s*=/); | |
1645 | ||
1646 | # Skip info or warning lines. | |
1647 | next if ($line =~ /\s*--/); | |
1648 | ||
1649 | # Remove newlines. | |
1650 | chomp($line); | |
1651 | ||
1652 | # Add enabled app layer proto to the array. | |
1653 | push(@enabled_app_layer_protos, $line); | |
1654 | } | |
1655 | ||
1656 | # Sort the array. | |
1657 | @enabled_app_layer_protos = sort(@enabled_app_layer_protos); | |
1658 | ||
1659 | # Return the array. | |
1660 | return @enabled_app_layer_protos; | |
1661 | } | |
1662 | ||
9283e9b9 SS |
1663 | # |
1664 | ## Function to generate the rules file with whitelisted addresses. | |
1665 | # | |
1666 | sub generate_ignore_file() { | |
1667 | my %ignored = (); | |
1668 | ||
1669 | # SID range 1000000-1999999 Reserved for Local Use | |
1670 | # Put your custom rules in this range to avoid conflicts | |
1671 | my $sid = 1500000; | |
1672 | ||
1673 | # Read-in ignoredfile. | |
1674 | &General::readhasharray($IDS::ignored_file, \%ignored); | |
1675 | ||
1676 | # Open ignorefile for writing. | |
1677 | open(FILE, ">$IDS::whitelist_file") or die "Could not write to $IDS::whitelist_file. $!\n"; | |
1678 | ||
1679 | # Config file header. | |
1680 | print FILE "# Autogenerated file.\n"; | |
1681 | print FILE "# All user modifications will be overwritten.\n\n"; | |
1682 | ||
1683 | # Add all user defined addresses to the whitelist. | |
1684 | # | |
1685 | # Check if the hash contains any elements. | |
1686 | if (keys (%ignored)) { | |
1687 | # Loop through the entire hash and write the host/network | |
1688 | # and remark to the ignore file. | |
1689 | while ( (my $key) = each %ignored) { | |
1690 | my $address = $ignored{$key}[0]; | |
1691 | my $remark = $ignored{$key}[1]; | |
1692 | my $status = $ignored{$key}[2]; | |
1693 | ||
1694 | # Check if the status of the entry is "enabled". | |
1695 | if ($status eq "enabled") { | |
1696 | # Check if the address/network is valid. | |
1697 | if ((&General::validip($address)) || (&General::validipandmask($address))) { | |
1698 | # Write rule line to the file to pass any traffic from this IP | |
c1ccae1c | 1699 | print FILE "pass ip $address any -> any any (msg:\"pass all traffic from/to $address\"\; bypass; sid:$sid\;)\n"; |
9283e9b9 SS |
1700 | |
1701 | # Increment sid. | |
1702 | $sid++; | |
1703 | } | |
1704 | } | |
1705 | } | |
1706 | } | |
1707 | ||
1708 | close(FILE); | |
1709 | } | |
1710 | ||
1fedede6 SS |
1711 | # |
1712 | ## Function to set correct ownership for single files and directories. | |
1713 | # | |
1714 | ||
1715 | sub set_ownership($) { | |
1716 | my ($target) = @_; | |
1717 | ||
1718 | # User and group of the WUI. | |
1719 | my $uname = "nobody"; | |
1720 | my $grname = "nobody"; | |
1721 | ||
1722 | # The chown function implemented in perl requies the user and group as nummeric id's. | |
1723 | my $uid = getpwnam($uname); | |
1724 | my $gid = getgrnam($grname); | |
1725 | ||
1726 | # Check if the given target exists. | |
1727 | unless ($target) { | |
1728 | # Stop the script and print error message. | |
1729 | die "The $target does not exist. Cannot change the ownership!\n"; | |
1730 | } | |
1731 | ||
1732 | # Check weather the target is a file or directory. | |
1733 | if (-f $target) { | |
1734 | # Change ownership ot the single file. | |
1735 | chown($uid, $gid, "$target"); | |
1736 | } elsif (-d $target) { | |
1737 | # Do a directory listing. | |
1738 | opendir(DIR, $target) or die $!; | |
1739 | # Loop through the direcory. | |
1740 | while (my $file = readdir(DIR)) { | |
1741 | ||
1742 | # We only want files. | |
1743 | next unless (-f "$target/$file"); | |
1744 | ||
1745 | # Set correct ownership for the files. | |
1746 | chown($uid, $gid, "$target/$file"); | |
1747 | } | |
1748 | ||
1749 | closedir(DIR); | |
1750 | ||
1751 | # Change ownership of the directory. | |
1752 | chown($uid, $gid, "$target"); | |
1753 | } | |
1754 | } | |
77c31301 SS |
1755 | |
1756 | # | |
1757 | ## Function to read-in the aliases file and returns all configured and enabled aliases. | |
1758 | # | |
1759 | sub get_aliases() { | |
1760 | # Location of the aliases file. | |
1761 | my $aliases_file = "${General::swroot}/ethernet/aliases"; | |
1762 | ||
1763 | # Array to store the aliases. | |
1764 | my @aliases; | |
1765 | ||
1766 | # Check if the file is empty. | |
1767 | if (-z $aliases_file) { | |
1768 | # Abort nothing to do. | |
1769 | return; | |
1770 | } | |
1771 | ||
1772 | # Open the aliases file. | |
1773 | open(ALIASES, $aliases_file) or die "Could not open $aliases_file. $!\n"; | |
1774 | ||
1775 | # Loop through the file content. | |
1776 | while (my $line = <ALIASES>) { | |
1777 | # Remove newlines. | |
1778 | chomp($line); | |
1779 | ||
1780 | # Splitt line content into single chunks. | |
1781 | my ($address, $state, $remark) = split(/\,/, $line); | |
1782 | ||
1783 | # Check if the state of the current processed alias is "on". | |
1784 | if ($state eq "on") { | |
1785 | # Check if the address is valid. | |
1786 | if(&Network::check_ip_address($address)) { | |
1787 | # Add the alias to the array of aliases. | |
1788 | push(@aliases, $address); | |
1789 | } | |
1790 | } | |
1791 | } | |
1792 | ||
1793 | # Close file handle. | |
1794 | close(ALIASES); | |
1795 | ||
1796 | # Return the array. | |
1797 | return @aliases; | |
1798 | } | |
1799 | ||
de8e1e5b SS |
1800 | # |
1801 | ## Function to grab the current assigned IP-address on red. | |
1802 | # | |
1803 | sub get_red_address() { | |
1804 | # File, which contains the current IP-address of the red interface. | |
1805 | my $file = "${General::swroot}/red/local-ipaddress"; | |
1806 | ||
1807 | # Check if the file exists. | |
1808 | if (-e $file) { | |
1809 | # Open the given file. | |
1810 | open(FILE, "$file") or die "Could not open $file."; | |
1811 | ||
1812 | # Obtain the address from the first line of the file. | |
1813 | my $address = <FILE>; | |
1814 | ||
1815 | # Close filehandle | |
1816 | close(FILE); | |
1817 | ||
1818 | # Remove newlines. | |
1819 | chomp $address; | |
1820 | ||
1821 | # Check if the grabbed address is valid. | |
1822 | if (&General::validip($address)) { | |
1823 | # Return the address. | |
1824 | return $address; | |
1825 | } | |
1826 | } | |
1827 | ||
1828 | # Return nothing. | |
1829 | return; | |
1830 | } | |
77c31301 | 1831 | |
6563d449 | 1832 | # |
ddaf8ae1 | 1833 | ## Function to get the used rules files of a given provider. |
6563d449 | 1834 | # |
8d6714ed | 1835 | sub get_provider_used_rulesfiles($) { |
ddaf8ae1 SS |
1836 | my ($provider) = @_; |
1837 | ||
8d6714ed SS |
1838 | # Hash to store the used rulefiles of the provider. |
1839 | my %provider_rulefiles = (); | |
1840 | ||
6563d449 SS |
1841 | # Array to store the used rulefiles. |
1842 | my @used_rulesfiles = (); | |
1843 | ||
8d6714ed SS |
1844 | # Get the filename which contains the used rulefiles for this provider. |
1845 | my $used_rulesfiles_file = &get_provider_used_rulesfiles_file($provider); | |
ddaf8ae1 | 1846 | |
8d6714ed SS |
1847 | # Read-in file, if it exists. |
1848 | &General::readhash("$used_rulesfiles_file", \%provider_rulefiles) if (-f $used_rulesfiles_file); | |
6563d449 | 1849 | |
8d6714ed SS |
1850 | # Loop through the hash of rulefiles which does the provider offer. |
1851 | foreach my $rulefile (keys %provider_rulefiles) { | |
1852 | # Skip disabled rulefiles. | |
1853 | next unless($provider_rulefiles{$rulefile} eq "enabled"); | |
6563d449 | 1854 | |
8d6714ed SS |
1855 | # The General::readhash function does not allow dots as |
1856 | # key value and limits the key "string" to the part before | |
1857 | # the dot, in case it contains one. | |
1858 | # | |
1859 | # So add the file extension for the rules file manually again. | |
1860 | $rulefile = "$rulefile.rules"; | |
6563d449 | 1861 | |
8d6714ed SS |
1862 | # Add the enabled rulefile to the array of enabled rulefiles. |
1863 | push(@used_rulesfiles, $rulefile); | |
6563d449 SS |
1864 | } |
1865 | ||
1866 | # Return the array of used rulesfiles. | |
1867 | return @used_rulesfiles; | |
1868 | } | |
1869 | ||
504fb53b SS |
1870 | # |
1871 | ## Function to delete the stored etag data of a given provider. | |
1872 | # | |
1873 | sub remove_from_etags ($) { | |
1874 | my ($provider) = @_; | |
1875 | ||
1876 | my %etags; | |
1877 | ||
1878 | # Early exit function if the etags file does not exist. | |
1879 | return unless (-f $etags_file); | |
1880 | ||
1881 | # Read-in etag file. | |
1882 | &General::readhash("$etags_file", \%etags); | |
1883 | ||
1884 | # Check if the hash contains an entry for the given provider. | |
1885 | if ($etags{$provider}) { | |
1886 | # Drop the entry. | |
1887 | delete($etags{$provider}); | |
1888 | ||
1889 | # Write back the etags file. | |
1890 | &General::writehash("$etags_file", \%etags); | |
1891 | } | |
1892 | } | |
1893 | ||
8076deba SS |
1894 | # |
1895 | ## Function to write the lock file for locking the WUI, while | |
1896 | ## the autoupdate script runs. | |
1897 | # | |
1898 | sub lock_ids_page() { | |
1899 | # Call subfunction to create the file. | |
1900 | &create_empty_file($ids_page_lock_file); | |
1901 | } | |
1902 | ||
1903 | # | |
1904 | ## Function to release the lock of the WUI, again. | |
1905 | # | |
1906 | sub unlock_ids_page() { | |
1907 | # Delete lock file. | |
1908 | unlink($ids_page_lock_file); | |
1909 | } | |
1910 | ||
8dcebe53 | 1911 | 1; |