CryptoConfig Class

Definition

Accesses the cryptography configuration information.

C#
[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public class CryptoConfig
C#
public class CryptoConfig
C#
[System.Runtime.InteropServices.ComVisible(true)]
public class CryptoConfig
Inheritance
CryptoConfig
Attributes

Examples

The following code example demonstrates how to use members of the CryptoConfig class.

C#
using System;
using System.Security.Cryptography;

class Members
{
    static void Main(string[] args)
    {
        // Create a CryptoConfig object to store configuration information.
        CryptoConfig cryptoConfig = new CryptoConfig();

        // Retrieve the class path for CryptoConfig.
        string classDescription = cryptoConfig.ToString();

        // Create a new SHA1 provider.
        // This example uses the SHA1 algorithm.
        // Due to collision problems with SHA1, Microsoft recommends SHA256 or better.
        SHA1CryptoServiceProvider SHA1alg = 
            (SHA1CryptoServiceProvider)CryptoConfig.CreateFromName("SHA1");

        // Create an RSAParameters with the TestContainer key container.
        CspParameters parameters = new CspParameters();
        parameters.KeyContainerName = "TestContainer";
        Object[] argsArray = new Object[] {parameters};

        // Instantiate the RSA provider instance accessing the TestContainer
        // key container.
        RSA rsa = (RSA)
            CryptoConfig.CreateFromName("RSA",argsArray);

        // Use the MapNameToOID method to get an object identifier  
        // (OID) from the string name of the SHA1 algorithm.
        // This example uses the SHA1 algorithm.
        // Due to collision problems with SHA1, Microsoft recommends SHA256 or better.
        string sha1Oid = CryptoConfig.MapNameToOID("SHA1");

        // Encode the specified object identifier.
        // This example uses the SHA1 algorithm.
        // Due to collision problems with SHA1, Microsoft recommends SHA256 or better.
        byte[] encodedMessage = CryptoConfig.EncodeOID(sha1Oid);

        // Display the results to the console.
        Console.WriteLine("** " + classDescription + " **");
        Console.WriteLine("Created an RSA provider " + 
            "with a KeyContainerName called " + parameters.KeyContainerName +
            ".");
        Console.WriteLine("Object identifier from the SHA1 name:" + sha1Oid);
        Console.WriteLine("The object identifier encoded: " + 
            System.Text.Encoding.ASCII.GetString(encodedMessage));
        Console.WriteLine("This sample completed successfully; " +
            "press Enter to exit.");
        Console.ReadLine();
    }
}
//
// This sample produces the following output:
//
// ** System.Security.Cryptography.CryptoConfig **
// Created an RSA provider with a KeyContainerName called TestContainer.
// Object identifier from the SHA1 name:1.3.14.3.2.26
// The object identifier encoded: HH*((*H9
// This sample completed successfully; press Enter to exit.

Remarks

The following table shows the simple names recognized by this class and the default algorithm implementations to which they map. Alternatively, you can map other implementations to these names, as described in Mapping Algorithm Names to Cryptography Classes.

Simple name Algorithm implementation
3DES, Triple DES, TripleDES, System.Security.Cryptography.TripleDES TripleDESCryptoServiceProvider
AES, System.Security.Cryptography.AesCryptoServiceProvider AesCryptoServiceProvider
AesManaged, System.Security.Cryptography.AesManaged AesManaged
System.Security.Cryptography.AsymmetricAlgorithm RSACryptoServiceProvider
DES, System.Security.Cryptography.DES DESCryptoServiceProvider
DSA, System.Security.Cryptography.DSA DSACryptoServiceProvider
ECDH, ECDiffieHellman, ECDiffieHellmanCng, System.Security.Cryptography.ECDiffieHellmanCng ECDiffieHellmanCng
ECDsa, ECDsaCng, System.Security.Cryptography.ECDsaCng ECDsaCng
System.Security.Cryptography.HashAlgorithm SHA1CryptoServiceProvider
HMAC, System.Security.Cryptography.HMAC HMACSHA1
HMACMD5, System.Security.Cryptography.HMACMD5 HMACMD5
HMACRIPEMD160, System.Security.Cryptography.HMACRIPEMD160 HMACRIPEMD160
HMACSHA1, System.Security.Cryptography.HMACSHA1 HMACSHA1
HMACSHA256, System.Security.Cryptography.HMACSHA256 HMACSHA256
HMACSHA384, System.Security.Cryptography.HMACSHA384 HMACSHA384
HMACSHA512, System.Security.Cryptography.HMACSHA512 HMACSHA512
System.Security.Cryptography.KeyedHashAlgorithm HMACSHA1
MACTripleDES, System.Security.Cryptography.MACTripleDES MACTripleDES
MD5, System.Security.Cryptography.MD5 MD5CryptoServiceProvider
System.Security.Cryptography.MD5Cng MD5Cng
RandomNumberGenerator RNGCryptoServiceProvider
RC2, System.Security.Cryptography.RC2 RC2CryptoServiceProvider
Rijndael, System.Security.Cryptography.Rijndael RijndaelManaged
RIPEMD160, RIPEMD-160, System.Security.Cryptography.RIPEMD160Managed RIPEMD160Managed
RSA, System.Security.Cryptography.RSA RSACryptoServiceProvider
SHA, SHA1, System.Security.Cryptography.SHA1 SHA1CryptoServiceProvider
System.Security.Cryptography.SHA1Cng SHA1Cng
SHA256, SHA-256, System.Security.Cryptography.SHA256 SHA256Managed
System.Security.Cryptography.SHA256Cng SHA256Cng
System.Security.Cryptography.SHA256CryptoServiceProvider SHA256CryptoServiceProvider
SHA384, SHA-384, System.Security.Cryptography.SHA384 SHA384Managed
System.Security.Cryptography.SHA384Cng SHA384Cng
System.Security.Cryptography.SHA384CryptoServiceProvider SHA384CryptoServiceProvider
SHA512, SHA-512, System.Security.Cryptography.SHA512 SHA512Managed
System.Security.Cryptography.SHA512Cng SHA512Cng
System.Security.Cryptography.SHA512CryptoServiceProvider SHA512CryptoServiceProvider
System.Security.Cryptography.SymmetricAlgorithm RijndaelManaged

Constructors

CryptoConfig()

Initializes a new instance of the CryptoConfig class.

Properties

AllowOnlyFipsAlgorithms

Indicates whether the runtime should enforce the policy to create only Federal Information Processing Standard (FIPS) certified algorithms.

Methods

AddAlgorithm(Type, String[])

Adds a set of names to algorithm mappings to be used for the current application domain.

AddOID(String, String[])

Adds a set of names to object identifier (OID) mappings to be used for the current application domain.

CreateFromName(String, Object[])

Creates a new instance of the specified cryptographic object with the specified arguments.

CreateFromName(String)

Creates a new instance of the specified cryptographic object.

EncodeOID(String)
Obsolete.

Encodes the specified object identifier (OID).

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MapNameToOID(String)

Gets the object identifier (OID) of the algorithm corresponding to the specified simple name.

MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

Product Versions
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1

See also