XMLDecryptor Class

Properties   Methods   Events   Config Settings   Errors  

The XMLDecryptor class decrypts XML documents.

Class Name

SecureBlackbox_XMLDecryptor

Procedural Interface

 secureblackbox_xmldecryptor_open();
 secureblackbox_xmldecryptor_close($res);
 secureblackbox_xmldecryptor_register_callback($res, $id, $function);
 secureblackbox_xmldecryptor_get_last_error($res);
 secureblackbox_xmldecryptor_get_last_error_code($res);
 secureblackbox_xmldecryptor_set($res, $id, $index, $value);
 secureblackbox_xmldecryptor_get($res, $id, $index);
 secureblackbox_xmldecryptor_do_config($res, $configurationstring);
 secureblackbox_xmldecryptor_do_decrypt($res);
 secureblackbox_xmldecryptor_do_doaction($res, $actionid, $actionparams);

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

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

Object Oriented Interface

public function getDecryptionKey();


public function setDecryptionKey($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 1 );


secureblackbox_xmldecryptor_set($res, 1, $value );

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

Specifies XML encoding.

Object Oriented Interface

public function getEncoding();


public function setEncoding($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 2 );


secureblackbox_xmldecryptor_set($res, 2, $value );

Default Value

''

Remarks

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

Data Type

String

EncryptedDataType Property (SecureBlackbox_XMLDecryptor Class)

Defines the type of data being encrypted.

Object Oriented Interface

public function getEncryptedDataType();

Procedural Interface

secureblackbox_xmldecryptor_get($res, 3 );

Default Value

0

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

The encryption method used to encrypt the document.

Object Oriented Interface

public function getEncryptionMethod();

Procedural Interface

secureblackbox_xmldecryptor_get($res, 4 );

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

Specifies if the encryption key is encrypted.

Object Oriented Interface

public function getEncryptKey();

Procedural Interface

secureblackbox_xmldecryptor_get($res, 5 );

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

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

Object Oriented Interface

public function getExternalCryptoAsyncDocumentID();


public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 6 );


secureblackbox_xmldecryptor_set($res, 6, $value );

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

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

Object Oriented Interface

public function getExternalCryptoCustomParams();


public function setExternalCryptoCustomParams($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 7 );


secureblackbox_xmldecryptor_set($res, 7, $value );

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

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

Object Oriented Interface

public function getExternalCryptoData();


public function setExternalCryptoData($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 8 );


secureblackbox_xmldecryptor_set($res, 8, $value );

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

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

Object Oriented Interface

public function getExternalCryptoExternalHashCalculation();


public function setExternalCryptoExternalHashCalculation($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 9 );


secureblackbox_xmldecryptor_set($res, 9, $value );

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 class.

If set to true, the class 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 (SecureBlackbox_XMLDecryptor Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

public function getExternalCryptoHashAlgorithm();


public function setExternalCryptoHashAlgorithm($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 10 );


secureblackbox_xmldecryptor_set($res, 10, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_XMLDecryptor Class)

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

Object Oriented Interface

public function getExternalCryptoKeyID();


public function setExternalCryptoKeyID($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 11 );


secureblackbox_xmldecryptor_set($res, 11, $value );

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

The pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeySecret();


public function setExternalCryptoKeySecret($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 12 );


secureblackbox_xmldecryptor_set($res, 12, $value );

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

Specifies the asynchronous signing method.

Object Oriented Interface

public function getExternalCryptoMethod();


public function setExternalCryptoMethod($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 13 );


secureblackbox_xmldecryptor_set($res, 13, $value );

Default Value

0

Remarks

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

Available options:

Data Type

Integer

ExternalCryptoMode Property (SecureBlackbox_XMLDecryptor Class)

Specifies the external cryptography mode.

Object Oriented Interface

public function getExternalCryptoMode();


public function setExternalCryptoMode($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 14 );


secureblackbox_xmldecryptor_set($res, 14, $value );

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (SecureBlackbox_XMLDecryptor Class)

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

Object Oriented Interface

public function getExternalCryptoPublicKeyAlgorithm();


public function setExternalCryptoPublicKeyAlgorithm($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 15 );


secureblackbox_xmldecryptor_set($res, 15, $value );

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

The data that should be encrypted.

Object Oriented Interface

public function getExternalData();


public function setExternalData($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 16 );


secureblackbox_xmldecryptor_set($res, 16, $value );

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

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 17 );


secureblackbox_xmldecryptor_set($res, 17, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (SecureBlackbox_XMLDecryptor Class)

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

Object Oriented Interface

public function getInputBytes();


public function setInputBytes($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 18 );


secureblackbox_xmldecryptor_set($res, 18, $value );

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

The XML file to be decrypted.

Object Oriented Interface

public function getInputFile();


public function setInputFile($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 19 );


secureblackbox_xmldecryptor_set($res, 19, $value );

Default Value

''

Remarks

Provide the path to the XML document to be decrypted.

Data Type

String

KeyDecryptionCertBytes Property (SecureBlackbox_XMLDecryptor Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getKeyDecryptionCertBytes();

Procedural Interface

secureblackbox_xmldecryptor_get($res, 20 );

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

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

Object Oriented Interface

public function getKeyDecryptionCertHandle();


public function setKeyDecryptionCertHandle($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 27 );


secureblackbox_xmldecryptor_set($res, 27, $value );

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

The symmetric key used to decrypt a session key.

Object Oriented Interface

public function getKeyDecryptionKey();


public function setKeyDecryptionKey($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 54 );


secureblackbox_xmldecryptor_set($res, 54, $value );

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

Defines how the session key is encrypted.

Object Oriented Interface

public function getKeyEncryptionType();

Procedural Interface

secureblackbox_xmldecryptor_get($res, 55 );

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

KeyInfoItemCount Property (SecureBlackbox_XMLDecryptor Class)

The number of records in the KeyInfoItem arrays.

Object Oriented Interface

public function getKeyInfoItemCount();

Procedural Interface

secureblackbox_xmldecryptor_get($res, 56 );

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

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

Object Oriented Interface

public function getKeyInfoItemIssuerRDN($keyinfoitemindex);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 57 , $keyinfoitemindex);

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

Returns the certificate's serial number.

Object Oriented Interface

public function getKeyInfoItemSerialNumber($keyinfoitemindex);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 58 , $keyinfoitemindex);

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

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

Object Oriented Interface

public function getKeyInfoItemSubjectKeyID($keyinfoitemindex);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 59 , $keyinfoitemindex);

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

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

Object Oriented Interface

public function getKeyInfoItemSubjectRDN($keyinfoitemindex);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 60 , $keyinfoitemindex);

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

The number of records in the KeyInfoCertificate arrays.

Object Oriented Interface

public function getKeyInfoCertificateCount();

Procedural Interface

secureblackbox_xmldecryptor_get($res, 61 );

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

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getKeyInfoCertificateBytes($keyinfocertificateindex);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 62 , $keyinfocertificateindex);

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

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

Object Oriented Interface

public function getKeyInfoCertificateHandle($keyinfocertificateindex);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 69 , $keyinfocertificateindex);

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

Defines how the session key is encrypted.

Object Oriented Interface

public function getKeyTransportMethod();

Procedural Interface

secureblackbox_xmldecryptor_get($res, 96 );

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

The key wrap method used to encrypt the session key.

Object Oriented Interface

public function getKeyWrapMethod();

Procedural Interface

secureblackbox_xmldecryptor_get($res, 97 );

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

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

Object Oriented Interface

public function getOutputBytes();

Procedural Interface

secureblackbox_xmldecryptor_get($res, 98 );

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

Defines where to save the decrypted XML document.

Object Oriented Interface

public function getOutputFile();


public function setOutputFile($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 99 );


secureblackbox_xmldecryptor_set($res, 99, $value );

Default Value

''

Remarks

A path where the decrypted XML document should be saved.

Data Type

String

UseGCM Property (SecureBlackbox_XMLDecryptor Class)

Indicates if GCM mode was enabled.

Object Oriented Interface

public function getUseGCM();

Procedural Interface

secureblackbox_xmldecryptor_get($res, 100 );

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

Defines the XML element to decrypt.

Object Oriented Interface

public function getXMLElement();


public function setXMLElement($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 101 );


secureblackbox_xmldecryptor_set($res, 101, $value );

Default Value

''

Remarks

Defines the XML element to decrypt.

Supported values are:

Data Type

String

NamespaceCount Property (SecureBlackbox_XMLDecryptor Class)

The number of records in the Namespace arrays.

Object Oriented Interface

public function getNamespaceCount();


public function setNamespaceCount($value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 102 );


secureblackbox_xmldecryptor_set($res, 102, $value );

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

A user-defined prefix value of a namespace.

Object Oriented Interface

public function getNamespacePrefix($namespaceindex);


public function setNamespacePrefix($namespaceindex, $value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 103 , $namespaceindex);


secureblackbox_xmldecryptor_set($res, 103, $value , $namespaceindex);

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

A user-defined URI value of a namespace.

Object Oriented Interface

public function getNamespaceURI($namespaceindex);


public function setNamespaceURI($namespaceindex, $value);

Procedural Interface

secureblackbox_xmldecryptor_get($res, 104 , $namespaceindex);


secureblackbox_xmldecryptor_set($res, 104, $value , $namespaceindex);

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

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_xmldecryptor_do_config($res, $configurationstring);

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.

Decrypt Method (SecureBlackbox_XMLDecryptor Class)

Decrypts an XML document.

Object Oriented Interface

public function doDecrypt();

Procedural Interface

secureblackbox_xmldecryptor_do_decrypt($res);

Remarks

Call this method to decrypt an XML document.

DoAction Method (SecureBlackbox_XMLDecryptor Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_xmldecryptor_do_doaction($res, $actionid, $actionparams);

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;....

DecryptionInfoNeeded Event (SecureBlackbox_XMLDecryptor Class)

Requests decryption information from the application.

Object Oriented Interface

public function fireDecryptionInfoNeeded($param);

Procedural Interface

secureblackbox_xmldecryptor_register_callback($res, 1, array($this, 'fireDecryptionInfoNeeded'));

Parameter List

 'canceldecryption'

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

Information about errors during signing.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_xmldecryptor_register_callback($res, 2, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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

Handles remote or external decryption.

Object Oriented Interface

public function fireExternalDecrypt($param);

Procedural Interface

secureblackbox_xmldecryptor_register_callback($res, 3, array($this, 'fireExternalDecrypt'));

Parameter List

 'operationid'
 'algorithm'
 'pars'
 'encrypteddata'
 'data'

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

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_xmldecryptor_register_callback($res, 4, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

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

Request to save decrypted external data.

Object Oriented Interface

public function fireSaveExternalData($param);

Procedural Interface

secureblackbox_xmldecryptor_register_callback($res, 5, array($this, 'fireSaveExternalData'));

Parameter List

 'externaldata'

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

The class 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 class, access to these internal properties is provided through the Config method.

XMLDecryptor Config Settings

Base Config Settings

Trappable Errors (XMLDecryptor Class)

XMLDecryptor Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Class 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)