sshbunny

sshbunny

Библиотека PHP, предоставляющая объектно-ориентированную оболочку для подключения к SSH и запуска команд оболочки с расширением php ssh2.

Требования

---

• PHP версии 5.3+
• Расширение SSH2.
• композитор.

Установить с помощью композитора

---

Лучший способ добавить библиотеку в ваш проект — использовать композитор.

composer require faraweilyas/ sshbunny

или

Клонировать этот репозиторий

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

Конфигурация

---

Конструктор sshbunny принимает четыре параметра, и все они имеют значения по умолчанию $method='local' , $authType=NULL , $host=NULL , $port=22 , $username=NULL

• $method может быть установлен на local или remote , local будет выполнять команды в вашей собственной оболочке без подключения к Интернету, а remote выполняет команды на удаленном сервере, к которому вы подключаетесь, в зависимости от вашей конфигурации.
• $authType может быть установлен в KEY , PASSWORD или KEY_PASSWORD , KEY и KEY_PASSWORD используют ssh2_auth_pubkey_file, разница в том, что когда вы устанавливаете $authType='KEY_PASSWORD' ssh2_auth_pubkey_file принимает последний параметр пароля, который теперь будет необходим, а PASSWORD использует ssh2_auth_password.
• В $port должен быть указан порт вашего сервера, если вы подключаетесь к удаленному серверу.
• В $username должно быть указано имя пользователя вашего сервера.

если вы устанавливаете метод подключения на $method='remote' и $authType = KEY || KEY_PASSWORD это означает, что вам нужно будет установить файл открытого и закрытого ключей, что вы можете сделать с помощью установщиков. sshbunny имеет $ sshbunny ->setKeys('public_key.pub', 'private_key') перед инициализацией.

Основное использование

---

Это будет выполняться локально, поскольку для метода подключения установлено 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 );

Это будет подключение к удаленному серверу, поскольку метод подключения установлен на remote , а тип аутентификации установлен на 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 );

Выполнение команды может выполнять несколько команд, или вы можете связать метод exec с другим методом 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 );

Доступные методы

• Вывод выполненной команды

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 );

• Очистить сохраненный вывод выполненной команды

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 );

• Отключить соединение с сервером

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 ();