tendns 0.2.0

Encrypted TXT discovery and hexadecimal IPv4 resolution, as a library and DNS 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
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
use super::*;

#[tokio::test(start_paused = true)]
async fn pending_cname_lookup_cannot_outlive_its_authenticated_publication() {
    let (config, mock, clock, resolver) = setup();
    let mut publication = publication(
        vec![Entry {
            subdomain: "alias".into(),
            value: Value::Cname(canonical_name("external.net").unwrap()),
        }],
        100,
    );
    publication.expires_at = 101;
    let mut parent = reply();
    parent
        .answers
        .push(txt(&config, "example.com", &publication, 60));
    mock.set("example.com", RecordType::TXT, parent);
    resolver
        .answer(query("alias.example.com", RecordType::CNAME))
        .await
        .unwrap();
    mock.set("external.net", RecordType::A, reply());
    let gate = Arc::new(tokio::sync::Semaphore::new(0));
    *mock.gate.lock().unwrap() = Some(gate.clone());
    let answer = resolver.answer(query("alias.example.com", RecordType::A));
    tokio::pin!(answer);
    assert_pending(answer.as_mut()).await;
    clock.0.store(101, Ordering::SeqCst);
    gate.add_permits(1);
    assert!(
        answer.await.is_err(),
        "a publication expired while waiting on its CNAME target"
    );
}

#[tokio::test(start_paused = true)]
async fn pending_cname_lookup_ages_only_synthetic_ttls() {
    let (config, mock, clock, resolver) = setup();
    let mut parent = reply();
    parent.answers.push(txt(
        &config,
        "example.com",
        &publication(
            vec![Entry {
                subdomain: "alias".into(),
                value: Value::Cname(canonical_name("external.net").unwrap()),
            }],
            100,
        ),
        60,
    ));
    mock.set("example.com", RecordType::TXT, parent);
    resolver
        .answer(query("alias.example.com", RecordType::CNAME))
        .await
        .unwrap();
    let mut target = reply();
    target.answers.push(Record::from_rdata(
        canonical_name("external.net").unwrap(),
        99,
        RData::A(A("192.0.2.1".parse().unwrap())),
    ));
    mock.set("external.net", RecordType::A, target);
    let gate = Arc::new(tokio::sync::Semaphore::new(0));
    *mock.gate.lock().unwrap() = Some(gate.clone());
    let answer = resolver.answer(query("alias.example.com", RecordType::A));
    tokio::pin!(answer);
    assert_pending(answer.as_mut()).await;
    tokio::time::advance(std::time::Duration::from_secs(5)).await;
    gate.add_permits(1);
    let answer = answer.await.unwrap();
    assert_eq!(answer.answers[0].ttl, 55);
    assert_eq!(answer.answers[1].ttl, 99);

    let answer = resolver.answer(query("alias.example.com", RecordType::A));
    tokio::pin!(answer);
    assert_pending(answer.as_mut()).await;
    clock.0.store(199, Ordering::SeqCst);
    gate.add_permits(1);
    let answer = answer.await.unwrap();
    assert_eq!(
        answer.answers[0].ttl, 1,
        "wall-clock changes must also bound the returned TTL"
    );
    assert_eq!(answer.answers[1].ttl, 99);
}

#[tokio::test]
async fn expiry_bounds_ttl_and_invalidates_cached_payload() {
    let (config, mock, clock, resolver) = setup();
    let mut answer = reply();
    let mut p = publication(vec![entry("", "192.0.2.1")], 100);
    p.expires_at = 105;
    answer.answers.push(txt(&config, "example.com", &p, 600));
    mock.set("example.com", RecordType::TXT, answer);
    let result = resolver
        .answer(query("example.com", RecordType::A))
        .await
        .unwrap();
    assert!(result.answers[0].ttl <= 5);
    clock.0.store(105, Ordering::SeqCst);
    assert!(
        resolver
            .answer(query("example.com", RecordType::A))
            .await
            .is_err()
    );
    assert_eq!(mock.calls().len(), 2);
}

#[tokio::test]
async fn concurrent_parent_queries_share_one_fetch() {
    let (config, mock, _, resolver) = setup();
    let mut answer = reply();
    answer.answers.push(txt(
        &config,
        "example.com",
        &publication(vec![entry("a", "192.0.2.1"), entry("b", "192.0.2.2")], 100),
        60,
    ));
    mock.set("example.com", RecordType::TXT, answer);
    let gate = Arc::new(tokio::sync::Semaphore::new(0));
    *mock.gate.lock().unwrap() = Some(gate.clone());
    let a = resolver.answer(query("a.example.com", RecordType::A));
    let b = resolver.answer(query("b.example.com", RecordType::A));
    tokio::pin!(a, b);
    assert_pending(a.as_mut()).await;
    assert_pending(b.as_mut()).await;
    assert_eq!(
        mock.calls().len(),
        1,
        "both requests must be in flight before releasing the upstream"
    );
    gate.add_permits(1);
    let (a, b) = tokio::join!(a, b);
    assert!(a.is_ok() && b.is_ok());
    assert_eq!(mock.calls().len(), 1);
}

