nanodns 1.0.6

A lightweight DNS server for internal networks — configured with a single JSON file
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
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
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
//! Integration tests — cover resolver, cache, config, and wildcard logic.
//! Network-free: local records only; upstream forwarding is not tested here.

use std::collections::HashMap;
use std::sync::Arc;

use hickory_proto::op::{Message, MessageType, OpCode, Query, ResponseCode};
use hickory_proto::rr::rdata::A;
use hickory_proto::rr::{DNSClass, Name, RData, RecordType};
use hickory_proto::serialize::binary::BinEncodable;

use nanodns::cache::DnsCache;
use nanodns::config::{
    Config, DnsRecord, RecordType as CfgType, RewriteAction, RewriteRule, ServerConfig, SoaRecord,
    ZoneConfig,
};
use nanodns::dns::Resolver;

// ─── Helpers ──────────────────────────────────────────────────────────────────

fn make_config(records: Vec<DnsRecord>, rewrites: Vec<RewriteRule>) -> Config {
    Config {
        server: ServerConfig::default(),
        records,
        rewrites,
        zones: HashMap::new(),
    }
}

fn make_config_with_zones(
    records: Vec<DnsRecord>,
    rewrites: Vec<RewriteRule>,
    zones: HashMap<String, ZoneConfig>,
) -> Config {
    Config {
        server: ServerConfig::default(),
        records,
        rewrites,
        zones,
    }
}

fn a_record(name: &str, ip: &str) -> DnsRecord {
    DnsRecord {
        name: name.into(),
        record_type: CfgType::A,
        value: ip.into(),
        ttl: 300,
        priority: None,
        wildcard: false,
        comment: None,
    }
}

fn wildcard_record(name: &str, ip: &str) -> DnsRecord {
    DnsRecord {
        wildcard: true,
        ..a_record(name, ip)
    }
}

fn nxdomain_rule(pattern: &str) -> RewriteRule {
    RewriteRule {
        pattern: pattern.into(),
        action: RewriteAction::Nxdomain,
        value: None,
        comment: None,
    }
}

fn make_query(name: &str, qtype: RecordType) -> Vec<u8> {
    let mut msg = Message::new();
    msg.set_id(42);
    msg.set_message_type(MessageType::Query);
    msg.set_op_code(OpCode::Query);
    msg.set_recursion_desired(true);
    let mut q = Query::new();
    q.set_name(Name::from_ascii(name).unwrap());
    q.set_query_type(qtype);
    q.set_query_class(DNSClass::IN);
    msg.add_query(q);
    msg.to_bytes().unwrap()
}

fn parse(bytes: &[u8]) -> Message {
    Message::from_vec(bytes).expect("Failed to parse DNS response")
}

fn make_resolver() -> Resolver {
    Resolver::new(Arc::new(DnsCache::new(100, 300, true)))
}

fn make_resolver_no_cache() -> Resolver {
    Resolver::new(Arc::new(DnsCache::new(100, 300, false)))
}

// ─── A record ─────────────────────────────────────────────────────────────────

#[tokio::test]
async fn test_a_record_resolved() {
    let r = make_resolver();
    let cfg = make_config(vec![a_record("web.internal.lan", "192.168.1.100")], vec![]);
    let resp = parse(
        &r.resolve(&make_query("web.internal.lan.", RecordType::A), &cfg)
            .await,
    );
    assert_eq!(resp.response_code(), ResponseCode::NoError);
    assert!(!resp.answers().is_empty());
}

#[tokio::test]
async fn test_a_record_correct_ip() {
    let r = make_resolver();
    let cfg = make_config(vec![a_record("host.lan", "10.0.0.5")], vec![]);
    let resp = parse(
        &r.resolve(&make_query("host.lan.", RecordType::A), &cfg)
            .await,
    );
    let answers = resp.answers();
    assert_eq!(answers.len(), 1);
    if let Some(RData::A(A(ip))) = answers[0].data() {
        assert_eq!(ip.to_string(), "10.0.0.5");
    } else {
        panic!("Expected A record data");
    }
}

#[tokio::test]
async fn test_multiple_a_records_round_robin() {
    let r = make_resolver();
    let cfg = make_config(
        vec![
            a_record("multi.lan", "10.0.0.1"),
            a_record("multi.lan", "10.0.0.2"),
        ],
        vec![],
    );
    let resp = parse(
        &r.resolve(&make_query("multi.lan.", RecordType::A), &cfg)
            .await,
    );
    assert_eq!(resp.answers().len(), 2);
}

