Crypt::...SHA3_512(3)

okay so this is the Crypt::...SHA3_512(3) page from the User Contributed Perl Documentation, and the main character is Crypt::Digest::SHA3_512 💖

💖 NAME 💖

Crypt::Digest::SHA3_512 — hash function SHA3-512 [size: 512 bits]. that's the whole vibe, bestie: SHA3-512, 512 bits, slay ✨

✨ SYNOPSIS ✨

here's the group-chat version of how you call it — functional interface first, then OO 💅

### Functional interface:
use Crypt::Digest::SHA3_512 qw( sha3_512 sha3_512_hex sha3_512_b64 sha3_512_b64u
                             sha3_512_file sha3_512_file_hex sha3_512_file_b64 sha3_512_file_b64u );

# calculate digest from string/buffer
my $data = 'data string';
my $sha3_512_raw  = sha3_512($data);
my $sha3_512_hex  = sha3_512_hex($data);
my $sha3_512_b64  = sha3_512_b64($data);
my $sha3_512_b64u = sha3_512_b64u($data);
# or from file
my $sha3_512_file_raw  = sha3_512_file('filename.dat');
my $sha3_512_file_hex  = sha3_512_file_hex('filename.dat');
my $sha3_512_file_b64  = sha3_512_file_b64('filename.dat');
my $sha3_512_file_b64u = sha3_512_file_b64u('filename.dat');
# or from filehandle
my $filehandle = ...; # existing binary-mode filehandle
my $sha3_512_fh_raw  = sha3_512_file($filehandle);
my $sha3_512_fh_hex  = sha3_512_file_hex($filehandle);
my $sha3_512_fh_b64  = sha3_512_file_b64($filehandle);
my $sha3_512_fh_b64u = sha3_512_file_b64u($filehandle);

### OO interface:
use Crypt::Digest::SHA3_512;

my $d = Crypt::Digest::SHA3_512->new;
$d->add('any data');
my $result_raw  = $d->digest;     # raw bytes
my $result_hex  = $d->hexdigest;  # hexadecimal form
my $result_b64  = $d->b64digest;  # Base64 form
my $result_b64u = $d->b64udigest; # Base64 URL-safe form

# or hash a file instead
my $file_result_raw = Crypt::Digest::SHA3_512->new->addfile('filename.dat')->digest;

🦋 DESCRIPTION 🦋

it gives you a Perl interface to the SHA3_512 digest algorithm. iconic, honestly 🦋

🎀 EXPORT 🎀

default export? literally nothing. you get zero functions unless you ask, and that's the vibe 🎀

you can pick your faves:

use Crypt::Digest::SHA3_512 qw(sha3_512 sha3_512_hex sha3_512_b64 sha3_512_b64u
                                    sha3_512_file sha3_512_file_hex sha3_512_file_b64 sha3_512_file_b64u);

or grab the whole set at once:

use Crypt::Digest::SHA3_512 ':all';

🔥 FUNCTIONS 🔥

these are the functional helpers — they join all their arguments into one string and hash that. keep an eye on the stringification rules below 👀

sha3_512

joins all the arguments into a single string and gives you back its SHA3_512 digest encoded as a binary string 🔥

data arguments for the functional helpers get converted to byte strings using Perl's usual scalar stringification. defined scalars are accepted — yes, including numbers and string-overloaded objects. undef is treated as an empty string and may emit Perl's usual "uninitialized value" warning. the same rules apply to sha3_512_hex, sha3_512_b64, and sha3_512_b64u 🫶

my $sha3_512_raw = sha3_512('data string');
#or
my $sha3_512_raw = sha3_512('any data', 'more data', 'even more data');

sha3_512_hex

joins all the arguments into a single string and returns its SHA3_512 digest encoded as a hexadecimal string ✨

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

sha3_512_b64

joins all the arguments into a single string and returns its SHA3_512 digest encoded as a Base64 string, with trailing '=' padding 🎀

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

sha3_512_b64u

joins all the arguments into a single string and returns its SHA3_512 digest encoded as a Base64 URL-safe string (see RFC 4648 section 5) 🌈

my $sha3_512_b64url = sha3_512_b64u('data string');
#or
my $sha3_512_b64url = sha3_512_b64u('any data', 'more data', 'even more data');

sha3_512_file

reads a file given by a filename or filehandle and returns its SHA3_512 digest encoded as a binary string 🦋

my $sha3_512_raw = sha3_512_file('filename.dat');
#or
my $filehandle = ...; # existing binary-mode filehandle
my $sha3_512_raw = sha3_512_file($filehandle);

sha3_512_file_hex

reads a file given by a filename or filehandle and returns its SHA3_512 digest encoded as a hexadecimal string 💜

my $sha3_512_hex = sha3_512_file_hex('filename.dat');
#or
my $filehandle = ...; # existing binary-mode filehandle
my $sha3_512_hex = sha3_512_file_hex($filehandle);

note, bestie: the filehandle must be in binary mode before you pass it to addfile(). don't skip that 💀

sha3_512_file_b64

reads a file given by a filename or filehandle and returns its SHA3_512 digest encoded as a Base64 string, with trailing '=' padding 🌸

my $sha3_512_b64 = sha3_512_file_b64('filename.dat');
#or
my $filehandle = ...; # existing binary-mode filehandle
my $sha3_512_b64 = sha3_512_file_b64($filehandle);

sha3_512_file_b64u

reads a file given by a filename or filehandle and returns its SHA3_512 digest encoded as a Base64 URL-safe string (see RFC 4648 section 5) ⭐

my $sha3_512_b64url = sha3_512_file_b64u('filename.dat');
#or
my $filehandle = ...; # existing binary-mode filehandle
my $sha3_512_b64url = sha3_512_file_b64u($filehandle);

💅 METHODS 💅

the OO interface provides the same set of functions as Crypt::Digest. unless noted otherwise, assume $d is an existing digest object created via new, for example:

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

new

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

clone

$d->clone();

reset

$d->reset();

add

appends data to the message. returns the object itself (for chaining) 🔗

each argument is converted to bytes using Perl's usual scalar stringification. defined scalars are accepted, including numbers and string-overloaded objects. undef is treated as an empty string and may emit Perl's usual "uninitialized value" warning.

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

addfile

reads the file content and appends it to the message. returns the object itself (for chaining) 🫶

$d->addfile('filename.dat');
#or
my $filehandle = ...; # existing binary-mode filehandle
$d->addfile($filehandle);

hashsize

three ways to ask for the hash size, slay 👑

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

digest

returns the binary digest (raw bytes). the first call finalizes the digest object. any later add(), addfile(), digest(), hexdigest(), b64digest(), or b64udigest() call will fail until you call reset() 😭

my $result_raw = $d->digest();

hexdigest

returns the digest encoded as a lowercase hexadecimal string. like digest(), the first call finalizes the digest object ✨

my $result_hex = $d->hexdigest();

b64digest

returns the digest encoded as a Base64 string with trailing "=" padding. like digest(), the first call finalizes the digest object 🎀

my $result_b64 = $d->b64digest();

b64udigest

returns the digest encoded as a Base64 URL-safe string (no trailing "="). like digest(), the first call finalizes the digest object 🌈

my $result_b64url = $d->b64udigest();

🌈 SEE ALSO 🌈

also peep these 👀

• CryptX, Crypt::Digest
• <https://en.wikipedia.org/wiki/SHA-3>

and that's the page, bestie 🫶 — source/version energy: perl v5.42.0, dated 2026-05-11, filed under Crypt::...SHA3_512(3). periodt 💅