[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.35 and 1.64

version 1.35, 2007/02/22 04:11:35 version 1.64, 2011/09/19 04:05:11
Line 1 
Line 1 
 package Palm::Keyring;  package Palm::Keyring;
 # $RedRiver: Keyring.pm,v 1.34 2007/02/21 05:24:14 andrew Exp $  # $RedRiver: Keyring.pm,v 1.61 2008/09/19 05:55:35 andrew Exp $
 ########################################################################  ########################################################################
 # Keyring.pm *** Perl class for Keyring for Palm OS databases.  # Keyring.pm *** Perl class for Keyring for Palm OS databases.
 #  #
Line 15 
Line 15 
 use strict;  use strict;
 use warnings;  use warnings;
   
   require 5.006_001;
   
 use Carp;  use Carp;
 $Carp::Verbose = 1;  
   
 use base qw/ Palm::StdAppInfo /;  use base qw/ Palm::StdAppInfo /;
   
Line 58 
Line 59 
         blocksize => 16,          blocksize => 16,
         default_iter => 250,          default_iter => 250,
     },      },
       {
           alias     => 'TESTING',
           name      => 'Testing',
           keylen    => 8,
           blocksize => 1,
           default_iter => 1,
       },
 );  );
   
   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_07';
   
 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-Z0-9_]{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;
               $options->{cipher}   = shift;
           }
     }      }
   
     # Create a generic PDB. No need to rebless it, though.      # Create a generic PDB. No need to rebless it, though.
Line 108 
Line 142 
     # Set defaults      # Set defaults
     if ($self->{version} == 5) {      if ($self->{version} == 5) {
         $self->{options}->{cipher} ||= 0; # 'None'          $self->{options}->{cipher} ||= 0; # 'None'
         $self->{options}->{iterations} ||=          my $c = crypts($self->{options}->{cipher})
             $CRYPTS[ $self->{options}->{cipher} ]{default_iter};              or croak('Unknown cipher ' . $self->{options}->{cipher});
           $self->{options}->{iterations} ||= $c->{default_iter};
        $self->{appinfo}->{cipher} ||= $self->{options}->{cipher};          $self->{appinfo}->{cipher} ||= $self->{options}->{cipher};
        $self->{appinfo}->{iter}   ||= $self->{options}->{iterations};          $self->{appinfo}->{iter}   ||= $self->{options}->{iterations};
     };      };
   
       if ( defined $options->{file} ) {
           $self->Load($options->{file});
       }
   
     if ( defined $options->{password} ) {      if ( defined $options->{password} ) {
         $self->Password($options->{password});          $self->Password($options->{password});
     }      }
Line 133 
Line 171 
 sub crypts  sub crypts
 {  {
     my $crypt = shift;      my $crypt = shift;
     if ($crypt =~ /\D/) {      if ((! defined $crypt) || (! length $crypt)) {
           return;
       } elsif ($crypt =~ /\D/) {
         foreach my $c (@CRYPTS) {          foreach my $c (@CRYPTS) {
             if ($c->{alias} eq $crypt) {              if ($c->{alias} eq $crypt) {
                 return $c;                  return $c;
Line 146 
Line 186 
     }      }
 }  }
   
   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  # ParseRecord
   
 sub ParseRecord  sub ParseRecord
Line 153 
Line 247 
     my $self     = shift;      my $self     = shift;
   
     my $rec = $self->SUPER::ParseRecord(@_);      my $rec = $self->SUPER::ParseRecord(@_);
     return $rec if ! exists $rec->{data};      return $rec if !(defined $rec->{data} && length $rec->{data} );
   
     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 = $CRYPTS[ $self->{appinfo}->{cipher} ]{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      = substr $extra, 0, $blocksize;  
         my $encrypted = substr $extra, $blocksize;  
   
         $rec->{name}      = $field->{data};  
         $rec->{ivec}      = $ivec;  
         $rec->{encrypted} = $encrypted;  
         delete $rec->{data};          delete $rec->{data};
   
           $rec->{plaintext}->{0} = $field;
           $rec->{ivec}      = substr $extra, 0, $blocksize;
           $rec->{encrypted} = substr $extra, $blocksize;
   
     } else {      } else {
         die 'Unsupported Version';          # XXX Can never get here to test, ParseAppInfoBlock is always run
         return;          # XXX first by Load().
           croak "Unsupported Version $self->{version}";
     }      }
   
     return $rec;      return $rec;
Line 194 
Line 301 
   
     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};
             }  
             $rec->{data} = join $NULL, $rec->{name}, $rec->{encrypted};  
             delete $rec->{name};  
             delete $rec->{encrypted};  
         }          }
   
     } elsif ($self->{version} == 5) {      } elsif ($self->{version} == 5) {
         my $field = {          croak 'No encrypted data in record' if !defined $rec->{encrypted};
             'label_id' => 1,          croak 'No ivec!' if !$rec->{ivec};
             'data'     => $rec->{name},  
             'font'     => 0,  
         };  
         my $packed .= _pack_field($field);  
   
         $rec->{data} = join '', $packed, $rec->{ivec}, $rec->{encrypted};          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 {
         die 'Unsupported Version';          croak "Unsupported Version $self->{version}";
     }      }
       # XXX Should I?
       #delete $rec->{plaintext};
       #delete $rec->{encrypted};
   
       croak 'No data in record to pack' if !$rec->{data};
   
     return $self->SUPER::PackRecord($rec, @_);      return $self->SUPER::PackRecord($rec, @_);
 }  }
   
