Rsa signature validation error logging (#718)

* Adding error logging for RSA signature validation and fixed error with having empty string in extra_data

* empty_string -> empty_str

* Fixing static test failure

* Attempting to resolve static test failure

---------

Co-authored-by: Noah Ostrowski <[email protected]>

Author: nrostrow-meta

app/code/Meta/BusinessExtension/Model/Api/CustomApiKey/Authenticator.php

@@ -23,6 +23,7 @@
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\App\Request\Http;
 use Magento\Framework\Exception\LocalizedException;
+use Meta\BusinessExtension\Helper\FBEHelper;
 use Meta\BusinessExtension\Model\System\Config as SystemConfig;
 
 class Authenticator
@@ -42,33 +43,42 @@ class Authenticator
      */
     private SystemConfig $systemConfig;
 
+    /**
+     * @var FBEHelper
+     */
+    private FBEHelper $fbeHelper;
+
     /**
      * Authenticator constructor
      *
      * @param ScopeConfigInterface $scopeConfig
      * @param Http                 $httpRequest
      * @param SystemConfig         $systemConfig
+     * @param FBEHelper            $fbeHelper
      */
     public function __construct(
         ScopeConfigInterface $scopeConfig,
         Http                 $httpRequest,
-        SystemConfig         $systemConfig
+        SystemConfig         $systemConfig,
+        FBEHelper            $fbeHelper
     ) {
         $this->scopeConfig = $scopeConfig;
         $this->httpRequest = $httpRequest;
         $this->systemConfig = $systemConfig;
+        $this->fbeHelper = $fbeHelper;
     }
 
     /**
      * Authenticate an API request (validate the token and RSA signature)
      *
+     * @param string|null $storeId
      * @return void
      * @throws LocalizedException
      */
-    public function authenticateRequest(): void
+    public function authenticateRequest(?string $storeId = null): void
     {
         $this->authenticateToken();
-        $this->authenticateSignature();
+        $this->authenticateSignature($storeId);
     }
 
     /**
@@ -104,10 +114,11 @@ private function authenticateToken(): void
     /**
      * Authenticate RSA Signature for API Request
      *
+     * @param string|null $storeId
      * @return void
      * @throws LocalizedException
      */
-    private function authenticateSignature(): void
+    private function authenticateSignature(?string $storeId = null): void
     {
         // phpcs:ignore Magento2.Functions.DiscouragedFunction
         $publicKey = file_get_contents(__DIR__ . '/PublicKey.pem');
@@ -130,7 +141,23 @@ private function authenticateSignature(): void
         $verification = openssl_verify($originalMessage, $decodedSignature, $publicKeyResource, OPENSSL_ALGO_SHA256);
 
         if (!$verification) {
-            throw new LocalizedException(__('RSA Signature Validation Failed'));
+            $ex = new LocalizedException(__('RSA Signature Validation Failed'));
+            if ($storeId !== null) {
+                $this->fbeHelper->logExceptionImmediatelyToMeta(
+                    $ex,
+                    [
+                        'store_id' => $storeId,
+                        'event' => 'authentication_error',
+                        'event_type' => 'rsa_signature_validation_error',
+                        'extra_data' => [
+                            'request_uri' => $requestUri,
+                            'request_body' => $requestBody,
+                            'request_signature' => $signature
+                        ]
+                    ]
+                );
+            }
+            throw $ex;
         }
     }
 }

app/code/Meta/BusinessExtension/Model/PersistMetaLogImmediatelyHandler.php

@@ -65,8 +65,12 @@ public function persistMetaLogImmediately(string $message): void
         // Meta expects extra_data field to be dict<string, string>
         $context['extra_data'] = array_map(
             function ($value) {
+                if ($value === '') {
+                    return 'empty_str';
+                }
                 return is_string($value) ? $value : json_encode($value);
-            }, $context['extra_data']
+            },
+            $context['extra_data']
         );
         $this->graphApiAdapter->persistLogToMeta($context, $accessToken);
     }

app/code/Meta/Sales/Model/Api/HealthCheckApi.php

@@ -57,8 +57,8 @@ public function __construct(
      */
     public function healthCheck(string $externalBusinessId): bool
     {
-        $this->authenticator->authenticateRequest();
-        $this->orderHelper->getStoreIdByExternalBusinessId($externalBusinessId);
+        $storeId = $this->orderHelper->getStoreIdByExternalBusinessId($externalBusinessId);
+        $this->authenticator->authenticateRequest($storeId);
 
         return true;
     }