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.

KeyCountThe number of records in the Key arrays.
KeyBitsInKeyIndicates the key length in bits.
KeyCanEncryptReturns True if this key can be used for encryption.
KeyCanSignReturns True if this key can be used for signing.
KeyCurveIndicates the elliptic curve associated with a EC key.
KeyEnabledEnables or disables this key for use in encryption or signing operation.
KeyEncryptionAlgorithmIndicates the symmetric algorithm used to encrypt the secret key.
KeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
KeyIsPublicReturns True if this key is a public key, and False otherwise.
KeyIsSecretReturns True if this key is a secret key, and False otherwise.
KeyIsSubkeyReturns True if this key is a subkey of another key, and False otherwise.
KeyKeyFPThe 20-byte fingerprint (hash value) of this key.
KeyKeyIDContains a 8-byte key identifier.
KeyPassphraseThe key protection password.
KeyPassphraseValidUse this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
KeyPrimaryKeyIDIf this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
KeyProtectionSpecifies the level of protection applied to the secret key.
KeyPublicKeyAlgorithmSpecifies the asymmetric algorithm of the key.
KeyQBitsThe length of the DSA Q (legitimate range: 160-512).
KeyTimestampUse this property to check the time the key was generated.
KeyUsernameSpecifies the name of the user bound to this key.
KeyValidToProvide accurate expiration moment indication.
KeyVersionIndicates the key version.
PinnedKeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SelectedKeyCountThe number of records in the SelectedKey arrays.
SelectedKeyBitsInKeyIndicates the key length in bits.
SelectedKeyCanEncryptReturns True if this key can be used for encryption.
SelectedKeyCanSignReturns True if this key can be used for signing.
SelectedKeyCurveIndicates the elliptic curve associated with a EC key.
SelectedKeyEnabledEnables or disables this key for use in encryption or signing operation.
SelectedKeyEncryptionAlgorithmIndicates the symmetric algorithm used to encrypt the secret key.
SelectedKeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SelectedKeyIsPublicReturns True if this key is a public key, and False otherwise.
SelectedKeyIsSecretReturns True if this key is a secret key, and False otherwise.
SelectedKeyIsSubkeyReturns True if this key is a subkey of another key, and False otherwise.
SelectedKeyKeyFPThe 20-byte fingerprint (hash value) of this key.
SelectedKeyKeyIDContains a 8-byte key identifier.
SelectedKeyPassphraseThe key protection password.
SelectedKeyPassphraseValidUse this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
SelectedKeyPrimaryKeyIDIf this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
SelectedKeyProtectionSpecifies the level of protection applied to the secret key.
SelectedKeyPublicKeyAlgorithmSpecifies the asymmetric algorithm of the key.
SelectedKeyQBitsThe length of the DSA Q (legitimate range: 160-512).
SelectedKeyTimestampUse this property to check the time the key was generated.
SelectedKeyUsernameSpecifies the name of the user bound to this key.
SelectedKeyValidToProvide accurate expiration moment indication.
SelectedKeyVersionIndicates the key version.

Method List


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

ConfigThis method sets or retrieves a configuration setting.
DoActionPerforms an additional action.
ExportBytesExports the keyring to a byte array.
ExportToFileExports the keyring to disk.
ImportBytesLoads a key from a byte array.
ImportFromFileLoads a key from a file.
ImportPinnedImports a pinned secret key to the keyring.
RemoveRemoves the specified key from the keyring.
RemoveByIDRemoves key by its ID.
ResetCreates a new empty keyring.
SelectFilters a selection of keys from the keyring using a template.
UpdatePinnedUpdate a pinned key in the keyring.

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.

ErrorInformation about errors during PGP key management.
NotificationThis 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.

TempPathLocation where the temporary files are stored.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the component.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolverSpecifies whether the client components should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

KeyCount Property (PGPKeyring Component)

The number of records in the Key arrays.

Syntax

