strip control characters from guest cloud-init log lines - #5426
Open
Nashit-h wants to merge 2 commits into
Open
Conversation
Signed-off-by: nashit hayyat <nashit@bugqore.com>
AkihiroSuda
reviewed
Aug 21, 2026
|
|
||
| // removeControlChars drops non-printable runes so guest-controlled text is safe | ||
| // to print to the operator's terminal. | ||
| func removeControlChars(s string) string { |
Member
There was a problem hiding this comment.
Contributor
Author
There was a problem hiding this comment.
Good point. Moved it to strutil.RemoveControlChars and switched both cidata and the hostagent path over to it.
Signed-off-by: nashit hayyat <nashit@bugqore.com>
Member
|
Please squash the commits |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What This PR Changes
The hostagent reads cloud-init log lines from the guest over SSH and forwards them in
CloudInitProgressevents, whichlimactl startandlimactl watchprint to the operator's terminal with a bare%s. A guest controls those bytes (anything in/var/log/cloud-init-output.logor the cloud-init journald output), so it can emit ANSI/OSC escape sequences and spoof or rewrite the terminal during the default start progress display. This strips non-printable runes at the single emit choke point (emitCloudInitProgressEvent) so every consumer is safe, matching theremoveControlCharshandling already used for other guest-controlled strings and the%#qquoting used for the sibling guest-error path.Linked Issue (Required in most cases)
Small self-contained security fix; no separate tracking issue.
How I Tested This
Added a regression test that runs an escape sequence through
emitCloudInitProgressEventand asserts the emittedLogLinehas no control characters. It fails on the current code (the\x1bsurvives) and passes with this change.go test ./pkg/hostagent/...and the repo-pinnedgolangci-lint run ./pkg/hostagent/are green.AI Usage