Skip to content

Commit

Permalink
feat: rename IsValidWebhookSignature to IsValidSignature in `Webh…
Browse files Browse the repository at this point in the history
…ookValidation
  • Loading branch information
TheUnderScorer committed Nov 18, 2024
1 parent 77e0c16 commit a8058e2
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 12 deletions.
5 changes: 5 additions & 0 deletions .changeset/nine-trainers-jam.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"fingerprint-pro-server-api-dotnet-sdk": major
---

Rename `IsValidWebhookSignature` to `IsValidSignature` in `WebhookValidation`
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
4 changes: 2 additions & 2 deletions docs/WebhookValidation.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
12 changes: 6 additions & 6 deletions src/FingerprintPro.ServerSdk.Test/WebhookValidationTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ 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);
}

[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);
}
Expand All @@ -29,31 +29,31 @@ 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);
}

[Test]
public void EmptyHeaderTest()
{
var result = WebhookValidation.IsValidWebhookSignature("invalid", Data, _secret);
var result = WebhookValidation.IsValidSignature("invalid", Data, _secret);

Assert.That(result, Is.False);
}

[Test]
public void EmptySecretTest()
{
var result = WebhookValidation.IsValidWebhookSignature("invalid", Data, "");
var result = WebhookValidation.IsValidSignature("invalid", Data, "");

Assert.That(result, Is.False);
}

[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);
}
Expand Down
2 changes: 1 addition & 1 deletion src/FingerprintPro.ServerSdk.WebhookExample/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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!");
2 changes: 1 addition & 1 deletion src/FingerprintPro.ServerSdk/WebhookValidation.cs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ private static bool IsValidHmacSignature(string signature, byte[] data, string s
/// <param name="header">The value of the "fpjs-event-signature" header.</param>
/// <param name="data">The raw data of the incoming request.</param>
/// <param name="secret">The secret key used to sign the request</param>
public static bool IsValidWebhookSignature(string header, byte[] data, string secret)
public static bool IsValidSignature(string header, byte[] data, string secret)
{
var signatures = header.Split(',');

Expand Down
2 changes: 1 addition & 1 deletion template/README.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down

0 comments on commit a8058e2

Please sign in to comment.