Skip to content

Support authenticating with client credentials #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: 3.x
Choose a base branch
from
Draft

Support authenticating with client credentials #91

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 15 additions & 3 deletions src/Connection/Connector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ class Connector implements ConnectorInterface
'scope' => 'scope',
'expires' => 'expires',
'expires_in' => 'expiresIn',
'resource_owner_id' => 'resourceOwnerId,',
];

/**
Expand All @@ -62,6 +61,10 @@ class Connector implements ConnectorInterface
* - revoke_url (string): The OAuth 2.0 revocation URL. Can be empty if auth_url is set.
* - certifier_url (string): The SSH certificate issuer URL. Can be empty if auth_url is set.
* - client_id (string): The OAuth2 client ID for this client.
* - api_token (string): An API token to use for authentication.
* - client_secret (string): The OAuth2 client secret for this client.
* If set, and api_token is empty, then client credentials-based authentication will be used.
* - scopes (string[]): Scope(s) to request when using client credentials-based authentication.
* - debug (bool): Whether or not Guzzle debugging should be enabled
* (default: false).
* - verify (bool): Whether or not SSL verification should be enabled
Expand Down Expand Up @@ -97,6 +100,7 @@ public function __construct(array $config = [], SessionInterface $session = null
'accounts' => 'https://api.platform.sh/',
'client_id' => 'platformsh-client-php',
'client_secret' => '',
'scopes' => [],
'debug' => false,
'verify' => true,
'user_agent' => null,
Expand Down Expand Up @@ -207,7 +211,7 @@ public function getSession(): Session|SessionInterface
/**
* Returns the access token saved in the session, if any.
*/
public function getAccessToken(): false|string
public function getAccessToken(): false|string|null
{
return $this->session->get('accessToken');
}
Expand Down Expand Up @@ -251,7 +255,7 @@ public function saveToken(AccessTokenInterface $token): void

public function isLoggedIn(): bool
{
return $this->session->get($this->storageKeys['access_token']) || $this->config['api_token'];
return $this->session->get($this->storageKeys['access_token']) || $this->config['api_token'] || $this->config['client_secret'];
}

public function setApiToken(string $token, string $type): void
Expand Down Expand Up @@ -373,6 +377,14 @@ protected function getOauthMiddleware(): GuzzleMiddleware
$grantOptions['api_token'] = $this->config['api_token'];
}

if ($this->config['client_secret']) {
$grantOptions['client_secret'] = $this->config['client_secret'];
}

if ($this->config['scopes']) {
$grantOptions['scope'] = implode(' ', (array) $this->config['scopes']);
}

$this->oauthMiddleware = new GuzzleMiddleware($this->getOAuth2Provider(), $grant, $grantOptions);
$this->oauthMiddleware->setTokenSaveCallback(function (AccessToken $token) {
$this->saveToken($token);
Expand Down