Botan::SHAKE_128_Cipher Class Reference

#include <shake_cipher.h>

Inheritance diagram for Botan::SHAKE_128_Cipher:

Public Member Functions
void	cipher (const uint8_t in[], uint8_t out[], size_t length) override
void	cipher1 (uint8_t buf[], size_t len)
void	clear () override
StreamCipher *	clone () const
template<typename Alloc >
void	decrypt (std::vector< uint8_t, Alloc > &inout)
virtual size_t	default_iv_length () const
template<typename Alloc >
void	encipher (std::vector< uint8_t, Alloc > &inout)
template<typename Alloc >
void	encrypt (std::vector< uint8_t, Alloc > &inout)
Key_Length_Specification	key_spec () const override
size_t	maximum_keylength () const
size_t	minimum_keylength () const
std::string	name () const override
std::unique_ptr< StreamCipher >	new_object () const override
virtual std::string	provider () const
void	seek (uint64_t offset) override
void	set_iv (const uint8_t iv[], size_t iv_len) override
template<typename Alloc >
void	set_key (const std::vector< uint8_t, Alloc > &key)
void	set_key (const SymmetricKey &key)
void	set_key (const uint8_t key[], size_t length)
	SHAKE_128_Cipher ()
virtual bool	valid_iv_length (size_t iv_len) const
bool	valid_keylength (size_t length) const
virtual void	write_keystream (uint8_t out[], size_t len)

Static Public Member Functions
static std::unique_ptr< StreamCipher >	create (const std::string &algo_spec, const std::string &provider="")
static std::unique_ptr< StreamCipher >	create_or_throw (const std::string &algo_spec, const std::string &provider="")
static std::vector< std::string >	providers (const std::string &algo_spec)

Protected Member Functions
void	verify_key_set (bool cond) const

Detailed Description

SHAKE-128 XOF presented as a stream cipher

Definition at line 19 of file shake_cipher.h.

Constructor & Destructor Documentation

SHAKE_128_Cipher()

Botan::SHAKE_128_Cipher::SHAKE_128_Cipher

(

)

Definition at line 15 of file shake_cipher.cpp.

                                   :
   m_buf_pos(0)
   {}

Member Function Documentation

cipher()

void Botan::SHAKE_128_Cipher::cipher ( const uint8_t  in[], uint8_t  out[], size_t  length  )

overridevirtual

Produce more XOF output

Implements Botan::StreamCipher.

Definition at line 19 of file shake_cipher.cpp.

   {
   const size_t SHAKE_128_BYTERATE = (1600-256)/8;
 
   verify_key_set(m_state.empty() == false);
 
   while(length >= SHAKE_128_BYTERATE - m_buf_pos)
      {
      xor_buf(out, in, &m_buffer[m_buf_pos], SHAKE_128_BYTERATE - m_buf_pos);
      length -= (SHAKE_128_BYTERATE - m_buf_pos);
      in += (SHAKE_128_BYTERATE - m_buf_pos);
      out += (SHAKE_128_BYTERATE - m_buf_pos);
 
      SHA_3::permute(m_state.data());
      copy_out_le(m_buffer.data(), SHAKE_128_BYTERATE, m_state.data());
 
      m_buf_pos = 0;
      }
   xor_buf(out, in, &m_buffer[m_buf_pos], length);
   m_buf_pos += length;
   }

References Botan::copy_out_le(), Botan::SHA_3::permute(), Botan::SymmetricAlgorithm::verify_key_set(), and Botan::xor_buf().

cipher1()

void Botan::StreamCipher::cipher1 ( uint8_t  buf[], size_t  len  )

inlineinherited

Encrypt or decrypt a message The message is encrypted/decrypted in place.

Parameters

buf	the plaintext / ciphertext
len	the length of buf in bytes

Definition at line 78 of file stream_cipher.h.

         { cipher(buf, buf, len); }

Referenced by Botan::SIV_Encryption::finish().

clear()

void Botan::SHAKE_128_Cipher::clear ( )

overridevirtual

Reset the state.

Implements Botan::SymmetricAlgorithm.

