nextcloud / server

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

Indentation +427 added lines, -427 removed lines

@@ -46,431 +46,431 @@
  * 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']];
-		} elseif (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 = [];
-				$keys = [];
-				$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 [];
-	}
-
-	/**
-	 * {@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 = [];
-			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(['sftp' => ['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);
-	}
-
-	/**
-	 * {@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 ['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']];
+        } elseif (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 = [];
+                $keys = [];
+                $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 [];
+    }
+
+    /**
+     * {@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 = [];
+            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(['sftp' => ['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);
+    }
+
+    /**
+     * {@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 ['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;
+    }
 }