#[tokio::test]
async fn test_a_record_case_insensitive() {
    let r = make_resolver();
    let cfg = make_config(vec![a_record("Web.Internal.LAN", "1.2.3.4")], vec![]);
    let resp = parse(
        &r.resolve(&make_query("web.internal.lan.", RecordType::A), &cfg)
            .await,
    );
    assert_eq!(resp.response_code(), ResponseCode::NoError);
    assert!(!resp.answers().is_empty());
}

#[tokio::test]
async fn test_unknown_name_no_local_no_zone_gets_servfail_or_forwards() {
    // Without upstream configured to something reachable, we get SERVFAIL
    // (this tests that we don't panic or return empty bytes on unknown names)
    let r = make_resolver_no_cache();
    let mut cfg = make_config(vec![], vec![]);
    cfg.server.upstream = vec!["127.0.0.1:1".into()]; // unreachable
    cfg.server.upstream_timeout = 1;
    let bytes = r
        .resolve(&make_query("unknown.example.com.", RecordType::A), &cfg)
        .await;
    assert!(!bytes.is_empty(), "Should always return a DNS message");
    let resp = parse(&bytes);
    // Either SERVFAIL (upstream failed) or NXDOMAIN (zone authority)
    assert!(matches!(
        resp.response_code(),
        ResponseCode::ServFail | ResponseCode::NXDomain
    ));
}

// ─── AAAA record ──────────────────────────────────────────────────────────────

#[tokio::test]
async fn test_aaaa_record_resolved() {
    let r = make_resolver();
    let cfg = make_config(
        vec![DnsRecord {
            name: "ipv6.lan".into(),
            record_type: CfgType::Aaaa,
            value: "fd00::1".into(),
            ttl: 300,
            priority: None,
            wildcard: false,
            comment: None,
        }],
        vec![],
    );
    let resp = parse(
        &r.resolve(&make_query("ipv6.lan.", RecordType::AAAA), &cfg)
            .await,
    );
    assert_eq!(resp.response_code(), ResponseCode::NoError);
    assert!(!resp.answers().is_empty());
}

// ─── CNAME record ─────────────────────────────────────────────────────────────

#[tokio::test]
async fn test_cname_record_returned_for_a_query() {
    let r = make_resolver();
    let cfg = make_config(
        vec![DnsRecord {
            name: "api.lan".into(),
            record_type: CfgType::Cname,
            value: "web.lan".into(),
            ttl: 300,
            priority: None,
            wildcard: false,
            comment: None,
        }],
        vec![],
    );
    let resp = parse(
        &r.resolve(&make_query("api.lan.", RecordType::A), &cfg)
            .await,
    );
    assert!(
        !resp.answers().is_empty(),
        "CNAME should be included for A query"
    );
}

// ─── MX record ────────────────────────────────────────────────────────────────

#[tokio::test]
async fn test_mx_record_resolved() {
    let r = make_resolver();
    let cfg = make_config(
        vec![DnsRecord {
            name: "example.lan".into(),
            record_type: CfgType::Mx,
            value: "mail.example.lan".into(),
            ttl: 300,
            priority: Some(10),
            wildcard: false,
            comment: None,
        }],
        vec![],
    );
    let resp = parse(
        &r.resolve(&make_query("example.lan.", RecordType::MX), &cfg)
            .await,
    );
    assert_eq!(resp.response_code(), ResponseCode::NoError);
    assert!(!resp.answers().is_empty());
}

// ─── TXT record ───────────────────────────────────────────────────────────────

#[tokio::test]
async fn test_txt_record_resolved() {
    let r = make_resolver();
    let cfg = make_config(
        vec![DnsRecord {
            name: "example.lan".into(),
            record_type: CfgType::Txt,
            value: "v=spf1 mx ~all".into(),
            ttl: 300,
            priority: None,
            wildcard: false,
            comment: None,
        }],
        vec![],
    );
    let resp = parse(
        &r.resolve(&make_query("example.lan.", RecordType::TXT), &cfg)
            .await,
    );
    assert_eq!(resp.response_code(), ResponseCode::NoError);
    assert!(!resp.answers().is_empty());
}

// ─── Wildcard records ─────────────────────────────────────────────────────────

