Back to product page

Authentication property


Determines which authentication type is used.

Type

An AuthenticationsEnum enumeration. Represents all possible types of authentication.

Syntax

  • Basic
object.Authentication [= value]
The Authentication(object,value) syntax has these parts:
objectAn expression evaluating to an object of type wodSFTP.
valueAn AuthenticationsEnum enumeration, as described in settings.

Remarks

The settings for value are:

Constant Value Description
authBoth 0 Use both authentications
authPassword 1 Use password authentication
authPubkey 2 Use public key authentication
authSecurID 3 Use SecurID token authentication
authKeyboardInteractive 4 Use KeyboardInteractive authentication
authGSSAPI 5 Use Kerberos GSS authentication


The Authentication property allows you to select the type of authentication that you want to use with the server. Most commonly you will choose authPassword authentication, which requires the Login and Password properties to be set before the Connect method is called. Once wodSFTP connects to the server it will authenticate you with username and password ONLY.

If you prefer to authenticate yourself using your PrivateKey (in which case the server MUST have your public key), you should set this property to authPubkey and you should set the Login and PrivateKey properties accordingly.

If you want to allow any of these authentication types to take place, set this property to authBoth. In this case wodSFTP will try to use both methods. Different server implementations may require that either one or both of the authentication methods are successful in order to login to the server. Please note that in this case you must set all three properties: Login, Password and PrivateKey.

To set PrivateKey, use the Keys object (included in the setup package) which will allow you to generate (and store) the required keys.

You can also use authSecurID authentication. In this case, set your Login and, instead of your password, provide the OTP (one time password) as provided by your token. wodSFTP will send authentication information to the server using these properties. Obviously, in this case you cannot use Password at the same time.

wodSFTP also supports Keyboard-Interactive authentication. wodSFTP will also attempt to authenticate with this as the fallback method if Password authentication fails.

authGSSAPI implements Kerberos protocol (http://web.mit.edu/Kerberos). When this authentication is used, there is no need to provide Login and Password at all - they are requested from the Kerberos authority (assuming you have valid credentials) and authentication is made without providing any login details in the code. wodSFTP supports both SSPI (Microsoft implementation) and KfW (MIT open source) implementations - whichever is available on the local system.

Platforms

Windows