DefaultAuthMethods Property

Specifies the supported authentication methods.

Syntax

 sftpserver.getDefaultAuthMethods([callback])
 sftpserver.setDefaultAuthMethods( defaultAuthMethods, [callback])

Default Value

"password,publickey"

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 getDefaultAuthMethods([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 setDefaultAuthMethods([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 supported authentication methods. The client will choose one of the supported mechanisms when authenticating to the class.

This must be a comma separated list of values. For more information on authenticating clients see the SSHUserAuthRequest event.

The following is a list of methods implemented by the class:


none	This authentication method is used by most SSH clients to obtain the list of authentication methods available for the user's account. In most cases you should not accept a request using this authentication method.
password	`AuthParam` will contain the user-supplied password. If the password is correct, set `Accept` to true.
publickey	`AuthParam` will contain an SSH2 public key blob. If the user's public key is acceptable, set `Accept` to true. The class will then handle verifying the digital signature and will respond to the client accordingly.
keyboard-interactive	SSHUserAuthRequest will fire multiple times for keyboard-interactive authentication: It will fire once for each response sent by the client in the SSH_MSG_USERAUTH_INFO_RESPONSE packet (one for each prompt specified by the daemon). The index of each response will be specified as a suffix in `AuthMethod`, with `AuthParam` containing the response to the corresponding prompt (e.g keyboard-interactive-1, keyboard-interactive-2 and so on). Finally, SSHUserAuthRequest will fire one last time with `AuthMethod` set to "keyboard-interactive" and `AuthParam` set to an empty string. The daemon must set `Accept` to true every time to allow the authentication process to succeed.

Data Type