wiardvanrij/sshwrapper

SSH wrapper for PHP

SSH wrapper for PHP

Information

!!! This is in very beta. I would not recommend using this on production or whatsoever. !!!, _(*1)

This library allows you to connect via SSH to your linux server with the PHP core class 'ssh2'. It also allows to use a "jump server" for instance:, _(*2)

command --ssh to-> jump server --ssh to-> actual server

Requirements

You will need to install the PHP ssh2 extension and enable this. I assume you have knowledge on how to install php extensions, _(*3)

Installation

Via composer, _(*4)

{
    "require": {
        "wiardvanrij/sshwrapper": "*"
    }
}

Because this library is in beta, please use the latest version. There is no stable, _(*5)

Usage

Require the autoloader and include the namespace, _(*6)

<?php

require('vendor/autoload.php');

use SshWrapper\SshCore;

Initiate the class with the host, _(*7)

$ssh = new SshCore('123.123.123.123');

Optional: Define the rsa public and private key locations if they differ from default. Defaults:, _(*8)

$ssh->authPriv = '~/.ssh/id_rsa';
$ssh->authPub = '~/.ssh/id_rsa.pub';

Optional: Define user and port if they differ from the default. Defaults:, _(*9)

$ssh->authUser = 'root';
$ssh->port = 22;

Prefered: If you use the ssh server as "jump server" you can define the actual server here including the user., _(*10)

$ssh->jumphost = 'root@321.321.321.321';

Connect, _(*11)

$ssh->connect();

And execute a command, _(*12)

$result = $ssh->exec('ls -lah');

var_dump($result);

Result is a string of the output, _(*13)

Disconnect to close the ssh connection, _(*14)

$ssh->disconnect();