Botan 1.10.17
Botan::KASUMI Class Reference

#include <kasumi.h>

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

Public Types

enum  

Public Member Functions

size_t block_size () const
void clear ()
BlockCipherclone () const
void decrypt (byte block[]) const
void decrypt (const byte in[], byte out[]) const
void decrypt_n (const byte in[], byte out[], size_t blocks) const
void encrypt (byte block[]) const
void encrypt (const byte in[], byte out[]) const
void encrypt_n (const byte in[], byte out[], size_t blocks) const
 KASUMI ()
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 byte key[], size_t length)
void set_key (const SymmetricKey &key)
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 Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited

Definition at line 107 of file block_cipher.h.

Constructor & Destructor Documentation

◆ KASUMI()

Botan::KASUMI::KASUMI ( )
inline

Definition at line 28 of file kasumi.h.

28: EK(64) {}

Referenced by clone().

Member Function Documentation

◆ block_size()

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

108{ return BS; }

◆ clear()

void Botan::KASUMI::clear ( )
inlinevirtual

Zeroize internal state

Implements Botan::Algorithm.

Definition at line 24 of file kasumi.h.

24{ zeroise(EK); }
void zeroise(MemoryRegion< T > &vec)
Definition secmem.h:428

References Botan::zeroise().

◆ clone()

BlockCipher * Botan::KASUMI::clone ( ) const
inlinevirtual

Get a new object representing the same algorithm as *this

Implements Botan::BlockCipher.

Definition at line 26 of file kasumi.h.

26{ return new KASUMI; }

References KASUMI().

◆ decrypt() [1/2]

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); }

◆ decrypt() [2/2]

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.

58 { decrypt_n(in, out, 1); }

◆ decrypt_n()

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 156 of file kasumi.cpp.

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

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

◆ encrypt() [1/2]

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); }

◆ encrypt() [2/2]

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.

48 { encrypt_n(in, out, 1); }

◆ encrypt_n()

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 112 of file kasumi.cpp.

113 {
114 for(size_t i = 0; i != blocks; ++i)
115 {
116 u16bit B0 = load_be<u16bit>(in, 0);
117 u16bit B1 = load_be<u16bit>(in, 1);
118 u16bit B2 = load_be<u16bit>(in, 2);
119 u16bit B3 = load_be<u16bit>(in, 3);
120
121 for(size_t j = 0; j != 8; j += 2)
122 {
123 const u16bit* K = &EK[8*j];
124
125 u16bit R = B1 ^ (rotate_left(B0, 1) & K[0]);
126 u16bit L = B0 ^ (rotate_left(R, 1) | K[1]);
127
128 L = FI(L ^ K[ 2], K[ 3]) ^ R;
129 R = FI(R ^ K[ 4], K[ 5]) ^ L;
130 L = FI(L ^ K[ 6], K[ 7]) ^ R;
131
132 R = B2 ^= R;
133 L = B3 ^= L;
134
135 R = FI(R ^ K[10], K[11]) ^ L;
136 L = FI(L ^ K[12], K[13]) ^ R;
137 R = FI(R ^ K[14], K[15]) ^ L;
138
139 R ^= (rotate_left(L, 1) & K[8]);
140 L ^= (rotate_left(R, 1) | K[9]);
141
142 B0 ^= L;
143 B1 ^= R;
144 }
145
146 store_be(out, B0, B1, B2, B3);
147
148 in += BLOCK_SIZE;
149 out += BLOCK_SIZE;
150 }
151 }

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

◆ key_spec()

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

111 {
113 }
Key_Length_Specification(size_t keylen)
Definition key_spec.h:25

◆ maximum_keylength()

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

Definition at line 33 of file sym_algo.h.

34 {
35 return key_spec().maximum_keylength();
36 }
size_t maximum_keylength() const
Definition sym_algo.h:33

◆ minimum_keylength()

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

Definition at line 41 of file sym_algo.h.

42 {
43 return key_spec().minimum_keylength();
44 }
size_t minimum_keylength() const
Definition sym_algo.h:41

◆ name()

std::string Botan::KASUMI::name ( ) const
inlinevirtual
Returns
name of this algorithm

Implements Botan::Algorithm.

Definition at line 25 of file kasumi.h.

25{ return "KASUMI"; }

◆ parallel_bytes()

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.

36 {
38 }

◆ parallelism()

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

Definition at line 30 of file block_cipher.h.

30{ return 1; }

◆ set_key() [1/2]

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

69 {
73 }
Invalid_Key_Length(const std::string &name, size_t length)
Definition exceptn.h:57

◆ set_key() [2/2]

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

61 { set_key(key.begin(), key.length()); }

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

52 {
54 }
bool valid_keylength(size_t length) const
Definition sym_algo.h:51

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