PGPKeyManager Component

Properties   Methods   Events   Config Settings   Errors  

The PGPKeyManager component manages PGP keys.

Syntax

TsbxPGPKeyManager

Remarks

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

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

KeyBitsInKey Property (PGPKeyManager Component)

Indicates the key length in bits.

Syntax

__property int KeyBitsInKey = { read=FKeyBitsInKey };

Default Value

2048

Remarks

Indicates the key length in bits.

This property is read-only.

Data Type

Integer

KeyCanEncrypt Property (PGPKeyManager Component)

Returns True if this key can be used for encryption.

Syntax

__property bool KeyCanEncrypt = { read=FKeyCanEncrypt };

Default Value

false

Remarks

Returns True if this key can be used for encryption.

This property is read-only.

Data Type

Boolean

KeyCanSign Property (PGPKeyManager Component)

Returns True if this key can be used for signing.

Syntax

__property bool KeyCanSign = { read=FKeyCanSign };

Default Value

false

Remarks

Returns True if this key can be used for signing.

This property is read-only.

Data Type

Boolean

KeyCurve Property (PGPKeyManager Component)

Indicates the elliptic curve associated with a EC key.

Syntax

__property String KeyCurve = { read=FKeyCurve };

Default Value

""

Remarks

Indicates the elliptic curve associated with a EC key.

Supported values:

This property is read-only.

Data Type

String

KeyEnabled Property (PGPKeyManager Component)

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

Syntax

__property bool KeyEnabled = { read=FKeyEnabled, write=FSetKeyEnabled };

Default Value

false

Remarks

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

Data Type

Boolean

KeyEncryptionAlgorithm Property (PGPKeyManager Component)

Indicates the symmetric algorithm used to encrypt the secret key.

Syntax

__property String KeyEncryptionAlgorithm = { read=FKeyEncryptionAlgorithm };

Default Value

"AES128"

Remarks

Indicates the symmetric algorithm used to encrypt the secret key.

This property is read-only.

Data Type

String

KeyIsPublic Property (PGPKeyManager Component)

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

Syntax

__property bool KeyIsPublic = { read=FKeyIsPublic };

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

KeyIsSecret Property (PGPKeyManager Component)

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

Syntax

__property bool KeyIsSecret = { read=FKeyIsSecret };

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

KeyIsSubkey Property (PGPKeyManager Component)

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

Syntax

__property bool KeyIsSubkey = { read=FKeyIsSubkey };

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

KeyKeyFP Property (PGPKeyManager Component)

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

Syntax

__property String KeyKeyFP = { read=FKeyKeyFP };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

KeyKeyID Property (PGPKeyManager Component)

Contains a 8-byte key identifier.

Syntax

__property String KeyKeyID = { read=FKeyKeyID };

Default Value

""

Remarks

Contains a 8-byte key identifier.

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

This property is read-only.

Data Type

String

KeyPassphrase Property (PGPKeyManager Component)

The key protection password.

Syntax

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

Default Value

""

Remarks

The key protection password.

Data Type

String

KeyPassphraseValid Property (PGPKeyManager Component)

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

Syntax

__property bool KeyPassphraseValid = { read=FKeyPassphraseValid };

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

KeyPrimaryKeyID Property (PGPKeyManager Component)

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

Syntax

__property String KeyPrimaryKeyID = { read=FKeyPrimaryKeyID };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

KeyProtection Property (PGPKeyManager Component)

Specifies the level of protection applied to the secret key.

Syntax

__property TsbxPGPKeyManagerKeyProtections KeyProtection = { read=FKeyProtection };

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

Default Value

pptNone

Remarks

Specifies the level of protection applied to the secret key.

Allowed values:

This property is read-only.

Data Type

Integer

KeyPublicKeyAlgorithm Property (PGPKeyManager Component)

Specifies the asymmetric algorithm of the key.

Syntax