Definition at line 53 of file shake_cipher.cpp.

   {
   zap(m_state);
   zap(m_buffer);
   m_buf_pos = 0;
   }

References Botan::zap().

clone()

StreamCipher * Botan::StreamCipher::clone ( ) const

inlineinherited

Returns

a new object representing the same algorithm as *this

Definition at line 130 of file stream_cipher.h.

         {
         return this->new_object().release();
         }

create()

std::unique_ptr< StreamCipher > Botan::StreamCipher::create ( const std::string &  algo_spec, const std::string &  provider = ""  )

staticinherited

Create an instance based on a name If provider is empty then best available is chosen.

Parameters

algo_spec	algorithm name
provider	provider implementation to use

Returns

a null pointer if the algo/provider combination cannot be found

Definition at line 38 of file stream_cipher.cpp.

   {
   const SCAN_Name req(algo_spec);
 
#if defined(BOTAN_HAS_CTR_BE)
   if((req.algo_name() == "CTR-BE" || req.algo_name() == "CTR") && req.arg_count_between(1,2))
      {
      if(provider.empty() || provider == "base")
         {
         auto cipher = BlockCipher::create(req.arg(0));
         if(cipher)
            {
            size_t ctr_size = req.arg_as_integer(1, cipher->block_size());
            return std::make_unique<CTR_BE>(std::move(cipher), ctr_size);
            }
         }
      }
#endif
 
#if defined(BOTAN_HAS_CHACHA)
   if(req.algo_name() == "ChaCha")
      {
      if(provider.empty() || provider == "base")
         return std::make_unique<ChaCha>(req.arg_as_integer(0, 20));
      }
 
   if(req.algo_name() == "ChaCha20")
      {
      if(provider.empty() || provider == "base")
         return std::make_unique<ChaCha>(20);
      }
#endif
 
#if defined(BOTAN_HAS_SALSA20)
   if(req.algo_name() == "Salsa20")
      {
      if(provider.empty() || provider == "base")
         return std::make_unique<Salsa20>();
      }
#endif
 
#if defined(BOTAN_HAS_SHAKE_CIPHER)
   if(req.algo_name() == "SHAKE-128" || req.algo_name() == "SHAKE-128-XOF")
      {
      if(provider.empty() || provider == "base")
         return std::make_unique<SHAKE_128_Cipher>();
      }
#endif
 
#if defined(BOTAN_HAS_OFB)
   if(req.algo_name() == "OFB" && req.arg_count() == 1)
      {
      if(provider.empty() || provider == "base")
         {
         if(auto cipher = BlockCipher::create(req.arg(0)))
            return std::make_unique<OFB>(std::move(cipher));
         }
      }
#endif
 
#if defined(BOTAN_HAS_RC4)
 
   if(req.algo_name() == "RC4" ||
      req.algo_name() == "ARC4" ||
      req.algo_name() == "MARK-4")
      {
      const size_t skip = (req.algo_name() == "MARK-4") ? 256 : req.arg_as_integer(0, 0);
 
      if(provider.empty() || provider == "base")
         {
         return std::make_unique<RC4>(skip);
         }
      }
 
#endif
 
   BOTAN_UNUSED(req);
   BOTAN_UNUSED(provider);
 
   return nullptr;
   }

References Botan::SCAN_Name::algo_name(), Botan::SCAN_Name::arg(), Botan::SCAN_Name::arg_as_integer(), Botan::SCAN_Name::arg_count(), Botan::SCAN_Name::arg_count_between(), BOTAN_UNUSED, Botan::StreamCipher::cipher(), Botan::BlockCipher::create(), and Botan::StreamCipher::provider().

Referenced by Botan::Cipher_Mode::create(), Botan::BlockCipher::create(), and Botan::StreamCipher::create_or_throw().

create_or_throw()

std::unique_ptr< StreamCipher > Botan::StreamCipher::create_or_throw ( const std::string &  algo_spec, const std::string &  provider = ""  )

staticinherited

Create an instance based on a name If provider is empty then best available is chosen.

Parameters

