Skip to content

Commit

Permalink
Rename parameters in HMAC validation IsValidWebhook() for Balance Pla…
Browse files Browse the repository at this point in the history 
…tform (#1056)
  • Loading branch information
@DjoykeAbyah
DjoykeAbyah authored Sep 9, 2024
1 parent 1365f8a commit 670627c
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 24 deletions.
32 changes: 16 additions & 16 deletions Adyen.Test/UtilTest.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,22 @@ public class UtilTest : BaseTest
public void TestHmac()
{
var data = "countryCode:currencyCode:merchantAccount:merchantReference:paymentAmount:sessionValidity:skinCode:NL:EUR:MagentoMerchantTest2:TEST-PAYMENT-2017-02-01-14\\:02\\:05:199:2017-02-02T14\\:02\\:05+01\\:00:PKz2KML1";
var key = "DFB1EB5485895CFA84146406857104ABB4CBCABDC8AAF103A624C8F6A3EAAB00";
var hmacKey = "DFB1EB5485895CFA84146406857104ABB4CBCABDC8AAF103A624C8F6A3EAAB00";
var hmacValidator = new HmacValidator();
var ecnrypted = hmacValidator.CalculateHmac(data, key);
Assert.IsTrue(string.Equals(ecnrypted, "34oR8T1whkQWTv9P+SzKyp8zhusf9n0dpqrm9nsqSJs="));
var hmacSignature = hmacValidator.CalculateHmac(data, hmacKey);
Assert.IsTrue(string.Equals(hmacSignature, "34oR8T1whkQWTv9P+SzKyp8zhusf9n0dpqrm9nsqSJs="));
}

[TestMethod]
public void TestBalancePlatformHmac()
{
var notification =
"{\"data\":{\"balancePlatform\":\"Integration_tools_test\",\"accountId\":\"BA32272223222H5HVKTBK4MLB\",\"sweep\":{\"id\":\"SWPC42272223222H5HVKV6H8C64DP5\",\"schedule\":{\"type\":\"balance\"},\"status\":\"active\",\"targetAmount\":{\"currency\":\"EUR\",\"value\":0},\"triggerAmount\":{\"currency\":\"EUR\",\"value\":0},\"type\":\"pull\",\"counterparty\":{\"balanceAccountId\":\"BA3227C223222H5HVKT3H9WLC\"},\"currency\":\"EUR\"}},\"environment\":\"test\",\"type\":\"balancePlatform.balanceAccountSweep.updated\"}";
var signKey = "D7DD5BA6146493707BF0BE7496F6404EC7A63616B7158EC927B9F54BB436765F";
var hmacKey = "9Qz9S/0xpar1klkniKdshxpAhRKbiSAewPpWoxKefQA=";
var hmacKey = "D7DD5BA6146493707BF0BE7496F6404EC7A63616B7158EC927B9F54BB436765F";
var hmacSignature = "9Qz9S/0xpar1klkniKdshxpAhRKbiSAewPpWoxKefQA=";
var hmacValidator = new HmacValidator();
bool response = hmacValidator.IsValidWebhook(hmacKey, signKey, notification);
Assert.IsTrue(response);
bool response = hmacValidator.IsValidWebhook(hmacSignature, hmacKey, notification);
Assert.IsTrue(response);
}

[TestMethod]
Expand All @@ -44,7 +44,7 @@ public void TestSerializationShopperInteractionDefaultIsZero()
[TestMethod]
public void TestNotificationRequestItemHmac()
{
var key = "DFB1EB5485895CFA84146406857104ABB4CBCABDC8AAF103A624C8F6A3EAAB00";
var hmacKey = "DFB1EB5485895CFA84146406857104ABB4CBCABDC8AAF103A624C8F6A3EAAB00";
var expectedSign = "ipnxGCaUZ4l8TUW75a71/ghd2Fe5ffvX0pV4TLTntIc=";
var additionalData = new Dictionary<string, string>
{
Expand All @@ -64,23 +64,23 @@ public void TestNotificationRequestItemHmac()
var hmacValidator = new HmacValidator();
var data = hmacValidator.GetDataToSign(notificationRequestItem);
Assert.AreEqual("pspReference:originalReference:merchantAccount:reference:1000:EUR:EVENT:true", data);
var encrypted = hmacValidator.CalculateHmac(notificationRequestItem, key);
var encrypted = hmacValidator.CalculateHmac(notificationRequestItem, hmacKey);
Assert.AreEqual(expectedSign, encrypted);
Assert.IsTrue(hmacValidator.IsValidHmac(notificationRequestItem, key));
Assert.IsTrue(hmacValidator.IsValidHmac(notificationRequestItem, hmacKey));
notificationRequestItem.AdditionalData["hmacSignature"] = "notValidSign";
Assert.IsFalse(hmacValidator.IsValidHmac(notificationRequestItem, key));
Assert.IsFalse(hmacValidator.IsValidHmac(notificationRequestItem, hmacKey));
}

[TestMethod]
public void TestHmacCalculationNotificationRequestWithSpecialChars()
{
string key = "66B61474A0AA3736BA8789EDC6D6CD9EBA0C4F414A554E32A407F849C045C69D";
string hmacKey = "66B61474A0AA3736BA8789EDC6D6CD9EBA0C4F414A554E32A407F849C045C69D";
var mockPath = GetMockFilePath("mocks/notification-response-refund-fail.json");
var response = MockFileToString(mockPath);
var hmacValidator = new HmacValidator();
var notificationRequest = JsonOperation.Deserialize<NotificationRequest>(response);
var notificationItem = notificationRequest.NotificationItemContainers[0].NotificationItem;
var isValidHmac = hmacValidator.IsValidHmac(notificationItem, key);
var isValidHmac = hmacValidator.IsValidHmac(notificationItem, hmacKey);
Assert.IsTrue(isValidHmac);
}

Expand All @@ -107,10 +107,10 @@ public void TestNullHmacValidator()
Success = true,
AdditionalData = null
};
var isValidHmacAdditionalDataNull = hmacValidator.IsValidHmac(notificationRequestItem, "key");
var isValidHmacAdditionalDataNull = hmacValidator.IsValidHmac(notificationRequestItem, "hmacKey");
Assert.IsFalse(isValidHmacAdditionalDataNull);
notificationRequestItem.AdditionalData = new Dictionary<string, string>();
var isValidHmacAdditionalDataEmpty = hmacValidator.IsValidHmac(notificationRequestItem, "key");
var isValidHmacAdditionalDataEmpty = hmacValidator.IsValidHmac(notificationRequestItem, "hmacKey");
Assert.IsFalse(isValidHmacAdditionalDataEmpty);
}

