Skip to content

Commit 9d187db

Browse files
ericstjericstj
committed
System.Security.Cryptography docs
1 parent c04f912 commit 9d187db

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">
@@ -136,6 +137,7 @@
136137
<summary>To be added.</summary>
137138
<returns>To be added.</returns>
138139
<remarks>To be added.</remarks>
140+
<inheritdoc />
139141
</Docs>
140142
</Member>
141143
<Member MemberName="MaxSignatureSizeInBytes">
@@ -158,8 +160,8 @@
158160
<ReturnType>System.Int32</ReturnType>
159161
</ReturnValue>
160162
<Docs>
161-
<summary>To be added.</summary>
162-
<value>To be added.</value>
163+
<summary>Gets the maximum signature size in bytes for the composite algorithm.</summary>
164+
<value>The maximum signature size in bytes for the composite algorithm.</value>
163165
<remarks>To be added.</remarks>
164166
</Docs>
165167
</Member>
@@ -183,8 +185,8 @@
183185
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
184186
</ReturnValue>
185187
<Docs>
186-
<summary>To be added.</summary>
187-
<value>To be added.</value>
188+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-44 and ECDSA P-256 with SHA256 algorithm.</summary>
189+
<value>An ML-DSA algorithm identifier for the ML-DSA-44 and ECDSA P-256 with SHA256 algorithm.</value>
188190
<remarks>To be added.</remarks>
189191
</Docs>
190192
</Member>
@@ -208,8 +210,8 @@
208210
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
209211
</ReturnValue>
210212
<Docs>
211-
<summary>To be added.</summary>
212-
<value>To be added.</value>
213+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-44 and Ed25519 algorithm.</summary>
214+
<value>An ML-DSA algorithm identifier for the ML-DSA-44 and Ed25519 algorithm.</value>
213215
<remarks>To be added.</remarks>
214216
</Docs>
215217
</Member>
@@ -233,8 +235,8 @@
233235
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
234236
</ReturnValue>
235237
<Docs>
236-
<summary>To be added.</summary>
237-
<value>To be added.</value>
238+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-44 and 2048-bit RSASSA-PKCS1-v1_5 with SHA256 algorithm.</summary>
239+
<value>An ML-DSA algorithm identifier for the ML-DSA-44 and 2048-bit RSASSA-PKCS1-v1_5 with SHA256 algorithm.</value>
238240
<remarks>To be added.</remarks>
239241
</Docs>
240242
</Member>
@@ -258,8 +260,8 @@
258260
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
259261
</ReturnValue>
260262
<Docs>
261-
<summary>To be added.</summary>
262-
<value>To be added.</value>
263+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-44 and 2048-bit RSASSA-PSS with SHA256 algorithm.</summary>
264+
<value>An ML-DSA algorithm identifier for the ML-DSA-44 and 2048-bit RSASSA-PSS with SHA256 algorithm.</value>
263265
<remarks>To be added.</remarks>
264266
</Docs>
265267
</Member>
@@ -283,8 +285,8 @@
283285
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
284286
</ReturnValue>
285287
<Docs>
286-
<summary>To be added.</summary>
287-
<value>To be added.</value>
288+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-65 and ECDSA BrainpoolP256r1 with SHA512 algorithm.</summary>
289+
<value>An ML-DSA algorithm identifier for the ML-DSA-65 and ECDSA BrainpoolP256r1 with SHA512 algorithm.</value>
288290
<remarks>To be added.</remarks>
289291
</Docs>
290292
</Member>
@@ -308,8 +310,8 @@
308310
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
309311
</ReturnValue>
310312
<Docs>
311-
<summary>To be added.</summary>
312-
<value>To be added.</value>
313+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-65 and ECDSA P-256 with SHA512 algorithm.</summary>
314+
<value>An ML-DSA algorithm identifier for the ML-DSA-65 and ECDSA P-256 with SHA512 algorithm.</value>
313315
<remarks>To be added.</remarks>
314316
</Docs>
315317
</Member>
@@ -333,8 +335,8 @@
333335
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
334336
</ReturnValue>
335337
<Docs>
336-
<summary>To be added.</summary>
337-
<value>To be added.</value>
338+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-65 and ECDSA P-384 with SHA512 algorithm.</summary>
339+
<value>An ML-DSA algorithm identifier for the ML-DSA-65 and ECDSA P-384 with SHA512 algorithm.</value>
338340
<remarks>To be added.</remarks>
339341
</Docs>
340342
</Member>
@@ -358,8 +360,8 @@
358360
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
359361
</ReturnValue>
360362
<Docs>
361-
<summary>To be added.</summary>
362-
<value>To be added.</value>
363+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-65 and Ed25519 algorithm.</summary>
364+
<value>An ML-DSA algorithm identifier for the ML-DSA-65 and Ed25519 algorithm.</value>
363365
<remarks>To be added.</remarks>
364366
</Docs>
365367
</Member>
@@ -383,8 +385,8 @@
383385
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
384386
</ReturnValue>
385387
<Docs>
386-
<summary>To be added.</summary>
387-
<value>To be added.</value>
388+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-65 and 3072-bit RSASSA-PKCS1-v1_5 with SHA512 algorithm.</summary>
389+
<value>An ML-DSA algorithm identifier for the ML-DSA-65 and 3072-bit RSASSA-PKCS1-v1_5 with SHA512 algorithm.</value>
388390
<remarks>To be added.</remarks>
389391
</Docs>
390392
</Member>
@@ -408,8 +410,8 @@
408410
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
409411
</ReturnValue>
410412
<Docs>
411-
<summary>To be added.</summary>
412-
<value>To be added.</value>
413+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-65 and 3072-bit RSASSA-PSS with SHA512 algorithm.</summary>
414+
<value>An ML-DSA algorithm identifier for the ML-DSA-65 and 3072-bit RSASSA-PSS with SHA512 algorithm.</value>
413415
<remarks>To be added.</remarks>
414416
</Docs>
415417
</Member>
@@ -433,8 +435,8 @@
433435
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
434436
</ReturnValue>
435437
<Docs>
436-
<summary>To be added.</summary>
437-
<value>To be added.</value>
438+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-65 and 4096-bit RSASSA-PKCS1-v1_5 with SHA512 algorithm.</summary>
439+
<value>An ML-DSA algorithm identifier for the ML-DSA-65 and 4096-bit RSASSA-PKCS1-v1_5 with SHA512 algorithm.</value>
438440
<remarks>To be added.</remarks>
439441
</Docs>
440442
</Member>
@@ -458,8 +460,8 @@
458460
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
459461
</ReturnValue>
460462
<Docs>
461-
<summary>To be added.</summary>
462-
<value>To be added.</value>
463+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-65 and 4096-bit RSASSA-PSS with SHA512 algorithm.</summary>
464+
<value>An ML-DSA algorithm identifier for the ML-DSA-65 and 4096-bit RSASSA-PSS with SHA512 algorithm.</value>
463465
<remarks>To be added.</remarks>
464466
</Docs>
465467
</Member>
@@ -483,8 +485,8 @@
483485
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
484486
</ReturnValue>
485487
<Docs>
486-
<summary>To be added.</summary>
487-
<value>To be added.</value>
488+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-87 and ECDSA BrainpoolP384r1 with SHA512 algorithm.</summary>
489+
<value>An ML-DSA algorithm identifier for the ML-DSA-87 and ECDSA BrainpoolP384r1 with SHA512 algorithm.</value>
488490
<remarks>To be added.</remarks>
489491
</Docs>
490492
</Member>
@@ -508,8 +510,8 @@
508510
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
509511
</ReturnValue>
510512
<Docs>
511-
<summary>To be added.</summary>
512-
<value>To be added.</value>
513+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-87 and ECDSA P-384 with SHA512 algorithm.</summary>
514+
<value>An ML-DSA algorithm identifier for the ML-DSA-87 and ECDSA P-384 with SHA512 algorithm.</value>
513515
<remarks>To be added.</remarks>
514516
</Docs>
515517
</Member>
@@ -533,8 +535,8 @@
533535
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
534536
</ReturnValue>
535537
<Docs>
536-
<summary>To be added.</summary>
537-
<value>To be added.</value>
538+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-87 and ECDSA P-521 with SHA512 algorithm.</summary>
539+
<value>An ML-DSA algorithm identifier for the ML-DSA-87 and ECDSA P-521 with SHA512 algorithm.</value>
538540
<remarks>To be added.</remarks>
539541
</Docs>
540542
</Member>
@@ -558,8 +560,8 @@
558560
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
559561
</ReturnValue>
560562
<Docs>
561-
<summary>To be added.</summary>
562-
<value>To be added.</value>
563+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-87 and Ed448 algorithm.</summary>
564+
<value>An ML-DSA algorithm identifier for the ML-DSA-87 and Ed448 algorithm.</value>
563565
<remarks>To be added.</remarks>
564566
</Docs>
565567
</Member>
@@ -583,8 +585,8 @@
583585
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
584586
</ReturnValue>
585587
<Docs>
586-
<summary>To be added.</summary>
587-
<value>To be added.</value>
588+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-87 and 3072-bit RSASSA-PSS with SHA512 algorithm.</summary>
589+
<value>An ML-DSA algorithm identifier for the ML-DSA-87 and 3072-bit RSASSA-PSS with SHA512 algorithm.</value>
588590
<remarks>To be added.</remarks>
589591
</Docs>
590592
</Member>
@@ -608,8 +610,8 @@
608610
<ReturnType>System.Security.Cryptography.CompositeMLDsaAlgorithm</ReturnType>
609611
</ReturnValue>
610612
<Docs>
611-
<summary>To be added.</summary>
612-
<value>To be added.</value>
613+
<summary>Gets a Composite ML-DSA algorithm identifier for the ML-DSA-87 and 4096-bit RSASSA-PSS with SHA512 algorithm.</summary>
614+
<value>An ML-DSA algorithm identifier for the ML-DSA-87 and 4096-bit RSASSA-PSS with SHA512 algorithm.</value>
613615
<remarks>To be added.</remarks>
614616
</Docs>
615617
</Member>
@@ -633,8 +635,8 @@
633635
<ReturnType>System.String</ReturnType>
634636
</ReturnValue>
635637
<Docs>
636-
<summary>To be added.</summary>
637-
<value>To be added.</value>
638+
<summary>Gets the name of the algorithm.</summary>
639+
<value>A string representing the algorithm name.</value>
638640
<remarks>To be added.</remarks>
639641
</Docs>
640642
</Member>
@@ -662,10 +664,11 @@
662664
<Parameter Name="right" Type="System.Security.Cryptography.CompositeMLDsaAlgorithm" />
663665
</Parameters>
664666
<Docs>
665-
<param name="left">To be added.</param>
666-
<param name="right">To be added.</param>
667-
<summary>To be added.</summary>
668-
<returns>To be added.</returns>
667+
<param name="left">An object that specifies an algorithm name.</param>
668+
<param name="right">A second object, to be compared to the object that is identified by the <paramref name="left" /> parameter.</param>
669+
<summary>Determines whether two <see cref="T:System.Security.Cryptography.CompositeMLDsaAlgorithm" /> objects specify the same algorithm name.</summary>
670+
<returns>
671+
<see langword="true" /> if the objects are considered equal; otherwise, <see langword="false" />.</returns>
669672
<remarks>To be added.</remarks>
670673
</Docs>
671674
</Member>
@@ -693,10 +696,11 @@
693696
<Parameter Name="right" Type="System.Security.Cryptography.CompositeMLDsaAlgorithm" />
694697
</Parameters>
695698
<Docs>
696-
<param name="left">To be added.</param>
697-
<param name="right">To be added.</param>
698-
<summary>To be added.</summary>
699-
<returns>To be added.</returns>
699+
<param name="left">An object that specifies an algorithm name.</param>
700+
<param name="right">A second object, to be compared to the object that is identified by the <paramref name="left" /> parameter.</param>
701+
<summary>Determines whether two <see cref="T:System.Security.Cryptography.CompositeMLDsaAlgorithm" /> objects do not specify the same algorithm name.</summary>
702+
<returns>
703+
<see langword="true" /> if the objects are not considered equal; otherwise, <see langword="false" />.</returns>
700704
<remarks>To be added.</remarks>
701705
</Docs>
702706
</Member>
@@ -724,6 +728,7 @@
724728
<summary>To be added.</summary>
725729
<returns>To be added.</returns>
726730
<remarks>To be added.</remarks>
731+
<inheritdoc />
727732
</Docs>
728733
</Member>
729734
</Members>

0 commit comments

Comments
 (0)