PGPKeyManager Component

Properties   Methods   Events   Config Settings   Errors  

The PGPKeyManager component manages PGP keys.

Syntax

TsbxPGPKeyManager

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.

Method List

---

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

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.

Config Settings

---

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

FIPSMode Property (PGPKeyManager Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

KeyBitsInKey Property (PGPKeyManager Component)

Indicates the key length in bits.

Syntax

__property int KeyBitsInKey = { read=FKeyBitsInKey, write=FSetKeyBitsInKey };

Default Value

2048

Remarks

Indicates the key length in bits.

This property is not available at design time.

Data Type

Integer

KeyCurve Property (PGPKeyManager Component)

Indicates the elliptic curve associated with a EC key.

Syntax

__property String KeyCurve = { read=FKeyCurve, write=FSetKeyCurve };

Default Value

""

Remarks

Indicates the elliptic curve associated with a EC key.

Supported values:

This property is not available at design time.

Data Type

String

KeyEncryptionAlgorithm Property (PGPKeyManager Component)

Indicates the symmetric algorithm used to encrypt the secret key.

Syntax

__property String KeyEncryptionAlgorithm = { read=FKeyEncryptionAlgorithm, write=FSetKeyEncryptionAlgorithm };

Default Value

"CAST5"

Remarks

Indicates the symmetric algorithm used to encrypt the secret key.

This property is not available at design time.

Data Type

String

KeyExpires Property (PGPKeyManager Component)

Indicates key expiration time in whole days from its generation moment.

Syntax

__property int KeyExpires = { read=FKeyExpires, write=FSetKeyExpires };

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

KeyHandle Property (PGPKeyManager Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 KeyHandle = { read=FKeyHandle, write=FSetKeyHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

KeyHashAlgorithm Property (PGPKeyManager Component)

Specifies the hash algorithm associated with the key.

Syntax

__property String KeyHashAlgorithm = { read=FKeyHashAlgorithm, write=FSetKeyHashAlgorithm };

Default Value

"SHA256"

Remarks

Specifies the hash algorithm associated with the key.

This property is not available at design time.

Data Type

String

KeyOldPacketFormat Property (PGPKeyManager Component)

Indicates whether legacy (PGP 2.

Syntax

__property bool KeyOldPacketFormat = { read=FKeyOldPacketFormat, write=FSetKeyOldPacketFormat };

Default Value

false

Remarks

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

This property is not available at design time.

Data Type

Boolean

KeyPassphrase Property (PGPKeyManager Component)

The key protection password.

Syntax

__property String KeyPassphrase = { read=FKeyPassphrase, write=FSetKeyPassphrase };

Default Value

""

Remarks

The key protection password.

This property is not available at design time.

Data Type

String

KeyProtection Property (PGPKeyManager Component)

Specifies the level of protection applied to the secret key.

Syntax

__property TsbxPGPKeyManagerKeyProtections KeyProtection = { read=FKeyProtection, write=FSetKeyProtection };

enum TsbxPGPKeyManagerKeyProtections {
  pptNone=0,
  pptLow=1,
  pptNormal=2,
  pptHigh=3
};

Default Value

pptNone

Remarks

Specifies the level of protection applied to the secret key.

Allowed values:

This property is not available at design time.

Data Type

Integer

KeyPublicKeyAlgorithm Property (PGPKeyManager Component)

Specifies the asymmetric algorithm of the key.

Syntax

__property String KeyPublicKeyAlgorithm = { read=FKeyPublicKeyAlgorithm, write=FSetKeyPublicKeyAlgorithm };

Default Value

""

Remarks

Specifies the asymmetric algorithm of the key.

This property is not available at design time.

Data Type

String

KeyQBits Property (PGPKeyManager Component)

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

Syntax

__property int KeyQBits = { read=FKeyQBits, write=FSetKeyQBits };

Default Value

0

Remarks

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.

This property is not available at design time.

Data Type

Integer

KeyUsername Property (PGPKeyManager Component)

Specifies the name of the user bound to this key.

Syntax

__property String KeyUsername = { read=FKeyUsername, write=FSetKeyUsername };

Default Value

""

Remarks

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.

This property is not available at design time.

Data Type

String

AddSubkey Method (PGPKeyManager Component)

Adds a new subkey to the Key.

Syntax

void __fastcall AddSubkey(int Bits, String Algorithm, int Expires);

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:

BindUser Method (PGPKeyManager Component)

Binds a new UserID to the Key.

Syntax

void __fastcall BindUser(String Username);

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

void __fastcall ChangePassphrase(String OldPassphrase, String NewPassphrase);

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

void __fastcall ChangeProtection(String OldPassphrase, String NewPassphrase, int ProtType, String EncAlgorithm, String HashAlgorithm);

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 for more details), EncAlgorithm is the key encryption algorithm, and

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

CheckPassphrase Method (PGPKeyManager Component)

Checks if the password matches the secret key.

Syntax

bool __fastcall CheckPassphrase(String Passphrase);

Remarks

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

Config Method (PGPKeyManager Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

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

String __fastcall DoAction(String ActionID, String ActionParams);

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

DynamicArray<Byte> __fastcall ExportKey();

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

DynamicArray<Byte> __fastcall ExportPublicKey();

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

void __fastcall ExportPublicToFile(String Filename);

Remarks

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

ExportToFile Method (PGPKeyManager Component)

Exports the key to a file.

Syntax

void __fastcall ExportToFile(String Filename);

Remarks

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

Generate Method (PGPKeyManager Component)

Generates a new single PGP key.

Syntax

void __fastcall 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

void __fastcall GenerateLegacy(String Username, int Bits, String Password, int Expires);

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

void __fastcall GeneratePair(String Username, String KeyAlgorithm, int KeyBits, String SubKeyAlgorithm, int SubKeyBits, String Password, int Expires);

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: Supported elliptic curves:

ImportFromFile Method (PGPKeyManager Component)

Loads a key from a file.

Syntax

void __fastcall ImportFromFile(String Filename);

Remarks

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

ImportKey Method (PGPKeyManager Component)

Loads a key from a byte array.

Syntax

void __fastcall ImportKey(DynamicArray<Byte> Data);

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

void __fastcall RemoveSubkey(int Index);

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

void __fastcall RemoveUser(int Index);

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

void __fastcall RevokeKey();

Remarks

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

RevokeSubkey Method (PGPKeyManager Component)

Revokes the key's subkey.

Syntax

void __fastcall RevokeSubkey(int Index);

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

void __fastcall RevokeSubkeybyID(String KeyId);

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

void __fastcall RevokeUser(int Index);

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

void __fastcall RevokeUserByName(String Username);

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

int __fastcall Validate();

Remarks

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

Possible result:

Error Event (PGPKeyManager Component)

Information about errors during PGP key management.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxPGPKeyManagerErrorEventParams;
typedef void __fastcall (__closure *TsbxPGPKeyManagerErrorEvent)(System::TObject* Sender, TsbxPGPKeyManagerErrorEventParams *e);
__property TsbxPGPKeyManagerErrorEvent OnError = { read=FOnError, write=FOnError };

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

typedef struct {
  String EventID;
  String EventParam;
} TsbxPGPKeyManagerNotificationEventParams;
typedef void __fastcall (__closure *TsbxPGPKeyManagerNotificationEvent)(System::TObject* Sender, TsbxPGPKeyManagerNotificationEventParams *e);
__property TsbxPGPKeyManagerNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

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.

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

Base Config Settings

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)