SecureShell::seeRemoteFile() - Code Metrics - Inspection of "Add commands seeInRemoteOutput and dontSee" - edno/codeception-secureshell - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6047b6...144a2d )

by Greg

created 2016-06-25 14:33 UTC

SecureShell::seeRemoteFile() A

↳ Parent: SecureShell

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	1
nc	1
nop	0

<?php
namespace Codeception\Extension;

use Codeception\Exception\ModuleException;
use Codeception\Exception\ModuleConfigException;
use Codeception\Module;
use \SplFileObject;
use \RuntimeException;
use \Exception;

class SecureShell extends Module
{

    const DEFAULT_PORT  = 22;
    const AUTH_PASSWORD = 1;
    const AUTH_PUBKEY   = 2;
    const AUTH_HOSTKEY  = 3;
    const AUTH_AGENT    = 4;
    const AUTH_NONE     = 0;

    protected $config = [];

    protected $requiredFields = [];

    protected static $knownHostsFile = '~/.ssh/known_hosts'; // configuration

    protected static $acceptUnknownHost = true; // configuration

    protected $tunnels = [];

    protected $connections = [];

    private $output;

    public function openConnection( $host,
                                    $port = SecureShell::DEFAULT_PORT,
                                    $auth = SecureShell::AUTH_PASSWORD,
                                    ...$args)
    {
        $uid = null;
        $callbacks = array('disconnect' => [$this, '_disconnect']);

        try {
            $connection = ssh2_connect($host, $port, $callbacks);
            if (!$connection) {
                throw new ModuleException(get_class($this), "Unable to connect to {$host} on port {$port}");
            } else {
                $fp = $this->__checkFingerprint($connection);

                if ($this->__authenticate($connection, $auth, ...$args) === false) {
                    throw new ModuleException(get_class($this), "Authentication failed on server {$host}:{$port}");
                } else {
                    $uid = hash('crc32', uniqid($fp), false);
                    $this->connections = array_merge($this->connections,
                                        [$uid => ['host' => $host,
                                                'port' => $port,
                                                'fingerprint' => $fp,
                                                'auth_method' => $auth,
                                                'resource' => $connection]
                                        ]);
                }
            }
        } catch (ModuleException $e) {
            throw $e;
        } catch (Exception $e) {
            throw new ModuleException(get_class($this), $e->getMessage());
        }
        return $uid;
    }

    public function closeConnection($uid) {
        switch ($this->__isValidConnnection($uid)) {
            case 0:
            case 1:
                unset($this->connections[$uid]);
                break;
            default:
                throw new ModuleException(get_class($this), "{$uid} is not a valid SSH connection");
        }
        return true;
    }

    public function getConnection($uid) {
        return $this->connections[$uid]['resource'];
    }

    protected function __isValidConnnection($uid) {
        if (isset($this->connections[$uid])) {
            if (is_resource($this->connections[$uid]['resource'])) {
                return 1;
            } else {
                return 0;
            }
        } else {
            return -1;
        }
    }

    protected function __authenticate($connection, $method, ...$args)
    {
        switch ($method) {
            case SecureShell::AUTH_PASSWORD:
                return ssh2_auth_password($connection, ...$args);
            case SecureShell::AUTH_PUBKEY:
            return ssh2_auth_pubkey_file($connection, ...$args);
            case SecureShell::AUTH_HOSTKEY:
                return ssh2_auth_hostbased_file($connection, ...$args);
            case SecureShell::AUTH_AGENT:
                return ssh2_auth_agent($connection, ...$args);
            case SecureShell::AUTH_NONE:
                return ssh2_auth_none($connection, ...$args);
            default:
                throw new ModuleException(get_class($this), 'Unsupported authentication method');
        }
    }

    protected function __checkFingerprint($connection)
    {
        $knownHost = false;
        try {
            $fingerprint = ssh2_fingerprint($connection, SSH2_FINGERPRINT_MD5 | SSH2_FINGERPRINT_HEX);
            $file = new SplFileObject(static::$knownHostsFile);
            $file->setFlags(SplFileObject::READ_CSV);
            $file->setCsvControl(' ');
            foreach ($file as $entry) {
                list($host, $method, $fp) = $entry;
<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;
                $knownHost = (strcmp($fp, $fingerprint) !== 0);
                if ($knownHost === true) {
                    break;
                }
            }
            $knownHost = $knownHost || static::$acceptUnknownHost;

            if ($knownHost === false) {
                throw new ModuleException(get_class($this), 'Unable to verify server identity!');
            }
        } catch (RuntimeException $e) {
            if (static::$acceptUnknownHost === false) {
                throw new ModuleException(get_class($this), 'Unable to verify server identity!');
            }
        }
        return $fingerprint;
    }

    protected function __disconnect()
    {
        foreach ($this->connections as $id => $connection) {
            if (is_resource($connection['resource']) !== true) {
                unset($this->connections[$id]);
            }
        }
    }

