forked from CollaboraOnline/online
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathStorage.cpp
1537 lines (1312 loc) · 59.9 KB
/
Storage.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
* 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 <chrono>
#include <config.h>
#include "HttpRequest.hpp"
#include "Storage.hpp"
#include <algorithm>
#include <memory>
#include <cassert>
#include <errno.h>
#include <fstream>
#include <iconv.h>
#include <string>
#include <Poco/Exception.h>
#include <Poco/JSON/Object.h>
#include <Poco/JSON/Parser.h>
#if !MOBILEAPP
#include <Poco/Net/AcceptCertificateHandler.h>
#include <Poco/Net/Context.h>
#include <Poco/Net/DNS.h>
#include <Poco/Net/HTTPClientSession.h>
#include <Poco/Net/HTTPRequest.h>
#include <Poco/Net/HTTPResponse.h>
#include <Poco/Net/HTTPSClientSession.h>
#include <Poco/Net/KeyConsoleHandler.h>
#include <Poco/Net/NameValueCollection.h>
#include <Poco/Net/SSLManager.h>
#endif
#include <Poco/StreamCopier.h>
#include <Poco/URI.h>
#include "Auth.hpp"
#include <Common.hpp>
#include "Exceptions.hpp"
#include <Log.hpp>
#include <Unit.hpp>
#include <Util.hpp>
#include "ProofKey.hpp"
#include <common/FileUtil.hpp>
#include <common/JsonUtil.hpp>
#include <common/TraceEvent.hpp>
#include <NetUtil.hpp>
#include <CommandControl.hpp>
#include "HostUtil.hpp"
#ifdef IOS
#include <ios.h>
#elif defined(__ANDROID__)
#include "androidapp.hpp"
#elif defined(GTKAPP)
#include "gtk.hpp"
#elif defined(__EMSCRIPTEN__)
#include "wasmapp.hpp"
#endif
bool StorageBase::FilesystemEnabled;
bool StorageBase::SSLAsScheme = true;
bool StorageBase::SSLEnabled = false;
#if !MOBILEAPP
std::string StorageBase::getLocalRootPath() const
{
std::string localPath = _jailPath;
if (localPath[0] == '/')
{
// Remove the leading /
localPath.erase(0, 1);
}
// /chroot/jailId/user/doc/childId
const Poco::Path rootPath = Poco::Path(_localStorePath, localPath);
Poco::File(rootPath).createDirectories();
return rootPath.toString();
}
#endif
void StorageBase::initialize()
{
#if !MOBILEAPP
const auto& app = Poco::Util::Application::instance();
FilesystemEnabled = app.config().getBool("storage.filesystem[@allow]", false);
//parse wopi.storage.host only when there is no storage.wopi.alias_groups entry in config
if (!app.config().has("storage.wopi.alias_groups"))
{
HostUtil::parseWopiHost(app.config());
}
#if ENABLE_FEATURE_LOCK
CommandControl::LockManager::parseLockedHost(app.config());
#endif
HostUtil::parseAliases(app.config());
#if ENABLE_SSL
// FIXME: should use our own SSL socket implementation here.
Poco::Crypto::initializeCrypto();
Poco::Net::initializeSSL();
// Init client
Poco::Net::Context::Params sslClientParams;
// false default for upgrade to preserve legacy configuration
// in-config-file defaults are true.
SSLAsScheme = COOLWSD::getConfigValue<bool>("storage.ssl.as_scheme", false);
// Fallback to ssl.enable if not set - for back compatibility & simplicity.
SSLEnabled = COOLWSD::getConfigValue<bool>(
"storage.ssl.enable", COOLWSD::getConfigValue<bool>("ssl.enable", true));
#if ENABLE_DEBUG
char *StorageSSLEnabled = getenv("STORAGE_SSL_ENABLE");
if (StorageSSLEnabled != NULL)
{
if (!strcasecmp(StorageSSLEnabled, "true"))
SSLEnabled = true;
else if (!strcasecmp(StorageSSLEnabled, "false"))
SSLEnabled = false;
}
#endif
if (SSLEnabled)
{
sslClientParams.certificateFile = COOLWSD::getPathFromConfigWithFallback("storage.ssl.cert_file_path", "ssl.cert_file_path");
sslClientParams.privateKeyFile = COOLWSD::getPathFromConfigWithFallback("storage.ssl.key_file_path", "ssl.key_file_path");
sslClientParams.caLocation = COOLWSD::getPathFromConfigWithFallback("storage.ssl.ca_file_path", "ssl.ca_file_path");
sslClientParams.cipherList = COOLWSD::getPathFromConfigWithFallback("storage.ssl.cipher_list", "ssl.cipher_list");
sslClientParams.verificationMode = (sslClientParams.caLocation.empty() ? Poco::Net::Context::VERIFY_NONE : Poco::Net::Context::VERIFY_STRICT);
sslClientParams.loadDefaultCAs = true;
}
else
sslClientParams.verificationMode = Poco::Net::Context::VERIFY_NONE;
Poco::SharedPtr<Poco::Net::PrivateKeyPassphraseHandler> consoleClientHandler = new Poco::Net::KeyConsoleHandler(false);
Poco::SharedPtr<Poco::Net::InvalidCertificateHandler> invalidClientCertHandler = new Poco::Net::AcceptCertificateHandler(false);
Poco::Net::Context::Ptr sslClientContext = new Poco::Net::Context(Poco::Net::Context::CLIENT_USE, sslClientParams);
sslClientContext->disableProtocols(Poco::Net::Context::Protocols::PROTO_SSLV2 |
Poco::Net::Context::Protocols::PROTO_SSLV3 |
Poco::Net::Context::Protocols::PROTO_TLSV1);
Poco::Net::SSLManager::instance().initializeClient(consoleClientHandler, invalidClientCertHandler, sslClientContext);
// Initialize our client SSL context.
ssl::Manager::initializeClientContext(
sslClientParams.certificateFile, sslClientParams.privateKeyFile, sslClientParams.caLocation,
sslClientParams.cipherList,
sslClientParams.caLocation.empty() ? ssl::CertificateVerification::Disabled
: ssl::CertificateVerification::Required);
if (!ssl::Manager::isClientContextInitialized())
LOG_ERR("Failed to initialize Client SSL.");
else
LOG_INF("Initialized Client SSL.");
#endif
#else
FilesystemEnabled = true;
#endif
}
#if !MOBILEAPP
bool isLocalhost(const std::string& targetHost)
{
const std::string targetAddress = net::resolveHostAddress(targetHost);
if (net::isLocalhost(targetHost))
{
LOG_INF("WOPI host [" << targetHost << "] is on the same host as the WOPI client: \""
<< targetAddress << "\". Connection is allowed.");
return true;
}
LOG_INF("WOPI host [" << targetHost << "] is not on the same host as the WOPI client: \""
<< targetAddress << "\". Connection is not allowed.");
return false;
}
#endif
bool isTemplate(const std::string& filename)
{
std::vector<std::string> templateExtensions {".stw", ".ott", ".dot", ".dotx", ".dotm", ".otm", ".stc", ".ots", ".xltx", ".xltm", ".sti", ".otp", ".potx", ".potm", ".std", ".otg"};
for (auto & extension : templateExtensions)
if (Util::endsWith(filename, extension))
return true;
return false;
}
std::unique_ptr<StorageBase> StorageBase::create(const Poco::URI& uri, const std::string& jailRoot,
const std::string& jailPath, bool takeOwnership)
{
// FIXME: By the time this gets called we have already sent to the client three
// 'statusindicator:' messages: 'find', 'connect' and 'ready'. We should ideally do the checks
// here much earlier. Also, using exceptions is lame and makes understanding the code harder,
// but that is just my personal preference.
std::unique_ptr<StorageBase> storage;
if (UnitWSD::get().createStorage(uri, jailRoot, jailPath, storage))
{
LOG_INF("Storage create hooked.");
if (storage)
{
return storage;
}
}
else if (uri.isRelative() || uri.getScheme() == "file")
{
LOG_INF("Public URI [" << COOLWSD::anonymizeUrl(uri.toString()) << "] is a file.");
#if ENABLE_DEBUG
if (std::getenv("FAKE_UNAUTHORIZED"))
{
LOG_FTL("Faking an UnauthorizedRequestException");
throw UnauthorizedRequestException("No acceptable WOPI hosts found matching the target host in config.");
}
#endif
if (FilesystemEnabled || takeOwnership)
{
return std::unique_ptr<StorageBase>(
new LocalStorage(uri, jailRoot, jailPath, takeOwnership));
}
LOG_ERR("Local Storage is disabled by default. Enable in the config file or on the command-line to enable.");
}
#if !MOBILEAPP
else if (HostUtil::isWopiEnabled())
{
LOG_INF("Public URI [" << COOLWSD::anonymizeUrl(uri.toString()) << "] considered WOPI.");
const auto& targetHost = uri.getHost();
bool allowed(false);
HostUtil::setFirstHost(uri);
if (HostUtil::allowedWopiHost(targetHost) ||
isLocalhost(targetHost))
{
allowed = true;
}
if (!allowed)
{
// check if the IP address is in the list of allowed hosts
const auto hostAddresses(Poco::Net::DNS::resolve(targetHost));
for (auto &address : hostAddresses.addresses())
{
if (HostUtil::allowedWopiHost(address.toString()))
{
allowed = true;
break;
}
}
}
if (allowed)
return std::unique_ptr<StorageBase>(new WopiStorage(uri, jailRoot, jailPath));
LOG_ERR("No acceptable WOPI hosts found matching the target host [" << targetHost << "] in config.");
throw UnauthorizedRequestException("No acceptable WOPI hosts found matching the target host [" + targetHost + "] in config.");
}
#endif
throw BadRequestException("No Storage configured or invalid URI.");
}
std::atomic<unsigned> LocalStorage::LastLocalStorageId;
std::unique_ptr<LocalStorage::LocalFileInfo> LocalStorage::getLocalFileInfo()
{
const Poco::Path path = getUri().getPath();
LOG_DBG("Getting info for local uri [" << COOLWSD::anonymizeUrl(getUri().toString()) << "], path [" << COOLWSD::anonymizeUrl(path.toString()) << "].");
const FileUtil::Stat stat(path.toString());
const std::chrono::system_clock::time_point lastModified = stat.modifiedTimepoint();
setFileInfo(FileInfo(path.getFileName(), "LocalOwner",
Util::getIso8601FracformatTime(lastModified)));
// Set automatic userid and username.
const std::string userId = std::to_string(LastLocalStorageId++);
std::string userNameString;
#if MOBILEAPP
if (user_name != nullptr)
userNameString = std::string(user_name);
#endif
if (userNameString.size() == 0)
userNameString = "LocalUser#" + userId;
return std::unique_ptr<LocalStorage::LocalFileInfo>(
new LocalFileInfo({"LocalUser" + userId, userNameString}));
}
std::string LocalStorage::downloadStorageFileToLocal(const Authorization& /*auth*/,
LockContext& /*lockCtx*/,
const std::string& /*templateUri*/)
{
#if !MOBILEAPP
// /chroot/jailId/user/doc/childId/file.ext
const std::string filename = Poco::Path(getUri().getPath()).getFileName();
setRootFilePath(Poco::Path(getLocalRootPath(), filename).toString());
setRootFilePathAnonym(COOLWSD::anonymizeUrl(getRootFilePath()));
LOG_INF("Public URI [" << COOLWSD::anonymizeUrl(getUri().getPath()) <<
"] jailed to [" << getRootFilePathAnonym() << "].");
// Despite the talk about URIs it seems that _uri is actually just a pathname here
const std::string publicFilePath = getUri().getPath();
if (!Poco::File(publicFilePath).exists())
{
LOG_ERR("Local file URI [" << publicFilePath << "] invalid or doesn't exist.");
throw BadRequestException("Invalid URI: " + getUri().toString());
}
if (!FileUtil::checkDiskSpace(getRootFilePath()))
{
throw StorageSpaceLowException("Low disk space for " + getRootFilePathAnonym());
}
if (_isTemporaryFile)
{
try
{
// Neither link nor copy, just move, it's a temporary file.
Poco::File(publicFilePath).moveTo(getRootFilePath());
// Cleanup the directory after moving.
const std::string dir = Poco::Path(publicFilePath).parent().toString();
if (FileUtil::isEmptyDirectory(dir))
FileUtil::removeFile(dir);
}
catch (const Poco::Exception& exc)
{
LOG_ERR("Failed to move [" << COOLWSD::anonymizeUrl(publicFilePath) << "] to ["
<< getRootFilePathAnonym() << "]: " << exc.displayText());
}
}
if (!FileUtil::Stat(getRootFilePath()).exists())
{
// Try to link.
LOG_INF("Linking " << COOLWSD::anonymizeUrl(publicFilePath) << " to "
<< getRootFilePathAnonym());
if (!Poco::File(getRootFilePath()).exists()
&& link(publicFilePath.c_str(), getRootFilePath().c_str()) == -1)
{
// Failed
LOG_INF("link(\"" << COOLWSD::anonymizeUrl(publicFilePath) << "\", \""
<< getRootFilePathAnonym() << "\") failed. Will copy. Linking error: "
<< Util::symbolicErrno(errno) << ' ' << strerror(errno));
}
}
try
{
// Fallback to copying.
if (!FileUtil::Stat(getRootFilePath()).exists())
{
FileUtil::copyFileTo(publicFilePath, getRootFilePath());
_isCopy = true;
}
}
catch (const Poco::Exception& exc)
{
LOG_ERR("copyTo(\"" << COOLWSD::anonymizeUrl(publicFilePath) << "\", \""
<< getRootFilePathAnonym() << "\") failed: " << exc.displayText());
throw;
}
setDownloaded(true);
// Now return the jailed path.
#ifndef KIT_IN_PROCESS
if (COOLWSD::NoCapsForKit)
return getRootFilePath();
else
return Poco::Path(getJailPath(), filename).toString();
#else
return getRootFilePath();
#endif
#else // MOBILEAPP
// In the mobile app we use no jail
setRootFilePath(getUri().getPath());
return getRootFilePath();
#endif
}
void LocalStorage::uploadLocalFileToStorageAsync(const Authorization& /*auth*/,
LockContext& /*lockCtx*/,
const std::string& /*saveAsPath*/,
const std::string& /*saveAsFilename*/,
bool /*isRename*/, const Attributes&, SocketPoll&,
const AsyncUploadCallback& asyncUploadCallback)
{
const std::string path = getUri().getPath();
// Assume failure by default.
UploadResult res = UploadResult(UploadResult::Result::FAILED, "Internal error");
try
{
LOG_TRC("Copying local file to local file storage (isCopy: " << _isCopy << ") for "
<< getRootFilePathAnonym());
// Copy the file back.
if (_isCopy && Poco::File(getRootFilePathUploading()).exists())
FileUtil::copyFileTo(getRootFilePathUploading(), path);
// update its fileinfo object. This is used later to check if someone else changed the
// document while we are/were editing it
getFileInfo().setLastModifiedTime(
Util::getIso8601FracformatTime(FileUtil::Stat(path).modifiedTimepoint()));
LOG_TRC("New FileInfo modified time in storage " << getFileInfo().getLastModifiedTime());
res = UploadResult(UploadResult::Result::OK);
}
catch (const Poco::Exception& exc)
{
LOG_ERR("copyTo(\"" << getRootFilePathAnonym() << "\", \"" << COOLWSD::anonymizeUrl(path)
<< "\") failed: " << exc.displayText());
// Default UploadResult is failure.
}
if (asyncUploadCallback)
asyncUploadCallback(AsyncUpload(AsyncUpload::State::Complete, res));
}
#if !MOBILEAPP
Poco::Net::HTTPClientSession* StorageBase::getHTTPClientSession(const Poco::URI& uri)
{
bool useSSL = false;
if (SSLAsScheme)
{
// the WOPI URI itself should control whether we use SSL or not
// for whether we verify vs. certificates, cf. above
useSSL = uri.getScheme() != "http";
}
else
{
// We decoupled the Wopi communication from client communication because
// the Wopi communication must have an independent policy.
// So, we will use here only Storage settings.
useSSL = SSLEnabled || COOLWSD::isSSLTermination();
}
// We decoupled the Wopi communication from client communication because
// the Wopi communication must have an independent policy.
// So, we will use here only Storage settings.
Poco::Net::HTTPClientSession* session = useSSL
? new Poco::Net::HTTPSClientSession(uri.getHost(), uri.getPort(),
Poco::Net::SSLManager::instance().defaultClientContext())
: new Poco::Net::HTTPClientSession(uri.getHost(), uri.getPort());
// Set the timeout to the configured value.
static int timeoutSec = COOLWSD::getConfigValue<int>("net.connection_timeout_secs", 30);
session->setTimeout(Poco::Timespan(timeoutSec, 0));
return session;
}
std::shared_ptr<http::Session> StorageBase::getHttpSession(const Poco::URI& uri)
{
bool useSSL = false;
if (SSLAsScheme)
{
// the WOPI URI itself should control whether we use SSL or not
// for whether we verify vs. certificates, cf. above
useSSL = uri.getScheme() != "http";
}
else
{
// We decoupled the Wopi communication from client communication because
// the Wopi communication must have an independent policy.
// So, we will use here only Storage settings.
useSSL = SSLEnabled || COOLWSD::isSSLTermination();
}
const auto protocol
= useSSL ? http::Session::Protocol::HttpSsl : http::Session::Protocol::HttpUnencrypted;
// Create the session.
auto httpSession = http::Session::create(uri.getHost(), protocol, uri.getPort());
static int timeoutSec = COOLWSD::getConfigValue<int>("net.connection_timeout_secs", 30);
httpSession->setTimeout(std::chrono::seconds(timeoutSec));
return httpSession;
}
namespace
{
static void addStorageDebugCookie(Poco::Net::HTTPRequest& request)
{
(void) request;
#if ENABLE_DEBUG
if (std::getenv("COOL_STORAGE_COOKIE"))
{
Poco::Net::NameValueCollection nvcCookies;
StringVector cookieTokens = StringVector::tokenize(std::string(std::getenv("COOL_STORAGE_COOKIE")), ':');
if (cookieTokens.size() == 2)
{
nvcCookies.add(cookieTokens[0], cookieTokens[1]);
request.setCookies(nvcCookies);
LOG_TRC("Added storage debug cookie [" << cookieTokens[0] << '=' << cookieTokens[1] << "].");
}
}
#endif
}
// access_token must be decoded
void addWopiProof(Poco::Net::HTTPRequest& request, const Poco::URI& uri,
const std::string& access_token)
{
assert(!uri.isRelative());
for (const auto& header : GetProofHeaders(access_token, uri.toString()))
request.set(header.first, header.second);
}
std::map<std::string, std::string> GetQueryParams(const Poco::URI& uri)
{
std::map<std::string, std::string> result;
for (const auto& param : uri.getQueryParameters())
result.emplace(param);
return result;
}
} // anonymous namespace
#endif // !MOBILEAPP
void LockContext::initSupportsLocks()
{
#if MOBILEAPP
_supportsLocks = false;
#else
if (_supportsLocks)
return;
// first time token setup
_supportsLocks = true;
_lockToken = "cool-lock" + Util::rng::getHexString(8);
#endif
}
bool LockContext::needsRefresh(const std::chrono::steady_clock::time_point &now) const
{
static int refreshSeconds = COOLWSD::getConfigValue<int>("storage.wopi.locking.refresh", 900);
return _supportsLocks && _isLocked && refreshSeconds > 0 &&
std::chrono::duration_cast<std::chrono::seconds>
(now - _lastLockTime).count() >= refreshSeconds;
}
void LockContext::dumpState(std::ostream& os) const
{
if (!_supportsLocks)
return;
os << "\n LockContext:";
os << "\n locked: " << _isLocked;
os << "\n token: " << _lockToken;
os << "\n last locked: " << Util::getSteadyClockAsString(_lastLockTime);
}
#if !MOBILEAPP
void WopiStorage::initHttpRequest(Poco::Net::HTTPRequest& request, const Poco::URI& uri,
const Authorization& auth) const
{
request.set("User-Agent", WOPI_AGENT_STRING);
auth.authorizeRequest(request);
addStorageDebugCookie(request);
// TODO: Avoid repeated parsing.
std::map<std::string, std::string> params = GetQueryParams(uri);
const auto it = params.find("access_token");
if (it != params.end())
addWopiProof(request, uri, it->second);
// Helps wrt. debugging cluster cases from the logs
request.set("X-COOL-WOPI-ServerId", Util::getProcessIdentifier());
}
http::Request WopiStorage::initHttpRequest(const Poco::URI& uri, const Authorization& auth) const
{
http::Request httpRequest(uri.getPathAndQuery());
//FIXME: Hack Hack Hack! Use own version.
Poco::Net::HTTPRequest request;
initHttpRequest(request, uri, auth);
// Copy the headers, including the cookies.
for (const auto& pair : request)
{
httpRequest.header().set(pair.first, pair.second);
}
return httpRequest;
}
std::unique_ptr<WopiStorage::WOPIFileInfo>
WopiStorage::getWOPIFileInfoForUri(Poco::URI uriObject, const Authorization& auth,
LockContext& lockCtx, unsigned redirectLimit)
{
ProfileZone profileZone("WopiStorage::getWOPIFileInfo", { {"url", _fileUrl} });
// update the access_token to the one matching to the session
auth.authorizeURI(uriObject);
const std::string uriAnonym = COOLWSD::anonymizeUrl(uriObject.toString());
LOG_DBG("Getting info for wopi uri [" << uriAnonym << "].");
std::string wopiResponse;
std::chrono::milliseconds callDurationMs;
try
{
std::shared_ptr<http::Session> httpSession = getHttpSession(uriObject);
http::Request httpRequest = initHttpRequest(uriObject, auth);
const auto startTime = std::chrono::steady_clock::now();
Log::StreamLogger logger = Log::trace();
if (logger.enabled())
{
logger << "WOPI::CheckFileInfo request header for URI [" << uriAnonym << "]:\n";
for (const auto& pair : httpRequest.header())
{
logger << '\t' << pair.first << ": " << pair.second << " / ";
}
LOG_END_FLUSH(logger);
}
const std::shared_ptr<const http::Response> httpResponse
= httpSession->syncRequest(httpRequest);
callDurationMs = std::chrono::duration_cast<std::chrono::milliseconds>(
std::chrono::steady_clock::now() - startTime);
if (httpResponse->statusLine().statusCode() == Poco::Net::HTTPResponse::HTTP_FOUND ||
httpResponse->statusLine().statusCode() == Poco::Net::HTTPResponse::HTTP_MOVED_PERMANENTLY ||
httpResponse->statusLine().statusCode() == Poco::Net::HTTPResponse::HTTP_TEMPORARY_REDIRECT ||
httpResponse->statusLine().statusCode() == Poco::Net::HTTPResponse::HTTP_PERMANENT_REDIRECT)
{
if (redirectLimit)
{
const std::string& location = httpResponse->get("Location");
LOG_TRC("WOPI::CheckFileInfo redirect to URI [" << COOLWSD::anonymizeUrl(location) << "]");
Poco::URI redirectUriObject(location);
setUri(redirectUriObject);
return getWOPIFileInfoForUri(redirectUriObject, auth, lockCtx, redirectLimit - 1);
}
else
{
LOG_WRN("WOPI::CheckFileInfo redirected too many times - URI [" << uriAnonym << "]");
}
}
// Note: we don't log the response if obfuscation is enabled, except for failures.
wopiResponse = httpResponse->getBody();
const bool failed
= (httpResponse->statusLine().statusCode() != Poco::Net::HTTPResponse::HTTP_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: ";
for (const auto& pair : httpResponse->header())
{
logRes << '\t' << pair.first << ": " << pair.second << " / ";
}
if (failed)
logRes << "\tBody: [" << wopiResponse << "]";
LOG_END_FLUSH(logRes);
}
if (failed)
{
if (httpResponse->statusLine().statusCode() == Poco::Net::HTTPResponse::HTTP_FORBIDDEN)
throw UnauthorizedRequestException(
"Access denied, 403. WOPI::CheckFileInfo failed on: " + uriAnonym);
throw StorageConnectionException("WOPI::CheckFileInfo failed: " + wopiResponse);
}
}
catch (const Poco::Exception& pexc)
{
LOG_ERR("Cannot get file info from WOPI storage uri [" << uriAnonym << "]. Error: " <<
pexc.displayText() << (pexc.nested() ? " (" + pexc.nested()->displayText() + ')' : ""));
throw;
}
catch (const BadRequestException& exc)
{
LOG_ERR("Cannot get file info from WOPI storage uri [" << uriAnonym << "]. Error: " << exc.what());
}
Poco::JSON::Object::Ptr object;
if (JsonUtil::parseJSON(wopiResponse, object))
{
if (COOLWSD::AnonymizeUserData)
LOG_DBG("WOPI::CheckFileInfo (" << callDurationMs << "): anonymizing...");
else
LOG_DBG("WOPI::CheckFileInfo (" << callDurationMs << "): " << wopiResponse);
std::size_t size = 0;
std::string filename, ownerId, lastModifiedTime;
JsonUtil::findJSONValue(object, "Size", size);
JsonUtil::findJSONValue(object, "OwnerId", ownerId);
JsonUtil::findJSONValue(object, "BaseFileName", filename);
JsonUtil::findJSONValue(object, "LastModifiedTime", lastModifiedTime);
FileInfo fileInfo = FileInfo({filename, ownerId, lastModifiedTime});
setFileInfo(fileInfo);
if (COOLWSD::AnonymizeUserData)
Util::mapAnonymized(Util::getFilenameFromURL(filename), Util::getFilenameFromURL(getUri().toString()));
auto wopiInfo = Util::make_unique<WopiStorage::WOPIFileInfo>(fileInfo, callDurationMs, object, uriObject);
if (wopiInfo->getSupportsLocks())
lockCtx.initSupportsLocks();
// If FileUrl is set, we use it for GetFile.
_fileUrl = wopiInfo->getFileUrl();
return wopiInfo;
}
else
{
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);
}
}
std::unique_ptr<WopiStorage::WOPIFileInfo> WopiStorage::getWOPIFileInfo(const Authorization& auth,
LockContext& lockCtx)
{
Poco::URI uriObject(getUri());
return getWOPIFileInfoForUri(uriObject, auth, lockCtx, RedirectionLimit);
}
void WopiStorage::WOPIFileInfo::init()
{
_userCanWrite = false;
_enableOwnerTermination = false;
_hidePrintOption = false;
_hideSaveOption = false;
_hideExportOption = false;
_hideRepairOption = false;
_disablePrint = false;
_disableExport = false;
_disableCopy = false;
_disableInactiveMessages = false;
_downloadAsPostMessage = false;
_userCanNotWriteRelative = true;
_enableInsertRemoteImage = false;
_enableShare = false;
_supportsLocks = false;
_supportsRename = false;
_userCanRename = false;
_hideUserList = "false";
_disableChangeTrackingRecord = WOPIFileInfo::TriState::Unset;
_disableChangeTrackingShow = WOPIFileInfo::TriState::Unset;
_hideChangeTrackingControls = WOPIFileInfo::TriState::Unset;
}
WopiStorage::WOPIFileInfo::WOPIFileInfo(const FileInfo &fileInfo,
std::chrono::milliseconds callDurationMs,
Poco::JSON::Object::Ptr &object, Poco::URI &uriObject)
{
init();
const std::string &filename = fileInfo.getFilename();
const std::string &ownerId = fileInfo.getOwnerId();
JsonUtil::findJSONValue(object, "UserId", _userId);
JsonUtil::findJSONValue(object, "UserFriendlyName", _username);
JsonUtil::findJSONValue(object, "TemplateSaveAs", _templateSaveAs);
JsonUtil::findJSONValue(object, "TemplateSource", _templateSource);
// UserFriendlyName is used as the Author when loading the document.
// If it's missing, document loading fails. Since the UserFriendlyName
// field is optional in WOPI specs, it's often left out by integrators.
if (_username.empty())
{
_username = "UnknownUser"; // Default to something sensible yet friendly.
if (!_userId.empty())
_username += '_' + _userId;
LOG_ERR("WOPI::CheckFileInfo does not specify a valid UserFriendlyName for the current "
"user. Temporarily ["
<< _username << "] will be used until a valid name is specified.");
}
std::ostringstream wopiResponse;
// Anonymize key values.
if (COOLWSD::AnonymizeUserData)
{
JsonUtil::findJSONValue(object, "ObfuscatedUserId", _obfuscatedUserId, false);
if (!_obfuscatedUserId.empty())
{
Util::mapAnonymized(ownerId, _obfuscatedUserId);
Util::mapAnonymized(_userId, _obfuscatedUserId);
Util::mapAnonymized(_username, _obfuscatedUserId);
}
Poco::JSON::Object::Ptr anonObject(object);
// Set anonymized version of the above fields before logging.
// Note: anonymization caches the result, so we don't need to store here.
if (COOLWSD::AnonymizeUserData)
anonObject->set("BaseFileName", COOLWSD::anonymizeUrl(filename));
// If obfuscatedUserId is provided, then don't log the originals and use it.
if (COOLWSD::AnonymizeUserData && _obfuscatedUserId.empty())
{
anonObject->set("OwnerId", COOLWSD::anonymizeUsername(ownerId));
anonObject->set("UserId", COOLWSD::anonymizeUsername(_userId));
anonObject->set("UserFriendlyName", COOLWSD::anonymizeUsername(_username));
}
anonObject->stringify(wopiResponse);
}
else
object->stringify(wopiResponse);
LOG_DBG("WOPI::CheckFileInfo (" << callDurationMs << "): " << wopiResponse.str());
JsonUtil::findJSONValue(object, "UserExtraInfo", _userExtraInfo);
JsonUtil::findJSONValue(object, "UserPrivateInfo", _userPrivateInfo);
JsonUtil::findJSONValue(object, "WatermarkText", _watermarkText);
JsonUtil::findJSONValue(object, "UserCanWrite", _userCanWrite);
JsonUtil::findJSONValue(object, "PostMessageOrigin", _postMessageOrigin);
JsonUtil::findJSONValue(object, "HidePrintOption", _hidePrintOption);
JsonUtil::findJSONValue(object, "HideSaveOption", _hideSaveOption);
JsonUtil::findJSONValue(object, "HideExportOption", _hideExportOption);
JsonUtil::findJSONValue(object, "HideRepairOption", _hideRepairOption);
JsonUtil::findJSONValue(object, "EnableOwnerTermination", _enableOwnerTermination);
JsonUtil::findJSONValue(object, "DisablePrint", _disablePrint);
JsonUtil::findJSONValue(object, "DisableExport", _disableExport);
JsonUtil::findJSONValue(object, "DisableCopy", _disableCopy);
JsonUtil::findJSONValue(object, "DisableInactiveMessages", _disableInactiveMessages);
JsonUtil::findJSONValue(object, "DownloadAsPostMessage", _downloadAsPostMessage);
JsonUtil::findJSONValue(object, "UserCanNotWriteRelative", _userCanNotWriteRelative);
JsonUtil::findJSONValue(object, "EnableInsertRemoteImage", _enableInsertRemoteImage);
JsonUtil::findJSONValue(object, "EnableShare", _enableShare);
JsonUtil::findJSONValue(object, "HideUserList", _hideUserList);
JsonUtil::findJSONValue(object, "SupportsLocks", _supportsLocks);
JsonUtil::findJSONValue(object, "SupportsRename", _supportsRename);
JsonUtil::findJSONValue(object, "UserCanRename", _userCanRename);
JsonUtil::findJSONValue(object, "BreadcrumbDocName", _breadcrumbDocName);
JsonUtil::findJSONValue(object, "FileUrl", _fileUrl);
#if ENABLE_FEATURE_LOCK
bool isUserLocked = false;
JsonUtil::findJSONValue(object, "IsUserLocked", isUserLocked);
if (config::getBool("feature_lock.locked_hosts[@allow]", false))
{
bool isReadOnly = false;
isUserLocked = false;
CommandControl::LockManager::setUnlockLink(uriObject.getHost());
Poco::URI newUri(HostUtil::getNewLockedUri(uriObject));
const std::string host = newUri.getHost();
if (CommandControl::LockManager::hostExist(host))
{
isReadOnly = CommandControl::LockManager::isHostReadOnly(host);
isUserLocked = CommandControl::LockManager::isHostCommandDisabled(host);
}
else
{
LOG_INF("Could not find matching locked_host: " << host << ",applying fallback settings");
isReadOnly = config::getBool("feature_lock.locked_hosts.fallback[@read_only]", false);
isUserLocked =
config::getBool("feature_lock.locked_hosts.fallback[@disabled_commands]", false);
}
if (isReadOnly)
{
isUserLocked = true;
_userCanWrite = false;
LOG_DBG("Feature lock is enabled and " << host << " is in the list of read-only members. Therefore, document is set to read-only.");
}
CommandControl::LockManager::setHostReadOnly(isReadOnly);
}
CommandControl::LockManager::setLockedUser(isUserLocked);
#else
(void)uriObject;
#endif
bool booleanFlag = false;
JsonUtil::findJSONValue(object, "IsUserRestricted", booleanFlag);
CommandControl::RestrictionManager::setRestrictedUser(booleanFlag);
if (JsonUtil::findJSONValue(object, "DisableChangeTrackingRecord", booleanFlag))
_disableChangeTrackingRecord = (booleanFlag ? WOPIFileInfo::TriState::True : WOPIFileInfo::TriState::False);
if (JsonUtil::findJSONValue(object, "DisableChangeTrackingShow", booleanFlag))
_disableChangeTrackingShow = (booleanFlag ? WOPIFileInfo::TriState::True : WOPIFileInfo::TriState::False);
if (JsonUtil::findJSONValue(object, "HideChangeTrackingControls", booleanFlag))
_hideChangeTrackingControls = (booleanFlag ? WOPIFileInfo::TriState::True : WOPIFileInfo::TriState::False);
static const std::string overrideWatermarks
= COOLWSD::getConfigValue<std::string>("watermark.text", "");
if (!overrideWatermarks.empty())
_watermarkText = overrideWatermarks;
if (isTemplate(filename))
_disableExport = true;
}
bool WopiStorage::updateLockState(const Authorization& auth, LockContext& lockCtx, bool lock,
const Attributes& attribs)
{
lockCtx._lockFailureReason.clear();
if (!lockCtx._supportsLocks)
return true;
Poco::URI uriObject(getUri());
auth.authorizeURI(uriObject);
Poco::URI uriObjectAnonym(getUri());
uriObjectAnonym.setPath(COOLWSD::anonymizeUrl(uriObjectAnonym.getPath()));
const std::string uriAnonym = uriObjectAnonym.toString();
const std::string wopiLog(lock ? "WOPI::Lock" : "WOPI::Unlock");
LOG_DBG(wopiLog << " requesting: " << uriAnonym);
try
{
std::unique_ptr<Poco::Net::HTTPClientSession> psession(getHTTPClientSession(uriObject));
Poco::Net::HTTPRequest request(Poco::Net::HTTPRequest::HTTP_POST,
uriObject.getPathAndQuery(),
Poco::Net::HTTPMessage::HTTP_1_1);
initHttpRequest(request, uriObject, auth);
request.set("X-WOPI-Override", lock ? "LOCK" : "UNLOCK");
request.set("X-WOPI-Lock", lockCtx._lockToken);
if (!attribs.getExtendedData().empty())
{
request.set("X-COOL-WOPI-ExtendedData", attribs.getExtendedData());
request.set("X-LOOL-WOPI-ExtendedData", attribs.getExtendedData());
}
// IIS requires content-length for POST requests: see https://forums.iis.net/t/1119456.aspx
request.setContentLength(0);
psession->sendRequest(request);
Poco::Net::HTTPResponse response;
std::istream& rs = psession->receiveResponse(response);
std::ostringstream oss;
Poco::StreamCopier::copyStream(rs, oss);
std::string responseString = oss.str();
LOG_INF(wopiLog << " response: " << responseString <<
" status " << response.getStatus());
if (response.getStatus() == Poco::Net::HTTPResponse::HTTP_OK)
{
lockCtx._isLocked = lock;
lockCtx._lastLockTime = std::chrono::steady_clock::now();
return true;
}
else
{
std::string sMoreInfo = response.get("X-WOPI-LockFailureReason", "");
if (!sMoreInfo.empty())
{
lockCtx._lockFailureReason = sMoreInfo;
sMoreInfo = ", failure reason: \"" + sMoreInfo + "\"";
}
LOG_ERR("Un-successful " << wopiLog << " with status " << response.getStatus() <<
sMoreInfo << " and response: " << responseString);
}
}
catch (const Poco::Exception& pexc)
{