https://github.com/zxcvbn-ts/zxcvbn

Low-Budget Password Strength Estimation
https://github.com/zxcvbn-ts/zxcvbn

hacktoberfest password password-strength

Last synced: over 1 year ago
JSON representation

Low-Budget Password Strength Estimation

• Host: GitHub
• URL: https://github.com/zxcvbn-ts/zxcvbn
• Owner: zxcvbn-ts
• License: mit
• Created: 2019-12-06T15:07:35.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-07T19:49:35.000Z (almost 2 years ago)
• Last Synced: 2024-10-28T05:35:18.016Z (over 1 year ago)
• Topics: hacktoberfest, password, password-strength
• Language: TypeScript
• Homepage: https://www.usenix.org/conference/usenixsecurity16/technical-sessions/presentation/wheeler
• Size: 26.5 MB
• Stars: 902
• Watchers: 7
• Forks: 72
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-list - zxcvbn - Budget Password Strength Estimation | zxcvbn-ts | 129 | (TypeScript)

README

          
[![@zxcvbn-ts/core](https://badgen.net/bundlephobia/min/@zxcvbn-ts/core)](https://bundlephobia.com/result?p=@zxcvbn-ts/core)

[![@zxcvbn-ts/core](https://badgen.net/npm/v/@zxcvbn-ts/core)](https://www.npmjs.com/package/@zxcvbn-ts/core)

[![@zxcvbn-ts/core](https://img.shields.io/github/license/zxcvbn-ts/zxcvbn)](LICENSE.txt)

[![@zxcvbn-ts/core](https://img.shields.io/github/actions/workflow/status/zxcvbn-ts/zxcvbn/build.js.yml?branch=master)](https://github.com/zxcvbn-ts/zxcvbn/actions/workflows/build.js.yml)

# zxcvbn-ts

This is a complete rewrite of [zxcvbn](https://github.com/dropbox/zxcvbn) into typescript

which is licensed under the [MIT](https://github.com/dropbox/zxcvbn/blob/master/LICENSE.txt) license.

Thanks to the original creators [dropbox](https://github.com/dropbox) for the great work.

> zxcvbn is a password strength estimator inspired by password crackers. 

> Through pattern matching and conservative estimation, 

> it recognizes and weighs 40k common passwords, 

> common names surnames, popular words from Wikipedia and common word in different language from different countries, 

> and other common patterns like dates, repeats (aaa), sequences (abcd), keyboard patterns (qwertyuiop), and l33t speak.

>

> Consider using zxcvbn as an algorithmic alternative to password composition policy — it is more secure, 

> flexible, and usable when sites require a minimal complexity score in place of annoying rules like "passwords must contain three of {lower, upper, numbers, symbols}".

>

> - More secure: policies often fail both ways, allowing weak passwords (P@ssword1) and disallowing strong passwords.

> - More flexible: zxcvbn allows many password styles to flourish so long as it detects sufficient complexity — passphrases are rated highly given enough uncommon words, keyboard patterns are ranked based on length and number of turns, and capitalization adds more complexity when it's unpredictaBle.

> - More usable: zxcvbn is designed to power simple, rule-free interfaces that give instant feedback. In addition to strength estimation, zxcvbn includes minimal, targeted verbal feedback that can help guide users towards less guessable passwords.

> For further detail and motivation, please refer to the USENIX Security '16 [paper and presentation](https://www.usenix.org/conference/usenixsecurity16/technical-sessions/presentation/wheeler).

The reason of this project is to modernize zxcvbn and make it maintainable with new features.

- [Features](#features)

- [Documentation](#Documentation)

- [LanguagePackages](#LanguagePackages)

- [Comparison](#Comparison)

- [Contribution](#Contribution)

## Features

- estimate strength of a password

- get a score for the password

- i18n support, for dictionaries and feedback translations

- extend existing dictionaries with your own

- usable without dictionaries at all, which reduce the scoring efficiency rapidly. This is not recommended

- types

- custom matcher

- [haveibeenpwned](https://haveibeenpwned.com/Passwords) matcher



## Documentation

Checkout the [Documentation](https://zxcvbn-ts.github.io/zxcvbn/).

There you will also find the [Demo](https://zxcvbn-ts.github.io/zxcvbn/demo/) pages

and the [Migration](https://zxcvbn-ts.github.io/zxcvbn/guide/migration) guide.

## LanguagePackages

If your language is missing as a language pack checkout the [guide](https://zxcvbn-ts.github.io/zxcvbn/guide/languages/#add-a-new-language-package) to add your own.

## Comparison

If you want to know how much the scoring changed compared to the original checkout the [comparison](https://zxcvbn-ts.github.io/zxcvbn/guide/comparison) page.

## Contribution

Please feel free to [open up an issue](https://github.com/zxcvbn-ts/zxcvbn/issues/new) or provide a pull request.