Botan 3.10.0
Crypto and TLS for C&
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
Botan::Kuznyechik Class Referencefinal

#include <kuznyechik.h>

Inheritance diagram for Botan::Kuznyechik:
Botan::Block_Cipher_Fixed_Params< 16, 32 > Botan::BlockCipher Botan::SymmetricAlgorithm

Public Types

enum  

Public Member Functions

size_t block_size () const final
void clear () override
BlockCipher * clone () const
BlockCipher * clone () 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
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
void decrypt_n (const uint8_t in[], uint8_t out[], size_t blocks) const override
void decrypt_n_xex (uint8_t data[], const uint8_t mask[], size_t blocks) const
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
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
void encrypt_n (const uint8_t in[], uint8_t out[], size_t blocks) const override
void encrypt_n_xex (uint8_t data[], const uint8_t mask[], size_t blocks) const
void encrypt_n_xex (uint8_t data[], const uint8_t mask[], size_t blocks) const
bool has_keying_material () const override
Key_Length_Specification key_spec () const final
size_t maximum_keylength () const
size_t maximum_keylength () const
size_t minimum_keylength () const
size_t minimum_keylength () const
std::string name () const override
std::unique_ptr< BlockCipher > new_object () const override
size_t parallel_bytes () const
size_t parallel_bytes () const
virtual size_t parallelism () const
virtual size_t parallelism () const
virtual std::string provider () 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)
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
bool valid_keylength (size_t length) const

Static Public Member Functions

static std::unique_ptr< BlockCipher > create (std::string_view algo_spec, std::string_view provider="")
static std::unique_ptr< BlockCipher > create (std::string_view algo_spec, std::string_view provider="")
static std::unique_ptr< BlockCipher > create_or_throw (std::string_view algo_spec, std::string_view provider="")
static std::unique_ptr< BlockCipher > create_or_throw (std::string_view algo_spec, std::string_view provider="")
static std::vector< std::string > providers (std::string_view algo_spec)
static std::vector< std::string > providers (std::string_view algo_spec)

Static Public Attributes

static constexpr size_t ParallelismMult
static constexpr size_t ParallelismMult = 4

Protected Member Functions

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

Detailed Description

Kuznyechik

Definition at line 20 of file kuznyechik.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited

Definition at line 212 of file block_cipher.h.

212{ BLOCK_SIZE = BS }; /* NOLINT(*-enum-size,*-use-enum-class) */
Botan::Block_Cipher_Fixed_Params
Definition block_cipher.h:210

Member Function Documentation

◆ assert_key_material_set() [1/4]

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

Definition at line 146 of file sym_algo.h.

146{ assert_key_material_set(has_keying_material()); }
Botan::Block_Cipher_Fixed_Params< 16, 32 >::has_keying_material
virtual bool has_keying_material() const=0

Referenced by Botan::AES_256::decrypt_n(), Botan::ARIA_256::decrypt_n(), Botan::Camellia_256::decrypt_n(), Botan::Kuznyechik::decrypt_n(), Botan::AES_256::encrypt_n(), Botan::ARIA_256::encrypt_n(), Botan::Camellia_256::encrypt_n(), and Botan::Kuznyechik::encrypt_n().

◆ assert_key_material_set() [2/4]

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

Definition at line 148 of file sym_algo.h.

148 {
149 if(!predicate) {
150 throw_key_not_set_error();
151 }
152 }

◆ assert_key_material_set() [3/4]

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

Definition at line 146 of file sym_algo.h.

146{ assert_key_material_set(has_keying_material()); }

References assert_key_material_set(), and has_keying_material().

Referenced by assert_key_material_set(), Botan::Salsa20::cipher_bytes(), Botan::Lion::decrypt_n(), Botan::Lion::encrypt_n(), Botan::GHASH::final(), Botan::GHASH::nonce_hash(), Botan::ChaCha::seek(), Botan::CTR_BE::seek(), Botan::Salsa20::seek(), Botan::GHASH::set_associated_data(), 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() [4/4]

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

Definition at line 148 of file sym_algo.h.

148 {
149 if(!predicate) {
150 throw_key_not_set_error();
151 }
152 }

◆ block_size()

size_t Botan::Block_Cipher_Fixed_Params< BS, KMIN, 0, 1, BlockCipher >::block_size ( ) const
inlinefinalvirtualinherited
Returns
block size of this algorithm

Implements Botan::BlockCipher.

Definition at line 214 of file block_cipher.h.

214{ return BS; }

◆ clear()

void Botan::Kuznyechik::clear ( )
overridevirtual

Reset the internal state. This includes not just the key, but any partial message that may have been in process.

