VB.NET

SFTP Authenticate with a Password

Demonstrates the Chilkat SFtp.AuthenticatePw method, which authenticates the connected session with a login name and password. The first argument is the login and the second is the password. Call Connect first and InitializeSftp afterward.

Background: Password authentication is the simplest SFTP method, but the password is a secret and should never be a hard-coded literal — obtain it from an interactive prompt, an environment variable, or a secrets vault. Public-key authentication is generally preferred for automated jobs. Note the fixed ordering: authentication happens between Connect and InitializeSftp.

Chilkat VB.NET Downloads

Download Chilkat for VB.NET

VB.NET

Dim success As Boolean = False

'  Demonstrates the SFtp.AuthenticatePw method, which authenticates the connected session with a
'  login name and password.  The 1st argument is the login and the 2nd is the password.

Dim sftp As New Chilkat.SFtp

'  Step 1: Connect the SSH transport.  Port 22 is the usual port.
Dim port As Integer = 22
success = sftp.Connect("sftp.example.com",port)
If (success = False) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


'  Normally you would not hard-code the password in source.  You should instead obtain it
'  from an interactive prompt, environment variable, or a secrets vault.
Dim password As String = "mySshPassword"

success = sftp.AuthenticatePw("mySshLogin",password)
If (success = False) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


'  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
'  file or directory operations.
success = sftp.InitializeSftp()
If (success = False) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


Debug.WriteLine("Authenticated with a password.")

sftp.Disconnect()