Dispose all resources used in CmsSignature #115666
Merged
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
|
Tagging subscribers to this area: @dotnet/area-system-security, @bartonjs, @vcsjones |
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the handling of signing keys in CmsSignature to ensure all disposable resources are consistently disposed. The changes include:
- Introducing a new helper method GetSigningKey to centralize key retrieval and disposal.
- Updating the implementations for RSA, DSA, ECDsa, and SlhDsa to use the new helper method.
- Minor renaming adjustments for clarity in key-related parameters.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| CmsSignature.cs | Added GetSigningKey helper to encapsulate key retrieval and disposal logic. |
| CmsSignature.SlhDsa.cs | Updated signing logic to use GetSigningKey for consistent disposal. |
| CmsSignature.RSA.cs | Refactored signing and verification for RSA to leverage GetSigningKey and ensure proper resource disposal. |
| CmsSignature.ECDsa.cs | Replaced direct disposal of keys with GetSigningKey and adjusted parameter naming. |
| CmsSignature.DSA.cs | Updated DSA signing to use GetSigningKey for improved resource management. |
.../System.Security.Cryptography.Pkcs/src/System/Security/Cryptography/Pkcs/CmsSignature.RSA.cs
Show resolved
Hide resolved
...ystem.Security.Cryptography.Pkcs/src/System/Security/Cryptography/Pkcs/CmsSignature.ECDsa.cs
Show resolved
Hide resolved
.../System.Security.Cryptography.Pkcs/src/System/Security/Cryptography/Pkcs/CmsSignature.DSA.cs
Show resolved
Hide resolved
...ystem.Security.Cryptography.Pkcs/src/System/Security/Cryptography/Pkcs/CmsSignature.ECDsa.cs
Show resolved
Hide resolved
.../System.Security.Cryptography.Pkcs/src/System/Security/Cryptography/Pkcs/CmsSignature.RSA.cs
Outdated
Show resolved
Hide resolved
bartonjs
reviewed
May 16, 2025
...stem.Security.Cryptography.Pkcs/src/System/Security/Cryptography/Pkcs/CmsSignature.SlhDsa.cs
Show resolved
Hide resolved
stephentoub
reviewed
May 28, 2025
...ries/System.Security.Cryptography.Pkcs/src/System/Security/Cryptography/Pkcs/CmsSignature.cs
Outdated
Show resolved
Hide resolved
| certificate.GetDSAPublicKey(); | ||
|
|
||
| if (dsa == null) | ||
| using (GetSigningKey(key, certificate, silent, DSACertificateExtensions.GetDSAPublicKey, out DSA? dsa)) |
There was a problem hiding this comment.
Note: Using DSACertificateExtensions.GetDSAPublicKey is more succinct, but the main reason for changing to this is because I was getting errors due to dotnet/roslyn-analyzers#4282.
bartonjs
approved these changes
Jun 5, 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.
Dispose keys in CmsSignature more consistently.
Contributes to #115578