SSHMacAlgorithms Property

A comma-separated list containing all allowable message authentication algorithms.

Syntax

 sshclient.getSSHMacAlgorithms([callback])
 sshclient.setSSHMacAlgorithms( SSHMacAlgorithms, [callback])

Default Value

"hmac-sha1,hmac-md5,hmac-sha2-256,hmac-sha2-512,hmac-ripemd160,hmac-sha1-96,hmac-md5-96,hmac-sha2-256-96,hmac-sha2-512-96,hmac-ripemd160-96"

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 getSSHMacAlgorithms([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 setSSHMacAlgorithms([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. SSHMacAlgorithms controls the message authentication code (MAC) algorithm list supplied by the class to the SSHHost. It is a comma-separated list containing the names of MAC algorithms as defined by section 6.4 of the SSH Transport Layer specification (RFC 4253).

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

• hmac-sha1
• hmac-md5
• hmac-sha1-96
• hmac-md5-96
• hmac-sha2-256
• hmac-sha2-256-96
• hmac-sha2-512
• hmac-sha2-512-96
• hmac-ripemd160
• hmac-ripemd160-96

Data Type

String