Skip to content

Remove .NET Framework remarks (System.Security.Cryptography)#12655

Merged
gewarren merged 7 commits into
dotnet:mainfrom
gewarren:fw-remarks-system-security-cryptography
May 29, 2026
Merged

Remove .NET Framework remarks (System.Security.Cryptography)#12655
gewarren merged 7 commits into
dotnet:mainfrom
gewarren:fw-remarks-system-security-cryptography

Conversation

@gewarren
Copy link
Copy Markdown
Contributor

@gewarren gewarren commented May 24, 2026

.NET Framework API ref has moved to its own repo (https://github.com/dotnet/dotnetfw-api-docs), so we can clean up .NET Framework remarks, exceptions, and code examples out of this repo. Contributes to #12513.

Removes remarks and examples related to:

  • .NET Framework versions
  • Code-access security
  • Configuring apps via app.config file
  • App domains

Also removes all remarks from obsolete APIs.

Hide whitespace changes

Copilot AI review requested due to automatic review settings May 24, 2026 03:01
@gewarren gewarren requested a review from a team as a code owner May 24, 2026 03:01
@github-actions github-actions Bot added the area-System.Security Issues related to security practices for .NET developers. label May 24, 2026
@dotnet-policy-service
Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/area-system-security, @vcsjones

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the .NET API reference XML docs in System.Security.Cryptography* to remove .NET Framework-specific remarks, exceptions, and usage notes now that .NET Framework API reference docs have moved to a separate repo.

Changes:

  • Removed or rewrote remarks that referenced .NET Framework-only features and behaviors (CAS, app.config, AppDomains, framework-version notes).
  • Normalized several exception descriptions to remove framework qualifiers (for example, “In all cases.”).
  • Cleaned up and reflowed various remarks blocks and IMPORTANT/NOTE callouts.

Reviewed changes

Copilot reviewed 41 out of 41 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
xml/System.Security.Cryptography/SymmetricAlgorithm.xml Rewords remarks to drop .NET Framework phrasing and adjusts Create() docs.
xml/System.Security.Cryptography/SHA256.xml Removes .NET Framework-specific return/exception details for Create overloads.
xml/System.Security.Cryptography/RSACryptoServiceProvider.xml Removes AppDomain/version-specific wording from UseMachineKeyStore remarks.
xml/System.Security.Cryptography/RSACng.xml Removes .NET Framework version-specific exception behavior from VerifyHash docs.
xml/System.Security.Cryptography/RSA.xml Removes .NET Framework version notes and normalizes exception text.
xml/System.Security.Cryptography/RijndaelManaged.xml Removes .NET Framework vs .NET Core block-size distinctions, simplifying to modern .NET behavior.
xml/System.Security.Cryptography/ProtectedData.xml Rewords Windows-only support notes and adds/updates PlatformNotSupportedException text.
xml/System.Security.Cryptography/Oid.xml Updates property summaries to reflect init-only narrative (but signatures still show settable).
xml/System.Security.Cryptography/KeyedHashAlgorithm.xml Removes .NET Framework versioning notes; normalizes PNSE text.
xml/System.Security.Cryptography/HMACSHA512.xml Removes legacy .NET Framework 2.0 SP notes and replaces with placeholder remarks.
xml/System.Security.Cryptography/HMACSHA384.xml Removes legacy .NET Framework 2.0 SP notes and replaces with placeholder remarks.
xml/System.Security.Cryptography/HMAC.xml Removes config-system mention and normalizes PNSE text.
xml/System.Security.Cryptography/HashAlgorithm.xml Removes obsoletion/version notes and normalizes PNSE text.
xml/System.Security.Cryptography/FromBase64Transform.xml Converts markdown remarks to XML paragraphs for CanTransformMultipleBlocks.
xml/System.Security.Cryptography/ECDsa.xml Rewords remarks/parameter guidance to remove .NET Framework mention.
xml/System.Security.Cryptography/ECDiffieHellmanPublicKey.xml Rewords PlatformNotSupportedException descriptions to remove framework qualifiers.
xml/System.Security.Cryptography/ECDiffieHellmanCngPublicKey.xml Normalizes whitespace and replaces some .NET Framework-specific remarks/exceptions.
xml/System.Security.Cryptography/ECDiffieHellmanCng.xml Removes argument/format exception documentation and normalizes PNSE text.
xml/System.Security.Cryptography/ECDiffieHellman.xml Rewords remarks to remove .NET Framework mention and reformats lists.
xml/System.Security.Cryptography/DSACryptoServiceProvider.xml Removes AppDomain/version-specific wording from UseMachineKeyStore remarks.
xml/System.Security.Cryptography/CryptoStream.xml Removes .NET Framework comparison from partial-read IMPORTANT notes and async remarks.
xml/System.Security.Cryptography/CryptoConfig.xml Removes .NET Framework config file references and partial-trust/CAS-related remarks.
xml/System.Security.Cryptography/CngProvider.xml Removes “service packs / .NET Framework releases” wording from remarks.
xml/System.Security.Cryptography/CngKeyBlobFormat.xml Removes “service packs / .NET Framework releases” wording from remarks.
xml/System.Security.Cryptography/CngAlgorithmGroup.xml Removes “service packs / .NET Framework releases” wording from remarks.
xml/System.Security.Cryptography/CngAlgorithm.xml Removes “service packs / .NET Framework releases” wording from remarks.
xml/System.Security.Cryptography/AsymmetricAlgorithm.xml Removes config-system mention and normalizes PNSE text.
xml/System.Security.Cryptography/AsnEncodedData.xml Rewords remarks to remove .NET Framework mention and trims extra whitespace.
xml/System.Security.Cryptography.Xml/SignedXml.xml Removes .NET Framework version-specific certificate-verification notes.
xml/System.Security.Cryptography.Xml/EncryptedXml.xml Rewords remarks to remove .NET Framework mention and trims redundant constructor remarks.
xml/System.Security.Cryptography.X509Certificates/X509Store.xml Removes .NET Framework version-based IDisposable guidance and replaces dispose remarks.
xml/System.Security.Cryptography.X509Certificates/X509ExtensionCollection.xml Rewords SyncRoot remarks to remove .NET Framework phrasing.
xml/System.Security.Cryptography.X509Certificates/X509Extension.xml Rewords list intro to remove .NET Framework mention and reformats list.
xml/System.Security.Cryptography.X509Certificates/X509ChainStatusFlags.xml Removes .NET Framework-introduced version note for certain flags.
xml/System.Security.Cryptography.X509Certificates/X509Chain.xml Removes .NET Framework version-based IDisposable guidance and replaces dispose remarks.
xml/System.Security.Cryptography.X509Certificates/X509Certificate2.xml Removes .NET Framework-only permission/version notes and normalizes PNSE text.
xml/System.Security.Cryptography.X509Certificates/X509Certificate.xml Removes .NET Framework version-based IDisposable guidance and replaces various remarks/exceptions.
xml/System.Security.Cryptography.Pkcs/SignerInfo.xml Removes CAS permission notes and normalizes countersignature remarks spacing.
xml/System.Security.Cryptography.Pkcs/SignedCms.xml Removes CAS permission notes; normalizes silent parameter doc and exception text.
xml/System.Security.Cryptography.Pkcs/EnvelopedCms.xml Removes .NET Framework vs .NET Core algorithm-default notes and CAS permission remarks.
xml/System.Security.Cryptography.Pkcs/CmsSigner.xml Removes .NET Framework-only support note and normalizes PNSE text.

Comment thread xml/System.Security.Cryptography/ProtectedData.xml Outdated
Comment thread xml/System.Security.Cryptography/Oid.xml Outdated
Comment thread xml/System.Security.Cryptography/Oid.xml Outdated
Comment thread xml/System.Security.Cryptography/ECDiffieHellman.xml Outdated
Comment thread xml/System.Security.Cryptography/CryptoStream.xml
Comment thread xml/System.Security.Cryptography/FromBase64Transform.xml Outdated
Comment thread xml/System.Security.Cryptography/SymmetricAlgorithm.xml
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
Comment thread xml/System.Security.Cryptography/HMAC.xml Outdated
Comment thread xml/System.Security.Cryptography/Oid.xml
Comment thread xml/System.Security.Cryptography/RijndaelManaged.xml Outdated
gewarren added 3 commits May 27, 2026 17:52
…gewarren/dotnet-api-docs into fw-remarks-system-security-cryptography
Clarified that the property is *init only* in .NET 5 and later versions.
Copy link
Copy Markdown
Member

@BillWagner BillWagner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM.

:shipit:

Comment thread xml/System.Security.Cryptography/AsymmetricAlgorithm.xml Outdated
Copy link
Copy Markdown
Member

@bartonjs bartonjs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than the potential followup to normalize returns statements for always-throw methods, LGTM.

@gewarren gewarren merged commit fbb6104 into dotnet:main May 29, 2026
6 checks passed
@gewarren gewarren deleted the fw-remarks-system-security-cryptography branch May 29, 2026 20:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-System.Security Issues related to security practices for .NET developers.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants