openvpn::DevURand Class Reference

#include <devurand.hpp>

Inheritance diagram for openvpn::DevURand:

Collaboration diagram for openvpn::DevURand:

Public Types
typedef RCPtr< DevURand >	Ptr
Public Types inherited from openvpn::StrongRandomAPI
typedef RCPtr< StrongRandomAPI >	Ptr
	Smart pointer type for managing the ownership of StrongRandomAPI objects.
Public Types inherited from openvpn::RandomAPI
typedef RCPtr< RandomAPI >	Ptr
	Smart pointer type for managing the ownership of RandomAPI objects.
typedef unsigned int	result_type
Public Types inherited from openvpn::RC< thread_unsafe_refcount >
typedef RCPtr< RC >	Ptr

Public Member Functions
	OPENVPN_EXCEPTION (dev_urand_error)
	DevURand ()
std::string	name () const override
	Get the name of the random number generation algorithm.
void	rand_bytes (unsigned char *buf, size_t size) override
	Fill a buffer with random bytes.
bool	rand_bytes_noexcept (unsigned char *buf, size_t size) override
	Fill a buffer with random bytes without throwing exceptions.
Public Member Functions inherited from openvpn::RandomAPI
template<typename T >
void	rand_fill (T &obj)
	Fill a data object with random bytes.
template<typename T >
T	rand_get ()
	Create a data object filled with random bytes.
template<typename T >
T	rand_get_positive ()
	Create a data object filled with random bytes, always >= 0 for signed types.
template<typename T >
T	randrange (const T end)
	Return a uniformly distributed random number in the range [0, end)
template<typename T >
T	randrange (const T start, const T end)
	Return a uniformly distributed random number in the range [start, end].
std::uint32_t	randrange32 (const std::uint32_t end)
	Return a uniformly distributed random number in the range [0, end)
std::uint32_t	randrange32 (const std::uint32_t start, const std::uint32_t end)
	Return a uniformly distributed random number in the range [start, end].
std::uint8_t	randbyte ()
	Return a random byte.
bool	randbool ()
	Return a random boolean.
result_type	operator() ()
Public Member Functions inherited from openvpn::RC< thread_unsafe_refcount >
	RC () noexcept=default
	RC (const RC &)=delete
virtual	~RC ()=default
RC &	operator= (const RC &)=delete
olong	use_count () const noexcept
	Delegates call to RCImpl and returns the result.

Private Member Functions
bool	rndbytes (unsigned char *buf, ssize_t size)

Private Attributes
ScopedFD	dev_urandom

Additional Inherited Members
Static Public Member Functions inherited from openvpn::RandomAPI
static constexpr result_type	min ()
static constexpr result_type	max ()
Static Public Member Functions inherited from openvpn::RC< thread_unsafe_refcount >
static constexpr bool	is_thread_safe ()
	Delegates call to RCImpl and returns the result.

Detailed Description

Definition at line 26 of file devurand.hpp.

Member Typedef Documentation

Ptr

typedef RCPtr<DevURand> openvpn::DevURand::Ptr

Definition at line 31 of file devurand.hpp.

Constructor & Destructor Documentation

DevURand()

openvpn::DevURand::DevURand ( )

inline

Definition at line 33 of file devurand.hpp.

Member Function Documentation

name()

std::string openvpn::DevURand::name ( ) const

inlineoverridevirtual

Get the name of the random number generation algorithm.

Returns

The name of the algorithm

Implements openvpn::RandomAPI.

Definition at line 41 of file devurand.hpp.

OPENVPN_EXCEPTION()

openvpn::DevURand::OPENVPN_EXCEPTION

(

dev_urand_error

)

rand_bytes()

void openvpn::DevURand::rand_bytes ( unsigned char *  buf, size_t  size  )

inlineoverridevirtual

Fill a buffer with random bytes.

Parameters

buf	Pointer to the buffer
size	Number of bytes to generate

Implements openvpn::RandomAPI.

Definition at line 47 of file devurand.hpp.

rand_bytes_noexcept()

bool openvpn::DevURand::rand_bytes_noexcept ( unsigned char *  buf, size_t  size  )

inlineoverridevirtual

Fill a buffer with random bytes without throwing exceptions.

Parameters

buf	Pointer to the buffer
size	Number of bytes to generate

Returns

true on success

false on failure

Implements openvpn::RandomAPI.

Definition at line 55 of file devurand.hpp.

rndbytes()

bool openvpn::DevURand::rndbytes ( unsigned char *  buf, ssize_t  size  )

inlineprivate

Definition at line 61 of file devurand.hpp.

Here is the caller graph for this function:

Member Data Documentation

dev_urandom

ScopedFD openvpn::DevURand::dev_urandom

private

Definition at line 67 of file devurand.hpp.

---

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

• openvpn/random/devurand.hpp