Botan  2.4.0
Crypto and TLS for C++11
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Botan::GOST_28147_89 Class Referencefinal

#include <gost_28147.h>

Inheritance diagram for Botan::GOST_28147_89:
Botan::Block_Cipher_Fixed_Params< 8, 32 > Botan::BlockCipher Botan::SymmetricAlgorithm

Public Types

enum  
 

Public Member Functions

size_t block_size () const override
 
void clear () override
 
BlockCipherclone () const override
 
void decrypt (const uint8_t in[], uint8_t out[]) const
 
void decrypt (uint8_t block[]) const
 
template<typename Alloc >
void decrypt (std::vector< uint8_t, Alloc > &block) const
 
template<typename Alloc , typename Alloc2 >
void decrypt (const std::vector< uint8_t, Alloc > &in, std::vector< uint8_t, Alloc2 > &out) 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 override
 
void encrypt (const uint8_t in[], uint8_t out[]) const
 
void encrypt (uint8_t block[]) const
 
template<typename Alloc >
void encrypt (std::vector< uint8_t, Alloc > &block) const
 
template<typename Alloc , typename Alloc2 >
void encrypt (const std::vector< uint8_t, Alloc > &in, std::vector< uint8_t, Alloc2 > &out) 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 override
 
 GOST_28147_89 (const GOST_28147_89_Params &params)
 
 GOST_28147_89 (const std::string &param_name)
 
Key_Length_Specification key_spec () const override
 
size_t maximum_keylength () const
 
size_t minimum_keylength () const
 
std::string name () const override
 
size_t parallel_bytes () const
 
virtual size_t parallelism () const
 
virtual std::string provider () const
 
void set_key (const SymmetricKey &key)
 
template<typename Alloc >
void set_key (const std::vector< uint8_t, Alloc > &key)
 
void set_key (const uint8_t key[], size_t length)
 
bool valid_keylength (size_t length) const
 

Static Public Member Functions

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

Protected Member Functions

void verify_key_set (bool cond) const
 

Detailed Description

GOST 28147-89

Definition at line 58 of file gost_28147.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited

Constructor & Destructor Documentation

◆ GOST_28147_89() [1/2]

Botan::GOST_28147_89::GOST_28147_89 ( const GOST_28147_89_Params params)
explicit
Parameters
paramsthe sbox parameters to use

Definition at line 59 of file gost_28147.cpp.

References Botan::GOST_28147_89_Params::sbox_pair().

59  : m_SBOX(1024)
60  {
61  // Convert the parallel 4x4 sboxes into larger word-based sboxes
62 
63  for(size_t i = 0; i != 256; ++i)
64  {
65  m_SBOX[i ] = rotl<11, uint32_t>(param.sbox_pair(0, i));
66  m_SBOX[i+256] = rotl<19, uint32_t>(param.sbox_pair(1, i));
67  m_SBOX[i+512] = rotl<27, uint32_t>(param.sbox_pair(2, i));
68  m_SBOX[i+768] = rotl< 3, uint32_t>(param.sbox_pair(3, i));
69  }
70  }

◆ GOST_28147_89() [2/2]

Botan::GOST_28147_89::GOST_28147_89 ( const std::string &  param_name)
inlineexplicit

Definition at line 74 of file gost_28147.h.

74  :
75  GOST_28147_89(GOST_28147_89_Params(param_name)) {}
GOST_28147_89(const GOST_28147_89_Params &params)
Definition: gost_28147.cpp:59

Member Function Documentation

◆ block_size()

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

Implements Botan::BlockCipher.

Definition at line 208 of file block_cipher.h.

208 { return BS; }

◆ clear()

void Botan::GOST_28147_89::clear ( )
overridevirtual

Reset the state.

Implements Botan::SymmetricAlgorithm.

Definition at line 182 of file gost_28147.cpp.

References Botan::zap().

Referenced by Botan::GOST_34_11::clear().

183  {
184  zap(m_EK);
185  }
void zap(std::vector< T, Alloc > &vec)
Definition: secmem.h:191

