265 lines
12 KiB
C++
265 lines
12 KiB
C++
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
|
||
|
|
/*
|
||
|
|
* Copyright the Collabora Online contributors.
|
||
|
|
*
|
||
|
|
* SPDX-License-Identifier: MPL-2.0
|
||
|
|
*
|
||
|
|
* 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/.
|
||
|
|
*/
|
||
|
|
|
||
|
|
#include <config.h>
|
||
|
|
|
||
|
|
#include <RequestVettingStation.hpp>
|
||
|
|
|
||
|
|
#include <COOLWSD.hpp>
|
||
|
|
#include <TraceEvent.hpp>
|
||
|
|
#include <StorageConnectionManager.hpp>
|
||
|
|
#include <Exceptions.hpp>
|
||
|
|
#include <Log.hpp>
|
||
|
|
#include <DocumentBroker.hpp>
|
||
|
|
#include <ClientSession.hpp>
|
||
|
|
#include <common/JsonUtil.hpp>
|
||
|
|
#include <Util.hpp>
|
||
|
|
|
||
|
|
extern std::shared_ptr<DocumentBroker>
|
||
|
|
findOrCreateDocBroker(const std::shared_ptr<ProtocolHandlerInterface>& proto,
|
||
|
|
DocumentBroker::ChildType type, const std::string& uri,
|
||
|
|
const std::string& docKey, const std::string& id, const Poco::URI& uriPublic,
|
||
|
|
unsigned mobileAppDocId = 0);
|
||
|
|
namespace
|
||
|
|
{
|
||
|
|
void sendLoadResult(const std::shared_ptr<ClientSession>& clientSession, bool success,
|
||
|
|
const std::string& errorMsg)
|
||
|
|
{
|
||
|
|
const std::string result = success ? "" : "Error while loading document";
|
||
|
|
const std::string resultstr = success ? "true" : "false";
|
||
|
|
// Some sane limit, otherwise we get problems transferring this
|
||
|
|
// to the client with large strings (can be a whole webpage)
|
||
|
|
// Replace reserved characters
|
||
|
|
std::string errorMsgFormatted = COOLProtocol::getAbbreviatedMessage(errorMsg);
|
||
|
|
errorMsgFormatted = Poco::translate(errorMsg, "\"", "'");
|
||
|
|
clientSession->sendMessage("commandresult: { \"command\": \"load\", \"success\": " + resultstr +
|
||
|
|
", \"result\": \"" + result + "\", \"errorMsg\": \"" +
|
||
|
|
errorMsgFormatted + "\"}");
|
||
|
|
}
|
||
|
|
|
||
|
|
} // anonymous namespace
|
||
|
|
|
||
|
|
void RequestVettingStation::handleRequest(SocketPoll& poll)
|
||
|
|
{
|
||
|
|
const std::string url = _requestDetails.getDocumentURI();
|
||
|
|
|
||
|
|
LOG_INF("URL [" << url << "] for WS Request.");
|
||
|
|
const auto uriPublic = RequestDetails::sanitizeURI(url);
|
||
|
|
const auto docKey = RequestDetails::getDocKey(uriPublic);
|
||
|
|
const std::string fileId = Util::getFilenameFromURL(docKey);
|
||
|
|
Util::mapAnonymized(fileId, fileId); // Identity mapping, since fileId is already obfuscated
|
||
|
|
|
||
|
|
LOG_INF("Starting GET request handler for session [" << _id << "] on url ["
|
||
|
|
<< COOLWSD::anonymizeUrl(url) << ']');
|
||
|
|
|
||
|
|
// Indicate to the client that document broker is searching.
|
||
|
|
static const std::string status("statusindicator: find");
|
||
|
|
LOG_TRC("Sending to Client [" << status << ']');
|
||
|
|
_ws->sendMessage(status);
|
||
|
|
|
||
|
|
LOG_INF("Sanitized URI [" << COOLWSD::anonymizeUrl(url) << "] to ["
|
||
|
|
<< COOLWSD::anonymizeUrl(uriPublic.toString())
|
||
|
|
<< "] and mapped to docKey [" << docKey << "] for session [" << _id
|
||
|
|
<< ']');
|
||
|
|
|
||
|
|
// Check if readonly session is required
|
||
|
|
bool isReadOnly = false;
|
||
|
|
for (const auto& param : uriPublic.getQueryParameters())
|
||
|
|
{
|
||
|
|
LOG_TRC("Query param: " << param.first << ", value: " << param.second);
|
||
|
|
if (param.first == "permission" && param.second == "readonly")
|
||
|
|
{
|
||
|
|
isReadOnly = true;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
LOG_INF("URL [" << COOLWSD::anonymizeUrl(url) << "] is "
|
||
|
|
<< (isReadOnly ? "readonly" : "writable"));
|
||
|
|
|
||
|
|
// Before we create DocBroker with a SocketPoll thread, a ClientSession, and a Kit process,
|
||
|
|
// we need to vet this request by invoking CheckFileInfo.
|
||
|
|
// For that, we need the storage settings to create a connection.
|
||
|
|
const StorageBase::StorageType storageType =
|
||
|
|
StorageBase::validate(uriPublic, /*takeOwnership=*/false);
|
||
|
|
switch (storageType)
|
||
|
|
{
|
||
|
|
case StorageBase::StorageType::Unsupported:
|
||
|
|
LOG_ERR("Unsupported URI [" << COOLWSD::anonymizeUrl(uriPublic.toString())
|
||
|
|
<< "] or no storage configured");
|
||
|
|
throw BadRequestException("No Storage configured or invalid URI " +
|
||
|
|
COOLWSD::anonymizeUrl(uriPublic.toString()) + ']');
|
||
|
|
|
||
|
|
break;
|
||
|
|
case StorageBase::StorageType::Unauthorized:
|
||
|
|
LOG_ERR("No acceptable WOPI hosts found matching the target host ["
|
||
|
|
<< uriPublic.getHost() << "] in config");
|
||
|
|
throw UnauthorizedRequestException(
|
||
|
|
"No acceptable WOPI hosts found matching the target host [" + uriPublic.getHost() +
|
||
|
|
"] in config");
|
||
|
|
break;
|
||
|
|
case StorageBase::StorageType::FileSystem:
|
||
|
|
break;
|
||
|
|
case StorageBase::StorageType::Wopi:
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
ProfileZone profileZone("WopiStorage::getWOPIFileInfo", { { "url", url } });
|
||
|
|
|
||
|
|
Poco::URI uriObject(uriPublic);
|
||
|
|
const std::string uriAnonym = COOLWSD::anonymizeUrl(uriObject.toString());
|
||
|
|
|
||
|
|
LOG_DBG("Getting info for wopi uri [" << uriAnonym << ']');
|
||
|
|
_httpSession = StorageConnectionManager::getHttpSession(uriObject);
|
||
|
|
Authorization auth = Authorization::create(uriPublic);
|
||
|
|
http::Request httpRequest = StorageConnectionManager::createHttpRequest(uriObject, auth);
|
||
|
|
|
||
|
|
const auto startTime = std::chrono::steady_clock::now();
|
||
|
|
|
||
|
|
LOG_TRC("WOPI::CheckFileInfo request header for URI [" << uriAnonym << "]:\n"
|
||
|
|
<< httpRequest.header());
|
||
|
|
|
||
|
|
http::Session::FinishedCallback finishedCallback =
|
||
|
|
[this, docKey, startTime, url, uriObject, uriPublic, isReadOnly,
|
||
|
|
uriAnonym](const std::shared_ptr<http::Session>& session)
|
||
|
|
{
|
||
|
|
const std::shared_ptr<const http::Response> httpResponse = session->response();
|
||
|
|
|
||
|
|
std::chrono::milliseconds callDurationMs =
|
||
|
|
std::chrono::duration_cast<std::chrono::milliseconds>(std::chrono::steady_clock::now() -
|
||
|
|
startTime);
|
||
|
|
|
||
|
|
// Note: we don't log the response if obfuscation is enabled, except for failures.
|
||
|
|
std::string wopiResponse = httpResponse->getBody();
|
||
|
|
const bool failed = (httpResponse->statusLine().statusCode() != http::StatusCode::OK);
|
||
|
|
|
||
|
|
Log::StreamLogger logRes = failed ? Log::error() : Log::trace();
|
||
|
|
if (logRes.enabled())
|
||
|
|
{
|
||
|
|
logRes << "WOPI::CheckFileInfo " << (failed ? "failed" : "returned") << " for URI ["
|
||
|
|
<< uriAnonym << "]: " << httpResponse->statusLine().statusCode() << ' '
|
||
|
|
<< httpResponse->statusLine().reasonPhrase()
|
||
|
|
<< ". Headers: " << httpResponse->header()
|
||
|
|
<< (failed ? "\tBody: [" + wopiResponse + ']' : std::string());
|
||
|
|
|
||
|
|
LOG_END_FLUSH(logRes);
|
||
|
|
}
|
||
|
|
|
||
|
|
if (failed)
|
||
|
|
{
|
||
|
|
if (httpResponse->statusLine().statusCode() == http::StatusCode::Forbidden)
|
||
|
|
throw UnauthorizedRequestException(
|
||
|
|
"Access denied, 403. WOPI::CheckFileInfo failed on: " + uriAnonym);
|
||
|
|
|
||
|
|
throw StorageConnectionException("WOPI::CheckFileInfo failed: " + wopiResponse);
|
||
|
|
}
|
||
|
|
|
||
|
|
Poco::JSON::Object::Ptr object;
|
||
|
|
if (!JsonUtil::parseJSON(wopiResponse, object))
|
||
|
|
{
|
||
|
|
if (COOLWSD::AnonymizeUserData)
|
||
|
|
wopiResponse = "obfuscated";
|
||
|
|
|
||
|
|
LOG_ERR("WOPI::CheckFileInfo ("
|
||
|
|
<< callDurationMs
|
||
|
|
<< ") failed or no valid JSON payload returned. Access denied. "
|
||
|
|
"Original response: ["
|
||
|
|
<< wopiResponse << ']');
|
||
|
|
|
||
|
|
throw UnauthorizedRequestException("Access denied. WOPI::CheckFileInfo failed on: " +
|
||
|
|
uriAnonym);
|
||
|
|
}
|
||
|
|
|
||
|
|
// Request a kit process for this doc.
|
||
|
|
std::shared_ptr<DocumentBroker> docBroker = findOrCreateDocBroker(
|
||
|
|
std::static_pointer_cast<ProtocolHandlerInterface>(_ws),
|
||
|
|
DocumentBroker::ChildType::Interactive, url, docKey, _id, uriPublic, _mobileAppDocId);
|
||
|
|
if (!docBroker)
|
||
|
|
{
|
||
|
|
throw ServiceUnavailableException("Failed to create DocBroker with docKey [" + docKey +
|
||
|
|
']');
|
||
|
|
}
|
||
|
|
|
||
|
|
LOG_DBG("DocBroker [" << docKey << "] acquired for [" << url << ']');
|
||
|
|
std::shared_ptr<ClientSession> clientSession =
|
||
|
|
docBroker->createNewClientSession(_ws, _id, uriPublic, isReadOnly, _requestDetails);
|
||
|
|
if (!clientSession)
|
||
|
|
{
|
||
|
|
LOG_WRN("Failed to create Client Session with id [" << _id << "] on docKey [" << docKey
|
||
|
|
<< ']');
|
||
|
|
throw std::runtime_error("Cannot create client session for doc " + docKey);
|
||
|
|
}
|
||
|
|
|
||
|
|
LOG_DBG("ClientSession [" << clientSession->getName() << "] for [" << docKey
|
||
|
|
<< "] acquired for [" << url << ']');
|
||
|
|
|
||
|
|
// Transfer the client socket to the DocumentBroker when we get back to the poll:
|
||
|
|
docBroker->setupTransfer(
|
||
|
|
_socket,
|
||
|
|
[docBroker, clientSession, this](const std::shared_ptr<Socket>& moveSocket)
|
||
|
|
{
|
||
|
|
try
|
||
|
|
{
|
||
|
|
LOG_DBG_S("Transfering docBroker [" << docBroker->getDocKey() << ']');
|
||
|
|
|
||
|
|
auto streamSocket = std::static_pointer_cast<StreamSocket>(moveSocket);
|
||
|
|
|
||
|
|
// Set WebSocketHandler's socket after its construction for shared_ptr goodness.
|
||
|
|
streamSocket->setHandler(_ws);
|
||
|
|
|
||
|
|
LOG_DBG_S('#' << moveSocket->getFD() << " handler is "
|
||
|
|
<< clientSession->getName());
|
||
|
|
|
||
|
|
// Add and load the session.
|
||
|
|
docBroker->addSession(clientSession);
|
||
|
|
|
||
|
|
COOLWSD::checkDiskSpaceAndWarnClients(true);
|
||
|
|
// Users of development versions get just an info
|
||
|
|
// when reaching max documents or connections
|
||
|
|
COOLWSD::checkSessionLimitsAndWarnClients();
|
||
|
|
|
||
|
|
sendLoadResult(clientSession, true, "");
|
||
|
|
}
|
||
|
|
catch (const UnauthorizedRequestException& exc)
|
||
|
|
{
|
||
|
|
LOG_ERR_S("Unauthorized Request while starting session on "
|
||
|
|
<< docBroker->getDocKey() << " for socket #" << moveSocket->getFD()
|
||
|
|
<< ". Terminating connection. Error: " << exc.what());
|
||
|
|
const std::string msg = "error: cmd=internal kind=unauthorized";
|
||
|
|
_ws->shutdown(WebSocketHandler::StatusCodes::POLICY_VIOLATION, msg);
|
||
|
|
moveSocket->ignoreInput();
|
||
|
|
}
|
||
|
|
catch (const StorageConnectionException& exc)
|
||
|
|
{
|
||
|
|
LOG_ERR_S("Storage error while starting session on "
|
||
|
|
<< docBroker->getDocKey() << " for socket #" << moveSocket->getFD()
|
||
|
|
<< ". Terminating connection. Error: " << exc.what());
|
||
|
|
const std::string msg = "error: cmd=storage kind=loadfailed";
|
||
|
|
_ws->shutdown(WebSocketHandler::StatusCodes::POLICY_VIOLATION, msg);
|
||
|
|
moveSocket->ignoreInput();
|
||
|
|
}
|
||
|
|
catch (const std::exception& exc)
|
||
|
|
{
|
||
|
|
LOG_ERR_S("Error while starting session on "
|
||
|
|
<< docBroker->getDocKey() << " for socket #" << moveSocket->getFD()
|
||
|
|
<< ". Terminating connection. Error: " << exc.what());
|
||
|
|
const std::string msg = "error: cmd=storage kind=loadfailed";
|
||
|
|
_ws->shutdown(WebSocketHandler::StatusCodes::POLICY_VIOLATION, msg);
|
||
|
|
moveSocket->ignoreInput();
|
||
|
|
}
|
||
|
|
});
|
||
|
|
};
|
||
|
|
|
||
|
|
_httpSession->setFinishedHandler(finishedCallback);
|
||
|
|
|
||
|
|
// Run the CheckFileInfo request on the WebServer Poll.
|
||
|
|
_httpSession->asyncRequest(httpRequest, poll);
|
||
|
|
}
|