(Node.js) SFTP Get/Set File Permission

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

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

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

    var sftp = new chilkat.SFtp();

    // Connect to the SSH/SFTP server.  
    var hostname = "sftp.example.com";
    var port = 22;
    var success = sftp.Connect(hostname,port);
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // 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) {
        console.log(sftp.LastErrorText);
        return;
    }

    // After authenticating, the SFTP subsystem must be initialized:
    success = sftp.InitializeSftp();
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // 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).
    var isHandle = false;
    var followLinks = true;
    var permVal = sftp.GetFilePermissions("qa_data/hamlet.xml",followLinks,isHandle);
    if (permVal < 0) {
        console.log(sftp.LastErrorText);
        return;
    }

    // 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
    console.log("decimal permissions value: " + permVal);

    // 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) {
        console.log(sftp.LastErrorText);
        return;
    }

    console.log("Success.");

}

chilkatExample();