Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

semantic-password-generator

GitHub Workflow Status npm bundle size npm type definitions

Secure passwords that humans can read πŸ—

Install

yarn add semantic-password-generator

Usage

The Semantic Password Generator (spg) uses the official Wikipedia API to get random articles which are transformed into the passwords. Hence, to allow a better usage of the network bandwich spg generates the password in 2 steps:

  1. Load a generator with a Wikipedia article
  2. Use the generator to get passwords
import spg from 'semantic-password-generator'

const generator = await spg()
const password = generator()

You can then safely generate multiple (similar) passwords with the same generator. This is usefull if you want to tweak it: length, l33t, symbols, etc.

while (passwords.length < 50) {
  passwords.push(generator())
}

The generator accepts a length argument. Note that the length won't be enforced. This means that if you want, say, a 10 chars length password. spg probably will return a bit longer one that you can trim if you want to. This is because spg tries to keep logic sentences as much as possible and forcing a hard length will cut the last word almost all the times.

// accepts a length
generator(32)

// accepts a config object, as well
// these are the defaults
generator({
  case: false,
  length: 24,
  leet: false,
  random: false,
  symbols: false,
})

Notice that internally spg ensures a minimum password length of 8. And a maximum as large as the Wikipedia article can provide. If you need less than 8 (please don't) you can trim it. If you want a larger one you can combine multiple generated passwords.

Example

To explore the lib and explore it check out the /packages/website directory. Here's a snapshot of the important bits:

import spg from 'semantic-password-generator'

let generator = await spg()

$renew.addEventListener('click', async () => {
  // create a new generator from another Wikipedia article
  generator = await spg()
  updatePassword(generator())
})

$tweak.addEventListener('change', async () => {
  // generate similar ones, no need to fetch Wikipedia anew
  updatePassword(generator())
})

About

Secure passwords that humans can read πŸ—

Topics

Resources

License

Stars

Watchers

Forks

Languages