sshbunny

sshbunny

Biblioteca PHP que fornece um wrapper orientado a objetos para conectar-se ao SSH e executar comandos shell com a extensão php ssh2.

Requisitos

---

• PHP versão 5.3+
• Extensão SSH2.
• compositor.

Instalar com compositor

---

A melhor maneira de adicionar a biblioteca ao seu projeto é usando o compositor.

composer require faraweilyas/ sshbunny

ou

Clonar este repositório

git clone https://github.com/faraweilyas/sshbunny.git

Configuração

---

O construtor sshbunny leva quatro parâmetros e todos eles têm valores padrão $method='local' , $authType=NULL , $host=NULL , $port=22 , $username=NULL

• $method pode ser definido como local ou remote , local executará comandos em seu próprio shell sem conexão com a Internet enquanto remote executa comandos no servidor remoto ao qual você se conecta com base em sua configuração.
• $authType pode ser definido como KEY , PASSWORD ou KEY_PASSWORD , KEY e KEY_PASSWORD usam ssh2_auth_pubkey_file a diferença é quando você define $authType='KEY_PASSWORD' ssh2_auth_pubkey_file pega o último parâmetro de senha que agora será obrigatório e PASSWORD usa ssh2_auth_password.
• $port deve ser definido como a porta do seu servidor se você estiver se conectando a um servidor remoto.
• $username deve ser definido como o nome de usuário do seu servidor.

se você estiver configurando o método de conexão para $method='remote' e $authType = KEY || KEY_PASSWORD isso significa que você precisará definir seu arquivo de chave pública e privada, o que pode ser feito com os setters sshbunny has $ sshbunny ->setKeys('public_key.pub', 'private_key') antes da inicialização.

Uso básico

---

Isso só será executado localmente, pois o método de conexão está definido como local

sshbunny ; require_once 'vendor/autoload.php'; // ->getData() will return output of command executed while ->getData(TRUE) will dispay the output $ sshbunny = (new sshbunny ('local')) ->initialize() ->exec("echo 'Hello World'") ->getData(TRUE);">

 <?php

use sshbunny  sshbunny ;

require_once ' vendor/autoload.php ' ;

// ->getData() will return output of command executed while ->getData(TRUE) will dispay the output
$ sshbunny = ( new sshbunny ( ' local ' ))
    -> initialize ()
    -> exec ( " echo 'Hello World' " )
    -> getData ( TRUE );

Isso irá se conectar a um servidor remoto, pois o método de conexão está definido como remote e o tipo de autenticação está definido como KEY

sshbunny ; require_once 'vendor/autoload.php'; defined('TEST_HOST') ? NULL : define('TEST_HOST', "138.222.15.1"); defined('PORT') ? NULL : define('PORT', "22"); defined('USERNAME') ? NULL : define('USERNAME', "ubuntu"); defined('PUBLIC_KEY') ? NULL : define('PUBLIC_KEY', 'id_ssl.pub'); defined('PRIVATE_KEY') ? NULL : define('PRIVATE_KEY', 'id_ssl'); $ sshbunny = (new sshbunny ('remote', 'KEY', HOST, PORT, USERNAME)) ->setKeys(PUBLIC_KEY, PRIVATE_KEY) ->initialize() ->exec("echo 'Hello World'") ->getData(TRUE);">

 <?php

use sshbunny  sshbunny ;

require_once ' vendor/autoload.php ' ;

defined ( ' TEST_HOST ' )    ? NULL : define ( ' TEST_HOST ' ,    " 138.222.15.1 " );
defined ( ' PORT ' )         ? NULL : define ( ' PORT ' ,         " 22 " );
defined ( ' USERNAME ' )     ? NULL : define ( ' USERNAME ' ,     " ubuntu " );
defined ( ' PUBLIC_KEY ' )   ? NULL : define ( ' PUBLIC_KEY ' ,   ' id_ssl.pub ' );
defined ( ' PRIVATE_KEY ' )  ? NULL : define ( ' PRIVATE_KEY ' ,  ' id_ssl ' );

$ sshbunny = ( new sshbunny ( ' remote ' , ' KEY ' , HOST , PORT , USERNAME ))
    -> setKeys ( PUBLIC_KEY , PRIVATE_KEY )
    -> initialize ()
    -> exec ( " echo 'Hello World' " )
    -> getData ( TRUE );

A execução do comando pode receber vários comandos ou você pode encadear o método exec com outro método exec

sshbunny ('remote', 'KEY', HOST, PORT, USERNAME)) ->setKeys(PUBLIC_KEY, PRIVATE_KEY) ->initialize() // Multiple commands ->exec("echo 'Hello World'", "cd /var/www/html") // Method chaining ->exec("ls -la") ->getData(TRUE);">

 $ sshbunny = ( new sshbunny ( ' remote ' , ' KEY ' , HOST , PORT , USERNAME ))
    -> setKeys ( PUBLIC_KEY , PRIVATE_KEY )
    -> initialize ()
    // Multiple commands
    -> exec ( " echo 'Hello World' " , " cd /var/www/html " )
    // Method chaining
    -> exec ( " ls -la " )
    -> getData ( TRUE );

Métodos disponíveis

• Saída do comando executado

sshbunny ->exec("ls -la") ->getData(); // Will display the result of executed command output $ sshbunny ->exec("ls -la") ->getData(TRUE);">

 // Will return the result of executed command output
$ sshbunny
    -> exec ( " ls -la " )
    -> getData ();
// Will display the result of executed command output
$ sshbunny
    -> exec ( " ls -la " )
    -> getData ( TRUE );

• Limpar saída de comando executada armazenada

sshbunny ->exec("ls -la") ->clearData() ->exec("whoami") ->getData(TRUE);">

 // Will clear the first executed command output and return the next executed command output
$ sshbunny
    -> exec ( " ls -la " )
    -> clearData ()
    -> exec ( " whoami " )
    -> getData ( TRUE );

• Desconectar conexão do servidor

sshbunny ->exec("ls -la", "whoami") ->getData(TRUE) ->disconnect();">

 // Will run the commands provided and display the result then disconnect from the server
$ sshbunny
    -> exec ( " ls -la " , " whoami " )
    -> getData ( TRUE )
    -> disconnect ();