NAME

Digest::CubeHash::XS - Perl interface to the CubeHash digest algorithm

SYNOPSIS

    # Functional interface
    use Digest::CubeHash::XS qw(
        cubehash_256 cubehash_256_hex cubehash_256_base64
    );

    $digest = cubehash_256($data);
    $digest = cubehash_256_hex($data);
    $digest = cubehash_256_base64($data);

    # Object-oriented interface
    use Digest::CubeHash::XS;

    $ctx = Digest::CubeHash::XS->new(256);

    $ctx->add($data);
    $ctx->addfile(*FILE);

    $digest = $ctx->digest;
    $digest = $ctx->hexdigest;
    $digest = $ctx->b64digest;

DESCRIPTION

The Digest::CubeHash::XS module provides an interface to the CubeHash message digest algorithm. CubeHash was a candidate in the NIST SHA-3 competition but did progress beyond round 2.

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

FUNCTIONS

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

cubehash_224($data, ...)

cubehash_256($data, ...)

cubehash_384($data, ...)

cubehash_512($data, ...)

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

cubehash_224_hex($data, ...)

cubehash_256_hex($data, ...)

cubehash_384_hex($data, ...)

cubehash_512_hex($data, ...)

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

cubehash_224_base64($data, ...)

cubehash_256_base64($data, ...)

cubehash_384_base64($data, ...)

cubehash_512_base64($data, ...)

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

METHODS

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

new

    $cubehash = Digest::CubeHash::XS->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

Task::Digest

http://cubehash.cr.yp.to/

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

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?Digest-CubeHash-XS. 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::CubeHash::XS

You can also look for information at:

• GitHub Source Repository

  http://github.com/gray/digest-cubehash-xs

• AnnoCPAN: Annotated CPAN documentation

  http://annocpan.org/dist/Digest-CubeHash-XS

• CPAN Ratings

  http://cpanratings.perl.org/d/Digest-CubeHash-XS

• RT: CPAN's request tracker

  http://rt.cpan.org/Public/Dist/Display.html?Name=Digest-CubeHash-XS

• Search CPAN

  http://search.cpan.org/dist/Digest-CubeHash-XS/

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>

cpanm Digest::CubeHash::XS

perl -MCPAN -e shell
install Digest::CubeHash::XS