libervia-backend: sat/plugins/plugin_xep

annotate sat/plugins/plugin_xep_0420.py @ 3916:40d47cc29ea4

plugin XEP-0300: type hints

author	Goffi <goffi@goffi.org>
date	Thu, 06 Oct 2022 15:19:08 +0200
parents	8289ac1b34f4
children	626629781a53

rev	line source
3877 00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	1 #!/usr/bin/env python3
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	2
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	3 # Libervia plugin for Stanza Content Encryption
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	4 # Copyright (C) 2022-2022 Tim Henkes (me@syndace.dev)
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	5
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	6 # This program is free software: you can redistribute it and/or modify
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	7 # it under the terms of the GNU Affero General Public License as published by
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	8 # the Free Software Foundation, either version 3 of the License, or
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	9 # (at your option) any later version.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	10
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	11 # This program is distributed in the hope that it will be useful,
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	14 # GNU Affero General Public License for more details.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	15
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	16 # You should have received a copy of the GNU Affero General Public License
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	18
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	19 from abc import ABC, abstractmethod
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	20 from datetime import datetime
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	21 import enum
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	22 import secrets
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	23 import string
3911 8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3877 diff changeset	24 from typing import Dict, NamedTuple, Optional, Set, Tuple, cast
3877 00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	25
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	26 from lxml import etree
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	27
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	28 from sat.core.constants import Const as C
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	29 from sat.core.i18n import D_
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	30 from sat.core.log import Logger, getLogger
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	31 from sat.core.sat_main import SAT
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	32 from sat.tools.xml_tools import ElementParser
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	33 from sat.plugins.plugin_xep_0033 import NS_ADDRESS
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	34 from sat.plugins.plugin_xep_0082 import XEP_0082
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	35 from sat.plugins.plugin_xep_0334 import NS_HINTS
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	36 from sat.plugins.plugin_xep_0359 import NS_SID
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	37 from sat.plugins.plugin_xep_0380 import NS_EME
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	38 from twisted.words.protocols.jabber import jid
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	39 from twisted.words.xish import domish
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	40
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	41
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	42 __all__ = [ # pylint: disable=unused-variable
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	43 "PLUGIN_INFO",
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	44 "NS_SCE",
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	45 "XEP_0420",
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	46 "ProfileRequirementsNotMet",
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	47 "AffixVerificationFailed",
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	48 "SCECustomAffix",
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	49 "SCEAffixPolicy",
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	50 "SCEProfile",
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	51 "SCEAffixValues"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	52 ]
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	53
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	54
3911 8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3877 diff changeset	55 log = cast(Logger, getLogger(__name__)) # type: ignore[no-untyped-call]
3877 00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	56
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	57
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	58 PLUGIN_INFO = {
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	59 C.PI_NAME: "SCE",
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	60 C.PI_IMPORT_NAME: "XEP-0420",
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	61 C.PI_TYPE: "SEC",
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	62 C.PI_PROTOCOLS: [ "XEP-0420" ],
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	63 C.PI_DEPENDENCIES: [ "XEP-0334", "XEP-0082" ],
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	64 C.PI_RECOMMENDATIONS: [ "XEP-0045", "XEP-0033", "XEP-0359" ],
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	65 C.PI_MAIN: "XEP_0420",
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	66 C.PI_HANDLER: "no",
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	67 C.PI_DESCRIPTION: D_("Implementation of Stanza Content Encryption"),
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	68 }
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	69
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	70
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	71 NS_SCE = "urn:xmpp:sce:1"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	72
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	73
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	74 class ProfileRequirementsNotMet(Exception):
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	75 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	76 Raised by :meth:`XEP_0420.unpack_stanza` in case the requirements formulated by the
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	77 profile are not met.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	78 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	79
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	80
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	81 class AffixVerificationFailed(Exception):
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	82 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	83 Raised by :meth:`XEP_0420.unpack_stanza` in case of affix verification failure.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	84 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	85
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	86
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	87 class SCECustomAffix(ABC):
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	88 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	89 Interface for custom affixes of SCE profiles.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	90 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	91
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	92 @property
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	93 @abstractmethod
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	94 def element_name(self) -> str:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	95 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	96 @return: The name of the affix's XML element.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	97 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	98
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	99 @property
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	100 @abstractmethod
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	101 def element_schema(self) -> str:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	102 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	103 @return: The XML schema definition of the affix element's XML structure, i.e. the
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	104 ``<xs:element/>`` schema element. This element will be referenced using
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	105 ``<xs:element ref="{element_name}"/>``.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	106 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	107
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	108 @abstractmethod
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	109 def create(self, stanza: domish.Element) -> domish.Element:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	110 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	111 @param stanza: The stanza element which has been processed by
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	112 :meth:`XEP_0420.pack_stanza`, i.e. all encryptable children have been removed
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	113 and only the root ``<message/>`` or ``<iq/>`` and unencryptable children
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	114 remain. Do not modify.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	115 @return: An affix element to include in the envelope. The element must have the
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	116 name :attr:`element_name` and must validate using :attr:`element_schema`.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	117 @raise ValueError: if the affix couldn't be built.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	118 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	119
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	120 @abstractmethod
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	121 def verify(self, stanza: domish.Element, element: domish.Element) -> None:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	122 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	123 @param stanza: The stanza element before being processed by
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	124 :meth:`XEP_0420.unpack_stanza`, i.e. all encryptable children have been
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	125 removed and only the root ``<message/>`` or ``<iq/>`` and unencryptable
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	126 children remain. Do not modify.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	127 @param element: The affix element to verify.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	128 @raise AffixVerificationFailed: on verification failure.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	129 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	130
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	131
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	132 @enum.unique
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	133 class SCEAffixPolicy(enum.Enum):
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	134 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	135 Policy for the presence of an affix in an SCE envelope.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	136 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	137
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	138 REQUIRED: str = "REQUIRED"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	139 OPTIONAL: str = "OPTIONAL"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	140 NOT_NEEDED: str = "NOT_NEEDED"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	141
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	142
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	143 class SCEProfile(NamedTuple):
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	144 # pylint: disable=invalid-name
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	145 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	146 An SCE profile, i.e. the definition which affixes are required, optional or not needed
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	147 at all by an SCE-enabled encryption protocol.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	148 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	149
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	150 rpad_policy: SCEAffixPolicy
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	151 time_policy: SCEAffixPolicy
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	152 to_policy: SCEAffixPolicy
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	153 from_policy: SCEAffixPolicy
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	154 custom_policies: Dict[SCECustomAffix, SCEAffixPolicy]
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	155
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	156
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	157 class SCEAffixValues(NamedTuple):
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	158 # pylint: disable=invalid-name
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	159 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	160 Structure returned by :meth:`XEP_0420.unpack_stanza` with the parsed/processes values
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	161 of all affixes included in the envelope. For custom affixes, the whole affix element
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	162 is returned.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	163 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	164
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	165 rpad: Optional[str]
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	166 timestamp: Optional[datetime]
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	167 recipient: Optional[jid.JID]
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	168 sender: Optional[jid.JID]
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	169 custom: Dict[SCECustomAffix, domish.Element]
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	170
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	171
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	172 ENVELOPE_SCHEMA = """<?xml version="1.0" encoding="utf8"?>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	173 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	174 targetNamespace="urn:xmpp:sce:1"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	175 xmlns="urn:xmpp:sce:1">
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	176
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	177 <xs:element name="envelope">
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	178 <xs:complexType>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	179 <xs:all>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	180 <xs:element ref="content"/>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	181 <xs:element ref="rpad" minOccurs="0"/>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	182 <xs:element ref="time" minOccurs="0"/>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	183 <xs:element ref="to" minOccurs="0"/>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	184 <xs:element ref="from" minOccurs="0"/>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	185 {custom_affix_references}
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	186 </xs:all>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	187 </xs:complexType>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	188 </xs:element>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	189
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	190 <xs:element name="content">
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	191 <xs:complexType>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	192 <xs:sequence>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	193 <xs:any minOccurs="0" maxOccurs="unbounded" processContents="skip"/>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	194 </xs:sequence>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	195 </xs:complexType>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	196 </xs:element>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	197
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	198 <xs:element name="rpad" type="xs:string"/>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	199
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	200 <xs:element name="time">
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	201 <xs:complexType>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	202 <xs:attribute name="stamp" type="xs:dateTime"/>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	203 </xs:complexType>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	204 </xs:element>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	205
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	206 <xs:element name="to">
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	207 <xs:complexType>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	208 <xs:attribute name="jid" type="xs:string"/>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	209 </xs:complexType>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	210 </xs:element>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	211
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	212 <xs:element name="from">
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	213 <xs:complexType>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	214 <xs:attribute name="jid" type="xs:string"/>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	215 </xs:complexType>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	216 </xs:element>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	217
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	218 {custom_affix_definitions}
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	219 </xs:schema>
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	220 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	221
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	222
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	223 class XEP_0420: # pylint: disable=invalid-name
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	224 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	225 Implementation of XEP-0420: Stanza Content Encryption under namespace
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	226 ``urn:xmpp:sce:1``.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	227
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	228 This is a passive plugin, i.e. it doesn't hook into any triggers to process stanzas
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	229 actively, but offers API for other plugins to use.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	230 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	231
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	232 # Set of namespaces whose elements are never allowed to be transferred in an encrypted
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	233 # envelope.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	234 MUST_BE_PLAINTEXT_NAMESPACES: Set[str] = {
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	235 NS_HINTS,
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	236 NS_SID, # TODO: Not sure whether this ban applies to both stanza-id and origin-id
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	237 NS_ADDRESS,
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	238 # Not part of the specification (yet), but just doesn't make sense in an encrypted
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	239 # envelope:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	240 NS_EME
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	241 }
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	242
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	243 # Set of (namespace, element name) tuples that define elements which are never allowed
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	244 # to be transferred in an encrypted envelope. If all elements under a certain
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	245 # namespace are forbidden, the namespace can be added to
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	246 # :attr:`MUST_BE_PLAINTEXT_NAMESPACES` instead.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	247 # Note: only full namespaces are forbidden by the spec for now, the following is for
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	248 # potential future use.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	249 MUST_BE_PLAINTEXT_ELEMENTS: Set[Tuple[str, str]] = set()
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	250
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	251 def __init__(self, sat: SAT) -> None:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	252 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	253 @param sat: The SAT instance.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	254 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	255
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	256 @staticmethod
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	257 def pack_stanza(profile: SCEProfile, stanza: domish.Element) -> bytes:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	258 """Pack a stanza according to Stanza Content Encryption.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	259
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	260 Removes all elements from the stanza except for a few exceptions that explicitly
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	261 need to be transferred in plaintext, e.g. because they contain hints/instructions
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	262 for the server on how to process the stanza. Together with the affix elements as
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	263 requested by the profile, the removed elements are added to an envelope XML
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	264 structure that builds the plaintext to be encrypted by the SCE-enabled encryption
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	265 scheme. Optional affixes are always added to the structure, i.e. they are treated
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	266 by the packing code as if they were required.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	267
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	268 Once built, the envelope structure is serialized to a byte string and returned for
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	269 the encryption scheme to encrypt and add to the stanza.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	270
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	271 @param profile: The SCE profile, i.e. the definition of affixes to include in the
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	272 envelope.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	273 @param stanza: The stanza to process. Will be modified by the call.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	274 @return: The serialized envelope structure that builds the plaintext for the
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	275 encryption scheme to process.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	276 @raise ValueError: if the <to/> or <from/> affixes are requested but the stanza
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	277 doesn't have the "to"/"from" attribute set to extract the value from. Can also
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	278 be raised by custom affixes.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	279
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	280 @warning: It is up to the calling code to add a <store/> message processing hint
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	281 if applicable.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	282 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	283
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	284 # Prepare the envelope and content elements
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	285 envelope = domish.Element((NS_SCE, "envelope"))
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	286 content = envelope.addElement((NS_SCE, "content"))
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	287
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	288 # Note the serialized byte size of the content element before adding any children
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	289 empty_content_byte_size = len(content.toXml().encode("utf-8"))
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	290
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	291 # Move elements that are not explicitly forbidden from being encrypted from the
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	292 # stanza to the content element.
3911 8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3877 diff changeset	293 for child in list(stanza.elements()):
3877 00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	294 if (
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	295 child.uri not in XEP_0420.MUST_BE_PLAINTEXT_NAMESPACES
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	296 and (child.uri, child.name) not in XEP_0420.MUST_BE_PLAINTEXT_ELEMENTS
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	297 ):
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	298 # Remove the child from the stanza
3911 8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3877 diff changeset	299 stanza.children.remove(child)
3877 00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	300
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	301 # A namespace of ``None`` can be used on domish elements to inherit the
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	302 # namespace from the parent. When moving elements from the stanza root to
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	303 # the content element, however, we don't want elements to inherit the
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	304 # namespace of the content element. Thus, check for elements with ``None``
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	305 # for their namespace and set the namespace to jabber:client, which is the
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	306 # namespace of the parent element.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	307 if child.uri is None:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	308 child.uri = C.NS_CLIENT
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	309 child.defaultUri = C.NS_CLIENT
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	310
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	311 # Add the child with corrected namespaces to the content element
3911 8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3877 diff changeset	312 content.addChild(child)
3877 00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	313
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	314 # Add the affixes requested by the profile
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	315 if profile.rpad_policy is not SCEAffixPolicy.NOT_NEEDED:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	316 # The specification defines the rpad affix to contain "[...] a randomly
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	317 # generated sequence of random length between 0 and 200 characters." This
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	318 # implementation differs a bit from the specification in that a minimum size
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	319 # other than 0 is chosen depending on the serialized size of the content
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	320 # element. This is to prevent the scenario where the encrypted content is
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	321 # short and the rpad is also randomly chosen to be short, which could allow
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	322 # guessing the content of a short message. To do so, the rpad length is first
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	323 # chosen to pad the content to at least 53 bytes, then afterwards another 0 to
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	324 # 200 bytes are added. Note that single-byte characters are used by this
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	325 # implementation, thus the number of characters equals the number of bytes.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	326 content_byte_size = len(content.toXml().encode("utf-8"))
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	327 content_byte_size_diff = content_byte_size - empty_content_byte_size
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	328 rpad_length = max(0, 53 - content_byte_size_diff) + secrets.randbelow(201)
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	329 rpad_content = "".join(
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	330 secrets.choice(string.digits + string.ascii_letters + string.punctuation)
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	331 for __
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	332 in range(rpad_length)
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	333 )
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	334 envelope.addElement((NS_SCE, "rpad"), content=rpad_content)
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	335
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	336 if profile.time_policy is not SCEAffixPolicy.NOT_NEEDED:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	337 time_element = envelope.addElement((NS_SCE, "time"))
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	338 time_element["stamp"] = XEP_0082.format_datetime()
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	339
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	340 if profile.to_policy is not SCEAffixPolicy.NOT_NEEDED:
3911 8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3877 diff changeset	341 recipient = stanza.getAttribute("to", None)
3877 00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	342 if recipient is None:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	343 raise ValueError(
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	344 "<to/> affix requested, but stanza doesn't have the 'to' attribute"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	345 " set."
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	346 )
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	347
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	348 to_element = envelope.addElement((NS_SCE, "to"))
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	349 to_element["jid"] = jid.JID(recipient).userhost()
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	350
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	351 if profile.from_policy is not SCEAffixPolicy.NOT_NEEDED:
3911 8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3877 diff changeset	352 sender = stanza.getAttribute("from", None)
3877 00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	353 if sender is None:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	354 raise ValueError(
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	355 "<from/> affix requested, but stanza doesn't have the 'from'"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	356 " attribute set."
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	357 )
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	358
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	359 from_element = envelope.addElement((NS_SCE, "from"))
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	360 from_element["jid"] = jid.JID(sender).userhost()
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	361
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	362 for affix, policy in profile.custom_policies.items():
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	363 if policy is not SCEAffixPolicy.NOT_NEEDED:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	364 envelope.addChild(affix.create(stanza))
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	365
3911 8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3877 diff changeset	366 return envelope.toXml().encode("utf-8")
3877 00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	367
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	368 @staticmethod
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	369 def unpack_stanza(
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	370 profile: SCEProfile,
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	371 stanza: domish.Element,
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	372 envelope_serialized: bytes
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	373 ) -> SCEAffixValues:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	374 """Unpack a stanza packed according to Stanza Content Encryption.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	375
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	376 Parses the serialized envelope as XML, verifies included affixes and makes sure
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	377 the requirements of the profile are met, and restores the stanza by moving
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	378 decrypted elements from the envelope back to the stanza top level.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	379
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	380 @param profile: The SCE profile, i.e. the definition of affixes that have to/may
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	381 be included in the envelope.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	382 @param stanza: The stanza to process. Will be modified by the call.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	383 @param envelope_serialized: The serialized envelope, i.e. the plaintext produced
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	384 by the decryption scheme utilizing SCE.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	385 @return: The parsed and processed values of all affixes that were present on the
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	386 envelope, notably including the timestamp.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	387 @raise ValueError: if the serialized envelope element is malformed.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	388 @raise ProfileRequirementsNotMet: if one or more affixes required by the profile
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	389 are missing from the envelope.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	390 @raise AffixVerificationFailed: if an affix included in the envelope fails to
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	391 validate. It doesn't matter whether the affix is required by the profile or
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	392 not, all affixes included in the envelope are validated and cause this
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	393 exception to be raised on failure.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	394
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	395 @warning: It is up to the calling code to verify the timestamp, if returned, since
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	396 the requirements on the timestamp may vary between SCE-enabled protocols.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	397 """
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	398
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	399 try:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	400 envelope_serialized_string = envelope_serialized.decode("utf-8")
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	401 except UnicodeError as e:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	402 raise ValueError("Serialized envelope can't bare parsed as utf-8.") from e
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	403
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	404 custom_affixes = set(profile.custom_policies.keys())
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	405
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	406 # Make sure the envelope adheres to the schema
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	407 parser = etree.XMLParser(schema=etree.XMLSchema(etree.XML(ENVELOPE_SCHEMA.format(
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	408 custom_affix_references="".join(
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	409 f'<xs:element ref="{custom_affix.element_name}" minOccurs="0"/>'
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	410 for custom_affix
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	411 in custom_affixes
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	412 ),
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	413 custom_affix_definitions="".join(
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	414 custom_affix.element_schema
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	415 for custom_affix
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	416 in custom_affixes
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	417 )
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	418 ).encode("utf-8"))))
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	419
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	420 try:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	421 etree.fromstring(envelope_serialized_string, parser)
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	422 except etree.XMLSyntaxError as e:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	423 raise ValueError("Serialized envelope doesn't pass schema validation.") from e
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	424
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	425 # Prepare the envelope and content elements
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	426 envelope = cast(domish.Element, ElementParser()(envelope_serialized_string))
3911 8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3877 diff changeset	427 content = next(envelope.elements(NS_SCE, "content"))
3877 00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	428
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	429 # Verify the affixes
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	430 rpad_element = cast(
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	431 Optional[domish.Element],
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	432 next(envelope.elements(NS_SCE, "rpad"), None)
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	433 )
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	434 time_element = cast(
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	435 Optional[domish.Element],
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	436 next(envelope.elements(NS_SCE, "time"), None)
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	437 )
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	438 to_element = cast(
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	439 Optional[domish.Element],
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	440 next(envelope.elements(NS_SCE, "to"), None)
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	441 )
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	442 from_element = cast(
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	443 Optional[domish.Element],
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	444 next(envelope.elements(NS_SCE, "from"), None)
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	445 )
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	446
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	447 # The rpad doesn't need verification.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	448 rpad_value = None if rpad_element is None else str(rpad_element)
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	449
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	450 # The time affix isn't verified other than that the timestamp is parseable.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	451 try:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	452 timestamp_value = None if time_element is None else \
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	453 XEP_0082.parse_datetime(time_element["stamp"])
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	454 except ValueError as e:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	455 raise AffixVerificationFailed("Malformed time affix") from e
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	456
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	457 # The to affix is verified by comparing the to attribute of the stanza with the
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	458 # JID referenced by the affix. Note that only bare JIDs are compared as per the
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	459 # specification.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	460 recipient_value: Optional[jid.JID] = None
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	461 if to_element is not None:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	462 recipient_value = jid.JID(to_element["jid"])
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	463
3911 8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3877 diff changeset	464 recipient_actual = stanza.getAttribute("to", None)
3877 00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	465 if recipient_actual is None:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	466 raise AffixVerificationFailed(
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	467 "'To' affix is included in the envelope, but the stanza is lacking a"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	468 " 'to' attribute to compare the value to."
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	469 )
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	470
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	471 recipient_actual_bare_jid = jid.JID(recipient_actual).userhost()
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	472 recipient_target_bare_jid = recipient_value.userhost()
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	473
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	474 if recipient_actual_bare_jid != recipient_target_bare_jid:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	475 raise AffixVerificationFailed(
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	476 f"Mismatch between actual and target recipient bare JIDs:"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	477 f" {recipient_actual_bare_jid} vs {recipient_target_bare_jid}."
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	478 )
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	479
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	480 # The from affix is verified by comparing the from attribute of the stanza with
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	481 # the JID referenced by the affix. Note that only bare JIDs are compared as per
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	482 # the specification.
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	483 sender_value: Optional[jid.JID] = None
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	484 if from_element is not None:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	485 sender_value = jid.JID(from_element["jid"])
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	486
3911 8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3877 diff changeset	487 sender_actual = stanza.getAttribute("from", None)
3877 00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	488 if sender_actual is None:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	489 raise AffixVerificationFailed(
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	490 "'From' affix is included in the envelope, but the stanza is lacking"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	491 " a 'from' attribute to compare the value to."
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	492 )
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	493
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	494 sender_actual_bare_jid = jid.JID(sender_actual).userhost()
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	495 sender_target_bare_jid = sender_value.userhost()
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	496
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	497 if sender_actual_bare_jid != sender_target_bare_jid:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	498 raise AffixVerificationFailed(
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	499 f"Mismatch between actual and target sender bare JIDs:"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	500 f" {sender_actual_bare_jid} vs {sender_target_bare_jid}."
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	501 )
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	502
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	503 # Find and verify custom affixes
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	504 custom_values: Dict[SCECustomAffix, domish.Element] = {}
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	505 for affix in custom_affixes:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	506 element_name = affix.element_name
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	507 element = cast(
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	508 Optional[domish.Element],
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	509 next(envelope.elements(NS_SCE, element_name), None)
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	510 )
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	511 if element is not None:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	512 affix.verify(stanza, element)
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	513 custom_values[affix] = element
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	514
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	515 # Check whether all affixes required by the profile are present
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	516 rpad_missing = \
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	517 profile.rpad_policy is SCEAffixPolicy.REQUIRED and rpad_element is None
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	518 time_missing = \
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	519 profile.time_policy is SCEAffixPolicy.REQUIRED and time_element is None
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	520 to_missing = \
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	521 profile.to_policy is SCEAffixPolicy.REQUIRED and to_element is None
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	522 from_missing = \
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	523 profile.from_policy is SCEAffixPolicy.REQUIRED and from_element is None
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	524 custom_missing = any(
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	525 affix not in custom_values
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	526 for affix, policy
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	527 in profile.custom_policies.items()
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	528 if policy is SCEAffixPolicy.REQUIRED
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	529 )
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	530
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	531 if rpad_missing or time_missing or to_missing or from_missing or custom_missing:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	532 custom_missing_string = ""
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	533 for custom_affix in custom_affixes:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	534 value = "present" if custom_affix in custom_values else "missing"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	535 custom_missing_string += f", [custom]{custom_affix.element_name}={value}"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	536
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	537 raise ProfileRequirementsNotMet(
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	538 f"SCE envelope is missing affixes required by the profile {profile}."
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	539 f" Affix presence:"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	540 f" rpad={'missing' if rpad_missing else 'present'}"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	541 f", time={'missing' if time_missing else 'present'}"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	542 f", to={'missing' if to_missing else 'present'}"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	543 f", from={'missing' if from_missing else 'present'}"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	544 + custom_missing_string
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	545 )
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	546
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	547 # Move elements that are not explicitly forbidden from being encrypted from the
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	548 # content element to the stanza.
3911 8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3877 diff changeset	549 for child in list(content.elements()):
3877 00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	550 if (
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	551 child.uri in XEP_0420.MUST_BE_PLAINTEXT_NAMESPACES
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	552 or (child.uri, child.name) in XEP_0420.MUST_BE_PLAINTEXT_ELEMENTS
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	553 ):
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	554 log.warning(
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	555 f"An element that MUST be transferred in plaintext was found in an"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	556 f" SCE envelope: {child.toXml()}"
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	557 )
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	558 else:
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	559 # Remove the child from the content element
3911 8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3877 diff changeset	560 content.children.remove(child)
3877 00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	561
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	562 # Add the child to the stanza
3911 8289ac1b34f4 plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: Syndace <me@syndace.dev> parents: 3877 diff changeset	563 stanza.addChild(child)
3877 00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	564
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	565 return SCEAffixValues(
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	566 rpad_value,
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	567 timestamp_value,
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	568 recipient_value,
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	569 sender_value,
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	570 custom_values
00212260f659 plugin XEP-0420: Implementation of Stanza Content Encryption: Syndace <me@syndace.dev> parents: diff changeset	571 )

Mercurial > libervia-backend

annotate sat/plugins/plugin_xep_0420.py @ 3916:40d47cc29ea4