Add security warning to ArrayPool.Return documentation #12062
Merged
+3
−0
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
Co-authored-by: jkotas <[email protected]>
jkotas
reviewed
Nov 20, 2025
Copilot
AI
changed the title
[WIP] Add security note to ArrayPool.Rent documentation
Add security warning to ArrayPool.Return documentation
Nov 20, 2025
Copilot finished work on behalf of
jkotas
November 20, 2025 17:29
Copilot finished reviewing on behalf of
jkotas
November 20, 2025 17:34
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds a critical security warning to the ArrayPool<T>.Return method documentation, alerting developers to the severe consequences of misusing the API.
- Adds an IMPORTANT callout documenting double-free and use-after-free vulnerabilities
- Includes links to CWE definitions (CWE-415 and CWE-416) for reference
- Warns about potential consequences: data corruption, data leaks, and denial of service
stephentoub
approved these changes
Nov 20, 2025
Co-authored-by: jkotas <[email protected]>
Copilot finished work on behalf of
jkotas
November 20, 2025 17:41
gewarren
approved these changes
Nov 20, 2025
richlander
approved these changes
Nov 20, 2025
Member
|
Tanner is correct in that CWE-415 / 416 are very C-oriented. If there is a security incident resulting from misuse of ArrayPool, the culprit is most likely to be CWE-672 (root cause) and CWE-488 (proximate cause). If you were going for technical accuracy, I'd choose these over 415 / 416. I imagine this doc is going for a friendly analogy more than technical accuracy. In that light, "double free" and "use after free" seem fine since they're well understood concepts and they adequately enough describe the general shape of the problem. |
GrabYourPitchforks
approved these changes
Nov 20, 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.
Summary
Adds an IMPORTANT note to
ArrayPool<T>.Returndocumenting that returning the same array twice or using it after return causes high-severity security vulnerabilities.The note warns about:
Both can lead to data corruption, data leaks, and denial of service. Links to CWE definitions are included for reference.
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.