3 * Password policy checking for a user
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * Check if a user's password complies with any password policies that apply to that
25 * user, based on the user's group membership.
28 class UserPasswordPolicy
{
36 * Mapping of statements to the function that will test the password for compliance. The
37 * checking functions take the policy value, the user, and password, and return a Status
38 * object indicating compliance.
41 private $policyCheckFunctions;
44 * @param array $policies
45 * @param array $checks mapping statement to its checking function. Checking functions are
46 * called with the policy value for this user, the user object, and the password to check.
48 public function __construct( array $policies, array $checks ) {
49 if ( !isset( $policies['default'] ) ) {
50 throw new InvalidArgumentException(
51 'Must include a \'default\' password policy'
54 $this->policies
= $policies;
56 foreach ( $checks as $statement => $check ) {
57 if ( !is_callable( $check ) ) {
58 throw new InvalidArgumentException(
59 'Policy check functions must be callable'
62 $this->policyCheckFunctions
[$statement] = $check;
67 * Check if a passwords meets the effective password policy for a User.
68 * @param User $user who's policy we are checking
69 * @param string $password the password to check
70 * @return Status error to indicate the password didn't meet the policy, or fatal to
71 * indicate the user shouldn't be allowed to login.
73 public function checkUserPassword( User
$user, $password ) {
74 $effectivePolicy = $this->getPoliciesForUser( $user );
75 $status = Status
::newGood();
77 foreach ( $effectivePolicy as $policy => $value ) {
78 if ( !isset( $this->policyCheckFunctions
[$policy] ) ) {
79 throw new DomainException( 'Invalid password policy config' );
83 $this->policyCheckFunctions
[$policy],
95 * Get the policy for a user, based on their group membership. Public so
96 * UI elements can access and inform the user.
98 * @return array the effective policy for $user
100 public function getPoliciesForUser( User
$user ) {
101 $effectivePolicy = self
::getPoliciesForGroups(
103 $user->getEffectiveGroups(),
104 $this->policies
['default']
107 Hooks
::run( 'PasswordPoliciesForUser', array( $user, &$effectivePolicy ) );
109 return $effectivePolicy;
113 * Utility function to get the effective policy from a list of policies, based
114 * on a list of groups.
115 * @param array $policies list of policies to consider
116 * @param array $userGroups the groups from which we calculate the effective policy
117 * @param array $defaultPolicy the default policy to start from
118 * @return array effective policy
120 public static function getPoliciesForGroups( array $policies, array $userGroups,
123 $effectivePolicy = $defaultPolicy;
124 foreach ( $policies as $group => $policy ) {
125 if ( in_array( $group, $userGroups ) ) {
126 $effectivePolicy = self
::maxOfPolicies(
133 return $effectivePolicy;
137 * Utility function to get a policy that is the most restrictive of $p1 and $p2. For
138 * simplicity, we setup the policy values so the maximum value is always more restrictive.
141 * @return array containing the more restrictive values of $p1 and $p2
143 public static function maxOfPolicies( array $p1, array $p2 ) {
145 $keys = array_merge( array_keys( $p1 ), array_keys( $p2 ) );
146 foreach ( $keys as $key ) {
147 if ( !isset( $p1[$key] ) ) {
148 $ret[$key] = $p2[$key];
149 } elseif ( !isset( $p2[$key] ) ) {
150 $ret[$key] = $p1[$key];
152 $ret[$key] = max( $p1[$key], $p2[$key] );