Skip to content

Commit

Permalink
Fix doc comments and double quoted strings (#762)
Browse files Browse the repository at this point in the history 
Fixed some doc comments to make working with the project easier
in the IDE.
Also changed some strings to single quoted to prevent interpreting
backslash as escape character.
  • Loading branch information
@tmotyl @bshaffer
tmotyl authored and bshaffer committed Dec 22, 2016
1 parent c1438af commit eaf82a7
Show file tree
Hide file tree
Showing 4 changed files with 105 additions and 36 deletions.
5 changes: 5 additions & 0 deletions src/OAuth2/Controller/AuthorizeController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,11 @@ protected function buildAuthorizeParameters($request, $response, $user_id)
return $params;
}

/**
* @param RequestInterface $request
* @param ResponseInterface $response
* @return bool
*/
public function validateAuthorizeRequest(RequestInterface $request, ResponseInterface $response)
{
// Make sure a valid client id was supplied (we can not redirect because we were unable to verify the URI)
Expand Down
35 changes: 26 additions & 9 deletions src/OAuth2/Controller/TokenController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,33 @@
use OAuth2\ResponseInterface;

/**
* @see OAuth2\Controller\TokenControllerInterface
* @see \OAuth2\Controller\TokenControllerInterface
*/
class TokenController implements TokenControllerInterface
{
/**
* @var AccessTokenInterface
*/
protected $accessToken;

/**
* @var array
*/
protected $grantTypes;

/**
* @var ClientAssertionTypeInterface
*/
protected $clientAssertionType;

/**
* @var Scope|ScopeInterface
*/
protected $scopeUtil;

/**
* @var ClientInterface
*/
protected $clientStorage;

public function __construct(AccessTokenInterface $accessToken, ClientInterface $clientStorage, array $grantTypes = array(), ClientAssertionTypeInterface $clientAssertionType = null, ScopeInterface $scopeUtil = null)
Expand Down Expand Up @@ -64,11 +83,11 @@ public function handleTokenRequest(RequestInterface $request, ResponseInterface
* This would be called from the "/token" endpoint as defined in the spec.
* You can call your endpoint whatever you want.
*
* @param $request - RequestInterface
* Request object to grant access token
* @param RequestInterface $request Request object to grant access token
* @param ResponseInterface $response
*
* @throws InvalidArgumentException
* @throws LogicException
* @throws \InvalidArgumentException
* @throws \LogicException
*
* @see http://tools.ietf.org/html/rfc6749#section-4
* @see http://tools.ietf.org/html/rfc6749#section-10.6
Expand Down Expand Up @@ -208,10 +227,8 @@ public function grantAccessToken(RequestInterface $request, ResponseInterface $r
/**
* addGrantType
*
* @param grantType - OAuth2\GrantTypeInterface
* the grant type to add for the specified identifier
* @param identifier - string
* a string passed in as "grant_type" in the response that will call this grantType
* @param GrantTypeInterface $grantType the grant type to add for the specified identifier
* @param string $identifier a string passed in as "grant_type" in the response that will call this grantType
*/
public function addGrantType(GrantTypeInterface $grantType, $identifier = null)
{
Expand Down
2 changes: 1 addition & 1 deletion src/OAuth2/GrantType/AuthorizationCode.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class AuthorizationCode implements GrantTypeInterface
protected $authCode;

/**
* @param OAuth2\Storage\AuthorizationCodeInterface $storage REQUIRED Storage class for retrieving authorization code information
* @param \OAuth2\Storage\AuthorizationCodeInterface $storage REQUIRED Storage class for retrieving authorization code information
*/
public function __construct(AuthorizationCodeInterface $storage)
{
Expand Down
99 changes: 73 additions & 26 deletions src/OAuth2/Server.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,20 +47,50 @@ class Server implements ResourceControllerInterface,
UserInfoControllerInterface
{
// misc properties
/**
* @var Response
*/
protected $response;

/**
* @var array
*/
protected $config;

/**
* @var array
*/
protected $storages;

// servers
/**
* @var AuthorizeControllerInterface
*/
protected $authorizeController;

/**
* @var TokenControllerInterface
*/
protected $tokenController;

/**
* @var ResourceControllerInterface
*/
protected $resourceController;

/**
* @var UserInfoControllerInterface
*/
protected $userInfoController;

// config classes
protected $grantTypes;
protected $responseTypes;
protected $tokenType;

/**
* @var ScopeInterface
*/
protected $scopeUtil;
protected $clientAssertionType;

Expand Down Expand Up @@ -92,9 +122,9 @@ class Server implements ResourceControllerInterface,
* @param array $grantTypes An array of OAuth2\GrantType\GrantTypeInterface to use for granting access tokens
* @param array $responseTypes Response types to use. array keys should be "code" and and "token" for
* Access Token and Authorization Code response types
* @param OAuth2\TokenType\TokenTypeInterface $tokenType The token type object to use. Valid token types are "bearer" and "mac"
* @param OAuth2\ScopeInterface $scopeUtil The scope utility class to use to validate scope
* @param OAuth2\ClientAssertionType\ClientAssertionTypeInterface $clientAssertionType The method in which to verify the client identity. Default is HttpBasic
* @param \OAuth2\TokenType\TokenTypeInterface $tokenType The token type object to use. Valid token types are "bearer" and "mac"
* @param \OAuth2\ScopeInterface $scopeUtil The scope utility class to use to validate scope
* @param \OAuth2\ClientAssertionType\ClientAssertionTypeInterface $clientAssertionType The method in which to verify the client identity. Default is HttpBasic
*
* @ingroup oauth2_section_7
*/
Expand Down Expand Up @@ -180,6 +210,8 @@ public function getUserInfoController()

/**
* every getter deserves a setter
*
* @param AuthorizeControllerInterface $authorizeController
*/
public function setAuthorizeController(AuthorizeControllerInterface $authorizeController)
{
Expand All @@ -188,6 +220,8 @@ public function setAuthorizeController(AuthorizeControllerInterface $authorizeCo

/**
* every getter deserves a setter
*
* @param TokenControllerInterface $tokenController
*/
public function setTokenController(TokenControllerInterface $tokenController)
{
Expand All @@ -196,6 +230,8 @@ public function setTokenController(TokenControllerInterface $tokenController)

/**
* every getter deserves a setter
*
* @param ResourceControllerInterface $resourceController
*/
public function setResourceController(ResourceControllerInterface $resourceController)
{
Expand All @@ -204,6 +240,8 @@ public function setResourceController(ResourceControllerInterface $resourceContr

/**
* every getter deserves a setter
*
* @param UserInfoControllerInterface $userInfoController
*/
public function setUserInfoController(UserInfoControllerInterface $userInfoController)
{
Expand All @@ -214,14 +252,16 @@ public function setUserInfoController(UserInfoControllerInterface $userInfoContr
* Return claims about the authenticated end-user.
* This would be called from the "/UserInfo" endpoint as defined in the spec.
*
* @param $request - OAuth2\RequestInterface
* @param $request - \OAuth2\RequestInterface
* Request object to grant access token
*
* @param $response - OAuth2\ResponseInterface
* @param $response - \OAuth2\ResponseInterface
* Response object containing error messages (failure) or user claims (success)
*
* @throws InvalidArgumentException
* @throws LogicException
* @return ResponseInterface
*
* @throws \InvalidArgumentException
* @throws \LogicException
*
* @see http://openid.net/specs/openid-connect-core-1_0.html#UserInfo
*/
Expand All @@ -238,14 +278,16 @@ public function handleUserInfoRequest(RequestInterface $request, ResponseInterfa
* This would be called from the "/token" endpoint as defined in the spec.
* Obviously, you can call your endpoint whatever you want.
*
* @param $request - OAuth2\RequestInterface
* @param $request - \OAuth2\RequestInterface
* Request object to grant access token
*
* @param $response - OAuth2\ResponseInterface
* @param $response - \OAuth2\ResponseInterface
* Response object containing error messages (failure) or access token (success)
*
* @throws InvalidArgumentException
* @throws LogicException
* @return ResponseInterface
*
* @throws \InvalidArgumentException
* @throws \LogicException
*
* @see http://tools.ietf.org/html/rfc6749#section-4
* @see http://tools.ietf.org/html/rfc6749#section-10.6
Expand Down Expand Up @@ -306,11 +348,14 @@ public function handleRevokeRequest(RequestInterface $request, ResponseInterface
* list of space-delimited strings.
* - state: (optional) An opaque value used by the client to maintain
* state between the request and callback.
* @param ResponseInterface $response
* @param $is_authorized
* TRUE or FALSE depending on whether the user authorized the access.
* @param $user_id
* Identifier of user who authorized the client
*
* @return Response
*
* @see http://tools.ietf.org/html/rfc6749#section-4
*
* @ingroup oauth2_section_4
Expand Down Expand Up @@ -464,6 +509,8 @@ public function getScopeUtil()

/**
* every getter deserves a setter
*
* @param ScopeInterface $scopeUtil
*/
public function setScopeUtil($scopeUtil)
{
Expand All @@ -473,7 +520,7 @@ public function setScopeUtil($scopeUtil)
protected function createDefaultAuthorizeController()
{
if (!isset($this->storages['client'])) {
throw new \LogicException("You must supply a storage object implementing OAuth2\Storage\ClientInterface to use the authorize server");
throw new \LogicException('You must supply a storage object implementing \OAuth2\Storage\ClientInterface to use the authorize server');
}
if (0 == count($this->responseTypes)) {
$this->responseTypes = $this->getDefaultResponseTypes();
Expand Down Expand Up @@ -505,7 +552,7 @@ protected function createDefaultTokenController()
foreach ($this->grantTypes as $grantType) {
if (!$grantType instanceof ClientAssertionTypeInterface) {
if (!isset($this->storages['client_credentials'])) {
throw new \LogicException("You must supply a storage object implementing OAuth2\Storage\ClientCredentialsInterface to use the token server");
throw new \LogicException('You must supply a storage object implementing OAuth2\Storage\ClientCredentialsInterface to use the token server');
}
$config = array_intersect_key($this->config, array_flip(explode(' ', 'allow_credentials_in_request_body allow_public_clients')));
$this->clientAssertionType = new HttpBasic($this->storages['client_credentials'], $config);
Expand All @@ -515,7 +562,7 @@ protected function createDefaultTokenController()
}

if (!isset($this->storages['client'])) {
throw new \LogicException("You must supply a storage object implementing OAuth2\Storage\ClientInterface to use the token server");
throw new \LogicException('You must supply a storage object implementing OAuth2\Storage\ClientInterface to use the token server');
}

$accessTokenResponseType = $this->getAccessTokenResponseType();
Expand All @@ -531,7 +578,7 @@ protected function createDefaultResourceController()
$this->storages['access_token'] = $this->createDefaultJwtAccessTokenStorage();
}
} elseif (!isset($this->storages['access_token'])) {
throw new \LogicException("You must supply a storage object implementing OAuth2\Storage\AccessTokenInterface or use JwtAccessTokens to use the resource server");
throw new \LogicException('You must supply a storage object implementing OAuth2\Storage\AccessTokenInterface or use JwtAccessTokens to use the resource server');
}

if (!$this->tokenType) {
Expand All @@ -551,11 +598,11 @@ protected function createDefaultUserInfoController()
$this->storages['access_token'] = $this->createDefaultJwtAccessTokenStorage();
}
} elseif (!isset($this->storages['access_token'])) {
throw new \LogicException("You must supply a storage object implementing OAuth2\Storage\AccessTokenInterface or use JwtAccessTokens to use the UserInfo server");
throw new \LogicException('You must supply a storage object implementing OAuth2\Storage\AccessTokenInterface or use JwtAccessTokens to use the UserInfo server');
}

if (!isset($this->storages['user_claims'])) {
throw new \LogicException("You must supply a storage object implementing OAuth2\OpenID\Storage\UserClaimsInterface to use the UserInfo server");
throw new \LogicException('You must supply a storage object implementing OAuth2\OpenID\Storage\UserClaimsInterface to use the UserInfo server');
}

if (!$this->tokenType) {
Expand Down Expand Up @@ -593,7 +640,7 @@ protected function getDefaultResponseTypes()
$config = array_intersect_key($this->config, array_flip(explode(' ', 'enforce_redirect auth_code_lifetime')));
if ($this->config['use_openid_connect']) {
if (!$this->storages['authorization_code'] instanceof OpenIDAuthorizationCodeInterface) {
throw new \LogicException("Your authorization_code storage must implement OAuth2\OpenID\Storage\AuthorizationCodeInterface to work when 'use_openid_connect' is true");
throw new \LogicException('Your authorization_code storage must implement OAuth2\OpenID\Storage\AuthorizationCodeInterface to work when "use_openid_connect" is true');
}
$responseTypes['code'] = new OpenIDAuthorizationCodeResponseType($this->storages['authorization_code'], $config);
$responseTypes['code id_token'] = new CodeIdToken($responseTypes['code'], $responseTypes['id_token']);
Expand All @@ -603,7 +650,7 @@ protected function getDefaultResponseTypes()
}

if (count($responseTypes) == 0) {
throw new \LogicException("You must supply an array of response_types in the constructor or implement a OAuth2\Storage\AuthorizationCodeInterface storage object or set 'allow_implicit' to true and implement a OAuth2\Storage\AccessTokenInterface storage object");
throw new \LogicException('You must supply an array of response_types in the constructor or implement a OAuth2\Storage\AuthorizationCodeInterface storage object or set "allow_implicit" to true and implement a OAuth2\Storage\AccessTokenInterface storage object');
}

return $responseTypes;
Expand All @@ -630,7 +677,7 @@ protected function getDefaultGrantTypes()
if (isset($this->storages['authorization_code'])) {
if ($this->config['use_openid_connect']) {
if (!$this->storages['authorization_code'] instanceof OpenIDAuthorizationCodeInterface) {
throw new \LogicException("Your authorization_code storage must implement OAuth2\OpenID\Storage\AuthorizationCodeInterface to work when 'use_openid_connect' is true");
throw new \LogicException('Your authorization_code storage must implement OAuth2\OpenID\Storage\AuthorizationCodeInterface to work when "use_openid_connect" is true');
}
$grantTypes['authorization_code'] = new OpenIDAuthorizationCodeGrantType($this->storages['authorization_code']);
} else {
Expand All @@ -639,7 +686,7 @@ protected function getDefaultGrantTypes()
}

if (count($grantTypes) == 0) {
throw new \LogicException("Unable to build default grant types - You must supply an array of grant_types in the constructor");
throw new \LogicException('Unable to build default grant types - You must supply an array of grant_types in the constructor');
}

return $grantTypes;
Expand Down Expand Up @@ -682,7 +729,7 @@ protected function getIdTokenTokenResponseType()
protected function createDefaultJwtAccessTokenStorage()
{
if (!isset($this->storages['public_key'])) {
throw new \LogicException("You must supply a storage object implementing OAuth2\Storage\PublicKeyInterface to use crypto tokens");
throw new \LogicException('You must supply a storage object implementing OAuth2\Storage\PublicKeyInterface to use crypto tokens');
}
$tokenStorage = null;
if (!empty($this->config['store_encrypted_token_string']) && isset($this->storages['access_token'])) {
Expand All @@ -698,7 +745,7 @@ protected function createDefaultJwtAccessTokenStorage()
protected function createDefaultJwtAccessTokenResponseType()
{
if (!isset($this->storages['public_key'])) {
throw new \LogicException("You must supply a storage object implementing OAuth2\Storage\PublicKeyInterface to use crypto tokens");
throw new \LogicException('You must supply a storage object implementing OAuth2\Storage\PublicKeyInterface to use crypto tokens');
}

$tokenStorage = null;
Expand All @@ -719,7 +766,7 @@ protected function createDefaultJwtAccessTokenResponseType()
protected function createDefaultAccessTokenResponseType()
{
if (!isset($this->storages['access_token'])) {
throw new \LogicException("You must supply a response type implementing OAuth2\ResponseType\AccessTokenInterface, or a storage object implementing OAuth2\Storage\AccessTokenInterface to use the token server");
throw new \LogicException('You must supply a response type implementing OAuth2\ResponseType\AccessTokenInterface, or a storage object implementing OAuth2\Storage\AccessTokenInterface to use the token server');
}

$refreshStorage = null;
Expand All @@ -736,10 +783,10 @@ protected function createDefaultAccessTokenResponseType()
protected function createDefaultIdTokenResponseType()
{
if (!isset($this->storages['user_claims'])) {
throw new \LogicException("You must supply a storage object implementing OAuth2\OpenID\Storage\UserClaimsInterface to use openid connect");
throw new \LogicException('You must supply a storage object implementing OAuth2\OpenID\Storage\UserClaimsInterface to use openid connect');
}
if (!isset($this->storages['public_key'])) {
throw new \LogicException("You must supply a storage object implementing OAuth2\Storage\PublicKeyInterface to use openid connect");
throw new \LogicException('You must supply a storage object implementing OAuth2\Storage\PublicKeyInterface to use openid connect');
}

$config = array_intersect_key($this->config, array_flip(explode(' ', 'issuer id_lifetime')));
Expand Down

0 comments on commit eaf82a7

Please sign in to comment.