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 1001 1002 1003 1004 1005 1006 1007
|
#include "connectionencryptiondata_p.h"
#include "logging_categories_p.h"
#include "qt_connection_util.h"
#include "room.h"
#include "syncdata.h"
#include "user.h"
#include "e2ee/qolmutility.h"
#include "events/encryptedevent.h"
#include "events/roomkeyevent.h"
#include <qt6keychain/keychain.h>
#include <QtCore/QCoreApplication>
#include <QtCore/QPromise>
using namespace Quotient;
using namespace Quotient::_impl;
// Below, encryptionData gets filled inside setupPicklingKey() instead of returning the future for
// a pickling key and then, in CED::setup(), another future for ConnectionEncryptionData because
// Qt versions before 6.5.2 don't handle QFutures with move-only data quite well (see QTBUG-112513).
// Oh, and unwrap() doesn't work with move-only types at all (QTBUG-127423). So it is a bit more
// verbose and repetitive than it should be.
inline QFuture<QKeychain::Job*> runKeychainJob(QKeychain::Job* j, const QString& keychainId)
{
j->setAutoDelete(true);
j->setKey(keychainId);
auto ft = QtFuture::connect(j, &QKeychain::Job::finished);
j->start();
return ft;
}
QFuture<void> setupPicklingKey(Connection* connection,
std::unique_ptr<ConnectionEncryptionData>& encryptionData)
{
using namespace QKeychain;
const auto keychainId = connection->userId() + "-Pickle"_L1;
qCInfo(MAIN) << "Keychain request: app" << qAppName() << "id" << keychainId;
return runKeychainJob(new ReadPasswordJob(qAppName()), keychainId)
.then([keychainId, &encryptionData, connection](const Job* j) -> QFuture<Job*> {
// The future will hold nullptr if the existing pickling key was found and no write is
// pending; a pointer to the write job if if a new key was made and is being written;
// be cancelled in case of an error.
switch (const auto readJob = static_cast<const ReadPasswordJob*>(j); readJob->error()) {
case Error::NoError: {
auto&& data = readJob->binaryData();
if (data.size() == PicklingKey::extent) {
qDebug(E2EE) << "Successfully loaded pickling key from keychain";
encryptionData = std::make_unique<ConnectionEncryptionData>(
connection, PicklingKey::fromByteArray(std::move(data)));
return makeReadyValueFuture<Job*>(nullptr);
}
qCritical(E2EE)
<< "The pickling key loaded from" << keychainId << "has length"
<< data.size() << "but the library expected" << PicklingKey::extent;
return {};
}
case Error::EntryNotFound: {
auto&& picklingKey = PicklingKey::generate();
auto writeJob = new WritePasswordJob(qAppName());
writeJob->setBinaryData(picklingKey.viewAsByteArray());
encryptionData = std::make_unique<ConnectionEncryptionData>(
connection, std::move(picklingKey)); // the future may still get cancelled
qDebug(E2EE) << "Saving a new pickling key to the keychain";
return runKeychainJob(writeJob, keychainId);
}
default:
qWarning(E2EE) << "Error loading pickling key - please fix your keychain:"
<< readJob->errorString();
}
return {};
})
.unwrap()
.then([](QFuture<Job*> writeFuture) {
if (const Job* const writeJob = writeFuture.result();
writeJob && writeJob->error() != Error::NoError) //
{
qCritical(E2EE) << "Could not save pickling key to keychain: "
<< writeJob->errorString();
writeFuture.cancel();
}
});
}
QFuture<bool> ConnectionEncryptionData::setup(Connection* connection,
std::unique_ptr<ConnectionEncryptionData>& result,
bool clearDatabase)
{
return setupPicklingKey(connection, result)
.then([connection, &result, clearDatabase] {
if (clearDatabase) {
qCInfo(E2EE) << "Clearing the database for account" << connection->objectName();
result->database.clear();
}
if (const auto outcome = result->database.setupOlmAccount(result->olmAccount)) {
if (outcome == OLM_SUCCESS) {
qCDebug(E2EE) << "The existing Olm account successfully unpickled";
return true;
}
qCritical(E2EE) << "Could not unpickle Olm account for" << connection->objectName();
return false;
}
qCDebug(E2EE) << "A new Olm account has been created, uploading device keys";
connection->callApi<UploadKeysJob>(result->olmAccount.deviceKeys())
.then(connection,
[connection, &result] {
result->trackedUsers += connection->userId();
result->outdatedUsers += connection->userId();
result->encryptionUpdateRequired = true;
},
[](auto* job) {
qCWarning(E2EE) << "Failed to upload device keys:" << job->errorString();
});
return true;
})
.onCanceled([connection] {
qCritical(E2EE) << "Could not setup E2EE for" << connection->objectName();
return false;
});
}
void ConnectionEncryptionData::saveDevicesList()
{
auto query = database.prepareQuery(u"DELETE FROM tracked_users"_s);
database.execute(query);
query.prepare(u"INSERT INTO tracked_users(matrixId) VALUES(:matrixId);"_s);
for (const auto& user : std::as_const(trackedUsers)) {
query.bindValue(u":matrixId"_s, user);
database.execute(query);
}
query.prepare(u"DELETE FROM outdated_users"_s);
database.execute(query);
query.prepare(u"INSERT INTO outdated_users(matrixId) VALUES(:matrixId);"_s);
for (const auto& user : std::as_const(outdatedUsers)) {
query.bindValue(u":matrixId"_s, user);
database.execute(query);
}
query.prepare(
u"INSERT INTO tracked_devices"
"(matrixId, deviceId, curveKeyId, curveKey, edKeyId, edKey, verified, selfVerified) "
"VALUES (:matrixId, :deviceId, :curveKeyId, :curveKey, :edKeyId, :edKey, :verified, :selfVerified);"_s);
auto deleteQuery =
database.prepareQuery(u"DELETE FROM tracked_devices WHERE matrixId=:matrixId;"_s);
for (const auto& [user, devices] : std::as_const(deviceKeys).asKeyValueRange()) {
deleteQuery.bindValue(u":matrixId"_s, user);
database.execute(deleteQuery);
for (const auto& device : std::as_const(devices)) {
const auto keys = device.keys.asKeyValueRange();
if (device.deviceId.isEmpty()) {
qCCritical(E2EE) << "Clearing an invalid tracked device record with empty deviceId";
continue;
}
const auto curveKeyIt = std::ranges::find_if(keys, [](const auto& p) {
return p.first.startsWith("curve"_L1);
});
const auto edKeyIt = std::ranges::find_if(keys, [](const auto& p) {
return p.first.startsWith("ed"_L1);
});
if (curveKeyIt == keys.end() || edKeyIt == keys.end()) {
qCCritical(E2EE) << "Clearing an invalid tracked device record due to keys missing";
continue;
}
query.bindValue(u":matrixId"_s, user);
query.bindValue(u":deviceId"_s, device.deviceId);
query.bindValue(u":curveKeyId"_s, curveKeyIt->first);
query.bindValue(u":curveKey"_s, curveKeyIt->second);
query.bindValue(u":edKeyId"_s, edKeyIt->first);
query.bindValue(u":edKey"_s, edKeyIt->second);
// If the device gets saved here, it can't be verified
query.bindValue(u":verified"_s, verifiedDevices[user][device.deviceId]);
query.bindValue(u":selfVerified"_s, selfVerifiedDevices[user][device.deviceId]);
database.execute(query);
}
}
}
void ConnectionEncryptionData::loadDevicesList()
{
auto query =
database.prepareQuery(QStringLiteral("SELECT * FROM tracked_users;"));
database.execute(query);
while (query.next()) {
trackedUsers += query.value(0).toString();
}
query =
database.prepareQuery(QStringLiteral("SELECT * FROM outdated_users;"));
database.execute(query);
while (query.next()) {
outdatedUsers += query.value(0).toString();
}
static const QStringList Algorithms{ SupportedAlgorithms.cbegin(),
SupportedAlgorithms.cend() };
query =
database.prepareQuery(QStringLiteral("SELECT * FROM tracked_devices;"));
database.execute(query);
while (query.next()) {
deviceKeys[query.value("matrixId"_L1).toString()].insert(
query.value("deviceId"_L1).toString(),
{
.userId = query.value("matrixId"_L1).toString(),
.deviceId = query.value("deviceId"_L1).toString(),
.algorithms = Algorithms,
.keys{ { query.value("curveKeyId"_L1).toString(),
query.value("curveKey"_L1).toString() },
{ query.value("edKeyId"_L1).toString(),
query.value("edKey"_L1).toString() } },
.signatures{} // not needed after initial validation so not saved
});
selfVerifiedDevices[query.value("matrixId"_L1).toString()][query.value("deviceId"_L1).toString()] = query.value("selfVerified"_L1).toBool();
verifiedDevices[query.value("matrixId"_L1).toString()][query.value("deviceId"_L1).toString()] = query.value("verified"_L1).toBool();
}
}
QString ConnectionEncryptionData::curveKeyForUserDevice(
const QString& userId, const QString& device) const
{
return deviceKeys[userId][device].keys["curve25519:"_L1 + device];
}
bool ConnectionEncryptionData::isKnownCurveKey(const QString& userId,
const QString& curveKey) const
{
auto query = database.prepareQuery(
QStringLiteral("SELECT * FROM tracked_devices WHERE matrixId=:matrixId "
"AND curveKey=:curveKey"));
query.bindValue(":matrixId"_L1, userId);
query.bindValue(":curveKey"_L1, curveKey);
database.execute(query);
return query.next();
}
bool ConnectionEncryptionData::hasOlmSession(const QString& user,
const QString& deviceId) const
{
const auto& curveKey = curveKeyForUserDevice(user, deviceId).toLatin1();
const auto sessionIt = olmSessions.find(curveKey);
return sessionIt != olmSessions.cend() && !sessionIt->second.empty();
}
void ConnectionEncryptionData::onSyncSuccess(SyncData& syncResponse)
{
oneTimeKeysCount = syncResponse.deviceOneTimeKeysCount();
if (oneTimeKeysCount[SignedCurve25519Key]
< 0.4 * olmAccount.maxNumberOfOneTimeKeys()
&& !isUploadingKeys) {
isUploadingKeys = true;
olmAccount.generateOneTimeKeys(olmAccount.maxNumberOfOneTimeKeys() / 2
- oneTimeKeysCount[SignedCurve25519Key]);
auto keys = olmAccount.oneTimeKeys();
auto job = olmAccount.createUploadKeyRequest(keys);
q->run(job, ForegroundRequest);
QObject::connect(job, &BaseJob::success, q,
[this] { olmAccount.markKeysAsPublished(); });
QObject::connect(job, &BaseJob::result, q,
[this] { isUploadingKeys = false; });
}
if(firstSync) {
loadDevicesList();
firstSync = false;
}
consumeDevicesList(syncResponse.takeDevicesList());
auto checkQuery = database.prepareQuery("SELECT * FROM master_keys WHERE userId=:userId"_L1);
checkQuery.bindValue(":userId"_L1, q->userId());
database.execute(checkQuery);
const auto haveMasterKey = checkQuery.next();
if (trackedUsers.contains(q->userId()) && !outdatedUsers.contains(q->userId()) && !haveMasterKey) {
emit q->crossSigningSetupRequired();
}
}
void ConnectionEncryptionData::consumeDevicesList(const DevicesList& devicesList)
{
bool hasNewOutdatedUser = false;
for(const auto &changed : devicesList.changed) {
if(trackedUsers.contains(changed)) {
outdatedUsers += changed;
hasNewOutdatedUser = true;
}
}
for(const auto &left : devicesList.left) {
trackedUsers -= left;
outdatedUsers -= left;
deviceKeys.remove(left);
}
if(hasNewOutdatedUser)
loadOutdatedUserDevices();
}
void ConnectionEncryptionData::loadOutdatedUserDevices()
{
QHash<QString, QStringList> users;
for(const auto &user : outdatedUsers) {
users[user] += QStringList();
}
currentQueryKeysJob.abandon(); // Cancel network request explicitly
currentQueryKeysJob = q->callApi<QueryKeysJob>(users).onResult(q, [this](QueryKeysJob* job) {
if (job->status().good())
handleQueryKeys(collectResponse(job));
emit q->finishedQueryingKeys();
});
}
void ConnectionEncryptionData::consumeToDeviceEvent(EventPtr toDeviceEvent)
{
if (processIfVerificationEvent(*toDeviceEvent, false))
return;
if (auto&& event = eventCast<EncryptedEvent>(std::move(toDeviceEvent))) {
if (event->algorithm() != OlmV1Curve25519AesSha2AlgoKey) {
qCDebug(E2EE) << "Unsupported algorithm" << event->id()
<< "for event" << event->algorithm();
return;
}
if (isKnownCurveKey(event->senderId(), event->senderKey())) {
handleEncryptedToDeviceEvent(*event);
return;
}
trackedUsers += event->senderId();
outdatedUsers += event->senderId();
encryptionUpdateRequired = true;
pendingEncryptedEvents.push_back(std::move(event));
}
}
bool ConnectionEncryptionData::processIfVerificationEvent(const Event& evt,
bool encrypted)
{
return switchOnType(
evt,
[this, encrypted](const KeyVerificationRequestEvent& reqEvt) {
setupKeyVerificationSession(reqEvt.fullJson()[SenderKey].toString(),
reqEvt, q, encrypted);
return true;
},
[](const KeyVerificationDoneEvent&) {
qCDebug(E2EE) << "Ignoring m.key.verification.done";
return true;
},
[this](const KeyVerificationEvent& kvEvt) {
if (auto* const session =
verificationSessions.value(kvEvt.transactionId())) {
qCDebug(E2EE) << "Handling" << kvEvt.matrixType();
session->handleEvent(kvEvt);
emit q->keyVerificationStateChanged(session, session->state());
}
return true;
},
false);
}
class SecretSendEvent : public Event {
public:
using Event::Event;
QUO_EVENT(SecretSendEvent, "m.secret.send")
QUO_CONTENT_GETTER(QString, requestId)
QUO_CONTENT_GETTER(QString, secret)
};
void ConnectionEncryptionData::handleEncryptedToDeviceEvent(const EncryptedEvent& event)
{
const auto [decryptedEvent, olmSessionId] = sessionDecryptMessage(event);
if (!decryptedEvent) {
qCWarning(E2EE) << "Failed to decrypt to-device event from device"
<< event.deviceId();
return;
}
if (processIfVerificationEvent(*decryptedEvent, true))
return;
decryptedEvent->switchOnType(
[this, &event, olmSessionId](const RoomKeyEvent& roomKeyEvent) {
if (auto* detectedRoom = q->room(roomKeyEvent.roomId())) {
detectedRoom->handleRoomKeyEvent(roomKeyEvent, event.senderId(),
olmSessionId, event.senderKey().toLatin1(), q->edKeyForUserDevice(event.senderId(), event.deviceId()).toLatin1());
} else {
qCDebug(E2EE)
<< "Encrypted event room id" << roomKeyEvent.roomId()
<< "is not found at the connection" << q->objectName();
}
},
[this](const SecretSendEvent& sse) {
emit q->secretReceived(sse.requestId(), sse.secret());
},
[](const Event& evt) {
qCWarning(E2EE) << "Skipping encrypted to_device event, type" << evt.matrixType();
});
}
void ConnectionEncryptionData::handleMasterKeys(const QHash<QString, CrossSigningKey>& masterKeys)
{
for (const auto &[userId, key] : asKeyValueRange(masterKeys)) {
if (key.userId != userId) {
qCWarning(E2EE) << "Master key: userId mismatch" << key.userId << userId;
continue;
}
if (!key.usage.contains("master"_L1)) {
qCWarning(E2EE) << "Master key: invalid usage" << key.usage;
continue;
}
auto checkQuery = database.prepareQuery("SELECT * FROM master_keys WHERE userId=:userId"_L1);
checkQuery.bindValue(":userId"_L1, key.userId);
database.execute(checkQuery);
if (checkQuery.next()) {
if (checkQuery.value("key"_L1).toString() == key.keys.values()[0]) {
continue;
}
qCWarning(E2EE) << "New master key for" << key.userId;
auto query = database.prepareQuery(
"UPDATE tracked_devices SET verified=0, selfVerified=0 WHERE matrixId=:matrixId;"_L1);
query.bindValue(":matrixId"_L1, userId);
database.execute(query);
query = database.prepareQuery("DELETE FROM self_signing_keys WHERE userId=:userId;"_L1);
query.bindValue(":userId"_L1, userId);
database.execute(query);
}
auto query = database.prepareQuery("DELETE FROM master_keys WHERE userId=:userId;"_L1);
query.bindValue(":userId"_L1, userId);
database.execute(query);
query = database.prepareQuery("INSERT INTO master_keys(userId, key, verified) VALUES(:userId, :key, false);"_L1);
query.bindValue(":userId"_L1, userId);
query.bindValue(":key"_L1, key.keys.values()[0]);
database.execute(query);
}
}
namespace {
QString getEd25519Signature(const CrossSigningKey& keyObject, const QString& userId,
const QString& masterKey)
{
return keyObject.signatures[userId]["ed25519:"_L1 + masterKey].toString();
}
}
void ConnectionEncryptionData::handleSelfSigningKeys(const QHash<QString, CrossSigningKey>& selfSigningKeys)
{
for (const auto &[userId, key] : asKeyValueRange(selfSigningKeys)) {
if (key.userId != userId) {
qCWarning(E2EE) << "Self signing key: userId mismatch"<< key.userId << userId;
continue;
}
if (!key.usage.contains("self_signing"_L1)) {
qCWarning(E2EE) << "Self signing key: invalid usage" << key.usage;
continue;
}
const auto masterKey = q->masterKeyForUser(userId);
if (masterKey.isEmpty())
continue;
auto checkQuery = database.prepareQuery("SELECT key FROM self_signing_keys WHERE userId=:userId;"_L1);
checkQuery.bindValue(":userId"_L1, userId);
database.execute(checkQuery);
if (checkQuery.next()) {
auto oldKey = checkQuery.value("key"_L1).toString();
if (oldKey != key.keys.values()[0]) {
qCWarning(E2EE) << "New self-signing key for" << userId << ". Marking all devices as unverified.";
auto query = database.prepareQuery(
"UPDATE tracked_devices SET verified=0, selfVerified=0 WHERE matrixId=:matrixId;"_L1);
query.bindValue(":matrixId"_L1, userId);
database.execute(query);
}
}
if (!ed25519VerifySignature(masterKey, toJson(key),
getEd25519Signature(key, userId, masterKey))) {
qCWarning(E2EE) << "Self signing key: failed signature verification" << userId;
continue;
}
auto query = database.prepareQuery("DELETE FROM self_signing_keys WHERE userId=:userId;"_L1);
query.bindValue(":userId"_L1, userId);
database.execute(query);
query = database.prepareQuery("INSERT INTO self_signing_keys(userId, key) VALUES(:userId, :key);"_L1);
query.bindValue(":userId"_L1, userId);
query.bindValue(":key"_L1, key.keys.values()[0]);
database.execute(query);
}
}
void ConnectionEncryptionData::handleUserSigningKeys(const QHash<QString, CrossSigningKey>& userSigningKeys)
{
for (const auto &[userId, key] : asKeyValueRange(userSigningKeys)) {
if (key.userId != userId) {
qWarning() << "User signing key: userId mismatch" << key.userId << userId;
continue;
}
if (!key.usage.contains("user_signing"_L1)) {
qWarning() << "User signing key: invalid usage" << key.usage;
continue;
}
const auto masterKey = q->masterKeyForUser(userId);
if (masterKey.isEmpty())
continue;
auto checkQuery = database.prepareQuery("SELECT key FROM user_signing_keys WHERE userId=:userId"_L1);
checkQuery.bindValue(":userId"_L1, userId);
database.execute(checkQuery);
if (checkQuery.next()) {
auto oldKey = checkQuery.value("key"_L1).toString();
if (oldKey != key.keys.values()[0]) {
qCWarning(E2EE) << "New user signing key; marking all master signing keys as unverified" << userId;
auto query = database.prepareQuery(
"UPDATE master_keys SET verified=0;"_L1);
database.execute(query);
}
}
if (!ed25519VerifySignature(masterKey, toJson(key),
getEd25519Signature(key, userId, masterKey))) {
qWarning() << "User signing key: failed signature verification" << userId;
continue;
}
auto query = database.prepareQuery("DELETE FROM user_signing_keys WHERE userId=:userId;"_L1);
query.bindValue(":userId"_L1, userId);
database.execute(query);
query = database.prepareQuery("INSERT INTO user_signing_keys(userId, key) VALUES(:userId, :key);"_L1);
query.bindValue(":userId"_L1, userId);
query.bindValue(":key"_L1, key.keys.values()[0]);
database.execute(query);
}
}
void ConnectionEncryptionData::checkVerifiedMasterKeys(const QHash<QString, CrossSigningKey>& masterKeys)
{
if (!q->isUserVerified(q->userId())) {
return;
}
auto query = database.prepareQuery("SELECT key FROM user_signing_keys WHERE userId=:userId;"_L1);
query.bindValue(":userId"_L1, q->userId());
database.execute(query);
if (!query.next()) {
return;
}
const auto userSigningKey = query.value("key"_L1).toString();
for (const auto& masterKey : masterKeys) {
auto signature = getEd25519Signature(masterKey, q->userId(), userSigningKey);
if (signature.isEmpty()) {
continue;
}
if (ed25519VerifySignature(userSigningKey, toJson(masterKey), signature)) {
database.setMasterKeyVerified(masterKey.keys.values()[0]);
emit q->userVerified(masterKey.userId);
} else {
qCWarning(E2EE) << "Master key signature verification failed" << masterKey.userId;
}
}
}
void ConnectionEncryptionData::handleDevicesList(
const QHash<QString, QHash<QString, QueryKeysJob::DeviceInformation>>& newDeviceKeys)
{
for(const auto &[user, keys] : newDeviceKeys.asKeyValueRange()) {
const auto oldDevices = deviceKeys[user];
auto query = database.prepareQuery("SELECT * FROM self_signing_keys WHERE userId=:userId;"_L1);
query.bindValue(":userId"_L1, user);
database.execute(query);
const auto selfSigningKey = query.next() ? query.value("key"_L1).toString() : QString();
deviceKeys[user].clear();
selfVerifiedDevices[user].clear();
for (const auto &device : keys) {
if (device.userId != user) {
qWarning(E2EE)
<< "mxId mismatch during device key verification:"
<< device.userId << user;
continue;
}
if (!std::ranges::all_of(device.algorithms, isSupportedAlgorithm)) {
qWarning(E2EE) << "Unsupported encryption algorithms found"
<< device.algorithms;
continue;
}
if (!verifyIdentitySignature(device, device.deviceId,
device.userId)) {
qWarning(E2EE) << "Failed to verify device keys signature. "
"Skipping device" << device.userId << device.deviceId;
continue;
}
if (const auto oldDeviceKeys = oldDevices.value(device.deviceId);
!oldDeviceKeys.deviceId.isEmpty()) // We've seen this device...
{
if (const auto keyId = "ed25519:"_L1 + device.deviceId;
oldDeviceKeys.keys[keyId] != device.keys[keyId])
// ...but its keys that came now are not the same
{
qDebug(E2EE)
<< "Device reuse detected. Skipping device" << device.userId << device.deviceId;
continue;
}
}
if (!selfSigningKey.isEmpty() && !device.signatures[user]["ed25519:"_L1 + selfSigningKey].isEmpty()) {
if (ed25519VerifySignature(selfSigningKey, toJson(static_cast<const DeviceKeys&>(device)), device.signatures[user]["ed25519:"_L1 + selfSigningKey])) {
selfVerifiedDevices[user][device.deviceId] = true;
emit q->sessionVerified(user, device.deviceId);
} else {
qCWarning(E2EE) << "failed self signing signature check" << user << device.deviceId;
}
}
deviceKeys[user][device.deviceId] = SLICE(device, DeviceKeys);
}
outdatedUsers -= user;
}
}
void ConnectionEncryptionData::handleQueryKeys(const QueryKeysJob::Response& keys)
{
database.transaction();
handleMasterKeys(keys.masterKeys);
handleSelfSigningKeys(keys.selfSigningKeys);
handleUserSigningKeys(keys.userSigningKeys);
checkVerifiedMasterKeys(keys.masterKeys);
handleDevicesList(keys.deviceKeys);
saveDevicesList();
database.commit();
// A completely faithful code would call std::partition() with bare
// isKnownCurveKey(), then handleEncryptedToDeviceEvent() on each event
// with the known key, and then std::erase()... but
// handleEncryptedToDeviceEvent() doesn't have side effects on the handled
// events so a small corner-cutting should be fine.
std::erase_if(pendingEncryptedEvents,
[this](const event_ptr_tt<EncryptedEvent>& pendingEvent) {
if (!isKnownCurveKey(pendingEvent->senderId(),
pendingEvent->senderKey()))
return false;
handleEncryptedToDeviceEvent(*pendingEvent);
return true;
});
}
void ConnectionEncryptionData::encryptionUpdate(const QList<QString>& forUsers)
{
for (const auto& userId : forUsers)
if (!trackedUsers.contains(userId)) {
trackedUsers += userId;
outdatedUsers += userId;
encryptionUpdateRequired = true;
}
}
bool ConnectionEncryptionData::createOlmSession(
const QString& targetUserId, const QString& targetDeviceId,
const OneTimeKeys& oneTimeKeyObject)
{
static QOlmUtility verifier;
qDebug(E2EE) << "Creating a new session for" << targetUserId
<< targetDeviceId;
if (oneTimeKeyObject.isEmpty()) {
qWarning(E2EE) << "No one time key for" << targetUserId
<< targetDeviceId;
return false;
}
auto* signedOneTimeKey =
std::get_if<SignedOneTimeKey>(&*oneTimeKeyObject.begin());
if (!signedOneTimeKey) {
qWarning(E2EE) << "No signed one time key for" << targetUserId
<< targetDeviceId;
return false;
}
// Verify contents of signedOneTimeKey - for that, drop `signatures` and
// `unsigned` and then verify the object against the respective signature
const auto signature =
signedOneTimeKey->signature(targetUserId, targetDeviceId);
if (!verifier.ed25519Verify(
q->edKeyForUserDevice(targetUserId, targetDeviceId).toLatin1(),
signedOneTimeKey->toJsonForVerification(), signature)) {
qWarning(E2EE) << "Failed to verify one-time-key signature for"
<< targetUserId << targetDeviceId
<< ". Skipping this device.";
return false;
}
const auto recipientCurveKey =
curveKeyForUserDevice(targetUserId, targetDeviceId).toLatin1();
auto session = olmAccount.createOutboundSession(recipientCurveKey,
signedOneTimeKey->key());
if (!session) {
qCWarning(E2EE) << "Failed to create olm session for "
<< recipientCurveKey << session.error();
return false;
}
saveSession(*session, recipientCurveKey);
olmSessions[recipientCurveKey].push_back(std::move(*session));
return true;
}
std::pair<QOlmMessage::Type, QByteArray>
ConnectionEncryptionData::olmEncryptMessage(const QString& userId,
const QString& device,
const QByteArray& message) const
{
const auto& curveKey = curveKeyForUserDevice(userId, device).toLatin1();
const auto& olmSession = olmSessions.at(curveKey).front();
const auto result = olmSession.encrypt(message);
database.updateOlmSession(curveKey, olmSession);
return { result.type(), result.toCiphertext() };
}
QJsonObject ConnectionEncryptionData::assembleEncryptedContent(
QJsonObject payloadJson, const QString& targetUserId,
const QString& targetDeviceId) const
{
payloadJson.insert(SenderKey, q->userId());
payloadJson.insert("keys"_L1,
QJsonObject{
{ Ed25519Key, olmAccount.identityKeys().ed25519 } });
payloadJson.insert("recipient"_L1, targetUserId);
payloadJson.insert(
"recipient_keys"_L1,
QJsonObject{ { Ed25519Key,
q->edKeyForUserDevice(targetUserId, targetDeviceId) } });
const auto [type, cipherText] = olmEncryptMessage(
targetUserId, targetDeviceId,
QJsonDocument(payloadJson).toJson(QJsonDocument::Compact));
QJsonObject encrypted{
{ curveKeyForUserDevice(targetUserId, targetDeviceId),
QJsonObject{ { "type"_L1, type },
{ "body"_L1, QString::fromLatin1(cipherText) } } }
};
return EncryptedEvent(encrypted, olmAccount.identityKeys().curve25519)
.contentJson();
}
std::pair<QByteArray, QByteArray> doDecryptMessage(const QOlmSession& session,
const QOlmMessage& message,
auto&& andThen)
{
const auto expectedMessage = session.decrypt(message);
if (expectedMessage) {
const auto result = std::pair{ *expectedMessage, session.sessionId() };
andThen();
return result;
}
const auto errorLine = message.type() == QOlmMessage::PreKey
? "Failed to decrypt prekey message:"
: "Failed to decrypt message:";
qCDebug(E2EE) << errorLine << expectedMessage.error();
return {};
}
std::pair<QByteArray, QByteArray> ConnectionEncryptionData::sessionDecryptMessage(
const QJsonObject& personalCipherObject, const QByteArray& senderKey)
{
const auto msgType = static_cast<QOlmMessage::Type>(
personalCipherObject.value(TypeKey).toInt(-1));
if (msgType != QOlmMessage::General && msgType != QOlmMessage::PreKey) {
qCWarning(E2EE) << "Olm message has incorrect type" << msgType;
return {};
}
const QOlmMessage message{
personalCipherObject.value(BodyKey).toString().toLatin1(), msgType
};
for (const auto& session : olmSessions[senderKey])
if (msgType == QOlmMessage::General
|| session.matchesInboundSessionFrom(senderKey, message)) {
return doDecryptMessage(session, message, [this, &session] {
q->database()->setOlmSessionLastReceived(
session.sessionId(), QDateTime::currentDateTime());
});
}
if (msgType == QOlmMessage::General) {
qCWarning(E2EE) << "Failed to decrypt message";
return {};
}
qCDebug(E2EE) << "Creating new inbound session"; // Pre-key messages only
auto newSessionResult =
olmAccount.createInboundSessionFrom(senderKey, message);
if (!newSessionResult) {
qCWarning(E2EE) << "Failed to create inbound session for" << senderKey;
return {};
}
auto&& newSession = std::move(*newSessionResult);
if (olmAccount.removeOneTimeKeys(newSession) != OLM_SUCCESS) {
qWarning(E2EE) << "Failed to remove one time key for session"
<< newSession.sessionId();
// Keep going though
}
return doDecryptMessage(newSession, message, [this, &senderKey, &newSession] {
saveSession(newSession, senderKey);
olmSessions[senderKey].push_back(std::move(newSession));
});
}
std::pair<EventPtr, QByteArray> ConnectionEncryptionData::sessionDecryptMessage(
const EncryptedEvent& encryptedEvent)
{
if (encryptedEvent.algorithm() != OlmV1Curve25519AesSha2AlgoKey)
return {};
const auto identityKey = olmAccount.identityKeys().curve25519;
const auto personalCipherObject = encryptedEvent.ciphertext(identityKey);
if (personalCipherObject.isEmpty()) {
qDebug(E2EE) << "Encrypted event is not for the current device";
return {};
}
const auto [decrypted, olmSessionId] =
sessionDecryptMessage(personalCipherObject,
encryptedEvent.senderKey().toLatin1());
if (decrypted.isEmpty()) {
qDebug(E2EE) << "Problem with new session from senderKey:"
<< encryptedEvent.senderKey()
<< olmAccount.oneTimeKeys().keys;
auto query = database.prepareQuery(
"SELECT deviceId FROM tracked_devices WHERE curveKey=:curveKey;"_L1);
query.bindValue(":curveKey"_L1, encryptedEvent.senderKey());
database.execute(query);
if (!query.next()) {
qCWarning(E2EE) << "Unknown device while trying to recover from broken olm session";
return {};
}
auto senderId = encryptedEvent.senderId();
auto deviceId = query.value("deviceId"_L1).toString();
QHash<QString, QHash<QString, QString>> hash{ { encryptedEvent.senderId(),
{ { deviceId, "signed_curve25519"_L1 } } } };
q->callApi<ClaimKeysJob>(hash).then(q, [this, deviceId, senderId](const auto* job) {
if (triedDevices.contains({ senderId, deviceId })) {
return;
}
triedDevices += { senderId, deviceId };
qDebug(E2EE) << "Sending dummy event to" << senderId << deviceId;
createOlmSession(senderId, deviceId, job->oneTimeKeys()[senderId][deviceId]);
q->sendToDevice(senderId, deviceId, DummyEvent(), true);
});
return {};
}
auto&& decryptedEvent =
fromJson<EventPtr>(QJsonDocument::fromJson(decrypted));
if (auto sender = decryptedEvent->fullJson()[SenderKey].toString();
sender != encryptedEvent.senderId()) {
qWarning(E2EE) << "Found user" << sender << "instead of sender" << encryptedEvent.senderId()
<< "in Olm plaintext";
return {};
}
auto query = database.prepareQuery(QStringLiteral(
"SELECT edKey FROM tracked_devices WHERE curveKey=:curveKey;"));
const auto senderKey = encryptedEvent.contentPart<QString>(SenderKeyKey);
query.bindValue(":curveKey"_L1, senderKey);
database.execute(query);
if (!query.next()) {
qWarning(E2EE) << "Received olm message from unknown device" << senderKey;
return {};
}
if (auto edKey = decryptedEvent->fullJson()["keys"_L1][Ed25519Key].toString();
edKey.isEmpty() || query.value("edKey"_L1).toString() != edKey) //
{
qDebug(E2EE) << "Received olm message with invalid ed key";
return {};
}
// TODO: keys to constants
const auto decryptedEventObject = decryptedEvent->fullJson();
if (const auto recipient =
decryptedEventObject.value("recipient"_L1).toString();
recipient != q->userId()) //
{
qDebug(E2EE) << "Found user" << recipient << "instead of" << q->userId()
<< "in Olm plaintext";
return {};
}
if (const auto ourKey =
decryptedEventObject["recipient_keys"_L1][Ed25519Key].toString();
ourKey != olmAccount.identityKeys().ed25519) //
{
qDebug(E2EE) << "Found key" << ourKey
<< "instead of our own ed25519 key in Olm plaintext";
return {};
}
return { std::move(decryptedEvent), olmSessionId };
}
void ConnectionEncryptionData::doSendSessionKeyToDevices(
const QString& roomId, const QByteArray& sessionId,
const QByteArray& sessionKey, uint32_t messageIndex,
const QMultiHash<QString, QString>& devices)
{
qDebug(E2EE) << "Sending room key to devices:" << sessionId << messageIndex;
QHash<QString, QHash<QString, QString>> hash;
for (const auto& [userId, deviceId] : devices.asKeyValueRange())
if (!hasOlmSession(userId, deviceId)) {
hash[userId].insert(deviceId, "signed_curve25519"_L1);
qDebug(E2EE) << "Adding" << userId << deviceId
<< "to keys to claim";
}
const auto sendKey = [devices, this, sessionId, messageIndex, sessionKey,
roomId] {
QHash<QString, QHash<QString, QJsonObject>> usersToDevicesToContent;
for (const auto& [targetUserId, targetDeviceId] : devices.asKeyValueRange()) {
if (!hasOlmSession(targetUserId, targetDeviceId))
continue;
// Noisy and leaks the key to logs but nice for debugging
// qDebug(E2EE) << "Creating the payload for" << targetUserId
// << targetDeviceId << sessionId << sessionKey.toHex();
const auto keyEventJson =
RoomKeyEvent(MegolmV1AesSha2AlgoKey, roomId,
QString::fromLatin1(sessionId),
QString::fromLatin1(sessionKey))
.fullJson();
usersToDevicesToContent[targetUserId][targetDeviceId] =
assembleEncryptedContent(keyEventJson, targetUserId,
targetDeviceId);
}
if (!usersToDevicesToContent.empty()) {
q->sendToDevices(EncryptedEvent::TypeId, usersToDevicesToContent);
QVector<std::tuple<QString, QString, QString>> receivedDevices;
receivedDevices.reserve(devices.size());
for (const auto& [user, device] : devices.asKeyValueRange())
receivedDevices.push_back(
{ user, device, curveKeyForUserDevice(user, device) });
database.setDevicesReceivedKey(roomId, receivedDevices,
sessionId, messageIndex);
}
};
if (hash.isEmpty()) {
sendKey();
return;
}
q->callApi<ClaimKeysJob>(hash).then(q, [this, sendKey](const ClaimKeysJob* job) {
for (const auto& [userId, userDevices] : job->oneTimeKeys().asKeyValueRange())
for (const auto& [deviceId, keys] : std::as_const(userDevices).asKeyValueRange())
createOlmSession(userId, deviceId, keys);
sendKey();
});
}
void ConnectionEncryptionData::sendSessionKeyToDevices(
const QString& roomId, const QOlmOutboundGroupSession& outboundSession,
const QMultiHash<QString, QString>& devices)
{
auto closure = std::bind_front(&ConnectionEncryptionData::doSendSessionKeyToDevices, this,
roomId, outboundSession.sessionId(), outboundSession.sessionKey(),
outboundSession.sessionMessageIndex(), devices);
if (currentQueryKeysJob != nullptr) {
currentQueryKeysJob = currentQueryKeysJob.onResult(q, std::move(closure));
} else
closure();
}
ConnectionEncryptionData::ConnectionEncryptionData(Connection* connection,
PicklingKey&& picklingKey)
: q(connection)
, olmAccount(q->userId(), q->deviceId())
, database(q->userId(), q->deviceId(), std::move(picklingKey))
, olmSessions(database.loadOlmSessions())
{
QObject::connect(&olmAccount, &QOlmAccount::needsSave, q,
[this] { saveOlmAccount(); });
}
void ConnectionEncryptionData::saveOlmAccount()
{
qCDebug(E2EE) << "Saving olm account";
database.storeOlmAccount(olmAccount);
}
void ConnectionEncryptionData::reloadDevices()
{
outdatedUsers = trackedUsers;
loadOutdatedUserDevices();
}
bool ConnectionEncryptionData::hasConflictingDeviceIdsAndCrossSigningKeys(const QString& userId)
{
auto devices = q->devicesForUser(userId);
auto selfQuery = database.prepareQuery("SELECT key FROM self_signing_keys WHERE userId=:userId;"_L1);
selfQuery.bindValue(":userId"_L1, userId);
database.execute(selfQuery);
if (selfQuery.next() && devices.contains(selfQuery.value("key"_L1).toString()))
return true;
if (devices.contains(q->masterKeyForUser(userId)))
return true;
auto userQuery = database.prepareQuery("SELECT key FROM user_signing_keys WHERE userId=:userId;"_L1);
userQuery.bindValue(":userId"_L1, userId);
database.execute(userQuery);
return userQuery.next() && devices.contains(userQuery.value("key"_L1).toString());
}
|