axum-standardwebhooks 1.0.0

Axum extractor that verifies signature for Standard Webhooks
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

# axum-standardwebhooks

[![Crates.io](https://img.shields.io/crates/v/axum-standardwebhooks.svg)](https://crates.io/crates/axum-standardwebhooks)
[![Documentation](https://docs.rs/axum-standardwebhooks/badge.svg)](https://docs.rs/axum-standardwebhooks)
[![MIT/Apache-2.0 licensed](https://img.shields.io/crates/l/axum-standardwebhooks.svg)](./LICENSE)

A library providing [Axum](https://github.com/tokio-rs/axum) extractors for validating webhooks according to the [Standard Webhooks specification](https://www.standardwebhooks.com/).

## Features

- Simple, ergonomic extractor for validating Standard Webhooks signatures
- Rejects requests with invalid or missing signatures
- Works with Axum's state management for shared webhook verifier
- Works with any existing body extractor that implements `FromRequest`

## Installation

Add the dependency to your `Cargo.toml`:

```toml
[dependencies]
axum-standardwebhooks = "1"
```

## Usage

### Basic example

```rust
use axum::{Router, routing::post, Json};
use axum_standardwebhooks::{StandardWebhook, SharedWebhook, Webhook};
use serde_json::Value;
use std::sync::Arc;
use axum::extract::FromRef;

async fn webhook_handler(StandardWebhook(Json(payload)): StandardWebhook<Json<Value>>) -> String {
    // The webhook signature has been verified, and we can safely use the payload
    format!("Received webhook: {}", payload)
}

#[derive(Clone)]
struct AppState {
    webhook: SharedWebhook,
}

impl FromRef<AppState> for SharedWebhook {
    fn from_ref(state: &AppState) -> Self {
        state.webhook.clone()
    }
}

#[tokio::main]
async fn main() {
    let app = Router::new()
        .route("/webhooks", post(webhook_handler))
        .with_state(AppState {
            webhook: SharedWebhook::new(Webhook::new("whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD").unwrap()),
        });

    let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await.unwrap();
    axum::serve(listener, app).await.unwrap();
}
```

## License

Licensed under either of:

* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.