openiwan 0.3.0

An iWAN client and protocol library
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
use super::{
    DnsDefaults, DnsOverrides, DnsPacketAction, DnsPacketEngine, DnsPlatformTarget,
    DnsPolicyResolver, DnsRelay, DnsRelayRequest, EffectiveDnsPolicy, PhysicalResolver,
    PlatformDnsLease, RelayConfig, discover_physical_resolvers,
};
use crate::Result;
use crate::client::{PacketDevice, SessionInfo};
use std::io::{self, ErrorKind};
use std::net::IpAddr;
use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
use std::sync::{Arc, Mutex, RwLock};
use std::thread::{self, JoinHandle};
use tracing::{debug, warn};

#[derive(Debug)]
struct PolicyInputs {
    defaults: DnsDefaults,
    overrides: DnsOverrides,
}

#[derive(Debug)]
pub struct DnsRuntime {
    target: DnsPlatformTarget,
    inputs: RwLock<PolicyInputs>,
    policy: RwLock<Arc<EffectiveDnsPolicy>>,
    physical: RwLock<Arc<[PhysicalResolver]>>,
    relay: Arc<DnsRelay>,
    lease: Mutex<Option<PlatformDnsLease>>,
    active: AtomicBool,
    workers: Mutex<Vec<JoinHandle<()>>>,
    worker_count: Arc<AtomicUsize>,
    max_workers: usize,
    physical_ipv6: bool,
}

impl DnsRuntime {
    pub fn new(
        target: DnsPlatformTarget,
        defaults: DnsDefaults,
        overrides: DnsOverrides,
        physical: Vec<PhysicalResolver>,
        relay_config: RelayConfig,
    ) -> Result<Self> {
        target.validate()?;
        overrides.validate()?;
        let policy = DnsPolicyResolver::resolve(&defaults, &overrides, &[])?;
        Ok(Self {
            target,
            inputs: RwLock::new(PolicyInputs {
                defaults,
                overrides,
            }),
            policy: RwLock::new(Arc::new(policy)),
            physical: RwLock::new(physical.clone().into()),
            relay: Arc::new(DnsRelay::new(relay_config, physical)),
            lease: Mutex::new(None),
            active: AtomicBool::new(false),
            workers: Mutex::new(Vec::new()),
            worker_count: Arc::new(AtomicUsize::new(0)),
            max_workers: relay_config.max_concurrent,
            physical_ipv6: true,
        })
    }

    /// Allow physical IPv6 resolvers for split-DNS relay traffic.
    ///
    /// This is enabled by default. TUN clients that capture and drop IPv6 can
    /// disable it so the relay cannot bypass that policy by binding directly
    /// to a physical interface.
    pub fn with_physical_ipv6(mut self, enabled: bool) -> Self {
        self.physical_ipv6 = enabled;
        self
    }

    pub fn policy(&self) -> Arc<EffectiveDnsPolicy> {
        Arc::clone(
            &self
                .policy
                .read()
                .unwrap_or_else(std::sync::PoisonError::into_inner),
        )
    }

    pub fn update_inputs(&self, defaults: DnsDefaults, overrides: DnsOverrides) -> Result<()> {
        overrides.validate()?;
        *self
            .inputs
            .write()
            .unwrap_or_else(std::sync::PoisonError::into_inner) = PolicyInputs {
            defaults,
            overrides,
        };
        Ok(())
    }

    pub fn update_policy(
        &self,
        defaults: DnsDefaults,
        overrides: DnsOverrides,
        session_dns: &[IpAddr],
    ) -> Result<()> {
        overrides.validate()?;
        let policy = DnsPolicyResolver::resolve(&defaults, &overrides, session_dns)?;
        self.activate_policy(policy)?;
        *self
            .inputs
            .write()
            .unwrap_or_else(std::sync::PoisonError::into_inner) = PolicyInputs {
            defaults,
            overrides,
        };
        Ok(())
    }