Line 242 
Line 359 
         # Nothing extra for version 4          # Nothing extra for version 4
   
     } elsif ($self->{version} == 5) {      } elsif ($self->{version} == 5) {
         _parse_appinfo_v5($appinfo) || return;          _parse_appinfo_v5($appinfo);
   
     } else {      } else {
         die "Unsupported Version";          croak "Unsupported Version $self->{version}";
         return;  
     }      }
   
     return $appinfo;      return $appinfo;
Line 256 
Line 372 
 {  {
     my $appinfo = shift;      my $appinfo = shift;
   
     if (! exists $appinfo->{other}) {      croak 'Corrupt appinfo? no {other}' if ! $appinfo->{other};
         # XXX Corrupt appinfo?  
         return;  
     }  
   
     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
Line 292 
Line 405 
     } elsif ($self->{version} == 5) {      } elsif ($self->{version} == 5) {
         _pack_appinfo_v5($self->{appinfo});          _pack_appinfo_v5($self->{appinfo});
     } else {      } else {
         die "Unsupported Version";          croak "Unsupported Version $self->{version}";
         return;  
     }      }
     return &Palm::StdAppInfo::pack_StdAppInfo($self->{appinfo});      return &Palm::StdAppInfo::pack_StdAppInfo($self->{appinfo});
 }  }
