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

fix: Always store provided state in transient medium #674

Merged
merged 12 commits into from
Nov 28, 2022
Merged

fix: Always store provided state in transient medium #674

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
b87a9e3
fix: Always store provided `state` in transient medium
evansims Nov 28, 2022
1058e71
Test suite fixes; add error handling for odd OpenSSL error in GitHub VM
evansims Nov 28, 2022
f4c3f54
Bump Ubuntu version on GitHub VM
evansims Nov 28, 2022
2fcc301
Update checks.yml
evansims Nov 28, 2022
3ff8eeb
Update checks.yml
evansims Nov 28, 2022
f5752d9
Update TokenGenerator.php
evansims Nov 28, 2022
bc070a2
Update checks.yml
evansims Nov 28, 2022
97a8436
Update checks.yml
evansims Nov 28, 2022
a1fc673
Update checks.yml
evansims Nov 28, 2022
8632e15
Update checks.yml
evansims Nov 28, 2022
e1aff02
Update TokenGenerator.php
evansims Nov 28, 2022
5495336
Test suite fixes and improvements; PHP 8 language feature adoption
evansims Nov 28, 2022
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
47 changes: 22 additions & 25 deletions .github/workflows/checks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:
jobs:
dependencies:
name: Dependencies
runs-on: ubuntu-latest
runs-on: ubuntu-22.04

strategy:
max-parallel: 10
Expand All @@ -25,10 +25,9 @@ jobs:
with:
php-version: ${{ matrix.php }}
coverage: none
extensions: mbstring
extensions: mbstring, openssl
env:
update: true
COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Get composer cache directory
id: composer-cache
Expand All @@ -45,25 +44,24 @@ jobs:

pest:
name: Pest
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
continue-on-error: true
needs: ["dependencies"]

strategy:
max-parallel: 10
matrix:
php: ["8.0", "8.1", "8.2"]
php: ["8.1", "8.2"]

steps:
- name: Set up PHP ${{ matrix.php }}
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
coverage: pcov
extensions: mbstring
extensions: mbstring, openssl
env:
update: true
COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Checkout code
uses: actions/checkout@v3
Expand All @@ -79,6 +77,9 @@ jobs:
key: ${{ matrix.php }}-composer-${{ hashFiles('**/composer.json') }}-${{ github.run_id }}
restore-keys: ${{ matrix.php }}-composer-${{ hashFiles('**/composer.json') }}-${{ github.run_id }}

- name: PHP debug
run: php -i

- name: Install dependencies with composer
run: composer install --prefer-dist

Expand All @@ -92,7 +93,7 @@ jobs:

phpstan:
name: PHPStan
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
needs: ["dependencies"]

strategy:
Expand All @@ -107,10 +108,9 @@ jobs:
with:
php-version: ${{ matrix.php }}
coverage: none
extensions: mbstring
extensions: mbstring, openssl
env:
update: true
COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Checkout code
uses: actions/checkout@v3
Expand All @@ -134,7 +134,7 @@ jobs:

psalm:
name: Psalm
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
needs: ["dependencies"]

strategy:
Expand All @@ -149,10 +149,9 @@ jobs:
with:
php-version: ${{ matrix.php }}
coverage: none
extensions: mbstring
extensions: mbstring, openssl
env:
update: true
COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Checkout code
uses: actions/checkout@v3
Expand All @@ -176,7 +175,7 @@ jobs:

pint:
name: Laravel Pint
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
needs: ["dependencies"]

strategy:
Expand All @@ -191,10 +190,9 @@ jobs:
with:
php-version: ${{ matrix.php }}
coverage: none
extensions: mbstring
extensions: mbstring, openssl
env:
update: true
COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Checkout code
uses: actions/checkout@v3
Expand All @@ -218,7 +216,7 @@ jobs:

rector:
name: Rector
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
needs: ["dependencies"]

strategy:
Expand All @@ -233,10 +231,9 @@ jobs:
with:
php-version: ${{ matrix.php }}
coverage: none
extensions: mbstring
extensions: mbstring, openssl
env:
update: true
COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Checkout code
uses: actions/checkout@v3
Expand Down
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,10 +93,10 @@
"rector:fix": "@php vendor/bin/rector process src",
"pest": "@php vendor/bin/pest --order-by random",
"test": [
"@pint",
"@phpstan",
"@psalm",
"@rector",
"@pint",
"@pest"
]
}
Expand Down
82 changes: 42 additions & 40 deletions src/API/Authentication.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ final class Authentication implements AuthenticationInterface
/**
* Instance of SdkConfiguration, for shared configuration across classes.
*/
private SdkConfiguration $configuration;
private ?SdkConfiguration $validatedConfiguration = null;

