Skip to content

Commit 1a8e027

Browse files
authored
Port System.Security new docs (#10156)
* System.Security.Cryptography * System.Security.Cryptography.X509Certificates
1 parent 6c6e9e6 commit 1a8e027

File tree

9 files changed

+1233
-469
lines changed

9 files changed

+1233
-469
lines changed

xml/System.Security.Cryptography.X509Certificates/X509SubjectKeyIdentifierHashAlgorithm.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@
169169
</ReturnValue>
170170
<MemberValue>3</MemberValue>
171171
<Docs>
172-
<summary>To be added.</summary>
172+
<summary>The SHA-256 hash over the SubjectPublicKeyInfo as described in RFC 7093.</summary>
173173
</Docs>
174174
</Member>
175175
<Member MemberName="Sha384">
@@ -195,7 +195,7 @@
195195
</ReturnValue>
196196
<MemberValue>4</MemberValue>
197197
<Docs>
198-
<summary>To be added.</summary>
198+
<summary>The SHA-384 hash over the SubjectPublicKeyInfo as described in RFC 7093.</summary>
199199
</Docs>
200200
</Member>
201201
<Member MemberName="Sha512">
@@ -221,7 +221,7 @@
221221
</ReturnValue>
222222
<MemberValue>5</MemberValue>
223223
<Docs>
224-
<summary>To be added.</summary>
224+
<summary>The SHA-512 hash over the SubjectPublicKeyInfo as described in RFC 7093.</summary>
225225
</Docs>
226226
</Member>
227227
<Member MemberName="ShortSha1">
@@ -290,7 +290,7 @@
290290
</ReturnValue>
291291
<MemberValue>6</MemberValue>
292292
<Docs>
293-
<summary>To be added.</summary>
293+
<summary>The SHA-256 hash over the subjectPublicKey truncated to the leftmost 160-bits as described in RFC 7093.</summary>
294294
</Docs>
295295
</Member>
296296
<Member MemberName="ShortSha384">
@@ -316,7 +316,7 @@
316316
</ReturnValue>
317317
<MemberValue>7</MemberValue>
318318
<Docs>
319-
<summary>To be added.</summary>
319+
<summary>The SHA-384 hash over the subjectPublicKey truncated to the leftmost 160-bits as described in RFC 7093.</summary>
320320
</Docs>
321321
</Member>
322322
<Member MemberName="ShortSha512">
@@ -342,7 +342,7 @@
342342
</ReturnValue>
343343
<MemberValue>8</MemberValue>
344344
<Docs>
345-
<summary>To be added.</summary>
345+
<summary>The SHA-512 hash over the subjectPublicKey truncated to the leftmost 160-bits as described in RFC 7093.</summary>
346346
</Docs>
347347
</Member>
348348
</Members>

xml/System.Security.Cryptography/CryptographicOperations.xml

Lines changed: 409 additions & 97 deletions
Large diffs are not rendered by default.

xml/System.Security.Cryptography/IncrementalHash.xml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -307,9 +307,11 @@
307307
</ReturnValue>
308308
<Parameters />
309309
<Docs>
310-
<summary>To be added.</summary>
311-
<returns>To be added.</returns>
310+
<summary>Creates a new instance of <see cref="T:System.Security.Cryptography.IncrementalHash" /> with the existing appended data preserved.</summary>
311+
<returns>A clone of the current instance.</returns>
312312
<remarks>To be added.</remarks>
313+
<exception cref="T:System.Security.Cryptography.CryptographicException">An error has occurred during the operation.</exception>
314+
<exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception>
313315
</Docs>
314316
</Member>
315317
<Member MemberName="CreateHash">

xml/System.Security.Cryptography/Kmac128.xml

Lines changed: 187 additions & 82 deletions
Large diffs are not rendered by default.

xml/System.Security.Cryptography/Kmac256.xml

Lines changed: 187 additions & 82 deletions
Large diffs are not rendered by default.

xml/System.Security.Cryptography/KmacXof128.xml

Lines changed: 187 additions & 82 deletions
Large diffs are not rendered by default.

xml/System.Security.Cryptography/KmacXof256.xml

Lines changed: 187 additions & 82 deletions
Large diffs are not rendered by default.

xml/System.Security.Cryptography/Shake128.xml

Lines changed: 33 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
<Docs>
4040
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Shake128" /> class.</summary>
4141
<remarks>To be added.</remarks>
42-
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
42+
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
4343
to determine if the platform supports SHAKE128.</exception>
4444
</Docs>
4545
</Member>
@@ -126,9 +126,12 @@
126126
</ReturnValue>
127127
<Parameters />
128128
<Docs>
129-
<summary>To be added.</summary>
130-
<returns>To be added.</returns>
129+
<summary>Creates a new instance of <see cref="T:System.Security.Cryptography.Shake128" /> with the existing appended data preserved.</summary>
130+
<returns>A clone of the current instance.</returns>
131131
<remarks>To be added.</remarks>
132+
<exception cref="T:System.Security.Cryptography.CryptographicException">An error has occurred during the operation.</exception>
133+
<exception cref="T:System.InvalidOperationException">The current instance is being read from and cannot be cloned.</exception>
134+
<exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception>
132135
</Docs>
133136
</Member>
134137
<Member MemberName="Dispose">
@@ -314,7 +317,7 @@
314317
<paramref name="outputLength" /> is negative.</exception>
315318
<exception cref="T:System.ArgumentNullException">
316319
<paramref name="source" /> is <see langword="null" />.</exception>
317-
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
320+
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
318321
to determine if the platform supports SHAKE128.</exception>
319322
</Docs>
320323
</Member>
@@ -356,7 +359,7 @@
356359
<paramref name="outputLength" /> is negative.</exception>
357360
<exception cref="T:System.ArgumentNullException">
358361
<paramref name="source" /> is <see langword="null" />.</exception>
359-
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
362+
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
360363
to determine if the platform supports SHAKE128.</exception>
361364
</Docs>
362365
</Member>
@@ -396,7 +399,7 @@
396399
<paramref name="source" /> does not support reading.</exception>
397400
<exception cref="T:System.ArgumentNullException">
398401
<paramref name="source" /> is <see langword="null" />.</exception>
399-
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
402+
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
400403
to determine if the platform supports SHAKE128.</exception>
401404
</Docs>
402405
</Member>
@@ -434,7 +437,7 @@
434437
<remarks>To be added.</remarks>
435438
<exception cref="T:System.ArgumentOutOfRangeException">
436439
<paramref name="outputLength" /> is negative.</exception>
437-
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
440+
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
438441
to determine if the platform supports SHAKE128.</exception>
439442
</Docs>
440443
</Member>
@@ -463,7 +466,7 @@
463466
<param name="destination">The buffer to fill with the hash.</param>
464467
<summary>Computes the hash of data using the SHAKE128 algorithm.</summary>
465468
<remarks>To be added.</remarks>
466-
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
469+
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
467470
to determine if the platform supports SHAKE128.</exception>
468471
</Docs>
469472
</Member>
@@ -502,7 +505,7 @@
502505
<Docs>
503506
<param name="source">The stream to hash.</param>
504507
<param name="outputLength">The size of the hash to produce.</param>
505-
<param name="cancellationToken">The token to monitor for cancellation requests.
508+
<param name="cancellationToken">The token to monitor for cancellation requests.
506509
The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
507510
<summary>Asynchronously computes the hash of a stream using the SHAKE128 algorithm.</summary>
508511
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> that completes with the computed hash.</returns>
@@ -515,7 +518,7 @@
515518
<paramref name="source" /> is <see langword="null" />.</exception>
516519
<exception cref="T:System.OperationCanceledException">
517520
<paramref name="cancellationToken" /> has been canceled.</exception>
518-
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
521+
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
519522
to determine if the platform supports SHAKE128.</exception>
520523
</Docs>
521524
</Member>
@@ -549,7 +552,7 @@
549552
<Docs>
550553
<param name="source">The stream to hash.</param>
551554
<param name="destination">The buffer to fill with the hash.</param>
552-
<param name="cancellationToken">The token to monitor for cancellation requests.
555+
<param name="cancellationToken">The token to monitor for cancellation requests.
553556
The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
554557
<summary>Asynchronously computes the hash of a stream using the SHAKE128 algorithm.</summary>
555558
<returns>A <see cref="T:System.Threading.Tasks.ValueTask" /> that represents the asynchronous operation.</returns>
@@ -560,7 +563,7 @@
560563
<paramref name="source" /> does not support reading.</exception>
561564
<exception cref="T:System.OperationCanceledException">
562565
<paramref name="cancellationToken" /> has been canceled.</exception>
563-
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
566+
<exception cref="T:System.PlatformNotSupportedException">The platform does not support SHAKE128. Callers can use the <see cref="P:System.Security.Cryptography.Shake128.IsSupported" /> property
564567
to determine if the platform supports SHAKE128.</exception>
565568
</Docs>
566569
</Member>
@@ -612,10 +615,16 @@
612615
<Parameter Name="outputLength" Type="System.Int32" Index="0" FrameworkAlternate="net-9.0" />
613616
</Parameters>
614617
<Docs>
615-
<param name="outputLength">To be added.</param>
616-
<summary>To be added.</summary>
617-
<returns>To be added.</returns>
618+
<param name="outputLength">The size of the hash to produce.</param>
619+
<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>
620+
<returns>The computed hash.</returns>
618621
<remarks>To be added.</remarks>
622+
<exception cref="T:System.ArgumentOutOfRangeException">
623+
<paramref name="outputLength" /> is negative.</exception>
624+
<exception cref="T:System.Security.Cryptography.CryptographicException">An error has occurred during the operation.</exception>
625+
<exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception>
626+
<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
627+
to perform a single operation.</exception>
619628
</Docs>
620629
</Member>
621630
<Member MemberName="Read">
@@ -637,9 +646,13 @@
637646
<Parameter Name="destination" Type="System.Span&lt;System.Byte&gt;" Index="0" FrameworkAlternate="net-9.0" />
638647
</Parameters>
639648
<Docs>
640-
<param name="destination">To be added.</param>
641-
<summary>To be added.</summary>
649+
<param name="destination">The buffer to fill with the hash.</param>
650+
<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>
642651
<remarks>To be added.</remarks>
652+
<exception cref="T:System.Security.Cryptography.CryptographicException">An error has occurred during the operation.</exception>
653+
<exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception>
654+
<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
655+
to perform a single operation.</exception>
643656
</Docs>
644657
</Member>
645658
<Member MemberName="Reset">
@@ -659,8 +672,10 @@
659672
</ReturnValue>
660673
<Parameters />
661674
<Docs>
662-
<summary>To be added.</summary>
675+
<summary>Resets the instance back to its initial state.</summary>
663676
<remarks>To be added.</remarks>
677+
<exception cref="T:System.Security.Cryptography.CryptographicException">An error has occurred during the operation.</exception>
678+
<exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception>
664679
</Docs>
665680
</Member>
666681
</Members>

0 commit comments

Comments
 (0)