Skip to main content

SignatureValidator

Struct SignatureValidator 

Source
pub struct SignatureValidator { /* private fields */ }
Expand description

Validates GitHub webhook signatures using HMAC-SHA256.

This validator ensures webhook payloads are authentic by verifying the X-Hub-Signature-256 header against the payload using the webhook secret.

§Security

  • Uses constant-time comparison to prevent timing attacks
  • Never logs secrets or signature values
  • Validates signature format before HMAC computation
  • Completes validation in under 100ms

§Examples

use github_bot_sdk::webhook::SignatureValidator;
use github_bot_sdk::auth::SecretProvider;
use std::sync::Arc;

let validator = SignatureValidator::new(secret_provider);

let payload = b"{\"action\":\"opened\",\"number\":1}";
let signature = "sha256=a1b2c3d4...";  // From X-Hub-Signature-256 header

if validator.validate(payload, signature).await? {
    println!("Valid webhook");
} else {
    println!("Invalid signature - rejecting webhook");
}

Implementations§

Source§

impl SignatureValidator

Source

pub fn new(secrets: Arc<dyn SecretProvider>) -> Self

Create a new signature validator.

§Arguments
  • secrets - Provider for retrieving webhook secrets
§Examples
let validator = SignatureValidator::new(secret_provider);
Source

pub async fn validate( &self, payload: &[u8], signature: &str, ) -> Result<bool, ValidationError>

Validate a webhook signature.

Verifies that the signature matches the HMAC-SHA256 of the payload using the webhook secret. Uses constant-time comparison to prevent timing attacks.

§Arguments
  • payload - The raw webhook payload bytes
  • signature - The signature from X-Hub-Signature-256 header (format: “sha256=<hex>”)
§Returns
  • Ok(true) - Signature is valid
  • Ok(false) - Signature is invalid (tampered payload or wrong secret)
  • Err - Validation error (malformed signature, secret retrieval failure)
§Examples
let payload = b"{\"action\":\"opened\"}";
let signature = "sha256=5c4a...";

match validator.validate(payload, signature).await {
    Ok(true) => println!("Valid webhook"),
    Ok(false) => println!("Invalid signature"),
    Err(e) => println!("Validation error: {}", e),
}

Trait Implementations§

Source§

impl Clone for SignatureValidator

Source§

fn clone(&self) -> SignatureValidator

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SignatureValidator

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more