EncryptionPassword Property

The password to use when encrypting the object.

Syntax

 amazons3.getEncryptionPassword([callback])
 amazons3.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

EncryptionPassword is used to tell the class to encrypt or decrypt the data.

When CreateObject is called, if this property contains a non-empty string, the data that is sent to the server will be AES encrypted using 256 bit keys.

If GetObject is called, and this property contains a non-empty string, the returned data will be AES decrypted.

The class does not control determining which objects have and have not been encrypted.

The keys and initialization vector which are used are generated based on a PKCS5 Password specification. However, if another utility generates keys based on a different scheme, setting the EncryptionKey and EncryptionIV may be used instead.

This property is not available at design time.

Data Type

String