[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.48 and 1.50

version 1.48, 2007/09/12 03:44:36 version 1.50, 2007/09/13 01:02:52
Line 1 
Line 1 
 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.49 2007/09/12 03:39:22 andrew Exp $
 ########################################################################  ########################################################################
 # Keyring.pm *** Perl class for Keyring for Palm OS databases.  # Keyring.pm *** Perl class for Keyring for Palm OS databases.
 #  #
Line 83 
Line 83 
 );  );
   
   
 our $VERSION = '0.96_01';  our $VERSION = '0.96_04';
   
 sub new  sub new
 {  {
Line 1391 
Line 1391 
 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;
Line 1412 
Line 1407 
     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
   
Line 1429 
Line 1426 
 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 1453 
Line 1450 
   
 =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
Line 1462 
Line 1459 
   
 =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
Line 1507 
Line 1500 
   
 =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.
   
Line 1531 
Line 1526 
   
 =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
Line 1565 
Line 1565 
             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',
Line 1575 
Line 1579 
         },          },
     };      };
   
 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',
Line 1600 
Line 1604 
     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);
Line 1668 
Line 1672 
   
 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
Line 1774 
Line 1778 
 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
Legend:
Removed from v.1.48  
changed lines
  Added in v.1.50
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>