mcp-oxidized 1.2.0

MCP server for Oxidized network device configuration backup system
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
//! Configuration management for mcp-oxidized server.
//!
//! This module handles loading configuration from environment variables with a
//! precedence chain that supports MCP client configuration passthrough.
//!
//! # Environment Variables
//!
//! - `OXIDIZED_URL` - Oxidized server URL (default: `http://localhost:8888`)
//! - `OXIDIZED_USER` - Optional username for Basic Auth
//! - `OXIDIZED_PASSWORD` - Optional password for Basic Auth
//! - `OXIDIZED_PASSWORD_FILE` - Optional path to file containing password (takes precedence over `OXIDIZED_PASSWORD`)
//! - `OXIDIZED_SSL_VERIFY` - SSL certificate verification (`true`/`false`, default: `true`)
//! - `OXIDIZED_HEADERS` - Custom HTTP headers (format: `Header1:Value1,Header2:Value2`)

use std::env;
use std::fs;
use thiserror::Error;

/// Configuration for mcp-oxidized server
#[derive(Debug, Clone)]
pub struct Config {
    /// Oxidized server base URL (e.g., `http://localhost:8888`)
    pub oxidized_url: String,
    /// Optional username for HTTP Basic Auth
    pub oxidized_user: Option<String>,
    /// Optional password for HTTP Basic Auth
    pub oxidized_password: Option<String>,
    /// Whether to verify SSL certificates (default: `true`)
    pub ssl_verify: bool,
    /// Custom HTTP headers to include in all requests
    pub custom_headers: Vec<(String, String)>,
}

/// Configuration errors with actionable context
#[derive(Debug, Error)]
pub enum ConfigError {
    #[error("Invalid Oxidized URL: {0}. Must start with http:// or https://")]
    InvalidUrl(String),

    #[error("Failed to read password file at {path}: {source}")]
    PasswordFileError {
        path: String,
        source: std::io::Error,
    },

    #[error("Environment variable error: {0}")]
    EnvVarError(String),

    #[error("Invalid header format: {0}. Expected format: Header1:Value1,Header2:Value2")]
    InvalidHeaderFormat(String),
}

impl Config {
    /// Load configuration from environment variables with precedence chain
    ///
    /// Precedence (highest to lowest):
    /// 1. Environment variables (includes MCP client config passed via Claude Desktop JSON)
    /// 2. Default values
    ///
    /// Note: MCP clients like Claude Desktop pass their config as environment variables
    /// to child processes. From this binary's perspective, all env vars are read the same
    /// way - the MCP client handles the precedence by setting env vars before spawning.
    ///
    /// Default values (zero-config mode):
    /// - OXIDIZED_URL: "http://localhost:8888"
    /// - OXIDIZED_USER: None
    /// - OXIDIZED_PASSWORD: None
    pub fn load() -> Result<Self, ConfigError> {
        // Load URL with default
        let oxidized_url =
            env::var("OXIDIZED_URL").unwrap_or_else(|_| "http://localhost:8888".to_string());

        // Validate URL format
        Self::validate_url(&oxidized_url)?;

        // Load optional credentials
        let oxidized_user = env::var("OXIDIZED_USER").ok();

        // Check for password file first, then direct password env var
        let oxidized_password = if let Ok(password_file) = env::var("OXIDIZED_PASSWORD_FILE") {
            Some(Self::read_password_file(&password_file)?)
        } else {
            env::var("OXIDIZED_PASSWORD").ok()
        };

        // SSL verify - default true, accept "false" to disable (case-insensitive)
        let ssl_verify = env::var("OXIDIZED_SSL_VERIFY")
            .map(|v| !v.eq_ignore_ascii_case("false"))
            .unwrap_or(true);

        // Custom headers - graceful degradation on parse error
        let custom_headers = match env::var("OXIDIZED_HEADERS") {
            Ok(raw) => Self::parse_headers(&raw).unwrap_or_else(|e| {
                tracing::warn!(error = %e, "Invalid OXIDIZED_HEADERS format, ignoring");
                vec![]
            }),
            Err(_) => vec![],
        };

        Ok(Config {
            oxidized_url,
            oxidized_user,
            oxidized_password,
            ssl_verify,
            custom_headers,
        })
    }

