forked from sympa-community/sympa
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathMessage.pm
4618 lines (3776 loc) · 137 KB
/
Message.pm
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
# -*- indent-tabs-mode: nil; -*-
# vim:ft=perl:et:sw=4
# Sympa - SYsteme de Multi-Postage Automatique
#
# Copyright (c) 1997, 1998, 1999 Institut Pasteur & Christophe Wolfhugel
# Copyright (c) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
# 2006, 2007, 2008, 2009, 2010, 2011 Comite Reseau des Universites
# Copyright (c) 2011, 2012, 2013, 2014, 2015, 2016, 2017 GIP RENATER
# Copyright 2017, 2018, 2019, 2020, 2021, 2022 The Sympa Community. See the
# AUTHORS.md file at the top-level directory of this distribution and at
# <https://github.com/sympa-community/sympa.git>.
#
# This program 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 2 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 <http://www.gnu.org/licenses/>.
package Sympa::Message;
use strict;
use warnings;
use DateTime;
use Encode qw();
use English; # FIXME: drop $PREMATCH usage
use File::Path qw();
use HTML::TreeBuilder;
use Mail::Address;
use MIME::Charset;
use MIME::EncWords;
use MIME::Entity;
use MIME::Field::ParamVal;
use MIME::Parser;
use MIME::Tools;
use Scalar::Util qw();
use Text::LineFold;
use URI::Escape qw();
BEGIN { eval 'use Crypt::SMIME'; }
BEGIN { eval 'use Net::DNS'; }
use Sympa;
use Conf;
use Sympa::Constants;
use Sympa::HTML::FormatText;
use Sympa::HTMLSanitizer;
use Sympa::Language;
use Sympa::Log;
use Sympa::Scenario;
use Sympa::Spool;
use Sympa::Template;
use Sympa::Tools::Data;
use Sympa::Tools::File;
use Sympa::Tools::Password;
use Sympa::Tools::SMIME;
use Sympa::Tools::Text;
use Sympa::User;
my $language = Sympa::Language->instance;
my $log = Sympa::Log->instance;
sub new {
$log->syslog('debug2', '(%s, ...)', @_);
my $class = shift;
my $serialized = shift;
my $self = bless {@_} => $class;
unless (defined $serialized and length $serialized) {
$log->syslog('err', 'Empty message');
return undef;
}
# Get attributes from pseudo-header fields at the top of serialized
# message. Note that field names are case-sensitive.
pos($serialized) = 0;
while ($serialized =~ /\G(X-Sympa-[-\w]+): (.*?)\n(?![ \t])/cgs) {
my ($k, $v) = ($1, $2);
next unless length $v;
if ($k eq 'X-Sympa-To') {
$self->{'rcpt'} = join ',', split(/\s*,\s*/, $v);
} elsif ($k eq 'X-Sympa-Checksum') { # To migrate format <= 6.2a.40
$self->{'checksum'} = $v;
} elsif ($k eq 'X-Sympa-Family') {
$self->{'family'} = $v;
} elsif ($k eq 'X-Sympa-From') { # Compatibility. Use Return-Path:
$self->{'envelope_sender'} = $v;
} elsif ($k eq 'X-Sympa-Auth-Level') { # New in 6.2a.41
if ($v eq 'md5') {
$self->{'md5_check'} = 1;
} else {
$log->syslog('err',
'Unknown authentication level "%s", ignored', $v);
}
} elsif ($k eq 'X-Sympa-Message-ID') { # New in 6.2a.41
$self->{'message_id'} = $v;
} elsif ($k eq 'X-Sympa-Sender') { # New in 6.2a.41
$self->{'sender'} = $v;
} elsif ($k eq 'X-Sympa-Display-Name') { # New in 6.2a.41
$self->{'gecos'} = $v;
} elsif ($k eq 'X-Sympa-Shelved') { # New in 6.2a.41
$self->{'shelved'} = {
map {
my ($ak, $av) = split /=/, $_, 2;
($ak => ($av || 1))
} split(/\s*;\s*/, $v)
};
} elsif ($k eq 'X-Sympa-Spam-Status') { # New in 6.2a.41
$self->{'spam_status'} = $v;
} else {
$log->syslog('err', 'Unknown attribute information: "%s: %s"',
$k, $v);
}
}
# Ignore Unix From_
$serialized =~ /\GFrom (.*?)\n(?![ \t])/cgs;
# Get envelope sender from Return-Path:.
# If old style X-Sympa-From: has been found, omit Return-Path:.
#
# We trust in "Return-Path:" header field only at the top of message
# to prevent forgery. See CAVEAT.
# N.B. Exim uses "Return-path:". The others use "Return-Path:".
if ($serialized =~ /\GReturn-[Pp]ath: (.*?)\n(?![ \t])/cgs
and not exists $self->{'envelope_sender'}) {
my $addr = $1;
if ($addr =~ /<>/) { # special: null envelope sender
$self->{'envelope_sender'} = '<>';
} elsif ($addr =~ /<MAILER-DAEMON>/) {
# Same as above, but a workaround for pipe(8) of Postfix 2.3+.
$self->{'envelope_sender'} = '<>';
} else {
my @addrs = Mail::Address->parse($addr);
if (@addrs
and Sympa::Tools::Text::valid_email($addrs[0]->address)) {
$self->{'envelope_sender'} = $addrs[0]->address;
}
}
}
# Strip attributes.
substr($serialized, 0, pos $serialized) = '';
# Check if message is parsable.
my $parser = MIME::Parser->new;
$parser->output_to_core(1);
$parser->tmp_dir($Conf::Conf{'tmpdir'});
my $entity = $parser->parse_data(\$serialized);
unless ($entity) {
$log->syslog('err', 'Unable to parse message');
return undef;
}
my $hdr = $entity->head;
my ($dummy, $body_string) = split /(?:\A|\n)\r?\n/, $serialized, 2;
$self->{_head} = $hdr;
$self->{_body} = $body_string;
$self->{_entity_cache} = $entity;
$self->{'size'} = length $serialized;
unless (exists $self->{'sender'} and defined $self->{'sender'}) {
($self->{'sender'}, $self->{'gecos'}) = $self->_get_sender_email;
}
## Store decoded subject and its original charset
my $subject = $hdr->get('Subject');
if (defined $subject and $subject =~ /\S/) {
my @decoded_subject = MIME::EncWords::decode_mimewords($subject);
$self->{'subject_charset'} = 'US-ASCII';
foreach my $token (@decoded_subject) {
unless ($token->[1]) {
# don't decode header including raw 8-bit bytes.
if ($token->[0] =~ /[^\x00-\x7F]/) {
$self->{'subject_charset'} = undef;
last;
}
next;
}
my $cset = MIME::Charset->new($token->[1]);
# don't decode header encoded with unknown charset.
unless ($cset->decoder) {
$self->{'subject_charset'} = undef;
last;
}
unless ($cset->output_charset eq 'US-ASCII') {
$self->{'subject_charset'} = $token->[1];
}
}
} else {
$self->{'subject_charset'} = undef;
}
if ($self->{'subject_charset'}) {
chomp $subject;
$self->{'decoded_subject'} =
MIME::EncWords::decode_mimewords($subject, Charset => 'UTF-8');
} else {
if (defined $subject) {
chomp $subject;
$subject =~ s/(\r\n|\r|\n)(?=[ \t])//g;
$subject =~ s/\r\n|\r|\n/ /g;
}
$self->{'decoded_subject'} = $subject;
}
## TOPICS
my $topics;
if ($topics = $hdr->get('X-Sympa-Topic')) {
$self->{'topic'} = $topics;
}
# Message ID
unless (exists $self->{'message_id'}) {
$self->{'message_id'} = _get_message_id($self);
}
return $self;
}
# Tentative: removed when refactoring finished.
sub new_from_file {
my $class = shift;
my $file = shift;
open my $fh, '<', $file or return undef;
my $serialized = do { local $RS; <$fh> };
close $fh;
my $self = $class->new($serialized, @_)
or return undef;
$self->{'filename'} = $file;
# Get file date
unless (exists $self->{'date'}) {
$self->{'date'} = Sympa::Tools::File::get_mtime($file);
}
return $self;
}
## Get sender of the message according to header fields specified by
## 'sender_headers' parameter.
## FIXME: S/MIME signer may not be same as the sender given by this function.
sub _get_sender_email {
my $self = shift;
my $hdr = $self->{_head};
my $sender = undef;
my $gecos = undef;
foreach my $field (split /[\s,]+/, $Conf::Conf{'sender_headers'}) {
if (lc $field eq 'return-path') {
## Try to get envelope sender
if ( $self->{'envelope_sender'}
and $self->{'envelope_sender'} ne '<>') {
$sender = Sympa::Tools::Text::canonic_email(
$self->{'envelope_sender'});
}
} elsif ($hdr->get($field)) {
## Try to get message header.
## On "Resent-*:" headers, the first occurrence must be used (see
## RFC 5322 3.6.6).
## FIXME: Though "From:" can occur multiple times, only the first
## one is detected.
my $addr = $hdr->get($field, 0); # get the first one
my @sender_hdr = Mail::Address->parse($addr);
if (@sender_hdr and $sender_hdr[0]->address) {
$sender = Sympa::Tools::Text::canonic_email(
$sender_hdr[0]->address);
my $phrase = $sender_hdr[0]->phrase;
if (defined $phrase and length $phrase) {
$gecos = MIME::EncWords::decode_mimewords($phrase,
Charset => 'UTF-8');
# Eliminate hostile characters.
$gecos =~ s/(\r\n|\r|\n)(?=[ \t])//g;
$gecos =~ s/[\0\r\n]+//g;
}
last;
}
}
last if defined $sender;
}
unless (defined $sender) {
#$log->syslog('debug3', 'No valid sender address');
return;
}
unless (Sympa::Tools::Text::valid_email($sender)) {
$log->syslog('err', 'Invalid sender address "%s"', $sender);
return;
}
return ($sender, $gecos);
}
# Note that this must be called after decrypting message
# FIXME: Also check Resent-Message-ID:.
sub _get_message_id {
my $self = shift;
return Sympa::Tools::Text::canonic_message_id(
$self->{_head}->get('Message-Id', 0));
}
# Old names: (part of) mail::mail_file(), mail::parse_tt2_messageasstring(),
# List::send_file(), List::send_global_file().
# Moved to: Sympa::Message::Template::new().
#sub new_from_template;
sub dup {
my $self = shift;
my $clone = {};
foreach my $key (sort keys %$self) {
my $val = $self->{$key};
next unless defined $val;
unless (Scalar::Util::blessed($val)) {
$clone->{$key} = Sympa::Tools::Data::dup_var($val);
} elsif ($val->can('dup') and !$val->isa('Sympa::List')) {
$clone->{$key} = $val->dup;
} else {
$clone->{$key} = $val;
}
}
return bless $clone => ref($self);
}
sub to_string {
my $self = shift;
my %options = @_;
my $serialized = '';
if (ref $self->{'rcpt'} eq 'ARRAY' and @{$self->{'rcpt'}}) {
$serialized .= sprintf "X-Sympa-To: %s\n",
join(',', @{$self->{'rcpt'}});
} elsif (defined $self->{'rcpt'} and length $self->{'rcpt'}) {
$serialized .= sprintf "X-Sympa-To: %s\n",
join(',', split(/\s*,\s*/, $self->{'rcpt'}));
}
if (defined $self->{'checksum'}) {
$serialized .= sprintf "X-Sympa-Checksum: %s\n", $self->{'checksum'};
}
if (defined $self->{'family'}) {
$serialized .= sprintf "X-Sympa-Family: %s\n", $self->{'family'};
}
if (defined $self->{'md5_check'}
and length $self->{'md5_check'}) { # New in 6.2a.41
$serialized .= sprintf "X-Sympa-Auth-Level: %s\n", 'md5';
}
if (defined $self->{'message_id'}) { # New in 6.2a.41
$serialized .= sprintf "X-Sympa-Message-ID: %s\n",
$self->{'message_id'};
}
if (defined $self->{'sender'}) { # New in 6.2a.41
$serialized .= sprintf "X-Sympa-Sender: %s\n", $self->{'sender'};
}
if (defined $self->{'gecos'}
and length $self->{'gecos'}) { # New in 6.2a.41
$serialized .= sprintf "X-Sympa-Display-Name: %s\n", $self->{'gecos'};
}
if (%{$self->{'shelved'} || {}}) { # New in 6.2a.41
$serialized .= sprintf "X-Sympa-Shelved: %s\n", join(
'; ',
map {
my $v = $self->{shelved}{$_};
("$v" eq '1') ? $_ : sprintf('%s=%s', $_, $v);
}
grep {
$self->{shelved}{$_}
} sort keys %{$self->{shelved}}
);
}
if (defined $self->{'spam_status'}) { # New in 6.2a.41.
$serialized .= sprintf "X-Sympa-Spam-Status: %s\n",
$self->{'spam_status'};
}
# This terminates pseudo-header part for attributes.
unless (defined $self->{'envelope_sender'}) {
$serialized .= "Return-Path: \n";
}
$serialized .= $self->as_string(%options);
return $serialized;
}
sub add_header {
my $self = shift;
$self->{_head}->add(@_);
delete $self->{_entity_cache}; # Clear entity cache.
}
sub delete_header {
my $self = shift;
$self->{_head}->delete(@_);
delete $self->{_entity_cache}; # Clear entity cache.
}
sub replace_header {
my $self = shift;
$self->{_head}->replace(@_);
delete $self->{_entity_cache}; # Clear entity cache.
}
sub head {
shift->{_head};
}
# NOTE: As this processes is needed for incoming messages only, it would be
# moved to incoming pipeline class..
sub check_spam_status {
my $self = shift;
my $robot_id =
(ref $self->{context} eq 'Sympa::List')
? $self->{context}->{'domain'}
: $self->{context};
my $spam_status =
Sympa::Scenario->new($robot_id, 'spam_status')
->authz('smtp', {'message' => $self});
if (defined $spam_status) {
if (ref($spam_status) eq 'HASH') {
$self->{'spam_status'} = $spam_status->{'action'};
} else {
$self->{'spam_status'} = $spam_status;
}
} else {
$self->{'spam_status'} = 'unknown';
}
}
BEGIN {
eval 'use Mail::DKIM::Signer';
eval 'use Mail::DKIM::ARC::Signer';
eval 'use Mail::DKIM::TextWrap'; # This doesn't export $VERSION.
}
# Old name: tools::dkim_sign() which took string and returned string.
sub dkim_sign {
$log->syslog('debug', '(%s)', @_);
my $self = shift;
my %options = @_;
return undef unless $Mail::DKIM::Signer::VERSION;
die 'bug in logic. Ask developer'
unless $options{s}
and $options{key}
and $options{d};
my $dkim = Mail::DKIM::Signer->new(
Algorithm => 'rsa-sha256',
Method => 'relaxed',
Domain => $options{d},
Selector => $options{s},
Key => $options{key},
($options{i} ? (Identity => $options{i}) : ()),
);
unless ($dkim) {
$log->syslog('err', 'Can\'t create Mail::DKIM::Signer');
return undef;
}
# For One-Click Unsubscribe.
$dkim->extended_headers({'List-Unsubscribe-Post' => '*'});
# $new_body will store the body as fed to Mail::DKIM to reuse it
# when returning the message as string. Line terminators must be
# normalized with CRLF.
my $msg_as_string = $self->as_string;
$msg_as_string =~ s/\r?\n/\r\n/g;
$msg_as_string =~ s/\r?\z/\r\n/ unless $msg_as_string =~ /\n\z/;
$dkim->PRINT($msg_as_string);
unless ($dkim->CLOSE) {
$log->syslog('err', 'Cannot sign (DKIM) message');
return undef;
}
my ($dummy, $new_body) = split /\r\n\r\n/, $msg_as_string, 2;
$new_body =~ s/\r\n/\n/g;
# Mail::DKIM::Signer wraps DKIM-Signature with with \r\n\t; this
# is the hardcoded Separator passed to Mail::DKIM::TextWrap via
# Mail::DKIM::KeyValueList. MIME::Tools on the other hand
# (MIME::Head::stringify() in particular) encode EOL as plain \n;
# so it is necessary to normalize CRLF->LF for DKIM-Signature to
# avoid confusing the mail agent.
my $dkim_signature = $dkim->signature->as_string;
$dkim_signature =~ s/\r\n/\n/g;
# Signing is done. Rebuilding message as string with original body
# and new headers.
# Note that DKIM-Signature: field should be prepended to the header.
$self->add_header('DKIM-Signature', $dkim_signature, 0);
$self->{_body} = $new_body;
delete $self->{_entity_cache}; # Clear entity cache.
return $self;
}
sub arc_seal {
$log->syslog('debug2', '(%s)', @_);
my $self = shift;
my %options = @_;
return undef unless $Mail::DKIM::ARC::Signer::VERSION;
die 'bug in logic. Ask developer'
unless $options{s}
and $options{key}
and $options{d}
and $options{cv}
and grep { $options{cv} eq $_ } qw(none pass fail);
my $arc = Mail::DKIM::ARC::Signer->new(
Algorithm => 'rsa-sha256',
Chain => $options{cv},
SrvId => $options{authserv_id},
Domain => $options{d},
Selector => $options{s},
Key => $options{key},
);
unless ($arc) {
$log->syslog('err', 'Can\'t create Mail::DKIM::ARC::Signer');
return undef;
}
$arc->extended_headers(
{
# For any DKIM signature(s). See RFC 8617, 4.1.2.
'DKIM-Signature' => '*',
# For One-Click Unsubscribe.
'List-Unsubscribe-Post' => '*',
}
);
# $new_body will store the body as fed to Mail::DKIM to reuse it
# when returning the message as string. Line terminators must be
# normalized with CRLF.
my $msg_as_string = $self->as_string;
$msg_as_string =~ s/\r?\n/\r\n/g;
$msg_as_string =~ s/\r?\z/\r\n/ unless $msg_as_string =~ /\n\z/;
unless (eval { $arc->PRINT($msg_as_string) and $arc->CLOSE }) {
$log->syslog('err', 'Cannot ARC seal message: %s', $EVAL_ERROR);
return undef;
}
unless ($arc->{result} eq 'sealed') {
$log->syslog('info', 'ARC %s: %s', $arc->{result}, $arc->{details});
return 0;
}
my ($dummy, $new_body) = split /\r\n\r\n/, $msg_as_string, 2;
$new_body =~ s/\r\n/\n/g;
# Normalize CRLF->LF for ARC header fields to avoid confusing the
# mail agent. See also the comment in dkim_sign().
my @seal = map {s/\r\n/\n/gr} grep {defined} $arc->as_strings;
# Seal is done. Rebuilding message as string with original body
# and new headers.
# Note that ARC-*: fields should be prepended to the header.
foreach my $ahdr (reverse @seal) {
my ($ah, $av) = split /:\s*/, $ahdr, 2;
$self->add_header($ah, $av, 0);
}
$self->{_body} = $new_body;
delete $self->{_entity_cache}; # Clear entity cache.
return 1;
}
BEGIN {
eval 'use Mail::AuthenticationResults::Parser';
eval 'use Mail::DKIM::ARC::Verifier';
eval 'use Mail::DKIM::Verifier';
}
# Old name: Sympa::Message::check_dkim_signature() which adds {dkim_pass} item.
sub check_dkim_sigs {
my $self = shift;
return unless $Mail::DKIM::Verifier::VERSION;
my $robot_id =
(ref $self->{context} eq 'Sympa::List') ? $self->{context}->{'domain'}
: (ref $self->{context} eq 'Sympa::Family')
? $self->{context}->{'domain'}
: $self->{context};
return
unless Sympa::Tools::Data::smart_eq(
Conf::get_robot_conf($robot_id || '*', 'dkim_feature'), 'on');
my $dkim;
unless ($dkim = Mail::DKIM::Verifier->new()) {
$log->syslog('err', 'Could not create Mail::DKIM::Verifier');
return;
}
# Line terminators must be normalized with CRLF.
my $msg_as_string = $self->as_string;
$msg_as_string =~ s/\r?\n/\r\n/g;
$msg_as_string =~ s/\r?\z/\r\n/ unless $msg_as_string =~ /\n\z/;
$dkim->PRINT($msg_as_string);
unless ($dkim->CLOSE) {
$log->syslog('err', 'Cannot verify signature of (DKIM) message');
return;
}
my ($dkim_pass, @entries);
foreach my $signature (grep { $_->result ne 'none' } $dkim->signatures) {
#FIXME: Identity of signatures would be checked.
$dkim_pass = 1 if $signature->result eq 'pass';
next if $signature->isa('Mail::DKIM::DkSignature'); # Skip domainkeys
$log->syslog(
'info', 'DKIM %s; d=%s; i=%s; s=%s',
$signature->result_detail, $signature->get_tag('d'),
$signature->get_tag('i'), $signature->get_tag('s')
) if $signature->result eq 'invalid';
# Map results by Mail::DKIM::Verifier to those defined by RFC 8601.
my $result = {
pass => 'pass',
fail => 'fail',
invalid => 'neutral',
temperror => 'temperror',
none => 'none',
}->{$signature->result // 'pass'} // 'permerror';
my $detail = $1 if $signature->result_detail =~ /\w+ [(](.*)[)]/;
my $key_info = do {
local $SIG{__DIE__};
eval {
sprintf '%s-bit %s key %s',
$signature->get_public_key->size,
$signature->get_public_key->type,
$signature->hash_algorithm;
}
};
push(
@entries,
{ 'dkim' => {
_ => $result,
_comment => join(', ', grep {$_} ($detail, $key_info)),
#FIXME:Internationalized domains should be ACE-encoded.
'header.d' => {_ => $signature->domain},
#FIXME:"i=" tag should be checked if encoded correctly.
'header.i' => {_ => $signature->get_tag('i')},
'header.b' => {_ => (substr $signature->data, 0, 8)},
'header.a' => {_ => $signature->algorithm},
'header.s' => {_ => $signature->selector},
}
}
);
}
return ($dkim_pass, @entries);
}
my @ar_props = qw(header.d header.i header.b header.a header.s);
sub aggregate_authentication_results {
my $self = shift;
my $srvid;
my $that = $self->{context};
if (ref $that eq 'Sympa::List') {
$srvid =
Conf::get_robot_conf($that->{'domain'}, 'arc_srvid')
|| $that->{'admin'}{'arc_parameters'}{'signer_domain'}
|| $that->{'admin'}{'dkim_parameters'}{'signer_domain'};
} else {
$srvid = Conf::get_robot_conf($that || '*', 'arc_srvid')
|| Conf::get_robot_conf($that || '*',
'arc_parameters.signer_domain')
|| Conf::get_robot_conf($that || '*',
'dkim_parameters.signer_domain');
}
my ($arc_cv, $dkim_pass) = $self->_scan_authentication_results($srvid)
if $srvid;
# If there are no useful Authentication-Results fields, add it by
# ourselves.
my @entinfos;
if (defined $arc_cv) {
$self->{shelved}{arc_cv} = $arc_cv;
} else {
($self->{shelved}{arc_cv}, my @eis) = $self->check_arc_seals;
push @entinfos, @eis;
}
if (defined $dkim_pass) {
$self->{dkim_pass} = $dkim_pass;
} else {
($self->{dkim_pass}, my @eis) = $self->check_dkim_sigs;
push @entinfos, @eis;
}
return unless $srvid;
# Compute entries of AR
unless (@entinfos) {
# Make sure that at least one AR including arc entry exists.
return if defined $arc_cv;
@entinfos = ({arc => {_ => 'none'}});
}
my $authres = Mail::AuthenticationResults::Header->new()->set_eol("\n")
->set_fold_at(77);
my $value = Mail::AuthenticationResults::Header::AuthServID->new()
->safe_set_value($srvid);
$value->add_child(Mail::AuthenticationResults::Header::Comment->new()
->safe_set_value('Sympa'));
$authres->set_value($value);
foreach my $entinfo (@entinfos) {
foreach my $key (sort keys %$entinfo) {
next unless length($entinfo->{$key}{_} // '');
my $entry = Mail::AuthenticationResults::Header::Entry->new()
->set_key($key)->safe_set_value($entinfo->{$key}{_});
$entry->add_child(
Mail::AuthenticationResults::Header::Comment->new()
->safe_set_value($entinfo->{$key}{_comment}))
if length($entinfo->{$key}{_comment} // '');
foreach my $subkey (grep { $entinfo->{$key}{$_} } @ar_props) {
next unless length($entinfo->{$key}{$subkey}{_} // '');
my $subentry =
Mail::AuthenticationResults::Header::SubEntry->new()
->set_key($subkey)
->safe_set_value($entinfo->{$key}{$subkey}{_});
$subentry->add_child(
Mail::AuthenticationResults::Header::Comment->new()
->safe_set_value($entinfo->{$key}{$subkey}{_comment}))
if length($entinfo->{$key}{$subkey}{_comment} // '');
$entry->add_child($subentry);
}
$authres->add_child($entry);
}
}
# Insert new AR at the top but not before the "Received:" field at first.
$self->add_header('Authentication-Results', $authres->as_string,
($self->header_as_string =~ /\AReceived:/i) ? 1 : 0);
}
sub _scan_authentication_results {
my $self = shift;
my $srvid = shift;
# Already checked?
my ($arc_cv, @dkim_results);
foreach my $field (split /\n(?![ \t])/, $self->header_as_string) {
if ($field =~ /\AARC-/i) {
# ARC field found before useful AR.
last;
} elsif ($field =~ /\AAuthentication-Results\s*:\s*(.*)\z/is) {
my $ar =
eval { Mail::AuthenticationResults::Parser->new->parse($1) };
unless ($ar) {
$log->syslog('info',
'Bad Authentication-Results field, ignore it: %s',
$EVAL_ERROR);
next;
}
next unless $ar->value->value eq $srvid;
($arc_cv) = map { lc $_->value } grep {
$_->key eq 'arc'
and ($_->value // '') =~ /\A(pass|fail|none)\z/i
} @{$ar->children // []}
unless $arc_cv;
push @dkim_results, map { lc $_->value } grep {
my $entry = $_;
$entry->key eq 'dkim'
and grep { lc($entry->value // '') eq $_ }
qw(fail neutral none pass permerror policy temperror)
} @{$ar->children // []};
}
}
my $dkim_pass = (grep { $_ eq 'pass' } @dkim_results) ? 1 : 0
if @dkim_results;
return ($arc_cv, $dkim_pass);
}
# Old name: Sympa::Message::check_arc_chain() which adds {arc_cv} item.
sub check_arc_seals {
my $self = shift;
return unless $Mail::DKIM::ARC::Verifier::VERSION;
my $arc;
unless ($arc = Mail::DKIM::ARC::Verifier->new(Strict => 1)) {
$log->syslog('err', 'Could not create Mail::DKIM::ARC::Verifier');
return;
}
# Line terminators must be normalized with CRLF.
my $msg_as_string = $self->as_string;
$msg_as_string =~ s/\r?\n/\r\n/g;
$msg_as_string =~ s/\r?\z/\r\n/ unless $msg_as_string =~ /\n\z/;
unless (eval { $arc->PRINT($msg_as_string) and $arc->CLOSE }) {
$log->syslog('err', 'Cannot verify chain of (ARC) message: %s',
$EVAL_ERROR);
return;
}
if (grep { $arc->result eq $_ } qw(pass fail none)) {
my $detail = $1 if $arc->result_detail =~ /\w+ [(](.*)[)]/;
return (
$arc->result,
{ arc => {
_ => $arc->result,
_comment => $detail,
},
}
);
} else {
$log->syslog('info', 'ARC %s', $arc->result_detail);
return;
}
}
# Old name: tools::remove_invalid_dkim_signature() which takes a message as
# string and outputs idem without signature if invalid.
sub remove_invalid_dkim_signature {
$log->syslog('debug2', '(%s)', @_);
my $self = shift;
return unless $self->get_header('DKIM-Signature');
my ($dkim_pass, @dummy) = $self->check_dkim_sigs;
unless ($dkim_pass) {
$log->syslog('info',
'DKIM signature of message %s is invalid, removing', $self);
$self->delete_header('DKIM-Signature');
delete $self->{dkim_pass};
}
}
sub as_entity {
my $self = shift;
unless (defined $self->{_entity_cache}) {
die 'Bug in logic. Ask developer' unless $self->{_head};
my $string =
$self->{_head}->as_string . "\n"
. (defined $self->{_body} ? $self->{_body} : '');
my $parser = MIME::Parser->new();
$parser->output_to_core(1);
$parser->tmp_dir($Conf::Conf{'tmpdir'});
$self->{_entity_cache} = $parser->parse_data(\$string);
}
return $self->{_entity_cache};
}
sub set_entity {
my $self = shift;
my $entity = shift;
return undef unless $entity;
my $orig = $self->as_entity->as_string;
my $new = $entity->as_string;
if ($orig ne $new) {
$self->{_head} = $entity->head;
$self->{_body} = $entity->body_as_string;
$self->{_entity_cache} = $entity; # Also update entity cache.
}
return $entity;
}
sub as_string {
my $self = shift;
my %options = @_;
die 'Bug in logic. Ask developer' unless $self->{_head};
return $self->{'orig_msg_as_string'}
if $options{'original'} and $self->{'smime_crypted'};
my $return_path = '';
if (defined $self->{'envelope_sender'}) {
my $val = $self->{'envelope_sender'};
$val = "<$val>" unless $val eq '<>';
$return_path = sprintf "Return-Path: %s\n", $val;
}
return
$return_path
. $self->{_head}->as_string . "\n"
. (defined $self->{_body} ? $self->{_body} : '');
}
sub body_as_string {
my $self = shift;
return $self->{_body};
}
sub header_as_string {
my $self = shift;
return $self->{_head}->as_string;
}
sub get_header {
my $self = shift;
my $field = shift;
my $sep = shift;
die sprintf 'Second argument is not index but separator: "%s"', $sep
if defined $sep and Scalar::Util::looks_like_number($sep);
my $hdr = $self->{_head};
if (defined $sep or wantarray) {
my @values = grep {s/\A$field\s*:\s*//i}
split /\n(?![ \t])/, $hdr->as_string();
if (defined $sep) {
return undef unless @values;
return join $sep, @values;
}
return @values;
} else {
my $value = $hdr->get($field, 0);
chomp $value if defined $value;
return $value;
}
}
# Old name: tools::decode_header() which can take Message, MIME::Entity,
# MIME::Head or Mail::Header object as argument.
sub get_decoded_header {
my $self = shift;
my $tag = shift;
my $sep = shift;
my $head = $self->head;
if (defined $sep) {
my @values = $head->get($tag);
return undef unless scalar @values;
foreach my $val (@values) {
$val = MIME::EncWords::decode_mimewords($val, Charset => 'UTF-8');
chomp $val;
}
return join $sep, @values;
} else {
my $val = $head->get($tag);
return undef unless defined $val;
$val = MIME::EncWords::decode_mimewords($val, Charset => 'UTF-8');
chomp $val;
return $val;
}
}
# Dump the Message object
# Currently not used.
sub dump {
my ($self, $output) = @_;
# my $output ||= \*STDERR;
my $old_output = select;
select $output;
foreach my $key (keys %{$self}) {
if (ref($self->{$key}) eq 'MIME::Entity') {
printf "%s =>\n", $key;
$self->{$key}->print;
} else {
printf "%s => %s\n", $key, $self->{$key};
}
}
select $old_output;
return 1;
}
## Add topic and put header X-Sympa-Topic
# OBSOLETED. No longer used.