# node-jen

> Jen is a portable and safe Javascript password/number generator

Latest version **1.1.0** (published 2018-05-24) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install node-jen
pnpm add node-jen
yarn add node-jen
bun add node-jen
```

Provides the command `node-jen`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2018-05-24 |
| First published | 2015-06-29 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 16 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Michael Vergoz |
| Maintainers | mykiimike |
| Keywords | password, random, number, portable, generator |

## Links

- npm: https://www.npmjs.com/package/node-jen
- Repository: https://github.com/mykiimike/jen
- Issues: https://github.com/mykiimike/jen/issues
- npm.io page: https://npm.io/package/node-jen

## Alternatives

- [random-seedable](https://npm.io/package/random-seedable.md) — 27.9K weekly downloads
- [n2words](https://npm.io/package/n2words.md) — 22.2K weekly downloads
- [@stdlib/math-base-special-factorialln](https://npm.io/package/@stdlib/math-base-special-factorialln.md) — 5.7K weekly downloads
- [@stdlib/math-base-special-abs2](https://npm.io/package/@stdlib/math-base-special-abs2.md) — 1.7K weekly downloads
- [commons-math-interpolation](https://npm.io/package/commons-math-interpolation.md) — 1.4K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2018-05-24
- 1.0.6 — 2016-07-11
- 1.0.5 — 2015-09-19
- 1.0.4 — 2015-07-10
- 1.0.3 — 2015-07-02
- 1.0.2 — 2015-07-01
- 1.0.1 — 2015-06-29
- 1.0.0 — 2015-06-29

## README

# Jen is a portable and safe Javascript password/number generator

[![Build Status](https://travis-ci.org/mykiimike/jen.svg)](https://travis-ci.org/mykiimike/jen)
[![][gt-issues]][gt-issues]
[![][gt-licence]][gt-licence]

[![NPM](https://nodei.co/npm/node-jen.png?downloads)](https://nodei.co/npm/node-jen/)

Jen allows to generate passwords, random bytes and random numbers securely using cryptographic approach.

Jen supports 4 engines to generate random bytes :
* NodeJS Crypto API
* W3C Crypto API http://www.w3.org/TR/WebCryptoAPI/
* Microsoft Crypto API https://msdn.microsoft.com/en-us/library/windows/desktop/aa380256(v=vs.85).aspx
* Failsafe

Failsafe uses Math.random() which is not safe because the random number generator doesn't use a
cryptographic approach.   

* You can see a demo at http://mykiimike.github.io/jen/
* Explaination [Cross Domain Math.random() prediction](http://ifsec.blogspot.fr/2012/05/cross-domain-mathrandom-prediction.html)

## Hardened passwords
Jen has a hardened passwords generator activated by default which adds specials chars into the password.
For those who want to use Jen for others things they must set to **false** the **hardened**
argument at the constructor.

## Install

### On NodeJS
```bash
npm install node-jen
```

### On browser
```html
<script type="text/javascript" src="path/to/jen.js"></script>
```

### With browserify & Webpack

Just include / require this repo or **jen.js** direcly into your code.

## Library

### Jen(hardened, banFailsafe)
```js
var hdl = new Jen(true, true);
```
* hardened: Use hardened version includes specials chars into password generator: (default true)
* banFailsafe: Generate an alert when using Failsafe cryptography (default true)

## Jen.password(min, max, regex)
## Jen.password(min, max)
## Jen.password(min)
This function returns a random String.

* min: Minimum String length (must be upper to 4)
* max: Maximum String length
* regex: Regular expression to filter selected chars

```js
console.log("10 Passwords from 10 to 30 w/o hardening");
for(var a=0; a<10; a++)
	console.log(hdl.password(10, 30));

console.log("10 Passwords fixed 5 w/o hardening");
for(var a=0; a<10; a++)
	console.log(hdl.password(5));

console.log("10 Passwords from 10 to 30 w/ hardening");
hdl.hardening(true);
for(var a=0; a<10; a++)
	console.log(hdl.password(10, 30));

console.log("10 Passwords fixed 10 w/ hardening");
for(var a=0; a<10; a++)
	console.log(hdl.password(10, 10));

console.log("10 Passwords fixed 10 w/o hardening with regex [A-F0-9]");
hdl.hardening(false);
for(var a=0; a<10; a++)
	console.log(hdl.password(10, 10, /[A-F0-9]/));
```

## Jen.random(size)
Generate random numbers (integers) into a String.

* size: Size of bytes read from randomBytes

```js
console.log("10 Random string (based on 4 bytes)");
for(var a=0; a<10; a++)
	console.log(hdl.random(4));
```

## Jen.randomBytes(size)
Generate random bytes into an Uint8Array.

* size: Size of bytes read from randomBytes

```js
console.log("10 Random 4 bytes");
for(var a=0; a<10; a++)
	console.log(hdl.randomBytes(4));
```

## Jen.randomBetween(max, min)
Generate random number between the given **min** and **max** arguments

* max: Maximum value
* min: Minimum value

```js
console.log("10 Random number between 10 and 3000");
for(var a=0; a<10; a++)
	console.log(hdl.randomBetween(3000, 10));
```

### Jen.hardening(bool)
Set on/off hardening string generator

* bool: boolean to activate hardened password generator (default true)

### Jen.engine()
Returns the current engine in a String
```js
console.log("Engine: "+hdl.engine());
```

### Jen.stats()
Get password generation statistics
```js
console.log("Last pass stats: "+hdl.stats());
```

### Jen.fill()
This function fill the random buffer line. You don't need to use it.

## Contact

* Michael Vergoz
* [@mykiimike](https://twitter.com/mykiimike) / [Github](https://github.com/mykiimike)

[gt-issues]: https://img.shields.io/github/issues/mykiimike/jen.svg
[gt-licence]: https://img.shields.io/badge/license-GPLv3-blue.svg

---
_Source: https://npm.io/package/node-jen · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._