Xojo Plugin

SFTP Authenticate with a SecureString Password

Demonstrates the Chilkat SFtp.AuthenticateSecPw method, which authenticates using SecureString login and password objects. The first argument is the login and the second is the password.

Background: A SecureString keeps the credential encrypted in memory, reducing the chance of a plaintext password lingering in the process. The behavior otherwise matches AuthenticatePw; only the credential handling is more protective. Populate the SecureString from a value obtained at runtime, not a hard-coded literal.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the SFtp.AuthenticateSecPw method, which authenticates using SecureString login
//  and password objects.  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 Int32
port = 22
success = sftp.Connect("sftp.example.com",port)
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
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
password = "mySshPassword"

//  Place the login and password into SecureString objects.
Dim secureLogin As New Chilkat.SecureString
success = secureLogin.Append("mySshLogin")
Dim securePassword As New Chilkat.SecureString
success = securePassword.Append(password)

success = sftp.AuthenticateSecPw(secureLogin,securePassword)
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
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
    System.DebugLog(sftp.LastErrorText)
    Return
End If

System.DebugLog("Authenticated with secure strings.")

sftp.Disconnect