CspKeyContainerInfo Class

 

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

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

System.Object
  System.Security.Cryptography.CspKeyContainerInfo

[ComVisibleAttribute(true)]
public sealed class CspKeyContainerInfo

NameDescription
System_CAPS_pubmethodCspKeyContainerInfo(CspParameters)

Initializes a new instance of the CspKeyContainerInfo class using the specified parameters.

NameDescription
System_CAPS_pubpropertyAccessible

Gets a value indicating whether a key in a key container is accessible.

System_CAPS_pubpropertyCryptoKeySecurity

Gets a CryptoKeySecurity object that represents access rights and audit rules for a container.

System_CAPS_pubpropertyExportable

Gets a value indicating whether a key can be exported from a key container.

System_CAPS_pubpropertyHardwareDevice

Gets a value indicating whether a key is a hardware key.

System_CAPS_pubpropertyKeyContainerName

Gets a key container name.

System_CAPS_pubpropertyKeyNumber

Gets a value that describes whether an asymmetric key was created as a signature key or an exchange key.

System_CAPS_pubpropertyMachineKeyStore

Gets a value indicating whether a key is from a machine key set.

System_CAPS_pubpropertyProtected

Gets a value indicating whether a key pair is protected.

System_CAPS_pubpropertyProviderName

Gets the provider name of a key.

System_CAPS_pubpropertyProviderType

Gets the provider type of a key.

System_CAPS_pubpropertyRandomlyGenerated

Gets a value indicating whether a key container was randomly generated by a managed cryptography class.

System_CAPS_pubpropertyRemovable

Gets a value indicating whether a key can be removed from a key container.

System_CAPS_pubpropertyUniqueKeyContainerName

Gets a unique key container name.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns 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();

        try
        {
            // 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();

            Console.WriteLine("CspKeyContainerInfo information:");

            Console.WriteLine();

            // 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)
        {
            Console.WriteLine(e.ToString());
        }
        finally
        {
            // Clear the key.
            rsa.Clear();
        }
    }
}

.NET Framework
Available since 2.0
Windows Phone Silverlight
Available since 7.1

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

Return to top
Show: