Random Password Toolkit

Random Password Toolkit is a robust package for generating and managing random passwords with advanced functionalities such as encryption, decryption, strength checking, and customizable options. This toolkit is perfect for developers looking for a secure and feature-rich solution to handle password-related tasks in their applications.

---

Features

• Random Password Generation: Generate strong and secure passwords.
• Generate Multiple Passwords: Create multiple passwords in bulk.
• Pronounceable Passwords: Generate passwords that are easier to read and pronounce.
• Custom Password Generation: Create passwords using a custom pool of characters.
• Password Strength Checker: Evaluate the strength of passwords with actionable feedback.
• Password Encryption: Secure passwords with AES-256 encryption.
• Password Decryption: Decrypt encrypted passwords safely.
• Customizable Options: Fully customizable password generation settings.

---

Benefits

• Security: Generate highly secure passwords to protect sensitive data.
• Flexibility: Customize password generation to suit any application.
• Ease of Use: Simple and intuitive API.
• Compatibility: Works seamlessly with JavaScript and TypeScript projects.
• Encryption & Decryption: Securely store and retrieve passwords.

---

Installation

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js. Node.js 0.10 or higher is required.

If this is a brand new project, make sure to create a package.json first with the npm init command.

Installation is done using the npm install command:

Install the package using npm/yarn:

1npm install random-password-toolkit

or

1yarn add random-password-toolkit

---

Options

The following options can be used with the password generation functions:

Option	Type	Description	Default
length	Integer	Length of the password.	10
numbers	Boolean	Include numbers in the password.	false
symbols	Boolean	Include symbols in the password.	false
lowercase	Boolean	Include lowercase letters.	true
uppercase	Boolean	Include uppercase letters.	true
excludeSimilarCharacters	Boolean	Exclude similar characters (e.g., 'i', 'l').	false
exclude	String	Characters to exclude from the password.	''
strict	Boolean	Enforce at least one character from each pool.	false

---

Usage

Importing the Package

1const {
2  generate,
3  generateMultiple,
4  generatePronounceablePassword,
5  generateWithCustomPool,
6  checkPasswordStrength,
7  encryptPassword,
8  decryptPassword
9} = require('random-password-toolkit');

---

1. Generate a Random Password

Generate a single random password with customizable options:

1const passwords = generate(5);
2console.log(passwords);
3// Output: yKsmtgtDsJ

1const password = generate({
2  length: 12,
3  numbers: true,
4  symbols: true,
5  uppercase: true,
6  strict: true
7});
8console.log(password);
9// Output: @D8cP#9Zr2&f

---

2. Generate Multiple Passwords

Generate multiple passwords at once:

1const passwords = generateMultiple(5);
2console.log(passwords);
3// Output: ['g8sFwLp4Rx', 'pR2zT9qMf7', ...]

1const password = generateMultiple({
2  length: 12,
3  numbers: true,
4  symbols: true,
5  uppercase: true,
6  strict: true
7});
8console.log(password);
9// Output: ['Fi:G+D1oTU','jec*<KSP:3','Z@ie>^]n7Q','6&J4O12}e?','K$9J|xDv|Y']

---

3. Generate Pronounceable Passwords

Create passwords that are easier to pronounce:

1const pronounceablePassword = generatePronounceablePassword(8);
2console.log(pronounceablePassword);
3// Output: bolozuna

---

4. Generate Password with Custom Pool

Generate passwords using a specific set of characters:

1const customPassword = generateWithCustomPool(8, 'abcd');
2console.log(customPassword);
3// Output: 2c1ea3fb

---

5. Check Password Strength

Evaluate the strength of a password:

1const strength = checkPasswordStrength('MyP@ssword123');
2console.log(strength);
3// Output: Very Strong

---

6. Encrypt a Password**

Securely encrypt a password:

1const encryptedData = encryptPassword('MySecurePassword');
2console.log('Encrypted Password:', encryptedData.encryptedPassword);
3console.log('IV:', encryptedData.iv);
4/* Output:
5Encrypted Password: 7de8fc05ab01ed48605fa1983c830e98e13716f507b59bbf1203f7f1361ee497
6IV: dc23c48d84eed6b07d89c479af6c5845*/

---

7. Decrypt a Password

Decrypt an encrypted password:

1// Decrypt the password using the returned IV
2const decryptedPassword = decryptPassword(encryptedData.encryptedPassword, encryptedData.iv);
3console.log('Decrypted Password:', decryptedPassword);
4// Output: MySecurePassword

---

8. Test generating zero secrets

Test generating zero secrets

1try {
2    console.log(generateMultiple(0));
3  } catch (error) {
4    console.error(error.message); // Expected: 'Amount must be greater than 0.'
5  }

---

---

9. Random Number Generator

Generates a random number within a given range, and the length of the number is defined by the length parameter. Parameters: min: The minimum value of the generated number. max: The maximum value of the generated number. length: The length of the generated number (total digits).

1const random6DigitNumber = generateRandomNumber(100000, 999999, 6);
2console.log(random6DigitNumber);  
3// Output: A 6-digit number, e.g., "539812"

---

---

10. Ranom OTP Generator

A string representing the OTP.

1const otp = generateOTP(6); // Generates a 6-digit OTP
2console.log(`Generated OTP: ${otp}`);
3// Output - Generated OTP: 9770112074

---

---

11. Random API Key Generator

Generates a secure random API key with the specified number of bytes. The API key is returned as a hexadecimal string.

Parameters: length (optional): The length of the API key in bytes (default: 32 bytes).

1const apiKey = generateApiKey(); // Generates a 64-character API key (32 bytes in hex)
2console.log(`Generated API Key: ${apiKey}`);
3// output: Generated API Key: 84e19acaa6f069e4fe9540a85fcdc146ecf8ed86b72eacfb67c75aeab4c68da7

---

Community and Ecosystem

By using Random Password Toolkit, you are joining a growing community of developers who are passionate about secure passwords and encryption. We encourage you to share your experiences, ideas, and feedback on GitHub Discussions or any community platform of your choice.

• GitHub Discussions: Share use cases, report bugs, and suggest features.

We'd love to hear from you and see how you're using Random Password Toolkit in your projects!

Issues and Feedback

For issues, feedback, and feature requests, please open an issue on our GitHub Issues page. We actively monitor and respond to community feedback.

---

License

This project is licensed under the MIT License. See the LICENSE file for details.