Expand Down
17 changes: 9 additions & 8 deletions Adyen/Util/HMACValidator.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ public class HmacValidator
private const string HmacSignature = "hmacSignature";

// Computes the Base64 encoded signature using the HMAC algorithm with the HMACSHA256 hashing function.
public string CalculateHmac(string signingstring, string hmacKey)
public string CalculateHmac(string payload, string hmacKey)
{
byte[] key = PackH(hmacKey);
byte[] data = Encoding.UTF8.GetBytes(signingstring);
byte[] data = Encoding.UTF8.GetBytes(payload);

try
{
Expand Down Expand Up @@ -94,19 +94,20 @@ public bool IsValidHmac(NotificationRequestItem notificationRequestItem, string
return string.Equals(expectedSign, merchantSign);
}


/// <summary>
/// Validates a balance platform and management webhook payload with the given <paramref name="hmacKey"/> and <paramref name="hmacSignature"/>.
/// Validates a balance platform and management webhook payload with the given <paramref name="hmacSignature"/> and <paramref name="hmacKey"/>.
/// </summary>
/// <param name="hmacKey">The HMAC key, retrieved from the Adyen Customer Area.</param>
/// <param name="hmacSignature">The HMAC signature, retrieved from the request header.</param>
/// <param name="hmacKey">The HMAC key, retrieved from the Adyen Customer Area.</param>
/// <param name="payload">The webhook payload.</param>
/// <returns>A return value indicates the HMAC validation succeeded.</returns>
public bool IsValidWebhook(string hmacKey, string hmacSignature, string payload)
public bool IsValidWebhook(string hmacSignature, string hmacKey, string payload)
{
var calculatedSign = CalculateHmac(payload, hmacSignature);
return TimeSafeEquals(Encoding.UTF8.GetBytes(hmacKey), Encoding.UTF8.GetBytes(calculatedSign));
var calculatedSign = CalculateHmac(payload, hmacKey);
return TimeSafeEquals(Encoding.UTF8.GetBytes(hmacSignature), Encoding.UTF8.GetBytes(calculatedSign));
}

/// This method compares two bytestrings in constant time based on length of shortest bytestring to prevent timing attacks.
private static bool TimeSafeEquals(byte[] a, byte[] b)
{
Expand Down

0 comments on commit 670627c

Please sign in to comment.