rt/lib/RT/Interface/Email/Auth/GnuPG.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2007 Best Practical Solutions, LLC
   6 #                                          <jesse@bestpractical.com>
   7 #
   8 # (Except where explicitly superseded by other copyright notices)
   9 #
  10 #
  11 # LICENSE:
  12 #
  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
  16 # from www.gnu.org.
  17 #
  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.
  22 #
  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/copyleft/gpl.html.
  28 #
  29 #
  30 # CONTRIBUTION SUBMISSION POLICY:
  31 #
  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.)
  37 #
  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.
  46 #
  47 # END BPS TAGGED BLOCK }}}
  48 #
  49 package RT::Interface::Email::Auth::GnuPG;
  50 use Mail::GnuPG;
  51
  52 =head2 GetCurrentUser
  53
  54 To use the gnupg-secured mail gateway, you need to do the following:
  55
  56 Set up a gnupgp key directory with a pubring containing only the keys
  57 you care about and specify the following in your SiteConfig.pm
  58
  59 Set($RT::GPGKeyDir, "/path/to/keyring-directory");
  60 @RT::MailPlugins = qw(Auth::MailFrom Auth::GnuPG Filter::TakeAction);
  61
  62
  63
  64 =cut
  65
  66
  67
  68 sub GetCurrentUser {
  69     my %args = (
  70         Message     => undef,
  71         RawMessageRef     => undef,
  72         CurrentUser => undef,
  73         AuthLevel   => undef,
  74         Ticket      => undef,
  75         Queue       => undef,
  76         Action      => undef,
  77         @_
  78     );
  79
  80     my ( $val, $key, $address,$gpg );
  81
  82     eval {
  83
  84         my $parser = RT::EmailParser->new();
  85         $parser->SmartParseMIMEEntityFromScalar(Message => ${$args{'RawMessageRef'}}, Decode => 0);
  86         $gpg = Mail::GnuPG->new( keydir => $RT::GPGKeyDir );
  87         my $entity = $parser->Entity;
  88         ( $val, $key, $address ) = $gpg->verify( $parser->Entity);
  89           $RT::Logger->crit("Got $val - $key - $address");
  90       };
  91
  92         if ($@) {
  93             $RT::Logger->crit($@);
  94         }
  95
  96       unless ($address) {
  97         $RT::Logger->crit( "Couldn't find a valid signature" . join ( "\n", @{ $gpg->{'last_message'} } ) );
  98         return ( $args{'CurrentUser'}, $args{'AuthLevel'} );
  99     }
 100
 101     my @addrs = Mail::Address->parse($address);
 102     $address = $addrs[0]->address();
 103
 104     my $CurrentUser = RT::CurrentUser->new();
 105     $CurrentUser->LoadByEmail($address);
 106
 107     if ( $CurrentUser->Id ) {
 108         $RT::Logger->crit($address . " authenticated via PGP signature");
 109         return ( $CurrentUser, 2 );
 110     }
 111
 112 }
 113
 114 eval "require RT::Interface::Email::Auth::GnuPG_Vendor";
 115 die $@
 116   if ( $@
 117     && $@ !~ qr{^Can't locate RT/Interface/Email/Auth/GnuPG_Vendor.pm} );
 118 eval "require RT::Interface::Email::Auth::GnuPG_Local";
 119 die $@
 120   if ( $@
 121     && $@ !~ qr{^Can't locate RT/Interface/Email/Auth/GnuPG_Local.pm} );
 122
 123 1;