Botan 3.8.1
Crypto and TLS for C&
Botan::BlockCipher Class Referenceabstract

#include <block_cipher.h>

Inheritance diagram for Botan::BlockCipher:
Botan::SymmetricAlgorithm Botan::Block_Cipher_Fixed_Params< 16, 16 > Botan::Block_Cipher_Fixed_Params< 16, 24 > Botan::Block_Cipher_Fixed_Params< 16, 32 > Botan::Block_Cipher_Fixed_Params< 8, 1, 56 > Botan::Block_Cipher_Fixed_Params< 8, 11, 16 > Botan::Block_Cipher_Fixed_Params< 8, 8 > Botan::Block_Cipher_Fixed_Params< 8, 32 > Botan::Block_Cipher_Fixed_Params< 8, 16 > Botan::Block_Cipher_Fixed_Params< 32, 16, 64, 4 > Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 > Botan::Block_Cipher_Fixed_Params< 8, 16, 24, 8 > Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD, BaseClass > Botan::Cascade_Cipher Botan::Lion Botan::Tweakable_Block_Cipher

Public Member Functions

virtual size_t block_size () const =0
 
virtual void clear ()=0
 
BlockCipherclone () const
 
void decrypt (const uint8_t in[], uint8_t out[]) const
 
void decrypt (std::span< const uint8_t > in, std::span< uint8_t > out) const
 
void decrypt (std::span< uint8_t > block) const
 
void decrypt (uint8_t block[]) const
 
virtual void decrypt_n (const uint8_t in[], uint8_t out[], size_t blocks) const =0
 
void decrypt_n_xex (uint8_t data[], const uint8_t mask[], size_t blocks) const
 
void encrypt (const uint8_t in[], uint8_t out[]) const
 
void encrypt (std::span< const uint8_t > in, std::span< uint8_t > out) const
 
void encrypt (std::span< uint8_t > block) const
 
void encrypt (uint8_t block[]) const
 
virtual void encrypt_n (const uint8_t in[], uint8_t out[], size_t blocks) const =0
 
void encrypt_n_xex (uint8_t data[], const uint8_t mask[], size_t blocks) const
 
virtual bool has_keying_material () const =0
 
virtual Key_Length_Specification key_spec () const =0
 
size_t maximum_keylength () const
 
size_t minimum_keylength () const
 
virtual std::string name () const =0
 
virtual std::unique_ptr< BlockCiphernew_object () const =0
 
size_t parallel_bytes () const
 
virtual size_t parallelism () const
 
virtual std::string provider () const
 
void set_key (const OctetString &key)
 
void set_key (const uint8_t key[], size_t length)
 
void set_key (std::span< const uint8_t > key)
 
bool valid_keylength (size_t length) const
 
 ~BlockCipher () override=default
 

Static Public Member Functions

static std::unique_ptr< BlockCiphercreate (std::string_view algo_spec, std::string_view provider="")
 
static std::unique_ptr< BlockCiphercreate_or_throw (std::string_view algo_spec, std::string_view provider="")
 
static std::vector< std::string > providers (std::string_view algo_spec)
 

Static Public Attributes

static constexpr size_t ParallelismMult = 4
 

Protected Member Functions

void assert_key_material_set () const
 
void assert_key_material_set (bool predicate) const
 

Detailed Description

This class represents a block cipher object.

Definition at line 22 of file block_cipher.h.

Constructor & Destructor Documentation

◆ ~BlockCipher()

Botan::BlockCipher::~BlockCipher ( )
overridedefault

Member Function Documentation

◆ assert_key_material_set() [1/2]

◆ assert_key_material_set() [2/2]

void Botan::SymmetricAlgorithm::assert_key_material_set ( bool predicate) const
inlineprotectedinherited

Definition at line 143 of file sym_algo.h.

143 {
144 if(!predicate) {
145 throw_key_not_set_error();
146 }
147 }

◆ block_size()

◆ clear()

◆ clone()

BlockCipher * Botan::BlockCipher::clone ( ) const
inline

Definition at line 188 of file block_cipher.h.

188{ return this->new_object().release(); }
virtual std::unique_ptr< BlockCipher > new_object() const =0

References new_object().

◆ create()

std::unique_ptr< BlockCipher > Botan::BlockCipher::create ( std::string_view algo_spec,
std::string_view provider = "" )
static

Create an instance based on a name If provider is empty then best available is chosen.