#[tokio::test]
async fn test_wildcard_single_level_matches() {
    let r = make_resolver();
    let cfg = make_config(vec![wildcard_record("*.app.lan", "1.2.3.4")], vec![]);
    let resp = parse(
        &r.resolve(&make_query("myapp.app.lan.", RecordType::A), &cfg)
            .await,
    );
    assert!(!resp.answers().is_empty());
}

#[tokio::test]
async fn test_wildcard_does_not_match_two_levels() {
    let r = make_resolver_no_cache();
    let mut cfg = make_config(vec![wildcard_record("*.app.lan", "1.2.3.4")], vec![]);
    cfg.server.upstream = vec!["127.0.0.1:1".into()];
    cfg.server.upstream_timeout = 1;
    let resp = parse(
        &r.resolve(&make_query("a.b.app.lan.", RecordType::A), &cfg)
            .await,
    );
    // Two-level subdomain must NOT match the wildcard — either SERVFAIL or NXDOMAIN
    assert!(matches!(
        resp.response_code(),
        ResponseCode::ServFail | ResponseCode::NXDomain
    ));
}

#[tokio::test]
async fn test_wildcard_also_matches_bare_name() {
    let r = make_resolver();
    let cfg = make_config(vec![wildcard_record("*.app.lan", "1.2.3.4")], vec![]);
    let resp = parse(
        &r.resolve(&make_query("app.lan.", RecordType::A), &cfg)
            .await,
    );
    assert!(
        !resp.answers().is_empty(),
        "Wildcard should match the bare parent name"
    );
}

#[tokio::test]
async fn test_exact_record_preferred_over_wildcard() {
    let r = make_resolver();
    let cfg = make_config(
        vec![
            a_record("specific.app.lan", "5.5.5.5"),
            wildcard_record("*.app.lan", "9.9.9.9"),
        ],
        vec![],
    );
    let resp = parse(
        &r.resolve(&make_query("specific.app.lan.", RecordType::A), &cfg)
            .await,
    );
    // Should find the exact record (5.5.5.5), not fall through to wildcard
    assert!(!resp.answers().is_empty());
}

// ─── Rewrite rules ────────────────────────────────────────────────────────────

#[tokio::test]
async fn test_nxdomain_rewrite_exact() {
    let r = make_resolver();
    let cfg = make_config(vec![], vec![nxdomain_rule("ads.example.com")]);
    let resp = parse(
        &r.resolve(&make_query("ads.example.com.", RecordType::A), &cfg)
            .await,
    );
    assert_eq!(resp.response_code(), ResponseCode::NXDomain);
}

#[tokio::test]
async fn test_nxdomain_rewrite_wildcard() {
    let r = make_resolver();
    let cfg = make_config(vec![], vec![nxdomain_rule("*.tracker.net")]);
    let resp = parse(
        &r.resolve(&make_query("pixel.tracker.net.", RecordType::A), &cfg)
            .await,
    );
    assert_eq!(resp.response_code(), ResponseCode::NXDomain);
}

#[tokio::test]
async fn test_rewrite_takes_priority_over_local_record() {
    // Even if there is a matching record, a rewrite rule fires first
    let r = make_resolver();
    let cfg = make_config(
        vec![a_record("blocked.lan", "1.2.3.4")],
        vec![nxdomain_rule("blocked.lan")],
    );
    let resp = parse(
        &r.resolve(&make_query("blocked.lan.", RecordType::A), &cfg)
            .await,
    );
    assert_eq!(resp.response_code(), ResponseCode::NXDomain);
}

#[tokio::test]
async fn test_non_matching_rewrite_does_not_block() {
    let r = make_resolver();
    let cfg = make_config(
        vec![a_record("allowed.lan", "1.2.3.4")],
        vec![nxdomain_rule("other.lan")],
    );
    let resp = parse(
        &r.resolve(&make_query("allowed.lan.", RecordType::A), &cfg)
            .await,
    );
    assert_eq!(resp.response_code(), ResponseCode::NoError);
    assert!(!resp.answers().is_empty());
}

// ─── Zone authority ───────────────────────────────────────────────────────────

