blib/lib/Crypt/AuthEnc/GCM.pm

filter: Statementstmt 95.4% 21 / 22 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 80.0% 4 / 5 Podpod n/a totaltotal 92.5% 25 / 27 CC 1 SCAR 1.8
CC
1
Cov
95%
CLONE_SKIP
2.0
BEGIN
1.0
BEGIN
1.0
CRAP 1.2
« blib/lib/Crypt/AuthEnc/ChaCha20Poly1305.pm ↑ Summary blib/lib/Crypt/Cipher.pm »
1 package Crypt::AuthEnc::GCM;
2  
3 5 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 5 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
5 5 our $VERSION = '0.091';
6  
7 5 require Exporter; our @ISA = qw(Exporter); ### use Exporter 5.57 'import';
8 5 our %EXPORT_TAGS = ( all => [qw( gcm_encrypt_authenticate gcm_decrypt_verify )] );
9 5 our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
10 5 our @EXPORT = qw();
11  
12 5 ▶use Carp;
Subroutine BEGIN: called CC=1 SCAR=0.0
13 5 $Carp::Internal{(__PACKAGE__)}++;
14 5 ▶use CryptX;
Subroutine BEGIN: called CC=1 SCAR=0.0
15  
16 0 ▶sub CLONE_SKIP { 1 } # prevent cloning
Subroutine CLONE_SKIP: not called CC=1 SCAR=6.9
17  
18 5 1;
19  
20 =pod
21  
22 =head1 NAME
23  
24 Crypt::AuthEnc::GCM - Authenticated encryption in GCM mode
25  
26 =head1 SYNOPSIS
27  
28 ### OO interface
29 use Crypt::AuthEnc::GCM;
30  
31 my $key = '...';
32 my $iv = '...';
33 my $expected_tag = '...';
34  
35 # encrypt and authenticate
36 my $ae_enc = Crypt::AuthEnc::GCM->new("AES", $key, $iv);
37 $ae_enc->adata_add('additional_authenticated_data1');
38 $ae_enc->adata_add('additional_authenticated_data2');
39 my $ct = $ae_enc->encrypt_add('data1');
40 $ct .= $ae_enc->encrypt_add('data2');
41 $ct .= $ae_enc->encrypt_add('data3');
42 my $tag = $ae_enc->encrypt_done();
43  
44 # decrypt and verify
45 my $ae_dec = Crypt::AuthEnc::GCM->new("AES", $key, $iv);
46 $ae_dec->adata_add('additional_authenticated_data1');
47 $ae_dec->adata_add('additional_authenticated_data2');
48 my $pt = $ae_dec->decrypt_add('ciphertext1');
49 $pt .= $ae_dec->decrypt_add('ciphertext2');
50 $pt .= $ae_dec->decrypt_add('ciphertext3');
51 $ae_dec->decrypt_done($expected_tag) or die "decrypt failed"; # constant-time tag check
52  
53 #or, if you need the computed tag, compare it with slow_eq from Crypt::Misc
54 #(Perl's 'eq' is not constant-time and leaks timing information)
55 my $computed_tag = $ae_dec->decrypt_done();
56 die "decrypt failed" unless Crypt::Misc::slow_eq($computed_tag, $expected_tag);
57  
58 ### functional interface
59 use Crypt::AuthEnc::GCM qw(gcm_encrypt_authenticate gcm_decrypt_verify);
60  
61 my $key = '...';
62 my $iv = '...';
63 my $adata = '...';
64 my $plaintext = '...';
65  
66 my ($ciphertext, $tag) = gcm_encrypt_authenticate('AES', $key, $iv, $adata, $plaintext);
67 my $decrypted = gcm_decrypt_verify('AES', $key, $iv, $adata, $ciphertext, $tag);
68  
69 =head1 DESCRIPTION
70  
71 Galois/Counter Mode (GCM) - provides encryption and authentication.
72  
73 Use a fresh object per message unless you intentionally reuse the same key via C<reset>.
74 The normal call order is: C<new>, one or more C<iv_add> calls, optional C<adata_add> calls,
75 zero or more C<encrypt_add> / C<decrypt_add> calls, then C<encrypt_done> / C<decrypt_done>.
76 The first C<encrypt_done> / C<decrypt_done> call finalizes the object. After that,
77 further C<iv_add>, C<adata_add>, C<encrypt_add>, C<decrypt_add>, C<encrypt_done>,
78 and C<decrypt_done> calls croak until you call C<reset>.
79  
80 If you construct with C<new($cipher, $key)>, you must provide the IV via C<iv_add> before
81 adding authenticated data or payload data. After C<reset>, start a new message with the same
82 key by supplying the IV again, and re-add AAD if needed.
83  
84 When verifying, C<decrypt_done($expected_tag)> is the safer form. The no-argument form of
85 C<decrypt_done> only returns the computed tag.
86  
87 =head1 EXPORT
88  
89 Nothing is exported by default.
90  
91 You can export selected functions:
92  
93 use Crypt::AuthEnc::GCM qw(gcm_encrypt_authenticate gcm_decrypt_verify);
94  
95 =head1 FUNCTIONS
96  
97 =head2 gcm_encrypt_authenticate
98  
99 my ($ciphertext, $tag) = gcm_encrypt_authenticate($cipher, $key, $iv, $adata, $plaintext);
100  
101 # $cipher .. [string] 'AES' or name of any other cipher with 16-byte block len
102 # $key ..... [binary string] AES key of proper length (128/192/256 bits)
103 # $iv ...... [binary string] initialization vector
104 # $adata ... [binary string] additional authenticated data
105  
106 =head2 gcm_decrypt_verify
107  
108 my $plaintext = gcm_decrypt_verify($cipher, $key, $iv, $adata, $ciphertext, $tag);
109 # on error returns undef
110  
111 =head1 METHODS
112  
113 Unless noted otherwise, assume C<$ae> is an existing AEAD object created via
114 C<new>, for example:
115  
116 my $ae = Crypt::AuthEnc::GCM->new($cipher, $key, $iv);
117  
118 =head2 new
119  
120 my $ae = Crypt::AuthEnc::GCM->new($cipher, $key);
121 #or
122 my $ae = Crypt::AuthEnc::GCM->new($cipher, $key, $iv);
123  
124 # $cipher .. [string] 'AES' or name of any other cipher
125 # $key ..... [binary string] encryption key of proper length
126 # $iv ...... [binary string] initialization vector (optional, you can set it later via iv_add method)
127  
128 =head2 iv_add
129  
130 Set initialization vector (IV). Multiple calls are concatenated to form the
131 full IV (the data is appended, not replaced). Returns the object itself.
132  
133 $ae->iv_add($iv_data); # can be called multiple times before AAD/payload
134  
135 Call C<iv_add> before the first C<adata_add>, C<encrypt_add>, or C<decrypt_add>. If you
136 reuse the object via C<reset>, provide the IV again for the new message.
137  
138 =head2 adata_add
139  
140 Add B<additional authenticated data>.
141 Can be called B<after> all C<iv_add> calls but before the first C<encrypt_add> or C<decrypt_add>.
142 Returns the object itself (for chaining).
143  
144 $ae->adata_add($aad_data); # can be called multiple times
145  
146 =head2 encrypt_add
147  
148 Returns a binary string of ciphertext (raw bytes).
149  
150 my $ciphertext = $ae->encrypt_add($data); # can be called multiple times
151  
152 =head2 encrypt_done
153  
154 Returns the authentication tag as a binary string (raw bytes).
155 This call finalizes the current message.
156  
157 my $tag = $ae->encrypt_done(); # returns $tag value
158  
159 =head2 decrypt_add
160  
161 Returns a binary string of plaintext (raw bytes).
162  
163 my $plaintext = $ae->decrypt_add($ciphertext); # can be called multiple times
164  
165 =head2 decrypt_done
166  
167 Without argument returns the computed tag as a binary string. With C<$tag> argument returns C<1> (success) or C<0> (failure).
168 This call finalizes the current message.
169  
170 my $tag = $ae->decrypt_done; # returns $tag value
171 #or
172 my $result = $ae->decrypt_done($tag); # returns 1 (success) or 0 (failure)
173  
174 Use the C<decrypt_done($tag)> form for authentication checks. The no-argument form only
175 returns the computed tag.
176  
177 =head2 reset
178  
179 $ae->reset;
180  
181 Start a new message with the same key. After C<reset>, call C<iv_add> again, then
182 C<adata_add> if needed, before processing payload data. C<reset> also clears the
183 finalized state set by C<encrypt_done> / C<decrypt_done>.
184  
185 =head2 clone
186  
187 Returns a copy of the AEAD object in its current state.
188  
189 my $ae_new = $ae->clone;
190  
191 =head1 SEE ALSO
192  
193 =over
194  
195 =item * L<CryptX>, L<Crypt::AuthEnc::CCM>, L<Crypt::AuthEnc::EAX>, L<Crypt::AuthEnc::OCB>
196  
197 =item * L<https://en.wikipedia.org/wiki/Galois/Counter_Mode>
198  
199 =item * L<https://csrc.nist.gov/pubs/sp/800/38/d/final>
200  
201 =back
202  
203 =cut
« blib/lib/Crypt/AuthEnc/ChaCha20Poly1305.pm ↑ Summary blib/lib/Crypt/Cipher.pm »