Parameters
algo_specalgorithm name
providerprovider implementation to choose
Returns
a null pointer if the algo/provider combination cannot be found

Definition at line 92 of file block_cipher.cpp.

92 {
93#if defined(BOTAN_HAS_COMMONCRYPTO)
94 if(provider.empty() || provider == "commoncrypto") {
95 if(auto bc = make_commoncrypto_block_cipher(algo))
96 return bc;
97
98 if(!provider.empty())
99 return nullptr;
100 }
101#endif
102
103 // TODO: CryptoAPI
104 // TODO: /dev/crypto
105
106 // Only base providers from here on out
107 if(provider.empty() == false && provider != "base") {
108 return nullptr;
109 }
110
111#if defined(BOTAN_HAS_AES)
112 if(algo == "AES-128") {
113 return std::make_unique<AES_128>();
114 }
115
116 if(algo == "AES-192") {
117 return std::make_unique<AES_192>();
118 }
119
120 if(algo == "AES-256") {
121 return std::make_unique<AES_256>();
122 }
123#endif
124
125#if defined(BOTAN_HAS_ARIA)
126 if(algo == "ARIA-128") {
127 return std::make_unique<ARIA_128>();
128 }
129
130 if(algo == "ARIA-192") {
131 return std::make_unique<ARIA_192>();
132 }
133
134 if(algo == "ARIA-256") {
135 return std::make_unique<ARIA_256>();
136 }
137#endif
138
139#if defined(BOTAN_HAS_SERPENT)
140 if(algo == "Serpent") {
141 return std::make_unique<Serpent>();
142 }
143#endif
144
145#if defined(BOTAN_HAS_SHACAL2)
146 if(algo == "SHACAL2") {
147 return std::make_unique<SHACAL2>();
148 }
149#endif
150
151#if defined(BOTAN_HAS_TWOFISH)
152 if(algo == "Twofish") {
153 return std::make_unique<Twofish>();
154 }
155#endif
156
157#if defined(BOTAN_HAS_THREEFISH_512)
158 if(algo == "Threefish-512") {
159 return std::make_unique<Threefish_512>();
160 }
161#endif
162
163#if defined(BOTAN_HAS_BLOWFISH)
164 if(algo == "Blowfish") {
165 return std::make_unique<Blowfish>();
166 }
167#endif
168
169#if defined(BOTAN_HAS_CAMELLIA)
170 if(algo == "Camellia-128") {
171 return std::make_unique<Camellia_128>();
172 }
173
174 if(algo == "Camellia-192") {
175 return std::make_unique<Camellia_192>();
176 }
177
178 if(algo == "Camellia-256") {
179 return std::make_unique<Camellia_256>();
180 }
181#endif
182
183#if defined(BOTAN_HAS_DES)
184 if(algo == "DES") {
185 return std::make_unique<DES>();
186 }
187
188 if(algo == "TripleDES" || algo == "3DES" || algo == "DES-EDE") {
189 return std::make_unique<TripleDES>();
190 }
191#endif
192
193#if defined(BOTAN_HAS_NOEKEON)
194 if(algo == "Noekeon") {
195 return std::make_unique<Noekeon>();
196 }
197#endif
198
199#if defined(BOTAN_HAS_CAST_128)
200 if(algo == "CAST-128" || algo == "CAST5") {
201 return std::make_unique<CAST_128>();
202 }
203#endif
204
205#if defined(BOTAN_HAS_IDEA)
206 if(algo == "IDEA") {
207 return std::make_unique<IDEA>();
208 }
209#endif
210
211#if defined(BOTAN_HAS_KUZNYECHIK)
212 if(algo == "Kuznyechik") {
213 return std::make_unique<Kuznyechik>();
214 }
215#endif
216
217#if defined(BOTAN_HAS_SEED)
218 if(algo == "SEED") {
219 return std::make_unique<SEED>();
220 }
221#endif
222
223#if defined(BOTAN_HAS_SM4)
224 if(algo == "SM4") {
225 return std::make_unique<SM4>();
226 }
227#endif
228
229 const SCAN_Name req(algo);
230
231#if defined(BOTAN_HAS_GOST_28147_89)
232 if(req.algo_name() == "GOST-28147-89") {
233 return std::make_unique<GOST_28147_89>(req.arg(0, "R3411_94_TestParam"));
234 }
235#endif
236
237#if defined(BOTAN_HAS_CASCADE)
238 if(req.algo_name() == "Cascade" && req.arg_count() == 2) {
239 auto c1 = BlockCipher::create(req.arg(0));
240 auto c2 = BlockCipher::create(req.arg(1));
241
242 if(c1 && c2) {
243 return std::make_unique<Cascade_Cipher>(std::move(c1), std::move(c2));
244 }
245 }
246#endif
247
248#if defined(BOTAN_HAS_LION)
249 if(req.algo_name() == "Lion" && req.arg_count_between(2, 3)) {
250 auto hash = HashFunction::create(req.arg(0));
251 auto stream = StreamCipher::create(req.arg(1));
252
253 if(hash && stream) {
254 const size_t block_size = req.arg_as_integer(2, 1024);
255 return std::make_unique<Lion>(std::move(hash), std::move(stream), block_size);
256 }
257 }
258#endif
259
260 BOTAN_UNUSED(req);
262
263 return nullptr;
264}
#define BOTAN_UNUSED
Definition assert.h:120
static std::unique_ptr< BlockCipher > create(std::string_view algo_spec, std::string_view provider="")
virtual size_t block_size() const =0
virtual std::string provider() const
static std::unique_ptr< HashFunction > create(std::string_view algo_spec, std::string_view provider="")
Definition hash.cpp:107
static std::unique_ptr< StreamCipher > create(std::string_view algo_spec, std::string_view provider="")
std::unique_ptr< BlockCipher > make_commoncrypto_block_cipher(std::string_view name)

