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.

local chilkat = require("chilkat")

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

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"

-- Load the SSH private key.  LoadText reads the file's text, which is then imported.
local privKey = chilkat.SshKey.new()
local keyText = privKey:load_text("qa_data/id_rsa")
if not privKey.last_method_success then
    print(privKey.last_error_text)
    return
end

success = privKey:from_open_ssh_private_key(keyText)
if not success then
    print(privKey.last_error_text)
    return
end

-- 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_pk(secureLogin, securePassword, privKey)
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.")

sftp:disconnect()