Xbase++

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 Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oSftp
LOCAL nPort
LOCAL cPassword
LOCAL oSecureLogin
LOCAL oSecurePassword

nSuccess := 0

//  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.

oSftp := CreateObject("Chilkat.SFtp")

//  Step 1: Connect the SSH transport.  Port 22 is the usual port.
nPort := 22
nSuccess := oSftp:Connect("sftp.example.com", nPort)
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  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.
cPassword := "mySshPassword"

//  Place the login and password into SecureString objects.
oSecureLogin := CreateObject("Chilkat.SecureString")
oSecureLogin:Append("mySshLogin")
oSecurePassword := CreateObject("Chilkat.SecureString")
oSecurePassword:Append(cPassword)

nSuccess := oSftp:AuthenticateSecPw(oSecureLogin, oSecurePassword)
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    oSecureLogin:destroy()
    oSecurePassword:destroy()
    RETURN
ENDIF

//  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
//  file or directory operations.
nSuccess := oSftp:InitializeSftp()
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    oSecureLogin:destroy()
    oSecurePassword:destroy()
    RETURN
ENDIF

? "Authenticated with secure strings."

oSftp:Disconnect()

oSftp:destroy()
oSecureLogin:destroy()
oSecurePassword:destroy()