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
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

use std::path::PathBuf;
use std::sync::RwLock;

use crates::http::{self, HeaderMap, Method, Request, Response, StatusCode};
use crates::serde_json::{self, Value};

use config::{Config, ConfigError};

/// A router for the Iron framework.
///
/// Drops JSON objects which are received via `POST` into a directory using the current date as the
/// filename.
pub struct Router {
    /// The path to the configuration file.
    path: PathBuf,
    /// The configuration for sorting objects based on their type.
    config: RwLock<Config>,
    /// The secrets for various projects.
    secrets: RwLock<Value>,
}

impl Router {
    /// Create a new router for a path.
    pub fn new<P: Into<PathBuf>>(path: P) -> Result<Self, ConfigError> {
        let path = path.into();
        let config = Config::from_path(&path)?;

        Ok(Self {
            path,

            secrets: RwLock::new(config.secrets()?),
            config: RwLock::new(config),
        })
    }

    /// Reload the filename.
    fn reload(&self) -> http::Result<Response<String>> {
        match Config::from_path(&self.path) {
            Ok(config) => {
                {
                    let mut inner_config = self
                        .config
                        .write()
                        .expect("expected to be able to get a write lock on the configuration");

                    *inner_config = config;
                }

                self.reload_secrets()
            },
            Err(err) => {
                error!("failed to load configuration: {:?}", err);

                Response::builder()
                    .status(StatusCode::NOT_ACCEPTABLE)
                    .body(format!("{:?}", err))
            },
        }
    }

    /// Reload secrets.
    fn reload_secrets(&self) -> http::Result<Response<String>> {
        let config = self
            .config
            .read()
            .expect("expected to be able to get a read lock on the configuration");

        match config.secrets() {
            Ok(secrets) => {
                let mut inner_secrets = self
                    .secrets
                    .write()
                    .expect("expected to be able to get a write lock on the secrets");

                *inner_secrets = secrets;

                Response::builder()
                    .status(StatusCode::OK)
                    .body(String::new())
            },
            Err(err) => {
                error!("failed to load secrets: {:?}", err);

                Response::builder()
                    .status(StatusCode::NOT_ACCEPTABLE)
                    .body(format!("{:?}", err))
            },
        }
    }

    /// Handle an object received over the given path.
    fn handle_impl(
        &self,
        path: &str,
        headers: &HeaderMap,
        data: &[u8],
        object: Value,
    ) -> http::Result<Response<()>> {
        let config = self
            .config
            .read()
            .expect("expected to be able to get a read lock on the configuration");

        if let Some(handler) = config.post_paths.get(path) {
            let secret = {
                let secrets = self
                    .secrets
                    .read()
                    .expect("expected to be able to get a read lock on the secrets");

                handler.lookup_secret(&secrets, &object).map(String::from)
            };

            if !handler.verify(headers, secret.as_ref().map(AsRef::as_ref), data) {
                error!(
                    target: "handler",
                    "failed to verify the a webhook:\nheaders:\n{:?}\ndata:\n{}",
                    headers,
                    String::from_utf8_lossy(data),
                );

                return Response::builder()
                    .status(StatusCode::NOT_ACCEPTABLE)
                    .body(());
            }

            if let Some(kind) = handler.kind(headers, &object) {
                if let Err(err) = handler.write_object(&kind, object.clone()) {
                    error!(
                        target: "handler",
                        "failed to write the {} object {}: {:?}",
                        kind,
                        object,
                        err,
                    );

                    // TODO: Should this return 500 Internal Server Error?
                }
            }

            Response::builder().status(StatusCode::ACCEPTED).body(())
        } else {
            Response::builder().status(StatusCode::NOT_FOUND).body(())
        }
    }

