Botan  1.10.9
Public Types | Public Member Functions | List of all members
Botan::Skipjack Class Reference

#include <skipjack.h>

Inheritance diagram for Botan::Skipjack:
Botan::Block_Cipher_Fixed_Params< 8, 10 > Botan::BlockCipher Botan::SymmetricAlgorithm Botan::Algorithm

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
 
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
 
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)
 
void set_key (const byte key[], size_t length)
 
 Skipjack ()
 
bool valid_keylength (size_t length) const
 

Detailed Description

Skipjack, a NSA designed cipher used in Fortezza

Definition at line 18 of file skipjack.h.

Member Enumeration Documentation

anonymous enum
inherited

Constructor & Destructor Documentation

Botan::Skipjack::Skipjack ( )
inline

Definition at line 28 of file skipjack.h.

28 : FTAB(2560) {}

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

108 { return BS; }
void Botan::Skipjack::clear ( )
virtual

Zeroize internal state

Implements Botan::Algorithm.

Definition at line 194 of file skipjack.cpp.

References Botan::zeroise().

195  {
196  zeroise(FTAB);
197  }
void zeroise(MemoryRegion< T > &vec)
Definition: secmem.h:415
BlockCipher* Botan::Skipjack::clone ( ) const
inlinevirtual

Get a new object representing the same algorithm as *this

Implements Botan::BlockCipher.

Definition at line 26 of file skipjack.h.

26 { return new Skipjack; }
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().

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
void Botan::Skipjack::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 119 of file skipjack.cpp.

References Botan::Block_Cipher_Fixed_Params< 8, 10 >::BLOCK_SIZE, Botan::load_le< u16bit >(), and Botan::store_le().

120  {
121  const byte* ftab = &FTAB[0];
122 
123  for(size_t i = 0; i != blocks; ++i)
124  {
125  u16bit W1 = load_le<u16bit>(in, 3);
126  u16bit W2 = load_le<u16bit>(in, 2);
127  u16bit W3 = load_le<u16bit>(in, 1);
128  u16bit W4 = load_le<u16bit>(in, 0);
129 
130  step_Bi(W2, W3, 32, ftab); step_Bi(W3, W4, 31, ftab);
131  step_Bi(W4, W1, 30, ftab); step_Bi(W1, W2, 29, ftab);
132  step_Bi(W2, W3, 28, ftab); step_Bi(W3, W4, 27, ftab);
133  step_Bi(W4, W1, 26, ftab); step_Bi(W1, W2, 25, ftab);
134 
135  step_Ai(W1, W2, 24, ftab); step_Ai(W2, W3, 23, ftab);
136  step_Ai(W3, W4, 22, ftab); step_Ai(W4, W1, 21, ftab);
137  step_Ai(W1, W2, 20, ftab); step_Ai(W2, W3, 19, ftab);
138  step_Ai(W3, W4, 18, ftab); step_Ai(W4, W1, 17, ftab);
139 
140  step_Bi(W2, W3, 16, ftab); step_Bi(W3, W4, 15, ftab);
141  step_Bi(W4, W1, 14, ftab); step_Bi(W1, W2, 13, ftab);
142  step_Bi(W2, W3, 12, ftab); step_Bi(W3, W4, 11, ftab);
143  step_Bi(W4, W1, 10, ftab); step_Bi(W1, W2, 9, ftab);
144 
145  step_Ai(W1, W2, 8, ftab); step_Ai(W2, W3, 7, ftab);
146  step_Ai(W3, W4, 6, ftab); step_Ai(W4, W1, 5, ftab);
147  step_Ai(W1, W2, 4, ftab); step_Ai(W2, W3, 3, ftab);
148  step_Ai(W3, W4, 2, ftab); step_Ai(W4, W1, 1, ftab);
149 
150  store_le(out, W4, W3, W2, W1);
151 
152  in += BLOCK_SIZE;
153  out += BLOCK_SIZE;
154  }
155  }
void store_le(u16bit in, byte out[2])
Definition: loadstor.h:427
unsigned char byte
Definition: types.h:22
unsigned short u16bit
Definition: types.h:27
u16bit load_le< u16bit >(const byte in[], size_t off)
Definition: loadstor.h:149
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::OFB::cipher(), Botan::DESX::encrypt_n(), Botan::CFB_Encryption::set_iv(), Botan::OFB::set_iv(), Botan::XTS_Encryption::set_iv(), Botan::CFB_Decryption::set_iv(), and Botan::XTS_Decryption::set_iv().

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
void Botan::Skipjack::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 78 of file skipjack.cpp.

