]>
git.proxmox.com Git - pmg-api.git/blob - PMG/API2/Quarantine.pm
1 package PMG
:: API2
:: Quarantine
;
11 use Mail
:: SpamAssassin
;
14 use PVE
:: Exception
qw(raise_param_exc raise_perm_exc) ;
15 use PVE
:: Tools
qw(extract_param) ;
16 use PVE
:: JSONSchema
qw(get_standard_option) ;
19 use PVE
:: APIServer
:: Formatter
;
22 use PMG
:: AccessControl
;
28 use base
qw(PVE::RESTHandler) ;
32 my $verify_optional_pmail = sub {
33 my ( $authuser, $role, $pmail ) = @_ ;
35 if ( $role eq 'quser' ) {
36 raise_param_exc
({ pmail
=> "parameter not allwed with role ' $role '" })
37 if defined ( $pmail ) && ( $pmail ne $authuser );
38 if ( $authuser =~ m/^(.+)\@quarantine$/ ) {
41 raise_param_exc
({ pmail
=> "got unexpected authuser ' $authuser ' with role ' $role '" });
44 raise_param_exc
({ pmail
=> "parameter required with role ' $role '" })
53 my $saversion = Mail
:: SpamAssassin-
> VERSION ;
55 my $salocaldir = "/var/lib/spamassassin/ $saversion/updates_spamassassin_org " ;
57 $spamdesc = PMG
:: Utils
:: load_sa_descriptions
([ $salocaldir ]) if ! $spamdesc ;
61 foreach my $test ( split ( ',' , $info )) {
62 my ( $name, $score ) = split ( ':' , $test );
64 my $info = { name
=> $name, score
=> $score + 0 , desc
=> '-' };
65 if ( my $si = $spamdesc ->{ $name }) {
66 $info ->{ desc
} = $si ->{ desc
};
67 $info ->{ url
} = $si ->{ url
} if defined ( $si ->{ url
});
75 my $extract_email = sub {
78 return $data if ! $data ;
80 if ( $data =~ m/^.*\s(\S+)\s*$/ ) {
84 if ( $data =~ m/^<([^<>\s]+)>$/ ) {
88 if ( $data !~ m/[\s><]/ && $data =~ m/^(.+\@[^\.]+\..*[^\.]+)$/ ) {
97 my $get_real_sender = sub {
100 my @lines = split ( ' \n ' , $ref ->{ header
});
101 my $head = Mail
:: Header-
> new ( \
@lines );
103 my @fromarray = split ( '\s*,\s*' , $head -> get ( 'from' ) || $ref ->{ sender
});
104 my $from = $extract_email ->( $fromarray [ 0 ]) || $ref ->{ sender
};;
105 my $sender = $extract_email ->( $head -> get ( 'sender' ));
107 return $sender if $sender ;
112 my $parse_header_info = sub {
115 my $res = { subject
=> '' , from
=> '' };
117 my @lines = split ( ' \n ' , $ref ->{ header
});
118 my $head = Mail
:: Header-
> new ( \
@lines );
120 $res ->{ subject
} = PMG
:: Utils
:: decode_rfc1522
( PVE
:: Tools
:: trim
( $head -> get ( 'subject' ))) // '' ;
122 my @fromarray = split ( '\s*,\s*' , $head -> get ( 'from' ) || $ref ->{ sender
});
124 $res ->{ from
} = PMG
:: Utils
:: decode_rfc1522
( PVE
:: Tools
:: trim
( $fromarray [ 0 ])) // '' ;
126 my $sender = PMG
:: Utils
:: decode_rfc1522
( PVE
:: Tools
:: trim
( $head -> get ( 'sender' )));
127 $res ->{ sender
} = $sender if $sender && ( $sender ne $res ->{ from
});
129 $res ->{ envelope_sender
} = $ref ->{ sender
};
130 $res ->{ receiver
} = $ref ->{ receiver
} // $ref ->{ pmail
};
131 $res ->{ id
} = 'C' . $ref ->{ cid
} . 'R' . $ref ->{ rid
};
132 $res ->{ time } = $ref ->{ time };
133 $res ->{ bytes
} = $ref ->{ bytes
};
135 my $qtype = $ref ->{ qtype
};
138 $res ->{ virusname
} = $ref ->{ info
};
139 $res ->{ spamlevel
} = 0 ;
140 } elsif ( $qtype eq 'S' ) {
141 $res ->{ spamlevel
} = $ref ->{ spamlevel
} // 0 ;
147 my $pmail_param_type = {
148 description
=> "List entries for the user with this primary email address. Quarantine users cannot speficy this parameter, but it is required for all other roles." ,
149 type
=> 'string' , format
=> 'email' ,
153 __PACKAGE__-
> register_method ({
157 permissions
=> { user
=> 'all' },
158 description
=> "Directory index." ,
160 additionalProperties
=> 0 ,
169 links
=> [ { rel
=> 'child' , href
=> "{name}" } ],
175 { name
=> 'whitelist' },
176 { name
=> 'blacklist' },
177 { name
=> 'content' },
179 { name
=> 'spamusers' },
180 { name
=> 'spamstatus' },
182 { name
=> 'virusstatus' },
183 { name
=> 'quarusers' },
190 my $read_or_modify_user_bw_list = sub {
191 my ( $listname, $param, $addrs, $delete ) = @_ ;
193 my $rpcenv = PMG
:: RESTEnvironment-
> get ();
194 my $authuser = $rpcenv -> get_user ();
195 my $role = $rpcenv -> get_role ();
197 my $pmail = $verify_optional_pmail ->( $authuser, $role, $param ->{ pmail
});
199 my $dbh = PMG
:: DBTools
:: open_ruledb
();
201 my $list = PMG
:: Quarantine
:: add_to_blackwhite
(
202 $dbh, $pmail, $listname, $addrs, $delete );
205 foreach my $a ( @$list ) { push @$res, { address
=> $a }; }
209 __PACKAGE__-
> register_method ({
213 permissions
=> { check
=> [ 'admin' , 'qmanager' , 'audit' , 'quser' ] },
214 description
=> "Show user whitelist." ,
216 additionalProperties
=> 0 ,
218 pmail
=> $pmail_param_type,
235 return $read_or_modify_user_bw_list ->( 'WL' , $param );
238 __PACKAGE__-
> register_method ({
239 name
=> 'whitelist_add' ,
242 description
=> "Add user whitelist entries." ,
243 permissions
=> { check
=> [ 'admin' , 'qmanager' , 'audit' , 'quser' ] },
246 additionalProperties
=> 0 ,
248 pmail
=> $pmail_param_type,
249 address
=> get_standard_option
( 'pmg-email-address' , {
250 description
=> "The address you want to add." ,
254 returns
=> { type
=> 'null' },
258 $read_or_modify_user_bw_list ->( 'WL' , $param, [ $param ->{ address
} ]);
263 __PACKAGE__-
> register_method ({
264 name
=> 'whitelist_delete' ,
265 path
=> 'whitelist/{address}' ,
267 description
=> "Delete user whitelist entries." ,
268 permissions
=> { check
=> [ 'admin' , 'qmanager' , 'audit' , 'quser' ] },
271 additionalProperties
=> 0 ,
273 pmail
=> $pmail_param_type,
274 address
=> get_standard_option
( 'pmg-email-address' , {
275 description
=> "The address you want to remove." ,
279 returns
=> { type
=> 'null' },
283 $read_or_modify_user_bw_list ->( 'WL' , $param, [ $param ->{ address
} ], 1 );
288 __PACKAGE__-
> register_method ({
292 permissions
=> { check
=> [ 'admin' , 'qmanager' , 'audit' , 'quser' ] },
293 description
=> "Show user blacklist." ,
295 additionalProperties
=> 0 ,
297 pmail
=> $pmail_param_type,
314 return $read_or_modify_user_bw_list ->( 'BL' , $param );
317 __PACKAGE__-
> register_method ({
318 name
=> 'blacklist_add' ,
321 description
=> "Add user blacklist entries." ,
322 permissions
=> { check
=> [ 'admin' , 'qmanager' , 'audit' , 'quser' ] },
325 additionalProperties
=> 0 ,
327 pmail
=> $pmail_param_type,
328 address
=> get_standard_option
( 'pmg-email-address' , {
329 description
=> "The address you want to add." ,
333 returns
=> { type
=> 'null' },
337 $read_or_modify_user_bw_list ->( 'BL' , $param, [ $param ->{ address
} ]);
342 __PACKAGE__-
> register_method ({
343 name
=> 'blacklist_delete' ,
344 path
=> 'blacklist/{address}' ,
346 description
=> "Delete user blacklist entries." ,
347 permissions
=> { check
=> [ 'admin' , 'qmanager' , 'audit' , 'quser' ] },
350 additionalProperties
=> 0 ,
352 pmail
=> $pmail_param_type,
353 address
=> get_standard_option
( 'pmg-email-address' , {
354 description
=> "The address you want to remove." ,
358 returns
=> { type
=> 'null' },
362 $read_or_modify_user_bw_list ->( 'BL' , $param, [ $param ->{ address
} ], 1 );
367 __PACKAGE__-
> register_method ({
371 permissions
=> { check
=> [ 'admin' , 'qmanager' , 'audit' ] },
372 description
=> "Get a list of receivers of spam in the given timespan (Default the last 24 hours)." ,
374 additionalProperties
=> 0 ,
376 starttime
=> get_standard_option
( 'pmg-starttime' ),
377 endtime
=> get_standard_option
( 'pmg-endtime' ),
386 description
=> 'the receiving email' ,
395 my $rpcenv = PMG
:: RESTEnvironment-
> get ();
396 my $authuser = $rpcenv -> get_user ();
400 my $dbh = PMG
:: DBTools
:: open_ruledb
();
402 my $start = $param ->{ starttime
} // ( time - 86400 );
403 my $end = $param ->{ endtime
} // ( $start + 86400 );
405 my $sth = $dbh -> prepare (
406 "SELECT DISTINCT pmail " .
407 "FROM CMailStore, CMSReceivers WHERE " .
408 "time >= $start AND time < $end AND " .
409 "QType = 'S' AND CID = CMailStore_CID AND RID = CMailStore_RID " .
410 "AND Status = 'N' ORDER BY pmail" );
414 while ( my $ref = $sth -> fetchrow_hashref ()) {
415 push @$res, { mail
=> $ref ->{ pmail
} };
421 __PACKAGE__-
> register_method ({
422 name
=> 'spamstatus' ,
423 path
=> 'spamstatus' ,
425 permissions
=> { check
=> [ 'admin' , 'qmanager' , 'audit' ] },
426 description
=> "Get Spam Quarantine Status" ,
428 additionalProperties
=> 0 ,
435 description
=> 'Number of stored mails.' ,
439 description
=> "Estimated disk space usage in MByte." ,
443 description
=> "Average size of stored mails in bytes." ,
447 description
=> "Average spam level." ,
455 my $dbh = PMG
:: DBTools
:: open_ruledb
();
456 my $ref = PMG
:: DBTools
:: get_quarantine_count
( $dbh, 'S' );
461 __PACKAGE__-
> register_method ({
465 permissions
=> { check
=> [ 'admin' , 'qmanager' , 'audit' ] },
466 description
=> "Get a list of users with whitelist/blacklist setttings." ,
468 additionalProperties
=> 0 ,
477 description
=> 'the receiving email' ,
486 my $rpcenv = PMG
:: RESTEnvironment-
> get ();
487 my $authuser = $rpcenv -> get_user ();
491 my $dbh = PMG
:: DBTools
:: open_ruledb
();
493 my $sth = $dbh -> prepare (
494 "SELECT DISTINCT pmail FROM UserPrefs ORDER BY pmail" );
498 while ( my $ref = $sth -> fetchrow_hashref ()) {
499 push @$res, { mail
=> $ref ->{ pmail
} };
505 __PACKAGE__-
> register_method ({
509 permissions
=> { check
=> [ 'admin' , 'qmanager' , 'audit' , 'quser' ] },
510 description
=> "Get a list of quarantined spam mails in the given timeframe (default the last 24 hours) for the given user." ,
512 additionalProperties
=> 0 ,
514 starttime
=> get_standard_option
( 'pmg-starttime' ),
515 endtime
=> get_standard_option
( 'pmg-endtime' ),
516 pmail
=> $pmail_param_type,
525 description
=> 'Unique ID' ,
529 description
=> "Size of raw email." ,
533 description
=> "SMTP envelope sender." ,
537 description
=> "Header 'From' field." ,
541 description
=> "Header 'Sender' field." ,
546 description
=> "Receiver email address" ,
550 description
=> "Header 'Subject' field." ,
554 description
=> "Receive time stamp" ,
558 description
=> "Spam score." ,
567 my $rpcenv = PMG
:: RESTEnvironment-
> get ();
568 my $authuser = $rpcenv -> get_user ();
569 my $role = $rpcenv -> get_role ();
571 my $pmail = $verify_optional_pmail ->( $authuser, $role, $param ->{ pmail
});
575 my $dbh = PMG
:: DBTools
:: open_ruledb
();
577 my $start = $param ->{ starttime
} // ( time - 86400 );
578 my $end = $param ->{ endtime
} // ( $start + 86400 );
580 my $sth = $dbh -> prepare (
582 "FROM CMailStore, CMSReceivers WHERE " .
583 "pmail = ? AND time >= $start AND time < $end AND " .
584 "QType = 'S' AND CID = CMailStore_CID AND RID = CMailStore_RID " .
585 "AND Status = 'N' ORDER BY pmail, time, receiver" );
587 $sth -> execute ( $pmail );
589 while ( my $ref = $sth -> fetchrow_hashref ()) {
590 my $data = $parse_header_info ->( $ref );
597 __PACKAGE__-
> register_method ({
601 permissions
=> { check
=> [ 'admin' , 'qmanager' , 'audit' ] },
602 description
=> "Get a list of quarantined virus mails in the given timeframe (default the last 24 hours)." ,
604 additionalProperties
=> 0 ,
606 starttime
=> get_standard_option
( 'pmg-starttime' ),
607 endtime
=> get_standard_option
( 'pmg-endtime' ),
616 description
=> 'Unique ID' ,
620 description
=> "Size of raw email." ,
624 description
=> "SMTP envelope sender." ,
628 description
=> "Header 'From' field." ,
632 description
=> "Header 'Sender' field." ,
637 description
=> "Receiver email address" ,
641 description
=> "Header 'Subject' field." ,
645 description
=> "Receive time stamp" ,
649 description
=> "Virus name." ,
658 my $rpcenv = PMG
:: RESTEnvironment-
> get ();
659 my $authuser = $rpcenv -> get_user ();
663 my $dbh = PMG
:: DBTools
:: open_ruledb
();
665 my $start = $param ->{ starttime
} // ( time - 86400 );
666 my $end = $param ->{ endtime
} // ( $start + 86400 );
668 my $sth = $dbh -> prepare (
670 "FROM CMailStore, CMSReceivers WHERE " .
671 "time >= $start AND time < $end AND " .
672 "QType = 'V' AND CID = CMailStore_CID AND RID = CMailStore_RID " .
673 "AND Status = 'N' ORDER BY time, receiver" );
677 while ( my $ref = $sth -> fetchrow_hashref ()) {
678 my $data = $parse_header_info ->( $ref );
685 __PACKAGE__-
> register_method ({
686 name
=> 'virusstatus' ,
687 path
=> 'virusstatus' ,
689 permissions
=> { check
=> [ 'admin' , 'qmanager' , 'audit' ] },
690 description
=> "Get Virus Quarantine Status" ,
692 additionalProperties
=> 0 ,
699 description
=> 'Number of stored mails.' ,
703 description
=> "Estimated disk space usage in MByte." ,
707 description
=> "Average size of stored mails in bytes." ,
715 my $dbh = PMG
:: DBTools
:: open_ruledb
();
716 my $ref = PMG
:: DBTools
:: get_quarantine_count
( $dbh, 'V' );
718 delete $ref ->{ avgspam
};
723 __PACKAGE__-
> register_method ({
727 permissions
=> { check
=> [ 'admin' , 'qmanager' , 'audit' , 'quser' ] },
728 description
=> "Get email data. There is a special formatter called 'htmlmail' to get sanitized html view of the mail content (use the '/api2/htmlmail/quarantine/content' url)." ,
730 additionalProperties
=> 0 ,
733 description
=> 'Unique ID' ,
735 pattern
=> 'C\d+R\d+' ,
739 description
=> "Display 'raw' eml data. This is only used with the 'htmlmail' formatter." ,
750 description
=> 'Unique ID' ,
754 description
=> "Size of raw email." ,
758 description
=> "SMTP envelope sender." ,
762 description
=> "Header 'From' field." ,
766 description
=> "Header 'Sender' field." ,
771 description
=> "Receiver email address" ,
775 description
=> "Header 'Subject' field." ,
779 description
=> "Receive time stamp" ,
783 description
=> "Spam score." ,
787 description
=> "Information about matched spam tests (name, score, desc, url)." ,
791 description
=> "Raw email header data." ,
795 description
=> "Raw email data (first 4096 bytes). Useful for preview. NOTE: The 'htmlmail' formatter displays the whole email." ,
803 my $rpcenv = PMG
:: RESTEnvironment-
> get ();
804 my $authuser = $rpcenv -> get_user ();
805 my $role = $rpcenv -> get_role ();
806 my $format = $rpcenv -> get_format ();
808 my ( $cid, $rid ) = $param ->{ id
} =~ m/^C(\d+)R(\d+)$/ ;
812 my $dbh = PMG
:: DBTools
:: open_ruledb
();
814 my $ref = PMG
:: DBTools
:: load_mail_data
( $dbh, $cid, $rid );
816 if ( $role eq 'quser' ) {
817 my $quar_username = $ref ->{ pmail
} . ' @quarantine ' ;
818 raise_perm_exc
( "mail does not belong to user ' $authuser '" )
819 if $authuser ne $quar_username ;
822 my $res = $parse_header_info ->( $ref );
825 my $filename = $ref ->{ file
};
826 my $spooldir = $PMG :: MailQueue
:: spooldir
;
828 my $path = " $spooldir/$filename " ;
830 if ( $format eq 'htmlmail' ) {
832 my $cfg = PMG
:: Config-
> new ();
833 my $viewimages = $cfg -> get ( 'spamquar' , 'viewimages' );
834 my $allowhref = $cfg -> get ( 'spamquar' , 'allowhrefs' );
836 $res ->{ content
} = PMG
:: HTMLMail
:: email_to_html
( $path, $param ->{ raw
}, $viewimages, $allowhref );
838 # to make result verification happy
841 $res ->{ spamlevel
} = 0 ;
842 $res ->{ spaminfo
} = [];
844 # include additional details
846 my ( $header, $content ) = PMG
:: HTMLMail
:: read_raw_email
( $path, 4096 );
848 $res ->{ file
} = $ref ->{ file
};
849 $res ->{ spaminfo
} = decode_spaminfo
( $ref ->{ info
});
850 $res ->{ header
} = $header ;
851 $res ->{ content
} = $content ;
859 PVE
:: APIServer
:: Formatter
:: register_page_formatter
(
860 'format' => 'htmlmail' ,
862 path
=> '/quarantine/content' ,
864 my ( $res, $data, $param, $path, $auth, $config ) = @_ ;
866 if (! HTTP
:: Status
:: is_success
( $res ->{ status
})) {
867 return ( "Error $res ->{status}: $res ->{message}" , "text/plain" );
870 my $ct = "text/html;charset=UTF-8" ;
872 my $raw = $data ->{ content
};
874 return ( encode
( 'UTF-8' , $raw ), $ct, 1 );
877 __PACKAGE__-
> register_method ({
881 description
=> "Execute quarantine actions." ,
882 permissions
=> { check
=> [ 'admin' , 'qmanager' , 'quser' ] },
885 additionalProperties
=> 0 ,
888 description
=> 'Unique ID' ,
890 pattern
=> 'C\d+R\d+' ,
894 description
=> 'Action - specify what you want to do with the mail.' ,
896 enum
=> [ 'whitelist' , 'blacklist' , 'deliver' , 'delete' ],
900 returns
=> { type
=> "null" },
904 my $rpcenv = PMG
:: RESTEnvironment-
> get ();
905 my $authuser = $rpcenv -> get_user ();
906 my $role = $rpcenv -> get_role ();
907 my $action = $param ->{ action
};
909 my ( $cid, $rid ) = $param ->{ id
} =~ m/^C(\d+)R(\d+)$/ ;
913 my $dbh = PMG
:: DBTools
:: open_ruledb
();
915 my $ref = PMG
:: DBTools
:: load_mail_data
( $dbh, $cid, $rid );
917 if ( $role eq 'quser' ) {
918 my $quar_username = $ref ->{ pmail
} . ' @quarantine ' ;
919 raise_perm_exc
( "mail does not belong to user ' $authuser '" )
920 if $authuser ne $quar_username ;
923 my $sender = $get_real_sender ->( $ref );
924 my $username = $ref ->{ pmail
};
926 if ( $action eq 'whitelist' ) {
927 PMG
:: Quarantine
:: add_to_blackwhite
( $dbh, $username, 'WL' , [ $sender ]);
928 } elsif ( $action eq 'blacklist' ) {
929 PMG
:: Quarantine
:: add_to_blackwhite
( $dbh, $username, 'BL' , [ $sender ]);
930 } elsif ( $action eq 'deliver' ) {
931 my $targets = [ $ref ->{ pmail
} ];
932 PMG
:: Quarantine
:: deliver_quarantined_mail
( $dbh, $ref, $targets );
933 } elsif ( $action eq 'delete' ) {
934 PMG
:: Quarantine
:: delete_quarantined_mail
( $dbh, $ref );
936 die "internal error" ; # should not be reached