    /// Handle an incoming HTTP request.
    ///
    /// This ends up deserializing the data as JSON if it validates. It is passed in as bytes to
    /// avoid forcing deserialization on the caller.
    pub fn handle(&self, req: &Request<Vec<u8>>) -> Result<Response<String>, http::Error> {
        let path = req.uri().path();

        if path.is_empty() {
            return Ok(Response::builder()
                .status(StatusCode::NOT_FOUND)
                .body(String::new())?);
        }

        // Remove the leading slash.
        let path = &path[1..];

        debug!(
            target: "handler",
            "got a {} request at {}",
            req.method(),
            path,
        );

        Ok(match *req.method() {
            Method::PUT => {
                if path == "__reload" {
                    self.reload()?
                } else if path == "__reload_secrets" {
                    self.reload_secrets()?
                } else {
                    Response::builder()
                        .status(StatusCode::NOT_FOUND)
                        .body(String::new())?
                }
            },
            Method::POST => {
                let data = req.body();

                serde_json::from_slice(data)
                    .map(|object| {
                        self.handle_impl(path, req.headers(), &data, object)
                            .map(|rsp| rsp.map(|()| String::new()))
                    })
                    .unwrap_or_else(|err| {
                        Response::builder()
                            .status(StatusCode::BAD_REQUEST)
                            .body(format!("{:?}", err))
                    })?
            },
            _ => {
                Response::builder()
                    .status(StatusCode::METHOD_NOT_ALLOWED)
                    .body(String::new())?
            },
        })
    }
}

#[cfg(test)]
mod test {
    use std::ffi::OsStr;
    use std::fs::{self, DirEntry, File, OpenOptions};
    use std::path::Path;

    use crates::http::{Method, Request, StatusCode};
    use crates::serde_json::Value;

    use router::Router;
    use test_utils;

    fn create_router(path: &Path, config: Value, secrets: Value) -> Router {
        let (config_path, _) = test_utils::write_config_secrets(path, config, secrets);
        Router::new(config_path).unwrap()
    }

    fn hook_files(path: &Path) -> Vec<DirEntry> {
        let current_dir = OsStr::new(".");
        let parent_dir = OsStr::new("..");
        fs::read_dir(&path)
            .unwrap()
            .map(Result::unwrap)
            .filter(|entry| {
                let file_name = entry.file_name();
                file_name != current_dir && file_name != parent_dir
            })
            .collect()
    }

    #[test]
    fn test_reload() {
        let tempdir = test_utils::create_tempdir("test_reload");
        let router = create_router(tempdir.path(), json!({}), json!({}));

        // Check that the test endpoint doesn't exist.
        {
            let hook = json!({});
            let req = Request::post("/test")
                .body(serde_json::to_vec(&hook).unwrap())
                .unwrap();
            let rsp = router.handle(&req).unwrap();

            assert_eq!(rsp.status(), StatusCode::NOT_FOUND);
            assert_eq!(rsp.body(), "");
        }

        // Rewrite the configuration.
        let test_path = tempdir.path().join("test");
        fs::create_dir(&test_path).unwrap();
        {
            let mut fout = OpenOptions::new().write(true).open(&router.path).unwrap();
            let config = json!({
                "post_paths": {
                    "test": {
                        "path": test_path.to_str().unwrap(),
                        "filters": [],
                    },
                },
            });
            serde_json::to_writer(&mut fout, &config).unwrap();
        }

        // Reload the configuration.
        {
            let req = Request::put("/__reload").body(Vec::new()).unwrap();
            let rsp = router.handle(&req).unwrap();

            assert_eq!(rsp.status(), StatusCode::OK);
            assert_eq!(rsp.body(), "");
        }

        // Retry the endpoint with success.
        {
            let hook = json!({});
            let req = Request::post("/test")
                .body(serde_json::to_vec(&hook).unwrap())
                .unwrap();
            let rsp = router.handle(&req).unwrap();

            assert_eq!(rsp.status(), StatusCode::ACCEPTED);
            assert_eq!(rsp.body(), "");
        }

        // Without filters, the hook directory should be empty.
        {
            let hook_files = hook_files(&test_path);
            assert!(hook_files.is_empty());
        }
    }

