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
|
import base64
from typing import Dict, Optional, Set, Tuple, cast
import xml.etree.ElementTree as ET
from omemo import (
DeviceListDownloadFailed,
EncryptedKeyMaterial,
KeyExchange,
Message,
SenderNotFound,
SessionManager
)
import x3dh
import xeddsa
try:
import xmlschema
except ImportError as import_error:
raise ImportError(
"Optional dependency xmlschema not found. Please install xmlschema, or install this package using"
" `pip install python-oldmemo[xml]`, to use the ElementTree-based XML serialization/parser helpers."
) from import_error
from .oldmemo import NAMESPACE, BundleImpl, ContentImpl, EncryptedKeyMaterialImpl, KeyExchangeImpl, StateImpl
__all__ = [
"serialize_device_list",
"parse_device_list",
"serialize_bundle",
"parse_bundle",
"serialize_message",
"parse_message"
]
NS = f"{{{NAMESPACE}}}"
DEVICE_LIST_SCHEMA = xmlschema.XMLSchema("""<?xml version="1.0" encoding="utf8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
targetNamespace="eu.siacs.conversations.axolotl"
xmlns="eu.siacs.conversations.axolotl">
<xs:element name="device">
<xs:complexType>
<xs:attribute name="id" type="xs:unsignedInt" use="required"/>
</xs:complexType>
</xs:element>
<xs:element name="list">
<xs:complexType>
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element ref="device"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
""")
BUNDLE_SCHEMA = xmlschema.XMLSchema("""<?xml version="1.0" encoding="utf8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
targetNamespace="eu.siacs.conversations.axolotl"
xmlns="eu.siacs.conversations.axolotl">
<xs:element name="signedPreKeyPublic">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:base64Binary">
<xs:attribute name="signedPreKeyId" type="xs:unsignedInt"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="signedPreKeySignature" type="xs:base64Binary"/>
<xs:element name="identityKey" type="xs:base64Binary"/>
<xs:element name="preKeyPublic">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:base64Binary">
<xs:attribute name="preKeyId" type="xs:unsignedInt" use="required"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="prekeys">
<xs:complexType>
<xs:sequence>
<xs:element ref="preKeyPublic" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="bundle">
<xs:complexType>
<xs:sequence>
<xs:element ref="signedPreKeyPublic"/>
<xs:element ref="signedPreKeySignature"/>
<xs:element ref="identityKey"/>
<xs:element ref="prekeys"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
""")
MESSAGE_SCHEMA = xmlschema.XMLSchema11("""<?xml version="1.1" encoding="utf8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
targetNamespace="eu.siacs.conversations.axolotl"
xmlns="eu.siacs.conversations.axolotl">
<xs:element name="payload" type="xs:base64Binary"/>
<xs:element name="iv" type="xs:base64Binary"/>
<xs:element name="key">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:base64Binary">
<xs:attribute name="rid" type="xs:unsignedInt" use="required"/>
<xs:attribute name="prekey" type="xs:boolean"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="header">
<xs:complexType>
<xs:all>
<xs:element ref="key" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="iv"/>
</xs:all>
<xs:attribute name="sid" type="xs:unsignedInt"/>
</xs:complexType>
</xs:element>
<xs:element name="encrypted">
<xs:complexType>
<xs:all>
<xs:element ref="header"/>
<xs:element ref="payload" minOccurs="0"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
""")
def serialize_device_list(device_list: Dict[int, Optional[str]]) -> ET.Element:
"""
Args:
device_list: The device list to serialize. The first entry of each tuple is the device id, and the
second entry is the optional label. Note that labels are not supported by this version of the
specification and will not be included in the XML.
Returns:
The serialized device list as an XML element.
"""
list_elt = ET.Element(f"{NS}list")
for device_id, _ in device_list.items():
device_elt = ET.SubElement(list_elt, f"{NS}device")
device_elt.set("id", str(device_id))
return list_elt
def parse_device_list(element: ET.Element) -> Dict[int, Optional[str]]:
"""
Args:
element: The XML element to parse the device list from.
Returns:
The extracted device list. The first entry of each tuple is the device id, and the second entry is the
optional label. Note that labels are not supported by this version of the specification, so all labels
will be set to ``None``.
Raises:
XMLSchemaValidationError: in case the element does not conform to the XML schema given in the
specification.
"""
DEVICE_LIST_SCHEMA.validate(element)
return { int(cast(str, device_elt.get("id"))): None for device_elt in element.iter(f"{NS}device") }
def serialize_bundle(bundle: BundleImpl) -> ET.Element:
"""
Args:
bundle: The bundle to serialize.
Returns:
The serialized bundle as an XML element.
"""
bundle_elt = ET.Element(f"{NS}bundle")
signed_pre_key_signature_mut = bytearray(bundle.bundle.signed_pre_key_sig)
signed_pre_key_signature_mut[63] |= bundle.bundle.identity_key[31] & 0x80
signed_pre_key_signature = bytes(signed_pre_key_signature_mut)
ET.SubElement(
bundle_elt,
f"{NS}signedPreKeyPublic",
attrib={ "signedPreKeyId": str(bundle.signed_pre_key_id) }
).text = base64.b64encode(StateImpl.serialize_public_key(bundle.bundle.signed_pre_key)).decode("ASCII")
ET.SubElement(
bundle_elt,
f"{NS}signedPreKeySignature"
).text = base64.b64encode(signed_pre_key_signature).decode("ASCII")
ET.SubElement(
bundle_elt,
f"{NS}identityKey"
).text = base64.b64encode(StateImpl.serialize_public_key(xeddsa.ed25519_pub_to_curve25519_pub(
bundle.bundle.identity_key
))).decode("ASCII")
prekeys_elt = ET.SubElement(bundle_elt, f"{NS}prekeys")
for pre_key in bundle.bundle.pre_keys:
ET.SubElement(
prekeys_elt,
f"{NS}preKeyPublic",
attrib={ "preKeyId": str(bundle.pre_key_ids[pre_key]) }
).text = base64.b64encode(StateImpl.serialize_public_key(pre_key)).decode("ASCII")
return bundle_elt
def parse_bundle(element: ET.Element, bare_jid: str, device_id: int) -> BundleImpl:
"""
Args:
element: The XML element to parse the bundle from.
bare_jid: The bare JID this bundle belongs to.
device_id: The device id of the specific device this bundle belongs to.
Returns:
The extracted bundle.
Raises:
ValueError: in case of malformed data that still passed the schema validation.
XMLSchemaValidationError: in case the element does not conform to the XML schema given in the
specification.
"""
BUNDLE_SCHEMA.validate(element)
spkp_elt = cast(ET.Element, element.find(f"{NS}signedPreKeyPublic"))
pkp_elts = list(element.iter(f"{NS}preKeyPublic"))
signed_pre_key_signature = base64.b64decode(cast(str, cast(ET.Element, element.find(
f"{NS}signedPreKeySignature"
)).text))
identity_key = xeddsa.curve25519_pub_to_ed25519_pub(StateImpl.parse_public_key(base64.b64decode(
cast(str, cast(ET.Element, element.find(f"{NS}identityKey")).text)
)), bool((signed_pre_key_signature[63] >> 7) & 1))
signed_pre_key_signature_mut = bytearray(signed_pre_key_signature)
signed_pre_key_signature_mut[63] &= 0x7f
signed_pre_key_signature = bytes(signed_pre_key_signature_mut)
pre_key_ids = {
StateImpl.parse_public_key(base64.b64decode(cast(str, pkp_elt.text))):
int(cast(str, pkp_elt.get("preKeyId")))
for pkp_elt
in pkp_elts
}
return BundleImpl(
bare_jid,
device_id,
x3dh.Bundle(
identity_key,
StateImpl.parse_public_key(base64.b64decode(cast(str, spkp_elt.text))),
signed_pre_key_signature,
frozenset(pre_key_ids.keys())
),
int(cast(str, spkp_elt.get("signedPreKeyId"))),
pre_key_ids
)
def serialize_message(message: Message) -> ET.Element:
"""
Args:
message: The message to serialize.
Returns:
The serialized message as an XML element.
"""
assert isinstance(message.content, ContentImpl)
encrypted_elt = ET.Element(f"{NS}encrypted")
header_elt = ET.SubElement(encrypted_elt, f"{NS}header", attrib={ "sid": str(message.device_id) })
for encrypted_key_material, key_exchange in message.keys:
assert isinstance(encrypted_key_material, EncryptedKeyMaterialImpl)
key_elt = ET.SubElement(
header_elt,
f"{NS}key",
attrib={ "rid": str(encrypted_key_material.device_id) }
)
authenticated_message = encrypted_key_material.serialize()
if key_exchange is None:
key_elt.text = base64.b64encode(authenticated_message).decode("ASCII")
else:
assert isinstance(key_exchange, KeyExchangeImpl)
key_exchange_serialized, _sign_bit_set = key_exchange.serialize(authenticated_message)
key_elt.set("prekey", "true")
key_elt.text = base64.b64encode(key_exchange_serialized).decode("ASCII")
ET.SubElement(
header_elt,
f"{NS}iv"
).text = base64.b64encode(message.content.initialization_vector).decode("ASCII")
if not message.content.empty:
ET.SubElement(
encrypted_elt,
f"{NS}payload"
).text = base64.b64encode(message.content.ciphertext).decode("ASCII")
return encrypted_elt
async def parse_message(
element: ET.Element,
sender_bare_jid: str,
own_bare_jid: str,
session_manager: SessionManager
) -> Message:
"""
Args:
element: The XML element to parse the message from.
sender_bare_jid: The bare JID of the sender.
own_bare_jid: The bare JID of the XMPP account decrypting this message, i.e. us.
session_manager: The session manager instance is required to find one piece of information that the
oldmemo message serialization format lacks with regards to the identity key.
Returns:
The extracted message.
Raises:
ValueError: in case there is malformed data not caught be the XML schema validation.
XMLSchemaValidationError: in case the element does not conform to the XML schema given in the
specification.
SenderNotFound: in case the public information about the sending device could not be found or is
incomplete.
Warning:
This version of the OMEMO specification matches key material to recipient purely by device id. The
library, however, matches by bare JID and device id. Since the XML doesn't include the bare JID, the
structures expected by the library can't be filled correctly. Instead, to match the behaviour of the
specification, the bare JID of all key material included in the message is assigned to
``own_bare_jid``, i.e. our own bare JID, which achieves the desired effect of matching only on
the device id.
"""
MESSAGE_SCHEMA.validate(element)
payload_elt = element.find(f"{NS}payload")
header_elt = cast(ET.Element, element.find(f"{NS}header"))
iv_elt = header_elt.find(f"{NS}iv")
sender_device_id = int(cast(str, header_elt.get("sid")))
# The following code might seem overkill just to find the sign of the identity key. However, to make usage
# of the library as simple as possible, I believe it is worth it. Since most results are cached, this
# shouldn't significantly slow down the overall decryption flow either.
sender_device = next((
device
for device
in await session_manager.get_device_information(sender_bare_jid)
if device.device_id == sender_device_id
), None)
if sender_device is None:
try:
# If the device wasn't found, refresh the device list
await session_manager.refresh_device_list(NAMESPACE, sender_bare_jid)
except DeviceListDownloadFailed as e:
raise SenderNotFound(
"Couldn't find public information about the device which sent this message and an attempt to"
" refresh the sender's device list failed."
) from e
sender_device = next((
device
for device
in await session_manager.get_device_information(sender_bare_jid)
if device.device_id == sender_device_id
), None)
if sender_device is None:
raise SenderNotFound(
"Couldn't find public information about the device which sent this message. I.e. the device"
" either does not appear in the device list of the sending XMPP account, or the bundle of the"
" sending device could not be downloaded."
)
set_sign_bit = bool((sender_device.identity_key[31] >> 7) & 1)
keys: Set[Tuple[EncryptedKeyMaterial, Optional[KeyExchange]]] = set()
for key_elt in header_elt.iter(f"{NS}key"):
recipient_device_id = int(cast(str, key_elt.get("rid")))
content = base64.b64decode(cast(str, key_elt.text))
key_exchange: Optional[KeyExchangeImpl] = None
authenticated_message: bytes
if bool(key_elt.get("prekey", False)):
key_exchange, authenticated_message = KeyExchangeImpl.parse(content, set_sign_bit)
else:
authenticated_message = content
encrypted_key_material = EncryptedKeyMaterialImpl.parse(
authenticated_message,
own_bare_jid,
recipient_device_id
)
keys.add((encrypted_key_material, key_exchange))
return Message(
NAMESPACE,
sender_bare_jid,
sender_device_id,
(
ContentImpl.make_empty()
if payload_elt is None or iv_elt is None
else ContentImpl(
base64.b64decode(cast(str, payload_elt.text)),
base64.b64decode(cast(str, iv_elt.text))
)
),
frozenset(keys)
)
|