[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.28 and 1.53

version 1.28, 2007/02/18 05:50:25 version 1.53, 2007/12/04 03:34:17
Line 1 
Line 1 
 package Palm::Keyring;  package Palm::Keyring;
 # $RedRiver: Keyring.pm,v 1.27 2007/02/10 16:21:28 andrew Exp $  # $RedRiver: Keyring.pm,v 1.52 2007/12/04 03:33:34 andrew Exp $
 ########################################################################  ########################################################################
 # Keyring.pm *** Perl class for Keyring for Palm OS databases.  # Keyring.pm *** Perl class for Keyring for Palm OS databases.
 #  #
Line 19 
Line 19 
   
 use base qw/ Palm::StdAppInfo /;  use base qw/ Palm::StdAppInfo /;
   
 use Digest::HMAC_SHA1 qw(hmac_sha1);  
 use Digest::SHA1 qw(sha1);  
 use Crypt::CBC;  
   
 use Digest::MD5 qw(md5);  
 use Crypt::DES;  
   
 my $ENCRYPT    = 1;  my $ENCRYPT    = 1;
 my $DECRYPT    = 0;  my $DECRYPT    = 0;
 my $MD5_CBLOCK = 64;  my $MD5_CBLOCK = 64;
Line 35 
Line 28 
 my $NULL       = chr 0;  my $NULL       = chr 0;
   
 my @CRYPTS = (  my @CRYPTS = (
     { # None      {
           alias     => 'None',
         name      => 'None',          name      => 'None',
         keylen    => 8,          keylen    => 8,
         blocksize => 1,          blocksize => 1,
           default_iter => 500,
     },      },
     { # DES-EDE3      {
           alias     => 'DES-EDE3',
         name      => 'DES_EDE3',          name      => 'DES_EDE3',
         keylen    => 24,          keylen    => 24,
         blocksize =>  8,          blocksize =>  8,
         DES_odd_parity => 1,          DES_odd_parity => 1,
           default_iter => 1000,
     },      },
     { # AES128      {
           alias     => 'AES128',
         name      => 'Rijndael',          name      => 'Rijndael',
         keylen    => 16,          keylen    => 16,
         blocksize => 16,          blocksize => 16,
           default_iter => 100,
     },      },
     { # AES256      {
           alias     => 'AES256',
         name      => 'Rijndael',          name      => 'Rijndael',
         keylen    => 32,          keylen    => 32,
         blocksize => 16,          blocksize => 16,
           default_iter => 250,
     },      },
 );  );
   
   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',
       },
   );
   
 our $VERSION = 0.95;  
   
   our $VERSION = '0.96_06';
   
 sub new  sub new
 {  {
     my $classname = shift;      my $classname = shift;
     my $options = {};      my $options = {};
   
     # hashref arguments      if (@_) {
     if (ref $_[0] eq 'HASH') {          # hashref arguments
       $options = shift;          if (ref $_[0] eq 'HASH') {
     }            $options = shift;
           }
   
     # CGI style arguments          # CGI style arguments
     elsif ($_[0] =~ /^-[a-zA-Z_]{1,20}$/) {          elsif ($_[0] =~ /^-[a-zA-Z0-9_]{1,20}$/) {
       my %tmp = @_;            my %tmp = @_;
       while ( my($key,$value) = each %tmp) {            while ( my($key,$value) = each %tmp) {
         $key =~ s/^-//;              $key =~ s/^-//;
         $options->{lc $key} = $value;              $options->{lc $key} = $value;
       }            }
     }          }
   
     else {          else {
         $options->{password} = shift;              $options->{password} = shift;
         $options->{version}  = shift;              $options->{version}  = shift;
           }
     }      }
   
     # Create a generic PDB. No need to rebless it, though.      # Create a generic PDB. No need to rebless it, though.
Line 103 
Line 129 
     # Set options      # Set options
     $self->{options} = $options;      $self->{options} = $options;
   
       # 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->{password} ) {      if ( defined $options->{password} ) {
         $self->Password($options->{password});          $self->Password($options->{password});
     }      }
