openvpn::OpenSSLRandom Class Reference

#include <rand.hpp>

Inheritance diagram for openvpn::OpenSSLRandom:

Collaboration diagram for openvpn::OpenSSLRandom:

Public Types
typedef RCPtr< OpenSSLRandom >	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 (rand_error_openssl)
	OpenSSLRandom ()=default
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, size_t size)

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 25 of file rand.hpp.

Member Typedef Documentation

Ptr

typedef RCPtr<OpenSSLRandom> openvpn::OpenSSLRandom::Ptr

Definition at line 30 of file rand.hpp.

Constructor & Destructor Documentation

OpenSSLRandom()

openvpn::OpenSSLRandom::OpenSSLRandom ( )

default

Member Function Documentation

name()

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

inlineoverridevirtual

Get the name of the random number generation algorithm.

Returns

The name of the algorithm

Implements openvpn::RandomAPI.

Definition at line 34 of file rand.hpp.

OPENVPN_EXCEPTION()

openvpn::OpenSSLRandom::OPENVPN_EXCEPTION

(

rand_error_openssl

)

rand_bytes()

void openvpn::OpenSSLRandom::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 40 of file rand.hpp.

rand_bytes_noexcept()

bool openvpn::OpenSSLRandom::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 48 of file rand.hpp.

rndbytes()

bool openvpn::OpenSSLRandom::rndbytes ( unsigned char *  buf, size_t  size  )

inlineprivate

Definition at line 54 of file rand.hpp.

Here is the caller graph for this function:

---

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

• openvpn/openssl/util/rand.hpp