IP*Works! SSH V9 - Online Help
IP*Works! SSH V9
Questions / Feedback?

SSHKeyExchangeAlgorithms Property

A comma-separated list containing all allowable key exchange algorithms.

Syntax

 psclient.getSSHKeyExchangeAlgorithms([callback])
 psclient.setSSHKeyExchangeAlgorithms( SSHKeyExchangeAlgorithms, [callback])

Default Value

"diffie-hellman-group14-sha1,diffie-hellman-group1-sha1,diffie-hellman-group-exchange-sha256,diffie-hellman-group-exchange-sha1"


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 getSSHKeyExchangeAlgorithms([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 setSSHKeyExchangeAlgorithms([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

SSH allows different algorithms to be negotiated for use when establishing the security layer of the connection. SSHKeyExchangeAlgorithms controls the key-exchange algorithm list supplied by the class to the SSHHost. It is a comma-separated list containing the names of key-exchange algorithms as defined by section 6.5 of the SSH Transport Layer specification (RFC 4253). The Key-exchange algorithms specified in RFC 4419 are also supported.

The value of this property must be a comma-separated list containing one or more of the following values:

  • diffie-hellman-group1-sha1
  • diffie-hellman-group14-sha1
  • diffie-hellman-group-exchange-sha256
  • diffie-hellman-group-exchange-sha1

Data Type

String

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 9.0.6240.0