    #[test]
    fn test_reload_error() {
        let router = {
            let tempdir = test_utils::create_tempdir("test_reload_error");
            create_router(tempdir.path(), json!({}), json!({}))
        };
        let req = Request::put("/__reload").body(Vec::new()).unwrap();
        let rsp = router.handle(&req).unwrap();

        assert_eq!(rsp.status(), StatusCode::NOT_ACCEPTABLE);
        assert!(
            rsp.body().contains("Read {"),
            "Error response did not match: {}",
            rsp.body(),
        );
    }

    #[test]
    fn test_reload_broken_secrets() {
        let tempdir = test_utils::create_tempdir("test_reload_broken_secrets");
        let router = create_router(tempdir.path(), json!({}), json!({}));

        // Rewrite the secrets.
        {
            let config = router
                .config
                .read()
                .expect("expected to be able to get a read lock on the configuration");
            let secrets_path = config.secrets_path().unwrap();
            File::create(secrets_path).unwrap();
        }

        // Reload the configuration.
        let req = Request::put("/__reload").body(Vec::new()).unwrap();
        let rsp = router.handle(&req).unwrap();

        assert_eq!(rsp.status(), StatusCode::NOT_ACCEPTABLE);
        assert!(
            rsp.body().contains("while parsing a value"),
            "Error response did not match: {}",
            rsp.body(),
        );
    }

    #[test]
    fn test_reload_secrets_error() {
        let router = {
            let tempdir = test_utils::create_tempdir("test_reload_secrets_error");
            create_router(tempdir.path(), json!({}), json!({}))
        };
        let req = Request::put("/__reload_secrets").body(Vec::new()).unwrap();
        let rsp = router.handle(&req).unwrap();

        assert_eq!(rsp.status(), StatusCode::NOT_ACCEPTABLE);
        assert!(
            rsp.body().contains("Read {"),
            "Error response did not match: {}",
            rsp.body(),
        );
    }

    #[test]
    fn test_invalid_put() {
        let tempdir = test_utils::create_tempdir("test_invalid_put");
        let router = create_router(tempdir.path(), json!({}), json!({}));
        let req = Request::put("/not_an_endpoint").body(Vec::new()).unwrap();
        let rsp = router.handle(&req).unwrap();

        assert_eq!(rsp.status(), StatusCode::NOT_FOUND);
        assert_eq!(rsp.body(), "");
    }

    #[test]
    fn test_invalid_methods() {
        let tempdir = test_utils::create_tempdir("test_invalid_put");
        let router = create_router(tempdir.path(), json!({}), json!({}));
        let invalid_methods = [
            Method::GET,
            // Method::POST,
            // Method::PUT,
            Method::DELETE,
            Method::HEAD,
            Method::OPTIONS,
            Method::CONNECT,
            Method::PATCH,
            Method::TRACE,
        ];

        for invalid_method in invalid_methods.iter().cloned() {
            let mut req = Request::new(Vec::new());
            *req.method_mut() = invalid_method;
            let rsp = router.handle(&req).unwrap();

            assert_eq!(rsp.status(), StatusCode::METHOD_NOT_ALLOWED);
            assert_eq!(rsp.body(), "");
        }
    }

    #[test]
    fn test_bad_hook() {
        let tempdir = test_utils::create_tempdir("test_bad_hook");
        let router = create_router(tempdir.path(), json!({}), json!({}));

        let req = Request::post("/test").body(Vec::new()).unwrap();
        let rsp = router.handle(&req).unwrap();

        assert_eq!(rsp.status(), StatusCode::BAD_REQUEST);
        assert!(
            rsp.body().contains("while parsing a value"),
            "Error response did not match: {}",
            rsp.body(),
        );
    }

    #[test]
    fn test_write_hook_error() {
        let tempdir = test_utils::create_tempdir("test_write_hook_error");
        let test_path = tempdir.path().join("test");
        // Don't create the directory to cause the write error.
        let config = json!({
            "post_paths": {
                "test": {
                    "path": test_path.to_str().unwrap(),
                    "filters": [
                        {
                            "kind": "unknown",
                        },
                    ],
                },
            },
        });
        let router = create_router(tempdir.path(), config, json!({}));

        let hook = json!({});
        let req = Request::post("/test")
            .body(serde_json::to_vec(&hook).unwrap())
            .unwrap();
        let rsp = router.handle(&req).unwrap();

        assert_eq!(rsp.status(), StatusCode::ACCEPTED);
        assert_eq!(rsp.body(), "");
    }