Line 116 
Line 152 
     return 1;      return 1;
 }  }
   
 # PackRecord  # Accessors
   
   sub crypts
   {
       my $crypt = shift;
       if ((! defined $crypt) || (! length $crypt)) {
           return;
       } elsif ($crypt =~ /\D/) {
           foreach my $c (@CRYPTS) {
               if ($c->{alias} eq $crypt) {
                   return $c;
               }
           }
           # didn't find it.
           return;
       } else {
           return $CRYPTS[$crypt];
       }
   }
   
   sub labels
   {
       my $label = shift;
   
       if ((! defined $label) || (! length $label)) {
           return;
       } elsif (exists $LABELS{$label}) {
           return $LABELS{$label};
       } else {
           foreach my $l (keys %LABELS) {
               if ($LABELS{$l}{name} eq $label) {
                   return $LABELS{$l};
               }
           }
   
           # didn't find it, make one.
           if ($label =~ /^\d+$/) {
               return {
                   id => $label,
                   name => undef,
               };
           } else {
               return;
           }
       }
   }
   
   # Write
   
   sub Write
   {
       my $self = shift;
   
       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;
   }
   
   # ParseRecord
   
 sub ParseRecord  sub ParseRecord
 {  {
     my $self     = shift;      my $self     = shift;
Line 127 
Line 237 
   
     if ($self->{version} == 4) {      if ($self->{version} == 4) {
         # skip the first record because it contains the password.          # skip the first record because it contains the password.
         return $rec if ! exists $self->{records};          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;          my ( $name, $encrypted ) = split /$NULL/xm, $rec->{data}, 2;
   
         return $rec if ! $encrypted;          return $rec if ! $encrypted;
         $rec->{name}      = $name;          $rec->{plaintext}->{0} = {
               label => 'name',
               label_id => 0,
               data  => $name,
               font  => 0,
           };
         $rec->{encrypted} = $encrypted;          $rec->{encrypted} = $encrypted;
         delete $rec->{data};          delete $rec->{data};
   
     } elsif ($self->{version} == 5) {      } elsif ($self->{version} == 5) {
         my $blocksize = $self->{appinfo}->{blocksize};          my $c = crypts( $self->{appinfo}->{cipher} )
               or croak('Unknown cipher ' . $self->{appinfo}->{cipher});
           my $blocksize = $c->{blocksize};
         my ($field, $extra) = _parse_field($rec->{data});          my ($field, $extra) = _parse_field($rec->{data});
         my ($ivec, $encrypted) = unpack "A$blocksize A*", $extra;          delete $rec->{data};
   
         if ($self->{options}->{v4compatible}) {          $rec->{plaintext}->{0} = $field;
             $rec->{name} = $field->{data};          $rec->{ivec}      = substr $extra, 0, $blocksize;
         } else {          $rec->{encrypted} = substr $extra, $blocksize;
             $rec->{name} = $field;  
         }  
         $rec->{ivec}      = $ivec;  
         $rec->{encrypted} = $encrypted;  
   
     } else {      } else {
         # XXX Unsupported version!          croak "Unsupported Version $self->{version}";
         return;          return;
     }      }
   
     return $rec;      return $rec;
 }  }
   
 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,  
     };  
 }  
   
 # PackRecord  # PackRecord
   
 sub PackRecord  sub PackRecord
Line 182 
Line 286 
   
     if ($self->{version} == 4) {      if ($self->{version} == 4) {
         if ($rec->{encrypted}) {          if ($rec->{encrypted}) {
             if (! defined $rec->{name}) {              my $name = $rec->{plaintext}->{0}->{data} || $EMPTY;
                 $rec->{name} = $EMPTY;              $rec->{data} = join $NULL, $name, $rec->{encrypted};
             }              delete $rec->{plaintext};
             $rec->{data} = join $NULL, $rec->{name}, $rec->{encrypted};  
             delete $rec->{name};  
             delete $rec->{encrypted};              delete $rec->{encrypted};
         }          }
   
     } elsif ($self->{version} == 5) {      } elsif ($self->{version} == 5) {
         # XXX do something          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);
   
           $rec->{data} = join $EMPTY, $packed, $rec->{ivec}, $rec->{encrypted};
   
     } else {      } else {
         # XXX Unsupported version!          croak "Unsupported Version $self->{version}";
         return;  
     }      }
   
     return $self->SUPER::PackRecord($rec, @_);      return $self->SUPER::PackRecord($rec, @_);
 }  }
   
 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);  
 }  
   
 # ParseAppInfoBlock  # ParseAppInfoBlock
   
 sub ParseAppInfoBlock  sub ParseAppInfoBlock
Line 238 
Line 341 
         _parse_appinfo_v5($appinfo) || return;          _parse_appinfo_v5($appinfo) || return;
   
     } else {      } else {
         # XXX Unknown version          croak "Unsupported Version $self->{version}";
         return;  
     }      }
   
     return $appinfo;      return $appinfo;
Line 256 
Line 358 
   
     my $unpackstr      my $unpackstr
         = ("C1" x 8)  # 8 uint8s in an array for the salt          = ("C1" x 8)  # 8 uint8s in an array for the salt
         . ("S1" x 2)  # the iter (uint16) and the cipher (uint16)          . ("n1" x 2)  # the iter (uint16) and the cipher (uint16)
         . ("C1" x 8); # and finally 8 more uint8s for the hash          . ("C1" x 8); # and finally 8 more uint8s for the hash
   
     my (@salt, $iter, $cipher, @hash);      my (@salt, $iter, $cipher, @hash);
Line 266 
Line 368 
     $appinfo->{salt}           = sprintf "%02x" x 8, @salt;      $appinfo->{salt}           = sprintf "%02x" x 8, @salt;
     $appinfo->{iter}           = $iter;      $appinfo->{iter}           = $iter;
     $appinfo->{cipher}         = $cipher;      $appinfo->{cipher}         = $cipher;
     $appinfo->{keylen}         = $CRYPTS[$appinfo->{cipher}]{keylen};  
     $appinfo->{blocksize}      = $CRYPTS[$appinfo->{cipher}]{blocksize};  
     $appinfo->{DES_odd_parity} = $CRYPTS[$appinfo->{cipher}]{DES_odd_parity};  
     $appinfo->{cipher_name}    = $CRYPTS[$appinfo->{cipher}]{name};  
     $appinfo->{masterhash}     = sprintf "%02x" x 8, @hash;      $appinfo->{masterhash}     = sprintf "%02x" x 8, @hash;
     delete $appinfo->{other};      delete $appinfo->{other};
   
