#include <ascon_xof128.h>

Inheritance diagram for Botan::Ascon_XOF128:

Public Member Functions
bool	accepts_input () const override
	Ascon_XOF128 ()
size_t	block_size () const override
void	clear ()
std::unique_ptr< XOF >	copy_state () const override
virtual Key_Length_Specification	key_spec () const
std::string	name () const override
std::unique_ptr< XOF >	new_object () const override
template<size_t count>
std::array< uint8_t, count >	output ()
template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>
T	output (size_t bytes)
void	output (std::span< uint8_t > output)
uint8_t	output_next_byte ()
std::vector< uint8_t >	output_stdvec (size_t bytes)
std::string	provider () const override
void	start (std::span< const uint8_t > salt={}, std::span< const uint8_t > key={})
void	update (std::span< const uint8_t > input)
virtual bool	valid_salt_length (size_t salt_len) const

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

Detailed Description

Ascon-XOF128 (NIST SP.800-232 Section 5.2)

Definition at line 21 of file ascon_xof128.h.

Constructor & Destructor Documentation

◆ Ascon_XOF128()

Botan::Ascon_XOF128::Ascon_XOF128 ( )

Definition at line 35 of file ascon_xof128.cpp.

35: m_ascon_p(initial_state_of_ascon_xof_permutation) {}

Member Function Documentation

◆ accepts_input()

bool Botan::Ascon_XOF128::accepts_input ( ) const

inlineoverridevirtual

Typically, this is true for new objects and becomes false once output() was called for the first time.

Returns: true iff calling update() is legal in the current object state

Implements Botan::XOF.

Definition at line 31 of file ascon_xof128.h.

31{ return !m_output_generated; }

◆ block_size()

size_t Botan::Ascon_XOF128::block_size ( ) const

inlineoverridevirtual

Returns: the intrinsic processing block size of this XOF

Implements Botan::XOF.

Definition at line 29 of file ascon_xof128.h.

29{ return m_ascon_p.byte_rate(); }

◆ clear()

void Botan::XOF::clear ( )

inlineinherited

Reset the state.

Definition at line 64 of file xof.h.

                   {
         m_xof_started = false;
         reset();
      }

Referenced by Botan::Kyber_90s_Symmetric_Primitives::get_PRF(), Botan::Kyber_Modern_Symmetric_Primitives::get_PRF(), Botan::ML_KEM_Symmetric_Primitives::get_PRF(), Botan::Kyber_90s_Symmetric_Primitives::get_XOF(), Botan::Kyber_Modern_Symmetric_Primitives::get_XOF(), Botan::ML_KEM_Symmetric_Primitives::get_XOF(), and Botan::Dilithium_Symmetric_Primitives_Base::H().

◆ copy_state()

std::unique_ptr< XOF > Botan::Ascon_XOF128::copy_state ( ) const

overridevirtual

Return a new XOF object with the same state as *this.

If the XOF is not yet in the output phase, it efficiently allows using several messages with a common prefix. Otherwise, the copied state will produce the same output bit stream as the original object at the time of this invocation.

This function should be called clone but for consistency with other classes it is called copy_state.

Returns: new XOF object

Implements Botan::XOF.

Definition at line 37 of file ascon_xof128.cpp.

                                                  {
   return std::make_unique<Ascon_XOF128>(*this);
}

◆ create()

std::unique_ptr< XOF > Botan::XOF::create	(	std::string_view	algo_spec,
		std::string_view	provider = "" )

staticinherited

Create an instance based on a name, or return null if the algo/provider combination cannot be found. If provider is empty then best available is chosen.

Definition at line 28 of file xof.cpp.

                                                                                {
   const SCAN_Name req(algo_spec);
 
   if(!provider.empty() && provider != "base") {
      return nullptr;  // unknown provider
   }
 
#if defined(BOTAN_HAS_SHAKE_XOF)
   if(req.algo_name() == "SHAKE-128" && req.arg_count() == 0) {
      return std::make_unique<SHAKE_128_XOF>();
   }
   if(req.algo_name() == "SHAKE-256" && req.arg_count() == 0) {
      return std::make_unique<SHAKE_256_XOF>();
   }
#endif
 
#if defined(BOTAN_HAS_ASCON_XOF128)
   if(req.algo_name() == "Ascon-XOF128" && req.arg_count() == 0) {
      return std::make_unique<Ascon_XOF128>();
   }
#endif
 
   return nullptr;
}

References Botan::SCAN_Name::algo_name(), Botan::SCAN_Name::arg_count(), and provider().

Referenced by create_or_throw(), and ~XOF().

◆ create_or_throw()

