1.1.0 • Published 6 years ago

@smartfrog/password v1.1.0

Weekly downloads
1
License
MIT
Repository
-
Last release
6 years ago

@smartfrog/password

password validity checker

npm version codecov Build Status

Rules

Password must contain the following:

  • at least 8 characters long - shown
  • at most 64 characters long - (not shown to the user for our internal use only)
  • Password must meet the following rules:
    • at least 1 uppercase character (A-Z)
    • at least 1 lowercase character (a-z)
    • at least 1 digit (0-9)
  • Spaces are also allowed but do not change the strength of the password

Strength will be measured as:

  • WEAK - not acceptable
  • MEDIUM - Acceptable
  • STRONG - Acceptable & minimum 10 characters

Usage

const password = require('@smartfrog/password')

password.isValid('test123!') //> false
password.isValid('Test123!') //> true

API

password.isValid(value)

check if password is valid based on the matching rules

return boolean


password.getScore(value)

get the score of a given password based on the matching rules

return number


password.getStrength(value)

get the strength of a given password based on the matching rules

return one of those value: 'WEAK', 'MEDIUM', 'STRONG'


password.getErrors(value)

get the errors of a given password based on the matching rules

return object


Examples

PasswordStrength
WEAK
!@$&$&WEAK
abcdefgWEAK
abcdefg!WEAK
abcdefghWEAK
ABCDEFGHWEAK
AbcdefghWEAK
AbcdefgWEAK
AbcdefgWEAK
Abcdef1WEAK
1234567WEAK
1-!@#$%WEAK
1234578WEAK
123457aBMEDIUM
Abcdefg1MEDIUM
Abcdefg12MEDIUM
Ab!@#$%12MEDIUM
Abcdefgh12STRONG
Abcdefgh1$STRONG
Abcdefgh1$34567890!@#$%^&*(dgdfnogSTRONG