Lianja

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 Lianja Downloads

Download Chilkat for Lianja

Lianja

llSuccess = .F.

//  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("CkSFtp")

//  Step 1: Connect the SSH transport.  Port 22 is the usual port.
lnPort = 22
llSuccess = loSftp.Connect("sftp.example.com",lnPort)
if (llSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    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.
lcPassword = "mySshPassword"

//  Load the SSH private key.  LoadText reads the file's text, which is then imported.
loPrivKey = createobject("CkSshKey")
lcKeyText = loPrivKey.LoadText("qa_data/id_rsa")
if (loPrivKey.LastMethodSuccess = .F.) then
    ? loPrivKey.LastErrorText
    release loSftp
    release loPrivKey
    return
endif

llSuccess = loPrivKey.FromOpenSshPrivateKey(lcKeyText)
if (llSuccess = .F.) then
    ? loPrivKey.LastErrorText
    release loSftp
    release loPrivKey
    return
endif

//  Place the login and password into SecureString objects.
loSecureLogin = createobject("CkSecureString")
loSecureLogin.Append("mySshLogin")
loSecurePassword = createobject("CkSecureString")
loSecurePassword.Append(lcPassword)

llSuccess = loSftp.AuthenticateSecPwPk(loSecureLogin,loSecurePassword,loPrivKey)
if (llSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    release loPrivKey
    release loSecureLogin
    release loSecurePassword
    return
endif

//  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
//  file or directory operations.
llSuccess = loSftp.InitializeSftp()
if (llSuccess = .F.) then
    ? loSftp.LastErrorText
    release loSftp
    release loPrivKey
    release loSecureLogin
    release loSecurePassword
    return
endif

? "Authenticated."

loSftp.Disconnect()


release loSftp
release loPrivKey
release loSecureLogin
release loSecurePassword