Xbase++

Set a Remote File's Owner and Group

Demonstrates the Chilkat SFtp.SetOwnerAndGroup method, which sets the owner and group of a remote item. The arguments are the remote path (or handle), whether the first argument is a handle, and the new owner and group values.

Background: This is the SFTP equivalent of chown. Changing ownership is a privileged operation on Unix systems — ordinary users generally cannot give their files away — so expect it to fail unless the authenticated account has the necessary rights. It is most often used by administrative jobs that upload files which must then belong to a service account, such as a web server user.

Chilkat Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oSftp
LOCAL nPort
LOCAL cPassword
LOCAL nIsHandle

nSuccess := 0

//  Demonstrates the SFtp.SetOwnerAndGroup method, which sets the owner and group of a remote item.
//  The 1st argument is the remote path (or handle), the 2nd (isHandle) indicates which, and the
//  3rd and 4th are the new owner and group.

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.  Changing ownership typically requires
//  elevated privileges on the server.
nIsHandle := 0
nSuccess := oSftp:SetOwnerAndGroup("subdir/report.pdf", nIsHandle, "www-data", "www-data")
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

? "Owner and group set."

oSftp:Disconnect()

oSftp:destroy()