generate-pw 1.2.1 → 1.2.2

package/README.md

@@ -17,7 +17,7 @@
 ### Randomly generate cryptographically-secure passwords.
 
 <a href="#%EF%B8%8F-mit-license"><img height=31 src="https://img.shields.io/badge/License-MIT-orange.svg?logo=internetarchive&logoColor=white&labelColor=464646&style=for-the-badge"></a>
-<a href="https://github.com/adamlui/js-utils/releases/tag/generate-pw-1.2.1"><img height=31 src="https://img.shields.io/badge/Latest_Build-1.2.1-44cc11.svg?logo=icinga&logoColor=white&labelColor=464646&style=for-the-badge"></a>
+<a href="https://github.com/adamlui/js-utils/releases/tag/generate-pw-1.2.2"><img height=31 src="https://img.shields.io/badge/Latest_Build-1.2.2-44cc11.svg?logo=icinga&logoColor=white&labelColor=464646&style=for-the-badge"></a>
 <a href="https://www.npmjs.com/package/generate-pw?activeTab=code"><img height=31 src="https://img.shields.io/npm/unpacked-size/generate-pw?style=for-the-badge&logo=ebox&logoColor=white&labelColor=464646&color=blue"></a>
 <a href="https://sonarcloud.io/component_measures?metric=new_vulnerabilities&id=adamlui_js-utils:generate-pw/generate-pw.js"><img height=31 src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fsonarcloud.io%2Fapi%2Fmeasures%2Fcomponent%3Fcomponent%3Dadamlui_js-utils%3Agenerate-pw%2Fgenerate-pw.js%26metricKeys%3Dvulnerabilities&query=%24.component.measures.0.value&style=for-the-badge&logo=sonarcloud&logoColor=white&labelColor=464646&label=Vulnerabilities&color=gold"></a>
 
