https://github.com/scniro/passcheck

https://github.com/scniro/passcheck

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/scniro/passcheck
• Owner: scniro
• License: mit
• Created: 2015-12-30T20:41:16.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-01-18T20:20:41.000Z (over 9 years ago)
• Last Synced: 2025-02-17T21:17:39.394Z (5 months ago)
• Language: JavaScript
• Size: 88.9 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# passcheck

[![Build Status](https://api.travis-ci.org/scniro/passcheck.svg)](https://travis-ci.org/scniro/passcheck)

[![NPM Version](https://img.shields.io/npm/v/passcheck.svg?style=flat)](https://www.npmjs.org/package/passcheck)

a policy driven password strength checker

- [AngularJS wrapper/api](http://ng-passcheck.azurewebsites.net/)

```

 install passcheck

```

### api

```javascript

var passcheck = require('./passcheck'); // -- nodejs. window.passcheck -- browser

```

##### `passcheck.config.get()`

 - returns the configuration

##### `passcheck.config.set(options)`

 - sets and overrides the default configuration

##### `passcheck.eval('password')`

 - returns results

```javascript

var result = passcheck.eval('Password123!');

// { weak: false, medium: false, strong: true, score: 76.5 }

passcheck.config.set({

    common: {

        test: true,

        path: './passwords.json' // 10k common passwords

    }

});

var result = passcheck.eval('password');

// { weak: true, medium: false, strong: false, score: 0, common: true }

```