Visual FoxPro

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 Visual FoxPro Downloads

Download Chilkat for Visual FoxPro

Visual FoxPro

LOCAL lnSuccess
LOCAL loSftp
LOCAL lnPort
LOCAL lcPassword
LOCAL loPrivKey
LOCAL lcKeyText
LOCAL loSecureLogin
LOCAL loSecurePassword

lnSuccess = 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.

loSftp = CreateObject('Chilkat.SFtp')

*  Step 1: Connect the SSH transport.  Port 22 is the usual port.
lnPort = 22
lnSuccess = loSftp.Connect("sftp.example.com",lnPort)
IF (lnSuccess = 0) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    CANCEL
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.
lcPassword = "mySshPassword"

*  Load the SSH private key.  LoadText reads the file's text, which is then imported.
loPrivKey = CreateObject('Chilkat.SshKey')
lcKeyText = loPrivKey.LoadText("qa_data/id_rsa")
IF (loPrivKey.LastMethodSuccess = 0) THEN
    ? loPrivKey.LastErrorText
    RELEASE loSftp
    RELEASE loPrivKey
    CANCEL
ENDIF

lnSuccess = loPrivKey.FromOpenSshPrivateKey(lcKeyText)
IF (lnSuccess = 0) THEN
    ? loPrivKey.LastErrorText
    RELEASE loSftp
    RELEASE loPrivKey
    CANCEL
ENDIF

*  Place the login and password into SecureString objects.
loSecureLogin = CreateObject('Chilkat.SecureString')
loSecureLogin.Append("mySshLogin")
loSecurePassword = CreateObject('Chilkat.SecureString')
loSecurePassword.Append(lcPassword)

lnSuccess = loSftp.AuthenticateSecPwPk(loSecureLogin,loSecurePassword,loPrivKey)
IF (lnSuccess = 0) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    RELEASE loPrivKey
    RELEASE loSecureLogin
    RELEASE loSecurePassword
    CANCEL
ENDIF

*  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
*  file or directory operations.
lnSuccess = loSftp.InitializeSftp()
IF (lnSuccess = 0) THEN
    ? loSftp.LastErrorText
    RELEASE loSftp
    RELEASE loPrivKey
    RELEASE loSecureLogin
    RELEASE loSecurePassword
    CANCEL
ENDIF

? "Authenticated."

loSftp.Disconnect()

RELEASE loSftp
RELEASE loPrivKey
RELEASE loSecureLogin
RELEASE loSecurePassword