1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
6 # <jesse@bestpractical.com>
8 # (Except where explicitly superseded by other copyright notices)
13 # This work is made available to you under the terms of Version 2 of
14 # the GNU General Public License. A copy of that license should have
15 # been provided with this software, but in any event can be snarfed
18 # This work is distributed in the hope that it will be useful, but
19 # WITHOUT ANY WARRANTY; without even the implied warranty of
20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 # General Public License for more details.
23 # You should have received a copy of the GNU General Public License
24 # along with this program; if not, write to the Free Software
25 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
26 # 02110-1301 or visit their web page on the internet at
27 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
30 # CONTRIBUTION SUBMISSION POLICY:
32 # (The following paragraph is not intended to limit the rights granted
33 # to you to modify and distribute this software under the terms of
34 # the GNU General Public License and is only of importance to you if
35 # you choose to contribute your changes and enhancements to the
36 # community by submitting them to Best Practical Solutions, LLC.)
38 # By intentionally submitting any modifications, corrections or
39 # derivatives to this work, or any other work intended for use with
40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
41 # you are the copyright holder for those contributions and you grant
42 # Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
43 # royalty-free, perpetual, license to use, copy, create derivative
44 # works based on those contributions, and sublicense and distribute
45 # those contributions and any derivatives thereof.
47 # END BPS TAGGED BLOCK }}}
49 package RT::Interface::Email::Auth::GnuPG;
56 To use the gnupg-secured mail gateway, you need to do the following:
58 Set up a GnuPG key directory with a pubring containing only the keys
59 you care about and specify the following in your SiteConfig.pm
61 Set(%GnuPGOptions, homedir => '/opt/rt3/var/data/GnuPG');
62 Set(@MailPlugins, 'Auth::MailFrom', 'Auth::GnuPG', ...other filter...);
66 sub ApplyBeforeDecode { return 1 }
69 use RT::EmailParser ();
74 RawMessageRef => undef,
78 $args{'Message'}->head->delete($_)
79 for qw(X-RT-GnuPG-Status X-RT-Incoming-Encrypton
80 X-RT-Incoming-Signature X-RT-Privacy);
82 my $msg = $args{'Message'}->dup;
84 my ($status, @res) = VerifyDecrypt( Entity => $args{'Message'} );
85 if ( $status && !@res ) {
86 $args{'Message'}->head->add(
87 'X-RT-Incoming-Encryption' => 'Not encrypted'
93 # FIXME: Check if the message is encrypted to the address of
94 # _this_ queue. send rejecting mail otherwise.
97 $RT::Logger->error("Had a problem during decrypting and verifying");
98 my $reject = HandleErrors( Message => $args{'Message'}, Result => \@res );
99 return (0, 'rejected because of problems during decrypting and verifying')
103 # attach the original encrypted message
104 $args{'Message'}->attach(
105 Type => 'application/x-rt-original-message',
106 Disposition => 'inline',
107 Data => ${ $args{'RawMessageRef'} },
110 $args{'Message'}->head->add( 'X-RT-Privacy' => 'PGP' );
112 foreach my $part ( $args{'Message'}->parts_DFS ) {
115 my $status = $part->head->get( 'X-RT-GnuPG-Status' );
117 for ( RT::Crypt::GnuPG::ParseStatus( $status ) ) {
118 if ( $_->{Operation} eq 'Decrypt' && $_->{Status} eq 'DONE' ) {
121 if ( $_->{Operation} eq 'Verify' && $_->{Status} eq 'DONE' ) {
123 'X-RT-Incoming-Signature' => $_->{UserString}
130 'X-RT-Incoming-Encryption' =>
131 $decrypted ? 'Success' : 'Not encrypted'
148 foreach my $run ( @{ $args{'Result'} } ) {
149 my @status = RT::Crypt::GnuPG::ParseStatus( $run->{'status'} );
150 unless ( $sent_once{'NoPrivateKey'} ) {
151 unless ( CheckNoPrivateKey( Message => $args{'Message'}, Status => \@status ) ) {
152 $sent_once{'NoPrivateKey'}++;
153 $reject = 1 if RT->Config->Get('GnuPG')->{'RejectOnMissingPrivateKey'};
156 unless ( $sent_once{'BadData'} ) {
157 unless ( CheckBadData( Message => $args{'Message'}, Status => \@status ) ) {
158 $sent_once{'BadData'}++;
159 $reject = 1 if RT->Config->Get('GnuPG')->{'RejectOnBadData'};
166 sub CheckNoPrivateKey {
167 my %args = (Message => undef, Status => [], @_ );
168 my @status = @{ $args{'Status'} };
170 my @decrypts = grep $_->{'Operation'} eq 'Decrypt', @status;
171 return 1 unless @decrypts;
172 foreach my $action ( @decrypts ) {
173 # if at least one secrete key exist then it's another error
175 grep !$_->{'User'}{'SecretKeyMissing'},
176 @{ $action->{'EncryptedTo'} };
179 $RT::Logger->error("Couldn't decrypt a message: have no private key");
181 my $address = (RT::Interface::Email::ParseSenderAddressFromHead( $args{'Message'}->head ))[0];
182 my ($status) = RT::Interface::Email::SendEmailUsingTemplate(
184 Template => 'Error: no private key',
186 Message => $args{'Message'},
187 TicketObj => $args{'Ticket'},
189 InReplyTo => $args{'Message'},
192 $RT::Logger->error("Couldn't send 'Error: no private key'");
198 my %args = (Message => undef, Status => [], @_ );
199 my @bad_data_messages =
201 grep $_->{'Status'} ne 'DONE' && $_->{'Operation'} eq 'Data',
202 @{ $args{'Status'} };
203 return 1 unless @bad_data_messages;
205 $RT::Logger->error("Couldn't process a message: ". join ', ', @bad_data_messages );
207 my $address = (RT::Interface::Email::ParseSenderAddressFromHead( $args{'Message'}->head ))[0];
208 my ($status) = RT::Interface::Email::SendEmailUsingTemplate(
210 Template => 'Error: bad GnuPG data',
212 Messages => [ @bad_data_messages ],
213 TicketObj => $args{'Ticket'},
215 InReplyTo => $args{'Message'},
218 $RT::Logger->error("Couldn't send 'Error: bad GnuPG data'");
229 my @res = RT::Crypt::GnuPG::VerifyDecrypt( %args );
231 $RT::Logger->debug("No more encrypted/signed parts");
235 $RT::Logger->debug('Found GnuPG protected parts');
237 # return on any error
238 if ( grep $_->{'exit_code'}, @res ) {
239 $RT::Logger->debug("Error during verify/decrypt operation");
244 my ($status, @nested) = VerifyDecrypt( %args );
245 return $status, @res, @nested;
248 eval "require RT::Interface::Email::Auth::GnuPG_Vendor";
251 && $@ !~ qr{^Can't locate RT/Interface/Email/Auth/GnuPG_Vendor.pm} );
252 eval "require RT::Interface::Email::Auth::GnuPG_Local";
255 && $@ !~ qr{^Can't locate RT/Interface/Email/Auth/GnuPG_Local.pm} );