Codebase list libcryptx-perl / 496d9b3 lib / Crypt / Digest / BLAKE2b_384.pm
496d9b3

Tree @496d9b3 (Download .tar.gz)

BLAKE2b_384.pm @496d9b3 — raw · history · blame 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
package Crypt::Digest::BLAKE2b_384;

### BEWARE - GENERATED FILE, DO NOT EDIT MANUALLY!

use strict;
use warnings;
our $VERSION = '0.054';

use base qw(Crypt::Digest Exporter);
our %EXPORT_TAGS = ( all => [qw( blake2b_384 blake2b_384_hex blake2b_384_b64 blake2b_384_b64u blake2b_384_file blake2b_384_file_hex blake2b_384_file_b64 blake2b_384_file_b64u )] );
our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
our @EXPORT = qw();

use Carp;
$Carp::Internal{(__PACKAGE__)}++;
use CryptX;

sub hashsize { Crypt::Digest::hashsize(__PACKAGE__) }

sub blake2b_384             { Crypt::Digest::digest_data(__PACKAGE__, @_) }
sub blake2b_384_hex         { Crypt::Digest::digest_data_hex(__PACKAGE__, @_) }
sub blake2b_384_b64         { Crypt::Digest::digest_data_b64(__PACKAGE__, @_) }
sub blake2b_384_b64u        { Crypt::Digest::digest_data_b64u(__PACKAGE__, @_) }

sub blake2b_384_file        { Crypt::Digest::digest_file(__PACKAGE__, @_) }
sub blake2b_384_file_hex    { Crypt::Digest::digest_file_hex(__PACKAGE__, @_) }
sub blake2b_384_file_b64    { Crypt::Digest::digest_file_b64(__PACKAGE__, @_) }
sub blake2b_384_file_b64u   { Crypt::Digest::digest_file_b64u(__PACKAGE__, @_) }

1;

=pod

=head1 NAME

Crypt::Digest::BLAKE2b_384 - Hash function BLAKE2b [size: 384 bits]

=head1 SYNOPSIS

   ### Functional interface:
   use Crypt::Digest::BLAKE2b_384 qw( blake2b_384 blake2b_384_hex blake2b_384_b64 blake2b_384_b64u
                                blake2b_384_file blake2b_384_file_hex blake2b_384_file_b64 blake2b_384_file_b64u );

   # calculate digest from string/buffer
   $blake2b_384_raw  = blake2b_384('data string');
   $blake2b_384_hex  = blake2b_384_hex('data string');
   $blake2b_384_b64  = blake2b_384_b64('data string');
   $blake2b_384_b64u = blake2b_384_b64u('data string');
   # calculate digest from file
   $blake2b_384_raw  = blake2b_384_file('filename.dat');
   $blake2b_384_hex  = blake2b_384_file_hex('filename.dat');
   $blake2b_384_b64  = blake2b_384_file_b64('filename.dat');
   $blake2b_384_b64u = blake2b_384_file_b64u('filename.dat');
   # calculate digest from filehandle
   $blake2b_384_raw  = blake2b_384_file(*FILEHANDLE);
   $blake2b_384_hex  = blake2b_384_file_hex(*FILEHANDLE);
   $blake2b_384_b64  = blake2b_384_file_b64(*FILEHANDLE);
   $blake2b_384_b64u = blake2b_384_file_b64u(*FILEHANDLE);

   ### OO interface:
   use Crypt::Digest::BLAKE2b_384;

   $d = Crypt::Digest::BLAKE2b_384->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 BLAKE2b_384 digest algorithm.

=head1 EXPORT

Nothing is exported by default.

You can export selected functions:

  use Crypt::Digest::BLAKE2b_384 qw(blake2b_384 blake2b_384_hex blake2b_384_b64 blake2b_384_b64u
                                      blake2b_384_file blake2b_384_file_hex blake2b_384_file_b64 blake2b_384_file_b64u);

Or all of them at once:

  use Crypt::Digest::BLAKE2b_384 ':all';

=head1 FUNCTIONS

=head2 blake2b_384

Logically joins all arguments into a single string, and returns its BLAKE2b_384 digest encoded as a binary string.

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

=head2 blake2b_384_hex

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

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

=head2 blake2b_384_b64

Logically joins all arguments into a single string, and returns its BLAKE2b_384 digest encoded as a Base64 string, B<with> trailing '=' padding.

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

=head2 blake2b_384_b64u

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

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

=head2 blake2b_384_file

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

 $blake2b_384_raw = blake2b_384_file('filename.dat');
 #or
 $blake2b_384_raw = blake2b_384_file(*FILEHANDLE);

=head2 blake2b_384_file_hex

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

 $blake2b_384_hex = blake2b_384_file_hex('filename.dat');
 #or
 $blake2b_384_hex = blake2b_384_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 blake2b_384_file_b64

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

 $blake2b_384_b64 = blake2b_384_file_b64('filename.dat');
 #or
 $blake2b_384_b64 = blake2b_384_file_b64(*FILEHANDLE);

=head2 blake2b_384_file_b64u

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

 $blake2b_384_b64url = blake2b_384_file_b64u('filename.dat');
 #or
 $blake2b_384_b64url = blake2b_384_file_b64u(*FILEHANDLE);

=head1 METHODS

The OO interface provides the same set of functions as L<Crypt::Digest>.

=head2 new

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

=item * L<https://blake2.net/|https://blake2.net/>

=item * L<https://tools.ietf.org/html/rfc7693|https://tools.ietf.org/html/rfc7693>

=back

=cut

__END__