__property String KeyPublicKeyAlgorithm = { read=FKeyPublicKeyAlgorithm };

Default Value

""

Remarks

Specifies the asymmetric algorithm of the key.

This property is read-only.

Data Type

String

KeyQBits Property (PGPKeyManager Component)

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

Syntax

__property int KeyQBits = { read=FKeyQBits };

Default Value

0

Remarks

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

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

This property is read-only.

Data Type

Integer

KeyTimestamp Property (PGPKeyManager Component)

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

Syntax

__property String KeyTimestamp = { read=FKeyTimestamp };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

KeyUsername Property (PGPKeyManager Component)

Specifies the name of the user bound to this key.

Syntax

__property String KeyUsername = { read=FKeyUsername };

Default Value

""

Remarks

Specifies the name of the user bound to this key.

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

This property is read-only.

Data Type

String

KeyValidTo Property (PGPKeyManager Component)

Provide accurate expiration moment indication.

Syntax

__property String KeyValidTo = { read=FKeyValidTo };

Default Value

"0"

Remarks

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

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

Data Type

String

KeyVersion Property (PGPKeyManager Component)

Indicates the key version.

Syntax

__property int KeyVersion = { read=FKeyVersion };

Default Value

0

Remarks

Indicates the key version.

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

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

This property is read-only.

Data Type

Integer