#[tokio::test(start_paused = true)]
async fn dns_ttl_refreshes_positive_and_negative_cache_entries() {
    for positive in [false, true] {
        let (config, mock, _, resolver) = setup();
        let mut answer = reply();
        if positive {
            answer.answers.push(txt(
                &config,
                "example.com",
                &publication(vec![entry("", "192.0.2.1")], 100),
                1,
            ));
        } else {
            answer.metadata.response_code = ResponseCode::NXDomain;
            answer.authorities.push(Record::from_rdata(
                canonical_name("example.com").unwrap(),
                30,
                RData::SOA(SOA::new(
                    canonical_name("ns.example.com").unwrap(),
                    canonical_name("admin.example.com").unwrap(),
                    1,
                    30,
                    30,
                    30,
                    1,
                )),
            ));
        }
        mock.set("example.com", RecordType::TXT, answer);
        for _ in 0..2 {
            let result = resolver
                .answer(query("example.com", RecordType::A))
                .await
                .unwrap();
            assert_eq!(result.answers.len(), usize::from(positive));
        }
        assert_eq!(mock.calls().len(), 1);
        let mut answer = reply();
        answer.answers.push(txt(
            &config,
            "example.com",
            &publication(vec![entry("", "192.0.2.2")], 100),
            60,
        ));
        mock.set("example.com", RecordType::TXT, answer);
        tokio::time::advance(std::time::Duration::from_secs(1)).await;
        let result = resolver
            .answer(query("example.com", RecordType::A))
            .await
            .unwrap();
        assert_eq!(
            result.answers[0].data,
            RData::A(A("192.0.2.2".parse().unwrap()))
        );
        assert_eq!(mock.calls().len(), 2);
    }
}

#[tokio::test]
async fn cancellation_releases_the_per_owner_fetch_lock() {
    let (config, mock, _, resolver) = setup();
    let mut answer = reply();
    answer.answers.push(txt(
        &config,
        "example.com",
        &publication(vec![entry("nas", "192.0.2.1")], 100),
        60,
    ));
    mock.set("example.com", RecordType::TXT, answer);
    let gate = Arc::new(tokio::sync::Semaphore::new(0));
    *mock.gate.lock().unwrap() = Some(gate.clone());
    let mut first = Box::pin(resolver.answer(query("nas.example.com", RecordType::A)));
    assert_pending(first.as_mut()).await;
    drop(first);
    gate.add_permits(1);
    let second = tokio::time::timeout(
        std::time::Duration::from_secs(1),
        resolver.answer(query("nas.example.com", RecordType::A)),
    )
    .await
    .unwrap()
    .unwrap();
    assert_eq!(second.answers.len(), 1);
    assert_eq!(mock.calls().len(), 2);
}

#[tokio::test]
async fn unrelated_owners_can_fetch_concurrently() {
    let (config, mock, _, resolver) = setup();
    for owner in ["example.com", "other.example.com"] {
        let mut answer = reply();
        answer.answers.push(txt(
            &config,
            owner,
            &publication(vec![entry("nas", "192.0.2.1")], 100),
            60,
        ));
        mock.set(owner, RecordType::TXT, answer);
    }
    let gate = Arc::new(tokio::sync::Semaphore::new(0));
    *mock.gate.lock().unwrap() = Some(gate.clone());
    let first = resolver.answer(query("nas.example.com", RecordType::A));
    let second = resolver.answer(query("nas.other.example.com", RecordType::A));
    tokio::pin!(first, second);
    assert_pending(first.as_mut()).await;
    assert_pending(second.as_mut()).await;
    assert_eq!(mock.calls().len(), 2);
    gate.add_permits(2);
    let (first, second) = tokio::join!(first, second);
    assert!(first.is_ok() && second.is_ok());
}

