Xojo Plugin

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 Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  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.

Dim sftp As New Chilkat.SFtp

//  Connect, authenticate, and initialize the SFTP subsystem.
Dim port As Int32
port = 22
success = sftp.Connect("sftp.example.com",port)
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

//  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.
Dim password As String
password = "mySshPassword"

success = sftp.AuthenticatePw("mySshLogin",password)
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

success = sftp.InitializeSftp()
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

//  The 1st argument is a path, so isHandle is 0.  Changing ownership typically requires
//  elevated privileges on the server.
Dim isHandle As Boolean
isHandle = False
success = sftp.SetOwnerAndGroup("subdir/report.pdf",isHandle,"www-data","www-data")
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

System.DebugLog("Owner and group set.")

sftp.Disconnect