HMACAlgorithm Property

The HMAC algorithm to use during encryption.

Syntax

 ecc.getHMACAlgorithm([callback])
 ecc.setHMACAlgorithm( HMACAlgorithm, [callback])

Possible Values

  0 (iesHMACSHA1), 
  1 (iesHMACSHA224), 
  2 (iesHMACSHA256), 
  3 (iesHMACSHA384), 
  4 (iesHMACSHA512), 
  5 (iesHMACRIPEMD160)

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 getHMACAlgorithm([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 setHMACAlgorithm([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 HMAC algorithm to use when encrypting. The HMAC algorithm is used when Encrypt and Decrypt are called to protect and verify data. Possible values are:

• 0 (iesHMACSHA1)
• 1 (iesHMACSHA224)
• 2 (iesHMACSHA256 - Default)
• 3 (iesHMACSHA384)
• 4 (iesHMACSHA512)
• 5 (iesHMACRIPEMD160)

This property is only applicable when calling Encrypt or Decrypt.

Data Type

Integer