- Tumbleweed 0.89.0-1.1
- Leap-16.0
- Leap-15.6
| Crypt::Digest::Keccak256(3) | User Contributed Perl Documentation | Crypt::Digest::Keccak256(3) |
NAME¶
Crypt::Digest::Keccak256 - Hash function Keccak-256 [size: 256 bits]
SYNOPSIS¶
### Functional interface:
use Crypt::Digest::Keccak256 qw( keccak256 keccak256_hex keccak256_b64 keccak256_b64u
keccak256_file keccak256_file_hex keccak256_file_b64 keccak256_file_b64u );
# calculate digest from string/buffer
my $data = 'data string';
my $keccak256_raw = keccak256($data);
my $keccak256_hex = keccak256_hex($data);
my $keccak256_b64 = keccak256_b64($data);
my $keccak256_b64u = keccak256_b64u($data);
# or from file
my $keccak256_file_raw = keccak256_file('filename.dat');
my $keccak256_file_hex = keccak256_file_hex('filename.dat');
my $keccak256_file_b64 = keccak256_file_b64('filename.dat');
my $keccak256_file_b64u = keccak256_file_b64u('filename.dat');
# or from filehandle
my $filehandle = ...; # existing binary-mode filehandle
my $keccak256_fh_raw = keccak256_file($filehandle);
my $keccak256_fh_hex = keccak256_file_hex($filehandle);
my $keccak256_fh_b64 = keccak256_file_b64($filehandle);
my $keccak256_fh_b64u = keccak256_file_b64u($filehandle);
### OO interface:
use Crypt::Digest::Keccak256;
my $d = Crypt::Digest::Keccak256->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::Keccak256->new->addfile('filename.dat')->digest;
DESCRIPTION¶
Provides an interface to the Keccak256 digest algorithm.
EXPORT¶
Nothing is exported by default.
You can export selected functions:
use Crypt::Digest::Keccak256 qw(keccak256 keccak256_hex keccak256_b64 keccak256_b64u
keccak256_file keccak256_file_hex keccak256_file_b64 keccak256_file_b64u);
Or all of them at once:
use Crypt::Digest::Keccak256 ':all';
FUNCTIONS¶
keccak256¶
Joins all arguments into a single string and returns its Keccak256 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 "keccak256_hex", "keccak256_b64", and "keccak256_b64u".
my $keccak256_raw = keccak256('data string');
#or
my $keccak256_raw = keccak256('any data', 'more data', 'even more data');
keccak256_hex¶
Joins all arguments into a single string and returns its Keccak256 digest encoded as a hexadecimal string.
my $keccak256_hex = keccak256_hex('data string');
#or
my $keccak256_hex = keccak256_hex('any data', 'more data', 'even more data');
keccak256_b64¶
Joins all arguments into a single string and returns its Keccak256 digest encoded as a Base64 string, with trailing '=' padding.
my $keccak256_b64 = keccak256_b64('data string');
#or
my $keccak256_b64 = keccak256_b64('any data', 'more data', 'even more data');
keccak256_b64u¶
Joins all arguments into a single string and returns its Keccak256 digest encoded as a Base64 URL-safe string (see RFC 4648 section 5).
my $keccak256_b64url = keccak256_b64u('data string');
#or
my $keccak256_b64url = keccak256_b64u('any data', 'more data', 'even more data');
keccak256_file¶
Reads a file given by a filename or filehandle and returns its Keccak256 digest encoded as a binary string.
my $keccak256_raw = keccak256_file('filename.dat');
#or
my $filehandle = ...; # existing binary-mode filehandle
my $keccak256_raw = keccak256_file($filehandle);
keccak256_file_hex¶
Reads a file given by a filename or filehandle and returns its Keccak256 digest encoded as a hexadecimal string.
my $keccak256_hex = keccak256_file_hex('filename.dat');
#or
my $filehandle = ...; # existing binary-mode filehandle
my $keccak256_hex = keccak256_file_hex($filehandle);
Note: The filehandle must be in binary mode before you pass it to addfile().
keccak256_file_b64¶
Reads a file given by a filename or filehandle and returns its Keccak256 digest encoded as a Base64 string, with trailing '=' padding.
my $keccak256_b64 = keccak256_file_b64('filename.dat');
#or
my $filehandle = ...; # existing binary-mode filehandle
my $keccak256_b64 = keccak256_file_b64($filehandle);
keccak256_file_b64u¶
Reads a file given by a filename or filehandle and returns its Keccak256 digest encoded as a Base64 URL-safe string (see RFC 4648 section 5).
my $keccak256_b64url = keccak256_file_b64u('filename.dat');
#or
my $filehandle = ...; # existing binary-mode filehandle
my $keccak256_b64url = keccak256_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::Keccak256->new();
new¶
my $d = Crypt::Digest::Keccak256->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::Keccak256->hashsize(); #or Crypt::Digest::Keccak256::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();
SEE ALSO¶
- CryptX, Crypt::Digest
- <https://keccak.team/index.html>
| 2026-05-11 | perl v5.42.1 |