    pub fn activate(&self, session: &SessionInfo) -> Result<()> {
        match discover_physical_resolvers() {
            Ok(discovered) => {
                *self
                    .physical
                    .write()
                    .unwrap_or_else(std::sync::PoisonError::into_inner) = discovered.into();
            }
            Err(error) => {
                warn!(%error, "could not refresh physical DNS resolvers; using prior snapshot");
            }
        }
        let policy = {
            let inputs = self
                .inputs
                .read()
                .unwrap_or_else(std::sync::PoisonError::into_inner);
            DnsPolicyResolver::resolve(&inputs.defaults, &inputs.overrides, &session.dns_servers)?
        };
        self.activate_policy(policy)
    }

    pub fn activate_policy(&self, policy: EffectiveDnsPolicy) -> Result<()> {
        let tunnel_servers = policy
            .servers
            .iter()
            .copied()
            .map(IpAddr::V4)
            .collect::<Vec<_>>();
        let physical_snapshot = Arc::clone(
            &self
                .physical
                .read()
                .unwrap_or_else(std::sync::PoisonError::into_inner),
        );
        let physical =
            filter_physical_resolvers(&physical_snapshot, &tunnel_servers, self.physical_ipv6);

        let mut lease = self
            .lease
            .lock()
            .unwrap_or_else(std::sync::PoisonError::into_inner);
        let previous_policy = self.policy();
        let previous_lease = lease.take();
        drop(previous_lease);
        let new_lease = match PlatformDnsLease::apply(&self.target, &policy.servers) {
            Ok(lease) => lease,
            Err(error) => {
                if let Ok(restored) =
                    PlatformDnsLease::apply(&self.target, &previous_policy.servers)
                {
                    *lease = Some(restored);
                }
                return Err(error);
            }
        };
        *self
            .policy
            .write()
            .unwrap_or_else(std::sync::PoisonError::into_inner) = Arc::new(policy);
        self.relay.update_resolvers(physical);
        *lease = Some(new_lease);
        self.active.store(true, Ordering::Release);
        Ok(())
    }

    pub fn deactivate(&self) -> Result<()> {
        self.active.store(false, Ordering::Release);
        self.relay.reset_generation();
        let workers = std::mem::take(
            &mut *self
                .workers
                .lock()
                .unwrap_or_else(std::sync::PoisonError::into_inner),
        );
        for worker in workers {
            let _ = worker.join();
        }
        self.lease
            .lock()
            .unwrap_or_else(std::sync::PoisonError::into_inner)
            .take();
        Ok(())
    }

    fn process(&self, packet: &[u8]) -> DnsPacketAction {
        if !self.active.load(Ordering::Acquire) {
            return DnsPacketAction::Pass;
        }
        DnsPacketEngine::from_shared(self.policy()).process(packet)
    }

    fn spawn_relay<D>(&self, device: Arc<D>, request: DnsRelayRequest)
    where
        D: PacketDevice + ?Sized,
    {
        self.reap_workers();
        if !self.try_acquire_worker() {
            if let Some(response) = request.servfail_packet() {
                let _ = device.write_packet(&response);
            }
            return;
        }
        if !self.relay.has_resolvers() {
            self.worker_count.fetch_sub(1, Ordering::AcqRel);
            return;
        }
        let relay = Arc::clone(&self.relay);
        let generation = relay.generation();
        let worker_count = Arc::clone(&self.worker_count);
        let worker_request = request.clone();
        let worker_device = Arc::clone(&device);
        let worker = thread::Builder::new()
            .name("openiwan-dns-relay".into())
            .spawn(move || {
                let _counter = WorkerCounter(worker_count);
                match relay.relay(worker_request.dns_request(), generation) {
                    Ok(response) => {
                        if let Some(packet) = worker_request.response_packet(&response)
                            && let Err(error) = worker_device.write_packet(&packet)
                        {
                            warn!(%error, "failed to inject relayed DNS response");
                        }
                    }
                    Err(error) if error.kind() == ErrorKind::Interrupted => {
                        debug!("discarding DNS reply from an obsolete generation");
                    }
                    Err(error) => {
                        warn!(%error, "physical DNS relay failed");
                        if let Some(packet) = worker_request.servfail_packet() {
                            let _ = worker_device.write_packet(&packet);
                        }
                    }
                }
            });
        match worker {
            Ok(worker) => self
                .workers
                .lock()
                .unwrap_or_else(std::sync::PoisonError::into_inner)
                .push(worker),
            Err(error) => {
                self.worker_count.fetch_sub(1, Ordering::AcqRel);
                warn!(%error, "failed to spawn DNS relay worker");
                if let Some(response) = request.servfail_packet() {
                    let _ = device.write_packet(&response);
                }
            }
        }
    }