◆ clone()

BlockCipher* Botan::GOST_28147_89::clone ( ) const
inlineoverridevirtual
Returns
new object representing the same algorithm as *this

Implements Botan::BlockCipher.

Definition at line 67 of file gost_28147.h.

67 { return new GOST_28147_89(m_SBOX); }
GOST_28147_89(const GOST_28147_89_Params &params)
Definition: gost_28147.cpp:59

◆ create()

std::unique_ptr< BlockCipher > Botan::BlockCipher::create ( const std::string &  algo_spec,
const std::string &  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 103 of file block_cipher.cpp.

References Botan::BlockCipher::block_size(), BOTAN_UNUSED, Botan::HashFunction::create(), Botan::StreamCipher::create(), hash, and Botan::make_openssl_block_cipher().

Referenced by botan_block_cipher_init(), Botan::MessageAuthenticationCode::create(), Botan::StreamCipher::create(), Botan::BlockCipher::create_or_throw(), Botan::get_aead(), Botan::get_block_cipher(), and Botan::get_cipher_mode().

105  {
106 #if defined(BOTAN_HAS_OPENSSL)
107  if(provider.empty() || provider == "openssl")
108  {
109  if(auto bc = make_openssl_block_cipher(algo))
110  return bc;
111 
112  if(!provider.empty())
113  return nullptr;
114  }
115 #endif
116 
117  // TODO: CommonCrypto
118  // TODO: CryptoAPI
119  // TODO: /dev/crypto
120 
121  // Only base providers from here on out
122  if(provider.empty() == false && provider != "base")
123  return nullptr;
124 
125 #if defined(BOTAN_HAS_AES)
126  if(algo == "AES-128")
127  {
128  return std::unique_ptr<BlockCipher>(new AES_128);
129  }
130 
131  if(algo == "AES-192")
132  {
133  return std::unique_ptr<BlockCipher>(new AES_192);
134  }
135 
136  if(algo == "AES-256")
137  {
138  return std::unique_ptr<BlockCipher>(new AES_256);
139  }
140 #endif
141 
142 #if defined(BOTAN_HAS_ARIA)
143  if(algo == "ARIA-128")
144  {
145  return std::unique_ptr<BlockCipher>(new ARIA_128);
146  }
147 
148  if(algo == "ARIA-192")
149  {
150  return std::unique_ptr<BlockCipher>(new ARIA_192);
151  }
152 
153  if(algo == "ARIA-256")
154  {
155  return std::unique_ptr<BlockCipher>(new ARIA_256);
156  }
157 #endif
158 
159 #if defined(BOTAN_HAS_SERPENT)
160  if(algo == "Serpent")
161  {
162  return std::unique_ptr<BlockCipher>(new Serpent);
163  }
164 #endif
165 
166 #if defined(BOTAN_HAS_SHACAL2)
167  if(algo == "SHACAL2")
168  {
169  return std::unique_ptr<BlockCipher>(new SHACAL2);
170  }
171 #endif
172 
173 #if defined(BOTAN_HAS_TWOFISH)
174  if(algo == "Twofish")
175  {
176  return std::unique_ptr<BlockCipher>(new Twofish);
177  }
178 #endif
179 
180 #if defined(BOTAN_HAS_THREEFISH_512)
181  if(algo == "Threefish-512")
182  {
183  return std::unique_ptr<BlockCipher>(new Threefish_512);
184  }
185 #endif
186 
187 #if defined(BOTAN_HAS_BLOWFISH)
188  if(algo == "Blowfish")
189  {
190  return std::unique_ptr<BlockCipher>(new Blowfish);
191  }
192 #endif
193 
194 #if defined(BOTAN_HAS_CAMELLIA)
195  if(algo == "Camellia-128")
196  {
197  return std::unique_ptr<BlockCipher>(new Camellia_128);
198  }
199 
200  if(algo == "Camellia-192")
201  {
202  return std::unique_ptr<BlockCipher>(new Camellia_192);
203  }
204 
205  if(algo == "Camellia-256")
206  {
207  return std::unique_ptr<BlockCipher>(new Camellia_256);
208  }
209 #endif
210 
211 #if defined(BOTAN_HAS_DES)
212  if(algo == "DES")
213  {
214  return std::unique_ptr<BlockCipher>(new DES);
215  }
216 
217  if(algo == "DESX")
218  {
219  return std::unique_ptr<BlockCipher>(new DESX);
220  }
221 
222  if(algo == "TripleDES" || algo == "3DES" || algo == "DES-EDE")
223  {
224  return std::unique_ptr<BlockCipher>(new TripleDES);
225  }
226 #endif
227 
228 #if defined(BOTAN_HAS_NOEKEON)
229  if(algo == "Noekeon")
230  {
231  return std::unique_ptr<BlockCipher>(new Noekeon);
232  }
233 #endif
234 
235 #if defined(BOTAN_HAS_CAST_128)
236  if(algo == "CAST-128" || algo == "CAST5")
237  {
238  return std::unique_ptr<BlockCipher>(new CAST_128);
239  }
240 #endif
241 
242 #if defined(BOTAN_HAS_CAST_256)
243  if(algo == "CAST-256")
244  {
245  return std::unique_ptr<BlockCipher>(new CAST_256);
246  }
247 #endif
248 
249 #if defined(BOTAN_HAS_IDEA)
250  if(algo == "IDEA")
251  {
252  return std::unique_ptr<BlockCipher>(new IDEA);
253  }
254 #endif
255 
256 #if defined(BOTAN_HAS_KASUMI)
257  if(algo == "KASUMI")
258  {
259  return std::unique_ptr<BlockCipher>(new KASUMI);
260  }
261 #endif
262 
263 #if defined(BOTAN_HAS_MISTY1)
264  if(algo == "MISTY1")
265  {
266  return std::unique_ptr<BlockCipher>(new MISTY1);
267  }
268 #endif
269 
270 #if defined(BOTAN_HAS_SEED)
271  if(algo == "SEED")
272  {
273  return std::unique_ptr<BlockCipher>(new SEED);
274  }
275 #endif
276 
277 #if defined(BOTAN_HAS_SM4)
278  if(algo == "SM4")
279  {
280  return std::unique_ptr<BlockCipher>(new SM4);
281  }
282 #endif
283 
284 #if defined(BOTAN_HAS_XTEA)
285  if(algo == "XTEA")
286  {
287  return std::unique_ptr<BlockCipher>(new XTEA);
288  }
289 #endif
290 
291  const SCAN_Name req(algo);
292 
293 #if defined(BOTAN_HAS_GOST_28147_89)
294  if(req.algo_name() == "GOST-28147-89")
295  {
296  return std::unique_ptr<BlockCipher>(new GOST_28147_89(req.arg(0, "R3411_94_TestParam")));
297  }
298 #endif
299 
300 #if defined(BOTAN_HAS_CASCADE)
301  if(req.algo_name() == "Cascade" && req.arg_count() == 2)
302  {
303  std::unique_ptr<BlockCipher> c1(BlockCipher::create(req.arg(0)));
304  std::unique_ptr<BlockCipher> c2(BlockCipher::create(req.arg(1)));
305 
306  if(c1 && c2)
307  return std::unique_ptr<BlockCipher>(new Cascade_Cipher(c1.release(), c2.release()));
308  }
309 #endif
310 
311 #if defined(BOTAN_HAS_LION)
312  if(req.algo_name() == "Lion" && req.arg_count_between(2, 3))
313  {
314  std::unique_ptr<HashFunction> hash(HashFunction::create(req.arg(0)));
315  std::unique_ptr<StreamCipher> stream(StreamCipher::create(req.arg(1)));
316 
317  if(hash && stream)
318  {
319  const size_t block_size = req.arg_as_integer(2, 1024);
320  return std::unique_ptr<BlockCipher>(new Lion(hash.release(), stream.release(), block_size));
321  }
322  }
323 #endif
324 
325  BOTAN_UNUSED(req);
327 
328  return nullptr;
329  }
static std::unique_ptr< HashFunction > create(const std::string &algo_spec, const std::string &provider="")
Definition: hash.cpp:106
#define BOTAN_UNUSED(...)
Definition: assert.h:106
static std::unique_ptr< BlockCipher > create(const std::string &algo_spec, const std::string &provider="")
static std::unique_ptr< StreamCipher > create(const std::string &algo_spec, const std::string &provider="")
std::unique_ptr< BlockCipher > make_openssl_block_cipher(const std::string &name)
virtual std::string provider() const
Definition: block_cipher.h:72
virtual size_t block_size() const =0
MechanismType hash

◆ create_or_throw()

std::unique_ptr< BlockCipher > Botan::BlockCipher::create_or_throw ( const std::string &  algo_spec,
const std::string &  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 333 of file block_cipher.cpp.

References Botan::BlockCipher::create().

Referenced by Botan::Encrypted_PSK_Database::Encrypted_PSK_Database(), Botan::make_block_cipher(), Botan::rfc3394_keyunwrap(), Botan::rfc3394_keywrap(), and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::TLS_CBC_HMAC_AEAD_Mode().

335  {
336  if(auto bc = BlockCipher::create(algo, provider))
337  {
338  return bc;
339  }
340  throw Lookup_Error("Block cipher", algo, provider);
341  }
static std::unique_ptr< BlockCipher > create(const std::string &algo_spec, const std::string &provider="")
virtual std::string provider() const
Definition: block_cipher.h:72

◆ decrypt() [1/4]

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

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.

Referenced by Botan::DESX::decrypt_n(), Botan::XTS_Decryption::finish(), Botan::CTS_Decryption::finish(), and Botan::nist_key_unwrap_padded().

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

◆ decrypt() [2/4]

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

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

◆ decrypt() [3/4]

template<typename Alloc >
void Botan::BlockCipher::decrypt ( std::vector< uint8_t, Alloc > &  block) const
inlineinherited

Decrypt one or more blocks

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

Definition at line 125 of file block_cipher.h.

126  {
127  return decrypt_n(block.data(), block.data(), block.size() / block_size());
128  }
virtual void decrypt_n(const uint8_t in[], uint8_t out[], size_t blocks) const =0
virtual size_t block_size() const =0

◆ decrypt() [4/4]

template<typename Alloc , typename Alloc2 >
void Botan::BlockCipher::decrypt ( const std::vector< uint8_t, Alloc > &  in,
std::vector< uint8_t, Alloc2 > &  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 148 of file block_cipher.h.

150  {
151  return decrypt_n(in.data(), out.data(), in.size() / block_size());
152  }
virtual void decrypt_n(const uint8_t in[], uint8_t out[], size_t blocks) const =0
virtual size_t block_size() const =0

◆ decrypt_n()

void Botan::GOST_28147_89::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 144 of file gost_28147.cpp.

References Botan::Block_Cipher_Fixed_Params< 8, 32 >::BLOCK_SIZE, GOST_2ROUND, Botan::load_le< uint32_t >(), Botan::store_le(), and Botan::SymmetricAlgorithm::verify_key_set().

145  {
146  verify_key_set(m_EK.empty() == false);
147 
148  for(size_t i = 0; i != blocks; ++i)
149  {
150  uint32_t N1 = load_le<uint32_t>(in, 0);
151  uint32_t N2 = load_le<uint32_t>(in, 1);
152 
153  GOST_2ROUND(N1, N2, 0, 1);
154  GOST_2ROUND(N1, N2, 2, 3);
155  GOST_2ROUND(N1, N2, 4, 5);
156  GOST_2ROUND(N1, N2, 6, 7);
157 
158  for(size_t j = 0; j != 3; ++j)
159  {
160  GOST_2ROUND(N1, N2, 7, 6);
161  GOST_2ROUND(N1, N2, 5, 4);
162  GOST_2ROUND(N1, N2, 3, 2);
163  GOST_2ROUND(N1, N2, 1, 0);
164  }
165 
166  store_le(out, N2, N1);
167  in += BLOCK_SIZE;
168  out += BLOCK_SIZE;
169  }
170  }
void verify_key_set(bool cond) const
Definition: sym_algo.h:95
uint32_t load_le< uint32_t >(const uint8_t in[], size_t off)
Definition: loadstor.h:196
#define GOST_2ROUND(N1, N2, R1, R2)
Definition: gost_28147.cpp:94
void store_le(uint16_t in, uint8_t out[2])
Definition: loadstor.h:450

◆ decrypt_n_xex()

void Botan::Block_Cipher_Fixed_Params< BS, KMIN, 0 , 1 >::decrypt_n_xex ( uint8_t  data[],
const uint8_t  mask[],
size_t  blocks 
) const
inlineoverridevirtualinherited

Reimplemented from Botan::BlockCipher.

Definition at line 220 of file block_cipher.h.

223  {
224  xor_buf(data, mask, blocks * BS);
225  decrypt_n(data, data, blocks);
226  xor_buf(data, mask, blocks * BS);
227  }
virtual void decrypt_n(const uint8_t in[], uint8_t out[], size_t blocks) const =0
void xor_buf(uint8_t out[], const uint8_t in[], size_t length)
Definition: mem_ops.h:163

◆ encrypt() [1/4]

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

Referenced by Botan::aont_package(), Botan::aont_unpackage(), Botan::GOST_34_11::copy_state(), Botan::DESX::encrypt_n(), Botan::XTS_Encryption::finish(), Botan::CTS_Encryption::finish(), Botan::nist_key_wrap_padded(), Botan::CBC_Encryption::process(), Botan::CFB_Mode::shift_register(), and Botan::CFB_Mode::valid_nonce_length().

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

◆ encrypt() [2/4]

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

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

◆ encrypt() [3/4]

template<typename Alloc >
void Botan::BlockCipher::encrypt ( std::vector< uint8_t, Alloc > &  block) const
inlineinherited

Encrypt one or more blocks

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

Definition at line 115 of file block_cipher.h.

116  {
117  return encrypt_n(block.data(), block.data(), block.size() / block_size());
118  }
virtual void encrypt_n(const uint8_t in[], uint8_t out[], size_t blocks) const =0
virtual size_t block_size() const =0

◆ encrypt() [4/4]

template<typename Alloc , typename Alloc2 >
void Botan::BlockCipher::encrypt ( const std::vector< uint8_t, Alloc > &  in,
std::vector< uint8_t, Alloc2 > &  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 136 of file block_cipher.h.

138  {
139  return encrypt_n(in.data(), out.data(), in.size() / block_size());
140  }
virtual void encrypt_n(const uint8_t in[], uint8_t out[], size_t blocks) const =0
virtual size_t block_size() const =0

◆ encrypt_n()

void Botan::GOST_28147_89::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 112 of file gost_28147.cpp.

References Botan::Block_Cipher_Fixed_Params< 8, 32 >::BLOCK_SIZE, GOST_2ROUND, Botan::load_le< uint32_t >(), Botan::store_le(), and Botan::SymmetricAlgorithm::verify_key_set().

113  {
114  verify_key_set(m_EK.empty() == false);
115 
116  for(size_t i = 0; i != blocks; ++i)
117  {
118  uint32_t N1 = load_le<uint32_t>(in, 0);
119  uint32_t N2 = load_le<uint32_t>(in, 1);
120 
121  for(size_t j = 0; j != 3; ++j)
122  {
123  GOST_2ROUND(N1, N2, 0, 1);
124  GOST_2ROUND(N1, N2, 2, 3);
125  GOST_2ROUND(N1, N2, 4, 5);
126  GOST_2ROUND(N1, N2, 6, 7);
127  }
128 
129  GOST_2ROUND(N1, N2, 7, 6);
130  GOST_2ROUND(N1, N2, 5, 4);
131  GOST_2ROUND(N1, N2, 3, 2);
132  GOST_2ROUND(N1, N2, 1, 0);
133 
134  store_le(out, N2, N1);
135 
136  in += BLOCK_SIZE;
137  out += BLOCK_SIZE;
138  }
139  }
void verify_key_set(bool cond) const
Definition: sym_algo.h:95
uint32_t load_le< uint32_t >(const uint8_t in[], size_t off)
Definition: loadstor.h:196
#define GOST_2ROUND(N1, N2, R1, R2)
Definition: gost_28147.cpp:94
void store_le(uint16_t in, uint8_t out[2])
Definition: loadstor.h:450

◆ encrypt_n_xex()

void Botan::Block_Cipher_Fixed_Params< BS, KMIN, 0 , 1 >::encrypt_n_xex ( uint8_t  data[],
const uint8_t  mask[],
size_t  blocks 
) const
inlineoverridevirtualinherited

Reimplemented from Botan::BlockCipher.

Definition at line 211 of file block_cipher.h.

214  {
215  xor_buf(data, mask, blocks * BS);
216  encrypt_n(data, data, blocks);
217  xor_buf(data, mask, blocks * BS);
218  }
void xor_buf(uint8_t out[], const uint8_t in[], size_t length)
Definition: mem_ops.h:163
virtual void encrypt_n(const uint8_t in[], uint8_t out[], size_t blocks) const =0

◆ key_spec()

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

Implements Botan::SymmetricAlgorithm.

Definition at line 229 of file block_cipher.h.

230  {
231  return Key_Length_Specification(KMIN, KMAX, KMOD);
232  }

◆ maximum_keylength()

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

Definition at line 39 of file sym_algo.h.

40  {
41  return key_spec().maximum_keylength();
42  }
size_t maximum_keylength() const
Definition: key_spec.h:69
virtual Key_Length_Specification key_spec() const =0

◆ minimum_keylength()

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

Definition at line 47 of file sym_algo.h.

48  {
49  return key_spec().minimum_keylength();
50  }
virtual Key_Length_Specification key_spec() const =0
size_t minimum_keylength() const
Definition: key_spec.h:61

◆ name()

std::string Botan::GOST_28147_89::name ( ) const
overridevirtual
Returns
the algorithm name

Implements Botan::SymmetricAlgorithm.

Definition at line 72 of file gost_28147.cpp.

73  {
74  /*
75  'Guess' the right name for the sbox on the basis of the values.
76  This would need to be updated if support for other sbox parameters
77  is added. Preferably, we would just store the string value in the
78  constructor, but can't break binary compat.
79  */
80  std::string sbox_name = "";
81  if(m_SBOX[0] == 0x00072000)
82  sbox_name = "R3411_94_TestParam";
83  else if(m_SBOX[0] == 0x0002D000)
84  sbox_name = "R3411_CryptoPro";
85  else
86  throw Internal_Error("GOST-28147 unrecognized sbox value");
87 
88  return "GOST-28147-89(" + sbox_name + ")";
89  }

◆ parallel_bytes()

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

Definition at line 63 of file block_cipher.h.

Referenced by Botan::XTS_Mode::update_granularity(), and Botan::CBC_Mode::update_granularity().

64  {
65  return parallelism() * block_size() * BOTAN_BLOCK_CIPHER_PAR_MULT;
66  }
virtual size_t parallelism() const
Definition: block_cipher.h:58
virtual size_t block_size() const =0

◆ parallelism()

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

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

Definition at line 58 of file block_cipher.h.

58 { return 1; }

◆ provider()

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_256, Botan::AES_192, Botan::Threefish_512, Botan::AES_128, Botan::IDEA, Botan::Serpent, Botan::Noekeon, and Botan::SHACAL2.

Definition at line 72 of file block_cipher.h.

72 { return "base"; }

◆ providers()

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

Definition at line 343 of file block_cipher.cpp.

Referenced by Botan::TLS::Ciphersuite::by_id(), and Botan::get_block_cipher_providers().

344  {
345  return probe_providers_of<BlockCipher>(algo, { "base", "openssl" });
346  }

◆ set_key() [1/3]

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

Set the symmetric key of this object.

Parameters
keythe SymmetricKey to be set.

Definition at line 66 of file sym_algo.h.

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

Referenced by Botan::aont_package(), Botan::aont_unpackage(), botan_block_cipher_set_key(), botan_mac_set_key(), Botan::GOST_34_11::copy_state(), Botan::DESX::decrypt_n(), Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::key_spec(), Botan::pbkdf2(), and Botan::TLS_PRF::TLS_PRF().

67  {
68  set_key(key.begin(), key.length());
69  }
void set_key(const SymmetricKey &key)
Definition: sym_algo.h:66

◆ set_key() [2/3]

template<typename Alloc >
void Botan::SymmetricAlgorithm::set_key ( const std::vector< uint8_t, Alloc > &  key)
inlineinherited

Definition at line 72 of file sym_algo.h.

73  {
74  set_key(key.data(), key.size());
75  }
void set_key(const SymmetricKey &key)
Definition: sym_algo.h:66

◆ set_key() [3/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 82 of file sym_algo.h.

83  {
84  if(!valid_keylength(length))
85  throw Invalid_Key_Length(name(), length);
86  key_schedule(key, length);
87  }
bool valid_keylength(size_t length) const
Definition: sym_algo.h:57
virtual std::string name() const =0

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

Referenced by Botan::aont_package(), and Botan::aont_unpackage().

58  {
59  return key_spec().valid_keylength(length);
60  }
bool valid_keylength(size_t length) const
Definition: key_spec.h:51
virtual Key_Length_Specification key_spec() const =0

◆ verify_key_set()

void Botan::SymmetricAlgorithm::verify_key_set ( bool  cond) const
inlineprotectedinherited

Definition at line 95 of file sym_algo.h.

Referenced by Botan::Salsa20::cipher(), Botan::CTR_BE::cipher(), Botan::RC4::cipher(), Botan::SHAKE_128_Cipher::cipher(), Botan::ChaCha::cipher(), Botan::Poly1305::clear(), Botan::MISTY1::decrypt_n(), Botan::DES::decrypt_n(), Botan::Twofish::decrypt_n(), Botan::CAST_256::decrypt_n(), Botan::KASUMI::decrypt_n(), Botan::CAST_128::decrypt_n(), Botan::SM4::decrypt_n(), Botan::XTEA::decrypt_n(), Botan::Blowfish::decrypt_n(), Botan::DESX::decrypt_n(), Botan::Noekeon::decrypt_n(), Botan::Threefish_512::decrypt_n(), Botan::IDEA::decrypt_n(), Botan::SEED::decrypt_n(), Botan::SHACAL2::decrypt_n(), Botan::Serpent::decrypt_n(), Botan::Lion::decrypt_n(), Botan::TripleDES::decrypt_n(), decrypt_n(), Botan::Blowfish::encrypt_n(), Botan::CAST_128::encrypt_n(), Botan::DESX::encrypt_n(), Botan::Threefish_512::encrypt_n(), Botan::KASUMI::encrypt_n(), Botan::CAST_256::encrypt_n(), Botan::XTEA::encrypt_n(), Botan::MISTY1::encrypt_n(), Botan::Twofish::encrypt_n(), Botan::IDEA::encrypt_n(), Botan::SHACAL2::encrypt_n(), Botan::SEED::encrypt_n(), Botan::SM4::encrypt_n(), Botan::Noekeon::encrypt_n(), Botan::DES::encrypt_n(), Botan::Serpent::encrypt_n(), Botan::Lion::encrypt_n(), Botan::TripleDES::encrypt_n(), encrypt_n(), Botan::Salsa20::seek(), Botan::CTR_BE::seek(), Botan::ChaCha::seek(), and Botan::GHASH::update_associated_data().

96  {
97  if(cond == false)
98  throw Key_Not_Set(name());
99  }
virtual std::string name() const =0

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