Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Sep 5, 2025

This PR adds documentation for a breaking change in .NET 10 RC 1 where MLDsa and SlhDsa Post-Quantum Cryptography classes renamed their members from using "SecretKey" to using "PrivateKey".

Changes Made

  • New Documentation: Created docs/core/compatibility/cryptography/10.0/mldsa-slhdsa-secretkey-to-privatekey.md with comprehensive breaking change documentation
  • Navigation Updates: Added entries to both the table of contents (toc.yml) and the .NET 10 breaking changes index (10.0.md)

Breaking Change Details

This source-incompatible breaking change affects 6 APIs across the MLDsa and SlhDsa classes:

  • MLDsa.ImportMLDsaSecretKeyImportMLDsaPrivateKey
  • MLDsa.ExportMLDsaSecretKeyExportMLDsaPrivateKey
  • MLDsaAlgorithm.SecretKeySizeInBytesPrivateKeySizeInBytes
  • SlhDsa.ImportSlhDsaSecretKeyImportSlhDsaPrivateKey
  • SlhDsa.ExportSlhDsaSecretKeyExportSlhDsaPrivateKey
  • SlhDsaAlgorithm.SecretKeySizeInBytesPrivateKeySizeInBytes

The documentation includes:

  • Clear before/after code examples
  • Migration guidance with diff-style examples
  • Proper categorization as a source-incompatible change
  • Complete list of affected APIs with cross-references

The change was made to align these experimental PQC algorithms with existing asymmetric cryptography naming conventions in .NET.

Fixes #47691.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.


Internal previews

📄 File 🔗 Preview link
docs/core/compatibility/10.0.md Breaking changes in .NET 10
docs/core/compatibility/cryptography/10.0/mldsa-slhdsa-secretkey-to-privatekey.md MLDsa and SlhDsa 'SecretKey' members renamed
docs/core/compatibility/toc.yml docs/core/compatibility/toc

@Copilot Copilot AI changed the title [WIP] [Breaking change]: MLDsa and SlhDsa members renamed from using "SecretKey" to using "PrivateKey" Add breaking change documentation for MLDsa and SlhDsa SecretKey to PrivateKey rename Sep 5, 2025
@Copilot Copilot AI requested a review from gewarren September 5, 2025 16:37
Copilot finished work on behalf of gewarren September 5, 2025 16:37
@gewarren gewarren marked this pull request as ready for review September 6, 2025 02:35
@gewarren gewarren requested a review from a team as a code owner September 6, 2025 02:35
@gewarren gewarren requested a review from bartonjs September 6, 2025 02:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Breaking change]: MLDsa and SlhDsa members renamed from using "SecretKey" to using "PrivateKey"
2 participants