Initial Commit

database/perl/vendor/lib/Crypt/Digest/Keccak512.pm

@@ -0,0 +1,223 @@
+package Crypt::Digest::Keccak512;
+
+### BEWARE - GENERATED FILE, DO NOT EDIT MANUALLY!
+
+use strict;
+use warnings;
+our $VERSION = '0.069';
+
+use base qw(Crypt::Digest Exporter);
+our %EXPORT_TAGS = ( all => [qw( keccak512 keccak512_hex keccak512_b64 keccak512_b64u keccak512_file keccak512_file_hex keccak512_file_b64 keccak512_file_b64u )] );
+our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
+our @EXPORT = qw();
+
+use Carp;
+$Carp::Internal{(__PACKAGE__)}++;
+use Crypt::Digest;
+
+sub hashsize                { Crypt::Digest::hashsize('Keccak512')             }
+sub keccak512             { Crypt::Digest::digest_data('Keccak512', @_)      }
+sub keccak512_hex         { Crypt::Digest::digest_data_hex('Keccak512', @_)  }
+sub keccak512_b64         { Crypt::Digest::digest_data_b64('Keccak512', @_)  }
+sub keccak512_b64u        { Crypt::Digest::digest_data_b64u('Keccak512', @_) }
+sub keccak512_file        { Crypt::Digest::digest_file('Keccak512', @_)      }
+sub keccak512_file_hex    { Crypt::Digest::digest_file_hex('Keccak512', @_)  }
+sub keccak512_file_b64    { Crypt::Digest::digest_file_b64('Keccak512', @_)  }
+sub keccak512_file_b64u   { Crypt::Digest::digest_file_b64u('Keccak512', @_) }
+
+1;
+
+=pod
+
+=head1 NAME
+
+Crypt::Digest::Keccak512 - Hash function Keccak-512 [size: 512 bits]
+
+=head1 SYNOPSIS
+
+   ### Functional interface:
+   use Crypt::Digest::Keccak512 qw( keccak512 keccak512_hex keccak512_b64 keccak512_b64u
+                                keccak512_file keccak512_file_hex keccak512_file_b64 keccak512_file_b64u );
+
+   # calculate digest from string/buffer
+   $keccak512_raw  = keccak512('data string');
+   $keccak512_hex  = keccak512_hex('data string');
+   $keccak512_b64  = keccak512_b64('data string');
+   $keccak512_b64u = keccak512_b64u('data string');
+   # calculate digest from file
+   $keccak512_raw  = keccak512_file('filename.dat');
+   $keccak512_hex  = keccak512_file_hex('filename.dat');
+   $keccak512_b64  = keccak512_file_b64('filename.dat');
+   $keccak512_b64u = keccak512_file_b64u('filename.dat');
+   # calculate digest from filehandle
+   $keccak512_raw  = keccak512_file(*FILEHANDLE);
+   $keccak512_hex  = keccak512_file_hex(*FILEHANDLE);
+   $keccak512_b64  = keccak512_file_b64(*FILEHANDLE);
+   $keccak512_b64u = keccak512_file_b64u(*FILEHANDLE);
+
+   ### OO interface:
+   use Crypt::Digest::Keccak512;
+
+   $d = Crypt::Digest::Keccak512->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
+
+=head1 DESCRIPTION
+
+Provides an interface to the Keccak512 digest algorithm.
+
+=head1 EXPORT
+
+Nothing is exported by default.
+
+You can export selected functions:
+
+  use Crypt::Digest::Keccak512 qw(keccak512 keccak512_hex keccak512_b64 keccak512_b64u
+                                      keccak512_file keccak512_file_hex keccak512_file_b64 keccak512_file_b64u);
+
+Or all of them at once:
+
+  use Crypt::Digest::Keccak512 ':all';
+
+=head1 FUNCTIONS
+
+=head2 keccak512
+
+Logically joins all arguments into a single string, and returns its Keccak512 digest encoded as a binary string.
+
+ $keccak512_raw = keccak512('data string');
+ #or
+ $keccak512_raw = keccak512('any data', 'more data', 'even more data');
+
+=head2 keccak512_hex
+
+Logically joins all arguments into a single string, and returns its Keccak512 digest encoded as a hexadecimal string.
+
+ $keccak512_hex = keccak512_hex('data string');
+ #or
+ $keccak512_hex = keccak512_hex('any data', 'more data', 'even more data');
+
+=head2 keccak512_b64
+
+Logically joins all arguments into a single string, and returns its Keccak512 digest encoded as a Base64 string, B<with> trailing '=' padding.
+
+ $keccak512_b64 = keccak512_b64('data string');
+ #or
+ $keccak512_b64 = keccak512_b64('any data', 'more data', 'even more data');
+
+=head2 keccak512_b64u
+
+Logically joins all arguments into a single string, and returns its Keccak512 digest encoded as a Base64 URL Safe string (see RFC 4648 section 5).
+
+ $keccak512_b64url = keccak512_b64u('data string');
+ #or
+ $keccak512_b64url = keccak512_b64u('any data', 'more data', 'even more data');
+
+=head2 keccak512_file
+
+Reads file (defined by filename or filehandle) content, and returns its Keccak512 digest encoded as a binary string.
+
+ $keccak512_raw = keccak512_file('filename.dat');
+ #or
+ $keccak512_raw = keccak512_file(*FILEHANDLE);
+
+=head2 keccak512_file_hex
+
+Reads file (defined by filename or filehandle) content, and returns its Keccak512 digest encoded as a hexadecimal string.
+
+ $keccak512_hex = keccak512_file_hex('filename.dat');
+ #or
+ $keccak512_hex = keccak512_file_hex(*FILEHANDLE);
+
+B<BEWARE:> You have to make sure that the filehandle is in binary mode before you pass it as argument to the addfile() method.
+
+=head2 keccak512_file_b64
+
+Reads file (defined by filename or filehandle) content, and returns its Keccak512 digest encoded as a Base64 string, B<with> trailing '=' padding.
+
+ $keccak512_b64 = keccak512_file_b64('filename.dat');
+ #or
+ $keccak512_b64 = keccak512_file_b64(*FILEHANDLE);
+
+=head2 keccak512_file_b64u
+
+Reads file (defined by filename or filehandle) content, and returns its Keccak512 digest encoded as a Base64 URL Safe string (see RFC 4648 section 5).
+
+ $keccak512_b64url = keccak512_file_b64u('filename.dat');
+ #or
+ $keccak512_b64url = keccak512_file_b64u(*FILEHANDLE);
+
+=head1 METHODS
+
+The OO interface provides the same set of functions as L<Crypt::Digest>.
+
+=head2 new
+
+ $d = Crypt::Digest::Keccak512->new();
+
+=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 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);
+
+=head2 hashsize
+
+ $d->hashsize;
+ #or
+ Crypt::Digest::Keccak512->hashsize();
+ #or
+ Crypt::Digest::Keccak512::hashsize();
+
+=head2 digest
+
+ $result_raw = $d->digest();
+
+=head2 hexdigest
+
+ $result_hex = $d->hexdigest();
+
+=head2 b64digest
+
+ $result_b64 = $d->b64digest();
+
+=head2 b64udigest
+
+ $result_b64url = $d->b64udigest();
+
+=head1 SEE ALSO
+
+=over
+
+=item * L<CryptX|CryptX>, L<Crypt::Digest>
+
+=item * L<https://keccak.team/index.html>
+
+=back
+
+=cut