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 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628
|
import copy
import json
import os
import time
from datetime import datetime, timedelta
from pathlib import Path
import pytest
from helpers import faker
from olm import Account, OutboundGroupSession
from nio.crypto import (
DeviceStore,
GroupSessionStore,
InboundGroupSession,
Olm,
OlmDevice,
OutboundSession,
OutgoingKeyRequest,
Session,
SessionStore,
)
from nio.events import (
DummyEvent,
ForwardedRoomKeyEvent,
MegolmEvent,
OlmEvent,
RoomKeyEvent,
RoomKeyRequest,
RoomKeyRequestCancellation,
RoomMessageText,
ToDeviceEvent,
UnknownBadEvent,
)
from nio.exceptions import EncryptionError, GroupEncryptionError, OlmTrustError
from nio.responses import KeysClaimResponse, KeysQueryResponse, KeysUploadResponse
from nio.store import DefaultStore, Ed25519Key, Key, KeyStore
AliceId = "@alice:example.org"
Alice_device = "ALDEVICE"
BobId = "@bob:example.org"
Bob_device = "BOBDEVICE"
MaloryId = "@malory:example.org"
Malory_device = "MALORYDEVICE"
PICKLE_KEY = "DEFAULT_KEY"
TEST_ROOM = "!test_room"
ephemeral_dir = os.path.join(os.curdir, "tests/data/encryption")
def ephemeral(func):
def wrapper(*args, **kwargs):
try:
ret = func(*args, **kwargs)
finally:
os.remove(os.path.join(ephemeral_dir, "@ephemeral:localhost_DEVICEID.db"))
return ret
return wrapper
@pytest.fixture
def olm_account(tempdir):
return Olm(
faker.mx_id(), faker.device_id(), DefaultStore("ephemeral", "DEVICEID", tempdir)
)
@pytest.fixture
def bob_account(tempdir):
return Olm(
faker.mx_id(), faker.device_id(), DefaultStore("ephemeral", "DEVICEID", tempdir)
)
@pytest.fixture
def alice_account_pair(tempdir):
first_device_id = faker.device_id()
second_device_id = faker.device_id()
first = Olm(
AliceId, faker.device_id(), DefaultStore(AliceId, first_device_id, tempdir)
)
second = Olm(
AliceId, faker.device_id(), DefaultStore(AliceId, second_device_id, tempdir)
)
first_device = OlmDevice(
first.user_id, first.device_id, first.account.identity_keys
)
second_device = OlmDevice(
second.user_id, second.device_id, second.account.identity_keys
)
first.device_store.add(second_device)
second.device_store.add(first_device)
first.verify_device(second_device)
second.verify_device(first_device)
return (first, second)
class TestClass:
@staticmethod
def _load_response(filename):
return json.loads(Path(filename).read_text())
def _get_store(self, user_id, device_id, pickle_key=""):
return DefaultStore(user_id, device_id, ephemeral_dir, pickle_key)
@staticmethod
def olm_message_to_event(message_dict, recipient, sender):
olm_content = message_dict["messages"][recipient.user_id][recipient.device_id]
return {
"sender": sender.user_id,
"type": "m.room.encrypted",
"content": olm_content,
}
@property
def ephemeral_olm(self):
user_id = "@ephemeral:localhost"
device_id = "DEVICEID"
return Olm(user_id, device_id, self._get_store(user_id, device_id))
@ephemeral
def test_new_account_creation(self):
olm = self.ephemeral_olm
assert isinstance(olm.account, Account)
def _load(self, user_id, device_id, pickle_key=""):
return Olm(user_id, device_id, self._get_store(user_id, device_id, pickle_key))
def test_account_loading(self):
olm = self._load("example", "DEVICEID", PICKLE_KEY)
assert isinstance(olm.account, Account)
assert (
olm.account.identity_keys["curve25519"]
== "Xjuu9d2KjHLGIHpCOCHS7hONQahapiwI1MhVmlPlCFM"
)
assert (
olm.account.identity_keys["ed25519"]
== "FEfrmWlasr4tcMtbNX/BU5lbdjmpt3ptg8ApTD8YAh4"
)
def test_fingerprint_store(self, monkeypatch):
def mocksave(self):
return
monkeypatch.setattr(KeyStore, "_save", mocksave)
store = KeyStore(os.path.join(ephemeral_dir, "ephemeral_devices"))
account = Account()
device = OlmDevice("example", "DEVICEID", account.identity_keys)
key = Key.from_olmdevice(device)
assert key not in store
assert store.add(key)
assert key in store
assert store.remove(key)
assert store.check(key) is False
def test_fingerprint_store_loading(self):
store = KeyStore(os.path.join(ephemeral_dir, "known_devices"))
key = Ed25519Key(
"example", "DEVICEID", "2MX1WOCAmE9eyywGdiMsQ4RxL2SIKVeyJXiSjVFycpA"
)
assert key in store
def test_invalid_store_entry_equality(self):
entry = Ed25519Key(
"example", "DEVICEID", "2MX1WOCAmE9eyywGdiMsQ4RxL2SIKVeyJXiSjVFycpA"
)
assert entry != 1
def test_differing_store_entries(self):
alice = Ed25519Key(
"alice", "DEVICEID", "2MX1WOCAmE9eyywGdiMsQ4RxL2SIKVeyJXiSjVFycpA"
)
bob = Ed25519Key(
"bob", "DEVICEDI", "3MX1WOCAmE9eyywGdiMsQ4RxL2SIKVeyJXiSjVFycpA"
)
assert alice != bob
def _create_session(self):
alice = Account()
bob = Account()
bob.generate_one_time_keys(1)
one_time = list(bob.one_time_keys["curve25519"].values())[0]
id_key = bob.identity_keys["curve25519"]
s = OutboundSession(alice, id_key, one_time)
return alice, bob, s
def test_session_store(self):
_alice, bob, s = self._create_session()
store = SessionStore()
store.add(bob.identity_keys["curve25519"], s)
assert s in store
def test_session_store_sort(self):
alice, bob, s = self._create_session()
bob.generate_one_time_keys(1)
one_time = list(bob.one_time_keys["curve25519"].values())[0]
curve_key = bob.identity_keys["curve25519"]
s2 = OutboundSession(alice, curve_key, one_time)
store = SessionStore()
store.add(curve_key, s)
store.add(curve_key, s2)
if s.use_time > s2.use_time:
assert s == store.get(curve_key)
else:
assert s2 == store.get(curve_key)
def test_device_store(self):
alice = OlmDevice(
"example",
"DEVICEID",
{
"ed25519": "2MX1WOCAmE9eyywGdiMsQ4RxL2SIKVeyJXiSjVFycpA",
"curve25519": "3MX1WOCAmE9eyywGdiMsQ4RxL2SIKVeyJXiSjVFycpA",
},
)
store = DeviceStore()
assert store.add(alice)
assert store.add(alice) is False
assert alice in store
@ephemeral
def test_olm_outbound_session_create(self):
bob = Account()
bob.generate_one_time_keys(1)
one_time = list(bob.one_time_keys["curve25519"].values())[0]
bob_device = OlmDevice(BobId, Bob_device, bob.identity_keys)
olm = self.ephemeral_olm
olm.device_store[bob_device.user_id][bob_device.id] = bob_device
olm.create_session(one_time, bob_device.curve25519)
assert isinstance(
olm.session_store.get(bob.identity_keys["curve25519"]), OutboundSession
)
def test_olm_session_load(self):
olm = self._load("example", "DEVICEID", PICKLE_KEY)
bob_session = olm.session_store.get(
"+Qs131S/odNdWG6VJ8hiy9YZW0us24wnsDjYQbaxLk4"
)
assert bob_session
assert bob_session.id == "EeEiqT9LjCtECaN7WTqcBQ7D5Dwm4+/L9Uxr1IyPAts"
@ephemeral
def test_olm_group_session_store(self):
olm = self.ephemeral_olm
bob_account = Account()
outbound_session = OutboundGroupSession()
olm.create_group_session(
bob_account.identity_keys["curve25519"],
bob_account.identity_keys["ed25519"],
"!test_room",
outbound_session.id,
outbound_session.session_key,
)
del olm
olm = self.ephemeral_olm
bob_session = olm.inbound_group_store.get(
"!test_room", bob_account.identity_keys["curve25519"], outbound_session.id
)
assert bob_session
assert bob_session.id == outbound_session.id
@ephemeral
def test_keys_query(self):
olm = self.ephemeral_olm
parsed_dict = TestClass._load_response("tests/data/keys_query.json")
response = KeysQueryResponse.from_dict(parsed_dict)
assert isinstance(response, KeysQueryResponse)
olm.handle_response(response)
device = olm.device_store["@alice:example.org"]["JLAFKJWSCS"]
assert device.ed25519 == "nE6W2fCblxDcOFmeEtCHNl8/l8bXcu7GKyAswA4r3mM"
del olm
olm = self.ephemeral_olm
device = olm.device_store["@alice:example.org"]["JLAFKJWSCS"]
assert device.ed25519 == "nE6W2fCblxDcOFmeEtCHNl8/l8bXcu7GKyAswA4r3mM"
@ephemeral
def test_same_query_response_twice(self):
olm = self.ephemeral_olm
parsed_dict = TestClass._load_response("tests/data/keys_query.json")
response = KeysQueryResponse.from_dict(parsed_dict)
olm.handle_response(response)
assert response.changed
# TODO check out why this fails under python2 if we remove the copy()
# call.
response2 = copy.copy(response)
olm.handle_response(response)
assert response2.changed
def test_olm_inbound_session(self, monkeypatch):
def mocksave(self):
return
monkeypatch.setattr(KeyStore, "_save", mocksave)
# create three new accounts
alice = self._load(AliceId, Alice_device)
bob = self._load(BobId, Bob_device)
malory = self._load(BobId, Bob_device)
# create olm devices for each others known devices list
alice_device = OlmDevice(AliceId, Alice_device, alice.account.identity_keys)
bob_device = OlmDevice(BobId, Bob_device, bob.account.identity_keys)
malory_device = OlmDevice(MaloryId, Malory_device, malory.account.identity_keys)
# add the devices to the device list
alice.device_store.add(bob_device)
alice.device_store.add(malory_device)
bob.device_store.add(alice_device)
# bob creates one time keys
bob.account.generate_one_time_keys(1)
one_time = list(bob.account.one_time_keys["curve25519"].values())[0]
# Mark the keys as published
bob.account.mark_keys_as_published()
# alice creates an outbound olm session with bob
alice.create_session(one_time, bob_device.curve25519)
# alice creates an group session
alice.create_outbound_group_session("!test:example.org")
group_session = alice.outbound_group_sessions["!test:example.org"]
# alice shares the group session with bob, but bob isn't verified
with pytest.raises(OlmTrustError):
_sharing_with, to_device = alice.share_group_session(
"!test:example.org", [BobId]
)
alice.verify_device(bob_device)
# alice shares the group session with bob and malory, but malory isn't
# blocked
with pytest.raises(OlmTrustError):
_sharing_with, to_device = alice.share_group_session(
"!test:example.org", [BobId, MaloryId]
)
alice.blacklist_device(malory_device)
_sharing_with, to_device = alice.share_group_session(
"!test:example.org", [BobId, MaloryId]
)
# check that we aren't sharing the group session with malory
with pytest.raises(KeyError):
to_device["messages"][MaloryId][malory_device.id]["ciphertext"]
ciphertext = to_device["messages"][BobId][bob_device.id]["ciphertext"]
olm_event_dict = {
"sender": AliceId,
"type": "m.room.encrypted",
"content": {
"algorithm": Olm._olm_algorithm,
"sender_key": alice_device.curve25519,
"ciphertext": ciphertext,
},
}
olm_event = OlmEvent.from_dict(olm_event_dict)
assert isinstance(olm_event, OlmEvent)
# bob decrypts the message and creates a new inbound session with alice
try:
# pdb.set_trace()
bob.decrypt_event(olm_event)
# we check that the session is there
assert bob.session_store.get(alice_device.curve25519)
# we check that the group session is there
assert bob.inbound_group_store.get(
"!test:example.org",
alice_device.curve25519,
group_session.id,
)
# Test another round of sharing, this time with an existing session
alice.create_outbound_group_session(TEST_ROOM)
group_session = alice.outbound_group_sessions[TEST_ROOM]
_sharing_with, to_device = alice.share_group_session(
TEST_ROOM, [BobId, MaloryId]
)
ciphertext = to_device["messages"][BobId][bob_device.id]["ciphertext"]
olm_event_dict = {
"sender": AliceId,
"type": "m.room.encrypted",
"content": {
"algorithm": Olm._olm_algorithm,
"sender_key": alice_device.curve25519,
"ciphertext": ciphertext,
},
}
olm_event = OlmEvent.from_dict(olm_event_dict)
assert isinstance(olm_event, OlmEvent)
event = bob.decrypt_event(olm_event)
assert event
assert bob.inbound_group_store.get(
TEST_ROOM,
alice_device.curve25519,
group_session.id,
)
finally:
# remove the databases, the known devices store is handled by
# monkeypatching
os.remove(os.path.join(ephemeral_dir, f"{AliceId}_{Alice_device}.db"))
os.remove(os.path.join(ephemeral_dir, f"{BobId}_{Bob_device}.db"))
def test_group_session_sharing(self, monkeypatch):
def mocksave(self):
return
monkeypatch.setattr(KeyStore, "_save", mocksave)
# create three new accounts
alice = self._load(AliceId, Alice_device)
bob = self._load(BobId, Bob_device)
malory = self._load(BobId, Bob_device)
# create olm devices for each others known devices list
alice_device = OlmDevice(AliceId, Alice_device, alice.account.identity_keys)
bob_device = OlmDevice(BobId, Bob_device, bob.account.identity_keys)
malory_device = OlmDevice(MaloryId, Malory_device, malory.account.identity_keys)
# add the devices to the device list
alice.device_store.add(bob_device)
alice.device_store.add(malory_device)
bob.device_store.add(alice_device)
# bob creates one time keys
bob.account.generate_one_time_keys(1)
one_time = list(bob.account.one_time_keys["curve25519"].values())[0]
# Mark the keys as published
bob.account.mark_keys_as_published()
# alice creates an outbound olm session with bob
alice.create_session(one_time, bob_device.curve25519)
alice.verify_device(bob_device)
alice.verify_device(malory_device)
alice._maxToDeviceMessagesPerRequest = 1
sharing_with, _to_device = alice.share_group_session(
"!test:example.org", [BobId, MaloryId]
)
group_session = alice.outbound_group_sessions["!test:example.org"]
assert group_session
assert len(sharing_with) == 1
assert not group_session.users_shared_with
group_session.users_shared_with.update(sharing_with)
sharing_with, _to_device = alice.share_group_session(
"!test:example.org", [BobId, MaloryId]
)
assert len(sharing_with) == 1
os.remove(os.path.join(ephemeral_dir, f"{AliceId}_{Alice_device}.db"))
os.remove(os.path.join(ephemeral_dir, f"{BobId}_{Bob_device}.db"))
@ephemeral
def test_room_key_event(self):
olm = self.ephemeral_olm
session = OutboundGroupSession()
payload = {
"sender": BobId,
"sender_device": Bob_device,
"type": "m.room_key",
"content": {
"algorithm": "m.megolm.v1.aes-sha2",
"room_id": TEST_ROOM,
"session_id": session.id,
"session_key": session.session_key,
},
"keys": {},
}
bad_event = olm._handle_room_key_event(
BobId, "Xjuu9d2KjHLGIHpCOCHS7hONQahapiwI1MhVmlPlCFM", {}
)
assert isinstance(bad_event, UnknownBadEvent)
event = olm._handle_room_key_event(
BobId, "Xjuu9d2KjHLGIHpCOCHS7hONQahapiwI1MhVmlPlCFM", payload
)
assert not event
payload["keys"] = {"ed25519": "FEfrmWlasr4tcMtbNX/BU5lbdjmpt3ptg8ApTD8YAh4"}
event = olm._handle_room_key_event(
BobId, "Xjuu9d2KjHLGIHpCOCHS7hONQahapiwI1MhVmlPlCFM", payload
)
assert isinstance(event, RoomKeyEvent)
def test_forwarded_room_key_event(self, alice_account_pair):
olm, bob = alice_account_pair
device = olm.device_store[bob.user_id][bob.device_id]
session = OutboundGroupSession()
session = InboundGroupSession(
session.session_key,
device.ed25519,
device.curve25519,
TEST_ROOM,
)
payload = {
"sender": device.user_id,
"sender_device": device.device_id,
"type": "m.forwarded_room_key",
"content": {
"algorithm": "m.megolm.v1.aes-sha2",
"room_id": session.room_id,
"session_id": session.id,
"session_key": session.export_session(session.first_known_index),
"sender_key": session.sender_key,
"sender_claimed_ed25519_key": session.ed25519,
"forwarding_curve25519_key_chain": session.forwarding_chain,
},
"keys": {"ed25519": session.ed25519},
}
bad_event = olm._handle_room_key_event(device.user_id, device.curve25519, {})
assert isinstance(bad_event, UnknownBadEvent)
event = olm._handle_forwarded_room_key_event(
device.user_id, device.curve25519, payload
)
assert not event
key_request = OutgoingKeyRequest(
session.id,
session.id,
session.room_id,
"m.megolm.v1.aes-sha2",
)
olm.outgoing_key_requests[session.id] = key_request
event = olm._handle_olm_event(device.user_id, device.curve25519, payload)
assert isinstance(event, ForwardedRoomKeyEvent)
def test_user_verification_status(self, monkeypatch):
def mocksave(self):
return
monkeypatch.setattr(KeyStore, "_save", mocksave)
# create three new accounts
alice = self._load(AliceId, Alice_device)
bob = self._load(BobId, Bob_device)
# create olm devices for each others known devices list
bob_device = OlmDevice(BobId, Bob_device, bob.account.identity_keys)
bob2_device = OlmDevice(BobId, Malory_device, bob.account.identity_keys)
alice.device_store.add(bob_device)
assert not alice.user_fully_verified(BobId)
alice.verify_device(bob_device)
assert alice.user_fully_verified(BobId)
alice.device_store.add(bob2_device)
assert not alice.user_fully_verified(BobId)
alice.verify_device(bob2_device)
assert alice.user_fully_verified(BobId)
os.remove(os.path.join(ephemeral_dir, f"{AliceId}_{Alice_device}.db"))
os.remove(os.path.join(ephemeral_dir, f"{BobId}_{Bob_device}.db"))
@ephemeral
def test_group_decryption(self):
olm = self.ephemeral_olm
olm.create_outbound_group_session(TEST_ROOM)
message = {
"type": "m.room.message",
"content": {
"msgtype": "m.text",
"body": "hello wordl",
},
}
with pytest.raises(GroupEncryptionError):
encrypted_dict = olm.group_encrypt(TEST_ROOM, message)
session = olm.outbound_group_sessions[TEST_ROOM]
session.shared = True
encrypted_dict = olm.group_encrypt(TEST_ROOM, message)
megolm = {"type": "m.room.encrypted", "content": encrypted_dict}
megolm_event = MegolmEvent.from_dict(megolm)
assert isinstance(megolm_event, UnknownBadEvent)
megolm["event_id"] = "1"
megolm["sender"] = "@ephemeral:example.org"
megolm["origin_server_ts"] = 0
megolm_event = MegolmEvent.from_dict(megolm)
assert isinstance(megolm_event, MegolmEvent)
with pytest.raises(EncryptionError):
event = olm.decrypt_megolm_event(megolm_event)
session_store = olm.inbound_group_store
olm.inbound_group_store = GroupSessionStore()
with pytest.raises(EncryptionError):
event = olm.decrypt_megolm_event(megolm_event)
olm.inbound_group_store = session_store
megolm_event.room_id = TEST_ROOM
event = olm.decrypt_event(megolm_event)
assert isinstance(event, RoomMessageText)
assert event.decrypted
@ephemeral
def test_key_sharing(self):
olm = self.ephemeral_olm
assert olm.should_upload_keys
to_share = olm.share_keys()
assert "device_keys" in to_share
assert "one_time_keys" in to_share
assert len(to_share["one_time_keys"]) == olm.account.max_one_time_keys // 2
response = KeysUploadResponse.from_dict(
{
"one_time_key_counts": {
"curve25519": 0,
"signed_curve25519": olm.account.max_one_time_keys // 2,
}
}
)
olm.handle_response(response)
assert not olm.should_upload_keys
with pytest.raises(
ValueError, match="Can't share any keys, too many keys already shared"
):
olm.share_keys()
olm.uploaded_key_count -= 1
assert olm.should_upload_keys
to_share = olm.share_keys()
assert "device_keys" not in to_share
assert "one_time_keys" in to_share
assert len(to_share["one_time_keys"]) == 1
def test_outbound_session_creation(self, monkeypatch):
def mocksave(self):
return
monkeypatch.setattr(KeyStore, "_save", mocksave)
alice = self._load(AliceId, Alice_device)
bob = self._load(BobId, Bob_device)
bob_device = OlmDevice(BobId, Bob_device, bob.account.identity_keys)
assert not alice.get_missing_sessions([BobId])
alice.device_store.add(bob_device)
missing = alice.get_missing_sessions([BobId])
assert not alice.session_store.get(bob_device.curve25519)
assert BobId in missing
assert Bob_device in missing[BobId]
to_share = bob.share_keys()
one_time_key = list(to_share["one_time_keys"].items())[0]
key_claim_dict = {
"one_time_keys": {
BobId: {
Bob_device: {one_time_key[0]: one_time_key[1]},
},
},
"failures": {},
}
response = KeysClaimResponse.from_dict(key_claim_dict, TEST_ROOM)
assert isinstance(response, KeysClaimResponse)
print(response)
alice.handle_response(response)
assert not alice.get_missing_sessions([BobId])
assert alice.session_store.get(bob_device.curve25519)
os.remove(os.path.join(ephemeral_dir, f"{AliceId}_{Alice_device}.db"))
os.remove(os.path.join(ephemeral_dir, f"{BobId}_{Bob_device}.db"))
def test_group_session_sharing_new(self, olm_account, bob_account):
alice = olm_account
bob = bob_account
alice_device = OlmDevice(
alice.user_id, alice.device_id, alice.account.identity_keys
)
bob_device = OlmDevice(bob.user_id, bob.device_id, bob.account.identity_keys)
alice.device_store.add(bob_device)
bob.device_store.add(alice_device)
bob.account.generate_one_time_keys(1)
one_time = list(bob.account.one_time_keys["curve25519"].values())[0]
bob.account.mark_keys_as_published()
alice.create_session(one_time, bob_device.curve25519)
sharing_with, _to_device = alice.share_group_session(
"!test:example.org", [bob.user_id], ignore_unverified_devices=True
)
assert len(sharing_with) == 1
assert alice.outbound_group_sessions["!test:example.org"]
assert alice.is_device_ignored(bob_device)
def test_session_unwedging(self, olm_account, bob_account):
alice = olm_account
bob = bob_account
alice_device = OlmDevice(
alice.user_id, alice.device_id, alice.account.identity_keys
)
bob_device = OlmDevice(bob.user_id, bob.device_id, bob.account.identity_keys)
alice.device_store.add(bob_device)
bob.device_store.add(alice_device)
bob.account.generate_one_time_keys(1)
one_time = list(bob.account.one_time_keys["curve25519"].values())[0]
bob.account.mark_keys_as_published()
alice.create_session(one_time, bob_device.curve25519)
# Let us pickle our session with bob here so we can later unpickle it
# and wedge our session.
alice_pickle = alice.session_store[bob_device.curve25519][0].pickle("")
# Share a initial olm encrypted message
_, to_device = alice.share_group_session(
TEST_ROOM, [bob.user_id], ignore_unverified_devices=True
)
outbound_session = alice.outbound_group_sessions[TEST_ROOM]
olm_message = self.olm_message_to_event(to_device, bob, alice)
# Pass the to-device event to bob and make sure we get the right events
event = ToDeviceEvent.parse_event(olm_message)
assert isinstance(event, OlmEvent)
decrypted_event = bob.decrypt_event(event)
assert isinstance(decrypted_event, RoomKeyEvent)
# Make sure bob got the room-key
assert bob.inbound_group_store
bob_session = bob.inbound_group_store.get(
TEST_ROOM, alice_device.curve25519, outbound_session.id
)
assert bob_session.id == outbound_session.id
# Now bob shares a room-key with alice
_, to_device = bob.share_group_session(
TEST_ROOM, [alice.user_id], ignore_unverified_devices=True
)
olm_message = self.olm_message_to_event(to_device, alice, bob)
event = ToDeviceEvent.parse_event(olm_message)
assert isinstance(event, OlmEvent)
decrypted_event = alice.decrypt_event(event)
assert isinstance(decrypted_event, RoomKeyEvent)
# Let us wedge the session now
session = alice.session_store[bob_device.curve25519][0]
alice.session_store[bob_device.curve25519][0] = Session.from_pickle(
alice_pickle, session.creation_time, "", session.use_time
)
alice.rotate_outbound_group_session(TEST_ROOM)
# Try to share a room-key now
_, to_device = alice.share_group_session(
TEST_ROOM, [bob.user_id], ignore_unverified_devices=True
)
# Set the creation time to be older than an hour, otherwise we will not
# be able to unwedge the session.
alice_session = bob.session_store.get(alice_device.curve25519)
alice_session.creation_time = datetime.now() - timedelta(hours=2)
olm_message = self.olm_message_to_event(to_device, bob, alice)
# Pass the to-device event to bob and make sure we get the right events
event = ToDeviceEvent.parse_event(olm_message)
assert isinstance(event, OlmEvent)
decrypted_event = bob.decrypt_event(event)
# Make sure that decryption failed
assert decrypted_event is None
# Make sure that we have queued a m.dummy message to be sent out as a
# to-device message
assert alice_device in bob.wedged_devices
# Bob should now claim new keys from alice, we're simulating this over
# here since the olm machine doesn't know how to do requests.
to_share = alice.share_keys()
one_time_key = list(to_share["one_time_keys"].items())[0]
key_claim_dict = {
"one_time_keys": {
alice.user_id: {
alice.device_id: {one_time_key[0]: one_time_key[1]},
},
},
"failures": {},
}
response = KeysClaimResponse.from_dict(key_claim_dict, TEST_ROOM)
assert not bob.outgoing_to_device_messages
assert isinstance(response, KeysClaimResponse)
bob.handle_response(response)
# After we claimed the keys a new Olm session will be created and a
# to-device message will be prepared for alice.
assert bob.outgoing_to_device_messages
message = bob.outgoing_to_device_messages[0]
assert message.type == "m.room.encrypted"
assert message.recipient == alice.user_id
assert message.recipient_device == alice.device_id
# Forward the message to alice.
event = ToDeviceEvent.parse_event(
self.olm_message_to_event(message.as_dict(), alice, bob)
)
assert isinstance(event, OlmEvent)
# Take out our currently used session for bob.
wedged_session = alice.session_store.get(bob_device.curve25519)
decrypted_event = alice.decrypt_event(event)
assert isinstance(decrypted_event, DummyEvent)
# Check that the dummy event created a new Olm session and that it is
# the preferred one.
new_session = alice.session_store.get(bob_device.curve25519)
assert wedged_session.use_time < new_session.use_time
assert wedged_session != new_session
# Try to mark the device again to be unwedged, this should fail since
# our creation time isn't old enough.
alice._mark_device_for_unwedging(alice_device.user_id, alice_device.curve25519)
assert alice_device not in bob.wedged_devices
def test_device_renaming(self, olm_account):
parsed_dict = TestClass._load_response("tests/data/keys_query.json")
response = KeysQueryResponse.from_dict(parsed_dict)
assert isinstance(response, KeysQueryResponse)
olm_account.handle_response(response)
device = olm_account.device_store["@alice:example.org"]["JLAFKJWSCS"]
assert device.ed25519 == "nE6W2fCblxDcOFmeEtCHNl8/l8bXcu7GKyAswA4r3mM"
assert device.display_name == "Alice's mobile phone"
parsed_dict["device_keys"]["@alice:example.org"]["JLAFKJWSCS"]["unsigned"][
"device_display_name"
] = "Phoney"
response = KeysQueryResponse.from_dict(parsed_dict)
olm_account.handle_response(response)
assert device.display_name == "Phoney"
def test_replay_attack_protection(self, olm_account, bob_account):
alice = olm_account
bob = bob_account
alice_device = OlmDevice(
alice.user_id, alice.device_id, alice.account.identity_keys
)
bob_device = OlmDevice(bob.user_id, bob.device_id, bob.account.identity_keys)
alice.device_store.add(bob_device)
bob.device_store.add(alice_device)
bob.account.generate_one_time_keys(1)
one_time = list(bob.account.one_time_keys["curve25519"].values())[0]
bob.account.mark_keys_as_published()
alice.create_session(one_time, bob_device.curve25519)
# Share a initial olm encrypted message
_, to_device = alice.share_group_session(
TEST_ROOM, [bob.user_id], ignore_unverified_devices=True
)
outbound_session = alice.outbound_group_sessions[TEST_ROOM]
outbound_session.shared = True
olm_message = self.olm_message_to_event(to_device, bob, alice)
# Pass the to-device event to bob and make sure we get the right events
event = ToDeviceEvent.parse_event(olm_message)
assert isinstance(event, OlmEvent)
decrypted_event = bob.decrypt_event(event)
assert isinstance(decrypted_event, RoomKeyEvent)
message = {
"type": "m.room.message",
"content": {"msgtype": "m.text", "body": "It's a secret to everybody."},
}
encrypted_content = alice.group_encrypt(TEST_ROOM, message)
encrypted_message = {
"event_id": "!event_id",
"type": "m.room.encrypted",
"sender": alice.user_id,
"origin_server_ts": int(time.time()),
"content": encrypted_content,
"room_id": TEST_ROOM,
}
event = MegolmEvent.from_dict(encrypted_message)
decrypted_event = bob.decrypt_event(event)
assert decrypted_event.body == message["content"]["body"]
# Let us now replay the event.
encrypted_message["event_id"] = "!new_event_id"
event = MegolmEvent.from_dict(encrypted_message)
with pytest.raises(EncryptionError):
bob.decrypt_megolm_event(event)
encrypted_message["event_id"] = "!event_id"
old_time = encrypted_message["origin_server_ts"]
encrypted_message["origin_server_ts"] += 100
event = MegolmEvent.from_dict(encrypted_message)
with pytest.raises(EncryptionError):
bob.decrypt_megolm_event(event)
# Let us now check that normal messages from the room history decrypt
# again.
encrypted_message["origin_server_ts"] = old_time
event = MegolmEvent.from_dict(encrypted_message)
decrypted_event = bob.decrypt_event(event)
assert decrypted_event.body == message["content"]["body"]
def test_key_forwards_with_ourselves(self, alice_account_pair):
alice, bob = alice_account_pair
bob_device = alice.device_store[bob.user_id][bob.device_id]
bob.account.generate_one_time_keys(1)
one_time = list(bob.account.one_time_keys["curve25519"].values())[0]
bob.account.mark_keys_as_published()
alice.create_session(one_time, bob_device.curve25519)
_, to_device = alice.share_group_session(
TEST_ROOM, [bob.user_id], ignore_unverified_devices=True
)
# Setup a working olm session by sharing a key from alice to bob
olm_message = self.olm_message_to_event(to_device, bob, alice)
event = ToDeviceEvent.parse_event(olm_message)
bob.decrypt_event(event)
# Bob shares a room session as well but alice never receives the
# session.
bob.share_group_session(
TEST_ROOM, [alice.user_id], ignore_unverified_devices=True
)
session = bob.outbound_group_sessions[TEST_ROOM]
session.shared = True
session.users_shared_with.add((alice.user_id, alice.device_id))
message = {
"type": "m.room.message",
"content": {"msgtype": "m.text", "body": "It's a secret to everybody."},
}
encrypted_content = bob.group_encrypt(TEST_ROOM, message)
encrypted_message = {
"event_id": "!event_id",
"type": "m.room.encrypted",
"sender": bob.user_id,
"origin_server_ts": int(time.time()),
"content": encrypted_content,
"room_id": TEST_ROOM,
}
event = MegolmEvent.from_dict(encrypted_message)
# Alice tries to decrypt the event but can't.
decrypted_event = alice.decrypt_event(event)
assert decrypted_event is None
key_request = event.as_key_request(
bob.user_id,
alice.device_id,
event.session_id,
)
outgoing_key_request = OutgoingKeyRequest(
event.session_id, event.session_id, TEST_ROOM, event.algorithm
)
alice.outgoing_key_requests[event.session_id] = outgoing_key_request
key_request = {
"sender": alice.user_id,
"type": "m.room_key_request",
"content": key_request.as_dict()["messages"][bob.user_id]["*"],
}
key_request_event = RoomKeyRequest.from_dict(key_request)
assert isinstance(key_request_event, RoomKeyRequest)
assert not bob.outgoing_to_device_messages
# Bob receives the event and queues it up for collection.
bob.handle_to_device_event(key_request_event)
assert key_request_event in bob.received_key_requests.values()
# Convert the key request event into a to-device message.
bob.collect_key_requests()
# Check that the message is now queued.
assert bob.outgoing_to_device_messages
to_device = bob.outgoing_to_device_messages[0]
# Let us now share the to-device message with Alice
olm_message = self.olm_message_to_event(to_device.as_dict(), alice, bob)
forwarded_key_event = ToDeviceEvent.parse_event(olm_message)
assert isinstance(forwarded_key_event, OlmEvent)
# Decrypt the olm event and check that we received a forwarded room
# key.
decrypted_event = alice.handle_to_device_event(forwarded_key_event)
assert isinstance(decrypted_event, ForwardedRoomKeyEvent)
# Alice tries to decrypt the previous event again.
decrypted_event = alice.decrypt_event(event)
assert isinstance(decrypted_event, RoomMessageText)
assert decrypted_event.body == "It's a secret to everybody."
def test_key_forwards_missing_session(self, alice_account_pair):
alice, bob = alice_account_pair
bob.create_outbound_group_session(TEST_ROOM)
alice_device = bob.device_store[alice.user_id][alice.device_id]
session = bob.outbound_group_sessions[TEST_ROOM]
session.shared = True
message = {
"type": "m.room.message",
"content": {"msgtype": "m.text", "body": "It's a secret to everybody."},
}
encrypted_content = bob.group_encrypt(TEST_ROOM, message)
encrypted_message = {
"event_id": "!event_id",
"type": "m.room.encrypted",
"sender": bob.user_id,
"origin_server_ts": int(time.time()),
"content": encrypted_content,
"room_id": TEST_ROOM,
}
event = MegolmEvent.from_dict(encrypted_message)
# Alice tries to decrypt the event but can't.
decrypted_event = alice.decrypt_event(event)
assert decrypted_event is None
key_request = event.as_key_request(
bob.user_id,
alice.device_id,
event.session_id,
)
outgoing_key_request = OutgoingKeyRequest(
event.session_id, event.session_id, TEST_ROOM, event.algorithm
)
alice.outgoing_key_requests[event.session_id] = outgoing_key_request
key_request = {
"sender": alice.user_id,
"type": "m.room_key_request",
"content": key_request.as_dict()["messages"][bob.user_id]["*"],
}
key_request_event = RoomKeyRequest.from_dict(key_request)
assert isinstance(key_request_event, RoomKeyRequest)
assert not bob.outgoing_to_device_messages
# Bob receives the event and queues it up for collection.
bob.handle_to_device_event(key_request_event)
assert key_request_event in bob.received_key_requests.values()
# Convert the key request event into a to-device message.
bob.collect_key_requests()
# Check that the message is not queued. We are missing a Olm session.
assert not bob.outgoing_to_device_messages
assert alice_device in bob.key_request_devices_no_session
assert (
key_request_event
in bob.key_requests_waiting_for_session[
alice_device.user_id, alice_device.id
].values()
)
# Let us do a key claim request.
to_share = alice.share_keys()
one_time_key = list(to_share["one_time_keys"].items())[0]
key_claim_dict = {
"one_time_keys": {
alice.user_id: {
alice.device_id: {one_time_key[0]: one_time_key[1]},
},
},
"failures": {},
}
response = KeysClaimResponse.from_dict(key_claim_dict)
bob.handle_response(response)
# We got a session now, the device is not waiting for a session anymore
assert alice_device not in bob.key_request_devices_no_session
# The key request is neither waiting for a session anymore.
assert (
key_request_event
not in bob.key_requests_waiting_for_session[
alice_device.user_id, alice_device.id
].values()
)
# The key request is now waiting to be collected again.
assert key_request_event in bob.received_key_requests.values()
# Let us collect it now.
bob.collect_key_requests()
# We found a to-device message now.
to_device = bob.outgoing_to_device_messages[0]
# Let us now share the to-device message with Alice
olm_message = self.olm_message_to_event(to_device.as_dict(), alice, bob)
forwarded_key_event = ToDeviceEvent.parse_event(olm_message)
assert isinstance(forwarded_key_event, OlmEvent)
# Decrypt the olm event and check that we received a forwarded room
# key.
decrypted_event = alice.handle_to_device_event(forwarded_key_event)
assert isinstance(decrypted_event, ForwardedRoomKeyEvent)
# Alice tries to decrypt the previous event again.
decrypted_event = alice.decrypt_event(event)
assert isinstance(decrypted_event, RoomMessageText)
assert decrypted_event.body == "It's a secret to everybody."
def test_key_forward_untrusted_device(self, alice_account_pair):
alice, bob = alice_account_pair
alice_device = bob.device_store[alice.user_id][alice.device_id]
bob_device = alice.device_store[bob.user_id][bob.device_id]
bob.unverify_device(alice_device)
bob.account.generate_one_time_keys(1)
one_time = list(bob.account.one_time_keys["curve25519"].values())[0]
bob.account.mark_keys_as_published()
alice.create_session(one_time, bob_device.curve25519)
_, to_device = alice.share_group_session(
TEST_ROOM, [bob.user_id], ignore_unverified_devices=True
)
# Setup a working olm session by sharing a key from alice to bob
olm_message = self.olm_message_to_event(to_device, bob, alice)
event = ToDeviceEvent.parse_event(olm_message)
bob.decrypt_event(event)
# Bob shares a room session as well but alice never receives the
# session.
bob.share_group_session(
TEST_ROOM, [alice.user_id], ignore_unverified_devices=True
)
session = bob.outbound_group_sessions[TEST_ROOM]
session.shared = True
session.users_shared_with.add((alice.user_id, alice.device_id))
message = {
"type": "m.room.message",
"content": {"msgtype": "m.text", "body": "It's a secret to everybody."},
}
encrypted_content = bob.group_encrypt(TEST_ROOM, message)
encrypted_message = {
"event_id": "!event_id",
"type": "m.room.encrypted",
"sender": bob.user_id,
"origin_server_ts": int(time.time()),
"content": encrypted_content,
"room_id": TEST_ROOM,
}
event = MegolmEvent.from_dict(encrypted_message)
# Alice tries to decrypt the event but can't.
decrypted_event = alice.decrypt_event(event)
assert decrypted_event is None
key_request = event.as_key_request(
bob.user_id,
alice.device_id,
event.session_id,
)
outgoing_key_request = OutgoingKeyRequest(
event.session_id, event.session_id, TEST_ROOM, event.algorithm
)
alice.outgoing_key_requests[event.session_id] = outgoing_key_request
key_request = {
"sender": alice.user_id,
"type": "m.room_key_request",
"content": key_request.as_dict()["messages"][bob.user_id]["*"],
}
key_request_event = RoomKeyRequest.from_dict(key_request)
assert isinstance(key_request_event, RoomKeyRequest)
assert not bob.outgoing_to_device_messages
# Bob receives the event and queues it up for collection.
bob.handle_to_device_event(key_request_event)
assert key_request_event in bob.received_key_requests.values()
# Convert the key request event into a to-device message.
collected_requests = bob.collect_key_requests()
# The message could not be queued because the device is not trusted
assert not bob.outgoing_to_device_messages
assert key_request_event in bob.key_request_from_untrusted.values()
assert key_request_event in collected_requests
# Let us try to continue the key share without verifying the device.
assert not bob.continue_key_share(key_request_event)
# Let us now verify the device and tell our Olm machine that we should
# resume.
bob.verify_device(alice_device)
assert bob.continue_key_share(key_request_event)
assert key_request_event not in bob.key_request_from_untrusted.values()
# There is now a key queued up to be sent as a to-device message.
assert bob.outgoing_to_device_messages
to_device = bob.outgoing_to_device_messages[0]
# Let us now share the to-device message with Alice
olm_message = self.olm_message_to_event(to_device.as_dict(), alice, bob)
forwarded_key_event = ToDeviceEvent.parse_event(olm_message)
assert isinstance(forwarded_key_event, OlmEvent)
# Decrypt the olm event and check that we received a forwarded room
# key.
decrypted_event = alice.handle_to_device_event(forwarded_key_event)
assert isinstance(decrypted_event, ForwardedRoomKeyEvent)
# Alice tries to decrypt the previous event again.
decrypted_event = alice.decrypt_event(event)
assert isinstance(decrypted_event, RoomMessageText)
assert decrypted_event.body == "It's a secret to everybody."
def test_key_forward_cancelling(self, olm_account, bob_account):
alice = olm_account
bob = bob_account
bob.user_id = alice.user_id
alice_device = OlmDevice(
alice.user_id, alice.device_id, alice.account.identity_keys
)
bob_device = OlmDevice(bob.user_id, bob.device_id, bob.account.identity_keys)
alice.device_store.add(bob_device)
bob.device_store.add(alice_device)
# bob.verify_device(alice_device)
bob.create_outbound_group_session(TEST_ROOM)
session = bob.outbound_group_sessions[TEST_ROOM]
session.shared = True
message = {
"type": "m.room.message",
"content": {"msgtype": "m.text", "body": "It's a secret to everybody."},
}
encrypted_content = bob.group_encrypt(TEST_ROOM, message)
encrypted_message = {
"event_id": "!event_id",
"type": "m.room.encrypted",
"sender": bob.user_id,
"origin_server_ts": int(time.time()),
"content": encrypted_content,
"room_id": TEST_ROOM,
}
event = MegolmEvent.from_dict(encrypted_message)
# Alice tries to decrypt the event but can't.
decrypted_event = alice.decrypt_event(event)
assert decrypted_event is None
key_request = event.as_key_request(
bob.user_id,
alice.device_id,
event.session_id,
)
outgoing_key_request = OutgoingKeyRequest(
event.session_id, event.session_id, TEST_ROOM, event.algorithm
)
alice.outgoing_key_requests[event.session_id] = outgoing_key_request
key_request = {
"sender": alice.user_id,
"type": "m.room_key_request",
"content": key_request.as_dict()["messages"][bob.user_id]["*"],
}
key_request_event = RoomKeyRequest.from_dict(key_request)
assert isinstance(key_request_event, RoomKeyRequest)
assert not bob.outgoing_to_device_messages
cancellation = RoomKeyRequestCancellation(
{},
key_request_event.sender,
key_request_event.requesting_device_id,
key_request_event.request_id,
)
# Bob receives the event and queues it up for collection.
bob.handle_to_device_event(key_request_event)
assert key_request_event in bob.received_key_requests.values()
# Cancel the request immediately.
bob.handle_to_device_event(cancellation)
assert key_request_event not in bob.received_key_requests.values()
# Bob receives the event again
bob.handle_to_device_event(key_request_event)
# This time we collect the event.
assert cancellation not in bob.collect_key_requests()
# Check that the message is not queued. We are missing a Olm session.
assert not bob.outgoing_to_device_messages
assert alice_device in bob.key_request_devices_no_session
assert (
key_request_event
in bob.key_requests_waiting_for_session[
alice_device.user_id, alice_device.id
].values()
)
# We cancel again.
bob.handle_to_device_event(cancellation)
assert cancellation not in bob.collect_key_requests()
assert alice_device not in bob.key_request_devices_no_session
assert (
key_request_event
not in bob.key_requests_waiting_for_session[
alice_device.user_id, alice_device.id
].values()
)
# Let us do another round
bob.handle_to_device_event(key_request_event)
bob.collect_key_requests()
# Let us do a key claim request.
to_share = alice.share_keys()
one_time_key = list(to_share["one_time_keys"].items())[0]
key_claim_dict = {
"one_time_keys": {
alice.user_id: {
alice.device_id: {one_time_key[0]: one_time_key[1]},
},
},
"failures": {},
}
response = KeysClaimResponse.from_dict(key_claim_dict)
bob.handle_response(response)
# We got a session now, the device is not waiting for a session anymore
assert alice_device not in bob.key_request_devices_no_session
# The key request is neither waiting for a session anymore.
assert (
key_request_event
not in bob.key_requests_waiting_for_session[
alice_device.user_id, alice_device.id
].values()
)
# The key request is now waiting to be collected again.
assert key_request_event in bob.received_key_requests.values()
# Let us collect it now.
bob.collect_key_requests()
# Still no, device isn't verified.
assert not bob.outgoing_to_device_messages
assert key_request_event in bob.key_request_from_untrusted.values()
# Cancel again, now we're going to get the cancellation event in the
# collect output
bob.handle_to_device_event(cancellation)
assert cancellation in bob.collect_key_requests()
# Let us finally check out if bob can also reject the sharing of the
# key.
bob.handle_to_device_event(key_request_event)
event_for_user = bob.collect_key_requests()[0]
assert not bob.outgoing_to_device_messages
assert key_request_event in bob.key_request_from_untrusted.values()
assert bob.cancel_key_share(event_for_user)
assert key_request_event not in bob.key_request_from_untrusted.values()
def test_invalid_key_requests(self, olm_account, bob_account):
alice = olm_account
bob = bob_account
alice_device = OlmDevice(
alice.user_id, alice.device_id, alice.account.identity_keys
)
bob_device = OlmDevice(bob.user_id, bob.device_id, bob.account.identity_keys)
alice.device_store.add(bob_device)
bob.device_store.add(alice_device)
# bob.verify_device(alice_device)
bob.create_outbound_group_session(TEST_ROOM)
session = bob.outbound_group_sessions[TEST_ROOM]
session.shared = True
message = {
"type": "m.room.message",
"content": {"msgtype": "m.text", "body": "It's a secret to everybody."},
}
encrypted_content = bob.group_encrypt(TEST_ROOM, message)
encrypted_message = {
"event_id": "!event_id",
"type": "m.room.encrypted",
"sender": bob.user_id,
"origin_server_ts": int(time.time()),
"content": encrypted_content,
"room_id": TEST_ROOM,
}
event = MegolmEvent.from_dict(encrypted_message)
# Alice tries to decrypt the event but can't.
decrypted_event = alice.decrypt_event(event)
assert decrypted_event is None
key_request = event.as_key_request(
bob.user_id,
alice.device_id,
event.session_id,
)
outgoing_key_request = OutgoingKeyRequest(
event.session_id, event.session_id, TEST_ROOM, event.algorithm
)
alice.outgoing_key_requests[event.session_id] = outgoing_key_request
key_request = {
"sender": alice.user_id,
"type": "m.room_key_request",
"content": key_request.as_dict()["messages"][bob.user_id]["*"],
}
key_request_event = RoomKeyRequest.from_dict(key_request)
assert isinstance(key_request_event, RoomKeyRequest)
assert not bob.outgoing_to_device_messages
key_request_event.session_id = "fake_id"
bob.handle_to_device_event(key_request_event)
assert key_request_event in bob.received_key_requests.values()
assert not bob.outgoing_to_device_messages
bob.collect_key_requests()
assert not bob.outgoing_to_device_messages
key_request_event.session_id = session.id
key_request_event.requesting_device_id = "FAKE_ID"
bob.handle_to_device_event(key_request_event)
assert key_request_event in bob.received_key_requests.values()
assert not bob.outgoing_to_device_messages
bob.collect_key_requests()
assert not bob.outgoing_to_device_messages
alice_device.deleted = True
key_request_event.requesting_device_id = alice.device_id
bob.handle_to_device_event(key_request_event)
assert key_request_event in bob.received_key_requests.values()
assert not bob.outgoing_to_device_messages
bob.collect_key_requests()
assert not bob.outgoing_to_device_messages
bob.user_id = alice.user_id
key_request_event.session_id = "fake_id"
bob.handle_to_device_event(key_request_event)
assert key_request_event in bob.received_key_requests.values()
assert not bob.outgoing_to_device_messages
bob.collect_key_requests()
assert not bob.outgoing_to_device_messages
key_request_event.session_id = session.id
key_request_event.requesting_device_id = "FAKE_ID"
bob.handle_to_device_event(key_request_event)
assert key_request_event in bob.received_key_requests.values()
assert not bob.outgoing_to_device_messages
bob.collect_key_requests()
assert not bob.outgoing_to_device_messages
|