SigningAlgorithm Property

The signing algorithm.

Syntax

 xmlsig.getSigningAlgorithm([callback])
 xmlsig.setSigningAlgorithm( signingAlgorithm, [callback])

Default Value

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 getSigningAlgorithm([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 setSigningAlgorithm([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 the signing algorithm.

This may be set before calling Sign. This value will be set after calling VerifySignature. Possible values are:

"RSA-SHA1" (default)
"RSA-SHA256"
"DSA-SHA1"
"HMAC-SHA1"

Note: When set to "HMAC-SHA1" HMACKey must also be set.

This property is not available at design time.

Data Type

String