Edit

Share via

CspParameters.KeyNumber Field

  • Reference

Definition

Namespace:
System.Security.Cryptography
Assembly:
System.Security.Cryptography.Csp.dll
Assembly:
System.Security.Cryptography.dll
Assembly:
mscorlib.dll
Assembly:
netstandard.dll
Source:
CspParameters.cs
Source:
CspParameters.cs
Source:
CspParameters.cs

Specifies whether an asymmetric key is created as a signature key or an exchange key.

public: int KeyNumber;
public int KeyNumber;
val mutable KeyNumber : int
Public KeyNumber As Integer

Field Value

Int32

Examples

The following code example demonstrates how to use the KeyNumber enumeration to specify a key type for an RSACryptoServiceProvider object.

// Create a new CspParameters object.
CspParameters^ cspParams = gcnew CspParameters();

// Specify an exchange key.
cspParams->KeyNumber = (int) KeyNumber::Exchange;

// Initialize the RSACryptoServiceProvider
// with the CspParameters object.
RSACryptoServiceProvider^ RSACSP = gcnew RSACryptoServiceProvider(cspParams);

// Create a new CspParameters object.
CspParameters cspParams = new CspParameters();

// Specify an exchange key.
cspParams.KeyNumber = (int) KeyNumber.Exchange;

// Initialize the RSACryptoServiceProvider
// with the CspParameters object.
RSACryptoServiceProvider RSACSP = new RSACryptoServiceProvider(cspParams);

' Create a new CspParameters object.
Dim cspParams As New CspParameters()

' Specify an exchange key.
cspParams.KeyNumber = Fix(KeyNumber.Exchange)

' Initialize the RSACryptoServiceProvider  
' with the CspParameters object.
Dim RSACSP As New RSACryptoServiceProvider(cspParams)

Remarks

The KeyNumber field initializes the KeyNumber property when you initialize a CspKeyContainerInfo object with a CspParameters object.

An exchange key is an asymmetric key pair used to encrypt session keys so that they can be safely stored and exchanged with other users. You can use the Exchange value (1) to specify an exchange key. This value corresponds to the AT_KEYEXCHANGE value used in the unmanaged Microsoft Cryptographic API (CAPI).

A signature key is an asymmetric key pair used for authenticating digitally signed messages or files. You can use the Signature value (2) to specify a signature key. This value corresponds to the AT_SIGNATURE value used in CAPI.

By default, the KeyNumber field specifies an exchange key.

Applies to

See also