Botan::Ascon_p Class Reference

#include <ascon_perm.h>

Inheritance diagram for Botan::Ascon_p:

Classes
struct	Config

Public Types
using	state_t
using	word_t

Public Member Functions
size_t &	_cursor ()
void	absorb (std::span< const uint8_t > input, std::optional< uint8_t > permutation_rounds=std::nullopt)
consteval	Ascon_p (Config config)
constexpr size_t	bit_capacity () const
constexpr size_t	bit_rate () const
constexpr size_t	byte_capacity () const
constexpr size_t	byte_rate () const
size_t	cursor () const
void	finish ()
void	initial_permute ()
void	intermediate_finish ()
void	percolate_in (std::span< uint8_t > data)
void	percolate_out (std::span< uint8_t > data)
void	permute ()
std::string	provider () const
template<size_t offset, size_t count> requires (offset + count <= state_bytes())
constexpr auto	range_of_state ()
void	squeeze (std::span< uint8_t > output)
constexpr auto &	state ()

Static Public Member Functions
static constexpr size_t	state_bits ()
static constexpr size_t	state_bytes ()

Static Public Attributes
static constexpr size_t	word_bits
static constexpr size_t	word_bytes

Protected Member Functions
void	reset_cursor ()

Detailed Description

Ascon_p as specified in NIST SP.800-232, Section 3

Definition at line 22 of file ascon_perm.h.

Member Typedef Documentation

state_t

using Botan::Sponge< words, word >::state_t

inherited

Definition at line 29 of file sponge.h.

word_t

using Botan::Sponge< words, word >::word_t

inherited

Definition at line 28 of file sponge.h.

Constructor & Destructor Documentation

Ascon_p()

Botan::Ascon_p::Ascon_p ( Config config )

inlineexplicitconsteval

Definition at line 32 of file ascon_perm.h.

                                                :
            Sponge({config.bit_rate, config.initial_state}),
            m_init_final_rounds(config.init_and_final_rounds),
            m_processing_rounds(config.processing_rounds) {
         BOTAN_ARG_CHECK(m_init_final_rounds > 0 && m_init_final_rounds <= 16,
                         "Invalid Ascon initialization/finalization rounds");
 
         BOTAN_ARG_CHECK(m_processing_rounds > 0 && m_processing_rounds <= 16, "Invalid Ascon processing rounds");
      }

References Botan::Ascon_p::Config::bit_rate, Botan::Ascon_p::Config::initial_state, and Botan::Sponge< 5, uint64_t >::Sponge().

Member Function Documentation

_cursor()

size_t & Botan::Sponge< words, word >::_cursor ( )

inlineinherited

Definition at line 59 of file sponge.h.

{ return m_S_cursor; }

absorb()

void Botan::Ascon_p::absorb	(	std::span< const uint8_t >	input,
		std::optional< uint8_t >	permutation_rounds = std::nullopt )

Definition at line 17 of file ascon_perm.cpp.

                                                                                          {
   const auto rounds = permutation_rounds.value_or(m_processing_rounds);
   absorb_into_sponge(*this, input, [this, rounds] { permute(rounds); });
}

References Botan::absorb_into_sponge(), and permute().

bit_capacity()

size_t Botan::Sponge< words, word >::bit_capacity ( ) const

inlineconstexprinherited

Definition at line 51 of file sponge.h.

{ return state_bits() - bit_rate(); }

bit_rate()

size_t Botan::Sponge< words, word >::bit_rate ( ) const

inlineconstexprinherited

Definition at line 47 of file sponge.h.

{ return m_bit_rate; }

byte_capacity()

size_t Botan::Sponge< words, word >::byte_capacity ( ) const

inlineconstexprinherited

Definition at line 53 of file sponge.h.

{ return state_bytes() - byte_rate(); }

byte_rate()

size_t Botan::Sponge< words, word >::byte_rate ( ) const

inlineconstexprinherited

Definition at line 49 of file sponge.h.

{ return m_bit_rate / 8; }

cursor()

size_t Botan::Sponge< words, word >::cursor ( ) const

inlineinherited

Definition at line 57 of file sponge.h.

{ return m_S_cursor; }

finish()

void Botan::Ascon_p::finish ( )

inline

Definition at line 49 of file ascon_perm.h.

{ finish(m_init_final_rounds); }

References finish().

