Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.x] Adds password rule #36960

Merged
merged 17 commits into from Apr 23, 2021
14 changes: 14 additions & 0 deletions src/Illuminate/Contracts/Validation/DataAwareRule.php
@@ -0,0 +1,14 @@
<?php

namespace Illuminate\Contracts\Validation;

interface DataAwareRule
{
/**
* Set the data under validation.
*
* @param array $data
* @return $this
*/
public function setData($data);
nunomaduro marked this conversation as resolved.
Show resolved Hide resolved
}
14 changes: 14 additions & 0 deletions src/Illuminate/Contracts/Validation/UncompromisedVerifier.php
@@ -0,0 +1,14 @@
<?php

namespace Illuminate\Contracts\Validation;

interface UncompromisedVerifier
{
/**
* Verify that the given data has not been compromised in data leaks.
*
* @param array $data
* @return bool
*/
public function verify($data);
}
95 changes: 95 additions & 0 deletions src/Illuminate/Validation/NotPwnedVerifier.php
@@ -0,0 +1,95 @@
<?php

namespace Illuminate\Validation;

use Exception;
use Illuminate\Contracts\Validation\UncompromisedVerifier;
use Illuminate\Http\Client\Factory;
nunomaduro marked this conversation as resolved.
Show resolved Hide resolved
use Illuminate\Support\Str;

class NotPwnedVerifier implements UncompromisedVerifier
{
/**
* The http factory instance.
*
* @var \Illuminate\Http\Client\Factory
*/
protected $factory;

/**
* Create a new uncompromised verifier.
*
* @param \Illuminate\Http\Client\Factory $factory
* @return void
*/
public function __construct($factory)
{
$this->factory = $factory;
}

/**
* Verify that the given data has not been compromised in public breaches.
*
* @param array $data
* @return bool
*/
public function verify($data)
{
$value = $data['value'];
$threshold = $data['threshold'];

if (empty($value = (string) $value)) {
return false;
}

[$hash, $hashPrefix] = $this->getHash($value);

return ! $this->search($hashPrefix)
->contains(function ($line) use ($hash, $hashPrefix, $threshold) {
[$hashSuffix, $count] = explode(':', $line);

return $hashPrefix.$hashSuffix == $hash && $count > $threshold;
});
}

/**
* Get the hash and its first 5 chars.
*
* @param string $value
* @return array
*/
protected function getHash($value)
{
$hash = strtoupper(sha1((string) $value));
$hashPrefix = substr($hash, 0, 5);

return [$hash, $hashPrefix];
}

/**
* Search by the given hash prefix and returns all occurrences of leaked passwords.
*
* @param string $hashPrefix
* @return \Illuminate\Support\Collection
*/
protected function search($hashPrefix)
{
try {
$response = $this->factory->withHeaders([
'Add-Padding' => true,
])->get(
'https://api.pwnedpasswords.com/range/'.$hashPrefix
);
nunomaduro marked this conversation as resolved.
Show resolved Hide resolved
} catch (Exception $e) {
report($e);
}

$body = (isset($response) && $response->successful())
? $response->body()
: '';

return Str::of($body)->trim()->explode("\n")->filter(function ($line) {
return Str::contains($line, ':');
});
}
}
252 changes: 252 additions & 0 deletions src/Illuminate/Validation/Rules/Password.php
@@ -0,0 +1,252 @@
<?php

namespace Illuminate\Validation\Rules;

use Illuminate\Container\Container;
use Illuminate\Contracts\Validation\DataAwareRule;
use Illuminate\Contracts\Validation\Rule;
use Illuminate\Contracts\Validation\UncompromisedVerifier;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\Validator;

