nextcloud / server

apps/files_external/lib/Lib/Storage/SFTPReadStream.php

Indentation +170 added lines, -170 removed lines

@@ -25,175 +25,175 @@
 use phpseclib\Net\SSH2;
 
 class SFTPReadStream implements File {
-	/** @var resource */
-	public $context;
-
-	/** @var \phpseclib\Net\SFTP */
-	private $sftp;
-
-	/** @var resource */
-	private $handle;
-
-	/** @var int */
-	private $internalPosition = 0;
-
-	/** @var int */
-	private $readPosition = 0;
-
-	/** @var bool */
-	private $eof = false;
-
-	private $buffer = '';
-
-	static function register($protocol = 'sftpread') {
-		if (in_array($protocol, stream_get_wrappers(), true)) {
-			return false;
-		}
-		return stream_wrapper_register($protocol, get_called_class());
-	}
-
-	/**
-	 * Load the source from the stream context and return the context options
-	 *
-	 * @param string $name
-	 * @return array
-	 * @throws \BadMethodCallException
-	 */
-	protected function loadContext($name) {
-		$context = stream_context_get_options($this->context);
-		if (isset($context[$name])) {
-			$context = $context[$name];
-		} else {
-			throw new \BadMethodCallException('Invalid context, "' . $name . '" options not set');
-		}
-		if (isset($context['session']) and $context['session'] instanceof \phpseclib\Net\SFTP) {
-			$this->sftp = $context['session'];
-		} else {
-			throw new \BadMethodCallException('Invalid context, session not set');
-		}
-		return $context;
-	}
-
-	public function stream_open($path, $mode, $options, &$opened_path) {
-		[, $path] = explode('://', $path);
-		$this->loadContext('sftp');
-
-		if (!($this->sftp->bitmap & SSH2::MASK_LOGIN)) {
-			return false;
-		}
-
-		$remote_file = $this->sftp->_realpath($path);
-		if ($remote_file === false) {
-			return false;
-		}
-
-		$packet = pack('Na*N2', strlen($remote_file), $remote_file, NET_SFTP_OPEN_READ, 0);
-		if (!$this->sftp->_send_sftp_packet(NET_SFTP_OPEN, $packet)) {
-			return false;
-		}
-
-		$response = $this->sftp->_get_sftp_packet();
-		switch ($this->sftp->packet_type) {
-			case NET_SFTP_HANDLE:
-				$this->handle = substr($response, 4);
-				break;
-			case NET_SFTP_STATUS: // presumably SSH_FX_NO_SUCH_FILE or SSH_FX_PERMISSION_DENIED
-				$this->sftp->_logError($response);
-				return false;
-			default:
-				user_error('Expected SSH_FXP_HANDLE or SSH_FXP_STATUS');
-				return false;
-		}
-
-		$this->request_chunk(256 * 1024);
-
-		return true;
-	}
-
-	public function stream_seek($offset, $whence = SEEK_SET) {
-		return false;
-	}
-
-	public function stream_tell() {
-		return $this->readPosition;
-	}
-
-	public function stream_read($count) {
-		if (!$this->eof && strlen($this->buffer) < $count) {
-			$chunk = $this->read_chunk();
-			$this->buffer .= $chunk;
-			if (!$this->eof) {
-				$this->request_chunk(256 * 1024);
-			}
-		}
-
-		$data = substr($this->buffer, 0, $count);
-		$this->buffer = substr($this->buffer, $count);
-		if ($this->buffer === false) {
-			$this->buffer = '';
-		}
-		$this->readPosition += strlen($data);
-
-		return $data;
-	}
-
-	private function request_chunk($size) {
-		$packet = pack('Na*N3', strlen($this->handle), $this->handle, $this->internalPosition / 4294967296, $this->internalPosition, $size);
-		return $this->sftp->_send_sftp_packet(NET_SFTP_READ, $packet);
-	}
-
-	private function read_chunk() {
-		$response = $this->sftp->_get_sftp_packet();
-
-		switch ($this->sftp->packet_type) {
-			case NET_SFTP_DATA:
-				$temp = substr($response, 4);
-				$len = strlen($temp);
-				$this->internalPosition += $len;
-				return $temp;
-			case NET_SFTP_STATUS:
-				[1 => $status] = unpack('N', substr($response, 0, 4));
-				if ($status == NET_SFTP_STATUS_EOF) {
-					$this->eof = true;
-				}
-				return '';
-			default:
-				return '';
-		}
-	}
-
-	public function stream_write($data) {
-		return false;
-	}
-
-	public function stream_set_option($option, $arg1, $arg2) {
-		return false;
-	}
-
-	public function stream_truncate($size) {
-		return false;
-	}
-
-	public function stream_stat() {
-		return false;
-	}
-
-	public function stream_lock($operation) {
-		return false;
-	}
-
-	public function stream_flush() {
-		return false;
-	}
-
-	public function stream_eof() {
-		return $this->eof;
-	}
-
-	public function stream_close() {
-		if (!$this->sftp->_close_handle($this->handle)) {
-			return false;
-		}
-	}
+    /** @var resource */
+    public $context;
+
+    /** @var \phpseclib\Net\SFTP */
+    private $sftp;
+
+    /** @var resource */
+    private $handle;
+
+    /** @var int */
+    private $internalPosition = 0;
+
+    /** @var int */
+    private $readPosition = 0;
+
+    /** @var bool */
+    private $eof = false;
+
+    private $buffer = '';
+
+    static function register($protocol = 'sftpread') {
+        if (in_array($protocol, stream_get_wrappers(), true)) {
+            return false;
+        }
+        return stream_wrapper_register($protocol, get_called_class());
+    }
+
+    /**
+     * Load the source from the stream context and return the context options
+     *
+     * @param string $name
+     * @return array
+     * @throws \BadMethodCallException
+     */
+    protected function loadContext($name) {
+        $context = stream_context_get_options($this->context);
+        if (isset($context[$name])) {
+            $context = $context[$name];
+        } else {
+            throw new \BadMethodCallException('Invalid context, "' . $name . '" options not set');
+        }
+        if (isset($context['session']) and $context['session'] instanceof \phpseclib\Net\SFTP) {
+            $this->sftp = $context['session'];
+        } else {
+            throw new \BadMethodCallException('Invalid context, session not set');
+        }
+        return $context;
+    }
+
+    public function stream_open($path, $mode, $options, &$opened_path) {
+        [, $path] = explode('://', $path);
+        $this->loadContext('sftp');
+
+        if (!($this->sftp->bitmap & SSH2::MASK_LOGIN)) {
+            return false;
+        }
+
+        $remote_file = $this->sftp->_realpath($path);
+        if ($remote_file === false) {
+            return false;
+        }
+
+        $packet = pack('Na*N2', strlen($remote_file), $remote_file, NET_SFTP_OPEN_READ, 0);
+        if (!$this->sftp->_send_sftp_packet(NET_SFTP_OPEN, $packet)) {
+            return false;
+        }
+
+        $response = $this->sftp->_get_sftp_packet();
+        switch ($this->sftp->packet_type) {
+            case NET_SFTP_HANDLE:
+                $this->handle = substr($response, 4);
+                break;
+            case NET_SFTP_STATUS: // presumably SSH_FX_NO_SUCH_FILE or SSH_FX_PERMISSION_DENIED
+                $this->sftp->_logError($response);
+                return false;
+            default:
+                user_error('Expected SSH_FXP_HANDLE or SSH_FXP_STATUS');
+                return false;
+        }
+
+        $this->request_chunk(256 * 1024);
+
+        return true;
+    }
+
+    public function stream_seek($offset, $whence = SEEK_SET) {
+        return false;
+    }
+
+    public function stream_tell() {
+        return $this->readPosition;
+    }
+
+    public function stream_read($count) {
+        if (!$this->eof && strlen($this->buffer) < $count) {
+            $chunk = $this->read_chunk();
+            $this->buffer .= $chunk;
+            if (!$this->eof) {
+                $this->request_chunk(256 * 1024);
+            }
+        }
+
+        $data = substr($this->buffer, 0, $count);
+        $this->buffer = substr($this->buffer, $count);
+        if ($this->buffer === false) {
+            $this->buffer = '';
+        }
+        $this->readPosition += strlen($data);
+
+        return $data;
+    }
+
+    private function request_chunk($size) {
+        $packet = pack('Na*N3', strlen($this->handle), $this->handle, $this->internalPosition / 4294967296, $this->internalPosition, $size);
+        return $this->sftp->_send_sftp_packet(NET_SFTP_READ, $packet);
+    }
+
+    private function read_chunk() {
+        $response = $this->sftp->_get_sftp_packet();
+
+        switch ($this->sftp->packet_type) {
+            case NET_SFTP_DATA:
+                $temp = substr($response, 4);
+                $len = strlen($temp);
+                $this->internalPosition += $len;
+                return $temp;
+            case NET_SFTP_STATUS:
+                [1 => $status] = unpack('N', substr($response, 0, 4));
+                if ($status == NET_SFTP_STATUS_EOF) {
+                    $this->eof = true;
+                }
+                return '';
+            default:
+                return '';
+        }
+    }
+
+    public function stream_write($data) {
+        return false;
+    }
+
+    public function stream_set_option($option, $arg1, $arg2) {
+        return false;
+    }
+
+    public function stream_truncate($size) {
+        return false;
+    }
+
+    public function stream_stat() {
+        return false;
+    }
+
+    public function stream_lock($operation) {
+        return false;
+    }
+
+    public function stream_flush() {
+        return false;
+    }
+
+    public function stream_eof() {
+        return $this->eof;
+    }
+
+    public function stream_close() {
+        if (!$this->sftp->_close_handle($this->handle)) {
+            return false;
+        }
+    }
 
 }

