oauth2-server/src/OAuth2/Grant/AuthCode.php

148 lines
4.4 KiB
PHP
Raw Normal View History

2013-02-01 10:50:32 +00:00
<?php
2013-02-13 19:36:56 +00:00
/**
* OAuth 2.0 Auth code grant
*
* @package lncd/oauth2
* @author Alex Bilbie <hello@alexbilbie.com>
* @copyright Copyright (c) 2013 University of Lincoln
* @license http://mit-license.org/
* @link http://github.com/lncd/oauth2
*/
2013-02-01 10:50:32 +00:00
2013-02-01 14:41:52 +00:00
namespace OAuth2\Grant;
2013-02-01 10:50:32 +00:00
2013-02-01 14:41:52 +00:00
use OAuth2\Request;
use OAuth2\AuthServer;
2013-02-01 10:50:32 +00:00
use OAuth2\Exception;
2013-02-01 14:41:52 +00:00
use OAuth2\Util\SecureKey;
use OAuth2\Storage\SessionInterface;
use OAuth2\Storage\ClientInterface;
use OAuth2\Storage\ScopeInterface;
2013-02-01 10:50:32 +00:00
2013-02-13 19:36:56 +00:00
/**
* Auth code grant class
*/
2013-02-01 10:50:32 +00:00
class AuthCode implements GrantTypeInterface {
2013-02-13 19:36:56 +00:00
/**
* Grant identifier
* @var string
*/
2013-02-01 14:41:52 +00:00
protected $identifier = 'authorization_code';
2013-02-13 19:36:56 +00:00
/**
* Response type
* @var string
*/
2013-02-01 10:50:32 +00:00
protected $responseType = 'code';
/**
* AuthServer instance
* @var AuthServer
*/
protected $authServer = null;
/**
* Constructor
* @param AuthServer $authServer AuthServer instance
* @return void
*/
public function __construct(AuthServer $authServer)
{
$this->authServer = $authServer;
}
2013-02-13 19:36:56 +00:00
/**
* Return the identifier
* @return string
*/
2013-02-01 10:50:32 +00:00
public function getIdentifier()
{
return $this->identifier;
}
2013-02-13 19:36:56 +00:00
/**
* Return the response type
* @return string
*/
2013-02-01 10:50:32 +00:00
public function getResponseType()
{
return $this->responseType;
}
2013-02-13 19:36:56 +00:00
/**
* Complete the auth code grant
* @param null|array $inputParams
* @return array
*/
public function completeFlow($inputParams = null)
2013-02-01 10:50:32 +00:00
{
2013-02-13 19:36:56 +00:00
// Get the required params
$authParams = $this->authServer->getParam(array('client_id', 'client_secret', 'redirect_uri', 'code'), 'post', $inputParams);
2013-02-01 10:50:32 +00:00
2013-02-13 19:36:56 +00:00
if (is_null($authParams['client_id'])) {
throw new Exception\ClientException(sprintf($this->authServer->getExceptionMessage('invalid_request'), 'client_id'), 0);
2013-02-01 14:41:52 +00:00
}
2013-02-01 10:50:32 +00:00
2013-02-01 14:41:52 +00:00
if (is_null($authParams['client_secret'])) {
throw new Exception\ClientException(sprintf($this->authServer->getExceptionMessage('invalid_request'), 'client_secret'), 0);
2013-02-01 14:41:52 +00:00
}
2013-02-01 10:50:32 +00:00
2013-02-01 14:41:52 +00:00
if (is_null($authParams['redirect_uri'])) {
throw new Exception\ClientException(sprintf($this->authServer->getExceptionMessage('invalid_request'), 'redirect_uri'), 0);
2013-02-01 14:41:52 +00:00
}
2013-02-01 10:50:32 +00:00
// Validate client ID and redirect URI
$clientDetails = $this->authServer->getStorage('client')->getClient($authParams['client_id'], $authParams['client_secret'], $authParams['redirect_uri'], $this->identifier);
2013-02-01 10:50:32 +00:00
if ($clientDetails === false) {
throw new Exception\ClientException($this->authServer->getExceptionMessage('invalid_client'), 8);
2013-02-01 10:50:32 +00:00
}
2013-02-01 14:41:52 +00:00
$authParams['client_details'] = $clientDetails;
// Validate the authorization code
2013-02-01 14:41:52 +00:00
if (is_null($authParams['code'])) {
throw new Exception\ClientException(sprintf($this->authServer->getExceptionMessage('invalid_request'), 'code'), 0);
2013-02-01 14:41:52 +00:00
}
2013-02-01 10:50:32 +00:00
// Verify the authorization code matches the client_id and the request_uri
$session = $this->authServer->getStorage('session')->validateAuthCode($authParams['client_id'], $authParams['redirect_uri'], $authParams['code']);
2013-02-01 10:50:32 +00:00
if ( ! $session) {
throw new Exception\ClientException(sprintf($this->authServer->getExceptionMessage('invalid_grant'), 'code'), 9);
2013-02-01 10:50:32 +00:00
}
// A session ID was returned so update it with an access token,
// remove the authorisation code, change the stage to 'granted'
2013-02-01 14:41:52 +00:00
$accessToken = SecureKey::make();
$refreshToken = ($this->authServer->hasGrantType('refresh_token')) ? SecureKey::make() : null;
2013-02-01 10:50:32 +00:00
$accessTokenExpires = time() + $this->authServer->getExpiresIn();
$accessTokenExpiresIn = $this->authServer->getExpiresIn();
2013-02-01 10:50:32 +00:00
$this->authServer->getStorage('session')->updateSession(
2013-02-01 10:50:32 +00:00
$session['id'],
null,
$accessToken,
$refreshToken,
$accessTokenExpires,
'granted'
);
$response = array(
'access_token' => $accessToken,
'token_type' => 'bearer',
'expires' => $accessTokenExpires,
'expires_in' => $accessTokenExpiresIn
);
if ($this->authServer->hasGrantType('refresh_token')) {
2013-02-01 10:50:32 +00:00
$response['refresh_token'] = $refreshToken;
}
return $response;
}
}