bindcar 0.8.1

HTTP REST API for managing BIND9 zones via rndc
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
// Copyright (c) 2025 Erick Bourgeois, firestoned
// SPDX-License-Identifier: MIT

//! Unit tests for rndc module

use super::rndc::*;

#[test]
fn test_rndc_rejects_weak_hmac_algorithms() {
    // A12: HMAC-MD5 and HMAC-SHA1 are deprecated and must be rejected.
    for weak in ["md5", "sha1", "hmac-md5", "hmac-sha1"] {
        let result = RndcExecutor::new(
            "127.0.0.1:953".to_string(),
            weak.to_string(),
            "dGVzdC1zZWNyZXQ=".to_string(),
        );
        assert!(result.is_err(), "weak algorithm {weak} should be rejected");
    }
}

#[test]
fn test_rndc_accepts_sha2_algorithms() {
    for ok in ["sha256", "hmac-sha256", "sha384", "sha512"] {
        let result = RndcExecutor::new(
            "127.0.0.1:953".to_string(),
            ok.to_string(),
            "dGVzdC1zZWNyZXQ=".to_string(),
        );
        assert!(result.is_ok(), "algorithm {ok} should be accepted");
    }
}

#[test]
fn test_validate_rndc_zone_name_rejects_injection() {
    // A9: sink-side guard rejects traversal, whitespace, and rndc metacharacters.
    for bad in [
        "",
        "../etc/passwd",
        "zone name",
        "zone;reload",
        "zone\nreload",
        "a..b",
    ] {
        assert!(
            validate_rndc_zone_name(bad).is_err(),
            "expected {bad:?} to be rejected"
        );
    }
    assert!(validate_rndc_zone_name("example.com").is_ok());
    assert!(validate_rndc_zone_name("_dmarc.example.com").is_ok());
}

#[test]
fn test_rndc_config_debug_redacts_secret() {
    // A4 regression: `{:?}` on an RndcConfig must never print the plaintext secret.
    let cfg = RndcConfig {
        server: "127.0.0.1:953".to_string(),
        algorithm: "sha256".to_string(),
        secret: "SUPERSECRETBASE64VALUE==".to_string(),
    };
    let debug = format!("{:?}", cfg);
    assert!(
        !debug.contains("SUPERSECRETBASE64VALUE"),
        "TSIG secret leaked via Debug: {debug}"
    );
    assert!(debug.contains("[REDACTED]"), "expected redaction: {debug}");
}

#[test]
fn test_rndc_executor_creation() {
    // Test with valid parameters
    let result = RndcExecutor::new(
        "127.0.0.1:953".to_string(),
        "sha256".to_string(),
        "dGVzdC1zZWNyZXQtaGVyZQ==".to_string(), // base64 encoded test secret
    );
    assert!(result.is_ok());
}

#[test]
fn test_rndc_executor_creation_with_hmac_prefix() {
    // Test with hmac- prefix (should be stripped)
    let result = RndcExecutor::new(
        "127.0.0.1:953".to_string(),
        "hmac-sha256".to_string(),
        "dGVzdC1zZWNyZXQtaGVyZQ==".to_string(),
    );
    assert!(result.is_ok());
}

#[test]
fn test_rndc_executor_creation_with_all_algorithms() {
    // A12: only the SHA-2 family is accepted; md5/sha1 are rejected (tested
    // separately in test_rndc_rejects_weak_hmac_algorithms).
    let algorithms = vec!["sha224", "sha256", "sha384", "sha512"];

    for algo in algorithms {
        let result = RndcExecutor::new(
            "127.0.0.1:953".to_string(),
            algo.to_string(),
            "dGVzdC1zZWNyZXQtaGVyZQ==".to_string(),
        );
        assert!(result.is_ok(), "Algorithm {} should be valid", algo);
    }
}

#[test]
fn test_rndc_executor_creation_with_hmac_prefix_all_algorithms() {
    // A12: SHA-2 family with hmac- prefix (md5/sha1 excluded).
    let algorithms = vec!["hmac-sha224", "hmac-sha256", "hmac-sha384", "hmac-sha512"];

    for algo in algorithms {
        let result = RndcExecutor::new(
            "127.0.0.1:953".to_string(),
            algo.to_string(),
            "dGVzdC1zZWNyZXQtaGVyZQ==".to_string(),
        );
        assert!(result.is_ok(), "Algorithm {} should be valid", algo);
    }
}

