PGPReader Component

Properties   Methods   Events   Config Settings   Errors  

The PGPReader component unprotects, verifies, and extracts data from protected PGP files.

Syntax

TsbxPGPReader

Remarks

PGPReader lets you process PGP messages, and validate and extract the protected data.

PGPReader supports all modern PGP keys and formats, from last-century PGP 2.6.x to the state-of-the art PGP 6. Single- and multi-file, as well as for-your-eyes-only PGP containers are supported.

The use of PGPReader is quite straightforward: you only need to provide the protected data and the keyring files, and the component will do the rest. PGPReader detects the protection parameters, matches them to the keys, and unwraps the protected data automatically.

Preparing keys

Encryption and signing in PGP is done with asymmetric keys (and sometimes with passwords, but that is a far less common scenario). Keys are normally stored in files called keyrings. More often that not they consist of a pair of files: a public keyring (e.g pubring.pkr) and a secret keyring (secring.skr), although there are exceptions. Sometimes, parties provide each other with standalone public keys that they want them to encrypt or verify data with.

Whichever form your keyring takes, use PGPKeyring to load it. It is recommended to load all the keyring files that you have to make sure that you have all the keys loaded. PGPKeyring can detect duplicate keys, so don't worry about loading the same key twice - any duplicates will be neatly merged together into one key object. PGPKeyring keyring = new PGPKeyring(); keyring.ImportFromFile("pubring.pkr"); keyring.ImportFromFile("secring.skr");

