EncryptionPassword Property

The encryption password.

Syntax

 box.getEncryptionPassword([callback])
 box.setEncryptionPassword( encryptionPassword, [callback])

Default Value

""

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 getEncryptionPassword([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 setEncryptionPassword([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

When this property is specified the class will attempt to encrypt or decrypt the file when calling UploadFile or DownloadFile. The class uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managed Key and IV values directly.

This property is not available at design time.

Data Type

String