References Botan::Block_Cipher_Fixed_Params< 8, 10 >::BLOCK_SIZE, Botan::load_le< u16bit >(), and Botan::store_le().

79  {
80  const byte* ftab = &FTAB[0];
81 
82  for(size_t i = 0; i != blocks; ++i)
83  {
84  u16bit W1 = load_le<u16bit>(in, 3);
85  u16bit W2 = load_le<u16bit>(in, 2);
86  u16bit W3 = load_le<u16bit>(in, 1);
87  u16bit W4 = load_le<u16bit>(in, 0);
88 
89  step_A(W1, W4, 1, ftab); step_A(W4, W3, 2, ftab);
90  step_A(W3, W2, 3, ftab); step_A(W2, W1, 4, ftab);
91  step_A(W1, W4, 5, ftab); step_A(W4, W3, 6, ftab);
92  step_A(W3, W2, 7, ftab); step_A(W2, W1, 8, ftab);
93 
94  step_B(W1, W2, 9, ftab); step_B(W4, W1, 10, ftab);
95  step_B(W3, W4, 11, ftab); step_B(W2, W3, 12, ftab);
96  step_B(W1, W2, 13, ftab); step_B(W4, W1, 14, ftab);
97  step_B(W3, W4, 15, ftab); step_B(W2, W3, 16, ftab);
98 
99  step_A(W1, W4, 17, ftab); step_A(W4, W3, 18, ftab);
100  step_A(W3, W2, 19, ftab); step_A(W2, W1, 20, ftab);
101  step_A(W1, W4, 21, ftab); step_A(W4, W3, 22, ftab);
102  step_A(W3, W2, 23, ftab); step_A(W2, W1, 24, ftab);
103 
104  step_B(W1, W2, 25, ftab); step_B(W4, W1, 26, ftab);
105  step_B(W3, W4, 27, ftab); step_B(W2, W3, 28, ftab);
106  step_B(W1, W2, 29, ftab); step_B(W4, W1, 30, ftab);
107  step_B(W3, W4, 31, ftab); step_B(W2, W3, 32, ftab);
108 
109  store_le(out, W4, W3, W2, W1);
110 
111  in += BLOCK_SIZE;
112  out += BLOCK_SIZE;
113  }
114  }
void store_le(u16bit in, byte out[2])
Definition: loadstor.h:427
unsigned char byte
Definition: types.h:22
unsigned short u16bit
Definition: types.h:27
u16bit load_le< u16bit >(const byte in[], size_t off)
Definition: loadstor.h:149
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  {
112  return Key_Length_Specification(KMIN, KMAX, KMOD);
113  }
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: 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 41 of file sym_algo.h.

42  {
43  return key_spec().minimum_keylength();
44  }
size_t minimum_keylength() const
Definition: key_spec.h:61
virtual Key_Length_Specification key_spec() const =0
std::string Botan::Skipjack::name ( ) const
inlinevirtual
Returns
name of this algorithm

Implements Botan::Algorithm.

Definition at line 25 of file skipjack.h.

25 { return "Skipjack"; }
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.

References block_size.

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
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  {
70  if(!valid_keylength(length))
71  throw Invalid_Key_Length(name(), length);
72  key_schedule(key, length);
73  }
bool valid_keylength(size_t length) const
Definition: sym_algo.h:51
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 51 of file sym_algo.h.

Referenced by Botan::aont_package(), Botan::aont_unpackage(), Botan::HMAC_RNG::HMAC_RNG(), Botan::Lion::Lion(), Botan::Randpool::Randpool(), and Botan::EAX_Base::valid_keylength().

52  {
53  return key_spec().valid_keylength(length);
54  }
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: