Add MemberGroup descriptions (System.Security)#12829
Draft
gewarren wants to merge 1 commit into
Draft
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates .NET API reference ECMAXML under the System.Security area by adding missing <MemberGroup> elements (with <summary> descriptions) for overloaded members, aligning with the effort tracked in dotnet-api-docs#12626.
Changes:
- Adds new
<MemberGroup>blocks (with summaries) for many overloaded methods/constructors across cryptography, PKCS, X.509, COSE, and claims APIs. - Fills previously empty
<MemberGroup><Docs />blocks in a few places (for example,CertificateRequest). - Improves overload-group discoverability and consistency in rendered reference docs by providing group-level summaries.
Reviewed changes
Copilot reviewed 113 out of 113 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| xml/System.Security.Permissions/KeyContainerPermissionAccessEntryCollection.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography/TripleDESCryptoServiceProvider.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography/SymmetricAlgorithm.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography/SP800108HmacCounterKdf.xml | Adds MemberGroup summaries for constructor and overload groups. |
| xml/System.Security.Cryptography/SlhDsaAlgorithm.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography/SlhDsa.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography/Shake256.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography/Shake128.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography/SHA512Managed.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography/SHA512.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography/SHA384Managed.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography/SHA384.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography/SHA3_512.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography/SHA3_384.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography/SHA3_256.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography/SHA256Managed.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography/SHA256.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography/SHA1Managed.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography/SHA1.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml | Adds MemberGroup summary for constructor overload group. |
| xml/System.Security.Cryptography/RSAOpenSsl.xml | Adds MemberGroup summaries for constructor and overload group. |
| xml/System.Security.Cryptography/RSACryptoServiceProvider.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography/RSACng.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography/RSA.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography/RNGCryptoServiceProvider.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography/RijndaelManaged.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography/Rfc2898DeriveBytes.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography/RandomNumberGenerator.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography/ProtectedData.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography/MLKemAlgorithm.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography/MLKem.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography/MLDsaAlgorithm.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography/MLDsa.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography/MD5.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography/KmacXof256.xml | Adds MemberGroup summaries for constructor and overload groups. |
| xml/System.Security.Cryptography/KmacXof128.xml | Adds MemberGroup summaries for constructor and overload groups. |
| xml/System.Security.Cryptography/Kmac256.xml | Adds MemberGroup summaries for constructor and overload groups. |
| xml/System.Security.Cryptography/Kmac128.xml | Adds MemberGroup summaries for constructor and overload groups. |
| xml/System.Security.Cryptography/IncrementalHash.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography/HMACSHA512.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography/HMACSHA384.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography/HMACSHA3_512.xml | Adds MemberGroup summaries for constructor and overload groups. |
| xml/System.Security.Cryptography/HMACSHA3_384.xml | Adds MemberGroup summaries for constructor and overload groups. |
| xml/System.Security.Cryptography/HMACSHA3_256.xml | Adds MemberGroup summaries for constructor and overload groups. |
| xml/System.Security.Cryptography/HMACSHA256.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography/HMACSHA1.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography/HMACMD5.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography/HMAC.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography/HKDF.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography/HashAlgorithm.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography/ECDsaOpenSsl.xml | Adds MemberGroup summaries for constructor and overload group. |
| xml/System.Security.Cryptography/ECDsaCng.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography/ECDsa.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography/ECDiffieHellmanPublicKey.xml | Adds MemberGroup summary for constructor overload group. |
| xml/System.Security.Cryptography/ECDiffieHellmanOpenSsl.xml | Adds MemberGroup summary for constructor overload group. |
| xml/System.Security.Cryptography/ECDiffieHellmanCng.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography/ECDiffieHellman.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography/ECAlgorithm.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography/DSAOpenSsl.xml | Adds MemberGroup summaries for constructor and overload group. |
| xml/System.Security.Cryptography/DSACryptoServiceProvider.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography/DSACng.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography/DSA.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography/DESCryptoServiceProvider.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography/CryptoStream.xml | Adds MemberGroup summaries for constructor and overload groups. |
| xml/System.Security.Cryptography/CryptographicOperations.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography/CompositeMLDsaAlgorithm.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography/CompositeMLDsa.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography/CngProperty.xml | Adds MemberGroup summary for constructor overload group. |
| xml/System.Security.Cryptography/ChaCha20Poly1305.xml | Adds MemberGroup summaries for constructor and overload groups. |
| xml/System.Security.Cryptography/AuthenticationTagMismatchException.xml | Adds MemberGroup summary for constructor overload group. |
| xml/System.Security.Cryptography/AsymmetricAlgorithm.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography/AsnEncodedDataCollection.xml | Adds MemberGroup summary for constructor overload group. |
| xml/System.Security.Cryptography/AesCcm.xml | Adds MemberGroup summaries for constructor and overload groups. |
| xml/System.Security.Cryptography/Aes.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography.Xml/CryptoSignedXmlRecursionException.xml | Adds MemberGroup summary for constructor overload group. |
| xml/System.Security.Cryptography.X509Certificates/X509SubjectAlternativeNameExtension.xml | Adds MemberGroup summary for constructor overload group. |
| xml/System.Security.Cryptography.X509Certificates/X509CertificateLoader.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography.X509Certificates/X509CertificateKeyAccessors.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography.X509Certificates/X509Certificate2Collection.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography.X509Certificates/X509Certificate2.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography.X509Certificates/X509Certificate.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography.X509Certificates/X509AuthorityKeyIdentifierExtension.xml | Adds MemberGroup summaries for constructor and overload groups. |
| xml/System.Security.Cryptography.X509Certificates/X509AuthorityInformationAccessExtension.xml | Adds MemberGroup summaries for constructor and overload groups. |
| xml/System.Security.Cryptography.X509Certificates/X500DistinguishedNameBuilder.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography.X509Certificates/PublicKey.xml | Adds MemberGroup summary for constructor overload group. |
| xml/System.Security.Cryptography.X509Certificates/Pkcs12LoaderLimits.xml | Adds MemberGroup summary for constructor overload group. |
| xml/System.Security.Cryptography.X509Certificates/CertificateRevocationListBuilder.xml | Adds MemberGroup summaries for multiple overload groups. |
| xml/System.Security.Cryptography.X509Certificates/CertificateRequest.xml | Replaces empty MemberGroup docs with summaries for overload groups. |
| xml/System.Security.Cryptography.Pkcs/SignedCms.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography.Pkcs/Rfc3161TimestampToken.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography.Pkcs/Rfc3161TimestampRequest.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography.Pkcs/Pkcs9LocalKeyId.xml | Adds MemberGroup summary for constructor overload group. |
| xml/System.Security.Cryptography.Pkcs/Pkcs9DocumentDescription.xml | Adds MemberGroup summary for constructor overload group. |
| xml/System.Security.Cryptography.Pkcs/Pkcs8PrivateKeyInfo.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography.Pkcs/Pkcs12SafeContents.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography.Pkcs/Pkcs12Builder.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography.Pkcs/EnvelopedCms.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography.Pkcs/ContentInfo.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Cryptography.Pkcs/AlgorithmIdentifier.xml | Adds MemberGroup summary for constructor overload group. |
| xml/System.Security.Cryptography.Cose/CoseSigner.xml | Adds MemberGroup summary for constructor overload group. |
| xml/System.Security.Cryptography.Cose/CoseSignature.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography.Cose/CoseSign1Message.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography.Cose/CoseMultiSignMessage.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography.Cose/CoseMessage.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography.Cose/CoseKey.xml | Adds MemberGroup summary for constructor overload group. |
| xml/System.Security.Cryptography.Cose/CoseHeaderValue.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography.Cose/CoseHeaderMap.xml | Adds MemberGroup summaries for overload groups. |
| xml/System.Security.Cryptography.Cose/CoseHeaderLabel.xml | Adds MemberGroup summaries for constructor and overload groups. |
| xml/System.Security.Claims/ClaimsPrincipal.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Claims/ClaimsIdentity.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Claims/Claim.xml | Adds MemberGroup summary for an overload group. |
| xml/System.Security.Authentication.ExtendedProtection/ChannelBinding.xml | Adds MemberGroup summary for constructor overload group. |
| </Member> | ||
| <MemberGroup MemberName="AddSafeContentsEncrypted"> | ||
| <Docs> | ||
| <summary>Add contents to the PFX in an bundle encrypted with a byte-based password from a span.</summary> |
Comment on lines
+560
to
+562
| <summary>Opens the specified file, reads the contents as a PKCS#12 PFX and extracts a certificate. | ||
| Loads the provided data as a PKCS#12 PFX and returns a collection of | ||
| all of the certificates therein.</summary> |
| </Member> | ||
| <MemberGroup MemberName="TryExportEncryptedPkcs8PrivateKey"> | ||
| <Docs> | ||
| <summary>When overriden in a derived class, attempts to export the current key in the PKCS#8 EncryptedPrivateKeyInfo format into a provided buffer, using a char-based password.</summary> |
| </Member> | ||
| <MemberGroup MemberName="TryExportEncryptedPkcs8PrivateKeyPem"> | ||
| <Docs> | ||
| <summary>Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a char-based password, PEM encoded.</summary> |
| </Member> | ||
| <MemberGroup MemberName="ExportEncryptedPkcs8PrivateKeyPem"> | ||
| <Docs> | ||
| <summary>Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a byte-based password, PEM encoded.</summary> |
Comment on lines
+257
to
+258
| <summary>Performs the HKDF-Extract function. | ||
| See section 2.2 of <a href="https://tools.ietf.org/html/rfc5869#section-2.2">RFC5869</a>.</summary> |
| </Member> | ||
| <MemberGroup MemberName="AppendData"> | ||
| <Docs> | ||
| <summary>Append the entire contents of <paramref name="data" /> to the data already processed in the hash or HMAC.</summary> |
| </Member> | ||
| <MemberGroup MemberName="CreateHMAC"> | ||
| <Docs> | ||
| <summary>Create an <see cref="T:System.Security.Cryptography.IncrementalHash" /> for the Hash-based Message Authentication Code (HMAC) algorithm utilizing the hash algorithm specified by <paramref name="hashAlgorithm" />, and a key specified by <paramref name="key" />.</summary> |
Comment on lines
+667
to
+669
| <summary>Retrieve the hash or HMAC for the data accumulated from prior calls to | ||
| <see cref="M:System.Security.Cryptography.IncrementalHash.AppendData(System.Byte[])" />, and return to the state the object | ||
| was in at construction.</summary> |
| </Member> | ||
| <MemberGroup MemberName="CreateFromHash"> | ||
| <Docs> | ||
| <summary>Create a timestamp request using a pre-computed hash value and the name of the hash algorithm.</summary> |
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
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.
Contributes to #12626.