Botan::Entropy_Accumulator_BufferedComputation Class Reference

#include <entropy_src.h>

Inheritance diagram for Botan::Entropy_Accumulator_BufferedComputation:

Public Member Functions
template<typename T>
void	add (const T &v, double entropy_bits_per_byte)
void	add (const void *bytes, size_t length, double entropy_bits_per_byte)
size_t	bits_collected () const
size_t	desired_remaining_bits () const
	Entropy_Accumulator_BufferedComputation (Buffered_Computation &sink, size_t goal)
MemoryRegion< byte > &	get_io_buffer (size_t size)
bool	polling_goal_achieved () const

Detailed Description

Entropy accumulator that puts the input into a Buffered_Computation

Definition at line 98 of file entropy_src.h.

Constructor & Destructor Documentation

Entropy_Accumulator_BufferedComputation()

Botan::Entropy_Accumulator_BufferedComputation::Entropy_Accumulator_BufferedComputation ( Buffered_Computation & sink, size_t goal )

inline

Parameters

sink	the hash or MAC we are feeding the poll data into
goal	is how many bits we want to collect in this poll

Definition at line 106 of file entropy_src.h.

                                                           :
         Entropy_Accumulator(goal), entropy_sink(sink) {}

References Botan::Entropy_Accumulator::Entropy_Accumulator().

Member Function Documentation

add() [1/2]

template<typename T>

void Botan::Entropy_Accumulator::add ( const T & v, double entropy_bits_per_byte )

inlineinherited

Add entropy to the accumulator

Parameters

v	is some value
entropy_bits_per_byte	is a best guess at how much entropy per byte is in this input

Definition at line 83 of file entropy_src.h.

         {
         add(&v, sizeof(T), entropy_bits_per_byte);
         }

References add().

add() [2/2]

void Botan::Entropy_Accumulator::add ( const void * bytes, size_t length, double entropy_bits_per_byte )

inlineinherited

Add entropy to the accumulator

Parameters

bytes	the input bytes
length	specifies how many bytes the input is
entropy_bits_per_byte	is a best guess at how much entropy per byte is in this input

Definition at line 70 of file entropy_src.h.

         {
         add_bytes(reinterpret_cast<const byte*>(bytes), length);
         collected_bits += entropy_bits_per_byte * length;
         }

Referenced by add(), Botan::Device_EntropySource::poll(), Botan::EGD_EntropySource::poll(), Botan::FTW_EntropySource::poll(), Botan::High_Resolution_Timestamp::poll(), Botan::Intel_Rdrand::poll(), Botan::Unix_EntropySource::poll(), Botan::Win32_CAPI_EntropySource::poll(), and Botan::Win32_EntropySource::poll().

bits_collected()

size_t Botan::Entropy_Accumulator::bits_collected ( ) const

inlineinherited

Returns

number of bits collected so far

Definition at line 44 of file entropy_src.h.

         { return static_cast<size_t>(collected_bits); }

Referenced by Botan::HMAC_RNG::reseed(), and Botan::Randpool::reseed().

desired_remaining_bits()

size_t Botan::Entropy_Accumulator::desired_remaining_bits ( ) const

inlineinherited

Returns

how many bits we need to reach our polling goal

Definition at line 56 of file entropy_src.h.

         {
         if(collected_bits >= entropy_goal)
            return 0;
         return static_cast<size_t>(entropy_goal - collected_bits);
         }

Referenced by Botan::Device_EntropySource::poll(), and Botan::EGD_EntropySource::poll().

get_io_buffer()

MemoryRegion< byte > & Botan::Entropy_Accumulator::get_io_buffer ( size_t size )

inlineinherited

Get a cached I/O buffer (purely for minimizing allocation overhead to polls)

Parameters

size	requested size for the I/O buffer

Returns

cached I/O buffer for repeated polls

Definition at line 38 of file entropy_src.h.

         { io_buffer.resize(size); return io_buffer; }

References Botan::MemoryRegion< T >::resize().

Referenced by Botan::Device_EntropySource::poll(), Botan::EGD_EntropySource::poll(), Botan::FTW_EntropySource::poll(), Botan::Unix_EntropySource::poll(), and Botan::Win32_CAPI_EntropySource::poll().

polling_goal_achieved()

bool Botan::Entropy_Accumulator::polling_goal_achieved ( ) const

inlineinherited

Returns

if our polling goal has been achieved

Definition at line 50 of file entropy_src.h.

         { return (collected_bits >= entropy_goal); }

Referenced by Botan::FTW_EntropySource::poll(), Botan::Unix_EntropySource::poll(), Botan::Win32_EntropySource::poll(), Botan::HMAC_RNG::reseed(), and Botan::Randpool::reseed().

---

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

• src/entropy/entropy_src.h