Philiprehberger.WebhookSignature 0.2.7

Philiprehberger.WebhookSignature

HMAC webhook signing and verification with replay prevention — supports SHA-256, SHA-384, and SHA-512.

Installation

dotnet add package Philiprehberger.WebhookSignature

Usage

using Philiprehberger.WebhookSignature;

// Sign a payload (defaults to HMAC-SHA256)
var signature = Webhook.Sign(payload, "your-secret");

// Verify a signature
bool valid = Webhook.Verify(payload, signature, "your-secret");

// With custom replay tolerance (default: 300 seconds)
bool valid = Webhook.Verify(payload, signature, "your-secret", toleranceSeconds: 60);

Algorithm Selection

Choose between SHA-256, SHA-384, and SHA-512:

// Sign with SHA-512
var signature = Webhook.Sign(payload, "your-secret", algorithm: HashAlgorithm.SHA512);

// Verify with SHA-512
bool valid = Webhook.Verify(payload, signature, "your-secret", algorithm: HashAlgorithm.SHA512);

Header Extraction

Extract signatures from HTTP header dictionaries with case-insensitive matching:

var headers = new Dictionary<string, string>
{
    ["X-Webhook-Signature"] = signature
};

// Uses "X-Webhook-Signature" by default
string? sig = Webhook.ExtractFromHeaders(headers);

// Or specify a custom header name
string? sig = Webhook.ExtractFromHeaders(headers, "X-Custom-Sig");

Key Rotation

Verify against multiple secrets during key rotation:

var secrets = new[] { "new-secret", "old-secret" };
bool valid = Webhook.VerifyWithKeyRotation(payload, signature, secrets);

// With custom tolerance and algorithm
bool valid = Webhook.VerifyWithKeyRotation(
    payload, signature, secrets,
    toleranceSeconds: 60,
    algorithm: HashAlgorithm.SHA512);

Dependency Injection

var verifier = new WebhookVerifier("your-secret", toleranceSeconds: 300);
bool valid = verifier.Verify(payload, signature);

// With a specific algorithm
var verifier = new WebhookVerifier("your-secret", algorithm: HashAlgorithm.SHA384);

ASP.NET Controller

[HttpPost("webhook")]
public IActionResult HandleWebhook(
    [FromBody] string payload,
    [FromHeader(Name = "X-Signature")] string signature)
{
    if (!Webhook.Verify(payload, signature, _secret))
        return Unauthorized();

    // Process webhook...
    return Ok();
}

API

Signature Format

Signatures use the format {unix-timestamp}.{hex-encoded-hmac}. The timestamp is included in the HMAC input to prevent replay attacks.

Development

dotnet build src/Philiprehberger.WebhookSignature.csproj --configuration Release

Support

If you find this project useful:

⭐ Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

License

MIT