Struct GitHubWebhook 

pub struct GitHubWebhook { /* private fields */ }

Available on crate feature github only.

GitHub webhook

Looks for hex signature in X-Hub-Signature-256 header, with a ‘sha256=’ prefix

GitHub docs

Implementations

impl GitHubWebhook

pub fn with_secret(secret_key: impl Into<Vec<u8>>) -> Self

Instantiate with the secret key

Trait Implementations

impl Webhook for GitHubWebhook

async fn validate_body( &self, req: &Request<'_>, body: impl AsyncRead + Unpin + Send + Sync, time_bounds: (u32, u32), ) -> Outcome<'_, Vec<u8>, WebhookError>

Read body and validate webhook. If the webhook uses a timestamp, verify that it is within the expected bounds (bounds are in unix epoch seconds).

fn validate_timestamp( &self, timestamp: &str, (min, max): (u32, u32), ) -> Outcome<'_, (), WebhookError>

Validate a timestamp against the given bounds. The default implementation assumes that it is in Unix epoch seconds, and returns a Bad Request error if it is invalid.

fn get_header<'r>( &self, req: &'r Request<'_>, name: &str, prefix: Option<&str>, ) -> Outcome<'_, &'r str, WebhookError>

Retrieve a header that’s expected for a webhook request. The default implementation looks for the header and returns a Bad Request error if it was not provided. It can also optionally strip a given prefix.

impl WebhookHmac for GitHubWebhook

type MAC = CoreWrapper<HmacCore<CoreWrapper<CtVariableCoreWrapper<Sha256VarCore, UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, OidSha256>>>>

Available on crate feature hmac only.

MAC algorithm (from the hmac crate) used to calculate the signature

fn secret_key(&self) -> &[u8]

Available on crate feature hmac only.

Get the secret key used to sign the webhook

fn expected_signatures( &self, req: &Request<'_>, ) -> Outcome<'_, Vec<Vec<u8>>, WebhookError>

Available on crate feature hmac only.

Get the expected signature(s) from the request. To obtain required headers, you can use the self.get_header() utility.

fn body_prefix( &self, req: &Request<'_>, time_bounds: (u32, u32), ) -> Outcome<'_, Option<Vec<u8>>, WebhookError>

Available on crate feature hmac only.

Get an optional prefix to attach to the raw body when calculating the signature. Timestamps should be validated against the given bounds.

fn body_suffix( &self, req: &Request<'_>, time_bounds: (u32, u32), ) -> Outcome<'_, Option<Vec<u8>>, WebhookError>

Available on crate feature hmac only.

Get an optional suffix to attach to the raw body when calculating the signature. Timestamps should be validated against the given bounds.

fn validate_with_hmac( &self, req: &Request<'_>, body: impl AsyncRead + Unpin + Send + Sync, time_bounds: (u32, u32), ) -> impl Future<Output = Outcome<'_, Vec<u8>, WebhookError>> + Send + Sync

where Self: Sync, Self::MAC: Sync,

Available on crate feature hmac only.

Read the request body and verify the HMAC signature. Calculates the HMAC directly from the raw streamed body (with a prefix if configured).