    fn try_acquire_worker(&self) -> bool {
        let mut current = self.worker_count.load(Ordering::Acquire);
        loop {
            if current >= self.max_workers {
                return false;
            }
            match self.worker_count.compare_exchange_weak(
                current,
                current + 1,
                Ordering::AcqRel,
                Ordering::Acquire,
            ) {
                Ok(_) => return true,
                Err(actual) => current = actual,
            }
        }
    }

    fn reap_workers(&self) {
        let mut workers = self
            .workers
            .lock()
            .unwrap_or_else(std::sync::PoisonError::into_inner);
        let mut index = 0;
        while index < workers.len() {
            if workers[index].is_finished() {
                let worker = workers.swap_remove(index);
                let _ = worker.join();
            } else {
                index += 1;
            }
        }
    }
}

fn filter_physical_resolvers(
    physical: &[PhysicalResolver],
    tunnel_servers: &[IpAddr],
    physical_ipv6: bool,
) -> Vec<PhysicalResolver> {
    physical
        .iter()
        .filter(|resolver| {
            (physical_ipv6 || resolver.address.ip().is_ipv4())
                && !tunnel_servers.contains(&resolver.address.ip())
        })
        .cloned()
        .collect()
}

impl Drop for DnsRuntime {
    fn drop(&mut self) {
        let _ = self.deactivate();
    }
}

struct WorkerCounter(Arc<AtomicUsize>);

impl Drop for WorkerCounter {
    fn drop(&mut self) {
        self.0.fetch_sub(1, Ordering::AcqRel);
    }
}

pub struct DnsPacketDevice<D: PacketDevice + ?Sized> {
    inner: Arc<D>,
    runtime: Arc<DnsRuntime>,
}

impl<D: PacketDevice + ?Sized> std::fmt::Debug for DnsPacketDevice<D> {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        formatter
            .debug_struct("DnsPacketDevice")
            .field("name", &self.inner.name())
            .field("runtime", &self.runtime)
            .finish_non_exhaustive()
    }
}

impl<D: PacketDevice + ?Sized> DnsPacketDevice<D> {
    pub fn new(inner: Arc<D>, runtime: Arc<DnsRuntime>) -> Self {
        Self { inner, runtime }
    }

    pub fn runtime(&self) -> &Arc<DnsRuntime> {
        &self.runtime
    }

    pub fn inner(&self) -> &Arc<D> {
        &self.inner
    }
}

impl<D: PacketDevice + ?Sized> PacketDevice for DnsPacketDevice<D> {
    fn name(&self) -> &str {
        self.inner.name()
    }

    fn activate_session(&self, session: &SessionInfo) -> Result<()> {
        self.inner.activate_session(session)?;
        if let Err(error) = self.runtime.activate(session) {
            let _ = self.inner.deactivate_session();
            return Err(error);
        }
        Ok(())
    }

    fn deactivate_session(&self) -> Result<()> {
        let runtime = self.runtime.deactivate();
        let inner = self.inner.deactivate_session();
        runtime.and(inner)
    }

    fn read_packet(&self, buffer: &mut [u8]) -> io::Result<usize> {
        loop {
            let length = self.inner.read_packet(buffer)?;
            match self.runtime.process(&buffer[..length]) {
                DnsPacketAction::Pass => return Ok(length),
                DnsPacketAction::Drop => {}
                DnsPacketAction::Inject(response) => {
                    write_complete(self.inner.as_ref(), &response)?;
                }
                DnsPacketAction::Relay(request) => {
                    if self.runtime.relay.has_resolvers() {
                        self.runtime.spawn_relay(Arc::clone(&self.inner), request);
                    } else {
                        // App-compatible fail-open behavior when the host has no
                        // usable physical resolver: send the original query
                        // through the tunnel.
                        return Ok(length);
                    }
                }
            }
        }
    }

