man > Crypt::Digest::Whirlpool

man perldoc info pydoc3 ri search

📛 NAME

Crypt::Digest::Whirlpool - Hash function Whirlpool [size: 512 bits]

🚀 Quick Reference

Use Case	Command	Description
🔢 Raw binary digest from string	whirlpool('data')	512-bit binary string
🔢 Hexadecimal digest from string	whirlpool_hex('data')	Hexadecimal string
🔢 Base64 digest from string	whirlpool_b64('data')	Base64 with padding
🔢 Base64 URL-safe digest from string	whirlpool_b64u('data')	Base64 URL-safe (RFC 4648)
📁 Digest from file	whirlpool_file('file.dat')	Reads file, returns binary digest
📁 Digest from filehandle	whirlpool_file(*FH)	Reads open filehandle (binary mode)
🛠️ OO instantiation	$d = Crypt::Digest::Whirlpool->new();	Creates new digest object
🛠️ OO add data	$d->add('data');	Incrementally feed data
🛠️ OO get hex digest	$d->hexdigest();	Returns hex string

📖 SYNOPSIS

🔹 Functional Interface

use Crypt::Digest::Whirlpool qw( whirlpool whirlpool_hex whirlpool_b64 whirlpool_b64u
                                 whirlpool_file whirlpool_file_hex whirlpool_file_b64 whirlpool_file_b64u );

# calculate digest from string/buffer
$whirlpool_raw  = whirlpool('data string');
$whirlpool_hex  = whirlpool_hex('data string');
$whirlpool_b64  = whirlpool_b64('data string');
$whirlpool_b64u = whirlpool_b64u('data string');
# calculate digest from file
$whirlpool_raw  = whirlpool_file('filename.dat');
$whirlpool_hex  = whirlpool_file_hex('filename.dat');
$whirlpool_b64  = whirlpool_file_b64('filename.dat');
$whirlpool_b64u = whirlpool_file_b64u('filename.dat');
# calculate digest from filehandle
$whirlpool_raw  = whirlpool_file(*FILEHANDLE);
$whirlpool_hex  = whirlpool_file_hex(*FILEHANDLE);
$whirlpool_b64  = whirlpool_file_b64(*FILEHANDLE);
$whirlpool_b64u = whirlpool_file_b64u(*FILEHANDLE);

🔹 OO Interface

use Crypt::Digest::Whirlpool;

$d = Crypt::Digest::Whirlpool->new;
$d->add('any data');
$d->addfile('filename.dat');
$d->addfile(*FILEHANDLE);
$result_raw  = $d->digest;     # raw bytes
$result_hex  = $d->hexdigest;  # hexadecimal form
$result_b64  = $d->b64digest;  # Base64 form
$result_b64u = $d->b64udigest; # Base64 URL Safe form

📝 DESCRIPTION

Provides an interface to the Whirlpool digest algorithm.

📤 EXPORT

Nothing is exported by default.

You can export selected functions:

use Crypt::Digest::Whirlpool qw(whirlpool whirlpool_hex whirlpool_b64 whirlpool_b64u
                                 whirlpool_file whirlpool_file_hex whirlpool_file_b64 whirlpool_file_b64u);

Or all of them at once:

use Crypt::Digest::Whirlpool ':all';

🔧 FUNCTIONS

🔹 whirlpool

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

$whirlpool_raw = whirlpool('data string');
#or
$whirlpool_raw = whirlpool('any data', 'more data', 'even more data');

🔹 whirlpool_hex

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

$whirlpool_hex = whirlpool_hex('data string');
#or
$whirlpool_hex = whirlpool_hex('any data', 'more data', 'even more data');

🔹 whirlpool_b64

Logically joins all arguments into a single string, and returns its Whirlpool digest encoded as a Base64 string, with trailing '=' padding.

$whirlpool_b64 = whirlpool_b64('data string');
#or
$whirlpool_b64 = whirlpool_b64('any data', 'more data', 'even more data');

🔹 whirlpool_b64u

Logically joins all arguments into a single string, and returns its Whirlpool digest encoded as a Base64 URL Safe string (see RFC 4648 section 5).

$whirlpool_b64url = whirlpool_b64u('data string');
#or
$whirlpool_b64url = whirlpool_b64u('any data', 'more data', 'even more data');

🔹 whirlpool_file

Reads file (defined by filename or filehandle) content, and returns its Whirlpool digest encoded as a binary string.

$whirlpool_raw = whirlpool_file('filename.dat');
#or
$whirlpool_raw = whirlpool_file(*FILEHANDLE);

🔹 whirlpool_file_hex

Reads file (defined by filename or filehandle) content, and returns its Whirlpool digest encoded as a hexadecimal string.

$whirlpool_hex = whirlpool_file_hex('filename.dat');
#or
$whirlpool_hex = whirlpool_file_hex(*FILEHANDLE);

⚠️ BEWARE: You have to make sure that the filehandle is in binary mode before you pass it as argument to the addfile() method.

🔹 whirlpool_file_b64

Reads file (defined by filename or filehandle) content, and returns its Whirlpool digest encoded as a Base64 string, with trailing '=' padding.

$whirlpool_b64 = whirlpool_file_b64('filename.dat');
#or
$whirlpool_b64 = whirlpool_file_b64(*FILEHANDLE);

🔹 whirlpool_file_b64u

Reads file (defined by filename or filehandle) content, and returns its Whirlpool digest encoded as a Base64 URL Safe string (see RFC 4648 section 5).

$whirlpool_b64url = whirlpool_file_b64u('filename.dat');
#or
$whirlpool_b64url = whirlpool_file_b64u(*FILEHANDLE);

🛠️ METHODS

The OO interface provides the same set of functions as Crypt::Digest.

🔹 new

$d = Crypt::Digest::Whirlpool->new();

🔹 clone

$d->clone();

🔹 reset

$d->reset();

🔹 add

$d->add('any data');
#or
$d->add('any data', 'more data', 'even more data');

🔹 addfile

$d->addfile('filename.dat');
#or
$d->addfile(*FILEHANDLE);

🔹 add_bits

$d->add_bits($bit_string);   # e.g. $d->add_bits("111100001010");
#or
$d->add_bits($data, $nbits); # e.g. $d->add_bits("\xF0\xA0", 16);

🔹 hashsize

$d->hashsize;
#or
Crypt::Digest::Whirlpool->hashsize();
#or
Crypt::Digest::Whirlpool::hashsize();

🔹 digest

$result_raw = $d->digest();

🔹 hexdigest

$result_hex = $d->hexdigest();

🔹 b64digest

$result_b64 = $d->b64digest();

🔹 b64udigest

$result_b64url = $d->b64udigest();

📚 SEE ALSO

• 🔗 Crypt::Digest (from CryptX)
• 🌐 Whirlpool (cryptography) on Wikipedia

📛 NAME 🚀 Quick Reference 📖 SYNOPSIS 📝 DESCRIPTION 📤 EXPORT 🔧 FUNCTIONS 🛠️ METHODS 📚 SEE ALSO