/**
* Authentication constructor.
Expand All @@ -35,20 +35,22 @@ final class Authentication implements AuthenticationInterface
* @psalm-suppress DocblockTypeContradiction
*/
public function __construct(
$configuration
private SdkConfiguration|array $configuration
) {
// If we're passed an array, construct a new SdkConfiguration from that structure.
if (is_array($configuration)) {
$configuration = new SdkConfiguration($configuration);
}
$this->getConfiguration();
}

public function getConfiguration(): SdkConfiguration
{
if (null === $this->validatedConfiguration) {
if (is_array($this->configuration)) {
return $this->validatedConfiguration = new SdkConfiguration($this->configuration);
}

// We only accept an SdkConfiguration type.
if (! $configuration instanceof SdkConfiguration) {
throw \Auth0\SDK\Exception\ConfigurationException::requiresConfiguration();
return $this->validatedConfiguration = $this->configuration;
}

// Store the configuration internally.
$this->configuration = $configuration;
return $this->validatedConfiguration;
}

public function getHttpClient(): HttpClient
Expand All @@ -57,7 +59,7 @@ public function getHttpClient(): HttpClient
return $this->httpClient;
}

return $this->httpClient = new HttpClient($this->configuration, HttpClient::CONTEXT_AUTHENTICATION_CLIENT);
return $this->httpClient = new HttpClient($this->getConfiguration(), HttpClient::CONTEXT_AUTHENTICATION_CLIENT);
}