__property int KeyCount = { read=FKeyCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at KeyCount - 1.

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

Data Type

Integer

KeyBitsInKey Property (PGPKeyring Component)

Indicates the key length in bits.

Syntax

__property int KeyBitsInKey[int KeyIndex] = { read=FKeyBitsInKey };

Default Value

2048

Remarks

Indicates the key length in bits.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Integer

KeyCanEncrypt Property (PGPKeyring Component)

Returns True if this key can be used for encryption.

Syntax

__property bool KeyCanEncrypt[int KeyIndex] = { read=FKeyCanEncrypt };

Default Value

false

Remarks

Returns True if this key can be used for encryption.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Boolean

KeyCanSign Property (PGPKeyring Component)

Returns True if this key can be used for signing.

Syntax

__property bool KeyCanSign[int KeyIndex] = { read=FKeyCanSign };

Default Value

false

Remarks

Returns True if this key can be used for signing.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Boolean

KeyCurve Property (PGPKeyring Component)

Indicates the elliptic curve associated with a EC key.

Syntax

__property String KeyCurve[int KeyIndex] = { read=FKeyCurve };

Default Value

""

Remarks

Indicates the elliptic curve associated with a EC key.

Supported values:

SB_PGP_CURVE_P256P256
SB_PGP_CURVE_P384P384
SB_PGP_CURVE_P521P521
SB_PGP_CURVE_ED25519ED25519
SB_PGP_CURVE_CURVE25519CURVE25519
SB_PGP_CURVE_BRAINPOOLP256R1BRAINPOOLP256
SB_PGP_CURVE_BRAINPOOLP512R1BRAINPOOLP512

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

String

KeyEnabled Property (PGPKeyring Component)

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

Syntax

__property bool KeyEnabled[int KeyIndex] = { read=FKeyEnabled };

Default Value

false

Remarks

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Boolean

KeyEncryptionAlgorithm Property (PGPKeyring Component)

Indicates the symmetric algorithm used to encrypt the secret key.

Syntax

__property String KeyEncryptionAlgorithm[int KeyIndex] = { read=FKeyEncryptionAlgorithm };

Default Value

"AES128"

Remarks

Indicates the symmetric algorithm used to encrypt the secret key.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

String

KeyHandle Property (PGPKeyring Component)

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

Syntax

__property __int64 KeyHandle[int KeyIndex] = { read=FKeyHandle };

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());

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Long64

KeyIsPublic Property (PGPKeyring Component)

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

Syntax

__property bool KeyIsPublic[int KeyIndex] = { read=FKeyIsPublic };

Default Value

false

Remarks

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Boolean

KeyIsSecret Property (PGPKeyring Component)

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

Syntax

__property bool KeyIsSecret[int KeyIndex] = { read=FKeyIsSecret };

Default Value

false

Remarks

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Boolean

KeyIsSubkey Property (PGPKeyring Component)

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

Syntax

__property bool KeyIsSubkey[int KeyIndex] = { read=FKeyIsSubkey };

Default Value

false

Remarks

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Boolean

KeyKeyFP Property (PGPKeyring Component)

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

Syntax

__property String KeyKeyFP[int KeyIndex] = { read=FKeyKeyFP };

Default Value

""

Remarks

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

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

String

KeyKeyID Property (PGPKeyring Component)

Contains a 8-byte key identifier.

Syntax

__property String KeyKeyID[int KeyIndex] = { read=FKeyKeyID };

Default Value

""

Remarks

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.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

String

KeyPassphrase Property (PGPKeyring Component)

The key protection password.

Syntax

__property String KeyPassphrase[int KeyIndex] = { read=FKeyPassphrase };

Default Value

""

Remarks

The key protection password.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

String

KeyPassphraseValid Property (PGPKeyring Component)

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

Syntax

__property bool KeyPassphraseValid[int KeyIndex] = { read=FKeyPassphraseValid };

Default Value

false

Remarks

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Boolean

KeyPrimaryKeyID Property (PGPKeyring Component)

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

Syntax

__property String KeyPrimaryKeyID[int KeyIndex] = { read=FKeyPrimaryKeyID };

Default Value

""

Remarks

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

String

KeyProtection Property (PGPKeyring Component)

Specifies the level of protection applied to the secret key.

Syntax

__property TsbxPGPKeyringKeyProtections KeyProtection[int KeyIndex] = { read=FKeyProtection };
enum TsbxPGPKeyringKeyProtections { pptNone=0, pptLow=1, pptNormal=2, pptHigh=3 };

Default Value

pptNone

Remarks

Specifies the level of protection applied to the secret key.

Allowed values:

