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
|
# -*- coding: utf-8 -*-
# Copyright 2018 Zil0
# Copyright © 2018, 2019 Damir Jelić <poljar@termina.org.uk>
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# http://www.apache.org/licenses/LICENSE-2.0
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import os
import sqlite3
from builtins import super
from dataclasses import dataclass, field
from functools import wraps
from typing import Dict, List, Optional
from peewee import DoesNotExist, SqliteDatabase
from playhouse.sqliteq import SqliteQueueDatabase
from ..crypto import (
DeviceStore,
GroupSessionStore,
InboundGroupSession,
OlmAccount,
OlmDevice,
OutgoingKeyRequest,
Session,
SessionStore,
TrustState,
)
from . import (
Accounts,
DeviceKeys,
DeviceKeys_v1,
DeviceTrustState,
EncryptedRooms,
ForwardedChains,
Key,
Keys,
KeyStore,
MegolmInboundSessions,
OlmSessions,
OutgoingKeyRequests,
StoreVersion,
SyncTokens,
)
def use_database(fn):
"""
Ensure that the correct database context is used for the wrapped function.
"""
@wraps(fn)
def inner(self, *args, **kwargs):
with self.database.bind_ctx(self.models):
return fn(self, *args, **kwargs)
return inner
def use_database_atomic(fn):
"""
Ensure that the correct database context is used for the wrapped function.
This also ensures that the database transaction will be atomic.
"""
@wraps(fn)
def inner(self, *args, **kwargs):
with self.database.bind_ctx(self.models):
if isinstance(self.database, SqliteQueueDatabase):
return fn(self, *args, **kwargs)
else:
with self.database.atomic():
return fn(self, *args, **kwargs)
return inner
@dataclass
class MatrixStore:
"""Storage class for matrix state."""
models = [
Accounts,
OlmSessions,
MegolmInboundSessions,
ForwardedChains,
DeviceKeys,
EncryptedRooms,
OutgoingKeyRequests,
StoreVersion,
Keys,
SyncTokens,
]
store_version = 2
user_id: str = field()
device_id: str = field()
store_path: str = field()
pickle_key: str = ""
database_name: str = ""
database_path: str = field(init=False)
database: SqliteDatabase = field(init=False)
def _create_database(self):
return SqliteDatabase(
self.database_path,
pragmas={
"foreign_keys": 1,
"secure_delete": 1,
},
)
def upgrade_to_v2(self):
with self.database.bind_ctx([DeviceKeys_v1]):
self.database.drop_tables(
[
DeviceTrustState,
DeviceKeys_v1,
],
safe=True,
)
with self.database.bind_ctx(self.models):
self.database.create_tables([DeviceKeys, DeviceTrustState])
self._update_version(2)
def __post_init__(self):
self.database_name = self.database_name or f"{self.user_id}_{self.device_id}.db"
self.database_path = os.path.join(self.store_path, self.database_name)
self.database = self._create_database()
self.database.connect()
store_version = self._get_store_version()
# Update the store if it's an old version here.
if store_version == 1:
self.upgrade_to_v2()
with self.database.bind_ctx(self.models):
self.database.create_tables(self.models)
def _get_store_version(self):
with self.database.bind_ctx([StoreVersion]):
self.database.create_tables([StoreVersion])
v, _ = StoreVersion.get_or_create(defaults={"version": self.store_version})
return v.version
def _update_version(self, new_version):
with self.database.bind_ctx([StoreVersion]):
v, _ = StoreVersion.get_or_create(defaults={"version": new_version})
v.version = new_version
v.save()
@use_database
def _get_account(self):
try:
return Accounts.get(
Accounts.user_id == self.user_id, Accounts.device_id == self.device_id
)
except DoesNotExist:
return None
def load_account(self):
# type: () -> Optional[OlmAccount]
"""Load the Olm account from the database.
Returns:
``OlmAccount`` object, or ``None`` if it wasn't found for the
current device_id.
"""
account = self._get_account()
if not account:
return None
return OlmAccount.from_pickle(account.account, self.pickle_key, account.shared)
@use_database
def save_account(self, account):
"""Save the provided Olm account to the database.
Args:
account (OlmAccount): The olm account that will be pickled and
saved in the database.
"""
Accounts.insert(
user_id=self.user_id,
device_id=self.device_id,
shared=account.shared,
account=account.pickle(self.pickle_key),
).on_conflict_ignore().execute()
Accounts.update(
{
Accounts.account: account.pickle(self.pickle_key),
Accounts.shared: account.shared,
}
).where(
(Accounts.user_id == self.user_id) & (Accounts.device_id == self.device_id)
).execute()
@use_database
def load_sessions(self):
# type: () -> SessionStore
"""Load all Olm sessions from the database.
Returns:
``SessionStore`` object, containing all the loaded sessions.
"""
session_store = SessionStore()
account = self._get_account()
if not account:
return session_store
for s in account.olm_sessions:
session = Session.from_pickle(s.session, s.creation_time, self.pickle_key)
session_store.add(s.sender_key, session)
return session_store
@use_database
def save_session(self, sender_key, session):
"""Save the provided Olm session to the database.
Args:
curve_key (str): The curve key that owns the Olm session.
session (Session): The Olm session that will be pickled and
saved in the database.
"""
account = self._get_account()
assert account
OlmSessions.replace(
account=account,
sender_key=sender_key,
session=session.pickle(self.pickle_key),
session_id=session.id,
creation_time=session.creation_time,
last_usage_date=session.use_time,
).execute()
@use_database
def load_inbound_group_sessions(self):
# type: () -> GroupSessionStore
"""Load all Olm sessions from the database.
Returns:
``GroupSessionStore`` object, containing all the loaded sessions.
"""
store = GroupSessionStore()
account = self._get_account()
if not account:
return store
for s in account.inbound_group_sessions:
session = InboundGroupSession.from_pickle(
s.session,
s.fp_key,
s.sender_key,
s.room_id,
self.pickle_key,
[chain.sender_key for chain in s.forwarded_chains],
)
store.add(session)
return store
@use_database
def save_inbound_group_session(self, session):
"""Save the provided Megolm inbound group session to the database.
Args:
session (InboundGroupSession): The session to save.
"""
account = self._get_account()
assert account
MegolmInboundSessions.insert(
sender_key=session.sender_key,
account=account,
fp_key=session.ed25519,
room_id=session.room_id,
session=session.pickle(self.pickle_key),
session_id=session.id,
).on_conflict_ignore().execute()
MegolmInboundSessions.update(
{MegolmInboundSessions.session: session.pickle(self.pickle_key)}
).where(MegolmInboundSessions.session_id == session.id).execute()
# TODO, use replace many here
for chain in session.forwarding_chain:
ForwardedChains.replace(sender_key=chain, session=session.id).execute()
@use_database
def load_device_keys(self):
# type: () -> DeviceStore
"""Load all the device keys from the database.
Returns DeviceStore containing the OlmDevices with the device keys.
"""
store = DeviceStore()
account = self._get_account()
if not account:
return store
for d in account.device_keys:
store.add(
OlmDevice(
d.user_id,
d.device_id,
{k.key_type: k.key for k in d.keys},
display_name=d.display_name,
deleted=d.deleted,
)
)
return store
@use_database_atomic
def save_device_keys(self, device_keys):
"""Save the provided device keys to the database.
Args:
device_keys (Dict[str, Dict[str, OlmDevice]]): A dictionary
containing a mapping from a user id to a dictionary containing
a mapping of a device id to a OlmDevice.
"""
account = self._get_account()
assert account
rows = []
for user_id, devices_dict in device_keys.items():
for device_id, device in devices_dict.items():
rows.append(
{
"account": account,
"user_id": user_id,
"device_id": device_id,
"display_name": device.display_name,
"deleted": device.deleted,
}
)
if not rows:
return
for idx in range(0, len(rows), 100):
data = rows[idx : idx + 100]
DeviceKeys.insert_many(data).on_conflict_ignore().execute()
for user_id, devices_dict in device_keys.items():
for device_id, device in devices_dict.items():
d = DeviceKeys.get(
(DeviceKeys.account == account)
& (DeviceKeys.user_id == user_id)
& (DeviceKeys.device_id == device_id)
)
d.deleted = device.deleted
d.save()
for key_type, key in device.keys.items():
Keys.replace(key_type=key_type, key=key, device=d).execute()
@use_database
def load_encrypted_rooms(self):
"""Load the set of encrypted rooms for this account.
Returns:
``Set`` containing room ids of encrypted rooms.
"""
account = self._get_account()
if not account:
return set()
return {room.room_id for room in account.encrypted_rooms}
@use_database
def load_outgoing_key_requests(self):
"""Load the set of outgoing key requests for this account.
Returns:
``Set`` containing request ids of key requests.
"""
account = self._get_account()
if not account:
return dict()
return {
request.request_id: OutgoingKeyRequest.from_database(request)
for request in account.out_key_requests
}
@use_database
def add_outgoing_key_request(self, key_request):
# type: (OutgoingKeyRequest) -> None
"""Add an outgoing key request to the store."""
account = self._get_account()
assert account
OutgoingKeyRequests.insert(
request_id=key_request.request_id,
session_id=key_request.session_id,
room_id=key_request.room_id,
algorithm=key_request.algorithm,
account=account,
).on_conflict_ignore().execute()
@use_database
def remove_outgoing_key_request(self, key_request):
# type: (OutgoingKeyRequest) -> None
"""Remove an active outgoing key request from the store."""
account = self._get_account()
assert account
db_key_request = OutgoingKeyRequests.get_or_none(
OutgoingKeyRequests.request_id == key_request.request_id,
OutgoingKeyRequests.account == account,
)
if db_key_request:
db_key_request.delete_instance()
@use_database_atomic
def save_encrypted_rooms(self, rooms):
"""Save the set of room ids for this account."""
account = self._get_account()
assert account
data = [(room_id, account) for room_id in rooms]
for idx in range(0, len(data), 400):
rows = data[idx : idx + 400]
EncryptedRooms.insert_many(
rows, fields=[EncryptedRooms.room_id, EncryptedRooms.account]
).on_conflict_ignore().execute()
@use_database
def save_sync_token(self, token):
# type (str) -> None
"""Save the given token"""
account = self._get_account()
assert account
SyncTokens.replace(account=account, token=token).execute()
@use_database
def load_sync_token(self):
# type () -> Optional[str]
account = self._get_account()
if not account:
return None
token = SyncTokens.get_or_none(
SyncTokens.account == account.id,
)
if token:
return token.token
return None
@use_database
def delete_encrypted_room(self, room):
# type: (str) -> None
"""Delete the a encrypted room from the store."""
db_room = EncryptedRooms.get_or_none(EncryptedRooms.room_id == room)
if db_room:
db_room.delete_instance()
def blacklist_device(self, device):
# type: (OlmDevice) -> bool
"""Mark a device as blacklisted.
Args:
device (OlmDevice): The device that will be marked as blacklisted
Returns True if the device was blacklisted, False otherwise, e.g. if
the device was already blacklisted.
"""
raise NotImplementedError
def unblacklist_device(self, device):
# type: (OlmDevice) -> bool
"""Unmark a device as blacklisted.
Args:
device (OlmDevice): The device that will be unmarked as blacklisted
"""
raise NotImplementedError
def verify_device(self, device):
# type: (OlmDevice) -> bool
"""Mark a device as verified.
Args:
device (OlmDevice): The device that will be marked as verified
Returns True if the device was verified, False otherwise, e.g. if the
device was already verified.
"""
raise NotImplementedError
def is_device_verified(self, device):
# type: (OlmDevice) -> bool
"""Check if a device is verified.
Args:
device (OlmDevice): The device that will be checked if it's
verified.
"""
raise NotImplementedError
def is_device_blacklisted(self, device):
# type: (OlmDevice) -> bool
"""Check if a device is blacklisted.
Args:
device (OlmDevice): The device that will be checked if it's
blacklisted.
"""
raise NotImplementedError
def unverify_device(self, device):
# type: (OlmDevice) -> bool
"""Unmark a device as verified.
Args:
device (OlmDevice): The device that will be unmarked as verified
Returns True if the device was unverified, False otherwise, e.g. if the
device wasn't verified.
"""
raise NotImplementedError
def ignore_device(self, device):
# type: (OlmDevice) -> bool
"""Mark a device as ignored.
Args:
device (OlmDevice): The device that will be marked as blacklisted
Returns True if the device was ignored, False otherwise, e.g. if
the device was already ignored.
"""
raise NotImplementedError
def unignore_device(self, device):
# type: (OlmDevice) -> bool
"""Unmark a device as ignored.
Args:
device (OlmDevice): The device that will be marked as blacklisted
Returns True if the device was unignored, False otherwise, e.g. if the
device wasn't ignored in the first place.
"""
raise NotImplementedError
def ignore_devices(self, devices):
# type: (List[OlmDevice]) -> None
"""Mark a list of devices as ignored.
This is a more efficient way to mark multiple devices as ignored.
Args:
device (list[OlmDevice]): A list of OlmDevices that will be marked
as ignored.
"""
raise NotImplementedError
def is_device_ignored(self, device):
# type: (OlmDevice) -> bool
"""Check if a device is ignored.
Args:
device (OlmDevice): The device that will be checked if it's
ignored.
"""
raise NotImplementedError
@dataclass
class DefaultStore(MatrixStore):
"""The default nio Matrix Store.
This store uses an Sqlite database as the main storage format while device
trust state is stored in plaintext files using a format similar to the ssh
known_hosts file format. The files will be created in the same directory as
the main Sqlite database.
One such file is created for each of the 3 valid states (verified,
blacklisted, ignored). If a device isn't found in any of those files the
verification state is considered to be unset.
Args:
user_id (str): The fully-qualified ID of the user that owns the store.
device_id (str): The device id of the user's device.
store_path (str): The path where the store should be stored.
pickle_key (str, optional): A passphrase that will be used to encrypt
encryption keys while they are in storage.
database_name (str, optional): The file-name of the database that
should be used.
"""
trust_db: KeyStore = field(init=False)
blacklist_db: KeyStore = field(init=False)
def __post_init__(self):
super().__post_init__()
trust_file_path = f"{self.user_id}_{self.device_id}.trusted_devices"
self.trust_db = KeyStore(os.path.join(self.store_path, trust_file_path))
blacklist_file_path = f"{self.user_id}_{self.device_id}.blacklisted_devices"
self.blacklist_db = KeyStore(os.path.join(self.store_path, blacklist_file_path))
ignore_file_path = f"{self.user_id}_{self.device_id}.ignored_devices"
self.ignore_db = KeyStore(os.path.join(self.store_path, ignore_file_path))
def blacklist_device(self, device):
# type: (OlmDevice) -> bool
key = Key.from_olmdevice(device)
self.trust_db.remove(key)
self.ignore_db.remove(key)
device.trust_state = TrustState.blacklisted
return self.blacklist_db.add(key)
def unblacklist_device(self, device):
# type: (OlmDevice) -> bool
key = Key.from_olmdevice(device)
if self.blacklist_db.remove(key):
device.trust_state = TrustState.unset
return True
return False
def verify_device(self, device):
# type: (OlmDevice) -> bool
key = Key.from_olmdevice(device)
self.blacklist_db.remove(key)
self.ignore_db.remove(key)
device.trust_state = TrustState.verified
return self.trust_db.add(key)
def is_device_verified(self, device):
# type: (OlmDevice) -> bool
key = Key.from_olmdevice(device)
return key in self.trust_db
def is_device_blacklisted(self, device):
# type: (OlmDevice) -> bool
key = Key.from_olmdevice(device)
return key in self.blacklist_db
def unverify_device(self, device):
# type: (OlmDevice) -> bool
key = Key.from_olmdevice(device)
if self.trust_db.remove(key):
device.trust_state = TrustState.unset
return True
return False
def ignore_device(self, device):
# type: (OlmDevice) -> bool
key = Key.from_olmdevice(device)
self.blacklist_db.remove(key)
self.trust_db.remove(key)
device.trust_state = TrustState.ignored
return self.ignore_db.add(key)
def unignore_device(self, device):
# type: (OlmDevice) -> bool
key = Key.from_olmdevice(device)
if self.ignore_db.remove(key):
device.trust_state = TrustState.unset
return True
return False
def ignore_devices(self, devices):
# type: (List[OlmDevice]) -> None
keys = [Key.from_olmdevice(device) for device in devices]
self.blacklist_db.remove_many(keys)
self.trust_db.remove_many(keys)
self.ignore_db.add_many(keys)
for device in devices:
device.trust_state = TrustState.ignored
return
def is_device_ignored(self, device):
# type: (OlmDevice) -> bool
key = Key.from_olmdevice(device)
return key in self.ignore_db
@use_database
def load_device_keys(self):
# type: () -> DeviceStore
store = DeviceStore()
account = self._get_account()
if not account:
return store
for d in account.device_keys:
device = OlmDevice(
d.user_id,
d.device_id,
{k.key_type: k.key for k in d.keys},
display_name=d.display_name,
deleted=d.deleted,
)
trust_state = TrustState.unset
key = Key.from_olmdevice(device)
if key in self.trust_db:
trust_state = TrustState.verified
elif key in self.blacklist_db:
trust_state = TrustState.blacklisted
elif key in self.ignore_db:
trust_state = TrustState.ignored
device.trust_state = trust_state
store.add(device)
return store
@dataclass
class SqliteStore(MatrixStore):
"""The Sqlite only nio Matrix Store.
This store uses an Sqlite database as the main storage format as well as
the store format for the trust state.
Args:
user_id (str): The fully-qualified ID of the user that owns the store.
device_id (str): The device id of the user's device.
store_path (str): The path where the store should be stored.
pickle_key (str, optional): A passphrase that will be used to encrypt
encryption keys while they are in storage.
database_name (str, optional): The file-name of the database that
should be used.
"""
models = MatrixStore.models + [DeviceTrustState]
def _get_device(self, device):
acc = self._get_account()
if not acc:
return None
try:
return DeviceKeys.get(
DeviceKeys.user_id == device.user_id,
DeviceKeys.device_id == device.id,
DeviceKeys.account == acc,
)
except DoesNotExist:
return None
@use_database
def verify_device(self, device):
# type: (OlmDevice) -> bool
if self.is_device_verified(device):
return False
d = self._get_device(device)
assert d
DeviceTrustState.replace(device=d, state=TrustState.verified).execute()
device.trust_state = TrustState.verified
return True
@use_database
def unverify_device(self, device):
# type: (OlmDevice) -> bool
if not self.is_device_verified(device):
return False
d = self._get_device(device)
assert d
DeviceTrustState.replace(device=d, state=TrustState.unset).execute()
device.trust_state = TrustState.unset
return True
@use_database
def is_device_verified(self, device):
# type: (OlmDevice) -> bool
d = self._get_device(device)
if not d:
return False
try:
trust_state = d.trust_state[0].state
except IndexError:
return False
return trust_state == TrustState.verified
@use_database
def blacklist_device(self, device):
# type: (OlmDevice) -> bool
if self.is_device_blacklisted(device):
return False
d = self._get_device(device)
assert d
DeviceTrustState.replace(device=d, state=TrustState.blacklisted).execute()
device.trust_state = TrustState.blacklisted
return True
@use_database
def unblacklist_device(self, device):
# type: (OlmDevice) -> bool
if not self.is_device_blacklisted(device):
return False
d = self._get_device(device)
assert d
DeviceTrustState.replace(device=d, state=TrustState.unset).execute()
device.trust_state = TrustState.unset
return True
@use_database
def is_device_blacklisted(self, device):
# type: (OlmDevice) -> bool
d = self._get_device(device)
if not d:
return False
try:
trust_state = d.trust_state[0].state
except IndexError:
return False
return trust_state == TrustState.blacklisted
@use_database
def ignore_device(self, device):
# type: (OlmDevice) -> bool
if self.is_device_ignored(device):
return False
d = self._get_device(device)
assert d
DeviceTrustState.replace(device=d, state=TrustState.ignored).execute()
device.trust_state = TrustState.ignored
return True
@use_database
def unignore_device(self, device):
# type: (OlmDevice) -> bool
if not self.is_device_ignored(device):
return False
d = self._get_device(device)
assert d
DeviceTrustState.replace(device=d, state=TrustState.unset).execute()
device.trust_state = TrustState.unset
return True
def _legacy_get_device_ids(self, account, devices):
device_ids = []
for device in devices:
d = DeviceKeys.get_or_none(
DeviceKeys.account == account.id,
DeviceKeys.user_id == device.user_id,
DeviceKeys.device_id == device.id,
)
assert d
device_ids.append(d.id)
return device_ids
def _get_device_ids(self, account, devices):
device_ids = []
tuple_values = [(d.user_id, d.id) for d in devices]
values = [item for sublist in tuple_values for item in sublist]
for idx in range(0, len(values), 300):
data = values[idx : idx + 300]
query_string = (
"SELECT devicekeys.* from devicekeys "
"JOIN accounts ON devicekeys.account_id=accounts.id "
"WHERE accounts.id == ? AND "
"(devicekeys.user_id, devicekeys.device_id) IN "
f"(VALUES {','.join(['(?, ?)'] * (len(data) // 2))})"
)
query = DeviceKeys.raw(query_string, account.id, *data)
device_ids += [device_key.id for device_key in query]
return device_ids
@use_database_atomic
def ignore_devices(self, devices):
# type: (List[OlmDevice]) -> None
acc = self._get_account()
if not acc:
return None
if sqlite3.sqlite_version_info >= (3, 15, 2):
device_ids = self._get_device_ids(acc, devices)
else:
device_ids = self._legacy_get_device_ids(acc, devices)
rows = [
{"device_id": device_id, "state": TrustState.ignored}
for device_id in device_ids
]
assert len(rows) == len(devices)
for idx in range(0, len(rows), 100):
trust_data = rows[idx : idx + 100]
DeviceTrustState.replace_many(trust_data).execute()
for device in devices:
device.trust_state = TrustState.ignored
@use_database
def is_device_ignored(self, device):
# type: (OlmDevice) -> bool
d = self._get_device(device)
if not d:
return False
try:
trust_state = d.trust_state[0].state
except IndexError:
return False
return trust_state == TrustState.ignored
@use_database
def load_device_keys(self):
# type: () -> DeviceStore
store = DeviceStore()
account = self._get_account()
if not account:
return store
for d in account.device_keys:
try:
trust_state = d.trust_state[0].state
except IndexError:
trust_state = TrustState.unset
store.add(
OlmDevice(
d.user_id,
d.device_id,
{k.key_type: k.key for k in d.keys},
display_name=d.display_name,
deleted=d.deleted,
trust_state=trust_state,
)
)
return store
class SqliteMemoryStore(SqliteStore):
"""The Sqlite only nio Matrix Store.
This store uses an Sqlite database as the main storage format as well as
the store format for the trust state. The Sqlite database will be stored
only in memory and all the data will be lost after the object is deleted.
Args:
user_id (str): The fully-qualified ID of the user that owns the store.
device_id (str): The device id of the user's device.
pickle_key (str, optional): A passphrase that will be used to encrypt
encryption keys while they are in storage.
"""
def __init__(self, user_id, device_id, pickle_key=""):
super().__init__(user_id, device_id, "", pickle_key=pickle_key)
def _create_database(self):
return SqliteDatabase(
":memory:",
pragmas={
"foreign_keys": 1,
"secure_delete": 1,
},
)
|