bluebox 0.1.4

A fast DNS interceptor and cache for local networks
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
//! DNS server orchestration.
//!
//! Coordinates packet capture, DNS resolution, caching, and response sending.
//! Designed with trait-based dependencies for testability.

use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};

use hickory_proto::op::Message;
use hickory_proto::serialize::binary::BinDecodable;
use metrics::counter;
use parking_lot::RwLock;
use tokio::sync::mpsc;
use tracing::{info, instrument, warn};

use crate::cache::DnsCache;
use crate::dns::{Blocker, DnsResolver};
use crate::error::Result;
use crate::network::{BufferPool, PacketBuilder, PacketInfo, PacketSender, extract_dns_query};

/// Statistics for server operations.
#[derive(Debug, Default)]
pub struct ServerStats {
    pub queries_received: u64,
    pub queries_blocked: u64,
    pub cache_hits: u64,
    pub cache_misses: u64,
    pub responses_sent: u64,
    pub errors: u64,
}

/// DNS query handler that processes queries using the provided dependencies.
///
/// This struct encapsulates the core DNS handling logic, separated from
/// the network capture layer for easier testing.
///
/// The blocker is wrapped in `Arc<RwLock<Blocker>>` to support hot-reloading
/// of blocklists without restarting the server.
pub struct QueryHandler<C, R>
where
    C: DnsCache,
    R: DnsResolver,
{
    cache: C,
    resolver: R,
    blocker: Arc<RwLock<Blocker>>,
}

impl<C, R> QueryHandler<C, R>
where
    C: DnsCache,
    R: DnsResolver,
{
    /// Create a new query handler with an owned blocker.
    ///
    /// This is convenient for testing or when you don't need hot-reloading.
    pub fn new(cache: C, resolver: R, blocker: Blocker) -> Self {
        Self {
            cache,
            resolver,
            blocker: Arc::new(RwLock::new(blocker)),
        }
    }

    /// Create a new query handler with a shared blocker.
    ///
    /// Use this when integrating with [`BlocklistManager`](crate::blocklist::manager::BlocklistManager)
    /// to enable hot-reloading of blocklists.
    #[must_use]
    pub const fn with_shared_blocker(cache: C, resolver: R, blocker: Arc<RwLock<Blocker>>) -> Self {
        Self {
            cache,
            resolver,
            blocker,
        }
    }

    /// Handle a DNS query and return the response.
    #[instrument(skip(self, query), fields(domain))]
    pub async fn handle_query(&self, query: Message) -> Result<Message> {
        let Some(query_record) = query.queries().first() else {
            warn!("Query has no questions");
            return Ok(query);
        };

        let name = query_record.name();
        let query_type = query_record.query_type().to_string();
        tracing::Span::current().record("domain", name.to_string());
        info!("Handling query for {name}");

        // Check blocklist (read lock is held briefly)
        if self.blocker.read().is_blocked(name) {
            info!("Domain {name} is blocked");
            counter!("dns.queries", "status" => "blocked", "query_type" => query_type).increment(1);
            return Ok(Blocker::blocked_response(&query));
        }

        // Check cache
        if let Some(mut cached) = self.cache.get(name).await {
            info!("Cache hit for {name}");
            counter!("dns.queries", "status" => "cache_hit", "query_type" => query_type)
                .increment(1);
            // Update the ID to match the query
            cached.set_id(query.id());
            return Ok(cached);
        }

        info!("Cache miss for {name}, forwarding to upstream");
        counter!("dns.queries", "status" => "cache_miss", "query_type" => query_type).increment(1);

        // Forward to upstream resolver
        let response = self.resolver.resolve(&query).await?;

        // Cache the response
        self.cache.insert(name.clone(), response.clone()).await;

        Ok(response)
    }
}

impl<C, R> Clone for QueryHandler<C, R>
where
    C: DnsCache + Clone,
    R: DnsResolver + Clone,
{
    fn clone(&self) -> Self {
        Self {
            cache: self.cache.clone(),
            resolver: self.resolver.clone(),
            blocker: Arc::clone(&self.blocker),
        }
    }
}

/// Configuration for the DNS server.
pub struct ServerConfig {
    pub channel_capacity: usize,
    pub buffer_pool_size: usize,
}

