thrall 0.0.22

thrall: the foot — a tool-execution client for a yog server
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

//! The act against a fake commons and a loopback punch port: every way it
//! refuses, the call it writes, and the cache the third rung re-punches.

use super::*;
use crate::dht::tests::fake::Mood;
use crate::rendezvous::item::Call;
use crate::rendezvous::punch::Punch;
use crate::test_support::roving::{commons, commons_as, engine, pairing, presence, tuned};

fn roving(tuning: Tuning) -> Roving {
    Roving::new(pairing(), tuning)
}

/// A port nothing listens on.
fn dead_port() -> u16 {
    let gone = std::net::TcpListener::bind("127.0.0.1:0").expect("bind");
    let port = gone.local_addr().expect("addr").port();
    drop(gone);
    port
}

#[test]
fn the_defaults_are_the_stated_ones() {
    let t = Tuning::default();
    assert_eq!(t.window, Duration::from_secs(35));
    assert_eq!(t.bootstrap, crate::rendezvous::mainline());
    assert_eq!(t.config.k, 8);
}

#[test]
fn no_bootstrap_resolving_refuses_before_any_datagram() {
    for bootstrap in [vec![], vec!["nowhere.invalid:6881".to_owned()]] {
        let mut r = roving(tuned(bootstrap));
        assert_eq!(
            r.rendezvous().expect_err("refused"),
            "no DHT bootstrap node resolved"
        );
    }
}

#[test]
fn no_presence_on_the_commons_refuses() {
    let (_node, tuning) = commons(vec![]);
    let mut r = roving(tuning);
    assert_eq!(
        r.rendezvous().expect_err("refused"),
        "no presence is published under the engine's rendezvous key"
    );
}

#[test]
fn a_presence_sealed_under_another_pairing_refuses() {
    let p = pairing();
    let sealed = crate::rendezvous::item::Presence {
        endpoints: vec!["127.0.0.1:1".parse().expect("addr")],
    }
    .seal(&[7u8; 32])
    .expect("seal");
    let item = engine().sign(p.presence_salt(), 1, sealed).expect("signed");
    let (_node, tuning) = commons(vec![item]);
    let mut r = roving(tuning);
    assert_eq!(
        r.rendezvous().expect_err("refused"),
        "the presence item does not open under this pairing"
    );
}

#[test]
fn a_presence_naming_no_endpoint_refuses() {
    let p = pairing();
    let sealed = crate::rendezvous::item::Presence { endpoints: vec![] }
        .seal(&p.seal_key())
        .expect("seal");
    let item = engine().sign(p.presence_salt(), 1, sealed).expect("signed");
    let (_node, tuning) = commons(vec![item]);
    let mut r = roving(tuning);
    assert_eq!(
        r.rendezvous().expect_err("refused"),
        "the engine's presence names no endpoint"
    );
}

/// The call is written before the punch, sealed so the commons cannot read
/// it, under a sequence that rises on every call — and a punch nobody
/// answers is the window waited out.
#[test]
fn a_call_is_filed_sealed_and_a_punch_nobody_answers_is_refused() {
    let port = dead_port();
    let (node, tuning) = commons(vec![presence(port, 1)]);
    let mut r = roving(tuning);
    let refusal = r.rendezvous().expect_err("nobody there");
    assert_eq!(
        refusal,
        "no SYN crossed toward 1 engine endpoint(s) inside the window"
    );
    let p = pairing();
    let inbox = p.inbox_keypair().expect("keypair").public();
    let held = node.held();
    let call = held
        .iter()
        .find(|i| i.key == inbox && i.salt == p.inbox_salt())
        .expect("the call was filed");
    assert!(call.verify());
    let opened = Call::open(&p.seal_key(), &call.value).expect("opens under the pairing");
    let punch = r.punch.as_ref().expect("bound").port();
    assert!(
        opened
            .endpoints
            .iter()
            .all(|e| e.port() == punch && !e.ip().is_loopback()),
        "{opened:?} names this box at its punch port"
    );
    let first = call.seq;
    r.rendezvous().expect_err("still nobody");
    let again = node
        .held()
        .into_iter()
        .find(|i| i.key == inbox)
        .expect("the call was filed again");
    assert!(again.seq > first, "the sequence rises");
    assert!(again.seq >= r.last_seq);
}

