Crypt::...::SHA256(3)

๐Ÿ’– NAME ๐Ÿ’–

okay so this is the User Contributed Perl Documentation page for Crypt::Digest::SHA256 โ€” you might spot the title as Crypt::...::SHA256(3) โ€” and it's literally the Hash function SHA-256 [size: 256 bits]. bestie, it's giving 256-bit hash realness โœจ


๐Ÿฆ‹ SYNOPSIS ๐Ÿฆ‹

two ways to vibe here, bestie: the functional interface and the OO interface. here's the code, exact, no cap:

          ### Functional interface:
          use Crypt::Digest::SHA256 qw( sha256 sha256_hex sha256_b64 sha256_b64u
                                       sha256_file sha256_file_hex sha256_file_b64 sha256_file_b64u );

          # calculate digest from string/buffer
          my $data = 'data string';
          my $sha256_raw  = sha256($data);
          my $sha256_hex  = sha256_hex($data);
          my $sha256_b64  = sha256_b64($data);
          my $sha256_b64u = sha256_b64u($data);
          # or from file
          my $sha256_file_raw  = sha256_file('filename.dat');
          my $sha256_file_hex  = sha256_file_hex('filename.dat');
          my $sha256_file_b64  = sha256_file_b64('filename.dat');
          my $sha256_file_b64u = sha256_file_b64u('filename.dat');
          # or from filehandle
          my $filehandle = ...; # existing binary-mode filehandle
          my $sha256_fh_raw  = sha256_file($filehandle);
          my $sha256_fh_hex  = sha256_file_hex($filehandle);
          my $sha256_fh_b64  = sha256_file_b64($filehandle);
          my $sha256_fh_b64u = sha256_file_b64u($filehandle);

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

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

๐ŸŒธ DESCRIPTION ๐ŸŒธ

It provides an interface to the SHA256 digest algorithm. that's the whole vibe check, bestie ๐Ÿ’…


๐ŸŽ€ EXPORT ๐ŸŽ€

Nothing is exported by default. okay so you gotta ask for what you want โ€” main character energy only.

You can export selected functions:

         use Crypt::Digest::SHA256 qw(sha256 sha256_hex sha256_b64 sha256_b64u
                                             sha256_file sha256_file_hex sha256_file_b64 sha256_file_b64u);

Or all of them at once:

         use Crypt::Digest::SHA256 ':all';

โœจ FUNCTIONS โœจ

๐ŸŒŸ sha256

Joins all arguments into a single string and returns its SHA256 digest encoded as a binary string. literally smashing your args together first, then hashing the whole thing ๐Ÿ’–

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 sha256_hex, sha256_b64, and sha256_b64u.

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

โญ sha256_hex

Joins all arguments into a single string and returns its SHA256 digest encoded as a hexadecimal string. hex girlie representation, slay ๐ŸŽ€

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

๐Ÿฆ‹ sha256_b64

Joins all arguments into a single string and returns its SHA256 digest encoded as a Base64 string, with trailing '=' padding. padding included, bestie, no notes ๐Ÿ’…

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

๐ŸŒˆ sha256_b64u

Joins all arguments into a single string and returns its SHA256 digest encoded as a Base64 URL-safe string (see RFC 4648 section 5). URL-safe and iconic โœจ

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

๐Ÿ“ sha256_file

Reads a file given by a filename or filehandle and returns its SHA256 digest encoded as a binary string. file goblin mode activated ๐Ÿ“

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

๐Ÿงš sha256_file_hex

Reads a file given by a filename or filehandle and returns its SHA256 digest encoded as a hexadecimal string. hex from a whole file? obsessed ๐Ÿ’œ

        my $sha256_hex = sha256_file_hex('filename.dat');
        #or
        my $filehandle = ...; # existing binary-mode filehandle
        my $sha256_hex = sha256_file_hex($filehandle);
๐Ÿšจ Note: The filehandle must be in binary mode before you pass it to addfile().

๐ŸŽ€ sha256_file_b64

Reads a file given by a filename or filehandle and returns its SHA256 digest encoded as a Base64 string, with trailing '=' padding. file-to-Base64 pipeline, cute and factual ๐Ÿซถ

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

๐ŸŒธ sha256_file_b64u

Reads a file given by a filename or filehandle and returns its SHA256 digest encoded as a Base64 URL-safe string (see RFC 4648 section 5). URL-safe file hash realness ๐ŸŒˆ

        my $sha256_b64url = sha256_file_b64u('filename.dat');
        #or
        my $filehandle = ...; # existing binary-mode filehandle
        my $sha256_b64url = sha256_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::SHA256->new();

๐Ÿ’ซ new

fresh digest object, brand new, no notes:

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

๐Ÿงธ clone

duplicate that digest object energy:

        $d->clone();

๐Ÿช„ reset

the reset button, bestie:

        $d->reset();

๐Ÿ’– add

Appends data to the message. Returns the object itself (for chaining). chainable, obsessed.

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 data goes in, chaining goes out โœจ

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

๐Ÿงฎ hashsize

ask the digest how big its hash is, iykyk:

        $d->hashsize;
        #or
        Crypt::Digest::SHA256->hashsize();
        #or
        Crypt::Digest::SHA256::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 like, don't come back for more without resetting, bestie ๐Ÿ˜ญ

        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 ๐ŸŒˆ


okay that's the whole page, bestie ๐Ÿซถ this cutie came from perl v5.42.0, dated 2026-05-11, and its footer label is Crypt::...::SHA256(3). slay ๐Ÿ’…โœจ

๐Ÿ“ฆ where this page comes from