js-crypto-random

Universal Module for Secure Random Generator in JavaScript

WARNING: At this time this solution should be considered suitable for research and experimentation, further code and security review is needed before utilization in a production application.

Introduction and Overview

This library is designed to be 'universal' as a random sequence generator, i.e., it works both on most browsers and on Node.js just by importing from npm/source code. Note that in the design principle, the library fully utilizes native APIs like WebCrypto API to accelerate its operation if available.

Installation

At your project directory, do either one of the following.

• From npm/yarn:

  $ npm install --save js-crypto-random // npm
  $ yarn add js-crypto-random // yarn
  

• From GitHub:

  $ git clone https://github.com/junkurihara/js-crypto-random.git
  

Then you should import the package as follows.

import random from 'js-crypto-random'; // for npm
import random from 'js-crypto-random/dist/index.js'; // for github

Usage

Generate random byte sequence

random.getRandomBytes(32).then( (rb) => {
  // now you get an Uint8Array of 32 bytes filled with randomly generated values
});

Generate random ascii sequence

random.getRandomAsciiString(32)( (ra) => {
  // now you get a string of 32 ASCII characters generated in a cryptographically random manner
});

License

Licensed under the MIT license, see LICENSE file.