secure-random-string
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/secure-random-string package

1.1.3 • Public • Published

secure-random-string

Node.js module that generates a cryptographically secure random string with a given length

Usage

var srs = require('secure-random-string');

Default behavior: Generate a random Base64 encoded string 32 characters long.

This may include alphanumeric characters as well as the following characters: +, /, =.

// Sync
var result = srs();
 
// Async
srs(function(err, sr) {
    console.log(sr);
});
 

Options: length

Optionally, you can specify a 'length' option to specify a length.

// sync
var result = srs({length: 256});
 
// async
srs({length: 256}, function(err, sr) {
    console.log(sr);
});

Options: alphanumeric

Optionally, you can specify a 'alphanumeric' option to get a alphanumerical chars only.

// sync
var result = srs({alphanumeric: true});
 
// async
srs({alphanumeric: true}, function(err, sr) {
    console.log(sr);
});

Error handling

An error is possible if there is not enough accumulated entropy to generate cryptographically strong data. In other words, this will not block even if all entropy sources are drained. Note that the sync API throws an exception, while the async API returns the error to the callback.

Author

Simon Santoro

Contributors

Mark Stosberg
Sandro Gomez

License

MIT

Package Sidebar

Install

npm i secure-random-string

Weekly Downloads

3,640

Version

1.1.3

License

MIT

Unpacked Size

7.33 kB

Total Files

6

Last publish

Collaborators

  • s2