Xbase++

Set a Remote File's POSIX Permissions

Demonstrates the Chilkat SFtp.SetPermissions method, which sets the POSIX permission bits of a remote item. The arguments are the remote path (or handle), whether the first argument is a handle, and the permission bits. Pass the permission bits only, not the file-type bits.

Background: This is the SFTP equivalent of chmod. Common values, written as octal, are 0644 for a normal file, 0600 for a private file, and 0755 for an executable or a directory. In languages without octal literals the same values must be given in decimal or hexadecimal (for example 0755 is decimal 493). Setting an executable bit after uploading a script is the classic use.

Chilkat Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oSftp
LOCAL nPort
LOCAL cPassword
LOCAL nIsHandle
LOCAL nPermissions

nSuccess := 0

//  Demonstrates the SFtp.SetPermissions method, which sets the POSIX permission bits of a remote
//  item.  The 1st argument is the remote path (or handle), the 2nd (isHandle) indicates which,
//  and the 3rd is the permission bits.

oSftp := CreateObject("Chilkat.SFtp")

//  Connect, authenticate, and initialize the SFTP subsystem.
nPort := 22
nSuccess := oSftp:Connect("sftp.example.com", nPort)
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  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.
cPassword := "mySshPassword"

nSuccess := oSftp:AuthenticatePw("mySshLogin", cPassword)
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

nSuccess := oSftp:InitializeSftp()
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  The 1st argument is a path, so isHandle is 0.
nIsHandle := 0

//  Pass the permission bits, not the file-type bits.  0755 gives the owner read/write/execute and
//  read/execute to group and others -- a common mode for an executable script.
nPermissions := 493
nSuccess := oSftp:SetPermissions("subdir/script.sh", nIsHandle, nPermissions)
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

? "Permissions set."

oSftp:Disconnect()

oSftp:destroy()