    fn write_packet(&self, packet: &[u8]) -> io::Result<usize> {
        self.inner.write_packet(packet)
    }
}

fn write_complete<D: PacketDevice + ?Sized>(device: &D, packet: &[u8]) -> io::Result<()> {
    let written = device.write_packet(packet)?;
    if written == packet.len() {
        Ok(())
    } else {
        Err(io::Error::new(
            ErrorKind::WriteZero,
            format!(
                "packet device accepted {written} of {} DNS response bytes",
                packet.len()
            ),
        ))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::dns::{DnsServerMode, SplitDnsMode};
    use crate::protocol::EncryptionMethod;
    use std::net::{Ipv4Addr, SocketAddr};

    struct NullDevice;

    impl PacketDevice for NullDevice {
        fn name(&self) -> &'static str {
            "null0"
        }

        fn read_packet(&self, _buffer: &mut [u8]) -> io::Result<usize> {
            Err(io::Error::new(ErrorKind::WouldBlock, "empty"))
        }

        fn write_packet(&self, packet: &[u8]) -> io::Result<usize> {
            Ok(packet.len())
        }
    }

    fn session(dns: Ipv4Addr) -> SessionInfo {
        SessionInfo {
            peer: SocketAddr::from(([192, 0, 2, 1], 6001)),
            session_id: 1,
            token: 2,
            encryption: EncryptionMethod::Xor,
            mtu: 1400,
            address: Some(IpAddr::V4(Ipv4Addr::new(10, 0, 0, 2))),
            gateway: None,
            dns_servers: vec![IpAddr::V4(dns)],
            segment_routing: false,
        }
    }

    #[test]
    fn physical_resolver_filter_can_disable_ipv6_without_affecting_ipv4() {
        let physical = [
            PhysicalResolver::new("192.0.2.53".parse().unwrap()),
            PhysicalResolver::new("2001:db8::53".parse().unwrap()),
            PhysicalResolver::new("198.51.100.53".parse().unwrap()),
        ];
        let tunnel = ["198.51.100.53".parse().unwrap()];

        let ipv4_only = filter_physical_resolvers(&physical, &tunnel, false);
        assert_eq!(
            ipv4_only
                .iter()
                .map(|resolver| resolver.address.ip())
                .collect::<Vec<_>>(),
            ["192.0.2.53".parse::<IpAddr>().unwrap()]
        );

        let dual_stack = filter_physical_resolvers(&physical, &tunnel, true);
        assert_eq!(dual_stack.len(), 2);
        assert!(
            dual_stack
                .iter()
                .any(|resolver| resolver.address.ip().is_ipv6())
        );
    }

    #[test]
    fn session_activation_recomputes_openack_dns() {
        let runtime = DnsRuntime::new(
            DnsPlatformTarget::new("test0"),
            DnsDefaults::default(),
            DnsOverrides::default(),
            Vec::new(),
            RelayConfig::default(),
        )
        .unwrap();
        // Avoid invoking a real platform DNS backend in this unit test by
        // resolving a disabled policy, then inspect policy replacement.
        runtime
            .update_inputs(
                DnsDefaults::default(),
                DnsOverrides {
                    server_mode: Some(DnsServerMode::Disabled),
                    split_mode: Some(SplitDnsMode::Off),
                    ..DnsOverrides::default()
                },
            )
            .unwrap();
        runtime
            .activate(&session(Ipv4Addr::new(192, 0, 2, 53)))
            .unwrap();
        assert_eq!(runtime.policy().server_mode, DnsServerMode::Disabled);
        runtime.deactivate().unwrap();
    }

    #[test]
    fn wrapper_delegates_identity_and_writes() {
        let runtime = Arc::new(
            DnsRuntime::new(
                DnsPlatformTarget::new("test0"),
                DnsDefaults::default(),
                DnsOverrides::default(),
                Vec::new(),
                RelayConfig::default(),
            )
            .unwrap(),
        );
        let device = DnsPacketDevice::new(Arc::new(NullDevice), runtime);
        assert_eq!(device.name(), "null0");
        assert_eq!(device.write_packet(&[1, 2, 3]).unwrap(), 3);
    }
}