PinnedKeyHandle Property (PGPKeyManager 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

SignatureCount Property (PGPKeyManager Component)

The number of records in the Signature arrays.

Syntax

__property int SignatureCount = { read=FSignatureCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignatureCertificationType
• SignatureCreationTime
• SignatureExpirationTime
• SignatureExportable
• SignatureHandle
• SignatureHashAlgorithm
• SignatureHashMark
• SignatureKeyExpirationTime
• SignatureKeyFlags
• SignatureLegacyFormat
• SignaturePolicyURL
• SignaturePreferredAlgorithms
• SignaturePrimaryUserID
• SignatureReasonForRevocation
• SignatureRevocable
• SignatureRevocation
• SignatureSignatureClass
• SignatureSignerKeyID
• SignatureSignerUserID
• SignatureStrictlyValid
• SignatureTarget
• SignatureTextSignature
• SignatureTrustAmount
• SignatureTrustLevel
• SignatureValidated
• SignatureValidity
• SignatureVersion

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

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

Data Type

Integer

SignatureCertificationType Property (PGPKeyManager Component)

Specifies the type of a UserID signature.

Syntax

__property TsbxPGPKeyManagerSignatureCertificationTypes SignatureCertificationType[int SignatureIndex] = { read=FSignatureCertificationType };

enum TsbxPGPKeyManagerSignatureCertificationTypes {
  pctGeneric=0,
  pctPersona=1,
  pctCasual=2,
  pctPositive=3
};

Default Value

pctGeneric

Remarks

Specifies the type of a UserID signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Integer

SignatureCreationTime Property (PGPKeyManager Component)

The time when the signature was created, in Universal Coordinated Time (UTC).

Syntax

__property String SignatureCreationTime[int SignatureIndex] = { read=FSignatureCreationTime };

Default Value

""

Remarks

The time when the signature was created, in Universal Coordinated Time (UTC).

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

String

SignatureExpirationTime Property (PGPKeyManager Component)

Specifies signature expiration time, in seconds since its creation time (CreationTime).

Syntax

__property int SignatureExpirationTime[int SignatureIndex] = { read=FSignatureExpirationTime };

Default Value

0

Remarks

Specifies signature expiration time, in seconds since its creation time (CreationTime).

Ths property set to 0 indicates that the signature never expires.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Integer

SignatureExportable Property (PGPKeyManager Component)

Specifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer.

Syntax

__property bool SignatureExportable[int SignatureIndex] = { read=FSignatureExportable };

Default Value

false

Remarks

Specifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Boolean

SignatureHandle Property (PGPKeyManager Component)

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

Syntax

__property __int64 SignatureHandle[int SignatureIndex] = { read=FSignatureHandle };

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

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

Data Type

Long64

SignatureHashAlgorithm Property (PGPKeyManager Component)

Specifies the hash algorithm used in the signature.

Syntax

__property String SignatureHashAlgorithm[int SignatureIndex] = { read=FSignatureHashAlgorithm };

Default Value

""

Remarks

Specifies the hash algorithm used in the signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

String

SignatureHashMark Property (PGPKeyManager Component)

Returns the hash mark attribute of a signature.

Syntax

__property int SignatureHashMark[int SignatureIndex] = { read=FSignatureHashMark };

Default Value

0

Remarks

Returns the hash mark attribute of a signature.

Check this property to get a hash mark of a signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Integer

SignatureKeyExpirationTime Property (PGPKeyManager Component)

The number of seconds after which the signed key will expire.

Syntax

__property int SignatureKeyExpirationTime[int SignatureIndex] = { read=FSignatureKeyExpirationTime };

Default Value

0

Remarks

The number of seconds after which the signed key will expire.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Integer

SignatureKeyFlags Property (PGPKeyManager Component)

Returns the key flags included in the signature.

Syntax

__property int SignatureKeyFlags[int SignatureIndex] = { read=FSignatureKeyFlags };

Default Value

0

Remarks

Returns the key flags included in the signature.

Use this property to retrieve the key flags stored in the key signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Integer

SignatureLegacyFormat Property (PGPKeyManager Component)

Indicates whether signature uses PGP 2.

Syntax

__property bool SignatureLegacyFormat[int SignatureIndex] = { read=FSignatureLegacyFormat };

Default Value

false

Remarks

Indicates whether signature uses PGP 2.6.x-compatible packet format.

The signature is fully compatible with the 'old' format only if it has version 3, uses MD5 hash algorithm, RSA public key algorithm, and its key length is not greater than 1024 bits.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Boolean

SignaturePolicyURL Property (PGPKeyManager Component)

Contains the URL of the signature policy.

Syntax

__property String SignaturePolicyURL[int SignatureIndex] = { read=FSignaturePolicyURL };

Default Value

""

Remarks

Contains the URL of the signature policy.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

String

SignaturePreferredAlgorithms Property (PGPKeyManager Component)

Contains a list of algorithms preferred by the signed key holder.

Syntax

__property String SignaturePreferredAlgorithms[int SignatureIndex] = { read=FSignaturePreferredAlgorithms };

Default Value

""

Remarks

Contains a list of algorithms preferred by the signed key holder.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

String

SignaturePrimaryUserID Property (PGPKeyManager Component)

Indicates whether the UserID covered by the signature is the main user id for this key.

Syntax

__property bool SignaturePrimaryUserID[int SignatureIndex] = { read=FSignaturePrimaryUserID };

Default Value

false

Remarks

Indicates whether the UserID covered by the signature is the main user id for this key.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Boolean

SignatureReasonForRevocation Property (PGPKeyManager Component)

Describes the reason why the key or the certificate was revoked.

Syntax

__property String SignatureReasonForRevocation[int SignatureIndex] = { read=FSignatureReasonForRevocation };

Default Value

""

Remarks

Describes the reason why the key or the certificate was revoked.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

String

SignatureRevocable Property (PGPKeyManager Component)

Specifies whether the signature can be revoked.

Syntax

__property bool SignatureRevocable[int SignatureIndex] = { read=FSignatureRevocable };

Default Value

false

Remarks

Specifies whether the signature can be revoked.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Boolean

SignatureRevocation Property (PGPKeyManager Component)

Indicates whether or not the signature is a revocation signature.

Syntax

__property bool SignatureRevocation[int SignatureIndex] = { read=FSignatureRevocation };

Default Value

false

Remarks

Indicates whether or not the signature is a revocation signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Boolean

SignatureSignatureClass Property (PGPKeyManager Component)

Indicates the signature class.

Syntax

__property TsbxPGPKeyManagerSignatureSignatureClass SignatureSignatureClass[int SignatureIndex] = { read=FSignatureSignatureClass };

enum TsbxPGPKeyManagerSignatureSignatureClass {
  pscDocument=0,
  pscTextDocument=1,
  pscStandalone=2,
  pscUIDGeneric=3,
  pscUIDPersona=4,
  pscUIDCasual=5,
  pscUIDPositive=6,
  pscSubkeyBinding=7,
  pscPrimaryKeyBinding=8,
  pscDirectKey=9,
  pscKeyRevocation=10,
  pscSubkeyRevocation=11,
  pscCertRevocation=12,
  pscTimestamp=13,
  pscThirdParty=14,
  pscNotSpecified=15
};

Default Value

pscDocument

Remarks

Indicates the signature class.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Integer

SignatureSignerKeyID Property (PGPKeyManager Component)

Indicates the KeyID of the signing key.

Syntax

__property String SignatureSignerKeyID[int SignatureIndex] = { read=FSignatureSignerKeyID };

Default Value

""

Remarks

Indicates the KeyID of the signing key.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

String

SignatureSignerUserID Property (PGPKeyManager Component)

Indicates the UserID associated with the signing key.

Syntax

__property String SignatureSignerUserID[int SignatureIndex] = { read=FSignatureSignerUserID };

Default Value

""

Remarks

Indicates the UserID associated with the signing key.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

String

SignatureStrictlyValid Property (PGPKeyManager Component)

Returns True if this signature is valid in a strict way (no compatibility relaxations).

Syntax

__property bool SignatureStrictlyValid[int SignatureIndex] = { read=FSignatureStrictlyValid };

Default Value

false

Remarks

Returns True if this signature is valid in a strict way (no compatibility relaxations).

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Boolean

SignatureTarget Property (PGPKeyManager Component)

Indicates the KeyID or Username of the target key or user.

Syntax

__property String SignatureTarget[int SignatureIndex] = { read=FSignatureTarget };

Default Value

""

Remarks

Indicates the KeyID or Username of the target key or user.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

String

SignatureTextSignature Property (PGPKeyManager Component)

Indicates whether or not the signature is made over a text document.

Syntax

__property bool SignatureTextSignature[int SignatureIndex] = { read=FSignatureTextSignature };

Default Value

false

Remarks

Indicates whether or not the signature is made over a text document.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Boolean

SignatureTrustAmount Property (PGPKeyManager Component)

Specifies the amount of trust assigned by this signature.

Syntax

__property int SignatureTrustAmount[int SignatureIndex] = { read=FSignatureTrustAmount };

Default Value

0

Remarks

Specifies the amount of trust assigned by this signature.

Specifies the amount of trust, in range 0-255, interpreted such that values less than 120 indicate partial trust and values of 120 or greater indicate complete trust.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Integer

SignatureTrustLevel Property (PGPKeyManager Component)

The trust level assigned by this signature.

Syntax

__property int SignatureTrustLevel[int SignatureIndex] = { read=FSignatureTrustLevel };

Default Value

0

Remarks

The trust level assigned by this signature.

Level 1 means that the signed key is asserted to be a valid trusted introducer, with the 2nd octet of the body specifying the degree of trust. Level n means that the signed key is asserted to be trusted to issue level (n-1)-trust signatures.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Integer

SignatureValidated Property (PGPKeyManager Component)

Whether the signature has been validated.

Syntax

__property bool SignatureValidated[int SignatureIndex] = { read=FSignatureValidated };

Default Value

false

Remarks

Whether the signature has been validated.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Boolean

SignatureValidity Property (PGPKeyManager Component)

Provides the validity status of the signature if the signature has been validated.

Syntax

__property TsbxPGPKeyManagerSignatureValidities SignatureValidity[int SignatureIndex] = { read=FSignatureValidity };

enum TsbxPGPKeyManagerSignatureValidities {
  svtValid=0,
  svtUnknown=1,
  svtCorrupted=2,
  svtSignerNotFound=3,
  svtFailure=4,
  svtReferenceCorrupted=5
};

Default Value

svtValid

Remarks

Provides the validity status of the signature if the signature has been validated.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Integer

SignatureVersion Property (PGPKeyManager Component)

Indicates the signature version.

Syntax

__property int SignatureVersion[int SignatureIndex] = { read=FSignatureVersion };

Default Value

0

Remarks

Indicates the signature version.

RFC 4880 defines two versions for PGP signatures: 3 and 4.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Integer

SigningKeyHandle Property (PGPKeyManager Component)

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

Syntax

__property __int64 SigningKeyHandle = { read=FSigningKeyHandle, write=FSetSigningKeyHandle };

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

SubkeyCount Property (PGPKeyManager Component)

The number of records in the Subkey arrays.

Syntax

__property int SubkeyCount = { read=FSubkeyCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• SubkeyBitsInKey
• SubkeyCanEncrypt
• SubkeyCanSign
• SubkeyCurve
• SubkeyEnabled
• SubkeyEncryptionAlgorithm
• SubkeyHandle
• SubkeyIsPublic
• SubkeyIsSecret
• SubkeyIsSubkey
• SubkeyKeyFP
• SubkeyKeyID
• SubkeyPassphrase
• SubkeyPassphraseValid
• SubkeyPrimaryKeyID
• SubkeyProtection
• SubkeyPublicKeyAlgorithm
• SubkeyQBits
• SubkeyTimestamp
• SubkeyUsername
• SubkeyValidTo
• SubkeyVersion

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

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

Data Type

Integer

SubkeyBitsInKey Property (PGPKeyManager Component)

Indicates the key length in bits.

Syntax

__property int SubkeyBitsInKey[int SubkeyIndex] = { read=FSubkeyBitsInKey };

Default Value

2048

Remarks

Indicates the key length in bits.

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

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

Data Type

Integer

SubkeyCanEncrypt Property (PGPKeyManager Component)

Returns True if this key can be used for encryption.

Syntax

__property bool SubkeyCanEncrypt[int SubkeyIndex] = { read=FSubkeyCanEncrypt };

Default Value

false

Remarks

Returns True if this key can be used for encryption.

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

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

Data Type

Boolean

SubkeyCanSign Property (PGPKeyManager Component)

Returns True if this key can be used for signing.

Syntax

__property bool SubkeyCanSign[int SubkeyIndex] = { read=FSubkeyCanSign };

Default Value

false

Remarks

Returns True if this key can be used for signing.

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

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

Data Type

Boolean

SubkeyCurve Property (PGPKeyManager Component)

Indicates the elliptic curve associated with a EC key.

Syntax

__property String SubkeyCurve[int SubkeyIndex] = { read=FSubkeyCurve };

Default Value

""

Remarks

Indicates the elliptic curve associated with a EC key.

Supported values:

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

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

Data Type

String

SubkeyEnabled Property (PGPKeyManager Component)

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

Syntax

__property bool SubkeyEnabled[int SubkeyIndex] = { read=FSubkeyEnabled };

Default Value

false

Remarks

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

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

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

Data Type

Boolean

SubkeyEncryptionAlgorithm Property (PGPKeyManager Component)

Indicates the symmetric algorithm used to encrypt the secret key.

Syntax

__property String SubkeyEncryptionAlgorithm[int SubkeyIndex] = { read=FSubkeyEncryptionAlgorithm };

Default Value

"AES128"

Remarks

Indicates the symmetric algorithm used to encrypt the secret key.

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

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

Data Type

String

SubkeyHandle Property (PGPKeyManager Component)

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

Syntax

__property __int64 SubkeyHandle[int SubkeyIndex] = { read=FSubkeyHandle };

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

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

Data Type

Long64

SubkeyIsPublic Property (PGPKeyManager Component)

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

Syntax

__property bool SubkeyIsPublic[int SubkeyIndex] = { read=FSubkeyIsPublic };

Default Value

false

Remarks

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

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

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

Data Type

Boolean

SubkeyIsSecret Property (PGPKeyManager Component)

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

Syntax

__property bool SubkeyIsSecret[int SubkeyIndex] = { read=FSubkeyIsSecret };

Default Value

false

Remarks

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

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

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

Data Type

Boolean

SubkeyIsSubkey Property (PGPKeyManager Component)

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

Syntax

__property bool SubkeyIsSubkey[int SubkeyIndex] = { read=FSubkeyIsSubkey };

Default Value

false

Remarks

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

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

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

Data Type

Boolean

SubkeyKeyFP Property (PGPKeyManager Component)

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

Syntax

__property String SubkeyKeyFP[int SubkeyIndex] = { read=FSubkeyKeyFP };

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

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

Data Type

String

SubkeyKeyID Property (PGPKeyManager Component)

Contains a 8-byte key identifier.

Syntax

__property String SubkeyKeyID[int SubkeyIndex] = { read=FSubkeyKeyID };

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

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

Data Type

String

SubkeyPassphrase Property (PGPKeyManager Component)

The key protection password.

Syntax

__property String SubkeyPassphrase[int SubkeyIndex] = { read=FSubkeyPassphrase };

Default Value

""

Remarks

The key protection password.

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

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

Data Type

String

SubkeyPassphraseValid Property (PGPKeyManager Component)

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

Syntax

__property bool SubkeyPassphraseValid[int SubkeyIndex] = { read=FSubkeyPassphraseValid };

Default Value

false

Remarks

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

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

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

Data Type

Boolean

SubkeyPrimaryKeyID Property (PGPKeyManager Component)

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

Syntax

__property String SubkeyPrimaryKeyID[int SubkeyIndex] = { read=FSubkeyPrimaryKeyID };

Default Value

""

Remarks

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

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

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

Data Type

String

SubkeyProtection Property (PGPKeyManager Component)

Specifies the level of protection applied to the secret key.

Syntax

__property TsbxPGPKeyManagerSubkeyProtections SubkeyProtection[int SubkeyIndex] = { read=FSubkeyProtection };

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

Default Value

pptNone

Remarks

Specifies the level of protection applied to the secret key.

Allowed values:

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

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

Data Type

Integer

SubkeyPublicKeyAlgorithm Property (PGPKeyManager Component)

Specifies the asymmetric algorithm of the key.

Syntax

__property String SubkeyPublicKeyAlgorithm[int SubkeyIndex] = { read=FSubkeyPublicKeyAlgorithm };

Default Value

""

Remarks

Specifies the asymmetric algorithm of the key.

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

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

Data Type

String

SubkeyQBits Property (PGPKeyManager Component)

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

Syntax

__property int SubkeyQBits[int SubkeyIndex] = { read=FSubkeyQBits };

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

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

Data Type

Integer

SubkeyTimestamp Property (PGPKeyManager Component)

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

Syntax

__property String SubkeyTimestamp[int SubkeyIndex] = { read=FSubkeyTimestamp };

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

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

Data Type

String

SubkeyUsername Property (PGPKeyManager Component)

Specifies the name of the user bound to this key.

Syntax

__property String SubkeyUsername[int SubkeyIndex] = { read=FSubkeyUsername };

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

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

Data Type

String

SubkeyValidTo Property (PGPKeyManager Component)

Provide accurate expiration moment indication.

Syntax

__property String SubkeyValidTo[int SubkeyIndex] = { read=FSubkeyValidTo };

Default Value

"0"

Remarks

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

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

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

Data Type

String

SubkeyVersion Property (PGPKeyManager Component)

Indicates the key version.

Syntax

__property int SubkeyVersion[int SubkeyIndex] = { read=FSubkeyVersion };

Default Value

0

Remarks

Indicates the key version.

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

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

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

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

Data Type

Integer

UserCount Property (PGPKeyManager Component)

The number of records in the User arrays.

Syntax

__property int UserCount = { read=FUserCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• UserHandle
• UserUsername

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

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

Data Type

Integer

UserHandle Property (PGPKeyManager Component)

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

Syntax

__property __int64 UserHandle[int UserIndex] = { read=FUserHandle };

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

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

Data Type

Long64

UserUsername Property (PGPKeyManager Component)

Specifies the user name of user.

Syntax

__property String UserUsername[int UserIndex] = { read=FUserUsername };

Default Value

""

Remarks

Specifies the user name of user.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

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

Data Type

String

ChangePassphrase Method (PGPKeyManager Component)

Changes the password of the secret key.

Syntax

void __fastcall ChangePassphrase(String OldPassphrase, String NewPassphrase);

Remarks

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

ChangeProtection Method (PGPKeyManager Component)

Changes the protection level of the secret key.

Syntax

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

Remarks

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

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

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

CheckPassphrase Method (PGPKeyManager Component)

Checks if the password matches the secret key.

Syntax

bool __fastcall CheckPassphrase(String Passphrase);

Remarks

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

Config Method (PGPKeyManager Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

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

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

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

CreateKey Method (PGPKeyManager Component)

Generates a new key.

Syntax

void __fastcall CreateKey(int Version, String Algorithm, int Bits, String ValidTo, String Password);

Remarks

Use this method to generate a new key with the provided parameters.

CreateSubkey Method (PGPKeyManager Component)

Generates a new subkey.

Syntax

void __fastcall CreateSubkey(String Algorithm, int Bits, String ValidTo, String Password);

Remarks

Use this method to generate a new subkey with the provided parameters.

CreateUser Method (PGPKeyManager Component)

Adds a user to an existing key.

Syntax

void __fastcall CreateUser(String Username);

Remarks

Use this method to add a user to an existing key. A typical format for a PGP key usage is "Name <email>", for example "John Johnson <john@johnson.com>".

DoAction Method (PGPKeyManager Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

Remarks

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

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

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

ExportBytes Method (PGPKeyManager Component)

Serializes the key to a byte array.

Syntax

DynamicArray<Byte> __fastcall ExportBytes(bool Secret);

Remarks

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

ExportToFile Method (PGPKeyManager Component)

Exports the key to a file.

Syntax

void __fastcall ExportToFile(String FileName, bool Secret);

Remarks

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

GeneratePair Method (PGPKeyManager Component)

Generates a new pair of PGP keys.

Syntax

void __fastcall GeneratePair(int Version, String Username, int Strength, String ValidTo, String Password);

Remarks

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

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

This method generates a 'standard' keypair based on the Version and Strength parameters. This can range from RSA keys for version 3 to strong Ed25519 keys for version 6.

The following PGP key versions and strengths are supported:

Provide the key encryption password and the validity period in days via the Password and ValidTo parameters.

ImportBytes Method (PGPKeyManager Component)

Loads a key from a byte array.

Syntax

void __fastcall ImportBytes(DynamicArray<Byte> Key);

Remarks

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

ImportFromFile Method (PGPKeyManager Component)

Loads a key from a file.

Syntax

void __fastcall ImportFromFile(String FileName);

Remarks

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

ImportPinned Method (PGPKeyManager Component)

Loads a key from a pinned key object.

Syntax

void __fastcall ImportPinned();

Remarks

Use this method to load a PGP key from a PinnedKey object. This is an easy way to import a key object from a keyring.

RemoveSignature Method (PGPKeyManager Component)

Unbinds the specified signature from the key, subkey or user.

Syntax

void __fastcall RemoveSignature(int Index);

Remarks

Use this method to remove the specified signature from the list of Signatures bound to the key, subkey or user.

RemoveSubkey Method (PGPKeyManager Component)

Removes the specified subkey from the key.

Syntax

void __fastcall RemoveSubkey(int Index);

Remarks

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

RemoveUser Method (PGPKeyManager Component)

Unbinds the specified user from the key.

Syntax

void __fastcall RemoveUser(int Index);

Remarks

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

Reset Method (PGPKeyManager Component)

Creates a new empty keyring.

Syntax

void __fastcall Reset();

Remarks

Use this method to initialize a new empty keyring.

RevokeKey Method (PGPKeyManager Component)

Revokes the key.

Syntax

void __fastcall RevokeKey(int Reason, String Comment);

Remarks

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

RevokeSubkey Method (PGPKeyManager Component)

Revokes the key's subkey.

Syntax

void __fastcall RevokeSubkey(int Index, int Reason, String Comment);

Remarks

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

RevokeUser Method (PGPKeyManager Component)

Revokes a user certification.

Syntax

void __fastcall RevokeUser(int Index, int Reason, String Comment);

Remarks

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

SignKey Method (PGPKeyManager Component)

Sign the key.

Syntax

void __fastcall SignKey(String KeyValidTo, String HashAlgorithm, String PreferredAlgs, int KeyFlags);

Remarks

Use this method to sign the key.

SignSubkey Method (PGPKeyManager Component)

Sign the key's subkey.

Syntax

void __fastcall SignSubkey(int Index, String KeyValidTo, String HashAlgorithm, String PreferredAlgs, int KeyFlags);

Remarks

Use this method to sign the subkey with a given Index.

SignUser Method (PGPKeyManager Component)

Sign a user certification.

Syntax

void __fastcall SignUser(int Index, String KeyValidTo, String HashAlgorithm, bool Primary, int CertType);

Remarks

Use this method to sign the user with the specified Index.

Verify Method (PGPKeyManager Component)

Verifies the integrity of a key signature.

Syntax

bool __fastcall Verify(int Index);

Remarks

Use this method to validate a key signature. Provide the index of the signature as a parameter.

Error Event (PGPKeyManager Component)

Information about errors during PGP key management.

Syntax

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

Remarks

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

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

KeyPassphraseNeeded Event (PGPKeyManager Component)

Requests a key protection password from the application.

Syntax

typedef struct {
  String KeyID;
  String UserID;
  bool MainKey;
  String Passphrase;
  bool Skip;
} TsbxPGPKeyManagerKeyPassphraseNeededEventParams;
typedef void __fastcall (__closure *TsbxPGPKeyManagerKeyPassphraseNeededEvent)(System::TObject* Sender, TsbxPGPKeyManagerKeyPassphraseNeededEventParams *e);
__property TsbxPGPKeyManagerKeyPassphraseNeededEvent OnKeyPassphraseNeeded = { read=FOnKeyPassphraseNeeded, write=FOnKeyPassphraseNeeded };

Remarks

The component fires this event to request a secret key passphrase from the application. Note that this event asks for a key protection passphrase rather than a message protection passphrase. The component fires it when it attempts to use a secret key to sign the data.

This event is fired for every protected secret key residing in SigningKeys. KeyID specifies the key for which the password is requested, and UserID identifies its user. MainKey tells whether the key is a master key or a subkey.

The handler should provide password via the Passphrase parameter, or set Skip to True to skip this key.

For each key KeyPassphraseNeeded is called in a loop until the correct password is provided or the maximum number of password attempts reached.

Notification Event (PGPKeyManager Component)

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

Syntax

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

Remarks

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

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

Config Settings (PGPKeyManager Component)

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

PGPKeyManager Config Settings

Base Config Settings

Trappable Errors (PGPKeyManager Component)

PGPKeyManager Errors