PGPWriter Component

Properties   Methods   Events   Config Settings   Errors  

The PGPWriter component protects data using PGP keys and certificates.

Syntax

TsbxPGPWriter

Remarks

PGPWriter allows you to encrypt, sign, armor, and compress the input data.

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.

Armor Property (PGPWriter Component)

Specifies whether the data should be armored.

Syntax

__property bool Armor = { read=FArmor, write=FSetArmor };

Default Value

false

Remarks

Switch this property on to armor the protected data by encoding it in base64 and enveloping with BEGIN and END markings.

Data Type

Boolean

ArmorBoundary Property (PGPWriter Component)

A boundary to put around the base64 armor.

Syntax

__property String ArmorBoundary = { read=FArmorBoundary, write=FSetArmorBoundary };

Default Value

""

Remarks

Use this property to specify the boundary to put around the base64 armor. If set to 'PGP MESSAGE', the armored data will be enveloped with '-----BEGIN PGP MESSAGE-----' and '-----END PGP MESSAGE-----' lines.

This property only makes sense if Armor is set True.

Data Type

String

ArmorHeaders Property (PGPWriter Component)

Additional headers to include with the armored message.

Syntax

__property String ArmorHeaders = { read=FArmorHeaders, write=FSetArmorHeaders };

Default Value

""

Remarks

Use this property to specify additional headers to be included with the armored message.

Assign this property with a multi-line text, with each line being of "header: value" form (without quotes).

Data Type

String

Compress Property (PGPWriter Component)

Whether to compress the data before encrypting it.

Syntax

__property bool Compress = { read=FCompress, write=FSetCompress };

Default Value

false

Remarks

Set this property to True to compress the data before encryption. Use CompressionAlgorithm and CompressionLevel to tune up compression parameters.

Data Type

Boolean

CompressionAlgorithm Property (PGPWriter Component)

The compression algorithm to use.

Syntax

__property String CompressionAlgorithm = { read=FCompressionAlgorithm, write=FSetCompressionAlgorithm };

Default Value

"Uncompressed"

Remarks

Use this property to specify the compression algorithm to use before encrypting the data. This property only makes sense if Compress is True.

Data Type

String

CompressionLevel Property (PGPWriter Component)

The compression level to use.

Syntax

__property int CompressionLevel = { read=FCompressionLevel, write=FSetCompressionLevel };

Default Value

0

Remarks

Use this property to specify the compression level, from 1 (fastest) to 9 (best).

Data Type

Integer

EncryptingKeyCount Property (PGPWriter Component)

The number of records in the EncryptingKey arrays.

Syntax

__property int EncryptingKeyCount = { read=FEncryptingKeyCount, write=FSetEncryptingKeyCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• EncryptingKeyHandle
• EncryptingKeyKeyFP
• EncryptingKeyKeyID
• EncryptingKeyUsername

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

This property is not available at design time.

Data Type

Integer

EncryptingKeyHandle Property (PGPWriter Component)

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

Syntax

__property __int64 EncryptingKeyHandle[int EncryptingKeyIndex] = { read=FEncryptingKeyHandle, write=FSetEncryptingKeyHandle };

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

This property is not available at design time.

Data Type

Long64

EncryptingKeyKeyFP Property (PGPWriter Component)

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

Syntax

__property String EncryptingKeyKeyFP[int EncryptingKeyIndex] = { read=FEncryptingKeyKeyFP };

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

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

Data Type

String

EncryptingKeyKeyID Property (PGPWriter Component)

Contains a 8-byte key identifier.

Syntax

__property String EncryptingKeyKeyID[int EncryptingKeyIndex] = { read=FEncryptingKeyKeyID };

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

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

Data Type

String

EncryptingKeyUsername Property (PGPWriter Component)

Specifies the name of the user bound to this key.

Syntax

__property String EncryptingKeyUsername[int EncryptingKeyIndex] = { read=FEncryptingKeyUsername, write=FSetEncryptingKeyUsername };

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

This property is not available at design time.

Data Type

String

EncryptionAlgorithm Property (PGPWriter Component)

A symmetric algorithm to use for data encryption.

Syntax

__property String EncryptionAlgorithm = { read=FEncryptionAlgorithm, write=FSetEncryptionAlgorithm };

Default Value

"CAST5"

Remarks

Use this property to specify a symmetric algorithm to use for data encryption.

Data Type

String

ExternalCryptoAsyncDocumentID Property (PGPWriter 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 (PGPWriter 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 (PGPWriter 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 (PGPWriter 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 (PGPWriter 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 (PGPWriter 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 (PGPWriter 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 (PGPWriter Component)

Specifies the asynchronous signing method.

Syntax

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

enum TsbxPGPWriterExternalCryptoMethods {
  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 (PGPWriter Component)

Specifies the external cryptography mode.

Syntax

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

enum TsbxPGPWriterExternalCryptoModes {
  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 (PGPWriter 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

Filename Property (PGPWriter Component)

Specifies the name of the file being protected.

Syntax

__property String Filename = { read=FFilename, write=FSetFilename };

Default Value

""

Remarks

Use this property to set the name of the file being protected, such as 'document.txt'. If Filename is empty or its value is "_CONSOLE", the data will be protected for-your-eyes-only, meaning the decryptor will only be able to read it on their screen, but not save.

Data Type

String

FIPSMode Property (PGPWriter Component)

Reserved.

Syntax

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

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

HashAlgorithm Property (PGPWriter Component)

The hash algorithm to use for signing.

Syntax

__property String HashAlgorithm = { read=FHashAlgorithm, write=FSetHashAlgorithm };

Default Value

""

Remarks

Use this property to specify the hash algorithm to use for calculating signatures.

Data Type

String

InputBytes Property (PGPWriter 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 (PGPWriter 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

InputIsText Property (PGPWriter Component)

Whether the input data is text.

Syntax

__property bool InputIsText = { read=FInputIsText, write=FSetInputIsText };

Default Value

false

Remarks

Set this property to true to indicate that the supplied data should be treated as text.

Data Type

Boolean

OutputBytes Property (PGPWriter 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 (PGPWriter 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 (PGPWriter Component)

The encryption password.

Syntax

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

Default Value

""

Remarks

Use this property to provide the encryption password. If an encryption password is used, no key will be needed to decrypt the data.

Data Type

String

Profile Property (PGPWriter 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

Protection Property (PGPWriter Component)

Specifies a password protection level.

Syntax

__property TsbxPGPWriterProtections Protection = { read=FProtection, write=FSetProtection };

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

Default Value

pptNone

Remarks

This property specifies the complexity of key derivation function for password-protected documents.

Allowed values:

Data Type

Integer

SigningKeyCount Property (PGPWriter Component)

The number of records in the SigningKey arrays.

Syntax

__property int SigningKeyCount = { read=FSigningKeyCount, write=FSetSigningKeyCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• SigningKeyHandle
• SigningKeyKeyFP
• SigningKeyKeyID
• SigningKeyPassphrase
• SigningKeyPassphraseValid
• SigningKeyUsername

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

This property is not available at design time.

Data Type

Integer

SigningKeyHandle Property (PGPWriter Component)

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

Syntax

__property __int64 SigningKeyHandle[int SigningKeyIndex] = { 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());

The SigningKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningKeyCount property.

This property is not available at design time.

Data Type

Long64

SigningKeyKeyFP Property (PGPWriter Component)

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

Syntax

__property String SigningKeyKeyFP[int SigningKeyIndex] = { read=FSigningKeyKeyFP };

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

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

Data Type

String

SigningKeyKeyID Property (PGPWriter Component)

Contains a 8-byte key identifier.

Syntax

__property String SigningKeyKeyID[int SigningKeyIndex] = { read=FSigningKeyKeyID };

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

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

Data Type

String

SigningKeyPassphrase Property (PGPWriter Component)

The key protection password.

Syntax

__property String SigningKeyPassphrase[int SigningKeyIndex] = { read=FSigningKeyPassphrase, write=FSetSigningKeyPassphrase };

Default Value

""

Remarks

The key protection password.

The SigningKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningKeyCount property.

This property is not available at design time.

Data Type

String

SigningKeyPassphraseValid Property (PGPWriter Component)

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

Syntax

__property bool SigningKeyPassphraseValid[int SigningKeyIndex] = { read=FSigningKeyPassphraseValid };

Default Value

false

Remarks

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

The SigningKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningKeyCount property.

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

Data Type

Boolean

SigningKeyUsername Property (PGPWriter Component)

Specifies the name of the user bound to this key.

Syntax

__property String SigningKeyUsername[int SigningKeyIndex] = { read=FSigningKeyUsername, write=FSetSigningKeyUsername };

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

This property is not available at design time.

Data Type

String

Timestamp Property (PGPWriter Component)

The date and time of the last modification of the protected data file (in UTC).

Syntax

__property String Timestamp = { read=FTimestamp, write=FSetTimestamp };

Default Value

""

Remarks

Use this property to set a timestamp for the data being protected.

Data Type

String

ClearTextSign Method (PGPWriter Component)

Creates a cleartext signature over the provided data.

Syntax

void __fastcall ClearTextSign();

Remarks

Call this method to create a cleartext signature over the provided data buffer (InputBytes). Only textual data can be signed in cleartext.

Pass the signing key(s) via SigningKeys property.

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

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

Encrypt Method (PGPWriter Component)

Encrypts data.

Syntax

void __fastcall Encrypt();

Remarks

Use this method to encrypt input data from a byte array (InputBytes), a file (InputFile) or a stream (InputStream) and get the protected message in another byte array (OutputBytes), or another file (OutputFile), or another stream (OutputStream).

Specify encryption keys in EncryptingKeys property, and/or encryption password via Passphrase property.

EncryptAndSign Method (PGPWriter Component)

Encrypts and signs data.

Syntax

void __fastcall EncryptAndSign();

Remarks

Use this method to encrypt and sign a byte array (InputBytes), a file (InputFile) or a stream (InputStream) and get the protected message in another byte array (OutputBytes), or another file (OutputFile), or another stream (OutputStream).

Specify encryption keys in EncryptingKeys property, and/or encryption password via Passphrase property. Use SigningKeys to provide the signing keys.

Please note that you might need to provide a passphrase to decrypt your signing key. This can be done via KeyPassphraseNeeded event, or by assigning the passphrase to the key object's Passphrase property.

Sign Method (PGPWriter Component)

Signs data.

Syntax

void __fastcall Sign(bool Detached);

Remarks

Use this method to sign a byte array (InputBytes), a file (InputFile) or a stream (InputStream) and get the signed message in another byte array (OutputBytes), or another file (OutputFile), or another stream (OutputStream).

Use SigningKeys to provide the signing keys.

Please note that you might need to provide a passphrase to decrypt your signing key. This can be done via KeyPassphraseNeeded event, or by assigning the passphrase to the key object's Passphrase property.

Error Event (PGPWriter Component)

Information about errors during PGP encryption.

Syntax

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

Remarks

The event is fired in case of exceptional conditions during data encryption or signing.

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

ExternalSign Event (PGPWriter Component)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

typedef struct {
  String OperationId;
  String HashAlgorithm;
  String Pars;
  String Data;
  String SignedData;
} TsbxPGPWriterExternalSignEventParams;
typedef void __fastcall (__closure *TsbxPGPWriterExternalSignEvent)(System::TObject* Sender, TsbxPGPWriterExternalSignEventParams *e);
__property TsbxPGPWriterExternalSignEvent OnExternalSign = { read=FOnExternalSign, write=FOnExternalSign };

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the component via the SignedData parameter.

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

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

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

KeyPassphraseNeeded Event (PGPWriter Component)

Requests a key protection password from the application.

Syntax

typedef struct {
  String KeyID;
  String UserID;
  bool MainKey;
  String Passphrase;
  bool Skip;
} TsbxPGPWriterKeyPassphraseNeededEventParams;
typedef void __fastcall (__closure *TsbxPGPWriterKeyPassphraseNeededEvent)(System::TObject* Sender, TsbxPGPWriterKeyPassphraseNeededEventParams *e);
__property TsbxPGPWriterKeyPassphraseNeededEvent 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 (PGPWriter Component)

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

Syntax

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

Progress Event (PGPWriter Component)

Reports the progress of the decryption operation.

Syntax

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

Remarks

The component fires this event repeatedly to report the progress of the file protection 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 protection process.

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

PGPWriter Config Settings

Base Config Settings

Trappable Errors (PGPWriter Component)

PGPWriter Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Component is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
	27262977   File does not exist (SB_ERROR_PGP_FILE_NOT_EXISTS)
	27262978   Invalid key (SB_ERROR_PGP_INVALID_KEY)
	27262979   No public key (SB_ERROR_PGP_NO_PUBLIC_KEY)
	27262980   No secret key (SB_ERROR_PGP_NO_SECRET_KEY)
	27262981   Not found (SB_ERROR_PGP_NOT_FOUND)
	27262982   Operation cannot be performed on a subkey (SB_ERROR_PGP_OPERATION_ON_SUBKEY)