Skip to content

Commit a8058e2

Browse files
feat: rename IsValidWebhookSignature to IsValidSignature in `WebhookValidation
1 parent 77e0c16 commit a8058e2

File tree

7 files changed

+17
-12
lines changed

7 files changed

+17
-12
lines changed

.changeset/nine-trainers-jam.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"fingerprint-pro-server-api-dotnet-sdk": major
3+
---
4+
5+
Rename `IsValidWebhookSignature` to `IsValidSignature` in `WebhookValidation`

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ public class WebhookController : ControllerBase
163163
var data = memoryStream.ToArray();
164164

165165
// Validate webhook signature
166-
var isValid = Webhook.IsValidWebhookSignature(
166+
var isValid = Webhook.IsValidSignature(
167167
header,
168168
data,
169169
secret);

docs/WebhookValidation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# FingerprintPro.ServerSdk.WebhookValidation
22

3-
## **IsValidWebhookSignature**
3+
## **IsValidSignature**
44

5-
> bool IsValidWebhookSignature(string header, byte[] data, string secret)
5+
> bool IsValidSignature(string header, byte[] data, string secret)
66
77
Verifies the HMAC signature extracted from the "fpjs-event-signature" header of the incoming request. This is a part of
88
the webhook signing process, which is available only for enterprise customers.

src/FingerprintPro.ServerSdk.Test/WebhookValidationTests.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ public class WebhookValidationTests
1212
[Test]
1313
public void ValidHeaderTest()
1414
{
15-
var result = WebhookValidation.IsValidWebhookSignature(_validHeader, Data, _secret);
15+
var result = WebhookValidation.IsValidSignature(_validHeader, Data, _secret);
1616

1717
Assert.That(result, Is.True);
1818
}
1919

2020
[Test]
2121
public void InvalidHeaderTest()
2222
{
23-
var result = WebhookValidation.IsValidWebhookSignature("v2=invalid", Data, _secret);
23+
var result = WebhookValidation.IsValidSignature("v2=invalid", Data, _secret);
2424

2525
Assert.That(result, Is.False);
2626
}
@@ -29,31 +29,31 @@ public void InvalidHeaderTest()
2929
[Test]
3030
public void HeaderWithoutVersionTest()
3131
{
32-
var result = WebhookValidation.IsValidWebhookSignature("invalid", Data, _secret);
32+
var result = WebhookValidation.IsValidSignature("invalid", Data, _secret);
3333

3434
Assert.That(result, Is.False);
3535
}
3636

3737
[Test]
3838
public void EmptyHeaderTest()
3939
{
40-
var result = WebhookValidation.IsValidWebhookSignature("invalid", Data, _secret);
40+
var result = WebhookValidation.IsValidSignature("invalid", Data, _secret);
4141

4242
Assert.That(result, Is.False);
4343
}
4444

4545
[Test]
4646
public void EmptySecretTest()
4747
{
48-
var result = WebhookValidation.IsValidWebhookSignature("invalid", Data, "");
48+
var result = WebhookValidation.IsValidSignature("invalid", Data, "");
4949

5050
Assert.That(result, Is.False);
5151
}
5252

5353
[Test]
5454
public void EmptyDataTest()
5555
{
56-
var result = WebhookValidation.IsValidWebhookSignature(_validHeader, ""u8.ToArray(), _secret);
56+
var result = WebhookValidation.IsValidSignature(_validHeader, ""u8.ToArray(), _secret);
5757

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

src/FingerprintPro.ServerSdk.WebhookExample/Program.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
const string secret = "secret";
55
var data = "data"u8.ToArray();
66

7-
var isValid = WebhookValidation.IsValidWebhookSignature(header, data, secret);
7+
var isValid = WebhookValidation.IsValidSignature(header, data, secret);
88

99
Console.WriteLine(isValid ? "Webhook signature is correct!" : "Webhook signature is incorrect!");

src/FingerprintPro.ServerSdk/WebhookValidation.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ private static bool IsValidHmacSignature(string signature, byte[] data, string s
2222
/// <param name="header">The value of the "fpjs-event-signature" header.</param>
2323
/// <param name="data">The raw data of the incoming request.</param>
2424
/// <param name="secret">The secret key used to sign the request</param>
25-
public static bool IsValidWebhookSignature(string header, byte[] data, string secret)
25+
public static bool IsValidSignature(string header, byte[] data, string secret)
2626
{
2727
var signatures = header.Split(',');
2828

template/README.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ public class WebhookController : ControllerBase
171171
var data = memoryStream.ToArray();
172172

173173
// Validate webhook signature
174-
var isValid = Webhook.IsValidWebhookSignature(
174+
var isValid = Webhook.IsValidSignature(
175175
header,
176176
data,
177177
secret);

0 commit comments

Comments
 (0)