mirror of
https://github.com/elyby/oauth2-server.git
synced 2024-12-27 23:40:22 +05:30
9775c0076b
Should allow for better compatibility with server implementations that aren't sitting on top of a standard SAPI (e.g. persistent web servers building a PSR-7 compatible request from a socket-received message). One catch here is that I've seen Apache hijack the HTTP Authorization header in the past, though that would probably impact the other aspects of the server just as much as it would this, so I think that risk is manageable. Added tests to cover all paths through the new code, so the AbstractGrant type still has 100% coverage :) Did notice that, as of the latest versions of PHPUnit, the mock creation method is deprecated. Maybe that needs to be updated? Haven't checked to see whether the replacements are PHPUnit 4.8 compatible though, so maybe they need to stay in order to test on older PHP versions?
499 lines
20 KiB
PHP
499 lines
20 KiB
PHP
<?php
|
|
|
|
namespace LeagueTests\Grant;
|
|
|
|
use League\Event\Emitter;
|
|
use League\OAuth2\Server\CryptKey;
|
|
use League\OAuth2\Server\Entities\AccessTokenEntityInterface;
|
|
use League\OAuth2\Server\Entities\AuthCodeEntityInterface;
|
|
use League\OAuth2\Server\Entities\RefreshTokenEntityInterface;
|
|
use League\OAuth2\Server\Grant\AbstractGrant;
|
|
use League\OAuth2\Server\Repositories\AccessTokenRepositoryInterface;
|
|
use League\OAuth2\Server\Repositories\AuthCodeRepositoryInterface;
|
|
use League\OAuth2\Server\Repositories\ClientRepositoryInterface;
|
|
use League\OAuth2\Server\Repositories\RefreshTokenRepositoryInterface;
|
|
use League\OAuth2\Server\Repositories\ScopeRepositoryInterface;
|
|
use League\OAuth2\Server\RequestTypes\AuthorizationRequest;
|
|
use LeagueTests\Stubs\AccessTokenEntity;
|
|
use LeagueTests\Stubs\AuthCodeEntity;
|
|
use LeagueTests\Stubs\ClientEntity;
|
|
use LeagueTests\Stubs\RefreshTokenEntity;
|
|
use LeagueTests\Stubs\ScopeEntity;
|
|
use Zend\Diactoros\ServerRequest;
|
|
|
|
class AbstractGrantTest extends \PHPUnit_Framework_TestCase
|
|
{
|
|
public function testGetSet()
|
|
{
|
|
/** @var AbstractGrant $grantMock */
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$grantMock->setPrivateKey(new CryptKey(__DIR__ . '/../Stubs/private.key'));
|
|
$grantMock->setPublicKey(new CryptKey(__DIR__ . '/../Stubs/public.key'));
|
|
$grantMock->setEmitter(new Emitter());
|
|
}
|
|
|
|
public function testHttpBasicWithPassword()
|
|
{
|
|
/** @var AbstractGrant $grantMock */
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$abstractGrantReflection = new \ReflectionClass($grantMock);
|
|
|
|
$serverRequest = new ServerRequest();
|
|
$serverRequest = $serverRequest->withHeader('Authorization', 'Basic ' . base64_encode('Open:Sesame'));
|
|
$basicAuthMethod = $abstractGrantReflection->getMethod('getBasicAuthCredentials');
|
|
$basicAuthMethod->setAccessible(true);
|
|
|
|
$this->assertSame(['Open', 'Sesame'], $basicAuthMethod->invoke($grantMock, $serverRequest));
|
|
}
|
|
|
|
public function testHttpBasicNoPassword()
|
|
{
|
|
/** @var AbstractGrant $grantMock */
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$abstractGrantReflection = new \ReflectionClass($grantMock);
|
|
|
|
$serverRequest = new ServerRequest();
|
|
$serverRequest = $serverRequest->withHeader('Authorization', 'Basic ' . base64_encode('Open:'));
|
|
$basicAuthMethod = $abstractGrantReflection->getMethod('getBasicAuthCredentials');
|
|
$basicAuthMethod->setAccessible(true);
|
|
|
|
$this->assertSame(['Open', ''], $basicAuthMethod->invoke($grantMock, $serverRequest));
|
|
}
|
|
|
|
public function testHttpBasicNotBasic()
|
|
{
|
|
/** @var AbstractGrant $grantMock */
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$abstractGrantReflection = new \ReflectionClass($grantMock);
|
|
|
|
$serverRequest = new ServerRequest();
|
|
$serverRequest = $serverRequest->withHeader('Authorization', 'Foo ' . base64_encode('Open:Sesame'));
|
|
$basicAuthMethod = $abstractGrantReflection->getMethod('getBasicAuthCredentials');
|
|
$basicAuthMethod->setAccessible(true);
|
|
|
|
$this->assertSame([null, null], $basicAuthMethod->invoke($grantMock, $serverRequest));
|
|
}
|
|
|
|
public function testHttpBasicNotBase64()
|
|
{
|
|
/** @var AbstractGrant $grantMock */
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$abstractGrantReflection = new \ReflectionClass($grantMock);
|
|
|
|
$serverRequest = new ServerRequest();
|
|
$serverRequest = $serverRequest->withHeader('Authorization', 'Basic ||');
|
|
$basicAuthMethod = $abstractGrantReflection->getMethod('getBasicAuthCredentials');
|
|
$basicAuthMethod->setAccessible(true);
|
|
|
|
$this->assertSame([null, null], $basicAuthMethod->invoke($grantMock, $serverRequest));
|
|
}
|
|
|
|
public function testHttpBasicNoColon()
|
|
{
|
|
/** @var AbstractGrant $grantMock */
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$abstractGrantReflection = new \ReflectionClass($grantMock);
|
|
|
|
$serverRequest = new ServerRequest();
|
|
$serverRequest = $serverRequest->withHeader('Authorization', 'Basic ' . base64_encode('OpenSesame'));
|
|
$basicAuthMethod = $abstractGrantReflection->getMethod('getBasicAuthCredentials');
|
|
$basicAuthMethod->setAccessible(true);
|
|
|
|
$this->assertSame([null, null], $basicAuthMethod->invoke($grantMock, $serverRequest));
|
|
}
|
|
|
|
public function testValidateClientPublic()
|
|
{
|
|
$client = new ClientEntity();
|
|
|
|
$clientRepositoryMock = $this->getMockBuilder(ClientRepositoryInterface::class)->getMock();
|
|
$clientRepositoryMock->method('getClientEntity')->willReturn($client);
|
|
|
|
/** @var AbstractGrant $grantMock */
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$grantMock->setClientRepository($clientRepositoryMock);
|
|
|
|
$abstractGrantReflection = new \ReflectionClass($grantMock);
|
|
|
|
$serverRequest = new ServerRequest();
|
|
$serverRequest = $serverRequest->withParsedBody(
|
|
[
|
|
'client_id' => 'foo',
|
|
]
|
|
);
|
|
$validateClientMethod = $abstractGrantReflection->getMethod('validateClient');
|
|
$validateClientMethod->setAccessible(true);
|
|
|
|
$result = $validateClientMethod->invoke($grantMock, $serverRequest, true, true);
|
|
$this->assertEquals($client, $result);
|
|
}
|
|
|
|
public function testValidateClientConfidential()
|
|
{
|
|
$client = new ClientEntity();
|
|
|
|
$clientRepositoryMock = $this->getMockBuilder(ClientRepositoryInterface::class)->getMock();
|
|
$clientRepositoryMock->method('getClientEntity')->willReturn($client);
|
|
|
|
/** @var AbstractGrant $grantMock */
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$grantMock->setClientRepository($clientRepositoryMock);
|
|
|
|
$abstractGrantReflection = new \ReflectionClass($grantMock);
|
|
|
|
$serverRequest = new ServerRequest();
|
|
$serverRequest = $serverRequest->withParsedBody(
|
|
[
|
|
'client_id' => 'foo',
|
|
'client_secret' => 'bar',
|
|
'redirect_uri' => 'http://foo/bar',
|
|
]
|
|
);
|
|
$validateClientMethod = $abstractGrantReflection->getMethod('validateClient');
|
|
$validateClientMethod->setAccessible(true);
|
|
|
|
$result = $validateClientMethod->invoke($grantMock, $serverRequest, true, true);
|
|
$this->assertEquals($client, $result);
|
|
}
|
|
|
|
/**
|
|
* @expectedException \League\OAuth2\Server\Exception\OAuthServerException
|
|
*/
|
|
public function testValidateClientMissingClientId()
|
|
{
|
|
$client = new ClientEntity();
|
|
$clientRepositoryMock = $this->getMockBuilder(ClientRepositoryInterface::class)->getMock();
|
|
$clientRepositoryMock->method('getClientEntity')->willReturn($client);
|
|
|
|
/** @var AbstractGrant $grantMock */
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$grantMock->setClientRepository($clientRepositoryMock);
|
|
|
|
$abstractGrantReflection = new \ReflectionClass($grantMock);
|
|
|
|
$serverRequest = new ServerRequest();
|
|
$validateClientMethod = $abstractGrantReflection->getMethod('validateClient');
|
|
$validateClientMethod->setAccessible(true);
|
|
|
|
$validateClientMethod->invoke($grantMock, $serverRequest, true, true);
|
|
}
|
|
|
|
/**
|
|
* @expectedException \League\OAuth2\Server\Exception\OAuthServerException
|
|
*/
|
|
public function testValidateClientMissingClientSecret()
|
|
{
|
|
$clientRepositoryMock = $this->getMockBuilder(ClientRepositoryInterface::class)->getMock();
|
|
$clientRepositoryMock->method('getClientEntity')->willReturn(null);
|
|
|
|
/** @var AbstractGrant $grantMock */
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$grantMock->setClientRepository($clientRepositoryMock);
|
|
|
|
$abstractGrantReflection = new \ReflectionClass($grantMock);
|
|
|
|
$serverRequest = new ServerRequest();
|
|
$serverRequest = $serverRequest->withParsedBody([
|
|
'client_id' => 'foo',
|
|
]);
|
|
|
|
$validateClientMethod = $abstractGrantReflection->getMethod('validateClient');
|
|
$validateClientMethod->setAccessible(true);
|
|
|
|
$validateClientMethod->invoke($grantMock, $serverRequest, true, true);
|
|
}
|
|
|
|
/**
|
|
* @expectedException \League\OAuth2\Server\Exception\OAuthServerException
|
|
*/
|
|
public function testValidateClientInvalidClientSecret()
|
|
{
|
|
$clientRepositoryMock = $this->getMockBuilder(ClientRepositoryInterface::class)->getMock();
|
|
$clientRepositoryMock->method('getClientEntity')->willReturn(null);
|
|
|
|
/** @var AbstractGrant $grantMock */
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$grantMock->setClientRepository($clientRepositoryMock);
|
|
|
|
$abstractGrantReflection = new \ReflectionClass($grantMock);
|
|
|
|
$serverRequest = new ServerRequest();
|
|
$serverRequest = $serverRequest->withParsedBody([
|
|
'client_id' => 'foo',
|
|
'client_secret' => 'foo',
|
|
]);
|
|
|
|
$validateClientMethod = $abstractGrantReflection->getMethod('validateClient');
|
|
$validateClientMethod->setAccessible(true);
|
|
|
|
$validateClientMethod->invoke($grantMock, $serverRequest, true, true);
|
|
}
|
|
|
|
/**
|
|
* @expectedException \League\OAuth2\Server\Exception\OAuthServerException
|
|
*/
|
|
public function testValidateClientInvalidRedirectUri()
|
|
{
|
|
$client = new ClientEntity();
|
|
$client->setRedirectUri('http://foo/bar');
|
|
$clientRepositoryMock = $this->getMockBuilder(ClientRepositoryInterface::class)->getMock();
|
|
$clientRepositoryMock->method('getClientEntity')->willReturn($client);
|
|
|
|
/** @var AbstractGrant $grantMock */
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$grantMock->setClientRepository($clientRepositoryMock);
|
|
|
|
$abstractGrantReflection = new \ReflectionClass($grantMock);
|
|
|
|
$serverRequest = new ServerRequest();
|
|
$serverRequest = $serverRequest->withParsedBody([
|
|
'client_id' => 'foo',
|
|
'redirect_uri' => 'http://bar/foo',
|
|
]);
|
|
|
|
$validateClientMethod = $abstractGrantReflection->getMethod('validateClient');
|
|
$validateClientMethod->setAccessible(true);
|
|
|
|
$validateClientMethod->invoke($grantMock, $serverRequest, true, true);
|
|
}
|
|
|
|
/**
|
|
* @expectedException \League\OAuth2\Server\Exception\OAuthServerException
|
|
*/
|
|
public function testValidateClientInvalidRedirectUriArray()
|
|
{
|
|
$client = new ClientEntity();
|
|
$client->setRedirectUri(['http://foo/bar']);
|
|
$clientRepositoryMock = $this->getMockBuilder(ClientRepositoryInterface::class)->getMock();
|
|
$clientRepositoryMock->method('getClientEntity')->willReturn($client);
|
|
|
|
/** @var AbstractGrant $grantMock */
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$grantMock->setClientRepository($clientRepositoryMock);
|
|
|
|
$abstractGrantReflection = new \ReflectionClass($grantMock);
|
|
|
|
$serverRequest = new ServerRequest();
|
|
$serverRequest = $serverRequest->withParsedBody([
|
|
'client_id' => 'foo',
|
|
'redirect_uri' => 'http://bar/foo',
|
|
]);
|
|
|
|
$validateClientMethod = $abstractGrantReflection->getMethod('validateClient');
|
|
$validateClientMethod->setAccessible(true);
|
|
|
|
$validateClientMethod->invoke($grantMock, $serverRequest, true, true);
|
|
}
|
|
|
|
/**
|
|
* @expectedException \League\OAuth2\Server\Exception\OAuthServerException
|
|
*/
|
|
public function testValidateClientBadClient()
|
|
{
|
|
$clientRepositoryMock = $this->getMockBuilder(ClientRepositoryInterface::class)->getMock();
|
|
$clientRepositoryMock->method('getClientEntity')->willReturn(null);
|
|
|
|
/** @var AbstractGrant $grantMock */
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$grantMock->setClientRepository($clientRepositoryMock);
|
|
|
|
$abstractGrantReflection = new \ReflectionClass($grantMock);
|
|
|
|
$serverRequest = new ServerRequest();
|
|
$serverRequest = $serverRequest->withParsedBody([
|
|
'client_id' => 'foo',
|
|
'client_secret' => 'bar',
|
|
]);
|
|
|
|
$validateClientMethod = $abstractGrantReflection->getMethod('validateClient');
|
|
$validateClientMethod->setAccessible(true);
|
|
|
|
$validateClientMethod->invoke($grantMock, $serverRequest, true);
|
|
}
|
|
|
|
public function testCanRespondToRequest()
|
|
{
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$grantMock->method('getIdentifier')->willReturn('foobar');
|
|
|
|
$serverRequest = new ServerRequest();
|
|
$serverRequest = $serverRequest->withParsedBody([
|
|
'grant_type' => 'foobar',
|
|
]);
|
|
|
|
$this->assertTrue($grantMock->canRespondToAccessTokenRequest($serverRequest));
|
|
}
|
|
|
|
public function testIssueRefreshToken()
|
|
{
|
|
$refreshTokenRepoMock = $this->getMock(RefreshTokenRepositoryInterface::class);
|
|
$refreshTokenRepoMock
|
|
->expects($this->once())
|
|
->method('getNewRefreshToken')
|
|
->willReturn(new RefreshTokenEntity());
|
|
|
|
/** @var AbstractGrant $grantMock */
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$grantMock->setRefreshTokenTTL(new \DateInterval('PT1M'));
|
|
$grantMock->setRefreshTokenRepository($refreshTokenRepoMock);
|
|
|
|
$abstractGrantReflection = new \ReflectionClass($grantMock);
|
|
$issueRefreshTokenMethod = $abstractGrantReflection->getMethod('issueRefreshToken');
|
|
$issueRefreshTokenMethod->setAccessible(true);
|
|
|
|
$accessToken = new AccessTokenEntity();
|
|
/** @var RefreshTokenEntityInterface $refreshToken */
|
|
$refreshToken = $issueRefreshTokenMethod->invoke($grantMock, $accessToken);
|
|
$this->assertTrue($refreshToken instanceof RefreshTokenEntityInterface);
|
|
$this->assertEquals($accessToken, $refreshToken->getAccessToken());
|
|
}
|
|
|
|
public function testIssueAccessToken()
|
|
{
|
|
$accessTokenRepoMock = $this->getMock(AccessTokenRepositoryInterface::class);
|
|
$accessTokenRepoMock->method('getNewToken')->willReturn(new AccessTokenEntity());
|
|
|
|
/** @var AbstractGrant $grantMock */
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$grantMock->setAccessTokenRepository($accessTokenRepoMock);
|
|
|
|
$abstractGrantReflection = new \ReflectionClass($grantMock);
|
|
$issueAccessTokenMethod = $abstractGrantReflection->getMethod('issueAccessToken');
|
|
$issueAccessTokenMethod->setAccessible(true);
|
|
|
|
/** @var AccessTokenEntityInterface $accessToken */
|
|
$accessToken = $issueAccessTokenMethod->invoke(
|
|
$grantMock,
|
|
new \DateInterval('PT1H'),
|
|
new ClientEntity(),
|
|
123,
|
|
[new ScopeEntity()]
|
|
);
|
|
$this->assertTrue($accessToken instanceof AccessTokenEntityInterface);
|
|
}
|
|
|
|
public function testIssueAuthCode()
|
|
{
|
|
$authCodeRepoMock = $this->getMock(AuthCodeRepositoryInterface::class);
|
|
$authCodeRepoMock->expects($this->once())->method('getNewAuthCode')->willReturn(new AuthCodeEntity());
|
|
|
|
/** @var AbstractGrant $grantMock */
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$grantMock->setAuthCodeRepository($authCodeRepoMock);
|
|
|
|
$abstractGrantReflection = new \ReflectionClass($grantMock);
|
|
$issueAuthCodeMethod = $abstractGrantReflection->getMethod('issueAuthCode');
|
|
$issueAuthCodeMethod->setAccessible(true);
|
|
|
|
$this->assertTrue(
|
|
$issueAuthCodeMethod->invoke(
|
|
$grantMock,
|
|
new \DateInterval('PT1H'),
|
|
new ClientEntity(),
|
|
123,
|
|
'http://foo/bar',
|
|
[new ScopeEntity()]
|
|
) instanceof AuthCodeEntityInterface
|
|
);
|
|
}
|
|
|
|
public function testGetCookieParameter()
|
|
{
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$grantMock->method('getIdentifier')->willReturn('foobar');
|
|
|
|
$abstractGrantReflection = new \ReflectionClass($grantMock);
|
|
$method = $abstractGrantReflection->getMethod('getCookieParameter');
|
|
$method->setAccessible(true);
|
|
|
|
$serverRequest = new ServerRequest();
|
|
$serverRequest = $serverRequest->withCookieParams([
|
|
'foo' => 'bar',
|
|
]);
|
|
|
|
$this->assertEquals('bar', $method->invoke($grantMock, 'foo', $serverRequest));
|
|
$this->assertEquals('foo', $method->invoke($grantMock, 'bar', $serverRequest, 'foo'));
|
|
}
|
|
|
|
public function testGetQueryStringParameter()
|
|
{
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$grantMock->method('getIdentifier')->willReturn('foobar');
|
|
|
|
$abstractGrantReflection = new \ReflectionClass($grantMock);
|
|
$method = $abstractGrantReflection->getMethod('getQueryStringParameter');
|
|
$method->setAccessible(true);
|
|
|
|
$serverRequest = new ServerRequest();
|
|
$serverRequest = $serverRequest->withQueryParams([
|
|
'foo' => 'bar',
|
|
]);
|
|
|
|
$this->assertEquals('bar', $method->invoke($grantMock, 'foo', $serverRequest));
|
|
$this->assertEquals('foo', $method->invoke($grantMock, 'bar', $serverRequest, 'foo'));
|
|
}
|
|
|
|
public function testValidateScopes()
|
|
{
|
|
$scope = new ScopeEntity();
|
|
$scopeRepositoryMock = $this->getMockBuilder(ScopeRepositoryInterface::class)->getMock();
|
|
$scopeRepositoryMock->method('getScopeEntityByIdentifier')->willReturn($scope);
|
|
|
|
/** @var AbstractGrant $grantMock */
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$grantMock->setScopeRepository($scopeRepositoryMock);
|
|
|
|
$this->assertEquals([$scope], $grantMock->validateScopes('basic '));
|
|
}
|
|
|
|
/**
|
|
* @expectedException \League\OAuth2\Server\Exception\OAuthServerException
|
|
*/
|
|
public function testValidateScopesBadScope()
|
|
{
|
|
$scopeRepositoryMock = $this->getMockBuilder(ScopeRepositoryInterface::class)->getMock();
|
|
$scopeRepositoryMock->method('getScopeEntityByIdentifier')->willReturn(null);
|
|
|
|
/** @var AbstractGrant $grantMock */
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$grantMock->setScopeRepository($scopeRepositoryMock);
|
|
|
|
$grantMock->validateScopes('basic ');
|
|
}
|
|
|
|
public function testGenerateUniqueIdentifier()
|
|
{
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
|
|
$abstractGrantReflection = new \ReflectionClass($grantMock);
|
|
$method = $abstractGrantReflection->getMethod('generateUniqueIdentifier');
|
|
$method->setAccessible(true);
|
|
|
|
$this->assertTrue(is_string($method->invoke($grantMock)));
|
|
}
|
|
|
|
public function testCanRespondToAuthorizationRequest()
|
|
{
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$this->assertFalse($grantMock->canRespondToAuthorizationRequest(new ServerRequest()));
|
|
}
|
|
|
|
/**
|
|
* @expectedException \LogicException
|
|
*/
|
|
public function testValidateAuthorizationRequest()
|
|
{
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$grantMock->validateAuthorizationRequest(new ServerRequest());
|
|
}
|
|
|
|
/**
|
|
* @expectedException \LogicException
|
|
*/
|
|
public function testCompleteAuthorizationRequest()
|
|
{
|
|
$grantMock = $this->getMockForAbstractClass(AbstractGrant::class);
|
|
$grantMock->completeAuthorizationRequest(new AuthorizationRequest());
|
|
}
|
|
}
|