vendor/auth0/auth0-php/src/Configuration/SdkConfiguration.php line 221

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Auth0\SDK\Configuration;
  7. use Auth0\SDK\Contract\ConfigurableContract;
  8. use Auth0\SDK\Contract\StoreInterface;
  9. use Auth0\SDK\Exception\ConfigurationException;
  10. use Auth0\SDK\Mixins\ConfigurableMixin;
  11. use Auth0\SDK\Store\CookieStore;
  12. use Auth0\SDK\Utility\EventDispatcher;
  13. use Http\Discovery\Exception\NotFoundException;
  14. use Http\Discovery\Psr17FactoryDiscovery;
  15. use Http\Discovery\Psr18ClientDiscovery;
  16. use Psr\Cache\CacheItemPoolInterface;
  17. use Psr\EventDispatcher\ListenerProviderInterface;
  18. use Psr\Http\Client\ClientInterface;
  19. use Psr\Http\Message\RequestFactoryInterface;
  20. use Psr\Http\Message\ResponseFactoryInterface;
  21. use Psr\Http\Message\StreamFactoryInterface;
  23. /**
  24.  * Configuration container for use with Auth0\SDK
  25.  *
  26.  * @method SdkConfiguration setAudience(?array $audience = null)
  27.  * @method SdkConfiguration setCookieDomain(?string $cookieDomain = null)
  28.  * @method SdkConfiguration setCookieExpires(int $cookieExpires = 0)
  29.  * @method SdkConfiguration setCookiePath(string $cookiePath = '/')
  30.  * @method SdkConfiguration setCookieSameSite(?string $cookieSameSite)
  31.  * @method SdkConfiguration setCookieSecret(?string $cookieSecret)
  32.  * @method SdkConfiguration setCookieSecure(bool $cookieSecure = false)
  33.  * @method SdkConfiguration setClientId(?string $clientId = null)
  34.  * @method SdkConfiguration setClientSecret(?string $clientSecret = null)
  35.  * @method SdkConfiguration setDomain(?string $domain = null)
  36.  * @method SdkConfiguration setCustomDomain(?string $customDomain = null)
  37.  * @method SdkConfiguration setEventListenerProvider(?ListenerProviderInterface $eventListenerProvider = null)
  38.  * @method SdkConfiguration setHttpClient(?ClientInterface $httpClient = null)
  39.  * @method SdkConfiguration setHttpMaxRetries(int $httpMaxRetires = 3)
  40.  * @method SdkConfiguration setHttpRequestFactory(?RequestFactoryInterface $httpRequestFactory = null)
  41.  * @method SdkConfiguration setHttpResponseFactory(?ResponseFactoryInterface $httpResponseFactory = null)
  42.  * @method SdkConfiguration setHttpStreamFactory(?StreamFactoryInterface $httpStreamFactory = null)
  43.  * @method SdkConfiguration setHttpTelemetry(bool $httpTelemetry = true)
  44.  * @method SdkConfiguration setManagementToken(?string $managementToken = null)
  45.  * @method SdkConfiguration setManagementTokenCache(?CacheItemPoolInterface $cache = null)
  46.  * @method SdkConfiguration setOrganization(?array $organization = null)
  47.  * @method SdkConfiguration setPersistAccessToken(bool $persistAccessToken = true)
  48.  * @method SdkConfiguration setPersistIdToken(bool $persistIdToken = true)
  49.  * @method SdkConfiguration setPersistRefreshToken(bool $persistRefreshToken = true)
  50.  * @method SdkConfiguration setPersistUser(bool $persistUser = true)
  51.  * @method SdkConfiguration setQueryUserInfo(bool $queryUserInfo = false)
  52.  * @method SdkConfiguration setRedirectUri(?string $redirectUri = null)
  53.  * @method SdkConfiguration setResponseMode(string $responseMode = 'query')
  54.  * @method SdkConfiguration setResponseType(string $responseType = 'code')
  55.  * @method SdkConfiguration setScope(?array $scope = null)
  56.  * @method SdkConfiguration setSessionStorage(?StoreInterface $sessionStorage = null)
  57.  * @method SdkConfiguration setSessionStorageId(string $sessionStorageId = 'auth0_session')
  58.  * @method SdkConfiguration setStrategy(string $strategy = 'webapp')
  59.  * @method SdkConfiguration setTokenAlgorithm(string $tokenAlgorithm = 'RS256')
  60.  * @method SdkConfiguration setTokenCache(?CacheItemPoolInterface $cache = null)
  61.  * @method SdkConfiguration setTokenCacheTtl(int $tokenCacheTtl = 60)
  62.  * @method SdkConfiguration setTokenJwksUri(?string $tokenJwksUri = null)
  63.  * @method SdkConfiguration setTokenLeeway(int $tokenLeeway = 60)
  64.  * @method SdkConfiguration setTokenMaxAge(?int $tokenMaxAge = null)
  65.  * @method SdkConfiguration setTransientStorage(?StoreInterface $transientStorage = null)
  66.  * @method SdkConfiguration setTransientStorageId(string $transientStorageId = 'auth0_transient')
  67.  * @method SdkConfiguration setUsePkce(bool $usePkce)
  68.  *
  69.  * @method array<string>|null getAudience(?\Throwable $exceptionIfNull = null)
  70.  * @method string|null getCookieDomain(?\Throwable $exceptionIfNull = null)
  71.  * @method int getCookieExpires()
  72.  * @method string getCookiePath()
  73.  * @method string|null getCookieSameSite(?\Throwable $exceptionIfNull = null)
  74.  * @method string|null getCookieSecret(?\Throwable $exceptionIfNull = null)
  75.  * @method bool getCookieSecure()
  76.  * @method string|null getClientId(?\Throwable $exceptionIfNull = null)
  77.  * @method string|null getClientSecret(?\Throwable $exceptionIfNull = null)
  78.  * @method string|string getDomain(?\Throwable $exceptionIfNull = null)
  79.  * @method string|string getCustomDomain(?\Throwable $exceptionIfNull = null)
  80.  * @method ListenerProviderInterface|null getEventListenerProvider(?\Throwable $exceptionIfNull = null)
  81.  * @method ClientInterface|null getHttpClient(?\Throwable $exceptionIfNull = null)
  82.  * @method int getHttpMaxRetries()
  83.  * @method RequestFactoryInterface|null getHttpRequestFactory(?\Throwable $exceptionIfNull = null)
  84.  * @method ResponseFactoryInterface|null getHttpResponseFactory(?\Throwable $exceptionIfNull = null)
  85.  * @method StreamFactoryInterface|null getHttpStreamFactory(?\Throwable $exceptionIfNull = null)
  86.  * @method bool getHttpTelemetry()
  87.  * @method string|null getManagementToken(?\Throwable $exceptionIfNull = null)
  88.  * @method CacheItemPoolInterface|null getManagementTokenCache(?\Throwable $exceptionIfNull = null)
  89.  * @method array<string>|null getOrganization(?\Throwable $exceptionIfNull = null)
  90.  * @method bool getPersistAccessToken()
  91.  * @method bool getPersistIdToken()
  92.  * @method bool getPersistRefreshToken()
  93.  * @method bool getPersistUser()
  94.  * @method bool getQueryUserInfo()
  95.  * @method string|null getRedirectUri(?\Throwable $exceptionIfNull = null)
  96.  * @method string getResponseMode()
  97.  * @method string getResponseType()
  98.  * @method array<string> getScope()
  99.  * @method StoreInterface|null getSessionStorage(?\Throwable $exceptionIfNull = null)
  100.  * @method string getSessionStorageId()
  101.  * @method string getStrategy()
  102.  * @method string getTokenAlgorithm()
  103.  * @method CacheItemPoolInterface|null getTokenCache(?\Throwable $exceptionIfNull = null)
  104.  * @method int getTokenCacheTtl()
  105.  * @method string|null getTokenJwksUri(?\Throwable $exceptionIfNull = null)
  106.  * @method int|null getTokenLeeway(?\Throwable $exceptionIfNull = null)
  107.  * @method int|null getTokenMaxAge(?\Throwable $exceptionIfNull = null)
  108.  * @method StoreInterface|null getTransientStorage(?\Throwable $exceptionIfNull = null)
  109.  * @method string getTransientStorageId()
  110.  * @method bool getUsePkce()
  111.  *
  112.  * @method bool hasAudience()
  113.  * @method bool hasCookieDomain()
  114.  * @method bool hasCookieExpires()
  115.  * @method bool hasCookiePath()
  116.  * @method bool hasCookieSameSite()
  117.  * @method bool hasCookieSecret()
  118.  * @method bool hasCookieSecure()
  119.  * @method bool hasClientId()
  120.  * @method bool hasClientSecret()
  121.  * @method bool hasDomain()
  122.  * @method bool hasCustomDomain()
  123.  * @method bool hasEventListenerProvider()
  124.  * @method bool hasHttpClient()
  125.  * @method bool hasHttpMaxRetries()
  126.  * @method bool hasHttpRequestFactory()
  127.  * @method bool hasHttpResponseFactory()
  128.  * @method bool hasHttpStreamFactory()
  129.  * @method bool hasHttpTelemetry()
  130.  * @method bool hasManagementToken()
  131.  * @method bool hasManagementTokenCache()
  132.  * @method bool hasOrganization()
  133.  * @method bool hasPersistAccessToken()
  134.  * @method bool hasPersistIdToken()
  135.  * @method bool hasPersistRefreshToken()
  136.  * @method bool hasPersistUser()
  137.  * @method bool hasQueryUserInfo()
  138.  * @method bool hasRedirectUri()
  139.  * @method bool hasResponseMode()
  140.  * @method bool hasResponseType()
  141.  * @method bool hasScope()
  142.  * @method bool hasSessionStorage()
  143.  * @method bool hasSessionStorageId()
  144.  * @method bool hasStrategy()
  145.  * @method bool hasTokenAlgorithm()
  146.  * @method bool hasTokenCache()
  147.  * @method bool hasTokenCacheTtl()
  148.  * @method bool hasTokenLeeway()
  149.  * @method bool hasTokenMaxAge()
  150.  * @method bool hasTransientStorage()
  151.  * @method bool hasTransientStorageId()
  152.  * @method bool hasUsePkce()
  153.  *
  154.  * @method bool pushScope($scope)
  155.  * @method bool pushAudience($audience)
  156.  * @method bool pushOrganization($organization)
  157.  */
  158. final class SdkConfiguration implements ConfigurableContract
  159. {
  160.     use ConfigurableMixin;
  162.     public const STRATEGY_REGULAR = 'webapp';
  163.     public const STRATEGY_API = 'api';
  164.     public const STRATEGY_MANAGEMENT_API = 'management';
  165.     public const STRATEGY_NONE = 'none';
  167.     /**
  168.      * An instance of the EventDispatcher utility.
  169.      */
  170.     private ?EventDispatcher $eventDispatcher = null;
  172.     /**
  173.      * SdkConfiguration Constructor
  174.      *
  175.      * @param array<mixed>|null              $configuration         An key-value array matching this constructor's arguments. Overrides any other passed arguments with the same key name.
  176.      * @param string|null                    $strategy              Defaults to 'webapp'. Should be assigned either 'api', 'management', or 'webapp' to specify the type of application the SDK is being applied to. Determines what configuration options will be required at initialization.
  177.      * @param string|null                    $domain                Auth0 domain for your tenant, found in your Auth0 Application settings.
  178.      * @param string|null                    $customDomain          If you have configured Auth0 to use a custom domain, configure it here.
  179.      * @param string|null                    $clientId              Client ID, found in the Auth0 Application settings.
  180.      * @param string|null                    $redirectUri           Authentication callback URI, as defined in your Auth0 Application settings.
  181.      * @param string|null                    $clientSecret          Client Secret, found in the Auth0 Application settings.
  182.      * @param array<string>|null             $audience              One or more API identifiers, found in your Auth0 API settings. The SDK uses the first value for building links. If provided, at least one of these values must match the 'aud' claim to validate an ID Token successfully.
  183.      * @param array<string>|null             $organization          One or more Organization IDs, found in your Auth0 Organization settings. The SDK uses the first value for building links. If provided, at least one of these values must match the 'org_id' claim to validate an ID Token successfully.
  184.      * @param bool                           $usePkce               Defaults to true. Use PKCE (Proof Key of Code Exchange) with Authorization Code Flow requests. See https://auth0.com/docs/flows/call-your-api-using-the-authorization-code-flow-with-pkce
  185.      * @param array<string>                  $scope                 One or more scopes to request for Tokens. See https://auth0.com/docs/scopes
  186.      * @param string                         $responseMode          Defaults to 'query.' Where to extract request parameters from, either 'query' for GET or 'form_post' for POST requests.
  187.      * @param string                         $responseType          Defaults to 'code.' Use 'code' for server-side flows and 'token' for application side flow.
  188.      * @param string                         $tokenAlgorithm        Defaults to 'RS256'. Algorithm to use for Token verification. Expects either 'RS256' or 'HS256'.
  189.      * @param string|null                    $tokenJwksUri          URI to the JWKS when verifying RS256 tokens.
  190.      * @param int|null                       $tokenMaxAge           The maximum window of time (in seconds) since the 'auth_time' to accept during Token validation.
  191.      * @param int                            $tokenLeeway           Defaults to 60. Leeway (in seconds) to allow during time calculations with Token validation.
  192.      * @param CacheItemPoolInterface|null    $tokenCache            A PSR-6 compatible cache adapter for storing JSON Web Key Sets (JWKS).
  193.      * @param int                            $tokenCacheTtl         How long (in seconds) to keep a JWKS cached.
  194.      * @param ClientInterface|null           $httpClient            A PSR-18 compatible HTTP client to use for API requests.
  195.      * @param int                            $httpMaxRetries        When a rate-limit (429 status code) response is returned from the Auth0 API, automatically retry the request up to this many times.
  196.      * @param RequestFactoryInterface|null   $httpRequestFactory    A PSR-17 compatible request factory to generate HTTP requests.
  197.      * @param ResponseFactoryInterface|null  $httpResponseFactory   A PSR-17 compatible response factory to generate HTTP responses.
  198.      * @param StreamFactoryInterface|null    $httpStreamFactory     A PSR-17 compatible stream factory to create request body streams.
  199.      * @param bool                           $httpTelemetry         Defaults to true. If true, API requests will include telemetry about the SDK and PHP runtime version to help us improve our services.
  200.      * @param StoreInterface|null            $sessionStorage        Defaults to use cookies. A StoreInterface-compatible class for storing Token state.
  201.      * @param string                         $sessionStorageId      Defaults to 'auth0_session'. The namespace to prefix session items under.
  202.      * @param string|null                    $cookieSecret          The secret used to derive an encryption key for the user identity in a session cookie and to sign the transient cookies used by the login callback.
  203.      * @param string|null                    $cookieDomain          Defaults to value of HTTP_HOST server environment information. Cookie domain, for example 'www.example.com', for use with PHP sessions and SDK cookies. To make cookies visible on all subdomains then the domain must be prefixed with a dot like '.example.com'.
  204.      * @param int                            $cookieExpires         Defaults to 0. How long, in seconds, before cookies expire. If set to 0 the cookie will expire at the end of the session (when the browser closes).
  205.      * @param string                         $cookiePath            Defaults to '/'. Specifies path on the domain where the cookies will work. Use a single slash ('/') for all paths on the domain.
  206.      * @param string|null                    $cookieSameSite        Defaults to 'lax'. Specifies whether cookies should be restricted to first-party or same-site context.
  207.      * @param bool                           $cookieSecure          Defaults to false. Specifies whether cookies should ONLY be sent over secure connections.
  208.      * @param bool                           $persistUser           Defaults to true. If true, the user data will persist in session storage.
  209.      * @param bool                           $persistIdToken        Defaults to true. If true, the Id Token will persist in session storage.
  210.      * @param bool                           $persistAccessToken    Defaults to true. If true, the Access Token will persist in session storage.
  211.      * @param bool                           $persistRefreshToken   Defaults to true. If true, the Refresh Token will persist in session storage.
  212.      * @param StoreInterface|null            $transientStorage      Defaults to use cookies. A StoreInterface-compatible class for storing ephemeral state data, such as nonces.
  213.      * @param string                         $transientStorageId    Defaults to 'auth0_transient'. The namespace to prefix transient items under.
  214.      * @param bool                           $queryUserInfo         Defaults to false. If true, query the /userinfo endpoint during an authorization code exchange.
  215.      * @param string|null                    $managementToken       An Access Token to use for Management API calls. If there isn't one specified, the SDK will attempt to get one for you using your $clientSecret.
  216.      * @param CacheItemPoolInterface|null    $managementTokenCache  A PSR-6 compatible cache adapter for storing generated management access tokens.
  217.      * @param ListenerProviderInterface|null $eventListenerProvider A PSR-14 compatible event listener provider, for interfacing with events triggered by the SDK.
  218.      *
  219.      * @throws \Auth0\SDK\Exception\ConfigurationException When a valid `$strategy` is not specified.
  220.      */
  221.     public function __construct(
  222.         ?array $configuration = null,
  223.         ?string $strategy = 'webapp',
  224.         ?string $domain = null,
  225.         ?string $customDomain = null,
  226.         ?string $clientId = null,
  227.         ?string $redirectUri = null,
  228.         ?string $clientSecret = null,
  229.         ?array $audience = null,
  230.         ?array $organization = null,
  231.         bool $usePkce = true,
  232.         array $scope = ['openid', 'profile', 'email'],
  233.         string $responseMode = 'query',
  234.         string $responseType = 'code',
  235.         string $tokenAlgorithm = 'RS256',
  236.         ?string $tokenJwksUri = null,
  237.         ?int $tokenMaxAge = null,
  238.         int $tokenLeeway = 60,
  239.         ?CacheItemPoolInterface $tokenCache = null,
  240.         int $tokenCacheTtl = 60,
  241.         ?ClientInterface $httpClient = null,
  242.         int $httpMaxRetries = 3,
  243.         ?RequestFactoryInterface $httpRequestFactory = null,
  244.         ?ResponseFactoryInterface $httpResponseFactory = null,
  245.         ?StreamFactoryInterface $httpStreamFactory = null,
  246.         bool $httpTelemetry = true,
  247.         ?StoreInterface $sessionStorage = null,
  248.         string $sessionStorageId = 'auth0_session',
  249.         ?string $cookieSecret = null,
  250.         ?string $cookieDomain = null,
  251.         int $cookieExpires = 0,
  252.         string $cookiePath = '/',
  253.         bool $cookieSecure = false,
  254.         ?string $cookieSameSite = null,
  255.         bool $persistUser = true,
  256.         bool $persistIdToken = true,
  257.         bool $persistAccessToken = true,
  258.         bool $persistRefreshToken = true,
  259.         ?StoreInterface $transientStorage = null,
  260.         string $transientStorageId = 'auth0_transient',
  261.         bool $queryUserInfo = false,
  262.         ?string $managementToken = null,
  263.         ?CacheItemPoolInterface $managementTokenCache = null,
  264.         ?ListenerProviderInterface $eventListenerProvider = null
  265.     ) {
  266.         $this->setState(func_get_args());
  268.         $this->setupStateCookies();
  269.         $this->setupStateFactories();
  270.         $this->setupStateStorage();
  272.         $this->validateState();
  273.     }
  275.     /**
  276.      * Return the configured custom or tenant domain, formatted with protocol.
  277.      *
  278.      * @param bool $forceTenantDomain Force the return of the tenant domain even if a custom domain is configured.
  279.      */
  280.     public function formatDomain(
  281.         bool $forceTenantDomain = false
  282.     ): string {
  283.         if ($this->hasCustomDomain() && ! $forceTenantDomain) {
  284.             return 'https://' . $this->getCustomDomain();
  285.         }
  287.         return 'https://' . $this->getDomain();
  288.     }
  290.     /**
  291.      * Return the configured domain with protocol.
  292.      */
  293.     public function formatCustomDomain(): ?string
  294.     {
  295.         if ($this->hasCustomDomain()) {
  296.             return 'https://' . $this->getCustomDomain();
  297.         }
  299.         return null;
  300.     }
  302.     /**
  303.      * Return the configured scopes as a space-delimited string.
  304.      */
  305.     public function formatScope(): ?string
  306.     {
  307.         if ($this->hasScope()) {
  308.             $scope = $this->getScope();
  310.             if ($scope !== []) {
  311.                 return implode(' ', $scope);
  312.             }
  313.         }
  315.         return null;
  316.     }
  318.     /**
  319.      * Get the first configured organization.
  320.      */
  321.     public function defaultOrganization(): ?string
  322.     {
  323.         // Return the default organization.
  324.         if ($this->hasOrganization()) {
  325.             $organization = $this->getOrganization();
  327.             if ($organization !== null && $organization !== []) {
  328.                 return $organization[0];
  329.             }
  330.         }
  332.         return null;
  333.     }
  335.     /**
  336.      * Get the first configured audience.
  337.      */
  338.     public function defaultAudience(): ?string
  339.     {
  340.         // Return the default audience.
  341.         if ($this->hasAudience()) {
  342.             $audience = $this->getAudience();
  344.             if ($audience !== null && $audience !== []) {
  345.                 return $audience[0] ?? '';
  346.             }
  347.         }
  349.         return null;
  350.     }
  352.     /**
  353.      * Get an instance of the EventDispatcher.
  354.      */
  355.     public function eventDispatcher(): EventDispatcher
  356.     {
  357.         if ($this->eventDispatcher === null) {
  358.             $this->eventDispatcher = new EventDispatcher($this);
  359.         }
  361.         return $this->eventDispatcher;
  362.     }
  364.     /**
  365.      * Setup SDK cookie state.
  366.      */
  367.     private function setupStateCookies(): void
  368.     {
  369.         if (! $this->hasCookieDomain()) {
  370.             $domain = $_SERVER['HTTP_HOST'] ?? $this->getRedirectUri();
  372.             if ($domain !== null) {
  373.                 $parsed = parse_url($domain, PHP_URL_HOST);
  375.                 if (is_string($parsed)) {
  376.                     $domain = $parsed;
  377.                 }
  379.                 if ($domain) {
  380.                     $this->setCookieDomain($domain);
  381.                 }
  382.             }
  383.         }
  384.     }
  386.     /**
  387.      * Setup SDK factories.
  388.      *
  389.      * @throws NotFoundException When a PSR-18 or PSR-17 are not configured, and cannot be discovered.
  390.      *
  391.      * @codeCoverageIgnore
  392.      */
  393.     private function setupStateFactories(): void
  394.     {
  395.         // If a PSR-18 compatible client wasn't provided, try to discover one.
  396.         if (! $this->getHttpClient() instanceof ClientInterface) {
  397.             try {
  398.                 $this->setHttpClient(Psr18ClientDiscovery::find());
  399.             } catch (\Throwable $th) {
  400.                 throw \Auth0\SDK\Exception\ConfigurationException::missingPsr18Library();
  401.             }
  402.         }
  404.         // If a PSR-17 compatible request factory wasn't provided, try to discover one.
  405.         if (! $this->getHttpRequestFactory() instanceof RequestFactoryInterface) {
  406.             try {
  407.                 $this->setHttpRequestFactory(Psr17FactoryDiscovery::findRequestFactory());
  408.             } catch (NotFoundException $exception) {
  409.                 throw \Auth0\SDK\Exception\ConfigurationException::missingPsr17Library();
  410.             }
  411.         }
  413.         // If a PSR-17 compatible response factory wasn't provided, try to discover one.
  414.         if (! $this->getHttpResponseFactory() instanceof ResponseFactoryInterface) {
  415.             try {
  416.                 $this->setHttpResponseFactory(Psr17FactoryDiscovery::findResponseFactory());
  417.             } catch (NotFoundException $exception) {
  418.                 throw \Auth0\SDK\Exception\ConfigurationException::missingPsr17Library();
  419.             }
  420.         }
  422.         // If a PSR-17 compatible stream factory wasn't provided, try to discover one.
  423.         if (! $this->getHttpStreamFactory() instanceof StreamFactoryInterface) {
  424.             try {
  425.                 $this->setHttpStreamFactory(Psr17FactoryDiscovery::findStreamFactory());
  426.             } catch (NotFoundException $exception) {
  427.                 throw \Auth0\SDK\Exception\ConfigurationException::missingPsr17Library();
  428.             }
  429.         }
  430.     }
  432.     /**
  433.      * Setup SDK storage state.
  434.      */
  435.     private function setupStateStorage(): void
  436.     {
  437.         if (! $this->getSessionStorage() instanceof StoreInterface) {
  438.             $this->setSessionStorage(new CookieStore($this, $this->getSessionStorageId()));
  439.         }
  441.         if (! $this->getTransientStorage() instanceof StoreInterface) {
  442.             $this->setTransientStorage(new CookieStore($this, $this->getTransientStorageId()));
  443.         }
  444.     }
  446.     /**
  447.      * Fires when the configuration state changes, to ensure changes are formatted correctly.
  448.      *
  449.      * @param string $propertyName The property being mutated.
  450.      * @param mixed  $propertyValue The new value of the property.
  451.      *
  452.      * @return mixed
  453.      *
  454.      * @throws ConfigurationException When a validation check for the mutation fails to pass, such as a incompatible type being used.
  455.      */
  456.     private function onStateChange(
  457.         string $propertyName,
  458.         $propertyValue
  459.     ) {
  460.         if ($propertyValue === null) {
  461.             return $propertyValue;
  462.         }
  464.         if ($propertyName === 'strategy') {
  465.             if (is_string($propertyValue) && mb_strlen($propertyValue) !== 0) {
  466.                 $propertyValue = mb_strtolower($propertyValue);
  468.                 if (in_array($propertyValue, [self::STRATEGY_REGULAR, self::STRATEGY_API, self::STRATEGY_MANAGEMENT_API, self::STRATEGY_NONE], true)) {
  469.                     return $propertyValue;
  470.                 }
  471.             }
  473.             throw \Auth0\SDK\Exception\ConfigurationException::validationFailed($propertyName);
  474.         }
  476.         if ($propertyName === 'domain' || $propertyName === 'customDomain') {
  477.             if (is_string($propertyValue)) {
  478.                 $propertyValue = trim($propertyValue);
  480.                 if (strlen($propertyValue) !== 0) {
  481.                     $host = preg_replace('#^[^:/.]*[:/]+#i', '', $propertyValue);
  482.                     $host = parse_url('https://' . $host, PHP_URL_HOST);
  483.                     $host = filter_var($host, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE);
  485.                     if (is_string($host) && strlen($host) !== 0 && filter_var($host, FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME) !== false) {
  486.                         return $host;
  487.                     }
  488.                 }
  489.             }
  491.             throw \Auth0\SDK\Exception\ConfigurationException::validationFailed($propertyName);
  492.         }
  494.         if ($propertyName === 'tokenAlgorithm' && ! in_array($propertyValue, ['HS256', 'RS256'], true)) {
  495.             throw \Auth0\SDK\Exception\ConfigurationException::invalidAlgorithm();
  496.         }
  498.         if (in_array($propertyName, ['organization', 'audience'], true)) {
  499.             if (is_array($propertyValue) && $propertyValue !== []) {
  500.                 return $propertyValue;
  501.             }
  503.             return null;
  504.         }
  506.         return $propertyValue;
  507.     }
  509.     /**
  510.      * Setup SDK validators based on strategy type.
  511.      */
  512.     private function validateState(
  513.         ?string $strategy = null
  514.     ): void {
  515.         $strategy = $strategy ?? $this->getStrategy();
  517.         if ($strategy === self::STRATEGY_REGULAR) {
  518.             $this->validateStateWebApp();
  519.         }
  521.         if ($strategy === self::STRATEGY_API) {
  522.             $this->validateStateApi();
  523.         }
  525.         if ($strategy === self::STRATEGY_MANAGEMENT_API) {
  526.             $this->validateStateManagement();
  527.         }
  528.     }
  530.     /**
  531.      * Run validations for an API-only usage configuration.
  532.      */
  533.     private function validateStateApi(): void
  534.     {
  535.         if (! $this->hasDomain()) {
  536.             throw \Auth0\SDK\Exception\ConfigurationException::requiresDomain();
  537.         }
  539.         if (! $this->hasAudience()) {
  540.             throw \Auth0\SDK\Exception\ConfigurationException::requiresAudience();
  541.         }
  542.     }
  544.     /**
  545.      * Run validations for a Management-only usage configuration.
  546.      */
  547.     private function validateStateManagement(): void
  548.     {
  549.         if (! $this->hasDomain()) {
  550.             throw \Auth0\SDK\Exception\ConfigurationException::requiresDomain();
  551.         }
  553.         if (! $this->hasManagementToken()) {
  554.             if (! $this->hasClientId()) {
  555.                 throw \Auth0\SDK\Exception\ConfigurationException::requiresClientId();
  556.             }
  558.             if (! $this->hasClientSecret()) {
  559.                 throw \Auth0\SDK\Exception\ConfigurationException::requiresClientSecret();
  560.             }
  561.         }
  562.     }
  564.     /**
  565.      * Run validations for a general webapp usage configuration.
  566.      */
  567.     private function validateStateWebApp(): void
  568.     {
  569.         if (! $this->hasDomain()) {
  570.             throw \Auth0\SDK\Exception\ConfigurationException::requiresDomain();
  571.         }
  573.         if (! $this->hasClientId()) {
  574.             throw \Auth0\SDK\Exception\ConfigurationException::requiresClientId();
  575.         }
  577.         if ($this->getTokenAlgorithm() === 'HS256' && ! $this->hasClientSecret()) {
  578.             throw \Auth0\SDK\Exception\ConfigurationException::requiresClientSecret();
  579.         }
  581.         if (! $this->hasCookieSecret()) {
  582.             throw \Auth0\SDK\Exception\ConfigurationException::requiresCookieSecret();
  583.         }
  584.     }
  585. }