lazydns 0.2.63

A light and fast DNS server/forwarder implementation in Rust
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

use crate::config::PluginConfig;
use crate::plugin::{Context, ExecPlugin, Plugin};
/// This plugin can either set a fixed TTL for all response records,
/// or enforce a minimum/maximum TTL range. Use `fix` to set all TTLs to
/// an exact value (>0); otherwise `min` and/or `max` are applied.
///
/// Quick setup strings are supported via `quick_setup`, e.g. "60" (fix=60)
/// or "30-300" (min=30, max=300).
use crate::{RegisterExecPlugin, Result};
use async_trait::async_trait;
use std::fmt;
use std::sync::Arc;

/// TTL plugin: fix or clamp TTLs on responses
/// TTL plugin configuration.
///
/// Fields:
/// - `fix`: If >0, all record TTLs will be set to this value.
/// - `min`: Minimum TTL to enforce when `fix == 0`.
/// - `max`: Maximum TTL to enforce when `fix == 0`.
#[derive(RegisterExecPlugin)]
pub struct TtlPlugin {
    fix: u32,
    min: u32,
    max: u32,
}

impl TtlPlugin {
    /// Create a new `TtlPlugin`.
    ///
    /// - `fix`: if non-zero, sets all TTLs to this value.
    /// - `min`: minimum TTL to clamp to when `fix` is zero.
    /// - `max`: maximum TTL to clamp to when `fix` is zero.
    pub fn new(fix: u32, min: u32, max: u32) -> Self {
        Self { fix, min, max }
    }

    /// Apply TTL rules to the response contained in `ctx`.
    ///
    /// If `fix` > 0, all records have their TTL replaced with `fix`.
    /// Otherwise `min` and `max` are enforced where set (>0).
    fn apply(&self, ctx: &mut Context) {
        if let Some(resp) = ctx.response_mut() {
            if self.fix > 0 {
                for rr in resp.answers_mut().iter_mut() {
                    rr.set_ttl(self.fix);
                }
                for rr in resp.authority_mut().iter_mut() {
                    rr.set_ttl(self.fix);
                }
                for rr in resp.additional_mut().iter_mut() {
                    rr.set_ttl(self.fix);
                }
            } else {
                if self.min > 0 {
                    for rr in resp.answers_mut().iter_mut() {
                        if rr.ttl() < self.min {
                            rr.set_ttl(self.min);
                        }
                    }
                    for rr in resp.authority_mut().iter_mut() {
                        if rr.ttl() < self.min {
                            rr.set_ttl(self.min);
                        }
                    }
                    for rr in resp.additional_mut().iter_mut() {
                        if rr.ttl() < self.min {
                            rr.set_ttl(self.min);
                        }
                    }
                }
                if self.max > 0 {
                    for rr in resp.answers_mut().iter_mut() {
                        if rr.ttl() > self.max {
                            rr.set_ttl(self.max);
                        }
                    }
                    for rr in resp.authority_mut().iter_mut() {
                        if rr.ttl() > self.max {
                            rr.set_ttl(self.max);
                        }
                    }
                    for rr in resp.additional_mut().iter_mut() {
                        if rr.ttl() > self.max {
                            rr.set_ttl(self.max);
                        }
                    }
                }
            }
        }
    }
}

impl fmt::Debug for TtlPlugin {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("TtlPlugin").finish()
    }
}

#[async_trait]
impl Plugin for TtlPlugin {
    /// Return the plugin name used in configuration.
    fn name(&self) -> &str {
        "ttl"
    }

    /// Execute the plugin for a given request context.
    ///
    /// This will modify any response in the context to adjust TTLs.
    async fn execute(&self, ctx: &mut Context) -> Result<()> {
        self.apply(ctx);
        Ok(())
    }

    fn init(config: &PluginConfig) -> Result<Arc<dyn Plugin>> {
        let args = config.effective_args();

        let ttl = args.get("ttl").and_then(|v| v.as_i64()).unwrap_or(300) as u32;
        Ok(Arc::new(TtlPlugin::new(ttl, 0, 0)))
    }
}

impl ExecPlugin for TtlPlugin {
    /// Parse a quick configuration string.
    ///
    /// Accepts either a range `"min-max"` or a single fixed value.
    /// Returns a `TtlPlugin` configured accordingly.
    fn quick_setup(prefix: &str, exec_str: &str) -> Result<Arc<dyn Plugin>> {
        if prefix != "ttl" {
            return Err(crate::Error::Config(format!(
                "ExecPlugin quick_setup: unsupported prefix '{}', expected 'ttl'",
                prefix
            )));
        }

        let plugin = if exec_str.contains('-') {
            let parts: Vec<&str> = exec_str.splitn(2, '-').collect();
            let l = parts[0].parse::<u32>().unwrap_or(0);
            let u = parts[1].parse::<u32>().unwrap_or(0);
            TtlPlugin::new(0, l, u)
        } else {
            let f = exec_str.parse::<u32>().unwrap_or(0);
            TtlPlugin::new(f, 0, 0)
        };

        Ok(Arc::new(plugin))
    }
}

