Struct SendGridWebhook 

pub struct SendGridWebhook { /* private fields */ }

Available on crate feature sendgrid only.

Sendgrid webhook

Looks for X-Twilio-Email-Event-Webhook-Signature and X-Twilio-Email-Event-Webhook-Timestamp headers. Signature header should be base64 ECDSA P256 ASN1 signature of {timestamp}{body}

SendGrid docs

Implementations

impl SendGridWebhook

pub fn with_public_key(public_key: impl AsRef<str>) -> Result<Self, DecodeError>

Instantiate using the base64 public key from SendGrid

Trait Implementations

impl Webhook for SendGridWebhook

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 WebhookPublicKey for SendGridWebhook

type ALG = EcdsaP256Asn1

Available on crate feature public-key only.

Algorithm used for verification

async fn public_key( &self, _req: &Request<'_>, ) -> Outcome<'_, Bytes, WebhookError>

Available on crate feature public-key only.

Get the public key for the webhook signature. This is async in case the public key needs to be fetched externally. The public key can be cached in Rocket state, accessible via req.rocket().state().

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

Available on crate feature public-key only.

Get the expected signature from the request

fn message_to_verify( &self, req: &Request<'_>, body: &Bytes, time_bounds: (u32, u32), ) -> Outcome<'_, Bytes, WebhookError>

Available on crate feature public-key only.

Get the message that needs to be verified. Any adjustments can be made to the body here before calculating the signature (e.g. prefixes or hashes, etc.)

fn validate_with_public_key( &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,

Available on crate feature public-key only.

Read the raw body and verify with the public key and configured algorithm