password-meter

Version:

This password meter library is inspired by pointing system in http://www.passwordmeter.com/, in which the main purpose is to help the end users to have more stronger passwords.

github.com/HamedFathi/PasswordMeter

HamedFathi/PasswordMeter

118 lines (100 loc) • 51.9 kB

HTML

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>password-meter</title><meta name="description" content="Documentation for password-meter"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">password-meter</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility">All<ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>password-meter </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography"><img src="https://user-images.githubusercontent.com/8418700/140722813-db8b8cdb-9f97-4710-aff4-14450264bf82.png" alt="password"> <a href="#passwordmeter" id="passwordmeter" style="color: inherit; text-decoration: none;"> <h1>PasswordMeter</h1> </a> This password meter library is inspired by pointing system in <a href="http://www.passwordmeter.com/">here</a>, in which the main purpose is to help the end users to have more stronger passwords. <a href="https://opensource.org/licenses/MIT"><img src="https://badges.frapsoft.com/os/mit/mit.svg?v=102" alt="Open Source Love"></a> <a href="https://badge.fury.io/js/password-meter"><img src="https://badge.fury.io/js/password-meter.svg" alt="npm version"></a> <a href="https://www.npmjs.com/package/password-meter"><img src="https://img.shields.io/npm/dm/password-meter.svg" alt="Downloads"></a> <pre><code>npm i password-meter yarn add password-meter </code></pre> <pre><code class="language-javascript"> // default console.log(JSON.stringify(new PasswordMeter().getResult('@xc5--WWb'))); // result { "score" : 170, "status" : "strong", "percent" : 85 } // with score range console.log(JSON.stringify(new PasswordMeter({}, { "40": "E", // 001 <= x < 040 "80": "D", // 040 <= x < 080 "120": "C", // 080 <= x < 120 "180": "B", // 120 <= x < 180 "200": "A", // 180 <= x < 200 "_": "A+" // x >= 200 }).getResult('@xc5--WWb'))); // result { "score" : 170, "status" : "B", "percent" : 85 } // with score range (The score range must have at least two members) console.log(JSON.stringify(new PasswordMeter({}, { "100": "Low", // 001 <= x < 100 "_": "High" // x >= 100 }).getResult('@xc5--WWb'))); // result { "score" : 170, "status" : "High", "percent" : 100 } // with requirements and score range console.log(JSON.stringify(new PasswordMeter({ minLength: 5, maxLength: 10, uppercaseLettersMinLength: 1, lowercaseLettersMinLength: 2, numbersMinLength: 1, symbolsMinLength: 1, include: ['a', '$'], exclude: ['1baA$', '0xaZ$'], startsWith: '1', endsWith: '$', includeOne: ['$'] }, { "40": "veryWeak", // 001 <= x < 040 "80": "weak", // 040 <= x < 080 "120": "medium", // 080 <= x < 120 "180": "strong", // 120 <= x < 180 "200": "veryStrong", // 180 <= x < 200 "_": "perfect" // x >= 200 }).getResults(['1baAe$', '0xaZ$', 'ERT', '1pwQvF@87$','12a4A6rx90$']))); // result [{ "score" : 118, "status" : "medium", "percent" : 59 }, { "score" : -1, "status" : "needs requirement(s)", "errors" : ["The password must start with 1.", "The Password must exclude all the items specified."], "percent" : 0 }, { "score" : -1, "status" : "needs requirement(s)", "errors" : ["The minimum password length is 5.", "The password must start with 1.", "The password must end with $.", "You must use at least 1 lowercase letter(s).", "You must use at least 1 number(s).", "You must use at least 1 symbol(s).", "The Password must include all the items specified.", "The Password must include at least one item specified [$]."], "percent" : 0 }, { "score" : -1, "status" : "needs requirement(s)", "errors" : ["The Password must include all the items specified."], "percent" : 0 }, { "score" : -1, "status" : "needs requirement(s)", "errors" : ["The maximum password length is 10."], "percent" : 0 } ] // with requirements and score range and custom messages console.log(JSON.stringify(new PasswordMeter({ minLength: { value: 5, message: "Hey!, check minLength" }, maxLength: { value: 10, message: "Hey!, check maxLength" }, uppercaseLettersMinLength: { value: 1, message: "Hey!, check uppercaseLettersMinLength" }, lowercaseLettersMinLength: { value: 2, message: "Hey!, check lowercaseLettersMinLength" }, numbersMinLength: { value: 1, message: "Hey!, check numbersMinLength" }, symbolsMinLength: { value: 1, message: "Hey!, check symbolsMinLength" }, include: { value: ['a', '$'], message: "Hey!, check include(s)" }, exclude: { value: ['1baA$', '0xaZ$'], message: "Hey!, check exclude(s)" }, startsWith: { value: '1', message: "Hey!, check startsWith" }, endsWith: { value: '$', message: "Hey!, check endsWith" }, includeOne: { value: ['$'], message: "Hey!, check includeOne" } }, { "40": "veryWeak", // 001 <= x < 040 "80": "weak", // 040 <= x < 080 "120": "medium", // 080 <= x < 120 "180": "strong", // 120 <= x < 180 "200": "veryStrong", // 180 <= x < 200 "_": "perfect" // x >= 200 }).getResults(['1baAe$', '0xaZ$', 'ERT', '1pwQvF@87$','12a4A6rx90$']))); // result [{ "score" : 118, "status" : "medium", "percent" : 59 }, { "score" : -1, "status" : "needs requirement(s)", "errors" : ["Hey!, check startsWith", "Hey!, check exclude(s)"], "percent" : 0 }, { "score" : -1, "status" : "needs requirement(s)", "errors" : ["Hey!, check minLength", "Hey!, check startsWith", "Hey!, check endsWith", "Hey!, check lowercaseLettersMinLength", "Hey!, check numbersMinLength", "Hey!, check symbolsMinLength", "Hey!, check include(s)", "Hey!, check includeOne"], "percent" : 0 }, { "score" : -1, "status" : "needs requirement(s)", "errors" : ["Hey!, check include(s)"], "percent" : 0 }, { "score" : -1, "status" : "needs requirement(s)", "errors" : ["Hey!, check maxLength"], "percent" : 0 } ] </code></pre> <hr/> <a href="#release-notes" id="release-notes" style="color: inherit; text-decoration: none;"> <h3>Release notes</h3> </a> <a href="#version-3101" id="version-3101" style="color: inherit; text-decoration: none;"> <h5>Version 3.10.1</h5> </a> Adding <code>exports</code> block to <code>package.json</code> to support <code>.cjs</code> and <code>.mjs</code>. All dependencies upddated. <a href="#version-393" id="version-393" style="color: inherit; text-decoration: none;"> <h5>Version 3.9.3</h5> </a> <code>System.js</code> module format added. All dependencies upddated. <a href="#version-392" id="version-392" style="color: inherit; text-decoration: none;"> <h5>Version 3.9.2</h5> </a> For <code>unpkg</code>, the minified <code>UMD</code> package was set. Fix bundle's name issue. Now, you can use the library inside a browser as well as the Node.js. <pre><code class="language-js">// IIFE // https://unpkg.com/password-meter@VERSION/dist/index.iife.js // https://unpkg.com/password-meter@3.9.3/dist/index.iife.js // https://unpkg.com/password-meter@3.9.3/dist/index.iife.min.js var pswm = new PasswordMeterModule.PasswordMeter(); var result = pswm.getResult("pa$$w0rd"); </code></pre> and also, <pre><code class="language-js">// UMD // https://unpkg.com/password-meter@VERSION/dist/index.umd.js // https://unpkg.com/password-meter // https://unpkg.com/password-meter@3.9.3/dist/index.umd.js // https://unpkg.com/password-meter@3.9.3/dist/index.umd.min.js var pswm = new PasswordMeterModule.PasswordMeter(); var result = pswm.getResult("pa$$w0rd"); </code></pre> <a href="#version-381" id="version-381" style="color: inherit; text-decoration: none;"> <h5>Version 3.8.1</h5> </a> Fix a bug for <code>UMD</code> module name. <a href="#version-38" id="version-38" style="color: inherit; text-decoration: none;"> <h5>Version 3.8</h5> </a> No new feature or breaking changes just changing in project structure. (From <code>Gulp</code> to <code>Rollup</code>) <a href="#version-37" id="version-37" style="color: inherit; text-decoration: none;"> <h5>Version 3.7</h5> </a> In <code>getResult(password: string, ignoreCase: boolean = false, skipReq: boolean = false))</code> <code>skipReq</code> was added. With this option we could provide a "score" to our users based on the current typed password (even if they aren't according to requirements). <pre><code class="language-typescript">console.log(JSON.stringify(new PasswordMeter({ uniqueLettersMinLength: { value: 5, message: "Hey!, check uniqMinLength" } }).getResult('aZ&4aZ&4', false, true))); // result {"score":124,"status":"strong","percent":62,"errors":["Hey!, check uniqMinLength"]} </code></pre> <a href="#version-36" id="version-36" style="color: inherit; text-decoration: none;"> <h5>Version 3.6</h5> </a> <code>includeOne</code> added. Now you can define custom special characters set. <pre><code class="language-typescript">console.log(JSON.stringify(new PasswordMeter({ includeOne: { value: ["#", "!", "*"], message: "Hey!, check includeOne" }, }).getResult('aZ&4aZ&4'))); // result {"score":-1,"status":"needs requirement(s)","errors":["Hey!, check includeOne"],"percent":0} </code></pre> They are looking for including at least one character from provided set, but <code>aZ&4aZ&4</code> has none of them! <a href="#version-35" id="version-35" style="color: inherit; text-decoration: none;"> <h5>Version 3.5</h5> </a> bug fixed: <code>uniqueLettersMinLength</code> is optional now. <a href="#version-34" id="version-34" style="color: inherit; text-decoration: none;"> <h5>Version 3.4</h5> </a> <code>uniqueLettersMinLength</code> added. Now you can define min length for unique letters. <pre><code class="language-typescript">console.log(JSON.stringify(new PasswordMeter({ uniqueLettersMinLength: { value: 5, message: "Hey!, check uniqMinLength" }, }).getResult('aZ&4aZ&4'))); // result {"score":-1,"status":"needs requirement(s)","errors":["Hey!, check uniqMinLength"],"percent":0} </code></pre> They are looking for <code>5</code> unique characters but <code>aZ&4aZ&4</code> needs one more! <a href="#version-33" id="version-33" style="color: inherit; text-decoration: none;"> <h5>Version 3.3</h5> </a> <pre><code>Everything except letters (a-z and A-Z) and numbers (0-9) are considered symbols, so the symbols are not defined in advance. </code></pre> <a href="#version-32" id="version-32" style="color: inherit; text-decoration: none;"> <h5>Version 3.2</h5> </a> <pre><code>An 'ignoreCase' mode is added in .getResult('',ignoreCase: boolean = false)) and also for .getResults([],ignoreCase: boolean = false)) as a parameter. Obviously, the default value is 'false', It helps you to 'exclude' and 'blackList' passwords in an easier way if you pass the 'true' then exclude: { value: ['test'], message: "Hey!, check exclude(s)" }, means every kind of 'test' word for example teST, TEST, Test eESt and so on are excluded. </code></pre> <a href="#version-31" id="version-31" style="color: inherit; text-decoration: none;"> <h5>Version 3.1</h5> </a> <pre><code>- blackList property added. eg: { blackList : ['123456','p@ssw0rd'] } </code></pre> <a href="#version-30" id="version-30" style="color: inherit; text-decoration: none;"> <h5>Version 3.0</h5> </a> <pre><code>- mustBe renamed to include. - mustNotBe renamed to exclude. - The getResult(s) includes percent. - You can create an object as a fully customizable score range. { "score" : "message" } Conditions : 1. The score range must have at least two members. 2. The last member of the score range must be "_". </code></pre> <a href="#version-20" id="version-20" style="color: inherit; text-decoration: none;"> <h5>Version 2.0</h5> </a> <pre><code>- getScore() renamed to getResult() - getScores() renamed to getResults() </code></pre> <hr/> <div>Icons made by <a href="https://www.freepik.com" title="Freepik">Freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flati