public function getSamlpLink(
Expand All @@ -68,7 +70,7 @@ public function getSamlpLink(

/** @var string $clientId */
[$clientId] = Toolkit::filter([
[$clientId, $this->configuration->getClientId()],
[$clientId, $this->getConfiguration()->getClientId()],
])->array()->first(\Auth0\SDK\Exception\ConfigurationException::requiresClientId());

/** @var array<string> $query */
Expand All @@ -78,7 +80,7 @@ public function getSamlpLink(

return sprintf(
'%s/samlp/%s?%s',
$this->configuration->formatDomain(),
$this->getConfiguration()->formatDomain(),
$clientId,
http_build_query($query, '', '&', PHP_QUERY_RFC3986)
);
Expand All @@ -91,12 +93,12 @@ public function getSamlpMetadataLink(

/** @var string $clientId */
[$clientId] = Toolkit::filter([
[$clientId, $this->configuration->getClientId()],
[$clientId, $this->getConfiguration()->getClientId()],
])->array()->first(\Auth0\SDK\Exception\ConfigurationException::requiresClientId());

return sprintf(
'%s/samlp/metadata/%s',
$this->configuration->formatDomain(),
$this->getConfiguration()->formatDomain(),
$clientId
);
}
Expand All @@ -112,12 +114,12 @@ public function getWsfedLink(

/** @var string $clientId */
[$clientId] = Toolkit::filter([
[$clientId, $this->configuration->getClientId()],
[$clientId, $this->getConfiguration()->getClientId()],
])->array()->first(\Auth0\SDK\Exception\ConfigurationException::requiresClientId());

return sprintf(
'%s/wsfed/%s?%s',
$this->configuration->formatDomain(),
$this->getConfiguration()->formatDomain(),
$clientId,
http_build_query($params, '', '&', PHP_QUERY_RFC3986)
);
Expand All @@ -127,7 +129,7 @@ public function getWsfedMetadataLink(): string
{
return sprintf(
'%s/wsfed/FederationMetadata/2007-06/FederationMetadata.xml',
$this->configuration->formatDomain()
$this->getConfiguration()->formatDomain()
);
}

Expand All @@ -146,21 +148,21 @@ public function getLoginLink(
])->isString();

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

return sprintf(
'%s/authorize?%s',
$this->configuration->formatDomain(),
$this->getConfiguration()->formatDomain(),
http_build_query(Toolkit::merge([
'state' => $state,
'client_id' => $this->configuration->getClientId(\Auth0\SDK\Exception\ConfigurationException::requiresClientId()),
'audience' => $this->configuration->defaultAudience(),
'organization' => $this->configuration->defaultOrganization(),
'client_id' => $this->getConfiguration()->getClientId(\Auth0\SDK\Exception\ConfigurationException::requiresClientId()),
'audience' => $this->getConfiguration()->defaultAudience(),
'organization' => $this->getConfiguration()->defaultOrganization(),
'redirect_uri' => $redirectUri,
'scope' => $this->configuration->formatScope(),
'response_mode' => $this->configuration->getResponseMode(),
'response_type' => $this->configuration->getResponseType(),
'scope' => $this->getConfiguration()->formatScope(),
'response_mode' => $this->getConfiguration()->getResponseMode(),
'response_type' => $this->getConfiguration()->getResponseType(),
], $params), '', '&', PHP_QUERY_RFC3986)
);
}
Expand All @@ -176,15 +178,15 @@ public function getLogoutLink(

/** @var string $returnTo */
[$returnTo] = Toolkit::filter([
[$returnTo, isset($params['returnTo']) ? (string) $params['returnTo'] : null, $this->configuration->getRedirectUri()],
[$returnTo, isset($params['returnTo']) ? (string) $params['returnTo'] : null, $this->getConfiguration()->getRedirectUri()],
])->array()->first(\Auth0\SDK\Exception\ConfigurationException::requiresRedirectUri());

return sprintf(
'%s/v2/logout?%s',
$this->configuration->formatDomain(),
$this->getConfiguration()->formatDomain(),
http_build_query(Toolkit::merge([
'returnTo' => $returnTo,
'client_id' => $this->configuration->getClientId(\Auth0\SDK\Exception\ConfigurationException::requiresClientId()),
'client_id' => $this->getConfiguration()->getClientId(\Auth0\SDK\Exception\ConfigurationException::requiresClientId()),
], $params), '', '&', PHP_QUERY_RFC3986)
);
}
Expand All @@ -202,8 +204,8 @@ public function passwordlessStart(
->method('post')
->addPath('passwordless', 'start')
->withBody((object) Toolkit::merge([
'client_id' => $this->configuration->getClientId(\Auth0\SDK\Exception\ConfigurationException::requiresClientId()),
'client_secret' => $this->configuration->getClientSecret(\Auth0\SDK\Exception\ConfigurationException::requiresClientSecret()),
'client_id' => $this->getConfiguration()->getClientId(\Auth0\SDK\Exception\ConfigurationException::requiresClientId()),
'client_secret' => $this->getConfiguration()->getClientSecret(\Auth0\SDK\Exception\ConfigurationException::requiresClientSecret()),
], $body))
->withHeaders($headers)
->call();
Expand All @@ -227,8 +229,8 @@ public function emailPasswordlessStart(
])->isString();

/** @var array{scope: ?string} $params */
if ((! isset($params['scope']) || '' === $params['scope']) && $this->configuration->hasScope()) {
$params['scope'] = $this->configuration->formatScope() ?? '';
if ((! isset($params['scope']) || '' === $params['scope']) && $this->getConfiguration()->hasScope()) {
$params['scope'] = $this->getConfiguration()->formatScope() ?? '';
}

$body = Toolkit::filter([
Expand Down Expand Up @@ -307,8 +309,8 @@ public function oauthToken(

$parameters = Toolkit::merge([
'grant_type' => $grantType,
'client_id' => $this->configuration->getClientId(\Auth0\SDK\Exception\ConfigurationException::requiresClientId()),
'client_secret' => $this->configuration->getClientSecret(\Auth0\SDK\Exception\ConfigurationException::requiresClientSecret()),
'client_id' => $this->getConfiguration()->getClientId(\Auth0\SDK\Exception\ConfigurationException::requiresClientId()),
'client_secret' => $this->getConfiguration()->getClientSecret(\Auth0\SDK\Exception\ConfigurationException::requiresClientSecret()),
], $params);

/** @var array<bool|int|string> $parameters */
Expand All @@ -334,7 +336,7 @@ public function codeExchange(
])->isString();

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

$params = Toolkit::filter([
Expand Down Expand Up @@ -416,7 +418,7 @@ public function clientCredentials(
/** @var array<int|string|null> $params */

$parameters = Toolkit::merge([
'audience' => $this->configuration->defaultAudience(),
'audience' => $this->getConfiguration()->defaultAudience(),
], $params);

/** @var array<int|string|null> $parameters */
Expand Down Expand Up @@ -472,7 +474,7 @@ public function dbConnectionsSignup(
->method('post')
->addPath('dbconnections', 'signup')
->withBody(Toolkit::merge([
'client_id' => $this->configuration->getClientId(\Auth0\SDK\Exception\ConfigurationException::requiresClientId()),
'client_id' => $this->getConfiguration()->getClientId(\Auth0\SDK\Exception\ConfigurationException::requiresClientId()),
'email' => $email,
'password' => $password,
'connection' => $connection,
Expand Down Expand Up @@ -502,7 +504,7 @@ public function dbConnectionsChangePassword(
->method('post')
->addPath('dbconnections', 'change_password')
->withBody(Toolkit::merge([
'client_id' => $this->configuration->getClientId(\Auth0\SDK\Exception\ConfigurationException::requiresClientId()),
'client_id' => $this->getConfiguration()->getClientId(\Auth0\SDK\Exception\ConfigurationException::requiresClientId()),
'email' => $email,
'connection' => $connection,
], $body))
Expand Down
Loading