You keyring will typically contain two types of keys: public and private. Private keys (i.e. your keys) are used for signing and decryption. Public keys (someone else's keys) are used for encryption and signature verification. This means that if you are looking to decrypt a file, you need to get your private keys ready. If you are looking to verify someone's signature over the data, you need to get the public keys.

When processing protected files PGPReader can look for the required keys in the keyring and select the appropriate ones automatically. This means that you do not need to comb through your key collection manually, cherry-picking public and private keys. Simply assign the entire collection of keys to PGPReader's DecryptingKeys and VerifyingKeys properties, and PGPReader will find and use the right one: reader.DecryptingKeys = keyring.Keys; reader.VerifyingKeys = keyring.Keys;

When it comes to using your private keys - i.e. when decrypting the data - there is one important catch that you need to keep in mind. Private PGP keys are typically protected with passwords. To be able to use them, you need to provide the valid password to the component when the key needs to be used. You can do that in one of the following three ways:

• By assigning the password to property. You can check whether the provided password is valid using the property.
• By assigning the password to KeyPassphrase property. This and the previous method assumes that you anticipate which key you will likely need to use.
• By subscribing to KeyPassphraseNeeded event and providing the password from within the event handler. This event will be fired in the middle of the decryption process for each eligible private key for which no valid password was provided using the first two methods. This method lets you provide the password on-the-fly, and is handy when you don't know which key you are going to use in advance.

Configuring the component

Unprotection configuration if quite straightforward and encompasses adjustment of the following settings:

• Provide the input data via the InputFile (or InputBytes) property.
• Provide the destination in OutputFile. If no output destination is provided, the output will be generated in OutputBytes.
• When processing multi-files PGP archives, consider subscribing to MultipleFilesFound, FileExtractionStart and FileExtractionFinish events. These come handy in tracking progress and adjusting output locations for individual files.
• Depending on your circumstances, you may want to subscribe to Signed and EncryptionInfo events to be notified about various protection parameters.

Unprotecting the file

You are all set now. Call the appropriate unprotection method to proceed with operation:

• DecryptAndVerify: process the input data by decrypting any protected data, extracting individual files, and verifying signatures. This is the method that you would likely need to use in most cases.
• VerifyDetached: verify a detached signature. Remember that you need to provide the original data separately via the DataFile or DataBytes properties.

reader.InputFile = "C:\files\input.pgp"; reader.OutputFile = "C:\files\output.txt"; reader.DecryptingKeys = keyring.Keys; reader.VerifyingKeys = keyring.Keys; reader.KeyPassphrase = "password"; reader.DecryptAndVerify();

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.

Armored Property (PGPReader Component)

Indicates if the processed message had been base64-armored.

Syntax

__property bool Armored = { read=FArmored };

Default Value

false

Remarks

This property is set to true if the supplied message was armored by encoding it into base64 and adding BEGIN and END brackets.

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

Data Type

Boolean

Compressed Property (PGPReader Component)

Indicates if the processed message had been compressed.

Syntax

__property bool Compressed = { read=FCompressed };

Default Value

false

Remarks

This property is set to true if the supplied message was compressed by its creator.

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

Data Type

Boolean

DataBytes Property (PGPReader Component)

Use this property to pass the original signed data to component in the byte array form.

Syntax

__property DynamicArray DataBytes = { read=FDataBytes, write=FSetDataBytes };

Remarks

When validating detached signatures, assign a byte array containing the signed data to this property.

This property is not available at design time.

Data Type

Byte Array

DataFile Property (PGPReader Component)

The name of the file containing the original signed data.

Syntax

__property String DataFile = { read=FDataFile, write=FSetDataFile };

Default Value

""

Remarks

Use this property to provide the original data when validating detached signatures with VerifyDetached.

Data Type

String

DecryptingKeyCount Property (PGPReader Component)

The number of records in the DecryptingKey arrays.

Syntax

__property int DecryptingKeyCount = { read=FDecryptingKeyCount, write=FSetDecryptingKeyCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• DecryptingKeyHandle
• DecryptingKeyKeyFP
• DecryptingKeyKeyID
• DecryptingKeyPassphrase
• DecryptingKeyPassphraseValid
• DecryptingKeyUsername

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

This property is not available at design time.

Data Type

Integer

DecryptingKeyHandle Property (PGPReader Component)

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

Syntax

__property __int64 DecryptingKeyHandle[int DecryptingKeyIndex] = { read=FDecryptingKeyHandle, write=FSetDecryptingKeyHandle };

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

This property is not available at design time.

Data Type

Long64

DecryptingKeyKeyFP Property (PGPReader Component)

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

Syntax

__property String DecryptingKeyKeyFP[int DecryptingKeyIndex] = { read=FDecryptingKeyKeyFP };

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

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

Data Type

String

DecryptingKeyKeyID Property (PGPReader Component)

Contains a 8-byte key identifier.

Syntax

__property String DecryptingKeyKeyID[int DecryptingKeyIndex] = { read=FDecryptingKeyKeyID };

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

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

Data Type

String

DecryptingKeyPassphrase Property (PGPReader Component)

The key protection password.

Syntax

__property String DecryptingKeyPassphrase[int DecryptingKeyIndex] = { read=FDecryptingKeyPassphrase, write=FSetDecryptingKeyPassphrase };

Default Value

""

Remarks

The key protection password.

The DecryptingKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptingKeyCount property.

This property is not available at design time.

Data Type

String

DecryptingKeyPassphraseValid Property (PGPReader Component)

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

Syntax

__property bool DecryptingKeyPassphraseValid[int DecryptingKeyIndex] = { read=FDecryptingKeyPassphraseValid };

Default Value

false

Remarks

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

The DecryptingKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptingKeyCount property.

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

Data Type

Boolean

DecryptingKeyUsername Property (PGPReader Component)

Specifies the name of the user bound to this key.

Syntax

__property String DecryptingKeyUsername[int DecryptingKeyIndex] = { read=FDecryptingKeyUsername };

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

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

Data Type

String

ExternalCryptoAsyncDocumentID Property (PGPReader Component)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

__property String ExternalCryptoAsyncDocumentID = { read=FExternalCryptoAsyncDocumentID, write=FSetExternalCryptoAsyncDocumentID };

Default Value

""

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (PGPReader Component)

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

__property String ExternalCryptoCustomParams = { read=FExternalCryptoCustomParams, write=FSetExternalCryptoCustomParams };

Default Value

""

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (PGPReader Component)

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

__property String ExternalCryptoData = { read=FExternalCryptoData, write=FSetExternalCryptoData };

Default Value

""

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (PGPReader Component)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

__property bool ExternalCryptoExternalHashCalculation = { read=FExternalCryptoExternalHashCalculation, write=FSetExternalCryptoExternalHashCalculation };

Default Value

false

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth component.

If set to true, the component will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (PGPReader Component)

Specifies the request's signature hash algorithm.

Syntax

__property String ExternalCryptoHashAlgorithm = { read=FExternalCryptoHashAlgorithm, write=FSetExternalCryptoHashAlgorithm };

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (PGPReader Component)

The ID of the pre-shared key used for DC request authentication.

Syntax

__property String ExternalCryptoKeyID = { read=FExternalCryptoKeyID, write=FSetExternalCryptoKeyID };

Default Value

""

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (PGPReader Component)

The pre-shared key used for DC request authentication.

Syntax

__property String ExternalCryptoKeySecret = { read=FExternalCryptoKeySecret, write=FSetExternalCryptoKeySecret };

Default Value

""

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (PGPReader Component)

Specifies the asynchronous signing method.

Syntax

__property TsbxPGPReaderExternalCryptoMethods ExternalCryptoMethod = { read=FExternalCryptoMethod, write=FSetExternalCryptoMethod };

enum TsbxPGPReaderExternalCryptoMethods {
  asmdPKCS1=0,
  asmdPKCS7=1
};

Default Value

asmdPKCS1

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

Data Type

Integer

ExternalCryptoMode Property (PGPReader Component)

Specifies the external cryptography mode.

Syntax

__property TsbxPGPReaderExternalCryptoModes ExternalCryptoMode = { read=FExternalCryptoMode, write=FSetExternalCryptoMode };

enum TsbxPGPReaderExternalCryptoModes {
  ecmDefault=0,
  ecmDisabled=1,
  ecmGeneric=2,
  ecmDCAuth=3,
  ecmDCAuthJSON=4
};

Default Value

ecmDefault

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (PGPReader Component)

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

__property String ExternalCryptoPublicKeyAlgorithm = { read=FExternalCryptoPublicKeyAlgorithm, write=FSetExternalCryptoPublicKeyAlgorithm };

Default Value

""

Remarks

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Data Type

String

FIPSMode Property (PGPReader Component)

Reserved.

Syntax

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

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (PGPReader Component)

Use this property to pass the input to component in byte array form.

Syntax

__property DynamicArray InputBytes = { read=FInputBytes, write=FSetInputBytes };

Remarks

Assign a byte array containing the data to be processed to this property.

This property is not available at design time.

Data Type

Byte Array

InputFile Property (PGPReader Component)

Provides a filename of a file to process.

Syntax

__property String InputFile = { read=FInputFile, write=FSetInputFile };

Default Value

""

Remarks

Use this property to provide a path to the file to be encrypted and/or signed.

Data Type

String

KeyPassphrase Property (PGPReader Component)

Specifies a passphrase for the decryption key.

Syntax

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

Default Value

""

Remarks

Use this property to provide a passphrase for the decryption secret key.

If this property is left empty or a wrong passphrase is provided, the KeyPassphraseNeeded event will be fired to request the correct passphrase.

Data Type

String

OutputBytes Property (PGPReader Component)

Use this property to read the output the component object has produced.

Syntax

__property DynamicArray OutputBytes = { read=FOutputBytes };

Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the OutputFile and OutputStream properties had not been assigned.

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

Data Type

Byte Array

OutputFile Property (PGPReader Component)

The file where the encrypted and/or signed data will be saved.

Syntax

__property String OutputFile = { read=FOutputFile, write=FSetOutputFile };

Default Value

""

Remarks

Use this property to provide a path to the file where the component should store the encrypted and/or signed data.

Data Type

String

Passphrase Property (PGPReader Component)

Specifies a message decryption password.

Syntax

__property String Passphrase = { read=FPassphrase, write=FSetPassphrase };

Default Value

""

Remarks

Use this property to provide a password to decrypt the data. Whether the message can be decrypted with a password is indicated by PassphraseUsed parameter of EncryptionInfo event.

Note that this is not the same as a secret key passphrase, which should be provided via KeyPassphrase property.

If this property is left empty or the assigned passphrase is incorrect, the PassphraseNeeded event will be fired to request the correct one.

Data Type

String

ProcessedLength Property (PGPReader Component)

Reports the number of bytes processed.

Syntax

__property __int64 ProcessedLength = { read=FProcessedLength };

Default Value

0

Remarks

Use this property to check the number of bytes that the component has read when processing the protected message.

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

Data Type

Long64

Profile Property (PGPReader Component)

Specifies a pre-defined profile to apply when creating the signature.

Syntax

__property String Profile = { read=FProfile, write=FSetProfile };

Default Value

""

Remarks

Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.

Data Type

String

SignatureCount Property (PGPReader 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 (PGPReader Component)

Specifies the type of a UserID signature.

Syntax

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

enum TsbxPGPReaderSignatureCertificationTypes {
  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 (PGPReader 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 (PGPReader 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 (PGPReader 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 (PGPReader 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 (PGPReader 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 (PGPReader 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 (PGPReader 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 (PGPReader 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 (PGPReader 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 (PGPReader 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 (PGPReader 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 (PGPReader 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 (PGPReader 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 (PGPReader 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 (PGPReader 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 (PGPReader Component)

Indicates the signature class.

Syntax

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

enum TsbxPGPReaderSignatureSignatureClass {
  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 (PGPReader 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 (PGPReader 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 (PGPReader 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 (PGPReader 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 (PGPReader 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 (PGPReader 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 (PGPReader 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 (PGPReader 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 (PGPReader Component)

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

Syntax

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

enum TsbxPGPReaderSignatureValidities {
  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 (PGPReader 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

VerifyingKeyCount Property (PGPReader Component)

The number of records in the VerifyingKey arrays.

Syntax

__property int VerifyingKeyCount = { read=FVerifyingKeyCount, write=FSetVerifyingKeyCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• VerifyingKeyHandle
• VerifyingKeyKeyFP
• VerifyingKeyKeyID
• VerifyingKeyUsername

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

This property is not available at design time.

Data Type

Integer

VerifyingKeyHandle Property (PGPReader Component)

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

Syntax

__property __int64 VerifyingKeyHandle[int VerifyingKeyIndex] = { read=FVerifyingKeyHandle, write=FSetVerifyingKeyHandle };

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

This property is not available at design time.

Data Type

Long64

VerifyingKeyKeyFP Property (PGPReader Component)

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

Syntax

__property String VerifyingKeyKeyFP[int VerifyingKeyIndex] = { read=FVerifyingKeyKeyFP };

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

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

Data Type

String

VerifyingKeyKeyID Property (PGPReader Component)

Contains a 8-byte key identifier.

Syntax

__property String VerifyingKeyKeyID[int VerifyingKeyIndex] = { read=FVerifyingKeyKeyID };

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

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

Data Type

String

VerifyingKeyUsername Property (PGPReader Component)

Specifies the name of the user bound to this key.

Syntax

__property String VerifyingKeyUsername[int VerifyingKeyIndex] = { read=FVerifyingKeyUsername };

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

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

Data Type

String

Config Method (PGPReader 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.

DecryptAndVerify Method (PGPReader Component)

Decrypts and verifies a protected message.

Syntax

void __fastcall DecryptAndVerify();

Remarks

Use this method to unprotect a PGP message contained in a byte array (InputBytes), in a file (InputFile) or in a stream (InputStream). The method writes the decrypted message to a byte array (OutputBytes), to a file (OutputFile) or to a stream (OutputStream).

DoAction Method (PGPReader 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;....

Common ActionIDs:

Reset Method (PGPReader Component)

Resets the component settings.

Syntax

void __fastcall Reset();

Remarks

Reset is a generic method available in every component.

VerifyDetached Method (PGPReader Component)

Verifies a detached signature.

Syntax

void __fastcall VerifyDetached();

Remarks

Use this method to verify a detached signature contained in a byte array (DataBytes), in a file (DataFile) or in a stream (DataStream) over a message contained in a byte array (InputBytes), in a file (InputFile) or in a stream (InputStream).

EncryptionInfo Event (PGPReader Component)

Reports early information on encryption parameters.

Syntax

typedef struct {
  String KeyIDs;
  int EncryptedProtection;
  bool PassphraseUsed;
} TsbxPGPReaderEncryptionInfoEventParams;
typedef void __fastcall (__closure *TsbxPGPReaderEncryptionInfoEvent)(System::TObject* Sender, TsbxPGPReaderEncryptionInfoEventParams *e);
__property TsbxPGPReaderEncryptionInfoEvent OnEncryptionInfo = { read=FOnEncryptionInfo, write=FOnEncryptionInfo };

Remarks

The component fires this event to report early encryption information. Use this event to find out what encryption type is used, and to provide appropriate decryption material (the secret keys or the password) via DecryptingKeys or Passphrase properties.

KeyIDs contains the IDs of the keys that can be used to decrypt the data. PassphraseUsed shows if the message can also be decrypted with a passphrase. Both can be set at the same time, indicating that each of the decryption routes can be taken.

EncryptedProtection parameter specifies whether the message includes a modification detection record.

Error Event (PGPReader Component)

Information about errors during PGP decryption/verification.

Syntax

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

Remarks

The event is fired in case of exceptional conditions during decryption/verification of protected data.

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

ExternalDecrypt Event (PGPReader Component)

Handles remote or external decryption.

Syntax

typedef struct {
  String OperationId;
  String Algorithm;
  String Pars;
  String EncryptedData;
  String Data;
} TsbxPGPReaderExternalDecryptEventParams;
typedef void __fastcall (__closure *TsbxPGPReaderExternalDecryptEvent)(System::TObject* Sender, TsbxPGPReaderExternalDecryptEventParams *e);
__property TsbxPGPReaderExternalDecryptEvent OnExternalDecrypt = { read=FOnExternalDecrypt, write=FOnExternalDecrypt };

Remarks

Assign a handler to this event if you need to delegate a low-level decryption operation to an external, remote, or custom decryption engine. The handler receives an encrypted value in the EncryptedData parameter, and is expected to decrypt it and place the decrypted value into the Data parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. Algorithm specifies the encryption algorithm being used, and Pars contains algorithm-dependent parameters.

The component uses base16 (hex) encoding for the EncryptedData, Data, and Pars parameters. If your decryption engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the decryption.

Sample data encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

FileExtractionFinish Event (PGPReader Component)

Reports the ending of file extraction process.

Syntax

typedef struct {
  String FileName;
  String Timestamp;
} TsbxPGPReaderFileExtractionFinishEventParams;
typedef void __fastcall (__closure *TsbxPGPReaderFileExtractionFinishEvent)(System::TObject* Sender, TsbxPGPReaderFileExtractionFinishEventParams *e);
__property TsbxPGPReaderFileExtractionFinishEvent OnFileExtractionFinish = { read=FOnFileExtractionFinish, write=FOnFileExtractionFinish };

Remarks

This event informs about the ending of extraction of the next available file. FileName parameter indicates the original file name, and the Timestamp its last modification time.

In the handler, the user can take away the output stream or store the file data from OutputBytes.

FileExtractionStart Event (PGPReader Component)

Reports the beginning of file extraction process.

Syntax

typedef struct {
  String FileName;
  String Timestamp;
  bool Skip;
} TsbxPGPReaderFileExtractionStartEventParams;
typedef void __fastcall (__closure *TsbxPGPReaderFileExtractionStartEvent)(System::TObject* Sender, TsbxPGPReaderFileExtractionStartEventParams *e);
__property TsbxPGPReaderFileExtractionStartEvent OnFileExtractionStart = { read=FOnFileExtractionStart, write=FOnFileExtractionStart };

Remarks

This event informs about the beginning of extraction of the next available file. A PGP message may contain more than one file. FileName parameter indicates the original file name, and the Timestamp its last modification time.

The user should provide an output filename in OutputFile or a stream in OutputStream. If none of them is provided, the extracted file will be placed to OutputBytes. After the file is extracted, FileExtractionFinish event is fired.

KeyPassphraseNeeded Event (PGPReader Component)

Requests a key protection password from the application.

Syntax

typedef struct {
  String KeyID;
  String UserID;
  bool MainKey;
  String Passphrase;
  bool Skip;
} TsbxPGPReaderKeyPassphraseNeededEventParams;
typedef void __fastcall (__closure *TsbxPGPReaderKeyPassphraseNeededEvent)(System::TObject* Sender, TsbxPGPReaderKeyPassphraseNeededEventParams *e);
__property TsbxPGPReaderKeyPassphraseNeededEvent 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 (which is requested via PassphraseNeeded). The component fires it when it has found a suitable decryption secret key in the keyring, and attempts to use it to decrypt the data.

If the data is encrypted with multiple keys, this event is called for each key in a loop until the password for at least one key is provided correctly. 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.

MultipleFilesFound Event (PGPReader Component)

Fires if the PGP message is recognized to contain multiple files.

Syntax

typedef struct {
  String TarFileName;
  bool Proceed;
} TsbxPGPReaderMultipleFilesFoundEventParams;
typedef void __fastcall (__closure *TsbxPGPReaderMultipleFilesFoundEvent)(System::TObject* Sender, TsbxPGPReaderMultipleFilesFoundEventParams *e);
__property TsbxPGPReaderMultipleFilesFoundEvent OnMultipleFilesFound = { read=FOnMultipleFilesFound, write=FOnMultipleFilesFound };

Remarks

The component fires this event to report that there is more than one file in the PGP message.

The TarFileName specifies the name of the TAR file containing the files. Tune up Proceed to go ahead or stop the processing.

Notification Event (PGPReader Component)

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

Syntax

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

PassphraseNeeded Event (PGPReader Component)

Requests a data protection password from the application.

Syntax

typedef struct {
  String Passphrase;
  bool Skip;
} TsbxPGPReaderPassphraseNeededEventParams;
typedef void __fastcall (__closure *TsbxPGPReaderPassphraseNeededEvent)(System::TObject* Sender, TsbxPGPReaderPassphraseNeededEventParams *e);
__property TsbxPGPReaderPassphraseNeededEvent OnPassphraseNeeded = { read=FOnPassphraseNeeded, write=FOnPassphraseNeeded };

Remarks

The component fires this event to request a decryption password. It is only fired if the data can be decrypted without a key.

The event is fired in a loop until the correct password is passed or the number of password attempts is exceeded.

Progress Event (PGPReader Component)

Reports the progress of the decryption operation.

Syntax

typedef struct {
  __int64 Current;
  __int64 Total;
  bool Cancel;
} TsbxPGPReaderProgressEventParams;
typedef void __fastcall (__closure *TsbxPGPReaderProgressEvent)(System::TObject* Sender, TsbxPGPReaderProgressEventParams *e);
__property TsbxPGPReaderProgressEvent OnProgress = { read=FOnProgress, write=FOnProgress };

Remarks

The component fires this event repeatedly to report the progress of the file extraction operation.

Current indicates the amount of processed data in bytes, and Total is the total number of bytes to be processed. Use Cancel to terminate the extraction process.

Signed Event (PGPReader Component)

Notifies the application about a signed message.

Syntax

typedef struct {
  String KeyIDs;
  int SignatureType;
} TsbxPGPReaderSignedEventParams;
typedef void __fastcall (__closure *TsbxPGPReaderSignedEvent)(System::TObject* Sender, TsbxPGPReaderSignedEventParams *e);
__property TsbxPGPReaderSignedEvent OnSigned = { read=FOnSigned, write=FOnSigned };

Remarks

The component fires this event when it identifies a signed message to allow the application to prepare the component for verification.

Use the KeyIDs parameter to identify keys used that were used to sign the message, and make sure they are available in the VerifyingKeys list.

SignatureType indicates the signature type:

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

PGPReader Config Settings

Base Config Settings

Trappable Errors (PGPReader Component)

PGPReader Errors