[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.65

version 1.1, 2006/01/26 20:54:19 version 1.65, 2011/09/19 04:23:37
Line 1 
Line 1 
 # Palm::Keyring.pm  package Palm::Keyring;
   # $RedRiver: Keyring.pm,v 1.62 2008/09/19 06:01:00 andrew Exp $
   ########################################################################
   # Keyring.pm *** Perl class for 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$  # 2006.01.26 #*#*# andrew fresh <andrew@cpan.org>
 # $RedRiver$  ########################################################################
   # Copyright (C) 2006, 2007 by Andrew Fresh
   #
   # This program is free software; you can redistribute it and/or modify
   # it under the same terms as Perl itself.
   ########################################################################
 use strict;  use strict;
 package Palm::Keyring;  use warnings;
 use Palm::Raw();  
 use Palm::StdAppInfo();  
 use vars qw( $VERSION @ISA );  
   
 use Digest::MD5 qw(md5);  require 5.006_001;
 use Crypt::TripleDES;  
   
 use constant ENCRYPT    =>  1;  use Carp;
 use constant DECRYPT    =>  0;  
 use constant MD5_CBLOCK => 64;  
 my $kSaltSize = 4;  
   
   use base qw/ Palm::StdAppInfo /;
   
 # One liner, to allow MakeMaker to work.  my $ENCRYPT    = 1;
 $VERSION = do { my @r = (q$Revision$ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r };  my $DECRYPT    = 0;
   my $MD5_CBLOCK = 64;
   my $kSalt_Size = 4;
   my $EMPTY      = q{};
   my $SPACE      = q{ };
   my $NULL       = chr 0;
   
 @ISA = qw( Palm::StdAppInfo Palm::Raw );  my @CRYPTS = (
       {
           alias     => 'None',
           name      => 'None',
           keylen    => 8,
           blocksize => 1,
           default_iter => 500,
       },
       {
           alias     => 'DES-EDE3',
           name      => 'DES_EDE3',
           keylen    => 24,
           blocksize =>  8,
           DES_odd_parity => 1,
           default_iter => 1000,
       },
       {
           alias     => 'AES128',
           name      => 'Rijndael',
           keylen    => 16,
           blocksize => 16,
           default_iter => 100,
       },
       {
           alias     => 'AES256',
           name      => 'Rijndael',
           keylen    => 32,
           blocksize => 16,
           default_iter => 250,
       },
       {   # Only for testing
           alias     => 'TESTING',
           name      => 'Testing',
           keylen    => 0,
           blocksize => 0,
           default_iter => 0,
       },
   );
   
 =head1 NAME  my %LABELS = (
       0 => {
           id   => 0,
           name => 'name',
       },
       1 => {
           id   => 1,
           name => 'account',
       },
       2 => {
           id   => 2,
           name => 'password',
       },
       3 => {
           id   => 3,
           name => 'lastchange',
       },
       255 => {
           id   => 255,
           name => 'notes',
       },
   );
   
 Palm::Keyring - Handler for Palm Keyring databases.  
   
 =head1 SYNOPSIS  our $VERSION = '0.96_07';
   
     use Palm::Keyring;  sub new
         $pdb->Decrypt('mypassword');  {
       my $classname = shift;
       my $options = {};
   
 =head1 DESCRIPTION      if (@_) {
           # hashref arguments
           if (ref $_[0] eq 'HASH') {
             $options = shift;
           }
   
 The Keyring PDB handler is a helper class for the Palm::PDB package. It          # CGI style arguments
 parses Keyring databases.  See          elsif ($_[0] =~ /^-[a-zA-Z0-9_]{1,20}$/) {
 L<http://gnukeyring.sourceforge.net/>.            my %tmp = @_;
             while ( my($key,$value) = each %tmp) {
               $key =~ s/^-//;
               $options->{lc $key} = $value;
             }
           }
   
 It is just the standard Palm::Raw with 2 additional public methods.  Decrypt and Encrypt.          else {
               $options->{password} = shift;
               $options->{version}  = shift;
               $options->{cipher}   = shift;
           }
       }
   
 =cut      # Create a generic PDB. No need to rebless it, though.
 =head2 new      my $self = $classname->SUPER::new();
   
   $pdb = new Palm::Keyring ('password');      $self->{name}    = 'Keys-Gtkr';    # Default
       $self->{creator} = 'Gtkr';
       $self->{type}    = 'Gkyr';
   
 Create a new PDB, initialized with the various Palm::Keyring fields      # The PDB is not a resource database by
 and an empty record list.      # default, but it's worth emphasizing,
       # since MemoDB is explicitly not a PRC.
       $self->{attributes}{resource} = 0;
   
 Use this method if you're creating a Keyring PDB from scratch.      # Set the version
       $self->{version} = $options->{version} || 4;
   
 =cut      # Set options
 #'      $self->{options} = $options;
 sub new  
       # Set defaults
       if ($self->{version} == 5) {
           $self->{options}->{cipher} ||= 0; # 'None'
           my $c = crypts($self->{options}->{cipher})
               or croak('Unknown cipher ' . $self->{options}->{cipher});
           $self->{options}->{iterations} ||= $c->{default_iter};
           $self->{appinfo}->{cipher} ||= $self->{options}->{cipher};
           $self->{appinfo}->{iter}   ||= $self->{options}->{iterations};
       };
   
       if ( defined $options->{file} ) {
           $self->Load($options->{file});
       }
   
       if ( defined $options->{password} ) {
           $self->Password($options->{password});
       }
   
       return $self;
   }
   
   sub import
 {  {
         my $classname   = shift;      Palm::PDB::RegisterPDBHandlers( __PACKAGE__, [ 'Gtkr', 'Gkyr' ], );
         my $pass = shift;      return 1;
   }
   
         my $self        = $classname->SUPER::new(@_);  # Accessors
                         # Create a generic PDB. No need to rebless it,  
                         # though.  
   
         $self->{name} = "Keys-Gtkr";    # Default  sub crypts
         $self->{creator} = "Gtkr";  {
         $self->{type} = "Gkyr";      my $crypt = shift;
         $self->{attributes}{resource} = 0;      if ((! defined $crypt) || (! length $crypt)) {
                                 # The PDB is not a resource database by          return;
                                 # default, but it's worth emphasizing,      } elsif ($crypt =~ /\D/) {
                                 # since MemoDB is explicitly not a PRC.          foreach my $c (@CRYPTS) {
               if ($c->{alias} eq $crypt) {
                   return $c;
               }
           }
           # didn't find it.
           return;
       } else {
           return $CRYPTS[$crypt];
       }
   }
   
         # Initialize the AppInfo block  sub labels
         $self->{appinfo} = {};  {
       my $label = shift;
   
         # Add the standard AppInfo block stuff      if ((! defined $label) || (! length $label)) {
         &Palm::StdAppInfo::seed_StdAppInfo($self->{appinfo});          return;
       } elsif (exists $LABELS{$label}) {
           return $LABELS{$label};
       } else {
           foreach my $l (keys %LABELS) {
               if ($LABELS{$l}{name} eq $label) {
                   return $LABELS{$l};
               }
           }
   
         # Set the version          # didn't find it, make one.
         $self->{version} = 4;          if ($label =~ /^\d+$/) {
               return {
                   id => $label,
                   name => undef,
               };
           } else {
               return;
           }
       }
   }
   
         # Give the PDB the first record that will hold the encrypted password  # Write
         $self->{records} = [  
                 {  
                   'category' => 0,  
                   'attributes' => {  
                                                         'private' => 1,  
                                                         'Secret' => 1,  
                                                         'Dirty' => 1,  
                                                         'dirty' => 1  
                                                   },  
                 },  
         ];  
   
         if ($pass) {  sub Write
                 $self->Encrypt($pass);  {
         }      my $self = shift;
   
         return $self;      if ($self->{version} == 4) {
          # Give the PDB the first record that will hold the encrypted password
           my $rec = $self->new_Record;
           $rec->{data} = $self->{encpassword};
   
           if (ref $self->{records} eq 'ARRAY') {
               unshift @{ $self->{records} }, $rec;
           } else {
               $self->{records} = [ $rec ];
           }
       }
   
       my @rc = $self->SUPER::Write(@_);
   
       if ($self->{version} == 4) {
           shift @{ $self->{records} };
       }
   
       return @rc;
 }  }
   
 sub import  # ParseRecord
   
   sub ParseRecord
 {  {
         &Palm::PDB::RegisterPDBHandlers(__PACKAGE__,      my $self     = shift;
                 [ "Gtkr", "Gkyr" ],  
                 );      my $rec = $self->SUPER::ParseRecord(@_);
       return $rec if !(defined $rec->{data} && length $rec->{data} );
   
       if ($self->{version} == 4) {
           # skip the first record because it contains the password.
           if (! exists $self->{records}) {
               $self->{encpassword} = $rec->{data};
               return '__DELETE_ME__';
           }
   
           if ($self->{records}->[0] eq '__DELETE_ME__') {
               shift @{ $self->{records} };
           }
   
           my ( $name, $encrypted ) = split /$NULL/xm, $rec->{data}, 2;
   
           return $rec if ! $encrypted;
           $rec->{plaintext}->{0} = {
               label => 'name',
               label_id => 0,
               data  => $name,
               font  => 0,
           };
           $rec->{encrypted} = $encrypted;
           delete $rec->{data};
   
       } elsif ($self->{version} == 5) {
           my $c = crypts( $self->{appinfo}->{cipher} )
               or croak('Unknown cipher ' . $self->{appinfo}->{cipher});
           my $blocksize = $c->{blocksize};
           my ($field, $extra) = _parse_field($rec->{data});
           delete $rec->{data};
   
           $rec->{plaintext}->{0} = $field;
           $rec->{ivec}      = substr $extra, 0, $blocksize;
           $rec->{encrypted} = substr $extra, $blocksize;
   
       } else {
           # XXX Can never get here to test, ParseAppInfoBlock is always run
           # XXX first by Load().
           croak "Unsupported Version $self->{version}";
       }
   
       return $rec;
 }  }
   
 sub Encrypt  # PackRecord
   
   sub PackRecord
 {  {
         my $self = shift;      my $self = shift;
         my $pass = shift;      my $rec  = shift;
   
         if ($pass) {      if ($self->{version} == 4) {
                 unless ($self->_keyring_verify($pass) ) {          if ($rec->{encrypted}) {
                         # This would encrypt with a new password.              my $name = $rec->{plaintext}->{0}->{data} || $EMPTY;
                         # First decrypting everything with the old password of course.              $rec->{data} = join $NULL, $name, $rec->{encrypted};
                         $self->_keyring_update($pass) || return undef;          }
                         $self->_keyring_verify($pass) || return undef;  
                 }  
         }  
   
         my $seen_enc_pass = 0;      }
         foreach my $record (@{ $self->{records} }) {      elsif ($self->{version} == 5) {
                 unless ($seen_enc_pass) {          croak 'No encrypted data in record' if !defined $rec->{encrypted};
                         $seen_enc_pass = 1;          croak 'No ivec!' if !$rec->{ivec};
                         next;  
                 }  
   
                 next unless defined $record->{plaintext};          my $field;
           if ($rec->{plaintext}->{0}) {
               $field = $rec->{plaintext}->{0};
           } else {
               $field = {
                   'label'    => 'name',
                   'label_id' => 0,
                   'data'     => $EMPTY,
                   'font'     => 0,
               };
           }
           my $packed = _pack_field($field);
   
                 my $name        = defined $record->{plaintext}->{name}        ? $record->{plaintext}->{name}        : '';          $rec->{data} = join $EMPTY, $packed, $rec->{ivec}, $rec->{encrypted};
                 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);      }
       else {
           croak "Unsupported Version $self->{version}";
       }
       # XXX Should I?
       #delete $rec->{plaintext};
       #delete $rec->{encrypted};
   
                 my $encrypted = $self->_crypt($plaintext, ENCRYPT);      croak 'No data in record to pack' if !$rec->{data};
   
                 $record->{data} = join("\0", $name, $encrypted);      return $self->SUPER::PackRecord($rec, @_);
         }  }
   
         return 1;  # ParseAppInfoBlock
   
   sub ParseAppInfoBlock
   {
       my $self = shift;
       my $data = shift;
       my $appinfo = {};
   
       &Palm::StdAppInfo::parse_StdAppInfo($appinfo, $data);
   
       # int8/uint8
       # - Signed or Unsigned Byte (8 bits). C types: char, unsigned char
       # int16/uint16
       # - Signed or Unsigned Word (16 bits). C types: short, unsigned short
       # int32/uint32
       # - Signed or Unsigned Doubleword (32 bits). C types: int, unsigned int
       # sz
       # - Zero-terminated C-style string
   
       if ($self->{version} == 4) {
           # Nothing extra for version 4
   
       } elsif ($self->{version} == 5) {
           _parse_appinfo_v5($appinfo);
   
       } else {
           croak "Unsupported Version $self->{version}";
       }
   
       return $appinfo;
 }  }
   
   sub _parse_appinfo_v5
   {
       my $appinfo = shift;
   
       croak 'Corrupt appinfo? no {other}' if ! $appinfo->{other};
   
       my $unpackstr
           = ("C1" x 8)  # 8 uint8s in an array for the salt
           . ("n1" x 2)  # the iter (uint16) and the cipher (uint16)
           . ("C1" x 8); # and finally 8 more uint8s for the hash
   
       my (@salt, $iter, $cipher, @hash);
       (@salt[0..7], $iter, $cipher, @hash[0..7])
           = unpack $unpackstr, $appinfo->{other};
   
       $appinfo->{salt}           = sprintf "%02x" x 8, @salt;
       $appinfo->{iter}           = $iter;
       $appinfo->{cipher}         = $cipher;
       $appinfo->{masterhash}     = sprintf "%02x" x 8, @hash;
       delete $appinfo->{other};
   
       return $appinfo
   }
   
   # PackAppInfoBlock
   
   sub PackAppInfoBlock
   {
       my $self = shift;
       my $retval;
   
       if ($self->{version} == 4) {
           # Nothing to do for v4
   
       } elsif ($self->{version} == 5) {
           _pack_appinfo_v5($self->{appinfo});
       } else {
           croak "Unsupported Version $self->{version}";
       }
       return &Palm::StdAppInfo::pack_StdAppInfo($self->{appinfo});
   }
   
   sub _pack_appinfo_v5
   {
       my $appinfo = shift;
   
       my $packstr
           = ("C1" x 8)  # 8 uint8s in an array for the salt
           . ("n1" x 2)  # the iter (uint16) and the cipher (uint16)
           . ("C1" x 8); # and finally 8 more uint8s for the hash
   
       my @salt = map { hex $_ } $appinfo->{salt} =~ /../gxm;
       my @hash = map { hex $_ } $appinfo->{masterhash} =~ /../gxm;
   
       my $packed = pack($packstr,
           @salt,
           $appinfo->{iter},
           $appinfo->{cipher},
           @hash
       );
   
       $appinfo->{other}  = $packed;
   
       return $appinfo
   }
   
   # Encrypt
   
   sub Encrypt
   {
       my $self = shift;
       my $rec  = shift || croak('Needed parameter [record] not passed!');
       my $pass = shift || $self->{password};
       my $data = shift || $rec->{plaintext};
       my $ivec = shift;
   
       $self->_password_verify($pass);
   
       if ( !$data ) { croak('Needed parameter [plaintext] not passed!'); }
   
       my $acct;
       if ($rec->{encrypted}) {
           $acct = $self->Decrypt($rec, $pass);
       }
   
       my $encrypted;
       if ($self->{version} == 4) {
           $self->{digest} ||= _calc_keys( $pass );
           my $datav4 = {
               name       => $data->{0}->{data},
               account    => $data->{1}->{data},
               password   => $data->{2}->{data},
               lastchange => $data->{3}->{data},
               notes      => $data->{255}->{data},
           };
           my $acctv4 = {};
           if ($acct) {
               $acctv4 = {
                   name       => $acct->{0}->{data},
                   account    => $acct->{1}->{data},
                   password   => $acct->{2}->{data},
                   lastchange => $acct->{3}->{data},
                   notes      => $acct->{255}->{data},
               };
           }
           $encrypted = _encrypt_v4($datav4, $acctv4, $self->{digest});
   
       } elsif ($self->{version} == 5) {
           ($encrypted, $ivec) = _encrypt_v5(
               $data, $acct,
               $self->{appinfo}->{key},
               $self->{appinfo}->{cipher},
               $ivec,
           );
           $rec->{ivec} = $ivec if $ivec;
   
       } else {
           croak "Unsupported Version $self->{version}";
       }
   
       $rec->{plaintext} = $data;
   
       if ($encrypted ne '1') {
           $rec->{attributes}{Dirty} = 1;
           $rec->{attributes}{dirty} = 1;
           $rec->{encrypted} = $encrypted;
       }
   
       return 1;
   }
   
   sub _encrypt_v4
   {
       my $new    = shift;
       my $old    = shift;
       my $digest = shift;
   
       $new->{account}  ||= $EMPTY;
       $new->{password} ||= $EMPTY;
       $new->{notes}    ||= $EMPTY;
   
       my $changed      = 0;
       my $need_newdate = 0;
       if ($old && %{ $old }) {
           no warnings 'uninitialized';
           foreach my $key (keys %{ $new }) {
               next if $key eq 'lastchange';
               if ($new->{$key} ne $old->{$key}) {
                   $changed = 1;
                   last;
               }
           }
           if ( exists $new->{lastchange} && exists $old->{lastchange} && (
               $new->{lastchange}->{day}   != $old->{lastchange}->{day}   ||
               $new->{lastchange}->{month} != $old->{lastchange}->{month} ||
               $new->{lastchange}->{year}  != $old->{lastchange}->{year}
           )) {
               $changed = 1;
               $need_newdate = 0;
           } else {
               $need_newdate = 1;
           }
   
       } else {
           $changed = 1;
       }
   
       # no need to re-encrypt if it has not changed.
       return 1 if ! $changed;
   
       my ($day, $month, $year);
   
       if ($new->{lastchange} && ! $need_newdate ) {
           $day   = $new->{lastchange}->{day}   || 1;
           $month = $new->{lastchange}->{month} || 0;
           $year  = $new->{lastchange}->{year}  || 0;
   
           # XXX Need to actually validate the above information somehow
           if ($year >= 1900) {
               $year -= 1900;
           }
       } else {
           $need_newdate = 1;
       }
   
       if ($need_newdate) {
           ($day, $month, $year) = (localtime)[3,4,5];
       }
   
       my $packed_date = _pack_keyring_date( {
               year  => $year,
               month => $month,
               day   => $day,
       });
   
       my $plaintext = join $NULL,
           $new->{account}, $new->{password}, $new->{notes}, $packed_date;
   
       return _crypt3des( $plaintext, $digest, $ENCRYPT );
   }
   
   sub _encrypt_v5
   {
       my $new    = shift;
       my $old    = shift;
       my $key    = shift;
       my $cipher = shift;
       my $ivec   = shift;
       my $c = crypts($cipher) or croak('Unknown cipher ' . $cipher);
   
       if (! defined $ivec) {
           if (!$c->{blocksize}) {
               $ivec = $EMPTY;
           }
           else {
               while (! $ivec) {
                   $ivec = pack("C*",map {rand(256)} 1..$c->{blocksize});
               }
           }
       }
   
       my $changed = 0;
       my $need_newdate = 1;
       if ($new->{3}->{data}) {
           $need_newdate = 0;
       }
   
       if ($old) {
           foreach my $k (keys %{ $new }) {
               if (! $old->{$k} ) {
                   $changed = 1;
                   last;
               }
               if (! $new->{$k}) {
                   $changed = 1;
                   last;
               }
               elsif ($k == 3) {
                   if (! $new->{$k}->{data} && $old->{$k}->{data} ) {
                       $changed = 1;
                       last;
                   }
   
                   my %n = %{ $new->{$k}->{data} };
                   my %o = %{ $old->{$k}->{data} };
   
                   foreach (qw( day month year )) {
                       $n{$_} ||= 0;
                       $o{$_} ||= 0;
                   }
   
                   if (
                       $n{day}   == $o{day}   &&
                       $n{month} == $o{month} &&
                       $n{year}  == $o{year}
                   ) {
                       $need_newdate = 1;
                   }
                   else {
                       $changed = 1;
                       last;
                   }
   
               }
               else {
                   my $n = join ':', sort %{ $new->{$k} };
                   my $o = join ':', sort %{ $old->{$k} };
                   if ($n ne $o) {
                       $changed = 1;
                       last;
                   }
               }
           }
       }
       else {
           $changed = 1;
       }
   
       return 1 if $changed == 0;
   
       if ($need_newdate) {
           my ($day, $month, $year) = (localtime)[3,4,5];
           $new->{3} = {
               label => 'lastchange',
               label_id => 3,
               font  => 0,
               data => {
                   year  => $year,
                   month => $month,
                   day   => $day,
              },
           };
       } else {
           # XXX Need to actually validate the above information somehow
           if ($new->{3}->{data}->{year} >= 1900) {
               $new->{3}->{data}->{year} -= 1900;
           }
       }
   
       my $plaintext;
       foreach my $k (keys %{ $new }) {
           next if $new->{$k}->{label_id} == 0;
           $plaintext .= _pack_field($new->{$k});
       }
       $plaintext .= chr(0xff) x 2;
   
       #print "CRYPT(e): $c->{name} [$cipher]\n";
       my $encrypted;
       if ($c->{name} eq 'None') {
           # do nothing
           $encrypted = $plaintext;
   
       } elsif ($c->{name} eq 'DES_EDE3' or $c->{name} eq 'Rijndael') {
           require Crypt::CBC;
           my $cbc = Crypt::CBC->new(
               -key         => $key,
               -literal_key => 1,
               -iv          => $ivec,
               -cipher      => $c->{name},
               -keysize     => $c->{keylen},
               -blocksize   => $c->{blocksize},
               -header      => 'none',
               -padding     => 'oneandzeroes',
           ) || croak("Unable to set up encryption!");
   
           $encrypted = $cbc->encrypt($plaintext);
   
       } else {
           croak "Unsupported Crypt $c->{name}";
       }
   
       return $encrypted, $ivec;
   }
   
   # Decrypt
   
 sub Decrypt  sub Decrypt
 {  {
         my $self = shift;      my $self = shift;
         my $pass = shift;      my $rec  = shift;
       my $pass = shift || $self->{password};
   
         if ($pass) {      if ( ! $rec) { croak('Needed parameter [record] not passed!'); }
                 $self->_keyring_verify($pass) || return undef;      if ( ! $rec->{encrypted} ) { croak('No encrypted content!'); }
         }  
   
         my $seen_enc_pass = 0;      $self->_password_verify($pass);
         foreach my $record (@{ $self->{records} }) {  
                 unless ($seen_enc_pass) {  
                         # need to skip the first record because it is the encrypted password  
                         $seen_enc_pass = 1;  
                         next;  
                 }  
   
                 next unless defined $record->{data};      my $plaintext;
       if ($self->{version} == 4) {
           $self->{digest} ||= _calc_keys( $pass );
           my $acct = _decrypt_v4($rec->{encrypted}, $self->{digest});
           $plaintext = {
               0 => $rec->{plaintext}->{0},
               1 => {
                   label    => 'account',
                   label_id => 1,
                   font     => 0,
                   data     => $acct->{account},
               },
               2 => {
                   label    => 'password',
                   label_id => 2,
                   font     => 0,
                   data     => $acct->{password},
               },
               3 => {
                   label    => 'lastchange',
                   label_id => 3,
                   font     => 0,
                   data     => $acct->{lastchange},
               },
               255 => {
                   label    => 'notes',
                   label_id => 255,
                   font     => 0,
                   data     => $acct->{notes},
               },
           };
   
                 my ($name, $encrypted) = split /\0/, $record->{data};      } elsif ($self->{version} == 5) {
                 $record->{plaintext}->{name} = $name;          $plaintext = _decrypt_v5(
               $rec->{encrypted}, $self->{appinfo}->{key},
               $self->{appinfo}->{cipher}, $rec->{ivec},
           );
           $plaintext->{0} ||= $rec->{plaintext}->{0};
   
                 my $decrypted = $self->_crypt($encrypted, DECRYPT);      } else {
                 my ($account, $password, $description, $extra)          croak "Unsupported Version $self->{version}";
                       = split /\0/, $decrypted, 4;      }
   
                 $record->{plaintext}->{account}     = defined $account     ? $account     : '';      $rec->{plaintext} = $plaintext;
                 $record->{plaintext}->{password}    = defined $password    ? $password    : '';      return $plaintext;
                 $record->{plaintext}->{description} = defined $description ? $description : '';  }
   
                 #print "Extra: $extra\n";  sub _decrypt_v4
                 #--------------------------------------------------  {
                 # print "Account:     $account\n";      my $encrypted = shift;
                 # print "Password:    $password\n";      my $digest    = shift;
                 # print "Description: $description\n";  
                 #--------------------------------------------------  
   
         }      my $plaintext = _crypt3des( $encrypted, $digest, $DECRYPT );
       my ( $account, $password, $notes, $packed_date )
           = split /$NULL/xm, $plaintext, 4;
   
         return 1;      my $modified;
       if ($packed_date) {
           #print _hexdump('DATE:', $packed_date);
           $modified = _parse_keyring_date($packed_date);
       }
   
       return {
           account    => $account,
           password   => $password,
           notes      => $notes,
           lastchange => $modified,
       };
 }  }
   
 sub _crypt  sub _decrypt_v5
 {  {
         my $self = shift;  
         my $original = shift;  
         my $flag = shift;  
   
         my $digest = $self->{digest} || $self->_calc_keys();      my $encrypted = shift;
         #print "DIGEST: $digest\n";      my $key       = shift;
       my $cipher    = shift;
       my $ivec      = shift;
   
         my $des = new Crypt::TripleDES;      my $c = crypts($cipher) or croak('Unknown cipher ' . $cipher);
   
         if ($flag == ENCRYPT) {      my $plaintext;
                 return $des->encrypt3($original, $digest);  
         } else {      #print "CRYPT(d): $c->{name} [$cipher]\n";
                 return $des->decrypt3($original, $digest);      if ($c->{name} eq 'None') {
         }          # do nothing
           $plaintext = $encrypted;
   
       }
       elsif ($c->{name} eq 'DES_EDE3' or $c->{name} eq 'Rijndael') {
           require Crypt::CBC;
           my $cbc = Crypt::CBC->new(
               -key         => $key,
               -literal_key => 1,
               -iv          => $ivec,
               -cipher      => $c->{name},
               -keysize     => $c->{keylen},
               -blocksize   => $c->{blocksize},
               -header      => 'none',
               -padding     => 'oneandzeroes',
           ) || croak("Unable to set up decryption!");
   
           my $len = $c->{blocksize} - length($encrypted) % $c->{blocksize};
           $encrypted .= $NULL x $len;
   
           $plaintext  = $cbc->decrypt($encrypted);
   
       }
       else {
           croak "Unsupported Crypt $c->{name} in decrypt";
       }
   
       my %fields;
       while ($plaintext) {
           my $field;
           ($field, $plaintext) = _parse_field($plaintext);
           last if ! $field;
           $fields{ $field->{label_id} } = $field;
       }
   
       return \%fields;
 }  }
   
 sub _calc_keys  # Password
   
   sub Password
 {  {
         my $self = shift;      my $self = shift;
       my $pass = shift;
       my $new_pass = shift;
   
         my $pass = $self->{'password'};      if (! $pass) {
         die "No password defined!" unless defined $pass;          delete $self->{password};
           delete $self->{appinfo}->{key};
           return 1;
       }
   
         my $digest = md5($pass);      if (
           ($self->{version} == 4 && ! exists $self->{encpassword}) ||
           ($self->{version} == 5 && ! exists $self->{appinfo}->{masterhash})
       ) {
           return $self->_password_update($pass);
       }
   
         my ($key1, $key2) = unpack('a8a8', $digest);      if ($new_pass) {
         #--------------------------------------------------          my @accts = ();
         # print "key1: $key1: ", length $key1, "\n";          foreach my $rec (@{ $self->{records} }) {
         # print "key2: $key2: ", length $key2, "\n";              my $acct = $self->Decrypt($rec, $pass)
         #--------------------------------------------------                  || croak("Couldn't decrypt $rec->{plaintext}->{0}->{data}");
               push @accts, $acct;
           }
   
         $digest = unpack('H*', $key1 . $key2 . $key1);          $self->_password_update($new_pass);
         #--------------------------------------------------          $pass = $new_pass;
         # print "Digest: ", $digest, "\n";  
         # print length $digest, "\n";  
         #--------------------------------------------------  
   
         $self->{digest} = $digest;          foreach my $i (0..$#accts) {
         return $digest;              delete $self->{records}->[$i]->{encrypted};
               $self->{records}->[$i]->{plaintext} = $accts[$i];
               $self->Encrypt($self->{records}->[$i], $pass);
           }
       }
   
       return $self->_password_verify($pass);
 }  }
   
 sub _keyring_verify  sub _password_verify {
       my $self = shift;
       my $pass = shift;
       if (!defined $pass) {
           $pass = $self->{password};
       }
   
       if ( !$pass ) {
           croak("Password not set!\n");
       }
   
       if (defined $self->{password} && $pass eq $self->{password}) {
           # already verified this password
           return 1;
       }
   
       if ($self->{version} == 4) {
           _password_verify_v4($pass, $self->{encpassword});
   
           # May as well generate the keys we need now,
           # since we know the password is right
           $self->{digest}   = _calc_keys($pass);
           $self->{password} = $pass;
   
           return 1;
       }
       elsif ($self->{version} == 5) {
           _password_verify_v5($self->{appinfo}, $pass);
           $self->{password} = $pass;
           return 1;
       }
   
       croak "Unsupported Version $self->{version}";
   }
   
   sub _password_verify_v4
 {  {
         my $self = shift;      require Digest::MD5;
         my $pass = shift;      import Digest::MD5 qw(md5);
   
         die "No password specified!" unless defined $pass;      my $pass = shift;
         $self->{password} = $pass;      my $data = shift;
   
         # AFAIK the thing we use to test the password is      if (! $pass) { croak('No password specified!'); }
         #     always in the first entry      if (! $data) { croak('No encrypted password in file!'); }
         my $data = $self->{records}->[0]->{data};  
         #die "No encrypted password in file!" unless defined $data;  
         return undef unless defined $data;  
   
         $data =~ s/\0$//;      $data =~ s/$NULL$//xm;
   
         my $salt = substr($data, 0, $kSaltSize);      my $salt = substr $data, 0, $kSalt_Size;
   
         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) || croak('MD5 Failed');
   
         my $digest = md5($msg);      if ($data ne $salt . $digest ) {
           croak("Incorrect Password!");
       }
   
         if ($data eq $salt . $digest) {      return 1;
                 # May as well generate the keys we need now, since we know the password is right  
                 if ($self->_calc_keys()) {  
                         return 1;  
                 } else {  
                         return undef;  
                 }  
         } else {  
                 return undef;  
         }  
 }  }
   
 sub _keyring_update  sub _password_verify_v5
 {  {
         # It is very important to Encrypt after calling this      my $appinfo = shift;
         #     (Although it is generally only called by Encrypt)      my $pass    = shift;
         # 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;      my $salt = pack("H*", $appinfo->{salt});
   
         # if the database already has a password in it      my $c = crypts($appinfo->{cipher})
         if ($self->{records}->[0]->{data}) {          or croak('Unknown cipher ' . $appinfo->{cipher});
                 # Make sure everything is decrypted before we update the keyring      my ($key, $hash) = _calc_key_v5(
                 $self->Decrypt() || return undef;          $pass, $salt, $appinfo->{iter},
         }          $c->{keylen},
           $c->{DES_odd_parity},
       );
   
         my $salt;      #print "Iter: '" . $appinfo->{iter} . "'\n";
         for (1..$kSaltSize) {      #print "Key:  '". unpack("H*", $key) . "'\n";
                 $salt .= chr(int(rand(255)));      #print "Salt: '". unpack("H*", $salt) . "'\n";
         }      #print "Hash: '". $hash . "'\n";
       #print "Hash: '". $appinfo->{masterhash} . "'\n";
   
         my $msg = $salt . $pass;      if ($appinfo->{masterhash} && $appinfo->{masterhash} ne $hash) {
           croak('Incorrect Password');
       }
       $appinfo->{key} = $key;
       return 1;
   }
   
         $msg .= "\0" x (MD5_CBLOCK - length($msg));  
   
         my $digest = md5($msg);  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;
   
         my $data = $salt . $digest;# . "\0";      if ($self->{version} == 4) {
           my $data = _password_update_v4($pass, @_);
   
         # AFAIK the thing we use to test the password is          if (! $data) { croak "Failed to update password!"; }
         #     always in the first entry  
         $self->{records}->[0]->{data} = $data;  
   
         $self->{password} = $pass;          # AFAIK the thing we use to test the password is
         $self->_calc_keys();          #     always in the first entry
           $self->{encpassword} = $data;
           $self->{password} = $pass;
           $self->{digest}   = _calc_keys( $self->{password} );
   
         return 1;          return 1;
       }
       elsif ($self->{version} == 5) {
           my $cipher  = shift || $self->{appinfo}->{cipher};
           my $iter    = shift || $self->{appinfo}->{iter};
           my $salt    = shift || 0;
   
           my $hash = _password_update_v5(
               $self->{appinfo}, $pass, $cipher, $iter, $salt
           );
   
           if (! $hash) { croak "Failed to update password!"; }
   
           $self->{password} = $pass;
   
           return 1;
       }
   
       croak "Unsupported Version $self->{version}";
 }  }
   
   sub _password_update_v4
   {
       require Digest::MD5;
       import Digest::MD5 qw(md5);
   
       my $pass = shift;
   
       croak('No password specified!') if ! defined $pass;
   
       my $salt;
       for ( 1 .. $kSalt_Size ) {
           $salt .= chr int rand 255;
       }
   
       my $msg = $salt . $pass;
   
       $msg .= "\0" x ( $MD5_CBLOCK - length $msg );
   
       my $digest = md5($msg) || croak('MD5 failed');
   
       my $data = $salt . $digest;    # . "\0";
   
       return $data;
   }
   
   sub _password_update_v5
   {
       my $appinfo = shift;
       my $pass    = shift;
       my $cipher  = shift;
       my $iter    = shift;
   
       # I thought $length needed to be 'blocksize', but apparently not.
       #my $length  = $CRYPTS[ $cipher ]{blocksize};
       my $length  = 8;
       my $salt    = shift || pack("C*",map {rand(256)} 1..$length);
   
       my $c = crypts($cipher) or croak('Unknown cipher ' . $cipher);
       my ($key, $hash) = _calc_key_v5(
           $pass, $salt, $iter,
           $c->{keylen},
           $c->{DES_odd_parity},
       );
   
       $appinfo->{salt}           = unpack "H*", $salt;
       $appinfo->{iter}           = $iter;
       $appinfo->{cipher}         = $cipher;
       $appinfo->{masterhash}     = $hash;
       $appinfo->{key}            = $key;
   
       return $key;
   }
   
   sub Unlock
   {
       my $self = shift;
       my ($pass) = @_;
       $pass ||= $self->{password};
   
       $self->_password_verify($pass);
   
       foreach my $rec (@{ $self->{records} }) {
           $self->Decrypt($rec);
       }
   
       return 1;
   
   }
   
   sub Lock
   {
       my $self = shift;
   
       $self->Password();
   
       foreach my $rec (@{ $self->{records} }) {
           my $name = $rec->{plaintext}->{0};
           delete $rec->{plaintext};
           $rec->{plaintext}->{0} = $name;
       }
   
       return 1;
   }
   
   # Helpers
   
   sub _calc_keys
   {
       require Digest::MD5;
       import Digest::MD5 qw(md5);
   
       my $pass = shift;
       if (! defined $pass) { croak('No password defined!'); };
   
       my $digest = md5($pass);
   
       my ( $key1, $key2 ) = unpack 'a8a8', $digest;
   
       #--------------------------------------------------
       # print "key1: $key1: ", length $key1, "\n";
       # print "key2: $key2: ", length $key2, "\n";
       #--------------------------------------------------
   
       $digest = unpack 'H*', $key1 . $key2 . $key1;
   
       #--------------------------------------------------
       # print "Digest: ", $digest, "\n";
       # print length $digest, "\n";
       #--------------------------------------------------
   
       return $digest;
   }
   
   sub _calc_key_v5
   {
       my ($pass, $salt, $iter, $keylen, $dop) = @_;
   
       require Digest::HMAC_SHA1;
       import  Digest::HMAC_SHA1 qw(hmac_sha1);
       require Digest::SHA1;
       import  Digest::SHA1 qw(sha1);
   
       my $key = _pbkdf2( $pass, $salt, $iter, $keylen, \&hmac_sha1 );
       $key = _DES_odd_parity($key) if $dop;
   
       my $hash = unpack("H*", substr(sha1($key.$salt),0, 8));
   
       return $key, $hash;
   }
   
   sub _crypt3des
   {
       require Crypt::DES;
   
       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);
               $pt .= ($NULL x $len);
           }
           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;
   }
   
   sub _parse_field
   {
       my $field = shift;
   
       my ($len) = unpack "n", $field;
       if ($len + 4 > length $field) {
           return (undef, $field);
       }
       my $unpackstr = "x2 C1 C1 A$len";
       my $offset    =   2 +1 +1 +$len;
       if ($len % 2) {
           # trim the 0/1 byte padding for next even address.
           $offset++;
           $unpackstr .= ' x'
       }
   
       my ($label, $font, $data) = unpack $unpackstr, $field;
       my $leftover = substr $field, $offset;
   
       my $label_id = $label;
       my $l = labels($label);
       if ($l) {
           $label = $l->{name} || $l->{id};
           $label_id = $l->{id};
       }
   
       if ($label_id && $label_id == 3) {
           ($data) = substr $field, 4, $len;
           $data = _parse_keyring_date($data);
       }
       return {
           #len      => $len,
           label    => $label,
           label_id => $label_id,
           font     => $font,
           data     => $data,
       }, $leftover;
   }
   
   sub _pack_field
   {
       my $field = shift;
   
       my $packed;
       if (defined $field) {
           my $label = $field->{label_id} || 0;
           if (defined $field->{label} && ! $label) {
               $label = $field->{label};
           }
   
           my $l = labels($field->{label});
           if ($l) {
               $label = $l->{id};
           }
   
           my $font  = $field->{font} || 0;
           my $data  = defined $field->{data} ? $field->{data} : $EMPTY;
   
           if ($label && $label == 3) {
               $data = _pack_keyring_date($data);
           }
           my $len = length $data;
           my $packstr = "n1 C1 C1 A*";
   
           $packed = pack $packstr, ($len, $label, $font, $data);
   
           if ($len % 2) {
               # add byte padding for next even address.
               $packed .= $NULL;
           }
       } else {
           my $packstr = "n1 C1 C1 x1";
           $packed = pack $packstr, 0, 0, 0;
       }
   
       return $packed;
   }
   
   sub _parse_keyring_date
   {
       my $data = shift;
   
       my $u = unpack 'n', $data;
       my $year  = (($u & 0xFE00) >> 9) + 4; # since 1900
       my $month = (($u & 0x01E0) >> 5) - 1; # 0-11
       my $day   = (($u & 0x001F) >> 0);     # 1-31
   
       return {
           year   => $year,
           month  => $month || 0,
           day    => $day   || 1,
       };
   }
   
   sub _pack_keyring_date
   {
       my $d = shift;
       my $year  = $d->{year};
       my $month = $d->{month};
       my $day   = $d->{day};
   
       $year -= 4;
       $month++;
   
       return pack 'n*', $day | ($month << 5) | ($year << 9);
   }
   
   
   sub _hexdump
   {
       my $prefix = shift;   # What to print in front of each line
       my $data = shift;     # The data to dump
       my $maxlines = shift; # Max # of lines to dump
       my $offset;           # Offset of current chunk
   
       my @lines;
   
       for ($offset = 0; $offset < length($data); $offset += 16)
       {
           my $hex;   # Hex values of the data
           my $ascii; # ASCII values of the data
           my $chunk; # Current chunk of data
   
           last if defined($maxlines) && ($offset >= ($maxlines * 16));
   
           $chunk = substr($data, $offset, 16);
   
           ($hex = $chunk) =~ s/./sprintf "%02x ", ord($&)/ges;
   
           ($ascii = $chunk) =~ y/\040-\176/./c;
   
           push @lines, sprintf "%s %-48s|%-16s|\n", $prefix, $hex, $ascii;
       }
       return wantarray ? @lines : \@lines;
   }
   
   sub _bindump
   {
       my $prefix = shift;   # What to print in front of each line
       my $data = shift;     # The data to dump
       my $maxlines = shift; # Max # of lines to dump
       my $offset;           # Offset of current chunk
   
       my @lines;
   
       for ($offset = 0; $offset < length($data); $offset += 8)
       {
           my $bin;   # binary values of the data
           my $ascii; # ASCII values of the data
           my $chunk; # Current chunk of data
   
           last if defined($maxlines) && ($offset >= ($maxlines * 8));
   
           $chunk = substr($data, $offset, 8);
   
           ($bin = $chunk) =~ s/./sprintf "%08b ", ord($&)/ges;
   
           ($ascii = $chunk) =~ y/\040-\176/./c;
   
           push @lines, sprintf "%s %-72s|%-8s|\n", $prefix, $bin, $ascii;
       }
       return wantarray ? @lines : \@lines;
   }
   
   # Thanks to Jochen Hoenicke <hoenicke@gmail.com>
   # (one of the authors of Palm Keyring)
   # for these next two subs.
   
   # Usage pbkdf2(password, salt, iter, keylen, prf)
   # iter is number of iterations
   # keylen is length of generated key in bytes
   # prf is the pseudo random function (e.g. hmac_sha1)
   # returns the key.
   sub _pbkdf2
   {
       my ($password, $salt, $iter, $keylen, $prf) = @_;
       my ($k, $t, $u, $ui, $i);
       $t = "";
       for ($k = 1; length($t) <  $keylen; $k++) {
       $u = $ui = &$prf($salt.pack('N', $k), $password);
       for ($i = 1; $i < $iter; $i++) {
           $ui = &$prf($ui, $password);
           $u ^= $ui;
       }
       $t .= $u;
       }
       return substr($t, 0, $keylen);
   }
   
   sub _DES_odd_parity {
       my $key = $_[0];
       my ($r, $i);
       my @odd_parity = (
     1,  1,  2,  2,  4,  4,  7,  7,  8,  8, 11, 11, 13, 13, 14, 14,
    16, 16, 19, 19, 21, 21, 22, 22, 25, 25, 26, 26, 28, 28, 31, 31,
    32, 32, 35, 35, 37, 37, 38, 38, 41, 41, 42, 42, 44, 44, 47, 47,
    49, 49, 50, 50, 52, 52, 55, 55, 56, 56, 59, 59, 61, 61, 62, 62,
    64, 64, 67, 67, 69, 69, 70, 70, 73, 73, 74, 74, 76, 76, 79, 79,
    81, 81, 82, 82, 84, 84, 87, 87, 88, 88, 91, 91, 93, 93, 94, 94,
    97, 97, 98, 98,100,100,103,103,104,104,107,107,109,109,110,110,
   112,112,115,115,117,117,118,118,121,121,122,122,124,124,127,127,
   128,128,131,131,133,133,134,134,137,137,138,138,140,140,143,143,
   145,145,146,146,148,148,151,151,152,152,155,155,157,157,158,158,
   161,161,162,162,164,164,167,167,168,168,171,171,173,173,174,174,
   176,176,179,179,181,181,182,182,185,185,186,186,188,188,191,191,
   193,193,194,194,196,196,199,199,200,200,203,203,205,205,206,206,
   208,208,211,211,213,213,214,214,217,217,218,218,220,220,223,223,
   224,224,227,227,229,229,230,230,233,233,234,234,236,236,239,239,
   241,241,242,242,244,244,247,247,248,248,251,251,253,253,254,254);
       for ($i = 0; $i< length($key); $i++) {
       $r .= chr($odd_parity[ord(substr($key, $i, 1))]);
       }
       return $r;
   }
   
 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 4 additional public methods.
   Unlock, Lock, Decrypt and Encrypt.
   
   It currently supports the v4 Keyring databases as well as
   the pre-release v5 databases.
   
   =head1 SYNOPSIS
   
       use Palm::PDB;
       use Palm::Keyring;
   
       my $pass = 'password';
       my $file = 'Keys-Gtkr.pdb';
       my $pdb  = new Palm::PDB;
       $pdb->Load($file);
   
       $pdb->Unlock($pass);
       foreach my $rec (@{ $pdb->{records} }) {
           print $rec->{plaintext}->{0}->{data}, ' - ',
                 $rec->{plaintext}->{1}->{data}, "\n";
       }
       $pdb->Lock();
   
   =head1 SUBROUTINES/METHODS
   
   =head2 new
   
       $pdb = new Palm::Keyring([$password[, $version[, $cipher]]]);
   
   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().
   
   If you pass in a password, it will initalize the database with the encrypted
   password.
   
   new() now also takes options in other formats
   
       $pdb = new Palm::Keyring({ key1 => value1,  key2 => value2 });
       $pdb = new Palm::Keyring( -key1 => value1, -key2 => value2);
   
   =over
   
   =item Supported options
   
   =over
   
   =item password
   
   The password used to initialize the database
   
   =item version
   
   The version of database to create.  Accepts either 4 or 5.  Currently defaults to 4.
   
   =item cipher
   
   The cipher to use.  Either the number or the name.  Only used by v5 datbases.
   
       0 => None
       1 => DES_EDE3
       2 => AES128
       3 => AES256
   
   =item iterations
   
   The number of iterations to encrypt with.  Only used by somy crypts in v5 databases.
   
   =item file
   
   The name of a file to Load().  This will override many of the other options.
   
   =back
   
   =back
   
   For v5 databases there are some additional appinfo fields set.
   These are set either on new() or Load().
   
       $pdb->{appinfo} = {
           # normal appinfo stuff described in L<Palm::StdAppInfo>
           cipher     => The index number of the cipher being used
           iter       => Number of iterations for the cipher
       };
   
   =head2 crypts
   
   Pass in the alias of the crypt to use, or the index.
   
   These only make sense for v5 databases.
   
   This is a function, not a method.
   
   $cipher can be 0, 1, 2, 3, None, DES_EDE3, AES128 or AES256.
   
       my $c = Palm::Keyring::crypt($cipher);
   
   $c is now:
   
       $c = {
           alias     => (None|DES_EDE3|AES128|AES256),
           name      => (None|DES_EDE3|Rijndael),
           keylen    => <key length of the cipher>,
           blocksize => <block size of the cipher>,
           default_iter => <default iterations for the cipher>,
       };
   
   If it is unable to find the crypt it will return undef.
   
   =head2 labels
   
   Pass in the id or the name of the label.  The label id is used as a key
   to the different parts of the records.
   See Encrypt() for details on where the label is used.
   
   This is a function, not a method.
   
       my $l = Palm::Keyring::labels($label);
   
   $l is now:
   
       $l = {
           id => 0,
           name => 'name',
       };
   
   If what you passed in was a number that doesn't have a name, it will return:
   
       $l => {
           id => $num_passed_in,
           name => undef,
       }
   
   If you pass in a name that it can't find, then it returns undef.
   
   =head2 Encrypt
   
   =head3 B<!!! IMPORTANT !!!>  The order of the arguments to Encrypt has
   changed.  $password and $plaintext used to be swapped.  They changed
   because you can now set $rec->{plaintext} and not pass in $plaintext so
   $password is more important.
   
       $pdb->Encrypt($rec[, $password[, $plaintext[, $ivec]]]);
   
   Encrypts an account into a record, either with the password previously
   used, or with a password that is passed.
   
   $ivec is the initialization vector to use to encrypt the record.  This is
   not used by v4 databases.  Normally this is not passed and is generated
   randomly.
   
   $rec is a record from $pdb->{records} or a new_Record().
   $rec->{plaintext} is a hashref in the format below.
   
       $plaintext = {
           0 => {
               label    => 'name',
               label_id => 0,
               font     => 0,
               data     => $name,
           1 => {
               label    => 'account',
               label_id => 1,
               font     => 0,
               data     => $account,
           },
           2 => {
               label    => 'password',
               label_id => 2,
               font     => 0,
               data     => $password,
           },
           3 => {
               label    => 'lastchange',
               label_id => 3,
               font     => 0,
               data     => {
                   year => $year, # usually the year - 1900
                   mon  => $mon,  # range 0-11
                   day  => $day,  # range 1-31
               },
           },
           255 => {
               label    => 'notes',
               label_id => 255,
               font     => 0,
               data     => $notes,
           },
       };
   
   The account name is stored in $rec->{plaintext}->{0}->{data} for both v4
   and v5 databases even when the record has not been Decrypt()ed.
   
       $rec->{plaintext}->{0} => {
           label    => 'name',
           label_id => 0,
           font     => 0,
           data     => 'account name',
       };
   
   If you have changed anything other than the lastchange, or don't pass in a
   lastchange key, Encrypt() will generate a new lastchange date for you.
   
   If you pass in a lastchange field that is different than the one in the
   record, it will honor what you passed in.
   
   You can either set $rec->{plaintext} or pass in $plaintext.  $plaintext
   is used over anything in $rec->{plaintext}.
   
   
   =head2 Decrypt
   
       my $plaintext = $pdb->Decrypt($rec[, $password]);
   
   Decrypts the record and returns a reference for the plaintext account as
   described under Encrypt().
   Also sets $rec->{plaintext} with the same information as $plaintext as
   described in Encrypt().
   
       foreach my $rec (@{ $pdb->{records} }) {
           my $plaintext = $pdb->Decrypt($rec);
           # do something with $plaintext
       }
   
   
   =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, it forgets the password that it was remembering.
   
   After a successful password verification the following fields are set
   
   For v4
   
       $pdb->{digest}   = the calculated digest used from the key;
       $pdb->{password} = the password that was passed in;
       $pdb->{encpassword} = the password as stored in the pdb;
   
   For v5
   
       $pdb->{appinfo} = {
           # As described under new() with these additional fields
           cipher     => The index number of the cipher being used
           iter       => Number of iterations for the cipher
           key        => The key that is calculated from the password
                         and salt and is used to decrypt the records.
           masterhash => the hash of the key that is stored in the
                         database.  Either set when Loading the database
                         or when setting a new password.
           salt       => the salt that is either read out of the database
                         or calculated when setting a new password.
       };
   
   =head2 Unlock
   
       $pdb->Unlock([$password]);
   
   Decrypts all the records.  Sets $rec->{plaintext} for all records.
   
   This makes it easy to show all decrypted information.
   
      my $pdb = Palm::KeyRing->new();
      $pdb->Load($keyring_file);
      $pdb->Unlock($password);
      foreach my $plaintext (map { $_->{plaintext} } @{ $pdb->{records} }) {
          # Do something like display the account.
      }
      $pdb->Lock();
   
   =head2 Lock
   
       $pdb->Lock();
   
   Unsets $rec->{plaintext} for all records and unsets the saved password.
   
   This does NOT Encrypt() any of the records before clearing them, so if
   you are not careful you will lose information.
   
   B<CAVEAT!> This only does "delete $rec->{plaintext}" and the same for the
   password.  If someone knows of a cross platform reliable way to make
   sure that the information is actually cleared from memory I would
   appreciate it.  Also, if someone knows how to make sure that the stuff
   in $rec->{plaintext} is not written to swap, that would be very handy as
   well.
   
   =head2 Other overridden subroutines/methods
   
   =over
   
   =item ParseAppInfoBlock
   
   Converts the extra returned by Palm::StdAppInfo::ParseAppInfoBlock() into
   the following additions to $pdb->{appinfo}
   
       $pdb->{appinfo} = {
           cipher     => The index number of the cipher being used (Not v4)
           iter       => Number of iterations for the cipher (Not v4)
       };
   
   =item PackAppInfoBlock
   
   Reverses ParseAppInfoBlock before
   sending it on to Palm::StdAppInfo::PackAppInfoBlock()
   
   =item ParseRecord
   
   Adds some fields to a record from Palm::StdAppInfo::ParseRecord()
   
       $rec = {
           name       => Account name
           ivec       => The IV for the encrypted record.  (Not v4)
           encrypted  => the encrypted information
       };
   
   For v4 databases it also removes record 0 and moves the encrypted password
   to $self->{encpassword}.
   
   =item PackRecord
   
   Reverses ParseRecord and then sends it through Palm::StdAppInfo::PackRecord()
   
   =item Write
   
   For v4 databases it puts back the record 0 for the encrypted password before
   writing it.
   
   =back
   
   =head1 DEPENDENCIES
   
   Palm::StdAppInfo
   
   B<For v4 databases>
   
   Digest::MD5
   
   Crypt::DES
   
   B<For v5 databases>
   
   Digest::HMAC_SHA1
   
   Digest::SHA1
   
   Depending on how the database is encrypted
   
   Crypt::CBC - For any encryption but None
   
   Crypt::DES_EDE3 - DES_EDE3 encryption
   
   Crytp::Rijndael - AES encryption schemes
   
   =head1 THANKS
   
   I would like to thank the helpful Perlmonk shigetsu who gave me some great
   advice and helped me get my first module posted.
   L<http://perlmonks.org/?node_id=596998>
   
   I would also like to thank
   Johan Vromans
   E<lt>jvromans@squirrel.nlE<gt> --
   L<http://www.squirrel.nl/people/jvromans>.
   He had his own Palm::KeyRing module that he posted a couple of days before
   mine was ready and he was kind enough to let me have the namespace as well
   as giving me some very helpful hints about doing a few things that I was
   unsure of.  He is really great.
   
   And finally,
   thanks to Jochen Hoenicke E<lt>hoenicke@gmail.comE<gt>
   (one of the authors of Palm Keyring)
   for getting me started on the v5 support as well as providing help
   and some subroutines.
   
   =head1 BUGS AND LIMITATIONS
   
   I am sure there are problems with this module.  For example, I have
   not done very extensive testing of the v5 databases.
   
   I am not sure I am 'require module' the best way, but I don't want to
   depend on modules that you don't need to use.
   
   The date validation for packing new dates is very poor.
   
   I have not gone through and standardized on how the module fails.  Some
   things fail with croak, some return undef, some may even fail silently.
   Nothing initializes a lasterr method or anything like that.
   
   This module does not do anything special with the plaintext data.  It SHOULD
   treat it somehow special so that it can't be found in RAM or in a swap file
   anywhere.  I don't have a clue how to do this.
   
   I need to fix all this before it is a 1.0 candidate.
   
   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@cpan.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/>
   
   The HACKING guide for palm keyring databases:
   L<http://gnukeyring.cvs.sourceforge.net/*checkout*/gnukeyring/keyring/HACKING>
   
   Johan Vromans also has a wxkeyring app that now uses this module, available
   from his website at L<http://www.vromans.org/johan/software/sw_palmkeyring.html>
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.65
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>