    /** Remote Commands methods **/

    public function runRemoteCommand($session, $command)
    {
        $connection = $this->getConnection($session);
        $stream = ssh2_exec($connection, $command);
        stream_set_blocking($stream, true);
        $errStream = ssh2_fetch_stream($stream, SSH2_STREAM_STDERR);
        $this->output['STDOUT'] = stream_get_contents($stream);
        $this->output['STDERR'] = stream_get_contents($errStream);
        return $this->output;
    }

    public function seeInRemoteOutput($text)
    {
        \PHPUnit_Framework_Assert::assertContains($text, $this->output['STDOUT']);
    }

    public function dontSeeInRemoteOutput($text)
    {
        \PHPUnit_Framework_Assert::assertNotContains($text, $this->output['STDOUT']);
    }

    /** Remote Files methods **/

    public function seeRemoteFile()
    {

    }

    public function dontSeeRemoteFile()
    {

    }

    public function grabRemoteFile()
    {

    }

    public function copyRemoteFile()
    {

    }

    public function deleteRemoteFile()
    {

    }

    /** Remote Dir methods **/

    public function seeRemoteDir()
    {

    }

    public function dontSeeRemoteDir()
    {

    }

    public function copyRemoteDir()
    {

    }

    public function deleteRemoteDir()
    {

    }

    public function readRemoteDir()
    {

    }

    /** Tunnel methods **/

    public function openRemoteTunnel()
    {

    }

    public function closeRemoteTunnel()
    {

    }

}


