PGPKeyring Component

Properties   Methods   Events   Config Settings   Errors  

The PGPKeyring component accesses and manages PGP keyring files.

Syntax

TsbxPGPKeyring

Remarks

PGPKeyring is used to hold and access PGP keys. It contains information about both public keys and secret keys, which are usually stored in two separate files: "public keyring" and "secret keyring", respectively.

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 (PGPKeyring Component)

Reserved.

Syntax

property FIPSMode: Boolean read get_FIPSMode write set_FIPSMode;

Default Value

false

Remarks

This property is reserved for future use.

Opened Property (PGPKeyring Component)

Indicates if the keyring is in an opened state.

Syntax

property Opened: Boolean read get_Opened;

Default Value

false

Remarks

If the keyring is open, it means that you can access, add, or removes keys from it.

This property is read-only and not available at design time.

PinnedKey Property (PGPKeyring Component)

A PGP key that is being manipulated on.

Syntax

property PinnedKey: TsbxPGPKey read get_PinnedKey write set_PinnedKey;

Remarks

Use this property to specify a key to perform operations on, such as adding.

This property is not available at design time.

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

PublicKeys Property (PGPKeyring Component)

Public keys available in the keyring.

Syntax

property PublicKeys: TsbxPGPKeyList read get_PublicKeys;

Remarks

This property populates a collection of all public keys contained in the keyring.

This property is read-only and not available at design time.

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

SecretKeys Property (PGPKeyring Component)

Secret keys available in the keyring.

Syntax

property SecretKeys: TsbxPGPKeyList read get_SecretKeys;

Remarks

This property populates a collection of all secret keys contained in the keyring.

This property is read-only and not available at design time.

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

SelectedPublicKeys Property (PGPKeyring Component)

The public keys matching the selection criteria.

Syntax

property SelectedPublicKeys: TsbxPGPKeyList read get_SelectedPublicKeys;

Remarks

This property contains all the public keys that match the selection filter passed to Select method.

This property is read-only and not available at design time.

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

SelectedSecretKeys Property (PGPKeyring Component)

The secret keys matching the selection criteria.

Syntax

property SelectedSecretKeys: TsbxPGPKeyList read get_SelectedSecretKeys;

Remarks

This property contains all the secret keys that match the selection filter passed to Select method.

This property is read-only and not available at design time.

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

AddFromBytes Method (PGPKeyring Component)

Adds an existing key to the keyring.

Syntax

procedure AddFromBytes(Bytes: TBytes);

Remarks

Use this method to add a key stored in a byte array to the keyring.

AddFromFile Method (PGPKeyring Component)

Adds an existing key to the keyring.

Syntax

procedure AddFromFile(Filename: String);

Remarks

Use this method to add a key stored in a file to the keyring.

AddFromFiles Method (PGPKeyring Component)

Adds a collection of keys to the keyring.

Syntax

procedure AddFromFiles(PublicKeyringFile: String; SecretKeyringFile: String);

Remarks

Use this method to add keys stored in two separate keyring files to the keyring.

AddFromStream Method (PGPKeyring Component)

Adds a key to the keyring.

Syntax

procedure AddFromStream(Stream: TStream);

Remarks

Use this method to add a key contained in Stream to the keyring.

AddFromStreams Method (PGPKeyring Component)

Adds a collection of keys to the keyring.

Syntax

procedure AddFromStreams(PublicKeyringStream: TStream; SecretKeyringStream: TStream);

Remarks

Use this method to add keys stored in two separate keyring streams to the keyring.

AddPinned Method (PGPKeyring Component)

Adds a pinned secret key to the keyring.

Syntax

procedure AddPinned();

Remarks

Use this method to add a key provided via PinnedKey to the keyring. This can be a public or secret key.

Clear Method (PGPKeyring Component)

Removes all the keys from the keyring.

Syntax

procedure Clear();

Remarks

Use this method to remove all the items from the keyring.

Close Method (PGPKeyring Component)

Closes the keyring.

Syntax

procedure Close();

Remarks

Use this method to close the keyring and release any associated memory resources.