#[test]
fn test_rndc_executor_creation_with_invalid_algorithm() {
    let result = RndcExecutor::new(
        "127.0.0.1:953".to_string(),
        "invalid-algo".to_string(),
        "dGVzdC1zZWNyZXQtaGVyZQ==".to_string(),
    );
    assert!(result.is_err());
    let error_msg = result.err().unwrap().to_string();
    assert!(error_msg.contains("Invalid or deprecated algorithm"));
}

#[test]
fn test_rndc_executor_creation_with_whitespace() {
    // Test trimming of whitespace
    let result = RndcExecutor::new(
        " 127.0.0.1:953 ".to_string(),
        " sha256 ".to_string(),
        " dGVzdC1zZWNyZXQtaGVyZQ== ".to_string(),
    );
    assert!(result.is_ok());
}

#[test]
fn test_rndc_executor_clone() {
    let executor = RndcExecutor::new(
        "127.0.0.1:953".to_string(),
        "sha256".to_string(),
        "dGVzdC1zZWNyZXQtaGVyZQ==".to_string(),
    )
    .expect("Failed to create executor");

    let cloned = executor.clone();
    // If clone succeeds without panic, the test passes
    drop(cloned);
}

#[test]
fn test_rndc_config() {
    let config = RndcConfig {
        server: "127.0.0.1:953".to_string(),
        algorithm: "sha256".to_string(),
        secret: "dGVzdC1zZWNyZXQ=".to_string(),
    };

    assert_eq!(config.server, "127.0.0.1:953");
    assert_eq!(config.algorithm, "sha256");
    assert_eq!(config.secret, "dGVzdC1zZWNyZXQ=");
}

#[test]
fn test_rndc_config_clone() {
    let config = RndcConfig {
        server: "127.0.0.1:953".to_string(),
        algorithm: "sha256".to_string(),
        secret: "dGVzdC1zZWNyZXQ=".to_string(),
    };

    let cloned = config.clone();
    assert_eq!(config.server, cloned.server);
    assert_eq!(config.algorithm, cloned.algorithm);
    assert_eq!(config.secret, cloned.secret);
}

#[test]
fn test_parse_rndc_conf_with_temp_file() {
    use std::io::Write;
    use tempfile::NamedTempFile;

    // Create a temporary rndc.conf file
    let mut temp_file = NamedTempFile::new().unwrap();
    writeln!(
        temp_file,
        r#"
key "rndc-key" {{
    algorithm hmac-sha256;
    secret "dGVzdC1zZWNyZXQtaGVyZQ==";
}};

options {{
    default-server 127.0.0.1;
    default-key "rndc-key";
    default-port 953;
}};
"#
    )
    .unwrap();

    let result = parse_rndc_conf(temp_file.path().to_str().unwrap());
    assert!(result.is_ok());

    let config = result.unwrap();
    assert_eq!(config.server, "127.0.0.1:953");
    assert_eq!(config.algorithm, "hmac-sha256");
    assert_eq!(config.secret, "dGVzdC1zZWNyZXQtaGVyZQ==");
}

#[test]
fn test_parse_rndc_conf_with_default_port() {
    use std::io::Write;
    use tempfile::NamedTempFile;

    // Create a temporary rndc.conf file without explicit port
    let mut temp_file = NamedTempFile::new().unwrap();
    writeln!(
        temp_file,
        r#"
key "test-key" {{
    algorithm sha256;
    secret "dGVzdC1zZWNyZXQ=";
}};

options {{
    default-server localhost;
}};
"#
    )
    .unwrap();

    let result = parse_rndc_conf(temp_file.path().to_str().unwrap());
    assert!(result.is_ok());

    let config = result.unwrap();
    assert_eq!(config.server, "localhost:953"); // Should add default port
}

#[test]
fn test_parse_rndc_conf_with_server_and_port() {
    use std::io::Write;
    use tempfile::NamedTempFile;

    // Create a temporary rndc.conf file with server:port format
    let mut temp_file = NamedTempFile::new().unwrap();
    writeln!(
        temp_file,
        r#"
key "test-key" {{
    algorithm sha256;
    secret "dGVzdC1zZWNyZXQ=";
}};

options {{
    default-server 192.168.1.1:8953;
}};
"#
    )
    .unwrap();

    let result = parse_rndc_conf(temp_file.path().to_str().unwrap());
    assert!(result.is_ok());

    let config = result.unwrap();
    assert_eq!(config.server, "192.168.1.1:8953"); // Should keep existing port
}

