2015-04-13 04:09:02 -05:00
|
|
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
|
2015-03-17 18:56:15 -05:00
|
|
|
/*
|
|
|
|
* This file is part of the LibreOffice project.
|
|
|
|
*
|
|
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef INCLUDED_LOOLWSD_HPP
|
|
|
|
#define INCLUDED_LOOLWSD_HPP
|
|
|
|
|
2018-02-16 10:23:25 -06:00
|
|
|
#include <algorithm>
|
2015-12-27 21:47:39 -06:00
|
|
|
#include <atomic>
|
2019-07-19 05:39:59 -05:00
|
|
|
#include <chrono>
|
2016-12-21 14:37:22 -06:00
|
|
|
#include <map>
|
2017-11-07 07:12:18 -06:00
|
|
|
#include <set>
|
2016-03-08 01:31:29 -06:00
|
|
|
#include <string>
|
2015-03-17 18:56:15 -05:00
|
|
|
|
2015-07-13 09:13:06 -05:00
|
|
|
#include <Poco/Path.h>
|
2016-01-25 19:07:10 -06:00
|
|
|
#include <Poco/Process.h>
|
2017-11-07 07:12:18 -06:00
|
|
|
#include <Poco/Util/AbstractConfiguration.h>
|
2016-03-08 01:31:29 -06:00
|
|
|
#include <Poco/Util/OptionSet.h>
|
|
|
|
#include <Poco/Util/ServerApplication.h>
|
2015-03-17 18:56:15 -05:00
|
|
|
|
2015-12-27 21:47:39 -06:00
|
|
|
#include "Util.hpp"
|
2020-01-17 16:31:41 -06:00
|
|
|
#include "FileUtil.hpp"
|
2015-12-27 21:47:39 -06:00
|
|
|
|
2017-03-04 17:07:17 -06:00
|
|
|
class ChildProcess;
|
2016-08-17 18:57:38 -05:00
|
|
|
class TraceFileWriter;
|
2017-03-30 04:15:28 -05:00
|
|
|
class DocumentBroker;
|
2019-07-04 04:50:33 -05:00
|
|
|
class ClipboardCache;
|
2016-08-17 18:57:38 -05:00
|
|
|
|
2018-09-13 11:16:00 -05:00
|
|
|
std::shared_ptr<ChildProcess> getNewChild_Blocks(
|
2019-02-12 05:16:40 -06:00
|
|
|
#if MOBILEAPP
|
2018-09-13 11:16:00 -05:00
|
|
|
const std::string& uri
|
|
|
|
#endif
|
|
|
|
);
|
2017-03-04 17:07:17 -06:00
|
|
|
|
2016-08-13 23:01:13 -05:00
|
|
|
/// The Server class which is responsible for all
|
|
|
|
/// external interactions.
|
2016-10-29 20:15:00 -05:00
|
|
|
class LOOLWSD : public Poco::Util::ServerApplication
|
2015-03-17 18:56:15 -05:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
LOOLWSD();
|
|
|
|
~LOOLWSD();
|
|
|
|
|
2016-03-10 21:33:03 -06:00
|
|
|
// An Application is a singleton anyway,
|
|
|
|
// so just keep these as statics.
|
2019-09-21 13:15:37 -05:00
|
|
|
static std::atomic<uint64_t> NextConnectionId;
|
2016-04-06 22:51:58 -05:00
|
|
|
static unsigned int NumPreSpawnedChildren;
|
2020-02-28 07:55:42 -06:00
|
|
|
#if !MOBILEAPP
|
2016-08-01 03:05:37 -05:00
|
|
|
static bool NoCapsForKit;
|
2018-03-19 10:20:10 -05:00
|
|
|
static bool NoSeccomp;
|
2018-04-17 14:47:17 -05:00
|
|
|
static bool AdminEnabled;
|
2020-03-04 13:38:17 -06:00
|
|
|
#if ENABLE_DEBUG
|
|
|
|
static bool SingleKit;
|
|
|
|
#endif
|
2020-02-28 07:55:42 -06:00
|
|
|
#endif
|
2017-01-15 11:57:22 -06:00
|
|
|
static std::atomic<int> ForKitWritePipe;
|
2017-01-15 16:54:55 -06:00
|
|
|
static std::atomic<int> ForKitProcId;
|
2017-02-08 05:34:16 -06:00
|
|
|
static bool DummyLOK;
|
2017-02-07 14:00:23 -06:00
|
|
|
static std::string FuzzFileName;
|
2017-01-26 02:19:50 -06:00
|
|
|
static std::string ConfigFile;
|
2017-11-07 07:12:18 -06:00
|
|
|
static std::string ConfigDir;
|
2016-01-15 02:40:54 -06:00
|
|
|
static std::string SysTemplate;
|
|
|
|
static std::string LoTemplate;
|
|
|
|
static std::string ChildRoot;
|
2016-04-14 04:13:30 -05:00
|
|
|
static std::string ServerName;
|
2016-03-20 09:07:24 -05:00
|
|
|
static std::string FileServerRoot;
|
2018-09-06 17:25:50 -05:00
|
|
|
static std::string ServiceRoot; ///< There are installations that need prefixing every page with some path.
|
2016-06-20 13:58:00 -05:00
|
|
|
static std::string LOKitVersion;
|
2019-05-16 15:12:20 -05:00
|
|
|
static std::string HostIdentifier; ///< A unique random hash that identifies this server
|
2018-01-07 21:34:28 -06:00
|
|
|
static std::string LogLevel;
|
2019-04-14 11:24:45 -05:00
|
|
|
static bool AnonymizeUserData;
|
2016-07-13 21:01:23 -05:00
|
|
|
static std::atomic<unsigned> NumConnections;
|
2016-07-31 12:56:57 -05:00
|
|
|
static std::unique_ptr<TraceFileWriter> TraceDumper;
|
2019-08-12 04:04:10 -05:00
|
|
|
#if !MOBILEAPP
|
2019-07-04 04:50:33 -05:00
|
|
|
static std::unique_ptr<ClipboardCache> SavedClipboards;
|
2019-08-12 04:04:10 -05:00
|
|
|
#endif
|
2017-07-17 12:59:46 -05:00
|
|
|
static std::set<std::string> EditFileExtensions;
|
2017-10-03 14:48:28 -05:00
|
|
|
static unsigned MaxConnections;
|
|
|
|
static unsigned MaxDocuments;
|
2017-10-03 22:54:05 -05:00
|
|
|
static std::string OverrideWatermark;
|
2017-11-07 07:12:18 -06:00
|
|
|
static std::set<const Poco::Util::AbstractConfiguration*> PluginConfigurations;
|
2019-07-19 05:39:59 -05:00
|
|
|
static std::chrono::time_point<std::chrono::system_clock> StartTime;
|
2019-12-05 15:27:16 -06:00
|
|
|
#if MOBILEAPP
|
|
|
|
/// This is used to be able to wait until the lokit main thread has finished (and it is safe to load a new document).
|
|
|
|
static std::mutex lokit_main_mutex;
|
|
|
|
#endif
|
2015-04-08 09:22:42 -05:00
|
|
|
|
2020-01-17 15:18:42 -06:00
|
|
|
/// For testing only [!]
|
|
|
|
static int getClientPortNumber();
|
2019-06-21 05:47:07 -05:00
|
|
|
/// For testing only [!]
|
2017-09-19 13:06:46 -05:00
|
|
|
static std::vector<int> getKitPids();
|
2019-06-21 05:47:07 -05:00
|
|
|
/// For testing only [!] DocumentBrokers are mostly single-threaded with their own thread
|
|
|
|
static std::vector<std::shared_ptr<DocumentBroker>> getBrokersTestOnly();
|
2017-09-19 13:06:46 -05:00
|
|
|
|
2019-09-21 13:15:37 -05:00
|
|
|
static std::string GetConnectionId()
|
2015-12-27 21:47:39 -06:00
|
|
|
{
|
2019-09-21 13:15:37 -05:00
|
|
|
return Util::encodeId(NextConnectionId++, 3);
|
2015-12-27 21:47:39 -06:00
|
|
|
}
|
|
|
|
|
2016-10-29 20:15:00 -05:00
|
|
|
static bool isSSLEnabled()
|
2016-07-18 06:45:36 -05:00
|
|
|
{
|
2019-08-20 03:20:22 -05:00
|
|
|
#if ENABLE_SSL
|
2016-07-18 06:45:36 -05:00
|
|
|
return LOOLWSD::SSLEnabled.get();
|
2019-08-20 03:20:22 -05:00
|
|
|
#else
|
|
|
|
return false;
|
|
|
|
#endif
|
2016-07-18 06:45:36 -05:00
|
|
|
}
|
|
|
|
|
2016-10-29 20:15:00 -05:00
|
|
|
static bool isSSLTermination()
|
2016-08-28 14:41:28 -05:00
|
|
|
{
|
2019-08-20 03:20:22 -05:00
|
|
|
#if ENABLE_SSL
|
2016-08-28 14:41:28 -05:00
|
|
|
return LOOLWSD::SSLTermination.get();
|
2019-08-20 03:20:22 -05:00
|
|
|
#else
|
|
|
|
return false;
|
|
|
|
#endif
|
2016-08-28 14:41:28 -05:00
|
|
|
}
|
2017-05-07 12:28:57 -05:00
|
|
|
|
2018-02-16 10:23:25 -06:00
|
|
|
/// Return true iff extension is marked as view action in discovery.xml.
|
2017-06-06 22:43:48 -05:00
|
|
|
static bool IsViewFileExtension(const std::string& extension)
|
|
|
|
{
|
2019-02-13 10:34:59 -06:00
|
|
|
#if MOBILEAPP
|
|
|
|
(void) extension;
|
|
|
|
return false; // mark everything editable on mobile
|
|
|
|
#else
|
2018-02-16 10:23:25 -06:00
|
|
|
std::string lowerCaseExtension = extension;
|
|
|
|
std::transform(lowerCaseExtension.begin(), lowerCaseExtension.end(), lowerCaseExtension.begin(), ::tolower);
|
|
|
|
return EditFileExtensions.find(lowerCaseExtension) == EditFileExtensions.end();
|
2019-02-13 10:34:59 -06:00
|
|
|
#endif
|
2017-06-06 22:43:48 -05:00
|
|
|
}
|
|
|
|
|
2017-05-07 12:28:57 -05:00
|
|
|
/// Returns the value of the specified application configuration,
|
2019-08-26 15:22:01 -05:00
|
|
|
/// or the default, if one doesn't exist.
|
2017-05-07 12:28:57 -05:00
|
|
|
template<typename T>
|
|
|
|
static
|
|
|
|
T getConfigValue(const std::string& name, const T def)
|
|
|
|
{
|
Add an initial libfuzzer based fuzzer
- target ClientSession::_handleInput(), since crashing there would bring
down the whole loolwsd (not just a kit process), and it deals with
input from untrusted users (browsers)
- add a --enable-fuzzers configure switch to build with
-fsanitize=fuzzer (compared to normal sanitizers build, this is the only
special flag needed)
- configuring other sanitizers is not done automatically, either use
--with-sanitizer=... or the environment variables from LODE's sanitizer
config
- run the actual fuzzer like this:
./clientsession_fuzzer -max_len=16384 fuzzer/data/
- note that at least openSUSE Leap 15.1 sadly ships with a clang with
libfuzzer static libs removed from the package, so you need a
self-built clang to run the fuzzer (either manual build or one from
LODE)
- <https://chromium.googlesource.com/chromium/src/testing/libfuzzer/+/refs/heads/master/efficient_fuzzing.md#execution-speed>
suggests that "You should aim for at least 1,000 exec/s from your fuzz
target locally" (i.e. one run should not take more than 1 ms), so try
this minimal approach first. The alternative would be to start from the
existing loolwsd_fuzzer binary, then step by step cut it down to not
fork(), not do any network traffic, etc -- till it's fast enough that
the fuzzer can find interesting input
- the various configurations start to be really complex (the matrix is
just very large), so try to use Util::isFuzzing() for fuzzer-specific
changes (this is what core.git does as well), and only resort to ifdefs
for the Util::isFuzzing() itself
Change-Id: I72dc1193b34c93eacb5d8e39cef42387d42bd72f
Reviewed-on: https://gerrit.libreoffice.org/c/online/+/89226
Tested-by: Jenkins CollaboraOffice <jenkinscollaboraoffice@gmail.com>
Reviewed-by: Michael Meeks <michael.meeks@collabora.com>
2020-02-21 08:52:20 -06:00
|
|
|
if (Util::isFuzzing())
|
|
|
|
{
|
|
|
|
return def;
|
|
|
|
}
|
|
|
|
|
2017-05-07 12:28:57 -05:00
|
|
|
return getConfigValue(Application::instance().config(), name, def);
|
|
|
|
}
|
2016-08-28 14:41:28 -05:00
|
|
|
|
2019-10-07 06:51:30 -05:00
|
|
|
/// Reads and processes path entries with the given property
|
|
|
|
/// from the configuration.
|
|
|
|
/// Converts relative paths to absolute.
|
|
|
|
static
|
|
|
|
std::string getPathFromConfig(const std::string& name)
|
|
|
|
{
|
|
|
|
return getPathFromConfig(Application::instance().config(), name);
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Reads and processes path entries with the given property
|
|
|
|
/// from the configuration. If value is empty then it reads from fallback
|
|
|
|
/// Converts relative paths to absolute.
|
|
|
|
static
|
|
|
|
std::string getPathFromConfigWithFallback(const std::string& name, const std::string& fallbackName)
|
|
|
|
{
|
|
|
|
std::string value = LOOLWSD::getPathFromConfig(name);
|
|
|
|
if (value.empty())
|
|
|
|
return LOOLWSD::getPathFromConfig(fallbackName);
|
|
|
|
return value;
|
|
|
|
}
|
|
|
|
|
2017-02-05 18:35:54 -06:00
|
|
|
/// Trace a new session and take a snapshot of the file.
|
|
|
|
static void dumpNewSessionTrace(const std::string& id, const std::string& sessionId, const std::string& uri, const std::string& path);
|
|
|
|
|
|
|
|
/// Trace the end of a session.
|
|
|
|
static void dumpEndSessionTrace(const std::string& id, const std::string& sessionId, const std::string& uri);
|
|
|
|
|
2017-01-13 06:52:08 -06:00
|
|
|
static void dumpEventTrace(const std::string& id, const std::string& sessionId, const std::string& data);
|
2016-08-02 20:09:01 -05:00
|
|
|
|
2017-01-13 06:52:08 -06:00
|
|
|
static void dumpIncomingTrace(const std::string& id, const std::string& sessionId, const std::string& data);
|
2016-07-30 21:22:28 -05:00
|
|
|
|
2017-01-13 06:52:08 -06:00
|
|
|
static void dumpOutgoingTrace(const std::string& id, const std::string& sessionId, const std::string& data);
|
2016-07-31 06:54:47 -05:00
|
|
|
|
2017-01-15 19:12:10 -06:00
|
|
|
/// Waits on Forkit and reaps if it dies, then restores.
|
|
|
|
/// Return true if wait succeeds.
|
|
|
|
static bool checkAndRestoreForKit();
|
|
|
|
|
2017-01-15 16:54:55 -06:00
|
|
|
/// Creates a new instance of Forkit.
|
|
|
|
/// Return true when successfull.
|
|
|
|
static bool createForKit();
|
|
|
|
|
2017-04-02 18:56:42 -05:00
|
|
|
/// Checks forkit (and respawns), rebalances
|
|
|
|
/// child kit processes and cleans up DocBrokers.
|
|
|
|
static void doHousekeeping();
|
2017-03-27 20:46:16 -05:00
|
|
|
|
2017-07-07 06:42:19 -05:00
|
|
|
/// Close document with @docKey and a @message
|
|
|
|
static void closeDocument(const std::string& docKey, const std::string& message);
|
|
|
|
|
2017-07-10 12:15:04 -05:00
|
|
|
/// Autosave a given document
|
|
|
|
static void autoSave(const std::string& docKey);
|
|
|
|
|
2018-06-10 10:35:59 -05:00
|
|
|
/// Anonymize the basename of filenames, preserving the path and extension.
|
|
|
|
static std::string anonymizeUrl(const std::string& url)
|
|
|
|
{
|
2020-01-17 16:31:41 -06:00
|
|
|
return FileUtil::anonymizeUrl(url);
|
2018-06-10 10:35:59 -05:00
|
|
|
}
|
|
|
|
|
2018-07-08 21:50:09 -05:00
|
|
|
/// Anonymize user names and IDs.
|
|
|
|
/// Will use the Obfuscated User ID if one is provied via WOPI.
|
2018-06-10 10:35:59 -05:00
|
|
|
static std::string anonymizeUsername(const std::string& username)
|
|
|
|
{
|
2020-01-17 16:31:41 -06:00
|
|
|
return FileUtil::anonymizeUsername(username);
|
2018-06-10 10:35:59 -05:00
|
|
|
}
|
|
|
|
|
2019-02-13 11:01:08 -06:00
|
|
|
/// get correct server URL with protocol + port number for this running server
|
|
|
|
static std::string getServerURL();
|
|
|
|
|
2019-05-16 15:12:20 -05:00
|
|
|
static std::string getVersionJSON();
|
|
|
|
|
2018-09-13 11:16:00 -05:00
|
|
|
int innerMain();
|
|
|
|
|
2015-03-17 18:56:15 -05:00
|
|
|
protected:
|
|
|
|
void initialize(Poco::Util::Application& self) override;
|
|
|
|
void defineOptions(Poco::Util::OptionSet& options) override;
|
|
|
|
void handleOption(const std::string& name, const std::string& value) override;
|
|
|
|
int main(const std::vector<std::string>& args) override;
|
|
|
|
|
2017-03-27 14:14:16 -05:00
|
|
|
/// Handle various global static destructors.
|
|
|
|
void cleanup();
|
|
|
|
|
2015-03-17 18:56:15 -05:00
|
|
|
private:
|
2019-08-20 03:20:22 -05:00
|
|
|
#if ENABLE_SSL
|
2016-07-19 04:07:07 -05:00
|
|
|
static Util::RuntimeConstant<bool> SSLEnabled;
|
2016-08-28 14:41:28 -05:00
|
|
|
static Util::RuntimeConstant<bool> SSLTermination;
|
2019-08-20 03:20:22 -05:00
|
|
|
#endif
|
2016-07-18 06:45:36 -05:00
|
|
|
|
2016-03-23 06:08:01 -05:00
|
|
|
void initializeSSL();
|
2015-03-17 18:56:15 -05:00
|
|
|
void displayHelp();
|
2016-04-06 17:17:59 -05:00
|
|
|
|
2016-07-18 06:45:36 -05:00
|
|
|
class ConfigValueGetter
|
|
|
|
{
|
2016-07-28 01:39:03 -05:00
|
|
|
Poco::Util::LayeredConfiguration& _config;
|
|
|
|
const std::string& _name;
|
2016-07-18 06:45:36 -05:00
|
|
|
|
|
|
|
public:
|
|
|
|
ConfigValueGetter(Poco::Util::LayeredConfiguration& config,
|
|
|
|
const std::string& name)
|
2016-07-28 01:39:03 -05:00
|
|
|
: _config(config)
|
|
|
|
, _name(name)
|
2016-10-29 20:15:00 -05:00
|
|
|
{
|
|
|
|
}
|
2016-07-18 06:45:36 -05:00
|
|
|
|
2017-01-28 16:25:14 -06:00
|
|
|
void operator()(int& value) { value = _config.getInt(_name); }
|
2016-07-28 01:39:03 -05:00
|
|
|
void operator()(unsigned int& value) { value = _config.getUInt(_name); }
|
2019-11-22 09:50:49 -06:00
|
|
|
void operator()(uint64_t& value) { value = _config.getUInt64(_name); }
|
2016-07-28 01:39:03 -05:00
|
|
|
void operator()(bool& value) { value = _config.getBool(_name); }
|
2016-07-30 21:19:31 -05:00
|
|
|
void operator()(std::string& value) { value = _config.getString(_name); }
|
2017-07-07 06:42:19 -05:00
|
|
|
void operator()(double& value) { value = _config.getDouble(_name); }
|
2016-07-18 06:45:36 -05:00
|
|
|
};
|
|
|
|
|
2016-10-29 20:15:00 -05:00
|
|
|
template <typename T>
|
|
|
|
static bool getSafeConfig(Poco::Util::LayeredConfiguration& config,
|
|
|
|
const std::string& name, T& value)
|
2016-06-25 11:31:22 -05:00
|
|
|
{
|
|
|
|
try
|
|
|
|
{
|
2016-07-18 06:45:36 -05:00
|
|
|
ConfigValueGetter(config, name)(value);
|
2016-06-25 11:31:22 -05:00
|
|
|
return true;
|
|
|
|
}
|
2020-02-28 07:58:32 -06:00
|
|
|
catch (...)
|
2016-06-25 11:31:22 -05:00
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2016-07-18 06:45:36 -05:00
|
|
|
template<typename T>
|
2016-06-25 11:31:22 -05:00
|
|
|
static
|
2016-07-18 06:45:36 -05:00
|
|
|
T getConfigValue(Poco::Util::LayeredConfiguration& config,
|
|
|
|
const std::string& name, const T def)
|
2016-06-25 11:31:22 -05:00
|
|
|
{
|
2016-07-18 06:45:36 -05:00
|
|
|
T value = def;
|
|
|
|
if (getSafeConfig(config, name, value) ||
|
|
|
|
getSafeConfig(config, name + "[@default]", value))
|
2016-06-25 11:31:22 -05:00
|
|
|
{
|
|
|
|
return value;
|
|
|
|
}
|
|
|
|
|
|
|
|
return def;
|
|
|
|
}
|
|
|
|
|
2016-04-06 17:17:59 -05:00
|
|
|
/// Reads and processes path entries with the given property
|
|
|
|
/// from the configuration.
|
|
|
|
/// Converts relative paths to absolute.
|
2019-10-07 06:51:30 -05:00
|
|
|
static
|
|
|
|
std::string getPathFromConfig(Poco::Util::LayeredConfiguration& config, const std::string& property)
|
2016-04-06 17:17:59 -05:00
|
|
|
{
|
2019-10-07 06:51:30 -05:00
|
|
|
std::string path = config.getString(property);
|
|
|
|
if (path.empty() && config.hasProperty(property + "[@default]"))
|
2016-04-06 22:51:58 -05:00
|
|
|
{
|
|
|
|
// Use the default value if empty and a default provided.
|
2019-10-07 06:51:30 -05:00
|
|
|
path = config.getString(property + "[@default]");
|
2016-04-06 22:51:58 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// Reconstruct absolute path if relative.
|
2016-06-25 17:03:41 -05:00
|
|
|
if (!Poco::Path(path).isAbsolute() &&
|
2019-10-07 06:51:30 -05:00
|
|
|
config.hasProperty(property + "[@relative]") &&
|
|
|
|
config.getBool(property + "[@relative]"))
|
2016-04-06 17:17:59 -05:00
|
|
|
{
|
|
|
|
path = Poco::Path(Application::instance().commandPath()).parent().append(path).toString();
|
|
|
|
}
|
|
|
|
|
|
|
|
return path;
|
|
|
|
}
|
2016-06-25 11:31:22 -05:00
|
|
|
|
|
|
|
private:
|
|
|
|
/// Settings passed from the command-line to override those in the config file.
|
|
|
|
std::map<std::string, std::string> _overrideSettings;
|
2018-09-13 11:16:00 -05:00
|
|
|
|
2019-02-12 05:16:40 -06:00
|
|
|
#if MOBILEAPP
|
2018-09-13 11:16:00 -05:00
|
|
|
public:
|
|
|
|
static int prisonerServerSocketFD;
|
|
|
|
#endif
|
2015-03-17 18:56:15 -05:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|