SigningAlgorithm Property

The signature hash algorithm used when signing.

Syntax

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

Default Value

"SHA1"

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 signature hash algorithm used when signing. Possible values are:

• SHA1 (default)
• MD5
• SHA256
• SHA384
• SHA512
• SHA224
• RIPEMD160

Data Type

String