impl Default for ServerConfig {
    fn default() -> Self {
        Self {
            channel_capacity: 1000,
            buffer_pool_size: 64,
        }
    }
}

/// Run the DNS server event loop.
///
/// This function coordinates:
/// 1. Receiving packets from the capture channel
/// 2. Processing DNS queries
/// 3. Sending responses
pub async fn run_server<C, R, S>(
    mut packet_rx: mpsc::Receiver<Vec<u8>>,
    handler: QueryHandler<C, R>,
    mut sender: S,
    buffer_pool: BufferPool,
    running: Arc<AtomicBool>,
) -> Result<()>
where
    C: DnsCache,
    R: DnsResolver,
    S: PacketSender,
{
    let packet_builder = PacketBuilder::new(buffer_pool);

    while running.load(Ordering::SeqCst) {
        let Some(packet) = packet_rx.recv().await else {
            break;
        };

        // Extract DNS query from packet
        let Some((packet_info, dns_payload)) = extract_dns_query(&packet) else {
            continue;
        };

        // Parse DNS message
        let query = match Message::from_bytes(&dns_payload) {
            Ok(m) => m,
            Err(e) => {
                warn!("Failed to parse DNS message: {}", e);
                continue;
            }
        };

        // Handle the query
        let response = match handler.handle_query(query).await {
            Ok(r) => r,
            Err(e) => {
                warn!("Failed to handle query: {}", e);
                continue;
            }
        };

        // Build and send response
        match packet_builder.build_response(&response, &packet_info) {
            Ok(response_packet) => {
                if let Err(e) = sender.send(&response_packet) {
                    warn!("Failed to send response: {}", e);
                }
            }
            Err(e) => {
                warn!("Failed to build response packet: {}", e);
            }
        }
    }

    Ok(())
}

/// Process a single DNS query (useful for testing).
pub async fn process_query<C, R>(
    dns_payload: &[u8],
    packet_info: &PacketInfo,
    handler: &QueryHandler<C, R>,
    packet_builder: &PacketBuilder,
) -> Result<Vec<u8>>
where
    C: DnsCache,
    R: DnsResolver,
{
    let query = Message::from_bytes(dns_payload)?;
    let response = handler.handle_query(query).await?;
    packet_builder.build_response(&response, packet_info)
}

#[cfg(test)]
#[allow(clippy::cast_possible_truncation)] // Test packet sizes are always small
mod tests {
    use super::*;
    use crate::cache::dns_cache::tests::MockCache;
    use crate::dns::resolver::tests::MockResolver;
    use hickory_proto::op::{MessageType, OpCode, Query, ResponseCode};
    use hickory_proto::rr::{Name, RecordType};
    use std::str::FromStr;

    fn create_query(domain: &str, id: u16) -> Message {
        let name = Name::from_str(domain).unwrap();
        let mut query = Query::new();
        query.set_name(name);
        query.set_query_type(RecordType::A);

        let mut message = Message::new();
        message.set_id(id);
        message.add_query(query);
        message
    }

    fn create_response(id: u16) -> Message {
        let mut response = Message::new();
        response
            .set_id(id)
            .set_message_type(MessageType::Response)
            .set_op_code(OpCode::Query)
            .set_response_code(ResponseCode::NoError);
        response
    }

    #[tokio::test]
    async fn should_return_blocked_response_for_blocked_domain() {
        let cache = MockCache::new();
        let resolver = MockResolver::new();
        let blocker = Blocker::new(["blocked.com", "*.ads.net"]);

        let handler = QueryHandler::new(cache, resolver.clone(), blocker);

        // Test exact match
        let query = create_query("blocked.com", 1);
        let response = handler.handle_query(query).await.unwrap();

        assert_eq!(response.response_code(), ResponseCode::NoError);
        assert_eq!(response.answers().len(), 1);
        // Resolver should not be called for blocked domains
        assert_eq!(resolver.resolve_count(), 0);

        // Test wildcard match
        let query = create_query("tracking.ads.net", 2);
        let response = handler.handle_query(query).await.unwrap();

        assert_eq!(response.response_code(), ResponseCode::NoError);
        assert_eq!(resolver.resolve_count(), 0);
    }

