=================================================================== RCS file: /cvs/palm/Palm-Keyring/lib/Palm/Keyring.pm,v retrieving revision 1.32 retrieving revision 1.42 diff -u -r1.32 -r1.42 --- palm/Palm-Keyring/lib/Palm/Keyring.pm 2007/02/19 03:33:56 1.32 +++ 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.31 2007/02/19 02:55:35 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. # @@ -28,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, @@ -103,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} ) { @@ -123,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 @@ -144,14 +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 = substr $extra, 0, $blocksize; - my $encrypted = substr $extra, $blocksize; + delete $rec->{data}; $rec->{name} = $field->{data}; - $rec->{ivec} = $ivec; - $rec->{encrypted} = $encrypted; + $rec->{ivec} = substr $extra, 0, $blocksize; + $rec->{encrypted} = substr $extra, $blocksize; } else { die 'Unsupported Version'; @@ -179,12 +204,21 @@ } } elsif ($self->{version} == 5) { - my $field = { - 'label_id' => 1, - 'data' => $rec->{name}, - 'font' => 0, - }; - my $packed .= _pack_field($field); + my $field; + if ($rec->{name}) { + $field = { + 'label_id' => 1, + 'data' => $rec->{name}, + 'font' => 0, + }; + } else { + $field = { + 'label_id' => $EMPTY, + 'data' => $EMPTY, + 'font' => 0, + }; + } + my $packed = _pack_field($field); $rec->{data} = join '', $packed, $rec->{ivec}, $rec->{encrypted}; @@ -239,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); @@ -280,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; @@ -306,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"); @@ -335,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; } @@ -384,8 +418,6 @@ sub _encrypt_v4 { - require Crypt::CBC; - my $new = shift; my $old = shift; my $digest = shift; @@ -459,29 +491,29 @@ my $old = shift; my $key = shift; my $cipher = shift; - my $length = $CRYPTS[ $cipher ]{blocksize}; - my $ivec = shift || pack("C*",map {rand(256)} 1..$length); + 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 }) { @@ -527,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', ); @@ -548,7 +581,7 @@ croak("Unable to set up encryption!"); } - $encrypted = $c->encrypt($decrypted); + $encrypted = $cbc->encrypt($decrypted); } else { die "Unsupported Version"; @@ -633,28 +666,29 @@ sub _decrypt_v5 { - require Crypt::CBC; + 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', ); @@ -662,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"; @@ -761,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,7 +826,7 @@ my $digest = md5($msg); - if (! $data eq $salt . $digest ) { + if ($data ne $salt . $digest ) { return; } @@ -800,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"; @@ -909,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 { @@ -1029,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 && $len + 4 < length $field) { + 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 { @@ -1067,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; @@ -1233,9 +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 pre-release v5 databases are mostly supported. There are definitely some -bugs, For example, t/keyring5.t sometimes fails. I am not sure why yet. +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. @@ -1255,7 +1306,18 @@ 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 @@ -1278,8 +1340,10 @@ $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 =item password @@ -1297,7 +1361,7 @@ =item cipher -The cipher to use. 0, 1, 2 or 3. +The cipher to use. Either the number or the name. 0 => None 1 => DES_EDE3 @@ -1308,15 +1372,56 @@ 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(). The v4 $acct is a hashref in the format below. @@ -1361,7 +1466,7 @@ The account name is stored in $rec->{name} for both v4 and v5 databases. -It is not returned in the decrypted information for v5. +It is not returned in the decrypted information for v5. $rec->{name} = 'account name'; @@ -1380,7 +1485,7 @@ Decrypts the record and returns a reference for the account as described under Encrypt(). - foreach (0..$#{ $pdb->{records}) { + foreach (0..$#{ $pdb->{records} }) { next if $_ == 0 && $pdb->{version} == 4; my $rec = $pdb->{records}->[$_]; my $acct = $pdb->Decrypt($rec); @@ -1401,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 @@ -1424,6 +1565,12 @@ mine was ready and he was kind enough to let me have the namespace as well as giving me some very helpful hints about doing a few things that I was unsure of. He is really great. + +And finally, +thanks to Jochen Hoenicke 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