Sample code for 30+ languages & platforms
Tcl

SFTP Authenticate with a SecureString Password

See more SFTP Examples

Demonstrates the Chilkat SFtp.AuthenticateSecPw method, which authenticates using SecureString login and password objects. The first argument is the login and the second is the password.

Background: A SecureString keeps the credential encrypted in memory, reducing the chance of a plaintext password lingering in the process. The behavior otherwise matches AuthenticatePw; only the credential handling is more protective. Populate the SecureString from a value obtained at runtime, not a hard-coded literal.

Chilkat Tcl Downloads

Tcl

load ./chilkat.dll

set success 0

#  Demonstrates the SFtp.AuthenticateSecPw method, which authenticates using SecureString login
#  and password objects.  The 1st argument is the login and the 2nd is the password.

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"

#  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_AuthenticateSecPw $sftp $secureLogin $securePassword]
if {$success == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    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_CkSecureString $secureLogin
    delete_CkSecureString $securePassword
    exit
}

puts "Authenticated with secure strings."

CkSFtp_Disconnect $sftp

delete_CkSFtp $sftp
delete_CkSecureString $secureLogin
delete_CkSecureString $securePassword