Merge pull request #51 from Laragear/fix/empty-issuer

Laragear · Jun 12, 2023 · 0e3949e · 0e3949e
2 parents 676e794 + ebc453f
commit 0e3949e
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 3 deletions.
diff --git a/src/Models/Concerns/SerializesSharedSecret.php b/src/Models/Concerns/SerializesSharedSecret.php
@@ -6,6 +6,7 @@
 use BaconQrCode\Renderer\ImageRenderer;
 use BaconQrCode\Renderer\RendererStyle\RendererStyle;
 use BaconQrCode\Writer;
+use InvalidArgumentException;
 
 use function array_values;
 use function chunk_split;
@@ -24,8 +25,9 @@ trait SerializesSharedSecret
      */
     public function toUri(): string
     {
-        $issuer = config('two-factor.issuer', config('app.name'));
-
+        $issuer = config('two-factor.issuer')
+                ?: config('app.name')
+                ?: throw new InvalidArgumentException('The TOTP issuer cannot be empty.');
         $query = http_build_query([
             'issuer'    => $issuer,
             'label'     => $this->attributes['label'],

diff --git a/src/Models/TwoFactorAuthentication.php b/src/Models/TwoFactorAuthentication.php
@@ -82,7 +82,7 @@ public function authenticatable(): MorphTo
     /**
      * Sets the Algorithm to lowercase.
      *
-     * @param $value
+     * @param  $value
      * @return void
      */
     protected function setAlgorithmAttribute($value): void

diff --git a/tests/Eloquent/TwoFactorAuthenticationTest.php b/tests/Eloquent/TwoFactorAuthenticationTest.php
@@ -6,6 +6,7 @@
 use Illuminate\Foundation\Testing\RefreshDatabase;
 use Illuminate\Support\Facades\Cache;
 use Illuminate\Support\Facades\Date;
+use InvalidArgumentException;
 use Laragear\TwoFactor\Models\TwoFactorAuthentication;
 use ParagonIE\ConstantTime\Base32;
 use Tests\Stubs\UserStub;
@@ -315,6 +316,20 @@ public function test_serializes_uri_to_json(): void
         static::assertEquals($uri, $tfa->toJson());
     }
 
+    public function test_uses_app_name_as_issuer(): void
+    {
+        $tfa = TwoFactorAuthentication::factory()->withRecovery()->withSafeDevices()->make([
+            'label'         => '[email protected]',
+            'shared_secret' => static::SECRET,
+            'algorithm'     => 'sHa256',
+            'digits'        => 14,
+        ]);
+
+        $uri = 'otpauth://totp/Laravel%[email protected]?issuer=Laravel&label=test%40foo.com&secret=KS72XBTN5PEBGX2IWBMVW44LXHPAQ7L3&algorithm=SHA256&digits=14';
+
+        static::assertSame($uri, $tfa->toUri());
+    }
+
     public function test_changes_issuer(): void
     {
         $this->app->make('config')->set('two-factor.issuer', 'foo bar');
@@ -331,6 +346,24 @@ public function test_changes_issuer(): void
         static::assertSame($uri, $tfa->toUri());
     }
 
+    public function test_throws_exception_when_issuer_is_empty(): void
+    {
+        $this->app->make('config')->set('app.name', '');
+        $this->app->make('config')->set('two-factor.issuer', '');
+
+        $tfa = TwoFactorAuthentication::factory()->withRecovery()->withSafeDevices()->make([
+            'label'         => '[email protected]',
+            'shared_secret' => static::SECRET,
+            'algorithm'     => 'sHa256',
+            'digits'        => 14,
+        ]);
+
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('The TOTP issuer cannot be empty.');
+
+        $tfa->toUri();
+    }
+
     public function test_uses_custom_generator(): void
     {
         $i = 0;