Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deanilvincent/check-password-strength
A simple npm package that checks the password strength of a certain passphrase. A password strength checker based from Javascript RegEx.
https://github.com/deanilvincent/check-password-strength
javascript-regex npm npm-package passphrase password-regex password-strength regex
Last synced: 1 day ago
JSON representation
A simple npm package that checks the password strength of a certain passphrase. A password strength checker based from Javascript RegEx.
- Host: GitHub
- URL: https://github.com/deanilvincent/check-password-strength
- Owner: deanilvincent
- License: mit
- Created: 2020-01-23T08:04:58.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-01-20T18:09:44.000Z (9 days ago)
- Last Synced: 2025-01-27T19:13:11.431Z (2 days ago)
- Topics: javascript-regex, npm, npm-package, passphrase, password-regex, password-strength, regex
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/check-password-strength
- Size: 662 KB
- Stars: 174
- Watchers: 6
- Forks: 17
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Overview
A simple way to check that password strength of a certain passphrase. The library is fully typed.
[](https://dev.azure.com/dv-github-repos/check-password-strength/_build/latest?definitionId=12)
[](https://img.shields.io/npm/dm/check-password-strength.svg) [](https://img.shields.io/npm/dt/check-password-strength.svg)
[DEMO 1](https://svelte.dev/repl/b5bf5871c99742e584da244b4bfeac92?version=3.44.3) by [@Ennoriel](https://github.com/Ennoriel)
[DEMO 2](https://check-password-strength.netlify.app/)
## Installation
### Install via Package Manager
`npm i check-password-strength --save`
### Install via Browser Script Tag using [UNPKG](https://unpkg.com/)
```html
const passwordStrength = checkPasswordStrength.passwordStrength('pwd123').value; // 'Weak'
```
## Setup & Basic Usage
```javascript
const { passwordStrength } = require('check-password-strength')
// OR
import { passwordStrength } from 'check-password-strength'
console.log(passwordStrength('asdfasdf').value)
// Too weak (It will return Too weak if the value doesn't match the Weak conditions)
console.log(passwordStrength('asdf1234').value)
// Weak
console.log(passwordStrength('Asd1234!').value)
// Medium
console.log(passwordStrength('A@2asdF2020!!*').value)
// Strong
```
## API
### arguments
The `passwordStrength` takes 3 arguments:
- `password` (string): the user password
- `options` (array — optional): an option to override the default complexity required to match your password policy. See below.
- `restrictSymbolsTo` (string — optional):
- By default, the `passwordStrength` function checks against all characters except for the 26 Latin lowercase letters, 26 uppercase letters, and 10 digits. This includes OWASP-recommended characters, accented letters, other alphabets, and emojis.
- If you wish to apply restrictions, you can provide a custom string. This string should consist of unescaped symbol characters, which will be utilized internally in a RegExp expression in the following format: `[${escapeStringRegexp(restrictSymbolsTo)}]`.
- Additionally, you can import and use the owaspSymbols to limit the symbols to those recommended by OWASP.
**Password Default Options**
The default options can be required:
```javascript
const { defaultOptions } = require("./index");
// OR
import { defaultOptions } from 'check-password-strength'
```
default options:
```javascript
[
{
id: 0,
value: "Too weak",
minDiversity: 0,
minLength: 0
},
{
id: 1,
value: "Weak",
minDiversity: 2,
minLength: 8
},
{
id: 2,
value: "Medium",
minDiversity: 4,
minLength: 10
},
{
id: 3,
value: "Strong",
minDiversity: 4,
minLength: 12
}
]
```
To override the default options, simply pass your custom array as the second argument:
- id: correspond to the return id attribute.
- value: correspond to the return value attribute.
- minDiversity: between 0 and 4, correspond to the minimum of different criterias ('lowercase', 'uppercase', 'symbol', 'number') that should be met to pass the password strength
- minLength: minimum length of the password that should be met to pass the password strength
**You can use an array containing fewer or more than four items to define the levels of trust.** However, the first element must have both the minDiversity and minLength parameters set to 0. This means that the first element should always represent a "too weak" option.
### Result
The result is an object containing the following values (unless you override the `options`):
| Property | Desc. |
| -------- | --------------------------------------------------------------- |
| id | **0** = Too weak, **1** = Weak & **2** = Medium, **3** = Strong |
| value | Too weak, Weak, Medium & Strong |
| contains | lowercase, uppercase, number and / or symbol |
| length | length of the password |
If you want to translate the value (Too weak → Trop faible), you can translate it based on the return value, or override the `defaultOptions` option, which will be passed back as the function's return value.
## Contribute
Feel free to clone or fork this project: `https://github.com/deanilvincent/check-password-strength.git`
Contributions & pull requests are welcome!
I'll be glad if you give this project a ★ on [Github](https://github.com/deanilvincent/check-password-strength) :)
## changelog
- v3: allow all symbols by default (any character except the 26 latin lowercase, uppercase letters and 10 digits) & set the default min length to 12 instead of 10
- v2: allow configuration through `options` object
- v1: first version
***
Kudos to [@Ennoriel](https://github.com/Ennoriel) and his efforts for making v2 and v3 possible!