summaryrefslogtreecommitdiff
path: root/lib/Crypt/Mac/F9.pm
diff options
context:
space:
mode:
Diffstat (limited to 'lib/Crypt/Mac/F9.pm')
-rw-r--r--lib/Crypt/Mac/F9.pm144
1 files changed, 144 insertions, 0 deletions
diff --git a/lib/Crypt/Mac/F9.pm b/lib/Crypt/Mac/F9.pm
new file mode 100644
index 00000000..7d479689
--- /dev/null
+++ b/lib/Crypt/Mac/F9.pm
@@ -0,0 +1,144 @@
+package Crypt::Mac::F9;
+
+### BEWARE - GENERATED FILE, DO NOT EDIT MANUALLY!
+
+use strict;
+use warnings;
+
+use Exporter 'import';
+our %EXPORT_TAGS = ( all => [qw( f9 f9_hex f9_b64 )] );
+our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
+our @EXPORT = qw();
+
+use CryptX;
+use base 'Crypt::Mac';
+
+use Crypt::Cipher;
+
+sub new { my $class = shift; _new(Crypt::Cipher::_trans_cipher_name(shift), @_) }
+sub f9 { Crypt::Mac::F9->new(shift, shift)->add(@_)->mac }
+sub f9_hex { Crypt::Mac::F9->new(shift, shift)->add(@_)->hexmac }
+sub f9_b64 { Crypt::Mac::F9->new(shift, shift)->add(@_)->b64mac }
+
+1;
+
+=pod
+
+=head1 NAME
+
+Crypt::Mac::F9 - Message authentication code F9
+
+=head1 SYNOPSIS
+
+ ### Functional interface:
+ use Crypt::Mac::F9 qw( f9 f9_hex );
+
+ # calculate MAC from string/buffer
+ $f9_raw = f9($cipher_name, $key, 'data string');
+ $f9_hex = f9_hex($cipher_name, $key, 'data string');
+ $f9_b64 = f9_b64($cipher_name, $key, 'data string');
+
+ ### 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
+
+=head1 DESCRIPTION
+
+Provides an interface to the F9 message authentication code (MAC) algorithm.
+
+=head1 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';
+
+=head1 FUNCTIONS
+
+=head2 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 string');
+ #or
+ $f9_raw = f9($cipher_name, $key, 'any data', 'more data', 'even more data');
+
+=head2 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($cipher_name, $key, 'data string');
+ #or
+ $f9_hex = f9($cipher_name, $key, 'any data', 'more data', 'even more data');
+
+=head2 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($cipher_name, $key, 'data string');
+ #or
+ $f9_b64 = f9($cipher_name, $key, 'any data', 'more data', 'even more data');
+
+=head1 METHODS
+
+The OO interface provides the same set of functions as L<Crypt::Mac>.
+
+=head2 new
+
+ $d = Crypt::Mac::F9->new($cipher_name, $key);
+
+=head2 clone
+
+ $d->clone();
+
+=head2 reset
+
+ $d->reset();
+
+=head2 add
+
+ $d->add('any data');
+ #or
+ $d->add('any data', 'more data', 'even more data');
+
+=head2 addfile
+
+ $d->addfile('filename.dat');
+ #or
+ $d->addfile(*FILEHANDLE);
+
+=head2 mac
+
+ $result_raw = $d->mac();
+
+=head2 hexmac
+
+ $result_hex = $d->hexmac();
+
+=head2 b64mac
+
+ $result_base64 = $d->b64mac();
+
+=head1 SEE ALSO
+
+=over 4
+
+=item L<CryptX|CryptX>, L<Crypt::Mac|Crypt::Mac>
+
+=back
+
+=cut
+
+__END__ \ No newline at end of file