Lua

SFTP Authenticate with a Password

Demonstrates the Chilkat SFtp.AuthenticatePw method, which authenticates the connected session with a login name and password. The first argument is the login and the second is the password. Call Connect first and InitializeSftp afterward.

Background: Password authentication is the simplest SFTP method, but the password is a secret and should never be a hard-coded literal — obtain it from an interactive prompt, an environment variable, or a secrets vault. Public-key authentication is generally preferred for automated jobs. Note the fixed ordering: authentication happens between Connect and InitializeSftp.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the SFtp.AuthenticatePw method, which authenticates the connected session with a
-- login name and password.  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"

success = sftp:authenticate_pw("mySshLogin", password)
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 a password.")

sftp:disconnect()