Skip to content
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.

Sign up for GitHub

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

Fix authorization request is not redirecting when code_challenge is invalid #1472

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix authorization request is not redirecting when code_challenge is invalid #1472

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions src/Exception/OAuthServerException.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,6 +346,16 @@ public function getRedirectUri(): ?string
return $this->redirectUri;
}

/**
* Set the Redirect URI used for redirecting.
*/
public function withRedirectUri(string $redirectUri): static
{
$this->redirectUri = $redirectUri;

return $this;
}

/**
* Returns the HTTP status code to send when the exceptions is output.
*/
Expand Down
13 changes: 8 additions & 5 deletions src/Grant/AuthCodeGrant.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ public function validateAuthorizationRequest(ServerRequestInterface $request): A

$scopes = $this->validateScopes(
$this->getQueryStringParameter('scope', $request, $this->defaultScope),
$this->makeRedirectUri(
$finalRedirectUri = $this->makeRedirectUri(
$redirectUri ?? $this->getClientRedirectUri($client),
$stateParameter !== null ? ['state' => $stateParameter] : []
)
Expand All @@ -306,7 +306,7 @@ public function validateAuthorizationRequest(ServerRequestInterface $request): A
throw OAuthServerException::invalidRequest(
'code_challenge_method',
'Code challenge method must be provided when `code_challenge` is set.'
);
)->withRedirectUri($finalRedirectUri);
}

if (array_key_exists($codeChallengeMethod, $this->codeChallengeVerifiers) === false) {
Expand All @@ -318,7 +318,7 @@ function ($method) {
},
array_keys($this->codeChallengeVerifiers)
))
);
)->withRedirectUri($finalRedirectUri);
}

// Validate code_challenge according to RFC-7636
Expand All @@ -327,13 +327,16 @@ function ($method) {
throw OAuthServerException::invalidRequest(
'code_challenge',
'Code challenge must follow the specifications of RFC-7636.'
);
)->withRedirectUri($finalRedirectUri);
}

$authorizationRequest->setCodeChallenge($codeChallenge);
$authorizationRequest->setCodeChallengeMethod($codeChallengeMethod);
} elseif ($this->requireCodeChallengeForPublicClients && !$client->isConfidential()) {
throw OAuthServerException::invalidRequest('code_challenge', 'Code challenge must be provided for public clients');
throw OAuthServerException::invalidRequest(
'code_challenge',
'Code challenge must be provided for public clients'
)->withRedirectUri($finalRedirectUri);
}

return $authorizationRequest;
Expand Down
113 changes: 104 additions & 9 deletions tests/Grant/AuthCodeGrantTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,13 +248,61 @@ public function testValidateAuthorizationRequestCodeChallenge(): void
self::assertInstanceOf(AuthorizationRequest::class, $grant->validateAuthorizationRequest($request));
}

public function testValidateAuthorizationRequestCodeChallengeRequired(): void
{
$client = new ClientEntity();
$client->setRedirectUri(self::REDIRECT_URI);
$clientRepositoryMock = $this->getMockBuilder(ClientRepositoryInterface::class)->getMock();
$clientRepositoryMock->method('getClientEntity')->willReturn($client);

$scope = new ScopeEntity();
$scope->setIdentifier(self::DEFAULT_SCOPE);
$scopeRepositoryMock = $this->getMockBuilder(ScopeRepositoryInterface::class)->getMock();
$scopeRepositoryMock->method('getScopeEntityByIdentifier')->willReturn($scope);

$grant = new AuthCodeGrant(
$this->getMockBuilder(AuthCodeRepositoryInterface::class)->getMock(),
$this->getMockBuilder(RefreshTokenRepositoryInterface::class)->getMock(),
new DateInterval('PT10M')
);

$grant->setDefaultScope(self::DEFAULT_SCOPE);
$grant->setClientRepository($clientRepositoryMock);
$grant->setScopeRepository($scopeRepositoryMock);

$request = (new ServerRequest())->withQueryParams([
'response_type' => 'code',
'client_id' => 'foo',
'redirect_uri' => self::REDIRECT_URI,
'code_challenge' => null,
'state' => 'foo',
]);

try {
$grant->validateAuthorizationRequest($request);
} catch (OAuthServerException $e) {
self::assertSame(3, $e->getCode());
self::assertSame('Code challenge must be provided for public clients', $e->getHint());
self::assertSame('invalid_request', $e->getErrorType());
self::assertSame('https://foo/bar?state=foo', $e->getRedirectUri());

return;
}

self::fail('The expected exception was not thrown');
}

public function testValidateAuthorizationRequestCodeChallengeInvalidLengthTooShort(): void
{
$client = new ClientEntity();
$client->setRedirectUri(self::REDIRECT_URI);
$clientRepositoryMock = $this->getMockBuilder(ClientRepositoryInterface::class)->getMock();
$clientRepositoryMock->method('getClientEntity')->willReturn($client);

$scope = new ScopeEntity();
$scope->setIdentifier(self::DEFAULT_SCOPE);
$scopeRepositoryMock = $this->getMockBuilder(ScopeRepositoryInterface::class)->getMock();
$scopeRepositoryMock->method('getScopeEntityByIdentifier')->willReturn($scope);

$grant = new AuthCodeGrant(
$this->getMockBuilder(AuthCodeRepositoryInterface::class)->getMock(),
Expand All @@ -271,11 +319,21 @@ public function testValidateAuthorizationRequestCodeChallengeInvalidLengthTooSho
'client_id' => 'foo',
'redirect_uri' => self::REDIRECT_URI,
'code_challenge' => str_repeat('A', 42),
'state' => 'foo',
]);

