Skip to content

Commit 6e5da84

Browse files
ericstjericstj
committed
System.Security.Cryptography docs
1 parent 1a9245c commit 6e5da84

File tree

16 files changed

+2321
-907
lines changed

16 files changed

+2321
-907
lines changed

‎xml/System.Security.Cryptography.Cose/CoseHeaderMap.xml‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -799,10 +799,11 @@ This member is an explicit interface member implementation. It can be used only
799799
<Parameter Name="value" Type="System.Security.Cryptography.Cose.CoseHeaderValue" RefType="out" />
800800
</Parameters>
801801
<Docs>
802-
<param name="key">To be added.</param>
803-
<param name="value">To be added.</param>
804-
<summary>To be added.</summary>
805-
<returns>To be added.</returns>
802+
<param name="key">The key whose value to get.</param>
803+
<param name="value">When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the <paramref name="value" /> parameter. This parameter is passed uninitialized.</param>
804+
<summary>Gets the value associated with the specified key.</summary>
805+
<returns>
806+
<see langword="true" /> if the object that implements <see cref="T:System.Collections.Generic.IDictionary`2" /> contains an element with the specified key; otherwise, <see langword="false" />.</returns>
806807
<remarks>To be added.</remarks>
807808
<inheritdoc cref="M:System.Collections.Generic.IDictionary`2.TryGetValue(`0,`1@)" />
808809
</Docs>

‎xml/System.Security.Cryptography.X509Certificates/Pkcs12LoaderLimits.xml‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,12 @@
120120
<ReturnType>System.Boolean</ReturnType>
121121
</ReturnValue>
122122
<Docs>
123-
<summary>To be added.</summary>
124-
<value>To be added.</value>
123+
<summary>Gets or sets a value indicating whether duplicate attributes are permitted.</summary>
124+
<value>
125+
<para>
126+
<see langword="true" /> to permit duplicate attributes; <see langword="false" /> to fail loading when duplicate attributes are found.</para>
127+
<para>The default is <see langword="false" />.</para>
128+
</value>
125129
<remarks>To be added.</remarks>
126130
</Docs>
127131
</Member>
@@ -205,6 +209,7 @@
205209
property values may change over time.
206210
</remarks>
207211
<altmember cref="P:System.Security.Cryptography.X509Certificates.Pkcs12LoaderLimits.IsReadOnly" />
212+
<seealso cref="P:System.Security.Cryptography.X509Certificates.Pkcs12LoaderLimits.IsReadOnly" />
208213
</Docs>
209214
</Member>
210215
<Member MemberName="IgnoreEncryptedAuthSafes">
@@ -495,6 +500,7 @@
495500
This property has no effect on non-Windows systems.
496501
</remarks>
497502
<altmember cref="P:System.Security.Cryptography.X509Certificates.X509Certificate2.FriendlyName" />
503+
<seealso cref="P:System.Security.Cryptography.X509Certificates.X509Certificate2.FriendlyName" />
498504
</Docs>
499505
</Member>
500506
<Member MemberName="PreserveKeyName">

‎xml/System.Security.Cryptography.X509Certificates/X509CertificateKeyAccessors.xml‎

Lines changed: 115 additions & 41 deletions
Large diffs are not rendered by default.

‎xml/System.Security.Cryptography.X509Certificates/X509CertificateLoader.xml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@
8383
The data did not load as a valid X.509 certificate.
8484
</exception>
8585
<altmember cref="M:System.Security.Cryptography.X509Certificates.X509Certificate2.GetCertContentType(System.String)" />
86+
<seealso cref="M:System.Security.Cryptography.X509Certificates.X509Certificate2.GetCertContentType(System.String)" />
8687
</Docs>
8788
</Member>
8889
<Member MemberName="LoadCertificate">
@@ -131,6 +132,7 @@
131132
The data did not load as a valid X.509 certificate.
132133
</exception>
133134
<altmember cref="M:System.Security.Cryptography.X509Certificates.X509Certificate2.GetCertContentType(System.String)" />
135+
<seealso cref="M:System.Security.Cryptography.X509Certificates.X509Certificate2.GetCertContentType(System.String)" />
134136
</Docs>
135137
</Member>
136138
<Member MemberName="LoadCertificateFromFile">
@@ -179,6 +181,7 @@
179181
An error occurred while loading the specified file.
180182
</exception>
181183
<altmember cref="M:System.Security.Cryptography.X509Certificates.X509Certificate2.GetCertContentType(System.String)" />
184+
<seealso cref="M:System.Security.Cryptography.X509Certificates.X509Certificate2.GetCertContentType(System.String)" />
182185
</Docs>
183186
</Member>
184187
<Member MemberName="LoadPkcs12">