#[test]
fn test_parse_rndc_conf_with_no_default_server() {
    use std::io::Write;
    use tempfile::NamedTempFile;

    // Create a temporary rndc.conf file without default-server
    let mut temp_file = NamedTempFile::new().unwrap();
    writeln!(
        temp_file,
        r#"
key "test-key" {{
    algorithm sha256;
    secret "dGVzdC1zZWNyZXQ=";
}};
"#
    )
    .unwrap();

    let result = parse_rndc_conf(temp_file.path().to_str().unwrap());
    assert!(result.is_ok());

    let config = result.unwrap();
    assert_eq!(config.server, "127.0.0.1:953"); // Should use default
}

#[test]
fn test_parse_rndc_conf_with_no_keys() {
    use std::io::Write;
    use tempfile::NamedTempFile;

    // Create a temporary rndc.conf file without keys
    let mut temp_file = NamedTempFile::new().unwrap();
    writeln!(
        temp_file,
        r#"
options {{
    default-server 127.0.0.1;
}};
"#
    )
    .unwrap();

    let result = parse_rndc_conf(temp_file.path().to_str().unwrap());
    assert!(result.is_err());
    assert!(result.unwrap_err().to_string().contains("No keys found"));
}

#[test]
fn test_parse_rndc_conf_with_missing_default_key() {
    use std::io::Write;
    use tempfile::NamedTempFile;

    // Create a temporary rndc.conf file with non-existent default key
    let mut temp_file = NamedTempFile::new().unwrap();
    writeln!(
        temp_file,
        r#"
key "test-key" {{
    algorithm sha256;
    secret "dGVzdC1zZWNyZXQ=";
}};

options {{
    default-key "non-existent-key";
}};
"#
    )
    .unwrap();

    let result = parse_rndc_conf(temp_file.path().to_str().unwrap());
    assert!(result.is_err());
    assert!(result.unwrap_err().to_string().contains("not found"));
}

#[test]
fn test_parse_rndc_conf_file_not_found() {
    let result = parse_rndc_conf("/nonexistent/path/rndc.conf");
    assert!(result.is_err());
}

// Note: Integration tests that actually execute rndc commands require
// a running BIND9 instance with rndc configured. These should be in
// integration tests, not unit tests.

// ---------------------------------------------------------------------------
// DNSSEC lifecycle commands (ADR-0001, roadmap 07)
// ---------------------------------------------------------------------------

fn test_executor() -> RndcExecutor {
    RndcExecutor::new(
        "127.0.0.1:953".to_string(),
        "sha256".to_string(),
        "dGVzdC1zZWNyZXQ=".to_string(),
    )
    .expect("test executor must construct")
}

#[tokio::test]
async fn test_dnssec_status_rejects_invalid_zone_name() {
    // The A9 sink-side guard must fire before any network I/O.
    let executor = test_executor();
    for bad in ["zone;reload", "zone name", "../etc"] {
        assert!(
            executor.dnssec_status(bad).await.is_err(),
            "expected {bad:?} to be rejected"
        );
    }
}

#[tokio::test]
async fn test_dnssec_checkds_rejects_invalid_zone_name() {
    let executor = test_executor();
    let result = executor
        .dnssec_checkds("zone;reload", 12345, crate::dnssec::CheckdsState::Withdrawn)
        .await;
    assert!(result.is_err());
}

#[test]
fn test_checkds_state_as_str() {
    assert_eq!(crate::dnssec::CheckdsState::Published.as_str(), "published");
    assert_eq!(crate::dnssec::CheckdsState::Withdrawn.as_str(), "withdrawn");
}

#[test]
fn test_checkds_state_deserializes_lowercase() {
    let published: crate::dnssec::CheckdsState = serde_json::from_str("\"published\"").unwrap();
    assert_eq!(published, crate::dnssec::CheckdsState::Published);
    let withdrawn: crate::dnssec::CheckdsState = serde_json::from_str("\"withdrawn\"").unwrap();
    assert_eq!(withdrawn, crate::dnssec::CheckdsState::Withdrawn);
    assert!(serde_json::from_str::<crate::dnssec::CheckdsState>("\"delete\"").is_err());
}