Lua

SFTP Authenticate with a SecureString Password

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

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

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

local sftp = chilkat.SFtp.new()

-- Step 1: Connect the SSH transport.  Port 22 is the usual port.
local port = 22
local success = sftp:connect("sftp.example.com", port)
if not success then
    print(sftp.last_error_text)
    return
end

-- 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.
local password = "mySshPassword"

-- Place the login and password into SecureString objects.
local secureLogin = chilkat.SecureString.new()
secureLogin:append("mySshLogin")
local securePassword = chilkat.SecureString.new()
securePassword:append(password)

success = sftp:authenticate_sec_pw(secureLogin, securePassword)
if not success then
    print(sftp.last_error_text)
    return
end

-- Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
-- file or directory operations.
success = sftp:initialize_sftp()
if not success then
    print(sftp.last_error_text)
    return
end

print("Authenticated with secure strings.")

sftp:disconnect()