NAME

Mail::DKIM::Algorithm::Base - base class for DKIM "algorithms"

SYNOPSIS

my $algorithm = new Mail::DKIM::Algorithm::rsa_sha1(
                    Signature => $dkim_signature
                );

# add headers
$algorithm->add_header("Subject: this is the subject\015\012");
$algorithm->finish_header;

# add body
$algorithm->add_body("This is the body.\015\012");
$algorithm->add_body("Another line of the body.\015\012");
$algorithm->finish_body;

# now sign or verify...
# TODO...

CONSTRUCTOR

You should not create an object of this class directly. Instead, use one of the DKIM algorithm implementation classes, such as rsa_sha1:

my $algorithm = new Mail::DKIM::Algorithm::rsa_sha1(
                    Signature => $dkim_signature
                );

METHODS

add_body() - feeds part of the body into the algorithm/canonicalization

$algorithm->add_body("This is the body.\015\012");
$algorithm->add_body("Another line of the body.\015\012");

add_header() - feeds a header field into the algorithm/canonicalization

$algorithm->add_header("Subject: this is the subject\015\012");

The header must start with the header field name and continue through any folded lines (including the embedded <CRLF> sequences). It terminates with the <CRLF> at the end of the header field.

finish_body() - signals the end of the message body

$algorithm->finish_body

Call this method when all lines from the body have been submitted. After calling this method, use sign() or verify() to get the results from the algorithm.

finish_header() - signals the end of the header field block

$algorithm->finish_header;

Call this method when all the headers have been submitted.

sign() - generates a signature using a private key

$base64 = $algorithm->sign($private_key);

verify() - verifies a signature using the public key

$result = $algorithm->verify($base64, $public_key);

The result is a true/false value: true indicates the signature data ($base64) is valid, false indicates it is invalid.