algo_spec	algorithm name
provider	provider implementation to use Throws a Lookup_Error if the algo/provider combination cannot be found

Definition at line 123 of file stream_cipher.cpp.

   {
   if(auto sc = StreamCipher::create(algo, provider))
      {
      return sc;
      }
   throw Lookup_Error("Stream cipher", algo, provider);
   }

References Botan::StreamCipher::create(), and Botan::StreamCipher::provider().

Referenced by Botan::ChaCha_RNG::ChaCha_RNG(), Botan::Sodium::crypto_secretbox_detached(), Botan::Sodium::crypto_secretbox_open_detached(), Botan::Sodium::crypto_secretbox_xsalsa20poly1305(), Botan::Sodium::crypto_secretbox_xsalsa20poly1305_open(), Botan::Sodium::crypto_stream_chacha20(), Botan::Sodium::crypto_stream_chacha20_ietf(), Botan::Sodium::crypto_stream_chacha20_ietf_xor_ic(), Botan::Sodium::crypto_stream_chacha20_xor_ic(), Botan::Sodium::crypto_stream_xchacha20(), Botan::Sodium::crypto_stream_xchacha20_xor_ic(), Botan::Kyber_90s_Symmetric_Primitives::PRF(), and Botan::Kyber_90s_Symmetric_Primitives::XOF().

decrypt()

template<typename Alloc >

void Botan::StreamCipher::decrypt ( std::vector< uint8_t, Alloc > &  inout )

inlineinherited

Decrypt a message in place The message is decrypted in place.

Parameters

inout

the plaintext / ciphertext

Definition at line 105 of file stream_cipher.h.

         { cipher(inout.data(), inout.data(), inout.size()); }

default_iv_length()

virtual size_t Botan::StreamCipher::default_iv_length ( ) const

inlinevirtualinherited

Return the default (preferred) nonce length If this function returns 0, then this cipher does not support nonces

Reimplemented in Botan::ChaCha, Botan::CTR_BE, Botan::OFB, and Botan::Salsa20.

Definition at line 119 of file stream_cipher.h.

{ return 0; }

encipher()

template<typename Alloc >

void Botan::StreamCipher::encipher ( std::vector< uint8_t, Alloc > &  inout )

inlineinherited

Encrypt a message The message is encrypted/decrypted in place.

Parameters

inout

the plaintext / ciphertext

Definition at line 87 of file stream_cipher.h.

         { cipher(inout.data(), inout.data(), inout.size()); }

encrypt()

template<typename Alloc >

void Botan::StreamCipher::encrypt ( std::vector< uint8_t, Alloc > &  inout )

inlineinherited

Encrypt a message The message is encrypted in place.

Parameters

inout

the plaintext / ciphertext

Definition at line 96 of file stream_cipher.h.

         { cipher(inout.data(), inout.data(), inout.size()); }

key_spec()

Key_Length_Specification Botan::SHAKE_128_Cipher::key_spec ( ) const

overridevirtual

Returns

object describing limits on key size

Implements Botan::SymmetricAlgorithm.

Definition at line 75 of file shake_cipher.cpp.

   {
   return Key_Length_Specification(1, 160);
   }

maximum_keylength()

size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const

inlineinherited

Returns

maximum allowed key length

Definition at line 120 of file sym_algo.h.

         {
         return key_spec().maximum_keylength();
         }

minimum_keylength()

size_t Botan::SymmetricAlgorithm::minimum_keylength ( ) const

inlineinherited

Returns

minimum allowed key length

Definition at line 128 of file sym_algo.h.

         {
         return key_spec().minimum_keylength();
         }

Referenced by botan_block_cipher_get_keyspec(), and botan_mac_get_keyspec().

name()

std::string Botan::SHAKE_128_Cipher::name ( ) const

overridevirtual

Returns

the algorithm name

Implements Botan::SymmetricAlgorithm.

Definition at line 80 of file shake_cipher.cpp.

   {
   return "SHAKE-128";
   }

Referenced by set_iv().

new_object()

std::unique_ptr< StreamCipher > Botan::SHAKE_128_Cipher::new_object ( ) const

