Botan 3.0.0-alpha0
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 (const std::string &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 ( const std::string &  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 90 of file entropy_srcs.cpp.

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

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: