passphrase.js

Passphrase generation for the browser, and your module

Purpose

Passphrase generation is a useful facet of obtaining a unique identifier, or a secure token

Traditionally, there have been passphrase libraries for nodejs modules; but none of them extend to the browser

This module provides a simple interface for passphrase generation, both in the browser, and as a module

Several wordlists have been included, thanks to the wonderful Electronic Frontier Foundation (EFF)

API Documentation

Detailed API documentation can be found within the api folder

Usage

Browser

All browser files are located within the dist folder

You can pick and choose which wordlists to include, or none at all

The primary logic functions exist within the functions.min.js file

Corresponding <file>.min.js.map files are also provided for debugging

...
<script
  type="text/javascript"
  src="https://cdn.jsdelivr.net/npm/passphrase.js@latest/dist/effLarge.min.js"
></script>
<script
  type="text/javascript"
  src="https://cdn.jsdelivr.net/npm/passphrase.js@latest/dist/effShort1.min.js"
></script>
<script
  type="text/javascript"
  src="https://cdn.jsdelivr.net/npm/passphrase.js@latest/dist/effShort2.min.js"
></script>
<script
  type="text/javascript"
  src="https://cdn.jsdelivr.net/npm/passphrase.js@latest/dist/functions.min.js"
></script>
<script type="text/javascript">
  console.log(passphrase.genPassPhraseNormal(4, passphrase.effLarge));
  // > busybody squabble agonizing armhole
  console.log(passphrase.genPassPhraseCrypto(4, passphrase.effShort1));
  // > card ruby stood union
</script>
...

CDN

We leverage jsDelivr for CDN hosting

You can either point to the latest version, or a tagged version, as shown below

https://cdn.jsdelivr.net/npm/passphrase.js@latest/dist/functions.min.js
https://cdn.jsdelivr.net/npm/passphrase.js@<release_version>/dist/functions.min.js

The latest tagged versions can be found on our NPM package versions tab

NodeJS

This module can be used within nodejs, it supports commonjs for now

npm install passphrase.js

const passphrase = require("passphrase.js");
console.log(passphrase.genPassPhraseNormal(4, passphrase.effLarge));
// > dangle raft failing say
console.log(passphrase.genPassPhraseCrypto(4, passphrase.effShort1));
// > copy suds watch bolt

Notes

• Some of the EFF words contain a - within them, keep this in mind if you use that as a separator

License

The MIT License