Config Method (PGPKeyring Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): 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.

CreateNew Method (PGPKeyring Component)

Creates a new empty keyring.

Syntax

procedure CreateNew();

Remarks

Use this method to initialize a new empty keyring.

DoAction Method (PGPKeyring Component)

Performs an additional action.

Syntax

function DoAction(ActionID: String; ActionParams: String): 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;....

Load Method (PGPKeyring Component)

Loads a keyring from disk.

Syntax

procedure Load(PublicKeyringFile: String; SecretKeyringFile: String);

Remarks

Use this method to load a keyring (usually stored in two files) to the keyring object. If you only have it in one file, pass an empty string as the second parameter.

LoadFromBytes Method (PGPKeyring Component)

Loads a keyring from two byte arrays.

Syntax

procedure LoadFromBytes(PublicKeyring: TBytes; SecretKeyring: TBytes);

Remarks

Use this method to load a keyring from two byte arrays. Keyring are typically stored in the form of two files (public and secret), but if you only have one file, pass an empty array as the second parameter.

LoadFromStreams Method (PGPKeyring Component)

Loads a keyring from two streams.

Syntax

procedure LoadFromStreams(PublicKeyringStream: TStream; SecretKeyringStream: TStream);

Remarks

Use this method to load a keyring (usually stored in two objects, public and secret) to the keyring object. If you only one keyring object/file, pass null as the second parameter.

RemoveByID Method (PGPKeyring Component)

Removes key by its ID.

Syntax

procedure RemoveByID(KeyID: String);

Remarks

Call this method to remove the specified key from the keyring.

RemovePublic Method (PGPKeyring Component)

Removes the specified public key from the keyring.

Syntax

procedure RemovePublic(Index: Integer);

Remarks

Use this method to remove a public key from the keyring. Use Index to pass the index of the key to be removed.

RemoveSecret Method (PGPKeyring Component)

Removes the specified secret key from the keyring.

Syntax

procedure RemoveSecret(Index: Integer);

Remarks

Use this method to remove a secret key from the keyring. Use Index to pass the index of the key to be removed.

Save Method (PGPKeyring Component)

Saves the keyring to disk.

Syntax

procedure Save(PublicKeyringFile: String; SecretKeyringFile: String);

Remarks

Use this method to save the keyring to disk. PGP software typically uses two files to store keyrings, public and private.

SaveToBytes Method (PGPKeyring Component)

Saves the keyring to a byte array.

Syntax

function SaveToBytes(Secret: Boolean): TBytes;

Remarks

Use this method to save the keyring to a byte array. PGP software typically uses two files to store keyrings. Use Secret parameter to specify which part of the keyring you would like to save (public or secret).

SaveToStreams Method (PGPKeyring Component)

Saves the keyring to streams.

Syntax

procedure SaveToStreams(PublicKeyringStream: TStream; SecretKeyringStream: TStream);

Remarks

Use this method to save the keyring to streams. PGP software typically uses two files to store keyrings, public and private.

Select Method (PGPKeyring Component)

Filters a selection of keys from the keyring using a template.

Syntax

procedure Select(Filter: String; SecretOnly: Boolean; MaxCount: Integer);

Remarks

Use this method to get a list of keys that satisfy the Filter criteria. The filter should follow the "Name=Value" format, where Name can be one of the following: userid, fp, fingerprint, and keyid.

Set SecretOnly to True to only search for secret keys. MaxCount allows to limit the number of keys returned.

Once the method completes, the keys that match the criteria will be available in SelectedPublicKeys and SelectedSecretKeys properties.

Error Event (PGPKeyring Component)

Information about errors during PGP key management.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent 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 (PGPKeyring Component)

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

Syntax

type TNotificationEvent = procedure (
  Sender: TObject;
  const EventID: String;
  const EventParam: String
) of Object;

property OnNotification: TNotificationEvent 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.

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

Constructors

>

constructor Create();

Creates an empty PGP key object.

Config Settings (PGPKeyring 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.

PGPKeyring Config Settings

Base Config Settings

Trappable Errors (PGPKeyring Component)

PGPKeyring 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)