Crypt::...E2b_160(3)

📦

version 0.89.0 · 16 versions

0.89.0 · opensuse-leap 16.0 (latest)
0.089 · epel 9
0.089 · epel 10
0.088 · alpine 3.22
0.088 · alpine 3.23
0.089 · alpine 3.24
0.091 · arch rolling
0.090 · ubuntu stonking
0.087 · fedora 43
0.076 · ubuntu jammy
0.089 · fedora 43, fedora 44
0.087 · fedora 44
0.080 · ubuntu noble
0.077 · debian bookworm
0.087 · ubuntu resolute
0.085 · debian trixie

NAME 💖

okay bestie, this is the User Contributed Perl Documentation page for Crypt::Digest::BLAKE2b_160 — Hash function BLAKE2b [size: 160 bits]. She's the BLAKE2b_160 digest girlie, and this is literally her whole manual-page vibe check. 💅

SYNOPSIS 🎀

here's the full functional + OO situation, no cap. Copy these exact lines:

          ### Functional interface:
          use Crypt::Digest::BLAKE2b_160 qw( blake2b_160 blake2b_160_hex blake2b_160_b64 blake2b_160_b64u
                                       blake2b_160_file blake2b_160_file_hex blake2b_160_file_b64 blake2b_160_file_b64u );

          # calculate digest from string/buffer
          my $data = 'data string';
          my $blake2b_160_raw  = blake2b_160($data);
          my $blake2b_160_hex  = blake2b_160_hex($data);
          my $blake2b_160_b64  = blake2b_160_b64($data);
          my $blake2b_160_b64u = blake2b_160_b64u($data);
          # or from file
          my $blake2b_160_file_raw  = blake2b_160_file('filename.dat');
          my $blake2b_160_file_hex  = blake2b_160_file_hex('filename.dat');
          my $blake2b_160_file_b64  = blake2b_160_file_b64('filename.dat');
          my $blake2b_160_file_b64u = blake2b_160_file_b64u('filename.dat');
          # or from filehandle
          my $filehandle = ...; # existing binary-mode filehandle
          my $blake2b_160_fh_raw  = blake2b_160_file($filehandle);
          my $blake2b_160_fh_hex  = blake2b_160_file_hex($filehandle);
          my $blake2b_160_fh_b64  = blake2b_160_file_b64($filehandle);
          my $blake2b_160_fh_b64u = blake2b_160_file_b64u($filehandle);

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

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

DESCRIPTION ✨

Provides an interface to the BLAKE2b_160 digest algorithm. That's it, that's the description, and honestly? iconic. 🦋

EXPORT 🌸

Nothing is exported by default. shy module behavior, we love to see it.

You can export selected functions:

         use Crypt::Digest::BLAKE2b_160 qw(blake2b_160 blake2b_160_hex blake2b_160_b64 blake2b_160_b64u
                                             blake2b_160_file blake2b_160_file_hex blake2b_160_file_b64 blake2b_160_file_b64u);

Or all of them at once:

         use Crypt::Digest::BLAKE2b_160 ':all';

FUNCTIONS 💅

Functional interface time, bestie. These helpers join their arguments and hash the result, with the exact deets below.

blake2b_160 ✨

Joins all arguments into a single string and returns its BLAKE2b_160 digest encoded as a binary string.

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 blake2b_160_hex, blake2b_160_b64, and blake2b_160_b64u.

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

blake2b_160_hex ✨

Joins all arguments into a single string and returns its BLAKE2b_160 digest encoded as a hexadecimal string.

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

blake2b_160_b64 ✨

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

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

blake2b_160_b64u ✨

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

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

blake2b_160_file ✨

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

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

blake2b_160_file_hex ✨

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

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

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

blake2b_160_file_b64 ✨

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

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

blake2b_160_file_b64u ✨

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

        my $blake2b_160_b64url = blake2b_160_file_b64u('filename.dat');
        #or
        my $filehandle = ...; # existing binary-mode filehandle
        my $blake2b_160_b64url = blake2b_160_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::BLAKE2b_160->new();

new 🎀

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

clone 🎀

        $d->clone();

reset 🎀

        $d->reset();

add 🎀

Appends data to the message. Returns the object itself (for chaining). chainable icon behavior.

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 🎀

        $d->hashsize;
        #or
        Crypt::Digest::BLAKE2b_160->hashsize();
        #or
        Crypt::Digest::BLAKE2b_160::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().

🚨 fr fr, this is the finalize-and-lock situation. After the first digest call, no more adds until 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();