Ruby

SFTP Get/Set File Permission

See more SFTP Examples

Demonstrates how to set the permissions of a file on the SFTP server. Ruby

require 'chilkat'

success = false

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

sftp = Chilkat::CkSFtp.new()

# Connect to the SSH/SFTP server.  
hostname = "sftp.example.com"
port = 22
success = sftp.Connect(hostname,port)
if (success != true)
    print sftp.lastErrorText() + "\n";
    exit
end

# Authenticate with the SSH server.  Chilkat SFTP supports
# both password-based authenication as well as public-key
# authentication.  This example uses password authenication.
success = sftp.AuthenticatePw("myLogin","myPassword")
if (success != true)
    print sftp.lastErrorText() + "\n";
    exit
end

# After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp()
if (success != true)
    print sftp.lastErrorText() + "\n";
    exit
end

# Get the file permissions for the "hamlet.xml" file on the server.
# The hamlet.xml file is located in the qa_data directory found under the HOME directory of the SSH user account.
# We are passing the remote file path (we are not passing a file handle returned by a previous call to OpenFile).
isHandle = false
followLinks = true
permVal = sftp.GetFilePermissions("qa_data/hamlet.xml",followLinks,isHandle)
if (permVal < 0)
    print sftp.lastErrorText() + "\n";
    exit
end

# Note: Filesystem permissions on Linux/Unix/MacOSX are typically written in octal (POSIX file permissions).  For example 0644 is octal.
# To convert to decimal: octal 644 = 6*8^2 + 4*8 + 4 = 420 (decimal)
# 
# The server may return a permissions value (in octal) such as 100644.
# The "100" indicates the file type, such as regular file or directory. 

# Show the decimal value of the permissions
print "decimal permissions value: " + permVal.to_s() + "\n";

# To set the file permissions, pass the integer value.
# Let's change the permissions to 0664, which is 6*8^2 + 6*8 + 4 = 436 (decimal)
success = sftp.SetPermissions("qa_data/hamlet.xml",isHandle,436)
if (success != true)
    print sftp.lastErrorText() + "\n";
    exit
end

print "Success." + "\n";