IncludeCertificates Property

Specifies whether to include the signer's certificate with the signed message.

Syntax

 cms.getIncludeCertificates([callback])
 cms.setIncludeCertificates( includeCertificates, [callback])

Possible Values

  0 (icsNone), 
  1 (icsSignerCerts), 
  2 (icsSignerCertsAndChain)

Default Value

1

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 getIncludeCertificates([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 setIncludeCertificates([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 setting specifies which certificates (if any) are included in the signed message. By default the public certificate of the certificate used to sign the message is included. This allows the receiving party to verify the signature without any additional knowledge. If this is set to icsNone the recipient must obtain and specify the public certificate to be used for signature verification. Possible values are:

Data Type

Integer