IPWorks Encrypt 2020 Node.js Edition

Questions / Feedback?

Algorithm Property

The Salsa20 algorithm.

Syntax

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

Possible Values

  0 (saSALSA20), 
  1 (saXSALSA20)

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 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 Salsa implementation to use. Possible values are:

  • 0 (Salsa20)
  • 1 (XSalsa20 - default)

The XSalsa20 algorithm is recommended and generally to be considered more secure. The Salsa20 algorithm is fully supported for implementations that require this. In addition the reduced 12 and 8 round variants of Salsa20 are also supported, please see SalsaRounds for details.

Data Type

Integer

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