$this->expectException(OAuthServerException::class);
try {
$grant->validateAuthorizationRequest($request);
} catch (OAuthServerException $e) {
self::assertSame(3, $e->getCode());
self::assertSame('Code challenge must follow the specifications of RFC-7636.', $e->getHint());
self::assertSame('invalid_request', $e->getErrorType());
self::assertSame('https://foo/bar?state=foo', $e->getRedirectUri());

$grant->validateAuthorizationRequest($request);
return;
}

self::fail('The expected exception was not thrown');
}

public function testValidateAuthorizationRequestCodeChallengeInvalidLengthTooLong(): void
Expand All @@ -284,7 +342,11 @@ public function testValidateAuthorizationRequestCodeChallengeInvalidLengthTooLon
$client->setRedirectUri(self::REDIRECT_URI);
$clientRepositoryMock = $this->getMockBuilder(ClientRepositoryInterface::class)->getMock();
$clientRepositoryMock->method('getClientEntity')->willReturn($client);

$scope = new ScopeEntity();
$scope->setIdentifier(self::DEFAULT_SCOPE);
$scopeRepositoryMock = $this->getMockBuilder(ScopeRepositoryInterface::class)->getMock();
$scopeRepositoryMock->method('getScopeEntityByIdentifier')->willReturn($scope);

$grant = new AuthCodeGrant(
$this->getMockBuilder(AuthCodeRepositoryInterface::class)->getMock(),
Expand All @@ -301,11 +363,21 @@ public function testValidateAuthorizationRequestCodeChallengeInvalidLengthTooLon
'client_id' => 'foo',
'redirect_uri' => self::REDIRECT_URI,
'code_challenge' => str_repeat('A', 129),
'state' => 'foo',
]);

$this->expectException(OAuthServerException::class);
try {
$grant->validateAuthorizationRequest($request);
} catch (OAuthServerException $e) {
self::assertSame(3, $e->getCode());
self::assertSame('Code challenge must follow the specifications of RFC-7636.', $e->getHint());
self::assertSame('invalid_request', $e->getErrorType());
self::assertSame('https://foo/bar?state=foo', $e->getRedirectUri());

$grant->validateAuthorizationRequest($request);
return;
}

self::fail('The expected exception was not thrown');
}

public function testValidateAuthorizationRequestCodeChallengeInvalidCharacters(): void
Expand All @@ -314,7 +386,11 @@ public function testValidateAuthorizationRequestCodeChallengeInvalidCharacters()
$client->setRedirectUri(self::REDIRECT_URI);
$clientRepositoryMock = $this->getMockBuilder(ClientRepositoryInterface::class)->getMock();
$clientRepositoryMock->method('getClientEntity')->willReturn($client);

$scope = new ScopeEntity();
$scope->setIdentifier(self::DEFAULT_SCOPE);
$scopeRepositoryMock = $this->getMockBuilder(ScopeRepositoryInterface::class)->getMock();
$scopeRepositoryMock->method('getScopeEntityByIdentifier')->willReturn($scope);

$grant = new AuthCodeGrant(
$this->getMockBuilder(AuthCodeRepositoryInterface::class)->getMock(),
Expand All @@ -331,11 +407,21 @@ public function testValidateAuthorizationRequestCodeChallengeInvalidCharacters()
'client_id' => 'foo',
'redirect_uri' => self::REDIRECT_URI,
'code_challenge' => str_repeat('A', 42) . '!',
'state' => 'foo',
]);

$this->expectException(OAuthServerException::class);
try {
$grant->validateAuthorizationRequest($request);
} catch (OAuthServerException $e) {
self::assertSame(3, $e->getCode());
self::assertSame('Code challenge must follow the specifications of RFC-7636.', $e->getHint());
self::assertSame('invalid_request', $e->getErrorType());
self::assertSame('https://foo/bar?state=foo', $e->getRedirectUri());

$grant->validateAuthorizationRequest($request);
return;
}

self::fail('The expected exception was not thrown');
}

public function testValidateAuthorizationRequestMissingClientId(): void
Expand Down Expand Up @@ -461,12 +547,21 @@ public function testValidateAuthorizationRequestInvalidCodeChallengeMethod(): vo
'redirect_uri' => self::REDIRECT_URI,
'code_challenge' => 'foobar',
'code_challenge_method' => 'foo',
'state' => 'bar',
]);

$this->expectException(OAuthServerException::class);
$this->expectExceptionCode(3);
try {
$grant->validateAuthorizationRequest($request);
} catch (OAuthServerException $e) {
self::assertSame(3, $e->getCode());
self::assertSame('Code challenge method must be one of `S256`, `plain`', $e->getHint());
self::assertSame('invalid_request', $e->getErrorType());
self::assertSame('https://foo/bar?state=bar', $e->getRedirectUri());

$grant->validateAuthorizationRequest($request);
return;
}

self::fail('The expected exception was not thrown');
}

public function testValidateAuthorizationRequestInvalidScopes(): void
Expand Down
Loading