Botan::Buffered_Computation Class Reference

#include <buf_comp.h>

Inheritance diagram for Botan::Buffered_Computation:

Public Member Functions
template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>
T	final ()
void	final (std::span< uint8_t > out)
template<concepts::resizable_byte_buffer T>
void	final (T &out)
void	final (uint8_t out[])
std::vector< uint8_t >	final_stdvec ()
virtual size_t	output_length () const =0
template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>
T	process (const uint8_t in[], size_t length)
template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>
T	process (std::span< const uint8_t > in)
template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>
T	process (std::string_view in)
void	update (const uint8_t in[], size_t length)
void	update (std::span< const uint8_t > in)
void	update (std::string_view str)
void	update (uint8_t in)
void	update_be (uint16_t val)
void	update_be (uint32_t val)
void	update_be (uint64_t val)
void	update_le (uint16_t val)
void	update_le (uint32_t val)
void	update_le (uint64_t val)
virtual	~Buffered_Computation ()=default

Detailed Description

This class represents any kind of computation which uses an internal state, such as hash functions or MACs

Definition at line 22 of file buf_comp.h.

Constructor & Destructor Documentation

~Buffered_Computation()

virtual Botan::Buffered_Computation::~Buffered_Computation ( )

virtualdefault

Member Function Documentation

final() [1/4]

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

T Botan::Buffered_Computation::final ( )

inline

Complete the computation and retrieve the final result as a container.

Returns

a contiguous container holding the result

Definition at line 104 of file buf_comp.h.

                {
         T output(output_length());
         final_result(output);
         return output;
      }

References output_length().

final() [2/4]

void Botan::Buffered_Computation::final

(

std::span< uint8_t >

out

)

Complete the computation and retrieve the final result

Parameters

out	the buffer to write the result to, must be output_length() bytes

Definition at line 54 of file buf_comp.cpp.

                                                     {
   BOTAN_ARG_CHECK(out.size() >= output_length(), "Output buffer has insufficient capacity");
   // Pass exactly output_length() bytes so that an oversized buffer has the
   // result written to its leading bytes with the remainder left untouched.
   final_result(out.first(output_length()));
}

References BOTAN_ARG_CHECK, and output_length().

final() [3/4]

template<concepts::resizable_byte_buffer T>

void Botan::Buffered_Computation::final ( T & out )

inline

Complete the computation and retrieve the final result

Parameters

out	a container which is resized to hold the result

Definition at line 127 of file buf_comp.h.

                         {
         out.resize(output_length());
         final_result(out);
      }

References output_length().

final() [4/4]

void Botan::Buffered_Computation::final ( uint8_t out[] )

inline

Complete the computation and retrieve the final result.

Parameters

out	The byte array to be filled with the result, which must be of length output_length()

Definition at line 97 of file buf_comp.h.

{ final_result({out, output_length()}); }

References output_length().

Referenced by Botan::expand_message_xmd(), final_stdvec(), Botan::PseudorandomKeyGeneration::gen(), Botan::TPM2::Verification_Operation::is_valid_signature(), Botan::mgf1_mask(), Botan::KMAC::operator=(), Botan::pbkdf2(), Botan::Sphincs_Hash_Functions_Sha2::PRF_msg(), process(), process(), process(), Botan::TPM2::Signature_Operation::sign(), and Botan::sm2_compute_za().

final_stdvec()

std::vector< uint8_t > Botan::Buffered_Computation::final_stdvec ( )

inline

Complete the computation and retrieve the final result

Returns

a std::vector holding the result

Definition at line 114 of file buf_comp.h.

{ return final<std::vector<uint8_t>>(); }

References final().

output_length()

virtual size_t Botan::Buffered_Computation::output_length ( ) const

pure virtual

Return the output length of this function

Returns

length of the output of this function in bytes

Implemented in Botan::Adler32, Botan::ANSI_X919_MAC, Botan::Ascon_Hash256, Botan::BLAKE2b, Botan::BLAKE2bMAC, Botan::BLAKE2s, Botan::CMAC, Botan::Comb4P, Botan::CRC24, Botan::CRC32, Botan::GMAC, Botan::GOST_34_11, Botan::HMAC, Botan::Keccak_1600, Botan::KMAC, Botan::MD4, Botan::MD5, Botan::Parallel, Botan::Poly1305, Botan::RawHashFunction, Botan::RIPEMD_160, Botan::SHA_1, Botan::SHA_224, Botan::SHA_256, Botan::SHA_384, Botan::SHA_3, Botan::SHA_512, Botan::SHA_512_256, Botan::SHAKE_128, Botan::SHAKE_256, Botan::SipHash, Botan::Skein_512, Botan::SM3, Botan::Streebog, Botan::TPM2::HashFunction, Botan::Truncated_Hash, and Botan::Whirlpool.

Referenced by Botan::expand_message_xmd(), final(), final(), final(), final(), Botan::PseudorandomKeyGeneration::gen(), Botan::mgf1_mask(), Botan::pbkdf2(), and Botan::HashFunction::security_level().

process() [1/3]

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

T Botan::Buffered_Computation::process ( const uint8_t in[], size_t length )

