PasswordPolicy
A tool for checking and creating password policies in PHP and JS.
Installation
Use composer to setup an autoloader
php composer.phar install
Require the composer autoload file:
require_once 'vendor/autoload.php';
Usage:
To use, first instantiate the core policy object:
$policy = new \PasswordPolicy\Policy;
Then, add rules:
$policy->contains('lowercase', $policy->atLeast(2));
Supported rule helper methods are:
-
contains($class, $constraint = null, $description = ''): Checks to see if a password contains a class of charsSupported Short-Cut classes:
letter-a-zA-Zlowercase-a-zuppercase-A-Zdigit-0-9symbol-^a-zA-Z0-9(in other words, non-alpha-numeric)null-\0alnum-a-zA-Z0-9
The second param is a constraint (optional)
-
length($constraint): Checks the length of the password matches a constraint -
endsWith($class, $description = ''): Checks to see if the password ends with a character class. -
startsWith($class, $description = ''): Checks to see if the password starts with a character class. -
notMatch($regex, $description): Checks if the password does not match a regex. -
match($regex, $description): Checks if the password matches the regex.
Supported Constraints:
The policy also has short-cut helpers for creating constraints:
-
atLeast($n): At least the param matchesEquivalent to
between($n, PHP_INT_MAX) -
atMost($n): At most the param matchesEquivalent to
between(0, $n) -
between($min, $max): Between $min and $max number of matches -
never(): No matchesEquivalent to
between(0, 0)
Testing the policy
Once you setup the policy, you can then test it in PHP using the test($password) method.
$result = $policy->test($password);
The result return is a stdclass object with two members, result and messages.
-
$result->result- A boolean if the password is valid. -
$result->messages- An array of messages
Each message is an object of two members:
-
$message->result- A boolean indicating if the rule passed -
$message->message- A textual description of the rule
Using JavaScript
Once you've built the policy, you can call toJavaScript() to generate a JS anonymous function for injecting into JS code.
$js = $policy->toJavaScript();
echo "var policy = $js;";
Then, the policy object in JS is basically a wrapper for $policy->test($password), and behaves the same (same return values).
var result = policy(password);
if (!result.result) {
/* Process Messages To Display Failure To User */
}
One note for the JavaScript, any regular expressions that you write need to be deliminated by / and be valid JS regexes (no PREG specific functionality is allowed).
46 Jul 19, 2022
142 Dec 25, 2022
371 Nov 24, 2022
256 Dec 9, 2022
110 Nov 30, 2022
59 Nov 29, 2021
417 Jan 3, 2023
9 Nov 30, 2022
8 Dec 14, 2022
212 Oct 24, 2022
3 Aug 23, 2022
3 Apr 11, 2022
266 Nov 8, 2022
1 Nov 25, 2021
896 Dec 26, 2022
25 Apr 29, 2022
3 Jul 30, 2022
134 Jan 2, 2023
52 Sep 6, 2022