std::unique_ptr< XOF > Botan::XOF::create_or_throw	(	std::string_view	algo_spec,
		std::string_view	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 Lookup_Error if not found.

Definition at line 54 of file xof.cpp.

                                                                                         {
   if(auto xof = XOF::create(algo_spec, provider)) {
      return xof;
   }
   throw Lookup_Error("XOF", algo_spec, provider);
}

References create(), and provider().

Referenced by Botan::AES_256_CTR_XOF::AES_256_CTR_XOF(), Botan::Classic_McEliece_Parameters::prg(), and ~XOF().

◆ key_spec()

virtual Key_Length_Specification Botan::XOF::key_spec ( ) const

inlinevirtualinherited

Returns: an object describing limits on the key size

Reimplemented in Botan::AES_256_CTR_XOF.

Definition at line 97 of file xof.h.

                                                        {
         // Keys are not supported by default
         return Key_Length_Specification(0);
      }

Referenced by start().

◆ name()

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

inlineoverridevirtual

Returns: the hash function name

Implements Botan::XOF.

Definition at line 25 of file ascon_xof128.h.

25{ return "Ascon-XOF128"; }

◆ new_object()

std::unique_ptr< XOF > Botan::Ascon_XOF128::new_object ( ) const

overridevirtual

Returns: new object representing the same algorithm as *this

Implements Botan::XOF.

Definition at line 41 of file ascon_xof128.cpp.

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

◆ output() [1/3]

template<size_t count>

std::array< uint8_t, count > Botan::XOF::output ( )

inlineinherited

Returns: the next count output bytes as a std::array<>.

Definition at line 163 of file xof.h.

                                        {
         std::array<uint8_t, count> out;  // NOLINT(*-member-init)
         generate_bytes(out);
         return out;
      }

◆ output() [2/3]

template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>

T Botan::XOF::output ( size_t bytes )

inlineinherited

Returns: the next bytes output bytes as the specified container type T.

Definition at line 153 of file xof.h.

                             {
         T out(bytes);
         generate_bytes(out);
         return out;
      }

Referenced by Botan::FrodoMatrix::make_sample_generator(), output(), output_stdvec(), and Botan::Kyber_Symmetric_Primitives::PRF().

◆ output() [3/3]

void Botan::XOF::output ( std::span< uint8_t > output )

inlineinherited

Fill output with the next output bytes. The number of bytes depends on the size of output.

Definition at line 181 of file xof.h.

181{ generate_bytes(output); }

Botan::XOF::output

T output(size_t bytes)

Definition xof.h:153

References output().

◆ output_next_byte()

uint8_t Botan::XOF::output_next_byte ( )

inlineinherited

Returns: the next single output byte

Definition at line 186 of file xof.h.

                                 {
         uint8_t out = 0;
         generate_bytes({&out, 1});
         return out;
      }

◆ output_stdvec()

std::vector< uint8_t > Botan::XOF::output_stdvec ( size_t bytes )

inlineinherited

Convenience overload to generate a std::vector<uint8_t>. Same as calling XOF::output<std::vector<uint8_t>>().

Returns: the next bytes output bytes as a byte vector.

Definition at line 175 of file xof.h.

175{ return output<std::vector<uint8_t>>(bytes); }

References output().

◆ provider()

std::string Botan::Ascon_XOF128::provider ( ) const

inlineoverridevirtual

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

Reimplemented from Botan::XOF.

Definition at line 27 of file ascon_xof128.h.

27{ return m_ascon_p.provider(); }

◆ providers()

std::vector< std::string > Botan::XOF::providers ( std::string_view algo_spec )

staticinherited

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

Parameters

algo_spec algorithm name

Definition at line 62 of file xof.cpp.

                                                            {
   return probe_providers_of<XOF>(algo_spec, {"base"});
}

References Botan::probe_providers_of().

Referenced by ~XOF().

◆ start()

void Botan::XOF::start	(	std::span< const uint8_t >	salt = {},
		std::span< const uint8_t >	key = {} )

inherited

Some XOFs can be parameterized with a salt and/or key. If required, this must be called before calling XOF::update().

See also: XOF::valid_salt_length(); XOF::key_spec()

Parameters

salt	a salt value to parameterize the XOF
key	a key to parameterize the XOF

Definition at line 70 of file xof.cpp.

                                                                       {
   if(!key_spec().valid_keylength(key.size())) {
      throw Invalid_Key_Length(name(), key.size());
   }
 
   if(!valid_salt_length(salt.size())) {
      throw Invalid_Argument(fmt("{} cannot accept a salt length of {}", name(), salt.size()));
   }
 
   m_xof_started = true;
   start_msg(salt, key);
}

References Botan::fmt(), key_spec(), name(), and valid_salt_length().

Referenced by name(), and update().

◆ update()

void Botan::XOF::update ( std::span< const uint8_t > input )

inlineinherited

Add input data to the XOF's internal state

Parameters

input the data that shall be

Definition at line 140 of file xof.h.

                                                {
         if(!m_xof_started) {
            // If the user didn't start() before the first input, we enforce
            // it with a default value, here.
            start();
         }
         add_data(input);
      }

References start().

◆ valid_salt_length()

virtual bool Botan::XOF::valid_salt_length ( size_t salt_len ) const

inlinevirtualinherited

Returns: true if salt length is acceptable, false otherwise

Reimplemented in Botan::AES_256_CTR_XOF, and Botan::cSHAKE_XOF.

Definition at line 89 of file xof.h.

                                                            {
         // Salts are not supported by default
         return salt_len == 0;
      }

Referenced by start().

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

src/lib/xof/ascon_xof128/ascon_xof128.h
src/lib/xof/ascon_xof128/ascon_xof128.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Ascon_XOF128()

Member Function Documentation

◆ accepts_input()

◆ block_size()

◆ clear()

◆ copy_state()

◆ create()

◆ create_or_throw()

◆ key_spec()

◆ name()

◆ new_object()

◆ output() [1/3]

◆ output() [2/3]

◆ output() [3/3]

◆ output_next_byte()

◆ output_stdvec()

◆ provider()

◆ providers()

◆ start()

◆ update()

◆ valid_salt_length()