File Coverage

blib/lib/Crypt/Digest/SHA256.pm

Criterion	Covered	Total	%
statement	26	30	86.6
branch			n/a
condition	0	3	0.0
subroutine	14	16	87.5
pod	11	11	100.0
total	51	60	85.0

package Crypt::Digest::SHA256;

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

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

use base qw(Crypt::Digest Exporter);
our %EXPORT_TAGS = ( all => [qw( sha256 sha256_hex sha256_b64 sha256_b64u sha256_file sha256_file_hex sha256_file_b64 sha256_file_b64u )] );
our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
our @EXPORT = qw();

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

sub new {
  my ($class) = @_;
  my $obj = Crypt::Digest->new('SHA256');
  return bless $obj, $class;
}

sub clone {
  my ($self) = @_;
  my $obj = Crypt::Digest::clone($self);
  return bless $obj, ref($self) || $self;
}

sub hashsize                { Crypt::Digest::hashsize('SHA256')             }
sub sha256             { Crypt::Digest::digest_data('SHA256', @_)      }
sub sha256_hex         { Crypt::Digest::digest_data_hex('SHA256', @_)  }
sub sha256_b64         { Crypt::Digest::digest_data_b64('SHA256', @_)  }
sub sha256_b64u        { Crypt::Digest::digest_data_b64u('SHA256', @_) }
sub sha256_file        { Crypt::Digest::digest_file('SHA256', @_)      }
sub sha256_file_hex    { Crypt::Digest::digest_file_hex('SHA256', @_)  }
sub sha256_file_b64    { Crypt::Digest::digest_file_b64('SHA256', @_)  }
sub sha256_file_b64u   { Crypt::Digest::digest_file_b64u('SHA256', @_) }

1;

=pod

=head1 NAME

Crypt::Digest::SHA256 - Hash function SHA-256 [size: 256 bits]

=head1 SYNOPSIS

   ### Functional interface:
   use Crypt::Digest::SHA256 qw( sha256 sha256_hex sha256_b64 sha256_b64u
                                sha256_file sha256_file_hex sha256_file_b64 sha256_file_b64u );

   # calculate digest from string/buffer
   my $data = 'data string';
   my $sha256_raw  = sha256($data);
   my $sha256_hex  = sha256_hex($data);
   my $sha256_b64  = sha256_b64($data);
   my $sha256_b64u = sha256_b64u($data);
   # or from file
   my $sha256_file_raw  = sha256_file('filename.dat');
   my $sha256_file_hex  = sha256_file_hex('filename.dat');
   my $sha256_file_b64  = sha256_file_b64('filename.dat');
   my $sha256_file_b64u = sha256_file_b64u('filename.dat');
   # or from filehandle
   my $filehandle = ...; # existing binary-mode filehandle
   my $sha256_fh_raw  = sha256_file($filehandle);
   my $sha256_fh_hex  = sha256_file_hex($filehandle);
   my $sha256_fh_b64  = sha256_file_b64($filehandle);
   my $sha256_fh_b64u = sha256_file_b64u($filehandle);

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

   my $d = Crypt::Digest::SHA256->new;
   $d->add('any data');
   my $result_raw  = $d->digest;     # raw bytes
   my $result_hex  = $d->hexdigest;  # hexadecimal form
   my $result_b64  = $d->b64digest;  # Base64 form
   my $result_b64u = $d->b64udigest; # Base64 URL-safe form

   # or hash a file instead
   my $file_result_raw = Crypt::Digest::SHA256->new->addfile('filename.dat')->digest;

=head1 DESCRIPTION

Provides an interface to the SHA256 digest algorithm.

=head1 EXPORT

Nothing is exported by default.

You can export selected functions:

  use Crypt::Digest::SHA256 qw(sha256 sha256_hex sha256_b64 sha256_b64u
                                      sha256_file sha256_file_hex sha256_file_b64 sha256_file_b64u);

Or all of them at once:

  use Crypt::Digest::SHA256 ':all';

=head1 FUNCTIONS

=head2 sha256

Joins all arguments into a single string and returns its SHA256 digest encoded as a binary string.

