Skip to content
This repository has been archived by the owner on Jan 21, 2020. It is now read-only.

add oauth2 response format #72

Merged
merged 4 commits into from
Mar 30, 2015
Merged

add oauth2 response format #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2899962
add oauth2 response format
Jan 7, 2015
4f709eb
add api_problem_error_response config for test
Jan 7, 2015
548bff1
support for windows
Jan 7, 2015
0172f2f
undo support for windows
Jan 7, 2015
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
2 changes: 2 additions & 0 deletions config/module.config.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@
* // see https://github.com/bshaffer/oauth2-server-php/blob/develop/src/OAuth2/Storage/Pdo.php#L57-L66
* ]
*/
'api_problem_error_response' => true, // if true, client errors is returned in application/problem+json content type,
// otherwise in format from oauth2 specification (default: true)
),
'zf-content-negotiation' => array(
'ZF\OAuth2\Controller\Auth' => array(
Expand Down
114 changes: 70 additions & 44 deletions src/Controller/AuthController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ class AuthController extends AbstractActionController
*/
protected $server;

/**
* @var boolean
*/
protected $apiProblemErrorResponse = true;

/**
* Constructor
*
Expand All @@ -33,6 +38,22 @@ public function __construct(OAuth2Server $server)
$this->server = $server;
}

/**
* @return boolean
*/
public function isApiProblemErrorResponse()
{
return $this->apiProblemErrorResponse;
}

/**
* @param boolean $apiProblemErrorResponse
*/
public function setApiProblemErrorResponse($apiProblemErrorResponse)
{
$this->apiProblemErrorResponse = $apiProblemErrorResponse;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Convert incoming variable to (bool)

}

/**
* Token Action (/oauth)
*/
Expand All @@ -52,21 +73,11 @@ public function tokenAction()

$oauth2request = $this->getOAuth2Request();
$response = $this->server->handleTokenRequest($oauth2request);

if ($response->isClientError()) {
$parameters = $response->getParameters();
$errorUri = isset($parameters['error_uri']) ? $parameters['error_uri'] : null;
$error = isset($parameters['error']) ? $parameters['error'] : null;
$errorDescription = isset($parameters['error_description']) ? $parameters['error_description'] : null;

return new ApiProblemResponse(
new ApiProblem(
$response->getStatusCode(),
$errorDescription,
$errorUri,
$error
)
);
return $this->getErrorResponse($response);
}

return $this->setHttpResponse($response);
}

Expand All @@ -78,17 +89,9 @@ public function resourceAction()
// Handle a request for an OAuth2.0 Access Token and send the response to the client
if (!$this->server->verifyResourceRequest($this->getOAuth2Request())) {
$response = $this->server->getResponse();
$parameters = $response->getParameters();
$errorUri = isset($parameters['error_uri']) ? $parameters['error_uri'] : null;
return new ApiProblemResponse(
new ApiProblem(
$response->getStatusCode(),
$parameters['error_description'],
$errorUri,
$parameters['error']
)
);
return $this->getApiProblemResponse($response);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be $this->getErrorResponse($response);?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Never mind; this particular problem is not handled by the oauth2 spec, so it can and should be in a different format.

}

$httpResponse = $this->getResponse();
$httpResponse->setStatusCode(200);
$httpResponse->getHeaders()->addHeaders(array('Content-type' => 'application/json'));
Expand All @@ -107,17 +110,10 @@ public function authorizeAction()
$response = new OAuth2Response();

// validate the authorize request
if (!$this->server->validateAuthorizeRequest($request, $response)) {
$parameters = $response->getParameters();
$errorUri = isset($parameters['error_uri']) ? $parameters['error_uri'] : null;
return new ApiProblemResponse(
new ApiProblem(
$response->getStatusCode(),
$parameters['error_description'],
$errorUri,
$parameters['error']
)
);
$isValid = $this->server->validateAuthorizeRequest($request, $response);

if (!$isValid) {
return $this->getErrorResponse($response);
}

$authorized = $request->request('authorized', false);
Expand All @@ -141,16 +137,7 @@ public function authorizeAction()
return $this->redirect()->toUrl($redirect);
}

$parameters = $response->getParameters();
$errorUri = isset($parameters['error_uri']) ? $parameters['error_uri'] : null;
return new ApiProblemResponse(
new ApiProblem(
$response->getStatusCode(),
$parameters['error_description'],
$errorUri,
$parameters['error']
)
);
return $this->getErrorResponse($response);
}

/**
Expand All @@ -166,6 +153,42 @@ public function receiveCodeAction()
return $view;
}

/**
* @param OAuth2Response $response
* @return \ZF\ApiProblem\ApiProblemResponse|\Zend\Stdlib\ResponseInterface
*/
protected function getErrorResponse(OAuth2Response $response)
{
if ($this->isApiProblemErrorResponse()) {
return $this->getApiProblemResponse($response);
} else {
return $this->setHttpResponse($response);
}
}

/**
* Map OAuth2Response to ApiProblemResponse
*
* @param OAuth2Response $response
* @return ApiProblemResponse
*/
protected function getApiProblemResponse(OAuth2Response $response)
{
$parameters = $response->getParameters();
$errorUri = isset($parameters['error_uri']) ? $parameters['error_uri'] : null;
$error = isset($parameters['error']) ? $parameters['error'] : null;
$errorDescription = isset($parameters['error_description']) ? $parameters['error_description'] : null;

return new ApiProblemResponse(
new ApiProblem(
$response->getStatusCode(),
$errorDescription,
$errorUri,
$error
)
);
}