@@ -135,6 +135,7 @@ const password = 'AawiddsE',
 console.log(pwStrength);
 
 /* outputs:
+
 {
   strengthScore: 60,
   recommendations: [ 'Include at least one number.', 'Include at least one symbol.' ],
@@ -175,7 +176,7 @@ When installed [globally](#-installation), **generate-pw** can also be used from
 $ generate-pw
 ```
 
-**💡 Note:** To generate multiple results, pass `--qty=n` where `n` is the number of passwords to generate.
+**💡 Note:** For security reasons, generated password(s) are stored in the clipboard.
 
 #
 

package/dist/generate-pw.min.js

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+const p=require("crypto")["randomInt"],s=require("child_process")["execSync"],u={lower:"abcdefghijklmnopqrstuvwxyz",upper:"ABCDEFGHIJKLMNOPQRSTUVWXYZ",numbers:"0123456789",symbols:"!@#$%^&*()-_=+[]{}/\\|;:'\",.<>?"};function a(o={}){var e,s={length:8,qty:1,charset:"",exclude:"",numbers:!1,symbols:!1,lowercase:!0,uppercase:!0,strict:!1};o={...s,...o};for(const r of Object.keys(o))if(!Object.prototype.hasOwnProperty.call(s,r))return console.error(`generatePassword() » ERROR: \`${r}\` is an invalid option.`+`
+generatePassword() » Valid options:
+  [ ${Object.keys(s).join(", ")} ]`);for(const n of["length","qty"])if(isNaN(o[n])||o[n]<1)return console.error(`generatePassword() » ERROR: [${n}] option must be > 1.`);for(const a of["numbers","symbols","lowercase","uppercase","strict"])if("boolean"!=typeof o[a])return console.error(`generatePassword() » ERROR: [${a}] option can only be \`true\` or \`false\`.`);if(1<o.qty){const{qty:l,...c}=o;return i(l,c)}{let s=o.charset||(o.numbers?u.numbers:"")+(o.symbols?u.symbols:"")+(o.lowercase?u.lower:"")+(o.uppercase?u.upper:""),r=(s=(s=""===s?u.lower+u.upper:s).replace(new RegExp(`[${o.exclude}]`,"g"),""),"");for(let e=0;e<o.length;e++){var t=p(0,s.length);r+=s.charAt(t)}return o.strict&&(e=["number","symbol","lower","upper"].filter(e=>o[e+"s"]||o[e+"case"]),r=m(r,e)),r}}function i(s,r={}){var e={length:8,qty:1,charset:"",exclude:"",numbers:!1,symbols:!1,lowercase:!0,uppercase:!0,strict:!1};if(r={...e,...r},s=parseInt(s),isNaN(s))return console.error("generatePasswords() » ERROR: First argument [qty] of generatePasswords() must be an integer");for(const t of Object.keys(r))if(!Object.prototype.hasOwnProperty.call(e,t))return console.error(`generatePasswords() » ERROR: \`${t}\` is an invalid option.`+`
+generatePassword() » Valid options:
+  [ ${Object.keys(e).join(", ")} ]`);if(isNaN(r.length)||r.length<1)return console.error("generatePasswords() » ERROR: [length] options must be > 1.");for(const n of["numbers","symbols","lowercase","uppercase","strict"])if("boolean"!=typeof r[n])return console.error(`generatePasswords() » ERROR: [${n}] option can only be \`true\` or \`false\`.`);var o=[];for(let e=0;e<s;e++)o.push(a(r));return o}function m(s,r=["number","symbol","lower","upper"]){for(const l of r)global["has"+l.charAt(0).toUpperCase()+l.slice(1)]=!1;for(let e=0;e<s.length;e++)for(const c of r)(u[c]||u[c+"s"]).includes(s.charAt(e))&&(global["has"+c.charAt(0).toUpperCase()+c.slice(1)]=!0);var e=Math.min(s.length,r.length),o=[];let t=0,n=s;for(const i of r)if(t<e&&!global["has"+i.charAt(0).toUpperCase()+i.slice(1)]){let e;for(;e=p(0,s.length),o.includes(e););o.push(e);var a=u[i]||u[i+"s"];n=n.substring(0,e)+a.charAt(p(0,a.length))+n.substring(e+1),t++}return n}function e(e){var s={minLength:8,minLower:1,minUpper:1,minNumber:1,minSymbol:1},r={lower:0,upper:0,number:0,symbol:0};for(const n of e)for(const a of Object.keys(r))(u[a]||u[a+"s"]).includes(n)&&r[a]++;var o=[];e.length<s.minLength&&o.push(`Make it at least ${s.minLength} characters long.`);for(const l of Object.keys(r))r[l]<s["min"+l.charAt(0).toUpperCase()+l.slice(1)]&&o.push("Include at least one "+l+`${["upper","lower"].includes(l)?"case letter":""}.`);let t=0;t+=e.length>=s.minLength?20:0;for(const c of Object.keys(r))t+=r[c]>=s["min"+c.charAt(0).toUpperCase()+c.slice(1)]?20:0;return{strengthScore:t,recommendations:o,isGood:80<=t}}if(require.main!==module)module.exports={generatePassword:a,generatePasswords:i,strictify:m,validateStrength:e};else{const n="",l="",c="",h={},d={paramOptions:{length:/^--?length/,qty:/^--?qu?a?n?ti?t?y=.*$/,charset:/^--?chars/,excludeChars:/^--?exclude=/},flags:{includeNums:/^--?(?:n|(?:include-?)?num(?:ber)?s?=?(?:true|1)?)$/,includeSymbols:/^--?(?:s|(?:include-?)?symbols?=?(?:true|1)?)$/,excludeLowerChars:/^--?(?:L|(?:exclude|disable|no)-?lower-?(?:case)?|lower-?(?:case)?=(?:false|0))$/,excludeUpperChars:/^--?(?:U|(?:exclude|disable|no)-?upper-?(?:case)?|upper-?(?:case)?=(?:false|0))$/,strictMode:/^--?s(?:trict)?(?:-?mode)?$/},cmds:{help:/^--?h(?:elp)?$/,version:/^--?ve?r?s?i?o?n?$/}};if(process.argv.forEach(s=>{var e,r,o;s.startsWith("-")&&(o=Object.keys(d.flags).find(e=>d.flags[e].test(s)),e=Object.keys(d.paramOptions).find(e=>d.paramOptions[e].test(s)),r=Object.keys(d.cmds).find(e=>d.cmds[e].test(s)),o?h[o]=!0:e?(o=s.split("=")[1],h[e]=parseInt(o)||o):r||(console.error(`
+${l}ERROR: Arg [${s}] not recognized.`+n),console.info(`
+${c}Valid arguments are below.`+n),t(["paramOptions","booelanOptions","infoCmds"]),process.exit(1)))}),process.argv.some(e=>/^--?h(?:elp)?$/.test(e)))t();else if(process.argv.some(e=>/^--?ve?r?s?i?o?n?$/.test(e)))console.info("v"+require("./package.json").version);else{for(const g of["length","qty"])h[g]&&(isNaN(h[g])||h[g]<1)&&(console.error(`
+${l}Error: [${g}] argument must be > 1.`+n),process.exit(1));const o={length:h.length||8,qty:h.qty||1,charset:h.charset,exclude:h.excludeChars,numbers:!!h.includeNums,symbols:!!h.includeSymbols,lowercase:!h.excludeLowerChars,uppercase:!h.excludeUpperChars,strict:!!h.strictMode},f=a(o);r(Array.isArray(f)?f.join("\n"):f)}function t(e=["cmdFormat","paramOptions","booelanOptions","infoCmds"]){const s={cmdFormat:[`
+${c}generate-pw [options|commands]`+n],paramOptions:["\nParameter options:"," --length=n                  Generate password(s) of n length."," --qty=n                     Generate n password(s)."," --charset=chars             Only include chars in password(s)."," --charset=chars             Only include chars in password(s)."," --exclude=chars             Exclude chars from password(s)."],booelanOptions:["\nBoolean options:"," -n, --include-numbers       Allow numbers in password(s)."," -s, --include-symbols       Allow symbols in password(s)."," -L, --no-lowercase          Disallow lowercase letters in password(s)."," -U, --no-uppercase          Disallow uppercase letters in password(s)."],infoCmds:["\nInfo commands:"," -h, --help                  Display help screen."," -v, --version               Show version number."]};e.forEach(e=>{s[e]?.forEach(e=>{{const o=process.stdout.columns||80,t=[],s=e.match(/\S+|\s+/g);let r="";s.forEach(e=>{var s=o-(0===t.length?0:29);r.length+e.length>s&&(t.push(0===t.length?r:r.trimStart()),r=""),r+=e}),t.push(0===t.length?r:r.trimStart()),t.forEach((e,s)=>console.info(0===s?e:" ".repeat(29)+e))}})})}function r(e){e=e.replace(/\s+$/m,"").replace(/"/g,'""'),"darwin"===process.platform?s(`printf "${e}" | pbcopy`):"linux"===process.platform?s(`printf "${e}" | xclip -selection clipboard`):"win32"===process.platform&&s(`Set-Clipboard -Value "${e}"`,{shell:"powershell"})}}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generate-pw",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "Randomly generate cryptographically-secure passwords.",
   "author": {
     "name": "Adam Lui",
@@ -9,13 +9,19 @@
   },
   "homepage": "https://github.com/adamlui/js-utils",
   "license": "MIT",
-  "main": "generate-pw.js",
+  "main": "dist/generate-pw.min.js",
+  "files": [
+    "dist",
+    "docs/",
+    "!docs/*/"
+  ],
   "bin": {
-    "generatepw": "generate-pw.js",
-    "generate-pw": "generate-pw.js"
+    "generatepw": "dist/generate-pw.min.js",
+    "generate-pw": "dist/generate-pw.min.js"
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "minify-js generate-pw.js dist",
     "bump:patch": "bash utils/bump.sh patch",
     "bump:minor": "bash utils/bump.sh minor",
     "bump:major": "bash utils/bump.sh major",
@@ -41,5 +47,8 @@
   "funding": {
     "type": "github",
     "url": "https://github.com/sponsors/adamlui"
+  },
+  "devDependencies": {
+    "@adamlui/minify.js": "^1.4.6"
   }
 }

