diff --git a/crates/cli/src/commands/admin/config.rs b/crates/cli/src/commands/admin/config.rs index 9a8eb5a6..09b894b6 100644 --- a/crates/cli/src/commands/admin/config.rs +++ b/crates/cli/src/commands/admin/config.rs @@ -22,7 +22,7 @@ use crate::private_file::write_private_file; #[derive(Subcommand, Debug)] #[command(disable_help_subcommand = true)] pub enum ConfigCommands { - /// Read a subsystem or target configuration + /// Read persisted settings and environment overrides for a subsystem or target Get(GetArgs), /// Set one or more keys after showing a preflight diff Set(SetArgs), @@ -303,7 +303,7 @@ async fn execute_with_api( async fn get(args: GetArgs, api: &dyn ConfigApi, formatter: &Formatter) -> rc_core::Result<()> { validate_selector(&args.selector)?; let document = api.get_config(&args.selector).await?; - let content = redact_config_document(&document.content); + let content = document.redacted_with_env_overrides(); output( formatter, false, diff --git a/crates/cli/tests/admin_config.rs b/crates/cli/tests/admin_config.rs index 2faea6d9..7b41d8c7 100644 --- a/crates/cli/tests/admin_config.rs +++ b/crates/cli/tests/admin_config.rs @@ -40,11 +40,41 @@ fn assert_valid_v3(value: &serde_json::Value) { ); } +#[test] +fn config_get_displays_storage_class_env_overrides_above_persisted_values() { + let config_dir = tempfile::tempdir().expect("create config dir"); + let (endpoint, _receiver, handle) = start_admin_test_server(concat!( + "# RUSTFS_STORAGE_CLASS_RRS=EC:8\n", + "#RUSTFS_STORAGE_CLASS_STANDARD=EC:8\n", + "storage_class rrs=\"EC:1\" standard=\"\"\n", + )); + + let output = run( + &["admin", "config", "get", "myalias", "storage_class"], + &endpoint, + &config_dir, + ); + assert!(output.status.success()); + assert_eq!( + String::from_utf8(output.stdout).expect("UTF-8 stdout"), + concat!( + "# RUSTFS_STORAGE_CLASS_RRS=EC:8\n", + "# RUSTFS_STORAGE_CLASS_STANDARD=EC:8\n", + "storage_class rrs=\"EC:1\" standard=\"\"\n", + ) + ); + handle.join().expect("server finished"); +} + #[test] fn config_get_defensively_redacts_server_output() { let config_dir = tempfile::tempdir().expect("create config dir"); - let (endpoint, receiver, handle) = - start_admin_test_server("identity_openid client_id=console client_secret=server-secret"); + let (endpoint, receiver, handle) = start_admin_test_server(concat!( + "# ordinary comment\n", + "# RUSTFS_IDENTITY_OPENID_CLIENT_ID=env-console\n", + "# RUSTFS_IDENTITY_OPENID_CLIENT_SECRET=env-secret\n", + "identity_openid client_id=console client_secret=server-secret", + )); let output = run( &[ @@ -67,10 +97,19 @@ fn config_get_defensively_redacts_server_output() { let stdout = String::from_utf8(output.stdout).expect("UTF-8 stdout"); assert!(stdout.contains("*redacted*")); assert!(!stdout.contains("server-secret")); + assert!(!stdout.contains("env-secret")); let value: serde_json::Value = serde_json::from_str(&stdout).expect("JSON output"); assert_eq!(value["schema_version"], 3); assert_eq!(value["type"], "admin_operations"); assert_eq!(value["data"]["operations"][0]["changed"], false); + assert_eq!( + value["data"]["operations"][0]["result"]["result"], + concat!( + "# RUSTFS_IDENTITY_OPENID_CLIENT_ID=env-console\n", + "# RUSTFS_IDENTITY_OPENID_CLIENT_SECRET=*redacted*\n", + "identity_openid client_id=\"console\" client_secret=\"*redacted*\"", + ) + ); assert_valid_v3(&value); let request = receiver @@ -121,7 +160,10 @@ fn config_set_dry_run_never_sends_mutation() { let config_dir = tempfile::tempdir().expect("create config dir"); let (endpoint, receiver, handle) = start_admin_sequence_test_server(vec![ ("200 OK", SCANNER_HELP), - ("200 OK", "scanner speed=default"), + ( + "200 OK", + "# RUSTFS_SCANNER_SPEED=slow\nscanner speed=default", + ), ]); let output = run( @@ -144,6 +186,13 @@ fn config_set_dry_run_never_sends_mutation() { "stderr: {}", String::from_utf8_lossy(&output.stderr) ); + let value: serde_json::Value = serde_json::from_slice(&output.stdout).expect("JSON diff"); + let changes = value["data"]["operations"][0]["result"]["diff"]["changes"] + .as_array() + .expect("changes"); + assert_eq!(changes.len(), 1); + assert_eq!(changes[0]["before"], "default"); + assert_eq!(changes[0]["after"], "fast"); let first = receiver .recv_timeout(Duration::from_secs(5)) .expect("help request"); diff --git a/crates/core/src/admin/configuration.rs b/crates/core/src/admin/configuration.rs index 5df45131..459d80e4 100644 --- a/crates/core/src/admin/configuration.rs +++ b/crates/core/src/admin/configuration.rs @@ -12,6 +12,20 @@ pub struct ConfigDocument { pub content: String, } +impl ConfigDocument { + /// Render a config query with server-reported environment overrides above their scopes. + pub fn redacted_with_env_overrides(&self) -> String { + self.content + .lines() + .filter_map(|line| match line.trim_start().strip_prefix('#') { + Some(comment) => redact_env_override(comment.trim_start()), + None => redact_config_line(line), + }) + .collect::>() + .join("\n") + } +} + impl std::fmt::Debug for ConfigDocument { fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { formatter @@ -215,31 +229,60 @@ fn parse_directives(input: &str, allow_bare_keys: bool) -> Result bool { - let key = key.trim().to_ascii_lowercase().replace(['-', '.'], "_"); +const SENSITIVE_FIELD_NAMES: &[&str] = &[ + "access_key", + "account_key", + "api_key", + "client_key", + "private_key", + "master_key", + "signing_key", + "encryption_key", + "session_key", + "connection_string", + "conn_string", + "dsn", + "authorization", + "auth_header", + "cookie", +]; + +fn has_sensitive_keyword(key: &str) -> bool { key.contains("secret") || key.contains("password") || key.contains("passphrase") || key.split('_').any(|part| part == "token") || key.split('_').any(|part| part == "credential") - || matches!( - key.as_str(), - "access_key" - | "account_key" - | "api_key" - | "client_key" - | "private_key" - | "master_key" - | "signing_key" - | "encryption_key" - | "session_key" - | "connection_string" - | "conn_string" - | "dsn" - | "authorization" - | "auth_header" - | "cookie" - ) +} + +fn is_sensitive_key(key: &str) -> bool { + let key = key.trim().to_ascii_lowercase().replace(['-', '.'], "_"); + has_sensitive_keyword(&key) || SENSITIVE_FIELD_NAMES.contains(&key.as_str()) +} + +fn redact_env_override(assignment: &str) -> Option { + let (name, value) = assignment.split_once('=')?; + let field = name.strip_prefix("RUSTFS_")?; + if field.is_empty() + || !field.bytes().all(|b| { + b.is_ascii_uppercase() || b.is_ascii_digit() || matches!(b, b'_' | b'-' | b'.') + }) + { + return None; + } + + // A sensitive field can sit between a subsystem prefix and a named target suffix. + let field = format!("_{}_", field.to_ascii_lowercase().replace(['-', '.'], "_")); + let sensitive = has_sensitive_keyword(&field) + || SENSITIVE_FIELD_NAMES + .iter() + .any(|key| field.contains(&format!("_{key}_"))); + let value = if sensitive && !value.is_empty() { + "*redacted*" + } else { + value + }; + Some(format!("# {name}={value}")) } fn redacted_value(key: &str, value: &str) -> String { @@ -465,6 +508,40 @@ mod tests { assert!(!redacted.contains("super-secret")); } + #[test] + fn config_get_preserves_only_env_assignments_and_redacts_named_target_secrets() { + let document = ConfigDocument { + content: concat!( + "# no assignment\n", + "# RUSTFS_SCANNER_SPEED\n", + "# RUSTFS_SCANNER_SPEED extra=discard\n", + "# OTHER_VARIABLE=discard\n", + "# RUSTFS_SCANNER_SPEED=slow\n", + "scanner speed=default\n", + "#RUSTFS_NOTIFY_WEBHOOK_COMMENT_PRIMARY= a=b \n", + "# RUSTFS_NOTIFY_WEBHOOK_TLS_CLIENT_KEY_PRIMARY=named-secret\n", + "# RUSTFS_NOTIFY_WEBHOOK_AUTH_TOKEN_PRIMARY=token-secret\n", + "notify_webhook:primary queue_limit=100", + ) + .into(), + }; + assert_eq!( + document.redacted_with_env_overrides(), + concat!( + "# RUSTFS_SCANNER_SPEED=slow\n", + "scanner speed=\"default\"\n", + "# RUSTFS_NOTIFY_WEBHOOK_COMMENT_PRIMARY= a=b \n", + "# RUSTFS_NOTIFY_WEBHOOK_TLS_CLIENT_KEY_PRIMARY=*redacted*\n", + "# RUSTFS_NOTIFY_WEBHOOK_AUTH_TOKEN_PRIMARY=*redacted*\n", + "notify_webhook:primary queue_limit=\"100\"", + ) + ); + assert_eq!( + redact_config_document(&document.content), + "scanner speed=\"default\"\nnotify_webhook:primary queue_limit=\"100\"" + ); + } + #[test] fn redacts_connection_and_key_credentials_conservatively() { let redacted = redact_config_document(