Benjamin Trott > Crypt-OpenPGP > Crypt::OpenPGP::SKSessionKey

Download:
Crypt-OpenPGP-1.06.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  15
Open  7
View/Report Bugs
Source   Latest Release: Crypt-OpenPGP-1.07

NAME ^

Crypt::OpenPGP::SKSessionKey - Symmetric-Key Encrypted Session Key

SYNOPSIS ^

    use Crypt::OpenPGP::SKSessionKey;

    my $passphrase = 'foobar';  # Not a very good passphrase
    my $key_data = 'f' x 64;    # Not a very good key

    my $skey = Crypt::OpenPGP::SKSessionKey->new(
        Passphrase  => $passphrase,
        SymKey      => $key_data,
    );
    my $serialized = $skey->save;

DESCRIPTION ^

Crypt::OpenPGP::SKSessionKey implements symmetric-key encrypted session key packets; these packets store symmetric-key-encrypted key data that, when decrypted using the proper passphrase, can be used to decrypt a block of ciphertext--that is, a Crypt::OpenPGP::Ciphertext object.

Symmetric-key encrypted session key packets can work in two different ways: in one scenario the passphrase you provide is used to encrypt a randomly chosen string of key material; the key material is the key that is actually used to encrypt the data packet, and the passphrase just serves to encrypt the key material. This encrypted key material is then serialized into the symmetric-key encrypted session key packet.

The other method of using this encryption form is to use the passphrase directly to encrypt the data packet. In this scenario the need for any additional key material goes away, because all the receiver needs is the same passphrase that you have entered to encrypt the data.

At the moment Crypt::OpenPGP really only supports the first scenario; note also that the interface to new may change in the future when support for the second scenario is added.

USAGE ^

Crypt::OpenPGP::SKSessionKey->new( %arg )

Creates a new encrypted session key packet object and returns that object. If there are no arguments in %arg, the object is created empty; this is used, for example in parse (below), to create an empty packet which is then filled from the data in the buffer.

If you wish to initialize a non-empty object, %arg can contain:

$skey->save

Serializes the session key packet and returns the string of octets.

Crypt::OpenPGP::SKSessionKey->parse($buffer)

Given $buffer, a Crypt::OpenPGP::Buffer object holding (or with offset pointing to) an encrypted session key packet, returns a new Crypt::OpenPGP::Ciphertext object, initialized with the data in the buffer.

$skey->decrypt($passphrase)

Given a passphrase $passphrase, decrypts the encrypted session key data. The key data includes the symmetric key itself, along with a one-octet ID of the symmetric cipher used to encrypt the message.

Returns a list containing two items: the symmetric key and the cipher algorithm ID. These are suitable for passing off to the decrypt method of a Crypt::OpenPGP::Ciphertext object to decrypt a block of encrypted data.

AUTHOR & COPYRIGHTS ^

Please see the Crypt::OpenPGP manpage for author, copyright, and license information.

syntax highlighting: