pretix-webhook 0.2.0

Tower service for receiving pretix 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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
use std::{
    convert::Infallible,
    sync::{Arc, Mutex},
};

use bytes::Bytes;
use http::{Request, StatusCode};
use http_body_util::Full;
use pretix_webhook::{BasicAuthCredential, WebhookHandler, WebhookServiceBuilder};
use pretix_webhook_events::WebhookEvent;
use tower::ServiceExt;

type Body = Full<Bytes>;

fn body(value: impl Into<Bytes>) -> Body {
    Full::new(value.into())
}

#[derive(Clone, Default)]
struct RecordingHandler {
    events: Arc<Mutex<Vec<WebhookEvent>>>,
}

impl WebhookHandler for RecordingHandler {
    type Error = Infallible;

    async fn handle(&self, event: WebhookEvent) -> Result<(), Self::Error> {
        self.events.lock().unwrap().push(event);
        Ok(())
    }
}

fn event_policy(organizer: &str, event: &str) -> WebhookServiceBuilder {
    WebhookServiceBuilder::new()
        .allow_organizer(organizer)
        .unwrap()
        .allow_event(event)
        .unwrap()
}

#[tokio::test]
async fn accepted_webhook_is_delivered_to_the_handler() {
    let handler = RecordingHandler::default();
    let recorded = Arc::clone(&handler.events);
    let app = event_policy("acmecorp", "democon").build(handler);
    let request = Request::post("/")
        .header("content-type", "application/json")
        .body(body(
            r#"{
                "notification_id": 123455,
                "organizer": "acmecorp",
                "event": "democon",
                "code": "ABC23",
                "action": "pretix.event.order.placed"
            }"#,
        ))
        .unwrap();

    let response = app.oneshot(request).await.unwrap();

    assert_eq!(response.status(), StatusCode::NO_CONTENT);
    let events = recorded.lock().unwrap();
    assert_eq!(events.len(), 1);
    assert_eq!(events[0].notification_id(), 123_455);
}

#[tokio::test]
async fn unsupported_organizers_and_events_are_hidden_with_not_found() {
    let app = WebhookServiceBuilder::new()
        .allow_organizer("acmecorp")
        .unwrap()
        .allow_event("democon")
        .unwrap()
        .build(RecordingHandler::default());

    for (organizer, event) in [("other", "democon"), ("acmecorp", "other")] {
        let payload = format!(
            r#"{{
                "notification_id": 1,
                "organizer": "{organizer}",
                "event": "{event}",
                "code": "ABC23",
                "action": "pretix.event.order.paid"
            }}"#
        );
        let request = Request::post("/")
            .header("content-type", "application/json")
            .body(body(payload))
            .unwrap();

        let response = app.clone().oneshot(request).await.unwrap();
        assert_eq!(response.status(), StatusCode::NOT_FOUND);
    }
}

#[tokio::test]
async fn new_config_accepts_every_organizer_and_event() {
    let app = WebhookServiceBuilder::new().build(RecordingHandler::default());
    for payload in [
        r#"{
            "notification_id": 1,
            "organizer": "previously-unknown",
            "event": "future-event",
            "action": "pretix.event.changed"
        }"#,
        r#"{
            "notification_id": 2,
            "action": "pretix.plugin.unknown"
        }"#,
    ] {
        let request = Request::post("/")
            .header("content-type", "application/json")
            .body(body(payload))
            .unwrap();
        let response = app.clone().oneshot(request).await.unwrap();
        assert_eq!(response.status(), StatusCode::NO_CONTENT);
    }
}

#[tokio::test]
async fn organizer_and_event_filters_are_independent() {
    let cases = [
        (
            WebhookServiceBuilder::new()
                .allow_organizer("acmecorp")
                .unwrap(),
            "acmecorp",
            "any-event",
            StatusCode::NO_CONTENT,
        ),
        (
            WebhookServiceBuilder::new()
                .allow_organizer("acmecorp")
                .unwrap(),
            "other",
            "any-event",
            StatusCode::NOT_FOUND,
        ),
        (
            WebhookServiceBuilder::new().allow_event("democon").unwrap(),
            "any-organizer",
            "democon",
            StatusCode::NO_CONTENT,
        ),
        (
            WebhookServiceBuilder::new().allow_event("democon").unwrap(),
            "any-organizer",
            "other",
            StatusCode::NOT_FOUND,
        ),
    ];

    for (config, organizer, event, expected) in cases {
        let app = config.build(RecordingHandler::default());
        let payload = format!(
            r#"{{
                "notification_id": 1,
                "organizer": "{organizer}",
                "event": "{event}",
                "action": "pretix.event.changed"
            }}"#
        );
        let request = Request::post("/").body(body(payload)).unwrap();
        let response = app.oneshot(request).await.unwrap();
        assert_eq!(response.status(), expected);
    }
}

#[tokio::test]
async fn organizer_level_payloads_enforce_only_the_organizer_filter() {
    let config = event_policy("acmecorp", "event-filter-is-not-applicable");

    for (organizer, expected) in [
        ("acmecorp", StatusCode::NO_CONTENT),
        ("other", StatusCode::NOT_FOUND),
    ] {
        let app = config.clone().build(RecordingHandler::default());
        let payload = format!(
            r#"{{
                "notification_id": 1,
                "organizer": "{organizer}",
                "customer": "customer-1",
                "action": "pretix.customer.created"
            }}"#
        );
        let request = Request::post("/").body(body(payload)).unwrap();
        let response = app.oneshot(request).await.unwrap();
        assert_eq!(response.status(), expected);
    }
}

#[tokio::test]
async fn unknown_payloads_cannot_bypass_applicable_filters_with_missing_fields() {
    let organizer_filtered = WebhookServiceBuilder::new()
        .allow_organizer("acmecorp")
        .unwrap()
        .build(RecordingHandler::default());
    let missing_organizer = Request::post("/")
        .body(body(
            r#"{
                "notification_id": 1,
                "event": "democon",
                "action": "pretix.plugin.unknown"
            }"#,
        ))
        .unwrap();
    assert_eq!(
        organizer_filtered
            .oneshot(missing_organizer)
            .await
            .unwrap()
            .status(),
        StatusCode::NOT_FOUND
    );

    let event_filtered = WebhookServiceBuilder::new()
        .allow_event("democon")
        .unwrap()
        .build(RecordingHandler::default());
    let organizer_level = Request::post("/")
        .body(body(
            r#"{
                "notification_id": 1,
                "organizer": "acmecorp",
                "action": "pretix.plugin.organizer-level"
            }"#,
        ))
        .unwrap();
    assert_eq!(
        event_filtered
            .clone()
            .oneshot(organizer_level)
            .await
            .unwrap()
            .status(),
        StatusCode::NO_CONTENT
    );

    for unreadable_event in ["12345", "null", "[\"democon\"]"] {
        let payload = format!(
            r#"{{
                "notification_id": 1,
                "organizer": "acmecorp",
                "event": {unreadable_event},
                "action": "pretix.plugin.unknown"
            }}"#
        );
        let request = Request::post("/").body(body(payload)).unwrap();
        assert_eq!(
            event_filtered
                .clone()
                .oneshot(request)
                .await
                .unwrap()
                .status(),
            StatusCode::NOT_FOUND,
            "event field {unreadable_event} bypassed the event filter"
        );
    }
}

#[tokio::test]
async fn filter_matching_is_exact_and_case_sensitive() {
    let app = event_policy("AcmeCorp", "DemoCon").build(RecordingHandler::default());

    for (organizer, event, expected) in [
        ("AcmeCorp", "DemoCon", StatusCode::NO_CONTENT),
        ("acmecorp", "DemoCon", StatusCode::NOT_FOUND),
        ("AcmeCorp", "democon", StatusCode::NOT_FOUND),
    ] {
        let payload = format!(
            r#"{{
                "notification_id": 1,
                "organizer": "{organizer}",
                "event": "{event}",
                "action": "pretix.event.changed"
            }}"#
        );
        let request = Request::post("/").body(body(payload)).unwrap();
        assert_eq!(
            app.clone().oneshot(request).await.unwrap().status(),
            expected
        );
    }
}

#[test]
fn filter_values_reject_only_empty_or_padded_slugs() {
    for value in ["", " padded", "padded ", "\tpadded"] {
        assert!(WebhookServiceBuilder::new().allow_organizer(value).is_err());
        assert!(WebhookServiceBuilder::new().allow_event(value).is_err());
    }

    let non_pretix_slug = format!("legacy:value-{}", "x".repeat(300));
    assert!(
        WebhookServiceBuilder::new()
            .allow_organizer(&non_pretix_slug)
            .is_ok()
    );
    assert!(
        WebhookServiceBuilder::new()
            .allow_event(non_pretix_slug)
            .is_ok()
    );
}

#[test]
fn debug_output_reports_policy_size_without_disclosing_it() {
    let config = event_policy("private-organizer", "private-event")
        .require_basic_auth([BasicAuthCredential::new("private-user", "private-secret")]);

    let debug = format!("{config:?}");

    for value in [
        "private-organizer",
        "private-event",
        "private-user",
        "private-secret",
    ] {
        assert!(!debug.contains(value), "value leaked in {debug:?}");
    }
    assert_eq!(
        debug,
        "WebhookServiceBuilder { organizers: <1 REDACTED>, events: <1 REDACTED>, credentials: <1 REDACTED>, body_limit: 2097152 }"
    );
}

