1. module owasp-password-strength-test
   1. function owasp-password-strength-test.config (params)
   2. function owasp-password-strength-test.test (password)
   3. object owasp-password-strength-test.configs
   4. object owasp-password-strength-test.tests

module owasp-password-strength-test

function owasp-password-strength-test.config (params)

• description and source-code

  config = function (params) {
    for (var prop in params) {
      if (params.hasOwnProperty(prop) && this.configs.hasOwnProperty(prop)) {
        this.configs[prop] = params[prop];
      }
    }
  }

• example usage

  ...
  
  
  ```javascript
  var owasp = require('owasp-password-strength-test');
  
  // Pass a hash of settings to the `config` method. The settings shown here are
  // the defaults.
  owasp.config({
    allowPassphrases       : true,
    maxLength              : 128,
    minLength              : 10,
    minPhraseLength        : 20,
    minOptionalTestsToPass : 4,
  });
  ```
  ...

function owasp-password-strength-test.test (password)

• description and source-code

  test = function (password) {
  
    // create an object to store the test results
    var result = {
      errors              : [],
      failedTests         : [],
      passedTests         : [],
      requiredTestErrors  : [],
      optionalTestErrors  : [],
      isPassphrase        : false,
      strong              : true,
      optionalTestsPassed : 0,
    };
  
    // Always submit the password/passphrase to the required tests
    var i = 0;
    this.tests.required.forEach(function(test) {
      var err = test(password);
      if (typeof err === 'string') {
        result.strong = false;
        result.errors.push(err);
        result.requiredTestErrors.push(err);
        result.failedTests.push(i);
      } else {
        result.passedTests.push(i);
      }
      i++;
    });
  
    // If configured to allow passphrases, and if the password is of a
    // sufficient length to consider it a passphrase, exempt it from the
    // optional tests.
    if (
      this.configs.allowPassphrases === true &&
      password.length >= this.configs.minPhraseLength
    ) {
      result.isPassphrase = true;
    }
  
    if (!result.isPassphrase) {
      var j = this.tests.required.length;
      this.tests.optional.forEach(function(test) {
        var err = test(password);
        if (typeof err === 'string') {
          result.errors.push(err);
          result.optionalTestErrors.push(err);
          result.failedTests.push(j);
        } else {
          result.optionalTestsPassed++;
          result.passedTests.push(j);
        }
        j++;
      });
    }
  
    // If the password is not a passphrase, assert that it has passed a
    // sufficient number of the optional tests, per the configuration
    if (
      !result.isPassphrase &&
      result.optionalTestsPassed < this.configs.minOptionalTestsToPass
    ) {
      result.strong = false;
    }
  
    // return the result
    return result;
  }

• example usage

  ...
  
  ### Server-side ###
  ```javascript
  // require the module
  var owasp = require('owasp-password-strength-test');
  
  // invoke test() to test the strength of a password
  var result = owasp.test('correct horse battery staple');
  ```
  
  ### In-browser ###
  ```javascript
  // in the browser, including the script will make a
  // `window.owaspPasswordStrengthTest` object availble.
  var result = owaspPasswordStrengthTest.test('correct horse battery staple');
  ...