Add rate limit (#128)

* add rate limit * add none to disable rate limit * add env MAGICLINK_RATE_LIMIT * add docs
cesargb · Jan 4, 2025 · 566eb98 · 566eb98
1 parent 330e0a1
commit 566eb98
Show file tree

Hide file tree

Showing 7 changed files with 146 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -27,6 +27,10 @@ offer secure content and even log in to the application.
 - [Lifetime](#lifetime)
 - [Events](#events)
 - [Customization](#customization)
+- [Rate limiting](#rate-limiting)
+- [Testing](#testing)
+- [Contributing](#contributing)
+- [Security](#security)
 
 ## Installation
 
@@ -326,8 +330,8 @@ php artisan vendor:publish --provider="MagicLink\MagicLinkServiceProvider" --tag
 
 And edit the file `config/magiclink.php`
 
-
 ### Migrations
+
 To customize the migration files of this package you need to publish the migration files:
 
 ```bash
@@ -336,7 +340,6 @@ php artisan vendor:publish --provider="MagicLink\MagicLinkServiceProvider" --tag
 
 You'll find the published files in `database/migrations/*`
 
-
 ### Custom response when magiclink is invalid
 
 When the magicLink is invalid by default the http request return a status 403.
@@ -407,6 +410,19 @@ return a `view()`
     ],
 ```
 
+## Rate limiting
+
+You can limit the number of requests per minute for a magic link. To do this, you need to
+set the `MAGICLINK_RATE_LIMIT` environment variable to the desired value.
+
+By default, the rate limit is 100 attempts per minutes. Use `none` to disable the rate limit.
+
+```bash
+# .env
+
+MAGICLINK_RATE_LIMIT='none'
+```
+
 ## Testing
 
 Run the tests with:

diff --git a/config/magiclink.php b/config/magiclink.php
@@ -1,8 +1,17 @@
 <?php
 
+
 return [
 
     'access_code' => [
+        /*
+        |--------------------------------------------------------------------------
+        | Access Code View
+        |--------------------------------------------------------------------------
+        |
+        | Here you may specify the view to ask for access code.
+        |
+        */
         'view' => 'magiclink::ask-for-access-code-form',
     ],
 
@@ -32,7 +41,24 @@
         'class' => MagicLink\Responses\Response::class,
     ],
 
-    'token'           => [
+    'middlewares' => [
+        'throttle:magiclink',
+        MagicLink\Middlewares\MagiclinkMiddleware::class,
+        'web',
+    ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Rate Limit
+    |--------------------------------------------------------------------------
+    |
+    | Here you may specify the number of attempts to rate limit per minutes
+    |
+    | Default: 100, if you want to disable rate limit, set as 'none'
+    */
+    'rate_limit' => env('MAGICLINK_RATE_LIMIT', 100),
+
+    'token' => [
         /*
         |--------------------------------------------------------------------------
         | Token size

diff --git a/routes/routes.php b/routes/routes.php
@@ -1,14 +1,10 @@
 <?php
 
 use Illuminate\Support\Facades\Route;
-use MagicLink\Middlewares\MagiclinkMiddleware;
 
 Route::group(
     [
-        'middleware' => [
-            MagiclinkMiddleware::class,
-            'web',
-        ],
+        'middleware' => config('magiclink.middlewares'),
     ],
     function () {
         Route::get(

diff --git a/src/MagicLinkServiceProvider.php b/src/MagicLinkServiceProvider.php
@@ -2,6 +2,8 @@
 
 namespace MagicLink;
 
+use Illuminate\Cache\RateLimiting\Limit;
+use Illuminate\Support\Facades\RateLimiter;
 use Illuminate\Support\ServiceProvider;
 
 class MagicLinkServiceProvider extends ServiceProvider
@@ -15,11 +17,25 @@ public function boot()
     {
         $this->offerPublishing();
 
+        $this->registerRateLimit();
+
         $this->loadRouteMagicLink();
 
         $this->loadViewMagicLink();
     }
 
+    private function registerRateLimit(): void
+    {
+        $rateLimit = config('magiclink.rate_limit', 100);
+
+        RateLimiter::for(
+            'magiclink',
+            fn () => $rateLimit === 'none'
+                ? Limit::none()
+                : Limit::perMinute($rateLimit)
+        );
+    }
+
     private function loadRouteMagicLink(): void
     {
         $disableRegisterRoute = config('magiclink.disable_default_route', false);

diff --git a/tests/Http/HttpHeadTest.php b/tests/Http/HttpHeadTest.php
@@ -0,0 +1,38 @@
+<?php
+
+namespace MagicLink\Test\Http;
+
+use MagicLink\Actions\ResponseAction;
+use MagicLink\MagicLink;
+use MagicLink\Test\TestCase;
+
+class HttpHeadTest extends TestCase
+{
+    public function test_http_head_request_has_not_effects()
+    {
+        $magiclink = MagicLink::create(new ResponseAction(function () {
+            return 'private content';
+        }));
+
+        $magiclink->num_visits = 4;
+        $magiclink->save();
+
+        $this->head($magiclink->url)
+            ->assertStatus(200)
+            ->assertDontSeeText('private content');
+
+        $magiclink->refresh();
+
+        $this->assertEquals(4, $magiclink->num_visits);
+    }
+
+    public function test_http_head_request_without_valid_magiclink()
+    {
+        $magiclink = MagicLink::create(new ResponseAction(function () {
+            return 'private content';
+        }));
+
+        $this->head($magiclink->url . '-bad')
+            ->assertStatus(404);
+    }
+}
diff --git a/tests/HttpTest.php → tests/Http/HttpTest.php b/tests/HttpTest.php → tests/Http/HttpTest.php
@@ -1,9 +1,10 @@
 <?php
 
-namespace MagicLink\Test;
+namespace MagicLink\Test\Http;
 
 use MagicLink\Actions\ResponseAction;
 use MagicLink\MagicLink;
+use MagicLink\Test\TestCase;
 
 class HttpTest extends TestCase
 {
@@ -25,24 +26,6 @@ public function test_http_get_request()
         $this->assertEquals(5, $magiclink->num_visits);
     }
 
-    public function test_http_head_request_has_not_effects()
-    {
-        $magiclink = MagicLink::create(new ResponseAction(function () {
-            return 'private content';
-        }));
-
-        $magiclink->num_visits = 4;
-        $magiclink->save();
-
-        $this->head($magiclink->url)
-            ->assertStatus(200)
-            ->assertDontSeeText('private content');
-
-        $magiclink->refresh();
-
-        $this->assertEquals(4, $magiclink->num_visits);
-    }
-
     public function test_http_options_request_has_not_effects()
     {
         $magiclink = MagicLink::create(new ResponseAction(function () {
@@ -73,14 +56,4 @@ public function test_http_urlencode_legacy()
             ->assertStatus(200)
             ->assertSeeText('private content');
     }
-
-    public function test_http_head_request_without_valid_magiclink()
-    {
-        $magiclink = MagicLink::create(new ResponseAction(function () {
-            return 'private content';
-        }));
-
-        $this->head($magiclink->url . '-bad')
-            ->assertStatus(404);
-    }
 }
diff --git a/tests/Http/HttpThrottleTest.php b/tests/Http/HttpThrottleTest.php
@@ -0,0 +1,44 @@
+<?php
+
+namespace MagicLink\Test\Http;
+
+use MagicLink\Actions\ResponseAction;
+use MagicLink\MagicLink;
+use MagicLink\MagicLinkServiceProvider;
+use MagicLink\Test\TestCase;
+
+class HttpThrottleTest extends TestCase
+{
+    public function test_http_failed_when_rate_limit_is_exceeded()
+    {
+        config(['magiclink.rate_limit' => 1]);
+        (new MagicLinkServiceProvider($this->app))->boot();
+
+        $magiclink = MagicLink::create(new ResponseAction(function () {
+            return 'private content';
+        }));
+
+        $this->get($magiclink->url)
+            ->assertStatus(200);
+
+        $this->get($magiclink->url)
+
+        ->assertStatus(429);
+    }
+    public function test_http_when_rate_limit_is_none()
+    {
+        config(['magiclink.rate_limit' => 'none']);
+        (new MagicLinkServiceProvider($this->app))->boot();
+
+        $magiclink = MagicLink::create(new ResponseAction(function () {
+            return 'private content';
+        }));
+
+        $this->get($magiclink->url)
+            ->assertStatus(200);
+
+        $this->get($magiclink->url)
+            ->assertStatus(200);
+    }
+
+}