/**
* Create an OAuth2 request based on the ZF2 request object
*
Expand Down Expand Up @@ -210,6 +233,9 @@ protected function getOAuth2Request()
if (isset($server['PHP_AUTH_PW'])) {
$headers['PHP_AUTH_PW'] = $server['PHP_AUTH_PW'];
}
if (isset($server['HTTP_AUTHORIZATION'])) {
$headers['AUTHORIZATION'] = $server['HTTP_AUTHORIZATION'];
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The above is not necessary, as the ZF2 request already ensures we have the authorization header present.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our code doesn't work without this check.


// Ensure the bodyParams are passed as an array
$bodyParams = $this->bodyParams() ?: array();
Expand Down
10 changes: 9 additions & 1 deletion src/Factory/AuthControllerFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ class AuthControllerFactory implements FactoryInterface
public function createService(ServiceLocatorInterface $controllers)
{
$services = $controllers->getServiceLocator()->get('ServiceManager');
return new AuthController($services->get('ZF\OAuth2\Service\OAuth2Server'));
$authController = new AuthController($services->get('ZF\OAuth2\Service\OAuth2Server'));

$config = $services->get('Config');
$apiProblemErrorResponse = isset($config['zf-oauth2']['api_problem_error_response'])
&& $config['zf-oauth2']['api_problem_error_response'] === true;

$authController->setApiProblemErrorResponse($apiProblemErrorResponse);

return $authController;
}
}
77 changes: 76 additions & 1 deletion test/Controller/AuthControllerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,51 @@ public function testToken()
$this->assertTrue(!empty($response['token_type']));
}

public function testTokenErrorIsApiProblem()
{
$request = $this->getRequest();
$request->getPost()->set('grant_type', 'fake_grant_type');
$request->getServer()->set('PHP_AUTH_USER', 'testclient');
$request->getServer()->set('PHP_AUTH_PW', 'testpass');
$request->setMethod('POST');

$this->dispatch('/oauth');
$this->assertControllerName('ZF\OAuth2\Controller\Auth');
$this->assertActionName('token');
$this->assertResponseStatusCode(400);

$headers = $this->getResponse()->getHeaders();
$this->assertEquals('application/problem+json', $headers->get('content-type')->getFieldValue());

$response = json_decode($this->getResponse()->getContent(), true);
$this->assertEquals('unsupported_grant_type', $response['title']);
$this->assertEquals('Grant type "fake_grant_type" not supported', $response['detail']);
$this->assertEquals('400', $response['status']);
}

public function testTokenErrorIsOAuth2Format()
{
$request = $this->getRequest();
$request->getPost()->set('grant_type', 'fake_grant_type');
$request->getServer()->set('PHP_AUTH_USER', 'testclient');
$request->getServer()->set('PHP_AUTH_PW', 'testpass');
$request->setMethod('POST');

$this->setIsOAuth2FormatResponse();

$this->dispatch('/oauth');
$this->assertControllerName('ZF\OAuth2\Controller\Auth');
$this->assertActionName('token');
$this->assertResponseStatusCode(400);

$headers = $this->getResponse()->getHeaders();
$this->assertEquals('application/json', $headers->get('content-type')->getFieldValue());

$response = json_decode($this->getResponse()->getContent(), true);
$this->assertEquals('unsupported_grant_type', $response['error']);
$this->assertEquals('Grant type "fake_grant_type" not supported', $response['error_description']);
}

public function testAuthorizeForm()
{
$_GET['response_type'] = 'code';
Expand All @@ -59,7 +104,7 @@ public function testAuthorizeForm()
$this->assertXpathQuery('//form/input[@name="authorized" and @value="no"]');
}

public function testAuthorizeErrorParam()
public function testAuthorizeParamErrorIsApiProblem()
{
$this->dispatch('/oauth/authorize');

Expand All @@ -76,6 +121,24 @@ public function testAuthorizeErrorParam()
$this->assertEquals('400', $response['status']);
}

public function testAuthorizeParamErrorIsOAuth2Format()
{
$this->setIsOAuth2FormatResponse();

$this->dispatch('/oauth/authorize');

$this->assertControllerName('ZF\OAuth2\Controller\Auth');
$this->assertActionName('authorize');
$this->assertResponseStatusCode(400);

$headers = $this->getResponse()->getHeaders();
$this->assertEquals('application/json', $headers->get('content-type')->getFieldValue());

$response = json_decode($this->getResponse()->getContent(), true);
$this->assertEquals('invalid_client', $response['error']);
$this->assertEquals('No client id supplied', $response['error_description']);
}

public function testAuthorizeCode()
{
$_GET['response_type'] = 'code';
Expand Down Expand Up @@ -174,6 +237,7 @@ public function testResource()
$this->assertResponseStatusCode(200);

$response = json_decode($this->getResponse()->getContent(), true);

$this->assertTrue($response['success']);
$this->assertEquals('You accessed my APIs!', $response['message']);

Expand All @@ -191,4 +255,15 @@ public function testResource()
$this->assertTrue($response['success']);
$this->assertEquals('You accessed my APIs!', $response['message']);
}

protected function setIsOAuth2FormatResponse()
{
$serviceManager = $this->getApplication()->getServiceManager();

$config = $serviceManager->get('Config');
$config['zf-oauth2']['api_problem_error_response'] = false;

$serviceManager->setAllowOverride(true);
$serviceManager->setService('Config', $config);
}
}
6 changes: 6 additions & 0 deletions test/Factory/AuthControllerFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ protected function setUp()

$this->services = $services = new ServiceManager();

$this->services->setService('Config', array(
'zf-oauth2' => array(
'api_problem_error_response' => true,
),
));

$this->controllers = $controllers = new ControllerManager();
$controllers->setServiceLocator(new ServiceManager());
$controllers->getServiceLocator()->setService('ServiceManager', $services);
Expand Down