# Crypt::Digest::Keccak384 - phpMan

## 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
       $keccak384_raw  = keccak384('data string');
       $keccak384_hex  = keccak384_hex('data string');
       $keccak384_b64  = keccak384_b64('data string');
       $keccak384_b64u = keccak384_b64u('data string');
       # calculate digest from file
       $keccak384_raw  = keccak384_file('filename.dat');
       $keccak384_hex  = keccak384_file_hex('filename.dat');
       $keccak384_b64  = keccak384_file_b64('filename.dat');
       $keccak384_b64u = keccak384_file_b64u('filename.dat');
       # calculate digest from filehandle
       $keccak384_raw  = keccak384_file(*FILEHANDLE);
       $keccak384_hex  = keccak384_file_hex(*FILEHANDLE);
       $keccak384_b64  = keccak384_file_b64(*FILEHANDLE);
       $keccak384_b64u = keccak384_file_b64u(*FILEHANDLE);

       ### OO interface:
       use [Crypt::Digest::Keccak384];

       $d = [Crypt::Digest::Keccak384]->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 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
    Logically joins all arguments into a single string, and returns its
    Keccak384 digest encoded as a binary string.

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

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

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

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

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

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

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

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

     $keccak384_raw = keccak384_file('filename.dat');
     #or
     $keccak384_raw = keccak384_file(*FILEHANDLE);

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

     $keccak384_hex = keccak384_file_hex('filename.dat');
     #or
     $keccak384_hex = keccak384_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.

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

     $keccak384_b64 = keccak384_file_b64('filename.dat');
     #or
     $keccak384_b64 = keccak384_file_b64(*FILEHANDLE);

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

     $keccak384_b64url = keccak384_file_b64u('filename.dat');
     #or
     $keccak384_b64url = keccak384_file_b64u(*FILEHANDLE);

## METHODS
    The OO interface provides the same set of functions as [Crypt::Digest].

  new
     $d = [Crypt::Digest::Keccak384]->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::Keccak384]->hashsize();
     #or
     [Crypt::Digest::Keccak384::hashsize]();

  digest
     $result_raw = $d->digest();

  hexdigest
     $result_hex = $d->hexdigest();

  b64digest
     $result_b64 = $d->b64digest();

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

## SEE ALSO
    *   CryptX, [Crypt::Digest]

    *   <<https://keccak.team/index.html>>