overridevirtual

Returns

new object representing the same algorithm as *this

Implements Botan::StreamCipher.

Definition at line 85 of file shake_cipher.cpp.

   {
   return std::make_unique<SHAKE_128_Cipher>();
   }

provider()

virtual std::string Botan::StreamCipher::provider ( ) const

inlinevirtualinherited

Returns

provider information about this implementation. Default is "base", might also return "sse2", "avx2" or some other arbitrary string.

Reimplemented in Botan::ChaCha.

Definition at line 150 of file stream_cipher.h.

{ return "base"; }

Referenced by Botan::StreamCipher::create(), and Botan::StreamCipher::create_or_throw().

providers()

std::vector< std::string > Botan::StreamCipher::providers ( const std::string &  algo_spec )

staticinherited

Returns

list of available providers for this algorithm, empty if not available

Definition at line 133 of file stream_cipher.cpp.

   {
   return probe_providers_of<StreamCipher>(algo_spec);
   }

seek()

void Botan::SHAKE_128_Cipher::seek ( uint64_t  offset )

overridevirtual

Seeking is not supported, this function will throw

Implements Botan::StreamCipher.

Definition at line 70 of file shake_cipher.cpp.

   {
   throw Not_Implemented("SHAKE_128_Cipher::seek");
   }

set_iv()

void Botan::SHAKE_128_Cipher::set_iv ( const uint8_t  iv[], size_t  iv_len  )

overridevirtual

IV not supported, this function will throw unless iv_len == 0

Implements Botan::StreamCipher.

Definition at line 60 of file shake_cipher.cpp.

   {
   /*
   * This could be supported in some way (say, by treating iv as
   * a prefix or suffix of the key).
   */
   if(length != 0)
      throw Invalid_IV_Length(name(), length);
   }

References name().

set_key() [1/3]

template<typename Alloc >

void Botan::SymmetricAlgorithm::set_key ( const std::vector< uint8_t, Alloc > &  key )

inlineinherited

Definition at line 153 of file sym_algo.h.

         {
         set_key(key.data(), key.size());
         }

set_key() [2/3]

void Botan::SymmetricAlgorithm::set_key ( const SymmetricKey &  key )

inlineinherited

Set the symmetric key of this object.

Parameters

key	the SymmetricKey to be set.

Definition at line 147 of file sym_algo.h.

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

References Botan::OctetString::begin(), and Botan::OctetString::length().

Referenced by botan_cipher_set_key(), botan_mac_set_key(), Botan::Sodium::crypto_stream_salsa20(), Botan::Sodium::crypto_stream_salsa20_xor_ic(), Botan::Sodium::crypto_stream_xsalsa20(), Botan::Sodium::crypto_stream_xsalsa20_xor_ic(), Botan::FPE::fe1_decrypt(), Botan::FPE::fe1_encrypt(), and Botan::Sodium::randombytes_buf_deterministic().

set_key() [3/3]

void Botan::SymmetricAlgorithm::set_key ( const uint8_t  key[], size_t  length  )

inherited

Set the symmetric key of this object.

Parameters

key	the to be set as a byte array.
length	in bytes of key param

Definition at line 17 of file sym_algo.cpp.

   {
   if(!valid_keylength(length))
      throw Invalid_Key_Length(name(), length);
   key_schedule(key, length);
   }

References Botan::SymmetricAlgorithm::name(), and Botan::SymmetricAlgorithm::valid_keylength().

valid_iv_length()

virtual bool Botan::StreamCipher::valid_iv_length ( size_t  iv_len ) const

inlinevirtualinherited

Parameters

iv_len

the length of the IV in bytes

Returns

if the length is valid for this algorithm

Reimplemented in Botan::ChaCha, Botan::CTR_BE, Botan::OFB, and Botan::Salsa20.

Definition at line 125 of file stream_cipher.h.

{ return (iv_len == 0); }

valid_keylength()

bool Botan::SymmetricAlgorithm::valid_keylength ( size_t  length ) const

inlineinherited