Spacing +1 added lines, -1 removed lines

@@ -64,7 +64,7 @@
 		if (isset($context[$name])) {
 			$context = $context[$name];
 		} else {
-			throw new \BadMethodCallException('Invalid context, "' . $name . '" options not set');
+			throw new \BadMethodCallException('Invalid context, "'.$name.'" options not set');
 		}
 		if (isset($context['session']) and $context['session'] instanceof \phpseclib\Net\SFTP) {
 			$this->sftp = $context['session'];

apps/files_external/lib/Lib/Storage/SFTPWriteStream.php

Indentation +148 added lines, -148 removed lines

@@ -25,154 +25,154 @@
 use phpseclib\Net\SSH2;
 
 class SFTPWriteStream implements File {
-	/** @var resource */
-	public $context;
-
-	/** @var \phpseclib\Net\SFTP */
-	private $sftp;
-
-	/** @var resource */
-	private $handle;
-
-	/** @var int */
-	private $internalPosition = 0;
-
-	/** @var int */
-	private $writePosition = 0;
-
-	/** @var bool */
-	private $eof = false;
-
-	private $buffer = '';
-
-	static function register($protocol = 'sftpwrite') {
-		if (in_array($protocol, stream_get_wrappers(), true)) {
-			return false;
-		}
-		return stream_wrapper_register($protocol, get_called_class());
-	}
-
-	/**
-	 * Load the source from the stream context and return the context options
-	 *
-	 * @param string $name
-	 * @return array
-	 * @throws \BadMethodCallException
-	 */
-	protected function loadContext($name) {
-		$context = stream_context_get_options($this->context);
-		if (isset($context[$name])) {
-			$context = $context[$name];
-		} else {
-			throw new \BadMethodCallException('Invalid context, "' . $name . '" options not set');
-		}
-		if (isset($context['session']) and $context['session'] instanceof \phpseclib\Net\SFTP) {
-			$this->sftp = $context['session'];
-		} else {
-			throw new \BadMethodCallException('Invalid context, session not set');
-		}
-		return $context;
-	}
-
-	public function stream_open($path, $mode, $options, &$opened_path) {
-		[, $path] = explode('://', $path);
-		$this->loadContext('sftp');
-
-		if (!($this->sftp->bitmap & SSH2::MASK_LOGIN)) {
-			return false;
-		}
-
-		$remote_file = $this->sftp->_realpath($path);
-		if ($remote_file === false) {
-			return false;
-		}
-
-		$packet = pack('Na*N2', strlen($remote_file), $remote_file, NET_SFTP_OPEN_WRITE | NET_SFTP_OPEN_CREATE | NET_SFTP_OPEN_TRUNCATE, 0);
-		if (!$this->sftp->_send_sftp_packet(NET_SFTP_OPEN, $packet)) {
-			return false;
-		}
-
-		$response = $this->sftp->_get_sftp_packet();
-		switch ($this->sftp->packet_type) {
-			case NET_SFTP_HANDLE:
-				$this->handle = substr($response, 4);
-				break;
-			case NET_SFTP_STATUS: // presumably SSH_FX_NO_SUCH_FILE or SSH_FX_PERMISSION_DENIED
-				$this->sftp->_logError($response);
-				return false;
-			default:
-				user_error('Expected SSH_FXP_HANDLE or SSH_FXP_STATUS');
-				return false;
-		}
-
-		return true;
-	}
-
-	public function stream_seek($offset, $whence = SEEK_SET) {
-		return false;
-	}
-
-	public function stream_tell() {
-		return $this->writePosition;
-	}
-
-	public function stream_read($count) {
-		return false;
-	}
-
-	public function stream_write($data) {
-		$written = strlen($data);
-		$this->writePosition += $written;
-
-		$this->buffer .= $data;
-
-		if (strlen($this->buffer) > 64 * 1024) {
-			if (!$this->stream_flush()) {
-				return false;
-			}
-		}
-
-		return $written;
-	}
-
-	public function stream_set_option($option, $arg1, $arg2) {
-		return false;
-	}
-
-	public function stream_truncate($size) {
-		return false;
-	}
-
-	public function stream_stat() {
-		return false;
-	}
-
-	public function stream_lock($operation) {
-		return false;
-	}
-
-	public function stream_flush() {
-		$size = strlen($this->buffer);
-		$packet = pack('Na*N3a*', strlen($this->handle), $this->handle, $this->internalPosition / 4294967296, $this->internalPosition, $size, $this->buffer);
-		if (!$this->sftp->_send_sftp_packet(NET_SFTP_WRITE, $packet)) {
-			return false;
-		}
-		$this->internalPosition += $size;
-		$this->buffer = '';
-
-		return $this->sftp->_read_put_responses(1);
-	}
-
-	public function stream_eof() {
-		return $this->eof;
-	}
-
-	public function stream_close() {
-		$this->stream_flush();
-		if (!$this->sftp->_close_handle($this->handle)) {
-			return false;
-		}
-	}
+    /** @var resource */
+    public $context;
+
+    /** @var \phpseclib\Net\SFTP */
+    private $sftp;
+
+    /** @var resource */
+    private $handle;
+
+    /** @var int */
+    private $internalPosition = 0;
+
+    /** @var int */
+    private $writePosition = 0;
+
+    /** @var bool */
+    private $eof = false;
+
+    private $buffer = '';
+
+    static function register($protocol = 'sftpwrite') {
+        if (in_array($protocol, stream_get_wrappers(), true)) {
+            return false;
+        }
+        return stream_wrapper_register($protocol, get_called_class());
+    }
+
+    /**
+     * Load the source from the stream context and return the context options
+     *
+     * @param string $name
+     * @return array
+     * @throws \BadMethodCallException
+     */
+    protected function loadContext($name) {
+        $context = stream_context_get_options($this->context);
+        if (isset($context[$name])) {
+            $context = $context[$name];
+        } else {
+            throw new \BadMethodCallException('Invalid context, "' . $name . '" options not set');
+        }
+        if (isset($context['session']) and $context['session'] instanceof \phpseclib\Net\SFTP) {
+            $this->sftp = $context['session'];
+        } else {
+            throw new \BadMethodCallException('Invalid context, session not set');
+        }
+        return $context;
+    }
+
+    public function stream_open($path, $mode, $options, &$opened_path) {
+        [, $path] = explode('://', $path);
+        $this->loadContext('sftp');
+
+        if (!($this->sftp->bitmap & SSH2::MASK_LOGIN)) {
+            return false;
+        }
+
+        $remote_file = $this->sftp->_realpath($path);
+        if ($remote_file === false) {
+            return false;
+        }
+
+        $packet = pack('Na*N2', strlen($remote_file), $remote_file, NET_SFTP_OPEN_WRITE | NET_SFTP_OPEN_CREATE | NET_SFTP_OPEN_TRUNCATE, 0);
+        if (!$this->sftp->_send_sftp_packet(NET_SFTP_OPEN, $packet)) {
+            return false;
+        }
+
+        $response = $this->sftp->_get_sftp_packet();
+        switch ($this->sftp->packet_type) {
+            case NET_SFTP_HANDLE:
+                $this->handle = substr($response, 4);
+                break;
+            case NET_SFTP_STATUS: // presumably SSH_FX_NO_SUCH_FILE or SSH_FX_PERMISSION_DENIED
+                $this->sftp->_logError($response);
+                return false;
+            default:
+                user_error('Expected SSH_FXP_HANDLE or SSH_FXP_STATUS');
+                return false;
+        }
+
+        return true;
+    }
+
+    public function stream_seek($offset, $whence = SEEK_SET) {
+        return false;
+    }
+
+    public function stream_tell() {
+        return $this->writePosition;
+    }
+
+    public function stream_read($count) {
+        return false;
+    }
+
+    public function stream_write($data) {
+        $written = strlen($data);
+        $this->writePosition += $written;
+
+        $this->buffer .= $data;
+
+        if (strlen($this->buffer) > 64 * 1024) {
+            if (!$this->stream_flush()) {
+                return false;
+            }
+        }
+
+        return $written;
+    }
+
+    public function stream_set_option($option, $arg1, $arg2) {
+        return false;
+    }
+
+    public function stream_truncate($size) {
+        return false;
+    }
+
+    public function stream_stat() {
+        return false;
+    }
+
+    public function stream_lock($operation) {
+        return false;
+    }
+
+    public function stream_flush() {
+        $size = strlen($this->buffer);
+        $packet = pack('Na*N3a*', strlen($this->handle), $this->handle, $this->internalPosition / 4294967296, $this->internalPosition, $size, $this->buffer);
+        if (!$this->sftp->_send_sftp_packet(NET_SFTP_WRITE, $packet)) {
+            return false;
+        }
+        $this->internalPosition += $size;
+        $this->buffer = '';
+
+        return $this->sftp->_read_put_responses(1);
+    }
+
+    public function stream_eof() {
+        return $this->eof;
+    }
+
+    public function stream_close() {
+        $this->stream_flush();
+        if (!$this->sftp->_close_handle($this->handle)) {
+            return false;
+        }
+    }
 
 }
 

Spacing +1 added lines, -1 removed lines

@@ -64,7 +64,7 @@
 		if (isset($context[$name])) {
 			$context = $context[$name];
 		} else {
-			throw new \BadMethodCallException('Invalid context, "' . $name . '" options not set');
+			throw new \BadMethodCallException('Invalid context, "'.$name.'" options not set');
 		}
 		if (isset($context['session']) and $context['session'] instanceof \phpseclib\Net\SFTP) {
 			$this->sftp = $context['session'];

apps/files_external/lib/Lib/Storage/SFTP.php

Indentation +437 added lines, -437 removed lines

@@ -44,441 +44,441 @@
 * provide access to SFTP servers.
 */
 class SFTP extends \OC\Files\Storage\Common {
-	private $host;
-	private $user;
-	private $root;
-	private $port = 22;
-
-	private $auth = [];
-
-	/**
-	 * @var \phpseclib\Net\SFTP
-	 */
-	protected $client;
-
-	/**
-	 * @param string $host protocol://server:port
-	 * @return array [$server, $port]
-	 */
-	private function splitHost($host) {
-		$input = $host;
-		if (strpos($host, '://') === false) {
-			// add a protocol to fix parse_url behavior with ipv6
-			$host = 'http://' . $host;
-		}
-
-		$parsed = parse_url($host);
-		if(is_array($parsed) && isset($parsed['port'])) {
-			return [$parsed['host'], $parsed['port']];
-		} else if (is_array($parsed)) {
-			return [$parsed['host'], 22];
-		} else {
-			return [$input, 22];
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function __construct($params) {
-		// Register sftp://
-		Stream::register();
-
-		$parsedHost =  $this->splitHost($params['host']);
-
-		$this->host = $parsedHost[0];
-		$this->port = $parsedHost[1];
-
-		if (!isset($params['user'])) {
-			throw new \UnexpectedValueException('no authentication parameters specified');
-		}
-		$this->user = $params['user'];
-
-		if (isset($params['public_key_auth'])) {
-			$this->auth[] = $params['public_key_auth'];
-		}
-		if (isset($params['password']) && $params['password'] !== '') {
-			$this->auth[] = $params['password'];
-		}
-
-		if ($this->auth === []) {
-			throw new \UnexpectedValueException('no authentication parameters specified');
-		}
-
-		$this->root
-			= isset($params['root']) ? $this->cleanPath($params['root']) : '/';
-
-		$this->root = '/' . ltrim($this->root, '/');
-		$this->root = rtrim($this->root, '/') . '/';
-	}
-
-	/**
-	 * Returns the connection.
-	 *
-	 * @return \phpseclib\Net\SFTP connected client instance
-	 * @throws \Exception when the connection failed
-	 */
-	public function getConnection() {
-		if (!is_null($this->client)) {
-			return $this->client;
-		}
-
-		$hostKeys = $this->readHostKeys();
-		$this->client = new \phpseclib\Net\SFTP($this->host, $this->port);
-
-		// The SSH Host Key MUST be verified before login().
-		$currentHostKey = $this->client->getServerPublicHostKey();
-		if (array_key_exists($this->host, $hostKeys)) {
-			if ($hostKeys[$this->host] !== $currentHostKey) {
-				throw new \Exception('Host public key does not match known key');
-			}
-		} else {
-			$hostKeys[$this->host] = $currentHostKey;
-			$this->writeHostKeys($hostKeys);
-		}
-
-		$login = false;
-		foreach ($this->auth as $auth) {
-			$login = $this->client->login($this->user, $auth);
-			if ($login === true) {
-				break;
-			}
-		}
-
-		if ($login === false) {
-			throw new \Exception('Login failed');
-		}
-		return $this->client;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function test() {
-		if (
-			!isset($this->host)
-			|| !isset($this->user)
-		) {
-			return false;
-		}
-		return $this->getConnection()->nlist() !== false;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function getId(){
-		$id = 'sftp::' . $this->user . '@' . $this->host;
-		if ($this->port !== 22) {
-			$id .= ':' . $this->port;
-		}
-		// note: this will double the root slash,
-		// we should not change it to keep compatible with
-		// old storage ids
-		$id .= '/' . $this->root;
-		return $id;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getHost() {
-		return $this->host;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getRoot() {
-		return $this->root;
-	}
-
-	/**
-	 * @return mixed
-	 */
-	public function getUser() {
-		return $this->user;
-	}
-
-	/**
-	 * @param string $path
-	 * @return string
-	 */
-	private function absPath($path) {
-		return $this->root . $this->cleanPath($path);
-	}
-
-	/**
-	 * @return string|false
-	 */
-	private function hostKeysPath() {
-		try {
-			$storage_view = \OCP\Files::getStorage('files_external');
-			if ($storage_view) {
-				return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') .
-					$storage_view->getAbsolutePath('') .
-					'ssh_hostKeys';
-			}
-		} catch (\Exception $e) {
-		}
-		return false;
-	}
-
-	/**
-	 * @param $keys
-	 * @return bool
-	 */
-	protected function writeHostKeys($keys) {
-		try {
-			$keyPath = $this->hostKeysPath();
-			if ($keyPath && file_exists($keyPath)) {
-				$fp = fopen($keyPath, 'w');
-				foreach ($keys as $host => $key) {
-					fwrite($fp, $host . '::' . $key . "\n");
-				}
-				fclose($fp);
-				return true;
-			}
-		} catch (\Exception $e) {
-		}
-		return false;
-	}
-
-	/**
-	 * @return array
-	 */
-	protected function readHostKeys() {
-		try {
-			$keyPath = $this->hostKeysPath();
-			if (file_exists($keyPath)) {
-				$hosts = array();
-				$keys = array();
-				$lines = file($keyPath, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
-				if ($lines) {
-					foreach ($lines as $line) {
-						$hostKeyArray = explode("::", $line, 2);
-						if (count($hostKeyArray) === 2) {
-							$hosts[] = $hostKeyArray[0];
-							$keys[] = $hostKeyArray[1];
-						}
-					}
-					return array_combine($hosts, $keys);
-				}
-			}
-		} catch (\Exception $e) {
-		}
-		return array();
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function mkdir($path) {
-		try {
-			return $this->getConnection()->mkdir($this->absPath($path));
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function rmdir($path) {
-		try {
-			$result = $this->getConnection()->delete($this->absPath($path), true);
-			// workaround: stray stat cache entry when deleting empty folders
-			// see https://github.com/phpseclib/phpseclib/issues/706
-			$this->getConnection()->clearStatCache();
-			return $result;
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function opendir($path) {
-		try {
-			$list = $this->getConnection()->nlist($this->absPath($path));
-			if ($list === false) {
-				return false;
-			}
-
-			$id = md5('sftp:' . $path);
-			$dirStream = array();
-			foreach($list as $file) {
-				if ($file !== '.' && $file !== '..') {
-					$dirStream[] = $file;
-				}
-			}
-			return IteratorDirectory::wrap($dirStream);
-		} catch(\Exception $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function filetype($path) {
-		try {
-			$stat = $this->getConnection()->stat($this->absPath($path));
-			if ((int) $stat['type'] === NET_SFTP_TYPE_REGULAR) {
-				return 'file';
-			}
-
-			if ((int) $stat['type'] === NET_SFTP_TYPE_DIRECTORY) {
-				return 'dir';
-			}
-		} catch (\Exception $e) {
-
-		}
-		return false;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function file_exists($path) {
-		try {
-			return $this->getConnection()->stat($this->absPath($path)) !== false;
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function unlink($path) {
-		try {
-			return $this->getConnection()->delete($this->absPath($path), true);
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function fopen($path, $mode) {
-		try {
-			$absPath = $this->absPath($path);
-			switch($mode) {
-				case 'r':
-				case 'rb':
-					if ( !$this->file_exists($path)) {
-						return false;
-					}
-					SFTPReadStream::register();
-					$context = stream_context_create(['sftp' => ['session' => $this->getConnection()]]);
-					$handle = fopen('sftpread://' . trim($absPath, '/'), 'r', false, $context);
-					return RetryWrapper::wrap($handle);
-				case 'w':
-				case 'wb':
-					SFTPWriteStream::register();
-					$context = stream_context_create(['sftp' => ['session' => $this->getConnection()]]);
-					return fopen('sftpwrite://' . trim($absPath, '/'), 'w', false, $context);
-				case 'a':
-				case 'ab':
-				case 'r+':
-				case 'w+':
-				case 'wb+':
-				case 'a+':
-				case 'x':
-				case 'x+':
-				case 'c':
-				case 'c+':
-					$context = stream_context_create(array('sftp' => array('session' => $this->getConnection())));
-					$handle = fopen($this->constructUrl($path), $mode, false, $context);
-					return RetryWrapper::wrap($handle);
-			}
-		} catch (\Exception $e) {
-		}
-		return false;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function touch($path, $mtime=null) {
-		try {
-			if (!is_null($mtime)) {
-				return false;
-			}
-			if (!$this->file_exists($path)) {
-				$this->getConnection()->put($this->absPath($path), '');
-			} else {
-				return false;
-			}
-		} catch (\Exception $e) {
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	 * @param string $path
-	 * @param string $target
-	 * @throws \Exception
-	 */
-	public function getFile($path, $target) {
-		$this->getConnection()->get($path, $target);
-	}
-
-	/**
-	 * @param string $path
-	 * @param string $target
-	 * @throws \Exception
-	 */
-	public function uploadFile($path, $target) {
-		$this->getConnection()->put($target, $path, NET_SFTP_LOCAL_FILE);
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function rename($source, $target) {
-		try {
-			if ($this->file_exists($target)) {
-				$this->unlink($target);
-			}
-			return $this->getConnection()->rename(
-				$this->absPath($source),
-				$this->absPath($target)
-			);
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function stat($path) {
-		try {
-			$stat = $this->getConnection()->stat($this->absPath($path));
-
-			$mtime = $stat ? $stat['mtime'] : -1;
-			$size = $stat ? $stat['size'] : 0;
-
-			return array('mtime' => $mtime, 'size' => $size, 'ctime' => -1);
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @return string
-	 */
-	public function constructUrl($path) {
-		// Do not pass the password here. We want to use the Net_SFTP object
-		// supplied via stream context or fail. We only supply username and
-		// hostname because this might show up in logs (they are not used).
-		$url = 'sftp://' . urlencode($this->user) . '@' . $this->host . ':' . $this->port . $this->root . $path;
-		return $url;
-	}
+    private $host;
+    private $user;
+    private $root;
+    private $port = 22;
+
+    private $auth = [];
+
+    /**
+     * @var \phpseclib\Net\SFTP
+     */
+    protected $client;
+
+    /**
+     * @param string $host protocol://server:port
+     * @return array [$server, $port]
+     */
+    private function splitHost($host) {
+        $input = $host;
+        if (strpos($host, '://') === false) {
+            // add a protocol to fix parse_url behavior with ipv6
+            $host = 'http://' . $host;
+        }
+
+        $parsed = parse_url($host);
+        if(is_array($parsed) && isset($parsed['port'])) {
+            return [$parsed['host'], $parsed['port']];
+        } else if (is_array($parsed)) {
+            return [$parsed['host'], 22];
+        } else {
+            return [$input, 22];
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __construct($params) {
+        // Register sftp://
+        Stream::register();
+
+        $parsedHost =  $this->splitHost($params['host']);
+
+        $this->host = $parsedHost[0];
+        $this->port = $parsedHost[1];
+
+        if (!isset($params['user'])) {
+            throw new \UnexpectedValueException('no authentication parameters specified');
+        }
+        $this->user = $params['user'];
+
+        if (isset($params['public_key_auth'])) {
+            $this->auth[] = $params['public_key_auth'];
+        }
+        if (isset($params['password']) && $params['password'] !== '') {
+            $this->auth[] = $params['password'];
+        }
+
+        if ($this->auth === []) {
+            throw new \UnexpectedValueException('no authentication parameters specified');
+        }
+
+        $this->root
+            = isset($params['root']) ? $this->cleanPath($params['root']) : '/';
+
+        $this->root = '/' . ltrim($this->root, '/');
+        $this->root = rtrim($this->root, '/') . '/';
+    }
+
+    /**
+     * Returns the connection.
+     *
+     * @return \phpseclib\Net\SFTP connected client instance
+     * @throws \Exception when the connection failed
+     */
+    public function getConnection() {
+        if (!is_null($this->client)) {
+            return $this->client;
+        }
+
+        $hostKeys = $this->readHostKeys();
+        $this->client = new \phpseclib\Net\SFTP($this->host, $this->port);
+
+        // The SSH Host Key MUST be verified before login().
+        $currentHostKey = $this->client->getServerPublicHostKey();
+        if (array_key_exists($this->host, $hostKeys)) {
+            if ($hostKeys[$this->host] !== $currentHostKey) {
+                throw new \Exception('Host public key does not match known key');
+            }
+        } else {
+            $hostKeys[$this->host] = $currentHostKey;
+            $this->writeHostKeys($hostKeys);
+        }
+
+        $login = false;
+        foreach ($this->auth as $auth) {
+            $login = $this->client->login($this->user, $auth);
+            if ($login === true) {
+                break;
+            }
+        }
+
+        if ($login === false) {
+            throw new \Exception('Login failed');
+        }
+        return $this->client;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function test() {
+        if (
+            !isset($this->host)
+            || !isset($this->user)
+        ) {
+            return false;
+        }
+        return $this->getConnection()->nlist() !== false;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getId(){
+        $id = 'sftp::' . $this->user . '@' . $this->host;
+        if ($this->port !== 22) {
+            $id .= ':' . $this->port;
+        }
+        // note: this will double the root slash,
+        // we should not change it to keep compatible with
+        // old storage ids
+        $id .= '/' . $this->root;
+        return $id;
+    }
+
+    /**
+     * @return string
+     */
+    public function getHost() {
+        return $this->host;
+    }
+
+    /**
+     * @return string
+     */
+    public function getRoot() {
+        return $this->root;
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getUser() {
+        return $this->user;
+    }
+
+    /**
+     * @param string $path
+     * @return string
+     */
+    private function absPath($path) {
+        return $this->root . $this->cleanPath($path);
+    }
+
+    /**
+     * @return string|false
+     */
+    private function hostKeysPath() {
+        try {
+            $storage_view = \OCP\Files::getStorage('files_external');
+            if ($storage_view) {
+                return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') .
+                    $storage_view->getAbsolutePath('') .
+                    'ssh_hostKeys';
+            }
+        } catch (\Exception $e) {
+        }
+        return false;
+    }
+
+    /**
+     * @param $keys
+     * @return bool
+     */
+    protected function writeHostKeys($keys) {
+        try {
+            $keyPath = $this->hostKeysPath();
+            if ($keyPath && file_exists($keyPath)) {
+                $fp = fopen($keyPath, 'w');
+                foreach ($keys as $host => $key) {
+                    fwrite($fp, $host . '::' . $key . "\n");
+                }
+                fclose($fp);
+                return true;
+            }
+        } catch (\Exception $e) {
+        }
+        return false;
+    }
+
+    /**
+     * @return array
+     */
+    protected function readHostKeys() {
+        try {
+            $keyPath = $this->hostKeysPath();
+            if (file_exists($keyPath)) {
+                $hosts = array();
+                $keys = array();
+                $lines = file($keyPath, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
+                if ($lines) {
+                    foreach ($lines as $line) {
+                        $hostKeyArray = explode("::", $line, 2);
+                        if (count($hostKeyArray) === 2) {
+                            $hosts[] = $hostKeyArray[0];
+                            $keys[] = $hostKeyArray[1];
+                        }
+                    }
+                    return array_combine($hosts, $keys);
+                }
+            }
+        } catch (\Exception $e) {
+        }
+        return array();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function mkdir($path) {
+        try {
+            return $this->getConnection()->mkdir($this->absPath($path));
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function rmdir($path) {
+        try {
+            $result = $this->getConnection()->delete($this->absPath($path), true);
+            // workaround: stray stat cache entry when deleting empty folders
+            // see https://github.com/phpseclib/phpseclib/issues/706
+            $this->getConnection()->clearStatCache();
+            return $result;
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function opendir($path) {
+        try {
+            $list = $this->getConnection()->nlist($this->absPath($path));
+            if ($list === false) {
+                return false;
+            }
+
+            $id = md5('sftp:' . $path);
+            $dirStream = array();
+            foreach($list as $file) {
+                if ($file !== '.' && $file !== '..') {
+                    $dirStream[] = $file;
+                }
+            }
+            return IteratorDirectory::wrap($dirStream);
+        } catch(\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function filetype($path) {
+        try {
+            $stat = $this->getConnection()->stat($this->absPath($path));
+            if ((int) $stat['type'] === NET_SFTP_TYPE_REGULAR) {
+                return 'file';
+            }
+
+            if ((int) $stat['type'] === NET_SFTP_TYPE_DIRECTORY) {
+                return 'dir';
+            }
+        } catch (\Exception $e) {
+
+        }
+        return false;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function file_exists($path) {
+        try {
+            return $this->getConnection()->stat($this->absPath($path)) !== false;
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function unlink($path) {
+        try {
+            return $this->getConnection()->delete($this->absPath($path), true);
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function fopen($path, $mode) {
+        try {
+            $absPath = $this->absPath($path);
+            switch($mode) {
+                case 'r':
+                case 'rb':
+                    if ( !$this->file_exists($path)) {
+                        return false;
+                    }
+                    SFTPReadStream::register();
+                    $context = stream_context_create(['sftp' => ['session' => $this->getConnection()]]);
+                    $handle = fopen('sftpread://' . trim($absPath, '/'), 'r', false, $context);
+                    return RetryWrapper::wrap($handle);
+                case 'w':
+                case 'wb':
+                    SFTPWriteStream::register();
+                    $context = stream_context_create(['sftp' => ['session' => $this->getConnection()]]);
+                    return fopen('sftpwrite://' . trim($absPath, '/'), 'w', false, $context);
+                case 'a':
+                case 'ab':
+                case 'r+':
+                case 'w+':
+                case 'wb+':
+                case 'a+':
+                case 'x':
+                case 'x+':
+                case 'c':
+                case 'c+':
+                    $context = stream_context_create(array('sftp' => array('session' => $this->getConnection())));
+                    $handle = fopen($this->constructUrl($path), $mode, false, $context);
+                    return RetryWrapper::wrap($handle);
+            }
+        } catch (\Exception $e) {
+        }
+        return false;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function touch($path, $mtime=null) {
+        try {
+            if (!is_null($mtime)) {
+                return false;
+            }
+            if (!$this->file_exists($path)) {
+                $this->getConnection()->put($this->absPath($path), '');
+            } else {
+                return false;
+            }
+        } catch (\Exception $e) {
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * @param string $path
+     * @param string $target
+     * @throws \Exception
+     */
+    public function getFile($path, $target) {
+        $this->getConnection()->get($path, $target);
+    }
+
+    /**
+     * @param string $path
+     * @param string $target
+     * @throws \Exception
+     */
+    public function uploadFile($path, $target) {
+        $this->getConnection()->put($target, $path, NET_SFTP_LOCAL_FILE);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function rename($source, $target) {
+        try {
+            if ($this->file_exists($target)) {
+                $this->unlink($target);
+            }
+            return $this->getConnection()->rename(
+                $this->absPath($source),
+                $this->absPath($target)
+            );
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function stat($path) {
+        try {
+            $stat = $this->getConnection()->stat($this->absPath($path));
+
+            $mtime = $stat ? $stat['mtime'] : -1;
+            $size = $stat ? $stat['size'] : 0;
+
+            return array('mtime' => $mtime, 'size' => $size, 'ctime' => -1);
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * @param string $path
+     * @return string
+     */
+    public function constructUrl($path) {
+        // Do not pass the password here. We want to use the Net_SFTP object
+        // supplied via stream context or fail. We only supply username and
+        // hostname because this might show up in logs (they are not used).
+        $url = 'sftp://' . urlencode($this->user) . '@' . $this->host . ':' . $this->port . $this->root . $path;
+        return $url;
+    }
 }

Spacing +22 added lines, -22 removed lines

@@ -64,11 +64,11 @@ 
 		$input = $host;
 		if (strpos($host, '://') === false) {
 			// add a protocol to fix parse_url behavior with ipv6
-			$host = 'http://' . $host;
+			$host = 'http://'.$host;
 		}
 
 		$parsed = parse_url($host);
-		if(is_array($parsed) && isset($parsed['port'])) {
+		if (is_array($parsed) && isset($parsed['port'])) {
 			return [$parsed['host'], $parsed['port']];
 		} else if (is_array($parsed)) {
 			return [$parsed['host'], 22];
@@ -84,7 +84,7 @@ 
 		// Register sftp://
 		Stream::register();
 
-		$parsedHost =  $this->splitHost($params['host']);
+		$parsedHost = $this->splitHost($params['host']);
 
 		$this->host = $parsedHost[0];
 		$this->port = $parsedHost[1];
@@ -108,8 +108,8 @@ 
 		$this->root
 			= isset($params['root']) ? $this->cleanPath($params['root']) : '/';
 
-		$this->root = '/' . ltrim($this->root, '/');
-		$this->root = rtrim($this->root, '/') . '/';
+		$this->root = '/'.ltrim($this->root, '/');
+		$this->root = rtrim($this->root, '/').'/';
 	}
 
 	/**
@@ -167,15 +167,15 @@ 
 	/**
 	 * {@inheritdoc}
 	 */
-	public function getId(){
-		$id = 'sftp::' . $this->user . '@' . $this->host;
+	public function getId() {
+		$id = 'sftp::'.$this->user.'@'.$this->host;
 		if ($this->port !== 22) {
-			$id .= ':' . $this->port;
+			$id .= ':'.$this->port;
 		}
 		// note: this will double the root slash,
 		// we should not change it to keep compatible with
 		// old storage ids
-		$id .= '/' . $this->root;
+		$id .= '/'.$this->root;
 		return $id;
 	}
 
@@ -205,7 +205,7 @@ 
 	 * @return string
 	 */
 	private function absPath($path) {
-		return $this->root . $this->cleanPath($path);
+		return $this->root.$this->cleanPath($path);
 	}
 
 	/**
@@ -215,8 +215,8 @@ 
 		try {
 			$storage_view = \OCP\Files::getStorage('files_external');
 			if ($storage_view) {
-				return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') .
-					$storage_view->getAbsolutePath('') .
+				return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT.'/data').
+					$storage_view->getAbsolutePath('').
 					'ssh_hostKeys';
 			}
 		} catch (\Exception $e) {
@@ -234,7 +234,7 @@ 
 			if ($keyPath && file_exists($keyPath)) {
 				$fp = fopen($keyPath, 'w');
 				foreach ($keys as $host => $key) {
-					fwrite($fp, $host . '::' . $key . "\n");
+					fwrite($fp, $host.'::'.$key."\n");
 				}
 				fclose($fp);
 				return true;
@@ -306,15 +306,15 @@ 
 				return false;
 			}
 
-			$id = md5('sftp:' . $path);
+			$id = md5('sftp:'.$path);
 			$dirStream = array();
-			foreach($list as $file) {
+			foreach ($list as $file) {
 				if ($file !== '.' && $file !== '..') {
 					$dirStream[] = $file;
 				}
 			}
 			return IteratorDirectory::wrap($dirStream);
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			return false;
 		}
 	}
@@ -366,21 +366,21 @@ 
 	public function fopen($path, $mode) {
 		try {
 			$absPath = $this->absPath($path);
-			switch($mode) {
+			switch ($mode) {
 				case 'r':
 				case 'rb':
-					if ( !$this->file_exists($path)) {
+					if (!$this->file_exists($path)) {
 						return false;
 					}
 					SFTPReadStream::register();
 					$context = stream_context_create(['sftp' => ['session' => $this->getConnection()]]);
-					$handle = fopen('sftpread://' . trim($absPath, '/'), 'r', false, $context);
+					$handle = fopen('sftpread://'.trim($absPath, '/'), 'r', false, $context);
 					return RetryWrapper::wrap($handle);
 				case 'w':
 				case 'wb':
 					SFTPWriteStream::register();
 					$context = stream_context_create(['sftp' => ['session' => $this->getConnection()]]);
-					return fopen('sftpwrite://' . trim($absPath, '/'), 'w', false, $context);
+					return fopen('sftpwrite://'.trim($absPath, '/'), 'w', false, $context);
 				case 'a':
 				case 'ab':
 				case 'r+':
@@ -403,7 +403,7 @@ 
 	/**
 	 * {@inheritdoc}
 	 */
-	public function touch($path, $mtime=null) {
+	public function touch($path, $mtime = null) {
 		try {
 			if (!is_null($mtime)) {
 				return false;
@@ -478,7 +478,7 @@ 
 		// Do not pass the password here. We want to use the Net_SFTP object
 		// supplied via stream context or fail. We only supply username and
 		// hostname because this might show up in logs (they are not used).
-		$url = 'sftp://' . urlencode($this->user) . '@' . $this->host . ':' . $this->port . $this->root . $path;
+		$url = 'sftp://'.urlencode($this->user).'@'.$this->host.':'.$this->port.$this->root.$path;
 		return $url;
 	}
 }