IPWorks Encrypt 2020 Node.js Edition

Questions / Feedback?

KDF Property

The key derivation function used during encryption and decryption.

Syntax

 ecc.getKDF([callback])
 ecc.setKDF( KDF, [callback])

Default Value

"KDF2"

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 getKDF([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 setKDF([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 key derivation function (KDF) to use when encrypting and decrypting. Possible values are:

  • "KDF1"
  • "KDF2" (Default)
The KDFHashAlgorithm specifies the hash algorithm used in conjunction with the specified KDF.

This property is only applicable when calling Encrypt or Decrypt.

Data Type

String

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