chillerlan\OAuth\Providers\SteamOpenID

Complexity

Total Complexity

9

Size/Duplication

Total Lines	98
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getRequestAuthorization()	0	10	2
A	getAuthURL()	0	13	1
A	getAccessToken()	0	32	2
A	parseTokenResponse()	0	16	4

<?php
/**
 * Class SteamOpenID
 *
 * @created      15.03.2021
 * @author       smiley <smiley@chillerlan.net>
 * @copyright    2021 smiley
 * @license      MIT
 */

namespace chillerlan\OAuth\Providers;

use chillerlan\OAuth\Core\{AccessToken, OAuthProvider, ProviderException};
use chillerlan\HTTP\Utils\QueryUtil;
use Psr\Http\Message\{RequestInterface, ResponseInterface, UriInterface};

use function explode, intval, preg_replace;

/**
 * @see https://steamcommunity.com/dev
 * @see https://partner.steamgames.com/doc/webapi_overview
 * @see https://steamwebapi.azurewebsites.net/
 */
class SteamOpenID extends OAuthProvider{

	protected string  $authURL        = 'https://steamcommunity.com/openid/login';
	protected string  $accessTokenURL = 'https://steamcommunity.com/openid/login';
	protected string  $apiURL         = 'https://api.steampowered.com';
	protected ?string $applicationURL = 'https://steamcommunity.com/dev/apikey';
	protected ?string $apiDocs        = 'https://developer.valvesoftware.com/wiki/Steam_Web_API';

	/**
	 * @inheritDoc
	 */
	public function getAuthURL(array $params = null):UriInterface{

		// we ignore user supplied params here
		$params = [
			'openid.ns'         => 'http://specs.openid.net/auth/2.0',
			'openid.mode'       => 'checkid_setup',
			'openid.return_to'  => $this->options->callbackURL,
			'openid.realm'      => $this->options->key,
			'openid.identity'   => 'http://specs.openid.net/auth/2.0/identifier_select',
			'openid.claimed_id' => 'http://specs.openid.net/auth/2.0/identifier_select',
		];

		return $this->uriFactory->createUri(QueryUtil::merge($this->authURL, $params));
	}

	/**
	 * @inheritDoc
	 */
	public function getAccessToken(array $received):AccessToken{

		$body = [
			'openid.mode' => 'check_authentication',
			'openid.ns'   => 'http://specs.openid.net/auth/2.0',
			'openid.sig'  => $received['openid_sig'],
		];

		foreach(explode(',', $received['openid_signed']) as $item){
			$body['openid.'.$item] = $received['openid_'.$item];
		}

		$request = $this->requestFactory
			->createRequest('POST', $this->accessTokenURL)
			->withHeader('Content-Type', 'application/x-www-form-urlencoded')
			->withBody($this->streamFactory->createStream(QueryUtil::build($body)));

		$token = $this->parseTokenResponse($this->http->sendRequest($request));
		$id    = preg_replace('/[^\d]/', '', $received['openid_claimed_id']);

		// as this method is intended for one-time authentication only we'll not receive a token.
		// instead we're gonna save the verified steam user id as token as it is required
		// for several "authenticated" endpoints.
		$token->accessToken = $id;
		$token->extraParams = [
			'claimed_id' => $received['openid_claimed_id'],
			'id_int'     => intval($id),
		];

		$this->storage->storeAccessToken($token, $this->serviceName);

		return $token;
	}

	/**
	 * @throws \chillerlan\OAuth\Core\ProviderException
	 */
	protected function parseTokenResponse(ResponseInterface $response):AccessToken{
		$data = explode("\x0a", (string)$response->getBody());

		if(!isset($data[1]) || !str_starts_with($data[1], 'is_valid')){
			throw new ProviderException('unable to parse token response');
		}

		if($data[1] !== 'is_valid:true'){
			throw new ProviderException('invalid id');
		}

		// the response is only validation, so we'll just return an empty token and add the id in the next step
		return new AccessToken([
			'accessToken' => 'SteamID',
			'provider' => $this->serviceName,
			'expires'  => AccessToken::EOL_NEVER_EXPIRES,
		]);
	}

	/**
	 *
	 */
	public function getRequestAuthorization(RequestInterface $request, AccessToken $token):RequestInterface{
		$uri    = (string)$request->getUri();
		$params = ['key' => $this->options->secret];

		// the steamid parameter does not necessarily specify the current user, so add it only when it's not already set
		if(!str_contains($uri, 'steamid=')){
			$params['steamid']= $token->accessToken;
		}

		return $request->withUri($this->uriFactory->createUri(QueryUtil::merge($uri, $params)));
	}

}