Tiny entropy-based password strength meter
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist
src
test
.gitattributes
.gitignore
.jshintrc
README.md
bower.json
gruntfile.js
package.json

README.md

Entropizer

Tiny password entropy calculator

For the jQuery plugin, click here

What is entropy and why should I care?

Entropy is a measure of disorder. In the context of passwords, it's a measure of how many different password combinations there are using a certain set of rules. The more combinations an attacker has to check, the longer it will take them to crack your password by brute force.

Entropy is expressed in bits - this is the logarithm (base 2) of the number of combinations. As such, an 80-bit password isn't twice as strong as a 40-bit password, it's 240 (about a trillion) times stronger.

A lot of password meters still use basic criteria such as minimum length, number and symbol requirements etc. This is inadequate and results in weak, forgettable passwords. Entropy is a much more reliable measure of password strength.

What is Entropizer?

Entropizer is a simple, super-lightweight (~1kb minified) library that calculates password entropy. It's easy to set up and customize, and comes with several preset character classes. You can also define custom character classes (e.g. for localization).

Entropizer supports AMD and CommonJS. It is available as an npm package and a bower component.

Getting Started

Basic usage:

// Use default character classes: lowercase, uppercase, numeric, split symbols (common and uncommon)
var entropizer = new Entropizer();

// ~57 bits of entropy
var entropy = entropizer.evaluate('password123');

Preset character classes are found under Entropizer.classes:

lowercase, uppercase, numeric, symbols, symbolsCommon, symbolsUncommon, hexadecimal

Specify the classes to use:

// Using names
var entropizer = new Entropizer({
	classes: ['lowercase', 'uppercase', 'numeric']
});

// Using the character class objects
var entropizer = new Entropizer({
	classes: [
		Entropizer.classes.lowercase,
		Entropizer.classes.uppercase,
		Entropizer.classes.numeric
	]
});

// Custom character classes
var entropizer = new Entropizer({
	classes: [
		{ regex: /[a-m]/, size: 13 },		// Using regex and a class size
		{ characters: 'nopqrstuvwxyz' }		// Using characters (implicit size)
	]
});

You can mix and match these different ways of defining character classes.

Browser compatibility

Entropizer supports IE6+, Firefox, Chrome and Opera.

Still confused?

Read the source, it's tiny!