Line 287 
Line 385 
         # Nothing to do for v4          # Nothing to do for v4
   
     } elsif ($self->{version} == 5) {      } elsif ($self->{version} == 5) {
         croak("Unsupported version!");          _pack_appinfo_v5($self->{appinfo});
         #$self->{appinfo}{other} = <pack application-specific data>;  
     } else {      } else {
         # XXX Unknown version          croak "Unsupported Version $self->{version}";
         return;  
     }      }
     return &Palm::StdAppInfo::pack_StdAppInfo($self->{appinfo});      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  # Encrypt
   
 sub Encrypt  sub Encrypt
 {  {
     my $self = shift;      my $self = shift;
     my $rec  = shift;      my $rec  = shift;
     my $data = shift;  
     my $pass = shift || $self->{password};      my $pass = shift || $self->{password};
       my $data = shift || $rec->{plaintext};
       my $ivec = shift;
   
     if ( ! $pass && ! $self->{key}) {      if ( ! $pass && ! $self->{appinfo}->{key}) {
         croak("password not set!\n");          croak("password not set!\n");
     }      }
   
Line 314 
Line 435 
     }      }
   
     if ( ! $data) {      if ( ! $data) {
         croak("Needed parameter 'data' not passed!\n");          croak("Needed 'plaintext' not passed!\n");
     }      }
   
     if ( ! $self->Password($pass)) {      if ( $pass && ! $self->Password($pass)) {
         croak("Incorrect Password!\n");          croak("Incorrect Password!\n");
     }      }
   
       my $acct;
       if ($rec->{encrypted}) {
           $acct = $self->Decrypt($rec, $pass);
       }
   
       my $encrypted;
     if ($self->{version} == 4) {      if ($self->{version} == 4) {
         $self->{digest} ||= _calc_keys( $pass );          $self->{digest} ||= _calc_keys( $pass );
         my $acct = {};          my $datav4 = {
         if ($rec->{encrypted}) {              name       => $data->{0}->{data},
             $acct = $self->Decrypt($rec, $pass);              account    => $data->{1}->{data},
               password   => $data->{2}->{data},
               lastchange => $data->{3}->{data},
               notes      => $data->{255}->{data},
           };
           my $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,
           );
           if (defined $ivec) {
               $rec->{ivec} = $ivec;
         }          }
         my $encrypted = _encrypt_v4($data, $self->{digest}, $acct);  
         if ($encrypted) {      } else {
             $rec->{attributes}{Dirty} = 1;          croak "Unsupported Version $self->{version}";
             $rec->{attributes}{dirty} = 1;      }
             $rec->{name}    ||= $data->{name};  
             $rec->{encrypted} = $encrypted;      $rec->{plaintext}->{0} = $data->{0};
   
       if ($encrypted) {
           if ($encrypted eq '1') {
             return 1;              return 1;
         }          }
     } elsif ($self->{version} == 5) {  
         croak("Unsupported version!");          $rec->{attributes}{Dirty} = 1;
         return _encrypt_v5(          $rec->{attributes}{dirty} = 1;
             $rec->{encrypted}, $rec->{ivec}, $self->{key},          $rec->{encrypted} = $encrypted;
             $self->{appinfo}->{keylen}, $self->{appinfo}->{cipher_name},  
         );          return 1;
     } else {      } else {
         # XXX Unsupported version!          return;
     }      }
     return;  
 }  }
   
 sub _encrypt_v4  sub _encrypt_v4
 {  {
     my $data   = shift;      my $new    = shift;
       my $old    = shift;
     my $digest = shift;      my $digest = shift;
     my $acct   = shift;  
   
     $data->{account}  ||= $EMPTY;      $new->{account}  ||= $EMPTY;
     $data->{password} ||= $EMPTY;      $new->{password} ||= $EMPTY;
     $data->{notes}    ||= $EMPTY;      $new->{notes}    ||= $EMPTY;
   
     my $changed      = 0;      my $changed      = 0;
     my $need_newdate = 0;      my $need_newdate = 0;
     if (%{ $acct }) {      if ($old && %{ $old }) {
         foreach my $key (keys %{ $data }) {          no warnings 'uninitialized';
           foreach my $key (keys %{ $new }) {
             next if $key eq 'lastchange';              next if $key eq 'lastchange';
             if ($data->{$key} ne $acct->{$key}) {              if ($new->{$key} ne $old->{$key}) {
                 $changed = 1;                  $changed = 1;
                 last;                  last;
             }              }
         }          }
         if ( exists $data->{lastchange} && exists $acct->{lastchange} && (          if ( exists $new->{lastchange} && exists $old->{lastchange} && (
             $data->{lastchange}->{day}   != $acct->{lastchange}->{day}   ||              $new->{lastchange}->{day}   != $old->{lastchange}->{day}   ||
             $data->{lastchange}->{month} != $acct->{lastchange}->{month} ||              $new->{lastchange}->{month} != $old->{lastchange}->{month} ||
             $data->{lastchange}->{year}  != $acct->{lastchange}->{year}              $new->{lastchange}->{year}  != $old->{lastchange}->{year}
         )) {          )) {
             $changed = 1;              $changed = 1;
             $need_newdate = 0;              $need_newdate = 0;
Line 387 
Line 539 
   
     my ($day, $month, $year);      my ($day, $month, $year);
   
     if ($data->{lastchange} && ! $need_newdate ) {      if ($new->{lastchange} && ! $need_newdate ) {
         $day   = $data->{lastchange}->{day}   || 1;          $day   = $new->{lastchange}->{day}   || 1;
         $month = $data->{lastchange}->{month} || 0;          $month = $new->{lastchange}->{month} || 0;
         $year  = $data->{lastchange}->{year}  || 0;          $year  = $new->{lastchange}->{year}  || 0;
   
         # XXX Need to actually validate the above information somehow          # XXX Need to actually validate the above information somehow
         if ($year >= 1900) {          if ($year >= 1900) {
Line 404 
Line 556 
         ($day, $month, $year) = (localtime)[3,4,5];          ($day, $month, $year) = (localtime)[3,4,5];
     }      }
   
     my $packeddate = _pack_keyring_date( {      my $packed_date = _pack_keyring_date( {
             year  => $year,              year  => $year,
             month => $month,              month => $month,
             day   => $day,              day   => $day,
     });      });
   
     my $plaintext = join $NULL,      my $plaintext = join $NULL,
         $data->{account}, $data->{password}, $data->{notes}, $packeddate;          $new->{account}, $new->{password}, $new->{notes}, $packed_date;
   
     return _crypt3des( $plaintext, $digest, $ENCRYPT );      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) {
           $ivec = pack("C*",map {rand(256)} 1..$c->{blocksize});
       }
   
       my $changed = 0;
       my $need_newdate = 1;
       if ($new->{3}->{data}) {
           $need_newdate = 0;
       }
       foreach my $k (keys %{ $new }) {
           if (! $old) {
               $changed = 1;
           } elsif ($k == 3) {
               if ($old && (
                       $new->{$k}{data}{day}   == $old->{$k}{data}{day}   &&
                       $new->{$k}{data}{month} == $old->{$k}{data}{month} &&
                       $new->{$k}{data}{year}  == $old->{$k}{data}{year}
                   )) {
                   $changed      = 1;
                   $need_newdate = 1;
               }
   
           } else {
               my $n = join ':', sort %{ $new->{$k} };
               my $o = join ':', sort %{ $old->{$k} };
               if ($n ne $o) {
                   $changed = 1;
               }
           }
       }
   
       return 1, 0 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;
   
       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',
           );
   
           if (! $c) {
               croak("Unable to set up encryption!");
           }
   
           $encrypted = $cbc->encrypt($plaintext);
   
       } else {
           croak "Unsupported Crypt $c->{name}";
       }
   
       return $encrypted, $ivec;
   }
   
 # Decrypt  # Decrypt
   
 sub Decrypt  sub Decrypt
 {  {
     my $self = shift;      my $self = shift;
     my $rec  = shift;      my $rec  = shift;
     my $pass = shift || $self->{password};      my $pass = shift || $self->{password};
   
     if ( ! $pass && ! $self->{key}) {      if ( ! $pass && ! $self->{appinfo}->{key}) {
         croak("password not set!\n");          croak("password not set!\n");
     }      }
   
Line 432 
Line 683 
         croak("Needed parameter 'record' not passed!\n");          croak("Needed parameter 'record' not passed!\n");
     }      }
   
     if ( ! $self->Password($pass)) {      if ( $pass && ! $self->Password($pass)) {
         croak("Invalid Password!\n");          croak("Invalid Password!\n");
     }      }
   
Line 440 
Line 691 
         croak("No encrypted content!");          croak("No encrypted content!");
     }      }
   
       my $plaintext;
     if ($self->{version} == 4) {      if ($self->{version} == 4) {
         $self->{digest} ||= _calc_keys( $pass );          $self->{digest} ||= _calc_keys( $pass );
         my $acct = _decrypt_v4($rec->{encrypted}, $self->{digest});          my $acct = _decrypt_v4($rec->{encrypted}, $self->{digest});
         $acct->{name} ||= $rec->{name};          $plaintext = {
         return $acct;              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},
               },
           };
   
     } elsif ($self->{version} == 5) {      } elsif ($self->{version} == 5) {
         my $fields = _decrypt_v5(          $plaintext = _decrypt_v5(
             $rec->{encrypted}, $rec->{ivec}, $self->{key},              $rec->{encrypted}, $self->{appinfo}->{key},
             $self->{appinfo}->{keylen}, $self->{appinfo}->{cipher_name},              $self->{appinfo}->{cipher}, $rec->{ivec},
         );          );
         if ($self->{options}->{v4compatible}) {          $plaintext->{0} ||= $rec->{plaintext}->{0};
             my %acct;  
             foreach my $f (@{ $fields }) {  
                 $acct{ $f->{label} } = $f->{data};  
             }  
             $acct{name} ||= $rec->{name};  
             return \%acct;  
         } else {  
             return $fields;  
         }  
     } else {      } else {
         # XXX Unsupported version!          croak "Unsupported Version $self->{version}";
     }      }
   
       if ($plaintext) {
           $rec->{plaintext} = $plaintext;
           return $plaintext;
       }
     return;      return;
 }  }
   