    #[tokio::test]
    async fn should_return_cached_response_on_cache_hit() {
        let cache = MockCache::new();
        let resolver = MockResolver::new();
        let blocker = Blocker::default();

        // Pre-populate cache
        let name = Name::from_str("cached.com").unwrap();
        let cached_response = create_response(999);
        cache.insert(name, cached_response).await;

        let handler = QueryHandler::new(cache.clone(), resolver.clone(), blocker);

        let query = create_query("cached.com", 123);
        let response = handler.handle_query(query).await.unwrap();

        // Response should have the query's ID, not the cached ID
        assert_eq!(response.id(), 123);
        assert_eq!(response.response_code(), ResponseCode::NoError);
        // Resolver should not be called for cache hits
        assert_eq!(resolver.resolve_count(), 0);
        // Cache get should be called
        assert_eq!(cache.get_call_count(), 1);
    }

    #[tokio::test]
    async fn should_resolve_and_cache_on_cache_miss() {
        let cache = MockCache::new();
        let resolver = MockResolver::new();

        // Configure resolver to return a response
        let name = Name::from_str("example.com").unwrap();
        let upstream_response = create_response(0);
        resolver.add_response(name, upstream_response).await;

        let blocker = Blocker::default();
        let handler = QueryHandler::new(cache.clone(), resolver.clone(), blocker);

        let query = create_query("example.com", 456);
        let response = handler.handle_query(query).await.unwrap();

        assert_eq!(response.id(), 456);
        // Resolver should be called
        assert_eq!(resolver.resolve_count(), 1);
        // Response should be cached
        assert_eq!(cache.insert_call_count(), 1);
    }

    #[tokio::test]
    async fn should_return_error_when_resolver_fails() {
        let cache = MockCache::new();
        let resolver = MockResolver::new();
        resolver.set_error("connection refused").await;

        let blocker = Blocker::default();
        let handler = QueryHandler::new(cache, resolver, blocker);

        let query = create_query("example.com", 789);
        let result = handler.handle_query(query).await;

        assert!(result.is_err());
    }

    #[tokio::test]
    async fn should_share_blocker_when_cloned() {
        let cache = MockCache::new();
        let resolver = MockResolver::new();
        let blocker = Blocker::new(["blocked.com"]);

        let handler1 = QueryHandler::new(cache, resolver, blocker);
        let handler2 = handler1.clone();

        // Both handlers should share the same blocker
        let query = create_query("blocked.com", 1);
        let response = handler2.handle_query(query).await.unwrap();
        assert_eq!(response.answers().len(), 1);
    }

    #[test]
    fn should_use_default_server_config_values() {
        let config = ServerConfig::default();
        assert_eq!(config.channel_capacity, 1000);
        assert_eq!(config.buffer_pool_size, 64);
    }

    #[tokio::test]
    async fn should_return_same_message_when_query_is_empty() {
        let cache = MockCache::new();
        let resolver = MockResolver::new();
        let blocker = Blocker::default();

        let handler = QueryHandler::new(cache, resolver, blocker);

        // Create a message with no queries
        let empty_query = Message::new();
        let response = handler.handle_query(empty_query.clone()).await.unwrap();

        // Should return the same message since there's no query to process
        assert_eq!(response.id(), empty_query.id());
    }

    #[tokio::test]
    async fn should_use_shared_blocker_with_hot_reload() {
        let cache = MockCache::new();
        let resolver = MockResolver::new();

        // Create a shared blocker (simulating BlocklistManager)
        let shared_blocker = Arc::new(RwLock::new(Blocker::default()));

        let handler =
            QueryHandler::with_shared_blocker(cache, resolver.clone(), Arc::clone(&shared_blocker));

        // Domain should not be blocked initially
        let query = create_query("newblocked.com", 1);
        let _response = handler.handle_query(query).await.unwrap();
        // Resolver was called because domain wasn't blocked
        assert_eq!(resolver.resolve_count(), 1);

        // Now update the shared blocker (simulating hot-reload)
        *shared_blocker.write() = Blocker::new(["newblocked.com"]);

        // Same domain should now be blocked
        let query = create_query("newblocked.com", 2);
        let response = handler.handle_query(query).await.unwrap();

        // Should get a blocked response (localhost)
        assert_eq!(response.answers().len(), 1);
        // Resolver should NOT be called again
        assert_eq!(resolver.resolve_count(), 1);
    }

