Skip to content

Commit

Permalink
Add ignore param to ValidateSignature middleware (#43160)
Browse files Browse the repository at this point in the history
* Add ignore param to ValidateSignature middleware

* Add test for ValidateSignature $ignore param
  • Loading branch information
valorin authored Jul 13, 2022
1 parent aedc437 commit a8a4006
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 1 deletion.
11 changes: 10 additions & 1 deletion src/Illuminate/Routing/Middleware/ValidateSignature.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@

class ValidateSignature
{
/**
* The names of the parameters that should be ignored.
*
* @var array<int, string>
*/
protected $ignore = [
//
];

/**
* Handle an incoming request.
*
Expand All @@ -19,7 +28,7 @@ class ValidateSignature
*/
public function handle($request, Closure $next, $relative = null)
{
if ($request->hasValidSignature($relative !== 'relative')) {
if ($request->hasValidSignatureWhileIgnoring($this->ignore, $relative !== 'relative')) {
return $next($request);
}

Expand Down
29 changes: 29 additions & 0 deletions tests/Integration/Routing/UrlSigningTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

use Illuminate\Contracts\Routing\UrlRoutable;
use Illuminate\Http\Request;
use Illuminate\Routing\Exceptions\InvalidSignatureException;
use Illuminate\Routing\Middleware\ValidateSignature;
use Illuminate\Support\Carbon;
use Illuminate\Support\Facades\Route;
Expand Down Expand Up @@ -251,6 +252,34 @@ public function testSignedMiddlewareWithRelativePath()
$response = $this->get('/foo/relative');
$response->assertStatus(403);
}

public function testSignedMiddlewareIgnoringParameter()
{
Route::get('/foo/{id}}', function (Request $request, $id) {
})->name('foo')->middleware('signed:relative');

$this->assertIsString($url = URL::signedRoute('foo', ['id' => 1]).'&ignore=me');
$request = Request::create($url);
$middleware = $this->createValidateSignatureMiddleware(['ignore']);

try {
$middleware->handle($request, function ($request) {
$this->assertTrue($request->hasValidSignatureWhileIgnoring(['ignore']));
});
} catch (InvalidSignatureException $exception) {
$this->fail($exception->getMessage());
}
}

protected function createValidateSignatureMiddleware(array $ignore)
{
return new class ($ignore) extends ValidateSignature {
public function __construct(array $ignore)
{
$this->ignore = $ignore;
}
};
}
}

class RoutableInterfaceStub implements UrlRoutable
Expand Down

0 comments on commit a8a4006

Please sign in to comment.