HashAlgorithm Property

The hash algorithm used for hash computation.

Syntax

 ecc.getHashAlgorithm([callback])
 ecc.setHashAlgorithm( hashAlgorithm, [callback])

Possible Values

  0 (ehaSHA1), 
  1 (ehaSHA224), 
  2 (ehaSHA256), 
  3 (ehaSHA384), 
  4 (ehaSHA512), 
  5 (ehaMD2), 
  6 (ehaMD4), 
  7 (ehaMD5), 
  8 (ehaMD5SHA1), 
  9 (ehaRIPEMD160)

Default Value

2

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 getHashAlgorithm([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 setHashAlgorithm([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 hash algorithm used for hash computation. This is only applicable when calling Sign or VerifySignature and KeyAlgorithm specifies a ECDSA key (secp256r1, secp384r1, or secp521r1. Possible values are:

When KeyAlgorithm specified an EdDSA key this setting is not applicable as the hash algorithm is defined by the specification as SHA-512 for ed25519 and SHAKE-256 for ed448.

Data Type

Integer