pptNone0Key is not encrypted
pptLow1Only the password hash is used to derive the secret key
pptNormal2Password hash with salt is used to derive the secret key
pptHigh3Hash from multiple passwords and salt are used for key derivation

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Integer

KeyPublicKeyAlgorithm Property (PGPKeyring Component)

Specifies the asymmetric algorithm of the key.

Syntax

__property String KeyPublicKeyAlgorithm[int KeyIndex] = { read=FKeyPublicKeyAlgorithm };

Default Value

""

Remarks

Specifies the asymmetric algorithm of the key.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

String

KeyQBits Property (PGPKeyring Component)

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

Syntax

__property int KeyQBits[int KeyIndex] = { read=FKeyQBits };

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.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Integer

KeyTimestamp Property (PGPKeyring Component)

Use this property to check the time the key was generated.

Syntax

__property String KeyTimestamp[int KeyIndex] = { read=FKeyTimestamp };

Default Value

""

Remarks

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

String

KeyUsername Property (PGPKeyring Component)

Specifies the name of the user bound to this key.

Syntax

__property String KeyUsername[int KeyIndex] = { read=FKeyUsername };

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.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

String

KeyValidTo Property (PGPKeyring Component)

Provide accurate expiration moment indication.

Syntax

__property String KeyValidTo[int KeyIndex] = { read=FKeyValidTo };

Default Value

"0"

Remarks

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

String

KeyVersion Property (PGPKeyring Component)

Indicates the key version.

Syntax

__property int KeyVersion[int KeyIndex] = { read=FKeyVersion };

Default Value

0

Remarks

Indicates the key version.

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

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

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

Data Type

Integer

PinnedKeyHandle Property (PGPKeyring Component)

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

Syntax

__property __int64 PinnedKeyHandle = { read=FPinnedKeyHandle, write=FSetPinnedKeyHandle };

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

SelectedKeyCount Property (PGPKeyring Component)

The number of records in the SelectedKey arrays.

Syntax

__property int SelectedKeyCount = { read=FSelectedKeyCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at SelectedKeyCount - 1.

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

Data Type

Integer

SelectedKeyBitsInKey Property (PGPKeyring Component)

Indicates the key length in bits.

Syntax

__property int SelectedKeyBitsInKey[int SelectedKeyIndex] = { read=FSelectedKeyBitsInKey };

Default Value

2048

Remarks

Indicates the key length in bits.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Integer

SelectedKeyCanEncrypt Property (PGPKeyring Component)

Returns True if this key can be used for encryption.

Syntax

__property bool SelectedKeyCanEncrypt[int SelectedKeyIndex] = { read=FSelectedKeyCanEncrypt };

Default Value

false

Remarks

Returns True if this key can be used for encryption.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Boolean

SelectedKeyCanSign Property (PGPKeyring Component)

Returns True if this key can be used for signing.

Syntax

__property bool SelectedKeyCanSign[int SelectedKeyIndex] = { read=FSelectedKeyCanSign };

Default Value

false

Remarks

Returns True if this key can be used for signing.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Boolean

SelectedKeyCurve Property (PGPKeyring Component)

Indicates the elliptic curve associated with a EC key.

Syntax

__property String SelectedKeyCurve[int SelectedKeyIndex] = { read=FSelectedKeyCurve };

Default Value

""

Remarks

Indicates the elliptic curve associated with a EC key.

Supported values:

SB_PGP_CURVE_P256P256
SB_PGP_CURVE_P384P384
SB_PGP_CURVE_P521P521
SB_PGP_CURVE_ED25519ED25519
SB_PGP_CURVE_CURVE25519CURVE25519
SB_PGP_CURVE_BRAINPOOLP256R1BRAINPOOLP256
SB_PGP_CURVE_BRAINPOOLP512R1BRAINPOOLP512

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

String

SelectedKeyEnabled Property (PGPKeyring Component)

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

Syntax

__property bool SelectedKeyEnabled[int SelectedKeyIndex] = { read=FSelectedKeyEnabled };

Default Value

false

Remarks

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

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Boolean

SelectedKeyEncryptionAlgorithm Property (PGPKeyring Component)

Indicates the symmetric algorithm used to encrypt the secret key.

Syntax

__property String SelectedKeyEncryptionAlgorithm[int SelectedKeyIndex] = { read=FSelectedKeyEncryptionAlgorithm };

Default Value

"AES128"

Remarks

Indicates the symmetric algorithm used to encrypt the secret key.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

String

SelectedKeyHandle Property (PGPKeyring Component)

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

Syntax

__property __int64 SelectedKeyHandle[int SelectedKeyIndex] = { read=FSelectedKeyHandle };

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());

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Long64

