*/ class AuthorizationCode implements GrantTypeInterface { /** * @var AuthorizationCodeInterface */ protected $storage; /** * @var array */ protected $authCode; /** * @param AuthorizationCodeInterface $storage - REQUIRED Storage class for retrieving authorization code information */ public function __construct(AuthorizationCodeInterface $storage) { $this->storage = $storage; } /** * @return string */ public function getQueryStringIdentifier() { return 'authorization_code'; } /** * Validate the OAuth request * * @param RequestInterface $request * @param ResponseInterface $response * @return bool * @throws Exception */ public function validateRequest(RequestInterface $request, ResponseInterface $response) { if (!$request->request('code')) { $response->setError(400, 'invalid_request', 'Missing parameter: "code" is required'); return false; } $code = $request->request('code'); if (!$authCode = $this->storage->getAuthorizationCode($code)) { $response->setError(400, 'invalid_grant', 'Authorization code doesn\'t exist or is invalid for the client'); return false; } /* * 4.1.3 - ensure that the "redirect_uri" parameter is present if the "redirect_uri" parameter was included in the initial authorization request * @uri - http://tools.ietf.org/html/rfc6749#section-4.1.3 */ if (isset($authCode['redirect_uri']) && $authCode['redirect_uri']) { if (!$request->request('redirect_uri') || urldecode($request->request('redirect_uri')) != urldecode($authCode['redirect_uri'])) { $response->setError(400, 'redirect_uri_mismatch', "The redirect URI is missing or do not match", "#section-4.1.3"); return false; } } if (!isset($authCode['expires'])) { throw new \Exception('Storage must return authcode with a value for "expires"'); } if ($authCode["expires"] < time()) { $response->setError(400, 'invalid_grant', "The authorization code has expired"); return false; } if (isset($authCode['code_challenge']) && $authCode['code_challenge']) { if (!($code_verifier = $request->request('code_verifier'))) { $response->setError(400, 'code_verifier_missing', "The PKCE code verifier parameter is required."); return false; } // Validate code_verifier according to RFC-7636 // @see: https://tools.ietf.org/html/rfc7636#section-4.1 if (preg_match('/^[A-Za-z0-9-._~]{43,128}$/', $code_verifier) !== 1) { $response->setError(400, 'code_verifier_invalid', "The PKCE code verifier parameter is invalid."); return false; } $code_verifier = $request->request('code_verifier'); switch ($authCode['code_challenge_method']) { case 'S256': $code_verifier_hashed = strtr(rtrim(base64_encode(hash('sha256', $code_verifier, true)), '='), '+/', '-_'); break; case 'plain': $code_verifier_hashed = $code_verifier; break; default: $response->setError(400, 'code_challenge_method_invalid', "Unknown PKCE code challenge method."); return FALSE; } if ($code_verifier_hashed !== $authCode['code_challenge']) { $response->setError(400, 'code_verifier_mismatch', "The PKCE code verifier parameter does not match the code challenge."); return FALSE; } } if (!isset($authCode['code'])) { $authCode['code'] = $code; // used to expire the code after the access token is granted } $this->authCode = $authCode; return true; } /** * Get the client id * * @return mixed */ public function getClientId() { return $this->authCode['client_id']; } /** * Get the scope * * @return string */ public function getScope() { return isset($this->authCode['scope']) ? $this->authCode['scope'] : null; } /** * Get the user id * * @return mixed */ public function getUserId() { return isset($this->authCode['user_id']) ? $this->authCode['user_id'] : null; } /** * Create access token * * @param AccessTokenInterface $accessToken * @param mixed $client_id - client identifier related to the access token. * @param mixed $user_id - user id associated with the access token * @param string $scope - scopes to be stored in space-separated string. * @return array */ public function createAccessToken(AccessTokenInterface $accessToken, $client_id, $user_id, $scope) { $token = $accessToken->createAccessToken($client_id, $user_id, $scope); $this->storage->expireAuthorizationCode($this->authCode['code']); return $token; } }