// Copyright © 2022-2023 Password Generator. All rights reserved.
-// SPDX-License-Identifier: Apache-2.0
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: Apache-2.0 OR MIT
-import childProcess from "child_process";
+import { exec } from "child_process";
import clipboardy from "clipboardy";
/**
- * Generate a strong password using OpenSSL.
+ * Generates a strong password of a specified length using OpenSSL.
*
- * @param {Object} options - Configuration options for password generation.
- * @param {number} options.length - The length of each password chunk.
- * @param {number} options.iteration - The number of password chunks.
- * @param {string} options.separator - The separator between password chunks.
- * @return {Promise<string>} The generated password.
+ * @param {number} length - The desired length of the password.
+ * @return {Promise<string>} A promise that resolves to the generated password.
*/
-const strongPassword = ({ length, iteration, separator }) => {
+export const strongPassword = (length) => {
return new Promise((resolve, reject) => {
- childProcess.exec("openssl rand -base64 256", (err, stdout, stderr) => {
+ exec("openssl rand -base64 256", (err, stdout, stderr) => {
if (err) {
console.error("Failed to execute command:", stderr);
return reject(err);
}
- const strong = stdout
- .toString()
- .match(new RegExp(`.{1,${length}}`, "g"))
- .slice(0, iteration)
- .join(separator);
-
- resolve(strong);
+ // Extract a string of the specified length from the base64 output
+ const strong = stdout.toString().match(new RegExp(`.{1,${length}}`, "g"));
+ resolve(strong[0]); // Resolve with the first match to ensure the correct length
});
});
};
+/**
+ * Asynchronously generates a strong password based on the provided options.
+ *
+ * @param {Object} options - Configuration options for password generation.
+ * @param {number} options.length - The length of each password chunk.
+ * @param {number} options.iteration - The number of password chunks.
+ * @param {string} options.separator - The separator between password chunks.
+ * @return {Promise<string>} A promise that resolves to the generated password.
+ */
+export const generatePassword = async({ length, iteration, separator }) => {
+ let passwordChunks = [];
+ for (let i = 0; i < iteration; i++) {
+ // Generate each password chunk and add it to the array
+ passwordChunks.push(await strongPassword(length));
+ }
+ // Join the chunks with the separator to form the final password
+ return passwordChunks.join(separator);
+};
+
+// The command-line interface part of the script:
+
// Parse command-line arguments
const args = process.argv.slice(2);
const data = {};
+// Ensure arguments are provided in pairs for key-value mapping
+if (args.length % 2 !== 0) {
+ console.error("Arguments should be provided in pairs.");
+ process.exit(1);
+}
+
for (let i = 0; i < args.length; i += 2) {
const key = args[i].replace("-", "");
const value = args[i + 1];
data[key] = value;
}
+// Validate required arguments for the password generation
if (data.t !== "strong" || !data.l || !data.i || !data.s) {
- console.error(
- "Usage: node . -t strong -l <length> -i <iteration> -s <separator>",
- );
+ console.error("Usage: node . -t strong -l <length> -i <iteration> -s <separator>");
process.exit(1);
}
-// Generate and print the password
+// Generate the password and copy it to the clipboard
(async() => {
- const generatedPassword = await strongPassword({
- length: parseInt(data.l, 10),
- iteration: parseInt(data.i, 10),
- separator: data.s,
- });
+ try {
+ const generatedPassword = await generatePassword({
+ length: parseInt(data.l, 10),
+ iteration: parseInt(data.i, 10),
+ separator: data.s,
+ });
- // Copy the password to clipboard
- clipboardy.writeSync(generatedPassword);
+ // Copy the password to clipboard for user convenience
+ await clipboardy.write(generatedPassword);
- console.log(generatedPassword);
+ // Output the generated password
+ console.log(`Generated Password: ${generatedPassword}`);
+ } catch (error) {
+ console.error("An error occurred while generating the password:", error);
+ }
})();
+
+export default generatePassword;
-
+
+
+# Password Generator
-A fast, simple and powerful open-source utility tool for generating strong, unique and random passwords. Password Generator is free to use as a secure password generator on any computer, phone, or tablet.
+A fast, simple, and powerful open-source utility tool for generating strong, unique, and random passwords. The Password Generator supports various types of passwords including base64-encoded, memorable, and complex strong passwords. It is designed to be a versatile tool for both personal and enterprise needs, ensuring that all users have access to high-security password options. Password Generator is free to use as a secure password generator on any computer, phone, or tablet.
-[](#installation)
-[](https://github.com/sebastienrousseau/password-generator/archive/refs/tags/1.1.1.zip)
+[](#installation)
+[](https://github.com/sebastienrousseau/password-generator/archive/refs/tags/1.1.3.zip)
[](https://www.codacy.com?utm_source=github.com&utm_medium=referral&utm_content=sebastienrousseau/password-generator&utm_campaign=Badge_Grade)
[](https://www.npmjs.com/package/@sebastienrousseau/password-generator)
@@ -14,6 +23,15 @@ A fast, simple and powerful open-source utility tool for generating strong, uniq
[](https://opensource.org/licenses/MIT)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fsebastienrousseau%2Fpassword-generator?ref=badge_small)
+## Features
+
+- **Base64 Passwords**: Generate passwords with base64 encoding for a balance of security and usability.
+- **Memorable Passwords**: Create passwords using a combination of memorable words, making them easier to remember while maintaining security.
+- **Strong Passwords**: Produce highly secure passwords with customizable length and complexity to meet the highest security standards.
+- **Customizable Options**: Specify password length, complexity, and word separators to tailor your password to your security needs.
+- **CLI Support**: Use the Password Generator directly from your terminal for quick and easy access.
+- **Secure**: Built with security as a priority, using cryptographic functions to ensure password strength.
+
## Installation
### From NPM or YARN
@@ -27,7 +45,7 @@ To install the Password Generator Tool, use either npm or yarn as follows:
Clone the main repository to get all source files including build scripts: `git clone https://github.com/sebastienrousseau/password-generator.git`
-## ❓ What's included
+## What's included
Within the download you'll find all the password generator source files grouped into the _dist_ folder.
@@ -98,7 +116,9 @@ You'll see something like this:
9 directories, 50 files
```
-## 💿 Usage
+## Usage
+
+To generate a password, you can call the Password Generator with the desired type and options. Below are examples of how to generate each type of password:
### From the CLI
@@ -134,7 +154,7 @@ var generatePassword = require('password-generator');
```
-## 🔐 Password options
+## Password options
### Base64 password
@@ -196,15 +216,15 @@ node . -t memorable -i 4 -s -
node dist/src/lib/memorable-password.js -t base64 -i 4 -s -
```
-## 🚥 Semantic Versioning Policy
+## Semantic Versioning Policy
For transparency into our release cycle and in striving to maintain backward compatibility, `password-generator` follows [semantic versioning](http://semver.org/) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy).
-## ✅ Changelog
+## Changelog
- [GitHub Releases](https://github.com/sebastienrousseau/password-generator/releases)
-## ❤️ Contributing
+## Contributing
Please read carefully through our [Contributing Guidelines](https://github.com/sebastienrousseau/password-generator/blob/master/.github/CONTRIBUTING.md) for further details on the process for submitting pull requests to us.
@@ -217,21 +237,21 @@ Development Tools
- `yarn lint-fix` instructs ESLint to try to fix as many issues as possible..
- `yarn test` runs tests and measures coverage.
-## 📖 Rules
+## Rules
We are committed to preserving and fostering a diverse, welcoming community. Please read our [Code of Conduct](https://github.com/sebastienrousseau/password-generator/blob/master/.github/CODE-OF-CONDUCT.md).
-## ⭐️ Our Values
+## Our Values
- We believe perfection must consider everything.
- We take our passion beyond code into our daily practices.
- We are just obsessed about creating and delivering exceptional solutions.
-## ⚖️ License
+## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/sebastienrousseau/password-generator/blob/master/LICENSE) file for details
-## 🏢 Acknowledgements
+## Acknowledgements
[The Password Generator Tool](https://password-generator.pro) is beautifully crafted by these people and a bunch of awesome [contributors](https://github.com/sebastienrousseau/password-generator/graphs/contributors)
diff --git a/docs/global.html b/docs/global.html
index ac41d0d..cc9dc11 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -98,13 +98,13 @@