Resolve #56 : Implemented async SSH driver

.travis.yml

@@ -6,11 +6,13 @@ php:
   - 7.0
   - 7.1
 
-sudo: false
-
-install:
+before_script:
+  - sudo apt-get update -qq
+  - sudo apt-get install -y -qq libssh2-1-dev libssh2-php
+  - pecl install -f ssh2-beta < .noninteractive
   - composer self-update
   - composer install --no-interaction --prefer-source
+  - echo `whoami`":1234" | sudo chpasswd
 
 script:
   - vendor/bin/phpunit -d memory_limit=1024M --coverage-text

composer.json

@@ -35,7 +35,8 @@
         "ext-event": "~1.0",
         "ext-libev": "*",
         "ext-zmq": "*",
-        "ext-fileinfo": "*"
+        "ext-fileinfo": "*",
+        "ext-ssh2": "*"
     },
     "replace": {
         "kraken-php/channel": "self.version",
@@ -53,6 +54,7 @@
         "kraken-php/promise": "self.version",
         "kraken-php/root": "self.version",
         "kraken-php/runtime": "self.version",
+        "kraken-php/ssh": "self.version",
         "kraken-php/stream": "self.version",
         "kraken-php/supervision": "self.version",
         "kraken-php/test": "self.version",

src/Event/BaseEventEmitterTrait.php

@@ -343,4 +343,15 @@ protected function attachTimesListener($pointer, $event, $limit, callable $liste
             return call_user_func_array($listener, func_get_args());
         };
     }
+
+    /**
+     * Destruct method.
+     */
+    private function destructEventEmitterTrait()
+    {
+        $this->emitterBlocked = EventEmitter::EVENTS_FORWARD;
+        $this->eventPointers = [];
+        $this->eventListeners = [];
+        $this->forwardListeners = [];
+    }
 }

src/SSH/Auth/SSH2Agent.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Kraken\SSH\Auth;
+
+use Kraken\SSH\SSH2AuthInterface;
+
+/**
+ * Agent based SSH2 authentication
+ */
+class SSH2Agent implements SSH2AuthInterface
+{
+    /**
+     * @var string
+     */
+    protected $username;
+
+    /**
+     * Constructor
+     *
+     * @param string $username The authentication username
+     */
+    public function __construct($username)
+    {
+        $this->username = $username;
+    }
+
+    /**
+     * @override
+     * @inheritDoc
+     */
+    public function authenticate($conn)
+    {
+        return @ssh2_auth_agent(
+            $conn,
+            $this->username
+        );
+    }
+}

src/SSH/Auth/SSH2HostBasedFile.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Kraken\SSH\Auth;
+
+use Kraken\SSH\SSH2AuthInterface;
+
+/**
+ * Host based SSH2 authentication.
+ */
+class SSH2HostBasedFile implements SSH2AuthInterface
+{
+    /**
+     * @var string
+     */
+    protected $username;
+
+    /**
+     * @var string
+     */
+    protected $hostname;
+
+    /**
+     * @var string
+     */
+    protected $publicKeyFile;
+
+    /**
+     * @var string
+     */
+    protected $privateKeyFile;
+
+    /**
+     * @var null|string
+     */
+    protected $passPhrase;
+
+    /**
+     * @var null|string
+     */
+    protected $localUsername;
+
+    /**
+     * @param string $username The authentication username
+     * @param string $hostname The authentication hostname
+     * @param string $publicKeyFile The path of the public key file
+     * @param string $privateKeyFile The path of the private key file
+     * @param string $passPhrase An optional pass phrase for the key
+     * @param string $localUsername  An optional local usernale. If omitted, the username will be used
+     */
+    public function __construct($username, $hostname, $publicKeyFile, $privateKeyFile, $passPhrase = null, $localUsername = null)
+    {
+        $this->username = $username;
+        $this->hostname = $hostname;
+        $this->publicKeyFile = $publicKeyFile;
+        $this->privateKeyFile = $privateKeyFile;
+        $this->passPhrase = $passPhrase;
+        $this->localUsername = $localUsername;
+    }
+
+    /**
+     * @override
+     * @inheritDoc
+     */
+    public function authenticate($conn)
+    {
+        return @ssh2_auth_hostbased_file(
+            $conn,
+            $this->username,
+            $this->hostname,
+            $this->publicKeyFile,
+            $this->privateKeyFile,
+            $this->passPhrase,
+            $this->localUsername
+        );
+    }
+}

src/SSH/Auth/SSH2None.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Kraken\SSH\Auth;
+
+use Kraken\SSH\SSH2AuthInterface;
+
+/**
+ * Username based SSH2 authentication.
+ */
+class SSH2None implements SSH2AuthInterface
+{
+    /**
+     * @var string
+     */
+    protected $username;
+
+    /**
+     * @param string $username The authentication username
+     */
+    public function __construct($username)
+    {
+        $this->username = $username;
+    }
+
+    /**
+     * @override
+     * @inheritDoc
+     */
+    public function authenticate($conn)
+    {
+        return true === @ssh2_auth_none($conn, $this->username);
+    }
+}

src/SSH/Auth/SSH2Password.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Kraken\SSH\Auth;
+
+use Kraken\SSH\SSH2AuthInterface;
+
+/**
+ * Password based SSH2 authentication
+ */
+class SSH2Password implements SSH2AuthInterface
+{
+    /**
+     * @var string
+     */
+    protected $username;
+
+    /**
+     * @var string
+     */
+    protected $password;
+
+    /**
+     * @param string $username The authentication username
+     * @param string $password The authentication password
+     */
+    public function __construct($username, $password)
+    {
+        $this->username = $username;
+        $this->password = $password;
+    }
+
+    /**
+     * @override
+     * @inheritDoc
+     */
+    public function authenticate($conn)
+    {
+        return @ssh2_auth_password($conn, $this->username, $this->password);
+    }
+}

src/SSH/Auth/SSH2PublicKeyFile.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace Kraken\SSH\Auth;
+
+use Kraken\SSH\SSH2AuthInterface;
+
+/**
+ * Public key based SSH2 authentication
+ */
+class SSH2PublicKeyFile implements SSH2AuthInterface
+{
+    /**
+     * @var string
+     */
+    protected $username;
+
+    /**
+     * @var string
+     */
+    protected $publicKeyFile;
+
+    /**
+     * @var string
+     */
+    protected $privateKeyFile;
+
+    /**
+     * @var null|string
+     */
+    protected $passPhrase;
+
+    /**
+     * @param string $username The authentication username
+     * @param string $publicKeyFile The path of the public key file
+     * @param string $privateKeyFile The path of the private key file
+     * @param string|null $passPhrase An optional pass phrase for the key
+     */
+    public function __construct($username, $publicKeyFile, $privateKeyFile, $passPhrase = null)
+    {
+        $this->username = $username;
+        $this->publicKeyFile = $publicKeyFile;
+        $this->privateKeyFile = $privateKeyFile;
+        $this->passPhrase = $passPhrase;
+    }
+
+    /**
+     * @override
+     * @inheritDoc
+     */
+    public function authenticate($conn)
+    {
+        return @ssh2_auth_pubkey_file(
+            $conn,
+            $this->username,
+            $this->publicKeyFile,
+            $this->privateKeyFile,
+            $this->passPhrase
+        );
+    }
+}