=================================================================== RCS file: /cvs/palm/Palm-Keyring/lib/Palm/Keyring.pm,v retrieving revision 1.29 retrieving revision 1.42 diff -u -r1.29 -r1.42 --- palm/Palm-Keyring/lib/Palm/Keyring.pm 2007/02/19 00:22:42 1.29 +++ palm/Palm-Keyring/lib/Palm/Keyring.pm 2007/02/23 03:41:28 1.42 @@ -1,5 +1,5 @@ package Palm::Keyring; -# $RedRiver: Keyring.pm,v 1.28 2007/02/18 05:50:25 andrew Exp $ +# $RedRiver: Keyring.pm,v 1.41 2007/02/23 03:38:07 andrew Exp $ ######################################################################## # Keyring.pm *** Perl class for Keyring for Palm OS databases. # @@ -16,17 +16,9 @@ use warnings; use Carp; -use Data::Dumper; 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 $DECRYPT = 0; my $MD5_CBLOCK = 64; @@ -36,26 +28,30 @@ my $NULL = chr 0; my @CRYPTS = ( - { # None + { + alias => 'None', name => 'None', keylen => 8, blocksize => 1, default_iter => 500, }, - { # DES-EDE3 + { + alias => 'DES-EDE3', name => 'DES_EDE3', keylen => 24, blocksize => 8, DES_odd_parity => 1, default_iter => 1000, }, - { # AES128 + { + alias => 'AES128', name => 'Rijndael', keylen => 16, blocksize => 16, default_iter => 100, }, - { # AES256 + { + alias => 'AES256', name => 'Rijndael', keylen => 32, blocksize => 16, @@ -111,11 +107,11 @@ # Set defaults if ($self->{version} == 5) { $self->{options}->{cipher} ||= 0; # 'None' - $self->{options}->{iterations} ||= - $CRYPTS[ $self->{options}->{cipher} ]{default_iter}; - - $self->{appinfo}->{cipher} ||= $self->{options}->{cipher}; - $self->{appinfo}->{iter} ||= $self->{options}->{iterations}; + 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} ) { @@ -131,6 +127,26 @@ return 1; } +# 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]; + } +} + # ParseRecord sub ParseRecord @@ -152,17 +168,15 @@ delete $rec->{data}; } 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 ($ivec, $encrypted) = unpack "A$blocksize A*", $extra; + delete $rec->{data}; - if ($self->{options}->{v4compatible}) { - $rec->{name} = $field->{data}; - } else { - $rec->{name} = $field; - } - $rec->{ivec} = $ivec; - $rec->{encrypted} = $encrypted; + $rec->{name} = $field->{data}; + $rec->{ivec} = substr $extra, 0, $blocksize; + $rec->{encrypted} = substr $extra, $blocksize; } else { die 'Unsupported Version'; @@ -192,25 +206,21 @@ } elsif ($self->{version} == 5) { my $field; if ($rec->{name}) { - if ($self->{options}->{v4compatible}) { - $field = { - label => 'name', - font => 0, - data => $rec->{'name'}, - }; - } else { - $field = $rec->{name}; - } + $field = { + 'label_id' => 1, + 'data' => $rec->{name}, + 'font' => 0, + }; + } else { + $field = { + 'label_id' => $EMPTY, + 'data' => $EMPTY, + 'font' => 0, + }; } - my $packed = ''; - if ($field) { - $packed = _pack_field($field); - } - my $len = length $packed; - my $blocksize = $CRYPTS[ $self->{appinfo}->{cipher} ]{blocksize}; + my $packed = _pack_field($field); - $rec->{data} = pack "A$len A$blocksize A*", - $packed, $rec->{ivec}, $rec->{encrypted}; + $rec->{data} = join '', $packed, $rec->{ivec}, $rec->{encrypted}; } else { die 'Unsupported Version'; @@ -263,7 +273,7 @@ my $unpackstr = ("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 my (@salt, $iter, $cipher, @hash); @@ -304,7 +314,7 @@ my $packstr = ("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 my @salt = map { hex $_ } $appinfo->{salt} =~ /../gxm; @@ -330,6 +340,7 @@ my $rec = shift; my $data = shift; my $pass = shift || $self->{password}; + my $ivec = shift; if ( ! $pass && ! $self->{appinfo}->{key}) { croak("password not set!\n"); @@ -359,31 +370,30 @@ $rec->{name} ||= $data->{name}; } elsif ($self->{version} == 5) { - my @recs = ($data, $acct); - my $name; + my @accts = ($data, $acct); if ($self->{options}->{v4compatible}) { $rec->{name} ||= $data->{name}; - foreach my $rec (@recs) { + foreach my $a (@accts) { my @fields; - foreach my $k (sort keys %{ $rec }) { + foreach my $k (sort keys %{ $a }) { my $field = { label => $k, font => 0, - data => $rec->{$k}, + data => $a->{$k}, }; push @fields, $field; } - $rec = \@fields; + $a = \@fields; } } - my $ivec; ($encrypted, $ivec) = _encrypt_v5( - @recs, + @accts, $self->{appinfo}->{key}, $self->{appinfo}->{cipher}, + $ivec, ); - if ($ivec) { + if (defined $ivec) { $rec->{ivec} = $ivec; } @@ -481,28 +491,29 @@ my $old = shift; my $key = shift; my $cipher = shift; - my $ivec = shift || pack("C*",map {rand(256)} 1..8); + my $ivec = shift; + my $c = crypts($cipher) or croak('Unknown cipher ' . $cipher); - my $keylen = $CRYPTS[ $cipher ]{keylen}; - my $cipher_name = $CRYPTS[ $cipher ]{name}; + if (! defined $ivec) { + $ivec = pack("C*",map {rand(256)} 1..$c->{blocksize}); + } my $changed = 0; my $need_newdate = 1; my $date_index; for (my $i = 0; $i < @{ $new }; $i++) { if ( - (exists $new->[$i]->{label_id} && $new->[$i]->{label_id} == 3) || - (exists $new->[$i]->{label} && $new->[$i]->{label} eq 'lastchange') + ($new->[$i]->{label_id} && $new->[$i]->{label_id} == 3) || + ($new->[$i]->{label} && $new->[$i]->{label} eq 'lastchange') ) { $date_index = $i; if ( $old && $#{ $new } == $#{ $old } && ( - $new->[$i]->{data}->{day} != $old->[$i]->{data}->{day} || - $new->[$i]->{data}->{month} != $old->[$i]->{data}->{month} || - $new->[$i]->{data}->{year} != $old->[$i]->{data}->{year} + $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; } } elsif ($old && $#{ $new } == $#{ $old }) { @@ -548,19 +559,20 @@ foreach my $field (@{ $new }) { $decrypted .= _pack_field($field); } - my $encrypted; - if ($cipher_name eq 'None') { + if ($c->{name} eq 'None') { # do nothing $encrypted = $decrypted; - } elsif ($cipher_name eq 'DES_EDE3' or $cipher_name eq 'Rijndael') { - my $c = Crypt::CBC->new( - -literal_key => 1, + } 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 => $cipher_name, - -keysize => $keylen, + -cipher => $c->{name}, + -keysize => $c->{keylen}, + -blocksize => $c->{blocksize}, -header => 'none', -padding => 'oneandzeroes', ); @@ -569,7 +581,7 @@ croak("Unable to set up encryption!"); } - $encrypted = $c->encrypt($decrypted); + $encrypted = $cbc->encrypt($decrypted); } else { die "Unsupported Version"; @@ -580,7 +592,7 @@ # Decrypt -sub Decrypt +sub Decrypt { my $self = shift; my $rec = shift; @@ -594,7 +606,7 @@ croak("Needed parameter 'record' not passed!\n"); } - if ( ! $self->Password($pass)) { + if ( $pass && ! $self->Password($pass)) { croak("Invalid Password!\n"); } @@ -654,27 +666,29 @@ sub _decrypt_v5 { + my $encrypted = shift; my $key = shift; my $cipher = shift; my $ivec = shift; - my $keylen = $CRYPTS[ $cipher ]{keylen}; - my $cipher_name = $CRYPTS[ $cipher ]{name}; + my $c = crypts($cipher) or croak('Unknown cipher ' . $cipher); my $decrypted; - if ($cipher_name eq 'None') { + if ($c->{name} eq 'None') { # do nothing $decrypted = $encrypted; - } elsif ($cipher_name eq 'DES_EDE3' or $cipher_name eq 'Rijndael') { - my $c = Crypt::CBC->new( - -literal_key => 1, + } 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 => $cipher_name, - -keysize => $keylen, + -cipher => $c->{name}, + -keysize => $c->{keylen}, + -blocksize => $c->{blocksize}, -header => 'none', -padding => 'oneandzeroes', ); @@ -682,8 +696,9 @@ if (! $c) { croak("Unable to set up encryption!"); } - $encrypted .= $NULL x $keylen; # pad out a keylen - $decrypted = $c->decrypt($encrypted); + my $len = $c->{blocksize} - length($encrypted) % $c->{blocksize}; + $encrypted .= $NULL x $len; + $decrypted = $cbc->decrypt($encrypted); } else { die "Unsupported Version"; @@ -713,7 +728,7 @@ if (! $pass) { delete $self->{password}; - delete $self->{key}; + delete $self->{appinfo}->{key}; return 1; } @@ -781,7 +796,7 @@ } } } elsif ($self->{version} == 5) { - return _password_verify_v5($pass, $self->{appinfo}); + return _password_verify_v5($self->{appinfo}, $pass); } else { # XXX unsupported version } @@ -791,6 +806,9 @@ sub _password_verify_v4 { + require Digest::MD5; + import Digest::MD5 qw(md5); + my $pass = shift; my $data = shift; @@ -808,7 +826,7 @@ my $digest = md5($msg); - if (! $data eq $salt . $digest ) { + if ($data ne $salt . $digest ) { return; } @@ -817,18 +835,22 @@ sub _password_verify_v5 { - my $pass = shift; my $appinfo = shift; + my $pass = shift; my $salt = pack("H*", $appinfo->{salt}); + my $c = crypts($appinfo->{cipher}) + or croak('Unknown cipher ' . $appinfo->{cipher}); my ($key, $hash) = _calc_key_v5( $pass, $salt, $appinfo->{iter}, - $CRYPTS[ $appinfo->{cipher} ]{keylen}, - $CRYPTS[ $appinfo->{cipher} ]{DES_odd_parity}, + $c->{keylen}, + $c->{DES_odd_parity}, ); + #print "Iter: '" . $appinfo->{iter} . "'\n"; #print "Key: '". unpack("H*", $key) . "'\n"; + #print "Salt: '". unpack("H*", $salt) . "'\n"; #print "Hash: '". $hash . "'\n"; #print "Hash: '". $appinfo->{masterhash} . "'\n"; @@ -891,6 +913,9 @@ sub _password_update_v4 { + require Digest::MD5; + import Digest::MD5 qw(md5); + my $pass = shift; if (! defined $pass) { croak('No password specified!'); }; @@ -923,22 +948,23 @@ 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, - $CRYPTS[ $cipher ]->{keylen}, - $CRYPTS[ $cipher ]->{DES_odd_parity}, + $c->{keylen}, + $c->{DES_odd_parity}, ); $appinfo->{salt} = unpack "H*", $salt; $appinfo->{iter} = $iter; $appinfo->{cipher} = $cipher; - - $appinfo->{key} = $key; $appinfo->{masterhash} = $hash; + $appinfo->{key} = $key; return $key; } +# Helpers sub _calc_keys { @@ -968,6 +994,11 @@ { 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); } @@ -978,6 +1009,8 @@ sub _crypt3des { + require Crypt::DES; + my ( $plaintext, $passphrase, $flag ) = @_; $passphrase .= $SPACE x ( 16 * 3 ); @@ -1036,21 +1069,22 @@ $labels[3] = 'lastchange'; $labels[255] = 'notes'; - my ($len) = unpack "S1", $field; + my ($len) = unpack "n1", $field; if ($len + 4 > length $field) { return undef, $field; } - my $unpackstr = "S1 C1 C1 A$len"; - if ($len % 2) { + my $unpackstr = "x2 C1 C1 A$len"; + my $offset = 2 +1 +1 +$len; + if ($len % 2) { # && $len + 4 < length $field) { # trim the 0/1 byte padding for next even address. + $offset++; $unpackstr .= ' x' } - $unpackstr .= ' A*'; - my (undef, $label, $font, $data, $leftover) - = unpack $unpackstr, $field; + my ($label, $font, $data) = unpack $unpackstr, $field; + my $leftover = substr $field, $offset; - if ($label == 3) { + if ($label && $label == 3) { $data = _parse_keyring_date($data); } return { @@ -1074,21 +1108,30 @@ notes => 255, ); - my $label = $field->{label_id} || $labels{ $field->{label} }; - my $font = $field->{font} || 0; - my $data = $field->{data} || ''; + my $packed; + if (defined $field) { + my $label = $field->{label_id} || 0; + if (defined $field->{label} && ! $label) { + $label = $labels{ $field->{label} }; + } + my $font = $field->{font} || 0; + my $data = defined $field->{data} ? $field->{data} : $EMPTY; - if ($label == 3) { - $data = _pack_keyring_date($data); - } - my $len = length $data; - my $packstr = "S1 C1 C1 A*"; + if ($label && $label == 3) { + $data = _pack_keyring_date($data); + } + my $len = length $data; + my $packstr = "n1 C1 C1 A*"; - my $packed = pack $packstr, ($len, $label, $font, $data); + $packed = pack $packstr, ($len, $label, $font, $data); - if ($len % 2) { - # 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; @@ -1227,7 +1270,6 @@ 1; __END__ - =head1 NAME Palm::Keyring - Handler for Palm Keyring databases. @@ -1241,8 +1283,10 @@ It has the standard Palm::PDB methods with 2 additional public methods. Decrypt and Encrypt. -It currently supports the v4 Keyring databases. The v5 databases from -the pre-release keyring-2.0 are not supported. +It currently supports the v4 Keyring databases as well as +the pre-release v5 databases. I am not completely happy with the interface +for accessing v5 databases, so any suggestions on improvements on +the interface are appreciated. This module doesn't store the decrypted content. It only keeps it until it returns it to you or encrypts it. @@ -1258,17 +1302,29 @@ $pdb->Load($file); foreach (0..$#{ $pdb->{records} }) { - next if $_ = 0; # skip the password record + # skip the password record for version 4 databases + next if $_ == 0 && $pdb->{version} == 4; my $rec = $pdb->{records}->[$_]; my $acct = $pdb->Decrypt($rec, $pass); - print $rec->{name}, ' - ', $acct->{account}, "\n"; + print $rec->{name}, ' - '; + if ($pdb->{version} == 4 || $pdb->{options}->{v4compatible}) { + print ' - ', $acct->{account}; + } else { + foreach my $a (@{ $acct }) { + if ($a->{label} eq 'account') { + print ' - ', $a->{data}; + last; + } + } + } + print "\n"; } =head1 SUBROUTINES/METHODS =head2 new - $pdb = new Palm::Keyring([$password]); + $pdb = new Palm::Keyring([$password[, $version]]); Create a new PDB, initialized with the various Palm::Keyring fields and an empty record list. @@ -1279,17 +1335,97 @@ If you pass in a password, it will initalize the first record with the encrypted password. +new() now also takes options in other formats + + $pdb = new Palm::Keyring({ key1 => value1, key2 => value2 }); + $pdb = new Palm::Keyring( -key1 => value1, -key2 => value2); + +=over + +=item Supported options + +=over + +=item password + +The password used to initialize the database + +=item version + +The version of database to create. Accepts either 4 or 5. Currently defaults to 4. + +=item 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 + +The cipher to use. Either the number or the name. + + 0 => None + 1 => DES_EDE3 + 2 => AES128 + 3 => AES256 + +=item iterations + +The number of iterations to encrypt with. + +=item options + +A hashref of the options that are set + +=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 + cipher => The index number of the cipher being used + iter => Number of iterations for the cipher + }; + +=head2 crypt + +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 => , + blocksize => , + default_iter => , + }; + =head2 Encrypt - $pdb->Encrypt($rec, $acct[, $password]); + $pdb->Encrypt($rec, $acct[, $password[, $ivec]]); Encrypts an account into a record, either with the password previously used, or with a password that is passed. +$ivec is the initialization vector to use to encrypt the record. This is +not used by v4 databases. Normally this is not passed and is generated +randomly. + $rec is a record from $pdb->{records} or a new_Record(). -$acct is a hashref in the format below. +The v4 $acct is a hashref in the format below. - my $acct = { + my $v4acct = { name => $rec->{name}, account => $account, password => $password, @@ -1301,6 +1437,39 @@ }, }; +The v5 $acct is an arrayref full of hashrefs that contain each encrypted field. + + my $v5acct = [ + { + 'label_id' => 2, + 'data' => 'abcd1234', + 'label' => 'password', + 'font' => 0 + }, + { + 'label_id' => 3, + 'data' => { + 'month' => 1, + 'day' => 11, + 'year' => 107 + }, + 'label' => 'lastchange', + 'font' => 0 + }, + { + 'label_id' => 255, + 'data' => 'This is a short note.', + 'label' => 'notes', + 'font' => 0 + } + ]; + + +The account name is stored in $rec->{name} for both v4 and v5 databases. +It is not returned in the decrypted information for v5. + + $rec->{name} = 'account name'; + If you have changed anything other than the lastchange, or don't pass in a lastchange key, Encrypt() will generate a new lastchange date for you. @@ -1313,16 +1482,17 @@ my $acct = $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 account as described under Encrypt(). - foreach (0..$#{ $pdb->{records}) { - next if $_ == 0; + foreach (0..$#{ $pdb->{records} }) { + next if $_ == 0 && $pdb->{version} == 4; my $rec = $pdb->{records}->[$_]; - my $acct = $pdb->Decrypt($rec[, $password]); + my $acct = $pdb->Decrypt($rec); # do something with $acct } + =head2 Password $pdb->Password([$password[, $new_password]]); @@ -1336,16 +1506,52 @@ 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; + +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. + }; + =head1 DEPENDENCIES Palm::StdAppInfo +B + Digest::MD5 Crypt::DES -Readonly +B +Digest::HMAC_SHA1 + +Digest::SHA1 + +Depending on how the database is encrypted + +Crypt::CBC - For any encryption but None + +Crypt::DES_EDE3 + +Crytp::Rijndael - The AES encryption schemes + =head1 THANKS I would like to thank the helpful Perlmonk shigetsu who gave me some great advice @@ -1360,6 +1566,12 @@ as giving me some very helpful hints about doing a few things that I was unsure of. He is really great. +And finally, +thanks to Jochen Hoenicke Ehoenicke@gmail.comE +(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 Please report any bugs or feature requests to @@ -1386,6 +1598,9 @@ The Keyring for Palm OS website: L + +The HACKING guide for palm keyring databases: +L Johan Vromans also has a wxkeyring app that now uses this module, available from his website at L