SelectedKeyIsPublic Property (PGPKeyring Component)

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

Syntax

__property bool SelectedKeyIsPublic[int SelectedKeyIndex] = { read=FSelectedKeyIsPublic };

Default Value

false

Remarks

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

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Boolean

SelectedKeyIsSecret Property (PGPKeyring Component)

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

Syntax

__property bool SelectedKeyIsSecret[int SelectedKeyIndex] = { read=FSelectedKeyIsSecret };

Default Value

false

Remarks

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

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Boolean

SelectedKeyIsSubkey Property (PGPKeyring Component)

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

Syntax

__property bool SelectedKeyIsSubkey[int SelectedKeyIndex] = { read=FSelectedKeyIsSubkey };

Default Value

false

Remarks

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

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Boolean

SelectedKeyKeyFP Property (PGPKeyring Component)

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

Syntax

__property String SelectedKeyKeyFP[int SelectedKeyIndex] = { read=FSelectedKeyKeyFP };

Default Value

""

Remarks

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

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

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

String

SelectedKeyKeyID Property (PGPKeyring Component)

Contains a 8-byte key identifier.

Syntax

__property String SelectedKeyKeyID[int SelectedKeyIndex] = { read=FSelectedKeyKeyID };

Default Value

""

Remarks

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.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

String

SelectedKeyPassphrase Property (PGPKeyring Component)

The key protection password.

Syntax

__property String SelectedKeyPassphrase[int SelectedKeyIndex] = { read=FSelectedKeyPassphrase };

Default Value

""

Remarks

The key protection password.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

String

SelectedKeyPassphraseValid Property (PGPKeyring Component)

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

Syntax

__property bool SelectedKeyPassphraseValid[int SelectedKeyIndex] = { read=FSelectedKeyPassphraseValid };

Default Value

false

Remarks

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

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Boolean

SelectedKeyPrimaryKeyID Property (PGPKeyring Component)

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

Syntax

__property String SelectedKeyPrimaryKeyID[int SelectedKeyIndex] = { read=FSelectedKeyPrimaryKeyID };

Default Value

""

Remarks

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

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

String

SelectedKeyProtection Property (PGPKeyring Component)

Specifies the level of protection applied to the secret key.

Syntax

__property TsbxPGPKeyringSelectedKeyProtections SelectedKeyProtection[int SelectedKeyIndex] = { read=FSelectedKeyProtection };
enum TsbxPGPKeyringSelectedKeyProtections { pptNone=0, pptLow=1, pptNormal=2, pptHigh=3 };

Default Value

pptNone

Remarks

Specifies the level of protection applied to the secret key.

Allowed values:

pptNone0Key is not encrypted
pptLow1Only the password hash is used to derive the secret key
pptNormal2Password hash with salt is used to derive the secret key
pptHigh3Hash from multiple passwords and salt are used for key derivation

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Integer

SelectedKeyPublicKeyAlgorithm Property (PGPKeyring Component)

Specifies the asymmetric algorithm of the key.

Syntax

__property String SelectedKeyPublicKeyAlgorithm[int SelectedKeyIndex] = { read=FSelectedKeyPublicKeyAlgorithm };

Default Value

""

Remarks

Specifies the asymmetric algorithm of the key.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

String

SelectedKeyQBits Property (PGPKeyring Component)

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

Syntax

__property int SelectedKeyQBits[int SelectedKeyIndex] = { read=FSelectedKeyQBits };

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.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Integer

SelectedKeyTimestamp Property (PGPKeyring Component)

Use this property to check the time the key was generated.

Syntax

__property String SelectedKeyTimestamp[int SelectedKeyIndex] = { read=FSelectedKeyTimestamp };

Default Value

""

Remarks

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

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

String

SelectedKeyUsername Property (PGPKeyring Component)

Specifies the name of the user bound to this key.

Syntax

__property String SelectedKeyUsername[int SelectedKeyIndex] = { read=FSelectedKeyUsername };

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.

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

