[BACK]Return to Keyring.pm CVS log [TXT][DIR] Up to [local] / palm / Palm-Keyring / lib / Palm

Diff for /palm/Palm-Keyring/lib/Palm/Keyring.pm between version 1.1 and 1.18

version 1.1, 2006/01/26 20:54:19 version 1.18, 2007/01/30 05:18:06
Line 1 
Line 1 
 # Palm::Keyring.pm  package Palm::Keyring;
   
   # $RedRiver: Keyring.pm,v 1.17 2007/01/30 05:16:16 andrew Exp $
 #  #
 # Perl class for dealing with Keyring for Palm OS databases.  # Perl class for dealing with Keyring for Palm OS databases.
 #  #
 #       Copyright (C) 2004, Andrew Fresh  
 #       You may distribute this file under the terms of the Artistic  
 #       License, as specified in the README file distributed with the p5-Palm distribution.  
 #  
 #   This started as Memo.pm, I just made it work for Keyring.  #   This started as Memo.pm, I just made it work for Keyring.
 #  
 # $Id$  
 # $RedRiver$  
   
 use strict;  use strict;
 package Palm::Keyring;  use warnings;
 use Palm::Raw();  use Carp;
 use Palm::StdAppInfo();  
 use vars qw( $VERSION @ISA );  
   
   use base qw/ Palm::StdAppInfo /;
   
 use Digest::MD5 qw(md5);  use Digest::MD5 qw(md5);
 use Crypt::TripleDES;  use Crypt::DES;
   use Readonly;
   
 use constant ENCRYPT    =>  1;  Readonly my $ENCRYPT    => 1;
 use constant DECRYPT    =>  0;  Readonly my $DECRYPT    => 0;
 use constant MD5_CBLOCK => 64;  Readonly my $MD5_CBLOCK => 64;
 my $kSaltSize = 4;  Readonly my $kSalt_Size => 4;
   Readonly my $EMPTY      => q{};
   Readonly my $SPACE      => q{ };
   Readonly my $NULL       => chr 0;
   
   
 # One liner, to allow MakeMaker to work.  # One liner, to allow MakeMaker to work.
 $VERSION = do { my @r = (q$Revision$ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r };  our $VERSION = 0.91;
   
 @ISA = qw( Palm::StdAppInfo Palm::Raw );  sub new {
       my $classname = shift;
       my $pass      = shift;
   
 =head1 NAME      # Create a generic PDB. No need to rebless it, though.
       my $self = $classname->SUPER::new(@_);
   
 Palm::Keyring - Handler for Palm Keyring databases.      $self->{'name'}    = 'Keys-Gtkr';    # Default
       $self->{'creator'} = 'Gtkr';
       $self->{'type'}    = 'Gkyr';
   
 =head1 SYNOPSIS      # The PDB is not a resource database by
       # default, but it's worth emphasizing,
       # since MemoDB is explicitly not a PRC.
       $self->{'attributes'}{'resource'} = 0;
   
     use Palm::Keyring;      # Initialize the AppInfo block
         $pdb->Decrypt('mypassword');      $self->{'appinfo'} = {};
   
 =head1 DESCRIPTION      # Add the standard AppInfo block stuff
       Palm::StdAppInfo::seed_StdAppInfo( $self->{'appinfo'} );
   
 The Keyring PDB handler is a helper class for the Palm::PDB package. It      # Set the version
 parses Keyring databases.  See      $self->{'version'} = 4;
 L<http://gnukeyring.sourceforge.net/>.  
   
 It is just the standard Palm::Raw with 2 additional public methods.  Decrypt and Encrypt.      if ( defined $pass ) {
           $self->Password($pass);
       }
   
 =cut      return $self;
 =head2 new  }
   
   $pdb = new Palm::Keyring ('password');  sub import {
       Palm::PDB::RegisterPDBHandlers( __PACKAGE__, [ 'Gtkr', 'Gkyr' ], );
       return 1;
   }
   
 Create a new PDB, initialized with the various Palm::Keyring fields  sub ParseRecord {
 and an empty record list.      my $self     = shift;
   
 Use this method if you're creating a Keyring PDB from scratch.      my $rec = $self->SUPER::ParseRecord(@_);
   
 =cut      # skip the 0 record that holds the password
 #'      return $rec if ! exists $self->{'records'};
 sub new  
 {  
         my $classname   = shift;  
         my $pass = shift;  
   
         my $self        = $classname->SUPER::new(@_);      # skip records with no data (There shouldn't be any)
                         # Create a generic PDB. No need to rebless it,      return $rec if ! exists $rec->{'data'};
                         # though.  
   
         $self->{name} = "Keys-Gtkr";    # Default      my ( $name, $encrypted ) = split /$NULL/xm, $rec->{'data'}, 2;
         $self->{creator} = "Gtkr";  
         $self->{type} = "Gkyr";  
         $self->{attributes}{resource} = 0;  
                                 # The PDB is not a resource database by  
                                 # default, but it's worth emphasizing,  
                                 # since MemoDB is explicitly not a PRC.  
   
         # Initialize the AppInfo block      return $rec if ! $encrypted;
         $self->{appinfo} = {};      $rec->{'data'} = $name;
       $rec->{'encrypted'} = $encrypted;
   
         # Add the standard AppInfo block stuff      return $rec;
         &Palm::StdAppInfo::seed_StdAppInfo($self->{appinfo});  }
   
         # Set the version  sub PackRecord {
         $self->{version} = 4;      my $self = shift;
       my $rec  = shift;
   
         # Give the PDB the first record that will hold the encrypted password      my $rec0_id = $self->{'records'}->[0]->{'id'};
         $self->{records} = [  
                 {  
                   'category' => 0,  
                   'attributes' => {  
                                                         'private' => 1,  
                                                         'Secret' => 1,  
                                                         'Dirty' => 1,  
                                                         'dirty' => 1  
                                                   },  
                 },  
         ];  
   
         if ($pass) {      if ($rec->{'encrypted'} && ! $rec->{'id'} == $rec0_id) {
                 $self->Encrypt($pass);          $rec->{'data'} = join $NULL, $rec->{'data'}, $rec->{'encrypted'};
         }          delete $rec->{'encrypted'};
       }
   
         return $self;      return $self->SUPER::PackRecord($rec, @_);
 }  }
   
 sub import  sub Encrypt {
 {      my $self = shift;
         &Palm::PDB::RegisterPDBHandlers(__PACKAGE__,      my $rec  = shift;
                 [ "Gtkr", "Gkyr" ],      my $data = shift;
                 );      my $pass = shift || $self->{'password'};
 }  
   
 sub Encrypt      if ( ! $pass) {
 {          croak("'password' not set!\n");
         my $self = shift;      }
         my $pass = shift;  
   
         if ($pass) {      if ( ! $rec) {
                 unless ($self->_keyring_verify($pass) ) {          croak("Needed parameter 'record' not passed!\n");
                         # This would encrypt with a new password.      }
                         # First decrypting everything with the old password of course.  
                         $self->_keyring_update($pass) || return undef;  
                         $self->_keyring_verify($pass) || return undef;  
                 }  
         }  
   
         my $seen_enc_pass = 0;      if ( ! $data) {
         foreach my $record (@{ $self->{records} }) {          croak("Needed parameter 'data' not passed!\n");
                 unless ($seen_enc_pass) {      }
                         $seen_enc_pass = 1;  
                         next;  
                 }  
   
                 next unless defined $record->{plaintext};      if ( ! $self->Password($pass)) {
           croak("Incorrect Password!\n");
       }
   
                 my $name        = defined $record->{plaintext}->{name}        ? $record->{plaintext}->{name}        : '';      $self->{'digest'} ||= _calc_keys( $pass );
                 my $account     = defined $record->{plaintext}->{account}     ? $record->{plaintext}->{account}     : '';  
                 my $password    = defined $record->{plaintext}->{password}    ? $record->{plaintext}->{password}    : '';  
                 my $description = defined $record->{plaintext}->{description} ? $record->{plaintext}->{description} : '';  
                 my $extra       = '';  
   
                 my $plaintext = join("\0", $account, $password, $description, $extra);      $data->{'account'}  ||= $EMPTY;
       $data->{'password'} ||= $EMPTY;
       $data->{'notes'}    ||= $EMPTY;
   
                 my $encrypted = $self->_crypt($plaintext, ENCRYPT);      my $plaintext = join $NULL,
           $data->{'account'}, $data->{'password'}, $data->{'notes'};
   
                 $record->{data} = join("\0", $name, $encrypted);      my $encrypted = _crypt3des( $plaintext, $self->{'digest'}, $ENCRYPT );
         }  
   
         return 1;      return if ! $encrypted;
   
       $rec->{'data'} ||= $data->{'name'};
       $rec->{'encrypted'} = $encrypted;
       return 1;
 }  }
   
 sub Decrypt  sub Decrypt {
 {      my $self = shift;
         my $self = shift;      my $rec  = shift;
         my $pass = shift;      my $pass = shift || $self->{'password'};
   
         if ($pass) {      if ( ! $pass) {
                 $self->_keyring_verify($pass) || return undef;          croak("'password' not set!\n");
         }      }
   
         my $seen_enc_pass = 0;      if ( ! $rec) {
         foreach my $record (@{ $self->{records} }) {          carp("Needed parameter 'record' not passed!\n");
                 unless ($seen_enc_pass) {          return;
                         # need to skip the first record because it is the encrypted password      }
                         $seen_enc_pass = 1;  
                         next;  
                 }  
   
                 next unless defined $record->{data};      if ( ! $self->Password($pass)) {
           croak("Invalid Password!\n");
       }
   
                 my ($name, $encrypted) = split /\0/, $record->{data};      if ( ! $rec->{'encrypted'} ) {
                 $record->{plaintext}->{name} = $name;          croak("No encrypted content!");
       }
   
                 my $decrypted = $self->_crypt($encrypted, DECRYPT);      $self->{'digest'} ||= _calc_keys( $pass );
                 my ($account, $password, $description, $extra)  
                       = split /\0/, $decrypted, 4;  
   
                 $record->{plaintext}->{account}     = defined $account     ? $account     : '';      my $decrypted =
                 $record->{plaintext}->{password}    = defined $password    ? $password    : '';          _crypt3des( $rec->{'encrypted'}, $self->{'digest'}, $DECRYPT );
                 $record->{plaintext}->{description} = defined $description ? $description : '';      my ( $account, $password, $notes, $extra ) = split /$NULL/xm,
             $decrypted, 4;
   
                 #print "Extra: $extra\n";      return {
                 #--------------------------------------------------          account  => $account,
                 # print "Account:     $account\n";          password => $password,
                 # print "Password:    $password\n";          notes    => $notes,
                 # print "Description: $description\n";      };
                 #--------------------------------------------------  }
   
         }  sub Password {
       my $self = shift;
       my $pass = shift || $self->{'password'};
       my $new_pass = shift;
   
         return 1;      if (! exists $self->{'records'}) {
 }          # Give the PDB the first record that will hold the encrypted password
           $self->{'records'} = [ $self->new_Record ];
   
 sub _crypt          return $self->_password_update($pass);
 {      }
         my $self = shift;  
         my $original = shift;  
         my $flag = shift;  
   
         my $digest = $self->{digest} || $self->_calc_keys();      if ($new_pass) {
         #print "DIGEST: $digest\n";          my @accts = ();
           foreach my $i (0..$#{ $self->{'records'} }) {
               if ($i == 0) {
                   push @accts, undef;
                   next;
               }
               my $acct = $self->Decrypt($self->{'records'}->[$i], $pass);
               if ( ! $acct ) {
                   croak("Couldn't decrypt $self->{'records'}->[$i]->{'data'}");
               }
               push @accts, $acct;
           }
   
         my $des = new Crypt::TripleDES;          if ( ! $self->_password_update($new_pass)) {
               croak("Couldn't set new password!");
           }
           $pass = $new_pass;
   
         if ($flag == ENCRYPT) {          foreach my $i (0..$#accts) {
                 return $des->encrypt3($original, $digest);              next if $i == 0;
         } else {              $self->Encrypt($self->{'records'}->[$i], $accts[$i], $pass);
                 return $des->decrypt3($original, $digest);          }
         }      }
   
       return $self->_password_verify($pass);
 }  }
   
 sub _calc_keys  sub _calc_keys {
 {      my $pass = shift;
         my $self = shift;      if (! defined $pass) { croak('No password defined!'); };
   
         my $pass = $self->{'password'};      my $digest = md5($pass);
         die "No password defined!" unless defined $pass;  
   
         my $digest = md5($pass);      my ( $key1, $key2 ) = unpack 'a8a8', $digest;
   
         my ($key1, $key2) = unpack('a8a8', $digest);      #--------------------------------------------------
         #--------------------------------------------------      # print "key1: $key1: ", length $key1, "\n";
         # print "key1: $key1: ", length $key1, "\n";      # print "key2: $key2: ", length $key2, "\n";
         # print "key2: $key2: ", length $key2, "\n";      #--------------------------------------------------
         #--------------------------------------------------  
   
         $digest = unpack('H*', $key1 . $key2 . $key1);      $digest = unpack 'H*', $key1 . $key2 . $key1;
         #--------------------------------------------------  
         # print "Digest: ", $digest, "\n";  
         # print length $digest, "\n";  
         #--------------------------------------------------  
   
         $self->{digest} = $digest;      #--------------------------------------------------
         return $digest;      # print "Digest: ", $digest, "\n";
       # print length $digest, "\n";
       #--------------------------------------------------
   
       return $digest;
 }  }
   
 sub _keyring_verify  sub _password_verify {
 {      my $self = shift;
         my $self = shift;      my $pass = shift;
         my $pass = shift;  
   
         die "No password specified!" unless defined $pass;      if (! $pass) { croak('No password specified!'); };
         $self->{password} = $pass;  
   
         # AFAIK the thing we use to test the password is      if (defined $self->{'password'} && $pass eq $self->{'password'}) {
         #     always in the first entry          # already verified this password
         my $data = $self->{records}->[0]->{data};          return 1;
         #die "No encrypted password in file!" unless defined $data;      }
         return undef unless defined $data;  
   
         $data =~ s/\0$//;      # AFAIK the thing we use to test the password is
       #     always in the first entry
       my $data = $self->{'records'}->[0]->{'data'};
   
         my $salt = substr($data, 0, $kSaltSize);      #die "No encrypted password in file!" unless defined $data;
       if ( ! defined $data) { return; };
   
         my $msg = $salt . $pass;      $data =~ s/$NULL$//xm;
   
         $msg .= "\0" x (MD5_CBLOCK - length($msg));      my $salt = substr $data, 0, $kSalt_Size;
   
         my $digest = md5($msg);      my $msg = $salt . $pass;
   
         if ($data eq $salt . $digest) {      $msg .= "\0" x ( $MD5_CBLOCK - length $msg );
                 # May as well generate the keys we need now, since we know the password is right  
                 if ($self->_calc_keys()) {      my $digest = md5($msg);
                         return 1;  
                 } else {      if ( $data eq $salt . $digest ) {
                         return undef;  
                 }  # May as well generate the keys we need now, since we know the password is right
         } else {          $self->{'digest'} = _calc_keys($pass);
                 return undef;          if ( $self->{'digest'} ) {
         }              $self->{'password'} = $pass;
               return 1;
           }
       }
       return;
 }  }
   
 sub _keyring_update  sub _password_update {
 {  
         # It is very important to Encrypt after calling this  
         #     (Although it is generally only called by Encrypt)  
         # because otherwise the data will be out of sync with the  
         # password, and that would suck!  
         my $self = shift;  
         my $pass = shift;  
   
         die "No password specified!" unless defined $pass;      # It is very important to Encrypt after calling this
       #     (Although it is generally only called by Encrypt)
       # because otherwise the data will be out of sync with the
       # password, and that would suck!
       my $self = shift;
       my $pass = shift;
   
         # if the database already has a password in it      if (! defined $pass) { croak('No password specified!'); };
         if ($self->{records}->[0]->{data}) {  
                 # Make sure everything is decrypted before we update the keyring  
                 $self->Decrypt() || return undef;  
         }  
   
         my $salt;      my $salt;
         for (1..$kSaltSize) {      for ( 1 .. $kSalt_Size ) {
                 $salt .= chr(int(rand(255)));          $salt .= chr int rand 255;
         }      }
   
         my $msg = $salt . $pass;      my $msg = $salt . $pass;
   
         $msg .= "\0" x (MD5_CBLOCK - length($msg));      $msg .= "\0" x ( $MD5_CBLOCK - length $msg );
   
         my $digest = md5($msg);      my $digest = md5($msg);
   
         my $data = $salt . $digest;# . "\0";      my $data = $salt . $digest;    # . "\0";
   
         # AFAIK the thing we use to test the password is      # AFAIK the thing we use to test the password is
         #     always in the first entry      #     always in the first entry
         $self->{records}->[0]->{data} = $data;      $self->{'records'}->[0]->{'data'} = $data;
   
         $self->{password} = $pass;      $self->{'password'} = $pass;
         $self->_calc_keys();      $self->{'digest'}   = _calc_keys( $self->{'password'} );
   
         return 1;      return 1;
 }  }
   
   sub _crypt3des {
       my ( $plaintext, $passphrase, $flag ) = @_;
   
       $passphrase   .= $SPACE x ( 16 * 3 );
       my $cyphertext = $EMPTY;
   
       my $size = length $plaintext;
   
       #print "STRING: '$plaintext' - Length: " . (length $plaintext) . "\n";
   
       my @C;
       for ( 0 .. 2 ) {
           $C[$_] =
             new Crypt::DES( pack 'H*', ( substr $passphrase, 16 * $_, 16 ));
       }
   
       for ( 0 .. ( ($size) / 8 ) ) {
           my $pt = substr $plaintext, $_ * 8, 8;
   
           #print "PT: '$pt' - Length: " . length($pt) . "\n";
           if (! length $pt) { next; };
           if ( (length $pt) < 8 ) {
               if ($flag == $DECRYPT) { croak('record not 8 byte padded'); };
               my $len = 8 - (length $pt);
   
               #print "LENGTH: $len\n";
               #print "Binary:    '" . unpack("b*", $pt) . "'\n";
               $pt .= ($NULL x $len);
   
               #print "PT: '$pt' - Length: " . length($pt) . "\n";
               #print "Binary:    '" . unpack("b*", $pt) . "'\n";
           }
           if ( $flag == $ENCRYPT ) {
               $pt = $C[0]->encrypt($pt);
               $pt = $C[1]->decrypt($pt);
               $pt = $C[2]->encrypt($pt);
           }
           else {
               $pt = $C[0]->decrypt($pt);
               $pt = $C[1]->encrypt($pt);
               $pt = $C[2]->decrypt($pt);
           }
   
           #print "PT: '$pt' - Length: " . length($pt) . "\n";
           $cyphertext .= $pt;
       }
   
       $cyphertext =~ s/$NULL+$//xm;
   
       #print "CT: '$cyphertext' - Length: " . length($cyphertext) . "\n";
   
       return $cyphertext;
   }
   
 1;  1;
 __END__  __END__
   
   =head1 NAME
   
   Palm::Keyring - Handler for Palm Keyring databases.
   
   =head1 DESCRIPTION
   
   The Keyring PDB handler is a helper class for the Palm::PDB package. It
   parses Keyring for Palm OS databases.  See
   L<http://gnukeyring.sourceforge.net/>.
   
   It has the standard Palm::PDB methods with 2 additional public methods.
   Decrypt and Encrypt.
   
   It currently supports the v4 Keyring databases.  The v5 databases from
   the pre-release keyring-2.0 are not supported.
   
   This module doesn't store the decrypted content.  It only keeps it until it
   returns it to you or encrypts it.
   
   =head1 SYNOPSIS
   
       use Palm::PDB;
       use Palm::Keyring;
   
       my $pass = 'password';
       my $file = 'Keys-Gtkr.pdb';
       my $pdb  = new Palm::PDB;
       $pdb->Load($file);
   
       foreach (0..$#{ $pdb->{'records'} }) {
           next if $_ = 0; # skip the password record
           my $rec  = $pdb->{'records'}->[$_];
           my $acct = $pdb->Decrypt($rec, $pass);
           print $rec->{'data'}, ' - ', $acct->{'account'}, "\n";
       }
   
   =head1 SUBROUTINES/METHODS
   
   =head2 new
   
       $pdb = new Palm::Keyring([$password]);
   
   Create a new PDB, initialized with the various Palm::Keyring fields
   and an empty record list.
   
   Use this method if you're creating a Keyring PDB from scratch otherwise you
   can just use Palm::PDB::new() before calling Load().
   
   =head2 Encrypt
   
       $pdb->Encrypt($rec, $acct, [$password]);
   
   Encrypts an account into a record, either with the password previously
   used, or with a password that is passed.
   
   $rec is a record from $pdb->{'records'} or a newly generated record.
   $acct is a hashref in the format below.
   
       my $acct = {
           account  => $account,
           password => $password,
           notes    => $notes,
       };
   
   =head2 Decrypt
   
       my $acct = $pdb->Decrypt($rec[, $password]);
   
   Decrypts the record and returns a hashref for the account as described
   under Encrypt();
   
       foreach (0..$#{ $pdb->{'records'}) {
           next if $_ == 0;
           my $rec = $pdb->{'records'}->[$_];
           my $acct = $pdb->Decrypt($rec[, $password]);
           # do something with $acct
       }
   
   =head2 Password
   
       $pdb->Password([$password[, $new_password]]);
   
   Either sets the password to be used to crypt, or if you pass $new_password,
   changes the password on the database.
   
   If you have created a new $pdb, and you didn't set a password when you
   called new(), you only need to pass one password and it will set that as
   the password.
   
   If nothing is passed, and there has been a password used before,
   it just verifies that the password was correct.
   
   =head1 DEPENDENCIES
   
   Palm::StdAppInfo
   
   Digest::MD5
   
   Crypt::DES
   
   Readonly
   
   =head1 BUGS AND LIMITATIONS
   
   Once this module is uploaded, you can
   Please report any bugs or feature requests to
   C<bug-palm-keyring at rt.cpan.org>, or through the web interface at
   L<http://rt.cpan.org>.  I will be notified, and then you'll automatically be
   notified of progress on your bug as I make changes.
   
 =head1 AUTHOR  =head1 AUTHOR
   
 Andrew Fresh E<lt>andrew@mad-techies.org<gt>  Andrew Fresh E<lt>andrew@mad-techies.orgE<gt>
   
   =head1 LICENSE AND COPYRIGHT
   
   Copyright 2004, 2005, 2006, 2007 Andrew Fresh, All Rights Reserved.
   
   This program is free software; you can redistribute it and/or
   modify it under the same terms as Perl itself.
   
 =head1 SEE ALSO  =head1 SEE ALSO
   
 Palm::PDB(3)  Palm::PDB(3)
   
 Palm::StdAppInfo(3)  Palm::StdAppInfo(3)
   
 =cut  The Keyring for Palm OS website:
   L<http://gnukeyring.sourceforge.net/>
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.18
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>