#[tokio::test(start_paused = true)]
async fn combined_values_use_the_shortest_ttl_and_expiry() {
    let (config, mock, clock, resolver) = setup();
    let mut answer = reply();
    let mut short = publication(vec![entry("nas", "192.0.2.1")], 100);
    short.expires_at = 105;
    answer.answers.push(txt(&config, "example.com", &short, 60));
    answer.answers.push(txt(
        &config,
        "example.com",
        &publication(vec![entry("nas", "192.0.2.2")], 100),
        3,
    ));
    mock.set("example.com", RecordType::TXT, answer);
    let result = resolver
        .answer(query("nas.example.com", RecordType::A))
        .await
        .unwrap();
    assert!(result.answers.iter().all(|r| r.ttl == 3));
    tokio::time::advance(std::time::Duration::from_secs(2)).await;
    clock.0.store(102, Ordering::SeqCst);
    let result = resolver
        .answer(query("nas.example.com", RecordType::A))
        .await
        .unwrap();
    assert!(result.answers.iter().all(|r| r.ttl == 1));
    assert_eq!(mock.calls().len(), 1);
    clock.0.store(105, Ordering::SeqCst);
    assert!(
        resolver
            .answer(query("nas.example.com", RecordType::A))
            .await
            .is_err()
    );
    assert_eq!(
        mock.calls(),
        vec![("example.com.".into(), RecordType::TXT); 2]
    );
}

#[tokio::test]
async fn zero_ttl_and_unproven_negative_answers_are_not_cached() {
    for negative in [false, true] {
        let (config, mock, _, resolver) = setup();
        let mut answer = reply();
        if !negative {
            answer.answers.push(txt(
                &config,
                "example.com",
                &publication(vec![entry("", "192.0.2.1")], 100),
                0,
            ));
        }
        mock.set("example.com", RecordType::TXT, answer);
        for _ in 0..2 {
            resolver
                .answer(query("example.com", RecordType::A))
                .await
                .unwrap();
        }
        assert_eq!(mock.calls().len(), 2, "negative={negative}");
    }
}

#[tokio::test]
async fn cache_eviction_refetches_without_cross_domain_key_reuse() {
    let other_key = tendns::protocol::Secret::generate().unwrap();
    let config = Arc::new(
        Policy::new(
            vec![
                discovery("example.com", KEY),
                discovery("inner.example.com", &other_key),
            ],
            vec![],
            60,
            1,
        )
        .unwrap(),
    );
    let mock = Arc::new(Mock::default());
    for (owner, ip) in [
        ("example.com", "192.0.2.1"),
        ("inner.example.com", "192.0.2.2"),
    ] {
        let mut answer = reply();
        answer.answers.push(txt(
            &config,
            owner,
            &publication(vec![entry("", ip)], 100),
            60,
        ));
        mock.set(owner, RecordType::TXT, answer);
    }
    let resolver = Resolver::with_clock(
        config,
        mock.clone(),
        Arc::new(FakeClock(AtomicU64::new(100))),
    );
    for (owner, ip) in [
        ("example.com", "192.0.2.1"),
        ("inner.example.com", "192.0.2.2"),
        ("example.com", "192.0.2.1"),
    ] {
        let answer = resolver.answer(query(owner, RecordType::A)).await.unwrap();
        assert_eq!(answer.answers[0].data, RData::A(A(ip.parse().unwrap())));
    }
    assert_eq!(
        mock.calls(),
        vec![
            ("example.com.".into(), RecordType::TXT),
            ("inner.example.com.".into(), RecordType::TXT),
            ("example.com.".into(), RecordType::TXT)
        ]
    );
}

#[tokio::test]
async fn failed_parent_fetches_do_not_poison_the_cache_or_leak_child_names() {
    for kind in [
        "servfail",
        "refused",
        "truncated",
        "expired",
        "future",
        "contradictory",
    ] {
        let (config, mock, _, resolver) = setup();
        let mut answer = reply();
        match kind {
            "servfail" => answer.metadata.response_code = ResponseCode::ServFail,
            "refused" => answer.metadata.response_code = ResponseCode::Refused,
            "truncated" => answer.metadata.truncation = true,
            _ => {
                let issued = match kind {
                    "expired" => 0,
                    "future" => 161,
                    _ => 100,
                };
                answer.answers.push(txt(
                    &config,
                    "example.com",
                    &publication(vec![entry("nas", "192.0.2.1")], issued),
                    60,
                ));
                if kind == "contradictory" {
                    answer.metadata.response_code = ResponseCode::NXDomain;
                }
            }
        }
        mock.set("example.com", RecordType::TXT, answer);
        assert!(
            resolver
                .answer(query("nas.example.com", RecordType::A))
                .await
                .is_err(),
            "{kind}"
        );
        let mut valid = reply();
        valid.answers.push(txt(
            &config,
            "example.com",
            &publication(vec![entry("nas", "192.0.2.1")], 100),
            60,
        ));
        mock.set("example.com", RecordType::TXT, valid);
        assert_eq!(
            resolver
                .answer(query("nas.example.com", RecordType::A))
                .await
                .unwrap()
                .answers
                .len(),
            1
        );
        assert_eq!(
            mock.calls(),
            vec![("example.com.".into(), RecordType::TXT); 2],
            "{kind}"
        );
    }
}