diff options
Diffstat (limited to 'lib/Crypt/Digest/SHA1.pm')
| -rw-r--r-- | lib/Crypt/Digest/SHA1.pm | 197 |
1 files changed, 197 insertions, 0 deletions
diff --git a/lib/Crypt/Digest/SHA1.pm b/lib/Crypt/Digest/SHA1.pm new file mode 100644 index 00000000..2279ec07 --- /dev/null +++ b/lib/Crypt/Digest/SHA1.pm @@ -0,0 +1,197 @@ +package Crypt::Digest::SHA1;
+
+### BEWARE - GENERATED FILE, DO NOT EDIT MANUALLY!
+
+use strict;
+use warnings;
+
+use Exporter 'import';
+our %EXPORT_TAGS = ( all => [qw( sha1 sha1_hex sha1_base64 sha1_file sha1_file_hex sha1_file_base64 )] );
+our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
+our @EXPORT = qw();
+
+use CryptX;
+use base 'Crypt::Digest';
+
+sub hashsize { Crypt::Digest::hashsize(__PACKAGE__) }
+
+sub sha1 { __PACKAGE__->new->add(@_)->digest }
+sub sha1_hex { __PACKAGE__->new->add(@_)->hexdigest }
+sub sha1_base64 { __PACKAGE__->new->add(@_)->b64digest }
+
+sub sha1_file { __PACKAGE__->new->addfile(@_)->digest }
+sub sha1_file_hex { __PACKAGE__->new->addfile(@_)->hexdigest }
+sub sha1_file_base64 { __PACKAGE__->new->addfile(@_)->b64digest }
+
+1;
+
+=pod
+
+=head1 NAME
+
+Crypt::Digest::SHA1 - Hash function SHA-1 [size: 160 bits]
+
+=head1 SYNOPSIS
+
+ ### Functional interface:
+ use Crypt::Digest::SHA1 qw( sha1 sha1_hex sha1_base64 sha1_file sha1_file_hex sha1_file_base64 );
+
+ # calculate digest from string/buffer
+ $sha1_raw = sha1('data string');
+ $sha1_hex = sha1_hex('data string');
+ $sha1_b64 = sha1_base64('data string');
+ # calculate digest from file
+ $sha1_raw = sha1_file('filename.dat');
+ $sha1_hex = sha1_file_hex('filename.dat');
+ $sha1_b64 = sha1_file_base64('filename.dat');
+ # calculate digest from filehandle
+ $sha1_raw = sha1_file(*FILEHANDLE);
+ $sha1_hex = sha1_file_hex(*FILEHANDLE);
+ $sha1_b64 = sha1_file_base64(*FILEHANDLE);
+
+ ### OO interface:
+ use Crypt::Digest::SHA1;
+
+ $d = Crypt::Digest::SHA1->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
+
+=head1 DESCRIPTION
+
+Provides an interface to the SHA1 digest algorithm.
+
+=head1 EXPORT
+
+Nothing is exported by default.
+
+You can export selected functions:
+
+ use Crypt::Digest::SHA1 qw(sha1 sha1_hex sha1_base64 sha1_file sha1_file_hex sha1_file_base64);
+
+Or all of them at once:
+
+ use Crypt::Digest::SHA1 ':all';
+
+=head1 FUNCTIONS
+
+=head2 sha1
+
+Logically joins all arguments into a single string, and returns its SHA1 digest encoded as a binary string.
+
+ $sha1_raw = sha1('data string');
+ #or
+ $sha1_raw = sha1('any data', 'more data', 'even more data');
+
+=head2 sha1_hex
+
+Logically joins all arguments into a single string, and returns its SHA1 digest encoded as a hexadecimal string.
+
+ $sha1_hex = sha1_hex('data string');
+ #or
+ $sha1_hex = sha1('any data', 'more data', 'even more data');
+
+=head2 sha1_base64
+
+Logically joins all arguments into a single string, and returns its SHA1 digest encoded as a Base64 string, B<with> trailing '=' padding.
+
+ $sha1_base64 = sha1_base64('data string');
+ #or
+ $sha1_base64 = sha1('any data', 'more data', 'even more data');
+
+=head2 sha1_file
+
+Reads file (defined by filename or filehandle) content, and returns its SHA1 digest encoded as a binary string.
+
+ $sha1_raw = sha1_file('filename.dat');
+ #or
+ $sha1_raw = sha1_file(*FILEHANDLE);
+
+=head2 sha1_file_hex
+
+Reads file (defined by filename or filehandle) content, and returns its SHA1 digest encoded as a hexadecimal string.
+
+ $sha1_hex = sha1_file_hex('filename.dat');
+ #or
+ $sha1_hex = sha1_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 sha1_file_base64
+
+Reads file (defined by filename or filehandle) content, and returns its SHA1 digest encoded as a Base64 string, B<with> trailing '=' padding.
+
+ $sha1_base64 = sha1_file_base64('filename.dat');
+ #or
+ $sha1_base64 = sha1_file_base64(*FILEHANDLE);
+
+=head1 METHODS
+
+The OO interface provides the same set of functions as L<Crypt::Digest>.
+
+=head2 new
+
+ $d = Crypt::Digest::SHA1->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->addfile('filename.dat');
+ #or
+ $d->addfile(*FILEHANDLE);
+
+=head2 hashsize
+
+ $d->hashsize;
+ #or
+ Crypt::Digest::SHA1->hashsize();
+ #or
+ Crypt::Digest::SHA1::hashsize();
+
+=head2 digest
+
+ $result_raw = $d->digest();
+
+=head2 hexdigest
+
+ $result_hex = $d->hexdigest();
+
+=head2 b64digest
+
+ $result_base64 = $d->b64digest();
+
+=head1 SEE ALSO
+
+=over 4
+
+=item L<CryptX|CryptX>, L<Crypt::Digest|Crypt::Digest>
+
+=item L<http://en.wikipedia.org/wiki/SHA-1|http://en.wikipedia.org/wiki/SHA-1>
+
+=back
+
+=cut
+
+__END__
\ No newline at end of file |