Xbase++

SFTP Authenticate with a SecureString Password and Private Key

Demonstrates the Chilkat SFtp.AuthenticateSecPwPk method, which authenticates using SecureString login and password objects together with a private key. The third argument is the SshKey private key.

Note: The private-key path is relative to the application's current working directory. Supply the path to your own key file.

Background: This is the SecureString form of two-factor SFTP authentication: the password is held encrypted in memory and combined with a private key for servers that require both. It is the most protective option when a deployment mandates two-factor SSH and you also want to minimize plaintext credential exposure in the process.

Chilkat Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oSftp
LOCAL nPort
LOCAL cPassword
LOCAL oPrivKey
LOCAL cKeyText
LOCAL oSecureLogin
LOCAL oSecurePassword

nSuccess := 0

//  Demonstrates the SFtp.AuthenticateSecPwPk method, which authenticates using SecureString login
//  and password objects together with a private key.  The 1st argument is the username, the 2nd
//  is the password, and the 3rd is an SshKey private key.

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"

//  Load the SSH private key.  LoadText reads the file's text, which is then imported.
oPrivKey := CreateObject("Chilkat.SshKey")
cKeyText := oPrivKey:LoadText("qa_data/id_rsa")
IF (oPrivKey:LastMethodSuccess == 0)
    ? oPrivKey:LastErrorText
    oSftp:destroy()
    oPrivKey:destroy()
    RETURN
ENDIF

nSuccess := oPrivKey:FromOpenSshPrivateKey(cKeyText)
IF (nSuccess == 0)
    ? oPrivKey:LastErrorText
    oSftp:destroy()
    oPrivKey:destroy()
    RETURN
ENDIF

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

nSuccess := oSftp:AuthenticateSecPwPk(oSecureLogin, oSecurePassword, oPrivKey)
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    oPrivKey: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()
    oPrivKey:destroy()
    oSecureLogin:destroy()
    oSecurePassword:destroy()
    RETURN
ENDIF

? "Authenticated."

oSftp:Disconnect()

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