Skip to content

armgit / codex

Public Imported from GitHub
0

Lightweight coding agent that runs in your terminal

Rust

Preserve missing environment variable diagnostics in Codex Doctor (#44654)

Eric Traut5c94936b56ef
diff --git a/codex-rs/cli/src/doctor/output.rs b/codex-rs/cli/src/doctor/output.rs
index c4c0087259..bef6dc7772 100644
--- a/codex-rs/cli/src/doctor/output.rs
+++ b/codex-rs/cli/src/doctor/output.rs
@@ -845,6 +845,29 @@ fn highlight_flags(text: &str, options: HumanOutputOptions) -> String {
}
pub(super) fn redact_detail(detail: &str) -> String {
+ // Preserve the authored diagnosis, but do not trust configured names to be
+ // non-secret: users sometimes paste credentials into env-var name fields.
+ if let Some((server, value)) = detail.split_once(": ") {
+ for prefix in ["env var ", "bearer token env var ", "header env var "] {
+ if let Some(variable) = value
+ .strip_prefix(prefix)
+ .and_then(|value| value.strip_suffix(" is not set"))
+ {
+ let server = redact_urls(redact_identifier(server));
+ let variable = if variable
+ .starts_with(|c: char| c.is_ascii_alphabetic() || c == '_')
+ && variable
+ .bytes()
+ .all(|b| b.is_ascii_alphanumeric() || b == b'_')
+ {
+ redact_identifier(variable)
+ } else {
+ "<redacted>"
+ };
+ return format!("{server}: {prefix}{variable} is not set");
+ }
+ }
+ }
let lower = detail.to_ascii_lowercase();
let label = lower.split(':').next().unwrap_or_default();
if label.contains("env var") {
@@ -874,6 +897,39 @@ pub(super) fn redact_detail(detail: &str) -> String {
}
}
+fn redact_identifier(identifier: &str) -> &str {
+ let credential_prefix = [
+ "sk-",
+ "sk_",
+ "ghp_",
+ "gho_",
+ "ghu_",
+ "ghs_",
+ "ghr_",
+ "github_pat_",
+ "xoxb-",
+ "xoxp-",
+ ]
+ .iter()
+ .any(|prefix| identifier.starts_with(prefix));
+ let aws_access_key = identifier.len() == 20
+ && (identifier.starts_with("AKIA") || identifier.starts_with("ASIA"))
+ && identifier
+ .bytes()
+ .all(|b| b.is_ascii_uppercase() || b.is_ascii_digit());
+ if !identifier.is_empty()
+ && !credential_prefix
+ && !aws_access_key
+ && identifier.bytes().all(|b| {
+ b.is_ascii_alphanumeric() || matches!(b, b'_' | b'-' | b'.' | b':' | b'@' | b'/')
+ })
+ {
+ identifier
+ } else {
+ "<redacted>"
+ }
+}
+
fn is_safe_presence_value(value: &str) -> bool {
matches!(
value.trim().to_ascii_lowercase().as_str(),
@@ -1752,6 +1808,73 @@ Run codex doctor without --summary for detailed diagnostics.
);
}
+ #[test]
+ fn redact_detail_preserves_missing_env_diagnostics() {
+ for prefix in ["env var", "bearer token env var", "header env var"] {
+ for (variable, expected) in [
+ ("DOCS_TOKEN", "DOCS_TOKEN"),
+ ("docs_token", "docs_token"),
+ ("", "<redacted>"),
+ ("TOKEN: SYNTHETIC_CREDENTIAL", "<redacted>"),
+ ("sk-proj-SYNTHETIC_CREDENTIAL", "<redacted>"),
+ ("ghp_SYNTHETIC_CREDENTIAL", "<redacted>"),
+ ("github_pat_SYNTHETIC_CREDENTIAL", "<redacted>"),
+ ("AKIAABCDEFGHIJKLMNOP", "<redacted>"),
+ ("ASIAABCDEFGHIJKLMNOP", "<redacted>"),
+ ("eyJhbGciOiJIUzI1NiJ9.synthetic.signature", "<redacted>"),
+ ] {
+ assert_eq!(
+ redact_detail(&format!("demo-server: {prefix} {variable} is not set")),
+ format!("demo-server: {prefix} {expected} is not set")
+ );
+ }
+ }
+ assert_eq!(
+ redact_detail(
+ "demo: command not found (helper --token SYNTHETIC_CREDENTIAL is not set)"
+ ),
+ "demo: <redacted>"
+ );
+ assert_eq!(
+ redact_detail("ghp_SYNTHETIC_CREDENTIAL: env var DOCS_TOKEN is not set"),
+ "<redacted>: env var DOCS_TOKEN is not set"
+ );
+ assert_eq!(
+ redact_detail("https://user:[email protected]: env var DOCS_TOKEN is not set"),
+ "https://example.com: env var DOCS_TOKEN is not set"
+ );
+ }
+
+ #[test]
+ fn missing_env_diagnostics_in_json_and_text() {
+ let check = DoctorCheck::new("mcp.config", "mcp", CheckStatus::Warning, "missing inputs")
+ .detail("demo: bearer token env var DOCS_TOKEN is not set")
+ .detail("DEMO: header env var DOCS_SECRET is not set")
+ .detail("stdio: env var DOCS_TOKEN is not set")
+ .detail("npm:@modelcontextprotocol/server-sequential.thinking: env var DOCS_TOKEN is not set")
+ .detail("typo: bearer token env var sk-proj-SYNTHETIC_CREDENTIAL is not set");
+ let json = serde_json::to_value(super::super::redacted_json_check(&check)).unwrap();
+ assert_eq!(
+ json["details"],
+ serde_json::json!({
+ "demo": "bearer token env var DOCS_TOKEN is not set",
+ "DEMO": "header env var DOCS_SECRET is not set",
+ "stdio": "env var DOCS_TOKEN is not set",
+ "npm:@modelcontextprotocol/server-sequential.thinking": "env var DOCS_TOKEN is not set",
+ "typo": "bearer token env var <redacted> is not set",
+ })
+ );
+ let report = DoctorReport {
+ overall_status: CheckStatus::Warning,
+ checks: vec![check],
+ ..sample_report()
+ };
+ insta::assert_snapshot!(
+ "missing_env_diagnostics",
+ render_human_report(&report, detailed_all_no_color_unicode_options())
+ );
+ }
+
#[test]
fn redact_detail_preserves_secret_presence_booleans() {
assert_eq!(
diff --git a/codex-rs/cli/src/doctor/snapshots/codex__doctor__output__tests__missing_env_diagnostics.snap b/codex-rs/cli/src/doctor/snapshots/codex__doctor__output__tests__missing_env_diagnostics.snap
new file mode 100644
index 0000000000..6077a182c1
--- /dev/null
+++ b/codex-rs/cli/src/doctor/snapshots/codex__doctor__output__tests__missing_env_diagnostics.snap
@@ -0,0 +1,23 @@
+---
+source: cli/src/doctor/output.rs
+expression: "render_human_report(&report, detailed_all_no_color_unicode_options())"
+---
+Codex Doctor v0.0.0
+
+Notes
+ ⚠ mcp missing inputs
+─────────────────────────────────────────────────────────────
+
+Configuration
+ ⚠ mcp missing inputs
+ demo bearer token env var DOCS_TOKEN is not set
+ DEMO header env var DOCS_SECRET is not set
+ stdio env var DOCS_TOKEN is not set
+ npm:@modelcontextprotocol/server-sequential.thinking env var DOCS_TOKEN is not set
+ typo bearer token env var <redacted> is not set
+
+─────────────────────────────────────────────────────────────
+0 ok · 1 notes · 1 warn · 0 fail degraded
+
+--summary compact output --all expand truncated lists
+--json redacted report