IPWorks S3 2020 Node.js Edition

Questions / Feedback?

EncryptionAlgorithm Property

The encryption algorithm.

Syntax

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

Possible Values

  0 (eaAES), 
  1 (eaBlowfish), 
  2 (eaCAST), 
  3 (eaDES), 
  4 (eaIDEA), 
  5 (eaRC2), 
  6 (eaRC4), 
  7 (eaTEA), 
  8 (eaTripleDES), 
  9 (eaTwofish), 
  10 (eaRijndael), 
  11 (eaChaCha), 
  12 (eaXSalsa20)

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 property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:

Algorithm Key Size
0 (eaAES - default) 256
1 (eaBlowfish) 448
2 (eaCAST) 128
3 (eaDES) 64
4 (eaIDEA) 128
5 (eaRC2) 128
6 (eaRC4) 2048
7 (eaTEA) 128
8 (eaTripleDES) 192
9 (eaTwofish) 256
10 (eaRijndael) 256
11 (eaChaCha) 256
12 (eaXSalsa20) 256

Data Type

Integer

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks S3 2020 Node.js Edition - Version 20.0 [Build 7722]