XMLDecryptor Class

Properties   Methods   Events   Config Settings   Errors  

The XMLDecryptor class decrypts XML documents.

Syntax

XMLDecryptor

Remarks

XMlDecryptor decrypts XML documents encrypted with certificates or generic keys.

Property List

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

Method List

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

Event List

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

Config Settings

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

DecryptionKey Property (XMLDecryptor Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionKey(char* &lpDecryptionKey, int &lenDecryptionKey);
int SetDecryptionKey(const char* lpDecryptionKey, int lenDecryptionKey);

Unicode (Windows)
INT GetDecryptionKey(LPSTR &lpDecryptionKey, INT &lenDecryptionKey);
INT SetDecryptionKey(LPCSTR lpDecryptionKey, INT lenDecryptionKey);

int secureblackbox_xmldecryptor_getdecryptionkey(void* lpObj, char** lpDecryptionKey, int* lenDecryptionKey);
int secureblackbox_xmldecryptor_setdecryptionkey(void* lpObj, const char* lpDecryptionKey, int lenDecryptionKey);

QByteArray GetDecryptionKey();
int SetDecryptionKey(QByteArray qbaDecryptionKey);

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

Specifies XML encoding.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncoding();
int SetEncoding(const char* lpszEncoding);

Unicode (Windows)
LPWSTR GetEncoding();
INT SetEncoding(LPCWSTR lpszEncoding);

char* secureblackbox_xmldecryptor_getencoding(void* lpObj);
int secureblackbox_xmldecryptor_setencoding(void* lpObj, const char* lpszEncoding);

QString GetEncoding();
int SetEncoding(QString qsEncoding);

Default Value

""

Remarks

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

Data Type

String

EncryptedDataType Property (XMLDecryptor Class)

Defines the type of data being encrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptedDataType();

Unicode (Windows)
INT GetEncryptedDataType();

CXEDT_ELEMENT(0), 
CXEDT_CONTENT(1), 
CXEDT_EXTERNAL(2)

int secureblackbox_xmldecryptor_getencrypteddatatype(void* lpObj);

int GetEncryptedDataType();

Default Value

0

Remarks

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

Supported values:

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

Data Type

Integer

EncryptionMethod Property (XMLDecryptor Class)

The encryption method used to encrypt the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionMethod();

Unicode (Windows)
LPWSTR GetEncryptionMethod();

char* secureblackbox_xmldecryptor_getencryptionmethod(void* lpObj);

QString GetEncryptionMethod();

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

Specifies if the encryption key is encrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptKey();

Unicode (Windows)
BOOL GetEncryptKey();

int secureblackbox_xmldecryptor_getencryptkey(void* lpObj);

bool GetEncryptKey();

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

ExternalCrypto Property (XMLDecryptor Class)

Provides access to external signing and DC parameters.

Syntax

• C++
• C
• Qt

SecureBlackboxExternalCrypto* GetExternalCrypto();

char* secureblackbox_xmldecryptor_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_xmldecryptor_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);

char* secureblackbox_xmldecryptor_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_xmldecryptor_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);

char* secureblackbox_xmldecryptor_getexternalcryptodata(void* lpObj);
int secureblackbox_xmldecryptor_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);

int secureblackbox_xmldecryptor_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_xmldecryptor_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);

char* secureblackbox_xmldecryptor_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_xmldecryptor_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

char* secureblackbox_xmldecryptor_getexternalcryptokeyid(void* lpObj);
int secureblackbox_xmldecryptor_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);

char* secureblackbox_xmldecryptor_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_xmldecryptor_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);

int secureblackbox_xmldecryptor_getexternalcryptomethod(void* lpObj);
int secureblackbox_xmldecryptor_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);

int secureblackbox_xmldecryptor_getexternalcryptomode(void* lpObj);
int secureblackbox_xmldecryptor_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

char* secureblackbox_xmldecryptor_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_xmldecryptor_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);

QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);

QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);

bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);

QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);

QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);

QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);

int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

Data Type

SecureBlackboxExternalCrypto

ExternalData Property (XMLDecryptor Class)

The data that should be encrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalData(char* &lpExternalData, int &lenExternalData);
int SetExternalData(const char* lpExternalData, int lenExternalData);

Unicode (Windows)
INT GetExternalData(LPSTR &lpExternalData, INT &lenExternalData);
INT SetExternalData(LPCSTR lpExternalData, INT lenExternalData);

int secureblackbox_xmldecryptor_getexternaldata(void* lpObj, char** lpExternalData, int* lenExternalData);
int secureblackbox_xmldecryptor_setexternaldata(void* lpObj, const char* lpExternalData, int lenExternalData);

QByteArray GetExternalData();
int SetExternalData(QByteArray qbaExternalData);

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

Reserved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_xmldecryptor_getfipsmode(void* lpObj);
int secureblackbox_xmldecryptor_setfipsmode(void* lpObj, int bFIPSMode);

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (XMLDecryptor Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputBytes(char* &lpInputBytes, int &lenInputBytes);
int SetInputBytes(const char* lpInputBytes, int lenInputBytes);

Unicode (Windows)
INT GetInputBytes(LPSTR &lpInputBytes, INT &lenInputBytes);
INT SetInputBytes(LPCSTR lpInputBytes, INT lenInputBytes);

int secureblackbox_xmldecryptor_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_xmldecryptor_setinputbytes(void* lpObj, const char* lpInputBytes, int lenInputBytes);

QByteArray GetInputBytes();
int SetInputBytes(QByteArray qbaInputBytes);

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

The XML file to be decrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* secureblackbox_xmldecryptor_getinputfile(void* lpObj);
int secureblackbox_xmldecryptor_setinputfile(void* lpObj, const char* lpszInputFile);

QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

""

Remarks

Provide the path to the XML document to be decrypted.

Data Type

String

KeyDecryptionCertificate Property (XMLDecryptor Class)

The certificate used to decrypt a session key.

Syntax

• C++
• C
• Qt

SecureBlackboxCertificate* GetKeyDecryptionCertificate();
int SetKeyDecryptionCertificate(SecureBlackboxCertificate* val);

int secureblackbox_xmldecryptor_getkeydecryptioncertbytes(void* lpObj, char** lpKeyDecryptionCertBytes, int* lenKeyDecryptionCertBytes);

int64 secureblackbox_xmldecryptor_getkeydecryptioncerthandle(void* lpObj);
int secureblackbox_xmldecryptor_setkeydecryptioncerthandle(void* lpObj, int64 lKeyDecryptionCertHandle);

QByteArray GetKeyDecryptionCertBytes();

qint64 GetKeyDecryptionCertHandle();
int SetKeyDecryptionCertHandle(qint64 lKeyDecryptionCertHandle);

Remarks

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

This property is not available at design time.

Data Type

SecureBlackboxCertificate

KeyDecryptionKey Property (XMLDecryptor Class)

The symmetric key used to decrypt a session key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyDecryptionKey(char* &lpKeyDecryptionKey, int &lenKeyDecryptionKey);
int SetKeyDecryptionKey(const char* lpKeyDecryptionKey, int lenKeyDecryptionKey);

Unicode (Windows)
INT GetKeyDecryptionKey(LPSTR &lpKeyDecryptionKey, INT &lenKeyDecryptionKey);
INT SetKeyDecryptionKey(LPCSTR lpKeyDecryptionKey, INT lenKeyDecryptionKey);

int secureblackbox_xmldecryptor_getkeydecryptionkey(void* lpObj, char** lpKeyDecryptionKey, int* lenKeyDecryptionKey);
int secureblackbox_xmldecryptor_setkeydecryptionkey(void* lpObj, const char* lpKeyDecryptionKey, int lenKeyDecryptionKey);

QByteArray GetKeyDecryptionKey();
int SetKeyDecryptionKey(QByteArray qbaKeyDecryptionKey);

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

Defines how the session key is encrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyEncryptionType();

Unicode (Windows)
INT GetKeyEncryptionType();

CXET_KEY_TRANSPORT(0), 
CXET_KEY_WRAP(1)

int secureblackbox_xmldecryptor_getkeyencryptiontype(void* lpObj);

int GetKeyEncryptionType();

Default Value

0

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

KeyInfo Property (XMLDecryptor Class)

A collection of KeyInfo items found in the KeyInfo element.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxXMLKeyInfoItem>* GetKeyInfo();

int secureblackbox_xmldecryptor_getkeyinfoitemcount(void* lpObj);

char* secureblackbox_xmldecryptor_getkeyinfoitemissuerrdn(void* lpObj, int keyinfoitemindex);

int secureblackbox_xmldecryptor_getkeyinfoitemserialnumber(void* lpObj, int keyinfoitemindex, char** lpKeyInfoItemSerialNumber, int* lenKeyInfoItemSerialNumber);

int secureblackbox_xmldecryptor_getkeyinfoitemsubjectkeyid(void* lpObj, int keyinfoitemindex, char** lpKeyInfoItemSubjectKeyID, int* lenKeyInfoItemSubjectKeyID);

char* secureblackbox_xmldecryptor_getkeyinfoitemsubjectrdn(void* lpObj, int keyinfoitemindex);

int GetKeyInfoItemCount();

QString GetKeyInfoItemIssuerRDN(int iKeyInfoItemIndex);

QByteArray GetKeyInfoItemSerialNumber(int iKeyInfoItemIndex);

QByteArray GetKeyInfoItemSubjectKeyID(int iKeyInfoItemIndex);

QString GetKeyInfoItemSubjectRDN(int iKeyInfoItemIndex);

Remarks

A collection of KeyInfo items that contains information about the public key that is used to perform encryption.

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

Data Type

SecureBlackboxXMLKeyInfoItem

KeyInfoCertificates Property (XMLDecryptor Class)

A collection of certificates found in the KeyInfo element.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxCertificate>* GetKeyInfoCertificates();

int secureblackbox_xmldecryptor_getkeyinfocertificatecount(void* lpObj);

int secureblackbox_xmldecryptor_getkeyinfocertificatebytes(void* lpObj, int keyinfocertificateindex, char** lpKeyInfoCertificateBytes, int* lenKeyInfoCertificateBytes);

int64 secureblackbox_xmldecryptor_getkeyinfocertificatehandle(void* lpObj, int keyinfocertificateindex);

int GetKeyInfoCertificateCount();

QByteArray GetKeyInfoCertificateBytes(int iKeyInfoCertificateIndex);

qint64 GetKeyInfoCertificateHandle(int iKeyInfoCertificateIndex);

Remarks

A collection of certificates that contains information about the public key that is used to perform encryption.

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

Data Type

SecureBlackboxCertificate

KeyTransportMethod Property (XMLDecryptor Class)

Defines how the session key is encrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyTransportMethod();

Unicode (Windows)
INT GetKeyTransportMethod();

CXKT_RSA15(0), 
CXKT_RSAOAEP(1)

int secureblackbox_xmldecryptor_getkeytransportmethod(void* lpObj);

int GetKeyTransportMethod();

Default Value

0

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

The key wrap method used to encrypt the session key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyWrapMethod();

Unicode (Windows)
LPWSTR GetKeyWrapMethod();

char* secureblackbox_xmldecryptor_getkeywrapmethod(void* lpObj);

QString GetKeyWrapMethod();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputBytes(char* &lpOutputBytes, int &lenOutputBytes);

Unicode (Windows)
INT GetOutputBytes(LPSTR &lpOutputBytes, INT &lenOutputBytes);

int secureblackbox_xmldecryptor_getoutputbytes(void* lpObj, char** lpOutputBytes, int* lenOutputBytes);

QByteArray GetOutputBytes();

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

Defines where to save the decrypted XML document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* secureblackbox_xmldecryptor_getoutputfile(void* lpObj);
int secureblackbox_xmldecryptor_setoutputfile(void* lpObj, const char* lpszOutputFile);

QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

Default Value

""

Remarks

A path where the decrypted XML document should be saved.

Data Type

String

UseGCM Property (XMLDecryptor Class)

Indicates if GCM mode was enabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseGCM();

Unicode (Windows)
BOOL GetUseGCM();

int secureblackbox_xmldecryptor_getusegcm(void* lpObj);

bool GetUseGCM();

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

Defines the XML element to decrypt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXMLElement();
int SetXMLElement(const char* lpszXMLElement);

Unicode (Windows)
LPWSTR GetXMLElement();
INT SetXMLElement(LPCWSTR lpszXMLElement);

char* secureblackbox_xmldecryptor_getxmlelement(void* lpObj);
int secureblackbox_xmldecryptor_setxmlelement(void* lpObj, const char* lpszXMLElement);

QString GetXMLElement();
int SetXMLElement(QString qsXMLElement);

Default Value

""

Remarks

Defines the XML element to decrypt.

Supported values are:

Data Type

String

AddKnownNamespace Method (XMLDecryptor Class)

Adds known prefix and correspondent namespace URI.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddKnownNamespace(const char* lpszPrefix, const char* lpszURI);

Unicode (Windows)
INT AddKnownNamespace(LPCWSTR lpszPrefix, LPCWSTR lpszURI);

int secureblackbox_xmldecryptor_addknownnamespace(void* lpObj, const char* lpszPrefix, const char* lpszURI);

int AddKnownNamespace(const QString& qsPrefix, const QString& qsURI);

Remarks

Use this method to add a known prefix and namespace URI that are used in XPath expression within XMLElement/XMLNode property, and within TargetXMLElement and XPathPrefixList properties of the references.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (XMLDecryptor Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_xmldecryptor_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Decrypt Method (XMLDecryptor Class)

Decrypts an XML document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Decrypt();

Unicode (Windows)
INT Decrypt();

int secureblackbox_xmldecryptor_decrypt(void* lpObj);

int Decrypt();

Remarks

Call this method to decrypt an XML document.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoAction Method (XMLDecryptor Class)

Performs an additional action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);

char* secureblackbox_xmldecryptor_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

QString DoAction(const QString& qsActionID, const QString& qsActionParams);

Remarks

DoAction is a generic method available in every class. 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:

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Reset Method (XMLDecryptor Class)

Resets the class settings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int secureblackbox_xmldecryptor_reset(void* lpObj);

int Reset();

Remarks

Reset is a generic method available in every class.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DecryptionInfoNeeded Event (XMLDecryptor Class)

Requests decryption information from the application.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDecryptionInfoNeeded(XMLDecryptorDecryptionInfoNeededEventParams *e);

typedef struct {
  int CancelDecryption;
  int reserved;
} XMLDecryptorDecryptionInfoNeededEventParams;


Unicode (Windows)
virtual INT FireDecryptionInfoNeeded(XMLDecryptorDecryptionInfoNeededEventParams *e);

typedef struct {
  BOOL CancelDecryption;
  INT reserved;
} XMLDecryptorDecryptionInfoNeededEventParams;

#define EID_XMLDECRYPTOR_DECRYPTIONINFONEEDED 1

virtual INT SECUREBLACKBOX_CALL FireDecryptionInfoNeeded(BOOL &bCancelDecryption);

class XMLDecryptorDecryptionInfoNeededEventParams {
public:
  bool CancelDecryption();
  void SetCancelDecryption(bool bCancelDecryption);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DecryptionInfoNeeded(XMLDecryptorDecryptionInfoNeededEventParams *e);

// Or, subclass XMLDecryptor and override this emitter function.
virtual int FireDecryptionInfoNeeded(XMLDecryptorDecryptionInfoNeededEventParams *e) {...}

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

Information about errors during signing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(XMLDecryptorErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} XMLDecryptorErrorEventParams;


Unicode (Windows)
virtual INT FireError(XMLDecryptorErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} XMLDecryptorErrorEventParams;

#define EID_XMLDECRYPTOR_ERROR 2

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class XMLDecryptorErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(XMLDecryptorErrorEventParams *e);

// Or, subclass XMLDecryptor and override this emitter function.
virtual int FireError(XMLDecryptorErrorEventParams *e) {...}

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

Handles remote or external decryption.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireExternalDecrypt(XMLDecryptorExternalDecryptEventParams *e);

typedef struct {
  const char *OperationId;
  const char *Algorithm;
  const char *Pars;
  const char *EncryptedData;
  char *Data;
  int reserved;
} XMLDecryptorExternalDecryptEventParams;


Unicode (Windows)
virtual INT FireExternalDecrypt(XMLDecryptorExternalDecryptEventParams *e);

typedef struct {
  LPCWSTR OperationId;
  LPCWSTR Algorithm;
  LPCWSTR Pars;
  LPCWSTR EncryptedData;
  LPWSTR Data;
  INT reserved;
} XMLDecryptorExternalDecryptEventParams;

#define EID_XMLDECRYPTOR_EXTERNALDECRYPT 3

virtual INT SECUREBLACKBOX_CALL FireExternalDecrypt(LPSTR &lpszOperationId, LPSTR &lpszAlgorithm, LPSTR &lpszPars, LPSTR &lpszEncryptedData, LPSTR &lpszData);

class XMLDecryptorExternalDecryptEventParams {
public:
  const QString &OperationId();

  const QString &Algorithm();

  const QString &Pars();

  const QString &EncryptedData();

  const QString &Data();
  void SetData(const QString &qsData);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ExternalDecrypt(XMLDecryptorExternalDecryptEventParams *e);

// Or, subclass XMLDecryptor and override this emitter function.
virtual int FireExternalDecrypt(XMLDecryptorExternalDecryptEventParams *e) {...}

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 class being used, and may be empty. Algorithm specifies the encryption algorithm being used, and Pars contains algorithm-dependent parameters.

The class 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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireNotification(XMLDecryptorNotificationEventParams *e);

typedef struct {
  const char *EventID;
  const char *EventParam;
  int reserved;
} XMLDecryptorNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(XMLDecryptorNotificationEventParams *e);

typedef struct {
  LPCWSTR EventID;
  LPCWSTR EventParam;
  INT reserved;
} XMLDecryptorNotificationEventParams;

#define EID_XMLDECRYPTOR_NOTIFICATION 4

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);

class XMLDecryptorNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Notification(XMLDecryptorNotificationEventParams *e);

// Or, subclass XMLDecryptor and override this emitter function.
virtual int FireNotification(XMLDecryptorNotificationEventParams *e) {...}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. 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 class, the exact action it is performing, or the document being processed, one or both may be omitted.

SaveExternalData Event (XMLDecryptor Class)

Request to save decrypted external data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSaveExternalData(XMLDecryptorSaveExternalDataEventParams *e);

typedef struct {
  const char *ExternalData;
  int lenExternalData;
  int reserved;
} XMLDecryptorSaveExternalDataEventParams;


Unicode (Windows)
virtual INT FireSaveExternalData(XMLDecryptorSaveExternalDataEventParams *e);

typedef struct {
  LPCSTR ExternalData;
  INT lenExternalData;
  INT reserved;
} XMLDecryptorSaveExternalDataEventParams;

#define EID_XMLDECRYPTOR_SAVEEXTERNALDATA 5

virtual INT SECUREBLACKBOX_CALL FireSaveExternalData(LPSTR &lpExternalData, INT &lenExternalData);

class XMLDecryptorSaveExternalDataEventParams {
public:
  const QByteArray &ExternalData();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SaveExternalData(XMLDecryptorSaveExternalDataEventParams *e);

// Or, subclass XMLDecryptor and override this emitter function.
virtual int FireSaveExternalData(XMLDecryptorSaveExternalDataEventParams *e) {...}

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.

Certificate Type

Encapsulates an individual X.509 certificate.

Syntax

SecureBlackboxCertificate (declared in secureblackbox.h)

Remarks

This type keeps and provides access to X.509 certificate details.

Fields

Constructors

Certificate()

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Syntax

SecureBlackboxExternalCrypto (declared in secureblackbox.h)

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

Fields

Constructors

ExternalCrypto()

XMLKeyInfoItem Type

Represents an XML KeyInfo item.

Syntax

SecureBlackboxXMLKeyInfoItem (declared in secureblackbox.h)

Remarks

This object contains information about the public key that was used to perform encryption or signing.

Fields

Constructors

XMLKeyInfoItem()

SecureBlackboxList Type

Syntax

SecureBlackboxList<T> (declared in secureblackbox.h)

Remarks

SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the XMLDecryptor class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (XMLDecryptor Class)

XMLDecryptor Config Settings

Base Config Settings

Trappable Errors (XMLDecryptor Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

XMLDecryptor Errors