Crypt::Digest::MD5(3)

User Contributed Perl Documentation

Crypt::Digest::MD5(3)

NAME

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

SYNOPSIS

### 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
$md5_raw  = md5('data string');
$md5_hex  = md5_hex('data string');
$md5_b64  = md5_b64('data string');
$md5_b64u = md5_b64u('data string');
# calculate digest from file
$md5_raw  = md5_file('filename.dat');
$md5_hex  = md5_file_hex('filename.dat');
$md5_b64  = md5_file_b64('filename.dat');
$md5_b64u = md5_file_b64u('filename.dat');
# calculate digest from filehandle
$md5_raw  = md5_file(*FILEHANDLE);
$md5_hex  = md5_file_hex(*FILEHANDLE);
$md5_b64  = md5_file_b64(*FILEHANDLE);
$md5_b64u = md5_file_b64u(*FILEHANDLE);
### OO interface:
use Crypt::Digest::MD5;
$d = Crypt::Digest::MD5->new;
$d->add('any data');
$d->addfile('filename.dat');
$d->addfile(*FILEHANDLE);
$result_raw  = $d->digest;     # raw bytes
$result_hex  = $d->hexdigest;  # hexadecimal form
$result_b64  = $d->b64digest;  # Base64 form
$result_b64u = $d->b64udigest; # Base64 URL Safe form

DESCRIPTION

Provides an interface to the MD5 digest algorithm.

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:

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

FUNCTIONS

md5

Logically joins all arguments into a single string, and returns its MD5 digest encoded as a binary string.

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

md5_hex

Logically joins all arguments into a single string, and returns its MD5 digest encoded as a hexadecimal string.

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

md5_b64

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

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

md5_b64u

Logically joins all arguments into a single string, and returns its MD5 digest encoded as a Base64 URL Safe string (see RFC 4648 section 5).

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

md5_file

Reads file (defined by filename or filehandle) content, and returns its MD5 digest encoded as a binary string.

$md5_raw = md5_file('filename.dat');
#or
$md5_raw = md5_file(*FILEHANDLE);

md5_file_hex

Reads file (defined by filename or filehandle) content, and returns its MD5 digest encoded as a hexadecimal string.

$md5_hex = md5_file_hex('filename.dat');
#or
$md5_hex = md5_file_hex(*FILEHANDLE);

BEWARE: You have to make sure that the filehandle is in binary mode before you pass it as argument to the addfile() method.

md5_file_b64

Reads file (defined by filename or filehandle) content, and returns its MD5 digest encoded as a Base64 string, with trailing '=' padding.

$md5_b64 = md5_file_b64('filename.dat');
#or
$md5_b64 = md5_file_b64(*FILEHANDLE);

md5_file_b64u

Reads file (defined by filename or filehandle) content, and returns its MD5 digest encoded as a Base64 URL Safe string (see RFC 4648 section 5).

$md5_b64url = md5_file_b64u('filename.dat');
#or
$md5_b64url = md5_file_b64u(*FILEHANDLE);

METHODS

The OO interface provides the same set of functions as Crypt::Digest.

new

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

clone

$d->clone();

reset

$d->reset();

add

$d->add('any data');
#or
$d->add('any data', 'more data', 'even more data');

addfile

$d->addfile('filename.dat');
#or
$d->addfile(*FILEHANDLE);

add_bits

$d->add_bits($bit_string);   # e.g. $d->add_bits("111100001010");
#or
$d->add_bits($data, $nbits); # e.g. $d->add_bits("\xF0\xA0", 16);

hashsize

$d->hashsize;
#or
Crypt::Digest::MD5->hashsize();
#or
Crypt::Digest::MD5::hashsize();

digest

$result_raw = $d->digest();

hexdigest

$result_hex = $d->hexdigest();

b64digest

$result_b64 = $d->b64digest();

b64udigest

$result_b64url = $d->b64udigest();