Rework to use phpseclib

Author: DivineOmega

composer.json

@@ -11,7 +11,7 @@
     ],
     "require": {
         "php": ">=7.1",
-        "ext-ssh2": "*"
+        "phpseclib/phpseclib": "^2.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^7.0||^8.0",

src/SSHCommand.php

@@ -2,64 +2,32 @@
 
 namespace DivineOmega\SSHConnection;
 
+use phpseclib\Net\SSH2;
 use RuntimeException;
 
 class SSHCommand
 {
     const EXECUTION_TIMEOUT_SECONDS = 30;
     const STREAM_BYTES_PER_READ = 4096;
 
-    private $resource;
+    private $ssh;
     private $command;
     private $output;
     private $error;
 
-    public function __construct($resource, string $command)
+    public function __construct(SSH2 $ssh, string $command)
     {
-        $this->resource = $resource;
+        $this->ssh = $ssh;
         $this->command = $command;
 
         $this->execute();
     }
 
     private function execute()
     {
-        $stdout = ssh2_exec($this->resource, $this->command);
-
-        if (!$stdout) {
-            throw new RuntimeException('Failed to execute command (no stdout stream): '.$this->command);
-        }
-
-        $stderr = ssh2_fetch_stream($stdout, SSH2_STREAM_STDERR);
-
-        if (!$stderr) {
-            throw new RuntimeException('Failed to execute command (no stdout stream): '.$this->command);
-        }
-
-        $this->readStreams($stdout, $stderr);
-    }
-
-    private function readStreams($stdout, $stderr)
-    {
-        $startTime = time();
-
-        while (true) {
-            $this->output = fread($stdout, self::STREAM_BYTES_PER_READ);
-            $this->error = fread($stderr, self::STREAM_BYTES_PER_READ);
-
-            if (feof($stdout) && feof($stderr)) {
-                break;
-            }
-
-            if (time() - $startTime > self::EXECUTION_TIMEOUT_SECONDS) {
-                throw new RuntimeException(
-                    'Command execution took over '.self::EXECUTION_TIMEOUT_SECONDS.' seconds: '.$this->command
-                );
-            }
-
-            // Prevent thrashing
-            sleep(1);
-        }
+        $this->ssh->enableQuietMode();
+        $this->output = $this->ssh->exec($this->command);
+        $this->error = $this->ssh->getStdError();
     }
 
     public function getRawOutput(): string

src/SSHConnection.php

@@ -3,6 +3,9 @@
 namespace DivineOmega\SSHConnection;
 
 use InvalidArgumentException;
+use phpseclib\Crypt\RSA;
+use phpseclib\Net\SCP;
+use phpseclib\Net\SSH2;
 use RuntimeException;
 
 class SSHConnection
@@ -11,10 +14,9 @@ class SSHConnection
     private $port = 22;
     private $username;
     private $password;
-    private $publicKeyPath;
     private $privateKeyPath;
     private $connected = false;
-    private $resource;
+    private $ssh;
 
     public function to(string $hostname): self
     {
@@ -40,9 +42,8 @@ public function withPassword(string $password): self
         return $this;
     }
 
-    public function withKeyPair(string $publicKeyPath, string $privateKeyPath): self
+    public function withPrivateKey(string $privateKeyPath): self
     {
-        $this->publicKeyPath = $publicKeyPath;
         $this->privateKeyPath = $privateKeyPath;
         return $this;
     }
@@ -57,30 +58,32 @@ private function sanityCheck()
             throw new InvalidArgumentException('Username not specified.');
         }
 
-        if (!$this->password && (!$this->publicKeyPath || !$this->privateKeyPath)) {
-            throw new InvalidArgumentException('No password or public-private key pair specified.');
+        if (!$this->password && (!$this->privateKeyPath)) {
+            throw new InvalidArgumentException('No password or private key path specified.');
         }
     }
 
     public function connect(): self
     {
         $this->sanityCheck();
 
-        $this->resource = ssh2_connect($this->hostname, $this->port);
+        $this->ssh = new SSH2($this->hostname);
 
-        if (!$this->resource) {
+        if (!$this->ssh) {
             throw new RuntimeException('Error connecting to server.');
         }
 
-        if ($this->publicKeyPath || $this->privateKeyPath) {
-            $authenticated = ssh2_auth_pubkey_file($this->resource, $this->username, $this->publicKeyPath, $this->privateKeyPath);
+        if ($this->privateKeyPath) {
+            $key = new RSA();
+            $key->loadKey(file_get_contents($this->privateKeyPath));
+            $authenticated = $this->ssh->login($this->username, $key);
             if (!$authenticated) {
                 throw new RuntimeException('Error authenticating with public-private key pair.');
             }
         }
 
         if ($this->password) {
-            $authenticated = ssh2_auth_password($this->resource, $this->username, $this->password);
+            $authenticated = $this->ssh->login($this->username, $this->password);
             if (!$authenticated) {
                 throw new RuntimeException('Error authenticating with password.');
             }
@@ -97,7 +100,7 @@ public function disconnect(): void
             throw new RuntimeException('Unable to disconnect. Not yet connected.');
         }
 
-        ssh2_disconnect($this->resource);
+        $this->ssh->disconnect();
     }
 
     public function run(string $command): SSHCommand
@@ -106,7 +109,7 @@ public function run(string $command): SSHCommand
             throw new RuntimeException('Unable to run commands when not connected.');
         }
 
-        return new SSHCommand($this->resource, $command);
+        return new SSHCommand($this->ssh, $command);
     }
 
     public function upload(string $localPath, string $remotePath): bool
@@ -119,7 +122,7 @@ public function upload(string $localPath, string $remotePath): bool
             throw new InvalidArgumentException('The local file does not exist.');
         }
 
-        return ssh2_scp_send($this->resource, $localPath, $remotePath);
+        return (new SCP($this->ssh))->put($remotePath, $localPath, SCP::SOURCE_LOCAL_FILE);
     }
 
     public function download(string $remotePath, string $localPath): bool
@@ -128,7 +131,7 @@ public function download(string $remotePath, string $localPath): bool
             throw new RuntimeException('Unable to download file when not connected.');
         }
 
-        return ssh2_scp_recv($this->resource, $remotePath, $localPath);
+        return (new SCP($this->ssh))->get($remotePath, $localPath);
     }
 
     public function isConnected(): bool