Skip to content

[13.x] Fix middleware type error #1815

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Http/Middleware/CheckToken.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

namespace Laravel\Passport\Http\Middleware;

use Laravel\Passport\AccessToken;
use Laravel\Passport\Contracts\ScopeAuthorizable;
use Laravel\Passport\Exceptions\MissingScopeException;

class CheckToken extends ValidateToken
Expand All @@ -12,7 +12,7 @@ class CheckToken extends ValidateToken
*
* @throws \Laravel\Passport\Exceptions\MissingScopeException
*/
protected function validate(AccessToken $token, string ...$params): void
protected function validate(ScopeAuthorizable $token, string ...$params): void
{
foreach ($params as $scope) {
if ($token->cant($scope)) {
Expand Down
4 changes: 2 additions & 2 deletions src/Http/Middleware/CheckTokenForAnyScope.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

namespace Laravel\Passport\Http\Middleware;

use Laravel\Passport\AccessToken;
use Laravel\Passport\Contracts\ScopeAuthorizable;
use Laravel\Passport\Exceptions\MissingScopeException;

class CheckTokenForAnyScope extends ValidateToken
Expand All @@ -12,7 +12,7 @@ class CheckTokenForAnyScope extends ValidateToken
*
* @throws \Laravel\Passport\Exceptions\MissingScopeException
*/
protected function validate(AccessToken $token, string ...$params): void
protected function validate(ScopeAuthorizable $token, string ...$params): void
{
foreach ($params as $scope) {
if ($token->can($scope)) {
Expand Down
9 changes: 7 additions & 2 deletions src/Http/Middleware/EnsureClientIsResourceOwner.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace Laravel\Passport\Http\Middleware;

use Laravel\Passport\AccessToken;
use Laravel\Passport\Contracts\ScopeAuthorizable;
use Laravel\Passport\Exceptions\AuthenticationException;
use Laravel\Passport\Exceptions\MissingScopeException;

Expand All @@ -13,9 +14,13 @@ class EnsureClientIsResourceOwner extends ValidateToken
*
* @throws \Laravel\Passport\Exceptions\AuthenticationException|\Laravel\Passport\Exceptions\MissingScopeException
*/
protected function validate(AccessToken $token, string ...$params): void
protected function validate(ScopeAuthorizable $token, string ...$params): void
{
if (! is_null($token->oauth_user_id) && $token->oauth_user_id !== $token->oauth_client_id) {
if (
$token instanceof AccessToken
&& ! is_null($token->oauth_user_id)
&& $token->oauth_user_id !== $token->oauth_client_id
) {
throw new AuthenticationException;
}

Expand Down
5 changes: 3 additions & 2 deletions src/Http/Middleware/ValidateToken.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
use Closure;
use Illuminate\Http\Request;
use Laravel\Passport\AccessToken;
use Laravel\Passport\Contracts\ScopeAuthorizable;
use Laravel\Passport\Exceptions\AuthenticationException;
use League\OAuth2\Server\Exception\OAuthServerException;
use League\OAuth2\Server\ResourceServer;
Expand Down Expand Up @@ -54,7 +55,7 @@ public function handle(Request $request, Closure $next, string ...$params): Resp
*
* @throws \Laravel\Passport\Exceptions\AuthenticationException
*/
protected function validateToken(Request $request): AccessToken
protected function validateToken(Request $request): ScopeAuthorizable
{
// If the user is authenticated and already has an access token set via
// the token guard, there's no need to validate the request's bearer
Expand All @@ -80,5 +81,5 @@ protected function validateToken(Request $request): AccessToken
/**
* Validate the given access token.
*/
abstract protected function validate(AccessToken $token, string ...$params): void;
abstract protected function validate(ScopeAuthorizable $token, string ...$params): void;
}
23 changes: 23 additions & 0 deletions tests/Unit/CheckTokenForAnyScopeTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Laravel\Passport\AccessToken;
use Laravel\Passport\Contracts\OAuthenticatable;
use Laravel\Passport\Exceptions\AuthenticationException;
use Laravel\Passport\Http\Middleware\CheckTokenForAnyScope;
use Laravel\Passport\TransientToken;
use League\OAuth2\Server\Exception\OAuthServerException;
use League\OAuth2\Server\ResourceServer;
use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
Expand Down Expand Up @@ -41,6 +43,27 @@ public function test_request_is_passed_along_if_token_is_valid()
$this->assertSame('response', $response->getContent());
}

public function test_request_is_passed_along_if_token_is_transient()
{
$user = m::mock(OAuthenticatable::class);
$user->shouldReceive('currentAccessToken')->andReturn(new TransientToken());

$resourceServer = m::mock(ResourceServer::class);
$resourceServer->shouldNotReceive('validateAuthenticatedRequest');

$middleware = new CheckTokenForAnyScope($resourceServer);

$request = Request::create('/');
$request->headers->set('Authorization', 'Bearer token');
$request->setUserResolver(fn () => $user);

$response = $middleware->handle($request, function () {
return new Response('response');
}, 'notfoo');

$this->assertSame('response', $response->getContent());
}

public function test_request_is_passed_along_if_token_has_any_required_scope()
{
$resourceServer = m::mock(ResourceServer::class);
Expand Down
23 changes: 23 additions & 0 deletions tests/Unit/CheckTokenTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Laravel\Passport\AccessToken;
use Laravel\Passport\Contracts\OAuthenticatable;
use Laravel\Passport\Exceptions\AuthenticationException;
use Laravel\Passport\Http\Middleware\CheckToken;
use Laravel\Passport\TransientToken;
use League\OAuth2\Server\Exception\OAuthServerException;
use League\OAuth2\Server\ResourceServer;
use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
Expand Down Expand Up @@ -41,6 +43,27 @@ public function test_request_is_passed_along_if_token_is_valid()
$this->assertSame('response', $response->getContent());
}

public function test_request_is_passed_along_if_token_is_transient()
{
$user = m::mock(OAuthenticatable::class);
$user->shouldReceive('currentAccessToken')->andReturn(new TransientToken());

$resourceServer = m::mock(ResourceServer::class);
$resourceServer->shouldNotReceive('validateAuthenticatedRequest');

$middleware = new CheckToken($resourceServer);

$request = Request::create('/');
$request->headers->set('Authorization', 'Bearer token');
$request->setUserResolver(fn () => $user);

$response = $middleware->handle($request, function () {
return new Response('response');
});

$this->assertSame('response', $response->getContent());
}

public function test_request_is_passed_along_if_token_and_scope_are_valid()
{
$resourceServer = m::mock(ResourceServer::class);
Expand Down