IPWorks Encrypt 2020 Node.js Edition

Questions / Feedback?

KDFHashAlgorithm Property

The KDF hash algorithm to use when encrypting and decrypting.

Syntax

 ecc.getKDFHashAlgorithm([callback])
 ecc.setKDFHashAlgorithm( KDFHashAlgorithm, [callback])

Possible Values

  0 (iesSHA1), 
  1 (iesSHA224), 
  2 (iesSHA256), 
  3 (iesSHA384), 
  4 (iesSHA512)

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 getKDFHashAlgorithm([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 setKDFHashAlgorithm([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 to use in when deriving a key using the specified KDF. Possible values are:

  • 0 (iesSHA1)
  • 1 (iesSHA224)
  • 2 (iesSHA256)
  • 3 (iesSHA384)
  • 4 (iesSHA512)

This property is only applicable when calling Encrypt or Decrypt.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Encrypt 2020 Node.js Edition - Version 20.0 [Build 8155]