About The Project

This library tries to create strong random passwords with a specified length, including and excluding certain characters. It is available as a NodeJS library.

Strength

According to the library zxcvbn by dropbox, 1000 randomly generated passwords with 15 characters generated by this library scored 4/4. (See index.test.js)

Built With

• NodeJS

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

You need to have npm and NodeJS installed. npm comes with NodeJS.

Installation

You can install the package using npm. The library has no dependencies except devdependencies for running tests.

1. Install using npm

   npm i random-password-generator

Usage

const rpg = require('random-password-generator');

const password = rpg({ length: 12, includeChars: ["€"], excludeChars: ["a", "z"] });
// => }u^1J 2kx{8€
const password2 = rpg();
// => vQ%hzIqmZi

Documentation

The usage is pretty simple. First require the module.

const rpg = require('random-password-generator');

Then you can call it as a function

const password = rpg({ length: 12, includeChars: ["€"], excludeChars: ["a", "z"] });

The password generated uses all the prinatble characters in the ASCII character set except the DEL character (code 32-126). This includes the space (␣). You can remove the space by setting excludeChars (see below). The length of the password will be 15, the recommended length.

The function takes an options object which has the following properties:

• length (number) - The length of the password. If it is 0 it will be set to default.
• includeChars (array of strings with length 1) - The characters to include. Nay repeats will be removed.
• excludeChars (array of strings with length 1) - The characters to exclude.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Be sure to test everything (jest) before pull requesting.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Siddharth - [email protected]

Project Link: https://github.com/SiddharthShyniben/random-password-generator