| 1 | package Crypt::Cipher::AES; | ||
| 2 | |||
| 3 | ### BEWARE - GENERATED FILE, DO NOT EDIT MANUALLY! | ||
| 4 | |||
| 5 | 4 | ▶ | use strict; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 6 | 4 | ▶ | use warnings; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 7 | 4 | our $VERSION = '0.091'; | |
| 8 | |||
| 9 | 4 | ▶ | use base qw(Crypt::Cipher); |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 10 | |||
| 11 | 35 | ▶ | sub new { |
|
Subroutine
new: called CC=1 SCAR=0.0
Pod
documented
| |||
| 12 | 35 | my ($class, @args) = @_; | |
| 13 | 35 | my $obj = Crypt::Cipher->new('AES', @args); | |
| 14 | 35 | return bless $obj, $class; | |
| 15 | } | ||
| 16 | |||
| 17 | 3 | ▶ | sub blocksize { Crypt::Cipher::blocksize('AES') } |
|
Subroutine
blocksize: called CC=1 SCAR=0.0
Pod
documented
| |||
| 18 | 3 | ▶ | sub keysize { Crypt::Cipher::keysize('AES') } |
|
Subroutine
keysize: called CC=1 SCAR=0.0
Pod
documented
| |||
| 19 | 3 | ▶ | sub max_keysize { Crypt::Cipher::max_keysize('AES') } |
|
Subroutine
max_keysize: called CC=1 SCAR=0.0
Pod
documented
| |||
| 20 | 4 | ▶ | sub min_keysize { Crypt::Cipher::min_keysize('AES') } |
|
Subroutine
min_keysize: called CC=1 SCAR=0.0
Pod
documented
| |||
| 21 | 3 | ▶ | sub default_rounds { Crypt::Cipher::default_rounds('AES') } |
|
Subroutine
default_rounds: called CC=1 SCAR=0.0
Pod
documented
| |||
| 22 | |||
| 23 | 4 | 1; | |
| 24 | |||
| 25 | =pod | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Crypt::Cipher::AES - Symmetric cipher AES (aka Rijndael), key size: 128/192/256 bits | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | ### example 1 | ||
| 34 | use Crypt::Mode::CBC; | ||
| 35 | |||
| 36 | my $key = '...'; # length must be a valid key size for this cipher | ||
| 37 | my $iv = '...'; # 16 bytes | ||
| 38 | my $cbc = Crypt::Mode::CBC->new('AES'); | ||
| 39 | my $ciphertext = $cbc->encrypt("secret data", $key, $iv); | ||
| 40 | |||
| 41 | ### example 2 (slower) | ||
| 42 | use Crypt::CBC; | ||
| 43 | use Crypt::Cipher::AES; | ||
| 44 | |||
| 45 | my $key = '...'; # length must be a valid key size for this cipher | ||
| 46 | my $iv = '...'; # 16 bytes | ||
| 47 | my $cbc = Crypt::CBC->new( -cipher=>'Cipher::AES', -key=>$key, -iv=>$iv ); | ||
| 48 | my $ciphertext = $cbc->encrypt("secret data"); | ||
| 49 | |||
| 50 | =head1 DESCRIPTION | ||
| 51 | |||
| 52 | This module implements the AES cipher. Its interface is compatible with L<Crypt::CBC>. | ||
| 53 | |||
| 54 | B<Note:> This module only implements single-block encryption and decryption. | ||
| 55 | For general data, use a block mode such as | ||
| 56 | L<Crypt::Mode::CBC>, L<Crypt::Mode::CTR>, or L<Crypt::CBC> (which is slower). | ||
| 57 | |||
| 58 | =head1 METHODS | ||
| 59 | |||
| 60 | Unless noted otherwise, assume C<$c> is an existing cipher object created via | ||
| 61 | C<new>, for example: | ||
| 62 | |||
| 63 | my $c = Crypt::Cipher::AES->new($key); | ||
| 64 | |||
| 65 | =head2 new | ||
| 66 | |||
| 67 | my $c = Crypt::Cipher::AES->new($key); | ||
| 68 | #or | ||
| 69 | my $c = Crypt::Cipher::AES->new($key, $rounds); | ||
| 70 | |||
| 71 | # $key .... [binary string] key of an accepted length (see keysize, min_keysize, max_keysize) | ||
| 72 | # $rounds . [integer] optional, number of rounds (if supported by the cipher; croaks on invalid value) | ||
| 73 | |||
| 74 | =head2 encrypt | ||
| 75 | |||
| 76 | Encrypts exactly one block of plaintext. The length of C<$plaintext> must | ||
| 77 | equal L</blocksize>; croaks otherwise. An empty string is accepted and | ||
| 78 | returned unchanged. | ||
| 79 | |||
| 80 | my $ciphertext = $c->encrypt($plaintext); | ||
| 81 | |||
| 82 | Returns the encrypted block as a binary string (raw bytes). | ||
| 83 | |||
| 84 | =head2 decrypt | ||
| 85 | |||
| 86 | Decrypts exactly one block of ciphertext. The length of C<$ciphertext> must | ||
| 87 | equal L</blocksize>; croaks otherwise. An empty string is accepted and | ||
| 88 | returned unchanged. | ||
| 89 | |||
| 90 | my $plaintext = $c->decrypt($ciphertext); | ||
| 91 | |||
| 92 | Returns the decrypted block as a binary string (raw bytes). | ||
| 93 | |||
| 94 | =head2 keysize | ||
| 95 | |||
| 96 | Just an alias for C<max_keysize>. | ||
| 97 | |||
| 98 | $c->keysize; | ||
| 99 | #or | ||
| 100 | Crypt::Cipher::AES->keysize; | ||
| 101 | #or | ||
| 102 | Crypt::Cipher::AES::keysize; | ||
| 103 | |||
| 104 | =head2 blocksize | ||
| 105 | |||
| 106 | Returns the cipher block size (in bytes). | ||
| 107 | |||
| 108 | $c->blocksize; | ||
| 109 | #or | ||
| 110 | Crypt::Cipher::AES->blocksize; | ||
| 111 | #or | ||
| 112 | Crypt::Cipher::AES::blocksize; | ||
| 113 | |||
| 114 | =head2 max_keysize | ||
| 115 | |||
| 116 | Returns the maximum key size (in bytes). | ||
| 117 | |||
| 118 | $c->max_keysize; | ||
| 119 | #or | ||
| 120 | Crypt::Cipher::AES->max_keysize; | ||
| 121 | #or | ||
| 122 | Crypt::Cipher::AES::max_keysize; | ||
| 123 | |||
| 124 | =head2 min_keysize | ||
| 125 | |||
| 126 | Returns the minimum key size (in bytes). | ||
| 127 | |||
| 128 | $c->min_keysize; | ||
| 129 | #or | ||
| 130 | Crypt::Cipher::AES->min_keysize; | ||
| 131 | #or | ||
| 132 | Crypt::Cipher::AES::min_keysize; | ||
| 133 | |||
| 134 | =head2 default_rounds | ||
| 135 | |||
| 136 | Returns the cipher's default round count. | ||
| 137 | |||
| 138 | $c->default_rounds; | ||
| 139 | #or | ||
| 140 | Crypt::Cipher::AES->default_rounds; | ||
| 141 | #or | ||
| 142 | Crypt::Cipher::AES::default_rounds; | ||
| 143 | |||
| 144 | =head1 SEE ALSO | ||
| 145 | |||
| 146 | =over | ||
| 147 | |||
| 148 | =item * L<CryptX>, L<Crypt::Cipher> | ||
| 149 | |||
| 150 | =item * L<https://en.wikipedia.org/wiki/Advanced_Encryption_Standard> | ||
| 151 | |||
| 152 | =back | ||
| 153 | |||
| 154 | =cut | ||