/// A commons that holds a newer call than this box can write refuses the
/// put, and the refusal is the act's.
#[test]
fn a_put_the_commons_refuses_is_the_acts_refusal() {
    let p = pairing();
    let future = p
        .inbox_keypair()
        .expect("keypair")
        .sign(p.inbox_salt(), i64::MAX, vec![])
        .expect("signed");
    let (_node, tuning) = commons(vec![presence(dead_port(), 1), future]);
    let mut r = roving(tuning);
    let refusal = r.rendezvous().expect_err("refused");
    assert!(
        refusal.ends_with("302 sequence number less than current"),
        "{refusal}"
    );
}

/// The whole act lands on a listening punch port, and the endpoints it read
/// are then the cache the third rung punches without the commons.
#[test]
fn a_rendezvous_lands_and_its_endpoints_are_re_punched_without_the_commons() {
    let far = Punch::bind(0).expect("bind");
    let port = far.port();
    let served = std::thread::spawn(move || {
        let first = far.punch(vec![], Duration::from_secs(5)).is_some();
        let second = far.punch(vec![], Duration::from_secs(5)).is_some();
        (first, second)
    });
    let (node, tuning) = commons(vec![presence(port, 1)]);
    let mut r = roving(tuning);
    assert!(r.repunch().is_none(), "nothing cached yet");
    let stream = r.rendezvous().expect("landed");
    assert_eq!(stream.peer_addr().expect("peer").port(), port);
    drop(stream);
    drop(node);
    let again = r.repunch().expect("re-punched at the cache");
    assert_eq!(again.peer_addr().expect("peer").port(), port);
    drop(again);
    assert_eq!(served.join().expect("served"), (true, true));
}

#[test]
fn a_re_punch_nobody_answers_is_none() {
    let (_node, tuning) = commons(vec![presence(dead_port(), 1)]);
    let mut r = roving(tuning);
    r.rendezvous().expect_err("nobody there");
    assert!(r.cached.is_some());
    assert!(r.repunch().is_none());
}

#[test]
fn a_nonce_is_fresh_and_the_clock_rises() {
    assert_ne!(nonce().expect("a"), nonce().expect("b"));
    assert!(unix_now() > 1_700_000_000);
}

/// The observed address joins the route-local ones at the punch port, never
/// twice, and never at the port the commons saw.
#[test]
fn an_observed_address_is_listed_once_at_the_punch_port() {
    let local: IpAddr = "192.0.2.5".parse().expect("ip");
    let seen = |s: &str| s.parse::<SocketAddr>().expect("addr");
    let far = seen("203.0.113.7:6881");
    assert_eq!(
        listed(vec![local], &[far, seen("[2001:db8::7]:1")], 9),
        vec![
            SocketAddr::new(local, 9),
            seen("203.0.113.7:9"),
            seen("[2001:db8::7]:9")
        ]
    );
    assert_eq!(
        listed(vec![local], &[seen("192.0.2.5:6881")], 9),
        vec![SocketAddr::new(local, 9)],
        "an observed address that is already local is not a second entry"
    );
    assert_eq!(listed(vec![], &[far], 9), vec![seen("203.0.113.7:9")]);
    assert_eq!(listed(vec![local], &[], 9), vec![SocketAddr::new(local, 9)]);
}

/// The call a foot behind a NAT files carries where the commons saw it,
/// through the seal and back; a walk that heard no claim adds nothing.
#[test]
fn the_filed_call_carries_the_observed_address_when_the_commons_named_one() {
    let us: SocketAddr = "203.0.113.7:6881".parse().expect("addr");
    for (mood, expect) in [(Mood::Claim(us), true), (Mood::Answer, false)] {
        let (node, tuning) = commons_as(mood, vec![presence(dead_port(), 1)]);
        let mut r = roving(tuning);
        r.rendezvous().expect_err("nobody there");
        let p = pairing();
        let inbox = p.inbox_keypair().expect("keypair").public();
        let filed = node
            .held()
            .into_iter()
            .find(|i| i.key == inbox)
            .expect("the call was filed");
        let opened = Call::open(&p.seal_key(), &filed.value).expect("opens");
        let punch = r.punch.as_ref().expect("bound").port();
        let at = SocketAddr::new(us.ip(), punch);
        assert_eq!(opened.endpoints.contains(&at), expect, "{opened:?}");
        assert!(opened.endpoints.iter().all(|e| e.port() == punch));
    }
}