Botan  1.11.17
Public Types | Public Member Functions | List of all members
Botan::KASUMI Class Reference

#include <kasumi.h>

Inheritance diagram for Botan::KASUMI:
Botan::Block_Cipher_Fixed_Params< 8, 16 > Botan::BlockCipher Botan::SymmetricAlgorithm

Public Types

enum  
 
typedef SCAN_Name Spec
 

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
 

Detailed Description

KASUMI, the block cipher used in 3G telephony

Definition at line 18 of file kasumi.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
inlinevirtualinherited
Returns
block size of this algorithm

Implements Botan::BlockCipher.

Definition at line 154 of file block_cipher.h.

154 { return BS; }
void Botan::KASUMI::clear ( )
virtual

Implements Botan::SymmetricAlgorithm.

Definition at line 230 of file kasumi.cpp.

References Botan::zap().

231  {
232  zap(EK);
233  }
void zap(std::vector< T, Alloc > &vec)
Definition: secmem.h:178
BlockCipher* Botan::KASUMI::clone ( ) const
inlinevirtual
Returns
new object representing the same algorithm as *this

Implements Botan::BlockCipher.

Definition at line 26 of file kasumi.h.

26 { return new KASUMI; }
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 59 of file block_cipher.h.

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

60  { 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 76 of file block_cipher.h.

76 { 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 93 of file block_cipher.h.

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

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

Definition at line 157 of file kasumi.cpp.

References Botan::Block_Cipher_Fixed_Params< 8, 16 >::BLOCK_SIZE, Botan::load_be< u16bit >(), Botan::rotate_left(), and Botan::store_be().

158  {
159  for(size_t i = 0; i != blocks; ++i)
160  {
161  u16bit B0 = load_be<u16bit>(in, 0);
162  u16bit B1 = load_be<u16bit>(in, 1);
163  u16bit B2 = load_be<u16bit>(in, 2);
164  u16bit B3 = load_be<u16bit>(in, 3);
165 
166  for(size_t j = 0; j != 8; j += 2)
167  {
168  const u16bit* K = &EK[8*(6-j)];
169 
170  u16bit L = B2, R = B3;
171 
172  L = FI(L ^ K[10], K[11]) ^ R;
173  R = FI(R ^ K[12], K[13]) ^ L;
174  L = FI(L ^ K[14], K[15]) ^ R;
175 
176  L ^= (rotate_left(R, 1) & K[8]);
177  R ^= (rotate_left(L, 1) | K[9]);
178 
179  R = B0 ^= R;
180  L = B1 ^= L;
181 
182  L ^= (rotate_left(R, 1) & K[0]);
183  R ^= (rotate_left(L, 1) | K[1]);
184 
185  R = FI(R ^ K[2], K[3]) ^ L;
186  L = FI(L ^ K[4], K[5]) ^ R;
187  R = FI(R ^ K[6], K[7]) ^ L;
188 
189  B2 ^= L;
190  B3 ^= R;
191  }
192 
193  store_be(out, B0, B1, B2, B3);
194 
195  in += BLOCK_SIZE;
196  out += BLOCK_SIZE;
197  }
198  }
T rotate_left(T input, size_t rot)
Definition: rotate.h:21
u16bit load_be< u16bit >(const byte in[], size_t off)
Definition: loadstor.h:133
uint16_t u16bit
Definition: types.h:32
void store_be(u16bit in, byte out[2])
Definition: loadstor.h:413
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 49 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_Encryption::update(), Botan::CBC_Encryption::update(), and Botan::CFB_Decryption::update().

50  { 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 68 of file block_cipher.h.

68 { 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 83 of file block_cipher.h.

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

106  {
107  return encrypt_n(&in[0], &out[0], in.size() / block_size());
108  }
virtual void encrypt_n(const byte in[], byte out[], size_t blocks) const =0
virtual size_t block_size() const =0
void Botan::KASUMI::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.

Definition at line 113 of file kasumi.cpp.

References Botan::Block_Cipher_Fixed_Params< 8, 16 >::BLOCK_SIZE, Botan::load_be< u16bit >(), Botan::rotate_left(), and Botan::store_be().

114  {
115  for(size_t i = 0; i != blocks; ++i)
116  {
117  u16bit B0 = load_be<u16bit>(in, 0);
118  u16bit B1 = load_be<u16bit>(in, 1);
119  u16bit B2 = load_be<u16bit>(in, 2);
120  u16bit B3 = load_be<u16bit>(in, 3);
121 
122  for(size_t j = 0; j != 8; j += 2)
123  {
124  const u16bit* K = &EK[8*j];
125 
126  u16bit R = B1 ^ (rotate_left(B0, 1) & K[0]);
127  u16bit L = B0 ^ (rotate_left(R, 1) | K[1]);
128 
129  L = FI(L ^ K[ 2], K[ 3]) ^ R;
130  R = FI(R ^ K[ 4], K[ 5]) ^ L;
131  L = FI(L ^ K[ 6], K[ 7]) ^ R;
132 
133  R = B2 ^= R;
134  L = B3 ^= L;
135 
136  R = FI(R ^ K[10], K[11]) ^ L;
137  L = FI(L ^ K[12], K[13]) ^ R;
138  R = FI(R ^ K[14], K[15]) ^ L;
139 
140  R ^= (rotate_left(L, 1) & K[8]);
141  L ^= (rotate_left(R, 1) | K[9]);
142 
143  B0 ^= L;
144  B1 ^= R;
145  }
146 
147  store_be(out, B0, B1, B2, B3);
148 
149  in += BLOCK_SIZE;
150  out += BLOCK_SIZE;
151  }
152  }
T rotate_left(T input, size_t rot)
Definition: rotate.h:21
u16bit load_be< u16bit >(const byte in[], size_t off)
Definition: loadstor.h:133
uint16_t u16bit
Definition: types.h:32
void store_be(u16bit in, byte out[2])
Definition: loadstor.h:413
Key_Length_Specification Botan::Block_Cipher_Fixed_Params< BS, KMIN, 0 , 1 >::key_spec ( ) const
inlinevirtualinherited
Returns
object describing limits on key size

Implements Botan::SymmetricAlgorithm.

Definition at line 156 of file block_cipher.h.

157  {
158  return Key_Length_Specification(KMIN, KMAX, KMOD);
159  }
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::KASUMI::name ( ) const
inlinevirtual

Implements Botan::SymmetricAlgorithm.

Definition at line 25 of file kasumi.h.

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

Definition at line 37 of file block_cipher.h.

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

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

32 { 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_set_key(), Botan::TLS::Session::decrypt(), Botan::TLS::Session::encrypt(), and Botan::pbkdf2().

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

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