Skip to content
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

feat(Authentication): Add support for Client Assertion #699

Merged
merged 2 commits into from
Jan 24, 2023
Merged

feat(Authentication): Add support for Client Assertion #699

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87a7de7
feat: Add support for Client Assertion
evansims Jan 22, 2023
5ed2257
Implement feedback
evansims Jan 23, 2023
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
91 changes: 66 additions & 25 deletions src/API/Authentication.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@

use Auth0\SDK\Configuration\SdkConfiguration;
use Auth0\SDK\Contract\API\AuthenticationInterface;
use Auth0\SDK\Exception\ConfigurationException;
use Auth0\SDK\Exception\TokenException;
use Auth0\SDK\Token\ClientAssertionGenerator;
use Auth0\SDK\Utility\HttpClient;
use Auth0\SDK\Utility\Toolkit;
use Psr\Http\Message\ResponseInterface;
Expand All @@ -15,6 +18,8 @@
*/
final class Authentication implements AuthenticationInterface
{
public const CONST_CLIENT_ASSERTION_TYPE = 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer';

/**
* Instance of Auth0\SDK\API\Utility\HttpClient.
*/
Expand All @@ -30,7 +35,7 @@ final class Authentication implements AuthenticationInterface
*
* @param array<mixed>|SdkConfiguration $configuration Required. Base configuration options for the SDK. See the SdkConfiguration class constructor for options.
*
* @throws \Auth0\SDK\Exception\ConfigurationException when an invalidation `configuration` is provided
* @throws ConfigurationException when an invalidation `configuration` is provided
*
* @psalm-suppress DocblockTypeContradiction
*/
Expand Down Expand Up @@ -71,7 +76,7 @@ public function getSamlpLink(
/** @var string $clientId */
[$clientId] = Toolkit::filter([
[$clientId, $this->getConfiguration()->getClientId()],
])->array()->first(\Auth0\SDK\Exception\ConfigurationException::requiresClientId());
])->array()->first(ConfigurationException::requiresClientId());