Line 471 
Line 746 
     my $encrypted = shift;      my $encrypted = shift;
     my $digest    = shift;      my $digest    = shift;
   
     my $decrypted = _crypt3des( $encrypted, $digest, $DECRYPT );      my $plaintext = _crypt3des( $encrypted, $digest, $DECRYPT );
     my ( $account, $password, $notes, $packeddate )      my ( $account, $password, $notes, $packed_date )
         = split /$NULL/xm, $decrypted, 4;          = split /$NULL/xm, $plaintext, 4;
   
     my $modified;      my $modified;
     if ($packeddate) {      if ($packed_date) {
         $modified = _parse_keyring_date($packeddate);          $modified = _parse_keyring_date($packed_date);
     }      }
   
     return {      return {
Line 490 
Line 765 
   
 sub _decrypt_v5  sub _decrypt_v5
 {  {
   
     my $encrypted = shift;      my $encrypted = shift;
     my $ivec      = shift;  
     my $key       = shift;      my $key       = shift;
     my $keylen    = shift;  
     my $cipher    = shift;      my $cipher    = shift;
       my $ivec      = shift;
   
     my $decrypted;      my $c = crypts($cipher) or croak('Unknown cipher ' . $cipher);
   
     if ($cipher eq 'None') {      my $plaintext;
   
       if ($c->{name} eq 'None') {
         # do nothing          # do nothing
         $decrypted = $encrypted;          $plaintext = $encrypted;
   
     } elsif ($cipher eq 'DES_EDE3' or $cipher eq 'Rijndael') {      } elsif ($c->{name} eq 'DES_EDE3' or $c->{name} eq 'Rijndael') {
         my $c = _setup_cipher_v5($ivec, $key, $keylen, $cipher);          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',
           );
   
         if (! $c) {          if (! $c) {
             croak("Unable to set up encryption!");              croak("Unable to set up encryption!");
         }          }
         $encrypted .= $NULL x $keylen; # pad out a keylen          my $len = $c->{blocksize} - length($encrypted) % $c->{blocksize};
         $decrypted  = $c->decrypt($encrypted);          $encrypted .= $NULL x $len;
           $plaintext  = $cbc->decrypt($encrypted);
   
     } else {      } else {
         # XXX Unknown encryption          croak "Unsupported Crypt $c->{name}";
         return;  
     }      }
   
     my @fields;      my %fields;
     while ($decrypted) {      while ($plaintext) {
         my $field;          my $field;
         ($field, $decrypted) = _parse_field($decrypted);          ($field, $plaintext) = _parse_field($plaintext);
         if (! $field) {          if (! $field) {
             last;              last;
         }          }
         push @fields, $field;          $fields{ $field->{label_id} } = $field;
     }      }
   
     return \@fields;      return \%fields;
 }  }
   
 # Password  # Password
Line 538 
Line 826 
   
     if (! $pass) {      if (! $pass) {
         delete $self->{password};          delete $self->{password};
           delete $self->{appinfo}->{key};
         return 1;          return 1;
     }      }
   
     if (! exists $self->{records}) {      if (
         # Give the PDB the first record that will hold the encrypted password          ($self->{version} == 4 && ! exists $self->{encpassword}) ||
         $self->{records} = [ $self->new_Record ];          ($self->{version} == 5 && ! exists $self->{appinfo}->{masterhash})
       ) {
         return $self->_password_update($pass);          return $self->_password_update($pass);
     }      }
   
     if ($new_pass) {      if ($new_pass) {
         my @accts = ();          my @accts = ();
         foreach my $i (0..$#{ $self->{records} }) {          foreach my $rec (@{ $self->{records} }) {
             if ($i == 0) {              my $acct = $self->Decrypt($rec, $pass);
                 push @accts, undef;  
                 next;  
             }  
             my $acct = $self->Decrypt($self->{records}->[$i], $pass);  
             if ( ! $acct ) {              if ( ! $acct ) {
                 croak("Couldn't decrypt $self->{records}->[$i]->{name}");                  croak("Couldn't decrypt $rec->{plaintext}->{0}->{data}");
             }              }
             push @accts, $acct;              push @accts, $acct;
         }          }
Line 568 
Line 853 
         $pass = $new_pass;          $pass = $new_pass;
   
         foreach my $i (0..$#accts) {          foreach my $i (0..$#accts) {
             next if $i == 0;  
             delete $self->{records}->[$i]->{encrypted};              delete $self->{records}->[$i]->{encrypted};
             $self->Encrypt($self->{records}->[$i], $accts[$i], $pass);              $self->{records}->[$i]->{plaintext} = $accts[$i];
               $self->Encrypt($self->{records}->[$i], $pass);
         }          }
     }      }
   
