Botan  1.11.26
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Botan::Serpent_SIMD Class Referencefinal

#include <serp_simd.h>

Inheritance diagram for Botan::Serpent_SIMD:
Botan::Serpent Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 > Botan::BlockCipher Botan::SymmetricAlgorithm

Public Types

enum  
 
typedef SCAN_Name Spec
 

Public Member Functions

size_t block_size () const override
 
void clear () override
 
BlockCipherclone () const override
 
void decrypt (const byte in[], byte out[]) const
 
void decrypt (byte block[]) const
 
template<typename Alloc >
void decrypt (std::vector< byte, Alloc > &block) const
 
template<typename Alloc , typename Alloc2 >
void decrypt (const std::vector< byte, Alloc > &in, std::vector< byte, Alloc2 > &out) const
 
void decrypt_n (const byte in[], byte out[], size_t blocks) const override
 
void encrypt (const byte in[], byte out[]) const
 
void encrypt (byte block[]) const
 
template<typename Alloc >
void encrypt (std::vector< byte, Alloc > &block) const
 
template<typename Alloc , typename Alloc2 >
void encrypt (const std::vector< byte, Alloc > &in, std::vector< byte, Alloc2 > &out) const
 
void encrypt_n (const byte in[], byte out[], size_t blocks) const override
 
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
 
size_t parallelism () const override
 
void set_key (const SymmetricKey &key)
 
template<typename Alloc >
void set_key (const std::vector< byte, Alloc > &key)
 