#[tokio::test]
async fn any_configured_basic_auth_credential_is_accepted() {
    let app = WebhookServiceBuilder::new()
        .require_basic_auth([
            BasicAuthCredential::new("old", "secret"),
            BasicAuthCredential::new("current", "new-secret"),
        ])
        .build(RecordingHandler::default());
    let payload = r#"{
        "notification_id": 1,
        "organizer": "acmecorp",
        "event": "democon",
        "action": "pretix.event.changed"
    }"#;

    for authorization in [None, Some("Basic d3Jvbmc6d3Jvbmc=")] {
        let mut request = Request::post("/")
            .header("content-type", "application/json")
            .body(body(payload))
            .unwrap();
        if let Some(authorization) = authorization {
            request
                .headers_mut()
                .insert("authorization", authorization.parse().unwrap());
        }

        let response = app.clone().oneshot(request).await.unwrap();
        assert_eq!(response.status(), StatusCode::UNAUTHORIZED);
        assert_eq!(
            response.headers().get("www-authenticate").unwrap(),
            "Basic realm=\"pretix-webhook\""
        );
    }

    for authorization in ["Basic b2xkOnNlY3JldA==", "Basic Y3VycmVudDpuZXctc2VjcmV0"] {
        let request = Request::post("/")
            .header("content-type", "application/json")
            .header("authorization", authorization)
            .body(body(payload))
            .unwrap();

        let response = app.clone().oneshot(request).await.unwrap();
        assert_eq!(response.status(), StatusCode::NO_CONTENT);
    }
}

#[tokio::test]
async fn empty_basic_auth_credentials_disable_authentication() {
    let app = WebhookServiceBuilder::new()
        .require_basic_auth([])
        .build(RecordingHandler::default());
    let request = Request::post("/")
        .body(body(
            r#"{
                "notification_id": 1,
                "organizer": "acmecorp",
                "event": "democon",
                "action": "pretix.event.changed"
            }"#,
        ))
        .unwrap();

    let response = app.oneshot(request).await.unwrap();

    assert_eq!(response.status(), StatusCode::NO_CONTENT);
}

#[tokio::test]
async fn malformed_payload_returns_bad_request() {
    let app = WebhookServiceBuilder::new().build(RecordingHandler::default());
    let request = Request::post("/")
        .header("content-type", "application/json")
        .body(body("not json"))
        .unwrap();

    let response = app.oneshot(request).await.unwrap();
    assert_eq!(response.status(), StatusCode::BAD_REQUEST);
}

#[tokio::test]
async fn default_body_limit_rejects_oversized_payloads() {
    let app = WebhookServiceBuilder::new().build(RecordingHandler::default());
    let request = Request::post("/")
        .body(body(vec![b' '; 2 * 1024 * 1024 + 1]))
        .unwrap();

    let response = app.oneshot(request).await.unwrap();

    assert_eq!(response.status(), StatusCode::PAYLOAD_TOO_LARGE);
}

#[tokio::test]
async fn authentication_is_checked_before_payload_parsing() {
    let app = WebhookServiceBuilder::new()
        .require_basic_auth([BasicAuthCredential::new("user", "secret")])
        .build(RecordingHandler::default());
    let unauthenticated = Request::post("/").body(body("not json")).unwrap();
    assert_eq!(
        app.clone().oneshot(unauthenticated).await.unwrap().status(),
        StatusCode::UNAUTHORIZED
    );

    let authenticated = Request::post("/")
        .header("authorization", "Basic dXNlcjpzZWNyZXQ=")
        .body(body("not json"))
        .unwrap();
    assert_eq!(
        app.oneshot(authenticated).await.unwrap().status(),
        StatusCode::BAD_REQUEST
    );
}

#[derive(Clone)]
struct FailingHandler;

impl WebhookHandler for FailingHandler {
    type Error = &'static str;

    async fn handle(&self, _event: WebhookEvent) -> Result<(), Self::Error> {
        Err("downstream unavailable")
    }
}

#[tokio::test]
async fn handler_failure_returns_retryable_server_error() {
    let app = WebhookServiceBuilder::new().build(FailingHandler);
    let request = Request::post("/")
        .header("content-type", "application/json")
        .body(body(
            r#"{
                "notification_id": 1,
                "organizer": "acmecorp",
                "event": "democon",
                "action": "pretix.event.changed"
            }"#,
        ))
        .unwrap();

    let response = app.oneshot(request).await.unwrap();
    assert_eq!(response.status(), StatusCode::INTERNAL_SERVER_ERROR);
}