Botan  2.4.0
Crypto and TLS for C++11
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::Darwin_SecRandom Botan::Device_EntropySource Botan::Getentropy Botan::Intel_Rdrand Botan::Intel_Rdseed Botan::ProcWalking_EntropySource 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 66 of file entropy_srcs.cpp.

References BOTAN_UNUSED.

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

67  {
68 #if defined(BOTAN_HAS_SYSTEM_RNG)
69  if(name == "system_rng" || name == "win32_cryptoapi")
70  {
71  return std::unique_ptr<Entropy_Source>(new System_RNG_EntropySource);
72  }
73 #endif
74 
75 #if defined(BOTAN_HAS_ENTROPY_SRC_RDRAND)
76  if(name == "rdrand")
77  {
78  return std::unique_ptr<Entropy_Source>(new Intel_Rdrand);
79  }
80 #endif
81 
82 #if defined(BOTAN_HAS_ENTROPY_SRC_RDSEED)
83  if(name == "rdseed")
84  {
85  return std::unique_ptr<Entropy_Source>(new Intel_Rdseed);
86  }
87 #endif
88 
89 #if defined(BOTAN_HAS_ENTROPY_SRC_DARWIN_SECRANDOM)
90  if(name == "darwin_secrandom")
91  {
92  return std::unique_ptr<Entropy_Source>(new Darwin_SecRandom);
93  }
94 #endif
95 
96 #if defined(BOTAN_HAS_ENTROPY_SRC_GETENTROPY)
97  if(name == "getentropy")
98  {
99  return std::unique_ptr<Entropy_Source>(new Getentropy);
100  }
101 #endif
102 
103 #if defined(BOTAN_HAS_ENTROPY_SRC_DEV_RANDOM)
104  if(name == "dev_random")
105  {
106  return std::unique_ptr<Entropy_Source>(new Device_EntropySource(BOTAN_SYSTEM_RNG_POLL_DEVICES));
107  }
108 #endif
109 
110 #if defined(BOTAN_HAS_ENTROPY_SRC_PROC_WALKER)
111  if(name == "proc_walk")
112  {
113  const std::string root_dir = BOTAN_ENTROPY_PROC_FS_PATH;
114  if(!root_dir.empty())
115  return std::unique_ptr<Entropy_Source>(new ProcWalking_EntropySource(root_dir));
116  }
117 #endif
118 
119 #if defined(BOTAN_HAS_ENTROPY_SRC_WIN32)
120  if(name == "system_stats")
121  {
122  return std::unique_ptr<Entropy_Source>(new Win32_EntropySource);
123  }
124 #endif
125 
127  return std::unique_ptr<Entropy_Source>();
128  }
virtual std::string name() const =0
#define BOTAN_UNUSED(...)
Definition: assert.h:106

◆ name()

virtual std::string Botan::Entropy_Source::name ( ) const
pure virtual

◆ 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::ProcWalking_EntropySource, Botan::Device_EntropySource, Botan::Darwin_SecRandom, Botan::Getentropy, Botan::Intel_Rdrand, Botan::Intel_Rdseed, and Botan::Win32_EntropySource.


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