    #[test]
    fn test_hook() {
        let tempdir = test_utils::create_tempdir("test_hook");
        let test_path = tempdir.path().join("test");
        fs::create_dir(&test_path).unwrap();
        let config = json!({
            "post_paths": {
                "test": {
                    "path": test_path.to_str().unwrap(),
                    "filters": [
                        {
                            "kind": "unknown",
                        },
                    ],
                },
            },
        });
        let router = create_router(tempdir.path(), config, json!({}));

        let hook = json!({});
        let req = Request::post("/test")
            .body(serde_json::to_vec(&hook).unwrap())
            .unwrap();
        let rsp = router.handle(&req).unwrap();

        assert_eq!(rsp.status(), StatusCode::ACCEPTED);
        assert_eq!(rsp.body(), "");

        let hook_files = hook_files(&test_path);
        assert_eq!(hook_files.len(), 1);

        let path = hook_files[0].path();
        let hook_contents = fs::read_to_string(&path).unwrap();
        let actual: Value = serde_json::from_str(&hook_contents).unwrap();

        assert_eq!(
            actual,
            json!({
                "kind": "unknown",
                "data": {},
            }),
        );
    }

    #[test]
    fn test_unverified_hook() {
        let tempdir = test_utils::create_tempdir("test_unverified_hook");
        let test_path = tempdir.path().join("test");
        fs::create_dir(&test_path).unwrap();
        let config = json!({
            "post_paths": {
                "test": {
                    "path": test_path.to_str().unwrap(),
                    "filters": [
                        {
                            "kind": "unknown",
                        },
                    ],
                    "verification": {
                        "secret_key_lookup": "/secret",
                        "verification_header": "X-Verify-Webhook",
                        "compare": {
                            "type": "token",
                        },
                    },
                },
            },
        });
        let secrets = json!({
            "secret": "secret",
        });
        let router = create_router(tempdir.path(), config, secrets);

        let hook = json!({});
        let req = Request::post("/test")
            .body(serde_json::to_vec(&hook).unwrap())
            .unwrap();
        let rsp = router.handle(&req).unwrap();

        assert_eq!(rsp.status(), StatusCode::NOT_ACCEPTABLE);
        assert_eq!(rsp.body(), "");

        // With verification failing, the hook directory should be empty.
        let hook_files = hook_files(&test_path);
        assert!(hook_files.is_empty());
    }

    #[test]
    fn test_verified_hook() {
        let tempdir = test_utils::create_tempdir("test_verified_hook");
        let test_path = tempdir.path().join("test");
        fs::create_dir(&test_path).unwrap();
        let config = json!({
            "post_paths": {
                "test": {
                    "path": test_path.to_str().unwrap(),
                    "filters": [
                        {
                            "kind": "unknown",
                        },
                    ],
                    "verification": {
                        "secret_key_lookup": "secret",
                        "verification_header": "X-Verify-Webhook",
                        "compare": {
                            "type": "token",
                        },
                    },
                },
            },
        });
        let secrets = json!({
            "secret": "secret",
        });
        let router = create_router(tempdir.path(), config, secrets);

        let hook = json!({});
        let req = Request::post("/test")
            .header("X-Verify-Webhook", "secret")
            .body(serde_json::to_vec(&hook).unwrap())
            .unwrap();
        let rsp = router.handle(&req).unwrap();

        assert_eq!(rsp.status(), StatusCode::ACCEPTED);
        assert_eq!(rsp.body(), "");

        let hook_files = hook_files(&test_path);
        assert_eq!(hook_files.len(), 1);

        let path = hook_files[0].path();
        let hook_contents = fs::read_to_string(&path).unwrap();
        let actual: Value = serde_json::from_str(&hook_contents).unwrap();

        assert_eq!(
            actual,
            json!({
                "kind": "unknown",
                "data": {},
            }),
        );
    }
}