#include <entropy_src.h>

Inheritance diagram for Botan::Entropy_Accumulator:

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 (size_t goal)
MemoryRegion< byte > &	get_io_buffer (size_t size)
bool	polling_goal_achieved () const
virtual	~Entropy_Accumulator ()

Detailed Description

Class used to accumulate the poll results of EntropySources

Definition at line 19 of file entropy_src.h.

Constructor & Destructor Documentation

◆ Entropy_Accumulator()

Botan::Entropy_Accumulator::Entropy_Accumulator ( size_t goal )

inline

Initialize an Entropy_Accumulator

Parameters

goal	is how many bits we would like to collect

Definition at line 26 of file entropy_src.h.

26 :

27 entropy_goal(goal), collected_bits(0) {}

Referenced by Botan::Entropy_Accumulator_BufferedComputation::Entropy_Accumulator_BufferedComputation().

◆ ~Entropy_Accumulator()

virtual Botan::Entropy_Accumulator::~Entropy_Accumulator ( )

inlinevirtual

Definition at line 29 of file entropy_src.h.

29{}

Member Function Documentation

◆ add() [1/2]

template<typename T>

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

inline

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 )

inline

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

inline

Returns: number of bits collected so far

Definition at line 44 of file entropy_src.h.

45 { 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

inline

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);
         }