IPWorks EDI 2020 Node.js Edition

Questions / Feedback?

OFTPConnectionEncryptionAlgorithm Property

The encryption algorithm used when sending files to the client.

Syntax

 oftpserver.getOFTPConnectionEncryptionAlgorithm(index, [callback])
 oftpserver.setOFTPConnectionEncryptionAlgorithm(index,  OFTPConnectionEncryptionAlgorithm, [callback])

Possible Values

  0 (conencra3DES), 
  1 (conencraAES)

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 getOFTPConnectionEncryptionAlgorithm([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 setOFTPConnectionEncryptionAlgorithm([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

The encryption algorithm used when sending files to the client.

In order to use encryption, you must set the OFTPConnectionVirtualFileSecurityLevel property. The supported algorithms for encryption are:

0 (encra3DES - default) DES (Triple Data Encryption Standard).
1 (encraAES) AES (Advanced Encryption Standard with key length of 128).

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by OFTPConnectionVersion.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Integer

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