Data arguments for the functional helpers are converted to byte strings using
Perl's usual scalar stringification. Defined scalars, including numbers and
string-overloaded objects, are accepted. C is treated as an empty
string and may emit Perl's usual "uninitialized value" warning. The same
rules apply to C, C, and
C.

 my $sha256_raw = sha256('data string');
 #or
 my $sha256_raw = sha256('any data', 'more data', 'even more data');

=head2 sha256_hex

Joins all arguments into a single string and returns its SHA256 digest encoded as a hexadecimal string.

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

=head2 sha256_b64

Joins all arguments into a single string and returns its SHA256 digest encoded as a Base64 string, B trailing '=' padding.

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

=head2 sha256_b64u

Joins all arguments into a single string and returns its SHA256 digest encoded as a Base64 URL-safe string (see RFC 4648 section 5).

 my $sha256_b64url = sha256_b64u('data string');
 #or
 my $sha256_b64url = sha256_b64u('any data', 'more data', 'even more data');

=head2 sha256_file

Reads a file given by a filename or filehandle and returns its SHA256 digest encoded as a binary string.

 my $sha256_raw = sha256_file('filename.dat');
 #or
 my $filehandle = ...; # existing binary-mode filehandle
 my $sha256_raw = sha256_file($filehandle);

=head2 sha256_file_hex

Reads a file given by a filename or filehandle and returns its SHA256 digest encoded as a hexadecimal string.

 my $sha256_hex = sha256_file_hex('filename.dat');
 #or
 my $filehandle = ...; # existing binary-mode filehandle
 my $sha256_hex = sha256_file_hex($filehandle);

B The filehandle must be in binary mode before you pass it to C.

=head2 sha256_file_b64

Reads a file given by a filename or filehandle and returns its SHA256 digest encoded as a Base64 string, B trailing '=' padding.

 my $sha256_b64 = sha256_file_b64('filename.dat');
 #or
 my $filehandle = ...; # existing binary-mode filehandle
 my $sha256_b64 = sha256_file_b64($filehandle);

=head2 sha256_file_b64u

Reads a file given by a filename or filehandle and returns its SHA256 digest encoded as a Base64 URL-safe string (see RFC 4648 section 5).

 my $sha256_b64url = sha256_file_b64u('filename.dat');
 #or
 my $filehandle = ...; # existing binary-mode filehandle
 my $sha256_b64url = sha256_file_b64u($filehandle);

=head1 METHODS

The OO interface provides the same set of functions as L.
Unless noted otherwise, assume C<$d> is an existing digest object created via
C, for example:

 my $d = Crypt::Digest::SHA256->new();

=head2 new

 my $d = Crypt::Digest::SHA256->new();

=head2 clone

 $d->clone();

=head2 reset

 $d->reset();

=head2 add

Appends data to the message. Returns the object itself (for chaining).

Each argument is converted to bytes using Perl's usual scalar stringification.
Defined scalars, including numbers and string-overloaded objects, are
accepted. C is treated as an empty string and may emit Perl's usual
"uninitialized value" warning.

 $d->add('any data');
 #or
 $d->add('any data', 'more data', 'even more data');

=head2 addfile

Reads the file content and appends it to the message. Returns the object itself (for chaining).

 $d->addfile('filename.dat');
 #or
 my $filehandle = ...; # existing binary-mode filehandle
 $d->addfile($filehandle);

=head2 hashsize

 $d->hashsize;
 #or
 Crypt::Digest::SHA256->hashsize();
 #or
 Crypt::Digest::SHA256::hashsize();

=head2 digest

Returns the binary digest (raw bytes).
The first call finalizes the digest object. Any later C,
C, C, C, C, or
C call will fail until you call C.

 my $result_raw = $d->digest();

=head2 hexdigest

Returns the digest encoded as a lowercase hexadecimal string.
Like C, the first call finalizes the digest object.

 my $result_hex = $d->hexdigest();

=head2 b64digest

Returns the digest encoded as a Base64 string with trailing C<=> padding.
Like C, the first call finalizes the digest object.

 my $result_b64 = $d->b64digest();

=head2 b64udigest

Returns the digest encoded as a Base64 URL-safe string (no trailing C<=>).
Like C, the first call finalizes the digest object.

 my $result_b64url = $d->b64udigest();

=head1 SEE ALSO

=over

=item * L, L

=item * L

=back

=cut