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.

FIPSModeReserved.
OpenedIndicates if the keyring is in an opened state.
PinnedKeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
PublicKeyCountThe number of records in the PublicKey arrays.
PublicKeyBitsInKeyIndicates the key length in bits.
PublicKeyCanEncryptReturns True if this key can be used for encryption.
PublicKeyCanSignReturns True if this key can be used for signing.
PublicKeyCurveIndicates the elliptic curve associated with a EC key.
PublicKeyEnabledEnables or disables this key for use in encryption or signing operation.
PublicKeyEncryptionAlgorithmIndicates the symmetric algorithm used to encrypt the secret key.
PublicKeyExpiresIndicates key expiration time in whole days from its generation moment.
PublicKeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
PublicKeyHashAlgorithmSpecifies the hash algorithm associated with the key.
PublicKeyIsPublicReturns True if this key is a public key, and False otherwise.
PublicKeyIsSecretReturns True if this key is a secret key, and False otherwise.
PublicKeyIsSubkeyReturns True if this key is a subkey of another key, and False otherwise.
PublicKeyKeyFPThe 20-byte fingerprint (hash value) of this key.
PublicKeyKeyHashAlgorithmSpecifies the hash algorithm used with DSA keys to calculate signatures.
PublicKeyKeyIDContains a 8-byte key identifier.
PublicKeyOldPacketFormatIndicates whether legacy (PGP 2.
PublicKeyPassphraseThe key protection password.
PublicKeyPassphraseValidUse this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
PublicKeyPrimaryKeyIDIf this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
PublicKeyProtectionSpecifies the level of protection applied to the secret key.
PublicKeyPublicKeyAlgorithmSpecifies the asymmetric algorithm of the key.
PublicKeyQBitsThe length of the DSA Q (legitimate range: 160-512).
PublicKeyRevokedReturns True if the key has been revoked, and False otherwise.
PublicKeySubkeyFPThe 20-byte fingerprint (hash value) of this key's subkey.
PublicKeySubkeyIDContains a 8-byte subkey identifier.
PublicKeyTimestampUse this property to check the time the key was generated.
PublicKeyUsernameSpecifies the name of the user bound to this key.
PublicKeyValidIndicates the validity status of the key.
PublicKeyValidToProvide accurate expiration moment indication.
PublicKeyVersionIndicates the key version.
SecretKeyCountThe number of records in the SecretKey arrays.
SecretKeyBitsInKeyIndicates the key length in bits.
SecretKeyCanEncryptReturns True if this key can be used for encryption.
SecretKeyCanSignReturns True if this key can be used for signing.
SecretKeyCurveIndicates the elliptic curve associated with a EC key.
SecretKeyEnabledEnables or disables this key for use in encryption or signing operation.
SecretKeyEncryptionAlgorithmIndicates the symmetric algorithm used to encrypt the secret key.
SecretKeyExpiresIndicates key expiration time in whole days from its generation moment.
SecretKeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SecretKeyHashAlgorithmSpecifies the hash algorithm associated with the key.
SecretKeyIsPublicReturns True if this key is a public key, and False otherwise.
SecretKeyIsSecretReturns True if this key is a secret key, and False otherwise.
SecretKeyIsSubkeyReturns True if this key is a subkey of another key, and False otherwise.
SecretKeyKeyFPThe 20-byte fingerprint (hash value) of this key.
SecretKeyKeyHashAlgorithmSpecifies the hash algorithm used with DSA keys to calculate signatures.
SecretKeyKeyIDContains a 8-byte key identifier.
SecretKeyOldPacketFormatIndicates whether legacy (PGP 2.
SecretKeyPassphraseThe key protection password.
SecretKeyPassphraseValidUse this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
SecretKeyPrimaryKeyIDIf this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
SecretKeyProtectionSpecifies the level of protection applied to the secret key.
SecretKeyPublicKeyAlgorithmSpecifies the asymmetric algorithm of the key.
SecretKeyQBitsThe length of the DSA Q (legitimate range: 160-512).
SecretKeyRevokedReturns True if the key has been revoked, and False otherwise.
SecretKeySubkeyFPThe 20-byte fingerprint (hash value) of this key's subkey.
SecretKeySubkeyIDContains a 8-byte subkey identifier.
SecretKeyTimestampUse this property to check the time the key was generated.
SecretKeyUsernameSpecifies the name of the user bound to this key.
SecretKeyValidIndicates the validity status of the key.
SecretKeyValidToProvide accurate expiration moment indication.
SecretKeyVersionIndicates the key version.
SelectedPublicKeyCountThe number of records in the SelectedPublicKey arrays.
SelectedPublicKeyBitsInKeyIndicates the key length in bits.
SelectedPublicKeyCanEncryptReturns True if this key can be used for encryption.
SelectedPublicKeyCanSignReturns True if this key can be used for signing.
SelectedPublicKeyCurveIndicates the elliptic curve associated with a EC key.
SelectedPublicKeyEnabledEnables or disables this key for use in encryption or signing operation.
SelectedPublicKeyEncryptionAlgorithmIndicates the symmetric algorithm used to encrypt the secret key.
SelectedPublicKeyExpiresIndicates key expiration time in whole days from its generation moment.
SelectedPublicKeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SelectedPublicKeyHashAlgorithmSpecifies the hash algorithm associated with the key.
SelectedPublicKeyIsPublicReturns True if this key is a public key, and False otherwise.
SelectedPublicKeyIsSecretReturns True if this key is a secret key, and False otherwise.
SelectedPublicKeyIsSubkeyReturns True if this key is a subkey of another key, and False otherwise.
SelectedPublicKeyKeyFPThe 20-byte fingerprint (hash value) of this key.
SelectedPublicKeyKeyHashAlgorithmSpecifies the hash algorithm used with DSA keys to calculate signatures.
SelectedPublicKeyKeyIDContains a 8-byte key identifier.
SelectedPublicKeyOldPacketFormatIndicates whether legacy (PGP 2.
SelectedPublicKeyPassphraseThe key protection password.
SelectedPublicKeyPassphraseValidUse this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
SelectedPublicKeyPrimaryKeyIDIf this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
SelectedPublicKeyProtectionSpecifies the level of protection applied to the secret key.
SelectedPublicKeyPublicKeyAlgorithmSpecifies the asymmetric algorithm of the key.
SelectedPublicKeyQBitsThe length of the DSA Q (legitimate range: 160-512).
SelectedPublicKeyRevokedReturns True if the key has been revoked, and False otherwise.
SelectedPublicKeySubkeyFPThe 20-byte fingerprint (hash value) of this key's subkey.
SelectedPublicKeySubkeyIDContains a 8-byte subkey identifier.
SelectedPublicKeyTimestampUse this property to check the time the key was generated.
SelectedPublicKeyUsernameSpecifies the name of the user bound to this key.
SelectedPublicKeyValidIndicates the validity status of the key.
SelectedPublicKeyValidToProvide accurate expiration moment indication.
SelectedPublicKeyVersionIndicates the key version.
SelectedSecretKeyCountThe number of records in the SelectedSecretKey arrays.
SelectedSecretKeyBitsInKeyIndicates the key length in bits.
SelectedSecretKeyCanEncryptReturns True if this key can be used for encryption.
SelectedSecretKeyCanSignReturns True if this key can be used for signing.
SelectedSecretKeyCurveIndicates the elliptic curve associated with a EC key.
SelectedSecretKeyEnabledEnables or disables this key for use in encryption or signing operation.
SelectedSecretKeyEncryptionAlgorithmIndicates the symmetric algorithm used to encrypt the secret key.
SelectedSecretKeyExpiresIndicates key expiration time in whole days from its generation moment.
SelectedSecretKeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SelectedSecretKeyHashAlgorithmSpecifies the hash algorithm associated with the key.
SelectedSecretKeyIsPublicReturns True if this key is a public key, and False otherwise.
SelectedSecretKeyIsSecretReturns True if this key is a secret key, and False otherwise.
SelectedSecretKeyIsSubkeyReturns True if this key is a subkey of another key, and False otherwise.
SelectedSecretKeyKeyFPThe 20-byte fingerprint (hash value) of this key.
SelectedSecretKeyKeyHashAlgorithmSpecifies the hash algorithm used with DSA keys to calculate signatures.
SelectedSecretKeyKeyIDContains a 8-byte key identifier.
SelectedSecretKeyOldPacketFormatIndicates whether legacy (PGP 2.
SelectedSecretKeyPassphraseThe key protection password.
SelectedSecretKeyPassphraseValidUse this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
SelectedSecretKeyPrimaryKeyIDIf this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
SelectedSecretKeyProtectionSpecifies the level of protection applied to the secret key.
SelectedSecretKeyPublicKeyAlgorithmSpecifies the asymmetric algorithm of the key.
SelectedSecretKeyQBitsThe length of the DSA Q (legitimate range: 160-512).
SelectedSecretKeyRevokedReturns True if the key has been revoked, and False otherwise.
SelectedSecretKeySubkeyFPThe 20-byte fingerprint (hash value) of this key's subkey.
SelectedSecretKeySubkeyIDContains a 8-byte subkey identifier.
SelectedSecretKeyTimestampUse this property to check the time the key was generated.
SelectedSecretKeyUsernameSpecifies the name of the user bound to this key.
SelectedSecretKeyValidIndicates the validity status of the key.
SelectedSecretKeyValidToProvide accurate expiration moment indication.
SelectedSecretKeyVersionIndicates 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.

AddFromBytesAdds an existing key to the keyring.
AddFromFileAdds an existing key to the keyring.
AddFromFilesAdds a collection of keys to the keyring.
AddPinnedAdds a pinned secret key to the keyring.
ClearRemoves all the keys from the keyring.
CloseCloses the keyring.
ConfigSets or retrieves a configuration setting.
CreateNewCreates a new empty keyring.
DoActionPerforms an additional action.
LoadLoads a keyring from disk.
LoadFromBytesLoads a keyring from two byte arrays.
RemoveByIDRemoves key by its ID.
RemovePublicRemoves the specified public key from the keyring.
RemoveSecretRemoves the specified secret key from the keyring.
SaveSaves the keyring to disk.
SaveToBytesSaves the keyring to a byte array.
SelectFilters a selection of keys from the keyring using a template.

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.

FIPSMode Property (PGPKeyring Component)

Reserved.

Syntax

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

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

Opened Property (PGPKeyring Component)

Indicates if the keyring is in an opened state.

Syntax

__property bool Opened = { read=FOpened };

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.

Data Type

Boolean

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

PublicKeyCount Property (PGPKeyring Component)

The number of records in the PublicKey arrays.

Syntax

__property int PublicKeyCount = { read=FPublicKeyCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

PublicKeyBitsInKey Property (PGPKeyring Component)

Indicates the key length in bits.

Syntax

__property int PublicKeyBitsInKey[int PublicKeyIndex] = { read=FPublicKeyBitsInKey };

Default Value

2048

Remarks

Indicates the key length in bits.

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

Integer

PublicKeyCanEncrypt Property (PGPKeyring Component)

Returns True if this key can be used for encryption.

Syntax

__property bool PublicKeyCanEncrypt[int PublicKeyIndex] = { read=FPublicKeyCanEncrypt };

Default Value

false

Remarks

Returns True if this key can be used for encryption.

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

Boolean

PublicKeyCanSign Property (PGPKeyring Component)

Returns True if this key can be used for signing.

Syntax

__property bool PublicKeyCanSign[int PublicKeyIndex] = { read=FPublicKeyCanSign };

Default Value

false

Remarks

Returns True if this key can be used for signing.

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

Boolean

PublicKeyCurve Property (PGPKeyring Component)

Indicates the elliptic curve associated with a EC key.

Syntax

__property String PublicKeyCurve[int PublicKeyIndex] = { read=FPublicKeyCurve };

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 PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

String

PublicKeyEnabled Property (PGPKeyring Component)

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

Syntax

__property bool PublicKeyEnabled[int PublicKeyIndex] = { read=FPublicKeyEnabled };

Default Value

false

Remarks

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

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

Boolean

PublicKeyEncryptionAlgorithm Property (PGPKeyring Component)

Indicates the symmetric algorithm used to encrypt the secret key.

Syntax

__property String PublicKeyEncryptionAlgorithm[int PublicKeyIndex] = { read=FPublicKeyEncryptionAlgorithm };

Default Value

"CAST5"

Remarks

Indicates the symmetric algorithm used to encrypt the secret key.

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

String

PublicKeyExpires Property (PGPKeyring Component)

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

Syntax

__property int PublicKeyExpires[int PublicKeyIndex] = { read=FPublicKeyExpires };

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.

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

Integer

PublicKeyHandle Property (PGPKeyring Component)

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

Syntax

__property __int64 PublicKeyHandle[int PublicKeyIndex] = { read=FPublicKeyHandle };

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 PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

Long64

PublicKeyHashAlgorithm Property (PGPKeyring Component)

Specifies the hash algorithm associated with the key.

Syntax

__property String PublicKeyHashAlgorithm[int PublicKeyIndex] = { read=FPublicKeyHashAlgorithm };

Default Value

"SHA256"

Remarks

Specifies the hash algorithm associated with the key.

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

String

PublicKeyIsPublic Property (PGPKeyring Component)

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

Syntax

__property bool PublicKeyIsPublic[int PublicKeyIndex] = { read=FPublicKeyIsPublic };

Default Value

false

Remarks

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

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

Boolean

PublicKeyIsSecret Property (PGPKeyring Component)

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

Syntax

__property bool PublicKeyIsSecret[int PublicKeyIndex] = { read=FPublicKeyIsSecret };

Default Value

false

Remarks

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

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

Boolean

PublicKeyIsSubkey Property (PGPKeyring Component)

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

Syntax

__property bool PublicKeyIsSubkey[int PublicKeyIndex] = { read=FPublicKeyIsSubkey };

Default Value

false

Remarks

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

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

Boolean

PublicKeyKeyFP Property (PGPKeyring Component)

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

Syntax

__property String PublicKeyKeyFP[int PublicKeyIndex] = { read=FPublicKeyKeyFP };

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 PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

String

PublicKeyKeyHashAlgorithm Property (PGPKeyring Component)

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

Syntax

__property String PublicKeyKeyHashAlgorithm[int PublicKeyIndex] = { read=FPublicKeyKeyHashAlgorithm };

Default Value

"SHA256"

Remarks

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

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

String

PublicKeyKeyID Property (PGPKeyring Component)

Contains a 8-byte key identifier.

Syntax

__property String PublicKeyKeyID[int PublicKeyIndex] = { read=FPublicKeyKeyID };

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 PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

String

PublicKeyOldPacketFormat Property (PGPKeyring Component)

Indicates whether legacy (PGP 2.

Syntax

__property bool PublicKeyOldPacketFormat[int PublicKeyIndex] = { read=FPublicKeyOldPacketFormat };

Default Value

false

Remarks

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

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

Boolean

PublicKeyPassphrase Property (PGPKeyring Component)

The key protection password.

Syntax

__property String PublicKeyPassphrase[int PublicKeyIndex] = { read=FPublicKeyPassphrase };

Default Value

""

Remarks

The key protection password.

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

String

PublicKeyPassphraseValid 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 PublicKeyPassphraseValid[int PublicKeyIndex] = { read=FPublicKeyPassphraseValid };

Default Value

false

Remarks

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

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

Boolean

PublicKeyPrimaryKeyID 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 PublicKeyPrimaryKeyID[int PublicKeyIndex] = { read=FPublicKeyPrimaryKeyID };

Default Value

""

Remarks

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

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

String

PublicKeyProtection Property (PGPKeyring Component)

Specifies the level of protection applied to the secret key.

Syntax

__property TsbxPGPKeyringPublicKeyProtections PublicKeyProtection[int PublicKeyIndex] = { read=FPublicKeyProtection };
enum TsbxPGPKeyringPublicKeyProtections { 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 PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

Integer

PublicKeyPublicKeyAlgorithm Property (PGPKeyring Component)

Specifies the asymmetric algorithm of the key.

Syntax

__property String PublicKeyPublicKeyAlgorithm[int PublicKeyIndex] = { read=FPublicKeyPublicKeyAlgorithm };

Default Value

""

Remarks

Specifies the asymmetric algorithm of the key.

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

String

PublicKeyQBits Property (PGPKeyring Component)

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

Syntax

__property int PublicKeyQBits[int PublicKeyIndex] = { read=FPublicKeyQBits };

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 PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

Integer

PublicKeyRevoked Property (PGPKeyring Component)

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

Syntax

__property bool PublicKeyRevoked[int PublicKeyIndex] = { read=FPublicKeyRevoked };

Default Value

false

Remarks

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

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

Boolean

PublicKeySubkeyFP Property (PGPKeyring Component)

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

Syntax

__property String PublicKeySubkeyFP[int PublicKeyIndex] = { read=FPublicKeySubkeyFP };

Default Value

""

Remarks

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

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

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

String

PublicKeySubkeyID Property (PGPKeyring Component)

Contains a 8-byte subkey identifier.

Syntax

__property String PublicKeySubkeyID[int PublicKeyIndex] = { read=FPublicKeySubkeyID };

Default Value

""

Remarks

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.

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

String

PublicKeyTimestamp Property (PGPKeyring Component)

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

Syntax

__property String PublicKeyTimestamp[int PublicKeyIndex] = { read=FPublicKeyTimestamp };

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 PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

String

PublicKeyUsername Property (PGPKeyring Component)

Specifies the name of the user bound to this key.

Syntax

__property String PublicKeyUsername[int PublicKeyIndex] = { read=FPublicKeyUsername };

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 PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

String

PublicKeyValid Property (PGPKeyring Component)

Indicates the validity status of the key.

Syntax

__property TsbxPGPKeyringPublicKeyValids PublicKeyValid[int PublicKeyIndex] = { read=FPublicKeyValid };
enum TsbxPGPKeyringPublicKeyValids { pkvStrictlyValid=0, pkvValid=1, pkvInvalid=2, pkvFailure=3, pkvUnknown=4 };

Default Value

pkvStrictlyValid

Remarks

Indicates the validity status of the key.

pkvStrictlyValid0Strictly valid

pkvValid1Valid

pkvInvalid2Invalid

pkvFailure3Generic validation failure

pkvUnknown4Validity unknown

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

Integer

PublicKeyValidTo Property (PGPKeyring Component)

Provide accurate expiration moment indication.

Syntax

__property String PublicKeyValidTo[int PublicKeyIndex] = { read=FPublicKeyValidTo };

Default Value

"0"

Remarks

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

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

String

PublicKeyVersion Property (PGPKeyring Component)

Indicates the key version.

Syntax

__property int PublicKeyVersion[int PublicKeyIndex] = { read=FPublicKeyVersion };

Default Value

-1

Remarks

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.

The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.

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

Data Type

Integer

SecretKeyCount Property (PGPKeyring Component)

The number of records in the SecretKey arrays.

Syntax

__property int SecretKeyCount = { read=FSecretKeyCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

SecretKeyBitsInKey Property (PGPKeyring Component)

Indicates the key length in bits.

Syntax

__property int SecretKeyBitsInKey[int SecretKeyIndex] = { read=FSecretKeyBitsInKey };

Default Value

2048

Remarks

Indicates the key length in bits.

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

Integer

SecretKeyCanEncrypt Property (PGPKeyring Component)

Returns True if this key can be used for encryption.

Syntax

__property bool SecretKeyCanEncrypt[int SecretKeyIndex] = { read=FSecretKeyCanEncrypt };

Default Value

false

Remarks

Returns True if this key can be used for encryption.

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

Boolean

SecretKeyCanSign Property (PGPKeyring Component)

Returns True if this key can be used for signing.

Syntax

__property bool SecretKeyCanSign[int SecretKeyIndex] = { read=FSecretKeyCanSign };

Default Value

false

Remarks

Returns True if this key can be used for signing.

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

Boolean

SecretKeyCurve Property (PGPKeyring Component)

Indicates the elliptic curve associated with a EC key.

Syntax

__property String SecretKeyCurve[int SecretKeyIndex] = { read=FSecretKeyCurve };

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 SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

String

SecretKeyEnabled Property (PGPKeyring Component)

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

Syntax

__property bool SecretKeyEnabled[int SecretKeyIndex] = { read=FSecretKeyEnabled };

Default Value

false

Remarks

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

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

Boolean

SecretKeyEncryptionAlgorithm Property (PGPKeyring Component)

Indicates the symmetric algorithm used to encrypt the secret key.

Syntax

__property String SecretKeyEncryptionAlgorithm[int SecretKeyIndex] = { read=FSecretKeyEncryptionAlgorithm };

Default Value

"CAST5"

Remarks

Indicates the symmetric algorithm used to encrypt the secret key.

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

String

SecretKeyExpires Property (PGPKeyring Component)

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

Syntax

__property int SecretKeyExpires[int SecretKeyIndex] = { read=FSecretKeyExpires };

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.

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

Integer

SecretKeyHandle Property (PGPKeyring Component)

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

Syntax

__property __int64 SecretKeyHandle[int SecretKeyIndex] = { read=FSecretKeyHandle };

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 SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

Long64

SecretKeyHashAlgorithm Property (PGPKeyring Component)

Specifies the hash algorithm associated with the key.

Syntax

__property String SecretKeyHashAlgorithm[int SecretKeyIndex] = { read=FSecretKeyHashAlgorithm };

Default Value

"SHA256"

Remarks

Specifies the hash algorithm associated with the key.

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

String

SecretKeyIsPublic Property (PGPKeyring Component)

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

Syntax

__property bool SecretKeyIsPublic[int SecretKeyIndex] = { read=FSecretKeyIsPublic };

Default Value

false

Remarks

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

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

Boolean

SecretKeyIsSecret Property (PGPKeyring Component)

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

Syntax

__property bool SecretKeyIsSecret[int SecretKeyIndex] = { read=FSecretKeyIsSecret };

Default Value

false

Remarks

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

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

Boolean

SecretKeyIsSubkey Property (PGPKeyring Component)

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

Syntax

__property bool SecretKeyIsSubkey[int SecretKeyIndex] = { read=FSecretKeyIsSubkey };

Default Value

false

Remarks

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

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

Boolean

SecretKeyKeyFP Property (PGPKeyring Component)

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

Syntax

__property String SecretKeyKeyFP[int SecretKeyIndex] = { read=FSecretKeyKeyFP };

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 SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

String

SecretKeyKeyHashAlgorithm Property (PGPKeyring Component)

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

Syntax

__property String SecretKeyKeyHashAlgorithm[int SecretKeyIndex] = { read=FSecretKeyKeyHashAlgorithm };

Default Value

"SHA256"

Remarks

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

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

String

SecretKeyKeyID Property (PGPKeyring Component)

Contains a 8-byte key identifier.

Syntax

__property String SecretKeyKeyID[int SecretKeyIndex] = { read=FSecretKeyKeyID };

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 SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

String

SecretKeyOldPacketFormat Property (PGPKeyring Component)

Indicates whether legacy (PGP 2.

Syntax

__property bool SecretKeyOldPacketFormat[int SecretKeyIndex] = { read=FSecretKeyOldPacketFormat };

Default Value

false

Remarks

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

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

Boolean

SecretKeyPassphrase Property (PGPKeyring Component)

The key protection password.

Syntax

__property String SecretKeyPassphrase[int SecretKeyIndex] = { read=FSecretKeyPassphrase };

Default Value

""

Remarks

The key protection password.

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

String

SecretKeyPassphraseValid 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 SecretKeyPassphraseValid[int SecretKeyIndex] = { read=FSecretKeyPassphraseValid };

Default Value

false

Remarks

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

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

Boolean

SecretKeyPrimaryKeyID 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 SecretKeyPrimaryKeyID[int SecretKeyIndex] = { read=FSecretKeyPrimaryKeyID };

Default Value

""

Remarks

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

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

String

SecretKeyProtection Property (PGPKeyring Component)

Specifies the level of protection applied to the secret key.

Syntax

__property TsbxPGPKeyringSecretKeyProtections SecretKeyProtection[int SecretKeyIndex] = { read=FSecretKeyProtection };
enum TsbxPGPKeyringSecretKeyProtections { 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 SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

Integer

SecretKeyPublicKeyAlgorithm Property (PGPKeyring Component)

Specifies the asymmetric algorithm of the key.

Syntax

__property String SecretKeyPublicKeyAlgorithm[int SecretKeyIndex] = { read=FSecretKeyPublicKeyAlgorithm };

Default Value

""

Remarks

Specifies the asymmetric algorithm of the key.

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

String

SecretKeyQBits Property (PGPKeyring Component)

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

Syntax

__property int SecretKeyQBits[int SecretKeyIndex] = { read=FSecretKeyQBits };

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 SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

Integer

SecretKeyRevoked Property (PGPKeyring Component)

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

Syntax

__property bool SecretKeyRevoked[int SecretKeyIndex] = { read=FSecretKeyRevoked };

Default Value

false

Remarks

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

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

Boolean

SecretKeySubkeyFP Property (PGPKeyring Component)

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

Syntax

__property String SecretKeySubkeyFP[int SecretKeyIndex] = { read=FSecretKeySubkeyFP };

Default Value

""

Remarks

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

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

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

String

SecretKeySubkeyID Property (PGPKeyring Component)

Contains a 8-byte subkey identifier.

Syntax

__property String SecretKeySubkeyID[int SecretKeyIndex] = { read=FSecretKeySubkeyID };

Default Value

""

Remarks

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.

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

String

SecretKeyTimestamp Property (PGPKeyring Component)

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

Syntax

__property String SecretKeyTimestamp[int SecretKeyIndex] = { read=FSecretKeyTimestamp };

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 SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

String

SecretKeyUsername Property (PGPKeyring Component)

Specifies the name of the user bound to this key.

Syntax

__property String SecretKeyUsername[int SecretKeyIndex] = { read=FSecretKeyUsername };

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 SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

String

SecretKeyValid Property (PGPKeyring Component)

Indicates the validity status of the key.

Syntax

__property TsbxPGPKeyringSecretKeyValids SecretKeyValid[int SecretKeyIndex] = { read=FSecretKeyValid };
enum TsbxPGPKeyringSecretKeyValids { pkvStrictlyValid=0, pkvValid=1, pkvInvalid=2, pkvFailure=3, pkvUnknown=4 };

Default Value

pkvStrictlyValid

Remarks

Indicates the validity status of the key.

pkvStrictlyValid0Strictly valid

pkvValid1Valid

pkvInvalid2Invalid

pkvFailure3Generic validation failure

pkvUnknown4Validity unknown

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

Integer

SecretKeyValidTo Property (PGPKeyring Component)

Provide accurate expiration moment indication.

Syntax

__property String SecretKeyValidTo[int SecretKeyIndex] = { read=FSecretKeyValidTo };

Default Value

"0"

Remarks

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

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

String

SecretKeyVersion Property (PGPKeyring Component)

Indicates the key version.

Syntax

__property int SecretKeyVersion[int SecretKeyIndex] = { read=FSecretKeyVersion };

Default Value

-1

Remarks

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.

The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

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

Data Type

Integer

SelectedPublicKeyCount Property (PGPKeyring Component)

The number of records in the SelectedPublicKey arrays.

Syntax

__property int SelectedPublicKeyCount = { read=FSelectedPublicKeyCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

SelectedPublicKeyBitsInKey Property (PGPKeyring Component)

Indicates the key length in bits.

Syntax

__property int SelectedPublicKeyBitsInKey[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyBitsInKey };

Default Value

2048

Remarks

Indicates the key length in bits.

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

Integer

SelectedPublicKeyCanEncrypt Property (PGPKeyring Component)

Returns True if this key can be used for encryption.

Syntax

__property bool SelectedPublicKeyCanEncrypt[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyCanEncrypt };

Default Value

false

Remarks

Returns True if this key can be used for encryption.

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

Boolean

SelectedPublicKeyCanSign Property (PGPKeyring Component)

Returns True if this key can be used for signing.

Syntax

__property bool SelectedPublicKeyCanSign[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyCanSign };

Default Value

false

Remarks

Returns True if this key can be used for signing.

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

Boolean

SelectedPublicKeyCurve Property (PGPKeyring Component)

Indicates the elliptic curve associated with a EC key.

Syntax

__property String SelectedPublicKeyCurve[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyCurve };

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 SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

String

SelectedPublicKeyEnabled Property (PGPKeyring Component)

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

Syntax

__property bool SelectedPublicKeyEnabled[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyEnabled };

Default Value

false

Remarks

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

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

Boolean

SelectedPublicKeyEncryptionAlgorithm Property (PGPKeyring Component)

Indicates the symmetric algorithm used to encrypt the secret key.

Syntax

__property String SelectedPublicKeyEncryptionAlgorithm[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyEncryptionAlgorithm };

Default Value

"CAST5"

Remarks

Indicates the symmetric algorithm used to encrypt the secret key.

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

String

SelectedPublicKeyExpires Property (PGPKeyring Component)

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

Syntax

__property int SelectedPublicKeyExpires[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyExpires };

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.

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

Integer

SelectedPublicKeyHandle Property (PGPKeyring Component)

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

Syntax

__property __int64 SelectedPublicKeyHandle[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyHandle };

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 SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

Long64

SelectedPublicKeyHashAlgorithm Property (PGPKeyring Component)

Specifies the hash algorithm associated with the key.

Syntax

__property String SelectedPublicKeyHashAlgorithm[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyHashAlgorithm };

Default Value

"SHA256"

Remarks

Specifies the hash algorithm associated with the key.

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

String

SelectedPublicKeyIsPublic Property (PGPKeyring Component)

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

Syntax

__property bool SelectedPublicKeyIsPublic[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyIsPublic };

Default Value

false

Remarks

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

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

Boolean

SelectedPublicKeyIsSecret Property (PGPKeyring Component)

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

Syntax

__property bool SelectedPublicKeyIsSecret[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyIsSecret };

Default Value

false

Remarks

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

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

Boolean

SelectedPublicKeyIsSubkey Property (PGPKeyring Component)

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

Syntax

__property bool SelectedPublicKeyIsSubkey[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyIsSubkey };

Default Value

false

Remarks

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

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

Boolean

SelectedPublicKeyKeyFP Property (PGPKeyring Component)

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

Syntax

__property String SelectedPublicKeyKeyFP[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyKeyFP };

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 SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

String

SelectedPublicKeyKeyHashAlgorithm Property (PGPKeyring Component)

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

Syntax

__property String SelectedPublicKeyKeyHashAlgorithm[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyKeyHashAlgorithm };

Default Value

"SHA256"

Remarks

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

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

String

SelectedPublicKeyKeyID Property (PGPKeyring Component)

Contains a 8-byte key identifier.

Syntax

__property String SelectedPublicKeyKeyID[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyKeyID };

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 SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

String

SelectedPublicKeyOldPacketFormat Property (PGPKeyring Component)

Indicates whether legacy (PGP 2.

Syntax

__property bool SelectedPublicKeyOldPacketFormat[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyOldPacketFormat };

Default Value

false

Remarks

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

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

Boolean

SelectedPublicKeyPassphrase Property (PGPKeyring Component)

The key protection password.

Syntax

__property String SelectedPublicKeyPassphrase[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyPassphrase };

Default Value

""

Remarks

The key protection password.

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

String

SelectedPublicKeyPassphraseValid 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 SelectedPublicKeyPassphraseValid[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyPassphraseValid };

Default Value

false

Remarks

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

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

Boolean

SelectedPublicKeyPrimaryKeyID 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 SelectedPublicKeyPrimaryKeyID[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyPrimaryKeyID };

Default Value

""

Remarks

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

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

String

SelectedPublicKeyProtection Property (PGPKeyring Component)

Specifies the level of protection applied to the secret key.

Syntax

__property TsbxPGPKeyringSelectedPublicKeyProtections SelectedPublicKeyProtection[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyProtection };
enum TsbxPGPKeyringSelectedPublicKeyProtections { 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 SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

Integer

SelectedPublicKeyPublicKeyAlgorithm Property (PGPKeyring Component)

Specifies the asymmetric algorithm of the key.

Syntax

__property String SelectedPublicKeyPublicKeyAlgorithm[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyPublicKeyAlgorithm };

Default Value

""

Remarks

Specifies the asymmetric algorithm of the key.

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

String

SelectedPublicKeyQBits Property (PGPKeyring Component)

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

Syntax

__property int SelectedPublicKeyQBits[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyQBits };

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 SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

Integer

SelectedPublicKeyRevoked Property (PGPKeyring Component)

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

Syntax

__property bool SelectedPublicKeyRevoked[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyRevoked };

Default Value

false

Remarks

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

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

Boolean

SelectedPublicKeySubkeyFP Property (PGPKeyring Component)

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

Syntax

__property String SelectedPublicKeySubkeyFP[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeySubkeyFP };

Default Value

""

Remarks

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

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

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

String

SelectedPublicKeySubkeyID Property (PGPKeyring Component)

Contains a 8-byte subkey identifier.

Syntax

__property String SelectedPublicKeySubkeyID[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeySubkeyID };

Default Value

""

Remarks

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.

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

String

SelectedPublicKeyTimestamp Property (PGPKeyring Component)

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

Syntax

__property String SelectedPublicKeyTimestamp[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyTimestamp };

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 SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

String

SelectedPublicKeyUsername Property (PGPKeyring Component)

Specifies the name of the user bound to this key.

Syntax

__property String SelectedPublicKeyUsername[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyUsername };

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 SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

String

SelectedPublicKeyValid Property (PGPKeyring Component)

Indicates the validity status of the key.

Syntax

__property TsbxPGPKeyringSelectedPublicKeyValids SelectedPublicKeyValid[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyValid };
enum TsbxPGPKeyringSelectedPublicKeyValids { pkvStrictlyValid=0, pkvValid=1, pkvInvalid=2, pkvFailure=3, pkvUnknown=4 };

Default Value

pkvStrictlyValid

Remarks

Indicates the validity status of the key.

pkvStrictlyValid0Strictly valid

pkvValid1Valid

pkvInvalid2Invalid

pkvFailure3Generic validation failure

pkvUnknown4Validity unknown

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

Integer

SelectedPublicKeyValidTo Property (PGPKeyring Component)

Provide accurate expiration moment indication.

Syntax

__property String SelectedPublicKeyValidTo[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyValidTo };

Default Value

"0"

Remarks

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

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

String

SelectedPublicKeyVersion Property (PGPKeyring Component)

Indicates the key version.

Syntax

__property int SelectedPublicKeyVersion[int SelectedPublicKeyIndex] = { read=FSelectedPublicKeyVersion };

Default Value

-1

Remarks

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.

The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.

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

Data Type

Integer

SelectedSecretKeyCount Property (PGPKeyring Component)

The number of records in the SelectedSecretKey arrays.

Syntax

__property int SelectedSecretKeyCount = { read=FSelectedSecretKeyCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

SelectedSecretKeyBitsInKey Property (PGPKeyring Component)

Indicates the key length in bits.

Syntax

__property int SelectedSecretKeyBitsInKey[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyBitsInKey };

Default Value

2048

Remarks

Indicates the key length in bits.

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

Integer

SelectedSecretKeyCanEncrypt Property (PGPKeyring Component)

Returns True if this key can be used for encryption.

Syntax

__property bool SelectedSecretKeyCanEncrypt[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyCanEncrypt };

Default Value

false

Remarks

Returns True if this key can be used for encryption.

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

Boolean

SelectedSecretKeyCanSign Property (PGPKeyring Component)

Returns True if this key can be used for signing.

Syntax

__property bool SelectedSecretKeyCanSign[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyCanSign };

Default Value

false

Remarks

Returns True if this key can be used for signing.

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

Boolean

SelectedSecretKeyCurve Property (PGPKeyring Component)

Indicates the elliptic curve associated with a EC key.

Syntax

__property String SelectedSecretKeyCurve[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyCurve };

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 SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

String

SelectedSecretKeyEnabled Property (PGPKeyring Component)

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

Syntax

__property bool SelectedSecretKeyEnabled[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyEnabled };

Default Value

false

Remarks

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

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

Boolean

SelectedSecretKeyEncryptionAlgorithm Property (PGPKeyring Component)

Indicates the symmetric algorithm used to encrypt the secret key.

Syntax

__property String SelectedSecretKeyEncryptionAlgorithm[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyEncryptionAlgorithm };

Default Value

"CAST5"

Remarks

Indicates the symmetric algorithm used to encrypt the secret key.

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

String

SelectedSecretKeyExpires Property (PGPKeyring Component)

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

Syntax

__property int SelectedSecretKeyExpires[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyExpires };

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.

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

Integer

SelectedSecretKeyHandle Property (PGPKeyring Component)

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

Syntax

__property __int64 SelectedSecretKeyHandle[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyHandle };

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 SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

Long64

SelectedSecretKeyHashAlgorithm Property (PGPKeyring Component)

Specifies the hash algorithm associated with the key.

Syntax

__property String SelectedSecretKeyHashAlgorithm[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyHashAlgorithm };

Default Value

"SHA256"

Remarks

Specifies the hash algorithm associated with the key.

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

String

SelectedSecretKeyIsPublic Property (PGPKeyring Component)

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

Syntax

__property bool SelectedSecretKeyIsPublic[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyIsPublic };

Default Value

false

Remarks

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

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

Boolean

SelectedSecretKeyIsSecret Property (PGPKeyring Component)

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

Syntax

__property bool SelectedSecretKeyIsSecret[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyIsSecret };

Default Value

false

Remarks

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

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

Boolean

SelectedSecretKeyIsSubkey Property (PGPKeyring Component)

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

Syntax

__property bool SelectedSecretKeyIsSubkey[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyIsSubkey };

Default Value

false

Remarks

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

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

Boolean

SelectedSecretKeyKeyFP Property (PGPKeyring Component)

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

Syntax

__property String SelectedSecretKeyKeyFP[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyKeyFP };

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 SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

String

SelectedSecretKeyKeyHashAlgorithm Property (PGPKeyring Component)

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

Syntax

__property String SelectedSecretKeyKeyHashAlgorithm[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyKeyHashAlgorithm };

Default Value

"SHA256"

Remarks

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

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

String

SelectedSecretKeyKeyID Property (PGPKeyring Component)

Contains a 8-byte key identifier.

Syntax

__property String SelectedSecretKeyKeyID[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyKeyID };

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 SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

String

SelectedSecretKeyOldPacketFormat Property (PGPKeyring Component)

Indicates whether legacy (PGP 2.

Syntax

__property bool SelectedSecretKeyOldPacketFormat[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyOldPacketFormat };

Default Value

false

Remarks

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

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

Boolean

SelectedSecretKeyPassphrase Property (PGPKeyring Component)

The key protection password.

Syntax

__property String SelectedSecretKeyPassphrase[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyPassphrase };

Default Value

""

Remarks

The key protection password.

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

String

SelectedSecretKeyPassphraseValid 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 SelectedSecretKeyPassphraseValid[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyPassphraseValid };

Default Value

false

Remarks

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

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

Boolean

SelectedSecretKeyPrimaryKeyID 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 SelectedSecretKeyPrimaryKeyID[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyPrimaryKeyID };

Default Value

""

Remarks

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

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

String

SelectedSecretKeyProtection Property (PGPKeyring Component)

Specifies the level of protection applied to the secret key.

Syntax

__property TsbxPGPKeyringSelectedSecretKeyProtections SelectedSecretKeyProtection[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyProtection };
enum TsbxPGPKeyringSelectedSecretKeyProtections { 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 SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

Integer

SelectedSecretKeyPublicKeyAlgorithm Property (PGPKeyring Component)

Specifies the asymmetric algorithm of the key.

Syntax

__property String SelectedSecretKeyPublicKeyAlgorithm[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyPublicKeyAlgorithm };

Default Value

""

Remarks

Specifies the asymmetric algorithm of the key.

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

String

SelectedSecretKeyQBits Property (PGPKeyring Component)

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

Syntax

__property int SelectedSecretKeyQBits[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyQBits };

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 SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

Integer

SelectedSecretKeyRevoked Property (PGPKeyring Component)

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

Syntax

__property bool SelectedSecretKeyRevoked[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyRevoked };

Default Value

false

Remarks

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

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

Boolean

SelectedSecretKeySubkeyFP Property (PGPKeyring Component)

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

Syntax

__property String SelectedSecretKeySubkeyFP[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeySubkeyFP };

Default Value

""

Remarks

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

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

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

String

SelectedSecretKeySubkeyID Property (PGPKeyring Component)

Contains a 8-byte subkey identifier.

Syntax

__property String SelectedSecretKeySubkeyID[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeySubkeyID };

Default Value

""

Remarks

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.

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

String

SelectedSecretKeyTimestamp Property (PGPKeyring Component)

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

Syntax

__property String SelectedSecretKeyTimestamp[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyTimestamp };

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 SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

String

SelectedSecretKeyUsername Property (PGPKeyring Component)

Specifies the name of the user bound to this key.

Syntax

__property String SelectedSecretKeyUsername[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyUsername };

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 SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

String

SelectedSecretKeyValid Property (PGPKeyring Component)

Indicates the validity status of the key.

Syntax

__property TsbxPGPKeyringSelectedSecretKeyValids SelectedSecretKeyValid[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyValid };
enum TsbxPGPKeyringSelectedSecretKeyValids { pkvStrictlyValid=0, pkvValid=1, pkvInvalid=2, pkvFailure=3, pkvUnknown=4 };

Default Value

pkvStrictlyValid

Remarks

Indicates the validity status of the key.

pkvStrictlyValid0Strictly valid

pkvValid1Valid

pkvInvalid2Invalid

pkvFailure3Generic validation failure

pkvUnknown4Validity unknown

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

Integer

SelectedSecretKeyValidTo Property (PGPKeyring Component)

Provide accurate expiration moment indication.

Syntax

__property String SelectedSecretKeyValidTo[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyValidTo };

Default Value

"0"

Remarks

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

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

String

SelectedSecretKeyVersion Property (PGPKeyring Component)

Indicates the key version.

Syntax

__property int SelectedSecretKeyVersion[int SelectedSecretKeyIndex] = { read=FSelectedSecretKeyVersion };

Default Value

-1

Remarks

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.

The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.

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

Data Type

Integer

AddFromBytes Method (PGPKeyring Component)

Adds an existing key to the keyring.

Syntax

void __fastcall AddFromBytes(DynamicArray<Byte> Bytes);

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

void __fastcall AddFromFile(String Filename);

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

void __fastcall AddFromFiles(String PublicKeyringFile, String SecretKeyringFile);

Remarks

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

AddPinned Method (PGPKeyring Component)

Adds a pinned secret key to the keyring.

Syntax

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

void __fastcall Clear();

Remarks

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

Close Method (PGPKeyring Component)

Closes the keyring.

Syntax

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

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.

CreateNew Method (PGPKeyring Component)

Creates a new empty keyring.

Syntax

void __fastcall CreateNew();

Remarks

Use this method to initialize a new empty keyring.

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

void __fastcall Load(String PublicKeyringFile, String SecretKeyringFile);

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

void __fastcall LoadFromBytes(DynamicArray<Byte> PublicKeyring, DynamicArray<Byte> SecretKeyring);

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.

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.

RemovePublic Method (PGPKeyring Component)

Removes the specified public key from the keyring.

Syntax

void __fastcall RemovePublic(int Index);

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

void __fastcall RemoveSecret(int Index);

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

void __fastcall Save(String PublicKeyringFile, String SecretKeyringFile);

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

DynamicArray<Byte> __fastcall SaveToBytes(bool Secret);

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

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 SelectedPublicKeys and SelectedSecretKeys properties.

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