libcryptx-perl/lib/Crypt/Mode/CBC.pm

131 lines
3.1 KiB
Perl
Raw Permalink Normal View History

2018-03-22 15:51:09 +01:00
package Crypt::Mode::CBC;
### BEWARE - GENERATED FILE, DO NOT EDIT MANUALLY!
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
use Crypt::Cipher;
2018-03-22 15:54:03 +01:00
sub encrypt {
my ($self, $pt) = (shift, shift);
local $SIG{__DIE__} = \&CryptX::_croak;
$self->start_encrypt(@_)->add($pt) . $self->finish;
}
sub decrypt {
my ($self, $ct) = (shift, shift);
local $SIG{__DIE__} = \&CryptX::_croak;
$self->start_decrypt(@_)->add($ct) . $self->finish;
}
sub CLONE_SKIP { 1 } # prevent cloning
2018-03-22 15:51:09 +01:00
1;
=pod
=head1 NAME
Crypt::Mode::CBC - Block cipher mode CBC [Cipher-block chaining]
=head1 SYNOPSIS
use Crypt::Mode::CBC;
my $m = Crypt::Mode::CBC->new('AES');
#(en|de)crypt at once
my $ciphertext = $m->encrypt($plaintext, $key, $iv);
my $plaintext = $m->decrypt($ciphertext, $key, $iv);
#encrypt more chunks
$m->start_encrypt($key, $iv);
my $ciphertext = $m->add('some data');
$ciphertext .= $m->add('more data');
$ciphertext .= $m->finish;
#decrypt more chunks
$m->start_decrypt($key, $iv);
my $plaintext = $m->add($some_ciphertext);
$plaintext .= $m->add($more_ciphertext);
$plaintext .= $m->finish;
=head1 DESCRIPTION
This module implements CBC cipher mode. B<NOTE:> it works only with ciphers from L<CryptX> (Crypt::Cipher::NNNN).
=head1 METHODS
=head2 new
2018-03-22 15:54:03 +01:00
my $m = Crypt::Mode::CBC->new($name);
2018-03-22 15:51:09 +01:00
#or
2018-03-22 15:54:03 +01:00
my $m = Crypt::Mode::CBC->new($name, $padding);
2018-03-22 15:51:09 +01:00
#or
2018-03-22 15:54:03 +01:00
my $m = Crypt::Mode::CBC->new($name, $padding, $cipher_rounds);
2018-03-22 15:51:09 +01:00
2018-03-22 15:54:03 +01:00
# $name ....... one of 'AES', 'Anubis', 'Blowfish', 'CAST5', 'Camellia', 'DES', 'DES_EDE',
# 'KASUMI', 'Khazad', 'MULTI2', 'Noekeon', 'RC2', 'RC5', 'RC6',
# 'SAFERP', 'SAFER_K128', 'SAFER_K64', 'SAFER_SK128', 'SAFER_SK64',
# 'SEED', 'Skipjack', 'Twofish', 'XTEA', 'IDEA', 'Serpent'
# simply any <NAME> for which there exists Crypt::Cipher::<NAME>
2018-03-22 15:51:09 +01:00
# $padding .... 0 no padding (plaintext size has to be myltiple of block length)
# 1 PKCS5 padding, Crypt::CBC's "standard" - DEFAULT
# 2 Crypt::CBC's "oneandzeroes"
# $cipher_rounds ... optional num of rounds for given cipher
=head2 encrypt
my $ciphertext = $m->encrypt($plaintext, $key, $iv);
=head2 decrypt
my $plaintext = $m->decrypt($ciphertext, $key, $iv);
=head2 start_encrypt
2018-03-22 15:54:03 +01:00
$m->start_encrypt($key, $iv);
2018-03-22 15:51:09 +01:00
=head2 start_decrypt
2018-03-22 15:54:03 +01:00
$m->start_decrypt($key, $iv);
2018-03-22 15:51:09 +01:00
=head2 add
2018-03-22 15:54:03 +01:00
# in encrypt mode
my $plaintext = $m->add($ciphertext);
# in decrypt mode
my $ciphertext = $m->add($plaintext);
2018-03-22 15:51:09 +01:00
=head2 finish
#encrypt more chunks
$m->start_encrypt($key, $iv);
my $ciphertext = '';
$ciphertext .= $m->add('some data');
$ciphertext .= $m->add('more data');
$ciphertext .= $m->finish;
#decrypt more chunks
$m->start_decrypt($key, $iv);
my $plaintext = '';
$plaintext .= $m->add($some_ciphertext);
$plaintext .= $m->add($more_ciphertext);
$plaintext .= $m->finish;
=head1 SEE ALSO
=over
2018-03-22 15:54:03 +01:00
=item * L<CryptX|CryptX>, L<Crypt::Cipher>
2018-03-22 15:51:09 +01:00
2018-03-22 15:54:03 +01:00
=item * L<Crypt::Cipher::AES>, L<Crypt::Cipher::Blowfish>, ...
2018-03-22 15:51:09 +01:00
2018-03-22 15:54:03 +01:00
=item * L<https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation#Cipher-block_chaining_.28CBC.29>
2018-03-22 15:51:09 +01:00
=back
2018-03-22 15:54:03 +01:00
=cut