Botan 3.3.0
Crypto and TLS for C&
Public Member Functions | Static Public Member Functions | List of all members
Botan::Entropy_Source Class Referenceabstract

#include <entropy_src.h>

Inheritance diagram for Botan::Entropy_Source:
Botan::Getentropy Botan::Intel_Rdseed Botan::Win32_EntropySource

Public Member Functions

 Entropy_Source ()=default
 
 Entropy_Source (const Entropy_Source &other)=delete
 
 Entropy_Source (Entropy_Source &&other)=delete
 
virtual std::string name () const =0
 
Entropy_Sourceoperator= (const Entropy_Source &other)=delete
 
virtual size_t poll (RandomNumberGenerator &rng)=0
 
virtual ~Entropy_Source ()=default
 

Static Public Member Functions

static std::unique_ptr< Entropy_Sourcecreate (std::string_view type)
 

Detailed Description

Abstract interface to a source of entropy

Definition at line 25 of file entropy_src.h.

Constructor & Destructor Documentation

◆ Entropy_Source() [1/3]

Botan::Entropy_Source::Entropy_Source ( )
default

◆ Entropy_Source() [2/3]

Botan::Entropy_Source::Entropy_Source ( const Entropy_Source & other)
delete

◆ Entropy_Source() [3/3]

Botan::Entropy_Source::Entropy_Source ( Entropy_Source && other)
delete

◆ ~Entropy_Source()

virtual Botan::Entropy_Source::~Entropy_Source ( )
virtualdefault

Member Function Documentation

◆ create()

std::unique_ptr< Entropy_Source > Botan::Entropy_Source::create ( std::string_view type)
static

Return a new entropy source of a particular type, or null Each entropy source may require substantial resources (eg, a file handle or socket instance), so try to share them among multiple RNGs, or just use the preconfigured global list accessed by Entropy_Sources::global_sources()

Definition at line 88 of file entropy_srcs.cpp.

88 {
89#if defined(BOTAN_HAS_SYSTEM_RNG)
90 if(name == "system_rng") {
91 return std::make_unique<System_RNG_EntropySource>();
92 }
93#endif
94
95#if defined(BOTAN_HAS_PROCESSOR_RNG)
96 if(name == "hwrng") {
98 return std::make_unique<Processor_RNG_EntropySource>();
99 }
100 }
101#endif
102
103#if defined(BOTAN_HAS_ENTROPY_SRC_RDSEED)
104 if(name == "rdseed") {
105 return std::make_unique<Intel_Rdseed>();
106 }
107#endif
108
109#if defined(BOTAN_HAS_ENTROPY_SRC_GETENTROPY)
110 if(name == "getentropy") {
111 return std::make_unique<Getentropy>();
112 }
113#endif
114
115#if defined(BOTAN_HAS_ENTROPY_SRC_WIN32)
116 if(name == "system_stats") {
117 return std::make_unique<Win32_EntropySource>();
118 }
119#endif
120
122 return nullptr;
123}
#define BOTAN_UNUSED
Definition assert.h:118
virtual std::string name() const =0

References Botan::Processor_RNG::available(), BOTAN_UNUSED, and name().

Referenced by Botan::Entropy_Sources::Entropy_Sources().

◆ name()

virtual std::string Botan::Entropy_Source::name ( ) const
pure virtual
Returns
name identifying this entropy source

Implemented in Botan::Getentropy, Botan::Intel_Rdseed, and Botan::Win32_EntropySource.

Referenced by create().

◆ operator=()

Entropy_Source & Botan::Entropy_Source::operator= ( const Entropy_Source & other)
delete

◆ poll()

virtual size_t Botan::Entropy_Source::poll ( RandomNumberGenerator & rng)
pure virtual

Perform an entropy gathering poll

Parameters
rngwill be provided with entropy via calls to add_entropy
Returns
conservative estimate of actual entropy added to rng during poll

Implemented in Botan::Getentropy, Botan::Intel_Rdseed, and Botan::Win32_EntropySource.


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