    #[tokio::test]
    async fn should_process_query_and_build_response_packet() {
        use crate::network::{BufferPool, PacketBuilder, PacketInfo};
        use hickory_proto::serialize::binary::BinEncodable;
        use pnet::util::MacAddr;
        use std::net::{IpAddr, Ipv4Addr};

        let cache = MockCache::new();
        let resolver = MockResolver::new();

        // Configure resolver to return a response
        let name = Name::from_str("example.com").unwrap();
        let upstream_response = create_response(0);
        resolver.add_response(name, upstream_response).await;

        let blocker = Blocker::default();
        let handler = QueryHandler::new(cache, resolver, blocker);
        let buffer_pool = BufferPool::new(4);
        let packet_builder = PacketBuilder::new(buffer_pool);

        let query = create_query("example.com", 123);
        let dns_payload = query.to_bytes().unwrap();

        let packet_info = PacketInfo {
            source_mac: MacAddr::new(0x11, 0x22, 0x33, 0x44, 0x55, 0x66),
            dest_mac: MacAddr::new(0xaa, 0xbb, 0xcc, 0xdd, 0xee, 0xff),
            source_ip: IpAddr::V4(Ipv4Addr::new(192, 168, 1, 100)),
            dest_ip: IpAddr::V4(Ipv4Addr::new(192, 168, 1, 1)),
            source_port: 12345,
            dest_port: 53,
        };

        let result = process_query(&dns_payload, &packet_info, &handler, &packet_builder).await;
        assert!(result.is_ok());

        let response_packet = result.unwrap();
        // Verify it's a valid Ethernet frame (at least 14 bytes header)
        assert!(response_packet.len() > 14 + 20 + 8); // Ethernet + IP + UDP headers
    }

    #[tokio::test]
    async fn should_run_server_and_process_packets() {
        use crate::network::BufferPool;
        use crate::network::capture::tests::MockSender;
        use hickory_proto::serialize::binary::BinEncodable;
        use pnet::packet::ethernet::{EtherTypes, MutableEthernetPacket};
        use pnet::packet::ip::IpNextHeaderProtocols;
        use pnet::packet::ipv4::MutableIpv4Packet;
        use pnet::packet::udp::MutableUdpPacket;
        use pnet::util::MacAddr;
        use std::net::Ipv4Addr;

        let cache = MockCache::new();
        let resolver = MockResolver::new();

        // Configure resolver to return a response
        let name = Name::from_str("test.com").unwrap();
        let upstream_response = create_response(0);
        resolver.add_response(name, upstream_response).await;

        let blocker = Blocker::default();
        let handler = QueryHandler::new(cache, resolver, blocker);
        let buffer_pool = BufferPool::new(4);
        let sender = MockSender::new();
        let running = Arc::new(AtomicBool::new(true));

        // Create a channel for packets
        let (tx, rx) = mpsc::channel(10);

        // Build a valid DNS query packet
        let query = create_query("test.com", 456);
        let dns_bytes = query.to_bytes().unwrap();

        let udp_len = 8 + dns_bytes.len();
        let ipv4_len = 20 + udp_len;
        let total_len = 14 + ipv4_len;

        let mut buffer = vec![0u8; total_len];

        // Build Ethernet header
        {
            let mut eth = MutableEthernetPacket::new(&mut buffer[..]).unwrap();
            eth.set_source(MacAddr::new(0x11, 0x22, 0x33, 0x44, 0x55, 0x66));
            eth.set_destination(MacAddr::new(0xaa, 0xbb, 0xcc, 0xdd, 0xee, 0xff));
            eth.set_ethertype(EtherTypes::Ipv4);
        }

        // Build IPv4 header
        {
            let mut ipv4 = MutableIpv4Packet::new(&mut buffer[14..]).unwrap();
            ipv4.set_version(4);
            ipv4.set_header_length(5);
            ipv4.set_total_length(ipv4_len as u16);
            ipv4.set_next_level_protocol(IpNextHeaderProtocols::Udp);
            ipv4.set_source(Ipv4Addr::new(192, 168, 1, 100));
            ipv4.set_destination(Ipv4Addr::new(192, 168, 1, 1));
        }

        // Build UDP header with DNS payload
        {
            let mut udp = MutableUdpPacket::new(&mut buffer[34..]).unwrap();
            udp.set_source(12345);
            udp.set_destination(53);
            udp.set_length(udp_len as u16);
            udp.set_payload(&dns_bytes);
        }

        // Send the packet
        tx.send(buffer).await.unwrap();

        // Close the channel to signal end
        drop(tx);

        // Run the server (it will process packets until channel is closed)
        let result = run_server(rx, handler, sender.clone(), buffer_pool, running).await;
        assert!(result.is_ok());

        // Verify a response was sent
        assert_eq!(sender.sent_count(), 1);
    }

