Lua

SFTP Public-Key Authentication

See more SFTP Examples

Demonstrates how to authenticate with an SSH/SFTP server using publickey authentication. Lua

local chilkat = require("chilkat")

-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.

local sftp = chilkat.SFtp.new()

-- Set some timeouts, in milliseconds:
sftp.connect_timeout_ms = 5000
sftp.idle_timeout_ms = 15000

-- Connect to the SSH server.
-- The standard SSH port = 22
-- The hostname may be a hostname or IP address.
local hostname = "sftp.example.com"
local port = 22
local success = sftp:connect(hostname, port)
if not success then
    print(sftp.last_error_text)
    return
end

local key = chilkat.SshKey.new()

-- Load a PEM file into a string variable:
-- (This does not load the PEM file into the key.  The LoadText
-- method is a convenience method for loading the full contents of ANY text
-- file into a string variable.)
local privKey = key:load_text("myPrivateKey.pem")
if not key.last_method_success then
    print(key.last_error_text)
    return
end

-- Load a private key from a PEM string:
-- (Private keys may be loaded from OpenSSH and Putty formats.
-- Both encrypted and unencrypted private key file formats
-- are supported.  This example loads an unencrypted private
-- key in OpenSSH format.
success = key:from_open_ssh_private_key(privKey)
if not success then
    print(key.last_error_text)
    return
end

-- Authenticate with the SSH server.  Chilkat SFTP supports
-- both password-based authenication as well as public-key
-- authentication.
success = sftp:authenticate_pk("myLogin", key)
if not success then
    print(sftp.last_error_text)
    return
end

print(sftp.last_error_text)
print("Public-Key Authentication Successful!")