ElyBy-Mirror/oauth2-server
1
0
Fork 0
mirror of https://github.com/elyby/oauth2-server.git synced 2024-12-31 17:30:21 +05:30
Code Issues Packages Projects Releases Wiki Activity

minor improvements and documentation fixes

Browse Source
This commit is contained in:
Julián Gutiérrez 2016-01-20 10:36:16 +01:00
parent 1e1043c04f
commit 3e5889e93b
17 changed files with 37 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/Entities/Interfaces/AccessTokenEntityInterface.php
View File

@ -4,4 +4,4 @@ namespace League\OAuth2\Server\Entities\Interfaces;
interface AccessTokenEntityInterface extends TokenInterface
{
}
}

2
src/Entities/ScopeEntity.php
View File

@ -15,7 +15,7 @@ class ScopeEntity implements ScopeEntityInterface
/**
* @inheritdoc
*/
function jsonSerialize()
public function jsonSerialize()
{
return $this->getIdentifier();
}

2
src/Entities/Traits/ClientEntityTrait.php
View File

@ -25,4 +25,4 @@ trait ClientEntityTrait
{
$this->name = $name;
}
}
}

2
src/Entities/Traits/RefreshTokenTrait.php
View File

@ -50,4 +50,4 @@ trait RefreshTokenTrait
{
$this->expiryDateTime = $dateTime;
}
}
}

2
src/Entities/Traits/TokenEntityTrait.php
View File

@ -123,4 +123,4 @@ trait TokenEntityTrait
{
return (new DateTime()) > $this->getExpiryDateTime();
}
}
}

6
src/Exception/OAuthServerException.php
View File

@ -60,7 +60,8 @@ class OAuthServerException extends \Exception
$localizedHint = null
) {
$errorMessage = (is_null($localizedError))
? 'The provided authorization grant is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client.'
? 'The provided authorization grant is invalid, expired, revoked, does not match ' .
'the redirection URI used in the authorization request, or was issued to another client.'
: $localizedError;
$hint = (is_null($localizedHint))
? 'Check the `grant_type` parameter'
@ -106,7 +107,8 @@ class OAuthServerException extends \Exception
$localizedHint = null
) {
$errorMessage = (is_null($localizedError))
? 'The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed.'
? 'The request is missing a required parameter, includes an invalid parameter value, ' .
'includes a parameter more than once, or is otherwise malformed.'
: $localizedError;
$hint = (is_null($localizedHint))
? sprintf('Check the `%s` parameter', $parameter)

19
src/Grant/AbstractGrant.php
View File

@ -11,7 +11,7 @@
namespace League\OAuth2\Server\Grant;
use League\Event\EmitterInterface;
use League\Event\EmitterAwareTrait;
use League\Event\Event;
use League\OAuth2\Server\Entities\AccessTokenEntity;
use League\OAuth2\Server\Entities\Interfaces\ClientEntityInterface;
@ -29,6 +29,8 @@ use Psr\Http\Message\ServerRequestInterface;
*/
abstract class AbstractGrant implements GrantTypeInterface
{
use EmitterAwareTrait;
const SCOPE_DELIMITER_STRING = ' ';
/**
@ -60,11 +62,6 @@ abstract class AbstractGrant implements GrantTypeInterface
*/
protected $accessTokenRepository;
/**
* @var \League\Event\Emitter
*/
protected $emitter;
/**
* @var ScopeRepositoryInterface
*/
@ -120,14 +117,6 @@ abstract class AbstractGrant implements GrantTypeInterface
$this->pathToPublicKey = $pathToPublicKey;
}
/**
* @inheritdoc
*/
public function setEmitter(EmitterInterface $emitter)
{
$this->emitter = $emitter;
}
/**
* {@inheritdoc}
*/
@ -179,7 +168,7 @@ abstract class AbstractGrant implements GrantTypeInterface
);
if (!$client instanceof ClientEntityInterface) {
$this->emitter->emit(new Event('client.authentication.failed', $request));
$this->getEmitter()->emit(new Event('client.authentication.failed', $request));
throw OAuthServerException::invalidClient();
}

