View on GitHub

Ssh2-utils

nodejs ssh2 utils module to ease ssh and sftp usage with nodejs

Download this project as a .zip file Download this project as a tar.gz file

SSH2Utils Build Status

A library to ease use of excellent modules ssh2.

Provide a set of methods to exec/run/getFile/putFile/getDir/putDir.

Install

npm i ssh2-utils --save

Changes

Documentation

Automatic source code documentation generation

is supported by jsdoc at https://maboiteaspam.github.io/ssh2-utils/docs/

Automatic tests documentation generation

is support by mocha https://github.com/maboiteaspam/ssh2-utils/tree/gh-pages/mocha-tests.md

API

Examples

SSH2Utils.exec(server, cmd, callback)

Execute a command on remote server and return its output.

Arguments

Examples

    var SSH2Utils = require('ssh2-utils');
    var ssh = new SSH2Utils();

    var server = {host: "localhost", username:"user", password:"pwd" };

    ssh.exec(server, 'ls', function(err,stdout,stderr){
        if(err) console.log(err);
        console.log(stdout);
        console.log(stderr);
    });

SSH2Utils.run(server, cmd, callback)

Execute a command on remote server and return its streams.

Arguments

Examples

    var SSH2Utils = require('ssh2-utils');
    var ssh = new SSH2Utils();

    var server = {host: "localhost", username:"user", password:"pwd" };

    ssh.run(server, ['ls','time'], function(err,stdout,stderr,server,conn){
        if(err) console.log(err);
        stdout.on('data', function(){
            console.log(''+data);
        });
        stderr.on('data', function(){
            console.log(''+data);
        });
        stdout.on('close',function(){
            conn.end();
        });
    });

SSH2Utils.runMultiple(server, cmds, onCmdCplt, onDone)

SSH2Utils.runMultiple(server, cmds, onDone)

Execute a series of command on remote server and returns their output.

Arguments

Examples

    var SSH2Utils = require('ssh2-utils');
    var ssh = new SSH2Utils();

    var server = {host: "localhost", username:"user", password:"pwd" };

    ssh.runMultiple(server, ['ls','time'], function(sessionText, sshObj){
        console.log(sessionText);
    });

SSH2Utils.getFile(server, remoteFile, localPath, callback)

Download a file from remote to local.

Arguments

Examples

    var SSH2Utils = require('ssh2-utils');
    var ssh = new SSH2Utils();

    var server = {host: "localhost", username:"user", password:"pwd" };

    ssh.getFile(server,'/tmp/from_some_remote','/tmp/to_some_local', function(err){
        if(err) console.log(err);
    });

SSH2Utils.putFile(server, localFile, remoteFile, callback)

Put a file from local to remote

Arguments

Examples

    var SSH2Utils = require('ssh2-utils');
    var ssh = new SSH2Utils();

    var server = {host: "localhost", username:"user", password:"pwd" };

    ssh.putFile(server,'/tmp/to_some_local','/tmp/from_some_remote', function(err){
        if(err) console.log(err);
    });

SSH2Utils.putDir(server, localPath, remoteFile, callback)

Put a local directory contents to a remote path.

Arguments

Examples

    var SSH2Utils = require('ssh2-utils');
    var ssh = new SSH2Utils();

    var server = {host: "localhost", username:"user", password:"pwd" };

    ssh.putDir(server,'/tmp/from_some_local','/tmp/to_some_remote', function(err){
        if(err) console.log(err);
    });

SSH2Utils.mkdir(server, remotePath, callback)

Create a directory at remote path.

Arguments

Examples

    var SSH2Utils = require('ssh2-utils');
    var ssh = new SSH2Utils();

    var server = {host: "localhost", username:"user", password:"pwd" };

    ssh.mkdir(server,'/tmp/to_some_remote', function(err){
        if(err) console.log(err);
    });

SSH2Utils.rmdir(server, remotePath, callback)

Deletes a directory at remote path.

Effectively performs rm -fr remotePath.

Arguments

Examples

    var SSH2Utils = require('ssh2-utils');
    var ssh = new SSH2Utils();

    var server = {host: "localhost", username:"user", password:"pwd" };

    ssh.rmdir(server,'/tmp/to_some_remote', function(err){
        if(err) console.log(err);
    });

SSH2Utils.fileExists(server, remotePath, callback)

Tests a path on remote.

Arguments

Examples

    var SSH2Utils = require('ssh2-utils');
    var ssh = new SSH2Utils();

    var server = {host: "localhost", username:"user", password:"pwd" };

    ssh.fileExists(server,'/tmp/to_some_remote', function(err){
        if(err) console.log(err);
    });

Suggestions

On linux you may want to edit /etc/ssh/ssh_config and append 

Host 127.0.0.1
   CheckHostIP no
   StrictHostKeyChecking no
   UserKnownHostsFile=/dev/null

This will help to have multiple vagrant box installed on the same machine.

On fedora you may want to create /etc/polkit-1/rules.d/10.virt.rules and add

polkit.addRule(function(action, subject) {
  polkit.log("action=" + action);
  polkit.log("subject=" + subject);
  var now = new Date();
  polkit.log("now=" + now)
  if ((action.id == "org.libvirt.unix.manage"
        || action.id == "org.libvirt.unix.monitor")

        && subject.isInGroup("~~your username group~~") // <--- change HERE

      ) {
    return polkit.Result.YES;
  }
  return null;
});

This will help to prevent the system from asking the password.

Status

In development. It needs some tests. some more methods implementation.

Test

For fedora users, use virtualbox,

sudo dnf install vagrant
# see http://www.if-not-true-then-false.com/2010/install-virtualbox-with-yum-on-fedora-centos-red-hat-rhel/
export VAGRANT_DEFAULT_PROVIDER=virtualbox
mocha

or help me get started on libvirt to port forward on vagrant@localhost -p 2222