Merge pull request #32 from Laragear/feat/remove-lingering-config-key

[1.x] Removes lingering config key

README.md

@@ -372,6 +372,24 @@ To add your own language, publish the translation files. These will be located i
 php artisan vendor:publish --provider="Laragear\TwoFactor\TwoFactorServiceProvider" --tag="translations"
 ```
 
+## Custom Recovery Codes
+
+Recovery codes are automatically generated using [`Str::random()`](https://laravel.com/docs/9.x/helpers#method-str-random) with [small configuration](#recovery-codes). This will suffice for most applications, but you can also create your own random string code generator.
+
+To create your own generator, set a custom callback to generate a recovery code with `TwoFactorAuthentication::generateRecoveryCodesUsing()`. This callable will receive the configuration string length, iteration, and total amount of codes, and should return an alfa-numeric string. 
+
+```php
+use Laragear\TwoFactor\Models\TwoFactorAuthentication;
+use Illuminate\Support\Str;
+
+TwoFactorAuthentication::generateRecoveryCodesUsing(function ($length, $iteration, $total) {
+    // Append the index of the code before the string. 
+    return $iteration . Str::random($length);
+});
+```
+
+This package will handle the recovery code match and usage for you, so you don't need to worry about that.
+
 ## Configuration
 
 To further configure the package, publish the configuration file:

config/two-factor.php

@@ -1,20 +1,6 @@
 <?php
 
 return [
-
-    /*
-    |--------------------------------------------------------------------------
-    | TwoFactorAuthentication Model
-    |--------------------------------------------------------------------------
-    |
-    | When using the "TwoFactorAuthentication" trait from this package, we need
-    | to know which Eloquent model should be used to retrieve your two factor
-    | authentication records. You can use your own for more advanced logic.
-    |
-    */
-
-    'model' => \Laragear\TwoFactor\Models\TwoFactorAuthentication::class,
-
     /*
     |--------------------------------------------------------------------------
     | Cache Store

src/TwoFactorAuthentication.php

@@ -151,7 +151,7 @@ public function validateTwoFactorCode(?string $code = null, bool $useRecoveryCod
     {
         return null !== $code
             && $this->hasTwoFactorEnabled()
-            && ($this->validateCode($code) || $useRecoveryCodes && $this->useRecoveryCode($code));
+            && ($this->validateCode($code) || ($useRecoveryCodes && $this->useRecoveryCode($code)));
     }
 
     /**
@@ -194,14 +194,13 @@ public function getRecoveryCodes(): Collection
     public function generateRecoveryCodes(): Collection
     {
         [
-            'two-factor.model' => $model,
             'two-factor.recovery.codes' => $amount,
             'two-factor.recovery.length' => $length
         ] = config()->get([
-            'two-factor.model', 'two-factor.recovery.codes', 'two-factor.recovery.length',
+            'two-factor.recovery.codes', 'two-factor.recovery.length',
         ]);
 
-        $this->twoFactorAuth->recovery_codes = $model::generateRecoveryCodes($amount, $length);
+        $this->twoFactorAuth->recovery_codes = Models\TwoFactorAuthentication::generateRecoveryCodes($amount, $length);
         $this->twoFactorAuth->recovery_codes_generated_at = now();
         $this->twoFactorAuth->save();
 
@@ -267,7 +266,7 @@ public function addSafeDevice(Request $request): string
      */
     protected function generateTwoFactorRemember(): string
     {
-        return config('two-factor.model')::generateDefaultTwoFactorRemember();
+        return Models\TwoFactorAuthentication::generateDefaultTwoFactorRemember();
     }
 
     /**