References Botan::SCAN_Name::algo_name(), Botan::SCAN_Name::arg(), Botan::SCAN_Name::arg_as_integer(), Botan::SCAN_Name::arg_count(), Botan::SCAN_Name::arg_count_between(), block_size(), BOTAN_UNUSED, create(), Botan::HashFunction::create(), Botan::StreamCipher::create(), Botan::make_commoncrypto_block_cipher(), and provider().

Referenced by botan_block_cipher_init(), Botan::AEAD_Mode::create(), create(), Botan::Cipher_Mode::create(), Botan::MessageAuthenticationCode::create(), Botan::StreamCipher::create(), and create_or_throw().

◆ create_or_throw()

std::unique_ptr< BlockCipher > Botan::BlockCipher::create_or_throw ( std::string_view algo_spec,
std::string_view provider = "" )
static

Create an instance based on a name, or throw if the algo/provider combination cannot be found. If provider is empty then best available is chosen.

Definition at line 267 of file block_cipher.cpp.

267 {
268 if(auto bc = BlockCipher::create(algo, provider)) {
269 return bc;
270 }
271 throw Lookup_Error("Block cipher", algo, provider);
272}

References create(), and provider().

Referenced by botan_nist_kw_dec(), botan_nist_kw_enc(), Botan::TLS::Connection_Cipher_State::Connection_Cipher_State(), Botan::Encrypted_PSK_Database::Encrypted_PSK_Database(), Botan::rfc3394_keyunwrap(), and Botan::rfc3394_keywrap().

◆ decrypt() [1/4]

void Botan::BlockCipher::decrypt ( const uint8_t in[],
uint8_t out[] ) const
inline

Decrypt a block.

Parameters
inThe ciphertext block to be decypted as a byte array. Must be of length block_size().
outThe byte array designated to hold the decrypted block. Must be of length block_size().

Definition at line 91 of file block_cipher.h.

91{ decrypt_n(in, out, 1); }
virtual void decrypt_n(const uint8_t in[], uint8_t out[], size_t blocks) const =0

References decrypt_n().

Referenced by Botan::nist_key_unwrap(), and Botan::nist_key_unwrap_padded().

◆ decrypt() [2/4]

void Botan::BlockCipher::decrypt ( std::span< const uint8_t > in,
std::span< uint8_t > out ) const
inline

Decrypt one or more blocks

Parameters
inthe input buffer (multiple of block_size())
outthe output buffer (same size as in)

Definition at line 139 of file block_cipher.h.

139 {
140 return decrypt_n(in.data(), out.data(), in.size() / block_size());
141 }

References block_size(), and decrypt_n().

◆ decrypt() [3/4]

void Botan::BlockCipher::decrypt ( std::span< uint8_t > block) const
inline

Decrypt one or more blocks

Parameters
blockthe input/output buffer (multiple of block_size())

