Botan  1.11.10
Public Types | 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  
 

Public Member Functions

size_t block_size () const
 
void clear ()
 
BlockCipherclone () const
 
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
 
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
 
Key_Length_Specification key_spec () const
 
size_t maximum_keylength () const
 
size_t minimum_keylength () const
 
std::string name () const
 
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
 

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 Enumeration Documentation

anonymous enum
inherited

Member Function Documentation

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

Implements Botan::BlockCipher.

Definition at line 152 of file block_cipher.h.

152 { return BS; }
void Botan::Noekeon::clear ( )
virtual

Implements Botan::SymmetricAlgorithm.

Definition at line 206 of file noekeon.cpp.

References Botan::zap().

207  {
208  zap(EK);
209  zap(DK);
210  }
void zap(std::vector< T, Alloc > &vec)
Definition: secmem.h:176
BlockCipher* Botan::Noekeon::clone ( ) const
inlinevirtual
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; }
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 57 of file block_cipher.h.

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

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

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

92  {
93  return decrypt_n(&block[0], &block[0], block.size() / block_size());
94  }
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 114 of file block_cipher.h.

116  {
117  return decrypt_n(&in[0], &out[0], in.size() / block_size());
118  }
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
virtual

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

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

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

48  { 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 66 of file block_cipher.h.

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

82  {
83  return encrypt_n(&block[0], &block[0], block.size() / block_size());
84  }
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 102 of file block_cipher.h.

104  {
105  return encrypt_n(&in[0], &out[0], in.size() / block_size());
106  }
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
virtual

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

88  {
89  for(size_t i = 0; i != blocks; ++i)
90  {
91  u32bit A0 = load_be<u32bit>(in, 0);
92  u32bit A1 = load_be<u32bit>(in, 1);
93  u32bit A2 = load_be<u32bit>(in, 2);
94  u32bit A3 = load_be<u32bit>(in, 3);
95 
96  for(size_t j = 0; j != 16; ++j)
97  {
98  A0 ^= RC[j];
99  theta(A0, A1, A2, A3, &EK[0]);
100 
101  A1 = rotate_left(A1, 1);
102  A2 = rotate_left(A2, 5);
103  A3 = rotate_left(A3, 2);
104 
105  gamma(A0, A1, A2, A3);
106 
107  A1 = rotate_right(A1, 1);
108  A2 = rotate_right(A2, 5);
109  A3 = rotate_right(A3, 2);
110  }
111 
112  A0 ^= RC[16];
113  theta(A0, A1, A2, A3, &EK[0]);
114 
115  store_be(out, A0, A1, A2, A3);
116 
117  in += BLOCK_SIZE;
118  out += BLOCK_SIZE;
119  }
120  }
T rotate_left(T input, size_t rot)
Definition: rotate.h:21
T rotate_right(T input, size_t rot)
Definition: rotate.h:34
static const byte RC[17]
Definition: noekeon.h:31
uint32_t u32bit
Definition: types.h:32
u32bit load_be< u32bit >(const byte in[], size_t off)
Definition: loadstor.h:166
void store_be(u16bit in, byte out[2])
Definition: loadstor.h:412
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 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 EK; }
Key_Length_Specification Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD >::key_spec ( ) const
inlinevirtualinherited
Returns
object describing limits on key size

Implements Botan::SymmetricAlgorithm.

Definition at line 154 of file block_cipher.h.

155  {
156  return Key_Length_Specification(KMIN, KMAX, KMOD);
157  }
size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const
inlineinherited
Returns
minimum allowed key length

Definition at line 36 of file sym_algo.h.

Referenced by Botan::PBE_PKCS5v20::PBE_PKCS5v20().

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
inlinevirtual

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

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

36  {
37  return parallelism() * block_size() * BOTAN_BLOCK_CIPHER_PAR_MULT;
38  }
virtual size_t parallelism() const
Definition: block_cipher.h:30
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 30 of file block_cipher.h.

30 { return 1; }
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_Filter::MAC_Filter(), and Botan::StreamCipher_Filter::StreamCipher_Filter().

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[0], 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: