XMLDecryptor Component

Properties   Methods   Events   Config Settings   Errors  

The XMLDecryptor component decrypts XML documents.

Syntax

TsbxXMLDecryptor

Remarks

XMlDecryptor decrypts XML documents encrypted with certificates or generic 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.

DecryptionKey Property (XMLDecryptor Component)

The symmetric (session) key used to encrypt the data.

Syntax

__property DynamicArray DecryptionKey = { read=FDecryptionKey, write=FSetDecryptionKey };

Remarks

Use this property to provide the encryption symmetric (session) key that will be used to encrypt a data.

It is required when the EncryptKey property is disabled. If the EncryptKey property is enabled, and no value is set, the component will generate a random session key (recommended).

This property is not available at design time.

Data Type

Byte Array

Encoding Property (XMLDecryptor Component)

Specifies XML encoding.

Syntax

__property String Encoding = { read=FEncoding, write=FSetEncoding };

Default Value

""

Remarks

Use this property to specify the encoding to apply to the XML documents.

Data Type

String

EncryptedDataType Property (XMLDecryptor Component)

Defines the type of data being encrypted.

Syntax

__property TsbxXMLDecryptorEncryptedDataTypes EncryptedDataType = { read=FEncryptedDataType };

enum TsbxXMLDecryptorEncryptedDataTypes {
  cxedtElement=0,
  cxedtContent=1,
  cxedtExternal=2
};

Default Value

cxedtElement

Remarks

This property defines what data type is about to be encrypted.

Supported values:

If the XMLNode property is set to the empty string, and the InputStream and InputFile properties are not provided, then a new XML document will be created with the xenc:EncryptedData element as a document element.

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

Data Type

Integer

EncryptionMethod Property (XMLDecryptor Component)

The encryption method used to encrypt the document.

Syntax

__property String EncryptionMethod = { read=FEncryptionMethod };

Default Value

"AES256"

Remarks

This property contains the encryption algorithm used to encrypt the XML document.

Supported values:

If UseGCM property is enabled, then supported values are:

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

Data Type

String

EncryptKey Property (XMLDecryptor Component)

Specifies if the encryption key is encrypted.

Syntax

__property bool EncryptKey = { read=FEncryptKey };

Default Value

true

Remarks

Use this property to specify if encryption (session) key should be encrypted and also added to the encrypted data.

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

Data Type

Boolean

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

Specifies the asynchronous signing method.

Syntax

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

