IPWorks Encrypt 2020 Node.js Edition

Questions / Feedback?

Algorithm Property

The underlying pseudorandom function.

Syntax

 pbkdf.getAlgorithm([callback])
 pbkdf.setAlgorithm( algorithm, [callback])

Possible Values

  0 (pbHMACSHA1), 
  1 (pbHMACSHA224), 
  2 (pbHMACSHA256), 
  3 (pbHMACSHA384), 
  4 (pbHMACSHA512), 
  5 (pbHMACMD5), 
  6 (pbHMACRIPEMD160), 
  7 (pbSHA1), 
  8 (pbMD5), 
  9 (pbMD2)

Default Value

0

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 getAlgorithm([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 setAlgorithm([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 algorithm used for the pseudo random function. Possible values are:

0 (pbHMACSHA1 - default) HMAC-SHA1, The default value and most commonly used.
1 (pbHMACSHA224) HMAC-SHA224
2 (pbHMACSHA256) HMAC-SHA256
3 (pbHMACSHA384) HMAC-SHA284
4 (pbHMACSHA512) HMAC-SHA512
5 (pbHMACMD5) HMAC-MD5
6 (pbHMACRIPEMD160) HMAC-RIPEMD160
7 (pbSHA1) SHA1, Only used with PBKDF1.
8 (pbMD5) MD5, Only used with PBKDF1.
9 (pbMD2) MD2, Only used with PBKDF1.

Note: When using PBDKF1 the maximum KeyLength value is 160 bits for SHA1, and 128 bits for MD2 and MD5.

Data Type

Integer

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