forked from rtm516/Open-Report-Parser
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreport-parser.pl
executable file
·1833 lines (1611 loc) · 59.7 KB
/
report-parser.pl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/perl
# -----------------------------------------------------------------------------
#
# Open Report Parser - Open Source report parser
# Copyright (C) 2023 John Bradley (userjack6880)
# Copyright (C) 2016 TechSneeze.com
# Copyright (C) 2012 John Bieling
#
# report-parser.pl
# main script
#
# Available at: https://github.com/userjack6880/Open-Report-Parser
#
# -----------------------------------------------------------------------------
#
# This file is part of Open Report Parser.
#
# Open Report Parser is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
# PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with
# this program. If not, see <https://www.gnu.org/licenses/>.
#
# -----------------------------------------------------------------------------
#
# The subroutines storeXMLInDatabase() and getXMLFromMessage() are based on
# John R. Levine's rddmarc (http://www.taugh.com/rddmarc/). The following
# special conditions apply to those subroutines:
#
# Copyright 2012, Taughannock Networks. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# Redistributions in binary form must reproduce the above copyright notice, this
# list of conditions and the following disclaimer in the documentation and/or
# other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# -----------------------------------------------------------------------------
# Always be safe
use strict;
use warnings;
# Use these modules
use Getopt::Long;
use IO::Compress::Gzip qw(gzip $GzipError);
#use Data::Dumper;
use Mail::IMAPClient;
use Mail::Mbox::MessageParser;
use MIME::Base64 qw(encode_base64);
use MIME::Words qw(decode_mimewords);
use MIME::Parser;
use MIME::Parser::Filer;
use XML::Simple;
use JSON;
use DBI;
use Socket;
use Socket6;
use PerlIO::gzip;
use File::Basename ();
use File::MimeInfo;
use IO::Socket::SSL;
#use IO::Socket::SSL 'debug3';
use lib 'lib';
use OAuth;
# -----------------------------------------------------------------------------
# usage
# -----------------------------------------------------------------------------
sub show_usage {
print "\n";
print " Usage: \n";
print " ./report-parser.pl [OPTIONS] [PATH] \n";
print "\n";
print " This script needs a configuration file called <report-parser.conf> in the\n";
print " current working directory, which defines a database server with credentials \n";
print " and (if used) an IMAP server with credentials. \n";
print "\n";
print " Additionaly, one of the following source options must be provided: \n";
print " -i : Read reports from messages on IMAP server as defined in the \n";
print " config file. \n";
print " -m : Read reports from mbox file(s) provided in PATH. \n";
print " -e : Read reports from MIME email file(s) provided in PATH. \n";
print " -x : Read reports from xml file(s) provided in PATH. \n";
print " -j : Read reports from json files(s) provided in PATH. \n";
print " -z : Read reports from zip file(s) provided in PATH. \n";
print "\n";
print " The following optional options are allowed: \n";
print " -d : Print debug info. \n";
print " -r : Replace existing reports rather than skipping them. \n";
print " --delete : Delete processed message files (the XML is stored in the \n";
print " database for later reference). \n";
print " --info : Print out number of XML files or emails processed. \n";
print " --tls : Force TLS-Only Mode. \n";
print "\n";
}
# -----------------------------------------------------------------------------
# main
# -----------------------------------------------------------------------------
# Define all possible configuration options.
our ($debug, $delete_reports, $delete_failed, $reports_replace, $dmarc_only,
$maxsize_xml, $compress_xml, $maxsize_json, $compress_json,
$dbtype, $dbname, $dbuser, $dbpass, $dbhost, $dbport, $db_tx_support,
$imapserver, $imapport, $imapuser, $imappass, $imapignoreerror, $imapssl, $imaptls,
$imapauth, $oauthclientid, $oauthuri,
$imapdmarcfolder, $imapdmarcproc, $imapdmarcerr,
$imaptlsfolder, $imaptlsproc, $imaptlserr,
$tlsverify, $processInfo,
$clear_token);
# defaults
$maxsize_xml = 50000;
$maxsize_json = 50000;
$dbtype = 'mysql';
$dbhost = 'localhost';
$db_tx_support = 1;
$dmarc_only = 1;
$reports_replace = 0;
$imapauth = 'simple';
$clear_token = 0;
$processInfo = 0;
$oauthuri = '';
$oauthclientid = '';
# used in messages
my $scriptname = 'Open Report Parser';
my $version = 'Version 0 Alpha 5';
# allowed values for the DB columns, also used to build the enum() in the
# CREATE TABLE statements in checkDatabase(), in order defined here
use constant ALLOWED_DISPOSITION => qw(
none
quarantine
reject
unknown
);
use constant ALLOWED_DKIM_ALIGN => qw(
fail
pass
unknown
);
use constant ALLOWED_SPF_ALIGN => qw(
fail
pass
unknown
);
use constant ALLOWED_DKIMRESULT => qw(
none
pass
fail
neutral
policy
temperror
permerror
unknown
);
use constant ALLOWED_SPFRESULT => qw(
none
neutral
pass
fail
softfail
temperror
permerror
unknown
);
# Load script configuration options from local config file. The file is expected
# to be in the current working directory.
my $conf_file = 'report-parser.conf';
# Get command line options.
my %options = ();
use constant { TS_IMAP => 0,
TS_MESSAGE_FILE => 1,
TS_XML_FILE => 2,
TS_MBOX_FILE => 3,
TS_ZIP_FILE => 4,
TS_JSON_FILE => 5 };
GetOptions( \%options, 'd', 'r', 'x', 'j', 'm', 'e', 'i', 'z', 'delete', 'info', 'c' => \$conf_file, 'clear' );
# locate conf file or die
if ( -e $conf_file ) {
#$conf_file = "./$conf_file";
}
elsif ( -e (File::Basename::dirname($0) . "/$conf_file" ) ) {
$conf_file = ( File::Basename::dirname($0) . "/$conf_file" );
}
else {
show_usage();
die "$scriptname: Could not read config file '$conf_file' from current working directory or path (" . File::Basename::dirname($0) . ')'
}
# load conf file with error handling
if ( substr($conf_file, 0, 1) ne '/' and substr($conf_file, 0, 1) ne '.') {
$conf_file = "./$conf_file";
}
my $conf_return = do $conf_file;
die "$scriptname: couldn't parse $conf_file: $@" if $@;
die "$scriptname: couldn't do $conf_file: $!" unless defined $conf_return;
# check config
if (!defined $imapdmarcfolder ) {
die "$scriptname: \$imapdmarcfolder not defined. Check config file";
}
if (!defined $imapignoreerror ) {
$imapignoreerror = 0; # maintain compatibility to old version
}
# Evaluate command line options
my $source_options = 0;
our $reports_source;
if (exists $options{m}) {
$source_options++;
$reports_source = TS_MBOX_FILE;
$dmarc_only = 1;
}
if (exists $options{x}) {
$source_options++;
$reports_source = TS_XML_FILE;
$dmarc_only = 1;
}
if (exists $options{j}) {
$source_options++;
$reports_source = TS_JSON_FILE;
$dmarc_only = -1;
}
if (exists $options{e}) {
$source_options++;
$reports_source = TS_MESSAGE_FILE;
$dmarc_only = 1;
}
if (exists $options{i}) {
$source_options++;
$reports_source = TS_IMAP;
}
if (exists $options{z}) {
$source_options++;
$reports_source = TS_ZIP_FILE;
$dmarc_only = 1;
}
if (exists $options{c}) {
$source_options++;
}
if ($source_options > 1) {
show_usage();
die "$scriptname: Only one source option can be used (-i, -x, -m, -e or -z).\n";
}
elsif ($source_options == 0) {
show_usage();
die "$scriptname: Please provide a source option (-i, -x, -m, -e or -z).\n";
}
if ($ARGV[0]) {
if ($reports_source == TS_IMAP) {
show_usage();
die "$scriptname: The IMAP source option (-i) may not be used together with a PATH.\n";
}
}
else {
if ($reports_source != TS_IMAP && $source_options == 1) {
show_usage();
die "$scriptname: The provided source option requires a PATH.\n";
}
}
# Override config options by command line options.
if (exists $options{r}) {$reports_replace = 1;}
if (exists $options{d}) {$debug = 1;}
if (exists $options{delete}) {$delete_reports = 1;}
if (exists $options{info}) {$processInfo = 1;}
if (exists $options{tls}) {$dmarc_only = -1;}
if (exists $options{clear}) {$clear_token = 1;}
# Cludgy, but it lets us preserve filename for dbx_postgres.pl
my $dbitype = 'mysql';
$dbitype = 'Pg' if $dbtype eq 'postgres';
# Print info
printInfo($scriptname."\n $version");
# Print out config if debug
if ($debug) {
print "$scriptname DEBUG ENABLED\n".
"-- Script Options --\n\n".
"Report Source: $reports_source\n".
"(0: IMAP, 1: Message, 2: XML, 3: MBOX, 4: ZIP, 5: JSON)\n".
"Show Processed: $processInfo\n".
"Delete Reports: $delete_reports\n".
"Delete Failed: $delete_failed\n".
"Replace Reports: $reports_replace\n".
"DMARC Only: $dmarc_only\n".
"(0: DMARC\\TLS, 1: DMARC Only, -1: TLS Only)\n\n".
"-- Database Options --\n\n".
"DB Type: $dbtype\n".
"DB Name: $dbname\n".
"DB User: $dbuser\n".
"DB Host/Port: $dbhost:$dbport\n".
"DB TX Support: $db_tx_support\n\n".
"Max XML Size: $maxsize_xml\n".
"Max JSON Size: $maxsize_json\n".
"Compress XML: $compress_xml\n".
"Compress JSON: $compress_json\n\n".
"-- IMAP Options --\n\n".
"IMAP Server: $imapserver\n".
"IMAP Port: $imapport\n".
"TLS: $imaptls\n".
"SSL: $imapssl\n".
"TLS Verify: $tlsverify\n".
"IMAP User: $imapuser\n".
"IMAP Ignore Err: $imapignoreerror\n".
"IMAP Auth: $imapauth\n".
"Oauth2 URI: $oauthuri\n".
"OAuth2 Client ID: $oauthclientid\n".
"DMARC Folders: \n".
" Reports: $imapdmarcfolder\n";
print " Processed: $imapdmarcproc\n" if defined($imapdmarcproc);
print " Error: $imapdmarcerr\n" if defined($imapdmarcerr);
print "TLS Folders: \n".
" Reports: $imaptlsfolder\n";
print " Processed: $imaptlsproc\n" if defined($imaptlsproc);
print " Error: $imaptlserr\n" if defined($imaptlserr);
print "----\n\n";
}
# Setup connection to database server.
our %dbx;
my $dbx_file = File::Basename::dirname($0) . "/dbx_$dbtype.pl";
my $dbx_return = do $dbx_file;
die "$scriptname: couldn't load DB definition for type $dbtype: $@" if $@;
die "$scriptname: couldn't load DB definition for type $dbtype: $!" unless defined $dbx_return;
my $dbh = DBI->connect("DBI:$dbitype:database=$dbname;host=$dbhost;port=$dbport",
$dbuser,
$dbpass)
or die "$scriptname: Cannot connect to database\n";
if ($db_tx_support) {
$dbh->{AutoCommit} = 0;
}
checkDatabase($dbh);
# Process messages based on $reports_source.
if ($reports_source == TS_IMAP) {
my $socketargs = '';
my $processedReport = 0;
# Disable verify mode for TLS support.
if ($imaptls == 1) {
if ( $tlsverify == 0 ) {
printDebug("use tls without verify servercert.");
$socketargs = [ SSL_verify_mode => SSL_VERIFY_NONE ];
}
else {
printDebug("use tls with verify servercert.");
$socketargs = [ SSL_verify_mode => SSL_VERIFY_PEER ];
}
# The whole point of setting this socket arg is so that we don't get the nasty warning
}
else {
printDebug("using ssl without verify servercert.");
$socketargs = [ SSL_verify_mode => SSL_VERIFY_NONE ];
}
printDebug("connection to $imapserver with Ssl => $imapssl, User => $imapuser, Ignoresizeerrors => $imapignoreerror");
# Setup connection to IMAP server.
my $imap = Mail::IMAPClient->new(
server => $imapserver,
port => $imapport,
ssl => $imapssl,
starttls => $imaptls,
debug => $debug,
socketargs => $socketargs
)
# module uses eval, so we use $@ instead of $!
or die "$scriptname: IMAP Failure: $@\n";
# This connection is finished this way because of the tradgedy of exchange...
if ($imapauth eq 'simple') {
printDebug("using simple auth");
$imap->User($imapuser);
$imap->Password($imappass);
$imap->connect();
}
elsif ($imapauth eq 'oauth2') {
printDebug("using oauth2");
# get the bearer token
my $oauth2token = OAuth::get_oauth($oauthuri, $oauthclientid, $dbh, $db_tx_support, $clear_token);
# authenticate
my $oauth_b64 = encode_base64("user=".$imapuser."\x01auth=Bearer ".$oauth2token."\x01\x01",'');
printDebug("AUTHENTICATE XOAUTH2 $oauth_b64\n---\noauth token: $oauth2token");
$imap->authenticate('XOAUTH2', sub { return $oauth_b64 })
or die "$scriptname: IMAP Failure: ".$imap->LastError."\n";
}
else {
die "$scriptname: unsupported authentication type\n";
}
# Ignore Size Errors due to issues with Exchange
$imap->Ignoresizeerrors($imapignoreerror);
# Set $imap to UID mode, which will force imap functions to use/return
# UIDs, instead of message sequence numbers. UIDs are not allowed to
# change during a session and are not allowed to be used twice. Looping
# over message sequence numbers and deleting a msg in between could have
# unwanted side effects.
$imap->Uid(1);
# How many msgs are we going to process?
printInfo("Processing ". $imap->message_count($imapdmarcfolder)." messages in folder <$imapdmarcfolder>.") if $dmarc_only >= 0;
printInfo("Processing ". $imap->message_count($imaptlsfolder)." messages in folder <$imaptlsfolder>.") if $dmarc_only <= 0;
# Only select and search $imapdmarcfolder, if we actually
# have something to do.
printDebug("report processing");
if ($imap->message_count($imapdmarcfolder) && $dmarc_only >= 0) {
$processedReport = processIMAP($imap, $processedReport, $imapdmarcfolder, $imapdmarcproc, $imapdmarcerr, 0);
}
if ($imap->message_count($imaptlsfolder) && $dmarc_only <= 0) {
$processedReport = processIMAP($imap, $processedReport, $imaptlsfolder, $imaptlsproc, $imaptlserr, 1);
}
# We're all done with IMAP here.
$imap->logout();
printInfo("Processed $processedReport emails.");
}
else { # TS_MESSAGE_FILE or TS_XML_FILE or TS_MBOX_FILE
my $counts = 0;
foreach my $a (@ARGV) {
# Linux bash supports wildcard expansion BEFORE the script is
# called, so here we only see a list of files. Other OS behave
# different, so we should not depend on that feature: Use glob
# on each argument to manually expand the argument, if possible.
my @file_list = glob($a);
foreach my $f (@file_list) {
my $filecontent;
if ($reports_source == TS_MBOX_FILE) {
my $parser = Mail::Mbox::MessageParser->new({"file_name" => $f, "debug" => $debug, "enable_cache" => 0});
my $num = 0;
do {
$num++;
$filecontent = $parser->read_next_email();
if (defined($filecontent)) {
if ($dmarc_only == 1) {
if (processXML(TS_MESSAGE_FILE, $filecontent, "message #$num of mbox file <$f>") & 2) {
# processXML return a value with delete bit enabled
warn "$scriptname: Removing message #$num from mbox file <$f> is not yet supported.\n";
}
}
else {
if (processJSON(TS_MESSAGE_FILE, $filecontent, "message #$num of mbox file <$f>") & 2) {
warn "$scriptname: Removing message #$num from mbox file <$f> is not yet supportd.\n";
}
}
$counts++;
}
} while(defined($filecontent));
}
elsif ($reports_source == TS_ZIP_FILE) {
# filecontent is zip file
if ($dmarc_only == 1) {
$filecontent = getXMLFromFile($f);
if (processXML(TS_ZIP_FILE, $filecontent, "xml file <$f>") & 2) {
# processXML return a value with delete bit enabled
unlink($f);
}
}
else {
$filecontent = getJSONFromFile($f);
if (processJSON(TS_ZIP_FILE, $filecontent, "xml file <$f>") & 2) {
unlink($f);
}
}
$counts++;
}
elsif (open(FILE, "<", $f)) {
$filecontent = join("", <FILE>);
close FILE;
if ($reports_source == TS_MESSAGE_FILE) {
# filecontent is a mime message with zip or xml part
if ($dmarc_only == 1) {
if (processXML(TS_MESSAGE_FILE, $filecontent, "message file <$f>") & 2) {
# processXML return a value with delete bit enabled
unlink($f);
}
}
else {
if (processJSON(TS_MESSAGE_FILE, $filecontent, "message file <$f>") & 2) {
unlink($f);
}
}
$counts++;
}
elsif ($reports_source == TS_XML_FILE) {
# filecontent is xml file
if (processXML(TS_XML_FILE, $filecontent, "xml file <$f>") & 2) {
# processXML return a value with delete bit enabled
unlink($f);
}
$counts++;
}
elsif ($reports_source == TS_JSON_FILE) {
# filecontent is json file
if (processJSON(TS_JSON_FILE, $filecontent, "json file <$f>") & 2) {
unlink($f);
}
$counts++;
}
else {
warn "$scriptname: Unknown reports_source <$reports_source> for file <$f>. Skipped.\n";
}
}
else {
warn "$scriptname: Could not open file <$f>: $!. Skipped.\n";
# Could not retrieve filecontent, the skipped message
# will be processed every time the script is run even if
# delete_reports and delete_failed is given. The user
# has to look at the actual file.
}
}
}
printInfo("$scriptname: Processed $counts messages(s).");
}
# -----------------------------------------------------------------------------
# subroutines
# -----------------------------------------------------------------------------
sub printDebug {
my $message = shift;
print "\n\n--- DEBUG ---\n".
" $message".
"\n-------------\n" if $debug;
}
# -----------------------------------------------------------------------------
sub printInfo {
my $message = shift;
print "\n\n--- DEBUG ---\n" if $debug;
print " $message\n" if $debug || $processInfo;
print "-------------\n" if $debug;
}
# -----------------------------------------------------------------------------
sub processIMAP {
my $imap = shift;
my $processedReport = shift;
my $imapfolder = shift;
my $imapproc = shift;
my $imaperr = shift;
my $type = shift;
printDebug("processing <$imapfolder>.");
# Select the mailbox to get messages from.
$imap->select($imapfolder)
or die "$scriptname: IMAP Select Error: $!";
# Store each message as an array element.
my @msgs = $imap->search('ALL')
or die "$scriptname: Couldn't get all messages\n";
# Loop through IMAP messages.
foreach my $msg (@msgs) {
my $processResult;
if ($type == 0) {
$processResult = processXML(TS_MESSAGE_FILE, $imap->message_string($msg), "IMAP message with UID #".$msg);
}
else {
$processResult = processJSON(TS_MESSAGE_FILE, $imap->message_string($msg), "IMAP message with UID #".$msg);
}
$processedReport++;
if ($processResult & 4) {
# processXML/JSON returned a value with database error bit enabled, do nothing at all!
if ($imaperr) {
# if we can, move to error folder
moveToImapFolder($imap, $msg, $imaperr);
}
else {
# do nothing at all
next;
}
}
elsif ($processResult & 2) {
# processXML/JSON return a value with delete bit enabled.
$imap->delete_message($msg)
or warn "$scriptname: Could not delete IMAP message. [$@]\n";
}
elsif ($imapproc) {
if ($processResult & 1 || !$imaperr) {
# processXML/JSON processed the XML OK, or it failed and there is no error imap folder
moveToImapFolder($imap, $msg, $imapproc);
}
elsif ($imaperr) {
# processXML/JSON failed and error folder set
moveToImapFolder($imap, $msg, $imaperr);
}
}
elsif ($imaperr && !($processResult & 1)) {
# processXML/JSON failed, error imap folder set, but imapdmarcproc unset. An unlikely setup, but still...
moveToImapFolder($imap, $msg, $imaperr);
}
}
# Expunge and close the folder.
$imap->expunge($imapfolder);
$imap->close($imapfolder);
return $processedReport;
}
# -----------------------------------------------------------------------------
sub moveToImapFolder {
my $imap = $_[0];
my $msg = $_[1];
my $imapfolder = $_[2];
print "Moving (copy and delete) IMAP message file to IMAP folder: $imapfolder\n" if $debug;
# Try to create $imapfolder, if it does not exist.
if (!$imap->exists($imapfolder)) {
$imap->create($imapfolder)
or warn "$scriptname: Could not create IMAP folder: $imapfolder.\n";
}
# Try to move the message to $imapfolder.
my $newid = $imap->copy($imapfolder, [ $msg ]);
if (!$newid) {
warn "$scriptname: Error on moving (copy and delete) processed IMAP message: Could not COPY message to IMAP folder: <$imapfolder>!\n";
warn "$scriptname: Messsage will not be moved/deleted. [$@]\n";
}
else {
$imap->delete_message($msg)
or do {
warn "$scriptname: Error on moving (copy and delete) processed IMAP message: Could not DELETE message\n";
warn "$scriptname: after copying it to <$imapfolder>. [$@]\n";
}
}
}
# -----------------------------------------------------------------------------
sub processXML {
my ($type, $filecontent, $f) = (@_);
if ($debug) {
print "\n";
print "----------------------------------------------------------------\n";
print "Processing $f \n";
print "----------------------------------------------------------------\n";
print "Type: $type\n";
print "FileContent: $filecontent\n";
print "MSG: $f\n";
print "----------------------------------------------------------------\n";
}
my $xml; #TS_XML_FILE or TS_MESSAGE_FILE
if ($type == TS_MESSAGE_FILE) {$xml = getXMLFromMessage($filecontent);}
elsif ($type == TS_ZIP_FILE) {$xml = $filecontent;}
else {$xml = getXMLFromXMLString($filecontent);}
# If !$xml, the file/mail is probably not a DMARC report.
# So do not storeXMLInDatabase.
if ($xml && storeXMLInDatabase($xml) <= 0) {
# If storeXMLInDatabase returns false, there was some sort
# of database storage failure and we MUST NOT delete the
# file, because it has not been pushed into the database.
# The user must investigate this issue.
warn "$scriptname: Skipping $f due to database errors.\n";
return 5; #xml ok(1), but database error(4), thus no delete (!2)
}
# Delete processed message, if the --delete option
# is given. Failed reports are only deleted, if delete_failed is given.
if ($delete_reports && ($xml || $delete_failed)) {
if ($xml) {
printDebug("Removing after report has been processed.");
return 3; #xml ok (1), delete file (2)
}
else {
# A mail which does not look like a DMARC report
# has been processed and should now be deleted.
# Print its content so it gets send as cron
# message, so the user can still investigate.
warn "$scriptname: The $f does not seem to contain a valid DMARC report. Skipped and Removed. Content:\n";
warn $filecontent."\n";
return 2; #xml not ok (!1), delete file (2)
}
}
if ($xml) {
return 1;
}
else {
warn "$scriptname: The $f does not seem to contain a valid DMARC report. Skipped.\n";
return 0;
}
}
# -----------------------------------------------------------------------------
# Walk through a mime message and return a reference to the XML data containing
# the fields of the first ZIPed XML file embedded into the message. The XML
# itself is not checked to be a valid DMARC report.
sub getXMLFromMessage {
printDebug("getting XML from message");
my ($message) = (@_);
# fixup type in trustwave SEG mails
$message =~ s/ContentType:/Content-Type:/;
my $parser = new MIME::Parser;
$parser->output_dir("/tmp");
$parser->filer->ignore_filename(1);
my $ent = $parser->parse_data($message);
my $body = $ent->bodyhandle;
my $mtype = $ent->mime_type;
my $subj = decode_mimewords($ent->get('subject'));
chomp($subj); # Subject always contains a \n.
printDebug("Subject: $subj\n".
" MimeType: $mtype");
my $location;
my $isgzip = 0;
if(lc $mtype eq "application/zip") {
printDebug("This is a ZIP file");
$location = $body->path;
}
elsif (lc $mtype eq "application/gzip" or lc $mtype eq "application/x-gzip") {
printDebug("This is a GZIP file");
$location = $body->path;
$isgzip = 1;
}
elsif (lc $mtype =~ "multipart/") {
# At the moment, nease.net messages are multi-part, so we need
# to breakdown the attachments and find the zip.
printDebug("This is a multipart attachment");
#print Dumper($ent->parts);
my $num_parts = $ent->parts;
for (my $i=0; $i < $num_parts; $i++) {
my $part = $ent->parts($i);
# Find a zip file to work on...
if(lc $part->mime_type eq "application/gzip" or lc $part->mime_type eq "application/x-gzip") {
$location = $ent->parts($i)->{ME_Bodyhandle}->{MB_Path};
$isgzip = 1;
printDebug("$location");
last; # of parts
}
elsif(lc $part->mime_type eq "application/x-zip-compressed"
or $part->mime_type eq "application/zip") {
$location = $ent->parts($i)->{ME_Bodyhandle}->{MB_Path};
printDebug("$location");
}
elsif(lc $part->mime_type eq "application/octet-stream") {
$location = $ent->parts($i)->{ME_Bodyhandle}->{MB_Path};
$isgzip = 1 if $location =~ /\.gz$/;
printDebug("$location");
}
else {
# Skip the attachment otherwise.
printDebug("Skipped an unknown attachment (".lc $part->mime_type.")");
next; # of parts
}
}
}
else {
## Clean up dangling mime parts in /tmp of messages without ZIP.
my $num_parts = $ent->parts;
for (my $i=0; $i < $num_parts; $i++) {
if ($debug) {
if ($ent->parts($i)->{ME_Bodyhandle} && $ent->parts($i)->{ME_Bodyhandle}->{MB_Path}) {
printDebug($ent->parts($i)->{ME_Bodyhandle}->{MB_Path});
}
else {
printDebug("undef");
}
}
if($ent->parts($i)->{ME_Bodyhandle}) {$ent->parts($i)->{ME_Bodyhandle}->purge;}
}
}
# If a ZIP has been found, extract XML and parse it.
my $xml;
printDebug("body is in " . $location) if defined($location);
$xml = getXMLFromZip($location,$isgzip);
if($body) {$body->purge;}
if($ent) {$ent->purge;}
return $xml;
}
# -----------------------------------------------------------------------------
sub getXMLFromFile { my $filename = $_[0];
printDebug("getting XML from file");
my $mtype = mimetype($filename);
if ($debug) {
print "Filename: $filename, MimeType: $mtype\n";
}
my $isgzip = 0;
if(lc $mtype eq "application/zip") {
if ($debug) {
print "This is a ZIP file \n";
}
}
elsif (lc $mtype eq "application/gzip" or lc $mtype eq "application/x-gzip") {
if ($debug) {
print "This is a GZIP file \n";
}
$isgzip = 1;
}
else {
if ($debug) {
print "This is not an archive file \n";
}
}
# If a ZIP has been found, extract XML and parse it.
my $xml = getXMLFromZip($filename,$isgzip);
return $xml;
}
# -----------------------------------------------------------------------------
sub getXMLFromZip {
printDebug("getting XML from ZIP");
my $filename = shift;
my $isgzip = shift;
my $xml;
if (defined($filename)) {
# Open the zip file and process the XML contained inside.
my $unzip = "";
if ($isgzip) {
open(XML, "<:gzip", $filename)
or $unzip = "gzip";
# check to see if the mimetype was incorrectly set to gzip *cough mimecast*
if ($unzip eq "gzip") {
printDebug("gzip failed, checking if incorrect mime type");
# incorrect mimetype with incorrect file extension seems to manifest as a .dat
# so let's check for that
my $ext = '';
if ($filename =~ /\.([^.]+)$/) {
print "extension: $1" if $debug;
$ext = $1;
}
else {
warn "$scriptname: Could not find extension for (<$filename>)! \n";
}
# if it's a dat file, then run this process again, but with $isgzip set to 0
if ($ext eq "dat") {
printDebug("Trying again using unzip");
$xml = getXMLFromZip($filename,0);
# if it fails again, it'll warn, if not, it'll return the correct xml
return $xml;
}
}
}
else {
open(XML, "-|", "unzip", "-p", $filename)
or $unzip = "unzip"; # Will never happen.
# Sadly unzip -p never fails, but we can check if the
# filehandle points to an empty file and pretend it did
# not open/failed.
if (eof XML) {
$unzip = "unzip";
}
}
# Read XML if possible (if open)
if ($unzip eq "") {
$xml = getXMLFromXMLString(join("", <XML>));
if (!$xml) {
warn "$scriptname: The XML found in ZIP file (<$filename>) does not seem to be valid XML! \n";
}
close XML;
}
else {
warn "$scriptname: Failed to $unzip ZIP file (<$filename>)! \n";
close XML;
}
}
else {
warn "$scriptname: Could not find an <$filename>! \n";
}
return $xml;
}
# -----------------------------------------------------------------------------
sub getXMLFromXMLString {
printDebug("getting XML from string");
my $raw_xml = $_[0];
eval {
my $xs = XML::Simple->new();
my $ref = $xs->XMLin($raw_xml, SuppressEmpty => '');
$ref->{'raw_xml'} = $raw_xml;
return $ref;
}
or do {
return undef;
}
}
# -----------------------------------------------------------------------------
# Extract fields from the XML report data hash and store them into the database.
# return 1 when ok, 0, for serious error and -1 for minor errors
sub storeXMLInDatabase {
printDebug("storing XML in database");
my $xml = $_[0]; # $xml is a reference to the xml data
my $from = $xml->{'report_metadata'}->{'date_range'}->{'begin'};
my $to = $xml->{'report_metadata'}->{'date_range'}->{'end'};
my $org = $xml->{'report_metadata'}->{'org_name'};
my $id = $xml->{'report_metadata'}->{'report_id'};
my $email = $xml->{'report_metadata'}->{'email'};
my $extra = $xml->{'report_metadata'}->{'extra_contact_info'};
my $domain = undef;
my $policy_adkim = undef;
my $policy_aspf = undef;
my $policy_p = undef;
my $policy_sp = undef;
my $policy_pct = undef;
if (ref $xml->{'policy_published'} eq "HASH") {
$domain = $xml->{'policy_published'}->{'domain'};