starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-03 21:25:34 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

[PR #10847] [MERGED] Sanitize C1 control chars in SetConsoleTitle API #28258

New Issue
Open
opened 2026-01-31 09:27:21 +00:00 by claunia · 0 comments
claunia commented 2026-01-31 09:27:21 +00:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/microsoft/terminal/pull/10847
Author: @j4james
Created: 8/1/2021
Status: ✅ Merged
Merged: 8/2/2021
Merged by: @undefined

Base: main ← Head: fix-title-control-chars

📝 Commits (5)

  • f3f9221 Sanitize C1 control chars in SetConsoleTitle.
  • bae851f Add a unit test checking that control chars are stripped.
  • 1cdb251 Correct spelling in comments.
  • a148106 Make the title sanitization more efficient.
  • 74f3449 And fix the formatting to keep the bot happy.

📊 Changes

2 files changed (+40 additions, -9 deletions)

View changed files

📝 src/host/getset.cpp (+5 -9)
📝 src/host/ut_host/ConptyOutputTests.cpp (+35 -0)

📄 Description

When the SetContoleTitle API is called with a title containing control
characters, we need to filter out those characters before we can forward
the title change over conpty as an escape sequence. If we don't do that,
the receiving terminal will end up executing the control characters
instead of updating the title. We were already filtering out the C0
control characters, but with this PR we're now filtering out C1 controls
characters as well.

I've simply updated the sanitizing routine in DoSrvSetConsoleTitleW to
filter our characters in the range 0x80 to 0x9F. This is in addition
to the C0 range (0x00 to 0x1F) that was already excluded.

Validation Steps Performed

I've added a conpty unit test that calls DoSrvSetConsoleTitleW with
titles containing a variety of C0 and C1 controls characters, and which
verifies that those characters are stripped from the title forwarded to
conpty.

I've also confirmed that the test case in issue #10312 is now working
correctly in Windows Terminal.

Closes #10312

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/microsoft/terminal/pull/10847 **Author:** [@j4james](https://github.com/j4james) **Created:** 8/1/2021 **Status:** ✅ Merged **Merged:** 8/2/2021 **Merged by:** [@undefined](undefined) **Base:** `main` ← **Head:** `fix-title-control-chars` --- ### 📝 Commits (5) - [`f3f9221`](https://github.com/microsoft/terminal/commit/f3f9221a20313e2658001083f1a40307be54dde3) Sanitize C1 control chars in SetConsoleTitle. - [`bae851f`](https://github.com/microsoft/terminal/commit/bae851f42b7a53907b55f2c0308233db63e8a281) Add a unit test checking that control chars are stripped. - [`1cdb251`](https://github.com/microsoft/terminal/commit/1cdb251d2eac2bd975876297dc868d69e7b08441) Correct spelling in comments. - [`a148106`](https://github.com/microsoft/terminal/commit/a1481063b8744f90bb8f90a043aa168aec49be20) Make the title sanitization more efficient. - [`74f3449`](https://github.com/microsoft/terminal/commit/74f3449bf3f9f8a3bcad8ce7fe1efa938da4fe69) And fix the formatting to keep the bot happy. ### 📊 Changes **2 files changed** (+40 additions, -9 deletions) <details> <summary>View changed files</summary> 📝 `src/host/getset.cpp` (+5 -9) 📝 `src/host/ut_host/ConptyOutputTests.cpp` (+35 -0) </details> ### 📄 Description When the `SetContoleTitle` API is called with a title containing control characters, we need to filter out those characters before we can forward the title change over conpty as an escape sequence. If we don't do that, the receiving terminal will end up executing the control characters instead of updating the title. We were already filtering out the C0 control characters, but with this PR we're now filtering out C1 controls characters as well. I've simply updated the sanitizing routine in `DoSrvSetConsoleTitleW` to filter our characters in the range `0x80` to `0x9F`. This is in addition to the C0 range (`0x00` to `0x1F`) that was already excluded. ## Validation Steps Performed I've added a conpty unit test that calls `DoSrvSetConsoleTitleW` with titles containing a variety of C0 and C1 controls characters, and which verifies that those characters are stripped from the title forwarded to conpty. I've also confirmed that the test case in issue #10312 is now working correctly in Windows Terminal. Closes #10312 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
claunia added the pull-request label 2026-01-31 09:27:21 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#28258
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?