PGPKeyManager Component

Properties Methods Events Config Settings Errors

The PGPKeyManager component manages PGP keys.

Syntax

nsoftware.SecureBlackbox.Pgpkeymanager

Remarks

PGPKeyManager allows you to load, save, generate, import, and export PGP keys.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.


FIPSMode	Reserved.
Key	The key to manipulate on.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.


AddSubkey	Adds a new subkey to the Key.
BindUser	Binds a new UserID to the Key.
ChangePassphrase	Changes the password of the secret key.
ChangeProtection	Changes the protection level of the secret key.
CheckPassphrase	Checks if the password matches the secret key.
Config	Sets or retrieves a configuration setting.
DoAction	Performs an additional action.
ExportKey	Serializes the key to a byte array.
ExportPublicKey	Exports the public key to a byte array.
ExportPublicToFile	Exports the public key to a file.
ExportPublicToStream	Exports the public key to a stream.
ExportToFile	Exports the key to a file.
ExportToStream	Exports the key to a stream.
Generate	Generates a new single PGP key.
GenerateLegacy	Generates a new key in the old format.
GeneratePair	Generates a new pair of PGP keys.
ImportFromFile	Loads a key from a file.
ImportFromStream	Loads a key from a stream.
ImportKey	Loads a key from a byte array.
RemoveSubkey	Removes the specified subkey from the key.
RemoveUser	Unbinds the specified user from the key.
RevokeKey	Revokes the key.
RevokeSubkey	Revokes the key's subkey.
RevokeSubkeybyID	Revokes the key's subkey.
RevokeUser	Revokes a user certification.
RevokeUserByName	Revokes a user certification.
Validate	Validates the key.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.


Error	Information about errors during PGP key management.
Notification	This event notifies the application about an underlying control flow event.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.


TempPath	Path for storing temporary files.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the component.
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
StaticDNS	Specifies whether static DNS rules should be used.
StaticIPAddress[domain]	Gets or sets an IP address for the specified domain name.
StaticIPAddresses	Gets or sets all the static DNS rules.
Tag	Allows to store any custom data.
TLSSessionGroup	Specifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetime	Specifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeInterval	Specifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolver	Specifies whether the client components should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

FIPSMode Property (PGPKeyManager Component)

Reserved.

public bool FIPSMode { get; set; }

Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

Key Property (PGPKeyManager Component)

The key to manipulate on.

Syntax

C#
VB.NET

public PGPKey Key { get; set; }

Public Property Key As PGPKey

Remarks

Use this property to specify the key to perform operations on.

This property is not available at design time.

Please refer to the PGPKey type for a complete list of fields.

AddSubkey Method (PGPKeyManager Component)

Adds a new subkey to the Key.

Syntax

C#
VB.NET

public void AddSubkey(int bits, string algorithm, int expires);

Public Sub AddSubkey(ByVal Bits As Integer, ByVal Algorithm As String, ByVal Expires As Integer)

Remarks

Use this method to add a subkey to a key. Note that the key you are adding the subkey to needs to contain its secret counterpart to be able to sign the new subkey.

Bits specifies the number of bits in the new subkey, Expires is the new subkey's expiration time and date, and Algorithm specifies its public key algorithm:


SB_PGP_PUBLIC_KEY_ALGORITHM_RSA	`RSA`
SB_PGP_PUBLIC_KEY_ALGORITHM_RSA_ENCRYPT	`RSA-encrypt`
SB_PGP_PUBLIC_KEY_ALGORITHM_RSA_SIGN	`RSA-sign`
SB_PGP_PUBLIC_KEY_ALGORITHM_DSA	`DSA`
SB_PGP_PUBLIC_KEY_ALGORITHM_ECDSA	`ECDSA`
SB_PGP_PUBLIC_KEY_ALGORITHM_ECDH	`ECDH`
SB_PGP_PUBLIC_KEY_ALGORITHM_ELGAMAL_ENCRYPT	`Elgamal-encrypt`
SB_PGP_PUBLIC_KEY_ALGORITHM_ELGAMAL	`Elgamal`
SB_PGP_PUBLIC_KEY_ALGORITHM_EDDSA	`EDDSA`

