Skip to content

Merge main into live #10475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 1, 2024
Merged

Merge main into live #10475

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
15dfa29
Fix use of CryptoStream examples (#10470)
vcsjones Sep 30, 2024
6139eea
Fix AEAD algorithm documentation to indicate when AuthenticationTagMi…
vcsjones Sep 30, 2024
45b1ff3
Remove over-specific and incorrect documentation about HMAC key lengths
vcsjones Sep 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion snippets/csharp/System.Security.Cryptography/Aes/Overview/program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,9 @@ static byte[] EncryptStringToBytes_Aes(string plainText, byte[] Key, byte[] IV)
//Write all data to the stream.
swEncrypt.Write(plainText);
}
encrypted = msEncrypt.ToArray();
}

encrypted = msEncrypt.ToArray();
}
}

Expand Down
5 changes: 3 additions & 2 deletions snippets/csharp/System.Security.Cryptography/AesCryptoServiceProvider/Overview/program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,9 @@ static byte[] EncryptStringToBytes_Aes(string plainText, byte[] Key, byte[] IV)
//Write all data to the stream.
swEncrypt.Write(plainText);
}
encrypted = msEncrypt.ToArray();
}

encrypted = msEncrypt.ToArray();
}
}

Expand Down Expand Up @@ -115,4 +116,4 @@ static string DecryptStringFromBytes_Aes(byte[] cipherText, byte[] Key, byte[] I
//</Snippet3>
}
}
//</Snippet1>
//</Snippet1>
5 changes: 3 additions & 2 deletions snippets/csharp/System.Security.Cryptography/AesManaged/Overview/program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,9 @@ static byte[] EncryptStringToBytes_Aes(string plainText, byte[] Key, byte[] IV)
//Write all data to the stream.
swEncrypt.Write(plainText);
}
encrypted = msEncrypt.ToArray();
}

encrypted = msEncrypt.ToArray();
}
}

Expand Down Expand Up @@ -115,4 +116,4 @@ static string DecryptStringFromBytes_Aes(byte[] cipherText, byte[] Key, byte[] I
//</Snippet3>
}
}
//</Snippet1>
//</Snippet1>
3 changes: 2 additions & 1 deletion snippets/csharp/System.Security.Cryptography/RijndaelManaged/Overview/class1.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,9 @@ static byte[] EncryptStringToBytes(string plainText, byte[] Key, byte[] IV)
//Write all data to the stream.
swEncrypt.Write(plainText);
}
encrypted = msEncrypt.ToArray();
}

encrypted = msEncrypt.ToArray();
}
}

Expand Down
6 changes: 4 additions & 2 deletions xml/System.Security.Cryptography/AesCcm.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,8 @@ The <paramref name="nonce" /> parameter length is not permitted by <see cref="P:

The <paramref name="tag" /> parameter length is not permitted by <see cref="P:System.Security.Cryptography.AesCcm.TagByteSizes" />.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="nonce" />, <paramref name="ciphertext" />, <paramref name="tag" />, or <paramref name="plaintext" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The tag value could not be verified, or the decryption operation otherwise failed.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The decryption operation failed. Prior to .NET 8, indicates the tag value could not be verified.</exception>
<exception cref="T:System.Security.Cryptography.AuthenticationTagMismatchException">.NET 8 and later versions: the tag value could not be verified.</exception>
</Docs>
</Member>
<Member MemberName="Decrypt">
Expand Down Expand Up @@ -280,7 +281,8 @@ The <paramref name="nonce" /> parameter length is not permitted by <see cref="P:
-or-

The <paramref name="tag" /> parameter length is not permitted by <see cref="P:System.Security.Cryptography.AesCcm.TagByteSizes" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The tag value could not be verified, or the decryption operation otherwise failed.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The decryption operation failed. Prior to .NET 8, indicates the tag value could not be verified.</exception>
<exception cref="T:System.Security.Cryptography.AuthenticationTagMismatchException">.NET 8 and later versions: the tag value could not be verified.</exception>
</Docs>
</Member>
<Member MemberName="Dispose">
Expand Down
6 changes: 4 additions & 2 deletions xml/System.Security.Cryptography/AesGcm.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,8 @@ The <paramref name="nonce" /> parameter length is not permitted by <see cref="P:

