merlinthemagic/mtm-shells

Shell tools for PHP 7

dev-master 2024-03-09 17:32 UTC

Requires

• php: >=7.3.0
• merlinthemagic/mtm-fs: >=0.0.1
• merlinthemagic/mtm-utilities: >=0.0.1

LGPL-3.0

• Martin Peter Madsen

• routeros
• bash

README

What is this?

A way to create and work with shells. You can execute any command you want, there is full parity with the underlying shell.

Install:

composer require merlinthemagic/mtm-shells

Get shell:

Bash as current user (e.g. apache, www-data, etc):

$ctrlObj		= \MTM\Shells\Factories::getShells()->getBash(false);

Bash as root:

Obviously letting PHP anywhere near root is a poor idea, but the option is there.

Allowing PHP user to run sudo:

Add last line of the below snippit to the file: /etc/sudoers

## Allow root to run any commands anywhere
root    ALL=(ALL)       ALL
## Add the line below, replace apache with whatever name your run your webserver with e.g. www-data
apache	ALL=(ALL)NOPASSWD:/usr/bin/python3

Then get a shell allowing MTM-Shells to use the sudo permissions we gave the webserver user over python3:

//get a root shell via sudo
$ctrlObj		= \MTM\Shells\Factories::getShells()->getBash(true);

If you dont like giving sudo permissions to the webserver, you can use SU and provide the password:

//get a root shell with password
$username		= "root";
$password		= "very_secret";

$ctrlObj		= \MTM\Shells\Factories::getShells()->getBash();
\MTM\Shells\Factories::getStencils()->getLinux()->getSu()->byPassword($ctrlObj, $username, $password);

echo $ctrlObj->getCmd("whoami")->get(); //root

Execute commands

$strCmd		= "whoami";
$data		= $ctrlObj->getCmd($strCmd)->get();
echo $data; //webserver user or if you got a root shell, then root :)

$strCmd1	= "cd /var";
$ctrlObj->getCmd($strCmd1)->get(); //enter the /var directory

$strCmd2	= "ls -sho --color=none";
$data		= $ctrlObj->getCmd($strCmd2)->get();
echo $data; //directory and file listing from /var

Files and directories:

SFTP Copy directory recursively to remote server

Note: SFTP will not include the source directory only all child files and directories into the specified destination directory Note: Destination directories that do not exist will be created

$ctrlObj		= \MTM\Shells\Factories::getShells()->getBash(); //can also be a ssh shell obj from MTM-SSH
$toolObj		= \MTM\Shells\Factories::getFiles()->getSftpTool();

$srcDir			= "/path/to/dir/";
$dstDir			= "/";
$ipAddr			= "192.168.1.15";
$username		= "myUserName";
$password		= "verySecret";

$toolObj->passwordCopy($ctrlObj, $srcDir, $dstDir, $ipAddr, $username, $password);

SCP Copy directory recursively to remote server

Note: SCP will include the source directory and all child files and directories into the specified destination directory Note: The base destination directory must exist and will not be created

$ctrlObj		= \MTM\Shells\Factories::getShells()->getBash(); //can also be a ssh shell obj from MTM-SSH
$toolObj		= \MTM\Shells\Factories::getFiles()->getScpTool();

$srcDir			= "/path/to/dir/";
$dstDir			= "/dst/dir/"; //must exist
$ipAddr			= "192.168.1.15";
$username		= "myUserName";
$password		= "verySecret";

$toolObj->passwordCopy($ctrlObj, $srcDir, $dstDir, $ipAddr, $username, $password);

Rsync Copy directory recursively to remote server

Note: RSync will include the source directory and all child files and directories into the specified destination directory Note: The base destination directory must exist and will not be created

$ctrlObj		= \MTM\Shells\Factories::getShells()->getBash(); //can also be a ssh shell obj from MTM-SSH
$toolObj		= \MTM\Shells\Factories::getFiles()->getRsyncTool();

$srcDir			= "/path/to/dir/";
$dstDir			= "/dst/dir/"; //must exist
$ipAddr			= "192.168.1.15";
$username		= "myUserName";
$password		= "verySecret";

$toolObj->passwordCopy($ctrlObj, $srcDir, $dstDir, $ipAddr, $username, $password);