SOAPQuickSigner Class

Properties   Methods   Events   Config Settings   Errors  

The SOAPQuickSigner class signs SOAP messages.

Class Name

SecureBlackbox_SOAPQuickSigner

Procedural Interface

 secureblackbox_soapquicksigner_open();
 secureblackbox_soapquicksigner_close($res);
 secureblackbox_soapquicksigner_register_callback($res, $id, $function);
 secureblackbox_soapquicksigner_get_last_error($res);
 secureblackbox_soapquicksigner_get_last_error_code($res);
 secureblackbox_soapquicksigner_set($res, $id, $index, $value);
 secureblackbox_soapquicksigner_get($res, $id, $index);
 secureblackbox_soapquicksigner_do_addbodyreference($res, $customid, $autogenerateid);
 secureblackbox_soapquicksigner_do_adddatareference($res, $datauri, $data);
 secureblackbox_soapquicksigner_do_addknownnamespace($res, $prefix, $uri);
 secureblackbox_soapquicksigner_do_addreference($res, $targetxmlelement, $customid, $autogenerateid);
 secureblackbox_soapquicksigner_do_config($res, $configurationstring);
 secureblackbox_soapquicksigner_do_doaction($res, $actionid, $actionparams);
 secureblackbox_soapquicksigner_do_extractasyncdata($res, $asyncreply);
 secureblackbox_soapquicksigner_do_getinnerxml($res, $xpath);
 secureblackbox_soapquicksigner_do_getouterxml($res, $xpath);
 secureblackbox_soapquicksigner_do_gettextcontent($res, $xpath);
 secureblackbox_soapquicksigner_do_reset($res);
 secureblackbox_soapquicksigner_do_setinnerxml($res, $xpath, $value);
 secureblackbox_soapquicksigner_do_settextcontent($res, $xpath, $value);
 secureblackbox_soapquicksigner_do_sign($res);
 secureblackbox_soapquicksigner_do_signasyncbegin($res);
 secureblackbox_soapquicksigner_do_signasyncend($res, $asyncreply);
 secureblackbox_soapquicksigner_do_signexternal($res);

Remarks

The purpose of the SOAPQuickSigner class is creating simple generic signatures over SOAP messages. Unlike SOAPSigner, it does not include chain validation and LTV features, and may be more appropriate for scenarios where no chain validation is required.

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.

CanonicalizationMethod Property (SecureBlackbox_SOAPQuickSigner Class)

Specifies XML canonicalization method to use.

Object Oriented Interface

public function getCanonicalizationMethod();
public function setCanonicalizationMethod($value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 1 );
secureblackbox_soapquicksigner_set($res, 1, $value );

Default Value

1

Remarks

Use this property to specify the method for XML canonicalization of SignedInfo element. See XML-Signature Syntax and Processing specification for details.

Supported canonicalization methods:

Data Type

Integer

EmbedCertificateMethod Property (SecureBlackbox_SOAPQuickSigner Class)

Controls the certificate disposition within the signature.

Object Oriented Interface

public function getEmbedCertificateMethod();
public function setEmbedCertificateMethod($value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 2 );
secureblackbox_soapquicksigner_set($res, 2, $value );

Default Value

1

Remarks

This property controls the method of embedding the signing certificate(s) into the signature if WS-Security signature type is used.

Supported values:

Data Type

Integer

Encoding Property (SecureBlackbox_SOAPQuickSigner Class)

Specifies XML encoding.

Object Oriented Interface

public function getEncoding();
public function setEncoding($value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 3 );
secureblackbox_soapquicksigner_set($res, 3, $value );

Default Value

''

Remarks

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

Data Type

String

ExternalCryptoAsyncDocumentID Property (SecureBlackbox_SOAPQuickSigner Class)

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

Object Oriented Interface

public function getExternalCryptoAsyncDocumentID();
public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 4 );
secureblackbox_soapquicksigner_set($res, 4, $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_SOAPQuickSigner Class)

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

Object Oriented Interface

