Add tools/hmac

Author: gcatanese

tools/hmac/README.md

@@ -0,0 +1,16 @@
+## HMAC Tools
+
+This folder contains PHP scripts to calculate the HMAC signature of the webhook payload.  
+They can be used to troubleshoot the HMAC signature calculation.
+
+Note: make sure you are using the HMAC key used to generate the signature associated with the payload in the JSON file
+
+### Payments webhooks
+
+Copy the content of the webhook in the payload.json (or provide a different file), then run with: 
+`node hmacValidatorPayments.js {hmacKey} {path to JSON file}`
+```
+cd tools/hmac
+node hmacValidatorPayments.js 11223344D785FBAE710E7F943F307971BB61B21281C98C9129B3D4018A57B2EB tools/hmac/payload.json
+```
+

tools/hmac/hmacValidatorPayments.js

@@ -0,0 +1,59 @@
+// script to calculate the HMAC signature of Payments webhooks (where the signature is calculated considering
+// a subset of the fields in the payload - i.e. NotificationRequestItem object)
+//
+// Run with: `node hmacValidatorPayments.js {hmacKey} {path to JSON file}
+//
+// cd tools/hmac
+// node hmacValidatorPayments.js 11223344D785FBAE710E7F943F307971BB61B21281C98C9129B3D4018A57B2EB payload.json
+
+const fs = require('fs');
+const { hmacValidator } = require('@adyen/api-library');
+
+// Ensure correct arguments
+if (process.argv.length !== 4) {
+    console.error("Usage: node HMACValidatorPayments.js <hmacKey> <payloadFile>");
+    process.exit(1);
+}
+
+const hmacKey = process.argv[2];
+const payloadFile = process.argv[3];
+
+// Check if file exists
+if (!fs.existsSync(payloadFile)) {
+    console.error(`Error: File '${payloadFile}' not found.`);
+    process.exit(1);
+}
+
+console.log(`Calculating HMAC signature with payload from '${payloadFile}'`);
+
+// Load and parse JSON file
+let jsonData;
+try {
+    const fileContent = fs.readFileSync(payloadFile, 'utf8');
+    jsonData = JSON.parse(fileContent);
+} catch (error) {
+    console.error("Error: Invalid JSON in payload file.");
+    process.exit(1);
+}
+
+// Validate JSON structure
+if (!jsonData.notificationItems || !Array.isArray(jsonData.notificationItems)) {
+    console.error("Error: 'notificationItems' key is missing or not an array.");
+    process.exit(1);
+}
+
+// Extract the first (and only) NotificationRequestItem
+const notificationRequestItem = jsonData.notificationItems[0]?.NotificationRequestItem;
+
+if (!notificationRequestItem) {
+    console.error("Error: 'NotificationRequestItem' is not found.");
+    process.exit(1);
+}
+
+//console.log(notificationRequestItem)
+
+const validator = new hmacValidator()
+const hmacSignature = validator.calculateHmac(notificationRequestItem, hmacKey);
+
+console.log(`HMAC Validation Result: ${hmacSignature}`);
+process.exit(0);

tools/hmac/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "hmac-troubleshooting",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "Scripts to troubleshooting HMAC signature calculation",
+  "dependencies": {
+    "@adyen/api-library": "^25.0.0"
+  }
+}

tools/hmac/payload.json

@@ -0,0 +1,54 @@
+{
+    "live": "false",
+    "notificationItems": [
+        {
+            "NotificationRequestItem": {
+                "additionalData": {
+                    "cardSummary": "0010",
+                    "hmacSignature": "e7qQumH1fdt5NHb6e62jq6hIGUCpfhAAFXhUXqXcJAQ=",
+                    "expiryDate": "03\/2030",
+                    "recurring.contractTypes": "ONECLICK,RECURRING",
+                    "cardBin": "222241",
+                    "recurring.recurringDetailReference": "DQWW2BQ9FX2R7475",
+                    "recurringProcessingModel": "Subscription",
+                    "metadata.orderTransactionId": "63",
+                    "alias": "F758505419855455",
+                    "paymentMethodVariant": "m1",
+                    "acquirerReference": "JQBMF3P3FJM",
+                    "issuerBin": "22224107",
+                    "cardIssuingCountry": "NL",
+                    "authCode": "060494",
+                    "cardHolderName": "Checkout Test",
+                    "PaymentAccountReference": "Jj3gVfMpPcpKzmHrHmpxqgfsvGaVa",
+                    "checkout.cardAddedBrand": "mc",
+                    "store": "None",
+                    "tokenization.shopperReference": "4d74f0727a318b13f85aee28ae556a08d7d9cf9e6d67b70a62e60e334aa7090d",
+                    "recurring.firstPspReference": "P9M9CTGJKKKKP275",
+                    "tokenization.storedPaymentMethodId": "DQWW2BQ9FX2R7475",
+                    "issuerCountry": "NL",
+                    "aliasType": "Default",
+                    "paymentMethod": "mc",
+                    "recurring.shopperReference": "4d74f0727a318b13f85aee28ae556a08d7d9cf9e6d67b70a62e60e334aa7090d",
+                    "cardPaymentMethod": "mc2"
+                },
+                "amount": {
+                    "currency": "EUR",
+                    "value": 32500
+                },
+                "eventCode": "AUTHORISATION",
+                "eventDate": "2025-02-24T15:20:56+01:00",
+                "merchantAccountCode": "Merchant 1",
+                "merchantReference": "1143-R2",
+                "operations": [
+                    "CANCEL",
+                    "CAPTURE",
+                    "REFUND"
+                ],
+                "paymentMethod": "mc",
+                "pspReference": "AB1234567890",
+                "reason": "060494:0010:03\/2030",
+                "success": "true"
+            }
+        }
+    ]
+}