#[tokio::test]
async fn test_zone_authority_nxdomain_for_unknown_name() {
    let r = make_resolver();
    let mut zones = HashMap::new();
    zones.insert(
        "internal.lan".into(),
        ZoneConfig {
            soa: Some(SoaRecord {
                mname: "ns1.internal.lan".into(),
                rname: "admin.internal.lan".into(),
                serial: 1,
                refresh: 3600,
                retry: 900,
                expire: 604800,
                minimum: 300,
            }),
            ns: None,
        },
    );
    let cfg = make_config_with_zones(vec![], vec![], zones);
    let resp = parse(
        &r.resolve(&make_query("norecord.internal.lan.", RecordType::A), &cfg)
            .await,
    );
    assert_eq!(
        resp.response_code(),
        ResponseCode::NXDomain,
        "Names in an authoritative zone with no record must return NXDOMAIN, not forward upstream"
    );
}

#[tokio::test]
async fn test_zone_authority_does_not_block_other_domains() {
    let r = make_resolver_no_cache();
    let mut zones = HashMap::new();
    zones.insert(
        "internal.lan".into(),
        ZoneConfig {
            soa: None,
            ns: None,
        },
    );
    let mut cfg = make_config_with_zones(vec![], vec![], zones);
    cfg.server.upstream = vec!["127.0.0.1:1".into()];
    cfg.server.upstream_timeout = 1;
    // "external.com" is NOT in our zones — should attempt upstream, not NXDOMAIN
    let resp = parse(
        &r.resolve(&make_query("external.com.", RecordType::A), &cfg)
            .await,
    );
    // Upstream unreachable → SERVFAIL (not NXDOMAIN from zone authority)
    assert_eq!(resp.response_code(), ResponseCode::ServFail);
}

// ─── Cache ────────────────────────────────────────────────────────────────────

#[tokio::test]
async fn test_cache_populates_on_first_query() {
    let cache = Arc::new(DnsCache::new(100, 300, true));
    let r = Resolver::new(cache.clone());
    let cfg = make_config(vec![a_record("cached.lan", "1.1.1.1")], vec![]);
    r.resolve(&make_query("cached.lan.", RecordType::A), &cfg)
        .await;
    assert!(cache.stats().active >= 1);
}

#[tokio::test]
async fn test_cache_returns_consistent_response() {
    let cache = Arc::new(DnsCache::new(100, 300, true));
    let r = Resolver::new(cache.clone());
    let cfg = make_config(vec![a_record("cached.lan", "2.2.2.2")], vec![]);
    let q = make_query("cached.lan.", RecordType::A);
    let first = r.resolve(&q, &cfg).await;
    let second = r.resolve(&q, &cfg).await;
    // Both responses should contain the same answer
    let r1 = parse(&first);
    let r2 = parse(&second);
    assert_eq!(r1.response_code(), r2.response_code());
    assert_eq!(r1.answers().len(), r2.answers().len());
}

#[tokio::test]
async fn test_cache_disabled_does_not_cache() {
    let cache = Arc::new(DnsCache::new(100, 300, false));
    let r = Resolver::new(cache.clone());
    let cfg = make_config(vec![a_record("nocache.lan", "3.3.3.3")], vec![]);
    r.resolve(&make_query("nocache.lan.", RecordType::A), &cfg)
        .await;
    assert_eq!(
        cache.stats().active,
        0,
        "Cache is disabled, nothing should be stored"
    );
}

#[tokio::test]
async fn test_cache_invalidation_clears_entries() {
    let cache = Arc::new(DnsCache::new(100, 300, true));
    let r = Resolver::new(cache.clone());
    let cfg = make_config(vec![a_record("inv.lan", "4.4.4.4")], vec![]);
    r.resolve(&make_query("inv.lan.", RecordType::A), &cfg)
        .await;
    assert!(cache.stats().active >= 1);
    cache.invalidate();
    assert_eq!(cache.stats().size, 0);
}

#[tokio::test]
async fn test_cache_key_distinguishes_record_types() {
    let cache = Arc::new(DnsCache::new(100, 300, true));
    let r = Resolver::new(cache.clone());
    let cfg = make_config(vec![a_record("dual.lan", "5.5.5.5")], vec![]);
    r.resolve(&make_query("dual.lan.", RecordType::A), &cfg)
        .await;
    r.resolve(&make_query("dual.lan.", RecordType::MX), &cfg)
        .await;
    // A and MX are separate cache entries
    assert!(cache.stats().size >= 1);
}

// ─── Config: load / validate / persist_version ────────────────────────────────

#[test]
fn test_config_validate_accepts_valid_a_record() {
    let cfg = make_config(vec![a_record("ok.lan", "192.168.0.1")], vec![]);
    assert!(nanodns::config::validate(&cfg).is_ok());
}