package/generate-pw.js

@@ -1,269 +0,0 @@
-#!/usr/bin/env node
-
-// Import crypto.randomInt() for secure RNG
-const { randomInt } = require('crypto');
-
-// Init CHARACTER SETS
-const charsets = {
-    lower: 'abcdefghijklmnopqrstuvwxyz',
-    upper: 'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
-    numbers: '0123456789',
-    symbols: '!@#$%^&*()-_=+[]{}/\\|;:\'",.<>?'
-};
-
-// Define MAIN functions
-
-function generatePassword(options = {}) { 
-
-    // Init options
-    const defaultOptions = {
-        length: 8,       // length of password
-        qty: 1,          // number of passwords to generate
-        charset: '',     // characters to include
-        exclude: '',     // characters to exclude
-        numbers: false,  // include numberChars
-        symbols: false,  // include symbolChars
-        lowercase: true, // include lowercase letters
-        uppercase: true, // include uppercase letters
-        strict: false    // require at least one char from each enabled set
-    };
-    options = { ...defaultOptions, ...options };
-
-    // Validate integer args
-    for (const numArgType of ['length', 'qty'])
-        if (isNaN(options[numArgType]) || options[numArgType] < 1)
-            return console.error(
-                `ERROR: [${ numArgType }] argument must be 1 or greater.`);
-
-    if (options.qty > 1) { // return array of [qty] password strings
-        const { qty, ...otherOptions } = options;
-        return generatePasswords(qty, otherOptions);
-
-    } else { // return single password string
-
-        // Init password's char set
-        let pwCharset = options.charset || ( // use passed [charset], or construct from options
-            (options.numbers ? charsets.numbers : '')
-              + (options.symbols ? charsets.symbols : '')
-              + (options.lowercase ? charsets.lower : '') 
-              + (options.uppercase ? charsets.upper : '')
-        );
-        if (pwCharset === '') // all flags false + no charset passed
-            pwCharset = charsets.lower + charsets.upper; // default to upper + lower
-
-        // Exclude passed `exclude` chars
-        pwCharset = pwCharset.replace(new RegExp(`[${ options.exclude }]`, 'g'), '');
-
-        // Generate unstrict password
-        let password = '';
-        for (let i = 0; i < options.length; i++) {
-            const randomIndex = randomInt(0, pwCharset.length);
-            password += pwCharset.charAt(randomIndex);
-        }
-
-        // Enforce strict mode if enabled
-        if (options.strict) {
-            const charTypes = ['number', 'symbol', 'lower', 'upper'],
-                  requiredCharTypes = charTypes.filter(charType => options[charType + 's'] || options[charType + 'case']);
-            password = strictify(password, requiredCharTypes);
-        }
-
-        return password;
-    }
-}
-
-function generatePasswords(qty, options) {
-    qty = parseInt(qty);
-    if (isNaN(qty)) return console.error(
-        'ERROR: First argument [qty] of generatePasswords() must be an integer');
-    const passwords = [];
-    for (let i = 0; i < qty; i++) passwords.push(generatePassword(options));
-    return passwords;
-}
-
-function strictify(password, requiredCharTypes = ['number', 'symbol', 'lower', 'upper']) {
-
-    // Init flags
-    for (const charType of requiredCharTypes)
-        global['has' + charType.charAt(0).toUpperCase() + charType.slice(1)] = false;
-    for (let i = 0; i < password.length; i++)
-        for (const charType of requiredCharTypes)
-            if ((charsets[charType] || charsets[charType + 's']).includes(password.charAt(i)))
-                global['has' + charType.charAt(0).toUpperCase() + charType.slice(1)] = true;
-
-    // Modify password if necessary
-    const maxReplacements = Math.min(password.length, requiredCharTypes.length),
-          replacedPositions = [];
-    let replacementCnt = 0, strictPW = password;
-    for (const charType of requiredCharTypes) {
-        if (replacementCnt < maxReplacements) {
-            if (!global['has' + charType.charAt(0).toUpperCase() + charType.slice(1)]) {
-                let replacementPos;
-                do replacementPos = randomInt(0, password.length); // pick random pos
-                while (replacedPositions.includes(replacementPos)); // check if pos already replaced
-                replacedPositions.push(replacementPos); // track new replacement pos
-                const replacementCharSet = charsets[charType] || charsets[charType + 's'];
-                strictPW = strictPW.substring(0, replacementPos) // perform actual replacement
-                         + replacementCharSet.charAt(randomInt(0, replacementCharSet.length))
-                         + strictPW.substring(replacementPos + 1);
-                replacementCnt++;
-    }}}
-
-    return strictPW;
-}
-
-function validateStrength(password) {
-    const strengthCriteria = { minLength: 8, minLower: 1, minUpper: 1, minNumber: 1, minSymbol: 1 };
-
-    // Count occurrences of each char type
-    const charCnts = { 'lower': 0, 'upper': 0, 'number': 0, 'symbol': 0 };
-    for (let i = 0; i < password.length; i++) {
-        const char = password[i];
-        for (const charType of Object.keys(charCnts))
-            if ((charsets[charType] || charsets[charType + 's']).includes(char))
-                charCnts[charType]++;
-    }
-
-    // Check criteria + add recommendations
-    const recommendations = [];
-    if (password.length < strengthCriteria.minLength)
-        recommendations.push(`Make it at least ${ strengthCriteria.minLength } characters long.`);
-    for (const charType of Object.keys(charCnts))
-        if (charCnts[charType] < strengthCriteria['min' + charType.charAt(0).toUpperCase() + charType.slice(1)])
-            recommendations.push('Include at least one ' + charType
-                + `${ ['upper', 'lower'].includes(charType) ? 'case letter' : '' }.`);
-
-    // Calculate strength score based on counts and criteria
-    let strengthScore = 0;
-    strengthScore += ( // +20 for satisfying min length
-        password.length >= strengthCriteria.minLength) ? 20 : 0;
-    for (const charType of Object.keys(charCnts))
-        strengthScore += ( // +20 per char type included
-            charCnts[charType] >= strengthCriteria['min' + charType.charAt(0).toUpperCase() + charType.slice(1)]) ? 20 : 0;
-
-    return { strengthScore, recommendations, isGood: strengthScore >= 80 };
-}
-
-// EXPORT main functions if script was required
-if (require.main !== module) module.exports = { generatePassword, generatePasswords, strictify, validateStrength };
-
-else { // run as CLI utility
-
-    // Init UI colors
-    const nc = '\x1b[0m',    // no color
-          br = '\x1b[1;91m', // bright red
-          by = '\x1b[1;33m', // bright yellow
-          bw = '\x1b[1;97m'; // bright white
-
-    // Load settings from ARGS
-    const config = {};
-    const argRegex = {
-        paramOptions: {
-            'length': /^--?length/,
-            'qty': /^--?qu?a?n?ti?t?y=\d+$/,
-            'charset': /^--?chars/,
-            'excludeChars': /^--?exclude=/
-        },
-        flags: {
-            'includeNums': /^--?(?:n|(?:include-?)?num(?:ber)?s?=?(?:true|1)?)$/,
-            'includeSymbols': /^--?(?:s|(?:include-?)?symbols?=?(?:true|1)?)$/,
-            'excludeLowerChars': /^--?(?:L|(?:exclude|disable|no)-?lower-?(?:case)?|lower-?(?:case)?=(?:false|0))$/,
-            'excludeUpperChars': /^--?(?:U|(?:exclude|disable|no)-?upper-?(?:case)?|upper-?(?:case)?=(?:false|0))$/,
-            'strictMode': /^--?s(?:trict)?(?:-?mode)?$/
-        },
-        cmds: {
-            'help': /^--?h(?:elp)?$/,
-            'version': /^--?ve?r?s?i?o?n?$/
-        }
-    };
-    process.argv.forEach(arg => {
-        if (!arg.startsWith('-')) return;
-        const matchedFlag = Object.keys(argRegex.flags).find(flag => argRegex.flags[flag].test(arg)),
-              matchedArgOption = Object.keys(argRegex.paramOptions).find(option => argRegex.paramOptions[option].test(arg)),
-              matchedCmd = Object.keys(argRegex.cmds).find(cmd => argRegex.cmds[cmd].test(arg));
-        if (matchedFlag) config[matchedFlag] = true;
-        else if (matchedArgOption) {
-            const value = arg.split('=')[1];
-            config[matchedArgOption] = parseInt(value) || value;
-        } else if (!matchedCmd) {
-            console.error(`\n${br}ERROR: Arg [${ arg }] not recognized.${nc}`);
-            console.info(`\n${by}Valid arguments are below.${nc}`);
-            printHelpSections(['paramOptions', 'booelanOptions', 'infoCmds']);
-            process.exit(1);
-    }});
-
-    // Show HELP screen if -h or --help passed
-    if (process.argv.some(arg => /^--?h(?:elp)?$/.test(arg))) printHelpSections();
-
-    // Show VERSION number if -v or --version passed
-    else if (process.argv.some(arg => /^--?ve?r?s?i?o?n?$/.test(arg)))
-        console.info('v' + require('./package.json').version);
-
-    else { // run MAIN routine
-        for (const numArgType of ['length', 'qty'])
-            if (config[numArgType] && (isNaN(config[numArgType]) || config[numArgType] < 1))
-                return console.error(`\n${br}Error: [${ numArgType }] argument must be 1 or greater.${nc}`);
-        const funcOptions = {
-            length: config.length || 8, qty: config.qty || 1,
-            charset: config.charset, exclude: config.excludeChars,
-            numbers: config.includeNums, symbols: config.includeSymbols,
-            lowercase: !config.excludeLowerChars, uppercase: !config.excludeUpperChars,
-            strict: config.strictMode
-        };
-        const pwResult = generatePassword(funcOptions);
-        console.log('\n' + bw + ( Array.isArray(pwResult) ? pwResult.join('\n') : pwResult ) + nc);
-    }
-
-    function printHelpSections(includeSections = ['cmdFormat', 'paramOptions', 'booelanOptions', 'infoCmds']) {
-        const helpSections = {
-            'cmdFormat': [
-                `\n${by}generate-pw [options|commands]${nc}`
-            ],
-            'paramOptions': [
-                '\nParameter options:',
-                ' --length=n                  Generate password(s) of n length.',
-                ' --qty=n                     Generate n password(s).',
-                ' --charset=chars             Only include chars in password(s).',
-                ' --charset=chars             Only include chars in password(s).',
-                ' --exclude=chars             Exclude chars from password(s).'
-            ],
-            'booelanOptions': [
-                '\nBoolean options:',
-                ' -n, --include-numbers       Allow numbers in password(s).',
-                ' -s, --include-symbols       Allow symbols in password(s).',
-                ' -L, --no-lowercase          Disallow lowercase letters in password(s).',
-                ' -U, --no-uppercase          Disallow uppercase letters in password(s).'
-            ],
-            'infoCmds': [
-                '\nInfo commands:',
-                ' -h, --help                  Display help screen.',
-                ' -v, --version               Show version number.'
-            ]
-        };
-        includeSections.forEach(section => { // print valid arg elems
-            helpSections[section]?.forEach(line => printHelpMsg(line)); });
-
-        function printHelpMsg(msg) { // wrap msg + indent 2nd+ lines (for --help screen)
-            const terminalWidth = process.stdout.columns || 80,
-                  indentation = 29, lines = [], words = msg.match(/\S+|\s+/g);
-
-            // Split msg into lines of appropriate lengths
-            let currentLine = '';
-            words.forEach(word => {
-                const lineLength = terminalWidth - ( lines.length === 0 ? 0 : indentation );
-                if (currentLine.length + word.length > lineLength) { // cap/store it
-                    lines.push(lines.length === 0 ? currentLine : currentLine.trimStart());
-                    currentLine = '';
-                }
-                currentLine += word;
-            });
-            lines.push(lines.length === 0 ? currentLine : currentLine.trimStart());
-
-            // Print formatted msg
-            lines.forEach((line, index) => console.info(
-                index === 0 ? line // print 1st line unindented
-                    : ' '.repeat(indentation) + line // print subsequent lines indented
-            ));
-        }
-    }
-}