add optional method parameter when confirming 2fa

Author: emargareten

README.md

@@ -78,8 +78,9 @@ class TwoFactorAuthenticationController extends Controller
 }
 ```
 
-After enabling two-factor authentication,
-the user must still "confirm" their two-factor authentication configuration by providing a valid two-factor authentication code. You should provide a way for the user to do this. For example, you could provide a view that displays the QR code and secret key for the user to scan into their authenticator app:
+### Confirming Two-Factor Authentication
+
+After enabling two-factor authentication, the user must still "confirm" their two-factor authentication configuration by providing a valid two-factor authentication code. You should provide a way for the user to do this. For example, you could provide a view that displays the QR code and secret key for the user to scan into their authenticator app:
 ```php
 use Illuminate\Http\RedirectResponse;
 use Illuminate\Http\Request;
@@ -135,6 +136,10 @@ $user->getCurrentOtp();
 > **Note**
 > When sending the one-time-password via SMS/email, you should set the window config to a higher value, to allow the user to enter the one-time password after it has been sent.
 
+The `confirmTwoFactorAuthentication` method takes an optional second parameter to specify the two-factor method, this is totally optional, it can be useful if you have multiple methods for receiving the one-time password.
+
+### Disabling Two-Factor Authentication
+
 You should also provide a way for the user to disable two-factor authentication. This can be done by calling the `disableTwoFactorAuthentication` method on the user model:
 
 ```php

database/migrations/add_two_factor_columns_to_users_table.php

@@ -16,6 +16,7 @@ public function up(): void
                 $table->text('two_factor_secret')->nullable();
                 $table->text('two_factor_recovery_codes')->nullable();
                 $table->timestamp('two_factor_confirmed_at')->nullable();
+                $table->string('two_factor_method')->nullable();
             });
         });
     }

src/Actions/ConfirmTwoFactorAuthentication.php

@@ -22,7 +22,7 @@ public function __construct(protected TwoFactorProvider $provider)
      *
      * @param  \App\Models\User  $user
      */
-    public function __invoke($user, string $code): void
+    public function __invoke($user, string $code, ?string $method): void
     {
         if (empty($user->two_factor_secret)
             || empty($code)
@@ -35,6 +35,7 @@ public function __invoke($user, string $code): void
 
         $user->forceFill([
             'two_factor_confirmed_at' => now(),
+            'two_factor_method' => $method,
         ])->save();
 
         TwoFactorAuthenticationConfirmed::dispatch($user);

src/Actions/DisableTwoFactorAuthentication.php

@@ -13,13 +13,17 @@ class DisableTwoFactorAuthentication
      */
     public function __invoke($user): void
     {
-        if (! is_null($user->two_factor_secret) ||
-            ! is_null($user->two_factor_recovery_codes) ||
-            ! is_null($user->two_factor_confirmed_at)) {
+        if (
+            ! is_null($user->two_factor_secret)
+            || ! is_null($user->two_factor_recovery_codes)
+            || ! is_null($user->two_factor_confirmed_at)
+            || ! is_null($user->two_factor_method)
+        ) {
             $user->forceFill([
                 'two_factor_secret' => null,
                 'two_factor_recovery_codes' => null,
                 'two_factor_confirmed_at' => null,
+                'two_factor_method' => null,
             ])->save();
 
             TwoFactorAuthenticationDisabled::dispatch($user);

src/TwoFactorAuthenticatable.php

@@ -103,9 +103,9 @@ public function disableTwoFactorAuthentication(): void
     /**
      * Confirm two-factor authentication for the user.
      */
-    public function confirmTwoFactorAuthentication(string $code): void
+    public function confirmTwoFactorAuthentication(string $code, ?string $method): void
     {
-        app(ConfirmTwoFactorAuthentication::class)($this, $code);
+        app(ConfirmTwoFactorAuthentication::class)($this, $code, $method);
     }
 
     /**

tests/TestUser.php

@@ -16,6 +16,7 @@
  * @property \Illuminate\Support\Carbon|null $updated_at
  * @property string|null $two_factor_secret
  * @property array|null $two_factor_recovery_codes
+ * @property string|null $two_factor_method
  * @property \Illuminate\Support\Carbon|null $two_factor_confirmed_at
  *
  * @method static TestUser create(array $attributes = [])