Line 327 
Line 439 
 sub Encrypt  sub Encrypt
 {  {
     my $self = shift;      my $self = shift;
     my $rec  = shift;      my $rec  = shift || croak('Needed parameter [record] not passed!');
     my $data = shift;  
     my $pass = shift || $self->{password};      my $pass = shift || $self->{password};
       my $data = shift || $rec->{plaintext};
     my $ivec = shift;      my $ivec = shift;
   
     if ( ! $pass && ! $self->{appinfo}->{key}) {      $self->_password_verify($pass);
         croak("password not set!\n");  
     }  
   
     if ( ! $rec) {      if ( !$data ) { croak('Needed parameter [plaintext] not passed!'); }
         croak("Needed parameter 'record' not passed!\n");  
     }  
   
     if ( ! $data) {  
         croak("Needed parameter 'data' not passed!\n");  
     }  
   
     if ( $pass && ! $self->Password($pass)) {  
         croak("Incorrect Password!\n");  
     }  
   
     my $acct;      my $acct;
     if ($rec->{encrypted}) {      if ($rec->{encrypted}) {
         $acct = $self->Decrypt($rec, $pass);          $acct = $self->Decrypt($rec, $pass);
Line 356 
Line 456 
     my $encrypted;      my $encrypted;
     if ($self->{version} == 4) {      if ($self->{version} == 4) {
         $self->{digest} ||= _calc_keys( $pass );          $self->{digest} ||= _calc_keys( $pass );
         $encrypted = _encrypt_v4($data, $acct, $self->{digest});          my $datav4 = {
         $rec->{name}    ||= $data->{name};              name       => $data->{0}->{data},
               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) {      } elsif ($self->{version} == 5) {
         my @accts = ($data, $acct);  
         if ($self->{options}->{v4compatible}) {  
             $rec->{name} ||= $data->{name};  
             foreach my $a (@accts) {  
                 my @fields;  
                 foreach my $k (sort keys %{ $a }) {  
                     my $field = {  
                         label    => $k,  
                         font     => 0,  
                         data     => $a->{$k},  
                     };  
                     push @fields, $field;  
                 }  
                 $a = \@fields;  
             }  
         }  
   
         ($encrypted, $ivec) = _encrypt_v5(          ($encrypted, $ivec) = _encrypt_v5(
             @accts,              $data, $acct,
             $self->{appinfo}->{key},              $self->{appinfo}->{key},
             $self->{appinfo}->{cipher},              $self->{appinfo}->{cipher},
             $ivec,              $ivec,
         );          );
         if (defined $ivec) {          $rec->{ivec} = $ivec if $ivec;
             $rec->{ivec} = $ivec;  
         }  
   
     } else {      } else {
         die "Unsupported Version";          croak "Unsupported Version $self->{version}";
     }      }
   
     if ($encrypted) {      $rec->{plaintext}->{0} = $data->{0};
         if ($encrypted eq '1') {  
             return 1;  
         }  
   
       if ($encrypted ne '1') {
         $rec->{attributes}{Dirty} = 1;          $rec->{attributes}{Dirty} = 1;
         $rec->{attributes}{dirty} = 1;          $rec->{attributes}{dirty} = 1;
         $rec->{encrypted} = $encrypted;          $rec->{encrypted} = $encrypted;
   
         return 1;  
     } else {  
         return;  
     }      }
   
       return 1;
 }  }
   
 sub _encrypt_v4  sub _encrypt_v4
Line 419 
Line 509 
     my $changed      = 0;      my $changed      = 0;
     my $need_newdate = 0;      my $need_newdate = 0;
     if ($old && %{ $old }) {      if ($old && %{ $old }) {
           no warnings 'uninitialized';
         foreach my $key (keys %{ $new }) {          foreach my $key (keys %{ $new }) {
             next if $key eq 'lastchange';              next if $key eq 'lastchange';
             if ($new->{$key} ne $old->{$key}) {              if ($new->{$key} ne $old->{$key}) {
Line 482 
Line 573 
     my $key    = shift;      my $key    = shift;
     my $cipher = shift;      my $cipher = shift;
     my $ivec   = shift;      my $ivec   = shift;
     my $blocksize   = $CRYPTS[ $cipher ]{blocksize};      my $c = crypts($cipher) or croak('Unknown cipher ' . $cipher);
     my $keylen      = $CRYPTS[ $cipher ]{keylen};  
     my $cipher_name = $CRYPTS[ $cipher ]{name};  
   
     if (! defined $ivec) {      if (! defined $ivec) {
         $ivec = pack("C*",map {rand(256)} 1..$blocksize);          if (!$c->{blocksize}) {
               $ivec = $EMPTY;
           }
           else {
               while (! $ivec) {
                   $ivec = pack("C*",map {rand(256)} 1..$c->{blocksize});
               }
           }
     }      }
   
     my $changed = 0;      my $changed = 0;
     my $need_newdate = 1;      my $need_newdate = 1;
     my $date_index;      if ($new->{3}->{data}) {
     for (my $i = 0; $i < @{ $new }; $i++) {          $need_newdate = 0;
         if (      }
             (exists $new->[$i]->{label_id} && $new->[$i]->{label_id} == 3) ||  
             (exists $new->[$i]->{label}    && $new->[$i]->{label}    eq 'lastchange')      if ($old) {
         ) {          foreach my $k (keys %{ $new }) {
             $date_index   = $i;              if (! $old->{$k} ) {
             if ( $old && $#{ $new } == $#{ $old } && (                  $changed = 1;
                     $new->[$i]->{data}->{day}   != $old->[$i]->{data}->{day}   ||  
                     $new->[$i]->{data}->{month} != $old->[$i]->{data}->{month} ||  
                     $new->[$i]->{data}->{year}  != $old->[$i]->{data}->{year}  
                 )) {  
                 $changed      = 1;  
                 $need_newdate = 0;  
                 last;                  last;
               }
               if (! $new->{$k}) {
                   $changed = 1;
                   last;
             }              }
               elsif ($k == 3) {
                   if (! $new->{$k}->{data} && $old->{$k}->{data} ) {
                       $changed = 1;
                       last;
                   }
   
         } elsif ($old && $#{ $new } == $#{ $old }) {                  my %n = %{ $new->{$k}->{data} };
             my $n = join ':', %{ $new->[$i] };                  my %o = %{ $old->{$k}->{data} };
             my $o = join ':', %{ $old->[$i] };  
             if ($n ne $o) {                  foreach (qw( day month year )) {
                 $changed = 1;                      $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;
                   }
             }              }
         } elsif ($#{ $new } != $#{ $old }) {  
             $changed = 1;  
         }          }
     }      }
     if ($old && (! @{ $old }) && $date_index) {      else {
         $need_newdate = 0;          $changed = 1;
     }      }
   
     return 1, 0 if $changed == 0;      return 1 if $changed == 0;
   
     if ($need_newdate || ! defined $date_index) {      if ($need_newdate) {
         my ($day, $month, $year) = (localtime)[3,4,5];          my ($day, $month, $year) = (localtime)[3,4,5];
         my $date = {          $new->{3} = {
             year  => $year,              label => 'lastchange',
             month => $month,              label_id => 3,
             day   => $day,              font  => 0,
               data => {
                   year  => $year,
                   month => $month,
                   day   => $day,
              },
         };          };
         if (defined $date_index) {  
             $new->[$date_index]->{data} = $date;  
         } else {  
             push @{ $new }, {  
                 label => 'lastchange',  
                 font  => 0,  
                 data  => $date,  
             };  
         }  
     } else {      } else {
         # XXX Need to actually validate the above information somehow          # XXX Need to actually validate the above information somehow
         if ($new->[$date_index]->{data}->{year} >= 1900) {          if ($new->{3}->{data}->{year} >= 1900) {
             $new->[$date_index]->{data}->{year} -= 1900;              $new->{3}->{data}->{year} -= 1900;
         }          }
     }      }
   
     my $decrypted;      my $plaintext;
     foreach my $field (@{ $new }) {      foreach my $k (keys %{ $new }) {
         $decrypted .= _pack_field($field);          next if $new->{$k}->{label_id} == 0;
           $plaintext .= _pack_field($new->{$k});
     }      }
       $plaintext .= chr(0xff) x 2;
   
     my $encrypted;      my $encrypted;
     if ($cipher_name eq 'None') {      if ($c->{name} eq 'None') {
         # do nothing          # do nothing
         $encrypted = $decrypted;          $encrypted = $plaintext;
   
     } elsif ($cipher_name eq 'DES_EDE3' or $cipher_name eq 'Rijndael') {      } elsif ($c->{name} eq 'DES_EDE3' or $c->{name} eq 'Rijndael') {
         require Crypt::CBC;          require Crypt::CBC;
         my $c = Crypt::CBC->new(          my $cbc = Crypt::CBC->new(
             -key         => $key,              -key         => $key,
             -literal_key => 1,              -literal_key => 1,
             -iv          => $ivec,              -iv          => $ivec,
             -cipher      => $cipher_name,              -cipher      => $c->{name},
             -keysize     => $keylen,              -keysize     => $c->{keylen},
             -blocksize   => $blocksize,              -blocksize   => $c->{blocksize},
             -header      => 'none',              -header      => 'none',
             -padding     => 'oneandzeroes',              -padding     => 'oneandzeroes',
         );          ) || croak("Unable to set up encryption!");
   
         if (! $c) {          $encrypted = $cbc->encrypt($plaintext);
             croak("Unable to set up encryption!");  
         }  
   
         $encrypted = $c->encrypt($decrypted);  
   
     } else {      } else {
         die "Unsupported Version";          croak "Unsupported Crypt $c->{name}";
     }      }
   
     return $encrypted, $ivec;      return $encrypted, $ivec;
Line 591 
Line 706 
     my $rec  = shift;      my $rec  = shift;
     my $pass = shift || $self->{password};      my $pass = shift || $self->{password};
   
     if ( ! $pass && ! $self->{appinfo}->{key}) {      if ( ! $rec) { croak('Needed parameter [record] not passed!'); }
         croak("password not set!\n");      if ( ! $rec->{encrypted} ) { croak('No encrypted content!'); }
     }  
   
     if ( ! $rec) {      $self->_password_verify($pass);
         croak("Needed parameter 'record' not passed!\n");  
     }  
   
     if ( $pass && ! $self->Password($pass)) {      my $plaintext;
         croak("Invalid Password!\n");  
     }  
   
     if ( ! $rec->{encrypted} ) {  
         croak("No encrypted content!");  
     }  
   
     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}, $self->{appinfo}->{key},              $rec->{encrypted}, $self->{appinfo}->{key},
             $self->{appinfo}->{cipher}, $rec->{ivec},              $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 {
         die "Unsupported Version";          croak "Unsupported Version $self->{version}";
     }      }
   
       if ($plaintext) {
           $rec->{plaintext} = $plaintext;
           return $plaintext;
       }
     return;      return;
 }  }
   
Line 640 
Line 766 
     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, $packed_date )      my ( $account, $password, $notes, $packed_date )
         = split /$NULL/xm, $decrypted, 4;          = split /$NULL/xm, $plaintext, 4;
   
     my $modified;      my $modified;
     if ($packed_date) {      if ($packed_date) {
Line 665 
Line 791 
     my $cipher    = shift;      my $cipher    = shift;
     my $ivec      = shift;      my $ivec      = shift;
   
     my $keylen       = $CRYPTS[ $cipher ]{keylen};      my $c = crypts($cipher) or croak('Unknown cipher ' . $cipher);
     my $cipher_name  = $CRYPTS[ $cipher ]{name};  
     my $blocksize    = $CRYPTS[ $cipher ]{blocksize};  
   
     my $decrypted;      my $plaintext;
   
     if ($cipher_name eq 'None') {      if ($c->{name} eq 'None') {
         # do nothing          # do nothing
         $decrypted = $encrypted;          $plaintext = $encrypted;
   
     } elsif ($cipher_name eq 'DES_EDE3' or $cipher_name eq 'Rijndael') {      } elsif ($c->{name} eq 'DES_EDE3' or $c->{name} eq 'Rijndael') {
         require Crypt::CBC;          require Crypt::CBC;
         my $c = Crypt::CBC->new(          my $cbc = Crypt::CBC->new(
             -key         => $key,              -key         => $key,
             -literal_key => 1,              -literal_key => 1,
             -iv          => $ivec,              -iv          => $ivec,
             -cipher      => $cipher_name,              -cipher      => $c->{name},
             -keysize     => $keylen,              -keysize     => $c->{keylen},
             -blocksize   => $blocksize,              -blocksize   => $c->{blocksize},
             -header      => 'none',              -header      => 'none',
             -padding     => 'oneandzeroes',              -padding     => 'oneandzeroes',
         );          ) || croak("Unable to set up encryption!");
   
         if (! $c) {          my $len = $c->{blocksize} - length($encrypted) % $c->{blocksize};
             croak("Unable to set up encryption!");  
         }  
         my $len = $blocksize - length($encrypted) % $blocksize;  
         $encrypted .= $NULL x $len;          $encrypted .= $NULL x $len;
         $decrypted  = $c->decrypt($encrypted);          $plaintext  = $cbc->decrypt($encrypted);
   
     } else {      } else {
         die "Unsupported Version";          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 728 
Line 848 
     }      }
   
     if (      if (
         ($self->{version} == 4 && ! exists $self->{records}) ||          ($self->{version} == 4 && ! exists $self->{encpassword}) ||
         ($self->{version} == 5 && ! exists $self->{appinfo}->{masterhash})          ($self->{version} == 5 && ! exists $self->{appinfo}->{masterhash})
     ) {      ) {
         if ($self->{version} == 4) {  
             # Give the PDB the first record that will hold the encrypted password  
             $self->{records} = [ $self->new_Record ];  
         }  
   
         return $self->_password_update($pass);          return $self->_password_update($pass);
     }      }
   
     if ($new_pass) {      if ($new_pass) {
         my $v4compat = $self->{options}->{v4compatible};  
         $self->{options}->{v4compatible} = 0;  
   
         my @accts = ();          my @accts = ();
         foreach my $i (0..$#{ $self->{records} }) {          foreach my $rec (@{ $self->{records} }) {
             if ($self->{version} == 4 && $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 762 
Line 870 
         $pass = $new_pass;          $pass = $new_pass;
   
         foreach my $i (0..$#accts) {          foreach my $i (0..$#accts) {
             if ($self->{version} == 4 && $i == 0) {  
                 next;  
             }  
             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);
         }          }
       }
   
         $self->{options}->{v4compatible} = $v4compat;      return $self->_password_verify($pass);
   }
   
   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}) {      if (defined $self->{password} && $pass eq $self->{password}) {
         # already verified this password          # already verified this password
         return 1;          return 1;
     }      }
   
     if ($self->{version} == 4) {      if ($self->{version} == 4) {
         # AFAIK the thing we use to test the password is          _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,
         if ($valid) {          # since we know the password is right
             $self->{digest} = _calc_keys($pass);          $self->{digest} = _calc_keys($pass);
             if ($self->{digest} ) {          $self->{password} = $pass;
                 $self->{password} = $pass;          return 1;
                 return 1;  
             }  
         }  
     } elsif ($self->{version} == 5) {      } elsif ($self->{version} == 5) {
         return _password_verify_v5($self->{appinfo}, $pass);          _password_verify_v5($self->{appinfo}, $pass);
     } else {          $self->{password} = $pass;
         # XXX unsupported version          return 1;
     }      }
   
     return;      croak "Unsupported Version $self->{version}";
 }  }
   
 sub _password_verify_v4  sub _password_verify_v4
Line 807 
Line 921 
     my $pass = shift;      my $pass = shift;
     my $data = shift;      my $data = shift;
   
     if (! $pass) { croak('No password specified!'); };      if (! $pass) { croak('No password specified!'); }
       if (! $data) { croak('No encrypted password in file!'); }
   
     # XXX die "No encrypted password in file!" unless defined $data;  
     if ( ! defined $data) { return; };  
   
     $data =~ s/$NULL$//xm;      $data =~ s/$NULL$//xm;
   
     my $salt = substr $data, 0, $kSalt_Size;      my $salt = substr $data, 0, $kSalt_Size;
Line 822 
Line 934 
     my $digest = md5($msg);      my $digest = md5($msg);
   
     if ($data ne $salt . $digest ) {      if ($data ne $salt . $digest ) {
         return;          croak("Incorrect Password!");
     }      }
   
     return 1;      return 1;
Line 835 
Line 947 
   
     my $salt = pack("H*", $appinfo->{salt});      my $salt = pack("H*", $appinfo->{salt});
   
       my $c = crypts($appinfo->{cipher})
           or croak('Unknown cipher ' . $appinfo->{cipher});
     my ($key, $hash) = _calc_key_v5(      my ($key, $hash) = _calc_key_v5(
         $pass, $salt, $appinfo->{iter},          $pass, $salt, $appinfo->{iter},
         $CRYPTS[ $appinfo->{cipher} ]{keylen},          $c->{keylen},
         $CRYPTS[ $appinfo->{cipher} ]{DES_odd_parity},          $c->{DES_odd_parity},
     );      );
   
     #print "Iter: '" . $appinfo->{iter} . "'\n";      #print "Iter: '" . $appinfo->{iter} . "'\n";
Line 847 
Line 961 
     #print "Hash: '". $hash . "'\n";      #print "Hash: '". $hash . "'\n";
     #print "Hash: '". $appinfo->{masterhash} . "'\n";      #print "Hash: '". $appinfo->{masterhash} . "'\n";
   
     if ($appinfo->{masterhash} eq $hash) {      if ($appinfo->{masterhash} ne $hash) {
         $appinfo->{key} = $key;          croak("Incorrect Password!");
     } else {  
         return;  
     }      }
   
     return $key;      $appinfo->{key} = $key;
       return 1;
 }  }
   
   
