DetachedSignature Property

Specifies whether to include a detached signature when signing a message.

Syntax

 cms.getDetachedSignature([callback])
 cms.setDetachedSignature( detachedSignature, [callback])

Default Value

FALSE

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getDetachedSignature([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setDetachedSignature([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property specifies whether the Sign operation products a message that includes both a signature and the message data, or just a signature.

When set to False default the output message holds the data and signature in one CMS message. This may be passed in its entirety to the receiving party for signature verification.

When set to True the output message holds only a signature in the CMS message. Both the original input data and the signature in the output message produced by the Sign operation must be passed to the receiving party for signature verification.

Data Type

Boolean