README

用于检查和创建PHP和JS中密码策略的工具。

安装

使用composer设置自动加载器

php composer.phar install

需要composer自动加载文件

require_once 'vendor/autoload.php';

使用方法

要使用，首先实例化核心策略对象

$policy = new \PasswordPolicy\Policy;

然后，添加规则

$policy->contains('lowercase', $policy->atLeast(2));

支持的规则帮助方法

• contains($class, $constraint = null, $description = '')：检查密码是否包含字符类

  支持的快捷类

  • letter - a-zA-Z
  • lowercase - a-z
  • uppercase - A-Z
  • digit - 0-9
  • symbol - ^a-zA-Z0-9（即非字母数字）
  • null - \0
  • alnum - a-zA-Z0-9

  第二个参数是约束（可选）

• length($constraint)：检查密码长度是否符合约束

• endsWith($class, $description = '')：检查密码是否以字符类结尾。

• startsWith($class, $description = '')：检查密码是否以字符类开头。

• notMatch($regex, $description)：检查密码是否不匹配正则表达式。

• match($regex, $description)：检查密码是否匹配正则表达式。

支持的约束

策略还具有创建约束的快捷帮助程序

• atLeast($n)：至少符合参数

  相当于between($n, PHP_INT_MAX)

• atMost($n)：最多符合参数

  相当于between(0, $n)

• between($min, $max)：在$min和$max之间匹配数量

• never()：无匹配

  相当于between(0, 0)

测试策略

设置策略后，您可以使用PHP中的test($password)方法进行测试。

$result = $policy->test($password);

返回结果是一个具有两个成员的stdclass对象，result和messages。

• $result->result - 如果密码有效，则为布尔值。

• $result->messages - 一系列消息的数组

每条消息都是具有两个成员的对象

• $message->result - 表示规则是否通过的布尔值

• $message->message - 规则的文本描述

使用JavaScript

构建策略后，可以调用toJavaScript()生成一个用于注入到JS代码中的JS匿名函数。

$js = $policy->toJavaScript();
echo "var policy = $js;";

然后，JS中的策略对象基本上是$policy->test($password)的包装器，行为相同（相同的返回值）。

var result = policy(password);
if (!result.result) {
    /* Process Messages To Display Failure To User */
}

关于JavaScript的一点注意事项，你编写的任何正则表达式都需要用/分隔，并且必须是有效的JavaScript正则表达式（不允许使用PREG特定的功能）。