Implements Botan::SymmetricAlgorithm.

Definition at line 218 of file kuznyechik.cpp.

218 {
219 zap(m_rke);
220 zap(m_rkd);
221}
Botan::zap
void zap(std::vector< T, Alloc > &vec)
Definition secmem.h:134

References Botan::zap().

◆ clone() [1/2]

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

Definition at line 188 of file block_cipher.h.

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

◆ clone() [2/2]

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

Definition at line 188 of file block_cipher.h.

188{ return this->new_object().release(); }

References new_object().

◆ create() [1/2]

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

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

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

◆ create() [2/2]

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

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

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

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() [1/2]

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

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

271 {
272 if(auto bc = BlockCipher::create(algo, provider)) {
273 return bc;
274 }
275 throw Lookup_Error("Block cipher", algo, provider);
276}

◆ create_or_throw() [2/2]

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

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

271 {
272 if(auto bc = BlockCipher::create(algo, provider)) {
273 return bc;
274 }
275 throw Lookup_Error("Block cipher", algo, provider);
276}

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/8]

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

Decrypt a block.

Parameters
inThe ciphertext block to be decrypted 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); }
Botan::Block_Cipher_Fixed_Params< 16, 32 >::decrypt_n
virtual void decrypt_n(const uint8_t in[], uint8_t out[], size_t blocks) const=0

◆ decrypt() [2/8]

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

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 }

◆ decrypt() [3/8]

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

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 }

◆ decrypt() [4/8]

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

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); }

◆ decrypt() [5/8]

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

Decrypt a block.

Parameters
inThe ciphertext block to be decrypted 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); }

References decrypt_n().

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

◆ decrypt() [6/8]

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

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() [7/8]

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

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() [8/8]

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

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

void Botan::Kuznyechik::decrypt_n ( const uint8_t in[],
uint8_t out[],
size_t blocks ) const
overridevirtual

Decrypt one or more blocks

Parameters
inthe input buffer (multiple of block_size())
outthe output buffer (same size as in)
blocksthe number of blocks to process

Implements Botan::BlockCipher.

Definition at line 339 of file kuznyechik.cpp.

339 {
340 assert_key_material_set();
341 while(blocks > 0) {
342 uint64_t x1 = load_le<uint64_t>(in, 0);
343 uint64_t x2 = load_le<uint64_t>(in, 1);
344
345 Kuznyechik_F::ILSS(x1, x2);
346
347 x1 ^= m_rkd[0];
348 x2 ^= m_rkd[1];
349 Kuznyechik_F::ILS(x1, x2);
350
351 x1 ^= m_rkd[2];
352 x2 ^= m_rkd[3];
353 Kuznyechik_F::ILS(x1, x2);
354
355 x1 ^= m_rkd[4];
356 x2 ^= m_rkd[5];
357 Kuznyechik_F::ILS(x1, x2);
358
359 x1 ^= m_rkd[6];
360 x2 ^= m_rkd[7];
361 Kuznyechik_F::ILS(x1, x2);
362
363 x1 ^= m_rkd[8];
364 x2 ^= m_rkd[9];
365 Kuznyechik_F::ILS(x1, x2);
366
367 x1 ^= m_rkd[10];
368 x2 ^= m_rkd[11];
369 Kuznyechik_F::ILS(x1, x2);
370
371 x1 ^= m_rkd[12];
372 x2 ^= m_rkd[13];
373 Kuznyechik_F::ILS(x1, x2);
374
375 x1 ^= m_rkd[14];
376 x2 ^= m_rkd[15];
377 Kuznyechik_F::ILS(x1, x2);
378
379 x1 ^= m_rkd[16];
380 x2 ^= m_rkd[17];
381 x1 = Kuznyechik_F::ISI(x1);
382 x2 = Kuznyechik_F::ISI(x2);
383
384 x1 ^= m_rkd[18];
385 x2 ^= m_rkd[19];
386
387 store_le(out, x1, x2);
388
389 in += 16;
390 out += 16;
391 blocks--;
392 }
393}
Botan::store_le
constexpr auto store_le(ParamTs &&... params)
Definition loadstor.h:736
Botan::load_le
constexpr auto load_le(ParamTs &&... params)
Definition loadstor.h:495

References Botan::Block_Cipher_Fixed_Params< 16, 32 >::assert_key_material_set(), Botan::load_le(), and Botan::store_le().

◆ decrypt_n_xex() [1/2]

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

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 }
Botan::Block_Cipher_Fixed_Params< 16, 32 >::block_size
size_t block_size() const final
Definition block_cipher.h:214

