X509PrivateKeyBuilder Class

Represents a managed X.509 private key generator.

Inheritance Hierarchy

SystemObject
SysadminsLV.PKI.CryptographyX509PrivateKeyBuilder

Namespace: SysadminsLV.PKI.Cryptography
Assembly: SysadminsLV.PKI (in SysadminsLV.PKI.dll) Version: 3.7.0.0 (3.7.0.0)

Syntax

public class X509PrivateKeyBuilder : IKeyStorageInfo, 
	IDisposable

Public Class X509PrivateKeyBuilder
	Implements IKeyStorageInfo, IDisposable

public ref class X509PrivateKeyBuilder : IKeyStorageInfo, 
	IDisposable

type X509PrivateKeyBuilder =  
    class
        interface IKeyStorageInfo
        interface IDisposable
    end

The X509PrivateKeyBuilder type exposes the following members.

Constructors

	Name	Description
	X509PrivateKeyBuilder	Initializes a new instance of the X509PrivateKeyBuilder class

Properties

	Name	Description
	Exportable	Gets or sets the flag that indicates whether the private key is exportable or not. For hardware providers, this flag is set to False and cannot be modified.
	KeyContainerName	Gets or sets key container name that is used to store the key material within key provider.
	KeyLength	Gets or sets asymmetric public key length in bits. For elliptic curve cryptography (ECC), this member is automatically populated from PublicKeyAlgorithm member value, because ECC curve includes key length.
	KeyProtection	Gets or sets private key protection options when the key is accessded.
	KeySpec	Gets or sets a value that identifies whether a private key can be used for signing, or encryption, or both.
	MachineContext	Gets or sets the value that indicates whether the key is stored in machine or current user context.
	ProviderName	Gets or sets a legacy cryptographic service provider (CSP) or CNG key storage provider (KSP).
	ProviderType	Gets provider type. Provider type is cryptographic service provider family and is used only with legacy CSP. This member is automatically populated after invoking Create method.
	PublicKeyAlgorithm	Gets or sets public key algorithm. For CNG keys, key and curve name must be used. For example, "ECDSA_P256", "ECDH_brainpoolP320r1". When not set, default key algorithm for specified provider is used and depends on a particular cryptographic service provider (CSP or KSP).
	SecurityDescriptor	Gets or sets an access control list to private key in a SDDL form.

Methods

	Name	Description
	Create	Creates a new asymmetric key pair based on a current configuration. If the method succeeds, all properties of this object are read-only and will throw exception when setter accessor is accessed.
	Delete	Deletes generated private key material from key storage. For software-based providers, the key is deleted from file system, for hardware-based providers, the key is deleted from hardware. When hardware-based provider is used, a PIN prompt dialog may appear.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Overrides ObjectFinalize.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetPublicKey	Gets public portion of the key pair.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)