Botan  1.11.30
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Botan::GOST_28147_89 Class Referencefinal

#include <gost_28147.h>

Inheritance diagram for Botan::GOST_28147_89:
Botan::Block_Cipher_Fixed_Params< 8, 32 > Botan::BlockCipher Botan::SymmetricAlgorithm

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
 
 GOST_28147_89 (const GOST_28147_89_Params &params)
 
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)
 

Detailed Description

GOST 28147-89

Definition at line 52 of file gost_28147.h.

Member Typedef Documentation

Definition at line 22 of file block_cipher.h.

Member Enumeration Documentation

anonymous enum
inherited

Constructor & Destructor Documentation

Botan::GOST_28147_89::GOST_28147_89 ( const GOST_28147_89_Params params)
explicit
Parameters
paramsthe sbox parameters to use

Definition at line 53 of file gost_28147.cpp.

References Botan::rotate_left(), and Botan::GOST_28147_89_Params::sbox_entry().

53  : m_SBOX(1024)
54  {
55  // Convert the parallel 4x4 sboxes into larger word-based sboxes
56  for(size_t i = 0; i != 4; ++i)
57  for(size_t j = 0; j != 256; ++j)
58  {
59  const u32bit T = (param.sbox_entry(2*i , j % 16)) |
60  (param.sbox_entry(2*i+1, j / 16) << 4);
61  m_SBOX[256*i+j] = rotate_left(T, (11+8*i) % 32);
62  }
63  }
T rotate_left(T input, size_t rot)
Definition: rotate.h:21
std::uint32_t u32bit
Definition: types.h:33

Member Function Documentation

size_t Botan::Block_Cipher_Fixed_Params< BS, KMIN, 0 , 1 >::block_size ( ) const
inlineoverridevirtualinherited
Returns
block size of this algorithm

Implements Botan::BlockCipher.

Definition at line 169 of file block_cipher.h.

169 { return BS; }
void Botan::GOST_28147_89::clear ( )
overridevirtual

Implements Botan::SymmetricAlgorithm.

Definition at line 171 of file gost_28147.cpp.

References Botan::zap().

Referenced by Botan::GOST_34_11::clear().

172  {
173  zap(m_EK);
174  }
void zap(std::vector< T, Alloc > &vec)
Definition: secmem.h:196
BlockCipher* Botan::GOST_28147_89::clone ( ) const
inlineoverridevirtual
Returns
new object representing the same algorithm as *this

Implements Botan::BlockCipher.

Definition at line 61 of file gost_28147.h.

61 { return new GOST_28147_89(m_SBOX); }
GOST_28147_89(const GOST_28147_89_Params &params)
Definition: gost_28147.cpp:53
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::GOST_28147_89::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.

Definition at line 135 of file gost_28147.cpp.

References Botan::Block_Cipher_Fixed_Params< 8, 32 >::BLOCK_SIZE, GOST_2ROUND, Botan::load_le< u32bit >(), and Botan::store_le().

136  {
137  for(size_t i = 0; i != blocks; ++i)
138  {
139  u32bit N1 = load_le<u32bit>(in, 0);
140  u32bit N2 = load_le<u32bit>(in, 1);
141 
142  GOST_2ROUND(N1, N2, 0, 1);
143  GOST_2ROUND(N1, N2, 2, 3);
144  GOST_2ROUND(N1, N2, 4, 5);
145  GOST_2ROUND(N1, N2, 6, 7);
146 
147  for(size_t j = 0; j != 3; ++j)
148  {
149  GOST_2ROUND(N1, N2, 7, 6);
150  GOST_2ROUND(N1, N2, 5, 4);
151  GOST_2ROUND(N1, N2, 3, 2);
152  GOST_2ROUND(N1, N2, 1, 0);
153  }
154 
155  store_le(out, N2, N1);
156  in += BLOCK_SIZE;
157  out += BLOCK_SIZE;
158  }
159  }
void store_le(u16bit in, byte out[2])
Definition: loadstor.h:461
std::uint32_t u32bit
Definition: types.h:33
u32bit load_le< u32bit >(const byte in[], size_t off)
Definition: loadstor.h:204
#define GOST_2ROUND(N1, N2, R1, R2)
Definition: gost_28147.cpp:87
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::GOST_28147_89::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.

Definition at line 105 of file gost_28147.cpp.

References Botan::Block_Cipher_Fixed_Params< 8, 32 >::BLOCK_SIZE, GOST_2ROUND, Botan::load_le< u32bit >(), and Botan::store_le().

106  {
107  for(size_t i = 0; i != blocks; ++i)
108  {
109  u32bit N1 = load_le<u32bit>(in, 0);
110  u32bit N2 = load_le<u32bit>(in, 1);
111 
112  for(size_t j = 0; j != 3; ++j)
113  {
114  GOST_2ROUND(N1, N2, 0, 1);
115  GOST_2ROUND(N1, N2, 2, 3);
116  GOST_2ROUND(N1, N2, 4, 5);
117  GOST_2ROUND(N1, N2, 6, 7);
118  }
119 
120  GOST_2ROUND(N1, N2, 7, 6);
121  GOST_2ROUND(N1, N2, 5, 4);
122  GOST_2ROUND(N1, N2, 3, 2);
123  GOST_2ROUND(N1, N2, 1, 0);
124 
125  store_le(out, N2, N1);
126 
127  in += BLOCK_SIZE;
128  out += BLOCK_SIZE;
129  }
130  }
void store_le(u16bit in, byte out[2])
Definition: loadstor.h:461
std::uint32_t u32bit
Definition: types.h:33
u32bit load_le< u32bit >(const byte in[], size_t off)
Definition: loadstor.h:204
#define GOST_2ROUND(N1, N2, R1, R2)
Definition: gost_28147.cpp:87
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::GOST_28147_89::name ( ) const
overridevirtual

Implements Botan::SymmetricAlgorithm.

Definition at line 65 of file gost_28147.cpp.

66  {
67  /*
68  'Guess' the right name for the sbox on the basis of the values.
69  This would need to be updated if support for other sbox parameters
70  is added. Preferably, we would just store the string value in the
71  constructor, but can't break binary compat.
72  */
73  std::string sbox_name = "";
74  if(m_SBOX[0] == 0x00072000)
75  sbox_name = "R3411_94_TestParam";
76  else if(m_SBOX[0] == 0x0002D000)
77  sbox_name = "R3411_CryptoPro";
78  else
79  throw Internal_Error("GOST-28147 unrecognized sbox value");
80 
81  return "GOST-28147-89(" + sbox_name + ")";
82  }
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::CBC_Mode::update_granularity(), and Botan::ECB_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

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