Skip to content

Port System.Security new docs #10156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 26, 2024
Merged

Port System.Security new docs #10156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4152e73
System.Security.Cryptography
carlossanlop Jul 25, 2024
d01e131
System.Security.Cryptography.X509Certificates
carlossanlop Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions xml/System.Security.Cryptography.X509Certificates/X509SubjectKeyIdentifierHashAlgorithm.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The SHA-256 hash over the SubjectPublicKeyInfo as described in RFC 7093.</summary>
</Docs>
</Member>
<Member MemberName="Sha384">
Expand All @@ -195,7 +195,7 @@
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The SHA-384 hash over the SubjectPublicKeyInfo as described in RFC 7093.</summary>
</Docs>
</Member>
<Member MemberName="Sha512">
Expand All @@ -221,7 +221,7 @@
</ReturnValue>
<MemberValue>5</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The SHA-512 hash over the SubjectPublicKeyInfo as described in RFC 7093.</summary>
</Docs>
</Member>
<Member MemberName="ShortSha1">
Expand Down Expand Up @@ -290,7 +290,7 @@
</ReturnValue>
<MemberValue>6</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The SHA-256 hash over the subjectPublicKey truncated to the leftmost 160-bits as described in RFC 7093.</summary>
</Docs>
</Member>
<Member MemberName="ShortSha384">
Expand All @@ -316,7 +316,7 @@
</ReturnValue>
<MemberValue>7</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The SHA-384 hash over the subjectPublicKey truncated to the leftmost 160-bits as described in RFC 7093.</summary>
</Docs>
</Member>
<Member MemberName="ShortSha512">
Expand All @@ -342,7 +342,7 @@
</ReturnValue>
<MemberValue>8</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The SHA-512 hash over the subjectPublicKey truncated to the leftmost 160-bits as described in RFC 7093.</summary>
</Docs>
</Member>
</Members>
Expand Down
506 changes: 409 additions & 97 deletions xml/System.Security.Cryptography/CryptographicOperations.xml
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 4 additions & 2 deletions xml/System.Security.Cryptography/IncrementalHash.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,9 +307,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Creates a new instance of <see cref="T:System.Security.Cryptography.IncrementalHash" /> with the existing appended data preserved.</summary>
<returns>A clone of the current instance.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Security.Cryptography.CryptographicException">An error has occurred during the operation.</exception>
<exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception>
</Docs>
</Member>
<Member MemberName="CreateHash">
Expand Down
269 changes: 187 additions & 82 deletions xml/System.Security.Cryptography/Kmac128.xml
View file
Open in desktop

Large diffs are not rendered by default.

269 changes: 187 additions & 82 deletions xml/System.Security.Cryptography/Kmac256.xml
View file
Open in desktop

Large diffs are not rendered by default.

269 changes: 187 additions & 82 deletions xml/System.Security.Cryptography/KmacXof128.xml
View file
Open in desktop

Large diffs are not rendered by default.

269 changes: 187 additions & 82 deletions xml/System.Security.Cryptography/KmacXof256.xml
View file
Open in desktop

Large diffs are not rendered by default.

51 changes: 33 additions & 18 deletions xml/System.Security.Cryptography/Shake128.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Shake128" /> class.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
to determine if the platform supports SHAKE128.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -126,9 +126,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Creates a new instance of <see cref="T:System.Security.Cryptography.Shake128" /> with the existing appended data preserved.</summary>
<returns>A clone of the current instance.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Security.Cryptography.CryptographicException">An error has occurred during the operation.</exception>
<exception cref="T:System.InvalidOperationException">The current instance is being read from and cannot be cloned.</exception>
<exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception>
</Docs>
</Member>
<Member MemberName="Dispose">
Expand Down Expand Up @@ -314,7 +317,7 @@
<paramref name="outputLength" /> is negative.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="source" /> is <see langword="null" />.</exception>
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
to determine if the platform supports SHAKE128.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -356,7 +359,7 @@
<paramref name="outputLength" /> is negative.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="source" /> is <see langword="null" />.</exception>
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
to determine if the platform supports SHAKE128.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -396,7 +399,7 @@
<paramref name="source" /> does not support reading.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="source" /> is <see langword="null" />.</exception>
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
to determine if the platform supports SHAKE128.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -434,7 +437,7 @@
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="outputLength" /> is negative.</exception>
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
to determine if the platform supports SHAKE128.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -463,7 +466,7 @@
<param name="destination">The buffer to fill with the hash.</param>
<summary>Computes the hash of data using the SHAKE128 algorithm.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
to determine if the platform supports SHAKE128.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -502,7 +505,7 @@
<Docs>
<param name="source">The stream to hash.</param>
<param name="outputLength">The size of the hash to produce.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.
<param name="cancellationToken">The token to monitor for cancellation requests.
The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<summary>Asynchronously computes the hash of a stream using the SHAKE128 algorithm.</summary>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> that completes with the computed hash.</returns>
Expand All @@ -515,7 +518,7 @@
<paramref name="source" /> is <see langword="null" />.</exception>
<exception cref="T:System.OperationCanceledException">
<paramref name="cancellationToken" /> has been canceled.</exception>
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
to determine if the platform supports SHAKE128.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -549,7 +552,7 @@
<Docs>
<param name="source">The stream to hash.</param>
<param name="destination">The buffer to fill with the hash.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.
<param name="cancellationToken">The token to monitor for cancellation requests.
The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<summary>Asynchronously computes the hash of a stream using the SHAKE128 algorithm.</summary>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask" /> that represents the asynchronous operation.</returns>
Expand All @@ -560,7 +563,7 @@
<paramref name="source" /> does not support reading.</exception>
<exception cref="T:System.OperationCanceledException">
<paramref name="cancellationToken" /> has been canceled.</exception>
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
to determine if the platform supports SHAKE128.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -612,10 +615,16 @@
<Parameter Name="outputLength" Type="System.Int32" Index="0" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="outputLength">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="outputLength">The size of the hash to produce.</param>
<summary>Retrieves the hash for the data accumulated from prior calls to the <c>AppendData</c> methods without resetting the object to its initial state and allowing additional calls to continue retrieving the hash.</summary>
<returns>The computed hash.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="outputLength" /> is negative.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">An error has occurred during the operation.</exception>
<exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception>
<exception cref="T:System.PlatformNotSupportedException">The platform does not support multiple reads of the hash. <see cref="M:System.Security.Cryptography.Shake128.GetHashAndReset(System.Int32)" /> can be used
to perform a single operation.</exception>
</Docs>
</Member>
<Member MemberName="Read">
Expand All @@ -637,9 +646,13 @@
<Parameter Name="destination" Type="System.Span&lt;System.Byte&gt;" Index="0" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<summary>To be added.</summary>
<param name="destination">The buffer to fill with the hash.</param>
<summary>Fills the buffer with the hash for the data accumulated from prior calls to the <c>AppendData</c> methods without resetting the object to its initial state and allowing additional calls to continue retrieving the hash.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.Security.Cryptography.CryptographicException">An error has occurred during the operation.</exception>
<exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception>
<exception cref="T:System.PlatformNotSupportedException">The platform does not support multiple reads of the hash. <see cref="M:System.Security.Cryptography.Shake128.GetHashAndReset(System.Span{System.Byte})" /> can be used
to perform a single operation.</exception>
</Docs>
</Member>
<Member MemberName="Reset">
Expand All @@ -659,8 +672,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Resets the instance back to its initial state.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.Security.Cryptography.CryptographicException">An error has occurred during the operation.</exception>
<exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception>
</Docs>
</Member>
</Members>
Expand Down
Loading