diff --git a/xml/System.Diagnostics/Stopwatch.xml b/xml/System.Diagnostics/Stopwatch.xml index 69219b67942..2cbb38255c6 100644 --- a/xml/System.Diagnostics/Stopwatch.xml +++ b/xml/System.Diagnostics/Stopwatch.xml @@ -437,7 +437,7 @@ class uses a high-resolution performance counter, returns the current value of that counter. If the class uses the system timer, returns the current property of the instance. + If the class uses a high-resolution performance counter, returns the current value of that counter. If the class uses the system timer, returns the current property of the instance. diff --git a/xml/System.Security.Cryptography/DESCryptoServiceProvider.xml b/xml/System.Security.Cryptography/DESCryptoServiceProvider.xml index 799aa09d2d6..86dc495b2ed 100644 --- a/xml/System.Security.Cryptography/DESCryptoServiceProvider.xml +++ b/xml/System.Security.Cryptography/DESCryptoServiceProvider.xml @@ -49,8 +49,9 @@ ## Remarks This algorithm supports a key length of 64 bits. - - +> [!IMPORTANT] +> A newer symmetric encryption algorithm, Advanced Encryption Standard (AES), is available. Consider using the class instead of the class. Use only for compatibility with legacy applications and data. + ## Examples The following code example uses (an implementation of ) with the specified key () and initialization vector () to encrypt a file specified by `inName`. It then outputs the encrypted result to the file specified by `outName`. diff --git a/xml/System.Security.Cryptography/DSA.xml b/xml/System.Security.Cryptography/DSA.xml index 44ea2b33cdc..cd7828892f2 100644 --- a/xml/System.Security.Cryptography/DSA.xml +++ b/xml/System.Security.Cryptography/DSA.xml @@ -48,7 +48,7 @@ To use a public-key system to digitally sign a message, the sender first applies a hash function to the message to create a message digest. The sender then encrypts the message digest with the sender's private key to create the sender's personal signature. Upon receiving the message and signature, the receiver decrypts the signature using the sender's public key to recover the message digest and hashes the message using the same hash algorithm that the sender used. If the message digest that the receiver computes exactly matches the message digest received from the sender, the receiver can assume that the message was not altered while in transit. Note that a signature can be verified by anyone, because the sender's public key is common knowledge. > [!IMPORTANT] -> Newer asymmetric algorithms are available. Consider using the class or the class instead of the class. Use only for compatibility with legacy applications and data. +> The creators of the DSA algorithm have withdrawn their support for it. Consider using the class or the class instead of the class. Use only for compatibility with legacy applications and data. Two different versions of the DSA algorithm exist. The original form, described in FIPS 186-2, requires the use of SHA-1 as the hash algorithm and supports key lengths from 512 bits to 1024 bits in increments of 64 bits. diff --git a/xml/System.Security.Cryptography/DSACng.xml b/xml/System.Security.Cryptography/DSACng.xml index 46332a47615..b6a731f89ff 100644 --- a/xml/System.Security.Cryptography/DSACng.xml +++ b/xml/System.Security.Cryptography/DSACng.xml @@ -90,8 +90,11 @@ [!IMPORTANT] +> The creators of the DSA algorithm have withdrawn their support for it. Consider using the class or the class instead of the class. Use only for compatibility with legacy applications and data. + ]]> diff --git a/xml/System.Security.Cryptography/DSACryptoServiceProvider.xml b/xml/System.Security.Cryptography/DSACryptoServiceProvider.xml index 9476880639b..47631ab2e98 100644 --- a/xml/System.Security.Cryptography/DSACryptoServiceProvider.xml +++ b/xml/System.Security.Cryptography/DSACryptoServiceProvider.xml @@ -57,7 +57,7 @@ To use a public-key system to digitally sign a message, the sender first applies a hash function to the message to create a message digest. The sender then encrypts the message digest with the sender's private key to create the sender's personal signature. Upon receiving the message and signature, the receiver decrypts the signature using the sender's public key to recover the message digest and hashes the message using the same hash algorithm that the sender used. If the message digest that the receiver computes exactly matches the message digest received from the sender, the receiver can be sure that the message was not altered while in transit. Note that a signature can be verified by anyone, because the sender's public key is common knowledge. > [!NOTE] -> Newer asymmetric algorithms are available. Consider using the class instead of the class. Use only for compatibility with legacy applications and data. +> The creators of the DSA algorithm have withdrawn their support for it. Consider using the class instead of the class. Use only for compatibility with legacy applications and data. This algorithm supports key lengths from 512 bits to 1024 bits in increments of 64 bits. diff --git a/xml/System.Security.Cryptography/DSAOpenSsl.xml b/xml/System.Security.Cryptography/DSAOpenSsl.xml index ef21000f981..991bae218d4 100644 --- a/xml/System.Security.Cryptography/DSAOpenSsl.xml +++ b/xml/System.Security.Cryptography/DSAOpenSsl.xml @@ -27,7 +27,7 @@ This class should only be used directly when doing platform interop with the system OpenSSL library. When platform interop is not needed, you should use the factory methods instead of a specific derived implementation. > [!IMPORTANT] -> Newer asymmetric algorithms are available. Consider using the class or the class instead of the class. Use only for compatibility with legacy applications and data. +> The creators of the DSA algorithm have withdrawn their support for it. Consider using the class or the class instead of the class. Use only for compatibility with legacy applications and data. DSAOpenSSL provides the FIPS 186-3 version of DSA. diff --git a/xml/System.Security.Cryptography/DSAParameters.xml b/xml/System.Security.Cryptography/DSAParameters.xml index 4de7bbafcff..eee17746184 100644 --- a/xml/System.Security.Cryptography/DSAParameters.xml +++ b/xml/System.Security.Cryptography/DSAParameters.xml @@ -44,7 +44,16 @@ Contains the typical parameters for the algorithm. - To be added. + + [!IMPORTANT] +> The creators of the DSA algorithm have withdrawn their support for it. Consider using the class or the class instead of the class. Use only for compatibility with legacy applications and data. + + ]]> + Cryptographic Services diff --git a/xml/System.Security.Cryptography/DSASignatureDeformatter.xml b/xml/System.Security.Cryptography/DSASignatureDeformatter.xml index 2623babf6f3..4b3f832c48e 100644 --- a/xml/System.Security.Cryptography/DSASignatureDeformatter.xml +++ b/xml/System.Security.Cryptography/DSASignatureDeformatter.xml @@ -42,6 +42,11 @@ [!IMPORTANT] +> The creators of the DSA algorithm have withdrawn their support for it. Consider using the class or the class instead of the class. Use only for compatibility with legacy applications and data. + ## Examples [!code-cpp[System.Security.Cryptography.DSASignatureDeformatter#1](~/samples/snippets/cpp/VS_Snippets_CLR_System/system.Security.Cryptography.DSASignatureDeformatter/CPP/sample.cpp#1)] [!code-csharp[System.Security.Cryptography.DSASignatureDeformatter#1](~/samples/snippets/csharp/VS_Snippets_CLR_System/system.Security.Cryptography.DSASignatureDeformatter/CS/sample.cs#1)] diff --git a/xml/System.Security.Cryptography/DSASignatureFormat.xml b/xml/System.Security.Cryptography/DSASignatureFormat.xml index 396634168e2..5676a239434 100644 --- a/xml/System.Security.Cryptography/DSASignatureFormat.xml +++ b/xml/System.Security.Cryptography/DSASignatureFormat.xml @@ -14,7 +14,16 @@ To be added. - To be added. + + [!IMPORTANT] +> The creators of the DSA algorithm have withdrawn their support for it. Consider using the class or the class instead of the class. Use only for compatibility with legacy applications and data. + + ]]> + diff --git a/xml/System.Security.Cryptography/DSASignatureFormatter.xml b/xml/System.Security.Cryptography/DSASignatureFormatter.xml index 3c00c8aff32..ccd870d2e7e 100644 --- a/xml/System.Security.Cryptography/DSASignatureFormatter.xml +++ b/xml/System.Security.Cryptography/DSASignatureFormatter.xml @@ -41,6 +41,11 @@ Creates a Digital Signature Algorithm () signature. [!IMPORTANT] +> The creators of the DSA algorithm have withdrawn their support for it. Consider using the class or the class instead of the class. Use only for compatibility with legacy applications and data. ## Examples [!code-cpp[System.Security.Cryptography.DSASignatureFormatter#1](~/samples/snippets/cpp/VS_Snippets_CLR_System/system.Security.Cryptography.DSASignatureFormatter/CPP/sample.cpp#1)] diff --git a/xml/System.Security.Cryptography/Rijndael.xml b/xml/System.Security.Cryptography/Rijndael.xml index 68b86b4fe00..11ad68b7c9b 100644 --- a/xml/System.Security.Cryptography/Rijndael.xml +++ b/xml/System.Security.Cryptography/Rijndael.xml @@ -47,11 +47,10 @@ -compatible). - - The class is the predecessor of the algorithm. You should use the algorithm instead of . For more information, see the entry [The Differences Between Rijndael and AES](https://docs.microsoft.com/archive/blogs/shawnfa/the-differences-between-rijndael-and-aes) in the .NET Security blog. - - + This algorithm supports key lengths of 128, 192, or 256 bits; defaulting to 256 bits. This algorithm supports block sizes of 128, 192, or 256 bits; defaulting to 128 bits (-compatible). + +> [!IMPORTANT] +> The class is the predecessor of the algorithm. You should use the algorithm instead of . For more information, see the entry [The Differences Between Rijndael and AES](https://docs.microsoft.com/archive/blogs/shawnfa/the-differences-between-rijndael-and-aes) in the .NET Security blog. ## Examples The following code example uses the class to encrypt and then decrypt data. diff --git a/xml/System.Security.Cryptography/RijndaelManaged.xml b/xml/System.Security.Cryptography/RijndaelManaged.xml index 827d32cc554..aa055b04ecd 100644 --- a/xml/System.Security.Cryptography/RijndaelManaged.xml +++ b/xml/System.Security.Cryptography/RijndaelManaged.xml @@ -49,9 +49,8 @@ ## Remarks This algorithm supports key lengths of 128, 192, or 256 bits; defaulting to 256 bits. In .NET Framework, this algorithm supports block sizes of 128, 192, or 256 bits; defaulting to 128 bits (-compatible). In .NET Core, it is the same as AES and supports only a 128-bit block size. - The algorithm is the predecessor of . You should use the class instead of . For more information, see the entry [The Differences Between Rijndael and AES](https://go.microsoft.com/fwlink/?LinkId=200932) in the .NET Security blog. - - +> [!IMPORTANT] +> The class is the predecessor of the algorithm. You should use the algorithm instead of . For more information, see the entry [The Differences Between Rijndael and AES](https://docs.microsoft.com/archive/blogs/shawnfa/the-differences-between-rijndael-and-aes) in the .NET Security blog. ## Examples The following example demonstrates how to encrypt and decrypt sample data using the `RijndaelManaged` class. diff --git a/xml/System.Security.Cryptography/RijndaelManagedTransform.xml b/xml/System.Security.Cryptography/RijndaelManagedTransform.xml index 36e08b5ceea..8a6aa127fe0 100644 --- a/xml/System.Security.Cryptography/RijndaelManagedTransform.xml +++ b/xml/System.Security.Cryptography/RijndaelManagedTransform.xml @@ -34,9 +34,11 @@ [!NOTE] -> Using this class is not recommended. A better practice is to use with a object. The object handles the padding issues that can occur when using directly. For an example, see the class. + +> [!IMPORTANT] +> The class is the predecessor of the algorithm. You should use the algorithm instead of . For more information, see the entry [The Differences Between Rijndael and AES](https://docs.microsoft.com/archive/blogs/shawnfa/the-differences-between-rijndael-and-aes) in the .NET Security blog. +> +> Using this class is not recommended. If you use the `Rijndael` algorithm, a better practice is to use with a object. The object handles the padding issues that can occur when using directly. For an example, see the class. Both the and methods return an instance of the class that is initialized with the key information of the current object. To encrypt or decrypt data using the Rijndael algorithm, pass the object returned by these methods to a object. diff --git a/xml/System.Security.Cryptography/TripleDESCng.xml b/xml/System.Security.Cryptography/TripleDESCng.xml index 0414adfc3b7..10d59908b9c 100644 --- a/xml/System.Security.Cryptography/TripleDESCng.xml +++ b/xml/System.Security.Cryptography/TripleDESCng.xml @@ -29,7 +29,16 @@ Provides a Cryptography Next Generation (CNG) implementation of the Triple Data Encryption Standard (3DES) algorithm. - To be added. + + [!IMPORTANT] +> A newer symmetric encryption algorithm, Advanced Encryption Standard (AES), is available. Consider using the class and its derived classes instead of the class. Use only for compatibility with legacy applications and data. + + ]]> +