boardwalk 0.2.0

Hypermedia server framework with reverse-tunnel federation
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

//! Peer link over TLS (`https://` / `wss://`).
//!
//! Self-signed cert via rcgen; client trusts it via the
//! `dangerous-test-tls` feature. Run with `--features dangerous-test-tls`.

#![cfg(feature = "dangerous-test-tls")]

use std::net::SocketAddr;
use std::sync::Arc;
use std::time::Duration;

use boardwalk::{Boardwalk, Device, DeviceConfig, DeviceError, TransitionInput};
use futures::future::BoxFuture;
use rustls::pki_types::{CertificateDer, PrivateKeyDer};
use serde_json::Value as Json;
use tokio_rustls::TlsAcceptor;

#[derive(Default)]
struct Led {
    on: bool,
}

impl Device for Led {
    fn config(&self, cfg: &mut DeviceConfig) {
        cfg.type_("led")
            .name("LED")
            .state(self.state())
            .when("off", &["turn-on"])
            .when("on", &["turn-off"]);
    }
    fn state(&self) -> &str {
        if self.on { "on" } else { "off" }
    }
    fn transition<'a>(
        &'a mut self,
        _name: &'a str,
        _input: TransitionInput,
    ) -> BoxFuture<'a, Result<(), DeviceError>> {
        Box::pin(async { Ok(()) })
    }
}

/// Stand up an HTTPS listener wrapping `router` with a self-signed cert
/// for "localhost"/"127.0.0.1". Returns its address.
async fn serve_tls(router: axum::Router) -> SocketAddr {
    // Install the rustls crypto provider once for the test process.
    let _ = rustls::crypto::CryptoProvider::install_default(
        rustls::crypto::aws_lc_rs::default_provider(),
    );

    let cert =
        rcgen::generate_simple_self_signed(vec!["localhost".to_string(), "127.0.0.1".to_string()])
            .unwrap();
    let cert_der: CertificateDer<'static> = cert.cert.der().clone();
    let key_der: PrivateKeyDer<'static> =
        PrivateKeyDer::try_from(cert.key_pair.serialize_der()).unwrap();

    let server_config = rustls::ServerConfig::builder()
        .with_no_client_auth()
        .with_single_cert(vec![cert_der], key_der)
        .unwrap();
    let acceptor = TlsAcceptor::from(Arc::new(server_config));

    let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
    let addr = listener.local_addr().unwrap();
    tokio::spawn(async move {
        loop {
            let (tcp, _) = match listener.accept().await {
                Ok(v) => v,
                Err(_) => return,
            };
            let acceptor = acceptor.clone();
            let router = router.clone();
            tokio::spawn(async move {
                let Ok(tls) = acceptor.accept(tcp).await else {
                    return;
                };
                let io = hyper_util::rt::TokioIo::new(tls);
                let service = router.into_service::<hyper::body::Incoming>();
                let svc = hyper_util::service::TowerToHyperService::new(service);
                let _ = hyper::server::conn::http1::Builder::new()
                    .serve_connection(io, svc)
                    .with_upgrades()
                    .await;
            });
        }
    });
    addr
}

#[tokio::test]
async fn hub_links_to_cloud_over_tls() {
    let cloud = Boardwalk::new().name("cloud").build().unwrap();
    let cloud_acceptors = cloud.acceptors.clone();
    let tls_addr = serve_tls(cloud.router).await;

    let hub = Boardwalk::new()
        .name("hub")
        .use_device(Led::default())
        .link(format!("https://localhost:{}/", tls_addr.port()))
        .build()
        .unwrap();
    let hub_listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
    tokio::spawn(async move {
        axum::serve(hub_listener, hub.router).await.unwrap();
    });

    // The TLS handshake adds latency; allow a bit more.
    assert!(
        cloud_acceptors
            .wait_for_first(Duration::from_secs(10))
            .await,
        "cloud should have received a confirmed peer over TLS within 10s"
    );

    // Sanity: the cloud's root advertises the hub as a peer through TLS.
    let cloud_url = format!("https://localhost:{}/", tls_addr.port());
    let client = reqwest::Client::builder()
        .danger_accept_invalid_certs(true)
        .build()
        .unwrap();
    let root: Json = client
        .get(&cloud_url)
        .send()
        .await
        .unwrap()
        .json()
        .await
        .unwrap();
    let has_peer = root["links"]
        .as_array()
        .unwrap()
        .iter()
        .any(|l| l["title"] == "hub");
    assert!(has_peer);
}