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 }}}
52 package RT::Crypt::GnuPG;
56 use RT::EmailParser ();
57 use RT::Util 'safe_run_child';
61 RT::Crypt::GnuPG - encrypt/decrypt and sign/verify email messages with the GNU Privacy Guard (GPG)
65 This module provides support for encryption and signing of outgoing messages,
66 as well as the decryption and verification of incoming email.
70 You can control the configuration of this subsystem from RT's configuration file.
71 Some options are available via the web interface, but to enable this functionality, you
72 MUST start in the configuration file.
74 There are two hashes, GnuPG and GnuPGOptions in the configuration file. The
75 first one controls RT specific options. It enables you to enable/disable facility
76 or change the format of messages. The second one is a hash with options for the
77 'gnupg' utility. You can use it to define a keyserver, enable auto-retrieval keys
78 and set almost any option 'gnupg' supports on your system.
84 Set to true value to enable this subsystem:
91 However, note that you B<must> add the 'Auth::GnuPG' email filter to enable
92 the handling of incoming encrypted/signed messages.
94 =head3 Format of outgoing messages
96 Format of outgoing messages can be controlled using the 'OutgoingMessagesFormat'
97 option in the RT config:
100 ... other options ...
101 OutgoingMessagesFormat => 'RFC',
102 ... other options ...
108 ... other options ...
109 OutgoingMessagesFormat => 'Inline',
110 ... other options ...
113 This framework implements two formats of signing and encrypting of email messages:
119 This format is also known as GPG/MIME and described in RFC3156 and RFC1847.
120 Technique described in these RFCs is well supported by many mail user
121 agents (MUA), but some MUAs support only inline signatures and encryption,
122 so it's possible to use inline format (see below).
126 This format doesn't take advantage of MIME, but some mail clients do
127 not support GPG/MIME.
129 We sign text parts using clear signatures. For each attachments another
130 attachment with a signature is added with '.sig' extension.
132 Encryption of text parts is implemented using inline format, other parts
133 are replaced with attachments with the filename extension '.pgp'.
135 This format is discouraged because modern mail clients typically don't support
140 =head3 Encrypting data in the database
142 You can allow users to encrypt data in the database using
143 option C<AllowEncryptDataInDB>. By default it's disabled.
144 Users must have rights to see and modify tickets to use
149 Use this hash to set options of the 'gnupg' program. You can define almost any
150 option you want which gnupg supports, but never try to set options which
151 change output format or gnupg's commands, such as --sign (command),
152 --list-options (option) and other.
154 Some GnuPG options take arguments while others take none. (Such as --use-agent).
155 For options without specific value use C<undef> as hash value.
156 To disable these option just comment them out or delete them from the hash
159 'option-with-value' => 'value',
160 'enabled-option-without-value' => undef,
161 # 'commented-option' => 'value or undef',
164 B<NOTE> that options may contain '-' character and such options B<MUST> be
165 quoted, otherwise you can see quite cryptic error 'gpg: Invalid option "--0"'.
171 The GnuPG home directory, by default it is set to F</opt/rt3/var/data/gpg>.
173 You can manage this data with the 'gpg' commandline utility
174 using the GNUPGHOME environment variable or --homedir option.
175 Other utilities may be used as well.
177 In a standard installation, access to this directory should be granted to
178 the web server user which is running RT's web interface, but if you're running
179 cronjobs or other utilities that access RT directly via API and may generate
180 encrypted/signed notifications then the users you execute these scripts under
181 must have access too.
183 However, granting access to the dir to many users makes your setup less secure,
184 some features, such as auto-import of keys, may not be available if you do not.
185 To enable this features and suppress warnings about permissions on
186 the dir use --no-permission-warning.
190 This option is required in advance when RFC format for outgoing messages is
191 used. We can not get default algorithm from gpg program so RT uses 'SHA1' by
192 default. You may want to override it. You can use MD5, SHA1, RIPEMD160,
193 SHA256 or other, however use `gpg --version` command to get information about
194 supported algorithms by your gpg. These algorithms are listed as hash-functions.
198 This option lets you use GPG Agent to cache the passphrase of RT's key. See
199 L<http://www.gnupg.org/documentation/manuals/gnupg/Invoking-GPG_002dAGENT.html>
200 for information about GPG Agent.
204 This option lets you set the passphrase of RT's key directly. This option is
205 special in that it isn't passed directly to GPG, but is put into a file that
206 GPG then reads (which is more secure). The downside is that anyone who has read
207 access to your RT_SiteConfig.pm file can see the passphrase, thus we recommend
208 the --use-agent option instead.
212 Read `man gpg` to get list of all options this program support.
216 =head2 Per-queue options
218 Using the web interface it's possible to enable signing and/or encrypting by
219 default. As an administrative user of RT, open 'Configuration' then 'Queues',
220 and select a queue. On the page you can see information about the queue's keys
221 at the bottom and two checkboxes to choose default actions.
223 As well, encryption is enabled for autoreplies and other notifications when
224 an encypted message enters system via mailgate interface even if queue's
227 =head2 Handling incoming messages
229 To enable handling of encrypted and signed message in the RT you should add
230 'Auth::GnuPG' mail plugin.
232 Set(@MailPlugins, 'Auth::MailFrom', 'Auth::GnuPG', ...other filter...);
234 See also `perldoc lib/RT/Interface/Email/Auth/GnuPG.pm`.
236 =head2 Errors handling
238 There are several global templates created in the database by default. RT
239 uses these templates to send error messages to users or RT's owner. These
240 templates have 'Error:' or 'Error to RT owner:' prefix in the name. You can
241 adjust the text of the messages using the web interface.
243 Note that C<$TicketObj>, C<$TransactionObj> and other variable usually available
244 in RT's templates are not available in these templates, but each template
245 used for errors reporting has set of available data structures you can use to
246 build better messages. See default templates and descriptions below.
248 As well, you can disable particular notification by deleting content of
249 a template. You can delete a template too, but in this case you'll see
250 error messages in the logs when RT can not load template you've deleted.
252 =head3 Problems with public keys
254 Template 'Error: public key' is used to inform the user that RT has problems with
255 his public key and won't be able to send him encrypted content. There are several
256 reasons why RT can't use a key. However, the actual reason is not sent to the user,
257 but sent to RT owner using 'Error to RT owner: public key'.
259 The possible reasons: "Not Found", "Ambiguous specification", "Wrong
260 key usage", "Key revoked", "Key expired", "No CRL known", "CRL too
261 old", "Policy mismatch", "Not a secret key", "Key not trusted" or
262 "No specific reason given".
264 Due to limitations of GnuPG, it's impossible to encrypt to an untrusted key,
265 unless 'always trust' mode is enabled.
267 In the 'Error: public key' template there are a few additional variables available:
271 =item $Message - user friendly error message
273 =item $Reason - short reason as listed above
275 =item $Recipient - recipient's identification
277 =item $AddressObj - L<Email::Address> object containing recipient's email address
281 A message can have several invalid recipients, to avoid sending many emails
282 to the RT owner the system sends one message to the owner, grouped by
283 recipient. In the 'Error to RT owner: public key' template a C<@BadRecipients>
284 array is available where each element is a hash reference that describes one
285 recipient using the same fields as described above. So it's something like:
288 { Message => '...', Reason => '...', Recipient => '...', ...},
289 { Message => '...', Reason => '...', Recipient => '...', ...},
293 =head3 Private key doesn't exist
295 Template 'Error: no private key' is used to inform the user that
296 he sent an encrypted email, but we have no private key to decrypt
299 In this template C<$Message> object of L<MIME::Entity> class
300 available. It's the message RT received.
304 Template 'Error: bad GnuPG data' used to inform the user that a
305 message he sent has invalid data and can not be handled.
307 There are several reasons for this error, but most of them are data
308 corruption or absence of expected information.
310 In this template C<@Messages> array is available and contains list
313 =head1 FOR DEVELOPERS
315 =head2 Documentation and references
317 * RFC1847 - Security Multiparts for MIME: Multipart/Signed and Multipart/Encrypted.
318 Describes generic MIME security framework, "mulitpart/signed" and "multipart/encrypted"
321 * RFC3156 - MIME Security with Pretty Good Privacy (PGP),
326 # gnupg options supported by GnuPG::Interface
327 # other otions should be handled via extra_args argument
328 my %supported_opt = map { $_ => 1 } qw(
354 # DEV WARNING: always pass all STD* handles to GnuPG interface even if we don't
355 # need them, just pass 'new IO::Handle' and then close it after safe_run_child.
356 # we don't want to leak anything into FCGI/Apache/MP handles, this break things.
357 # So code should look like:
358 # my $handles = GnuPG::Handles->new(
359 # stdin => ($handle{'stdin'} = new IO::Handle),
360 # stdout => ($handle{'stdout'} = new IO::Handle),
361 # stderr => ($handle{'stderr'} = new IO::Handle),
365 =head2 SignEncrypt Entity => MIME::Entity, [ Encrypt => 1, Sign => 1, ... ]
367 Signs and/or encrypts an email message with GnuPG utility.
373 During signing you can pass C<Signer> argument to set key we sign with this option
374 overrides gnupg's C<default-key> option. If C<Signer> argument is not provided
375 then address of a message sender is used.
377 As well you can pass C<Passphrase>, but if value is undefined then L</GetPassphrase>
382 During encryption you can pass a C<Recipients> array, otherwise C<To>, C<Cc> and
383 C<Bcc> fields of the message are used to fetch the list.
387 Returns a hash with the following keys:
400 my $entity = $args{'Entity'};
401 if ( $args{'Sign'} && !defined $args{'Signer'} ) {
402 $args{'Signer'} = UseKeyForSigning()
403 || (Email::Address->parse( $entity->head->get( 'From' ) ))[0]->address;
405 if ( $args{'Encrypt'} && !$args{'Recipients'} ) {
407 $args{'Recipients'} = [
408 grep $_ && !$seen{ $_ }++, map $_->address,
409 map Email::Address->parse( $entity->head->get( $_ ) ),
414 my $format = lc RT->Config->Get('GnuPG')->{'OutgoingMessagesFormat'} || 'RFC';
415 if ( $format eq 'inline' ) {
416 return SignEncryptInline( %args );
418 return SignEncryptRFC3156( %args );
422 sub SignEncryptRFC3156 {
436 my $gnupg = new GnuPG::Interface;
437 my %opt = RT->Config->Get('GnuPGOptions');
439 # handling passphrase in GnuPGOptions
440 $args{'Passphrase'} = delete $opt{'passphrase'}
441 if !defined $args{'Passphrase'};
443 $opt{'digest-algo'} ||= 'SHA1';
444 $opt{'default_key'} = $args{'Signer'}
445 if $args{'Sign'} && $args{'Signer'};
446 $gnupg->options->hash_init(
447 _PrepareGnuPGOptions( %opt ),
449 meta_interactive => 0,
452 my $entity = $args{'Entity'};
454 if ( $args{'Sign'} && !defined $args{'Passphrase'} ) {
455 $args{'Passphrase'} = GetPassphrase( Address => $args{'Signer'} );
459 if ( $args{'Sign'} && !$args{'Encrypt'} ) {
460 # required by RFC3156(Ch. 5) and RFC1847(Ch. 2.1)
461 foreach ( grep !$_->is_multipart, $entity->parts_DFS ) {
462 my $tenc = $_->head->mime_encoding;
463 unless ( $tenc =~ m/^(?:7bit|quoted-printable|base64)$/i ) {
464 $_->head->mime_attr( 'Content-Transfer-Encoding'
465 => $_->effective_type =~ m{^text/}? 'quoted-printable': 'base64'
470 my ($handles, $handle_list) = _make_gpg_handles(stdin =>IO::Handle::CRLF->new );
471 my %handle = %$handle_list;
473 $gnupg->passphrase( $args{'Passphrase'} );
476 local $SIG{'CHLD'} = 'DEFAULT';
477 my $pid = safe_run_child { $gnupg->detach_sign( handles => $handles ) };
478 $entity->make_multipart( 'mixed', Force => 1 );
480 local $SIG{'PIPE'} = 'IGNORE';
481 $entity->parts(0)->print( $handle{'stdin'} );
482 close $handle{'stdin'};
487 my @signature = readline $handle{'stdout'};
488 close $handle{'stdout'};
490 $res{'exit_code'} = $?;
491 foreach ( qw(stderr logger status) ) {
492 $res{$_} = do { local $/; readline $handle{$_} };
493 delete $res{$_} unless $res{$_} && $res{$_} =~ /\S/s;
496 $RT::Logger->debug( $res{'status'} ) if $res{'status'};
497 $RT::Logger->warning( $res{'stderr'} ) if $res{'stderr'};
498 $RT::Logger->error( $res{'logger'} ) if $res{'logger'} && $?;
499 if ( $err || $res{'exit_code'} ) {
500 $res{'message'} = $err? $err : "gpg exitted with error code ". ($res{'exit_code'} >> 8);
504 # setup RFC1847(Ch.2.1) requirements
505 my $protocol = 'application/pgp-signature';
506 $entity->head->mime_attr( 'Content-Type' => 'multipart/signed' );
507 $entity->head->mime_attr( 'Content-Type.protocol' => $protocol );
508 $entity->head->mime_attr( 'Content-Type.micalg' => 'pgp-'. lc $opt{'digest-algo'} );
511 Disposition => 'inline',
516 if ( $args{'Encrypt'} ) {
518 $gnupg->options->push_recipients( $_ ) foreach
519 map UseKeyForEncryption($_) || $_,
520 grep !$seen{ $_ }++, map $_->address,
521 map Email::Address->parse( $entity->head->get( $_ ) ),
524 my ($tmp_fh, $tmp_fn) = File::Temp::tempfile( UNLINK => 1 );
525 binmode $tmp_fh, ':raw';
527 my ($handles, $handle_list) = _make_gpg_handles(stdout => $tmp_fh);
528 my %handle = %$handle_list;
529 $handles->options( 'stdout' )->{'direct'} = 1;
530 $gnupg->passphrase( $args{'Passphrase'} ) if $args{'Sign'};
533 local $SIG{'CHLD'} = 'DEFAULT';
534 my $pid = safe_run_child { $args{'Sign'}
535 ? $gnupg->sign_and_encrypt( handles => $handles )
536 : $gnupg->encrypt( handles => $handles ) };
537 $entity->make_multipart( 'mixed', Force => 1 );
539 local $SIG{'PIPE'} = 'IGNORE';
540 $entity->parts(0)->print( $handle{'stdin'} );
541 close $handle{'stdin'};
546 $res{'exit_code'} = $?;
547 foreach ( qw(stderr logger status) ) {
548 $res{$_} = do { local $/; readline $handle{$_} };
549 delete $res{$_} unless $res{$_} && $res{$_} =~ /\S/s;
552 $RT::Logger->debug( $res{'status'} ) if $res{'status'};
553 $RT::Logger->warning( $res{'stderr'} ) if $res{'stderr'};
554 $RT::Logger->error( $res{'logger'} ) if $res{'logger'} && $?;
556 $res{'message'} = $@? $@: "gpg exited with error code ". ($? >> 8);
560 my $protocol = 'application/pgp-encrypted';
562 $entity->head->mime_attr( 'Content-Type' => 'multipart/encrypted' );
563 $entity->head->mime_attr( 'Content-Type.protocol' => $protocol );
566 Disposition => 'inline',
567 Data => ['Version: 1',''],
571 Type => 'application/octet-stream',
572 Disposition => 'inline',
577 $entity->parts(-1)->bodyhandle->{'_dirty_hack_to_save_a_ref_tmp_fh'} = $tmp_fh;
582 sub SignEncryptInline {
585 my $entity = $args{'Entity'};
588 $entity->make_singlepart;
589 if ( $entity->is_multipart ) {
590 foreach ( $entity->parts ) {
591 %res = SignEncryptInline( @_, Entity => $_ );
592 return %res if $res{'exit_code'};
597 return _SignEncryptTextInline( @_ )
598 if $entity->effective_type =~ /^text\//i;
600 return _SignEncryptAttachmentInline( @_ );
603 sub _SignEncryptTextInline {
616 return unless $args{'Sign'} || $args{'Encrypt'};
618 my $gnupg = new GnuPG::Interface;
619 my %opt = RT->Config->Get('GnuPGOptions');
621 # handling passphrase in GnupGOptions
622 $args{'Passphrase'} = delete $opt{'passphrase'}
623 if !defined($args{'Passphrase'});
625 $opt{'digest-algo'} ||= 'SHA1';
626 $opt{'default_key'} = $args{'Signer'}
627 if $args{'Sign'} && $args{'Signer'};
628 $gnupg->options->hash_init(
629 _PrepareGnuPGOptions( %opt ),
631 meta_interactive => 0,
634 if ( $args{'Sign'} && !defined $args{'Passphrase'} ) {
635 $args{'Passphrase'} = GetPassphrase( Address => $args{'Signer'} );
638 if ( $args{'Encrypt'} ) {
639 $gnupg->options->push_recipients( $_ ) foreach
640 map UseKeyForEncryption($_) || $_,
641 @{ $args{'Recipients'} || [] };
646 my ($tmp_fh, $tmp_fn) = File::Temp::tempfile( UNLINK => 1 );
647 binmode $tmp_fh, ':raw';
649 my ($handles, $handle_list) = _make_gpg_handles(stdout => $tmp_fh);
650 my %handle = %$handle_list;
652 $handles->options( 'stdout' )->{'direct'} = 1;
653 $gnupg->passphrase( $args{'Passphrase'} ) if $args{'Sign'};
655 my $entity = $args{'Entity'};
657 local $SIG{'CHLD'} = 'DEFAULT';
658 my $method = $args{'Sign'} && $args{'Encrypt'}
660 : ($args{'Sign'}? 'clearsign': 'encrypt');
661 my $pid = safe_run_child { $gnupg->$method( handles => $handles ) };
663 local $SIG{'PIPE'} = 'IGNORE';
664 $entity->bodyhandle->print( $handle{'stdin'} );
665 close $handle{'stdin'};
669 $res{'exit_code'} = $?;
672 foreach ( qw(stderr logger status) ) {
673 $res{$_} = do { local $/; readline $handle{$_} };
674 delete $res{$_} unless $res{$_} && $res{$_} =~ /\S/s;
677 $RT::Logger->debug( $res{'status'} ) if $res{'status'};
678 $RT::Logger->warning( $res{'stderr'} ) if $res{'stderr'};
679 $RT::Logger->error( $res{'logger'} ) if $res{'logger'} && $?;
680 if ( $err || $res{'exit_code'} ) {
681 $res{'message'} = $err? $err : "gpg exitted with error code ". ($res{'exit_code'} >> 8);
685 $entity->bodyhandle( new MIME::Body::File $tmp_fn );
686 $entity->{'__store_tmp_handle_to_avoid_early_cleanup'} = $tmp_fh;
691 sub _SignEncryptAttachmentInline {
704 return unless $args{'Sign'} || $args{'Encrypt'};
706 my $gnupg = new GnuPG::Interface;
707 my %opt = RT->Config->Get('GnuPGOptions');
709 # handling passphrase in GnupGOptions
710 $args{'Passphrase'} = delete $opt{'passphrase'}
711 if !defined($args{'Passphrase'});
713 $opt{'digest-algo'} ||= 'SHA1';
714 $opt{'default_key'} = $args{'Signer'}
715 if $args{'Sign'} && $args{'Signer'};
716 $gnupg->options->hash_init(
717 _PrepareGnuPGOptions( %opt ),
719 meta_interactive => 0,
722 if ( $args{'Sign'} && !defined $args{'Passphrase'} ) {
723 $args{'Passphrase'} = GetPassphrase( Address => $args{'Signer'} );
726 my $entity = $args{'Entity'};
727 if ( $args{'Encrypt'} ) {
728 $gnupg->options->push_recipients( $_ ) foreach
729 map UseKeyForEncryption($_) || $_,
730 @{ $args{'Recipients'} || [] };
735 my ($tmp_fh, $tmp_fn) = File::Temp::tempfile( UNLINK => 1 );
736 binmode $tmp_fh, ':raw';
738 my ($handles, $handle_list) = _make_gpg_handles(stdout => $tmp_fh);
739 my %handle = %$handle_list;
740 $handles->options( 'stdout' )->{'direct'} = 1;
741 $gnupg->passphrase( $args{'Passphrase'} ) if $args{'Sign'};
744 local $SIG{'CHLD'} = 'DEFAULT';
745 my $method = $args{'Sign'} && $args{'Encrypt'}
747 : ($args{'Sign'}? 'detach_sign': 'encrypt');
748 my $pid = safe_run_child { $gnupg->$method( handles => $handles ) };
750 local $SIG{'PIPE'} = 'IGNORE';
751 $entity->bodyhandle->print( $handle{'stdin'} );
752 close $handle{'stdin'};
756 $res{'exit_code'} = $?;
759 foreach ( qw(stderr logger status) ) {
760 $res{$_} = do { local $/; readline $handle{$_} };
761 delete $res{$_} unless $res{$_} && $res{$_} =~ /\S/s;
764 $RT::Logger->debug( $res{'status'} ) if $res{'status'};
765 $RT::Logger->warning( $res{'stderr'} ) if $res{'stderr'};
766 $RT::Logger->error( $res{'logger'} ) if $res{'logger'} && $?;
767 if ( $err || $res{'exit_code'} ) {
768 $res{'message'} = $err? $err : "gpg exitted with error code ". ($res{'exit_code'} >> 8);
772 my $filename = $entity->head->recommended_filename || 'no_name';
773 if ( $args{'Sign'} && !$args{'Encrypt'} ) {
774 $entity->make_multipart;
776 Type => 'application/octet-stream',
778 Filename => "$filename.sig",
779 Disposition => 'attachment',
782 $entity->bodyhandle( new MIME::Body::File $tmp_fn );
783 $entity->effective_type('application/octet-stream');
784 $entity->head->mime_attr( $_ => "$filename.pgp" )
785 foreach (qw(Content-Type.name Content-Disposition.filename));
788 $entity->{'__store_tmp_handle_to_avoid_early_cleanup'} = $tmp_fh;
793 sub SignEncryptContent {
806 return unless $args{'Sign'} || $args{'Encrypt'};
808 my $gnupg = new GnuPG::Interface;
809 my %opt = RT->Config->Get('GnuPGOptions');
811 # handling passphrase in GnupGOptions
812 $args{'Passphrase'} = delete $opt{'passphrase'}
813 if !defined($args{'Passphrase'});
815 $opt{'digest-algo'} ||= 'SHA1';
816 $opt{'default_key'} = $args{'Signer'}
817 if $args{'Sign'} && $args{'Signer'};
818 $gnupg->options->hash_init(
819 _PrepareGnuPGOptions( %opt ),
821 meta_interactive => 0,
824 if ( $args{'Sign'} && !defined $args{'Passphrase'} ) {
825 $args{'Passphrase'} = GetPassphrase( Address => $args{'Signer'} );
828 if ( $args{'Encrypt'} ) {
829 $gnupg->options->push_recipients( $_ ) foreach
830 map UseKeyForEncryption($_) || $_,
831 @{ $args{'Recipients'} || [] };
836 my ($tmp_fh, $tmp_fn) = File::Temp::tempfile( UNLINK => 1 );
837 binmode $tmp_fh, ':raw';
839 my ($handles, $handle_list) = _make_gpg_handles(stdout => $tmp_fh);
840 my %handle = %$handle_list;
841 $handles->options( 'stdout' )->{'direct'} = 1;
842 $gnupg->passphrase( $args{'Passphrase'} ) if $args{'Sign'};
845 local $SIG{'CHLD'} = 'DEFAULT';
846 my $method = $args{'Sign'} && $args{'Encrypt'}
848 : ($args{'Sign'}? 'clearsign': 'encrypt');
849 my $pid = safe_run_child { $gnupg->$method( handles => $handles ) };
851 local $SIG{'PIPE'} = 'IGNORE';
852 $handle{'stdin'}->print( ${ $args{'Content'} } );
853 close $handle{'stdin'};
857 $res{'exit_code'} = $?;
860 foreach ( qw(stderr logger status) ) {
861 $res{$_} = do { local $/; readline $handle{$_} };
862 delete $res{$_} unless $res{$_} && $res{$_} =~ /\S/s;
865 $RT::Logger->debug( $res{'status'} ) if $res{'status'};
866 $RT::Logger->warning( $res{'stderr'} ) if $res{'stderr'};
867 $RT::Logger->error( $res{'logger'} ) if $res{'logger'} && $?;
868 if ( $err || $res{'exit_code'} ) {
869 $res{'message'} = $err? $err : "gpg exitted with error code ". ($res{'exit_code'} >> 8);
873 ${ $args{'Content'} } = '';
876 my $status = read $tmp_fh, my $buf, 4*1024;
877 unless ( defined $status ) {
878 $RT::Logger->crit( "couldn't read message: $!" );
879 } elsif ( !$status ) {
882 ${ $args{'Content'} } .= $buf;
888 sub FindProtectedParts {
889 my %args = ( Entity => undef, CheckBody => 1, @_ );
890 my $entity = $args{'Entity'};
892 # inline PGP block, only in singlepart
893 unless ( $entity->is_multipart ) {
894 my $io = $entity->open('r');
896 $RT::Logger->warning( "Entity of type ". $entity->effective_type ." has no body" );
899 while ( defined($_ = $io->getline) ) {
900 next unless /^-----BEGIN PGP (SIGNED )?MESSAGE-----/;
901 my $type = $1? 'signed': 'encrypted';
902 $RT::Logger->debug("Found $type inline part");
913 # RFC3156, multipart/{signed,encrypted}
914 if ( ( my $type = $entity->effective_type ) =~ /^multipart\/(?:encrypted|signed)$/ ) {
915 unless ( $entity->parts == 2 ) {
916 $RT::Logger->error( "Encrypted or signed entity must has two subparts. Skipped" );
920 my $protocol = $entity->head->mime_attr( 'Content-Type.protocol' );
921 unless ( $protocol ) {
922 $RT::Logger->error( "Entity is '$type', but has no protocol defined. Skipped" );
926 if ( $type eq 'multipart/encrypted' ) {
927 unless ( $protocol eq 'application/pgp-encrypted' ) {
928 $RT::Logger->info( "Skipping protocol '$protocol', only 'application/pgp-encrypted' is supported" );
931 $RT::Logger->debug("Found encrypted according to RFC3156 part");
936 Data => $entity->parts(1),
937 Info => $entity->parts(0),
940 unless ( $protocol eq 'application/pgp-signature' ) {
941 $RT::Logger->info( "Skipping protocol '$protocol', only 'application/pgp-signature' is supported" );
944 $RT::Logger->debug("Found signed according to RFC3156 part");
949 Data => $entity->parts(0),
950 Signature => $entity->parts(1),
955 # attachments signed with signature in another part
957 foreach my $i ( 0 .. $entity->parts - 1 ) {
958 my $part = $entity->parts($i);
960 # we can not associate a signature within an attachment
962 my $fname = $part->head->recommended_filename;
965 if ( $part->effective_type eq 'application/pgp-signature' ) {
966 push @file_indices, $i;
968 elsif ( $fname =~ /\.sig$/i && $part->effective_type eq 'application/octet-stream' ) {
969 push @file_indices, $i;
974 foreach my $i ( @file_indices ) {
975 my $sig_part = $entity->parts($i);
976 $skip{"$sig_part"}++;
977 my $sig_name = $sig_part->head->recommended_filename;
978 my ($file_name) = $sig_name =~ /^(.*?)(?:\.sig)?$/;
980 my ($data_part_idx) =
981 grep $file_name eq ($entity->parts($_)->head->recommended_filename||''),
982 grep $sig_part ne $entity->parts($_),
983 0 .. $entity->parts - 1;
984 unless ( defined $data_part_idx ) {
985 $RT::Logger->error("Found $sig_name attachment, but didn't find $file_name");
988 my $data_part_in = $entity->parts($data_part_idx);
990 $skip{"$data_part_in"}++;
991 $RT::Logger->debug("Found signature (in '$sig_name') of attachment '$file_name'");
994 Format => 'Attachment',
996 Data => $data_part_in,
997 Signature => $sig_part,
1001 # attachments with inline encryption
1002 my @encrypted_indices =
1003 grep {($entity->parts($_)->head->recommended_filename || '') =~ /\.pgp$/}
1004 0 .. $entity->parts - 1;
1006 foreach my $i ( @encrypted_indices ) {
1007 my $part = $entity->parts($i);
1009 $RT::Logger->debug("Found encrypted attachment '". $part->head->recommended_filename ."'");
1011 Type => 'encrypted',
1012 Format => 'Attachment',
1018 push @res, FindProtectedParts( Entity => $_ )
1019 foreach grep !$skip{"$_"}, $entity->parts;
1024 =head2 VerifyDecrypt Entity => undef, [ Detach => 1, Passphrase => undef, SetStatus => 1 ]
1036 my @protected = FindProtectedParts( Entity => $args{'Entity'} );
1038 # XXX: detaching may brake nested signatures
1039 foreach my $item( grep $_->{'Type'} eq 'signed', @protected ) {
1041 if ( $item->{'Format'} eq 'RFC3156' ) {
1042 push @res, { VerifyRFC3156( %$item, SetStatus => $args{'SetStatus'} ) };
1043 if ( $args{'Detach'} ) {
1044 $item->{'Top'}->parts( [ $item->{'Data'} ] );
1045 $item->{'Top'}->make_singlepart;
1047 $status_on = $item->{'Top'};
1048 } elsif ( $item->{'Format'} eq 'Inline' ) {
1049 push @res, { VerifyInline( %$item ) };
1050 $status_on = $item->{'Data'};
1051 } elsif ( $item->{'Format'} eq 'Attachment' ) {
1052 push @res, { VerifyAttachment( %$item ) };
1053 if ( $args{'Detach'} ) {
1054 $item->{'Top'}->parts( [
1055 grep "$_" ne $item->{'Signature'}, $item->{'Top'}->parts
1057 $item->{'Top'}->make_singlepart;
1059 $status_on = $item->{'Data'};
1061 if ( $args{'SetStatus'} || $args{'AddStatus'} ) {
1062 my $method = $args{'AddStatus'} ? 'add' : 'set';
1063 $status_on->head->$method(
1064 'X-RT-GnuPG-Status' => $res[-1]->{'status'}
1068 foreach my $item( grep $_->{'Type'} eq 'encrypted', @protected ) {
1070 if ( $item->{'Format'} eq 'RFC3156' ) {
1071 push @res, { DecryptRFC3156( %$item ) };
1072 $status_on = $item->{'Top'};
1073 } elsif ( $item->{'Format'} eq 'Inline' ) {
1074 push @res, { DecryptInline( %$item ) };
1075 $status_on = $item->{'Data'};
1076 } elsif ( $item->{'Format'} eq 'Attachment' ) {
1077 push @res, { DecryptAttachment( %$item ) };
1078 $status_on = $item->{'Data'};
1080 if ( $args{'SetStatus'} || $args{'AddStatus'} ) {
1081 my $method = $args{'AddStatus'} ? 'add' : 'set';
1082 $status_on->head->$method(
1083 'X-RT-GnuPG-Status' => $res[-1]->{'status'}
1090 sub VerifyInline { return DecryptInline( @_ ) }
1092 sub VerifyAttachment {
1093 my %args = ( Data => undef, Signature => undef, Top => undef, @_ );
1095 my $gnupg = new GnuPG::Interface;
1096 my %opt = RT->Config->Get('GnuPGOptions');
1097 $opt{'digest-algo'} ||= 'SHA1';
1098 $gnupg->options->hash_init(
1099 _PrepareGnuPGOptions( %opt ),
1100 meta_interactive => 0,
1103 foreach ( $args{'Data'}, $args{'Signature'} ) {
1104 next unless $_->bodyhandle->is_encoded;
1106 require RT::EmailParser;
1107 RT::EmailParser->_DecodeBody($_);
1110 my ($tmp_fh, $tmp_fn) = File::Temp::tempfile( UNLINK => 1 );
1111 binmode $tmp_fh, ':raw';
1112 $args{'Data'}->bodyhandle->print( $tmp_fh );
1115 my ($handles, $handle_list) = _make_gpg_handles();
1116 my %handle = %$handle_list;
1120 local $SIG{'CHLD'} = 'DEFAULT';
1121 my $pid = safe_run_child { $gnupg->verify(
1122 handles => $handles, command_args => [ '-', $tmp_fn ]
1125 local $SIG{'PIPE'} = 'IGNORE';
1126 $args{'Signature'}->bodyhandle->print( $handle{'stdin'} );
1127 close $handle{'stdin'};
1131 $res{'exit_code'} = $?;
1132 foreach ( qw(stderr logger status) ) {
1133 $res{$_} = do { local $/; readline $handle{$_} };
1134 delete $res{$_} unless $res{$_} && $res{$_} =~ /\S/s;
1137 $RT::Logger->debug( $res{'status'} ) if $res{'status'};
1138 $RT::Logger->warning( $res{'stderr'} ) if $res{'stderr'};
1139 $RT::Logger->error( $res{'logger'} ) if $res{'logger'} && $?;
1141 $res{'message'} = $@? $@: "gpg exitted with error code ". ($? >> 8);
1147 my %args = ( Data => undef, Signature => undef, Top => undef, @_ );
1149 my $gnupg = new GnuPG::Interface;
1150 my %opt = RT->Config->Get('GnuPGOptions');
1151 $opt{'digest-algo'} ||= 'SHA1';
1152 $gnupg->options->hash_init(
1153 _PrepareGnuPGOptions( %opt ),
1154 meta_interactive => 0,
1157 my ($tmp_fh, $tmp_fn) = File::Temp::tempfile( UNLINK => 1 );
1158 binmode $tmp_fh, ':raw:eol(CRLF?)';
1159 $args{'Data'}->print( $tmp_fh );
1162 my ($handles, $handle_list) = _make_gpg_handles();
1163 my %handle = %$handle_list;
1167 local $SIG{'CHLD'} = 'DEFAULT';
1168 my $pid = safe_run_child { $gnupg->verify(
1169 handles => $handles, command_args => [ '-', $tmp_fn ]
1172 local $SIG{'PIPE'} = 'IGNORE';
1173 $args{'Signature'}->bodyhandle->print( $handle{'stdin'} );
1174 close $handle{'stdin'};
1178 $res{'exit_code'} = $?;
1179 foreach ( qw(stderr logger status) ) {
1180 $res{$_} = do { local $/; readline $handle{$_} };
1181 delete $res{$_} unless $res{$_} && $res{$_} =~ /\S/s;
1184 $RT::Logger->debug( $res{'status'} ) if $res{'status'};
1185 $RT::Logger->warning( $res{'stderr'} ) if $res{'stderr'};
1186 $RT::Logger->error( $res{'logger'} ) if $res{'logger'} && $?;
1188 $res{'message'} = $@? $@: "gpg exitted with error code ". ($? >> 8);
1193 sub DecryptRFC3156 {
1198 Passphrase => undef,
1202 my $gnupg = new GnuPG::Interface;
1203 my %opt = RT->Config->Get('GnuPGOptions');
1205 # handling passphrase in GnupGOptions
1206 $args{'Passphrase'} = delete $opt{'passphrase'}
1207 if !defined($args{'Passphrase'});
1209 $opt{'digest-algo'} ||= 'SHA1';
1210 $gnupg->options->hash_init(
1211 _PrepareGnuPGOptions( %opt ),
1212 meta_interactive => 0,
1215 if ( $args{'Data'}->bodyhandle->is_encoded ) {
1216 require RT::EmailParser;
1217 RT::EmailParser->_DecodeBody($args{'Data'});
1220 $args{'Passphrase'} = GetPassphrase()
1221 unless defined $args{'Passphrase'};
1223 my ($tmp_fh, $tmp_fn) = File::Temp::tempfile( UNLINK => 1 );
1224 binmode $tmp_fh, ':raw';
1226 my ($handles, $handle_list) = _make_gpg_handles(stdout => $tmp_fh);
1227 my %handle = %$handle_list;
1228 $handles->options( 'stdout' )->{'direct'} = 1;
1232 local $SIG{'CHLD'} = 'DEFAULT';
1233 $gnupg->passphrase( $args{'Passphrase'} );
1234 my $pid = safe_run_child { $gnupg->decrypt( handles => $handles ) };
1236 local $SIG{'PIPE'} = 'IGNORE';
1237 $args{'Data'}->bodyhandle->print( $handle{'stdin'} );
1238 close $handle{'stdin'}
1243 $res{'exit_code'} = $?;
1244 foreach ( qw(stderr logger status) ) {
1245 $res{$_} = do { local $/; readline $handle{$_} };
1246 delete $res{$_} unless $res{$_} && $res{$_} =~ /\S/s;
1249 $RT::Logger->debug( $res{'status'} ) if $res{'status'};
1250 $RT::Logger->warning( $res{'stderr'} ) if $res{'stderr'};
1251 $RT::Logger->error( $res{'logger'} ) if $res{'logger'} && $?;
1253 # if the decryption is fine but the signature is bad, then without this
1254 # status check we lose the decrypted text
1255 # XXX: add argument to the function to control this check
1256 if ( $res{'status'} !~ /DECRYPTION_OKAY/ ) {
1258 $res{'message'} = $@? $@: "gpg exitted with error code ". ($? >> 8);
1264 my $parser = new RT::EmailParser;
1265 my $decrypted = $parser->ParseMIMEEntityFromFileHandle( $tmp_fh, 0 );
1266 $decrypted->{'__store_link_to_object_to_avoid_early_cleanup'} = $parser;
1267 $args{'Top'}->parts( [] );
1268 $args{'Top'}->add_part( $decrypted );
1269 $args{'Top'}->make_singlepart;
1276 Passphrase => undef,
1280 my $gnupg = new GnuPG::Interface;
1281 my %opt = RT->Config->Get('GnuPGOptions');
1283 # handling passphrase in GnuPGOptions
1284 $args{'Passphrase'} = delete $opt{'passphrase'}
1285 if !defined($args{'Passphrase'});
1287 $opt{'digest-algo'} ||= 'SHA1';
1288 $gnupg->options->hash_init(
1289 _PrepareGnuPGOptions( %opt ),
1290 meta_interactive => 0,
1293 if ( $args{'Data'}->bodyhandle->is_encoded ) {
1294 require RT::EmailParser;
1295 RT::EmailParser->_DecodeBody($args{'Data'});
1298 $args{'Passphrase'} = GetPassphrase()
1299 unless defined $args{'Passphrase'};
1301 my ($tmp_fh, $tmp_fn) = File::Temp::tempfile( UNLINK => 1 );
1302 binmode $tmp_fh, ':raw';
1304 my $io = $args{'Data'}->open('r');
1306 die "Entity has no body, never should happen";
1311 my ($had_literal, $in_block) = ('', 0);
1312 my ($block_fh, $block_fn) = File::Temp::tempfile( UNLINK => 1 );
1313 binmode $block_fh, ':raw';
1315 while ( defined(my $str = $io->getline) ) {
1316 if ( $in_block && $str =~ /^-----END PGP (?:MESSAGE|SIGNATURE)-----/ ) {
1317 print $block_fh $str;
1319 next if $in_block > 0;
1321 seek $block_fh, 0, 0;
1323 my ($res_fh, $res_fn);
1324 ($res_fh, $res_fn, %res) = _DecryptInlineBlock(
1327 BlockHandle => $block_fh,
1329 return %res unless $res_fh;
1331 print $tmp_fh "-----BEGIN OF PGP PROTECTED PART-----\n" if $had_literal;
1332 while (my $buf = <$res_fh> ) {
1335 print $tmp_fh "-----END OF PART-----\n" if $had_literal;
1337 ($block_fh, $block_fn) = File::Temp::tempfile( UNLINK => 1 );
1338 binmode $block_fh, ':raw';
1341 elsif ( $str =~ /^-----BEGIN PGP (SIGNED )?MESSAGE-----/ ) {
1343 print $block_fh $str;
1345 elsif ( $in_block ) {
1346 print $block_fh $str;
1350 $had_literal = 1 if /\S/s;
1356 # we're still in a block, this not bad not good. let's try to
1357 # decrypt what we have, it can be just missing -----END PGP...
1358 seek $block_fh, 0, 0;
1360 my ($res_fh, $res_fn);
1361 ($res_fh, $res_fn, %res) = _DecryptInlineBlock(
1364 BlockHandle => $block_fh,
1366 return %res unless $res_fh;
1368 print $tmp_fh "-----BEGIN OF PGP PROTECTED PART-----\n" if $had_literal;
1369 while (my $buf = <$res_fh> ) {
1372 print $tmp_fh "-----END OF PART-----\n" if $had_literal;
1376 $args{'Data'}->bodyhandle( new MIME::Body::File $tmp_fn );
1377 $args{'Data'}->{'__store_tmp_handle_to_avoid_early_cleanup'} = $tmp_fh;
1381 sub _DecryptInlineBlock {
1384 BlockHandle => undef,
1385 Passphrase => undef,
1388 my $gnupg = $args{'GnuPG'};
1390 my ($tmp_fh, $tmp_fn) = File::Temp::tempfile( UNLINK => 1 );
1391 binmode $tmp_fh, ':raw';
1393 my ($handles, $handle_list) = _make_gpg_handles(
1394 stdin => $args{'BlockHandle'},
1396 my %handle = %$handle_list;
1397 $handles->options( 'stdout' )->{'direct'} = 1;
1398 $handles->options( 'stdin' )->{'direct'} = 1;
1402 local $SIG{'CHLD'} = 'DEFAULT';
1403 $gnupg->passphrase( $args{'Passphrase'} );
1404 my $pid = safe_run_child { $gnupg->decrypt( handles => $handles ) };
1407 $res{'exit_code'} = $?;
1408 foreach ( qw(stderr logger status) ) {
1409 $res{$_} = do { local $/; readline $handle{$_} };
1410 delete $res{$_} unless $res{$_} && $res{$_} =~ /\S/s;
1413 $RT::Logger->debug( $res{'status'} ) if $res{'status'};
1414 $RT::Logger->warning( $res{'stderr'} ) if $res{'stderr'};
1415 $RT::Logger->error( $res{'logger'} ) if $res{'logger'} && $?;
1417 # if the decryption is fine but the signature is bad, then without this
1418 # status check we lose the decrypted text
1419 # XXX: add argument to the function to control this check
1420 if ( $res{'status'} !~ /DECRYPTION_OKAY/ ) {
1422 $res{'message'} = $@? $@: "gpg exitted with error code ". ($? >> 8);
1423 return (undef, undef, %res);
1428 return ($tmp_fh, $tmp_fn, %res);
1431 sub DecryptAttachment {
1435 Passphrase => undef,
1439 my $gnupg = new GnuPG::Interface;
1440 my %opt = RT->Config->Get('GnuPGOptions');
1442 # handling passphrase in GnuPGOptions
1443 $args{'Passphrase'} = delete $opt{'passphrase'}
1444 if !defined($args{'Passphrase'});
1446 $opt{'digest-algo'} ||= 'SHA1';
1447 $gnupg->options->hash_init(
1448 _PrepareGnuPGOptions( %opt ),
1449 meta_interactive => 0,
1452 if ( $args{'Data'}->bodyhandle->is_encoded ) {
1453 require RT::EmailParser;
1454 RT::EmailParser->_DecodeBody($args{'Data'});
1457 $args{'Passphrase'} = GetPassphrase()
1458 unless defined $args{'Passphrase'};
1460 my ($tmp_fh, $tmp_fn) = File::Temp::tempfile( UNLINK => 1 );
1461 binmode $tmp_fh, ':raw';
1462 $args{'Data'}->bodyhandle->print( $tmp_fh );
1465 my ($res_fh, $res_fn, %res) = _DecryptInlineBlock(
1468 BlockHandle => $tmp_fh,
1470 return %res unless $res_fh;
1472 $args{'Data'}->bodyhandle( new MIME::Body::File $res_fn );
1473 $args{'Data'}->{'__store_tmp_handle_to_avoid_early_cleanup'} = $res_fh;
1475 my $filename = $args{'Data'}->head->recommended_filename;
1476 $filename =~ s/\.pgp$//i;
1477 $args{'Data'}->head->mime_attr( $_ => $filename )
1478 foreach (qw(Content-Type.name Content-Disposition.filename));
1483 sub DecryptContent {
1486 Passphrase => undef,
1490 my $gnupg = new GnuPG::Interface;
1491 my %opt = RT->Config->Get('GnuPGOptions');
1493 # handling passphrase in GnupGOptions
1494 $args{'Passphrase'} = delete $opt{'passphrase'}
1495 if !defined($args{'Passphrase'});
1497 $opt{'digest-algo'} ||= 'SHA1';
1498 $gnupg->options->hash_init(
1499 _PrepareGnuPGOptions( %opt ),
1500 meta_interactive => 0,
1503 $args{'Passphrase'} = GetPassphrase()
1504 unless defined $args{'Passphrase'};
1506 my ($tmp_fh, $tmp_fn) = File::Temp::tempfile( UNLINK => 1 );
1507 binmode $tmp_fh, ':raw';
1509 my ($handles, $handle_list) = _make_gpg_handles(
1511 my %handle = %$handle_list;
1512 $handles->options( 'stdout' )->{'direct'} = 1;
1516 local $SIG{'CHLD'} = 'DEFAULT';
1517 $gnupg->passphrase( $args{'Passphrase'} );
1518 my $pid = safe_run_child { $gnupg->decrypt( handles => $handles ) };
1520 local $SIG{'PIPE'} = 'IGNORE';
1521 print { $handle{'stdin'} } ${ $args{'Content'} };
1522 close $handle{'stdin'};
1527 $res{'exit_code'} = $?;
1528 foreach ( qw(stderr logger status) ) {
1529 $res{$_} = do { local $/; readline $handle{$_} };
1530 delete $res{$_} unless $res{$_} && $res{$_} =~ /\S/s;
1533 $RT::Logger->debug( $res{'status'} ) if $res{'status'};
1534 $RT::Logger->warning( $res{'stderr'} ) if $res{'stderr'};
1535 $RT::Logger->error( $res{'logger'} ) if $res{'logger'} && $?;
1537 # if the decryption is fine but the signature is bad, then without this
1538 # status check we lose the decrypted text
1539 # XXX: add argument to the function to control this check
1540 if ( $res{'status'} !~ /DECRYPTION_OKAY/ ) {
1542 $res{'message'} = $@? $@: "gpg exitted with error code ". ($? >> 8);
1547 ${ $args{'Content'} } = '';
1550 my $status = read $tmp_fh, my $buf, 4*1024;
1551 unless ( defined $status ) {
1552 $RT::Logger->crit( "couldn't read message: $!" );
1553 } elsif ( !$status ) {
1556 ${ $args{'Content'} } .= $buf;
1562 =head2 GetPassphrase [ Address => undef ]
1564 Returns passphrase, called whenever it's required with Address as a named argument.
1569 my %args = ( Address => undef, @_ );
1575 Takes a string containing output of gnupg status stream. Parses it and returns
1576 array of hashes. Each element of array is a hash ref and represents line or
1577 group of lines in the status message.
1579 All hashes have Operation, Status and Message elements.
1585 Classification of operations gnupg performs. Now we have support
1586 for Sign, Encrypt, Decrypt, Verify, PassphraseCheck, RecipientsCheck and Data
1591 Informs about success. Value is 'DONE' on success, other values means that
1592 an operation failed, for example 'ERROR', 'BAD', 'MISSING' and may be other.
1596 User friendly message.
1600 This parser is based on information from GnuPG distribution, see also
1601 F<docs/design_docs/gnupg_details_on_output_formats> in the RT distribution.
1605 my %REASON_CODE_TO_TEXT = (
1607 1 => "No armored data",
1608 2 => "Expected a packet, but did not found one",
1609 3 => "Invalid packet found",
1610 4 => "Signature expected, but not found",
1613 0 => "No specific reason given",
1615 2 => "Ambigious specification",
1616 3 => "Wrong key usage",
1619 6 => "No CRL known",
1621 8 => "Policy mismatch",
1622 9 => "Not a secret key",
1623 10 => "Key not trusted",
1626 0 => 'not specified',
1627 4 => 'unknown algorithm',
1628 9 => 'missing public key',
1632 sub ReasonCodeToText {
1633 my $keyword = shift;
1635 return $REASON_CODE_TO_TEXT{ $keyword }{ $code }
1636 if exists $REASON_CODE_TO_TEXT{ $keyword }{ $code };
1640 my %simple_keyword = (
1642 Operation => 'RecipientsCheck',
1644 Message => 'No recipients',
1647 Operation => 'Data',
1649 Message => 'Unexpected data has been encountered',
1652 Operation => 'Data',
1654 Message => 'The ASCII armor is corrupted',
1659 my %parse_keyword = map { $_ => 1 } qw(
1661 SIG_CREATED GOODSIG BADSIG ERRSIG
1663 DECRYPTION_FAILED DECRYPTION_OKAY
1664 BAD_PASSPHRASE GOOD_PASSPHRASE
1666 NO_RECP INV_RECP NODATA UNEXPECTED
1669 # keywords we ignore without any messages as we parse them using other
1670 # keywords as starting point or just ignore as they are useless for us
1671 my %ignore_keyword = map { $_ => 1 } qw(
1672 NEED_PASSPHRASE MISSING_PASSPHRASE BEGIN_SIGNING PLAINTEXT PLAINTEXT_LENGTH
1673 BEGIN_ENCRYPTION SIG_ID VALIDSIG
1674 ENC_TO BEGIN_DECRYPTION END_DECRYPTION GOODMDC
1675 TRUST_UNDEFINED TRUST_NEVER TRUST_MARGINAL TRUST_FULLY TRUST_ULTIMATE
1680 return () unless $status;
1683 while ( $status =~ /\[GNUPG:\]\s*(.*?)(?=\[GNUPG:\]|\z)/igms ) {
1684 push @status, $1; $status[-1] =~ s/\s+/ /g; $status[-1] =~ s/\s+$//;
1686 $status = join "\n", @status;
1690 my (%user_hint, $latest_user_main_key);
1691 for ( my $i = 0; $i < @status; $i++ ) {
1692 my $line = $status[$i];
1693 my ($keyword, $args) = ($line =~ /^(\S+)\s*(.*)$/s);
1694 if ( $simple_keyword{ $keyword } ) {
1695 push @res, $simple_keyword{ $keyword };
1696 $res[-1]->{'Keyword'} = $keyword;
1699 unless ( $parse_keyword{ $keyword } ) {
1700 $RT::Logger->warning("Skipped $keyword") unless $ignore_keyword{ $keyword };
1704 if ( $keyword eq 'USERID_HINT' ) {
1705 my %tmp = _ParseUserHint($status, $line);
1706 $latest_user_main_key = $tmp{'MainKey'};
1707 if ( $user_hint{ $tmp{'MainKey'} } ) {
1708 while ( my ($k, $v) = each %tmp ) {
1709 $user_hint{ $tmp{'MainKey'} }->{$k} = $v;
1712 $user_hint{ $tmp{'MainKey'} } = \%tmp;
1716 elsif ( $keyword eq 'BAD_PASSPHRASE' || $keyword eq 'GOOD_PASSPHRASE' ) {
1719 Operation => 'PassphraseCheck',
1720 Status => $keyword eq 'BAD_PASSPHRASE'? 'BAD' : 'DONE',
1723 $res{'Status'} = 'MISSING' if $status[ $i - 1 ] =~ /^MISSING_PASSPHRASE/;
1724 foreach my $line ( reverse @status[ 0 .. $i-1 ] ) {
1725 next unless $line =~ /^NEED_PASSPHRASE\s+(\S+)\s+(\S+)\s+(\S+)/;
1726 next if $key_id && $2 ne $key_id;
1727 @res{'MainKey', 'Key', 'KeyType'} = ($1, $2, $3);
1730 $res{'Message'} = ucfirst( lc( $res{'Status'} eq 'DONE'? 'GOOD': $res{'Status'} ) ) .' passphrase';
1731 $res{'User'} = ( $user_hint{ $res{'MainKey'} } ||= {} ) if $res{'MainKey'};
1732 if ( exists $res{'User'}->{'EmailAddress'} ) {
1733 $res{'Message'} .= ' for '. $res{'User'}->{'EmailAddress'};
1735 $res{'Message'} .= " for '0x$key_id'";
1739 elsif ( $keyword eq 'END_ENCRYPTION' ) {
1741 Operation => 'Encrypt',
1743 Message => 'Data has been encrypted',
1745 foreach my $line ( reverse @status[ 0 .. $i-1 ] ) {
1746 next unless $line =~ /^BEGIN_ENCRYPTION\s+(\S+)\s+(\S+)/;
1747 @res{'MdcMethod', 'SymAlgo'} = ($1, $2);
1752 elsif ( $keyword eq 'DECRYPTION_FAILED' || $keyword eq 'DECRYPTION_OKAY' ) {
1753 my %res = ( Operation => 'Decrypt' );
1754 @res{'Status', 'Message'} =
1755 $keyword eq 'DECRYPTION_FAILED'
1756 ? ('ERROR', 'Decryption failed')
1757 : ('DONE', 'Decryption process succeeded');
1759 foreach my $line ( reverse @status[ 0 .. $i-1 ] ) {
1760 next unless $line =~ /^ENC_TO\s+(\S+)\s+(\S+)\s+(\S+)/;
1761 my ($key, $alg, $key_length) = ($1, $2, $3);
1763 my %encrypted_to = (
1764 Message => "The message is encrypted to '0x$key'",
1765 User => ( $user_hint{ $key } ||= {} ),
1767 KeyLength => $key_length,
1771 push @{ $res{'EncryptedTo'} ||= [] }, \%encrypted_to;
1776 elsif ( $keyword eq 'NO_SECKEY' || $keyword eq 'NO_PUBKEY' ) {
1777 my ($key) = split /\s+/, $args;
1778 my $type = $keyword eq 'NO_SECKEY'? 'secret': 'public';
1780 Operation => 'KeyCheck',
1781 Status => 'MISSING',
1782 Message => ucfirst( $type ) ." key '0x$key' is not available",
1786 $res{'User'} = ( $user_hint{ $key } ||= {} );
1787 $res{'User'}{ ucfirst( $type ). 'KeyMissing' } = 1;
1790 # GOODSIG, BADSIG, VALIDSIG, TRUST_*
1791 elsif ( $keyword eq 'GOODSIG' ) {
1793 Operation => 'Verify',
1795 Message => 'The signature is good',
1797 @res{qw(Key UserString)} = split /\s+/, $args, 2;
1798 $res{'Message'} .= ', signed by '. $res{'UserString'};
1800 foreach my $line ( @status[ $i .. $#status ] ) {
1801 next unless $line =~ /^TRUST_(\S+)/;
1805 $res{'Message'} .= ', trust level is '. lc( $res{'Trust'} || 'unknown');
1807 foreach my $line ( @status[ $i .. $#status ] ) {
1808 next unless $line =~ /^VALIDSIG\s+(.*)/;
1821 ) } = split /\s+/, $1, 10;
1826 elsif ( $keyword eq 'BADSIG' ) {
1828 Operation => 'Verify',
1830 Message => 'The signature has not been verified okay',
1832 @res{qw(Key UserString)} = split /\s+/, $args, 2;
1835 elsif ( $keyword eq 'ERRSIG' ) {
1837 Operation => 'Verify',
1839 Message => 'Not possible to check the signature',
1841 @res{qw(Key PubkeyAlgo HashAlgo Class Timestamp ReasonCode Other)}
1842 = split /\s+/, $args, 7;
1844 $res{'Reason'} = ReasonCodeToText( $keyword, $res{'ReasonCode'} );
1845 $res{'Message'} .= ", the reason is ". $res{'Reason'};
1849 elsif ( $keyword eq 'SIG_CREATED' ) {
1850 # SIG_CREATED <type> <pubkey algo> <hash algo> <class> <timestamp> <key fpr>
1851 my @props = split /\s+/, $args;
1853 Operation => 'Sign',
1855 Message => "Signed message",
1857 PubKeyAlgo => $props[1],
1858 HashKeyAlgo => $props[2],
1860 Timestamp => $props[4],
1861 KeyFingerprint => $props[5],
1862 User => $user_hint{ $latest_user_main_key },
1864 $res[-1]->{Message} .= ' by '. $user_hint{ $latest_user_main_key }->{'EmailAddress'}
1865 if $user_hint{ $latest_user_main_key };
1867 elsif ( $keyword eq 'INV_RECP' ) {
1868 my ($rcode, $recipient) = split /\s+/, $args, 2;
1869 my $reason = ReasonCodeToText( $keyword, $rcode );
1871 Operation => 'RecipientsCheck',
1873 Message => "Recipient '$recipient' is unusable, the reason is '$reason'",
1874 Recipient => $recipient,
1875 ReasonCode => $rcode,
1879 elsif ( $keyword eq 'NODATA' ) {
1880 my $rcode = (split /\s+/, $args)[0];
1881 my $reason = ReasonCodeToText( $keyword, $rcode );
1883 Operation => 'Data',
1885 Message => "No data has been found. The reason is '$reason'",
1886 ReasonCode => $rcode,
1891 $RT::Logger->warning("Keyword $keyword is unknown");
1894 $res[-1]{'Keyword'} = $keyword if @res && !$res[-1]{'Keyword'};
1899 sub _ParseUserHint {
1900 my ($status, $hint) = (@_);
1901 my ($main_key_id, $user_str) = ($hint =~ /^USERID_HINT\s+(\S+)\s+(.*)$/);
1902 return () unless $main_key_id;
1904 MainKey => $main_key_id,
1905 String => $user_str,
1906 EmailAddress => (map $_->address, Email::Address->parse( $user_str ))[0],
1910 sub _PrepareGnuPGOptions {
1912 my %res = map { lc $_ => $opt{ $_ } } grep $supported_opt{ lc $_ }, keys %opt;
1913 $res{'extra_args'} ||= [];
1914 foreach my $o ( grep !$supported_opt{ lc $_ }, keys %opt ) {
1915 push @{ $res{'extra_args'} }, '--'. lc $o;
1916 push @{ $res{'extra_args'} }, $opt{ $o }
1917 if defined $opt{ $o };
1924 # one arg -> return preferred key
1926 sub UseKeyForEncryption {
1929 } elsif ( @_ > 1 ) {
1931 $key{ lc($_) } = delete $key{ $_ } foreach grep lc ne $_, keys %key;
1933 return $key{ $_[0] };
1938 =head2 UseKeyForSigning
1940 Returns or sets identifier of the key that should be used for signing.
1942 Returns the current value when called without arguments.
1944 Sets new value when called with one argument and unsets if it's undef.
1949 sub UseKeyForSigning {
1956 =head2 GetKeysForEncryption
1958 Takes identifier and returns keys suitable for encryption.
1960 B<Note> that keys for which trust level is not set are
1965 sub GetKeysForEncryption {
1967 my %res = GetKeysInfo( $key_id, 'public', @_ );
1968 return %res if $res{'exit_code'};
1969 return %res unless $res{'info'};
1971 foreach my $key ( splice @{ $res{'info'} } ) {
1972 # skip disabled keys
1973 next if $key->{'Capabilities'} =~ /D/;
1974 # skip keys not suitable for encryption
1975 next unless $key->{'Capabilities'} =~ /e/i;
1976 # skip disabled, expired, revoke and keys with no trust,
1977 # but leave keys with unknown trust level
1978 next if $key->{'TrustLevel'} < 0;
1980 push @{ $res{'info'} }, $key;
1982 delete $res{'info'} unless @{ $res{'info'} };
1986 sub GetKeysForSigning {
1988 return GetKeysInfo( $key_id, 'private', @_ );
1991 sub CheckRecipients {
1992 my @recipients = (@_);
1994 my ($status, @issues) = (1, ());
1997 foreach my $address ( grep !$seen{ lc $_ }++, map $_->address, @recipients ) {
1998 my %res = GetKeysForEncryption( $address );
1999 if ( $res{'info'} && @{ $res{'info'} } == 1 && $res{'info'}[0]{'TrustLevel'} > 0 ) {
2000 # good, one suitable and trusted key
2003 my $user = RT::User->new( $RT::SystemUser );
2004 $user->LoadByEmail( $address );
2005 # it's possible that we have no User record with the email
2006 $user = undef unless $user->id;
2008 if ( my $fpr = UseKeyForEncryption( $address ) ) {
2009 if ( $res{'info'} && @{ $res{'info'} } ) {
2011 grep lc $_->{'Fingerprint'} eq lc $fpr,
2012 grep $_->{'TrustLevel'} > 0,
2018 EmailAddress => $address,
2019 $user? (User => $user) : (),
2022 $issue{'Message'} = "Selected key either is not trusted or doesn't exist anymore."; #loc
2023 push @issues, \%issue;
2028 $prefered_key = $user->PreferredKey if $user;
2029 #XXX: prefered key is not yet implemented...
2034 EmailAddress => $address,
2035 $user? (User => $user) : (),
2039 unless ( $res{'info'} && @{ $res{'info'} } ) {
2041 $issue{'Message'} = "There is no key suitable for encryption."; #loc
2043 elsif ( @{ $res{'info'} } == 1 && !$res{'info'}[0]{'TrustLevel'} ) {
2045 $issue{'Message'} = "There is one suitable key, but trust level is not set."; #loc
2049 $issue{'Message'} = "There are several keys suitable for encryption."; #loc
2051 push @issues, \%issue;
2053 return ($status, @issues);
2056 sub GetPublicKeyInfo {
2057 return GetKeyInfo( shift, 'public', @_ );
2060 sub GetPrivateKeyInfo {
2061 return GetKeyInfo( shift, 'private', @_ );
2065 my %res = GetKeysInfo(@_);
2066 $res{'info'} = $res{'info'}->[0];
2072 my $type = shift || 'public';
2076 return (exit_code => 0) unless $force;
2079 my $gnupg = new GnuPG::Interface;
2080 my %opt = RT->Config->Get('GnuPGOptions');
2081 $opt{'digest-algo'} ||= 'SHA1';
2082 $opt{'with-colons'} = undef; # parseable format
2083 $opt{'fingerprint'} = undef; # show fingerprint
2084 $opt{'fixed-list-mode'} = undef; # don't merge uid with keys
2085 $gnupg->options->hash_init(
2086 _PrepareGnuPGOptions( %opt ),
2088 meta_interactive => 0,
2093 my ($handles, $handle_list) = _make_gpg_handles();
2094 my %handle = %$handle_list;
2097 local $SIG{'CHLD'} = 'DEFAULT';
2098 my $method = $type eq 'private'? 'list_secret_keys': 'list_public_keys';
2099 my $pid = safe_run_child { $gnupg->$method( handles => $handles, $email? (command_args => $email) : () ) };
2100 close $handle{'stdin'};
2104 my @info = readline $handle{'stdout'};
2105 close $handle{'stdout'};
2107 $res{'exit_code'} = $?;
2108 foreach ( qw(stderr logger status) ) {
2109 $res{$_} = do { local $/; readline $handle{$_} };
2110 delete $res{$_} unless $res{$_} && $res{$_} =~ /\S/s;
2113 $RT::Logger->debug( $res{'status'} ) if $res{'status'};
2114 $RT::Logger->warning( $res{'stderr'} ) if $res{'stderr'};
2115 $RT::Logger->error( $res{'logger'} ) if $res{'logger'} && $?;
2117 $res{'message'} = $@? $@: "gpg exitted with error code ". ($? >> 8);
2121 @info = ParseKeysInfo( @info );
2122 $res{'info'} = \@info;
2129 my %gpg_opt = RT->Config->Get('GnuPGOptions');
2132 foreach my $line( @lines ) {
2135 ($tag, $line) = split /:/, $line, 2;
2136 if ( $tag eq 'pub' ) {
2139 TrustChar KeyLength Algorithm Key
2140 Created Expire Empty OwnerTrustChar
2141 Empty Empty Capabilities Other
2142 ) } = split /:/, $line, 12;
2144 # workaround gnupg's wierd behaviour, --list-keys command report calculated trust levels
2145 # for any model except 'always', so you can change models and see changes, but not for 'always'
2146 # we try to handle it in a simple way - we set ultimate trust for any key with trust
2147 # level >= 0 if trust model is 'always'
2149 $always_trust = 1 if exists $gpg_opt{'always-trust'};
2150 $always_trust = 1 if exists $gpg_opt{'trust-model'} && $gpg_opt{'trust-model'} eq 'always';
2151 @info{qw(Trust TrustTerse TrustLevel)} =
2152 _ConvertTrustChar( $info{'TrustChar'} );
2153 if ( $always_trust && $info{'TrustLevel'} >= 0 ) {
2154 @info{qw(Trust TrustTerse TrustLevel)} =
2155 _ConvertTrustChar( 'u' );
2158 @info{qw(OwnerTrust OwnerTrustTerse OwnerTrustLevel)} =
2159 _ConvertTrustChar( $info{'OwnerTrustChar'} );
2160 $info{ $_ } = _ParseDate( $info{ $_ } )
2161 foreach qw(Created Expire);
2164 elsif ( $tag eq 'sec' ) {
2167 Empty KeyLength Algorithm Key
2168 Created Expire Empty OwnerTrustChar
2169 Empty Empty Capabilities Other
2170 ) } = split /:/, $line, 12;
2171 @info{qw(OwnerTrust OwnerTrustTerse OwnerTrustLevel)} =
2172 _ConvertTrustChar( $info{'OwnerTrustChar'} );
2173 $info{ $_ } = _ParseDate( $info{ $_ } )
2174 foreach qw(Created Expire);
2177 elsif ( $tag eq 'uid' ) {
2179 @info{ qw(Trust Created Expire String) }
2180 = (split /:/, $line)[0,4,5,8];
2181 $info{ $_ } = _ParseDate( $info{ $_ } )
2182 foreach qw(Created Expire);
2183 push @{ $res[-1]{'User'} ||= [] }, \%info;
2185 elsif ( $tag eq 'fpr' ) {
2186 $res[-1]{'Fingerprint'} = (split /:/, $line, 10)[8];
2196 "The key has been disabled", #loc
2197 "key disabled", #loc
2202 "The key has been revoked", #loc
2207 e => [ "The key has expired", #loc
2212 n => [ "Don't trust this key at all", #loc
2217 #gpupg docs says that '-' and 'q' may safely be treated as the same value
2219 'Unknown (no trust value assigned)', #loc
2224 'Unknown (no trust value assigned)', #loc
2229 'Unknown (this value is new to the system)', #loc
2235 "There is marginal trust in this key", #loc
2240 "The key is fully trusted", #loc
2245 "The key is ultimately trusted", #loc
2251 sub _ConvertTrustChar {
2253 return @{ $verbose{'-'} } unless $value;
2254 $value = substr $value, 0, 1;
2255 return @{ $verbose{ $value } || $verbose{'o'} };
2262 return $value unless $value;
2265 my $obj = RT::Date->new( $RT::SystemUser );
2267 if ( $value =~ /^\d+$/ ) {
2268 $obj->Set( Value => $value );
2270 $obj->Set( Format => 'unknown', Value => $value, Timezone => 'utc' );
2278 my $gnupg = new GnuPG::Interface;
2279 my %opt = RT->Config->Get('GnuPGOptions');
2280 $gnupg->options->hash_init(
2281 _PrepareGnuPGOptions( %opt ),
2282 meta_interactive => 0,
2285 my ($handles, $handle_list) = _make_gpg_handles();
2286 my %handle = %$handle_list;
2289 local $SIG{'CHLD'} = 'DEFAULT';
2290 local @ENV{'LANG', 'LC_ALL'} = ('C', 'C');
2291 my $pid = safe_run_child { $gnupg->wrap_call(
2292 handles => $handles,
2293 commands => ['--delete-secret-and-public-key'],
2294 command_args => [$key],
2296 close $handle{'stdin'};
2297 while ( my $str = readline $handle{'status'} ) {
2298 if ( $str =~ /^\[GNUPG:\]\s*GET_BOOL delete_key\..*/ ) {
2299 print { $handle{'command'} } "y\n";
2305 close $handle{'stdout'};
2308 $res{'exit_code'} = $?;
2309 foreach ( qw(stderr logger status) ) {
2310 $res{$_} = do { local $/; readline $handle{$_} };
2311 delete $res{$_} unless $res{$_} && $res{$_} =~ /\S/s;
2314 $RT::Logger->debug( $res{'status'} ) if $res{'status'};
2315 $RT::Logger->warning( $res{'stderr'} ) if $res{'stderr'};
2316 $RT::Logger->error( $res{'logger'} ) if $res{'logger'} && $?;
2317 if ( $err || $res{'exit_code'} ) {
2318 $res{'message'} = $err? $err : "gpg exitted with error code ". ($res{'exit_code'} >> 8);
2326 my $gnupg = new GnuPG::Interface;
2327 my %opt = RT->Config->Get('GnuPGOptions');
2328 $gnupg->options->hash_init(
2329 _PrepareGnuPGOptions( %opt ),
2330 meta_interactive => 0,
2333 my ($handles, $handle_list) = _make_gpg_handles();
2334 my %handle = %$handle_list;
2337 local $SIG{'CHLD'} = 'DEFAULT';
2338 local @ENV{'LANG', 'LC_ALL'} = ('C', 'C');
2339 my $pid = safe_run_child { $gnupg->wrap_call(
2340 handles => $handles,
2341 commands => ['--import'],
2343 print { $handle{'stdin'} } $key;
2344 close $handle{'stdin'};
2348 close $handle{'stdout'};
2351 $res{'exit_code'} = $?;
2352 foreach ( qw(stderr logger status) ) {
2353 $res{$_} = do { local $/; readline $handle{$_} };
2354 delete $res{$_} unless $res{$_} && $res{$_} =~ /\S/s;
2357 $RT::Logger->debug( $res{'status'} ) if $res{'status'};
2358 $RT::Logger->warning( $res{'stderr'} ) if $res{'stderr'};
2359 $RT::Logger->error( $res{'logger'} ) if $res{'logger'} && $?;
2360 if ( $err || $res{'exit_code'} ) {
2361 $res{'message'} = $err? $err : "gpg exitted with error code ". ($res{'exit_code'} >> 8);
2368 Signs a small message with the key, to make sure the key exists and
2369 we have a useable passphrase. The first argument MUST be a key identifier
2370 of the signer: either email address, key id or finger print.
2372 Returns a true value if all went well.
2379 my $mime = MIME::Entity->build(
2380 Type => "text/plain",
2381 From => 'nobody@localhost',
2382 To => 'nobody@localhost',
2383 Subject => "dry sign",
2387 my %res = SignEncrypt(
2394 return $res{exit_code} == 0;
2401 This routine returns true if RT's GnuPG support is configured and working
2402 properly (and false otherwise).
2409 my $gnupg = new GnuPG::Interface;
2410 my %opt = RT->Config->Get('GnuPGOptions');
2411 $gnupg->options->hash_init(
2412 _PrepareGnuPGOptions( %opt ),
2414 meta_interactive => 0,
2417 my ($handles, $handle_list) = _make_gpg_handles();
2418 my %handle = %$handle_list;
2422 local $SIG{'CHLD'} = 'DEFAULT';
2423 my $pid = safe_run_child { $gnupg->wrap_call( commands => ['--version' ], handles => $handles ) };
2424 close $handle{'stdin'};
2429 "Probe for GPG failed."
2430 ." Couldn't run `gpg --version`: ". $@
2435 # on some systems gpg exits with code 2, but still 100% functional,
2436 # it's general error system error or incorrect command, command is correct,
2437 # but there is no way to get actuall error
2438 if ( $? && ($? >> 8) != 2 ) {
2439 my $msg = "Probe for GPG failed."
2440 ." Process exitted with code ". ($? >> 8)
2441 . ($? & 127 ? (" as recieved signal ". ($? & 127)) : '')
2443 foreach ( qw(stderr logger status) ) {
2444 my $tmp = do { local $/; readline $handle{$_} };
2445 next unless $tmp && $tmp =~ /\S/s;
2447 $msg .= "\n$_:\n$tmp\n";
2449 $RT::Logger->debug( $msg );
2456 sub _make_gpg_handles {
2457 my %handle_map = (@_);
2458 $handle_map{$_} = IO::Handle->new
2459 foreach grep !defined $handle_map{$_},
2460 qw(stdin stdout stderr logger status command);
2462 my $handles = GnuPG::Handles->new(%handle_map);
2463 return ($handles, \%handle_map);
2466 eval "require RT::Crypt::GnuPG_Vendor";
2467 if ($@ && $@ !~ qr{^Can't locate RT/Crypt/GnuPG_Vendor.pm}) {
2471 eval "require RT::Crypt::GnuPG_Local";
2472 if ($@ && $@ !~ qr{^Can't locate RT/Crypt/GnuPG_Local.pm}) {
2476 # helper package to avoid using temp file
2477 package IO::Handle::CRLF;
2479 use base qw(IO::Handle);
2482 my ($self, @args) = (@_);
2483 s/\r*\n/\x0D\x0A/g foreach @args;
2484 return $self->SUPER::print( @args );