Introduce Hasher::isAcceptable

bastien-phi · Oct 17, 2023 · a53227d · a53227d
1 parent ce8e63e
commit a53227d
Show file tree

Hide file tree

Showing 7 changed files with 75 additions and 0 deletions.
diff --git a/src/Illuminate/Contracts/Hashing/Hasher.php b/src/Illuminate/Contracts/Hashing/Hasher.php
@@ -39,4 +39,12 @@ public function check($value, $hashedValue, array $options = []);
      * @return bool
      */
     public function needsRehash($hashedValue, array $options = []);
+
+    /**
+     * Check if the given hash is acceptable for the hasher.
+     *
+     * @param  string  $hashedValue
+     * @return bool
+     */
+    public function isAcceptable($hashedValue);
 }
diff --git a/src/Illuminate/Hashing/AbstractHasher.php b/src/Illuminate/Hashing/AbstractHasher.php
@@ -31,4 +31,15 @@ public function check($value, $hashedValue, array $options = [])
 
         return password_verify($value, $hashedValue);
     }
+
+    /**
+     * Check if the given hash is acceptable for the hasher.
+     *
+     * @param  string  $hashedValue
+     * @return bool
+     */
+    public function isAcceptable($hashedValue)
+    {
+        return method_exists($this, 'needsRehash') && ! $this->needsRehash($hashedValue);
+    }
 }
diff --git a/src/Illuminate/Hashing/ArgonHasher.php b/src/Illuminate/Hashing/ArgonHasher.php
@@ -144,6 +144,21 @@ public function setTime(int $time)
         return $this;
     }
 