Referenced by finish(), and intermediate_finish().

initial_permute()

void Botan::Ascon_p::initial_permute ( )

inline

Definition at line 55 of file ascon_perm.h.

{ permute(m_init_final_rounds); }

References permute().

intermediate_finish()

void Botan::Ascon_p::intermediate_finish ( )

inline

Definition at line 51 of file ascon_perm.h.

{ finish(m_processing_rounds); }

References finish().

percolate_in()

void Botan::Ascon_p::percolate_in

(

std::span< uint8_t >

data

)

Definition at line 26 of file ascon_perm.cpp.

                                                {
   BufferSlicer input_slicer(data);
   BufferStuffer output_stuffer(data);
 
   process_bytes_in_sponge(*this, data.size(), [&](uint64_t state_word, auto bounds) {
      state_word ^= bounds.read_from(input_slicer);
      bounds.write_into(output_stuffer, state_word);
      return state_word;
   });
 
   BOTAN_ASSERT_NOMSG(input_slicer.empty());
   BOTAN_ASSERT_NOMSG(output_stuffer.full());
}

References BOTAN_ASSERT_NOMSG, Botan::BufferSlicer::empty(), Botan::BufferStuffer::full(), and Botan::process_bytes_in_sponge().

percolate_out()

void Botan::Ascon_p::percolate_out

(

std::span< uint8_t >

data

)

Definition at line 40 of file ascon_perm.cpp.

                                                 {
   BufferSlicer input_slicer(data);
   BufferStuffer output_stuffer(data);
 
   process_bytes_in_sponge(*this, data.size(), [&](uint64_t state_word, auto bounds) {
      const auto input_word = bounds.read_from(input_slicer);
      bounds.write_into(output_stuffer, state_word ^ input_word);
      return bounds.masked_assignment(state_word, input_word);
   });
 
   BOTAN_ASSERT_NOMSG(input_slicer.empty());
   BOTAN_ASSERT_NOMSG(output_stuffer.full());
}

References BOTAN_ASSERT_NOMSG, Botan::BufferSlicer::empty(), Botan::BufferStuffer::full(), and Botan::process_bytes_in_sponge().

permute()

void Botan::Ascon_p::permute ( )

inline

Definition at line 53 of file ascon_perm.h.

{ permute(m_processing_rounds); }

References permute().

Referenced by absorb(), initial_permute(), and permute().

provider()

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

inline

Definition at line 42 of file ascon_perm.h.

{ return "base"; }

range_of_state()

template<size_t offset, size_t count>
requires (offset + count <= state_bytes())

auto Botan::Ascon_p::range_of_state ( )

inlineconstexpr

Definition at line 59 of file ascon_perm.h.

                                      {
         return std::span{state()}.template subspan<offset, count>();
      }

References Botan::Sponge< 5, uint64_t >::state().

reset_cursor()

void Botan::Sponge< words, word >::reset_cursor ( )

inlineprotectedinherited

Definition at line 62 of file sponge.h.

{ m_S_cursor = 0; }

squeeze()

void Botan::Ascon_p::squeeze

(

std::span< uint8_t >

output

)

Definition at line 22 of file ascon_perm.cpp.

                                             {
   squeeze_from_sponge(*this, output);
}

References Botan::squeeze_from_sponge().

state()

auto & Botan::Sponge< words, word >::state ( )

inlineconstexprinherited

Definition at line 55 of file sponge.h.

{ return m_S; }

Referenced by Botan::Ascon_p::range_of_state().

state_bits()

constexpr size_t Botan::Sponge< words, word >::state_bits ( )

inlinestaticconstexprinherited

Definition at line 45 of file sponge.h.

{ return state_bytes() * 8; }

state_bytes()

constexpr size_t Botan::Sponge< words, word >::state_bytes ( )

inlinestaticconstexprinherited

Definition at line 43 of file sponge.h.

{ return sizeof(state_t); }

Member Data Documentation

word_bits

size_t Botan::Sponge< words, word >::word_bits

staticconstexprinherited

Definition at line 31 of file sponge.h.

word_bytes

size_t Botan::Sponge< words, word >::word_bytes

staticconstexprinherited

Definition at line 30 of file sponge.h.

---

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

• src/lib/permutations/ascon_perm/ascon_perm.h
• src/lib/permutations/ascon_perm/ascon_perm.cpp