Line 580 
Line 865 
     }      }
   
     if ($self->{version} == 4) {      if ($self->{version} == 4) {
         # AFAIK the thing we use to test the password is          my $valid = _password_verify_v4($pass, $self->{encpassword});
         #     always in the first entry  
         my $valid = _password_verify_v4($pass, $self->{records}->[0]->{data});  
   
 # May as well generate the keys we need now, since we know the password is right          # May as well generate the keys we need now,
           # since we know the password is right
         if ($valid) {          if ($valid) {
             $self->{digest} = _calc_keys($pass);              $self->{digest} = _calc_keys($pass);
             if ($self->{digest} ) {              if ($self->{digest} ) {
Line 593 
Line 877 
             }              }
         }          }
     } elsif ($self->{version} == 5) {      } elsif ($self->{version} == 5) {
         $self->{key} = _password_verify_v5($pass, $self->{appinfo});          return _password_verify_v5($self->{appinfo}, $pass);
         return 1 if $self->{key};  
     } else {      } else {
         # XXX unsupported version          croak "Unsupported version $self->{version}";
     }      }
   
     return;      return;
Line 604 
Line 887 
   
 sub _password_verify_v4  sub _password_verify_v4
 {  {
       require Digest::MD5;
       import Digest::MD5 qw(md5);
   
     my $pass = shift;      my $pass = shift;
     my $data = shift;      my $data = shift;
   
Line 621 
Line 907 
   
     my $digest = md5($msg);      my $digest = md5($msg);
   
     if (! $data eq $salt . $digest ) {      if ($data ne $salt . $digest ) {
         return;          return;
     }      }
   
Line 630 
Line 916 
   
 sub _password_verify_v5  sub _password_verify_v5
 {  {
     my $pass    = shift;  
     my $appinfo = shift;      my $appinfo = shift;
       my $pass    = shift;
   
     my $salt = pack("H*", $appinfo->{salt});      my $salt = pack("H*", $appinfo->{salt});
   
     my $key = _pbkdf2(      my $c = crypts($appinfo->{cipher})
         $pass, $salt, $appinfo->{iter}, $appinfo->{keylen}, \&hmac_sha1          or croak('Unknown cipher ' . $appinfo->{cipher});
       my ($key, $hash) = _calc_key_v5(
           $pass, $salt, $appinfo->{iter},
           $c->{keylen},
           $c->{DES_odd_parity},
     );      );
     if ($appinfo->{DES_odd_parity}) {  
         $key = DES_odd_parity($key);  
     }  
   
     my $newhash = unpack("H*", substr(sha1($key.$salt),0, 8));      #print "Iter: '" . $appinfo->{iter} . "'\n";
   
     #print "Key:  '". unpack("H*", $key) . "'\n";      #print "Key:  '". unpack("H*", $key) . "'\n";
     #print "Hash: '". $newhash . "'\n";      #print "Salt: '". unpack("H*", $salt) . "'\n";
       #print "Hash: '". $hash . "'\n";
     #print "Hash: '". $appinfo->{masterhash} . "'\n";      #print "Hash: '". $appinfo->{masterhash} . "'\n";
   
     if ($appinfo->{masterhash} eq $newhash) {      if ($appinfo->{masterhash} eq $hash) {
         $appinfo->{key} = $key;          $appinfo->{key} = $key;
     } else {      } else {
         return;          return;
     }      }
   
     return $key;      return $key;
 }  }
   
 # V4 helpers  
   
   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;
   
       if ($self->{version} == 4) {
           my $data = _password_update_v4($pass, @_);
   
           if (! $data) {
               carp("Failed  to update password!");
               return;
           }
   
           # AFAIK the thing we use to test the password is
           #     always in the first entry
           $self->{encpassword} = $data;
           $self->{password} = $pass;
           $self->{digest}   = _calc_keys( $self->{password} );
   
           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) {
               carp("Failed  to update password!");
               return;
           }
   
           return 1;
       } else {
           croak("Unsupported version ($self->{version})");
       }
   
       return;
   }
   
   sub _password_update_v4
   {
       require Digest::MD5;
       import Digest::MD5 qw(md5);
   
       my $pass = shift;
   
       if (! defined $pass) { croak('No password specified!'); };
   
       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);
   
       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 this 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};
   
       if ( $pass && ! $self->Password($pass)) {
           croak("Invalid Password!\n");
       }
   
       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  sub _calc_keys
 {  {
     my $pass = shift;      my $pass = shift;
Line 682 
Line 1104 
     return $digest;      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 );
       if ($dop) { $key = _DES_odd_parity($key); }
   
       my $hash = unpack("H*", substr(sha1($key.$salt),0, 8));
   
       return $key, $hash;
   }
   
 sub _crypt3des  sub _crypt3des
 {  {
       require Crypt::DES;
   
     my ( $plaintext, $passphrase, $flag ) = @_;      my ( $plaintext, $passphrase, $flag ) = @_;
   
     $passphrase   .= $SPACE x ( 16 * 3 );      $passphrase   .= $SPACE x ( 16 * 3 );
Line 731 
Line 1172 
     return $cyphertext;      return $cyphertext;
 }  }
   
 # V5 helpers  
   
 sub _setup_cipher_v5  
 {  
     my $ivec   = shift;  
     my $key    = shift;  
     my $keylen = shift;  
     my $cipher = shift;  
   
     return Crypt::CBC->new(  
         -literal_key => 1,  
         -key         => $key,  
         -iv          => $ivec,  
         -cipher      => $cipher,  
         -keysize     => $keylen,  
         -header      => 'none',  
         -padding     => 'oneandzeroes',  
     );  
 }  
   
 sub _parse_field  sub _parse_field
 {  {
     my $field = shift;      my $field = shift;
   
     my @labels;      my ($len) = unpack "n", $field;
     $labels[0]   = 'name';  
     $labels[1]   = 'account';  
     $labels[2]   = 'password';  
     $labels[3]   = 'lastchange';  
     $labels[255] = 'notes';  
   
     my ($len) = unpack "S1", $field;  
     if ($len + 4 > length $field) {      if ($len + 4 > length $field) {
         return undef, $field;          return undef, $field;
     }      }
     my $unpackstr = "S1 C1 C1 A$len";      my $unpackstr = "x2 C1 C1 A$len";
       my $offset    =   2 +1 +1 +$len;
     if ($len % 2) {      if ($len % 2) {
         # trim the 0/1 byte padding for next even address.          # trim the 0/1 byte padding for next even address.
           $offset++;
         $unpackstr .= ' x'          $unpackstr .= ' x'
     }      }
     $unpackstr .= ' A*';  
   
     my (undef, $label, $font, $data, $leftover)      my ($label, $font, $data) = unpack $unpackstr, $field;
         = unpack $unpackstr, $field;      my $leftover = substr $field, $offset;
   
     if ($label == 3) {      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);          $data = _parse_keyring_date($data);
     }      }
     return {      return {
         #len      => $len,          #len      => $len,
         label    => $labels[ $label ] || $label,          label    => $label,
         label_id => $label,          label_id => $label_id,
         font     => $font,          font     => $font,
         data     => $data,          data     => $data,
     }, $leftover;      }, $leftover;
 }  }
   
 # All version helpers  sub _pack_field
   
 sub _password_update  
 {  {
       my $field = shift;
   
     # It is very important to Encrypt after calling this      my $packed;
     #     (Although it is generally only called by Encrypt)      if (defined $field) {
     # because otherwise the data will be out of sync with the          my $label = $field->{label_id} || 0;
     # password, and that would suck!          if (defined $field->{label} && ! $label) {
     my $self = shift;              $label = $field->{label};
     my $pass = shift;          }
   
     # XXX have to separate this out to v4 and v5 sections.          my $l = labels($field->{label});
     die "Unsupported version" unless $self->{version} == 4;          if ($l) {
               $label = $l->{id};
           }
   
     if (! defined $pass) { croak('No password specified!'); };          my $font  = $field->{font} || 0;
           my $data  = defined $field->{data} ? $field->{data} : $EMPTY;
   
     my $salt;          if ($label && $label == 3) {
     for ( 1 .. $kSalt_Size ) {              $data = _pack_keyring_date($data);
         $salt .= chr int rand 255;          }
           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;
     }      }
   
     my $msg = $salt . $pass;      return $packed;
   }
   
     $msg .= "\0" x ( $MD5_CBLOCK - length $msg );  sub _parse_keyring_date
   {
       my $data = shift;
   
     my $digest = md5($msg);      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
   
     my $data = $salt . $digest;    # . "\0";      return {
           year   => $year,
           month  => $month || 0,
           day    => $day   || 1,
       };
   }
   
     # AFAIK the thing we use to test the password is  sub _pack_keyring_date
     #     always in the first entry  {
     $self->{records}->[0]->{data} = $data;      my $d = shift;
       my $year  = $d->{year};
       my $month = $d->{month};
       my $day   = $d->{day};
   
     $self->{password} = $pass;      $year -= 4;
     $self->{digest}   = _calc_keys( $self->{password} );      $month++;
   
     return 1;      return pack 'n*', $day | ($month << 5) | ($year << 9);
 }  }
   
   
 sub _hexdump  sub _hexdump
 {  {
     my $prefix = shift;   # What to print in front of each line      my $prefix = shift;   # What to print in front of each line
Line 903 
Line 1355 
     return substr($t, 0, $keylen);      return substr($t, 0, $keylen);
 }  }
   
 sub DES_odd_parity($) {  sub _DES_odd_parity($) {
     my $key = $_[0];      my $key = $_[0];
     my ($r, $i);      my ($r, $i);
     my @odd_parity = (      my @odd_parity = (
Line 931 
Line 1383 
   
 1;  1;
 __END__  __END__
   
 =head1 NAME  =head1 NAME
   
 Palm::Keyring - Handler for Palm Keyring databases.  Palm::Keyring - Handler for Palm Keyring databases.
Line 942 
Line 1393 
 parses Keyring for Palm OS databases.  See  parses Keyring for Palm OS databases.  See
 L<http://gnukeyring.sourceforge.net/>.  L<http://gnukeyring.sourceforge.net/>.
   
 It has the standard Palm::PDB methods with 2 additional public methods.  It has the standard Palm::PDB methods with 4 additional public methods.
 Decrypt and Encrypt.  Unlock, Lock, Decrypt and Encrypt.
   
 It currently supports the v4 Keyring databases.  The v5 databases from  It currently supports the v4 Keyring databases as well as
 the pre-release keyring-2.0 are not supported.  the pre-release v5 databases.
   
 This module doesn't store the decrypted content.  It only keeps it until it  
 returns it to you or encrypts it.  
   
 =head1 SYNOPSIS  =head1 SYNOPSIS
   
     use Palm::PDB;      use Palm::PDB;
Line 961 
Line 1409 
     my $pdb  = new Palm::PDB;      my $pdb  = new Palm::PDB;
     $pdb->Load($file);      $pdb->Load($file);
   
     foreach (0..$#{ $pdb->{records} }) {      $pdb->Unlock($pass);
         next if $_ = 0; # skip the password record      foreach my $rec (@{ $pdb->{records} }) {
         my $rec  = $pdb->{records}->[$_];          print $rec->{plaintext}->{0}->{data}, ' - ',
         my $acct = $pdb->Decrypt($rec, $pass);                $rec->{plaintext}->{1}->{data}, "\n";
         print $rec->{name}, ' - ', $acct->{account}, "\n";  
     }      }
       $pdb->Lock();
   
 =head1 SUBROUTINES/METHODS  =head1 SUBROUTINES/METHODS
   
 =head2 new  =head2 new
   
     $pdb = new Palm::Keyring([$password]);      $pdb = new Palm::Keyring([$password[, $version]]);
   
 Create a new PDB, initialized with the various Palm::Keyring fields  Create a new PDB, initialized with the various Palm::Keyring fields
 and an empty record list.  and an empty record list.
Line 980 
Line 1428 
 Use this method if you're creating a Keyring PDB from scratch otherwise you  Use this method if you're creating a Keyring PDB from scratch otherwise you
 can just use Palm::PDB::new() before calling Load().  can just use Palm::PDB::new() before calling Load().
   
 If you pass in a password, it will initalize the first record with the encrypted  If you pass in a password, it will initalize the database with the encrypted
 password.  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.
   
   =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  =head2 Encrypt
   
     $pdb->Encrypt($rec, $acct[, $password]);  =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  Encrypts an account into a record, either with the password previously
 used, or with a password that is passed.  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 is a record from $pdb->{records} or a new_Record().
 $acct is a hashref in the format below.  $rec->{plaintext} is a hashref in the format below.
   
     my $acct = {      $plaintext = {
         name       => $rec->{name},          0 => {
         account    => $account,              label    => 'name',
         password   => $password,              label_id => 0,
         notes      => $notes,              font     => 0,
         lastchange => {              data     => $name,
             year  => 107, # years since 1900          1 => {
             month =>   0, # 0-11, 0 = January, 11 = December              label    => 'account',
             day   =>  30, # 1-31, same as localtime              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  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.  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  If you pass in a lastchange field that is different than the one in the
 record, it will honor what you passed in.  record, it will honor what you passed in.
   
 Encrypt() only uses the $acct->{name} if there is not already a $rec->{name}.  You can either set $rec->{plaintext} or pass in $plaintext.  $plaintext
   is used over anything in $rec->{plaintext}.
   
   
 =head2 Decrypt  =head2 Decrypt
   
     my $acct = $pdb->Decrypt($rec[, $password]);      my $plaintext = $pdb->Decrypt($rec[, $password]);
   
 Decrypts the record and returns a hashref for the account as described  Decrypts the record and returns a reference for the plaintext account as
 under Encrypt().  described under Encrypt().
   Also sets $rec->{plaintext} with the same information as $plaintext as
   described in Encrypt().
   
     foreach (0..$#{ $pdb->{records}) {      foreach my $rec (@{ $pdb->{records} }) {
         next if $_ == 0;          my $plaintext = $pdb->Decrypt($rec);
         my $rec = $pdb->{records}->[$_];          # do something with $plaintext
         my $acct = $pdb->Decrypt($rec[, $password]);  
         # do something with $acct  
     }      }
   
   
 =head2 Password  =head2 Password
   
     $pdb->Password([$password[, $new_password]]);      $pdb->Password([$password[, $new_password]]);
Line 1040 
Line 1629 
   
 If nothing is passed, it forgets the password that it was remembering.  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  =head1 DEPENDENCIES
   
 Palm::StdAppInfo  Palm::StdAppInfo
   
   B<For v4 databases>
   
 Digest::MD5  Digest::MD5
   
 Crypt::DES  Crypt::DES
   
 Readonly  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  =head1 THANKS
   
 I would like to thank the helpful Perlmonk shigetsu who gave me some great advice  I would like to thank the helpful Perlmonk shigetsu who gave me some great
 and helped me get my first module posted.  L<http://perlmonks.org/?node_id=596998>  advice and helped me get my first module posted.
   L<http://perlmonks.org/?node_id=596998>
   
 I would also like to thank  I would also like to thank
 Johan Vromans  Johan Vromans
Line 1064 
Line 1766 
 as giving me some very helpful hints about doing a few things that I was  as giving me some very helpful hints about doing a few things that I was
 unsure of.  He is really great.  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  =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  Please report any bugs or feature requests to
 C<bug-palm-keyring at rt.cpan.org>, or through the web interface at  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  L<http://rt.cpan.org>.  I will be notified, and then you'll automatically be
Line 1090 
Line 1816 
   
 The Keyring for Palm OS website:  The Keyring for Palm OS website:
 L<http://gnukeyring.sourceforge.net/>  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  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>  from his website at L<http://www.vromans.org/johan/software/sw_palmkeyring.html>
Legend:
Removed from v.1.28  
changed lines
  Added in v.1.53
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>