1			<?php
2			namespace Codeception\Extension;
3
4			use Codeception\Exception\ModuleException;
5			use Codeception\Exception\ModuleConfigException;
6			use Codeception\Module;
7			use \SplFileObject;
8			use \RuntimeException;
9			use \Exception;
10
11			class SecureShell extends Module
12			{
13
14			const DEFAULT_PORT = 22;
15			const AUTH_PASSWORD = 1;
16			const AUTH_PUBKEY = 2;
17			const AUTH_HOSTKEY = 3;
18			const AUTH_AGENT = 4;
19			const AUTH_NONE = 0;
20
21			protected $config = [];
22
23			protected $requiredFields = [];
24
25			protected static $knownHostsFile = '~/.ssh/known_hosts'; // configuration
26
27			protected static $acceptUnknownHost = true; // configuration
28
29			protected $tunnels = [];
30
31			protected $connections = [];
32
33			private $output;
34
35			public function openConnection( $host,
36			$port = SecureShell::DEFAULT_PORT,
37			$auth = SecureShell::AUTH_PASSWORD,
38			...$args)
39			{
40			$uid = null;
41			$callbacks = array('disconnect' => [$this, '_disconnect']);
42
43			try {
44			$connection = ssh2_connect($host, $port, $callbacks);
45			if (!$connection) {
46			throw new ModuleException(get_class($this), "Unable to connect to {$host} on port {$port}");
47			} else {
48			$fp = $this->__checkFingerprint($connection);
49
50			if ($this->__authenticate($connection, $auth, ...$args) === false) {
51			throw new ModuleException(get_class($this), "Authentication failed on server {$host}:{$port}");
52			} else {
53			$uid = hash('crc32', uniqid($fp), false);
54			$this->connections = array_merge($this->connections,
55			[$uid => ['host' => $host,
56			'port' => $port,
57			'fingerprint' => $fp,
58			'auth_method' => $auth,
59			'resource' => $connection]
60			]);
61			}
62			}
63			} catch (ModuleException $e) {
64			throw $e;
65			} catch (Exception $e) {
66			throw new ModuleException(get_class($this), $e->getMessage());
67			}
68			return $uid;
69			}
70
71			public function closeConnection($uid) {
72			switch ($this->__isValidConnnection($uid)) {
73			case 0:
74			case 1:
75			unset($this->connections[$uid]);
76			break;
77			default:
78			throw new ModuleException(get_class($this), "{$uid} is not a valid SSH connection");
79			}
80			return true;
81			}
82
83			public function getConnection($uid) {
84			return $this->connections[$uid]['resource'];
85			}
86
87			protected function __isValidConnnection($uid) {
88			if (isset($this->connections[$uid])) {
89			if (is_resource($this->connections[$uid]['resource'])) {
90			return 1;
91			} else {
92			return 0;
93			}
94			} else {
95			return -1;
96			}
97			}
98
99			protected function __authenticate($connection, $method, ...$args)
100			{
101			switch ($method) {
102			case SecureShell::AUTH_PASSWORD:
103			return ssh2_auth_password($connection, ...$args);
104			case SecureShell::AUTH_PUBKEY:
105			return ssh2_auth_pubkey_file($connection, ...$args);
106			case SecureShell::AUTH_HOSTKEY:
107			return ssh2_auth_hostbased_file($connection, ...$args);
108			case SecureShell::AUTH_AGENT:
109			return ssh2_auth_agent($connection, ...$args);
110			case SecureShell::AUTH_NONE:
111			return ssh2_auth_none($connection, ...$args);
112			default:
113			throw new ModuleException(get_class($this), 'Unsupported authentication method');
114			}
115			}
116
117			protected function __checkFingerprint($connection)
118			{
119			$knownHost = false;
120			try {
121			$fingerprint = ssh2_fingerprint($connection, SSH2_FINGERPRINT_MD5 \| SSH2_FINGERPRINT_HEX);
122			$file = new SplFileObject(static::$knownHostsFile);
123			$file->setFlags(SplFileObject::READ_CSV);
124			$file->setCsvControl(' ');
125			foreach ($file as $entry) {
126			list($host, $method, $fp) = $entry;
			0 ignored issues – show Unused Code introduced 2016-06-16 22:18 UTC by Report Bug Copy Issue Report The assignment to `$host` is unused. Consider omitting it like so `list($first,,$third)`. This checks looks for assignemnts to variables using the `list(...)` function, where not all assigned variables are subsequently used. Consider the following code example. <?php function returnThreeValues() { return array('a', 'b', 'c'); } list($a, $b, $c) = returnThreeValues(); print $a . " - " . $c; Only the variables `$a` and `$c` are used. There was no need to assign `$b`. Instead, the list call could have been. list($a,, $c) = returnThreeValues(); Loading history... Unused Code introduced 2016-06-16 22:18 UTC by Report Bug Copy Issue Report The assignment to `$method` is unused. Consider omitting it like so `list($first,,$third)`. This checks looks for assignemnts to variables using the `list(...)` function, where not all assigned variables are subsequently used. Consider the following code example. <?php function returnThreeValues() { return array('a', 'b', 'c'); } list($a, $b, $c) = returnThreeValues(); print $a . " - " . $c; Only the variables `$a` and `$c` are used. There was no need to assign `$b`. Instead, the list call could have been. list($a,, $c) = returnThreeValues(); Loading history...
127			$knownHost = (strcmp($fp, $fingerprint) !== 0);
128			if ($knownHost === true) {
129			break;
130			}
131			}
132			$knownHost = $knownHost \|\| static::$acceptUnknownHost;
133
134			if ($knownHost === false) {
135			throw new ModuleException(get_class($this), 'Unable to verify server identity!');
136			}
137			} catch (RuntimeException $e) {
138			if (static::$acceptUnknownHost === false) {
139			throw new ModuleException(get_class($this), 'Unable to verify server identity!');
140			}
141			}
142			return $fingerprint;
143			}
144
145			protected function __disconnect()
146			{
147			foreach ($this->connections as $id => $connection) {
148			if (is_resource($connection['resource']) !== true) {
149			unset($this->connections[$id]);
150			}
151			}
152			}
153
154			/ Remote Commands methods /
155
156			public function runRemoteCommand($session, $command)
157			{
158			$connection = $this->getConnection($session);
159			$stream = ssh2_exec($connection, $command);
160			stream_set_blocking($stream, true);
161			$errStream = ssh2_fetch_stream($stream, SSH2_STREAM_STDERR);
162			$this->output['STDOUT'] = stream_get_contents($stream);
163			$this->output['STDERR'] = stream_get_contents($errStream);
164			return $this->output;
165			}
166
167			public function seeInRemoteOutput($text)
168			{
169			\PHPUnit_Framework_Assert::assertContains($text, $this->output['STDOUT']);
170			}
171
172			public function dontSeeInRemoteOutput($text)
173			{
174			\PHPUnit_Framework_Assert::assertNotContains($text, $this->output['STDOUT']);
175			}
176
177			/ Remote Files methods /
178
179			public function seeRemoteFile()
180			{
181
182			}
183
184			public function dontSeeRemoteFile()
185			{
186
187			}
188
189			public function grabRemoteFile()
190			{
191
192			}
193
194			public function copyRemoteFile()
195			{
196
197			}
198
199			public function deleteRemoteFile()
200			{
201
202			}
203
204			/ Remote Dir methods /
205
206			public function seeRemoteDir()
207			{
208
209			}
210
211			public function dontSeeRemoteDir()
212			{
213
214			}
215
216			public function copyRemoteDir()
217			{
218
219			}
220
221			public function deleteRemoteDir()
222			{
223
224			}
225
226			public function readRemoteDir()
227			{
228
229			}
230
231			/ Tunnel methods /
232
233			public function openRemoteTunnel()
234			{
235
236			}
237
238			public function closeRemoteTunnel()
239			{
240
241			}
242
243			}
244

edno / codeception-secureshell

GitHub Access Token became invalid

Push — master ( 6047b6...144a2d )

SecureShell::seeRemoteFile() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like