common-passwords
A simple package to validate against common passwords and help keep your application secure.
composer require crumbls/common-passwords
- php artisan common-passwords:install
- Add the \Crumbls\CommonPasswords\Rules\NotCommonPassword() rule to your password field.
- Best practice says that the best place to do this is to put it into your registration and password recovery validators.
- You can add any extra passwords using the \Crumbls\CommonPasswords\Models\Password model. It only has one field: password
Attached is a simple example that can be ran from anywhere. It will throw a validation exception because we are verifying the password "password" which is a commonly used password.
try {
$validator = \Illuminate\Support\Facades\Validator::make([
'password' => 'password'
], [
'password' => [
'required',
'string',
'min:1',
'max:256',
new \Crumbls\CommonPasswords\Rules\NotCommonPassword()
],
]);
print_r($validator->validated());
} catch (\Illuminate\Validation\ValidationException $e) {
echo $e->getMessage();
}
Since authentication and registration are commonly reinvented based on the application, this is an example of how you could do it in a very basic RegistrationController out of Laravel 8.x. This would overwrite your validator method.
/**
* Get a validator for an incoming registration request.
*
* @param array $data
* @return \Illuminate\Contracts\Validation\Validator
*/
protected function validator(array $data)
{
return Validator::make($data, [
'name' => ['required', 'string', 'max:255'],
'email' => ['required', 'string', 'email', 'max:255', 'unique:users'],
'password' => ['required', 'string', 'min:8', 'confirmed', new \Crumbls\CommonPasswords\Rules\NotCommonPassword()],
]);
}
I've had a people ask if you can use this to directly check if a user's password is on this list. It's a horrible idea because of the resources it consumes and this is just brute force testing. That is why you should verify it when you are setting the password. But, if you need to for some reason, here is a simple sample on how to do it.
// Take a random user. You should be more pointed than this.
$user = \App\Models\User::inRandomOrder()->take(1)->first();
$passwords = \Crumbls\CommonPasswords\Models\Password::orderBy(
with(new \Crumbls\CommonPasswords\Models\Password())->getKeyName(),
'asc'
)->get();
foreach($passwords as $password) {
if (\Hash::check($password->password, $user->password)) {
printf('User had an invalid password: %s .', $password->password);
break;
}
}
The documentation is sparse. If you have any questions, feel free to ask here or on twitter @chasecmiller Remember that this is only designed to be a validation rule.
246 Jan 5, 2023
1.7k Dec 27, 2022
41 Dec 12, 2021
43 Sep 28, 2022
26 Dec 26, 2022
1 Oct 25, 2021
6 Sep 20, 2022
5 Oct 5, 2022
142 Dec 25, 2022
2 Sep 2, 2022
482 Dec 30, 2022
6 Jun 11, 2023
1 Jan 26, 2022
2.1k Dec 30, 2022
3 Jan 4, 2022
108 Nov 1, 2022
1.6k Jan 6, 2023
178 Jan 4, 2023
10.7k Jun 13, 2022
153 Jan 2, 2023
48 Apr 10, 2022
1 Oct 19, 2022
10 Aug 12, 2022
7 Dec 15, 2022
2 Mar 18, 2022
1.5k Dec 30, 2022
451 Dec 27, 2022
13 Apr 23, 2022