IPWorks Encrypt 2020 Node.js Edition

Questions / Feedback?

EncryptionAlgorithm Property

The encryption algorithm to use.

Syntax

 ecc.getEncryptionAlgorithm([callback])
 ecc.setEncryptionAlgorithm( encryptionAlgorithm, [callback])

Possible Values

  0 (iesAES), 
  1 (iesTripleDES), 
  2 (iesXOR)

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 getEncryptionAlgorithm([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 setEncryptionAlgorithm([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 setting specifies the encryption algorithm to use when Encrypt is called. This must also be set before calling Decrypt to match the algorithm used during the initial encryption.

Possible values are:

  • 0 (iesAES - default)
  • 1 (iesTripleDES)
  • 2 (iesXOR)

AES Notes

When EncryptionAlgorithm is set to iesAES AES CBC with a default key size of 256 bits is used. To specify a different key size set EncryptionKeySize.

Data Type

Integer

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