Crypt::...::SHA384(3)

📦
version 0.89.0 · 16 versions
, in opensuse-leap 16.0

💅 NAME 💅

okay bestie, welcome to the Crypt::...::SHA384(3) page — yes, it's part of User Contributed Perl Documentation — and the actual module is Crypt::Digest::SHA384: hash function SHA-384 [size: 384 bits]. iconic. 💖

✨ SYNOPSIS ✨

okay so you can go functional or OO, and both are valid. here's the whole synopsis, exactly as it should be — no details dropped, periodt:

          ### Functional interface:
          use Crypt::Digest::SHA384 qw( sha384 sha384_hex sha384_b64 sha384_b64u
                                       sha384_file sha384_file_hex sha384_file_b64 sha384_file_b64u );

          # calculate digest from string/buffer
          my $data = 'data string';
          my $sha384_raw  = sha384($data);
          my $sha384_hex  = sha384_hex($data);
          my $sha384_b64  = sha384_b64($data);
          my $sha384_b64u = sha384_b64u($data);
          # or from file
          my $sha384_file_raw  = sha384_file('filename.dat');
          my $sha384_file_hex  = sha384_file_hex('filename.dat');
          my $sha384_file_b64  = sha384_file_b64('filename.dat');
          my $sha384_file_b64u = sha384_file_b64u('filename.dat');
          # or from filehandle
          my $filehandle = ...; # existing binary-mode filehandle
          my $sha384_fh_raw  = sha384_file($filehandle);
          my $sha384_fh_hex  = sha384_file_hex($filehandle);
          my $sha384_fh_b64  = sha384_file_b64($filehandle);
          my $sha384_fh_b64u = sha384_file_b64u($filehandle);

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

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

🌸 DESCRIPTION 🌸

This module gives you an interface to the SHA384 digest algorithm. that's the whole description — short, sweet, and to the point. 💅

🎀 EXPORT 🎀

Nothing is exported by default. like, zero, nada, unless you ask.

If you want just selected functions, do this:

         use Crypt::Digest::SHA384 qw(sha384 sha384_hex sha384_b64 sha384_b64u
                                             sha384_file sha384_file_hex sha384_file_b64 sha384_file_b64u);

Or grab all of them at once:

         use Crypt::Digest::SHA384 ':all';

🦋 FUNCTIONS 🦋

Functional helper time, bestie. the join-then-digest girlies are all here. ✨

💜 sha384 💜

Joins all arguments into a single string and returns its SHA384 digest encoded as a binary string. raw bytes energy. 💖

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 sha384_hex, sha384_b64, and sha384_b64u.

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

💜 sha384_hex 💜

Joins all arguments into a single string and returns its SHA384 digest encoded as a hexadecimal string. hex girlie representation. 🎀

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

💜 sha384_b64 💜

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

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

💜 sha384_b64u 💜

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

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

💜 sha384_file 💜

Reads a file given by a filename or filehandle and returns its SHA384 digest encoded as a binary string. file-based hashing, slay. 🦋

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

💜 sha384_file_hex 💜

Reads a file given by a filename or filehandle and returns its SHA384 digest encoded as a hexadecimal string.

        my $sha384_hex = sha384_file_hex('filename.dat');
        #or
        my $filehandle = ...; # existing binary-mode filehandle
        my $sha384_hex = sha384_file_hex($filehandle);
⚠️ Note: The filehandle must be in binary mode before you pass it to addfile().

💜 sha384_file_b64 💜

Reads a file given by a filename or filehandle and returns its SHA384 digest encoded as a Base64 string, with trailing '=' padding.

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

💜 sha384_file_b64u 💜

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

        my $sha384_b64url = sha384_file_b64u('filename.dat');
        #or
        my $filehandle = ...; # existing binary-mode filehandle
        my $sha384_b64url = sha384_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::SHA384->new();

💜 new 💜

fresh digest object, no cap:

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

💜 clone 💜

copy era:

        $d->clone();

💜 reset 💜

the reset button, literally:

        $d->reset();

💜 add 💜

Appends data to the message. Returns the object itself (for chaining). bestie, it hands the object right back so you can keep the chain going. 🔥

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).

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

💜 hashsize 💜

asks for the hash size, iykyk:

        $d->hashsize;
        #or
        Crypt::Digest::SHA384->hashsize();
        #or
        Crypt::Digest::SHA384::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(). that's not a vibe, that's the rule. 💀
        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 🌈

mwah 💋 — source/version perl v5.42.0, date 2026-05-11, manual Crypt::...::SHA384(3). byeee bestie 🫶✨

📦 where this page comes from