    #[tokio::test]
    async fn should_skip_non_dns_packets_in_server() {
        use crate::network::BufferPool;
        use crate::network::capture::tests::MockSender;
        use pnet::packet::ethernet::{EtherTypes, MutableEthernetPacket};

        let cache = MockCache::new();
        let resolver = MockResolver::new();
        let blocker = Blocker::default();
        let handler = QueryHandler::new(cache, resolver, blocker);
        let buffer_pool = BufferPool::new(4);
        let sender = MockSender::new();
        let running = Arc::new(AtomicBool::new(true));

        let (tx, rx) = mpsc::channel(10);

        // Send a non-IP packet (ARP)
        let mut buffer = vec![0u8; 64];
        {
            let mut eth = MutableEthernetPacket::new(&mut buffer[..]).unwrap();
            eth.set_ethertype(EtherTypes::Arp);
        }
        tx.send(buffer).await.unwrap();
        drop(tx);

        let result = run_server(rx, handler, sender.clone(), buffer_pool, running).await;
        assert!(result.is_ok());

        // No response should be sent for non-DNS packets
        assert_eq!(sender.sent_count(), 0);
    }

    #[tokio::test]
    async fn should_handle_malformed_dns_payload_gracefully() {
        use crate::network::BufferPool;
        use crate::network::capture::tests::MockSender;
        use pnet::packet::ethernet::{EtherTypes, MutableEthernetPacket};
        use pnet::packet::ip::IpNextHeaderProtocols;
        use pnet::packet::ipv4::MutableIpv4Packet;
        use pnet::packet::udp::MutableUdpPacket;
        use pnet::util::MacAddr;
        use std::net::Ipv4Addr;

        let cache = MockCache::new();
        let resolver = MockResolver::new();
        let blocker = Blocker::default();
        let handler = QueryHandler::new(cache, resolver, blocker);
        let buffer_pool = BufferPool::new(4);
        let sender = MockSender::new();
        let running = Arc::new(AtomicBool::new(true));

        let (tx, rx) = mpsc::channel(10);

        // Build packet with invalid DNS payload
        let invalid_dns = b"not valid dns data";
        let udp_len = 8 + invalid_dns.len();
        let ipv4_len = 20 + udp_len;
        let total_len = 14 + ipv4_len;

        let mut buffer = vec![0u8; total_len];

        {
            let mut eth = MutableEthernetPacket::new(&mut buffer[..]).unwrap();
            eth.set_source(MacAddr::new(0x11, 0x22, 0x33, 0x44, 0x55, 0x66));
            eth.set_destination(MacAddr::new(0xaa, 0xbb, 0xcc, 0xdd, 0xee, 0xff));
            eth.set_ethertype(EtherTypes::Ipv4);
        }

        {
            let mut ipv4 = MutableIpv4Packet::new(&mut buffer[14..]).unwrap();
            ipv4.set_version(4);
            ipv4.set_header_length(5);
            ipv4.set_total_length(ipv4_len as u16);
            ipv4.set_next_level_protocol(IpNextHeaderProtocols::Udp);
            ipv4.set_source(Ipv4Addr::new(192, 168, 1, 100));
            ipv4.set_destination(Ipv4Addr::new(192, 168, 1, 1));
        }

        {
            let mut udp = MutableUdpPacket::new(&mut buffer[34..]).unwrap();
            udp.set_source(12345);
            udp.set_destination(53);
            udp.set_length(udp_len as u16);
            udp.set_payload(invalid_dns);
        }

        tx.send(buffer).await.unwrap();
        drop(tx);

        let result = run_server(rx, handler, sender.clone(), buffer_pool, running).await;
        assert!(result.is_ok());

        // No response should be sent for malformed DNS
        assert_eq!(sender.sent_count(), 0);
    }
}