SFTP Authenticate with a SecureString Password and Private Key

See more SFTP Examples

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.

integer li_rc
integer li_Success
oleobject loo_Sftp
integer li_Port
string ls_Password
oleobject loo_PrivKey
string ls_KeyText
oleobject loo_SecureLogin
oleobject loo_SecurePassword

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

loo_Sftp = create oleobject
li_rc = loo_Sftp.ConnectToNewObject("Chilkat.SFtp")
if li_rc < 0 then
    destroy loo_Sftp
    MessageBox("Error","Connecting to COM object failed")
    return
end if

//  Step 1: Connect the SSH transport.  Port 22 is the usual port.
li_Port = 22
li_Success = loo_Sftp.Connect("sftp.example.com",li_Port)
if li_Success = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    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.
ls_Password = "mySshPassword"

//  Load the SSH private key.  LoadText reads the file's text, which is then imported.
loo_PrivKey = create oleobject
li_rc = loo_PrivKey.ConnectToNewObject("Chilkat.SshKey")

ls_KeyText = loo_PrivKey.LoadText("qa_data/id_rsa")
if loo_PrivKey.LastMethodSuccess = 0 then
    Write-Debug loo_PrivKey.LastErrorText
    destroy loo_Sftp
    destroy loo_PrivKey
    return
end if

li_Success = loo_PrivKey.FromOpenSshPrivateKey(ls_KeyText)
if li_Success = 0 then
    Write-Debug loo_PrivKey.LastErrorText
    destroy loo_Sftp
    destroy loo_PrivKey
    return
end if

//  Place the login and password into SecureString objects.
loo_SecureLogin = create oleobject
li_rc = loo_SecureLogin.ConnectToNewObject("Chilkat.SecureString")

loo_SecureLogin.Append("mySshLogin")
loo_SecurePassword = create oleobject
li_rc = loo_SecurePassword.ConnectToNewObject("Chilkat.SecureString")

loo_SecurePassword.Append(ls_Password)

li_Success = loo_Sftp.AuthenticateSecPwPk(loo_SecureLogin,loo_SecurePassword,loo_PrivKey)
if li_Success = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    destroy loo_PrivKey
    destroy loo_SecureLogin
    destroy loo_SecurePassword
    return
end if

//  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
//  file or directory operations.
li_Success = loo_Sftp.InitializeSftp()
if li_Success = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    destroy loo_PrivKey
    destroy loo_SecureLogin
    destroy loo_SecurePassword
    return
end if

Write-Debug "Authenticated."

loo_Sftp.Disconnect()


destroy loo_Sftp
destroy loo_PrivKey
destroy loo_SecureLogin
destroy loo_SecurePassword