ComputeSecretKDF Property

The key derivation function.

Syntax

 ecc.getComputeSecretKDF([callback])
 ecc.setComputeSecretKDF( computeSecretKDF, [callback])

Possible Values

  0 (ekdSHA1), 
  1 (ekdSHA256), 
  2 (ekdSHA384), 
  3 (ekdSHA512), 
  4 (ekdMD2), 
  5 (ekdMD4), 
  6 (ekdMD5), 
  7 (ekdHMACSHA1), 
  8 (ekdHMACSHA256), 
  9 (ekdHMACSHA384), 
  10 (ekdHMACSHA512), 
  11 (ekdHMACMD5), 
  12 (ekdTLS), 
  13 (ekdConcat)

Default Value

1

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 getComputeSecretKDF([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 setComputeSecretKDF([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) and algorithm to use when calling ComputeSecret.

Possible values are:

HMAC Notes

If an HMAC algorithm is selected HMACKey may optionally be set to specify the key.

TLS Notes

When set to TLS, TLSSeed and TLSLabel are required. In addition PrependSecret and AppendSecret are not applicable.

Concat Notes

If Concat is selected the following configuration settings are applicable:

• ConcatAlgorithmId (required)
• ConcatPartyUInfo (required)
• ConcatPartyVInfo (required)
• ConcatSuppPubInfo
• ConcatSuppPrivInfo
• ConcatHashAlgorithm

Data Type

Integer