Line 869 
Line 982 
     if ($self->{version} == 4) {      if ($self->{version} == 4) {
         my $data = _password_update_v4($pass, @_);          my $data = _password_update_v4($pass, @_);
   
         if (! $data) {          if (! $data) { croak "Failed to update password!"; }
             carp("Failed  to update password!");  
             return;  
         }  
   
         # AFAIK the thing we use to test the password is          # AFAIK the thing we use to test the password is
         #     always in the first entry          #     always in the first entry
         $self->{records}->[0]->{data} = $data;          $self->{encpassword} = $data;
         $self->{password} = $pass;          $self->{password} = $pass;
         $self->{digest}   = _calc_keys( $self->{password} );          $self->{digest}   = _calc_keys( $self->{password} );
   
Line 891 
Line 1001 
             $self->{appinfo}, $pass, $cipher, $iter, $salt              $self->{appinfo}, $pass, $cipher, $iter, $salt
         );          );
   
         if (! $hash) {          if (! $hash) { croak "Failed to update password!"; }
             carp("Failed  to update password!");  
             return;  
         }  
   
           $self->{password} = $pass;
   
         return 1;          return 1;
     } else {  
         croak("Unsupported version ($self->{version})");  
     }      }
   
     return;      croak "Unsupported Version $self->{version}";
 }  }
   
 sub _password_update_v4  sub _password_update_v4
