Throw better exception when authentication fails

If the CantoClient cannot authenticate because ultimately client credentials mode would be needed but is not allowed, throw an MissingClientSecretException instead of RuntimeException. See #23 Fixes #24
flownative · Jan 19, 2022 · 8e9187b · 8e9187b
1 parent 74e11d0
commit 8e9187b
Showing 1 changed file with 40 additions and 1 deletion.
diff --git a/Classes/Service/CantoClient.php b/Classes/Service/CantoClient.php
@@ -16,6 +16,7 @@
 use Flownative\Canto\Domain\Model\AccountAuthorization;
 use Flownative\Canto\Domain\Repository\AccountAuthorizationRepository;
 use Flownative\Canto\Exception\AuthenticationFailedException;
+use Flownative\Canto\Exception\MissingClientSecretException;
 use Flownative\OAuth2\Client\Authorization;
 use Flownative\OAuth2\Client\OAuthClientException;
 use GuzzleHttp\Client;
@@ -24,11 +25,14 @@
 use GuzzleHttp\Psr7\Response;
 use GuzzleHttp\Psr7\ServerRequest;
 use GuzzleHttp\Psr7\Uri;
+use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Core\Bootstrap;
+use Neos\Flow\Http\Exception as HttpException;
 use Neos\Flow\Http\HttpRequestHandlerInterface;
 use Neos\Flow\Mvc\ActionRequest;
 use Neos\Flow\Mvc\Exception\StopActionException;
+use Neos\Flow\Mvc\Routing\Exception\MissingActionNameException;
 use Neos\Flow\Mvc\Routing\UriBuilder;
 use Neos\Flow\Security\Context;
 use Neos\Media\Domain\Model\AssetSource\SupportsSortingInterface;
@@ -118,6 +122,13 @@ public function allowClientCredentialsAuthentication(bool $allowed): void
         $this->allowClientCredentialsAuthentication = $allowed;
     }
 
+    /**
+     * @throws MissingClientSecretException
+     * @throws HttpException
+     * @throws MissingActionNameException
+     * @throws AuthenticationFailedException
+     * @throws IdentityProviderException
+     */
     private function authenticate(): void
     {
         $oAuthClient = new CantoOAuthClient($this->serviceName);
@@ -150,7 +161,7 @@ private function authenticate(): void
                 throw new AuthenticationFailedException('Authentication failed: ' . ($result->help ?? 'Unknown cause'), 1630059881);
             }
         } else {
-            throw new \RuntimeException('Security context not initialized and client credentials use not allowed', 1631821639);
+            throw new MissingClientSecretException('Security context not initialized and client credentials use not allowed', 1631821639);
         }
     }
 
@@ -175,7 +186,11 @@ private function redirectToUri(string $uri): void
      * @return ResponseInterface
      * @throws AuthenticationFailedException
      * @throws GuzzleException
+     * @throws HttpException
+     * @throws MissingActionNameException
+     * @throws MissingClientSecretException
      * @throws OAuthClientException
+     * @throws IdentityProviderException
      */
     public function getFile(string $assetProxyId): ResponseInterface
     {
@@ -204,6 +219,10 @@ public function updateFile(string $id, array $metadata): ResponseInterface
      * @return ResponseInterface
      * @throws AuthenticationFailedException
      * @throws GuzzleException
+     * @throws HttpException
+     * @throws IdentityProviderException
+     * @throws MissingActionNameException
+     * @throws MissingClientSecretException
      * @throws OAuthClientException
      */
     public function search(string $keyword, array $formatTypes, string $customQueryPart = '', int $offset = 0, int $limit = 50, array $orderings = []): ResponseInterface
@@ -238,6 +257,10 @@ public function search(string $keyword, array $formatTypes, string $customQueryP
      * @return array
      * @throws AuthenticationFailedException
      * @throws GuzzleException
+     * @throws HttpException
+     * @throws IdentityProviderException
+     * @throws MissingActionNameException
+     * @throws MissingClientSecretException
      * @throws OAuthClientException
      * @todo perhaps cache the result
      */
@@ -254,6 +277,10 @@ public function getCustomFields(): array
      * @return array
      * @throws AuthenticationFailedException
      * @throws GuzzleException
+     * @throws HttpException
+     * @throws IdentityProviderException
+     * @throws MissingActionNameException
+     * @throws MissingClientSecretException
      * @throws OAuthClientException
      */
     public function user(): array
@@ -269,6 +296,10 @@ public function user(): array
      * @return array
      * @throws AuthenticationFailedException
      * @throws GuzzleException
+     * @throws HttpException
+     * @throws IdentityProviderException
+     * @throws MissingActionNameException
+     * @throws MissingClientSecretException
      * @throws OAuthClientException
      */
     public function tree(): array
@@ -285,6 +316,10 @@ public function tree(): array
      * @return Uri|null
      * @throws AuthenticationFailedException
      * @throws GuzzleException
+     * @throws HttpException
+     * @throws IdentityProviderException
+     * @throws MissingActionNameException
+     * @throws MissingClientSecretException
      * @throws OAuthClientException
      */
     public function directUri(string $assetProxyId): ?Uri
@@ -356,6 +391,10 @@ private function getAuthenticatedRequest(Authorization $authorization, string $u
      * @return Response
      * @throws AuthenticationFailedException
      * @throws GuzzleException
+     * @throws HttpException
+     * @throws IdentityProviderException
+     * @throws MissingActionNameException
+     * @throws MissingClientSecretException
      * @throws OAuthClientException
      */
     public function sendAuthenticatedRequest(string $uriPathAndQuery, string $method = 'GET', array $bodyFields = []): Response