void set_key (const byte 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::vector< std::string > providers (const std::string &algo_spec)
 

Protected Member Functions

const secure_vector< u32bit > & get_round_keys () const
 
void set_round_keys (const u32bit ks[132])
 

Detailed Description

Serpent implementation using SIMD

Definition at line 18 of file serp_simd.h.

Member Typedef Documentation

Definition at line 22 of file block_cipher.h.

Member Enumeration Documentation

anonymous enum
inherited

Member Function Documentation

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

Implements Botan::BlockCipher.

Definition at line 169 of file block_cipher.h.

169 { return BS; }
void Botan::Serpent::clear ( )
overridevirtualinherited

Implements Botan::SymmetricAlgorithm.

Definition at line 199 of file serpent.cpp.

References Botan::zap().

200  {
201  zap(m_round_key);
202  }
void zap(std::vector< T, Alloc > &vec)
Definition: secmem.h:196
BlockCipher* Botan::Serpent_SIMD::clone ( ) const
inlineoverridevirtual
Returns
new object representing the same algorithm as *this

Reimplemented from Botan::Serpent.

Definition at line 26 of file serp_simd.h.

26 { return new Serpent_SIMD; }
std::unique_ptr< BlockCipher > Botan::BlockCipher::create ( const std::string &  algo_spec,
const std::string &  provider = "" 
)
staticinherited

Create an instance based on a name Will return a null pointer if the algo/provider combination cannot be found. If provider is empty then best available is chosen.

Definition at line 150 of file block_cipher.cpp.

Referenced by Botan::TLS::Connection_Cipher_State::Connection_Cipher_State(), Botan::get_block_cipher(), Botan::Cascade_Cipher::make(), Botan::CBC_MAC::make(), Botan::CTR_BE::make(), Botan::OFB::make(), Botan::CMAC::make(), Botan::make_block_cipher(), Botan::make_block_cipher_mode(), Botan::make_block_cipher_mode_len(), Botan::make_block_cipher_mode_len2(), Botan::rfc3394_keyunwrap(), and Botan::rfc3394_keywrap().

152  {
153  return std::unique_ptr<BlockCipher>(make_a<BlockCipher>(Botan::BlockCipher::Spec(algo_spec), provider));
154  }
void Botan::BlockCipher::decrypt ( const byte  in[],
byte  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 72 of file block_cipher.h.

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

73  { decrypt_n(in, out, 1); }
virtual void decrypt_n(const byte in[], byte out[], size_t blocks) const =0
void Botan::BlockCipher::decrypt ( byte  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 89 of file block_cipher.h.

89 { decrypt_n(block, block, 1); }
virtual void decrypt_n(const byte in[], byte out[], size_t blocks) const =0
template<typename Alloc >
void Botan::BlockCipher::decrypt ( std::vector< byte, Alloc > &  block) const
inlineinherited

Decrypt one or more blocks

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

Definition at line 106 of file block_cipher.h.

107  {
108  return decrypt_n(block.data(), block.data(), block.size() / block_size());
109  }
virtual void decrypt_n(const byte in[], byte out[], size_t blocks) const =0
virtual size_t block_size() const =0
template<typename Alloc , typename Alloc2 >
void Botan::BlockCipher::decrypt ( const std::vector< byte, Alloc > &  in,
std::vector< byte, 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 129 of file block_cipher.h.

131  {
132  return decrypt_n(in.data(), out.data(), in.size() / block_size());
133  }
virtual void decrypt_n(const byte in[], byte out[], size_t blocks) const =0
virtual size_t block_size() const =0
void Botan::Serpent_SIMD::decrypt_n ( const byte  in[],
byte  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

Reimplemented from Botan::Serpent.

Definition at line 199 of file serp_simd.cpp.

References Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 >::BLOCK_SIZE, Botan::Serpent::decrypt_n(), and Botan::Serpent::get_round_keys().

200  {
201  const u32bit* KS = &(this->get_round_keys()[0]);
202 
203  while(blocks >= 4)
204  {
205  serpent_decrypt_4(in, out, KS);
206  in += 4 * BLOCK_SIZE;
207  out += 4 * BLOCK_SIZE;
208  blocks -= 4;
209  }
210 
211  if(blocks)
212  Serpent::decrypt_n(in, out, blocks);
213  }
std::uint32_t u32bit
Definition: types.h:33
void decrypt_n(const byte in[], byte out[], size_t blocks) const override
Definition: serpent.cpp:106
const secure_vector< u32bit > & get_round_keys() const
Definition: serpent.h:32
void Botan::BlockCipher::encrypt ( const byte  in[],
byte  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 62 of file block_cipher.h.

Referenced by Botan::aont_package(), Botan::aont_unpackage(), Botan::GOST_34_11::clear(), Botan::DESX::encrypt_n(), Botan::XTS_Encryption::finish(), Botan::CTS_Encryption::finish(), Botan::CFB_Encryption::update(), Botan::CBC_Encryption::update(), Botan::CFB_Decryption::update(), and Botan::CFB_Mode::valid_nonce_length().

63  { encrypt_n(in, out, 1); }
virtual void encrypt_n(const byte in[], byte out[], size_t blocks) const =0
void Botan::BlockCipher::encrypt ( byte  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 81 of file block_cipher.h.

81 { encrypt_n(block, block, 1); }
virtual void encrypt_n(const byte in[], byte out[], size_t blocks) const =0
template<typename Alloc >
void Botan::BlockCipher::encrypt ( std::vector< byte, Alloc > &  block) const
inlineinherited

Encrypt one or more blocks

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

Definition at line 96 of file block_cipher.h.

97  {
98  return encrypt_n(block.data(), block.data(), block.size() / block_size());
99  }
virtual void encrypt_n(const byte in[], byte out[], size_t blocks) const =0
virtual size_t block_size() const =0
template<typename Alloc , typename Alloc2 >
void Botan::BlockCipher::encrypt ( const std::vector< byte, Alloc > &  in,
std::vector< byte, 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 117 of file block_cipher.h.

119  {
120  return encrypt_n(in.data(), out.data(), in.size() / block_size());
121  }
virtual void encrypt_n(const byte in[], byte out[], size_t blocks) const =0
virtual size_t block_size() const =0
void Botan::Serpent_SIMD::encrypt_n ( const byte  in[],
byte  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

Reimplemented from Botan::Serpent.

Definition at line 180 of file serp_simd.cpp.

References Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 >::BLOCK_SIZE, Botan::Serpent::encrypt_n(), and Botan::Serpent::get_round_keys().

181  {
182  const u32bit* KS = &(this->get_round_keys()[0]);
183 
184  while(blocks >= 4)
185  {
186  serpent_encrypt_4(in, out, KS);
187  in += 4 * BLOCK_SIZE;
188  out += 4 * BLOCK_SIZE;
189  blocks -= 4;
190  }
191 
192  if(blocks)
193  Serpent::encrypt_n(in, out, blocks);
194  }
std::uint32_t u32bit
Definition: types.h:33
const secure_vector< u32bit > & get_round_keys() const
Definition: serpent.h:32
void encrypt_n(const byte in[], byte out[], size_t blocks) const override
Definition: serpent.cpp:54
const secure_vector<u32bit>& Botan::Serpent::get_round_keys ( ) const
inlineprotectedinherited

For use by subclasses using SIMD, asm, etc

Returns
const reference to the key schedule

Definition at line 32 of file serpent.h.

Referenced by decrypt_n(), and encrypt_n().

33  { return m_round_key; }
Key_Length_Specification Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD >::key_spec ( ) const
inlineoverridevirtualinherited
Returns
object describing limits on key size

Implements Botan::SymmetricAlgorithm.

Definition at line 171 of file block_cipher.h.

172  {
173  return Key_Length_Specification(KMIN, KMAX, KMOD);
174  }
size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const
inlineinherited
Returns
minimum allowed key length

Definition at line 36 of file sym_algo.h.

37  {
38  return key_spec().maximum_keylength();
39  }
size_t maximum_keylength() const
Definition: key_spec.h:69
virtual Key_Length_Specification key_spec() const =0
size_t Botan::SymmetricAlgorithm::minimum_keylength ( ) const
inlineinherited
Returns
maxmium allowed key length

Definition at line 44 of file sym_algo.h.

45  {
46  return key_spec().minimum_keylength();
47  }
size_t minimum_keylength() const
Definition: key_spec.h:61
virtual Key_Length_Specification key_spec() const =0
std::string Botan::Serpent::name ( ) const
inlineoverridevirtualinherited

Implements Botan::SymmetricAlgorithm.

Definition at line 25 of file serpent.h.

25 { return "Serpent"; }
size_t Botan::BlockCipher::parallel_bytes ( ) const
inlineinherited
Returns
prefererred parallelism of this cipher in bytes

Definition at line 50 of file block_cipher.h.

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

51  {
52  return parallelism() * block_size() * BOTAN_BLOCK_CIPHER_PAR_MULT;
53  }
virtual size_t parallelism() const
Definition: block_cipher.h:45
virtual size_t block_size() const =0
size_t Botan::Serpent_SIMD::parallelism ( ) const
inlineoverridevirtual
Returns
native parallelism of this cipher in blocks

Reimplemented from Botan::BlockCipher.

Definition at line 21 of file serp_simd.h.

21 { return 4; }
std::vector< std::string > Botan::BlockCipher::providers ( const std::string &  algo_spec)
staticinherited

Returns the list of available providers for this algorithm, empty if not available

Definition at line 156 of file block_cipher.cpp.

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

157  {
158  return providers_of<BlockCipher>(BlockCipher::Spec(algo_spec));
159  }
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 63 of file sym_algo.h.

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

Referenced by Botan::aont_package(), Botan::aont_unpackage(), botan_mac_set_key(), Botan::GOST_34_11::clear(), Botan::DESX::decrypt_n(), Botan::pbkdf2(), and Botan::TLS_PRF::TLS_PRF().

64  {
65  set_key(key.begin(), key.length());
66  }
void set_key(const SymmetricKey &key)
Definition: sym_algo.h:63
template<typename Alloc >
void Botan::SymmetricAlgorithm::set_key ( const std::vector< byte, Alloc > &  key)
inlineinherited

Definition at line 69 of file sym_algo.h.

70  {
71  set_key(key.data(), key.size());
72  }
void set_key(const SymmetricKey &key)
Definition: sym_algo.h:63
void Botan::SymmetricAlgorithm::set_key ( const byte  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 79 of file sym_algo.h.

80  {
81  if(!valid_keylength(length))
82  throw Invalid_Key_Length(name(), length);
83  key_schedule(key, length);
84  }
bool valid_keylength(size_t length) const
Definition: sym_algo.h:54
virtual std::string name() const =0
void Botan::Serpent::set_round_keys ( const u32bit  ks[132])
inlineprotectedinherited

For use by subclasses that implement the key schedule

Parameters
ksis the new key schedule value to set

Definition at line 39 of file serpent.h.

40  {
41  m_round_key.assign(&ks[0], &ks[132]);
42  }
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 54 of file sym_algo.h.

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

55  {
56  return key_spec().valid_keylength(length);
57  }
bool valid_keylength(size_t length) const
Definition: key_spec.h:51
virtual Key_Length_Specification key_spec() const =0

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