From a8058e29f70206f387271fbcd9c3b810a867c414 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Przemys=C5=82aw=20=C5=BBydek?= Date: Mon, 18 Nov 2024 14:49:39 +0100 Subject: [PATCH] feat: rename `IsValidWebhookSignature` to `IsValidSignature` in `WebhookValidation --- .changeset/nine-trainers-jam.md | 5 +++++ README.md | 2 +- docs/WebhookValidation.md | 4 ++-- .../WebhookValidationTests.cs | 12 ++++++------ .../Program.cs | 2 +- src/FingerprintPro.ServerSdk/WebhookValidation.cs | 2 +- template/README.mustache | 2 +- 7 files changed, 17 insertions(+), 12 deletions(-) create mode 100644 .changeset/nine-trainers-jam.md diff --git a/.changeset/nine-trainers-jam.md b/.changeset/nine-trainers-jam.md new file mode 100644 index 0000000..c69d2e5 --- /dev/null +++ b/.changeset/nine-trainers-jam.md @@ -0,0 +1,5 @@ +--- +"fingerprint-pro-server-api-dotnet-sdk": major +--- + +Rename `IsValidWebhookSignature` to `IsValidSignature` in `WebhookValidation` diff --git a/README.md b/README.md index 13f1446..cbe425c 100644 --- a/README.md +++ b/README.md @@ -163,7 +163,7 @@ public class WebhookController : ControllerBase var data = memoryStream.ToArray(); // Validate webhook signature - var isValid = Webhook.IsValidWebhookSignature( + var isValid = Webhook.IsValidSignature( header, data, secret); diff --git a/docs/WebhookValidation.md b/docs/WebhookValidation.md index 3e02224..3b66f8d 100644 --- a/docs/WebhookValidation.md +++ b/docs/WebhookValidation.md @@ -1,8 +1,8 @@ # FingerprintPro.ServerSdk.WebhookValidation -## **IsValidWebhookSignature** +## **IsValidSignature** -> bool IsValidWebhookSignature(string header, byte[] data, string secret) +> bool IsValidSignature(string header, byte[] data, string secret) Verifies the HMAC signature extracted from the "fpjs-event-signature" header of the incoming request. This is a part of the webhook signing process, which is available only for enterprise customers. diff --git a/src/FingerprintPro.ServerSdk.Test/WebhookValidationTests.cs b/src/FingerprintPro.ServerSdk.Test/WebhookValidationTests.cs index 331d461..13d783a 100644 --- a/src/FingerprintPro.ServerSdk.Test/WebhookValidationTests.cs +++ b/src/FingerprintPro.ServerSdk.Test/WebhookValidationTests.cs @@ -12,7 +12,7 @@ public class WebhookValidationTests [Test] public void ValidHeaderTest() { - var result = WebhookValidation.IsValidWebhookSignature(_validHeader, Data, _secret); + var result = WebhookValidation.IsValidSignature(_validHeader, Data, _secret); Assert.That(result, Is.True); } @@ -20,7 +20,7 @@ public void ValidHeaderTest() [Test] public void InvalidHeaderTest() { - var result = WebhookValidation.IsValidWebhookSignature("v2=invalid", Data, _secret); + var result = WebhookValidation.IsValidSignature("v2=invalid", Data, _secret); Assert.That(result, Is.False); } @@ -29,7 +29,7 @@ public void InvalidHeaderTest() [Test] public void HeaderWithoutVersionTest() { - var result = WebhookValidation.IsValidWebhookSignature("invalid", Data, _secret); + var result = WebhookValidation.IsValidSignature("invalid", Data, _secret); Assert.That(result, Is.False); } @@ -37,7 +37,7 @@ public void HeaderWithoutVersionTest() [Test] public void EmptyHeaderTest() { - var result = WebhookValidation.IsValidWebhookSignature("invalid", Data, _secret); + var result = WebhookValidation.IsValidSignature("invalid", Data, _secret); Assert.That(result, Is.False); } @@ -45,7 +45,7 @@ public void EmptyHeaderTest() [Test] public void EmptySecretTest() { - var result = WebhookValidation.IsValidWebhookSignature("invalid", Data, ""); + var result = WebhookValidation.IsValidSignature("invalid", Data, ""); Assert.That(result, Is.False); } @@ -53,7 +53,7 @@ public void EmptySecretTest() [Test] public void EmptyDataTest() { - var result = WebhookValidation.IsValidWebhookSignature(_validHeader, ""u8.ToArray(), _secret); + var result = WebhookValidation.IsValidSignature(_validHeader, ""u8.ToArray(), _secret); Assert.That(result, Is.False); } diff --git a/src/FingerprintPro.ServerSdk.WebhookExample/Program.cs b/src/FingerprintPro.ServerSdk.WebhookExample/Program.cs index 5b9e47f..76a0a6b 100644 --- a/src/FingerprintPro.ServerSdk.WebhookExample/Program.cs +++ b/src/FingerprintPro.ServerSdk.WebhookExample/Program.cs @@ -4,6 +4,6 @@ const string secret = "secret"; var data = "data"u8.ToArray(); -var isValid = WebhookValidation.IsValidWebhookSignature(header, data, secret); +var isValid = WebhookValidation.IsValidSignature(header, data, secret); Console.WriteLine(isValid ? "Webhook signature is correct!" : "Webhook signature is incorrect!"); diff --git a/src/FingerprintPro.ServerSdk/WebhookValidation.cs b/src/FingerprintPro.ServerSdk/WebhookValidation.cs index 601deba..b3c3767 100644 --- a/src/FingerprintPro.ServerSdk/WebhookValidation.cs +++ b/src/FingerprintPro.ServerSdk/WebhookValidation.cs @@ -22,7 +22,7 @@ private static bool IsValidHmacSignature(string signature, byte[] data, string s /// The value of the "fpjs-event-signature" header. /// The raw data of the incoming request. /// The secret key used to sign the request - public static bool IsValidWebhookSignature(string header, byte[] data, string secret) + public static bool IsValidSignature(string header, byte[] data, string secret) { var signatures = header.Split(','); diff --git a/template/README.mustache b/template/README.mustache index d3152c9..cd0310a 100644 --- a/template/README.mustache +++ b/template/README.mustache @@ -171,7 +171,7 @@ public class WebhookController : ControllerBase var data = memoryStream.ToArray(); // Validate webhook signature - var isValid = Webhook.IsValidWebhookSignature( + var isValid = Webhook.IsValidSignature( header, data, secret);