String

SelectedKeyValidTo Property (PGPKeyring Component)

Provide accurate expiration moment indication.

Syntax

__property String SelectedKeyValidTo[int SelectedKeyIndex] = { read=FSelectedKeyValidTo };

Default Value

"0"

Remarks

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

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

String

SelectedKeyVersion Property (PGPKeyring Component)

Indicates the key version.

Syntax

__property int SelectedKeyVersion[int SelectedKeyIndex] = { read=FSelectedKeyVersion };

Default Value

0

Remarks

Indicates the key version.

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

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

The SelectedKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedKeyCount property.

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

Data Type

Integer

Config Method (PGPKeyring Component)

This method 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 (PGPKeyring 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;....

ExportBytes Method (PGPKeyring Component)

Exports the keyring to a byte array.

Syntax

DynamicArray<Byte> __fastcall ExportBytes(bool Secret);

Remarks

Use this method to export 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 export (public or secret).

ExportToFile Method (PGPKeyring Component)

Exports the keyring to disk.

Syntax

void __fastcall ExportToFile(String FileName, bool Secret);

Remarks

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

ImportBytes Method (PGPKeyring Component)

Loads a key from a byte array.

Syntax

void __fastcall ImportBytes(DynamicArray<Byte> Keyring);

Remarks

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

ImportFromFile Method (PGPKeyring Component)

Loads a key from a file.

Syntax

void __fastcall ImportFromFile(String KeyringFile);

Remarks

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

ImportPinned Method (PGPKeyring Component)

Imports a pinned secret key to the keyring.

Syntax

void __fastcall ImportPinned();

Remarks

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

Remove Method (PGPKeyring Component)

Removes the specified key from the keyring.

Syntax

void __fastcall Remove(int Index);

Remarks

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

RemoveByID Method (PGPKeyring Component)

Removes key by its ID.

Syntax

void __fastcall RemoveByID(String KeyID);

Remarks

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

Reset Method (PGPKeyring Component)

Creates a new empty keyring.

Syntax

void __fastcall Reset();

Remarks

Use this method to initialize a new empty keyring.

Select Method (PGPKeyring Component)

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

Syntax

void __fastcall Select(String Filter, bool SecretOnly, int MaxCount);

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 SelectedKeys property.

UpdatePinned Method (PGPKeyring Component)

Update a pinned key in the keyring.

Syntax

void __fastcall UpdatePinned();

Remarks

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

Error Event (PGPKeyring Component)

Information about errors during PGP key management.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxPGPKeyringErrorEventParams;
typedef void __fastcall (__closure *TsbxPGPKeyringErrorEvent)(System::TObject* Sender, TsbxPGPKeyringErrorEventParams *e);
__property TsbxPGPKeyringErrorEvent 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 (PGPKeyring Component)

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

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxPGPKeyringNotificationEventParams;
typedef void __fastcall (__closure *TsbxPGPKeyringNotificationEvent)(System::TObject* Sender, TsbxPGPKeyringNotificationEventParams *e);
__property TsbxPGPKeyringNotificationEvent 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 (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

TempPath:   Location where the temporary files are stored.

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:

offNo caching (default)
localLocal caching
globalGlobal 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:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (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:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll 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-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude 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:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush 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:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore 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:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep 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:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal 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 (PGPKeyring Component)

PGPKeyring Errors

1048577   Invalid parameter (SB_ERROR_INVALID_PARAMETER)
1048578   Invalid configuration (SB_ERROR_INVALID_SETUP)
1048579   Invalid state (SB_ERROR_INVALID_STATE)
1048580   Invalid value (SB_ERROR_INVALID_VALUE)
1048581   Private key not found (SB_ERROR_NO_PRIVATE_KEY)
1048582   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)
1048583   The file was not found (SB_ERROR_NO_SUCH_FILE)
1048584   Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE)
1048585   General error (SB_ERROR_GENERAL_ERROR)
27262977   The file was not found (SB_ERROR_PGP_FILE_NOT_EXISTS)
27262978   Invalid signing key (SB_ERROR_PGP_INVALID_KEY)
27262980   No secret key is available (SB_ERROR_PGP_NO_SECRET_KEY)
27262982   The operation is not supported on a subkey (SB_ERROR_PGP_OPERATION_ON_SUBKEY)