BindUser Method (PGPKeyManager Component)

Binds a new UserID to the Key.

Syntax

C#
VB.NET

public void BindUser(string username);

Public Sub BindUser(ByVal Username As String)

Remarks

Use this method to add a new Username as an owner of the Key.

Note that the key needs to contain its secret counterpart to be able to sign the new user ID.

ChangePassphrase Method (PGPKeyManager Component)

Changes the password of the secret key.

Syntax

C#
VB.NET

public void ChangePassphrase(string oldPassphrase, string newPassphrase);

Public Sub ChangePassphrase(ByVal OldPassphrase As String, ByVal NewPassphrase As String)

Remarks

Call this method to change the password that protects the secret key.

ChangeProtection Method (PGPKeyManager Component)

Changes the protection level of the secret key.

Syntax

C#
VB.NET

public void ChangeProtection(string oldPassphrase, string newPassphrase, int protType, string encAlgorithm, string hashAlgorithm);

Public Sub ChangeProtection(ByVal OldPassphrase As String, ByVal NewPassphrase As String, ByVal ProtType As Integer, ByVal EncAlgorithm As String, ByVal HashAlgorithm As String)

Remarks

Use this method to change the protection level of the Key.

OldPassphrase specifies the current password to decrypt the key, NewPassphrase is the new password for the key, ProtType is the new protection type (see Protection for more details), EncAlgorithm is the key encryption algorithm, and


SB_PGP_SYMMETRIC_ALGORITHM_PLAINTEXT	`Plaintext`
SB_PGP_SYMMETRIC_ALGORITHM_IDEA	`Idea`
SB_PGP_SYMMETRIC_ALGORITHM_3DES	`3DES`
SB_PGP_SYMMETRIC_ALGORITHM_CAST5	`CAST5`
SB_PGP_SYMMETRIC_ALGORITHM_BLOWFISH	`Blowfish`
SB_PGP_SYMMETRIC_ALGORITHM_AES128	`AES128`
SB_PGP_SYMMETRIC_ALGORITHM_AES192	`AES192`
SB_PGP_SYMMETRIC_ALGORITHM_AES256	`AES256`
SB_PGP_SYMMETRIC_ALGORITHM_TWOFISH256	`Twofish256`

and HashAlgorithm specify the algorithms to be used for key derivation.


SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`

CheckPassphrase Method (PGPKeyManager Component)

Checks if the password matches the secret key.

Syntax

C#
VB.NET

public bool CheckPassphrase(string passphrase);

Public Function CheckPassphrase(ByVal Passphrase As String) As Boolean

Remarks

Use this method to check if a password can decrypt the Key.

Config Method (PGPKeyManager Component)

Sets or retrieves a configuration setting.

Syntax

C#
VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (PGPKeyManager Component)

Performs an additional action.

Syntax

C#
VB.NET

public string DoAction(string actionID, string actionParams);

Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As String

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

ExportKey Method (PGPKeyManager Component)

Serializes the key to a byte array.

Syntax

C#
VB.NET

public byte[] ExportKey();

Public Function ExportKey() As Byte()

Remarks

Use this method to save the Key (both the public and secret parts) to a byte array.

ExportPublicKey Method (PGPKeyManager Component)

Exports the public key to a byte array.

Syntax

C#
VB.NET

public byte[] ExportPublicKey();

Public Function ExportPublicKey() As Byte()

Remarks

Use this method to save the public key contained in Key to a byte array.

ExportPublicToFile Method (PGPKeyManager Component)

Exports the public key to a file.

Syntax

C#
VB.NET

public void ExportPublicToFile(string filename);

Public Sub ExportPublicToFile(ByVal Filename As String)

Remarks

Use this method to save the public key stored in Key to the file specified by Filename.

ExportPublicToStream Method (PGPKeyManager Component)

Exports the public key to a stream.

Syntax

C#
VB.NET

public void ExportPublicToStream(System.IO.Stream stream);

Public Sub ExportPublicToStream(ByVal Stream As System.IO.Stream)

Remarks

Use this method to save the public key to the stream specified by Stream.

ExportToFile Method (PGPKeyManager Component)

Exports the key to a file.

Syntax

C#
VB.NET

public void ExportToFile(string filename);

Public Sub ExportToFile(ByVal Filename As String)

Remarks

Use this method to save the Key (both the public and secret parts) to the file specified in Filename.

ExportToStream Method (PGPKeyManager Component)

Exports the key to a stream.

Syntax

C#
VB.NET

public void ExportToStream(System.IO.Stream stream);

Public Sub ExportToStream(ByVal Stream As System.IO.Stream)

Remarks

Use this method to save the Key (both the public and secret parts) to a stream pointed by Stream.

Generate Method (PGPKeyManager Component)

Generates a new single PGP key.

Syntax

C#
VB.NET

public void Generate();

Public Sub Generate()

Remarks

Call this method after setting up relevant fields of Key to generate a new PGP key. This method generates a 'standalone' key without subkeys. Use GeneratePair to generate a pair of a main key and a subkey.

Most PGP implementations work with pairs of keys: the sign-only primary key and the encrypt-only (or encrypt-and-sign) subkey. If you need to generate a conformant PGP key to use with other PGP software, you likely need to use the GeneratePair method.

GenerateLegacy Method (PGPKeyManager Component)

Generates a new key in the old format.

Syntax

C#
VB.NET

public void GenerateLegacy(string username, int bits, string password, int expires);

Public Sub GenerateLegacy(ByVal Username As String, ByVal Bits As Integer, ByVal Password As String, ByVal Expires As Integer)

Remarks

Use this method when you need to generate an RSA key in the old (PGP 2.6.x) format.

Username specifies the user of the key, Bits is the key length in bits. Provide Password for the key and its expiration date and time via Expires.

Only use this method where you want to work with very old PGP software. While still providing a decent level of protection (subject to key length, of course), legacy keys are rarely used these days, and have almost everywhere been replaced with new-style keys.

Most modern PGP implementations work with pairs of keys: the sign-only primary key and the encrypt-only (or encrypt-and-sign) subkey. If you need to generate a conformant PGP key to use with other PGP software, you likely need to use the GeneratePair method.

GeneratePair Method (PGPKeyManager Component)

Generates a new pair of PGP keys.

Syntax

C#
VB.NET

public void GeneratePair(string username, string keyAlgorithm, int keyBits, string subKeyAlgorithm, int subKeyBits, string password, int expires);

Public Sub GeneratePair(ByVal Username As String, ByVal KeyAlgorithm As String, ByVal KeyBits As Integer, ByVal SubKeyAlgorithm As String, ByVal SubKeyBits As Integer, ByVal Password As String, ByVal Expires As Integer)

Remarks

Use this method to create a new key-subkey pair. This is the primary method for generating conformant PGP keys.

Pass the user ID of the new key via the Username property. This typically should be in the format of User Name <user@email>, for example Robert Frost <robert@frost.com>, but generally can be an arbitrary text string.

Set KeyAlgorithm and SubKeyAlgorithm to the public key algorithms that you want to use for the new key. See the full list of algorithms below. Where ECDSA or ECDH algorithm is used, you can specify a particular curve after the algorithm name, separated with the colon: ECDSA:P384 or ECDH:BRAINPOOLP256. KeyBits and SubKeyBits specify the number of bits in the key and the subkey. These parameters can be set to zero if the key length is implicitly defined by the algorithm of the key. For example, ECDSA P256 keys are always 256 bit long, so you may pass 0 as the corresponding KeyBits or SubKeyBits parameter.

Provide the key encryption password and the validity period in days via the Password and Expires parameters. Set Expires to zero to indicate that the key does not expire.

While you can use any combination of algorithms for your key and subkey, most implementations got used to specific hard-wired combinations. Sticking to those will help make sure your keys are understood by other implementations. Typical combinations are:

EDDSA main key with ECDH:CURVE25519 subkey;
ECDSA main key with ECDH subkey; both with NIST curves (P256, P384, or P512);
ECDSA main key with ECDH subkey; both with Brainpool curves (BRAINPOOLP256 or BRAINPOOLP512);
RSA main key with RSA subkey.

The code snippet below illustrates a typical key generation procedure:

    Pgpkeymanager mgr = new Pgpkeymanager();

    // generating a pair
    mgr.GeneratePair("Michel Legrand <ml@email.com>", "EDDSA", 0, "ECDH:CURVE25519", 0, "password", 0);

    // creating a keyring object and adding the new pair to the keyring
    Pgpkeyring keyring = new Pgpkeyring();

    keyring.CreateNew();

    keyring.PinnedKey = mgr.Key;
    keyring.AddPinned();

    // exporting the keyring to a file
    keyring.Save("pubkey.pkr", "seckey.skr");

Alternative calls to GeneratePair may look like this:

    mgr.GeneratePair("Michel Legrand <ml@email.com>", "ECDSA:P384", 0, "ECDH", 0, "password", 0);

    mgr.GeneratePair("Michel Legrand <ml@email.com>", "ECDSA:BRAINPOOLP256", 0, "ECDH:BRAINPOOLP256", 0, "password", 0);

    mgr.GeneratePair("Michel Legrand <ml@email.com>", "RSA", 4096, "RSA", 2048, "password", 0);

Supported public key algorithms:


SB_PGP_PUBLIC_KEY_ALGORITHM_RSA	`RSA`
SB_PGP_PUBLIC_KEY_ALGORITHM_RSA_ENCRYPT	`RSA-encrypt`
SB_PGP_PUBLIC_KEY_ALGORITHM_RSA_SIGN	`RSA-sign`
SB_PGP_PUBLIC_KEY_ALGORITHM_DSA	`DSA`
SB_PGP_PUBLIC_KEY_ALGORITHM_ECDSA	`ECDSA`
SB_PGP_PUBLIC_KEY_ALGORITHM_ECDH	`ECDH`
SB_PGP_PUBLIC_KEY_ALGORITHM_ELGAMAL_ENCRYPT	`Elgamal-encrypt`
SB_PGP_PUBLIC_KEY_ALGORITHM_ELGAMAL	`Elgamal`
SB_PGP_PUBLIC_KEY_ALGORITHM_EDDSA	`EDDSA`

Supported elliptic curves:


SB_PGP_CURVE_P256	`P256`
SB_PGP_CURVE_P384	`P384`
SB_PGP_CURVE_P521	`P521`
SB_PGP_CURVE_ED25519	`ED25519`
SB_PGP_CURVE_CURVE25519	`CURVE25519`
SB_PGP_CURVE_BRAINPOOLP256R1	`BRAINPOOLP256`
SB_PGP_CURVE_BRAINPOOLP512R1	`BRAINPOOLP512`

ImportFromFile Method (PGPKeyManager Component)

Loads a key from a file.

Syntax

C#
VB.NET

public void ImportFromFile(string filename);

Public Sub ImportFromFile(ByVal Filename As String)

Remarks

Use this method to load a key, either public or secret, from a file.

ImportFromStream Method (PGPKeyManager Component)

Loads a key from a stream.

Syntax

C#
VB.NET

public void ImportFromStream(System.IO.Stream stream);

Public Sub ImportFromStream(ByVal Stream As System.IO.Stream)

Remarks

Use this method to load a key, either public or secret, from a stream.

ImportKey Method (PGPKeyManager Component)

Loads a key from a byte array.

Syntax

C#
VB.NET

public void ImportKey(byte[] data);

Public Sub ImportKey(ByVal Data As Byte())

Remarks

Use this method to load a key, either public or secret, from a byte array.

RemoveSubkey Method (PGPKeyManager Component)

Removes the specified subkey from the key.

Syntax

C#
VB.NET

public void RemoveSubkey(int index);

Public Sub RemoveSubkey(ByVal Index As Integer)

Remarks

Use this method to remove the subkey referred by its Index from the key.

RemoveUser Method (PGPKeyManager Component)

Unbinds the specified user from the key.

Syntax

C#
VB.NET

public void RemoveUser(int index);

Public Sub RemoveUser(ByVal Index As Integer)

Remarks

Use this method to remove the specified user from the list of UserIDs bound to the key.

RevokeKey Method (PGPKeyManager Component)

Revokes the key.

Syntax

C#
VB.NET

public void RevokeKey();

Public Sub RevokeKey()

Remarks

Use this method to revoke the key by adding a revocation signature.

RevokeSubkey Method (PGPKeyManager Component)

Revokes the key's subkey.

Syntax

C#
VB.NET

public void RevokeSubkey(int index);

Public Sub RevokeSubkey(ByVal Index As Integer)

Remarks

Use this method to revoke the subkey with a given Index by adding a revocation signature.

RevokeSubkeybyID Method (PGPKeyManager Component)

Revokes the key's subkey.

Syntax

C#
VB.NET

public void RevokeSubkeybyID(string keyId);

Public Sub RevokeSubkeybyID(ByVal KeyId As String)

Remarks

Use this method to revoke the subkey with a given KeyID by adding a revocation signature.

RevokeUser Method (PGPKeyManager Component)

Revokes a user certification.

Syntax

C#
VB.NET

public void RevokeUser(int index);

Public Sub RevokeUser(ByVal Index As Integer)

Remarks

Use this method to revoke the user with the specified Index by adding a revocation signature to the key.

RevokeUserByName Method (PGPKeyManager Component)

Revokes a user certification.

Syntax

C#
VB.NET

public void RevokeUserByName(string username);

Public Sub RevokeUserByName(ByVal Username As String)

Remarks

Use this method to revoke the certification of the user specified by Username by adding a revocation signature.

Validate Method (PGPKeyManager Component)

Validates the key.

Syntax

C#
VB.NET

public int Validate();

Public Function Validate() As Integer

Remarks

Call this method to validate signatures over the PGP key and all the subkeys.

Possible result:


pkvStrictlyValid	`0`	Strictly valid
pkvValid	`1`	Valid
pkvInvalid	`2`	Invalid
pkvFailure	`3`	Generic validation failure
pkvUnknown	`4`	Validity unknown

Error Event (PGPKeyManager Component)

Information about errors during PGP key management.

Syntax

C#
VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, PgpkeymanagerErrorEventArgs e);

public class PgpkeymanagerErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As PgpkeymanagerErrorEventArgs)

Public Class PgpkeymanagerErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The event is fired in case of exceptional conditions during key management.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (PGPKeyManager Component)

This event notifies the application about an underlying control flow event.

Syntax

C#
VB.NET

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, PgpkeymanagerNotificationEventArgs e);

public class PgpkeymanagerNotificationEventArgs : EventArgs {
  public string EventID { get; }
  public string EventParam { get; }
}

Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As PgpkeymanagerNotificationEventArgs)

Public Class PgpkeymanagerNotificationEventArgs Inherits EventArgs
  Public ReadOnly Property EventID As String
  Public ReadOnly Property EventParam As String
End Class

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

PGPKey Type

This container represents a PGP key.

Remarks

OpenPGP standard supports several types of keys. In our days, a typical OpenPGP keypair actually consists of two cryptographic keys: a primary key and a subkey. The primary key is normally used for signing, while the subkey is used for encryption.

While it is typical for PGP environments to use a primary key/subkey bundle, this is not a must. Sometimes you may come across standalone keys (mainly when dealing with older implementations), as well as whole key trees, each of those carrying a bunch of differently-purposed subkeys bound to the same primary key.

Algorithm-wise, OpenPGP keys also differ. Generally speaking, OpenPGP supports the following public key algorithms: RSA, Elgamal (often incorrectly referred to as DH), DSA, ECDH and ECDSA. When it comes to primary key/subkey bundles, DSA/Elgamal, RSA/RSA and ECDSA/ECDH pairs are typically used. Although there's no restriction on algorithm bundles, and, e.g. a ECDSA/Elgamal key bundle is perfectly possible, such combination is rarely used in practice.

A typical OpenPGP key is associated with some kind of user ID (Username). It is normally represented with a user's e-mail address, while in theory can be any piece of text. The secret part of the OpenPGP keypair is protected with a password (Passphrase).

Fields

BitsInKey
int
Default Value: 2048

Indicates the key length in bits.

CanEncrypt
bool (read-only)
Default Value: False

Returns True if this key can be used for encryption.

CanSign
bool (read-only)
Default Value: False

Returns True if this key can be used for signing.

Curve
string
Default Value: ""

Indicates the elliptic curve associated with a EC key.

Supported values:


SB_PGP_CURVE_P256	`P256`
SB_PGP_CURVE_P384	`P384`
SB_PGP_CURVE_P521	`P521`
SB_PGP_CURVE_ED25519	`ED25519`
SB_PGP_CURVE_CURVE25519	`CURVE25519`
SB_PGP_CURVE_BRAINPOOLP256R1	`BRAINPOOLP256`
SB_PGP_CURVE_BRAINPOOLP512R1	`BRAINPOOLP512`

Enabled
bool
Default Value: False

Enables or disables this key for use in encryption or signing operation.

EncryptionAlgorithm
string
Default Value: "CAST5"

Indicates the symmetric algorithm used to encrypt the secret key.

Expires
int
Default Value: 0

Indicates key expiration time in whole days from its generation moment. The value of 0 indicates that the key does not expire.

HashAlgorithm
string
Default Value: "SHA256"

Specifies the hash algorithm associated with the key.

IsPublic
bool (read-only)
Default Value: False

Returns True if this key is a public key, and False otherwise.

IsSecret
bool (read-only)
Default Value: False

Returns True if this key is a secret key, and False otherwise.

IsSubkey
bool (read-only)
Default Value: False

Returns True if this key is a subkey of another key, and False otherwise.

KeyFP
string (read-only)
Default Value: ""

The 20-byte fingerprint (hash value) of this key.

KeyFP could be used to distinguish two keys with the same KeyID.

KeyHashAlgorithm
string (read-only)
Default Value: "SHA256"

Specifies the hash algorithm used with DSA keys to calculate signatures.

KeyID
string (read-only)
Default Value: ""

Contains a 8-byte key identifier.

It is quite rare that IDs of two keys collide. If that happens, their fingerprints (KeyFP) can be used for distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.

OldPacketFormat
bool
Default Value: False

Indicates whether legacy (PGP 2.6.x) packet format should be used.

Passphrase
string
Default Value: ""

The key protection password.

PassphraseValid
bool (read-only)
Default Value: False

Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.

PrimaryKeyID
string (read-only)
Default Value: ""

If this key is a subkey (IsSubkey returns True), this field contains the identifier of the subkey's primary key.

Protection
PGPProtectionTypes
Default Value: 0

Specifies the level of protection applied to the secret key.

Allowed values:


pptNone	`0`	Key is not encrypted
pptLow	`1`	Only the password hash is used to derive the secret key
pptNormal	`2`	Password hash with salt is used to derive the secret key
pptHigh	`3`	Hash from multiple passwords and salt are used for key derivation

PublicKeyAlgorithm
string
Default Value: ""

Specifies the asymmetric algorithm of the key.

QBits
int
Default Value: 0

The length of the DSA Q (legitimate range: 160-512).

This parameter corresponds to the hash algorithm used with the key. For example, if the value of Q is 256, SHA-256 will be used.

Revoked
bool (read-only)
Default Value: False

Returns True if the key has been revoked, and False otherwise.

SubkeyFP
string (read-only)
Default Value: ""

The 20-byte fingerprint (hash value) of this key's subkey.

KeyFP could be used to distinguish two subkeys with the same SubkeyID.

SubkeyID
string (read-only)
Default Value: ""

Contains a 8-byte subkey identifier.

It is quite rare that IDs of two keys collide. If that happens, their fingerprints (SubkeyFP) can be used to distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.

Timestamp
string (read-only)
Default Value: ""

Use this property to check the time the key was generated. The date and time are stored and retrieved in Universal Coordinate Time (UTC).

Username
string
Default Value: ""

Specifies the name of the user bound to this key.

The PGP username is typically represented with a full name and an email address, but generally can be any non-empty string.

Valid
PGPKeyValidities (read-only)
Default Value: 0

Indicates the validity status of the key.


pkvStrictlyValid	`0`	Strictly valid
pkvValid	`1`	Valid
pkvInvalid	`2`	Invalid
pkvFailure	`3`	Generic validation failure
pkvUnknown	`4`	Validity unknown

ValidTo
string (read-only)
Default Value: "0"

Provide accurate expiration moment indication. This is different to Expires property which only contains expiration time in days in old keys.

Version
int (read-only)
Default Value: -1

Indicates the key version.

The key version refers to the version of the public-key packet format as defined in RFC 4880.

Only two versions are currently allowed here: 3 and 4. It is recommended that all new keys are created with version of 4.

Constructors

C#
VB.NET

public PGPKey();

Public PGPKey()

Creates an empty PGP key object.

C#
VB.NET

public PGPKey(string filename);

Public PGPKey(ByVal Filename As String)

Create a PGP key object from a key file.

Config Settings (PGPKeyManager Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

PGPKeyManager Config Settings

TempPath: Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

Base Config Settings

CheckKeyIntegrityBeforeUse: Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching: Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the component.

Supported values are:


off		No caching (default)
local		Local caching
global		Global caching

Cookies: Gets or sets local cookies for the component.

Use this property to get cookies from the internal cookie storage of the component and/or restore them back between application sessions.

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE: Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies: Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the components that have its CookieCaching property set to "global".

HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other components.

LogDestination: Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:


file		File
console		Console
systemlog		System Log (supported for Android only)
debugger		Debugger (supported for VCL for Windows and .Net)

LogDetails: Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:


time		Current time
level		Level
package		Package name
module		Module name
class		Class name
method		Method name
threadid		Thread Id
contenttype		Content type
content		Content
all		All details

LogFile: Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters: Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:


exclude-package		Exclude a package specified in the value
exclude-module		Exclude a module specified in the value
exclude-class		Exclude a class specified in the value
exclude-method		Exclude a method specified in the value
include-package		Include a package specified in the value
include-module		Include a module specified in the value
include-class		Include a class specified in the value
include-method		Include a method specified in the value

LogFlushMode: Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:


none		No flush (caching only)
immediate		Immediate flush (real-time logging)
maxcount		Flush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel: Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:


none		None (by default)
fatal		Severe errors that cause premature termination.
error		Other runtime errors or unexpected conditions.
warning		Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
info		Interesting runtime events (startup/shutdown).
debug		Detailed information on flow of through the system.
trace		More detailed information.

LogMaxEventCount: Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode: Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:


none		No rotation
deleteolder		Delete older entries from the cache upon reaching LogMaxEventCount
keepolder		Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

StaticDNS: Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the component. Works only if UseOwnDNSResolver is set to true.

Supported values are:


none		No static DNS rules (default)
local		Local static DNS rules
global		Global static DNS rules

StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the component) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

StaticIPAddresses: Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the component is set to "local", the property returns/restores the rules from/to the internal storage of the component. If StaticDNS of the component is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag: Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup: Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the components.

TLSSessionLifetime: Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval: Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS: Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom: Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (PGPKeyManager Component)

PGPKeyManager Errors


	1048577 Invalid parameter value (`SB_ERROR_INVALID_PARAMETER`)
	1048578 Component is configured incorrectly (`SB_ERROR_INVALID_SETUP`)
	1048579 Operation cannot be executed in the current state (`SB_ERROR_INVALID_STATE`)
	1048580 Attempt to set an invalid value to a property (`SB_ERROR_INVALID_VALUE`)
	1048581 Certificate does not have its private key loaded (`SB_ERROR_NO_PRIVATE_KEY`)
	1048581 Cancelled by the user (`SB_ERROR_CANCELLED_BY_USER`)
	27262977 File does not exist (`SB_ERROR_PGP_FILE_NOT_EXISTS`)
	27262978 Invalid key (`SB_ERROR_PGP_INVALID_KEY`)
	27262979 No public key (`SB_ERROR_PGP_NO_PUBLIC_KEY`)
	27262980 No secret key (`SB_ERROR_PGP_NO_SECRET_KEY`)
	27262981 Not found (`SB_ERROR_PGP_NOT_FOUND`)
	27262982 Operation cannot be performed on a subkey (`SB_ERROR_PGP_OPERATION_ON_SUBKEY`)