inline

Update and finalize computation. Does the same as calling update() and final() consecutively.

Parameters

in	the input to process as a byte array
length	the length of the byte array

Returns

the result of the call to final()

Definition at line 140 of file buf_comp.h.

                                                   {
         update(in, length);
         return final<T>();
      }

References final(), and update().

process() [2/3]

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

T Botan::Buffered_Computation::process ( std::span< const uint8_t > in )

inline

Update and finalize computation. Does the same as calling update() and final() consecutively.

Parameters

in	the input to process as a contiguous container

Returns

the result of the call to final()

Definition at line 164 of file buf_comp.h.

                                           {
         update(in);
         return final<T>();
      }

References final(), and update().

process() [3/3]

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

T Botan::Buffered_Computation::process ( std::string_view in )

inline

Update and finalize computation. Does the same as calling update() and final() consecutively.

Parameters

in	the input to process as a string

Returns

the result of the call to final()

Definition at line 152 of file buf_comp.h.

                                   {
         update(in);
         return final<T>();
      }

References final(), and update().

update() [1/4]

void Botan::Buffered_Computation::update ( const uint8_t in[], size_t length )

inline

Add new input to process.

Parameters

in	the input to process as a byte array
length	of param in in bytes

Definition at line 35 of file buf_comp.h.

{ add_data({in, length}); }

Referenced by Botan::expand_message_xmd(), Botan::PseudorandomKeyGeneration::gen(), Botan::LMOTS_Public_Key::LMOTS_Public_Key(), Botan::mgf1_mask(), Botan::pbkdf2(), Botan::Sphincs_Hash_Functions_Sha2::PRF_msg(), process(), process(), process(), and Botan::sm2_compute_za().

update() [2/4]

void Botan::Buffered_Computation::update ( std::span< const uint8_t > in )

inline

Add new input to process.

Parameters

in	the input to process as a contiguous data range

Definition at line 41 of file buf_comp.h.

{ add_data(in); }

update() [3/4]

void Botan::Buffered_Computation::update

(

std::string_view

str

)

Add new input to process.

Parameters

str	the input to process as a std::string_view. Will be interpreted as a byte array based on the strings encoding.

Definition at line 14 of file buf_comp.cpp.

                                                    {
   add_data(as_span_of_bytes(str));
}

References Botan::as_span_of_bytes().

update() [4/4]

void Botan::Buffered_Computation::update ( uint8_t in )

inline

Process a single byte.

Parameters

in	the byte to process

Definition at line 90 of file buf_comp.h.

{ add_data({&in, 1}); }

update_be() [1/3]

void Botan::Buffered_Computation::update_be

(

uint16_t

val

)

Add new input to process, encoded as a big-endian integer

Parameters

val	the value to process

Definition at line 18 of file buf_comp.cpp.

                                                 {
   uint8_t inb[sizeof(val)];
   store_be(val, inb);
   add_data({inb, sizeof(inb)});
}

References Botan::store_be().

Referenced by Botan::expand_message_xmd(), Botan::mgf1_mask(), and Botan::pbkdf2().

update_be() [2/3]

void Botan::Buffered_Computation::update_be

(

uint32_t

val

)

Add new input to process, encoded as a big-endian integer

Parameters

val	the value to process

Definition at line 24 of file buf_comp.cpp.

                                                 {
   uint8_t inb[sizeof(val)];
   store_be(val, inb);
   add_data({inb, sizeof(inb)});
}

References Botan::store_be().

update_be() [3/3]

void Botan::Buffered_Computation::update_be

(

uint64_t

val

)

Add new input to process, encoded as a big-endian integer

Parameters

val	the value to process

Definition at line 30 of file buf_comp.cpp.

                                                 {
   uint8_t inb[sizeof(val)];
   store_be(val, inb);
   add_data({inb, sizeof(inb)});
}

References Botan::store_be().

update_le() [1/3]

void Botan::Buffered_Computation::update_le

(

uint16_t

val

)

Add new input to process, encoded as a little-endian integer

Parameters

val	the value to process

Definition at line 36 of file buf_comp.cpp.

                                                 {
   uint8_t inb[sizeof(val)];
   store_le(val, inb);
   add_data({inb, sizeof(inb)});
}

References Botan::store_le().

update_le() [2/3]

void Botan::Buffered_Computation::update_le

(

uint32_t

val

)

Add new input to process, encoded as a little-endian integer

Parameters

val	the value to process

Definition at line 42 of file buf_comp.cpp.

                                                 {
   uint8_t inb[sizeof(val)];
   store_le(val, inb);
   add_data({inb, sizeof(inb)});
}

References Botan::store_le().

update_le() [3/3]

void Botan::Buffered_Computation::update_le

(

uint64_t

val

)

Add new input to process, encoded as a little-endian integer

Parameters

val	the value to process

Definition at line 48 of file buf_comp.cpp.

                                                 {
   uint8_t inb[sizeof(val)];
   store_le(val, inb);
   add_data({inb, sizeof(inb)});
}

References Botan::store_le().

---

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

• src/lib/base/buf_comp.h
• src/lib/base/buf_comp.cpp