Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
CspKeyContainerInfo Class
Collapse the table of content
Expand the table of content

CspKeyContainerInfo Class

Provides additional information about a cryptographic key pair. This class cannot be inherited.


Namespace:  System.Security.Cryptography
Assembly:  mscorlib (in mscorlib.dll)

public sealed class CspKeyContainerInfo

The CspKeyContainerInfo type exposes the following members.

Public methodCspKeyContainerInfoInitializes a new instance of the CspKeyContainerInfo class using the specified parameters.

Public propertyAccessibleGets a value indicating whether a key in a key container is accessible.
Public propertyCryptoKeySecurityGets a CryptoKeySecurity object that represents access rights and audit rules for a container.
Public propertyExportableGets a value indicating whether a key can be exported from a key container.
Public propertyHardwareDeviceGets a value indicating whether a key is a hardware key.
Public propertyKeyContainerNameGets a key container name.
Public propertyKeyNumberGets a value that describes whether an asymmetric key was created as a signature key or an exchange key.
Public propertyMachineKeyStoreGets a value indicating whether a key is from a machine key set.
Public propertyProtectedGets a value indicating whether a key pair is protected.
Public propertyProviderNameGets the provider name of a key.
Public propertyProviderTypeGets the provider type of a key.
Public propertyRandomlyGeneratedGets a value indicating whether a key container was randomly generated by a managed cryptography class.
Public propertyRemovableGets a value indicating whether a key can be removed from a key container.
Public propertyUniqueKeyContainerNameGets a unique key container name.

Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Use this class to obtain additional information about a key pair, such as the key container name or the key number.

In cases where a random key is generated by the RSACryptoServiceProvider or the DSACryptoServiceProvider, a key container will not be created until you call a method that uses the key. Some properties of the CspKeyContainerInfo class will throw a CryptographicException if a key container has not been created.

The following code example creates a key container and retrieves information about that container.

using System;
using System.Security.Cryptography;
using System.Text;

public class CspKeyContainerInfoExample

    public static void Main(String[] args)
        RSACryptoServiceProvider rsa= new RSACryptoServiceProvider();

            // Note: In cases where a random key is generated,    
            // a key container is not created until you call   
            // a method that uses the key.  This example calls 
            // the Encrypt method before calling the 
            // CspKeyContainerInfo property so that a key 
            // container is created.   

            // Create some data to encrypt and display it. 
            string data = "Here is some data to encrypt.";

            Console.WriteLine("Data to encrypt: " + data);

            // Convert the data to an array of bytes and  
            // encrypt it. 
            byte[] byteData = Encoding.ASCII.GetBytes(data);

            byte[] encData = rsa.Encrypt(byteData, false);

            // Display the encrypted value.
            Console.WriteLine("Encrypted Data: " + Encoding.ASCII.GetString(encData));


            Console.WriteLine("CspKeyContainerInfo information:");


            // Create a new CspKeyContainerInfo object.
            CspKeyContainerInfo keyInfo = rsa.CspKeyContainerInfo;

            // Display the value of each property.

            Console.WriteLine("Accessible property: " + keyInfo.Accessible);

            Console.WriteLine("Exportable property: " + keyInfo.Exportable);

            Console.WriteLine("HardwareDevice property: " + keyInfo.HardwareDevice);

            Console.WriteLine("KeyContainerName property: " + keyInfo.KeyContainerName);

            Console.WriteLine("KeyNumber property: " + keyInfo.KeyNumber.ToString());

            Console.WriteLine("MachineKeyStore property: " + keyInfo.MachineKeyStore);

            Console.WriteLine("Protected property: " + keyInfo.Protected);

            Console.WriteLine("ProviderName property: " + keyInfo.ProviderName);

            Console.WriteLine("ProviderType property: " + keyInfo.ProviderType);

            Console.WriteLine("RandomlyGenerated property: " + keyInfo.RandomlyGenerated);

            Console.WriteLine("Removable property: " + keyInfo.Removable);

            Console.WriteLine("UniqueKeyContainerName property: " + keyInfo.UniqueKeyContainerName);

        catch (Exception e)
            // Clear the key.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
© 2015 Microsoft