You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<summary>Represents an Advanced Encryption Standard (AES) key to be used with the Counter with CBC-MAC (CCM) mode of operation.</summary>
22
22
<remarks>To be added.</remarks>
23
23
</Docs>
24
24
<Members>
@@ -38,9 +38,11 @@
38
38
<ParameterName="key"Type="System.Byte[]" />
39
39
</Parameters>
40
40
<Docs>
41
-
<paramname="key">To be added.</param>
42
-
<summary>To be added.</summary>
41
+
<paramname="key">The secret key to use for this instance.</param>
42
+
<summary>Initializes a new instance of the <seecref="T:System.Security.Cryptography.AesCcm" /> class with a provided key.</summary>
43
43
<remarks>To be added.</remarks>
44
+
<exceptioncref="T:System.ArgumentNullException">The <paramrefname="key" /> parameter is <seelangword="null" />.</exception>
45
+
<exceptioncref="T:System.Security.Cryptography.CryptographicException">The <paramrefname="key" /> parameter length is other than 16, 24, or 32 bytes (128, 192, or 256 bits).</exception>
<paramname="key">The secret key to use for this instance.</param>
65
+
<summary>Initializes a new instance of the <seecref="T:System.Security.Cryptography.AesCcm" /> class with a provided key.</summary>
64
66
<remarks>To be added.</remarks>
67
+
<exceptioncref="T:System.Security.Cryptography.CryptographicException">The <paramrefname="key" /> parameter length is other than 16, 24, or 32 bytes (128, 192, or 256 bits).</exception>
<paramname="nonce">The nonce associated with this message, which must match the value provided during encryption.</param>
93
+
<paramname="ciphertext">The encrypted content to decrypt.</param>
94
+
<paramname="tag">The authentication tag produced for this message during encryption.</param>
95
+
<paramname="plaintext">The byte array to receive the decrypted contents.</param>
96
+
<paramname="associatedData">Extra data associated with this message, which must match the value provided during encryption.</param>
97
+
<summary>Decrypts the ciphertext into the provided destination buffer if the authentication tag can be validated.</summary>
98
+
<remarks>
99
+
<formattype="text/markdown"><![CDATA[
100
+
101
+
## Remarks
102
+
103
+
If `tag` cannot be validated (using the key, `nonce`, `ciphertext`, and `associatedData` values), then `plaintext` is cleared.
104
+
105
+
]]></format>
106
+
</remarks>
107
+
<exceptioncref="T:System.ArgumentException">The <paramrefname="plaintext" /> parameter and the <paramrefname="ciphertext" /> do not have the same length.
108
+
109
+
-or-
110
+
111
+
The <paramrefname="nonce"/> parameter length is not permitted by <seecref="P:System.Security.Cryptography.AesCcm.NonceByteSizes" />.
112
+
113
+
-or-
114
+
115
+
The <paramrefname="tag"/> parameter length is not permitted by <seecref="P:System.Security.Cryptography.AesCcm.TagByteSizes" />.</exception>
116
+
<exceptioncref="T:System.ArgumentNullException">The <paramrefname="nonce" />, <paramrefname="ciphertext" />, <paramrefname="tag" />, or <paramrefname="plaintext"/> parameter is <seelangword="null" />.</exception>
117
+
<exceptioncref="T:System.Security.Cryptography.CryptographicException">The tag value could not be verified, or the decryption operation otherwise failed.</exception>
<paramname="nonce">The nonce associated with this message, which must match the value provided during encryption.</param>
143
+
<paramname="ciphertext">The encrypted content to decrypt.</param>
144
+
<paramname="tag">The authentication tag produced for this message during encryption.</param>
145
+
<paramname="plaintext">The byte span to receive the decrypted contents.</param>
146
+
<paramname="associatedData">Extra data associated with this message, which must match the value provided during encryption.</param>
147
+
<summary>Decrypts the ciphertext into the provided destination buffer if the authentication tag can be validated.</summary>
148
+
<remarks>
149
+
<formattype="text/markdown"><![CDATA[
150
+
151
+
## Remarks
152
+
153
+
If `tag` cannot be validated (using the key, `nonce`, `ciphertext`, and `associatedData` values), then `plaintext` is cleared.
154
+
155
+
]]></format>
156
+
</remarks>
157
+
<exceptioncref="T:System.ArgumentException">The <paramrefname="plaintext" /> parameter and the <paramrefname="ciphertext" /> do not have the same length.
158
+
159
+
-or-
160
+
161
+
The <paramrefname="nonce"/> parameter length is not permitted by <seecref="P:System.Security.Cryptography.AesCcm.NonceByteSizes" />.
162
+
163
+
-or-
164
+
165
+
The <paramrefname="tag"/> parameter length is not permitted by <seecref="P:System.Security.Cryptography.AesCcm.TagByteSizes" />.</exception>
166
+
<exceptioncref="T:System.Security.Cryptography.CryptographicException">The tag value could not be verified, or the decryption operation otherwise failed.</exception>
127
167
</Docs>
128
168
</Member>
129
169
<MemberMemberName="Dispose">
@@ -146,7 +186,7 @@
146
186
</ReturnValue>
147
187
<Parameters />
148
188
<Docs>
149
-
<summary>To be added.</summary>
189
+
<summary>Releases the resources used by the current instance of the <seecref="T:System.Security.Cryptography.AesCcm" /> class.</summary>
<paramname="nonce">The nonce associated with this message, which should be a unique value for every operation with the same key.</param>
216
+
<paramname="plaintext">The content to encrypt.</param>
217
+
<paramname="tag">The byte array to receive the generated authentication tag.</param>
218
+
<paramname="ciphertext">The byte array to receive the encrypted contents.</param>
219
+
<paramname="associatedData">Extra data associated with this message, which must also be provided during decryption.</param>
220
+
<summary>Encrypts the plaintext into the ciphertext destination buffer and generates the authentication tag into a separate buffer.</summary>
221
+
<remarks>
222
+
<formattype="text/markdown"><![CDATA[
223
+
224
+
## Remarks
225
+
226
+
The security guarantees of the AES-CCM algorithm mode require that the same nonce value is never used twice with the same key.
227
+
228
+
]]></format>
229
+
</remarks>
230
+
<exceptioncref="T:System.ArgumentException">The <paramrefname="plaintext" /> parameter and the <paramrefname="ciphertext" /> do not have the same length.
231
+
232
+
-or-
233
+
234
+
The <paramrefname="nonce"/> parameter length is not permitted by <seecref="P:System.Security.Cryptography.AesCcm.NonceByteSizes" />.
235
+
236
+
-or-
237
+
238
+
The <paramrefname="tag"/> parameter length is not permitted by <seecref="P:System.Security.Cryptography.AesCcm.TagByteSizes" />.</exception>
239
+
<exceptioncref="T:System.ArgumentNullException">The <paramrefname="nonce" />, <paramrefname="ciphertext" />, <paramrefname="tag" />, or <paramrefname="plaintext"/> parameter is <seelangword="null" />.</exception>
<paramname="nonce">The nonce associated with this message, which should be a unique value for every operation with the same key.</param>
266
+
<paramname="plaintext">The content to encrypt.</param>
267
+
<paramname="tag">The byte span to receive the generated authentication tag.</param>
268
+
<paramname="ciphertext">The byte span to receive the encrypted contents.</param>
269
+
<paramname="associatedData">Extra data associated with this message, which must also be provided during decryption.</param>
270
+
<summary>Encrypts the plaintext into the ciphertext destination buffer and generates the authentication tag into a separate buffer.</summary>
271
+
<remarks>
272
+
<formattype="text/markdown"><![CDATA[
273
+
274
+
## Remarks
275
+
276
+
The security guarantees of the AES-CCM algorithm mode require that the same nonce value is never used twice with the same key.
277
+
278
+
]]></format>
279
+
</remarks>
280
+
<exceptioncref="T:System.ArgumentException">The <paramrefname="plaintext" /> parameter and the <paramrefname="ciphertext" /> do not have the same length.
281
+
282
+
-or-
283
+
284
+
The <paramrefname="nonce"/> parameter length is not permitted by <seecref="P:System.Security.Cryptography.AesCcm.NonceByteSizes" />.
285
+
286
+
-or-
287
+
288
+
The <paramrefname="tag"/> parameter length is not permitted by <seecref="P:System.Security.Cryptography.AesCcm.TagByteSizes" />.</exception>
0 commit comments