Check whether a given key length is valid for this algorithm.

Parameters

length

the key length to be checked.

Returns

true if the key length is valid.

Definition at line 138 of file sym_algo.h.

         {
         return key_spec().valid_keylength(length);
         }

Referenced by Botan::SymmetricAlgorithm::set_key().

verify_key_set()

void Botan::SymmetricAlgorithm::verify_key_set ( bool  cond ) const

inlineprotectedinherited

Definition at line 171 of file sym_algo.h.

         {
         if(cond == false)
            throw_key_not_set_error();
         }

Referenced by Botan::ChaCha::cipher(), Botan::CTR_BE::cipher(), Botan::RC4::cipher(), Botan::Salsa20::cipher(), cipher(), Botan::AES_128::decrypt_n(), Botan::AES_192::decrypt_n(), Botan::AES_256::decrypt_n(), Botan::ARIA_128::decrypt_n(), Botan::ARIA_192::decrypt_n(), Botan::ARIA_256::decrypt_n(), Botan::Blowfish::decrypt_n(), Botan::Camellia_128::decrypt_n(), Botan::Camellia_192::decrypt_n(), Botan::Camellia_256::decrypt_n(), Botan::CAST_128::decrypt_n(), Botan::DES::decrypt_n(), Botan::TripleDES::decrypt_n(), Botan::GOST_28147_89::decrypt_n(), Botan::IDEA::decrypt_n(), Botan::Lion::decrypt_n(), Botan::Noekeon::decrypt_n(), Botan::SEED::decrypt_n(), Botan::Serpent::decrypt_n(), Botan::SHACAL2::decrypt_n(), Botan::SM4::decrypt_n(), Botan::Threefish_512::decrypt_n(), Botan::Twofish::decrypt_n(), Botan::AES_128::encrypt_n(), Botan::AES_192::encrypt_n(), Botan::AES_256::encrypt_n(), Botan::ARIA_128::encrypt_n(), Botan::ARIA_192::encrypt_n(), Botan::ARIA_256::encrypt_n(), Botan::Blowfish::encrypt_n(), Botan::Camellia_128::encrypt_n(), Botan::Camellia_192::encrypt_n(), Botan::Camellia_256::encrypt_n(), Botan::CAST_128::encrypt_n(), Botan::DES::encrypt_n(), Botan::TripleDES::encrypt_n(), Botan::GOST_28147_89::encrypt_n(), Botan::IDEA::encrypt_n(), Botan::Lion::encrypt_n(), Botan::Noekeon::encrypt_n(), Botan::SEED::encrypt_n(), Botan::Serpent::encrypt_n(), Botan::SHACAL2::encrypt_n(), Botan::SM4::encrypt_n(), Botan::Threefish_512::encrypt_n(), Botan::Twofish::encrypt_n(), Botan::OCB_Encryption::finish(), Botan::OCB_Decryption::finish(), Botan::GHASH::ghash_update(), Botan::CFB_Encryption::process(), Botan::CFB_Decryption::process(), Botan::ChaCha::seek(), Botan::CTR_BE::seek(), Botan::Salsa20::seek(), Botan::OCB_Mode::set_associated_data(), Botan::ChaCha::set_iv(), Botan::Salsa20::set_iv(), Botan::GHASH::update(), Botan::GHASH::update_associated_data(), and Botan::ChaCha::write_keystream().

write_keystream()

virtual void Botan::StreamCipher::write_keystream ( uint8_t  out[], size_t  len  )

inlinevirtualinherited

Write keystream bytes to a buffer

Parameters

out	the byte array to hold the keystream
len	the length of out in bytes

Reimplemented in Botan::ChaCha.

Definition at line 66 of file stream_cipher.h.

         {
         clear_mem(out, len);
         cipher1(out, len);
         }

References Botan::clear_mem().

Referenced by Botan::Sodium::crypto_stream_salsa20(), and Botan::Sodium::crypto_stream_xsalsa20().

---

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

• src/lib/stream/shake_cipher/shake_cipher.h
• src/lib/stream/shake_cipher/shake_cipher.cpp