voipex-password-policy v1.0.0

voipex-pwd-policy

Voipex passwpord policy is library consist from another libraries which were put to getter to make one complex library handeling password policies.

Documentation

Setters

defaultPolicy (string)

Set default policy used by IPEX a.s.

policy.defaultPolicy = 'sip'

Parameters

• policy
  • default value: not set
  • allowed value - 'sip', 'users'

minimumLength (int)

Minimal length of password to be valid. If value is 0 validator is not applied

Parameters

• minimumLength
  • default value: 0
  • when value is 0 validator is not used

policy.minimumLength = 1

maximumLength (int)

Maximal length of password to be valid. Default = 0 validotor is not used

Parameters

• maximumLength
  • default value: 0
  • when value is 0 validator is not used

policy.maximumLength = 1

allowedUpperLetter (string)

Set of uppers letters which password can only contain.

Parameters

• upperLetters
  • default value: 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'

policy.allowedUpperLetter = 'A'

allowedLowerLetter (string)

Set of lower letters which password can only contain

Parameters

• lowerLetters
  • default value: 'abcdefghijklmnopqrstuvwxyz'

policy.allowedLowerLetter = 'a'

alloweNumbers (string)

Set of digits which password can only contain.

Parameters

• numbers
  • default value: '0123456789'

policy.alloweNumbers = '0'

alloweSymbols (string)

Set of symbols which password can only contain

Parameters

• symbols -
  • default value: '_-!"?$%^&*()+={}[]:;@\'~#|<>,.?\/ '

policy.alloweSymbols = '-'

minimumTimeToCrack (int)

Minimal time for which password could't be cracked

Parameters

• days
  • default value: 0
  • when value is 0 validator is not used

policy.minimumTimeToCrack = 1

minimumNumberOfUpperLetters (int)

Minimal count of upper letters in password to be valid

Parameters

• numberOfUpperLetters
  • default value: 0
  • when value is 0 validator is not used

policy.minimumNumberOfUpperLetters = 1

minimumNumberOfDigits (int)

Minimal count of digits in password to be valid

Parameters

• numberOfDigits
  • default value: 0
  • when value is 0 validator is not used

policy.minimumNumberOfDigits = 1

Getters

errors: array

Return list of errors in validators

console.log(policy.errors)

Validators

checkSymbols (boolean)

Check if password contains only allowed symbols

• active
  • default value: false

checkLetters (boolean)

Check if password contains only allowed letters

• active
  • default value: false

checkNumbers (boolean)

Check if password contains only allowed digits

• active
  • default value: false

validate (string)

Validate given password on setted rules

• password

Example

const PasswordPolicy = require('voipex-password-policy')

const policy = new PasswordPolicy()
policy.defaultPolicy = 'user'
policy.validate('password')