◆ decrypt_n_xex() [2/2]

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

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/8]

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

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); }
Botan::Block_Cipher_Fixed_Params< 16, 32 >::encrypt_n
virtual void encrypt_n(const uint8_t in[], uint8_t out[], size_t blocks) const=0

◆ encrypt() [2/8]

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

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 }

◆ encrypt() [3/8]

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

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 }

◆ encrypt() [4/8]

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

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); }

◆ encrypt() [5/8]

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

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); }

References encrypt_n().

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

◆ encrypt() [6/8]

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

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() [7/8]

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

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() [8/8]

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

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

void Botan::Kuznyechik::encrypt_n ( const uint8_t in[],
uint8_t out[],
size_t blocks ) const
overridevirtual

Encrypt one or more blocks

Parameters
inthe input buffer (multiple of block_size())
outthe output buffer (same size as in)
blocksthe number of blocks to process

Implements Botan::BlockCipher.

Definition at line 286 of file kuznyechik.cpp.

286 {
287 assert_key_material_set();
288 while(blocks > 0) {
289 uint64_t x1 = load_le<uint64_t>(in, 0);
290 uint64_t x2 = load_le<uint64_t>(in, 1);
291
292 x1 ^= m_rke[0];
293 x2 ^= m_rke[1];
294 Kuznyechik_F::LS(x1, x2);
295
296 x1 ^= m_rke[2];
297 x2 ^= m_rke[3];
298 Kuznyechik_F::LS(x1, x2);
299
300 x1 ^= m_rke[4];
301 x2 ^= m_rke[5];
302 Kuznyechik_F::LS(x1, x2);
303
304 x1 ^= m_rke[6];
305 x2 ^= m_rke[7];
306 Kuznyechik_F::LS(x1, x2);
307
308 x1 ^= m_rke[8];
309 x2 ^= m_rke[9];
310 Kuznyechik_F::LS(x1, x2);
311
312 x1 ^= m_rke[10];
313 x2 ^= m_rke[11];
314 Kuznyechik_F::LS(x1, x2);
315
316 x1 ^= m_rke[12];
317 x2 ^= m_rke[13];
318 Kuznyechik_F::LS(x1, x2);
319
320 x1 ^= m_rke[14];
321 x2 ^= m_rke[15];
322 Kuznyechik_F::LS(x1, x2);
323
324 x1 ^= m_rke[16];
325 x2 ^= m_rke[17];
326 Kuznyechik_F::LS(x1, x2);
327
328 x1 ^= m_rke[18];
329 x2 ^= m_rke[19];
330
331 store_le(out, x1, x2);
332
333 in += 16;
334 out += 16;
335 blocks--;
336 }
337}

References Botan::Block_Cipher_Fixed_Params< 16, 32 >::assert_key_material_set(), Botan::load_le(), and Botan::store_le().

◆ encrypt_n_xex() [1/2]

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

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 }

◆ encrypt_n_xex() [2/2]

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

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

bool Botan::Kuznyechik::has_keying_material ( ) const
overridevirtual
Returns
true if a key has been set on this object

Implements Botan::SymmetricAlgorithm.

Definition at line 223 of file kuznyechik.cpp.

223 {
224 return !m_rke.empty();
225}

◆ key_spec()

Key_Length_Specification Botan::Block_Cipher_Fixed_Params< BS, KMIN, 0, 1, BlockCipher >::key_spec ( ) const
inlinefinalvirtualinherited
Returns
object describing limits on key size

Implements Botan::SymmetricAlgorithm.

Definition at line 216 of file block_cipher.h.

216{ return Key_Length_Specification(KMIN, KMAX, KMOD); }

◆ maximum_keylength() [1/2]

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

Definition at line 102 of file sym_algo.h.

102{ return key_spec().maximum_keylength(); }
Botan::Block_Cipher_Fixed_Params< 16, 32 >::key_spec
Key_Length_Specification key_spec() const final
Definition block_cipher.h:216
Botan::Key_Length_Specification::maximum_keylength
size_t maximum_keylength() const
Definition sym_algo.h:56

◆ maximum_keylength() [2/2]

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

Definition at line 102 of file sym_algo.h.

102{ return key_spec().maximum_keylength(); }
Botan::SymmetricAlgorithm::key_spec
virtual Key_Length_Specification key_spec() const =0

References key_spec().

◆ minimum_keylength() [1/2]

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

Definition at line 107 of file sym_algo.h.

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

◆ minimum_keylength() [2/2]

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

Definition at line 107 of file sym_algo.h.

107{ return key_spec().minimum_keylength(); }

References key_spec().

◆ name()

std::string Botan::Kuznyechik::name ( ) const
inlineoverridevirtual
Returns
the algorithm name

