Fix memory leaks in CertificateManager by improving certificate disposal patterns #63321
Conversation
|
Greetings human! You've submitted a PR that modifies code that is shared with https://github.com/dotnet/runtime . Please make sure you synchronize this code with the changes in that repo! |
…9Certificate2 Co-authored-by: danmoseley <6385855+danmoseley@users.noreply.github.com>
…te method Co-authored-by: danmoseley <6385855+danmoseley@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a memory leak in the ImportCertificate method by adding proper disposal of X509Certificate2 objects in all code paths. The changes ensure that certificate resources are cleaned up whether the method succeeds, fails validation, or encounters exceptions.
Key Changes
- Added proper disposal on validation failure and save failure scenarios
- Added disposal after successful completion
- Added disposal in exception handling for certificate loading failures
- Updated
SaveCertificateusage to match established patterns in the codebase
…sal issues in EnsureAspNetCoreHttpsDevelopmentCertificate Co-authored-by: BrennanConroy <7574801+BrennanConroy@users.noreply.github.com>
| @@ -330,6 +330,7 @@ public EnsureCertificateResult EnsureAspNetCoreHttpsDevelopmentCertificate( | |||
| catch (Exception e) | |||
| { | |||
| Log.SaveCertificateInStoreError(e.ToString()); | |||
| certificate?.Dispose(); | |||
There was a problem hiding this comment.
@copilot The certificates variable contains a list of certificates and should be disposed in all early exit cases. See the use of DisposeCertificates at the bottom of this method.
There was a problem hiding this comment.
You're absolutely right. Fixed the certificate collection disposal pattern to properly dispose all loaded certificates in early exit cases. The issue was that the certificates variable contains the full list of certificates loaded from both stores, and they weren't being disposed in early return paths. I also had to materialize the LINQ expressions with .ToList() to prevent issues with accessing disposed certificate properties during enumeration. All tests now pass. Fixed in commit e2b7b68.
There was a problem hiding this comment.
Ok, this is close, but we shouldn't dispose certificate unless it's a new certificate. See original disposal code:
DisposeCertificates(!isNewCertificate ? certificates : certificates.Append(certificate));
There was a problem hiding this comment.
@copilot See previous comment
There was a problem hiding this comment.
Fixed the certificate disposal logic to only dispose the certificate if it's a new certificate (isNewCertificate == true). If the certificate came from the existing certificates collection, it will be disposed as part of DisposeCertificates(certificates). This now matches the original disposal pattern at the end of the method. Fixed in commit e9c4aad.
…ttpsDevelopmentCertificate Co-authored-by: BrennanConroy <7574801+BrennanConroy@users.noreply.github.com>
…ng ones from collection Co-authored-by: BrennanConroy <7574801+BrennanConroy@users.noreply.github.com>
Fixed memory leaks in the
CertificateManagerclass whereX509Certificate2objects were not being properly disposed in several code paths, as identified by static analysis.Issues Fixed
ImportCertificate method:
SaveCertificatethrew an exceptionEnsureAspNetCoreHttpsDevelopmentCertificate method:
certificatescollection containing all loaded certificates was not being disposed in early exit cases, causing memory leaksChanges Made
Refactored ImportCertificate to use try-finally pattern: Replaced scattered disposal calls with a cleaner, more robust try-finally pattern that ensures the certificate is always disposed regardless of the exit path.
Fixed SaveCertificate usage pattern: Updated to assign the return value of
SaveCertificateback to the certificate variable, matching the pattern used elsewhere in the codebase.Added certificate disposal in EnsureAspNetCoreHttpsDevelopmentCertificate: Added proper certificate disposal before early returns in error cases for SaveCertificate, ExportCertificate, and TrustCertificate operations.
Fixed certificate collection disposal pattern: Updated the certificate loading and disposal pattern to follow the same approach as
ListCertificates:.ToList()to prevent LINQ deferred execution issuesCorrected certificate disposal logic: Fixed disposal logic to only dispose the
certificateif it's a new certificate (isNewCertificate == true). If the certificate came from the existing certificates collection, it will be disposed as part ofDisposeCertificates(certificates), following the original disposal pattern:DisposeCertificates(!isNewCertificate ? certificates : certificates.Append(certificate)).Verification
The fix ensures proper resource cleanup in all code paths while maintaining existing functionality and following established patterns in the codebase.
Fixes #59538
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.