Digest::Keccak - Perl interface to the Keccak digest algorithm

NAME

Digest::Keccak - Perl interface to the Keccak digest algorithm

SYNOPSIS

    # Functional interface
    use Digest::Keccak qw(keccak_256 keccak_256_hex keccak_256_base64);
    $digest = keccak_256($data);
    $digest = keccak_256_hex($data);
    $digest = keccak_256_base64($data);
    # Object-oriented interface
    use Digest::Keccak;
    $ctx = Digest::Keccak->new(256);
    $ctx->add($data);
    $ctx->addfile(*FILE);
    $digest = $ctx->digest;
    $digest = $ctx->hexdigest;
    $digest = $ctx->b64digest;

DESCRIPTION

The Digest::Keccak module provides an interface to the Keccak message digest algorithm. Keccak is a candidate in the NIST SHA-3 competition.

This interface follows the conventions set forth by the Digest module.

FUNCTIONS

The following functions are provided by the Digest::Keccak module. None of these functions are exported by default.

keccak_224($data, ...)

keccak_256($data, ...)

keccak_384($data, ...)

keccak_512($data, ...)

Logically joins the arguments into a single string, and returns its Keccak digest encoded as a binary string.

keccak_224_hex($data, ...)

keccak_256_hex($data, ...)

keccak_384_hex($data, ...)

keccak_512_hex($data, ...)

Logically joins the arguments into a single string, and returns its Keccak digest encoded as a hexadecimal string.

keccak_224_base64($data, ...)

keccak_256_base64($data, ...)

keccak_384_base64($data, ...)

keccak_512_base64($data, ...)

Logically joins the arguments into a single string, and returns its Keccak digest encoded as a Base64 string, without any trailing padding.

METHODS

The object-oriented interface to Digest::Keccak is identical to that described by Digest, except for the following:

new

    $keccak = Digest::Keccak->new(256)

The constructor requires the algorithm to be specified. It must be one of: 224, 256, 384, 512.

algorithm

hashsize

Returns the algorithm used by the object.

SEE ALSO

Digest

the Task::Digest manpage

http://keccak.noekeon.org/

http://en.wikipedia.org/wiki/NIST_hash_function_competition

http://www.saphir2.com/sphlib/

REQUESTS AND BUGS

Please report any bugs or feature requests to http://rt.cpan.org/Public/Bug/Report.html. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Digest::Keccak

You can also look for information at:

COPYRIGHT AND LICENSE

Copyright (C) 2010-2011 gray <gray at cpan.org>, all rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR

gray, <gray at cpan.org>

 Digest::Keccak - Perl interface to the Keccak digest algorithm