Merge pull request #11096 from nanaya/hasher-cleanup

Simplify custom hasher driver

Author: notbakaneko

app/Hashing/OsuHasher.php app/Hashing/OsuBcryptHasher.php

@@ -7,7 +7,7 @@
 
 use Illuminate\Contracts\Hashing\Hasher;
 
-class OsuHasher implements Hasher
+class OsuBcryptHasher implements Hasher
 {
     /**
      * The number of rounds to hash, as 2^n.
@@ -37,12 +37,10 @@ public function info($hashedValue)
      */
     public function make($value, array $options = [])
     {
-        $cost = array_get($options, 'cost', $this->rounds);
-
         // When we originally moved to bcrypt (quite a few years ago),
         // we had to migrate everything without waiting for every user to
         // change their passwords, hence the md5 still being there.
-        $hash = password_hash(md5($value), PASSWORD_BCRYPT, ['cost' => $cost]);
+        $hash = password_hash(md5($value), PASSWORD_BCRYPT, ['cost' => $this->cost($options)]);
 
         // see static::check()
         return str_replace('$2y$', '$2a$', $hash);
@@ -83,9 +81,13 @@ public function check($value, $hashedValue, array $options = [])
      */
     public function needsRehash($hashedValue, array $options = [])
     {
-        $cost = array_get($options, 'cost', $this->rounds);
         $hashedValue = str_replace('$2a$', '$2y$', $hashedValue);
 
-        return password_needs_rehash($hashedValue, PASSWORD_BCRYPT, ['cost' => $cost]);
+        return password_needs_rehash($hashedValue, PASSWORD_BCRYPT, ['cost' => $this->cost($options)]);
+    }
+
+    protected function cost(array $options): int
+    {
+        return $options['rounds'] ?? $this->rounds;
     }
 }

app/Hashing/OsuHashManager.php

@@ -5,7 +5,7 @@
 
 namespace App\Providers;
 
-use App\Hashing\OsuHashManager;
+use App\Hashing\OsuBcryptHasher;
 use App\Libraries\MorphMap;
 use App\Libraries\OsuCookieJar;
 use App\Libraries\OsuMessageSelector;
@@ -79,6 +79,8 @@ public function boot()
         // newest scribe tries to rename {modelName} parameters to {id}
         // but it kind of doesn't work with our route handlers.
         Scribe::normalizeEndpointUrlUsing(fn ($url) => $url);
+
+        \Hash::extend('osubcrypt', fn () => new OsuBcryptHasher());
     }
 
     /**
@@ -99,14 +101,6 @@ public function register()
             $localCacheManager->registerSingleton(app($name));
         }
 
-        $this->app->singleton('hash', function ($app) {
-            return new OsuHashManager($app);
-        });
-
-        $this->app->singleton('hash.driver', function ($app) {
-            return $app['hash']->driver();
-        });
-
         $this->app->singleton('cookie', function ($app) {
             $config = $GLOBALS['cfg']['session'];
 

app/Providers/AppServiceProvider.php

@@ -178,7 +178,6 @@
 
     'providers' => ServiceProvider::defaultProviders()->except([
         Illuminate\Cookie\CookieServiceProvider::class,
-        Illuminate\Hashing\HashServiceProvider::class,
         Illuminate\Session\SessionServiceProvider::class,
     ])->merge([
         App\Providers\AppServiceProvider::class,

config/app.php

@@ -11,11 +11,11 @@
     | passwords for your application. By default, the bcrypt algorithm is
     | used; however, you remain free to modify this option if you wish.
     |
-    | Supported: "bcrypt", "argon", "argon2id"
+    | Supported: "bcrypt", "argon", "argon2id", "osubcrypt"
     |
     */
 
-    'driver' => 'bcrypt',
+    'driver' => 'osubcrypt',
 
     /*
     |--------------------------------------------------------------------------

config/hashing.php

@@ -5,27 +5,27 @@
 
 namespace Tests\Hashing;
 
-use App\Hashing\OsuHasher;
+use App\Hashing\OsuBcryptHasher;
 use Illuminate\Contracts\Hashing\Hasher;
 use PHPUnit\Framework\TestCase;
 
-class OsuHasherTest extends TestCase
+class OsuBcryptHasherTest extends TestCase
 {
     public function testBasicHashing()
     {
-        $hasher = new OsuHasher();
+        $hasher = new OsuBcryptHasher();
         $value = $hasher->make('password');
         $this->assertNotSame('password', $value);
         $this->assertNotSame(md5('password'), $value);
 
         $this->assertTrue($hasher->check('password', $value));
         $this->assertFalse($hasher->needsRehash($value));
-        $this->assertTrue($hasher->needsRehash($value, ['cost' => 4]));
+        $this->assertTrue($hasher->needsRehash($value, ['rounds' => 4]));
     }
 
     public function testImplementsHasher()
     {
-        $hasher = new OsuHasher();
+        $hasher = new OsuBcryptHasher();
         $this->assertInstanceOf(Hasher::class, $hasher);
     }
 }