Botan  1.11.30
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes | List of all members
Botan::Noekeon Class Reference

#include <noekeon.h>

Inheritance diagram for Botan::Noekeon:
Botan::Block_Cipher_Fixed_Params< 16, 16 > Botan::BlockCipher Botan::SymmetricAlgorithm Botan::Noekeon_SIMD

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
 
virtual size_t parallelism () const
 
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_DK () const
 
const secure_vector< u32bit > & get_EK () const
 

Static Protected Attributes

static const byte RC [17]
 

Detailed Description

Noekeon

Definition at line 18 of file noekeon.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, 0 , 1 >::block_size ( ) const
inlineoverridevirtualinherited
void Botan::Noekeon::clear ( )
overridevirtual

Implements Botan::SymmetricAlgorithm.

Definition at line 205 of file noekeon.cpp.

References Botan::zap().

206  {
207  zap(m_EK);
208  zap(m_DK);
209  }
void zap(std::vector< T, Alloc > &vec)
Definition: secmem.h:196
BlockCipher* Botan::Noekeon::clone ( ) const
inlineoverridevirtual
Returns
new object representing the same algorithm as *this

Implements Botan::BlockCipher.

Reimplemented in Botan::Noekeon_SIMD.

Definition at line 26 of file noekeon.h.

26 { return new Noekeon; }
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::Noekeon::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

Implements Botan::BlockCipher.

Reimplemented in Botan::Noekeon_SIMD.

Definition at line 124 of file noekeon.cpp.

References Botan::Block_Cipher_Fixed_Params< 16, 16 >::BLOCK_SIZE, Botan::load_be< u32bit >(), RC, Botan::rotate_left(), Botan::rotate_right(), and Botan::store_be().

Referenced by Botan::Noekeon_SIMD::decrypt_n().

125  {
126  for(size_t i = 0; i != blocks; ++i)
127  {
128  u32bit A0 = load_be<u32bit>(in, 0);
129  u32bit A1 = load_be<u32bit>(in, 1);
130  u32bit A2 = load_be<u32bit>(in, 2);
131  u32bit A3 = load_be<u32bit>(in, 3);
132 
133  for(size_t j = 16; j != 0; --j)
134  {
135  theta(A0, A1, A2, A3, m_DK.data());
136  A0 ^= RC[j];
137 
138  A1 = rotate_left(A1, 1);
139  A2 = rotate_left(A2, 5);
140  A3 = rotate_left(A3, 2);
141 
142  gamma(A0, A1, A2, A3);
143 
144  A1 = rotate_right(A1, 1);
145  A2 = rotate_right(A2, 5);
146  A3 = rotate_right(A3, 2);
147  }
148 
149  theta(A0, A1, A2, A3, m_DK.data());
150  A0 ^= RC[0];
151 
152  store_be(out, A0, A1, A2, A3);
153 
154  in += BLOCK_SIZE;
155  out += BLOCK_SIZE;
156  }
157  }
T rotate_left(T input, size_t rot)
Definition: rotate.h:21
std::uint32_t u32bit
Definition: types.h:33
T rotate_right(T input, size_t rot)
Definition: rotate.h:34
static const byte RC[17]
Definition: noekeon.h:31
u32bit load_be< u32bit >(const byte in[], size_t off)
Definition: loadstor.h:185
void store_be(u16bit in, byte out[2])
Definition: loadstor.h:445
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::Noekeon::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

Implements Botan::BlockCipher.

Reimplemented in Botan::Noekeon_SIMD.

Definition at line 86 of file noekeon.cpp.

References Botan::Block_Cipher_Fixed_Params< 16, 16 >::BLOCK_SIZE, Botan::load_be< u32bit >(), RC, Botan::rotate_left(), Botan::rotate_right(), and Botan::store_be().

Referenced by Botan::Noekeon_SIMD::encrypt_n().

87  {
88  for(size_t i = 0; i != blocks; ++i)
89  {
90  u32bit A0 = load_be<u32bit>(in, 0);
91  u32bit A1 = load_be<u32bit>(in, 1);
92  u32bit A2 = load_be<u32bit>(in, 2);
93  u32bit A3 = load_be<u32bit>(in, 3);
94 
95  for(size_t j = 0; j != 16; ++j)
96  {
97  A0 ^= RC[j];
98  theta(A0, A1, A2, A3, m_EK.data());
99 
100  A1 = rotate_left(A1, 1);
101  A2 = rotate_left(A2, 5);
102  A3 = rotate_left(A3, 2);
103 
104  gamma(A0, A1, A2, A3);
105 
106  A1 = rotate_right(A1, 1);
107  A2 = rotate_right(A2, 5);
108  A3 = rotate_right(A3, 2);
109  }
110 
111  A0 ^= RC[16];
112  theta(A0, A1, A2, A3, m_EK.data());
113 
114  store_be(out, A0, A1, A2, A3);
115 
116  in += BLOCK_SIZE;
117  out += BLOCK_SIZE;
118  }
119  }
T rotate_left(T input, size_t rot)
Definition: rotate.h:21
std::uint32_t u32bit
Definition: types.h:33
T rotate_right(T input, size_t rot)
Definition: rotate.h:34
static const byte RC[17]
Definition: noekeon.h:31
u32bit load_be< u32bit >(const byte in[], size_t off)
Definition: loadstor.h:185
void store_be(u16bit in, byte out[2])
Definition: loadstor.h:445
const secure_vector<u32bit>& Botan::Noekeon::get_DK ( ) const
inlineprotected
Returns
const reference to decryption subkeys

Definition at line 41 of file noekeon.h.

Referenced by Botan::Noekeon_SIMD::decrypt_n().

41 { return m_DK; }
const secure_vector<u32bit>& Botan::Noekeon::get_EK ( ) const
inlineprotected
Returns
const reference to encryption subkeys

Definition at line 36 of file noekeon.h.

Referenced by Botan::Noekeon_SIMD::encrypt_n().

36 { return m_EK; }
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 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::Noekeon::name ( ) const
inlineoverridevirtual

Implements Botan::SymmetricAlgorithm.

Definition at line 25 of file noekeon.h.

25 { return "Noekeon"; }
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
virtual size_t Botan::BlockCipher::parallelism ( ) const
inlinevirtualinherited
Returns
native parallelism of this cipher in blocks

Reimplemented in Botan::AES_256_NI, Botan::AES_192_NI, Botan::AES_128_NI, Botan::IDEA_SSE2, Botan::Noekeon_SIMD, Botan::Serpent_SIMD, and Botan::XTEA_SIMD.

Definition at line 45 of file block_cipher.h.

45 { return 1; }
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
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

Member Data Documentation

const byte Botan::Noekeon::RC
staticprotected
Initial value:
= {
0x80, 0x1B, 0x36, 0x6C, 0xD8, 0xAB, 0x4D, 0x9A,
0x2F, 0x5E, 0xBC, 0x63, 0xC6, 0x97, 0x35, 0x6A,
0xD4 }

The Noekeon round constants

Definition at line 31 of file noekeon.h.

Referenced by decrypt_n(), Botan::Noekeon_SIMD::decrypt_n(), encrypt_n(), and Botan::Noekeon_SIMD::encrypt_n().


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