Crypt::OpenPGP::Plaintext 1.03

Crypt::OpenPGP::Plaintext is a plaintext, literal-data packet.

SYNOPSIS

use Crypt::OpenPGP::Plaintext;

my $pt = Crypt::OpenPGP::Plaintext->new(
Data => $data,
Filename => $file,
);
my $serialized = $pt->save;

my $pt = Crypt::OpenPGP::Plaintext->parse($buffer);

Crypt::OpenPGP::Plaintext implements plaintext literal-data packets, and is essentially just a container for a string of octets, along with some meta-data about the plaintext.

USAGE

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

Creates a new plaintext data packet object and returns that object. If there are no arguments in %arg, the object is created with an empty data container; 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:

Data

A block of octets that make up the plaintext data.

This argument is required (for a non-empty object).

Filename

The name of the file that this data came from, or the name of a file where it should be saved upon extraction from the packet (after decryption, for example, if this packet is going to be encrypted).

Mode

The mode in which the data is formatted. Valid values are t and b, meaning "text" and "binary", respectively.

This argument is optional; Mode defaults to b.

$pt->save

Returns the serialized form of the plaintext object, which is the plaintext data, preceded by some meta-data describing the data.

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

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

$pt->data

Returns the plaintext data.

$pt->mode

Returns the mode of the packet (either t or b).