Export (0) Print
Expand All

CspParameters Class

Contains parameters that are passed to the cryptographic service provider (CSP) that performs cryptographic computations. This class cannot be inherited.

System.Object
  System.Security.Cryptography.CspParameters

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

[<Sealed>]
[<ComVisibleAttribute(true)>]
type CspParameters =  class end

The CspParameters type exposes the following members.

  NameDescription
Public methodCspParameters()Initializes a new instance of the CspParameters class.
Public methodCspParameters(Int32)Initializes a new instance of the CspParameters class with the specified provider type code.
Public methodCspParameters(Int32, String)Initializes a new instance of the CspParameters class with the specified provider type code and name.
Public methodCspParameters(Int32, String, String)Initializes a new instance of the CspParameters class with the specified provider type code and name, and the specified container name.
Public methodCspParameters(Int32, String, String, CryptoKeySecurity, IntPtr)Initializes a new instance of the CspParameters class using a provider type, a provider name, a container name, access information, and a handle to an unmanaged smart card password dialog.
Public methodCspParameters(Int32, String, String, CryptoKeySecurity, SecureString)Initializes a new instance of the CspParameters class using a provider type, a provider name, a container name, access information, and a password associated with a smart card key.
Top

  NameDescription
Public propertyCryptoKeySecurityGets or sets a CryptoKeySecurity object that represents access rights and audit rules for a container.
Public propertyFlagsRepresents the flags for CspParameters that modify the behavior of the cryptographic service provider (CSP).
Public propertyKeyPasswordGets or sets a password associated with a smart card key.
Public propertyParentWindowHandleGets or sets a handle to the unmanaged parent window for a smart card password dialog box.
Top

  NameDescription
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.)
Top

  NameDescription
Public fieldKeyContainerNameRepresents the key container name for CspParameters.
Public fieldKeyNumberSpecifies whether an asymmetric key is created as a signature key or an exchange key.
Public fieldProviderNameRepresents the provider name for CspParameters.
Public fieldProviderTypeRepresents the provider type code for CspParameters.
Top

The CspParameters class represents parameters that you can pass to managed cryptography classes that internally use Microsoft Cryptographic Service Providers (CSPs) from the unmanaged Microsoft Cryptography API (CAPI). Classes with names ending in "CryptoServiceProvider" are managed code wrappers for the corresponding CSP.

Use the CspParameters class to do the following:

  • Specify a particular CSP by passing the provider type to the ProviderType or ProviderName property. You can also specify a CSP using an overload of the constructor.

  • Create a key container where you can store cryptographic keys. Key containers provide the most secure way to persist cryptographic keys and keep them secret from malicious third parties. For more information about creating key containers, see How to: Store Asymmetric Keys in a Key Container.

  • Specify whether to create an asymmetric signature key or an asymmetric exchange key using the KeyNumber property.

The following code example creates a key container using the CspParameters class and saves the key in the container.

No code example is currently available or this language may not be supported.

The following code example uses the CspParameters class to select a Smart Card Cryptographic Service Provider. It then signs and verifies data using the smart card.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.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

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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