tower-github-webhook 0.2.0

tower-github-webhook is a crate that simplifies validating webhooks received from GitHub
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

use crate::ValidateGitHubWebhook;
use tower_layer::Layer;

/// Layer that applies the [ValidateGitHubWebhook] middleware which authorizes all requests using
/// the `X-Hub-Signature-256` header.
#[derive(Clone)]
pub struct ValidateGitHubWebhookLayer<Secret> {
    webhook_secret: Secret,
}

impl<Secret> ValidateGitHubWebhookLayer<Secret> {
    /// Authorize requests using the `X-Hub-Signature-256` header. If the signature specified in
    /// that header is not signed using the `webhook_secret` secret, the request will fail.
    ///
    /// The `webhook_secret` parameter can be any type that implements `AsRef<[u8]>` such as
    /// `String`. However, using `secrecy::SecretString` is recommended to prevent the secret from
    /// being printed in any logs.
    pub fn new(webhook_secret: Secret) -> Self {
        Self { webhook_secret }
    }
}

impl<S, Secret> Layer<S> for ValidateGitHubWebhookLayer<Secret>
where
    Secret: AsRef<[u8]> + Clone,
{
    type Service = ValidateGitHubWebhook<S>;

    fn layer(&self, inner: S) -> Self::Service {
        ValidateGitHubWebhook::new(self.webhook_secret.clone(), inner)
    }
}