    /// Validate URL format - must start with http:// or https://
    fn validate_url(url: &str) -> Result<(), ConfigError> {
        if !url.starts_with("http://") && !url.starts_with("https://") {
            return Err(ConfigError::InvalidUrl(url.to_string()));
        }
        Ok(())
    }

    /// Read password from file, trimming whitespace
    fn read_password_file(path: &str) -> Result<String, ConfigError> {
        fs::read_to_string(path)
            .map(|content| content.trim().to_string())
            .map_err(|source| ConfigError::PasswordFileError {
                path: path.to_string(),
                source,
            })
    }

    /// Parse OXIDIZED_HEADERS env var format: "Header1:Value1,Header2:Value2"
    ///
    /// # Arguments
    ///
    /// * `raw` - The raw header string to parse
    ///
    /// # Returns
    ///
    /// A vector of (header_name, header_value) tuples.
    /// Invalid entries are logged as warnings and skipped (graceful degradation).
    ///
    /// # Examples
    ///
    /// ```ignore
    /// let headers = Config::parse_headers("X-Api-Key:secret,X-Custom:value")?;
    /// assert_eq!(headers.len(), 2);
    /// ```
    pub fn parse_headers(raw: &str) -> Result<Vec<(String, String)>, ConfigError> {
        if raw.trim().is_empty() {
            return Ok(vec![]);
        }

        let mut headers = Vec::new();
        for pair in raw.split(',') {
            let pair = pair.trim();
            if pair.is_empty() {
                continue;
            }

            // Split on FIRST ':' only (value may contain ':')
            match pair.split_once(':') {
                Some((key, value)) => {
                    let key = key.trim().to_string();
                    let value = value.trim().to_string();
                    if key.is_empty() {
                        tracing::warn!(pair = %pair, "Skipping header with empty key");
                        continue;
                    }
                    headers.push((key, value));
                }
                None => {
                    tracing::warn!(
                        pair = %pair,
                        "Invalid header format, expected 'Key:Value', skipping"
                    );
                }
            }
        }

        Ok(headers)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serial_test::serial;
    use std::io::Write;
    use tempfile::NamedTempFile;

    /// Clear all OXIDIZED_* env vars before each test.
    /// SAFETY: Tests using this are marked #[serial] ensuring single-threaded execution.
    fn clear_env_vars() {
        for key in [
            "OXIDIZED_URL",
            "OXIDIZED_USER",
            "OXIDIZED_PASSWORD",
            "OXIDIZED_PASSWORD_FILE",
            "OXIDIZED_SSL_VERIFY",
            "OXIDIZED_HEADERS",
        ] {
            // SAFETY: #[serial] ensures no concurrent access to env vars
            unsafe { std::env::remove_var(key) };
        }
    }

    /// Set an environment variable for testing.
    /// SAFETY: Tests using this are marked #[serial] ensuring single-threaded execution.
    fn set_env(key: &str, value: &str) {
        // SAFETY: #[serial] ensures no concurrent access to env vars
        unsafe { std::env::set_var(key, value) };
    }

    #[test]
    #[serial]
    fn test_default_values_when_no_env_vars() {
        clear_env_vars();

        let config = Config::load().expect("Should load with defaults");

        assert_eq!(config.oxidized_url, "http://localhost:8888");
        assert_eq!(config.oxidized_user, None);
        assert_eq!(config.oxidized_password, None);
        assert!(config.ssl_verify, "SSL verify should default to true");
        assert!(
            config.custom_headers.is_empty(),
            "Custom headers should be empty by default"
        );
    }

    #[test]
    #[serial]
    fn test_env_var_precedence() {
        clear_env_vars();
        set_env("OXIDIZED_URL", "https://oxidized.example.com");
        set_env("OXIDIZED_USER", "admin");
        set_env("OXIDIZED_PASSWORD", "secret123");

        let config = Config::load().expect("Should load from env vars");

        assert_eq!(config.oxidized_url, "https://oxidized.example.com");
        assert_eq!(config.oxidized_user, Some("admin".to_string()));
        assert_eq!(config.oxidized_password, Some("secret123".to_string()));

        clear_env_vars();
    }

    #[test]
    fn test_url_validation_valid_http() {
        let result = Config::validate_url("http://localhost:8888");
        assert!(result.is_ok());
    }

    #[test]
    fn test_url_validation_valid_https() {
        let result = Config::validate_url("https://oxidized.example.com");
        assert!(result.is_ok());
    }

    #[test]
    fn test_url_validation_invalid_format() {
        let result = Config::validate_url("ftp://invalid.com");
        assert!(result.is_err());

        if let Err(ConfigError::InvalidUrl(url)) = result {
            assert_eq!(url, "ftp://invalid.com");
        } else {
            panic!("Expected InvalidUrl error");
        }
    }

    #[test]
    fn test_password_file_reading() {
        let mut temp_file = NamedTempFile::new().expect("Failed to create temp file");
        writeln!(temp_file, "  my-secret-password  ").expect("Failed to write to temp file");

        let password = Config::read_password_file(temp_file.path().to_str().unwrap())
            .expect("Should read password file");

        assert_eq!(password, "my-secret-password");
    }

    #[test]
    fn test_password_file_not_found() {
        let result = Config::read_password_file("/nonexistent/password.txt");
        assert!(result.is_err());

        if let Err(ConfigError::PasswordFileError { path, .. }) = result {
            assert_eq!(path, "/nonexistent/password.txt");
        } else {
            panic!("Expected PasswordFileError");
        }
    }

    #[test]
    #[serial]
    fn test_password_file_precedence_over_env_var() {
        clear_env_vars();

        let mut temp_file = NamedTempFile::new().expect("Failed to create temp file");
        writeln!(temp_file, "file-password").expect("Failed to write to temp file");

        set_env("OXIDIZED_PASSWORD_FILE", temp_file.path().to_str().unwrap());
        set_env("OXIDIZED_PASSWORD", "env-password");
        set_env("OXIDIZED_URL", "http://localhost:8888");

        let config = Config::load().expect("Should load config");

        // Password file should take precedence
        assert_eq!(config.oxidized_password, Some("file-password".to_string()));

        clear_env_vars();
    }

    // -------------------------------------------------------------------------
    // SSL Verification Tests (Story 4-1, AC1)
    // -------------------------------------------------------------------------

    #[test]
    #[serial]
    fn test_ssl_verify_default_true() {
        clear_env_vars();

        let config = Config::load().expect("Should load config");
        assert!(config.ssl_verify, "SSL verify should default to true");

        clear_env_vars();
    }

    #[test]
    #[serial]
    fn test_ssl_verify_false_explicit() {
        clear_env_vars();
        set_env("OXIDIZED_SSL_VERIFY", "false");

        let config = Config::load().expect("Should load config");
        assert!(
            !config.ssl_verify,
            "SSL verify should be false when set to 'false'"
        );

        clear_env_vars();
    }

    #[test]
    #[serial]
    fn test_ssl_verify_false_case_insensitive() {
        clear_env_vars();
        set_env("OXIDIZED_SSL_VERIFY", "FALSE");

        let config = Config::load().expect("Should load config");
        assert!(
            !config.ssl_verify,
            "SSL verify should be false (case-insensitive)"
        );

        clear_env_vars();
    }

    #[test]
    #[serial]
    fn test_ssl_verify_true_explicit() {
        clear_env_vars();
        set_env("OXIDIZED_SSL_VERIFY", "true");

        let config = Config::load().expect("Should load config");
        assert!(
            config.ssl_verify,
            "SSL verify should be true when set to 'true'"
        );

        clear_env_vars();
    }

    #[test]
    #[serial]
    fn test_ssl_verify_any_other_value_is_true() {
        clear_env_vars();
        set_env("OXIDIZED_SSL_VERIFY", "yes");

        let config = Config::load().expect("Should load config");
        assert!(
            config.ssl_verify,
            "SSL verify should be true for non-'false' values"
        );

        clear_env_vars();
    }

    // -------------------------------------------------------------------------
    // Header Parsing Tests (Story 4-1, AC2)
    // -------------------------------------------------------------------------

    #[test]
    fn test_parse_headers_valid() {
        let headers = Config::parse_headers("X-Api-Key:secret,X-Custom:value").unwrap();

        assert_eq!(headers.len(), 2);
        assert_eq!(headers[0], ("X-Api-Key".to_string(), "secret".to_string()));
        assert_eq!(headers[1], ("X-Custom".to_string(), "value".to_string()));
    }

    #[test]
    fn test_parse_headers_with_colon_in_value() {
        let headers = Config::parse_headers("Authorization:Bearer token:with:colons").unwrap();

        assert_eq!(headers.len(), 1);
        assert_eq!(headers[0].0, "Authorization");
        assert_eq!(headers[0].1, "Bearer token:with:colons");
    }

    #[test]
    fn test_parse_headers_empty() {
        let headers = Config::parse_headers("").unwrap();
        assert!(headers.is_empty());
    }

    #[test]
    fn test_parse_headers_whitespace_only() {
        let headers = Config::parse_headers("   ").unwrap();
        assert!(headers.is_empty());
    }

    #[test]
    fn test_parse_headers_malformed_graceful() {
        // Invalid entry "invalid" is skipped, valid ones are kept
        let headers = Config::parse_headers("valid:header,invalid,also:valid").unwrap();

        assert_eq!(headers.len(), 2);
        assert_eq!(headers[0], ("valid".to_string(), "header".to_string()));
        assert_eq!(headers[1], ("also".to_string(), "valid".to_string()));
    }

    #[test]
    fn test_parse_headers_trims_whitespace() {
        let headers =
            Config::parse_headers("  X-Api-Key : secret123 , X-Custom : value  ").unwrap();

        assert_eq!(headers.len(), 2);
        assert_eq!(
            headers[0],
            ("X-Api-Key".to_string(), "secret123".to_string())
        );
        assert_eq!(headers[1], ("X-Custom".to_string(), "value".to_string()));
    }

    #[test]
    fn test_parse_headers_empty_key_skipped() {
        // Entry with empty key after colon should be skipped
        let headers = Config::parse_headers(":value,valid:header").unwrap();

        assert_eq!(headers.len(), 1);
        assert_eq!(headers[0], ("valid".to_string(), "header".to_string()));
    }

    #[test]
    fn test_parse_headers_empty_value_allowed() {
        // Empty value is valid (some headers may have no value)
        let headers = Config::parse_headers("X-Empty:").unwrap();

        assert_eq!(headers.len(), 1);
        assert_eq!(headers[0], ("X-Empty".to_string(), "".to_string()));
    }

    #[test]
    fn test_parse_headers_trailing_comma() {
        let headers = Config::parse_headers("X-Api-Key:secret,").unwrap();

        assert_eq!(headers.len(), 1);
        assert_eq!(headers[0], ("X-Api-Key".to_string(), "secret".to_string()));
    }

    #[test]
    #[serial]
    fn test_config_load_with_headers() {
        clear_env_vars();
        set_env("OXIDIZED_HEADERS", "X-Api-Key:secret123,X-Custom:value");

        let config = Config::load().expect("Should load config");

        assert_eq!(config.custom_headers.len(), 2);
        assert_eq!(
            config.custom_headers[0],
            ("X-Api-Key".to_string(), "secret123".to_string())
        );
        assert_eq!(
            config.custom_headers[1],
            ("X-Custom".to_string(), "value".to_string())
        );

        clear_env_vars();
    }

    #[test]
    #[serial]
    fn test_config_load_with_invalid_headers_graceful() {
        clear_env_vars();
        // All entries are malformed - should gracefully degrade to empty
        set_env("OXIDIZED_HEADERS", "invalid");

        let config = Config::load().expect("Should load config even with invalid headers");

        // Should have empty headers (graceful degradation)
        assert!(config.custom_headers.is_empty());

        clear_env_vars();
    }
}