Crypt::Digest::Keccak384(3pm)

NAME

Crypt::Digest::Keccak384 - Hash function Keccak-384 [size: 384 bits]

SYNOPSIS

   ### Functional interface:
   use Crypt::Digest::Keccak384 qw( keccak384 keccak384_hex keccak384_b64 keccak384_b64u
                                keccak384_file keccak384_file_hex keccak384_file_b64 keccak384_file_b64u );
   # calculate digest from string/buffer
   my $data = 'data string';
   my $keccak384_raw  = keccak384($data);
   my $keccak384_hex  = keccak384_hex($data);
   my $keccak384_b64  = keccak384_b64($data);
   my $keccak384_b64u = keccak384_b64u($data);
   # or from file
   my $keccak384_file_raw  = keccak384_file('filename.dat');
   my $keccak384_file_hex  = keccak384_file_hex('filename.dat');
   my $keccak384_file_b64  = keccak384_file_b64('filename.dat');
   my $keccak384_file_b64u = keccak384_file_b64u('filename.dat');
   # or from filehandle
   my $filehandle = ...; # existing binary-mode filehandle
   my $keccak384_fh_raw  = keccak384_file($filehandle);
   my $keccak384_fh_hex  = keccak384_file_hex($filehandle);
   my $keccak384_fh_b64  = keccak384_file_b64($filehandle);
   my $keccak384_fh_b64u = keccak384_file_b64u($filehandle);
   ### OO interface:
   use Crypt::Digest::Keccak384;
   my $d = Crypt::Digest::Keccak384->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::Keccak384->new->addfile('filename.dat')->digest;

DESCRIPTION

Since: CryptX-0.059

Provides an interface to the Keccak384 digest algorithm.

EXPORT

Nothing is exported by default.

You can export selected functions:

  use Crypt::Digest::Keccak384 qw(keccak384 keccak384_hex keccak384_b64 keccak384_b64u
                                      keccak384_file keccak384_file_hex keccak384_file_b64 keccak384_file_b64u);

Or all of them at once:

  use Crypt::Digest::Keccak384 ':all';

FUNCTIONS

keccak384

Joins all arguments into a single string and returns its Keccak384 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 "keccak384_hex", "keccak384_b64", and "keccak384_b64u".

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

keccak384_hex

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

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

keccak384_b64

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

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

keccak384_b64u

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

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

keccak384_file

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

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

keccak384_file_hex

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

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

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

keccak384_file_b64

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

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

keccak384_file_b64u

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

 my $keccak384_b64url = keccak384_file_b64u('filename.dat');
 #or
 my $filehandle = ...; # existing binary-mode filehandle
 my $keccak384_b64url = keccak384_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::Keccak384->new();

new

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

clone

 $d->clone();

reset

 $d->reset();

add

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

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

 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();