# Crypt::Mac::F9 - phpMan

## NAME
    [Crypt::Mac::F9] - Message authentication code F9

## SYNOPSIS
       ### Functional interface:
       use [Crypt::Mac::F9] qw( f9 f9_hex );

       # calculate MAC from string/buffer
       $f9_raw  = f9($cipher_name, $key, 'data buffer');
       $f9_hex  = f9_hex($cipher_name, $key, 'data buffer');
       $f9_b64  = f9_b64($cipher_name, $key, 'data buffer');
       $f9_b64u = f9_b64u($cipher_name, $key, 'data buffer');

       ### OO interface:
       use [Crypt::Mac::F9];

       $d = [Crypt::Mac::F9]->new($cipher_name, $key);
       $d->add('any data');
       $d->addfile('filename.dat');
       $d->addfile(*FILEHANDLE);
       $result_raw  = $d->mac;     # raw bytes
       $result_hex  = $d->hexmac;  # hexadecimal form
       $result_b64  = $d->b64mac;  # Base64 form
       $result_b64u = $d->b64umac; # Base64 URL Safe form

## DESCRIPTION
    Provides an interface to the F9 message authentication code (MAC)
    algorithm.

## EXPORT
    Nothing is exported by default.

    You can export selected functions:

      use [Crypt::Mac::F9] qw(f9 f9_hex );

    Or all of them at once:

      use [Crypt::Mac::F9] ':all';

## FUNCTIONS
  f9
    Logically joins all arguments into a single string, and returns its F9
    message authentication code encoded as a binary string.

     $f9_raw = f9($cipher_name, $key, 'data buffer');
     #or
     $f9_raw = f9($cipher_name, $key, 'any data', 'more data', 'even more data');

  f9_hex
    Logically joins all arguments into a single string, and returns its F9
    message authentication code encoded as a hexadecimal string.

     $f9_hex = f9_hex($cipher_name, $key, 'data buffer');
     #or
     $f9_hex = f9_hex($cipher_name, $key, 'any data', 'more data', 'even more data');

  f9_b64
    Logically joins all arguments into a single string, and returns its F9
    message authentication code encoded as a Base64 string.

     $f9_b64 = f9_b64($cipher_name, $key, 'data buffer');
     #or
     $f9_b64 = f9_b64($cipher_name, $key, 'any data', 'more data', 'even more data');

  f9_b64u
    Logically joins all arguments into a single string, and returns its F9
    message authentication code encoded as a Base64 URL Safe string (see RFC
    4648 section 5).

     $f9_b64url = f9_b64u($cipher_name, $key, 'data buffer');
     #or
     $f9_b64url = f9_b64u($cipher_name, $key, 'any data', 'more data', 'even more data');

## METHODS
  new
     $d = [Crypt::Mac::F9]->new($cipher_name, $key);

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

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

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

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

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

## SEE ALSO
    *   CryptX