Crypt::...SHA3_256(3)

💖 NAME 💖

okay so bestie, welcome to the User Contributed Perl Documentation page for Crypt::...SHA3_256(3) — the manual for Crypt::Digest::SHA3_256, aka the hash function SHA3-256 [size: 256 bits]. that's the name, that's the vibe, periodt. ✨

---

🦋 SYNOPSIS 🦋

here's the whole group-chat screenshot of how you call it, functional interface first and then the OO era. 💅

### Functional interface:
use Crypt::Digest::SHA3_256 qw( sha3_256 sha3_256_hex sha3_256_b64 sha3_256_b64u
                             sha3_256_file sha3_256_file_hex sha3_256_file_b64 sha3_256_file_b64u );

# calculate digest from string/buffer
my $data = 'data string';
my $sha3_256_raw  = sha3_256($data);
my $sha3_256_hex  = sha3_256_hex($data);
my $sha3_256_b64  = sha3_256_b64($data);
my $sha3_256_b64u = sha3_256_b64u($data);
# or from file
my $sha3_256_file_raw  = sha3_256_file('filename.dat');
my $sha3_256_file_hex  = sha3_256_file_hex('filename.dat');
my $sha3_256_file_b64  = sha3_256_file_b64('filename.dat');
my $sha3_256_file_b64u = sha3_256_file_b64u('filename.dat');
# or from filehandle
my $filehandle = ...; # existing binary-mode filehandle
my $sha3_256_fh_raw  = sha3_256_file($filehandle);
my $sha3_256_fh_hex  = sha3_256_file_hex($filehandle);
my $sha3_256_fh_b64  = sha3_256_file_b64($filehandle);
my $sha3_256_fh_b64u = sha3_256_file_b64u($filehandle);

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

my $d = Crypt::Digest::SHA3_256->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_256->new->addfile('filename.dat')->digest;

---

🌸 DESCRIPTION 🌸

Provides an interface to the SHA3_256 digest algorithm. literally that's the main-character job: you get a clean way to talk to SHA3_256 and get your digest back. 🔥

---

🎀 EXPORT 🎀

Nothing is exported by default. no surprise pop-ins. 🙈

You can export selected functions:

use Crypt::Digest::SHA3_256 qw(sha3_256 sha3_256_hex sha3_256_b64 sha3_256_b64u
                                    sha3_256_file sha3_256_file_hex sha3_256_file_b64 sha3_256_file_b64u);

Or all of them at once:

use Crypt::Digest::SHA3_256 ':all';

---

✨ FUNCTIONS ✨

💜 sha3_256

Joins all arguments into a single string and returns its SHA3_256 digest encoded as a binary string. raw bytes, no extra garnish. 🫶

Data arguments for the functional helpers are converted to byte strings using Perl's usual scalar stringification. Defined scalars, including numbers and string-overloaded objects, are accepted. "undef" is treated as an empty string and may emit Perl's usual "uninitialized value" warning. The same rules apply to sha3_256_hex, sha3_256_b64, and sha3_256_b64u.

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

🌈 sha3_256_hex

Joins all arguments into a single string and returns its SHA3_256 digest encoded as a hexadecimal string. hex girl summer. 💅

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

🍓 sha3_256_b64

Joins all arguments into a single string and returns its SHA3_256 digest encoded as a Base64 string, with trailing '=' padding. cute little padding behavior, no cap. 🎀

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

🧚 sha3_256_b64u

Joins all arguments into a single string and returns its SHA3_256 digest encoded as a Base64 URL-safe string (see RFC 4648 section 5). URL-safe edition, very demure. ✨

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

🔥 sha3_256_file

Reads a file given by a filename or filehandle and returns its SHA3_256 digest encoded as a binary string. file mode activated, bestie. 🦋

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

⭐ sha3_256_file_hex

Reads a file given by a filename or filehandle and returns its SHA3_256 digest encoded as a hexadecimal string. hex from a whole file? iconic. 👑

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

Note: The filehandle must be in binary mode before you pass it to addfile(). 🚨

🎀 sha3_256_file_b64

Reads a file given by a filename or filehandle and returns its SHA3_256 digest encoded as a Base64 string, with trailing '=' padding. file-to-Base64 pipeline, slay. 💖

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

🦋 sha3_256_file_b64u

Reads a file given by a filename or filehandle and returns its SHA3_256 digest encoded as a Base64 URL-safe string (see RFC 4648 section 5). URL-safe and file-friendly, we love to see it. 🌈

my $sha3_256_b64url = sha3_256_file_b64u('filename.dat');
#or
my $filehandle = ...; # existing binary-mode filehandle
my $sha3_256_b64url = sha3_256_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_256->new();

🌱 new

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

🧚 clone

$d->clone();

🎀 reset

$d->reset();

💜 add

Appends data to the message. Returns the object itself (for chaining). chain them calls, bestie. 🔗

Each argument is converted to bytes using Perl's usual scalar stringification. Defined scalars, including numbers and string-overloaded objects, are accepted. "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). file content? straight into the message. periodt. 🫶

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

⭐ hashsize

$d->hashsize;
#or
Crypt::Digest::SHA3_256->hashsize();
#or
Crypt::Digest::SHA3_256::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(). so don't try to keep the party going after finalization, okay? 😭

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

🍓 hexdigest

Returns the digest encoded as a lowercase hexadecimal string. Like digest(), the first call finalizes the digest object. lowercase hex, very neat, very cutesy. 💖

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. padding included, no notes. 🎀

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. URL-safe and padding-free, she's lowkey perfect. ✨

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

---

👑 SEE ALSO 👑

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

---

mwah 💋 this page is brought to you by perl v5.42.0, dated 2026-05-11. go hash something and slay, bestie. 🫶