ntropy ~trunk

NTropy

This library provides a lightweight platform-independent interface to generate cryptographically secure pseudorandom data from system sources. NTropy is compatible with @safe, @nogc and nothrow, and can be compiled with BetterC compatibility.

Public methods in the source code have embedded documentation.

Usage

Fill a buffer with cryptographically secure random data:

import ntropy;

auto myBuffer = new ubyte[](32);
if(ntropy.generate(myBuffer)){
	//use `myBuffer`
}else{
	//error detected!
}

Generate a fixed amount of cryptographically secure random data:

import ntropy;

bool success;

short[14] myData = ntropy.generate!(short[14])(success);
if(success){
	//use `myData`
}else{
	//error detected!
}

int myInt = ntropy.generate!int(success);
if(success){
	//use `myInt`
}else{
	//error detected!
}

Supported platforms

Not all platforms have been tested. Pull requests to add new platforms, lower minimum system versions, or fix bugs are welcome.

BetterC compatibility

If you are using dub, then by default the library will compile without BetterC. To enable BetterC compatibility, select the yesBC configuration in your dub recipe.

See also

• csprng-d inspired this project. It is a similar library but not as lightweight, and isn't actively maintained.
• getrandom for Rust, whose documentation inspired this README.