Botan 3.1.1
Crypto and TLS for C&
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
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
 
virtual 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
 
virtual 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 SymmetricKey &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
 
virtual ~BlockCipher ()=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)
 

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()

virtual Botan::BlockCipher::~BlockCipher ( )
virtualdefault

Member Function Documentation

◆ assert_key_material_set() [1/2]

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

Definition at line 139 of file sym_algo.h.

virtual bool has_keying_material() const =0
void assert_key_material_set() const
Definition: sym_algo.h:139

References Botan::SymmetricAlgorithm::assert_key_material_set().

Referenced by Botan::SymmetricAlgorithm::assert_key_material_set(), Botan::Salsa20::cipher_bytes(), Botan::AES_128::decrypt_n(), Botan::AES_192::decrypt_n(), Botan::AES_256::decrypt_n(), Botan::ARIA_128::decrypt_n(), Botan::ARIA_192::decrypt_n(), Botan::ARIA_256::decrypt_n(), Botan::Blowfish::decrypt_n(), Botan::Camellia_128::decrypt_n(), Botan::Camellia_192::decrypt_n(), Botan::Camellia_256::decrypt_n(), Botan::CAST_128::decrypt_n(), Botan::DES::decrypt_n(), Botan::TripleDES::decrypt_n(), Botan::GOST_28147_89::decrypt_n(), Botan::IDEA::decrypt_n(), Botan::Lion::decrypt_n(), Botan::Noekeon::decrypt_n(), Botan::SEED::decrypt_n(), Botan::Serpent::decrypt_n(), Botan::SHACAL2::decrypt_n(), Botan::SM4::decrypt_n(), Botan::Threefish_512::decrypt_n(), Botan::Twofish::decrypt_n(), Botan::AES_128::encrypt_n(), Botan::AES_192::encrypt_n(), Botan::AES_256::encrypt_n(), Botan::ARIA_128::encrypt_n(), Botan::ARIA_192::encrypt_n(), Botan::ARIA_256::encrypt_n(), Botan::Blowfish::encrypt_n(), Botan::Camellia_128::encrypt_n(), Botan::Camellia_192::encrypt_n(), Botan::Camellia_256::encrypt_n(), Botan::CAST_128::encrypt_n(), Botan::DES::encrypt_n(), Botan::TripleDES::encrypt_n(), Botan::GOST_28147_89::encrypt_n(), Botan::IDEA::encrypt_n(), Botan::Lion::encrypt_n(), Botan::Noekeon::encrypt_n(), Botan::SEED::encrypt_n(), Botan::Serpent::encrypt_n(), Botan::SHACAL2::encrypt_n(), Botan::SM4::encrypt_n(), Botan::Threefish_512::encrypt_n(), Botan::Twofish::encrypt_n(), Botan::GHASH::final(), Botan::GHASH::ghash_update(), Botan::ChaCha::seek(), Botan::CTR_BE::seek(), Botan::Salsa20::seek(), Botan::OCB_Mode::set_associated_data_n(), Botan::Salsa20::set_iv_bytes(), Botan::GHASH::update(), and Botan::GHASH::update_associated_data().

◆ assert_key_material_set() [2/2]

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

Definition at line 141 of file sym_algo.h.

141 {
142 if(!predicate)
143 throw_key_not_set_error();
144 }

◆ block_size()

virtual size_t Botan::BlockCipher::block_size ( ) const
pure virtual

◆ clear()

virtual void Botan::SymmetricAlgorithm::clear ( )
pure virtualinherited

◆ clone()

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

Definition at line 170 of file block_cipher.h.

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

◆ 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 87 of file block_cipher.cpp.

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

256 {
257 if(auto bc = BlockCipher::create(algo, provider)) {
258 return bc;
259 }
260 throw Lookup_Error("Block cipher", algo, provider);
261}

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 83 of file block_cipher.h.

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

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 131 of file block_cipher.h.

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

◆ 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 113 of file block_cipher.h.

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

◆ 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 99 of file block_cipher.h.

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

◆ decrypt_n()

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

◆ decrypt_n_xex()

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

◆ 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 74 of file block_cipher.h.

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

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 122 of file block_cipher.h.

122 {
123 return encrypt_n(in.data(), out.data(), in.size() / block_size());
124 }

◆ 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 105 of file block_cipher.h.

105 {
106 return encrypt_n(block.data(), block.data(), block.size() / block_size());
107 }

◆ 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 91 of file block_cipher.h.

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

◆ encrypt_n()

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

◆ encrypt_n_xex()

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

◆ has_keying_material()

virtual bool Botan::SymmetricAlgorithm::has_keying_material ( ) const
pure virtualinherited

◆ key_spec()

virtual Key_Length_Specification Botan::SymmetricAlgorithm::key_spec ( ) const
pure virtualinherited

◆ maximum_keylength()

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

Definition at line 95 of file sym_algo.h.

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

◆ minimum_keylength()

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

Definition at line 100 of file sym_algo.h.

100{ return key_spec().minimum_keylength(); }
size_t minimum_keylength() const
Definition: sym_algo.h:49

◆ name()

virtual std::string Botan::SymmetricAlgorithm::name ( ) const
pure virtualinherited

◆ new_object()

virtual std::unique_ptr< BlockCipher > Botan::BlockCipher::new_object ( ) const
pure virtual

◆ parallel_bytes()

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

Definition at line 59 of file block_cipher.h.

virtual size_t parallelism() const
Definition: block_cipher.h:54
#define BOTAN_BLOCK_CIPHER_PAR_MULT
Definition: build.h:429

References BOTAN_BLOCK_CIPHER_PAR_MULT.

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 54 of file block_cipher.h.

54{ return 1; }

◆ 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 65 of file block_cipher.h.

65{ 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 263 of file block_cipher.cpp.

263 {
264 return probe_providers_of<BlockCipher>(algo, {"base", "commoncrypto"});
265}

◆ set_key() [1/3]

void Botan::SymmetricAlgorithm::set_key ( const SymmetricKey key)
inlineinherited

◆ set_key() [2/3]

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

Set the symmetric key of this object.

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

Definition at line 17 of file sym_algo.cpp.

17 {
18 if(!valid_keylength(length)) {
19 throw Invalid_Key_Length(name(), length);
20 }
21 key_schedule(key, length);
22}
bool valid_keylength(size_t length) const
Definition: sym_algo.h:107
virtual std::string name() const =0

References Botan::SymmetricAlgorithm::name(), and Botan::SymmetricAlgorithm::valid_keylength().

◆ set_key() [3/3]

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

Set the symmetric key of this object.

Parameters
keythe contiguous byte range to be set.

Definition at line 119 of file sym_algo.h.

119{ set_key(key.data(), key.size()); }

References Botan::SymmetricAlgorithm::set_key().

Referenced by Botan::SymmetricAlgorithm::set_key().

◆ 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 107 of file sym_algo.h.

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

Referenced by Botan::SymmetricAlgorithm::set_key().


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