| version 1.48, 2007/09/12 03:44:36 |
version 1.55, 2008/09/17 15:47:47 |
|
|
| package Palm::Keyring; |
package Palm::Keyring; |
| # $RedRiver: Keyring.pm,v 1.47 2007/09/12 00:30:10 andrew Exp $ |
# $RedRiver: Keyring.pm,v 1.54 2007/12/05 05:42:29 andrew Exp $ |
| ######################################################################## |
######################################################################## |
| # Keyring.pm *** Perl class for Keyring for Palm OS databases. |
# Keyring.pm *** Perl class for Keyring for Palm OS databases. |
| # |
# |
|
|
| use strict; |
use strict; |
| use warnings; |
use warnings; |
| |
|
| |
require 5.006_001; |
| |
|
| use Carp; |
use Carp; |
| |
|
| use base qw/ Palm::StdAppInfo /; |
use base qw/ Palm::StdAppInfo /; |
|
|
| ); |
); |
| |
|
| |
|
| our $VERSION = '0.96_01'; |
our $VERSION = '0.96_07'; |
| |
|
| sub new |
sub new |
| { |
{ |
|
|
| |
|
| my $plaintext; |
my $plaintext; |
| foreach my $k (keys %{ $new }) { |
foreach my $k (keys %{ $new }) { |
| |
next if $new->{$k}->{label_id} == 0; |
| $plaintext .= _pack_field($new->{$k}); |
$plaintext .= _pack_field($new->{$k}); |
| } |
} |
| |
$plaintext .= chr(0xff) x 2; |
| |
|
| my $encrypted; |
my $encrypted; |
| if ($c->{name} eq 'None') { |
if ($c->{name} eq 'None') { |
|
|
| |
|
| my ($len) = unpack "n", $field; |
my ($len) = unpack "n", $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; |
|
|
| 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 |
|
|
| |
|
| ($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 |
|
|
| 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 |
|
|
| |
|
| ($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> |
|
|
| # 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); |
|
|
| 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 = ( |
|
|
| 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 as well as |
It currently supports the v4 Keyring databases as well as |
| the pre-release v5 databases. I am not completely happy with the interface |
the pre-release v5 databases. |
| for accessing v5 databases, so any suggestions on improvements on |
|
| the interface are appreciated. |
|
| |
|
| This module doesn't store the plaintext content. It only keeps it until it |
|
| returns it to you or encrypts it. |
|
| |
|
| =head1 SYNOPSIS |
=head1 SYNOPSIS |
| |
|
| use Palm::PDB; |
use Palm::PDB; |
|
|
| my $pdb = new Palm::PDB; |
my $pdb = new Palm::PDB; |
| $pdb->Load($file); |
$pdb->Load($file); |
| |
|
| |
$pdb->Unlock($pass); |
| foreach my $rec (@{ $pdb->{records} }) { |
foreach my $rec (@{ $pdb->{records} }) { |
| my $plaintext = $pdb->Decrypt($rec, $pass); |
print $rec->{plaintext}->{0}->{data}, ' - ', |
| print $plaintext->{0}->{data}, ' - ', $plaintext->{1}->{data}, "\n"; |
$rec->{plaintext}->{1}->{data}, "\n"; |
| } |
} |
| |
$pdb->Lock(); |
| |
|
| =head1 SUBROUTINES/METHODS |
=head1 SUBROUTINES/METHODS |
| |
|
|
|
| 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 |
|
|
| |
|
| =item cipher |
=item cipher |
| |
|
| The cipher to use. Either the number or the name. |
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 |
|
|
| |
|
| =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 options |
|
| |
|
| A hashref of the options that are set |
|
| |
|
| =back |
=back |
| |
|
| =back |
=back |
|
|
| |
|
| =head2 labels |
=head2 labels |
| |
|
| Pass in the id or the name of the label; |
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. |
This is a function, not a method. |
| |
|
|
|
| |
|
| =head2 Encrypt |
=head2 Encrypt |
| |
|
| |
=head3 B<!!! IMPORTANT !!!> The order of the arguments to Encrypt has |
| |
changed. $password and $plaintext used to be swapped. They changed |
| |
because you can now set $rec->{plaintext} and not pass in $plaintext so |
| |
$password is more important. |
| |
|
| $pdb->Encrypt($rec[, $password[, $plaintext[, $ivec]]]); |
$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 |
|
|
| label => 'lastchange', |
label => 'lastchange', |
| label_id => 3, |
label_id => 3, |
| font => 0, |
font => 0, |
| data => $lastchange, |
data => { |
| |
year => $year, # usually the year - 1900 |
| |
mon => $mon, # range 0-11 |
| |
day => $day, # range 1-31 |
| |
}, |
| }, |
}, |
| 255 => { |
255 => { |
| label => 'notes', |
label => 'notes', |
|
|
| }, |
}, |
| }; |
}; |
| |
|
| The account name is also stored in $rec->{plaintext}->{0}->{data} for both v4 |
The account name is stored in $rec->{plaintext}->{0}->{data} for both v4 |
| and v5 databases. |
and v5 databases even when the record has not been Decrypt()ed. |
| |
|
| $rec->{plaintext}->{0} => { |
$rec->{plaintext}->{0} => { |
| label => 'name', |
label => 'name', |
|
|
| my $plaintext = $pdb->Decrypt($rec[, $password]); |
my $plaintext = $pdb->Decrypt($rec[, $password]); |
| |
|
| Decrypts the record and returns a reference for the plaintext account as |
Decrypts the record and returns a reference for the plaintext account as |
| described under L<Encrypt>. |
described under Encrypt(). |
| Also sets $rec->{plaintext} with the same information as $plaintext as |
Also sets $rec->{plaintext} with the same information as $plaintext as |
| described in L<Encrypt>. |
described in Encrypt(). |
| |
|
| foreach my $rec (@{ $pdb->{records} }) { |
foreach my $rec (@{ $pdb->{records} }) { |
| my $plaintext = $pdb->Decrypt($rec); |
my $plaintext = $pdb->Decrypt($rec); |
|
|
| |
|
| Unsets $rec->{plaintext} for all records and unsets the saved password. |
Unsets $rec->{plaintext} for all records and unsets the saved password. |
| |
|
| This does NOT L<Encrypt> any of the records before clearing them, so if |
This does NOT Encrypt() any of the records before clearing them, so if |
| you are not careful you will lose information. |
you are not careful you will lose information. |
| |
|
| B<CAVEAT!> This only does "delete $rec->{plaintext}" and the same for the |
B<CAVEAT!> This only does "delete $rec->{plaintext}" and the same for the |
|
|
| I am not sure I am 'require module' the best way, but I don't want to |
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. |
depend on modules that you don't need to use. |
| |
|
| I am not very happy with the data structures used by Encrypt() and |
|
| Decrypt() for v5 databases, but I am not sure of a better way. |
|
| |
|
| The date validation for packing new dates is very poor. |
The date validation for packing new dates is very poor. |
| |
|
| I have not gone through and standardized on how the module fails. Some |
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. |
things fail with croak, some return undef, some may even fail silently. |
| Nothing initializes a lasterr method or anything like that. I need |
Nothing initializes a lasterr method or anything like that. |
| to fix all that before it is a 1.0 candidate. |
|
| |
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 |