libcryptx-perl/lib/Crypt/AuthEnc/EAX.pm

143 lines
3.9 KiB
Perl
Raw Permalink Normal View History

2018-03-22 15:51:09 +01:00
package Crypt::AuthEnc::EAX;
use strict;
use warnings;
2018-03-22 15:54:03 +01:00
our $VERSION = '0.058_002';
2018-03-22 15:51:09 +01:00
2018-03-22 15:54:03 +01:00
require Exporter; our @ISA = qw(Exporter); ### use Exporter 'import';
2018-03-22 15:51:09 +01:00
our %EXPORT_TAGS = ( all => [qw( eax_encrypt_authenticate eax_decrypt_verify )] );
our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
our @EXPORT = qw();
2018-03-22 15:54:03 +01:00
use Carp;
$Carp::Internal{(__PACKAGE__)}++;
2018-03-22 15:51:09 +01:00
use CryptX;
2018-03-22 15:54:03 +01:00
# obsolete, only for backwards compatibility
sub header_add { goto &adata_add }
sub aad_add { goto &adata_add }
sub CLONE_SKIP { 1 } # prevent cloning
2018-03-22 15:51:09 +01:00
1;
=pod
=head1 NAME
Crypt::AuthEnc::EAX - Authenticated encryption in EAX mode
=head1 SYNOPSIS
### OO interface
use Crypt::AuthEnc::EAX;
# encrypt and authenticate
my $ae = Crypt::AuthEnc::EAX->new("AES", $key, $iv);
2018-03-22 15:54:03 +01:00
$ae->adata_add('additional_authenticated_data1');
$ae->adata_add('additional_authenticated_data2');
my $ct = $ae->encrypt_add('data1');
$ct .= $ae->encrypt_add('data2');
$ct .= $ae->encrypt_add('data3');
my $tag = $ae->encrypt_done();
2018-03-22 15:51:09 +01:00
# decrypt and verify
my $ae = Crypt::AuthEnc::EAX->new("AES", $key, $iv);
2018-03-22 15:54:03 +01:00
$ae->adata_add('additional_authenticated_data1');
$ae->adata_add('additional_authenticated_data2');
my $pt = $ae->decrypt_add('ciphertext1');
$pt .= $ae->decrypt_add('ciphertext2');
$pt .= $ae->decrypt_add('ciphertext3');
my $tag = $ae->decrypt_done();
2018-03-22 15:51:09 +01:00
die "decrypt failed" unless $tag eq $expected_tag;
#or
2018-03-22 15:54:03 +01:00
my $result = $ae->decrypt_done($expected_tag); # 0 or 1
2018-03-22 15:51:09 +01:00
### functional interface
use Crypt::AuthEnc::EAX qw(eax_encrypt_authenticate eax_decrypt_verify);
my ($ciphertext, $tag) = eax_encrypt_authenticate('AES', $key, $iv, $adata, $plaintext);
my $plaintext = eax_decrypt_verify('AES', $key, $iv, $adata, $ciphertext, $tag);
=head1 DESCRIPTION
EAX is a mode that requires a cipher, CTR and OMAC support and provides encryption and authentication.
2018-03-22 15:54:03 +01:00
It is initialized with a random IV that can be shared publicly, additional authenticated data which can
2018-03-22 15:51:09 +01:00
be fixed and public, and a random secret symmetric key.
=head1 EXPORT
Nothing is exported by default.
You can export selected functions:
use Crypt::AuthEnc::EAX qw(eax_encrypt_authenticate eax_decrypt_verify);
=head1 FUNCTIONS
=head2 eax_encrypt_authenticate
my ($ciphertext, $tag) = eax_encrypt_authenticate($cipher, $key, $iv, $adata, $plaintext);
# $cipher .. 'AES' or name of any other cipher with 16-byte block len
# $key ..... AES key of proper length (128/192/256bits)
# $iv ...... unique initialization vector (no need to keep it secret)
# $adata ... additional authenticated data
=head2 eax_decrypt_verify
2018-03-22 15:54:03 +01:00
my $plaintext = eax_decrypt_verify($cipher, $key, $iv, $adata, $ciphertext, $tag);
# on error returns undef
2018-03-22 15:51:09 +01:00
=head1 METHODS
=head2 new
my $ae = Crypt::AuthEnc::EAX->new($cipher, $key, $iv);
#or
my $ae = Crypt::AuthEnc::EAX->new($cipher, $key, $iv, $adata);
# $cipher .. 'AES' or name of any other cipher with 16-byte block len
# $key ..... AES key of proper length (128/192/256bits)
# $iv ...... unique initialization vector (no need to keep it secret)
# $adata ... additional authenticated data (optional)
2018-03-22 15:54:03 +01:00
=head2 adata_add
2018-03-22 15:51:09 +01:00
2018-03-22 15:54:03 +01:00
$ae->adata_add($adata); # can be called multiple times
2018-03-22 15:51:09 +01:00
=head2 encrypt_add
2018-03-22 15:54:03 +01:00
$ciphertext = $ae->encrypt_add($data); # can be called multiple times
2018-03-22 15:51:09 +01:00
=head2 encrypt_done
2018-03-22 15:54:03 +01:00
$tag = $ae->encrypt_done(); # returns $tag value
2018-03-22 15:51:09 +01:00
=head2 decrypt_add
2018-03-22 15:54:03 +01:00
$plaintext = $ae->decrypt_add($ciphertext); # can be called multiple times
2018-03-22 15:51:09 +01:00
=head2 decrypt_done
my $tag = $ae->decrypt_done; # returns $tag value
2018-03-22 15:54:03 +01:00
#or
my $result = $ae->decrypt_done($tag); # returns 1 (success) or 0 (failure)
2018-03-22 15:51:09 +01:00
=head2 clone
my $ae_new = $ae->clone;
=head1 SEE ALSO
=over
=item * L<CryptX|CryptX>, L<Crypt::AuthEnc::CCM|Crypt::AuthEnc::CCM>, L<Crypt::AuthEnc::GCM|Crypt::AuthEnc::GCM>, L<Crypt::AuthEnc::OCB|Crypt::AuthEnc::OCB>
=item * L<https://en.wikipedia.org/wiki/EAX_mode|https://en.wikipedia.org/wiki/EAX_mode>
=back
2018-03-22 15:54:03 +01:00
=cut