enum TsbxXMLDecryptorExternalCryptoMethods {
  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 (XMLDecryptor Component)

Specifies the external cryptography mode.

Syntax

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

enum TsbxXMLDecryptorExternalCryptoModes {
  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 (XMLDecryptor 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

ExternalData Property (XMLDecryptor Component)

The data that should be encrypted.

Syntax

__property DynamicArray ExternalData = { read=FExternalData, write=FSetExternalData };

Remarks

Use this property to provide the data that should be encrypted if EncryptedDataType property is set to cxedtExternal value.

This property is not available at design time.

Data Type

Byte Array

FIPSMode Property (XMLDecryptor 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 (XMLDecryptor 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 (XMLDecryptor Component)

The XML file to be decrypted.

Syntax

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

Default Value

""

Remarks

Provide the path to the XML document to be decrypted.

Data Type

String

KeyDecryptionCertBytes Property (XMLDecryptor Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray KeyDecryptionCertBytes = { read=FKeyDecryptionCertBytes };

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

KeyDecryptionCertHandle Property (XMLDecryptor Component)

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

Syntax

__property __int64 KeyDecryptionCertHandle = { read=FKeyDecryptionCertHandle, write=FSetKeyDecryptionCertHandle };

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

KeyDecryptionKey Property (XMLDecryptor Component)

The symmetric key used to decrypt a session key.

Syntax

__property DynamicArray KeyDecryptionKey = { read=FKeyDecryptionKey, write=FSetKeyDecryptionKey };

Remarks

Use this property to provide the decryption symmetric key that will be used to decrypt a session key. It is required when EncryptKey property is enabled and KeyEncryptionType set to cxetKeyWrap value.

This property is not available at design time.

Data Type

Byte Array

KeyEncryptionType Property (XMLDecryptor Component)

Defines how the session key is encrypted.

Syntax

__property TsbxXMLDecryptorKeyEncryptionTypes KeyEncryptionType = { read=FKeyEncryptionType };

enum TsbxXMLDecryptorKeyEncryptionTypes {
  cxetKeyTransport=0,
  cxetKeyWrap=1
};

Default Value

cxetKeyTransport

Remarks

This property defines how the session key is encrypted.

Supported values:

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

Data Type

Integer

KeyInfoItemCount Property (XMLDecryptor Component)

The number of records in the KeyInfoItem arrays.

Syntax

__property int KeyInfoItemCount = { read=FKeyInfoItemCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• KeyInfoItemIssuerRDN
• KeyInfoItemSerialNumber
• KeyInfoItemSubjectKeyID
• KeyInfoItemSubjectRDN

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

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

Data Type

Integer

KeyInfoItemIssuerRDN Property (XMLDecryptor Component)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Syntax

__property String KeyInfoItemIssuerRDN[int KeyInfoItemIndex] = { read=FKeyInfoItemIssuerRDN };

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

The KeyInfoItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyInfoItemCount property.

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

Data Type

String

KeyInfoItemSerialNumber Property (XMLDecryptor Component)

Returns the certificate's serial number.

Syntax

__property DynamicArray KeyInfoItemSerialNumber[int KeyInfoItemIndex] = { read=FKeyInfoItemSerialNumber };

Remarks

Returns the certificate's serial number.

The KeyInfoItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyInfoItemCount property.

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

Data Type

Byte Array

KeyInfoItemSubjectKeyID Property (XMLDecryptor Component)

Contains a unique identifier (fingerprint) of the certificate's private key.

Syntax

__property DynamicArray KeyInfoItemSubjectKeyID[int KeyInfoItemIndex] = { read=FKeyInfoItemSubjectKeyID };

Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

The KeyInfoItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyInfoItemCount property.

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

Data Type

Byte Array

KeyInfoItemSubjectRDN Property (XMLDecryptor Component)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Syntax

__property String KeyInfoItemSubjectRDN[int KeyInfoItemIndex] = { read=FKeyInfoItemSubjectRDN };

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

The KeyInfoItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyInfoItemCount property.

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

Data Type

String

KeyInfoCertificateCount Property (XMLDecryptor Component)

The number of records in the KeyInfoCertificate arrays.

Syntax

__property int KeyInfoCertificateCount = { read=FKeyInfoCertificateCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• KeyInfoCertificateBytes
• KeyInfoCertificateHandle

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

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

Data Type

Integer

KeyInfoCertificateBytes Property (XMLDecryptor Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray KeyInfoCertificateBytes[int KeyInfoCertificateIndex] = { read=FKeyInfoCertificateBytes };

Remarks

Returns the raw certificate data in DER format.

The KeyInfoCertificateIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyInfoCertificateCount property.

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

Data Type

Byte Array

KeyInfoCertificateHandle Property (XMLDecryptor Component)

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

Syntax

__property __int64 KeyInfoCertificateHandle[int KeyInfoCertificateIndex] = { read=FKeyInfoCertificateHandle };

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

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

Data Type

Long64

KeyTransportMethod Property (XMLDecryptor Component)

Defines how the session key is encrypted.

Syntax

__property TsbxXMLDecryptorKeyTransportMethods KeyTransportMethod = { read=FKeyTransportMethod };

enum TsbxXMLDecryptorKeyTransportMethods {
  cxktRSA15=0,
  cxktRSAOAEP=1
};

Default Value

cxktRSA15

Remarks

This property defines how the session key is encrypted.

Supported values:

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

Data Type

Integer

KeyWrapMethod Property (XMLDecryptor Component)

The key wrap method used to encrypt the session key.

Syntax

__property String KeyWrapMethod = { read=FKeyWrapMethod };

Default Value

"Cammelia256"

Remarks

This property specifies the key wrap algorithm used to encrypt the session key.

Supported values:

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

Data Type

String

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

Defines where to save the decrypted XML document.

Syntax

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

Default Value

""

Remarks

A path where the decrypted XML document should be saved.

Data Type

String

UseGCM Property (XMLDecryptor Component)

Indicates if GCM mode was enabled.

Syntax

__property bool UseGCM = { read=FUseGCM };

Default Value

true

Remarks

Use this property to check if GCM encryption mode was enabled.

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

Data Type

Boolean

XMLElement Property (XMLDecryptor Component)

Defines the XML element to decrypt.

Syntax

__property String XMLElement = { read=FXMLElement, write=FSetXMLElement };

Default Value

""

Remarks

Defines the XML element to decrypt.

Supported values are:

Data Type

String

NamespaceCount Property (XMLDecryptor Component)

The number of records in the Namespace arrays.

Syntax

__property int NamespaceCount = { read=FNamespaceCount, write=FSetNamespaceCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• NamespacePrefix
• NamespaceURI

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

This property is not available at design time.

Data Type

Integer

NamespacePrefix Property (XMLDecryptor Component)

A user-defined prefix value of a namespace.

Syntax

__property String NamespacePrefix[int NamespaceIndex] = { read=FNamespacePrefix, write=FSetNamespacePrefix };

Default Value

""

Remarks

A user-defined prefix value of a namespace.

The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is not available at design time.

Data Type

String

NamespaceURI Property (XMLDecryptor Component)

A user-defined URI value of a namespace.

Syntax

__property String NamespaceURI[int NamespaceIndex] = { read=FNamespaceURI, write=FSetNamespaceURI };

Default Value

""

Remarks

A user-defined URI value of a namespace.

The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is not available at design time.

Data Type

String

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

Decrypt Method (XMLDecryptor Component)

Decrypts an XML document.

Syntax

void __fastcall Decrypt();

Remarks

Call this method to decrypt an XML document.

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

DecryptionInfoNeeded Event (XMLDecryptor Component)

Requests decryption information from the application.

Syntax

typedef struct {
  bool CancelDecryption;
} TsbxXMLDecryptorDecryptionInfoNeededEventParams;
typedef void __fastcall (__closure *TsbxXMLDecryptorDecryptionInfoNeededEvent)(System::TObject* Sender, TsbxXMLDecryptorDecryptionInfoNeededEventParams *e);
__property TsbxXMLDecryptorDecryptionInfoNeededEvent OnDecryptionInfoNeeded = { read=FOnDecryptionInfoNeeded, write=FOnDecryptionInfoNeeded };

Remarks

This event is fired when the component needs decryption information (the private key) from the user.

Use EncryptKey, Config["KeyName"] and KeyEncryptionType properties to identify the encryption type and then set DecryptionKey or KeyDecryptionKey or KeyDecryptionCertificate properties accordingly.

if CancelDecryption property is set to true value (default value) then decryption would fail if provided key/certificate is invalid. Otherwise this event would be fired again.

Error Event (XMLDecryptor Component)

Information about errors during signing.

Syntax

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

Remarks

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

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

ExternalDecrypt Event (XMLDecryptor Component)

Handles remote or external decryption.

Syntax

typedef struct {
  String OperationId;
  String Algorithm;
  String Pars;
  String EncryptedData;
  String Data;
} TsbxXMLDecryptorExternalDecryptEventParams;
typedef void __fastcall (__closure *TsbxXMLDecryptorExternalDecryptEvent)(System::TObject* Sender, TsbxXMLDecryptorExternalDecryptEventParams *e);
__property TsbxXMLDecryptorExternalDecryptEvent 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

Notification Event (XMLDecryptor Component)

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

Syntax

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

SaveExternalData Event (XMLDecryptor Component)

Request to save decrypted external data.

Syntax

typedef struct {
  DynamicArray ExternalData;
} TsbxXMLDecryptorSaveExternalDataEventParams;
typedef void __fastcall (__closure *TsbxXMLDecryptorSaveExternalDataEvent)(System::TObject* Sender, TsbxXMLDecryptorSaveExternalDataEventParams *e);
__property TsbxXMLDecryptorSaveExternalDataEvent OnSaveExternalData = { read=FOnSaveExternalData, write=FOnSaveExternalData };

Remarks

This event is fired when the component successfully decrypted an external data and needs to save it. The same data could be read using ExternalData property.

It makes sense to use this event when the XML document contains several xenc:EncryptedData elements and the component decrypts them all.

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

XMLDecryptor Config Settings

Base Config Settings

Trappable Errors (XMLDecryptor Component)

XMLDecryptor 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) 
	39845889   Input file does not exist (SB_ERROR_XML_INPUTFILE_NOT_EXISTS)
	39845890   Data file does not exist (SB_ERROR_XML_DATAFILE_NOT_EXISTS)
	39845891   Unsupported signature method type (SB_ERROR_XML_UNSUPPORTED_SIGNATURE_METHOD_TYPE)
	39845892   Unsupported has algorithm (SB_ERROR_XML_UNSUPPORTED_HASH_ALGORITHM)
	39845893   Unsupported key type (SB_ERROR_XML_UNSUPPORTED_KEY_TYPE)
	39845894   Invalid key type (SB_ERROR_XML_INVALID_KEY_TYPE)
	39845895   Invalid encryption method (SB_ERROR_XML_INVALID_ENCRYPTION_METHOD)
	39845896   Not found (SB_ERROR_XML_NOT_FOUND)
	39845897   No element ID (SB_ERROR_XML_NO_ELEMENT_ID)