chillerlan / php-oauth-core

src/Core/CSRFToken.php

Spacing +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
  *
  * @link https://tools.ietf.org/html/rfc6749#section-10.12
  */
-interface CSRFToken{
+interface CSRFToken {
 
 	/**
 	 * Checks whether the CSRF state was set and verifies against the last known state.

src/Core/OAuth1Provider.php

Braces +2 added lines, -4 removed lines

@@ -83,11 +83,9 @@
 
 		if(empty($data)){
 			throw new ProviderException('unable to parse token response');
-		}
-		elseif(isset($data['error'])){
+		} elseif(isset($data['error'])){
 			throw new ProviderException('error retrieving access token: '.$data['error']);
-		}
-		elseif(!isset($data['oauth_token']) || !isset($data['oauth_token_secret'])){
+		} elseif(!isset($data['oauth_token']) || !isset($data['oauth_token_secret'])){
 			throw new ProviderException('invalid token');
 		}
 

Spacing +10 added lines, -10 removed lines

@@ -28,7 +28,7 @@ 
 /**
  * Implements an abstract OAuth1 provider with all methods required by the OAuth1Interface.
  */
-abstract class OAuth1Provider extends OAuthProvider implements OAuth1Interface{
+abstract class OAuth1Provider extends OAuthProvider implements OAuth1Interface {
 
 	/**
 	 * The request OAuth1 token URL
@@ -67,7 +67,7 @@ 
 			->withHeader('Content-Length', '0') // tumblr requires a content-length header set
 		;
 
-		foreach($this->authHeaders as $header => $value){
+		foreach ($this->authHeaders as $header => $value) {
 			$request = $request->withAddedHeader($header, $value);
 		}
 
@@ -84,20 +84,20 @@ 
 	protected function parseTokenResponse(ResponseInterface $response, bool $checkCallbackConfirmed = null):AccessToken{
 		$data = QueryUtil::parse(MessageUtil::decompress($response));
 
-		if(empty($data)){
+		if (empty($data)) {
 			throw new ProviderException('unable to parse token response');
 		}
-		elseif(isset($data['error'])){
+		elseif (isset($data['error'])) {
 			throw new ProviderException('error retrieving access token: '.$data['error']);
 		}
-		elseif(!isset($data['oauth_token']) || !isset($data['oauth_token_secret'])){
+		elseif (!isset($data['oauth_token']) || !isset($data['oauth_token_secret'])) {
 			throw new ProviderException('invalid token');
 		}
 
-		if(
+		if (
 			$checkCallbackConfirmed
 			&& (!isset($data['oauth_callback_confirmed']) || $data['oauth_callback_confirmed'] !== 'true')
-		){
+		) {
 			throw new ProviderException('oauth callback unconfirmed');
 		}
 
@@ -133,7 +133,7 @@ 
 	protected function getSignature(string $url, array $params, string $method, string $accessTokenSecret = null):string{
 		$parsed = QueryUtil::parseUrl($url);
 
-		if(!isset($parsed['host']) || !isset($parsed['scheme']) || !in_array($parsed['scheme'], ['http', 'https'], true)){
+		if (!isset($parsed['host']) || !isset($parsed['scheme']) || !in_array($parsed['scheme'], ['http', 'https'], true)) {
 			throw new ProviderException('getSignature: invalid url');
 		}
 
@@ -150,7 +150,7 @@ 
 		]);
 
 		// https://tools.ietf.org/html/rfc5849#section-3.4.2
-		$key  = array_map('rawurlencode', [
+		$key = array_map('rawurlencode', [
 			$this->options->secret,
 			$accessTokenSecret ?? ''
 		]);
@@ -197,7 +197,7 @@ 
 			$token->accessTokenSecret
 		);
 
-		if(isset($query['oauth_session_handle'])){
+		if (isset($query['oauth_session_handle'])) {
 			$parameters['oauth_session_handle'] = $query['oauth_session_handle']; // @codeCoverageIgnore
 		}
 

src/Storage/MemoryStorage.php

Spacing +6 added lines, -6 removed lines

@@ -17,7 +17,7 @@ 
 /**
  * Implements a memory storage adapter. Memory storage is not persistent as tokens are only stored during script runtime.
  */
-class MemoryStorage extends OAuthStorageAbstract{
+class MemoryStorage extends OAuthStorageAbstract {
 
 	/**
 	 * the token storage array
@@ -43,7 +43,7 @@ 
 	 */
 	public function getAccessToken(string $service):AccessToken{
 
-		if($this->hasAccessToken($service)){
+		if ($this->hasAccessToken($service)) {
 			return $this->tokens[$service];
 		}
 
@@ -62,7 +62,7 @@ 
 	 */
 	public function clearAccessToken(string $service):OAuthStorageInterface{
 
-		if(array_key_exists($service, $this->tokens)){
+		if (array_key_exists($service, $this->tokens)) {
 			unset($this->tokens[$service]);
 		}
 
@@ -74,7 +74,7 @@ 
 	 */
 	public function clearAllAccessTokens():OAuthStorageInterface{
 
-		foreach(array_keys($this->tokens) as $service){
+		foreach (array_keys($this->tokens) as $service) {
 			unset($this->tokens[$service]);
 		}
 
@@ -97,7 +97,7 @@ 
 	 */
 	public function getCSRFState(string $service):string{
 
-		if($this->hasCSRFState($service)){
+		if ($this->hasCSRFState($service)) {
 			return $this->states[$service];
 		}
 
@@ -116,7 +116,7 @@ 
 	 */
 	public function clearCSRFState(string $service):OAuthStorageInterface{
 
-		if(array_key_exists($service, $this->states)){
+		if (array_key_exists($service, $this->states)) {
 			unset($this->states[$service]);
 		}
 

src/Storage/SessionStorage.php

Spacing +12 added lines, -12 removed lines

@@ -20,7 +20,7 @@ 
 /**
  * Implements a session storage adapter. Session storage is half persistent as tokens are stored for the duration of the session.
  */
-class SessionStorage extends OAuthStorageAbstract{
+class SessionStorage extends OAuthStorageAbstract {
 
 	/**
 	 * the key name for the token storage array in $_SESSION
@@ -35,7 +35,7 @@ 
 	/**
 	 * SessionStorage constructor.
 	 */
-	public function __construct(SettingsContainerInterface $options = null){
+	public function __construct(SettingsContainerInterface $options = null) {
 		parent::__construct($options);
 
 		$this->tokenVar = $this->options->sessionTokenVar;
@@ -43,15 +43,15 @@ 
 
 		// Determine if the session has started.
 		// @link http://stackoverflow.com/a/18542272/1470961
-		if($this->options->sessionStart && !(session_status() !== PHP_SESSION_NONE)){
+		if ($this->options->sessionStart && !(session_status() !== PHP_SESSION_NONE)) {
 			session_start();
 		}
 
-		if(!isset($_SESSION[$this->tokenVar])){
+		if (!isset($_SESSION[$this->tokenVar])) {
 			$_SESSION[$this->tokenVar] = [];
 		}
 
-		if(!isset($_SESSION[$this->stateVar])){
+		if (!isset($_SESSION[$this->stateVar])) {
 			$_SESSION[$this->stateVar] = [];
 		}
 
@@ -62,8 +62,8 @@ 
 	 *
 	 * @codeCoverageIgnore
 	 */
-	public function __destruct(){
-		if($this->options->sessionStart){
+	public function __destruct() {
+		if ($this->options->sessionStart) {
 			session_write_close();
 		}
 	}
@@ -82,7 +82,7 @@ 
 	 */
 	public function getAccessToken(string $service):AccessToken{
 
-		if($this->hasAccessToken($service)){
+		if ($this->hasAccessToken($service)) {
 			return $this->fromStorage($_SESSION[$this->tokenVar][$service]);
 		}
 
@@ -101,7 +101,7 @@ 
 	 */
 	public function clearAccessToken(string $service):OAuthStorageInterface{
 
-		if(array_key_exists($service, $_SESSION[$this->tokenVar])){
+		if (array_key_exists($service, $_SESSION[$this->tokenVar])) {
 			unset($_SESSION[$this->tokenVar][$service]);
 		}
 
@@ -113,7 +113,7 @@ 
 	 */
 	public function clearAllAccessTokens():OAuthStorageInterface{
 
-		foreach(array_keys($_SESSION[$this->tokenVar]) as $service){
+		foreach (array_keys($_SESSION[$this->tokenVar]) as $service) {
 			unset($_SESSION[$this->tokenVar][$service]);
 		}
 
@@ -136,7 +136,7 @@ 
 	 */
 	public function getCSRFState(string $service):string{
 
-		if($this->hasCSRFState($service)){
+		if ($this->hasCSRFState($service)) {
 			return $_SESSION[$this->stateVar][$service];
 		}
 
@@ -155,7 +155,7 @@ 
 	 */
 	public function clearCSRFState(string $service):OAuthStorageInterface{
 
-		if(array_key_exists($service, $_SESSION[$this->stateVar])){
+		if (array_key_exists($service, $_SESSION[$this->stateVar])) {
 			unset($_SESSION[$this->stateVar][$service]);
 		}
 

src/OAuthOptions.php

Spacing +1 added lines, -1 removed lines

@@ -16,6 +16,6 @@
 /**
  * This class holds all settings related to the OAuth provider as well as the default HTTP client.
  */
-class OAuthOptions extends SettingsContainerAbstract{
+class OAuthOptions extends SettingsContainerAbstract {
 	use OAuthOptionsTrait, HTTPOptionsTrait;
 }

src/Core/OAuth2Provider.php

Spacing +24 added lines, -24 removed lines

@@ -34,7 +34,7 @@ 
  * Implements an abstract OAuth2 provider with all methods required by the OAuth2Interface.
  * It also implements the ClientCredentials, CSRFToken and TokenRefresh interfaces in favor over traits.
  */
-abstract class OAuth2Provider extends OAuthProvider implements OAuth2Interface{
+abstract class OAuth2Provider extends OAuthProvider implements OAuth2Interface {
 
 	/**
 	 * Specifies the authentication method:
@@ -91,11 +91,11 @@ 
 			'type'          => 'web_server',
 		]);
 
-		if(!empty($scopes)){
+		if (!empty($scopes)) {
 			$params['scope'] = implode($this->scopesDelimiter, $scopes);
 		}
 
-		if($this instanceof CSRFToken){
+		if ($this instanceof CSRFToken) {
 			$params = $this->setState($params);
 		}
 
@@ -114,19 +114,19 @@ 
 		// silly amazon sends compressed data...
 		$data = json_decode(MessageUtil::decompress($response), true, 512, JSON_THROW_ON_ERROR);
 
-		if(!is_array($data)){
+		if (!is_array($data)) {
 			throw new ProviderException('unable to parse token response');
 		}
 
-		foreach(['error_description', 'error'] as $field){
+		foreach (['error_description', 'error'] as $field) {
 
-			if(isset($data[$field])){
+			if (isset($data[$field])) {
 				throw new ProviderException('error retrieving access token: "'.$data[$field].'"');
 			}
 
 		}
 
-		if(!isset($data['access_token'])){
+		if (!isset($data['access_token'])) {
 			throw new ProviderException('token missing');
 		}
 
@@ -148,7 +148,7 @@ 
 	 */
 	public function getAccessToken(string $code, string $state = null):AccessToken{
 
-		if($this instanceof CSRFToken){
+		if ($this instanceof CSRFToken) {
 			$this->checkState($state);
 		}
 
@@ -166,7 +166,7 @@ 
 			->withHeader('Accept-Encoding', 'identity')
 			->withBody($this->streamFactory->createStream(QueryUtil::build($body, PHP_QUERY_RFC1738)));
 
-		foreach($this->authHeaders as $header => $value){
+		foreach ($this->authHeaders as $header => $value) {
 			$request = $request->withHeader($header, $value);
 		}
 
@@ -182,11 +182,11 @@ 
 	 */
 	public function getRequestAuthorization(RequestInterface $request, AccessToken $token):RequestInterface{
 
-		if($this->authMethod === OAuth2Interface::AUTH_METHOD_HEADER){
+		if ($this->authMethod === OAuth2Interface::AUTH_METHOD_HEADER) {
 			return $request->withHeader('Authorization', $this->authMethodHeader.' '.$token->accessToken);
 		}
 
-		if($this->authMethod === OAuth2Interface::AUTH_METHOD_QUERY){
+		if ($this->authMethod === OAuth2Interface::AUTH_METHOD_QUERY) {
 			$uri = QueryUtil::merge((string)$request->getUri(), [$this->authMethodQuery => $token->accessToken]);
 
 			return $request->withUri($this->uriFactory->createUri($uri));
@@ -204,13 +204,13 @@ 
 	 */
 	public function getClientCredentialsToken(array $scopes = null):AccessToken{
 
-		if(!$this instanceof ClientCredentials){
+		if (!$this instanceof ClientCredentials) {
 			throw new ProviderException('client credentials token not supported');
 		}
 
 		$params = ['grant_type' => 'client_credentials'];
 
-		if($scopes !== null){
+		if ($scopes !== null) {
 			$params['scope'] = implode($this->scopesDelimiter, $scopes);
 		}
 
@@ -222,7 +222,7 @@ 
 			->withBody($this->streamFactory->createStream(QueryUtil::build($params, PHP_QUERY_RFC1738)))
 		;
 
-		foreach($this->authHeaders as $header => $value){
+		foreach ($this->authHeaders as $header => $value) {
 			$request = $request->withAddedHeader($header, $value);
 		}
 
@@ -242,17 +242,17 @@ 
 	 */
 	public function refreshAccessToken(AccessToken $token = null):AccessToken{
 
-		if(!$this instanceof TokenRefresh){
+		if (!$this instanceof TokenRefresh) {
 			throw new ProviderException('token refresh not supported');
 		}
 
-		if($token === null){
+		if ($token === null) {
 			$token = $this->storage->getAccessToken($this->serviceName);
 		}
 
 		$refreshToken = $token->refreshToken;
 
-		if(empty($refreshToken)){
+		if (empty($refreshToken)) {
 			throw new ProviderException(
 				sprintf('no refresh token available, token expired [%s]', date('Y-m-d h:i:s A', $token->expires))
 			);
@@ -273,13 +273,13 @@ 
 			->withBody($this->streamFactory->createStream(QueryUtil::build($body, PHP_QUERY_RFC1738)))
 		;
 
-		foreach($this->authHeaders as $header => $value){
+		foreach ($this->authHeaders as $header => $value) {
 			$request = $request->withAddedHeader($header, $value);
 		}
 
 		$newToken = $this->parseTokenResponse($this->http->sendRequest($request));
 
-		if(empty($newToken->refreshToken)){
+		if (empty($newToken->refreshToken)) {
 			$newToken->refreshToken = $refreshToken;
 		}
 
@@ -299,17 +299,17 @@ 
 	 */
 	public function checkState(string $state = null):void{
 
-		if(!$this instanceof CSRFToken){
+		if (!$this instanceof CSRFToken) {
 			throw new ProviderException('CSRF protection not supported');
 		}
 
-		if(empty($state) || !$this->storage->hasCSRFState($this->serviceName)){
+		if (empty($state) || !$this->storage->hasCSRFState($this->serviceName)) {
 			throw new ProviderException('invalid state for '.$this->serviceName);
 		}
 
 		$knownState = $this->storage->getCSRFState($this->serviceName);
 
-		if(!hash_equals($knownState, $state)){
+		if (!hash_equals($knownState, $state)) {
 			throw new ProviderException('invalid CSRF state: '.$this->serviceName.' '.$state);
 		}
 
@@ -326,11 +326,11 @@ 
 	 */
 	public function setState(array $params):array{
 
-		if(!$this instanceof CSRFToken){
+		if (!$this instanceof CSRFToken) {
 			throw new ProviderException('CSRF protection not supported');
 		}
 
-		if(!isset($params['state'])){
+		if (!isset($params['state'])) {
 			$params['state'] = sha1(random_bytes(256));
 		}
 

src/Core/OAuthProvider.php

Spacing +17 added lines, -17 removed lines

@@ -42,7 +42,7 @@ 
  * @property string      $serviceName
  * @property string|null $userRevokeURL
  */
-abstract class OAuthProvider implements OAuthInterface{
+abstract class OAuthProvider implements OAuthInterface {
 	use LoggerAwareTrait;
 
 	protected const ALLOWED_PROPERTIES = [
@@ -137,7 +137,7 @@ 
 		OAuthStorageInterface $storage,
 		OAuthOptions|SettingsContainerInterface $options,
 		LoggerInterface $logger = null
-	){
+	) {
 		$this->http    = $http;
 		$this->storage = $storage;
 		$this->options = $options;
@@ -158,7 +158,7 @@ 
 	 */
 	public function __get(string $name):mixed{
 
-		if(in_array($name, $this::ALLOWED_PROPERTIES, true)){
+		if (in_array($name, $this::ALLOWED_PROPERTIES, true)) {
 			return $this->{$name};
 		}
 
@@ -234,28 +234,28 @@ 
 		$request = $this->requestFactory
 			->createRequest($method ?? 'GET', QueryUtil::merge($this->getRequestTarget($path), $params ?? []));
 
-		foreach(array_merge($this->apiHeaders, $headers ?? []) as $header => $value){
+		foreach (array_merge($this->apiHeaders, $headers ?? []) as $header => $value) {
 			$request = $request->withAddedHeader($header, $value);
 		}
 
-		if($request->hasHeader('content-type')){
+		if ($request->hasHeader('content-type')) {
 			$contentType = strtolower($request->getHeaderLine('content-type'));
 
-			if(is_array($body)){
-				if($contentType === 'application/x-www-form-urlencoded'){
+			if (is_array($body)) {
+				if ($contentType === 'application/x-www-form-urlencoded') {
 					$body = $this->streamFactory->createStream(QueryUtil::build($body, PHP_QUERY_RFC1738));
 				}
-				elseif(in_array($contentType, ['application/json', 'application/vnd.api+json'])){
+				elseif (in_array($contentType, ['application/json', 'application/vnd.api+json'])) {
 					$body = $this->streamFactory->createStream(json_encode($body));
 				}
 			}
-			elseif(is_string($body)){
+			elseif (is_string($body)) {
 				// we don't check if the given string matches the content type - this is the implementor's responsibility
 				$body = $this->streamFactory->createStream($body);
 			}
 		}
 
-		if($body instanceof StreamInterface){
+		if ($body instanceof StreamInterface) {
 			$request = $request
 				->withBody($body)
 				->withHeader('Content-length', (string)$body->getSize())
@@ -277,18 +277,18 @@ 
 	protected function getRequestTarget(string $uri):string{
 		$parsedURL = QueryUtil::parseUrl($uri);
 
-		if(!isset($parsedURL['path'])){
+		if (!isset($parsedURL['path'])) {
 			throw new ProviderException('invalid path');
 		}
 
 		// for some reason we were given a host name
-		if(isset($parsedURL['host'])){
+		if (isset($parsedURL['host'])) {
 			$api  = QueryUtil::parseUrl($this->apiURL);
 			$host = $api['host'] ?? null;
 
 			// back out if it doesn't match
-			if($parsedURL['host'] !== $host){
-				throw new ProviderException(sprintf('given host (%s) does not match provider (%s)', $parsedURL['host'] , $host));
+			if ($parsedURL['host'] !== $host) {
+				throw new ProviderException(sprintf('given host (%s) does not match provider (%s)', $parsedURL['host'], $host));
 			}
 
 			// we explicitly ignore any existing parameters here
@@ -305,15 +305,15 @@ 
 	public function sendRequest(RequestInterface $request):ResponseInterface{
 
 		// get authorization only if we request the provider API
-		if(str_starts_with((string)$request->getUri(), $this->apiURL)){
+		if (str_starts_with((string)$request->getUri(), $this->apiURL)) {
 			$token = $this->storage->getAccessToken($this->serviceName);
 
 			// attempt to refresh an expired token
-			if(
+			if (
 				$this instanceof TokenRefresh
 				&& $this->options->tokenAutoRefresh
 				&& ($token->isExpired() || $token->expires === $token::EOL_UNKNOWN)
-			){
+			) {
 				$token = $this->refreshAccessToken($token);
 			}
 

Braces +2 added lines, -4 removed lines

@@ -244,12 +244,10 @@
 			if(is_array($body)){
 				if($contentType === 'application/x-www-form-urlencoded'){
 					$body = $this->streamFactory->createStream(QueryUtil::build($body, PHP_QUERY_RFC1738));
-				}
-				elseif(in_array($contentType, ['application/json', 'application/vnd.api+json'])){
+				} elseif(in_array($contentType, ['application/json', 'application/vnd.api+json'])){
 					$body = $this->streamFactory->createStream(json_encode($body));
 				}
-			}
-			elseif(is_string($body)){
+			} elseif(is_string($body)){
 				// we don't check if the given string matches the content type - this is the implementor's responsibility
 				$body = $this->streamFactory->createStream($body);
 			}

src/Storage/OAuthStorageAbstract.php

Spacing +3 added lines, -3 removed lines

@@ -19,7 +19,7 @@ 
 /**
  * Implements ab anstract OAuth storage adapter
  */
-abstract class OAuthStorageAbstract implements OAuthStorageInterface{
+abstract class OAuthStorageAbstract implements OAuthStorageInterface {
 	use LoggerAwareTrait;
 
 	protected OAuthOptions|SettingsContainerInterface $options;
@@ -27,7 +27,7 @@ 
 	/**
 	 * OAuthStorageAbstract constructor.
 	 */
-	public function __construct(OAuthOptions|SettingsContainerInterface $options = null, LoggerInterface $logger = null){
+	public function __construct(OAuthOptions|SettingsContainerInterface $options = null, LoggerInterface $logger = null) {
 		$this->options = $options ?? new OAuthOptions;
 		$this->logger  = $logger ?? new NullLogger;
 	}
@@ -47,7 +47,7 @@ 
 	 */
 	public function fromStorage(mixed $data):AccessToken{
 
-		if(!is_string($data)){
+		if (!is_string($data)) {
 			throw new OAuthStorageException('invalid data');
 		}