The <paramref name="tag" /> parameter length is not permitted by <see cref="P:System.Security.Cryptography.AesGcm.TagByteSizes" />.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="nonce" />, <paramref name="ciphertext" />, <paramref name="tag" />, or <paramref name="plaintext" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The tag value could not be verified, or the decryption operation otherwise failed.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The decryption operation failed. Prior to .NET 8, indicates the tag value could not be verified.</exception>
<exception cref="T:System.Security.Cryptography.AuthenticationTagMismatchException">.NET 8 and later versions: the tag value could not be verified.</exception>
</Docs>
</Member>
<Member MemberName="Decrypt">
Expand Down Expand Up @@ -373,7 +374,8 @@ The <paramref name="nonce" /> parameter length is not permitted by <see cref="P:
-or-

The <paramref name="tag" /> parameter length is not permitted by <see cref="P:System.Security.Cryptography.AesGcm.TagByteSizes" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The tag value could not be verified, or the decryption operation otherwise failed.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The decryption operation failed. Prior to .NET 8, indicates the tag value could not be verified.</exception>
<exception cref="T:System.Security.Cryptography.AuthenticationTagMismatchException">.NET 8 and later versions: the tag value could not be verified.</exception>
</Docs>
</Member>
<Member MemberName="Dispose">
Expand Down
6 changes: 4 additions & 2 deletions xml/System.Security.Cryptography/ChaCha20Poly1305.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,8 @@ The <paramref name="nonce" /> parameter length is not 12 bytes (96 bits).

The <paramref name="tag" /> parameter length is not 16 bytes (128 bits).</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="nonce" />, <paramref name="ciphertext" />, <paramref name="tag" />, or <paramref name="plaintext" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The tag value could not be verified, or the decryption operation otherwise failed.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The decryption operation failed. Prior to .NET 8, indicates the tag value could not be verified.</exception>
<exception cref="T:System.Security.Cryptography.AuthenticationTagMismatchException">.NET 8 and later versions: the tag value could not be verified.</exception>
</Docs>
</Member>
<Member MemberName="Decrypt">
Expand Down Expand Up @@ -238,7 +239,8 @@ The <paramref name="nonce" /> parameter length is not 12 bytes (96 bits).
-or-

The <paramref name="tag" /> parameter length is not 16 bytes (128 bits).</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The tag value could not be verified, or the decryption operation otherwise failed.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The decryption operation failed. Prior to .NET 8, indicates the tag value could not be verified.</exception>
<exception cref="T:System.Security.Cryptography.AuthenticationTagMismatchException">.NET 8 and later versions: the tag value could not be verified.</exception>
</Docs>
</Member>
<Member MemberName="Dispose">
Expand Down
10 changes: 2 additions & 8 deletions xml/System.Security.Cryptography/IncrementalHash.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -449,13 +449,7 @@
</Parameters>
<Docs>
<param name="hashAlgorithm">The name of the hash algorithm to perform within the HMAC.</param>
<param name="key">
The secret key for the HMAC. The key can be any length, but a key longer than the output size
of the hash algorithm specified by <paramref name="hashAlgorithm" /> will be hashed (using the
algorithm specified by <paramref name="hashAlgorithm" />) to derive a correctly-sized key. Therefore,
the recommended size of the secret key is the output size of the hash specified by
<paramref name="hashAlgorithm" />.
</param>
<param name="key">The secret key for the HMAC.</param>
<summary>
Create an <see cref="T:System.Security.Cryptography.IncrementalHash" /> for the Hash-based Message Authentication Code (HMAC)
algorithm utilizing the hash algorithm specified by <paramref name="hashAlgorithm" />, and a
Expand Down Expand Up @@ -513,7 +507,7 @@
</Parameters>
<Docs>
<param name="hashAlgorithm">The name of the hash algorithm to perform within the HMAC.</param>
<param name="key">The secret key for the HMAC. The key can be any length, but a key longer than the output size of the hash algorithm specified by <paramref name="hashAlgorithm" /> will be hashed (using the algorithm specified by <paramref name="hashAlgorithm" />) to derive a correctly-sized key. Therefore, the recommended size of the secret key is the output size of the hash specified by <paramref name="hashAlgorithm" />.</param>
<param name="key">The secret key for the HMAC.</param>
<summary>Create an <see cref="T:System.Security.Cryptography.IncrementalHash" /> for the Hash-based Message Authentication Code (HMAC) algorithm utilizing the hash algorithm specified by <paramref name="hashAlgorithm" />, and a key specified by <paramref name="key" />.</summary>
<returns>A hash instance to compute the hash algorithm specified by <paramref name="hashAlgorithm" />.</returns>
<remarks>To be added.</remarks>
Expand Down
Loading