Crypt::Digest::MD5(3)

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

💖 NAME 💖

Crypt::Digest::MD5 - Hash function MD5 [size: 128 bits] ✨

okay bestie, welcome to the User Contributed Perl Documentation page for Crypt::Digest::MD5 — it's literally the interface to the MD5 digest algorithm, and it's giving 128-bit main character energy 💅

🦋 SYNOPSIS 🦋

so here's the whole vibe: you can use the functional helpers, or you can go full OO bestie. both ate, no cap 💖

          ### Functional interface:
          use Crypt::Digest::MD5 qw( md5 md5_hex md5_b64 md5_b64u
                                       md5_file md5_file_hex md5_file_b64 md5_file_b64u );

          # calculate digest from string/buffer
          my $data = 'data string';
          my $md5_raw  = md5($data);
          my $md5_hex  = md5_hex($data);
          my $md5_b64  = md5_b64($data);
          my $md5_b64u = md5_b64u($data);
          # or from file
          my $md5_file_raw  = md5_file('filename.dat');
          my $md5_file_hex  = md5_file_hex('filename.dat');
          my $md5_file_b64  = md5_file_b64('filename.dat');
          my $md5_file_b64u = md5_file_b64u('filename.dat');
          # or from filehandle
          my $filehandle = ...; # existing binary-mode filehandle
          my $md5_fh_raw  = md5_file($filehandle);
          my $md5_fh_hex  = md5_file_hex($filehandle);
          my $md5_fh_b64  = md5_file_b64($filehandle);
          my $md5_fh_b64u = md5_file_b64u($filehandle);

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

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

🌸 DESCRIPTION 🌸

Provides an interface to the MD5 digest algorithm. that's the whole description, bestie — short, sweet, iconic 🫶

🎀 EXPORT 🎀

Nothing is exported by default. ✨

You can export selected functions:

         use Crypt::Digest::MD5 qw(md5 md5_hex md5_b64 md5_b64u
                                             md5_file md5_file_hex md5_file_b64 md5_file_b64u);

Or all of them at once, because why not:

         use Crypt::Digest::MD5 ':all';

🧚 FUNCTIONS 🧚

md5

Joins all arguments into a single string and returns its MD5 digest encoded as a binary string. raw bytes, iykyk 💅

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 md5_hex, md5_b64, and md5_b64u. 🫶

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

md5_hex

Joins all arguments into a single string and returns its MD5 digest encoded as a hexadecimal string. hex girl summer, fr fr ✨

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

md5_b64

Joins all arguments into a single string and returns its MD5 digest encoded as a Base64 string, with trailing '=' padding. the padding is literally part of the look 💅

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

md5_b64u

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

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

md5_file

Reads a file given by a filename or filehandle and returns its MD5 digest encoded as a binary string. file mode bestie, let's go 🎀

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

md5_file_hex

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

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

md5_file_b64

Reads a file given by a filename or filehandle and returns its MD5 digest encoded as a Base64 string, with trailing '=' padding. yes, the padding is still there 💖

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

md5_file_b64u

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

        my $md5_b64url = md5_file_b64u('filename.dat');
        #or
        my $filehandle = ...; # existing binary-mode filehandle
        my $md5_b64url = md5_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::MD5->new();

new

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

clone

        $d->clone();

reset

        $d->reset();

add

Appends data to the message. Returns the object itself (for chaining). chaining is so slay ✨

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). yup, still returning the object, periodt 🫶

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

hashsize

        $d->hashsize;
        #or
        Crypt::Digest::MD5->hashsize();
        #or
        Crypt::Digest::MD5::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 the rule, bestie — don't try it.

        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, iconic 💅

        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. no padding, just vibes 🦋

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

🌈 SEE ALSO 🌈

okay that's the whole page, bestie 💖 this Crypt::Digest::MD5(3) page comes from perl v5.42.0, dated 2026-05-11. mwah 🫶✨

📦 where this page comes from