.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Whirlpool 3pm"
.TH Whirlpool 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Digest::Whirlpool \- A 512\-bit, collision\-resistant, one\-way hash function
.SH ABSTRACT
.IX Header "ABSTRACT"
WHIRLPOOL is a 512\-bit, collision-resistant, one-way hash function
developed by Paulo S. L. M. Barreto and Vincent Rijmen. It has been
recommended by the NESSIE project (along with SHA\-256/384/512) and
adopted as ISO/IEC 10118\-3.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
In programs:
.PP
.Vb 2
\&    # Using L<Digest> (recommended)
\&    use Digest;
\&
\&    my $whirlpool = Digest\->new( \*(AqWhirlpool\*(Aq );
\&
\&    # Get a hash and reset the object
\&    $whirlpool\->add( "hash this" );
\&    my $hexdigest = $whirlpool\->hexdigest;
\&
\&    # Populate the object again, and clone it before getting the
\&    # digest to avoid resetting
\&    $whirlpool\->add( "hash this" );
\&    my $b64digest = $whirlpool\->clone\->b64digest;
\&    $whirlpool\->add( "add this to the hash" );
\&
\&    # Using this module directly (same interface)
\&    use Digest::Whirlpool;
\&    my $whirlpool = Digest\->new( \*(AqWhirlpool\*(Aq );
\&    $whirlpool\->add( ... );
\&    ....
.Ve
.PP
From the command line:
.PP
.Vb 2
\&    whirlpoolsum files
\&    whirlpoolsum \-\-help
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Provides an interface to the WHIRLPOOL hash algorithm. This module
subclasses Digest::base and can be used either directly or through
the Digest meta-module. Using the latter is recommended.
.SH EXPORT
.IX Header "EXPORT"
None.
.SH METHODS
.IX Header "METHODS"
Since this module implements the standard Digest
interface and should be used through the
Digest module you should look at that documentation for the general
interface, below is a description of methods that differ.
.SS clone
.IX Subsection "clone"
Copy the internal state of the current object into a new object and
return it.
.SS reset
.IX Subsection "reset"
Resets the object to the same internal state it was in when it was
constructed.
.PP
This works exactly like "new" except it doesn't allocate new memory
for its internal state.
.SS base64digest
.IX Subsection "base64digest"
An legacy alias for the \fBb64digest\fR method which should be used
instead.
.SS hashsize
.IX Subsection "hashsize"
Returns the size (in bits) of a WHIRLPOOL hash, i.e. 512.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP \(bu 4
NESSIE consortium, \fIPortfolio of recommended cryptographic primitives\fR, February 27, 2003.
.IP \(bu 4
<http://paginas.terra.com.br/informatica/paulobarreto/WhirlpoolPage.html>
.SH "AUTHORS & HISTORY"
.IX Header "AUTHORS & HISTORY"
The original version of this package was written by Julius C. Duque in
2003. It was rewritten by Ævar Arnfjörð Bjarmason
<avar@cpan.org> in January 2007 who added compatability with the
Digest interface, improved documentation and a \fBwhirlpoolsum\fR\|(1)
command-line utility amongst other things.
.SH BUGS
.IX Header "BUGS"
Please report any bugs that aren't already listed at
<http://rt.cpan.org/Dist/Display.html?Queue=Digest\-Whirlpool> to
<http://rt.cpan.org/Public/Bug/Report.html?Queue=Digest\-Whirlpool>
.SH LICENSE
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.PP
Copyright 2003 Julius C. Duque and 2007 and 2009 Ævar Arnfjörð Bjarmason.