‎xml/System.Security.Cryptography/CompositeMLDsa.xml‎

Lines changed: 429 additions & 152 deletions
Large diffs are not rendered by default.

‎xml/System.Security.Cryptography/CompositeMLDsaAlgorithm.xml‎

Lines changed: 54 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
</Attribute>
3333
</Attributes>
3434
<Docs>
35-
<summary>To be added.</summary>
35+
<summary>Represents a composite ML-DSA algorithm identifier, combining ML-DSA with a traditional algorithm.</summary>
3636
<remarks>To be added.</remarks>
3737
</Docs>
3838
<Members>
@@ -70,6 +70,7 @@
7070
<summary>To be added.</summary>
7171
<returns>To be added.</returns>
7272
<remarks>To be added.</remarks>
73+
<inheritdoc />
7374
</Docs>
7475
</Member>
7576
<Member MemberName="Equals">
@@ -135,6 +136,7 @@
135136
<summary>To be added.</summary>
136137
<returns>To be added.</returns>
137138
<remarks>To be added.</remarks>
139+
<inheritdoc />
138140
</Docs>
139141
</Member>
140142
<Member MemberName="MaxSignatureSizeInBytes">
@@ -157,8 +159,8 @@
157159
<ReturnType>System.Int32</ReturnType>
158160
</ReturnValue>
159161
<Docs>
160-
<summary>To be added.</summary>
161-
<value>To be added.</value>
162+
<summary>Gets the maximum signature size in bytes for the composite algorithm.</summary>
163+
<value>The maximum signature size in bytes for the composite algorithm.</value>
162164
<remarks>To be added.</remarks>
163165
</Docs>
164166
</Member>
@@ -182,8 +184,8 @@
182184
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
183185
</ReturnValue>
184186
<Docs>
185-
<summary>To be added.</summary>
186-
<value>To be added.</value>
187+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-44 and ECDSA P-256 with SHA256 algorithm.</summary>
188+
<value>An ML-DSA algorithm identifier for the ML-DSA-44 and ECDSA P-256 with SHA256 algorithm.</value>
187189
<remarks>To be added.</remarks>
188190
</Docs>
189191
</Member>
@@ -207,8 +209,8 @@
207209
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
208210
</ReturnValue>
209211
<Docs>
210-
<summary>To be added.</summary>
211-
<value>To be added.</value>
212+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-44 and Ed25519 algorithm.</summary>
213+
<value>An ML-DSA algorithm identifier for the ML-DSA-44 and Ed25519 algorithm.</value>
212214
<remarks>To be added.</remarks>
213215
</Docs>
214216
</Member>
@@ -232,8 +234,8 @@
232234
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
233235
</ReturnValue>
234236
<Docs>
235-
<summary>To be added.</summary>
236-
<value>To be added.</value>
237+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-44 and 2048-bit RSASSA-PKCS1-v1_5 with SHA256 algorithm.</summary>
238+
<value>An ML-DSA algorithm identifier for the ML-DSA-44 and 2048-bit RSASSA-PKCS1-v1_5 with SHA256 algorithm.</value>
237239
<remarks>To be added.</remarks>
238240
</Docs>
239241
</Member>
@@ -257,8 +259,8 @@
257259
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
258260
</ReturnValue>
259261
<Docs>
260-
<summary>To be added.</summary>
261-
<value>To be added.</value>
262+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-44 and 2048-bit RSASSA-PSS with SHA256 algorithm.</summary>
263+
<value>An ML-DSA algorithm identifier for the ML-DSA-44 and 2048-bit RSASSA-PSS with SHA256 algorithm.</value>
262264
<remarks>To be added.</remarks>
263265
</Docs>
264266
</Member>
@@ -282,8 +284,8 @@
282284
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
283285
</ReturnValue>
284286
<Docs>
285-
<summary>To be added.</summary>
286-
<value>To be added.</value>
287+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-65 and ECDSA BrainpoolP256r1 with SHA512 algorithm.</summary>
288+
<value>An ML-DSA algorithm identifier for the ML-DSA-65 and ECDSA BrainpoolP256r1 with SHA512 algorithm.</value>
287289
<remarks>To be added.</remarks>
288290
</Docs>
289291
</Member>
@@ -307,8 +309,8 @@
307309
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
308310
</ReturnValue>
309311
<Docs>
310-
<summary>To be added.</summary>
311-
<value>To be added.</value>
312+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-65 and ECDSA P-256 with SHA512 algorithm.</summary>
313+
<value>An ML-DSA algorithm identifier for the ML-DSA-65 and ECDSA P-256 with SHA512 algorithm.</value>
312314
<remarks>To be added.</remarks>
313315
</Docs>
314316
</Member>
@@ -332,8 +334,8 @@
332334
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
333335
</ReturnValue>
334336
<Docs>
335-
<summary>To be added.</summary>
336-
<value>To be added.</value>
337+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-65 and ECDSA P-384 with SHA512 algorithm.</summary>
338+
<value>An ML-DSA algorithm identifier for the ML-DSA-65 and ECDSA P-384 with SHA512 algorithm.</value>
337339
<remarks>To be added.</remarks>
338340
</Docs>
339341
</Member>
@@ -357,8 +359,8 @@
357359
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
358360
</ReturnValue>
359361
<Docs>
360-
<summary>To be added.</summary>
361-
<value>To be added.</value>
362+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-65 and Ed25519 algorithm.</summary>
363+
<value>An ML-DSA algorithm identifier for the ML-DSA-65 and Ed25519 algorithm.</value>
362364
<remarks>To be added.</remarks>
363365
</Docs>
364366
</Member>
@@ -382,8 +384,8 @@
382384
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
383385
</ReturnValue>
384386
<Docs>
385-
<summary>To be added.</summary>
386-
<value>To be added.</value>
387+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-65 and 3072-bit RSASSA-PKCS1-v1_5 with SHA512 algorithm.</summary>
388+
<value>An ML-DSA algorithm identifier for the ML-DSA-65 and 3072-bit RSASSA-PKCS1-v1_5 with SHA512 algorithm.</value>
387389
<remarks>To be added.</remarks>
388390
</Docs>
389391
</Member>
@@ -407,8 +409,8 @@
407409
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
408410
</ReturnValue>
409411
<Docs>
410-
<summary>To be added.</summary>
411-
<value>To be added.</value>
412+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-65 and 3072-bit RSASSA-PSS with SHA512 algorithm.</summary>
413+
<value>An ML-DSA algorithm identifier for the ML-DSA-65 and 3072-bit RSASSA-PSS with SHA512 algorithm.</value>
412414
<remarks>To be added.</remarks>
413415
</Docs>
414416
</Member>
@@ -432,8 +434,8 @@
432434
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
433435
</ReturnValue>
434436
<Docs>
435-
<summary>To be added.</summary>
436-
<value>To be added.</value>
437+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-65 and 4096-bit RSASSA-PKCS1-v1_5 with SHA512 algorithm.</summary>
438+
<value>An ML-DSA algorithm identifier for the ML-DSA-65 and 4096-bit RSASSA-PKCS1-v1_5 with SHA512 algorithm.</value>
437439
<remarks>To be added.</remarks>
438440
</Docs>
439441
</Member>
@@ -457,8 +459,8 @@
457459
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
458460
</ReturnValue>
459461
<Docs>
460-
<summary>To be added.</summary>
461-
<value>To be added.</value>
462+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-65 and 4096-bit RSASSA-PSS with SHA512 algorithm.</summary>
463+
<value>An ML-DSA algorithm identifier for the ML-DSA-65 and 4096-bit RSASSA-PSS with SHA512 algorithm.</value>
462464
<remarks>To be added.</remarks>
463465
</Docs>
464466
</Member>
@@ -482,8 +484,8 @@
482484
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
483485
</ReturnValue>
484486
<Docs>
485-
<summary>To be added.</summary>
486-
<value>To be added.</value>
487+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-87 and ECDSA BrainpoolP384r1 with SHA512 algorithm.</summary>
488+
<value>An ML-DSA algorithm identifier for the ML-DSA-87 and ECDSA BrainpoolP384r1 with SHA512 algorithm.</value>
487489
<remarks>To be added.</remarks>
488490
</Docs>
489491
</Member>
@@ -507,8 +509,8 @@
507509
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
508510
</ReturnValue>
509511
<Docs>
510-
<summary>To be added.</summary>
511-
<value>To be added.</value>
512+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-87 and ECDSA P-384 with SHA512 algorithm.</summary>
513+
<value>An ML-DSA algorithm identifier for the ML-DSA-87 and ECDSA P-384 with SHA512 algorithm.</value>
512514
<remarks>To be added.</remarks>
513515
</Docs>
514516
</Member>
@@ -532,8 +534,8 @@
532534
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
533535
</ReturnValue>
534536
<Docs>
535-
<summary>To be added.</summary>
536-
<value>To be added.</value>
537+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-87 and ECDSA P-521 with SHA512 algorithm.</summary>
538+
<value>An ML-DSA algorithm identifier for the ML-DSA-87 and ECDSA P-521 with SHA512 algorithm.</value>
537539
<remarks>To be added.</remarks>
538540
</Docs>
539541
</Member>
@@ -557,8 +559,8 @@
557559
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
558560
</ReturnValue>
559561
<Docs>
560-
<summary>To be added.</summary>
561-
<value>To be added.</value>
562+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-87 and Ed448 algorithm.</summary>
563+
<value>An ML-DSA algorithm identifier for the ML-DSA-87 and Ed448 algorithm.</value>
562564
<remarks>To be added.</remarks>
563565
</Docs>
564566
</Member>
@@ -582,8 +584,8 @@
582584
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
583585
</ReturnValue>
584586
<Docs>
585-
<summary>To be added.</summary>
586-
<value>To be added.</value>
587+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-87 and 3072-bit RSASSA-PSS with SHA512 algorithm.</summary>
588+
<value>An ML-DSA algorithm identifier for the ML-DSA-87 and 3072-bit RSASSA-PSS with SHA512 algorithm.</value>
587589
<remarks>To be added.</remarks>
588590
</Docs>
589591
</Member>
@@ -607,8 +609,8 @@
607609
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
608610
</ReturnValue>
609611
<Docs>
610-
<summary>To be added.</summary>
611-
<value>To be added.</value>
612+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-87 and 4096-bit RSASSA-PSS with SHA512 algorithm.</summary>
613+
<value>An ML-DSA algorithm identifier for the ML-DSA-87 and 4096-bit RSASSA-PSS with SHA512 algorithm.</value>
612614
<remarks>To be added.</remarks>
613615
</Docs>
614616
</Member>
@@ -632,8 +634,8 @@
632634
<ReturnType>System.String</ReturnType>
633635
</ReturnValue>
634636
<Docs>
635-
<summary>To be added.</summary>
636-
<value>To be added.</value>
637+
<summary>Gets the name of the algorithm.</summary>
638+
<value>A string representing the algorithm name.</value>
637639
<remarks>To be added.</remarks>
638640
</Docs>
639641
</Member>
@@ -661,10 +663,11 @@
661663
<Parameter Name="right" Type="System.Security.Cryptography.CompositeMLDsaAlgorithm" />
662664
</Parameters>
663665
<Docs>
664-
<param name="left">To be added.</param>
665-
<param name="right">To be added.</param>
666-
<summary>To be added.</summary>
667-
<returns>To be added.</returns>
666+
<param name="left">An object that specifies an algorithm name.</param>
667+
<param name="right">A second object, to be compared to the object that is identified by the <paramref name="left" /> parameter.</param>
668+
<summary>Determines whether two <see cref="T:System.Security.Cryptography.CompositeMLDsaAlgorithm" /> objects specify the same algorithm name.</summary>
669+
<returns>
670+
<see langword="true" /> if the objects are considered equal; otherwise, <see langword="false" />.</returns>
668671
<remarks>To be added.</remarks>
669672
</Docs>
670673
</Member>
@@ -692,10 +695,11 @@
692695
<Parameter Name="right" Type="System.Security.Cryptography.CompositeMLDsaAlgorithm" />
693696
</Parameters>
694697
<Docs>
695-
<param name="left">To be added.</param>
696-
<param name="right">To be added.</param>
697-
<summary>To be added.</summary>
698-
<returns>To be added.</returns>
698+
<param name="left">An object that specifies an algorithm name.</param>
699+
<param name="right">A second object, to be compared to the object that is identified by the <paramref name="left" /> parameter.</param>
700+
<summary>Determines whether two <see cref="T:System.Security.Cryptography.CompositeMLDsaAlgorithm" /> objects do not specify the same algorithm name.</summary>
701+
<returns>
702+
<see langword="true" /> if the objects are not considered equal; otherwise, <see langword="false" />.</returns>
699703
<remarks>To be added.</remarks>
700704
</Docs>
701705
</Member>
@@ -723,6 +727,7 @@
723727
<summary>To be added.</summary>
724728
<returns>To be added.</returns>
725729
<remarks>To be added.</remarks>
730+
<inheritdoc />
726731
</Docs>
727732
</Member>
728733
</Members>

0 commit comments

Comments
 (0)