docs: Add untrusted data security warnings to System.Speech APIs #12149
+27
−1
Conversation
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
Add untrusted-data-instance-note to APIs that handle external XML/SRGS/SSML/audio files to warn developers about security risks when processing untrusted data. Changes: - SrgsDocument: Added class-level warning and warnings to constructors that accept file paths and XmlReader - Grammar: Added warnings to constructors that accept file paths and streams - PromptBuilder: Added warnings to AppendSsml(XmlReader) and AppendAudio(string) methods - GrammarBuilder: Added warnings to AppendRuleReference methods that accept file paths These APIs can load and parse external files which may contain corrupted or malicious content. The warnings direct developers to validate all inputs per OWASP guidelines.
github-actions
bot
added
the
needs-area-label
Author
|
@dotnet-policy-service agree company="Microsoft" |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds security warnings to System.Speech APIs that handle external data sources (XML, SRGS, SSML, and audio files) to alert developers about potential security risks when processing untrusted data.
Key changes:
- Added
untrusted-data-instance-noteinclude directives to constructors and methods that accept file paths, streams, or XmlReader objects - Applied warnings consistently across four XML documentation files covering speech recognition and synthesis APIs
- Class-level and method-level warnings added to ensure comprehensive security guidance
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| xml/System.Speech.Synthesis/PromptBuilder.xml | Added security warnings to AppendAudio(string) and AppendSsml(XmlReader) methods |
| xml/System.Speech.Recognition/GrammarBuilder.xml | Added security warnings to both AppendRuleReference method overloads that accept file paths |
| xml/System.Speech.Recognition/Grammar.xml | Added security warnings to four constructors that accept file paths or streams |
| xml/System.Speech.Recognition.SrgsGrammar/SrgsDocument.xml | Added class-level security warning and warnings to constructors that accept file paths or XmlReader |
| <remarks> | ||
| <format type="text/markdown"><] |
There was a problem hiding this comment.
The include file reference should be untrusted-data-instance-note instead of untrusted-data-class-note to maintain consistency with the other warnings added in this PR. All other locations correctly use untrusted-data-instance-note.
Suggested change
| [!INCLUDE [untrusted-data-class-note](~/includes/untrusted-data-class-note.md)] | |
| [!INCLUDE [untrusted-data-instance-note](~/includes/untrusted-data-instance-note.md)] |
gewarren
approved these changes
Dec 16, 2025
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.
Add untrusted-data-instance-note to APIs that handle external XML/SRGS/SSML/audio files to warn developers about security risks when processing untrusted data.
Changes:
These APIs can load and parse external files which may contain corrupted or malicious content. The warnings direct developers to validate all inputs per OWASP guidelines.
Summary
Describe your changes here.
Fixes #Issue_Number (if available)