#[cfg(test)]
mod tests {
    use std::net::{Ipv4Addr, Ipv6Addr};

    use super::*;
    use crate::dns::types::{RecordClass, RecordType};
    use crate::dns::{Message, RData, ResourceRecord};

    fn make_a_record(name: &str, ttl: u32) -> ResourceRecord {
        ResourceRecord::new(
            name.into(),
            RecordType::A,
            RecordClass::IN,
            ttl,
            crate::dns::RData::A(std::net::Ipv4Addr::new(1, 2, 3, 4)),
        )
    }

    #[tokio::test]
    async fn test_ttl_fix() {
        let plugin = TtlPlugin::new(10, 0, 0);
        let mut msg = Message::new();
        msg.add_answer(make_a_record("a", 300));
        let mut ctx = crate::plugin::Context::new(crate::dns::Message::new());
        ctx.set_response(Some(msg));
        plugin.execute(&mut ctx).await.unwrap();
        let resp = ctx.response().unwrap();
        assert_eq!(resp.answers()[0].ttl(), 10);
    }

    #[tokio::test]
    async fn test_ttl_min_clamp() {
        let plugin = TtlPlugin::new(0, 50, 0);
        let mut msg = Message::new();
        msg.add_answer(make_a_record("a", 30));
        msg.add_authority(make_a_record("auth", 10));
        msg.add_additional(make_a_record("add", 20));

        let mut ctx = crate::plugin::Context::new(crate::dns::Message::new());
        ctx.set_response(Some(msg));
        plugin.execute(&mut ctx).await.unwrap();
        let resp = ctx.response().unwrap();
        assert_eq!(resp.answers()[0].ttl(), 50);
        assert_eq!(resp.authority()[0].ttl(), 50);
        assert_eq!(resp.additional()[0].ttl(), 50);
    }

    #[tokio::test]
    async fn test_ttl_max_clamp() {
        let plugin = TtlPlugin::new(0, 0, 100);
        let mut msg = Message::new();
        msg.add_answer(make_a_record("a", 200));
        msg.add_authority(make_a_record("auth", 250));
        msg.add_additional(make_a_record("add", 500));

        let mut ctx = crate::plugin::Context::new(crate::dns::Message::new());
        ctx.set_response(Some(msg));
        plugin.execute(&mut ctx).await.unwrap();
        let resp = ctx.response().unwrap();
        assert_eq!(resp.answers()[0].ttl(), 100);
        assert_eq!(resp.authority()[0].ttl(), 100);
        assert_eq!(resp.additional()[0].ttl(), 100);
    }

    #[tokio::test]
    async fn test_ttl_min_max_range() {
        let plugin = TtlPlugin::new(0, 30, 100);
        let mut msg = Message::new();
        msg.add_answer(make_a_record("low", 10));
        msg.add_answer(make_a_record("mid", 50));
        msg.add_answer(make_a_record("high", 200));

        let mut ctx = crate::plugin::Context::new(crate::dns::Message::new());
        ctx.set_response(Some(msg));
        plugin.execute(&mut ctx).await.unwrap();
        let resp = ctx.response().unwrap();
        assert_eq!(resp.answers()[0].ttl(), 30);
        assert_eq!(resp.answers()[1].ttl(), 50);
        assert_eq!(resp.answers()[2].ttl(), 100);
    }

    #[tokio::test]
    async fn test_ttl_plugin_rewrites_records() {
        let mut response = Message::new();
        response.set_response(true);
        response.add_answer(ResourceRecord::new(
            "example.com".to_string(),
            RecordType::A,
            RecordClass::IN,
            300,
            RData::A(Ipv4Addr::new(192, 0, 2, 1)),
        ));
        response.add_additional(ResourceRecord::new(
            "example.com".to_string(),
            RecordType::AAAA,
            RecordClass::IN,
            450,
            RData::AAAA(Ipv6Addr::LOCALHOST),
        ));

        let mut ctx = Context::new(Message::new());
        ctx.set_response(Some(response));

        let plugin = TtlPlugin::new(60, 0, 0);
        plugin.execute(&mut ctx).await.unwrap();

        let resp = ctx.response().unwrap();
        assert!(resp.answers().iter().all(|r| r.ttl() == 60));
        assert!(resp.additional().iter().all(|r| r.ttl() == 60));
    }

    #[test]
    fn test_exec_plugin_quick_setup() {
        // Test that ExecPlugin::quick_setup works correctly
        let plugin = <TtlPlugin as ExecPlugin>::quick_setup("ttl", "60").unwrap();
        assert_eq!(plugin.name(), "ttl");

        // Test invalid prefix
        let result = <TtlPlugin as ExecPlugin>::quick_setup("invalid", "60");
        assert!(result.is_err());
    }
}