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

   1 # {{{ BEGIN BPS TAGGED BLOCK
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2004 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., 675 Mass Ave, Cambridge, MA 02139, USA.
  26 #
  27 #
  28 # CONTRIBUTION SUBMISSION POLICY:
  29 #
  30 # (The following paragraph is not intended to limit the rights granted
  31 # to you to modify and distribute this software under the terms of
  32 # the GNU General Public License and is only of importance to you if
  33 # you choose to contribute your changes and enhancements to the
  34 # community by submitting them to Best Practical Solutions, LLC.)
  35 #
  36 # By intentionally submitting any modifications, corrections or
  37 # derivatives to this work, or any other work intended for use with
  38 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  39 # you are the copyright holder for those contributions and you grant
  40 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  41 # royalty-free, perpetual, license to use, copy, create derivative
  42 # works based on those contributions, and sublicense and distribute
  43 # those contributions and any derivatives thereof.
  44 #
  45 # }}} END BPS TAGGED BLOCK
  46 #
  47 package RT::Interface::Email::Auth::GnuPG;
  48 use Mail::GnuPG;
  49
  50 =head2 GetCurrentUser
  51
  52 To use the gnupg-secured mail gateway, you need to do the following:
  53
  54 Set up a gnupgp key directory with a pubring containing only the keys
  55 you care about and specify the following in your SiteConfig.pm
  56
  57 Set($RT::GPGKeyDir, "/path/to/keyring-directory");
  58 @RT::MailPlugins = qw(Auth::MailFrom Auth::GnuPG Filter::TakeAction);
  59
  60
  61
  62 =cut
  63
  64
  65
  66 sub GetCurrentUser {
  67     my %args = (
  68         Message     => undef,
  69         RawMessageRef     => undef,
  70         CurrentUser => undef,
  71         AuthLevel   => undef,
  72         Ticket      => undef,
  73         Queue       => undef,
  74         Action      => undef,
  75         @_
  76     );
  77
  78     my ( $val, $key, $address,$gpg );
  79
  80     eval {
  81
  82         my $parser = RT::EmailParser->new();
  83         $parser->SmartParseMIMEEntityFromScalar(Message => ${$args{'RawMessageRef'}}, Decode => 0);
  84         $gpg = Mail::GnuPG->new( keydir => $RT::GPGKeyDir );
  85         my $entity = $parser->Entity;
  86         ( $val, $key, $address ) = $gpg->verify( $parser->Entity);
  87           $RT::Logger->crit("Got $val - $key - $address");
  88       };
  89
  90         if ($@) {
  91             $RT::Logger->crit($@);
  92         }
  93
  94       unless ($address) {
  95         $RT::Logger->crit( "Couldn't find a valid signature" . join ( "\n", @{ $gpg->{'last_message'} } ) );
  96         return ( $args{'CurrentUser'}, $args{'AuthLevel'} );
  97     }
  98
  99     my @addrs = Mail::Address->parse($address);
 100     $address = $addrs[0]->address();
 101
 102     my $CurrentUser = RT::CurrentUser->new();
 103     $CurrentUser->LoadByEmail($address);
 104
 105     if ( $CurrentUser->Id ) {
 106         $RT::Logger->crit($address . " authenticated via PGP signature");
 107         return ( $CurrentUser, 2 );
 108     }
 109
 110 }
 111
 112 eval "require RT::Interface::Email::Auth::GnuPG_Vendor";
 113 die $@
 114   if ( $@
 115     && $@ !~ qr{^Can't locate RT/Interface/Email/Auth/GnuPG_Vendor.pm} );
 116 eval "require RT::Interface::Email::Auth::GnuPG_Local";
 117 die $@
 118   if ( $@
 119     && $@ !~ qr{^Can't locate RT/Interface/Email/Auth/GnuPG_Local.pm} );
 120
 121 1;