#[test]
fn test_config_validate_rejects_bad_ipv4() {
    let cfg = make_config(
        vec![DnsRecord {
            name: "bad.lan".into(),
            record_type: CfgType::A,
            value: "not-an-ip".into(),
            ttl: 300,
            priority: None,
            wildcard: false,
            comment: None,
        }],
        vec![],
    );
    assert!(nanodns::config::validate(&cfg).is_err());
}

#[test]
fn test_config_validate_rejects_mx_without_priority() {
    let cfg = make_config(
        vec![DnsRecord {
            name: "mx.lan".into(),
            record_type: CfgType::Mx,
            value: "mail.lan".into(),
            ttl: 300,
            priority: None, // missing!
            wildcard: false,
            comment: None,
        }],
        vec![],
    );
    assert!(nanodns::config::validate(&cfg).is_err());
}

#[test]
fn test_config_validate_accepts_mx_with_priority() {
    let cfg = make_config(
        vec![DnsRecord {
            name: "mx.lan".into(),
            record_type: CfgType::Mx,
            value: "mail.lan".into(),
            ttl: 300,
            priority: Some(10),
            wildcard: false,
            comment: None,
        }],
        vec![],
    );
    assert!(nanodns::config::validate(&cfg).is_ok());
}

#[test]
fn test_config_write_example_and_load() {
    use std::path::PathBuf;
    let path = PathBuf::from(env!("CARGO_TARGET_TMPDIR")).join("test_example.json");
    nanodns::config::write_example(&path).expect("write_example failed");
    let cfg = nanodns::config::load(&path).expect("load failed");
    assert!(
        !cfg.records.is_empty(),
        "Example config should have records"
    );
    assert!(
        cfg.server.mgmt_port > 0,
        "Example config should enable mgmt API"
    );
}

#[test]
fn test_config_persist_version() {
    use std::path::PathBuf;
    let path = PathBuf::from(env!("CARGO_TARGET_TMPDIR")).join("test_persist.json");
    nanodns::config::write_example(&path).unwrap();

    // Initial version from example
    let initial = nanodns::config::load(&path).unwrap();
    let v0 = initial.server.config_version;

    nanodns::config::persist_version(&path, v0 + 5).expect("persist_version failed");

    let updated = nanodns::config::load(&path).unwrap();
    assert_eq!(updated.server.config_version, v0 + 5);

    // Other fields must be unchanged
    assert_eq!(updated.records.len(), initial.records.len());
    assert_eq!(updated.server.port, initial.server.port);
}

#[test]
fn test_config_save_round_trip() {
    use std::path::PathBuf;
    let path = PathBuf::from(env!("CARGO_TARGET_TMPDIR")).join("test_save.json");
    let mut cfg = make_config(
        vec![a_record("save.lan", "7.7.7.7")],
        vec![nxdomain_rule("blocked.net")],
    );
    cfg.server.config_version = 42;

    nanodns::config::save(&path, &cfg).expect("save failed");
    let loaded = nanodns::config::load(&path).expect("load after save failed");

    assert_eq!(loaded.server.config_version, 42);
    assert_eq!(loaded.records.len(), 1);
    assert_eq!(loaded.records[0].value, "7.7.7.7");
    assert_eq!(loaded.rewrites.len(), 1);
}

// ─── Wildcard unit tests (also covers dns::wildcard directly) ─────────────────

mod wildcard_unit {
    use nanodns::dns::wildcard::matches;

    #[test]
    fn exact_match() {
        assert!(matches("foo.bar", "foo.bar"));
    }

    #[test]
    fn exact_mismatch() {
        assert!(!matches("foo.bar", "baz.bar"));
    }

    #[test]
    fn wildcard_single_level() {
        assert!(matches("*.foo.bar", "any.foo.bar"));
    }

    #[test]
    fn wildcard_does_not_match_two_levels() {
        assert!(!matches("*.foo.bar", "a.b.foo.bar"));
    }

    #[test]
    fn wildcard_matches_bare_parent() {
        assert!(matches("*.foo.bar", "foo.bar"));
    }

    #[test]
    fn wildcard_does_not_match_unrelated() {
        assert!(!matches("*.foo.bar", "other.com"));
    }

    #[test]
    fn trailing_dot_ignored() {
        assert!(matches("foo.bar", "foo.bar."));
        assert!(matches("foo.bar.", "foo.bar"));
    }
}