view release on metacpan or  search on metacpan

lib/Crypt/OpenPGP/Words.pm  view on Meta::CPAN

                penetrate      perceptive     performance    pharmacy
                phonetic       photograph     pioneer        pocketful
                politeness     positive       potato         processor
                provincial     proximate      puberty        publisher
                pyramid        quantity       racketeer      rebellion
                recipe         recover        repellent      replica
                reproduce      resistor       responsive     retraction
                retrieval      retrospect     revenue        revival
                revolver       sandalwood     sardonic       Saturday
                savagery       scavenger      sensation      sociable
                souvenir       specialist     speculate      stethoscope
                stupendous     supportive     surrender      suspicious
                sympathy       tambourine     telephone      therapist
                tobacco        tolerance      tomorrow       torpedo
                tradition      travesty       trombonist     truncated
                typewriter     ultimate       undaunted      underfoot
                unicorn        unify          universe       unravel
                upcoming       vacancy        vagabond       vertigo
                Virginia       visitor        vocalist       voyager
                warranty       Waterloo       whimsical      Wichita
                Wilmington     Wyoming        yesteryear     Yucatan
        ) ]

    );
}

1;
__END__

=head1 NAME

Crypt::OpenPGP::Words - Create English-word encodings

=head1 SYNOPSIS

    use Crypt::OpenPGP::Words;
    my $cert = Crypt::OpenPGP::Certificate->new;
    my @words = Crypt::OpenPGP::Words->encode( $cert->fingerprint );

=head1 DESCRIPTION

I<Crypt::OpenPGP::Words> provides routines to convert either octet or
hexadecimal strings into a list of English words, using the same
algorithm and biometric word lists as used in PGP (see
I<AUTHOR & COPYRIGHTS> for source of word lists).

In PGP this is often used for creating memorable fingerprints, the idea
being that it is easier to associate a list of words with one's key
than a string of hex digits. See the I<fingerprint_words> method in
I<Crypt::OpenPGP::Certificate> for an interface to word fingerprints.

=head1 USAGE

=head2 Crypt::OpenPGP::Words->encode( $octet_str )

Given an octet string I<$octet_str>, encodes that string into a list of
English words.

The encoding is performed by splitting the string into octets; the list
of octets is then iterated over. There are two lists of words, 256 words
each. Two-syllable words are used for encoding odd iterations through
the loop; three-syllable words for even iterations. The word list is
formed by treating each octet as an index into the appropriate word list
(two- or three-syllable), then adding the word at that index to the list.

Returns the list of words.

=head2 Crypt::OpenPGP::Words->encode_hex( $hex_str )

Performs the exact same encoding as I<encode>; I<$hex_str>, a string
of hexadecimal digits, is first transformed into a string of octets,
then passed to I<encode>.

Returns the list of words.

=head1 AUTHOR & COPYRIGHTS

Based on PGPWords.pm by Mike Dillon. Biometric word lists as defined in
manual for PGPFreeware for Windows 6.5.1, Appendix D

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

=cut