Lua

Get a Remote File's Owner

Demonstrates the Chilkat SFtp.GetFileOwner method, which returns a remote file's owner. The arguments are the remote path (or handle), whether symbolic links are followed, and whether the first argument is a handle.

Background: Ownership determines who may read, write, or change a file under Unix permission rules, so reading the owner is useful for auditing or for deciding whether an operation will be allowed. Note that a server may report the owner as a numeric UID rather than a name if it cannot resolve the account, and that ownership is a Unix concept — servers on other platforms may return an empty or synthetic value.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the SFtp.GetFileOwner method, which returns a remote file's owner.  The 1st
-- argument is the remote path (or handle), the 2nd selects whether symbolic links are followed,
-- and the 3rd indicates whether the 1st argument is a handle.

local sftp = chilkat.SFtp.new()

-- Connect, authenticate, and initialize the SFTP subsystem.
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

success = sftp:initialize_sftp()
if not success then
    print(sftp.last_error_text)
    return
end

-- The 2nd argument (bFollowLinks) selects whether a symbolic link is followed to its target.
-- The 3rd argument (bIsHandle) is false here because the 1st argument is a path, not an
-- open handle.
local bFollowLinks = true
local bIsHandle = false

local owner = sftp:get_file_owner("subdir/report.pdf", bFollowLinks, bIsHandle)
if not sftp.last_method_success then
    print(sftp.last_error_text)
    return
end

print("Owner: " .. owner)

sftp:disconnect()