Line 941 
Line 1048 
     my $length  = 8;      my $length  = 8;
     my $salt    = shift || pack("C*",map {rand(256)} 1..$length);      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(      my ($key, $hash) = _calc_key_v5(
         $pass, $salt, $iter,          $pass, $salt, $iter,
         $CRYPTS[ $cipher ]->{keylen},          $c->{keylen},
         $CRYPTS[ $cipher ]->{DES_odd_parity},          $c->{DES_odd_parity},
     );      );
   
     $appinfo->{salt}           = unpack "H*", $salt;      $appinfo->{salt}           = unpack "H*", $salt;
     $appinfo->{iter}           = $iter;      $appinfo->{iter}           = $iter;
     $appinfo->{cipher}         = $cipher;      $appinfo->{cipher}         = $cipher;
   
     $appinfo->{key}            = $key;  
     $appinfo->{masterhash}     = $hash;      $appinfo->{masterhash}     = $hash;
       $appinfo->{key}            = $key;
   
     return $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  # Helpers
   
 sub _calc_keys  sub _calc_keys
 {  {
       require Digest::MD5;
       import Digest::MD5 qw(md5);
   
     my $pass = shift;      my $pass = shift;
     if (! defined $pass) { croak('No password defined!'); };      if (! defined $pass) { croak('No password defined!'); };
   
Line 993 
Line 1134 
     import  Digest::SHA1 qw(sha1);      import  Digest::SHA1 qw(sha1);
   
     my $key = _pbkdf2( $pass, $salt, $iter, $keylen, \&hmac_sha1 );      my $key = _pbkdf2( $pass, $salt, $iter, $keylen, \&hmac_sha1 );
     if ($dop) { $key = DES_odd_parity($key); }      if ($dop) { $key = _DES_odd_parity($key); }
   
     my $hash = unpack("H*", substr(sha1($key.$salt),0, 8));      my $hash = unpack("H*", substr(sha1($key.$salt),0, 8));
   
Line 1055 
Line 1196 
 {  {
     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 "n1", $field;  
     if ($len + 4 > length $field) {      if ($len + 4 > length $field) {
         return undef, $field;          return (undef, $field);
     }      }
     my $unpackstr = "x2 C1 C1 A$len";      my $unpackstr = "x2 C1 C1 A$len";
     my $offset    =   2 +1 +1 +$len;      my $offset    =   2 +1 +1 +$len;
     if ($len % 2) { # && $len + 4 < length $field) {      if ($len % 2) {
         # trim the 0/1 byte padding for next even address.          # trim the 0/1 byte padding for next even address.
         $offset++;          $offset++;
         $unpackstr .= ' x'          $unpackstr .= ' x'
Line 1077 
Line 1211 
     my ($label, $font, $data) = unpack $unpackstr, $field;      my ($label, $font, $data) = unpack $unpackstr, $field;
     my $leftover = substr $field, $offset;      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;
Line 1093 
Line 1235 
 {  {
     my $field = shift;      my $field = shift;
   
     my %labels = (      my $packed;
         name       =>   0,      if (defined $field) {
         account    =>   1,          my $label = $field->{label_id} || 0;
         password   =>   2,          if (defined $field->{label} && ! $label) {
         lastchange =>   3,              $label = $field->{label};
         notes      => 255,          }
     );  
   
     my $label = $field->{label_id} || $labels{ $field->{label} };          my $l = labels($field->{label});
     my $font  = $field->{font}     || 0;          if ($l) {
     my $data  = $field->{data}     || '';              $label = $l->{id};
           }
   
     if ($label == 3) {          my $font  = $field->{font} || 0;
         $data = _pack_keyring_date($data);          my $data  = defined $field->{data} ? $field->{data} : $EMPTY;
     }  
     my $len = length $data;  
     my $packstr = "n1 C1 C1 A*";  
   
     my $packed = pack $packstr, ($len, $label, $font, $data);          if ($label && $label == 3) {
               $data = _pack_keyring_date($data);
           }
           my $len = length $data;
           my $packstr = "n1 C1 C1 A*";
   
     if ($len % 2) {          $packed = pack $packstr, ($len, $label, $font, $data);
         # add byte padding for next even address.  
         $packed .= $NULL;          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;      return $packed;
Line 1147 
Line 1296 
     $year -= 4;      $year -= 4;
     $month++;      $month++;
   
     return pack 'n', $day | ($month << 5) | ($year << 9);      return pack 'n*', $day | ($month << 5) | ($year << 9);
 }  }
   
   
Line 1158 
Line 1307 
     my $maxlines = shift; # Max # of lines to dump      my $maxlines = shift; # Max # of lines to dump
     my $offset;           # Offset of current chunk      my $offset;           # Offset of current chunk
   
       my @lines;
   
     for ($offset = 0; $offset < length($data); $offset += 16)      for ($offset = 0; $offset < length($data); $offset += 16)
     {      {
         my $hex;   # Hex values of the data          my $hex;   # Hex values of the data
Line 1172 
Line 1323 
   
         ($ascii = $chunk) =~ y/\040-\176/./c;          ($ascii = $chunk) =~ y/\040-\176/./c;
   
         printf "%s %-48s|%-16s|\n", $prefix, $hex, $ascii;          push @lines, sprintf "%s %-48s|%-16s|\n", $prefix, $hex, $ascii;
     }      }
       return wantarray ? @lines : \@lines;
 }  }
   
 sub _bindump  sub _bindump
Line 1183 
Line 1335 
     my $maxlines = shift; # Max # of lines to dump      my $maxlines = shift; # Max # of lines to dump
     my $offset;           # Offset of current chunk      my $offset;           # Offset of current chunk
   
       my @lines;
   
     for ($offset = 0; $offset < length($data); $offset += 8)      for ($offset = 0; $offset < length($data); $offset += 8)
     {      {
         my $bin;   # binary values of the data          my $bin;   # binary values of the data
Line 1197 
Line 1351 
   
         ($ascii = $chunk) =~ y/\040-\176/./c;          ($ascii = $chunk) =~ y/\040-\176/./c;
   
         printf "%s %-72s|%-8s|\n", $prefix, $bin, $ascii;          push @lines, sprintf "%s %-72s|%-8s|\n", $prefix, $bin, $ascii;
     }      }
       return wantarray ? @lines : \@lines;
 }  }
   
 # Thanks to Jochen Hoenicke <hoenicke@gmail.com>  # Thanks to Jochen Hoenicke <hoenicke@gmail.com>
Line 1210 
Line 1365 
 # keylen is length of generated key in bytes  # keylen is length of generated key in bytes
 # prf is the pseudo random function (e.g. hmac_sha1)  # prf is the pseudo random function (e.g. hmac_sha1)
 # returns the key.  # returns the key.
 sub _pbkdf2($$$$$)  sub _pbkdf2
 {  {
     my ($password, $salt, $iter, $keylen, $prf) = @_;      my ($password, $salt, $iter, $keylen, $prf) = @_;
     my ($k, $t, $u, $ui, $i);      my ($k, $t, $u, $ui, $i);
Line 1226 
Line 1381 
     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 1264 
Line 1419 
 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.  It currently supports the v4 Keyring databases as well as
 The pre-release v5 databases are mostly supported.  There are definitely some  the pre-release v5 databases.
 bugs,  For example, t/keyring5.t sometimes fails.  I am not sure why yet.  
   
 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 1284 
Line 1435 
     my $pdb  = new Palm::PDB;      my $pdb  = new Palm::PDB;
     $pdb->Load($file);      $pdb->Load($file);
   
     foreach (0..$#{ $pdb->{records} }) {      $pdb->Unlock($pass);
         # skip the password record for version 4 databases      foreach my $rec (@{ $pdb->{records} }) {
         next if $_ == 0 && $pdb->{version} == 4;          print $rec->{plaintext}->{0}->{data}, ' - ',
         my $rec  = $pdb->{records}->[$_];                $rec->{plaintext}->{1}->{data}, "\n";
         my $acct = $pdb->Decrypt($rec, $pass);  
         print $rec->{name}, ' - ', $acct->{account}, "\n";  
     }      }
       $pdb->Lock();
   
 =head1 SUBROUTINES/METHODS  =head1 SUBROUTINES/METHODS
   
 =head2 new  =head2 new
   
     $pdb = new Palm::Keyring([$password[, $version]]);      $pdb = new Palm::Keyring([$password[, $version[, $cipher]]]);
   
 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 1304 
Line 1454 
 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  new() now also takes options in other formats
Line 1312 
Line 1462 
     $pdb = new Palm::Keyring({ key1 => value1,  key2 => value2 });      $pdb = new Palm::Keyring({ key1 => value1,  key2 => value2 });
     $pdb = new Palm::Keyring( -key1 => value1, -key2 => value2);      $pdb = new Palm::Keyring( -key1 => value1, -key2 => value2);
   
 =head3 Supported options are:  =over
   
   =item Supported options
   
 =over  =over
   
 =item password  =item password
Line 1324 
Line 1476 
   
 The version of database to create.  Accepts either 4 or 5.  Currently defaults to 4.  The version of database to create.  Accepts either 4 or 5.  Currently defaults to 4.
   
 =item v4compatible  
   
 The format of the fields passed to Encrypt and returned from Decrypt have changed.  
 This allows programs to use the newer databases with few changes but with less features.  
   
 =item cipher  =item cipher
   
 The cipher to use.  0, 1, 2 or 3.  The cipher to use.  Either the number or the name.  Only used by v5 datbases.
   
     0 => None      0 => None
     1 => DES_EDE3      1 => DES_EDE3
Line 1340 
Line 1487 
   
 =item iterations  =item iterations
   
 The number of iterations to encrypt with.  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
   
 =head2 crypt  =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.  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.  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);      my $c = Palm::Keyring::crypt($cipher);
   
 $c is now:  $c is now:
Line 1357 
Line 1523 
     $c = {      $c = {
         alias     => (None|DES_EDE3|AES128|AES256),          alias     => (None|DES_EDE3|AES128|AES256),
         name      => (None|DES_EDE3|Rijndael),          name      => (None|DES_EDE3|Rijndael),
         keylen    => <key length of the ciphe>,          keylen    => <key length of the cipher>,
         blocksize => <block size of the cipher>,          blocksize => <block size of the cipher>,
         default_iter => <default iterations for 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[, $ivec]]);  =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.
   
Line 1375 
Line 1573 
 randomly.  randomly.
   
 $rec is a record from $pdb->{records} or a new_Record().  $rec is a record from $pdb->{records} or a new_Record().
 The v4 $acct is a hashref in the format below.  $rec->{plaintext} is a hashref in the format below.
   
     my $v4acct = {      $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',
 The v5 $acct is an arrayref full of hashrefs that contain each encrypted field.              label_id => 2,
               font     => 0,
     my $v5acct = [              data     => $password,
         {  
             'label_id' => 2,  
             'data' => 'abcd1234',  
             'label' => 'password',  
             'font' => 0  
         },          },
         {          3 => {
             'label_id' => 3,              label    => 'lastchange',
             'data' => {              label_id => 3,
                 'month' => 1,              font     => 0,
                 'day' => 11,              data     => {
                 'year' => 107                  year => $year, # usually the year - 1900
                   mon  => $mon,  # range 0-11
                   day  => $day,  # range 1-31
             },              },
             'label' => 'lastchange',  
             'font' => 0  
         },          },
         {          255 => {
             'label_id' => 255,              label    => 'notes',
             'data' => 'This is a short note.',              label_id => 255,
             'label' => 'notes',              font     => 0,
             '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.
   
 The account name is stored in $rec->{name} for both v4 and v5 databases.      $rec->{plaintext}->{0} => {
 It is not returned in the decrypted information for v5.          label    => 'name',
           label_id => 0,
           font     => 0,
           data     => 'account name',
       };
   
     $rec->{name} = '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 reference 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 && $pdb->{version} == 4;          my $plaintext = $pdb->Decrypt($rec);
         my $rec = $pdb->{records}->[$_];          # do something with $plaintext
         my $acct = $pdb->Decrypt($rec);  
         # do something with $acct  
     }      }
   
   
Line 1458 
Line 1659 
   
 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 1482 
Line 1796 
 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
Legend:
Removed from v.1.35  
changed lines
  Added in v.1.64
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>