IPWorks Encrypt 2020 Node.js Edition

Questions / Feedback?

UseAEAD Property

Whether to use AEAD (Authenticated Encryption with Additional Data).

Syntax

 chacha.getUseAEAD([callback])
 chacha.setUseAEAD( useAEAD, [callback])

Default Value

FALSE

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 getUseAEAD([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 setUseAEAD([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

If this property is set to True the class uses the algorithm AEAD_CHACHA20_POLY1305 as defined in RFC 7539 to construct a message using AEAD. See Encrypt and Decrypt for details.

Data Type

Boolean

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