rocket-webhook 0.1.0-alpha.2

Webhook validation for Rocket applications
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

use std::{error::Error, fmt::Display};

/// Possible errors when receiving a webhook
#[derive(Debug)]
pub enum WebhookError {
    /// Signature verification failed
    Signature(String),
    /// Missing required header
    MissingHeader(String),
    /// Invalid required header
    InvalidHeader(String),
    /// Timestamp was invalid and/or not within expected bounds
    Timestamp(String),
    /// Error deserializing webhook payload
    Deserialize(rocket::serde::json::serde_json::Error),
    /// Error while reading the body of the webhook
    Read(std::io::Error),
    /// The webhook was not setup properly on the Rocket instance
    NotAttached,
}

impl Display for WebhookError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            WebhookError::Signature(e) => write!(f, "Failed to validate signature: {e}"),
            WebhookError::MissingHeader(name) => write!(f, "Missing header '{name}'"),
            WebhookError::InvalidHeader(err) => write!(f, "Header has invalid format: {err}"),
            WebhookError::Timestamp(time) => write!(f, "Invalid timestamp: {time}"),
            WebhookError::Deserialize(err) => {
                write!(f, "Failed to deserialize webhook payload: {err}")
            }
            WebhookError::Read(err) => write!(f, "Failed to read webhook body: {err}"),
            WebhookError::NotAttached => {
                write!(f, "Webhook of this type is not attached to Rocket")
            }
        }
    }
}

impl Error for WebhookError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            WebhookError::Deserialize(err) => Some(err),
            WebhookError::Read(err) => Some(err),
            _ => None,
        }
    }
}