ripple::csprng_engine Class Reference

A cryptographically secure random number engine. More...

#include <csprng.h>

Collaboration diagram for ripple::csprng_engine:

Public Types
using	result_type = std::uint64_t

Public Member Functions
	csprng_engine (csprng_engine const &)=delete
csprng_engine &	operator= (csprng_engine const &)=delete
	csprng_engine (csprng_engine &&)=delete
csprng_engine &	operator= (csprng_engine &&)=delete
	csprng_engine ()
	~csprng_engine ()
void	mix_entropy (void *buffer=nullptr, std::size_t count=0)
	Mix entropy into the pool.
result_type	operator() ()
	Generate a random integer.
void	operator() (void *ptr, std::size_t count)
	Fill a buffer with the requested amount of random data.

Static Public Member Functions
static constexpr result_type	min ()
static constexpr result_type	max ()

Private Attributes
std::mutex	mutex_

Detailed Description

A cryptographically secure random number engine.

The engine is thread-safe (it uses a lock to serialize access) and will, automatically, mix in some randomness from std::random_device.

Meets the requirements of UniformRandomNumberEngine

Definition at line 35 of file csprng.h.

Member Typedef Documentation

result_type

using ripple::csprng_engine::result_type = std::uint64_t

Definition at line 41 of file csprng.h.

Constructor & Destructor Documentation

csprng_engine() [1/3]

ripple::csprng_engine::csprng_engine ( csprng_engine const &  )

delete

csprng_engine() [2/3]

ripple::csprng_engine::csprng_engine ( csprng_engine &&  )

delete

csprng_engine() [3/3]

ripple::csprng_engine::csprng_engine

(

)

Definition at line 34 of file libxrpl/crypto/csprng.cpp.

~csprng_engine()

ripple::csprng_engine::~csprng_engine

(

)

Definition at line 41 of file libxrpl/crypto/csprng.cpp.

Member Function Documentation

operator=() [1/2]

csprng_engine & ripple::csprng_engine::operator= ( csprng_engine const &  )

delete

operator=() [2/2]

csprng_engine & ripple::csprng_engine::operator= ( csprng_engine &&  )

delete

mix_entropy()

void ripple::csprng_engine::mix_entropy	(	void *	buffer = nullptr,
		std::size_t	count = 0
	)

Mix entropy into the pool.

Definition at line 50 of file libxrpl/crypto/csprng.cpp.

operator()() [1/2]

csprng_engine::result_type ripple::csprng_engine::operator()

(

)

Generate a random integer.

Definition at line 95 of file libxrpl/crypto/csprng.cpp.

operator()() [2/2]

void ripple::csprng_engine::operator()	(	void *	ptr,
		std::size_t	count
	)

Fill a buffer with the requested amount of random data.

Definition at line 78 of file libxrpl/crypto/csprng.cpp.

min()

static constexpr result_type ripple::csprng_engine::min ( )

staticconstexpr

Definition at line 68 of file csprng.h.

max()

static constexpr result_type ripple::csprng_engine::max ( )

staticconstexpr

Definition at line 75 of file csprng.h.

Member Data Documentation

mutex_

std::mutex ripple::csprng_engine::mutex_

private

Definition at line 38 of file csprng.h.