/** @var array<string> $query */
$query = Toolkit::filter([
Expand All @@ -94,7 +99,7 @@ public function getSamlpMetadataLink(
/** @var string $clientId */
[$clientId] = Toolkit::filter([
[$clientId, $this->getConfiguration()->getClientId()],
])->array()->first(\Auth0\SDK\Exception\ConfigurationException::requiresClientId());
])->array()->first(ConfigurationException::requiresClientId());

return sprintf(
'%s/samlp/metadata/%s',
Expand All @@ -115,7 +120,7 @@ public function getWsfedLink(
/** @var string $clientId */
[$clientId] = Toolkit::filter([
[$clientId, $this->getConfiguration()->getClientId()],
])->array()->first(\Auth0\SDK\Exception\ConfigurationException::requiresClientId());
])->array()->first(ConfigurationException::requiresClientId());

return sprintf(
'%s/wsfed/%s?%s',
Expand Down Expand Up @@ -149,14 +154,14 @@ public function getLoginLink(

[$redirectUri] = Toolkit::filter([
[$redirectUri, isset($params['redirect_uri']) ? (string) $params['redirect_uri'] : null, $this->getConfiguration()->getRedirectUri()],
])->array()->first(\Auth0\SDK\Exception\ConfigurationException::requiresRedirectUri());
])->array()->first(ConfigurationException::requiresRedirectUri());

return sprintf(
'%s/authorize?%s',
$this->getConfiguration()->formatDomain(),
http_build_query(Toolkit::merge([
'state' => $state,
'client_id' => $this->getConfiguration()->getClientId(\Auth0\SDK\Exception\ConfigurationException::requiresClientId()),
'client_id' => $this->getConfiguration()->getClientId(ConfigurationException::requiresClientId()),
'audience' => $this->getConfiguration()->defaultAudience(),
'organization' => $this->getConfiguration()->defaultOrganization(),
'redirect_uri' => $redirectUri,
Expand All @@ -179,14 +184,14 @@ public function getLogoutLink(
/** @var string $returnTo */
[$returnTo] = Toolkit::filter([
[$returnTo, isset($params['returnTo']) ? (string) $params['returnTo'] : null, $this->getConfiguration()->getRedirectUri()],
])->array()->first(\Auth0\SDK\Exception\ConfigurationException::requiresRedirectUri());
])->array()->first(ConfigurationException::requiresRedirectUri());

return sprintf(
'%s/v2/logout?%s',
$this->getConfiguration()->formatDomain(),
http_build_query(Toolkit::merge([
'returnTo' => $returnTo,
'client_id' => $this->getConfiguration()->getClientId(\Auth0\SDK\Exception\ConfigurationException::requiresClientId()),
'client_id' => $this->getConfiguration()->getClientId(ConfigurationException::requiresClientId()),
], $params), '', '&', PHP_QUERY_RFC3986),
);
}
Expand All @@ -195,18 +200,17 @@ public function passwordlessStart(
?array $body = null,
?array $headers = null,
): ResponseInterface {
/** @var array<int|string> $headers */
/** @var array<string> $body */

[$body, $headers] = Toolkit::filter([$body, $headers])->array()->trim();

/** @var array<mixed> $body */
/** @var array<int|string> $headers */
$body = $this->addClientAuthentication($body);

return $this->getHttpClient()->
method('post')->
addPath('passwordless', 'start')->
withBody((object) Toolkit::merge([
'client_id' => $this->getConfiguration()->getClientId(\Auth0\SDK\Exception\ConfigurationException::requiresClientId()),
'client_secret' => $this->getConfiguration()->getClientSecret(\Auth0\SDK\Exception\ConfigurationException::requiresClientSecret()),
], $body))->
withBody((object) $body)->
withHeaders($headers)->
call();
}
Expand Down Expand Up @@ -299,27 +303,29 @@ public function oauthToken(
?array $headers = null,
): ResponseInterface {
[$grantType] = Toolkit::filter([$grantType])->string()->trim();

/** @var array<int|string> $headers */
/** @var array<bool|int|string> $params */

[$params, $headers] = Toolkit::filter([$params, $headers])->array()->trim();

Toolkit::assert([
[$grantType, \Auth0\SDK\Exception\ArgumentException::missing('grantType')],
])->isString();

/** @var array<bool|int|string> $params */
$parameters = Toolkit::merge([
'grant_type' => $grantType,
'client_id' => $this->getConfiguration()->getClientId(\Auth0\SDK\Exception\ConfigurationException::requiresClientId()),
'client_secret' => $this->getConfiguration()->getClientSecret(\Auth0\SDK\Exception\ConfigurationException::requiresClientSecret()),
$params = Toolkit::merge([
'grant_type' => $grantType,
], $params);

/** @var array<bool|int|string> $parameters */
/** @var array<int|string> $headers */
$params = $this->addClientAuthentication($params);

/** @var array<bool|int|string> $params */

return $this->getHttpClient()->
method('post')->
addPath('oauth', 'token')->
withHeaders($headers)->
withFormParams($parameters)->
withFormParams($params)->
call();
}

Expand All @@ -336,7 +342,7 @@ public function codeExchange(

[$redirectUri] = Toolkit::filter([
[$redirectUri, $this->getConfiguration()->getRedirectUri()],
])->array()->first(\Auth0\SDK\Exception\ConfigurationException::requiresRedirectUri());
])->array()->first(ConfigurationException::requiresRedirectUri());

$params = Toolkit::filter([
[
Expand Down Expand Up @@ -469,7 +475,7 @@ public function dbConnectionsSignup(
method('post')->
addPath('dbconnections', 'signup')->
withBody(Toolkit::merge([
'client_id' => $this->getConfiguration()->getClientId(\Auth0\SDK\Exception\ConfigurationException::requiresClientId()),
'client_id' => $this->getConfiguration()->getClientId(ConfigurationException::requiresClientId()),
'email' => $email,
'password' => $password,
'connection' => $connection,
Expand Down Expand Up @@ -499,11 +505,46 @@ public function dbConnectionsChangePassword(
method('post')->
addPath('dbconnections', 'change_password')->
withBody(Toolkit::merge([
'client_id' => $this->getConfiguration()->getClientId(\Auth0\SDK\Exception\ConfigurationException::requiresClientId()),
'client_id' => $this->getConfiguration()->getClientId(ConfigurationException::requiresClientId()),
'email' => $email,
'connection' => $connection,
], $body))->
withHeaders($headers)->
call();
}

/**
* Add client authentication to a request body.
*
* @param array<mixed> $requestBody Request body being sent to the endpoint.
*
* @return array<mixed> Request body with client authentication added.
*
* @throws TokenException If client assertion signing key or algorithm is invalid.
* @throws ConfigurationException If client ID or secret are invalid.
*/
private function addClientAuthentication(array $requestBody): array
{
$clientId = $this->getConfiguration()->getClientId(ConfigurationException::requiresClientId()) ?? '';
$clientAssertionSigningKey = $this->getConfiguration()->getClientAssertionSigningKey();
$clientAssertionSigningAlgorithm = $this->getConfiguration()->getClientAssertionSigningAlgorithm();

$requestBody['client_id'] = $clientId;

if (null !== $clientAssertionSigningKey) {
$requestBody['client_assertion_type'] = self::CONST_CLIENT_ASSERTION_TYPE;
$requestBody['client_assertion'] = (string) ClientAssertionGenerator::create(
domain: $this->getConfiguration()->formatDomain(true) . '/',
clientId: $clientId,
signingKey: $clientAssertionSigningKey,
signingAlgorithm: $clientAssertionSigningAlgorithm
);

return $requestBody;
}

$requestBody['client_secret'] = $this->getConfiguration()->getClientSecret(ConfigurationException::requiresClientSecret()) ?? '';

return $requestBody;
}
}
Loading