Skip to content

Commit b5871f7

Browse files
bartonjsbartonjs
authored
Add missing documentation for System.Security.* (dotnet#8431)
1 parent a34fe82 commit b5871f7

File tree

4 files changed

+102
-40
lines changed

4 files changed

+102
-40
lines changed

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

Lines changed: 77 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1062,13 +1062,24 @@ This object was created with a constructor which did not accept a signing key.
10621062
<Parameter Name="signerSignaturePadding" Type="System.Security.Cryptography.RSASignaturePadding" Index="3" FrameworkAlternate="net-7.0" />
10631063
</Parameters>
10641064
<Docs>
1065-
<param name="pkcs10">To be added.</param>
1066-
<param name="signerHashAlgorithm">To be added.</param>
1067-
<param name="options">To be added.</param>
1068-
<param name="signerSignaturePadding">To be added.</param>
1069-
<summary>To be added.</summary>
1070-
<returns>To be added.</returns>
1065+
<param name="pkcs10">The binary PKCS#10 signing request to load.</param>
1066+
<param name="signerHashAlgorithm">The hash algorithm to use when creating a certificate or new signing request.</param>
1067+
<param name="options">A bitwise combination of the enumeration values that specifies how to load the request.</param>
1068+
<param name="signerSignaturePadding">The RSA Signature Padding to use when creating a certificate from this request. For RSA signing certificates using the default signature generator, this parameter is required; otherwise, this parameter is ignored.</param>
1069+
<summary>Loads a binary PKCS#10 signing request as a new CertificateRequest instance.</summary>
1070+
<returns>A CertificateRequest instance which contains the information from the signing request.</returns>
10711071
<remarks>To be added.</remarks>
1072+
<exception cref="T:System.ArgumentException">
1073+
<paramref name="signerHashAlgorithm" />.<see cref="P:System.Security.Cryptography.HashAlgorithmName.Name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />.</exception>
1074+
<exception cref="T:System.ArgumentNullException"><paramref name="pkcs10" /> is <see langword="null" />.</exception>
1075+
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="options"/> specifies a value that is not supported.</exception>
1076+
<exception cref="T:System.Security.Cryptography.CryptographicException">
1077+
<paramref name="pkcs10"/> is not a valid PKCS#10 signing request.
1078+
1079+
-or-
1080+
1081+
<paramref name="pkcs10"/> contains a signature that could not be verified using its embedded public key.
1082+
</exception>
10721083
</Docs>
10731084
</Member>
10741085
<Member MemberName="LoadSigningRequest">
@@ -1099,14 +1110,25 @@ This object was created with a constructor which did not accept a signing key.
10991110
<Parameter Name="signerSignaturePadding" Type="System.Security.Cryptography.RSASignaturePadding" Index="4" FrameworkAlternate="net-7.0" />
11001111
</Parameters>
11011112
<Docs>
1102-
<param name="pkcs10">To be added.</param>
1103-
<param name="signerHashAlgorithm">To be added.</param>
1104-
<param name="bytesConsumed">To be added.</param>
1105-
<param name="options">To be added.</param>
1106-
<param name="signerSignaturePadding">To be added.</param>
1107-
<summary>To be added.</summary>
1108-
<returns>To be added.</returns>
1113+
<param name="pkcs10">The binary PKCS#10 signing request to load.</param>
1114+
<param name="signerHashAlgorithm">The hash algorithm to use when creating a certificate or new signing request.</param>
1115+
<param name="bytesConsumed">When this method returns, contains a value that indicates the number of bytes read from <paramref name="source" />. This parameter is treated as uninitialized.</param>
1116+
<param name="options">A bitwise combination of the enumeration values that specifies how to load the request.</param>
1117+
<param name="signerSignaturePadding">The RSA Signature Padding to use when creating a certificate from this request. For RSA signing certificates using the default signature generator, this parameter is required; otherwise, this parameter is ignored.</param>
1118+
<summary>Loads a binary PKCS#10 signing request as a new CertificateRequest instance.</summary>
1119+
<returns>A CertificateRequest instance which contains the information from the signing request.</returns>
11091120
<remarks>To be added.</remarks>
1121+
<exception cref="T:System.ArgumentException">
1122+
<paramref name="signerHashAlgorithm" />.<see cref="P:System.Security.Cryptography.HashAlgorithmName.Name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />.</exception>
1123+
<exception cref="T:System.ArgumentNullException"><paramref name="pkcs10" /> is <see langword="null" />.</exception>
1124+
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="options"/> specifies a value that is not supported.</exception>
1125+
<exception cref="T:System.Security.Cryptography.CryptographicException">
1126+
<paramref name="pkcs10"/> is not a valid PKCS#10 signing request.
1127+
1128+
-or-
1129+
1130+
<paramref name="pkcs10"/> contains a signature that could not be verified using its embedded public key.
1131+
</exception>
11101132
</Docs>
11111133
</Member>
11121134
<Member MemberName="LoadSigningRequestPem">
@@ -1136,13 +1158,28 @@ This object was created with a constructor which did not accept a signing key.
11361158
<Parameter Name="signerSignaturePadding" Type="System.Security.Cryptography.RSASignaturePadding" Index="3" FrameworkAlternate="net-7.0" />
11371159
</Parameters>
11381160
<Docs>
1139-
<param name="pkcs10Pem">To be added.</param>
1140-
<param name="signerHashAlgorithm">To be added.</param>
1141-
<param name="options">To be added.</param>
1142-
<param name="signerSignaturePadding">To be added.</param>
1143-
<summary>To be added.</summary>
1144-
<returns>To be added.</returns>
1161+
<param name="pkcs10Pem">The PEM-encoded PKCS#10 signing request to load.</param>
1162+
<param name="signerHashAlgorithm">The hash algorithm to use when creating a certificate or new signing request.</param>
1163+
<param name="options">A bitwise combination of the enumeration values that specifies how to load the request.</param>
1164+
<param name="signerSignaturePadding">The RSA Signature Padding to use when creating a certificate from this request. For RSA signing certificates using the default signature generator, this parameter is required; otherwise, this parameter is ignored.</param>
1165+
<summary>Loads the first PEM-encoded PKCS#10 signing request from <paramref name="pkcs10Pem"/> as a new CertificateRequest instance.</summary>
1166+
<returns>A CertificateRequest instance which contains the information from the signing request.</returns>
11451167
<remarks>To be added.</remarks>
1168+
<exception cref="T:System.ArgumentException">
1169+
<paramref name="signerHashAlgorithm" />.<see cref="P:System.Security.Cryptography.HashAlgorithmName.Name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />.</exception>
1170+
<exception cref="T:System.ArgumentNullException"><paramref name="pkcs10" /> is <see langword="null" />.</exception>
1171+
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="options"/> specifies a value that is not supported.</exception>
1172+
<exception cref="T:System.Security.Cryptography.CryptographicException">
1173+
<paramref name="pkcs10Pem"/> does not contain a PKCS#10 signing request.
1174+
1175+
-or-
1176+
1177+
<paramref name="pkcs10Pem"/> is not a valid PKCS#10 signing request.
1178+
1179+
-or-
1180+
1181+
<paramref name="pkcs10Pem"/> contains a signature that could not be verified using its embedded public key.
1182+
</exception>
11461183
</Docs>
11471184
</Member>
11481185
<Member MemberName="LoadSigningRequestPem">
@@ -1172,13 +1209,28 @@ This object was created with a constructor which did not accept a signing key.
11721209
<Parameter Name="signerSignaturePadding" Type="System.Security.Cryptography.RSASignaturePadding" Index="3" FrameworkAlternate="net-7.0" />
11731210
</Parameters>
11741211
<Docs>
1175-
<param name="pkcs10Pem">To be added.</param>
1176-
<param name="signerHashAlgorithm">To be added.</param>
1177-
<param name="options">To be added.</param>
1178-
<param name="signerSignaturePadding">To be added.</param>
1179-
<summary>To be added.</summary>
1180-
<returns>To be added.</returns>
1212+
<param name="pkcs10Pem">The PEM-encoded PKCS#10 signing request to load.</param>
1213+
<param name="signerHashAlgorithm">The hash algorithm to use when creating a certificate or new signing request.</param>
1214+
<param name="options">A bitwise combination of the enumeration values that specifies how to load the request.</param>
1215+
<param name="signerSignaturePadding">The RSA Signature Padding to use when creating a certificate from this request. For RSA signing certificates using the default signature generator, this parameter is required; otherwise, this parameter is ignored.</param>
1216+
<summary>Loads the first PEM-encoded PKCS#10 signing request from <paramref name="pkcs10Pem"/> as a new CertificateRequest instance.</summary>
1217+
<returns>A CertificateRequest instance which contains the information from the signing request.</returns>
11811218
<remarks>To be added.</remarks>
1219+
<exception cref="T:System.ArgumentException">
1220+
<paramref name="signerHashAlgorithm" />.<see cref="P:System.Security.Cryptography.HashAlgorithmName.Name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />.</exception>
1221+
<exception cref="T:System.ArgumentNullException"><paramref name="pkcs10" /> is <see langword="null" />.</exception>
1222+
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="options"/> specifies a value that is not supported.</exception>
1223+
<exception cref="T:System.Security.Cryptography.CryptographicException">
1224+
<paramref name="pkcs10Pem"/> does not contain a PKCS#10 signing request.
1225+
1226+
-or-
1227+
1228+
<paramref name="pkcs10Pem"/> is not a valid PKCS#10 signing request.
1229+
1230+
-or-
1231+
1232+
<paramref name="pkcs10Pem"/> contains a signature that could not be verified using its embedded public key.
1233+
</exception>
11821234
</Docs>
11831235
</Member>
11841236
<Member MemberName="OtherRequestAttributes">

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
<Parameters />
3737
<Docs>
3838
<summary>Gets the object identifier (OID) identifying the single attribute value for this Relative Distinguished Name (RDN), when the RDN only contains one attribute.</summary>
39-
<returns>To be added.</returns>
39+
<returns>The object identifier (OID) identifying the single attribute value for this Relative Distinguished Name (RDN).</returns>
4040
<remarks>To be added.</remarks>
4141
<exception cref="T:System.InvalidOperationException">The Relative Distinguished Name has multiple attributes (<see cref="P:System.Security.Cryptography.X509Certificates.X500RelativeDistinguishedName.HasMultipleElements" />
4242
is <see langword="true" />).</exception>

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

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
17+
<summary>Represents the Subject Alternative Name X.509 Extension (2.5.29.17).</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>
@@ -31,7 +31,7 @@
3131
</AssemblyInfo>
3232
<Parameters />
3333
<Docs>
34-
<summary>To be added.</summary>
34+
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.X509Certificates.X509SubjectAlternativeNameExtension" /> class.</summary>
3535
<remarks>To be added.</remarks>
3636
</Docs>
3737
</Member>
@@ -51,10 +51,14 @@
5151
<Parameter Name="critical" Type="System.Boolean" />
5252
</Parameters>
5353
<Docs>
54-
<param name="rawData">To be added.</param>
55-
<param name="critical">To be added.</param>
56-
<summary>To be added.</summary>
54+
<param name="rawData">The encoded data used to create the extension.</param>
55+
<param name="critical"><see langword="true" /> if the extension is critical; otherwise, <see langword="false" />. The default is <see langword="false"/>.</param>
56+
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.X509Certificates.X509SubjectAlternativeNameExtension" /> class from an encoded representation of the extension and an optional critical marker.</summary>
5757
<remarks>To be added.</remarks>
58+
<exception cref="T:System.ArgumentNullException">
59+
<paramref name="rawData" /> is <see langword="null" />.</exception>
60+
<exception cref="T:System.Security.Cryptography.CryptographicException">
61+
<paramref name="rawData" /> did not decode as a Subject Alternative Name extension.</exception>
5862
</Docs>
5963
</Member>
6064
<Member MemberName=".ctor">
@@ -73,10 +77,12 @@
7377
<Parameter Name="critical" Type="System.Boolean" />
7478
</Parameters>
7579
<Docs>
76-
<param name="rawData">To be added.</param>
77-
<param name="critical">To be added.</param>
78-
<summary>To be added.</summary>
80+
<param name="rawData">The encoded data used to create the extension.</param>
81+
<param name="critical"><see langword="true" /> if the extension is critical; otherwise, <see langword="false" />. The default is <see langword="false"/>.</param>
82+
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.X509Certificates.X509SubjectAlternativeNameExtension" /> class from an encoded representation of the extension and an optional critical marker.</summary>
7983
<remarks>To be added.</remarks>
84+
<exception cref="T:System.Security.Cryptography.CryptographicException">
85+
<paramref name="rawData" /> did not decode as a Subject Alternative Name extension.</exception>
8086
</Docs>
8187
</Member>
8288
<Member MemberName="CopyFrom">
@@ -101,6 +107,7 @@
101107
<param name="asnEncodedData">To be added.</param>
102108
<summary>To be added.</summary>
103109
<remarks>To be added.</remarks>
110+
<inheritdoc />
104111
</Docs>
105112
</Member>
106113
<Member MemberName="EnumerateDnsNames">
@@ -120,9 +127,10 @@
120127
</ReturnValue>
121128
<Parameters />
122129
<Docs>
123-
<summary>To be added.</summary>
124-
<returns>To be added.</returns>
130+
<summary>Enumerates the alternative name entries with a DNS Name type identifier.</summary>
131+
<returns>The name entries with a DNS Name type identifier.</returns>
125132
<remarks>To be added.</remarks>
133+
<exception cref="T:System.Security.Cryptography.CryptographicException">The contents of the extension could not be decoded successfully.</exception>
126134
</Docs>
127135
</Member>
128136
<Member MemberName="EnumerateIPAddresses">
@@ -142,8 +150,8 @@
142150
</ReturnValue>
143151
<Parameters />
144152
<Docs>
145-
<summary>To be added.</summary>
146-
<returns>To be added.</returns>
153+
<summary>Enumerates the alternative name entries with an IP Address type identifier.</summary>
154+
<returns>The name entries with an IP Address type identifier.</returns>
147155
<remarks>To be added.</remarks>
148156
</Docs>
149157
</Member>

‎xml/System.Security.Cryptography/RSACng.xml‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1063,9 +1063,10 @@ any already open key is unaffected by this method.
10631063
<param name="destination">To be added.</param>
10641064
<param name="padding">To be added.</param>
10651065
<param name="bytesWritten">To be added.</param>
1066-
<summary>Decrypts data using the private key.</summary>
1066+
<summary>To be added.</summary>
10671067
<returns>To be added.</returns>
10681068
<remarks>To be added.</remarks>
1069+
<inheritdoc />
10691070
</Docs>
10701071
</Member>
10711072
<Member MemberName="TryEncrypt">
@@ -1097,9 +1098,10 @@ any already open key is unaffected by this method.
10971098
<param name="destination">To be added.</param>
10981099
<param name="padding">To be added.</param>
10991100
<param name="bytesWritten">To be added.</param>
1100-
<summary>Encrypts data using the public key.</summary>
1101+
<summary>To be added.</summary>
11011102
<returns>To be added.</returns>
11021103
<remarks>To be added.</remarks>
1104+
<inheritdoc />
11031105
</Docs>
11041106
</Member>
11051107
<Member MemberName="TryExportEncryptedPkcs8PrivateKey">

0 commit comments

Comments
 (0)