class Password implements Rule, DataAwareRule
{
/**
* The data under validation.
*
* @var array
*/
protected $data;

/**
* The minimum size of the password.
*
* @var int
*/
protected $min = 8;

/**
* If the password requires at least one uppercase and one lowercase letter.
*
* @var bool
*/
protected $mixedCase = false;

/**
* If the password requires at least one letter.
*
* @var bool
*/
protected $letters = false;

/**
* If the password requires at least one number.
*
* @var bool
*/
protected $numbers = false;

/**
* If the password requires at least one symbol.
*
* @var bool
*/
protected $symbols = false;

/**
* If the password should has not been compromised in data leaks.
*
* @var bool
*/
protected $uncompromised = false;

/**
* The number of times a password can appear in data leaks before being consider compromised.
*
* @var int
*/
protected $uncompromisedThreshold = 0;
nunomaduro marked this conversation as resolved.
Show resolved Hide resolved

/**
* The failure messages, if any.
*
* @var array
*/
protected $messages = [];

/**
* Create a new rule instance.
*
* @param int $min
* @return void
*/
public function __construct($min)
{
$this->min = max((int) $min, 1);
}

/**
* Set the data under validation.
*
* @param array $data
* @return $this
*/
public function setData($data)
{
$this->data = $data;

return $this;
}

/**
* Sets the minimum size of the password.
*
* @param int $size
* @return $this
*/
public static function min($size)
{
return new static($size);
}
nunomaduro marked this conversation as resolved.
Show resolved Hide resolved

/**
* Ensures the password has not been compromised in data leaks.
*
* @param int $threshold
* @return $this
*/
public function uncompromised($threshold = 0)
{
$this->uncompromised = true;

$this->uncompromisedThreshold = $threshold;

return $this;
}

/**
* Makes the password require at least one uppercase and one lowercase letter.
*
* @return $this
*/
public function mixedCase()
{
$this->mixedCase = true;

return $this;
}

/**
* Makes the password require at least one letter.
*
* @return $this
*/
public function letters()
{
$this->letters = true;

return $this;
}

/**
* Makes the password require at least one number.
*
* @return $this
*/
public function numbers()
{
$this->numbers = true;

return $this;
}

/**
* Makes the password require at least one symbol.
*
* @return $this
*/
public function symbols()
{
$this->symbols = true;

return $this;
}

/**
* Determine if the validation rule passes.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
public function passes($attribute, $value)
{
$validator = Validator::make($this->data, [
$attribute => 'string|min:'.$this->min,
]);

if ($validator->fails()) {
return $this->fail($validator->messages()->all());
}

$value = (string) $value;

if ($this->mixedCase && ! preg_match('/(\p{Ll}+.*\p{Lu})|(\p{Lu}+.*\p{Ll})/u', $value)) {
$this->fail('The :attribute must contain at least one uppercase and one lowercase letter.');
}

if ($this->letters && ! preg_match('/\pL/', $value)) {
nunomaduro marked this conversation as resolved.
Show resolved Hide resolved
$this->fail('The :attribute must contain at least one letter.');
}

if ($this->symbols && ! preg_match('/\p{Z}|\p{S}|\p{P}/', $value)) {
nunomaduro marked this conversation as resolved.
Show resolved Hide resolved
$this->fail('The :attribute must contain at least one symbol.');
}

if ($this->numbers && ! preg_match('/\pN/', $value)) {
nunomaduro marked this conversation as resolved.
Show resolved Hide resolved
$this->fail('The :attribute must contain at least one number.');
}

if (! empty($this->messages)) {
return false;
}

if ($this->uncompromised && ! Container::getInstance()->make(UncompromisedVerifier::class)->verify([
'value' => $value,
'threshold' => $this->uncompromisedThreshold,
])) {
return $this->fail(
'The given :attribute has appeared in a data leak. Please choose a different :attribute.'
);
}

return true;
}

/**
* Get the validation error message.
*
* @return array
*/
public function message()
{
return $this->messages;
}

/**
* Adds the given failures, and return false.
*
* @param array|string $message
nunomaduro marked this conversation as resolved.
Show resolved Hide resolved
* @return bool
*/
protected function fail($messages)
{
$messages = collect(Arr::wrap($messages))->map(function ($message) {
return __($message);
})->all();

$this->messages = array_merge($this->messages, $messages);

return false;
}
}