Implements Botan::SymmetricAlgorithm.

Definition at line 27 of file kuznyechik.h.

27{ return "Kuznyechik"; }

◆ new_object()

std::unique_ptr< BlockCipher > Botan::Kuznyechik::new_object ( ) const
inlineoverridevirtual
Returns
new object representing the same algorithm as *this

Implements Botan::BlockCipher.

Definition at line 29 of file kuznyechik.h.

29{ return std::make_unique<Kuznyechik>(); }

◆ parallel_bytes() [1/2]

size_t Botan::BlockCipher::parallel_bytes ( ) const
inlineinherited
Returns
preferred parallelism of this cipher in bytes

Definition at line 67 of file block_cipher.h.

67{ return parallelism() * block_size() * BlockCipher::ParallelismMult; }

◆ parallel_bytes() [2/2]

size_t Botan::BlockCipher::parallel_bytes ( ) const
inlineinherited
Returns
preferred parallelism of this cipher in bytes

Definition at line 67 of file block_cipher.h.

67{ return parallelism() * block_size() * BlockCipher::ParallelismMult; }
Botan::BlockCipher::ParallelismMult
static constexpr size_t ParallelismMult
Definition block_cipher.h:52

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

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

◆ parallelism() [1/2]

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

Definition at line 62 of file block_cipher.h.

62{ return 1; }

◆ parallelism() [2/2]

virtual size_t Botan::BlockCipher::parallelism ( ) const
inlinevirtualinherited
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() [1/2]

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

Definition at line 73 of file block_cipher.h.

73{ return "base"; }

◆ provider() [2/2]

virtual std::string Botan::BlockCipher::provider ( ) const
inlinevirtualinherited
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::Camellia_128, Botan::Camellia_192, Botan::Camellia_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() [1/2]

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

Definition at line 44 of file block_cipher.cpp.

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

◆ providers() [2/2]

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

Definition at line 278 of file block_cipher.cpp.

278 {
279 return probe_providers_of<BlockCipher>(algo, {"base", "commoncrypto"});
280}

References Botan::probe_providers_of().

◆ set_key() [1/6]

void Botan::SymmetricAlgorithm::set_key ( const OctetString & key)
inherited

Set the symmetric key of this object.

Parameters
keythe SymmetricKey to be set.

Definition at line 120 of file sym_algo.cpp.

14 {
15 set_key(std::span{key.begin(), key.length()});
16}
Botan::Block_Cipher_Fixed_Params< 16, 32 >::set_key
void set_key(const OctetString &key)
Definition sym_algo.cpp:14

◆ set_key() [2/6]

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

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

◆ set_key() [3/6]

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 126 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}
Botan::Block_Cipher_Fixed_Params< 16, 32 >::valid_keylength
bool valid_keylength(size_t length) const
Definition sym_algo.h:114
Botan::Block_Cipher_Fixed_Params< 16, 32 >::name
virtual std::string name() const=0

◆ set_key() [4/6]

void Botan::SymmetricAlgorithm::set_key ( const OctetString & key)
inherited

Set the symmetric key of this object.

Parameters
keythe SymmetricKey to be set.

Definition at line 14 of file sym_algo.cpp.

14 {
15 set_key(std::span{key.begin(), key.length()});
16}

References Botan::OctetString::begin(), Botan::OctetString::length(), and set_key().

Referenced by Botan::create_aes_row_generator(), Botan::Sodium::crypto_stream_salsa20(), Botan::Sodium::crypto_stream_salsa20_xor_ic(), Botan::Sodium::crypto_stream_xsalsa20(), Botan::Sodium::crypto_stream_xsalsa20_xor_ic(), Botan::FPE::fe1_decrypt(), Botan::FPE::fe1_encrypt(), Botan::Sphincs_Hash_Functions_Sha2::PRF_msg(), Botan::Sodium::randombytes_buf_deterministic(), Botan::TLS::TLS_NULL_HMAC_AEAD_Mode::reset(), and set_key().

◆ set_key() [5/6]

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

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

References set_key().

Referenced by set_key().

◆ set_key() [6/6]

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}

References name(), and valid_keylength().

◆ valid_keylength() [1/2]

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

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

◆ valid_keylength() [2/2]

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

114{ return key_spec().valid_keylength(length); }

References key_spec().

Referenced by set_key().

Member Data Documentation

◆ ParallelismMult [1/2]

size_t Botan::BlockCipher::ParallelismMult
staticconstexprinherited

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.

◆ ParallelismMult [2/2]

size_t Botan::BlockCipher::ParallelismMult = 4
staticconstexprinherited

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:
Generated by doxygen 1.15.0