+    /**
+     * Check if the given hash is acceptable for the hasher.
+     *
+     * @param  string  $hashedValue
+     * @return bool
+     */
+    public function isAcceptable($hashedValue)
+    {
+        $info = $this->info($hashedValue);
+
+        return $info['algoName'] === $this->algorithm()
+            && $info['options']['memory_cost'] / $info['options']['threads'] <= 4 * 65536
+            && $info['options']['threads'] <= 16;
+    }
+
     /**
      * Set the default password threads factor.
      *

diff --git a/src/Illuminate/Hashing/BcryptHasher.php b/src/Illuminate/Hashing/BcryptHasher.php
@@ -88,6 +88,19 @@ public function needsRehash($hashedValue, array $options = [])
         ]);
     }
 
+    /**
+     * Check if the given hash is acceptable for the hasher.
+     *
+     * @param  string  $hashedValue
+     * @return bool
+     */
+    public function isAcceptable($hashedValue)
+    {
+        $info = $this->info($hashedValue);
+
+        return $info['algoName'] === 'bcrypt' && $info['options']['cost'] <= 16;
+    }
+
     /**
      * Set the default password work factor.
      *

diff --git a/src/Illuminate/Hashing/HashManager.php b/src/Illuminate/Hashing/HashManager.php
@@ -88,6 +88,17 @@ public function needsRehash($hashedValue, array $options = [])
         return $this->driver()->needsRehash($hashedValue, $options);
     }
 
+    /**
+     * Check if the given hash is acceptable for the hasher.
+     *
+     * @param  string  $hashedValue
+     * @return bool
+     */
+    public function isAcceptable($hashedValue)
+    {
+        return $this->driver()->isAcceptable($hashedValue);
+    }
+
     /**
      * Determine if a given string is already hashed.
      *

diff --git a/src/Illuminate/Support/Facades/Hash.php b/src/Illuminate/Support/Facades/Hash.php
@@ -10,6 +10,7 @@
  * @method static string make(string $value, array $options = [])
  * @method static bool check(string $value, string $hashedValue, array $options = [])
  * @method static bool needsRehash(string $hashedValue, array $options = [])
+ * @method static bool isAcceptable(string $hashedValue)
  * @method static bool isHashed(string $value)
  * @method static string getDefaultDriver()
  * @method static mixed driver(string|null $driver = null)

diff --git a/tests/Hashing/HasherTest.php b/tests/Hashing/HasherTest.php
@@ -56,6 +56,10 @@ public function testBasicBcryptHashing()
         $this->assertSame('bcrypt', password_get_info($value)['algoName']);
         $this->assertGreaterThanOrEqual(12, password_get_info($value)['options']['cost']);
         $this->assertTrue($this->hashManager->isHashed($value));
+        $this->assertTrue($hasher->isAcceptable($value));
+        $this->assertFalse($hasher->isAcceptable('password'));
+        $this->assertFalse($hasher->isAcceptable('$2y$17$1iPpw8cxiw6.ijzD2Ry1mOvBMM2kPu6wayaIXWLMG5fhFX5ejCEa6'));
+        $this->assertFalse($hasher->isAcceptable('$argon2i$v=19$m=65536,t=4,p=1$eE4vbkhJTm54M0k4OU1LTw$C9JCrLeNkNHI1jWx3pBqpK2bTgFrtcVcIfARjCN0218'));
     }
 
     public function testBasicArgon2iHashing()
@@ -68,6 +72,12 @@ public function testBasicArgon2iHashing()
         $this->assertTrue($hasher->needsRehash($value, ['threads' => 1]));
         $this->assertSame('argon2i', password_get_info($value)['algoName']);
         $this->assertTrue($this->hashManager->isHashed($value));
+        $this->assertTrue($hasher->isAcceptable($value));
+        $this->assertTrue($hasher->isAcceptable('$argon2i$v=19$m=4194304,t=4,p=16$c01ieWxxZWozSmtHTzd5Vw$y9hJhd9Ip28ZFbh4BEVpPYSA6n017UIBdPcuTVna4hw'));
+        $this->assertFalse($hasher->isAcceptable('password'));
+        $this->assertFalse($hasher->isAcceptable('$argon2i$v=19$m=4194304,t=4,p=8$Ri5lRGt5VFMvMEtiLkYxQg$sPuFc8V0SKB1gmOJXmqcXscTZ8Awdkihf7m0Y/bskSg'));
+        $this->assertFalse($hasher->isAcceptable('$argon2i$v=19$m=8388608,t=4,p=32$Z0JUVVFTMTBVRnZlRHhldQ$sQrSwO1zcTFOseS56GZOd27SR9c05YUXPK7Np+gJpv4'));
+        $this->assertFalse($hasher->isAcceptable('$2y$10$PCXl4nmz2z8vckcBFi2AQObDvYOIlNa99REfp0dQN/Hq7Lc1wA5qC'));
     }
 
     public function testBasicArgon2idHashing()
@@ -80,6 +90,12 @@ public function testBasicArgon2idHashing()
         $this->assertTrue($hasher->needsRehash($value, ['threads' => 1]));
         $this->assertSame('argon2id', password_get_info($value)['algoName']);
         $this->assertTrue($this->hashManager->isHashed($value));
+        $this->assertTrue($hasher->isAcceptable($value));
+        $this->assertTrue($hasher->isAcceptable('$argon2id$v=19$m=4194304,t=4,p=16$WmJySGpROWJuMUJxZXQ5Rw$u96pRIoI4xsj+OfFoluc+iEng3jkDfuTFDIJOYbRml0'));
+        $this->assertFalse($hasher->isAcceptable('password'));
+        $this->assertFalse($hasher->isAcceptable('$argon2id$v=19$m=4194304,t=4,p=8$VmZWVE5Uc2xDbklQVlhBWA$59KcqVqTfDt4WjoFIQkFIuXQEZBuRN7+G/YR7BDb9i8'));
+        $this->assertFalse($hasher->isAcceptable('$argon2id$v=19$m=8388608,t=4,p=32$dVFMcDB4WWkvRU41bGtDMQ$q4Y/26s5RVLn3tInzMgh/jUKeoOj/BXINARKQsvvhC4'));
+        $this->assertFalse($hasher->isAcceptable('$2y$10$PCXl4nmz2z8vckcBFi2AQObDvYOIlNa99REfp0dQN/Hq7Lc1wA5qC'));
     }
 
     /**