11
src/Grant/GrantTypeInterface.php
View File

@ -12,7 +12,7 @@
namespace League\OAuth2\Server\Grant;
use DateInterval;
use League\Event\EmitterInterface;
use League\Event\EmitterAwareInterface;
use League\OAuth2\Server\Repositories\AccessTokenRepositoryInterface;
use League\OAuth2\Server\Repositories\ClientRepositoryInterface;
use League\OAuth2\Server\Repositories\ScopeRepositoryInterface;
@ -22,7 +22,7 @@ use Psr\Http\Message\ServerRequestInterface;
/**
* Grant type interface
*/
interface GrantTypeInterface
interface GrantTypeInterface extends EmitterAwareInterface
{
/**
* Return the identifier
@ -67,13 +67,6 @@ interface GrantTypeInterface
*/
public function canRespondToRequest(ServerRequestInterface $request);
/**
* Set the event emitter
*
* @param \League\Event\EmitterInterface $emitter
*/
public function setEmitter(EmitterInterface $emitter);
/**
* Set the client repository
*

2
src/Grant/PasswordGrant.php
View File

@ -100,7 +100,7 @@ class PasswordGrant extends AbstractGrant
$user = $this->userRepository->getUserEntityByUserCredentials($username, $password);
if (!$user instanceof UserEntityInterface) {
$this->emitter->emit(new Event('user.authentication.failed', $request));
$this->getEmitter()->emit(new Event('user.authentication.failed', $request));
throw OAuthServerException::invalidCredentials();
}

9
src/Grant/RefreshTokenGrant.php
View File

@ -38,9 +38,8 @@ class RefreshTokenGrant extends AbstractGrant
/**
* @param \League\OAuth2\Server\Repositories\RefreshTokenRepositoryInterface $refreshTokenRepository
*/
public function __construct(
RefreshTokenRepositoryInterface $refreshTokenRepository
) {
public function __construct(RefreshTokenRepositoryInterface $refreshTokenRepository)
{
$this->refreshTokenRepository = $refreshTokenRepository;
}
@ -64,7 +63,7 @@ class RefreshTokenGrant extends AbstractGrant
// the request doesn't include any new scopes
foreach ($scopes as $scope) {
if (in_array($scope->getIdentifier(), $oldRefreshToken['scopes']) === false) {
$this->emitter->emit(new Event('scope.selection.failed', $request));
$this->getEmitter()->emit(new Event('scope.selection.failed', $request));
throw OAuthServerException::invalidScope($scope->getIdentifier());
}
@ -112,7 +111,7 @@ class RefreshTokenGrant extends AbstractGrant
$refreshTokenData = json_decode($refreshToken, true);
if ($refreshTokenData['client_id'] !== $clientId) {
$this->emitter->emit(new Event('refresh_token.client.failed', $request));
$this->getEmitter()->emit(new Event('refresh_token.client.failed', $request));
throw OAuthServerException::invalidRefreshToken(
'Token is not linked to client,' .

2
src/Repositories/AuthCodeRepositoryInterface.php
View File

@ -33,8 +33,6 @@ interface AuthCodeRepositoryInterface extends RepositoryInterface
* @param string $code The authorization code string
* @param integer $expireTime Token expire time
* @param string $redirectUri Client redirect uri
*
* @return void
*/
public function persistNewAuthCode($code, $expireTime, $redirectUri);

4
src/Repositories/ClientRepositoryInterface.php
View File

@ -20,11 +20,11 @@ interface ClientRepositoryInterface extends RepositoryInterface
* Get a client
*
* @param string $clientIdentifier The client's identifier
* @param string|null $clientSecret The client's secret
* @param string $clientSecret The client's secret
* @param string|null $redirectUri The client's redirect URI
* @param string|null $grantType The grant type used
*
* @return \League\OAuth2\Server\Entities\Interfaces\ClientEntityInterface
*/
public function getClientEntity($clientIdentifier, $grantType, $clientSecret = null, $redirectUri = null);
public function getClientEntity($clientIdentifier, $clientSecret, $redirectUri = null, $grantType = null);
}

9
src/Repositories/MacTokenInterface.php
View File

@ -13,7 +13,6 @@ namespace League\OAuth2\Server\Storage;
use League\OAuth2\Server\Repositories\RepositoryInterface;
/**
* MacTokenInterface
*/
@ -21,15 +20,17 @@ interface MacTokenInterface extends RepositoryInterface
{
/**
* Create a MAC key linked to an access token
* @param string $macKey
* @param string $accessToken
* @return void
*
* @param string $macKey
* @param string $accessToken
*/
public function persistMacTokenEntity($macKey, $accessToken);
/**
* Get a MAC key by access token
*
* @param string $accessToken
*
* @return string
*/
public function getMacKeyByAccessTokenString($accessToken);

4
src/Repositories/RefreshTokenRepositoryInterface.php
View File

@ -21,9 +21,9 @@ interface RefreshTokenRepositoryInterface extends RepositoryInterface
/**
* Create a new refresh token_name
*
* @param \League\OAuth2\Server\Entities\Interfaces\RefreshTokenEntityInterface $refreshTokenEntityInterface
* @param \League\OAuth2\Server\Entities\Interfaces\RefreshTokenEntityInterface $refreshTokenEntity
*/
public function persistNewRefreshToken(RefreshTokenEntityInterface $refreshTokenEntityInterface);
public function persistNewRefreshToken(RefreshTokenEntityInterface $refreshTokenEntity);
/**
* Revoke the refresh token

6
src/Repositories/ScopeRepositoryInterface.php
View File

@ -19,9 +19,9 @@ interface ScopeRepositoryInterface extends RepositoryInterface
/**
* Return information about a scope
*
* @param string $identifier The scope identifier
* @param string $grantType The grant type used in the request
* @param string $clientId The client sending the request
* @param string $identifier The scope identifier
* @param string $grantType The grant type used in the request
* @param string|null $clientId The client sending the request
*
* @return \League\OAuth2\Server\Entities\Interfaces\ScopeEntityInterface
*/

8
src/ResponseTypes/BearerTokenResponse.php
View File

@ -28,12 +28,14 @@ class BearerTokenResponse extends AbstractResponseType
*/
public function generateHttpResponse(ResponseInterface $response)
{
$expireDateTime = $this->accessToken->getExpiryDateTime()->getTimestamp();
$jwtAccessToken = (new Builder())
->setAudience($this->accessToken->getClient()->getIdentifier())
->setId($this->accessToken->getIdentifier(), true)
->setIssuedAt(time())
->setNotBefore(time())
->setExpiration($this->accessToken->getExpiryDateTime()->getTimestamp())
->setExpiration($expireDateTime)
->setSubject($this->accessToken->getUserIdentifier())
->set('scopes', $this->accessToken->getScopes())
->sign(new Sha256(), new Key($this->pathToPrivateKey))
@ -41,7 +43,7 @@ class BearerTokenResponse extends AbstractResponseType
$responseParams = [
'token_type' => 'Bearer',
'expires_in' => $this->accessToken->getExpiryDateTime()->getTimestamp() - (new \DateTime())->getTimestamp(),
'expires_in' => $expireDateTime - (new \DateTime)->getTimestamp(),
'access_token' => (string) $jwtAccessToken,
];
@ -54,7 +56,7 @@ class BearerTokenResponse extends AbstractResponseType
'access_token_id' => $this->accessToken->getIdentifier(),
'scopes' => $this->accessToken->getScopes(),
'user_id' => $this->accessToken->getUserIdentifier(),
'expire_time' => $this->refreshToken->getExpiryDateTime()->getTimestamp(),
'expire_time' => $expireDateTime,
]
),
$this->pathToPrivateKey

1
src/Server.php
View File

@ -2,7 +2,6 @@
namespace League\OAuth2\Server;
use DateInterval;
use League\Event\EmitterAwareInterface;
use League\Event\EmitterAwareTrait;
use League\OAuth2\Server\Exception\OAuthServerException;