EncryptionPassword Property

The password to use when encrypting/decrypting a blob.

Syntax

 azureblob.getEncryptionPassword([callback])
 azureblob.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 CreateBlob is called, if this property contains a non-empty string, the BlobData sent to the server will be AES encrypted using 256-bit keys. If GetBlob is called and this property contains a non-empty string, the returned data will be AES decrypted.

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

Note, the default keys and initialization vector used are generated based on the PKCS5 Password specification. However if a different scheme is needed, EncryptionKey and EncryptionIV can be set to the desired values.

This property is not available at design time.

Data Type

String