Installations
npm install xkcd-pass-genScore
65.5
Supply Chain
85.3
Quality
74.9
Maintenance
100
Vulnerability
100
License
Releases
Unable to fetch releases
Developer
jctrvlr
Developer Guide
Module System
CommonJS
Min. Node Version
Typescript Support
No
Node Version
13.12.0
NPM Version
6.14.4
Statistics
10 Commits
2 Watching
7 Branches
1 Contributors
Updated on 30 Oct 2023
Languages
JavaScript (100%)
Total Downloads
Cumulative downloads
Total Downloads
5,493
Last day
0%
2
Compared to previous day
Last week
-44.4%
5
Compared to previous week
Last month
-67.3%
16
Compared to previous month
Last year
1%
2,513
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
XKCD-based Password Generator - Based on XKPasswd - Bart Busschots https://xkpasswd.net
Generates a password based on parameters.
Install
To install in your projects:
npm install --save xkcd-pass-gen
Usage
Options
| Name | Type | Optional | Default | Description |
|---|---|---|---|---|
| numPasswords | int | True | 1 | Number of passwords to be generated |
| numWords | int | True | 2 | Number of words in each generated password |
| minLength | int | True | 4 | Minimum length of word generated |
| maxLength | int | True | 4 | Maximum length of word generated |
| sepType | string | True | 'none' | none [none], specified [spec](specific character specified in .sep), random character [rand](random character from array of characters given in .sep) |
| sep | string/array | True | '-' | Character(s) to be used as separators. Either single character or array depending on separator type |
| wCase | string | True | 'alt' | Word case. Options: Alternating [alt], First Letter [first], lowercase [lower], uppercase [upper], capitalize every letter except the first [except] |
| padDigBe | int | True | 0 | Number of digits to add at the front |
| padDigAf | int | True | 2 | Number of digits to add at the end |
| padsType | int | True | 'none' | Padding to end symbol type. Options: none [none], specified [spec], random symbol [rand] |
| padsLoc | int | True | 'end' | Padding symbol location. Will only be used if padsType is set to something other than none. Options: beginning [beg], end [end], both [both] |
| padsAmount | int | True | 2 | Number of symbol characters to be added. Will only be used if padsType is set to something other than none. |
| pads | int | True | '$' | Symbol(s) to be used as padding. Either single character or array depending on separator type. |
Example
1const genPasswords = require('xkcd-pass-gen'); 2 3// Passing in nothing will print default wordWORD## 4genPasswords().then((result) => { 5 console.log(result); 6}); 7 8// Passing in some parameters 9const options = { 10 numPasswords: 4, 11 numWords: 3, 12 minLength: 2, 13 maxLength: 4, 14}; 15 16genPasswords(options).then((result) => { 17 console.log(result); 18});
Lambda
You can create a nodejs lambda function with the lambda folder.
Questions?
- Found a bug or just have a question? Open an issue here on Github!
- Tweet at me @thecuriouseng
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 0/10 approved changesets -- score normalized to 0
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
project is archived
Details
- Warn: Repository is archived.
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
14 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Score
1.7
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More