1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
<?php
/**
* Password policy checking for a user
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Password;
use DomainException;
use InvalidArgumentException;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\MediaWikiServices;
use MediaWiki\Status\Status;
use MediaWiki\User\UserIdentity;
use StatusValue;
/**
* Check if a user's password complies with any password policies that apply to that
* user, based on the user's group membership.
* @since 1.26
*/
class UserPasswordPolicy {
/**
* @var array[]
*/
private $policies;
/**
* Mapping of statements to the function that will test the password for compliance. The
* checking functions take the policy value, the user, and password, and return a Status
* object indicating compliance.
* @var callable[]
*/
private $policyCheckFunctions;
/**
* @param array[] $policies List of policies per user group
* @param callable[] $checks mapping statement to its checking function. Checking functions are
* called with the policy value for this user, the user object, and the password to check.
*/
public function __construct( array $policies, array $checks ) {
if ( !isset( $policies['default'] ) ) {
throw new InvalidArgumentException(
'Must include a \'default\' password policy'
);
}
$this->policies = $policies;
foreach ( $checks as $statement => $check ) {
if ( !is_callable( $check ) ) {
throw new InvalidArgumentException(
"Policy check functions must be callable. '$statement' isn't callable."
);
}
$this->policyCheckFunctions[$statement] = $check;
}
}
/**
* Check if a password meets the effective password policy for a User.
* @param UserIdentity $user whose policy we are checking
* @param string $password the password to check
* @return Status error to indicate the password didn't meet the policy, or fatal to
* indicate the user shouldn't be allowed to login. The status value will be an array,
* potentially with the following keys:
* - forceChange: do not allow the user to login without changing the password if invalid.
* - suggestChangeOnLogin: prompt for a password change on login if the password is invalid.
*/
public function checkUserPassword( UserIdentity $user, $password ) {
$effectivePolicy = $this->getPoliciesForUser( $user );
return $this->checkPolicies(
$user,
$password,
$effectivePolicy,
$this->policyCheckFunctions
);
}
/**
* Check if a password meets the effective password policy for a User, using a set
* of groups they may or may not belong to. This function does not use the DB, so can
* be used in the installer.
* @param UserIdentity $user whose policy we are checking
* @param string $password the password to check
* @param string[] $groups list of groups to which we assume the user belongs
* @return Status error to indicate the password didn't meet the policy, or fatal to
* indicate the user shouldn't be allowed to login. The status value will be an array,
* potentially with the following keys:
* - forceChange: do not allow the user to login without changing the password if invalid.
* - suggestChangeOnLogin: prompt for a password change on login if the password is invalid.
*/
public function checkUserPasswordForGroups( UserIdentity $user, $password, array $groups ) {
$effectivePolicy = self::getPoliciesForGroups(
$this->policies,
$groups,
$this->policies['default']
);
return $this->checkPolicies(
$user,
$password,
$effectivePolicy,
$this->policyCheckFunctions
);
}
/**
* @param UserIdentity $user
* @param string $password
* @param array $policies List of policy statements for the group the user belongs to
* @param callable[] $policyCheckFunctions
* @return Status
*/
private function checkPolicies( UserIdentity $user, $password, $policies, $policyCheckFunctions ) {
$status = Status::newGood( [] );
$forceChange = false;
$suggestChangeOnLogin = false;
$legacyUser = MediaWikiServices::getInstance()
->getUserFactory()
->newFromUserIdentity( $user );
foreach ( $policies as $policy => $settings ) {
if ( !isset( $policyCheckFunctions[$policy] ) ) {
throw new DomainException( "Invalid password policy config. No check defined for '$policy'." );
}
if ( !is_array( $settings ) ) {
// legacy format
$settings = [ 'value' => $settings ];
}
if ( !array_key_exists( 'value', $settings ) ) {
throw new DomainException( "Invalid password policy config. No value defined for '$policy'." );
}
$value = $settings['value'];
/** @var StatusValue $policyStatus */
$policyStatus = $policyCheckFunctions[$policy](
$value,
$legacyUser,
$password
);
if ( !$policyStatus->isGood() ) {
if ( !empty( $settings['forceChange'] ) ) {
$forceChange = true;
}
if ( !empty( $settings['suggestChangeOnLogin'] ) ) {
$suggestChangeOnLogin = true;
}
}
$status->merge( $policyStatus );
}
if ( $status->isOK() ) {
if ( $forceChange ) {
$status->value['forceChange'] = true;
} elseif ( $suggestChangeOnLogin ) {
$status->value['suggestChangeOnLogin'] = true;
}
}
return $status;
}
/**
* Get the policy for a user, based on their group membership. Public so
* UI elements can access and inform the user.
* @param UserIdentity $user
* @return array the effective policy for $user
*/
public function getPoliciesForUser( UserIdentity $user ) {
$services = MediaWikiServices::getInstance();
$effectivePolicy = self::getPoliciesForGroups(
$this->policies,
$services->getUserGroupManager()
->getUserEffectiveGroups( $user ),
$this->policies['default']
);
$legacyUser = $services->getUserFactory()
->newFromUserIdentity( $user );
( new HookRunner( $services->getHookContainer() ) )->onPasswordPoliciesForUser( $legacyUser, $effectivePolicy );
return $effectivePolicy;
}
/**
* Utility function to get the effective policy from a list of policies, based
* on a list of groups.
* @param array[] $policies List of policies per user group
* @param string[] $userGroups the groups from which we calculate the effective policy
* @param array $defaultPolicy the default policy to start from
* @return array effective policy
*/
public static function getPoliciesForGroups( array $policies, array $userGroups,
array $defaultPolicy
) {
$effectivePolicy = $defaultPolicy;
foreach ( $policies as $group => $policy ) {
if ( in_array( $group, $userGroups ) ) {
$effectivePolicy = self::maxOfPolicies(
$effectivePolicy,
$policy
);
}
}
return $effectivePolicy;
}
/**
* Utility function to get a policy that is the most restrictive of $p1 and $p2. For
* simplicity, we setup the policy values so the maximum value is always more restrictive.
* It is also used recursively to merge settings within the same policy.
* @param array $p1
* @param array $p2
* @return array containing the more restrictive values of $p1 and $p2
*/
public static function maxOfPolicies( array $p1, array $p2 ) {
$ret = [];
$keys = array_merge( array_keys( $p1 ), array_keys( $p2 ) );
foreach ( $keys as $key ) {
if ( !isset( $p1[$key] ) ) {
$ret[$key] = $p2[$key];
} elseif ( !isset( $p2[$key] ) ) {
$ret[$key] = $p1[$key];
} elseif ( !is_array( $p1[$key] ) && !is_array( $p2[$key] ) ) {
$ret[$key] = max( $p1[$key], $p2[$key] );
} else {
if ( !is_array( $p1[$key] ) ) {
$p1[$key] = [ 'value' => $p1[$key] ];
} elseif ( !is_array( $p2[$key] ) ) {
$p2[$key] = [ 'value' => $p2[$key] ];
}
$ret[$key] = self::maxOfPolicies( $p1[$key], $p2[$key] );
}
}
return $ret;
}
}
/** @deprecated since 1.43 use MediaWiki\\Password\\UserPasswordPolicy */
class_alias( UserPasswordPolicy::class, 'UserPasswordPolicy' );
|
