JavaScript

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.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

JavaScript

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

var sftp = new CkSFtp();

//  Connect, authenticate, and initialize the SFTP subsystem.
var port = 22;
success = sftp.Connect("sftp.example.com",port);
if (success == false) {
    console.log(sftp.LastErrorText);
    return;
}

//  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.
var password = "mySshPassword";

success = sftp.AuthenticatePw("mySshLogin",password);
if (success == false) {
    console.log(sftp.LastErrorText);
    return;
}

success = sftp.InitializeSftp();
if (success == false) {
    console.log(sftp.LastErrorText);
    return;
}

//  The 1st argument is a path, so isHandle is false.  Changing ownership typically requires
//  elevated privileges on the server.
var isHandle = false;
success = sftp.SetOwnerAndGroup("subdir/report.pdf",isHandle,"www-data","www-data");
if (success == false) {
    console.log(sftp.LastErrorText);
    return;
}

console.log("Owner and group set.");

sftp.Disconnect();