fix(macos): mask sensitive wizard cli prompts by sallyom · Pull Request #76746 · openclaw/openclaw

sallyom · 2026-05-03T14:53:46Z

Summary

Honor WizardStep.sensitive in the bundled openclaw-mac wizard text prompt path.
Use termios to disable terminal echo for sensitive input instead of getpass(3), so long credentials are not truncated.
Suppress saved credential previews for sensitive prompts while preserving blank-to-keep-existing behavior.

Fixes #76698.

Validation

swift build --package-path apps/macos --product OpenClaw --configuration release ✅
swift build --package-path apps/macos --product openclaw-mac --configuration release ✅
PTY proof with fake wizard gateway: 190-char sensitive input accepted, answer matched exactly, terminal log contained neither submitted token nor saved initial value ✅
git diff --check ✅
swiftformat --lint apps/macos/Sources --config .swiftformat blocked locally: swiftformat: command not found
swiftlint --config .swiftlint.yml blocked locally: swiftlint: command not found

Notes

This is the focused macOS CLI follow-up to #76693.

clawsweeper · 2026-05-03T14:54:51Z

Codex review: needs maintainer review before merge.

Summary
The PR updates openclaw-mac wizard to honor sensitive text steps with termios no-echo input, hides existing credential previews, preserves blank-to-keep-existing behavior, and adds a changelog entry.

Reproducibility: yes. Source inspection gives a high-confidence reproduction path: send a sensitive wizard text step to openclaw-mac wizard on current main, and the text branch uses echoing readLineWithPrompt plus [initial] display.

Next step before merge
This is an active implementation PR with a protected maintainer label and no narrow automated repair finding; the next step is maintainer review plus normal macOS CI/validation.

Security
Cleared: The diff reduces credential exposure and does not add dependencies, permissions, network calls, artifact downloads, or package-resolution changes.

Review details

Best possible solution:

Land a focused macOS CLI fix that honors the existing WizardStep.sensitive contract without changing storage, transport, or broader onboarding behavior.

Do we have a high-confidence way to reproduce the issue?

Yes. Source inspection gives a high-confidence reproduction path: send a sensitive wizard text step to openclaw-mac wizard on current main, and the text branch uses echoing readLineWithPrompt plus [initial] display.

Is this the best way to solve the issue?

Yes. The proposed termios no-echo branch is the narrow owner-side fix for the macOS CLI client, avoids getpass(3) truncation, and preserves blank-to-keep-existing behavior.

What I checked:

Current main leak path: The macOS CLI text step reads with readLineWithPrompt and prints the initial value in brackets without checking step.sensitive, so sensitive wizard input and saved values are visible in the terminal path. (apps/macos/Sources/OpenClawMacCLI/WizardCommand.swift:445, 935f078a89f0)
Sensitive contract exists: The shared Swift protocol model decodes WizardStep.sensitive, so no protocol expansion is needed for this client to honor the flag. (apps/shared/OpenClawKit/Sources/OpenClawProtocol/GatewayModels.swift:2402, 935f078a89f0)
Adjacent macOS UI behavior: The SwiftUI onboarding wizard already switches sensitive text steps to SecureField, confirming the expected macOS-side rendering behavior. (apps/macos/Sources/OpenClaw/OnboardingWizard.swift:303, 935f078a89f0)
Node-side contract implementation: Merged PR fix(onboarding): mask token/credential inputs in CLI wizard prompts #76693 added the sensitive flag plumbing and masks sensitive Clack prompts with password(), leaving this PR as the focused macOS CLI follow-up. (src/wizard/clack-prompter.ts:122, 727398f41a85)
PR patch matches the gap: The supplied PR diff branches on step.sensitive == true, uses termios to disable echo, suppresses [initial] display, and keeps the previous value on blank sensitive input. (apps/macos/Sources/OpenClawMacCLI/WizardCommand.swift:445, 8a63773e22b8)
Protected handling required: The provided GitHub context shows the PR has the maintainer label, so ClawSweeper cleanup should not close it automatically.

Likely related people:

steipete: git show and git blame show the current WizardCommand.swift path and echoing text prompt branch came from commit 399d7f6. (role: introduced current macOS CLI wizard path; confidence: medium; commits: 399d7f61783f; files: apps/macos/Sources/OpenClawMacCLI/WizardCommand.swift)
anurag-bg-neu: Merged PR fix(onboarding): mask token/credential inputs in CLI wizard prompts #76693, commit 727398f, added sensitive support to the Node wizard contract and explicitly documented this macOS CLI follow-up. (role: recent sensitive wizard contract contributor; confidence: high; commits: 727398f41a85; files: src/wizard/session.ts, src/wizard/clack-prompter.ts, src/wizard/session.test.ts)

Remaining risk / open question:

The PR diff does not add an automated Swift CLI regression test for no-echo input or >128-character sensitive values, so that behavior still depends on the claimed PTY proof and normal macOS validation.

Codex review notes: model gpt-5.5, reasoning high; reviewed against 935f078a89f0.

@sallyom