Definition at line 121 of file block_cipher.h.

121 {
122 return decrypt_n(block.data(), block.data(), block.size() / block_size());
123 }

References block_size(), and decrypt_n().

◆ decrypt() [4/4]

void Botan::BlockCipher::decrypt ( uint8_t block[]) const
inline

Decrypt a block.

Parameters
blockthe ciphertext block to be decrypted Must be of length block_size(). Will hold the result when the function has finished.

Definition at line 107 of file block_cipher.h.

107{ decrypt_n(block, block, 1); }

References decrypt_n().

◆ decrypt_n()

virtual void Botan::BlockCipher::decrypt_n ( const uint8_t in[],
uint8_t out[],
size_t blocks ) const
pure virtual

◆ decrypt_n_xex()

void Botan::BlockCipher::decrypt_n_xex ( uint8_t data[],
const uint8_t mask[],
size_t blocks ) const
inline

Definition at line 172 of file block_cipher.h.

172 {
173 const size_t BS = block_size();
174 for(size_t i = 0; i != blocks * BS; ++i) {
175 data[i] ^= mask[i];
176 }
177 decrypt_n(data, data, blocks);
178 for(size_t i = 0; i != blocks * BS; ++i) {
179 data[i] ^= mask[i];
180 }
181 }

References block_size(), decrypt_n(), and decrypt_n_xex().

Referenced by decrypt_n_xex().

◆ encrypt() [1/4]

void Botan::BlockCipher::encrypt ( const uint8_t in[],
uint8_t out[] ) const
inline

Encrypt a block.

Parameters
inThe plaintext block to be encrypted as a byte array. Must be of length block_size().
outThe byte array designated to hold the encrypted block. Must be of length block_size().

Definition at line 82 of file block_cipher.h.

82{ encrypt_n(in, out, 1); }
virtual void encrypt_n(const uint8_t in[], uint8_t out[], size_t blocks) const =0

References encrypt_n().

Referenced by Botan::nist_key_wrap(), Botan::nist_key_wrap_padded(), and Botan::CFB_Mode::shift_register().

◆ encrypt() [2/4]

void Botan::BlockCipher::encrypt ( std::span< const uint8_t > in,
std::span< uint8_t > out ) const
inline

Encrypt one or more blocks

Parameters
inthe input buffer (multiple of block_size())
outthe output buffer (same size as in)

Definition at line 130 of file block_cipher.h.

130 {
131 return encrypt_n(in.data(), out.data(), in.size() / block_size());
132 }

References block_size(), and encrypt_n().

◆ encrypt() [3/4]

void Botan::BlockCipher::encrypt ( std::span< uint8_t > block) const
inline

Encrypt one or more blocks

Parameters
blockthe input/output buffer (multiple of block_size())

Definition at line 113 of file block_cipher.h.

113 {
114 return encrypt_n(block.data(), block.data(), block.size() / block_size());
115 }

References block_size(), and encrypt_n().

◆ encrypt() [4/4]

void Botan::BlockCipher::encrypt ( uint8_t block[]) const
inline

Encrypt a block.

Parameters
blockthe plaintext block to be encrypted Must be of length block_size(). Will hold the result when the function has finished.

Definition at line 99 of file block_cipher.h.

99{ encrypt_n(block, block, 1); }

References encrypt_n().

◆ encrypt_n()

virtual void Botan::BlockCipher::encrypt_n ( const uint8_t in[],
uint8_t out[],
size_t blocks ) const
pure virtual

◆ encrypt_n_xex()

void Botan::BlockCipher::encrypt_n_xex ( uint8_t data[],
const uint8_t mask[],
size_t blocks ) const
inline

Definition at line 160 of file block_cipher.h.

160 {
161 const size_t BS = block_size();
162 for(size_t i = 0; i != blocks * BS; ++i) {
163 data[i] ^= mask[i];
164 }
165 encrypt_n(data, data, blocks);
166 for(size_t i = 0; i != blocks * BS; ++i) {
167 data[i] ^= mask[i];
168 }
169 }

References block_size(), encrypt_n(), and encrypt_n_xex().

Referenced by encrypt_n_xex().

◆ has_keying_material()

◆ key_spec()

◆ maximum_keylength()

size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const
inlineinherited
Returns
maximum allowed key length

Definition at line 97 of file sym_algo.h.

