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.

load ./chilkat.dll

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

set sftp [new_CkSFtp]

#  Step 1: Connect the SSH transport.  Port 22 is the usual port.
set port 22
set success [CkSFtp_Connect $sftp "sftp.example.com" $port]
if {$success == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

#  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.
set password "mySshPassword"

#  Load the SSH private key.  LoadText reads the file's text, which is then imported.
set privKey [new_CkSshKey]

set keyText [CkSshKey_loadText $privKey "qa_data/id_rsa"]
if {[CkSshKey_get_LastMethodSuccess $privKey] == 0} then {
    puts [CkSshKey_lastErrorText $privKey]
    delete_CkSFtp $sftp
    delete_CkSshKey $privKey
    exit
}

set success [CkSshKey_FromOpenSshPrivateKey $privKey $keyText]
if {$success == 0} then {
    puts [CkSshKey_lastErrorText $privKey]
    delete_CkSFtp $sftp
    delete_CkSshKey $privKey
    exit
}

#  Place the login and password into SecureString objects.
set secureLogin [new_CkSecureString]

CkSecureString_Append $secureLogin "mySshLogin"
set securePassword [new_CkSecureString]

CkSecureString_Append $securePassword $password

set success [CkSFtp_AuthenticateSecPwPk $sftp $secureLogin $securePassword $privKey]
if {$success == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    delete_CkSshKey $privKey
    delete_CkSecureString $secureLogin
    delete_CkSecureString $securePassword
    exit
}

#  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
#  file or directory operations.
set success [CkSFtp_InitializeSftp $sftp]
if {$success == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    delete_CkSshKey $privKey
    delete_CkSecureString $secureLogin
    delete_CkSecureString $securePassword
    exit
}

puts "Authenticated."

CkSFtp_Disconnect $sftp

delete_CkSFtp $sftp
delete_CkSshKey $privKey
delete_CkSecureString $secureLogin
delete_CkSecureString $securePassword