public function getExternalCryptoCustomParams();
public function setExternalCryptoCustomParams($value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 5 );
secureblackbox_soapquicksigner_set($res, 5, $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_SOAPQuickSigner 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_soapquicksigner_get($res, 6 );
secureblackbox_soapquicksigner_set($res, 6, $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_SOAPQuickSigner 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_soapquicksigner_get($res, 7 );
secureblackbox_soapquicksigner_set($res, 7, $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_SOAPQuickSigner Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

public function getExternalCryptoHashAlgorithm();
public function setExternalCryptoHashAlgorithm($value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 8 );
secureblackbox_soapquicksigner_set($res, 8, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_SOAPQuickSigner 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_soapquicksigner_get($res, 9 );
secureblackbox_soapquicksigner_set($res, 9, $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_SOAPQuickSigner Class)

The pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeySecret();
public function setExternalCryptoKeySecret($value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 10 );
secureblackbox_soapquicksigner_set($res, 10, $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_SOAPQuickSigner Class)

Specifies the asynchronous signing method.

Object Oriented Interface

public function getExternalCryptoMethod();
public function setExternalCryptoMethod($value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 11 );
secureblackbox_soapquicksigner_set($res, 11, $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_SOAPQuickSigner Class)

Specifies the external cryptography mode.

Object Oriented Interface

public function getExternalCryptoMode();
public function setExternalCryptoMode($value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 12 );
secureblackbox_soapquicksigner_set($res, 12, $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_SOAPQuickSigner 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_soapquicksigner_get($res, 13 );
secureblackbox_soapquicksigner_set($res, 13, $value );

Default Value

''

Remarks

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

Data Type

String

FIPSMode Property (SecureBlackbox_SOAPQuickSigner Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();
public function setFIPSMode($value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 14 );
secureblackbox_soapquicksigner_set($res, 14, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

HashAlgorithm Property (SecureBlackbox_SOAPQuickSigner Class)

Specifies the hash algorithm to be used.

Object Oriented Interface

public function getHashAlgorithm();
public function setHashAlgorithm($value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 15 );
secureblackbox_soapquicksigner_set($res, 15, $value );

Default Value

'SHA256'

Remarks

Use this property to set the hash algorithm for signature calculation.

Supported values:

Data Type

String

InputFile Property (SecureBlackbox_SOAPQuickSigner Class)

Specifies the SOAP message to be signed.

Object Oriented Interface

public function getInputFile();
public function setInputFile($value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 16 );
secureblackbox_soapquicksigner_set($res, 16, $value );

Default Value

''

Remarks

Provide a full path to the SOAP message to be signed.

Data Type

String

OutputFile Property (SecureBlackbox_SOAPQuickSigner Class)

A file where the signed SOAP message will be saved.

Object Oriented Interface

public function getOutputFile();
public function setOutputFile($value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 17 );
secureblackbox_soapquicksigner_set($res, 17, $value );

Default Value

''

Remarks

Provide a full path to the file where the signed SOAP message should be saved.

Data Type

String

ReferenceCount Property (SecureBlackbox_SOAPQuickSigner Class)

The number of records in the Reference arrays.

Object Oriented Interface

public function getReferenceCount();
public function setReferenceCount($value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 18 );
secureblackbox_soapquicksigner_set($res, 18, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ReferenceAutoGenerateElementId
• ReferenceCanonicalizationMethod
• ReferenceCustomElementId
• ReferenceDataObjectDescription
• ReferenceDataObjectEncoding
• ReferenceDataObjectIdentifier
• ReferenceDataObjectMimeType
• ReferenceDigestValue
• ReferenceHandle
• ReferenceHasDataObjectFormat
• ReferenceHashAlgorithm
• ReferenceHasURI
• ReferenceID
• ReferenceInclusiveNamespacesPrefixList
• ReferenceReferenceType
• ReferenceTargetData
• ReferenceTargetType
• ReferenceTargetXMLElement
• ReferenceURI
• ReferenceUseBase64Transform
• ReferenceUseEnvelopedSignatureTransform
• ReferenceUseXPathFilter2Transform
• ReferenceUseXPathTransform
• ReferenceValidationResult
• ReferenceXPathExpression
• ReferenceXPathFilter2Expressions
• ReferenceXPathFilter2Filters
• ReferenceXPathFilter2PrefixList
• ReferenceXPathPrefixList

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

This property is not available at design time.

Data Type

Integer

ReferenceAutoGenerateElementId Property (SecureBlackbox_SOAPQuickSigner Class)

Specifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing.

Object Oriented Interface

public function getReferenceAutoGenerateElementId($referenceindex);
public function setReferenceAutoGenerateElementId($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 19 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 19, $value , $referenceindex);

Default Value

false

Remarks

Specifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing. Used when the referenced element doesn't have an ID and CustomElementId and URI properties are empty.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

Boolean

ReferenceCanonicalizationMethod Property (SecureBlackbox_SOAPQuickSigner Class)

Use this property to specify the canonicalization method for the transform of the reference.

Object Oriented Interface

public function getReferenceCanonicalizationMethod($referenceindex);
public function setReferenceCanonicalizationMethod($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 20 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 20, $value , $referenceindex);

Default Value

0

Remarks

Use this property to specify the canonicalization method for the transform of the reference. Use cxcmNone value to not to include canonicalization transform in transform chain. See XML-Signature Syntax and Processing specification for details.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

Integer

ReferenceCustomElementId Property (SecureBlackbox_SOAPQuickSigner Class)

Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing.

Object Oriented Interface

public function getReferenceCustomElementId($referenceindex);
public function setReferenceCustomElementId($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 21 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 21, $value , $referenceindex);

Default Value

''

Remarks

Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing. Used when the referenced element doesn't have an ID and URI property is empty.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceDataObjectDescription Property (SecureBlackbox_SOAPQuickSigner Class)

This property contains textual information related to the referenced data object, which is found in the corresponding DataObjectFormat's Description element.

Object Oriented Interface

public function getReferenceDataObjectDescription($referenceindex);
public function setReferenceDataObjectDescription($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 22 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 22, $value , $referenceindex);

Default Value

''

Remarks

This property contains textual information related to the referenced data object, which is found in the corresponding DataObjectFormat's Description element.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceDataObjectEncoding Property (SecureBlackbox_SOAPQuickSigner Class)

This property contains an indication of the encoding format of the referenced data object, which is found in the corresponding DataObjectFormat's Encoding element.

Object Oriented Interface

public function getReferenceDataObjectEncoding($referenceindex);
public function setReferenceDataObjectEncoding($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 23 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 23, $value , $referenceindex);

Default Value

''

Remarks

This property contains an indication of the encoding format of the referenced data object, which is found in the corresponding DataObjectFormat's Encoding element.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceDataObjectIdentifier Property (SecureBlackbox_SOAPQuickSigner Class)

This property contains an identifier indicating the type of the referenced data object, which is found in the corresponding DataObjectFormat's ObjectIdentifier element.

Object Oriented Interface

public function getReferenceDataObjectIdentifier($referenceindex);
public function setReferenceDataObjectIdentifier($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 24 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 24, $value , $referenceindex);

Default Value

''

Remarks

This property contains an identifier indicating the type of the referenced data object, which is found in the corresponding DataObjectFormat's ObjectIdentifier element.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceDataObjectMimeType Property (SecureBlackbox_SOAPQuickSigner Class)

This property contains an indication of the MIME type of the referenced data object, which is found in the corresponding DataObjectFormat's MimeType element.

Object Oriented Interface

public function getReferenceDataObjectMimeType($referenceindex);
public function setReferenceDataObjectMimeType($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 25 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 25, $value , $referenceindex);

Default Value

''

Remarks

This property contains an indication of the MIME type of the referenced data object, which is found in the corresponding DataObjectFormat's MimeType element.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceDigestValue Property (SecureBlackbox_SOAPQuickSigner Class)

Use this property to get or set the value of the digest calculated over the referenced data.

Object Oriented Interface

public function getReferenceDigestValue($referenceindex);
public function setReferenceDigestValue($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 26 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 26, $value , $referenceindex);

Remarks

Use this property to get or set the value of the digest calculated over the referenced data.

This property is optional and should be set only if you don't provide the actual data via TargetData or URI. If the data is set, then you don't need to set DigestValue since it will be calculated automatically.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

Byte Array

ReferenceHandle Property (SecureBlackbox_SOAPQuickSigner Class)

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

Object Oriented Interface

public function getReferenceHandle($referenceindex);
public function setReferenceHandle($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 27 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 27, $value , $referenceindex);

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

This property is not available at design time.

Data Type

Long64

ReferenceHasDataObjectFormat Property (SecureBlackbox_SOAPQuickSigner Class)

Specifies whether corresponding XAdES DataObjectFormat element is created for the current reference.

Object Oriented Interface

public function getReferenceHasDataObjectFormat($referenceindex);
public function setReferenceHasDataObjectFormat($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 28 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 28, $value , $referenceindex);

Default Value

false

Remarks

Specifies whether corresponding XAdES DataObjectFormat element is created for the current reference.

Check this property to find out if the reference has an associated DataObjectFormat element.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

Boolean

ReferenceHashAlgorithm Property (SecureBlackbox_SOAPQuickSigner Class)

Specifies the hash algorithm to be used.

Object Oriented Interface

public function getReferenceHashAlgorithm($referenceindex);
public function setReferenceHashAlgorithm($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 29 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 29, $value , $referenceindex);

Default Value

'SHA256'

Remarks

Specifies the hash algorithm to be used.

Supported values:

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceHasURI Property (SecureBlackbox_SOAPQuickSigner Class)

Specifies whether the URI is set (even when it is empty).

Object Oriented Interface

public function getReferenceHasURI($referenceindex);
public function setReferenceHasURI($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 30 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 30, $value , $referenceindex);

Default Value

true

Remarks

Specifies whether the URI is set (even when it is empty).

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

Boolean

ReferenceID Property (SecureBlackbox_SOAPQuickSigner Class)

A user-defined identifier (ID) attribute of this Reference element.

Object Oriented Interface

public function getReferenceID($referenceindex);
public function setReferenceID($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 31 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 31, $value , $referenceindex);

Default Value

''

Remarks

A user-defined identifier (ID) attribute of this Reference element.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceInclusiveNamespacesPrefixList Property (SecureBlackbox_SOAPQuickSigner Class)

Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference.

Object Oriented Interface

public function getReferenceInclusiveNamespacesPrefixList($referenceindex);
public function setReferenceInclusiveNamespacesPrefixList($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 32 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 32, $value , $referenceindex);

Default Value

''

Remarks

Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference. See XML-Signature Syntax and Processing specification for details.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceReferenceType Property (SecureBlackbox_SOAPQuickSigner Class)

The Reference's type attribute as defined in XMLDSIG specification.

Object Oriented Interface

public function getReferenceReferenceType($referenceindex);
public function setReferenceReferenceType($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 33 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 33, $value , $referenceindex);

Default Value

''

Remarks

The Reference's type attribute as defined in XMLDSIG specification.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceTargetData Property (SecureBlackbox_SOAPQuickSigner Class)

Contains the referenced external data when the digest value is not explicitly specified.

Object Oriented Interface

public function getReferenceTargetData($referenceindex);
public function setReferenceTargetData($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 34 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 34, $value , $referenceindex);

Remarks

Contains the referenced external data when the digest value is not explicitly specified.

This property is optional and should only be set if you reference the external data via URI, and you don't provide the digest value explicitly via DigestValue.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

Byte Array

ReferenceTargetType Property (SecureBlackbox_SOAPQuickSigner Class)

The reference's target type to use.

Object Oriented Interface

public function getReferenceTargetType($referenceindex);
public function setReferenceTargetType($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 35 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 35, $value , $referenceindex);

Default Value

0

Remarks

The reference's target type to use.

Use this property to specify the reference's target type to use when forming the signature.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

Integer

ReferenceTargetXMLElement Property (SecureBlackbox_SOAPQuickSigner Class)

This property specifies the referenced XML element.

Object Oriented Interface

public function getReferenceTargetXMLElement($referenceindex);
public function setReferenceTargetXMLElement($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 36 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 36, $value , $referenceindex);

Default Value

''

Remarks

This property specifies the referenced XML element. Used when the URI property is not set. In this case, the URI value is generated based on the ID of the referenced (target) XML element. If the URI property is set, this property is ignored until the ResolveReference event.

Supported values are:

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceURI Property (SecureBlackbox_SOAPQuickSigner Class)

Use this property to get or set the URL which references the data.

Object Oriented Interface

public function getReferenceURI($referenceindex);
public function setReferenceURI($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 37 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 37, $value , $referenceindex);

Default Value

''

Remarks

Use this property to get or set the URL which references the data. If the data is external, the application must set either TargetData or DigestValue. If TargetData is set, the digest is calculated automatically unless it is explicitly set by the application via DigestValue.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceUseBase64Transform Property (SecureBlackbox_SOAPQuickSigner Class)

Specifies whether Base64 transform is included in transform chain.

Object Oriented Interface

public function getReferenceUseBase64Transform($referenceindex);
public function setReferenceUseBase64Transform($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 38 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 38, $value , $referenceindex);

Default Value

false

Remarks

Specifies whether Base64 transform is included in transform chain.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

Boolean

ReferenceUseEnvelopedSignatureTransform Property (SecureBlackbox_SOAPQuickSigner Class)

Specifies whether enveloped signature transform is included in transform chain.

Object Oriented Interface

public function getReferenceUseEnvelopedSignatureTransform($referenceindex);
public function setReferenceUseEnvelopedSignatureTransform($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 39 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 39, $value , $referenceindex);

Default Value

false

Remarks

Specifies whether enveloped signature transform is included in transform chain.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

Boolean

ReferenceUseXPathFilter2Transform Property (SecureBlackbox_SOAPQuickSigner Class)

Specifies whether XPath Filter 2.

Object Oriented Interface

public function getReferenceUseXPathFilter2Transform($referenceindex);
public function setReferenceUseXPathFilter2Transform($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 40 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 40, $value , $referenceindex);

Default Value

false

Remarks

Specifies whether XPath Filter 2.0 transform is included in transform chain.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

Boolean

ReferenceUseXPathTransform Property (SecureBlackbox_SOAPQuickSigner Class)

Specifies whether XPath transform is included in transform chain.

Object Oriented Interface

public function getReferenceUseXPathTransform($referenceindex);
public function setReferenceUseXPathTransform($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 41 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 41, $value , $referenceindex);

Default Value

false

Remarks

Specifies whether XPath transform is included in transform chain.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

Boolean

ReferenceValidationResult Property (SecureBlackbox_SOAPQuickSigner Class)

The outcome of the cryptographic reference validation.

Object Oriented Interface

public function getReferenceValidationResult($referenceindex);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 42 , $referenceindex);

Default Value

false

Remarks

The outcome of the cryptographic reference validation.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

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

Data Type

Boolean

ReferenceXPathExpression Property (SecureBlackbox_SOAPQuickSigner Class)

Use this property to specify XPath expression for XPath transform of the reference.

Object Oriented Interface

public function getReferenceXPathExpression($referenceindex);
public function setReferenceXPathExpression($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 43 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 43, $value , $referenceindex);

Default Value

''

Remarks

Use this property to specify XPath expression for XPath transform of the reference.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceXPathFilter2Expressions Property (SecureBlackbox_SOAPQuickSigner Class)

Use this property to specify XPointer expression(s) for XPath Filter 2.

Object Oriented Interface

public function getReferenceXPathFilter2Expressions($referenceindex);
public function setReferenceXPathFilter2Expressions($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 44 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 44, $value , $referenceindex);

Default Value

''

Remarks

Use this property to specify XPointer expression(s) for XPath Filter 2.0 transform of the reference.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceXPathFilter2Filters Property (SecureBlackbox_SOAPQuickSigner Class)

Use this property to specify XPointer filter(s) for XPath Filter 2.

Object Oriented Interface

public function getReferenceXPathFilter2Filters($referenceindex);
public function setReferenceXPathFilter2Filters($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 45 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 45, $value , $referenceindex);

Default Value

''

Remarks

Use this property to specify XPointer filter(s) for XPath Filter 2.0 transform of the reference. The prefix list is comma-separated.

Supported values:

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceXPathFilter2PrefixList Property (SecureBlackbox_SOAPQuickSigner Class)

Use this property to specify a prefix list for XPath Filter 2.

Object Oriented Interface

public function getReferenceXPathFilter2PrefixList($referenceindex);
public function setReferenceXPathFilter2PrefixList($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 46 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 46, $value , $referenceindex);

Default Value

''

Remarks

Use this property to specify a prefix list for XPath Filter 2.0 transform of the reference. The prefix list is space-separated. Namespace URIs that are used are taken from XPathNamespaces property.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceXPathPrefixList Property (SecureBlackbox_SOAPQuickSigner Class)

Use this property to specify a prefix list for XPath transform of the reference.

Object Oriented Interface

public function getReferenceXPathPrefixList($referenceindex);
public function setReferenceXPathPrefixList($referenceindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 47 , $referenceindex);
secureblackbox_soapquicksigner_set($res, 47, $value , $referenceindex);

Default Value

''

Remarks

Use this property to specify a prefix list for XPath transform of the reference. The prefix list is space-separated. Namespace URIs that are used are taken from XPathNamespaces property.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

SecurityHeaderIndex Property (SecureBlackbox_SOAPQuickSigner Class)

Specifies the SecurityHeader index.

Object Oriented Interface

public function getSecurityHeaderIndex();
public function setSecurityHeaderIndex($value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 48 );
secureblackbox_soapquicksigner_set($res, 48, $value );

Default Value

-1

Remarks

Use this property to specify the index of SecurityHeader element where to put the signature. If the specified SecurityHeader element doesn't exist then a new SecurityHeader element will be created. The default value is "-1", in this case a new SecurityHeader element will be always created.

Data Type

Integer

SignatureType Property (SecureBlackbox_SOAPQuickSigner Class)

The SOAP signature type to use.

Object Oriented Interface

public function getSignatureType();
public function setSignatureType($value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 49 );
secureblackbox_soapquicksigner_set($res, 49, $value );

Default Value

1

Remarks

Use this property to specify the signature type to use when forming the signature.

Supported values:

Data Type

Integer

SigningCertBytes Property (SecureBlackbox_SOAPQuickSigner Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningCertBytes();

Procedural Interface

secureblackbox_soapquicksigner_get($res, 50 );

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

SigningCertHandle Property (SecureBlackbox_SOAPQuickSigner Class)

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

Object Oriented Interface

public function getSigningCertHandle();
public function setSigningCertHandle($value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 58 );
secureblackbox_soapquicksigner_set($res, 58, $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

SigningChainCount Property (SecureBlackbox_SOAPQuickSigner Class)

The number of records in the SigningChain arrays.

Object Oriented Interface

public function getSigningChainCount();
public function setSigningChainCount($value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 89 );
secureblackbox_soapquicksigner_set($res, 89, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SigningChainBytes
• SigningChainHandle

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

This property is not available at design time.

Data Type

Integer

SigningChainBytes Property (SecureBlackbox_SOAPQuickSigner Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningChainBytes($signingchainindex);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 90 , $signingchainindex);

Remarks

Returns the raw certificate data in DER format.

The $signingchainindex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

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

Data Type

Byte Array

SigningChainHandle Property (SecureBlackbox_SOAPQuickSigner Class)

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

Object Oriented Interface

public function getSigningChainHandle($signingchainindex);
public function setSigningChainHandle($signingchainindex, $value);

Procedural Interface

secureblackbox_soapquicksigner_get($res, 98 , $signingchainindex);
secureblackbox_soapquicksigner_set($res, 98, $value , $signingchainindex);

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

This property is not available at design time.

Data Type

Long64

AddBodyReference Method (SecureBlackbox_SOAPQuickSigner Class)

Creates a new XML reference to the Body element of the SOAP message.

Object Oriented Interface

public function doAddBodyReference($customid, $autogenerateid);

Procedural Interface

secureblackbox_soapquicksigner_do_addbodyreference($res, $customid, $autogenerateid);

Remarks

Use this method to add a reference to the Body element of the SOAP message.

The reference's URI is set basing on the ID of the XML element. If the XML element doesn't have an ID then a CustomId value will be used. If CustomId is empty and AutoGenerateId is set, the ID will be generated automatically. An exception will be thrown otherwise.

Use CanonicalizationMethod and HashAlgorithm properties to specify the canonicalization method and hash algorithm to use.

The method returns the index of the new reference entry in the References collection.

AddDataReference Method (SecureBlackbox_SOAPQuickSigner Class)

Creates a new XML reference to the specified data.

Object Oriented Interface

public function doAddDataReference($datauri, $data);

Procedural Interface

secureblackbox_soapquicksigner_do_adddatareference($res, $datauri, $data);

Remarks

Use this method to add a reference to the custom data. Pass the reference's URI via DataURI parameter.

Use HashAlgorithm property to specify the hash algorithm to use.

The method returns the index of the new reference entry in the References collection.

AddKnownNamespace Method (SecureBlackbox_SOAPQuickSigner Class)

Adds known prefix and correspondent namespace URI.

Object Oriented Interface

public function doAddKnownNamespace($prefix, $uri);

Procedural Interface

secureblackbox_soapquicksigner_do_addknownnamespace($res, $prefix, $uri);

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.

AddReference Method (SecureBlackbox_SOAPQuickSigner Class)

Creates a new XML reference to the specified XML element.

Object Oriented Interface

public function doAddReference($targetxmlelement, $customid, $autogenerateid);

Procedural Interface

secureblackbox_soapquicksigner_do_addreference($res, $targetxmlelement, $customid, $autogenerateid);

Remarks

Use this method to add a reference to a particular XML element.

The reference's URI is set basing on the ID of the XML element. If the XML element doesn't have an ID then a CustomId value will be used. If CustomId is empty and AutoGenerateId is set, the ID will be generated automatically. An exception will be thrown otherwise.

Use CanonicalizationMethod and HashAlgorithm properties to specify the canonicalization method and hash algorithm to use.

The method returns the index of the new reference entry in the References collection.

Config Method (SecureBlackbox_SOAPQuickSigner Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

DoAction Method (SecureBlackbox_SOAPQuickSigner Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

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

Common ActionIDs:

ExtractAsyncData Method (SecureBlackbox_SOAPQuickSigner Class)

Extracts user data from the DC signing service response.

Object Oriented Interface

public function doExtractAsyncData($asyncreply);

Procedural Interface

secureblackbox_soapquicksigner_do_extractasyncdata($res, $asyncreply);

Remarks

Call this method before finalizing the asynchronous signing process to extract the data passed to the ExternalCrypto.Data property on the pre-signing stage.

The Data parameter can be used to pass some state or document identifier along with the signing request from the pre-signing to the completion async stage.

GetInnerXML Method (SecureBlackbox_SOAPQuickSigner Class)

Get the inner XML content of the selected XML element.

Object Oriented Interface

public function doGetInnerXML($xpath);

Procedural Interface

secureblackbox_soapquicksigner_do_getinnerxml($res, $xpath);

Remarks

Call this method to get the inner XML content of the selected XML element.

GetOuterXML Method (SecureBlackbox_SOAPQuickSigner Class)

Get the outer XML content of the selected XML element.

Object Oriented Interface

public function doGetOuterXML($xpath);

Procedural Interface

secureblackbox_soapquicksigner_do_getouterxml($res, $xpath);

Remarks

Call this method to get the outer XML content of the selected XML element.

GetTextContent Method (SecureBlackbox_SOAPQuickSigner Class)

Get the text content of the selected XML element.

Object Oriented Interface

public function doGetTextContent($xpath);

Procedural Interface

secureblackbox_soapquicksigner_do_gettextcontent($res, $xpath);

Remarks

Call this method to get the text content of the selected XML element.

Reset Method (SecureBlackbox_SOAPQuickSigner Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_soapquicksigner_do_reset($res);

Remarks

Reset is a generic method available in every class.

SetInnerXML Method (SecureBlackbox_SOAPQuickSigner Class)

Set the inner XML content of the selected XML element.

Object Oriented Interface

public function doSetInnerXML($xpath, $value);

Procedural Interface

secureblackbox_soapquicksigner_do_setinnerxml($res, $xpath, $value);

Remarks

Call this method to set the inner XML content of the selected XML element.

SetTextContent Method (SecureBlackbox_SOAPQuickSigner Class)

Set the text content of the selected XML element.

Object Oriented Interface

public function doSetTextContent($xpath, $value);

Procedural Interface

secureblackbox_soapquicksigner_do_settextcontent($res, $xpath, $value);

Remarks

Call this method to set the text content of the selected XML element.

Sign Method (SecureBlackbox_SOAPQuickSigner Class)

Signs the SOAP message.

Object Oriented Interface

public function doSign();

Procedural Interface

secureblackbox_soapquicksigner_do_sign($res);

Remarks

Call this method to generate a signed SOAP message.

SignAsyncBegin Method (SecureBlackbox_SOAPQuickSigner Class)

Initiates the asynchronous signing operation.

Object Oriented Interface

public function doSignAsyncBegin();

Procedural Interface

secureblackbox_soapquicksigner_do_signasyncbegin($res);

Remarks

When using the DC framework, call this method to initiate the asynchronous signing process. Upon completion, a pre-signed copy of the document will be saved in OutputFile (or OutputStream). Keep the pre-signed copy somewhere local, and pass the returned string ('the request state') to the DC processor for handling.

Upon receiving the response state from the DC processor, assign the path to the pre-signed copy to InputFile (or InputStream), and call SignAsyncEnd to finalize the signing.

Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the SigningCertificate property.

Use the ExternalCrypto.AsyncDocumentID property to supply a unique document ID to include in the request. This is helpful when creating batches of multiple async requests, as it allows you to pass the whole response batch to SignAsyncEnd and expect it to recover the correct response from the batch automatically.

AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.

In a typical scenario you get a client-side async state from the SignAsyncBegin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth class), which processes it and produces a matching signature state. The async state produced by the server is then passed to the SignAsyncEnd method.

SignAsyncEnd Method (SecureBlackbox_SOAPQuickSigner Class)

Completes the asynchronous signing operation.

Object Oriented Interface

public function doSignAsyncEnd($asyncreply);

Procedural Interface

secureblackbox_soapquicksigner_do_signasyncend($res, $asyncreply);

Remarks

When using the DC framework, call this method upon receiving the response state from the DC processor to complete the asynchronous signing process.

Before calling this method, assign the path to the pre-signed copy of the document obtained from the prior SignAsyncBegin call to InputFile (or InputStream). The method will embed the signature into the pre-signed document, and save the complete signed document to OutputFile (or OutputStream).

Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the SigningCertificate property.

Use the ExternalCrypto.AsyncDocumentID parameter to pass a specific document ID if using batched AsyncReply. If used, it should match the value provided on the pre-signing (SignAsyncBegin) stage.

AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.

In a typical scenario you get a client-side async state from the SignAsyncBegin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth class), which processes it and produces a matching signature state. The async state produced by the server is then passed to the SignAsyncEnd method.

SignExternal Method (SecureBlackbox_SOAPQuickSigner Class)

Signs the document using an external signing facility.

Object Oriented Interface

public function doSignExternal();

Procedural Interface

secureblackbox_soapquicksigner_do_signexternal($res);

Remarks

Call this method to delegate the low-level signing operation to an external, remote, or custom signing engine. This method is useful if the signature has to be made by a device accessible through a custom or non-standard signing interface.

When all preparations are done and hash is computed, the class fires ExternalSign event which allows to pass the hash value for signing.

Error Event (SecureBlackbox_SOAPQuickSigner Class)

Information about errors during signing.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_soapquicksigner_register_callback($res, 1, 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. For a list of valid error codes and their descriptions, please refer to SOAP.

ExternalSign Event (SecureBlackbox_SOAPQuickSigner Class)

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

Object Oriented Interface

public function fireExternalSign($param);

Procedural Interface

secureblackbox_soapquicksigner_register_callback($res, 2, array($this, 'fireExternalSign'));

Parameter List

 'operationid'
 'hashalgorithm'
 'pars'
 'data'
 'signeddata'

Remarks

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

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

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

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

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

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

FormatElement Event (SecureBlackbox_SOAPQuickSigner Class)

Reports the XML element that is currently being processed.

Object Oriented Interface

public function fireFormatElement($param);

Procedural Interface

secureblackbox_soapquicksigner_register_callback($res, 3, array($this, 'fireFormatElement'));

Parameter List

 'starttagwhitespace'
 'endtagwhitespace'
 'level'
 'path'
 'haschildelements'

Remarks

Path and Level specify the path to the XML element being processed and its nesting level, respectively.

HasChildElements specify if processed XML element has child elements.

Among other purposes, this event may be used to add whitespace formatting before or after a particular element in the signature.

FormatText Event (SecureBlackbox_SOAPQuickSigner Class)

Reports XML text that is currently being processed.

Object Oriented Interface

public function fireFormatText($param);

Procedural Interface

secureblackbox_soapquicksigner_register_callback($res, 4, array($this, 'fireFormatText'));

Parameter List

 'text'
 'texttype'
 'level'
 'path'

Remarks

TextType parameter specifies the type of the XML text (normal or Base64-encoded) that is stored in the element; Path and Level specify the path to the XML element and its nesting level.

Among other purposes, this event may be used to add whitespace formatting before or after a particular element in the signature.

Notification Event (SecureBlackbox_SOAPQuickSigner Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_soapquicksigner_register_callback($res, 5, 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.

This class can fire this event with the following EventID values:

ResolveReference Event (SecureBlackbox_SOAPQuickSigner Class)

Asks the application to resolve a reference.

Object Oriented Interface

public function fireResolveReference($param);

Procedural Interface

secureblackbox_soapquicksigner_register_callback($res, 6, array($this, 'fireResolveReference'));

Parameter List

 'referenceindex'
 'uri'

Remarks

This event is fired when the control could not automatically resolve a reference and requires custom treatment.

URI contains a reference to the data.

ReferenceIndex specifies the index of the reference to process.

Based on the reference's URI the event handler should set either TargetXMLElement or TargetData property of the reference.

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

SOAPQuickSigner Config Settings

Base Config Settings

Trappable Errors (SOAPQuickSigner Class)

SOAPQuickSigner Errors