97{ return key_spec().maximum_keylength(); }
size_t maximum_keylength() const
Definition sym_algo.h:56
virtual Key_Length_Specification key_spec() const =0

References key_spec().

◆ minimum_keylength()

size_t Botan::SymmetricAlgorithm::minimum_keylength ( ) const
inlineinherited
Returns
minimum allowed key length

Definition at line 102 of file sym_algo.h.

102{ return key_spec().minimum_keylength(); }
size_t minimum_keylength() const
Definition sym_algo.h:51

References key_spec().

◆ name()

◆ new_object()

◆ parallel_bytes()

size_t Botan::BlockCipher::parallel_bytes ( ) const
inline
Returns
prefererred parallelism of this cipher in bytes

Definition at line 67 of file block_cipher.h.

static constexpr size_t ParallelismMult
virtual size_t parallelism() const

References block_size(), parallelism(), and ParallelismMult.

Referenced by Botan::CBC_Mode::ideal_granularity().

◆ parallelism()

virtual size_t Botan::BlockCipher::parallelism ( ) const
inlinevirtual
Returns
native parallelism of this cipher in blocks

Reimplemented in Botan::AES_128, Botan::AES_192, Botan::AES_256, Botan::IDEA, Botan::Noekeon, Botan::Serpent, Botan::SHACAL2, and Botan::SM4.

Definition at line 62 of file block_cipher.h.

62{ return 1; }

Referenced by parallel_bytes().

◆ provider()

virtual std::string Botan::BlockCipher::provider ( ) const
inlinevirtual
Returns
provider information about this implementation. Default is "base", might also return "sse2", "avx2", "openssl", or some other arbitrary string.

Reimplemented in Botan::AES_128, Botan::AES_192, Botan::AES_256, Botan::IDEA, Botan::Noekeon, Botan::Serpent, Botan::SHACAL2, and Botan::SM4.

Definition at line 73 of file block_cipher.h.

73{ return "base"; }

Referenced by create(), and create_or_throw().

◆ providers()

std::vector< std::string > Botan::BlockCipher::providers ( std::string_view algo_spec)
static
Returns
list of available providers for this algorithm, empty if not available
Parameters
algo_specalgorithm name

Definition at line 274 of file block_cipher.cpp.

274 {
275 return probe_providers_of<BlockCipher>(algo, {"base", "commoncrypto"});
276}
std::vector< std::string > probe_providers_of(std::string_view algo_spec, const std::vector< std::string > &possible={"base"})
Definition scan_name.h:105

References Botan::probe_providers_of().

◆ set_key() [1/3]

◆ set_key() [2/3]

void Botan::SymmetricAlgorithm::set_key ( const uint8_t key[],
size_t length )
inlineinherited

Set the symmetric key of this object.

Parameters
keythe to be set as a byte array.
lengthin bytes of key param

Definition at line 128 of file sym_algo.h.

128{ set_key(std::span{key, length}); }

References set_key().

Referenced by set_key().

◆ set_key() [3/3]

void Botan::SymmetricAlgorithm::set_key ( std::span< const uint8_t > key)
inherited

Set the symmetric key of this object.

Parameters
keythe contiguous byte range to be set.

Definition at line 22 of file sym_algo.cpp.

22 {
23 if(!valid_keylength(key.size())) {
24 throw Invalid_Key_Length(name(), key.size());
25 }
26 key_schedule(key);
27}
bool valid_keylength(size_t length) const
Definition sym_algo.h:109
virtual std::string name() const =0

References name(), and valid_keylength().

◆ valid_keylength()

bool Botan::SymmetricAlgorithm::valid_keylength ( size_t length) const
inlineinherited

Check whether a given key length is valid for this algorithm.

Parameters
lengththe key length to be checked.
Returns
true if the key length is valid.

Definition at line 109 of file sym_algo.h.

109{ return key_spec().valid_keylength(length); }
bool valid_keylength(size_t length) const
Definition sym_algo.h:44

References key_spec().

Referenced by set_key().

Member Data Documentation

◆ ParallelismMult

size_t Botan::BlockCipher::ParallelismMult = 4
staticconstexpr

Multiplier on a block cipher's native parallelism

Usually notable performance gains come from further loop blocking, at least for 2 or 4x

Definition at line 52 of file block_cipher.h.

Referenced by Botan::GCM_Mode::ideal_granularity(), and parallel_bytes().


The documentation for this class was generated from the following files: