@th3rius/csprng

A cryptographically secure generator for random numbers in a range.


Keywords
csprng, random, number, crypto, csrpng
License
WTFPL
Install
npm install @th3rius/csprng@1.0.3

Documentation

csprng

A CommonJS module for generating cryptographically secure pseudo-random numbers.

Works in Node.js, and should work in the browser as well, using Webpack or Browserify.

This module is based on code originally written by Scott Arciszewski, released under the WTFPL / CC0 / ZAP.

Usage

This module will return the result asynchronously - this is necessary to avoid blocking your entire application while generating a number.

An example:

var Promise = require("bluebird");
var randomNumber = require("@th3rius/csrpng");

Promise.try(function() {
	return randomNumber(10, 30);
}).then(function(number) {
	console.log("Your random number:", number);
}).catch({code: "RandomGenerationError"}, function(err) {
	console.log("Something went wrong!");
});

API

randomNumber(minimum, maximum, [cb])

Returns a Promise that resolves to a random number within the specified range.

Note that the range is inclusive, and both numbers must be integer values. It is not possible to securely generate a random value for floating point numbers, so if you are working with fractional numbers (eg. 1.24), you will have to decide on a fixed 'precision' and turn them into integer values (eg. 124).

  • minimum: The lowest possible value in the range.
  • maximum: The highest possible value in the range. Inclusive.

Optionally also accepts a nodeback as cb, but seriously, you should be using Promises.

randomNumber.RandomGenerationError

Any errors that occur during the random number generation process will be of this type. The error object will also have a code property, set to the string "RandomGenerationError".

The error message will provide more information, but this kind of error will generally mean that the arguments you've specified are somehow invalid.