libervia-backend: sat/plugins/plugin_xep

annotate sat/plugins/plugin_xep_0373.py @ 4048:04e21d6c9188

plugin XEP-0320: Use of DTLS-SRTP in Jingle Sessions: rel 421

author	Goffi <goffi@goffi.org>
date	Mon, 15 May 2023 17:02:40 +0200
parents	524856bd7b19
children

rev	line source
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1 #!/usr/bin/env python3
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	3 # Libervia plugin for OpenPGP for XMPP
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	4 # Copyright (C) 2022-2022 Tim Henkes (me@syndace.dev)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	5
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	6 # This program is free software: you can redistribute it and/or modify
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	7 # it under the terms of the GNU Affero General Public License as published by
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	8 # the Free Software Foundation, either version 3 of the License, or
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	9 # (at your option) any later version.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	10
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	11 # This program is distributed in the hope that it will be useful,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	14 # GNU Affero General Public License for more details.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	15
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	16 # You should have received a copy of the GNU Affero General Public License
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	18
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	19 from abc import ABC, abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	20 import base64
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	21 from datetime import datetime, timezone
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	22 import enum
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	23 import secrets
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	24 import string
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	25 from typing import Any, Dict, Iterable, List, Literal, Optional, Set, Tuple, cast
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	26 from xml.sax.saxutils import quoteattr
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	27
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	28 from typing_extensions import Final, NamedTuple, Never, assert_never
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	29 from wokkel import muc, pubsub
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	30 from wokkel.disco import DiscoFeature, DiscoInfo
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	31 import xmlschema
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	32
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	33 from sat.core import exceptions
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	34 from sat.core.constants import Const as C
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	35 from sat.core.core_types import SatXMPPEntity
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	36 from sat.core.i18n import _, D_
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	37 from sat.core.log import getLogger, Logger
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	38 from sat.core.sat_main import SAT
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	39 from sat.core.xmpp import SatXMPPClient
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	40 from sat.memory import persistent
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	41 from sat.plugins.plugin_xep_0045 import XEP_0045
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	42 from sat.plugins.plugin_xep_0060 import XEP_0060
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	43 from sat.plugins.plugin_xep_0163 import XEP_0163
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	44 from sat.tools.xmpp_datetime import format_datetime, parse_datetime
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	45 from sat.tools import xml_tools
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	46 from twisted.internet import defer
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	47 from twisted.words.protocols.jabber import jid
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	48 from twisted.words.xish import domish
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	49
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	50 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	51 import gpg
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	52 except ImportError as import_error:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	53 raise exceptions.MissingModule(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	54 "You are missing the 'gpg' package required by the OX plugin. The recommended"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	55 " installation method is via your operating system's package manager, since the"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	56 " version of the library has to match the version of your GnuPG installation. See"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	57 " https://wiki.python.org/moin/GnuPrivacyGuard#Accessing_GnuPG_via_gpgme"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	58 ) from import_error
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	59
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	60
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	61 __all__ = [ # pylint: disable=unused-variable
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	62 "PLUGIN_INFO",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	63 "NS_OX",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	64 "XEP_0373",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	65 "VerificationError",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	66 "XMPPInteractionFailed",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	67 "InvalidPacket",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	68 "DecryptionFailed",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	69 "VerificationFailed",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	70 "UnknownKey",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	71 "GPGProviderError",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	72 "GPGPublicKey",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	73 "GPGSecretKey",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	74 "GPGProvider",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	75 "PublicKeyMetadata",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	76 "gpg_provider",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	77 "TrustLevel"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	78 ]
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	79
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	80
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	81 log = cast(Logger, getLogger(__name__)) # type: ignore[no-untyped-call]
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	82
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	83
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	84 PLUGIN_INFO = {
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	85 C.PI_NAME: "XEP-0373",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	86 C.PI_IMPORT_NAME: "XEP-0373",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	87 C.PI_TYPE: "SEC",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	88 C.PI_PROTOCOLS: [ "XEP-0373" ],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	89 C.PI_DEPENDENCIES: [ "XEP-0060", "XEP-0163" ],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	90 C.PI_RECOMMENDATIONS: [],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	91 C.PI_MAIN: "XEP_0373",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	92 C.PI_HANDLER: "no",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	93 C.PI_DESCRIPTION: D_("Implementation of OpenPGP for XMPP"),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	94 }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	95
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	96
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	97 NS_OX: Final = "urn:xmpp:openpgp:0"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	98
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	99
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	100 PARAM_CATEGORY = "Security"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	101 PARAM_NAME = "ox_policy"
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	102 STR_KEY_PUBLIC_KEYS_METADATA = "/public-keys-metadata/{}"
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	103
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	104
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	105 class VerificationError(Exception):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	106 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	107 Raised by verifying methods of :class:`XEP_0373` on semantical verification errors.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	108 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	109
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	110
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	111 class XMPPInteractionFailed(Exception):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	112 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	113 Raised by methods of :class:`XEP_0373` on XMPP interaction failure. The reason this
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	114 exception exists is that the exceptions raised by XMPP interactions are not properly
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	115 documented for the most part, thus all exceptions are caught and wrapped in instances
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	116 of this class.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	117 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	118
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	119
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	120 class InvalidPacket(ValueError):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	121 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	122 Raised by methods of :class:`GPGProvider` when an invalid packet is encountered.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	123 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	124
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	125
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	126 class DecryptionFailed(Exception):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	127 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	128 Raised by methods of :class:`GPGProvider` on decryption failures.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	129 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	130
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	131
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	132 class VerificationFailed(Exception):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	133 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	134 Raised by methods of :class:`GPGProvider` on verification failures.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	135 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	136
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	137
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	138 class UnknownKey(ValueError):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	139 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	140 Raised by methods of :class:`GPGProvider` when an unknown key is referenced.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	141 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	142
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	143
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	144 class GPGProviderError(Exception):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	145 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	146 Raised by methods of :class:`GPGProvider` on internal errors.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	147 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	148
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	149
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	150 class GPGPublicKey(ABC):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	151 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	152 Interface describing a GPG public key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	153 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	154
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	155 @property
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	156 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	157 def fingerprint(self) -> str:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	158 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	159 @return: The OpenPGP v4 fingerprint string of this public key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	160 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	161
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	162
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	163 class GPGSecretKey(ABC):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	164 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	165 Interface descibing a GPG secret key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	166 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	167
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	168 @property
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	169 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	170 def public_key(self) -> GPGPublicKey:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	171 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	172 @return: The public key corresponding to this secret key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	173 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	174
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	175
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	176 class GPGProvider(ABC):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	177 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	178 Interface describing a GPG provider, i.e. a library or framework providing GPG
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	179 encryption, signing and key management.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	180
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	181 All methods may raise :class:`GPGProviderError` in addition to those exception types
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	182 listed explicitly.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	183
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	184 # TODO: Check keys for revoked, disabled and expired everywhere and exclude those (?)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	185 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	186
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	187 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	188 def export_public_key(self, public_key: GPGPublicKey) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	189 """Export a public key in a key material packet according to RFC 4880 §5.5.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	190
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	191 Do not use OpenPGP's ASCII Armor.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	192
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	193 @param public_key: The public key to export.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	194 @return: The packet containing the exported public key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	195 @raise UnknownKey: if the public key is not available.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	196 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	197
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	198 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	199 def import_public_key(self, packet: bytes) -> GPGPublicKey:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	200 """import a public key from a key material packet according to RFC 4880 §5.5.
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	201
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	202 OpenPGP's ASCII Armor is not used.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	203
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	204 @param packet: A packet containing an exported public key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	205 @return: The public key imported from the packet.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	206 @raise InvalidPacket: if the packet is either syntactically or semantically deemed
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	207 invalid.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	208
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	209 @warning: Only packets of version 4 or higher may be accepted, packets below
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	210 version 4 MUST be rejected.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	211 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	212
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	213 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	214 def backup_secret_key(self, secret_key: GPGSecretKey) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	215 """Export a secret key for transfer according to RFC 4880 §11.1.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	216
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	217 Do not encrypt the secret data, i.e. set the octet indicating string-to-key usage
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	218 conventions to zero in the corresponding secret-key packet according to RFC 4880
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	219 §5.5.3. Do not use OpenPGP's ASCII Armor.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	220
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	221 @param secret_key: The secret key to export.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	222 @return: The binary blob containing the exported secret key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	223 @raise UnknownKey: if the secret key is not available.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	224 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	225
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	226 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	227 def restore_secret_keys(self, data: bytes) -> Set[GPGSecretKey]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	228 """Restore secret keys exported for transfer according to RFC 4880 §11.1.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	229
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	230 The secret data is not encrypted, i.e. the octet indicating string-to-key usage
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	231 conventions in the corresponding secret-key packets according to RFC 4880 §5.5.3
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	232 are set to zero. OpenPGP's ASCII Armor is not used.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	233
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	234 @param data: Concatenation of one or more secret keys exported for transfer.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	235 @return: The secret keys imported from the data.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	236 @raise InvalidPacket: if the data or one of the packets included in the data is
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	237 either syntactically or semantically deemed invalid.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	238
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	239 @warning: Only packets of version 4 or higher may be accepted, packets below
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	240 version 4 MUST be rejected.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	241 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	242
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	243 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	244 def encrypt_symmetrically(self, plaintext: bytes, password: str) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	245 """Encrypt data symmetrically according to RFC 4880 §5.3.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	246
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	247 The password is used to build a Symmetric-Key Encrypted Session Key packet which
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	248 precedes the Symmetrically Encrypted Data packet that holds the encrypted data.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	249
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	250 @param plaintext: The data to encrypt.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	251 @param password: The password to encrypt the data with.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	252 @return: The encrypted data.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	253 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	254
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	255 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	256 def decrypt_symmetrically(self, ciphertext: bytes, password: str) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	257 """Decrypt data symmetrically according to RFC 4880 §5.3.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	258
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	259 The ciphertext consists of a Symmetrically Encrypted Data packet that holds the
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	260 encrypted data, preceded by a Symmetric-Key Encrypted Session Key packet using the
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	261 password.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	262
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	263 @param ciphertext: The ciphertext.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	264 @param password: The password to decrypt the data with.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	265 @return: The plaintext.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	266 @raise DecryptionFailed: on decryption failure.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	267 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	268
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	269 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	270 def sign(self, data: bytes, secret_keys: Set[GPGSecretKey]) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	271 """Sign some data.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	272
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	273 OpenPGP's ASCII Armor is not used.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	274
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	275 @param data: The data to sign.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	276 @param secret_keys: The secret keys to sign the data with.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	277 @return: The OpenPGP message carrying the signed data.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	278 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	279
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	280 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	281 def sign_detached(self, data: bytes, secret_keys: Set[GPGSecretKey]) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	282 """Sign some data. Create the signature detached from the data.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	283
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	284 OpenPGP's ASCII Armor is not used.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	285
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	286 @param data: The data to sign.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	287 @param secret_keys: The secret keys to sign the data with.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	288 @return: The OpenPGP message carrying the detached signature.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	289 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	290
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	291 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	292 def verify(self, signed_data: bytes, public_keys: Set[GPGPublicKey]) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	293 """Verify signed data.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	294
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	295 OpenPGP's ASCII Armor is not used.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	296
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	297 @param signed_data: The signed data as an OpenPGP message.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	298 @param public_keys: The public keys to verify the signature with.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	299 @return: The verified and unpacked data.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	300 @raise VerificationFailed: if the data could not be verified.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	301
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	302 @warning: For implementors: it has to be confirmed that a valid signature by one
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	303 of the public keys is available.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	304 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	305
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	306 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	307 def verify_detached(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	308 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	309 data: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	310 signature: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	311 public_keys: Set[GPGPublicKey]
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	312 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	313 """Verify signed data, where the signature was created detached from the data.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	314
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	315 OpenPGP's ASCII Armor is not used.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	316
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	317 @param data: The data.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	318 @param signature: The signature as an OpenPGP message.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	319 @param public_keys: The public keys to verify the signature with.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	320 @raise VerificationFailed: if the data could not be verified.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	321
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	322 @warning: For implementors: it has to be confirmed that a valid signature by one
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	323 of the public keys is available.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	324 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	325
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	326 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	327 def encrypt(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	328 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	329 plaintext: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	330 public_keys: Set[GPGPublicKey],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	331 signing_keys: Optional[Set[GPGSecretKey]] = None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	332 ) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	333 """Encrypt and optionally sign some data.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	334
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	335 OpenPGP's ASCII Armor is not used.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	336
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	337 @param plaintext: The data to encrypt and optionally sign.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	338 @param public_keys: The public keys to encrypt the data for.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	339 @param signing_keys: The secret keys to sign the data with.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	340 @return: The OpenPGP message carrying the encrypted and optionally signed data.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	341 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	342
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	343 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	344 def decrypt(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	345 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	346 ciphertext: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	347 secret_keys: Set[GPGSecretKey],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	348 public_keys: Optional[Set[GPGPublicKey]] = None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	349 ) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	350 """Decrypt and optionally verify some data.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	351
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	352 OpenPGP's ASCII Armor is not used.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	353
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	354 @param ciphertext: The encrypted and optionally signed data as an OpenPGP message.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	355 @param secret_keys: The secret keys to attempt decryption with.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	356 @param public_keys: The public keys to verify the optional signature with.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	357 @return: The decrypted, optionally verified and unpacked data.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	358 @raise DecryptionFailed: on decryption failure.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	359 @raise VerificationFailed: if the data could not be verified.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	360
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	361 @warning: For implementors: it has to be confirmed that the data was decrypted
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	362 using one of the secret keys and that a valid signature by one of the public
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	363 keys is available in case the data is signed.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	364 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	365
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	366 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	367 def list_public_keys(self, user_id: str) -> Set[GPGPublicKey]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	368 """List public keys.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	369
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	370 @param user_id: The user id.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	371 @return: The set of public keys available for this user id.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	372 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	373
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	374 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	375 def list_secret_keys(self, user_id: str) -> Set[GPGSecretKey]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	376 """List secret keys.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	377
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	378 @param user_id: The user id.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	379 @return: The set of secret keys available for this user id.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	380 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	381
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	382 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	383 def can_sign(self, public_key: GPGPublicKey) -> bool:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	384 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	385 @return: Whether the public key belongs to a key pair capable of signing.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	386 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	387
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	388 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	389 def can_encrypt(self, public_key: GPGPublicKey) -> bool:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	390 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	391 @return: Whether the public key belongs to a key pair capable of encryption.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	392 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	393
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	394 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	395 def create_key(self, user_id: str) -> GPGSecretKey:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	396 """Create a new GPG key, capable of signing and encryption.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	397
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	398 The key is generated without password protection and without expiration. If a key
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	399 with the same user id already exists, a new key is created anyway.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	400
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	401 @param user_id: The user id to assign to the new key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	402 @return: The new key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	403 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	404
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	405
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	406 class GPGME_GPGPublicKey(GPGPublicKey):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	407 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	408 GPG public key implementation based on GnuPG Made Easy (GPGME).
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	409 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	410
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	411 def __init__(self, key_obj: Any) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	412 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	413 @param key_obj: The GPGME key object.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	414 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	415
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	416 self.__key_obj = key_obj
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	417
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	418 @property
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	419 def fingerprint(self) -> str:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	420 return self.__key_obj.fpr
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	421
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	422 @property
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	423 def key_obj(self) -> Any:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	424 return self.__key_obj
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	425
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	426
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	427 class GPGME_GPGSecretKey(GPGSecretKey):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	428 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	429 GPG secret key implementation based on GnuPG Made Easy (GPGME).
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	430 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	431
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	432 def __init__(self, public_key: GPGME_GPGPublicKey) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	433 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	434 @param public_key: The public key corresponding to this secret key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	435 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	436
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	437 self.__public_key = public_key
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	438
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	439 @property
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	440 def public_key(self) -> GPGME_GPGPublicKey:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	441 return self.__public_key
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	442
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	443
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	444 class GPGME_GPGProvider(GPGProvider):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	445 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	446 GPG provider implementation based on GnuPG Made Easy (GPGME).
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	447 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	448
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	449 def __init__(self, home_dir: Optional[str] = None) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	450 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	451 @param home_dir: Optional GPG home directory path to use for all operations.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	452 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	453
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	454 self.__home_dir = home_dir
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	455
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	456 def export_public_key(self, public_key: GPGPublicKey) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	457 assert isinstance(public_key, GPGME_GPGPublicKey)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	458
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	459 pattern = public_key.fingerprint
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	460
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	461 with gpg.Context(home_dir=self.__home_dir) as c:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	462 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	463 result = c.key_export_minimal(pattern)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	464 except gpg.errors.GPGMEError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	465 raise GPGProviderError("Internal GPGME error") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	466
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	467 if result is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	468 raise UnknownKey(f"Public key {pattern} not found.")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	469
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	470 return result
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	471
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	472 def import_public_key(self, packet: bytes) -> GPGPublicKey:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	473 # TODO
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	474 # - Reject packets older than version 4
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	475 # - Check whether it's actually a public key (through packet inspection?)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	476
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	477 with gpg.Context(home_dir=self.__home_dir) as c:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	478 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	479 result = c.key_import(packet)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	480 except gpg.errors.GPGMEError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	481 # From looking at the code, `key_import` never raises. The documentation
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	482 # says it does though, so this is included for future-proofness.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	483 raise GPGProviderError("Internal GPGME error") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	484
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	485 if not hasattr(result, "considered"):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	486 raise InvalidPacket(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	487 f"Data not considered for public key import: {result}"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	488 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	489
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	490 if len(result.imports) != 1:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	491 raise InvalidPacket(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	492 "Public key packet does not contain exactly one public key (not"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	493 " counting subkeys)."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	494 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	495
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	496 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	497 key_obj = c.get_key(result.imports[0].fpr, secret=False)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	498 except gpg.errors.GPGMEError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	499 raise GPGProviderError("Internal GPGME error") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	500 except gpg.errors.KeyError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	501 raise GPGProviderError("Newly imported public key not found") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	502
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	503 return GPGME_GPGPublicKey(key_obj)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	504
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	505 def backup_secret_key(self, secret_key: GPGSecretKey) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	506 assert isinstance(secret_key, GPGME_GPGSecretKey)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	507 # TODO
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	508 # - Handle password protection/pinentry
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	509 # - Make sure the key is exported unencrypted
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	510
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	511 pattern = secret_key.public_key.fingerprint
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	512
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	513 with gpg.Context(home_dir=self.__home_dir) as c:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	514 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	515 result = c.key_export_secret(pattern)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	516 except gpg.errors.GPGMEError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	517 raise GPGProviderError("Internal GPGME error") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	518
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	519 if result is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	520 raise UnknownKey(f"Secret key {pattern} not found.")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	521
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	522 return result
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	523
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	524 def restore_secret_keys(self, data: bytes) -> Set[GPGSecretKey]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	525 # TODO
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	526 # - Reject packets older than version 4
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	527 # - Check whether it's actually secret keys (through packet inspection?)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	528
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	529 with gpg.Context(home_dir=self.__home_dir) as c:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	530 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	531 result = c.key_import(data)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	532 except gpg.errors.GPGMEError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	533 # From looking at the code, `key_import` never raises. The documentation
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	534 # says it does though, so this is included for future-proofness.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	535 raise GPGProviderError("Internal GPGME error") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	536
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	537 if not hasattr(result, "considered"):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	538 raise InvalidPacket(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	539 f"Data not considered for secret key import: {result}"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	540 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	541
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	542 if len(result.imports) == 0:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	543 raise InvalidPacket("Secret key packet does not contain a secret key.")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	544
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	545 secret_keys = set()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	546 for import_status in result.imports:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	547 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	548 key_obj = c.get_key(import_status.fpr, secret=True)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	549 except gpg.errors.GPGMEError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	550 raise GPGProviderError("Internal GPGME error") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	551 except gpg.errors.KeyError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	552 raise GPGProviderError("Newly imported secret key not found") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	553
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	554 secret_keys.add(GPGME_GPGSecretKey(GPGME_GPGPublicKey(key_obj)))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	555
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	556 return secret_keys
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	557
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	558 def encrypt_symmetrically(self, plaintext: bytes, password: str) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	559 with gpg.Context(home_dir=self.__home_dir) as c:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	560 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	561 ciphertext, __, __ = c.encrypt(plaintext, passphrase=password, sign=False)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	562 except gpg.errors.GPGMEError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	563 raise GPGProviderError("Internal GPGME error") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	564
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	565 return ciphertext
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	566
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	567 def decrypt_symmetrically(self, ciphertext: bytes, password: str) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	568 with gpg.Context(home_dir=self.__home_dir) as c:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	569 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	570 plaintext, __, __ = c.decrypt(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	571 ciphertext,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	572 passphrase=password,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	573 verify=False
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	574 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	575 except gpg.errors.GPGMEError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	576 # TODO: Find out what kind of error is raised if the password is wrong and
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	577 # re-raise it as DecryptionFailed instead.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	578 raise GPGProviderError("Internal GPGME error") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	579 except gpg.UnsupportedAlgorithm as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	580 raise DecryptionFailed("Unsupported algorithm") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	581
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	582 return plaintext
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	583
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	584 def sign(self, data: bytes, secret_keys: Set[GPGSecretKey]) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	585 signers = []
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	586 for secret_key in secret_keys:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	587 assert isinstance(secret_key, GPGME_GPGSecretKey)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	588
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	589 signers.append(secret_key.public_key.key_obj)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	590
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	591 with gpg.Context(home_dir=self.__home_dir, signers=signers) as c:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	592 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	593 signed_data, __ = c.sign(data)
3954 1ab16449577b plugin XEP-0373: typos Goffi <goffi@goffi.org> parents: 3942 diff changeset	594 except gpg.errors.GPGMEError as e:
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	595 raise GPGProviderError("Internal GPGME error") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	596 except gpg.errors.InvalidSigners as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	597 raise GPGProviderError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	598 "At least one of the secret keys is invalid for signing"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	599 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	600
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	601 return signed_data
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	602
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	603 def sign_detached(self, data: bytes, secret_keys: Set[GPGSecretKey]) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	604 signers = []
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	605 for secret_key in secret_keys:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	606 assert isinstance(secret_key, GPGME_GPGSecretKey)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	607
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	608 signers.append(secret_key.public_key.key_obj)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	609
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	610 with gpg.Context(home_dir=self.__home_dir, signers=signers) as c:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	611 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	612 signature, __ = c.sign(data, mode=gpg.constants.sig.mode.DETACH)
3954 1ab16449577b plugin XEP-0373: typos Goffi <goffi@goffi.org> parents: 3942 diff changeset	613 except gpg.errors.GPGMEError as e:
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	614 raise GPGProviderError("Internal GPGME error") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	615 except gpg.errors.InvalidSigners as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	616 raise GPGProviderError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	617 "At least one of the secret keys is invalid for signing"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	618 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	619
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	620 return signature
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	621
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	622 def verify(self, signed_data: bytes, public_keys: Set[GPGPublicKey]) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	623 with gpg.Context(home_dir=self.__home_dir) as c:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	624 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	625 data, result = c.verify(signed_data)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	626 except gpg.errors.GPGMEError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	627 raise GPGProviderError("Internal GPGME error") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	628 except gpg.errors.BadSignatures as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	629 raise VerificationFailed("Bad signatures on signed data") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	630
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	631 valid_signature_found = False
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	632 for public_key in public_keys:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	633 assert isinstance(public_key, GPGME_GPGPublicKey)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	634
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	635 for subkey in public_key.key_obj.subkeys:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	636 for sig in result.signatures:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	637 if subkey.can_sign and subkey.fpr == sig.fpr:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	638 valid_signature_found = True
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	639
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	640 if not valid_signature_found:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	641 raise VerificationFailed(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	642 "Data not signed by one of the expected public keys"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	643 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	644
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	645 return data
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	646
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	647 def verify_detached(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	648 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	649 data: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	650 signature: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	651 public_keys: Set[GPGPublicKey]
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	652 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	653 with gpg.Context(home_dir=self.__home_dir) as c:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	654 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	655 __, result = c.verify(data, signature=signature)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	656 except gpg.errors.GPGMEError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	657 raise GPGProviderError("Internal GPGME error") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	658 except gpg.errors.BadSignatures as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	659 raise VerificationFailed("Bad signatures on signed data") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	660
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	661 valid_signature_found = False
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	662 for public_key in public_keys:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	663 assert isinstance(public_key, GPGME_GPGPublicKey)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	664
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	665 for subkey in public_key.key_obj.subkeys:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	666 for sig in result.signatures:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	667 if subkey.can_sign and subkey.fpr == sig.fpr:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	668 valid_signature_found = True
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	669
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	670 if not valid_signature_found:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	671 raise VerificationFailed(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	672 "Data not signed by one of the expected public keys"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	673 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	674
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	675 def encrypt(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	676 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	677 plaintext: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	678 public_keys: Set[GPGPublicKey],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	679 signing_keys: Optional[Set[GPGSecretKey]] = None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	680 ) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	681 recipients = []
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	682 for public_key in public_keys:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	683 assert isinstance(public_key, GPGME_GPGPublicKey)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	684
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	685 recipients.append(public_key.key_obj)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	686
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	687 signers = []
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	688 if signing_keys is not None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	689 for secret_key in signing_keys:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	690 assert isinstance(secret_key, GPGME_GPGSecretKey)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	691
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	692 signers.append(secret_key.public_key.key_obj)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	693
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	694 sign = signing_keys is not None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	695
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	696 with gpg.Context(home_dir=self.__home_dir, signers=signers) as c:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	697 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	698 ciphertext, __, __ = c.encrypt(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	699 plaintext,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	700 recipients=recipients,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	701 sign=sign,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	702 always_trust=True,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	703 add_encrypt_to=True
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	704 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	705 except gpg.errors.GPGMEError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	706 raise GPGProviderError("Internal GPGME error") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	707 except gpg.errors.InvalidRecipients as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	708 raise GPGProviderError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	709 "At least one of the public keys is invalid for encryption"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	710 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	711 except gpg.errors.InvalidSigners as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	712 raise GPGProviderError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	713 "At least one of the signing keys is invalid for signing"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	714 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	715
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	716 return ciphertext
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	717
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	718 def decrypt(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	719 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	720 ciphertext: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	721 secret_keys: Set[GPGSecretKey],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	722 public_keys: Optional[Set[GPGPublicKey]] = None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	723 ) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	724 verify = public_keys is not None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	725
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	726 with gpg.Context(home_dir=self.__home_dir) as c:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	727 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	728 plaintext, result, verify_result = c.decrypt(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	729 ciphertext,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	730 verify=verify
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	731 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	732 except gpg.errors.GPGMEError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	733 raise GPGProviderError("Internal GPGME error") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	734 except gpg.UnsupportedAlgorithm as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	735 raise DecryptionFailed("Unsupported algorithm") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	736
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	737 # TODO: Check whether the data was decrypted using one of the expected secret
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	738 # keys
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	739
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	740 if public_keys is not None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	741 valid_signature_found = False
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	742 for public_key in public_keys:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	743 assert isinstance(public_key, GPGME_GPGPublicKey)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	744
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	745 for subkey in public_key.key_obj.subkeys:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	746 for sig in verify_result.signatures:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	747 if subkey.can_sign and subkey.fpr == sig.fpr:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	748 valid_signature_found = True
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	749
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	750 if not valid_signature_found:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	751 raise VerificationFailed(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	752 "Data not signed by one of the expected public keys"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	753 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	754
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	755 return plaintext
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	756
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	757 def list_public_keys(self, user_id: str) -> Set[GPGPublicKey]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	758 with gpg.Context(home_dir=self.__home_dir) as c:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	759 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	760 return {
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	761 GPGME_GPGPublicKey(key)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	762 for key
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	763 in c.keylist(pattern=user_id, secret=False)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	764 }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	765 except gpg.errors.GPGMEError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	766 raise GPGProviderError("Internal GPGME error") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	767
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	768 def list_secret_keys(self, user_id: str) -> Set[GPGSecretKey]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	769 with gpg.Context(home_dir=self.__home_dir) as c:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	770 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	771 return {
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	772 GPGME_GPGSecretKey(GPGME_GPGPublicKey(key))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	773 for key
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	774 in c.keylist(pattern=user_id, secret=True)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	775 }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	776 except gpg.errors.GPGMEError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	777 raise GPGProviderError("Internal GPGME error") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	778
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	779 def can_sign(self, public_key: GPGPublicKey) -> bool:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	780 assert isinstance(public_key, GPGME_GPGPublicKey)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	781
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	782 return any(subkey.can_sign for subkey in public_key.key_obj.subkeys)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	783
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	784 def can_encrypt(self, public_key: GPGPublicKey) -> bool:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	785 assert isinstance(public_key, GPGME_GPGPublicKey)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	786
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	787 return any(subkey.can_encrypt for subkey in public_key.key_obj.subkeys)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	788
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	789 def create_key(self, user_id: str) -> GPGSecretKey:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	790 with gpg.Context(home_dir=self.__home_dir) as c:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	791 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	792 result = c.create_key(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	793 user_id,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	794 expires=False,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	795 sign=True,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	796 encrypt=True,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	797 certify=False,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	798 authenticate=False,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	799 force=True
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	800 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	801
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	802 key_obj = c.get_key(result.fpr, secret=True)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	803 except gpg.errors.GPGMEError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	804 raise GPGProviderError("Internal GPGME error") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	805 except gpg.errors.KeyError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	806 raise GPGProviderError("Newly created key not found") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	807
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	808 return GPGME_GPGSecretKey(GPGME_GPGPublicKey(key_obj))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	809
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	810
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	811 class PublicKeyMetadata(NamedTuple):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	812 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	813 Metadata about a published public key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	814 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	815
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	816 fingerprint: str
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	817 timestamp: datetime
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	818
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	819
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	820 @enum.unique
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	821 class TrustLevel(enum.Enum):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	822 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	823 The trust levels required for BTBV and manual trust.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	824 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	825
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	826 TRUSTED: str = "TRUSTED"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	827 BLINDLY_TRUSTED: str = "BLINDLY_TRUSTED"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	828 UNDECIDED: str = "UNDECIDED"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	829 DISTRUSTED: str = "DISTRUSTED"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	830
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	831
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	832 OPENPGP_SCHEMA = xmlschema.XMLSchema("""<?xml version="1.0" encoding="utf8"?>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	833 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	834 targetNamespace="urn:xmpp:openpgp:0"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	835 xmlns="urn:xmpp:openpgp:0">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	836
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	837 <xs:element name="openpgp" type="xs:base64Binary"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	838 </xs:schema>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	839 """)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	840
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	841
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	842 # The following schema needs verion 1.1 of XML Schema, which is not supported by lxml.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	843 # Luckily, xmlschema exists, which is a clean, well maintained, cross-platform
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	844 # implementation of XML Schema, including version 1.1.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	845 CONTENT_SCHEMA = xmlschema.XMLSchema11("""<?xml version="1.1" encoding="utf8"?>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	846 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	847 targetNamespace="urn:xmpp:openpgp:0"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	848 xmlns="urn:xmpp:openpgp:0">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	849
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	850 <xs:element name="signcrypt">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	851 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	852 <xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	853 <xs:element ref="to" maxOccurs="unbounded"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	854 <xs:element ref="time"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	855 <xs:element ref="rpad" minOccurs="0"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	856 <xs:element ref="payload"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	857 </xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	858 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	859 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	860
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	861 <xs:element name="sign">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	862 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	863 <xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	864 <xs:element ref="to" maxOccurs="unbounded"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	865 <xs:element ref="time"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	866 <xs:element ref="rpad" minOccurs="0"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	867 <xs:element ref="payload"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	868 </xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	869 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	870 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	871
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	872 <xs:element name="crypt">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	873 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	874 <xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	875 <xs:element ref="to" minOccurs="0" maxOccurs="unbounded"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	876 <xs:element ref="time"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	877 <xs:element ref="rpad" minOccurs="0"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	878 <xs:element ref="payload"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	879 </xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	880 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	881 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	882
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	883 <xs:element name="to">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	884 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	885 <xs:attribute name="jid" type="xs:string"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	886 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	887 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	888
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	889 <xs:element name="time">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	890 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	891 <xs:attribute name="stamp" type="xs:dateTime"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	892 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	893 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	894
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	895 <xs:element name="rpad" type="xs:string"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	896
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	897 <xs:element name="payload">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	898 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	899 <xs:sequence>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	900 <xs:any minOccurs="0" maxOccurs="unbounded" processContents="skip"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	901 </xs:sequence>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	902 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	903 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	904 </xs:schema>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	905 """)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	906
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	907
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	908 PUBLIC_KEYS_LIST_NODE = "urn:xmpp:openpgp:0:public-keys"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	909 PUBLIC_KEYS_LIST_SCHEMA = xmlschema.XMLSchema("""<?xml version="1.0" encoding="utf8"?>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	910 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	911 targetNamespace="urn:xmpp:openpgp:0"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	912 xmlns="urn:xmpp:openpgp:0">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	913
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	914 <xs:element name="public-keys-list">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	915 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	916 <xs:sequence>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	917 <xs:element ref="pubkey-metadata" minOccurs="0" maxOccurs="unbounded"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	918 </xs:sequence>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	919 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	920 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	921
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	922 <xs:element name="pubkey-metadata">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	923 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	924 <xs:attribute name="v4-fingerprint" type="xs:string"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	925 <xs:attribute name="date" type="xs:dateTime"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	926 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	927 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	928 </xs:schema>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	929 """)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	930
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	931
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	932 PUBKEY_SCHEMA = xmlschema.XMLSchema("""<?xml version="1.0" encoding="utf8"?>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	933 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	934 targetNamespace="urn:xmpp:openpgp:0"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	935 xmlns="urn:xmpp:openpgp:0">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	936
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	937 <xs:element name="pubkey">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	938 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	939 <xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	940 <xs:element ref="data"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	941 </xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	942 <xs:anyAttribute processContents="skip"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	943 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	944 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	945
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	946 <xs:element name="data" type="xs:base64Binary"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	947 </xs:schema>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	948 """)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	949
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	950
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	951 SECRETKEY_SCHEMA = xmlschema.XMLSchema("""<?xml version="1.0" encoding="utf8"?>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	952 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	953 targetNamespace="urn:xmpp:openpgp:0"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	954 xmlns="urn:xmpp:openpgp:0">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	955
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	956 <xs:element name="secretkey" type="xs:base64Binary"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	957 </xs:schema>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	958 """)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	959
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	960
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	961 DEFAULT_TRUST_MODEL_PARAM = f"""
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	962 <params>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	963 <individual>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	964 <category name="{PARAM_CATEGORY}" label={quoteattr(D_('Security'))}>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	965 <param name="{PARAM_NAME}"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	966 label={quoteattr(D_('OMEMO default trust policy'))}
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	967 type="list" security="3">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	968 <option value="manual" label={quoteattr(D_('Manual trust (more secure)'))} />
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	969 <option value="btbv"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	970 label={quoteattr(D_('Blind Trust Before Verification (more user friendly)'))}
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	971 selected="true" />
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	972 </param>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	973 </category>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	974 </individual>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	975 </params>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	976 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	977
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	978
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	979 def get_gpg_provider(sat: SAT, client: SatXMPPClient) -> GPGProvider:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	980 """Get the GPG provider for a client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	981
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	982 @param sat: The SAT instance.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	983 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	984 @return: The GPG provider specifically for that client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	985 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	986
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	987 return GPGME_GPGProvider(str(sat.get_local_path(client, "gnupg-home")))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	988
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	989
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	990 def generate_passphrase() -> str:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	991 """Generate a secure passphrase for symmetric encryption.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	992
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	993 @return: The passphrase.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	994 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	995
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	996 return "-".join("".join(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	997 secrets.choice("123456789ABCDEFGHIJKLMNPQRSTUVWXYZ") for __ in range(4)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	998 ) for __ in range(6))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	999
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1000
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1001 # TODO: Handle the user id mess
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1002 class XEP_0373:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1003 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1004 Implementation of XEP-0373: OpenPGP for XMPP under namespace ``urn:xmpp:openpgp:0``.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1005 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1006
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1007 def __init__(self, host: SAT) -> None:
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1008 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1009 @param sat: The SAT instance.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1010 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1011
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1012 self.host = host
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1013
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1014 # Add configuration option to choose between manual trust and BTBV as the trust
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1015 # model
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1016 host.memory.update_params(DEFAULT_TRUST_MODEL_PARAM)
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1017
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1018 self.__xep_0045 = cast(Optional[XEP_0045], host.plugins.get("XEP-0045"))
4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1019 self.__xep_0060 = cast(XEP_0060, host.plugins["XEP-0060"])
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1020
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1021 self.__storage: Dict[str, persistent.LazyPersistentBinaryDict] = {}
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1022
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1023 xep_0163 = cast(XEP_0163, host.plugins["XEP-0163"])
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1024 xep_0163.add_pep_event(
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1025 "OX_PUBLIC_KEYS_LIST",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1026 PUBLIC_KEYS_LIST_NODE,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1027 lambda items_event, profile: defer.ensureDeferred(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1028 self.__on_public_keys_list_update(items_event, profile)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1029 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1030 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1031
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1032 async def profile_connecting(self, client):
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1033 client.gpg_provider = get_gpg_provider(self.host, client)
4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1034
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1035 async def profile_connected( # pylint: disable=invalid-name
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1036 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1037 client: SatXMPPClient
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1038 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1039 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1040 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1041 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1042
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1043 profile = cast(str, client.profile)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1044
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1045 if not profile in self.__storage:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1046 self.__storage[profile] = \
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1047 persistent.LazyPersistentBinaryDict("XEP-0373", client.profile)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1048
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1049 if len(self.list_secret_keys(client)) == 0:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1050 log.debug(f"Generating first GPG key for {client.jid.userhost()}.")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1051 await self.create_key(client)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1052
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1053 async def __on_public_keys_list_update(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1054 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1055 items_event: pubsub.ItemsEvent,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1056 profile: str
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1057 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1058 """Handle public keys list updates fired by PEP.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1059
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1060 @param items_event: The event.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1061 @param profile: The profile this event belongs to.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1062 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1063
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1064 client = self.host.get_client(profile)
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1065
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1066 sender = cast(jid.JID, items_event.sender)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1067 items = cast(List[domish.Element], items_event.items)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1068
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1069 if len(items) > 1:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1070 log.warning("Ignoring public keys list update with more than one element.")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1071 return
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1072
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1073 item_elt = next(iter(items), None)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1074 if item_elt is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1075 log.debug("Ignoring empty public keys list update.")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1076 return
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1077
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1078 public_keys_list_elt = cast(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1079 Optional[domish.Element],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1080 next(item_elt.elements(NS_OX, "public-keys-list"), None)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1081 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1082
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1083 pubkey_metadata_elts: Optional[List[domish.Element]] = None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1084
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1085 if public_keys_list_elt is not None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1086 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1087 PUBLIC_KEYS_LIST_SCHEMA.validate(public_keys_list_elt.toXml())
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1088 except xmlschema.XMLSchemaValidationError:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1089 pass
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1090 else:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1091 pubkey_metadata_elts = \
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1092 list(public_keys_list_elt.elements(NS_OX, "pubkey-metadata"))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1093
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1094 if pubkey_metadata_elts is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1095 log.warning(f"Malformed public keys list update item: {item_elt.toXml()}")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1096 return
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1097
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1098 new_public_keys_metadata = { PublicKeyMetadata(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1099 fingerprint=cast(str, pubkey_metadata_elt["v4-fingerprint"]),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1100 timestamp=parse_datetime(cast(str, pubkey_metadata_elt["date"]))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1101 ) for pubkey_metadata_elt in pubkey_metadata_elts }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1102
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1103 storage_key = STR_KEY_PUBLIC_KEYS_METADATA.format(sender.userhost())
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1104
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1105 local_public_keys_metadata = cast(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1106 Set[PublicKeyMetadata],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1107 await self.__storage[profile].get(storage_key, set())
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1108 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1109
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1110 unchanged_keys = new_public_keys_metadata & local_public_keys_metadata
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1111 changed_or_new_keys = new_public_keys_metadata - unchanged_keys
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1112 available_keys = self.list_public_keys(client, sender)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1113
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1114 for key_metadata in changed_or_new_keys:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1115 # Check whether the changed or new key has been imported before
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1116 if any(key.fingerprint == key_metadata.fingerprint for key in available_keys):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1117 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1118 # If it has been imported before, try to update it
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1119 await self.import_public_key(client, sender, key_metadata.fingerprint)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1120 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1121 log.warning(f"Public key import failed: {e}")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1122
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1123 # If the update fails, remove the key from the local metadata list
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1124 # such that the update is attempted again next time
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1125 new_public_keys_metadata.remove(key_metadata)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1126
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1127 # Check whether this update was for our account and make sure all of our keys are
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1128 # included in the update
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1129 if sender.userhost() == client.jid.userhost():
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1130 secret_keys = self.list_secret_keys(client)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1131 missing_keys = set(filter(lambda secret_key: all(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1132 key_metadata.fingerprint != secret_key.public_key.fingerprint
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1133 for key_metadata
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1134 in new_public_keys_metadata
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1135 ), secret_keys))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1136
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1137 if len(missing_keys) > 0:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1138 log.warning(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1139 "Public keys list update did not contain at least one of our keys."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1140 f" {new_public_keys_metadata}"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1141 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1142
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1143 for missing_key in missing_keys:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1144 log.warning(missing_key.public_key.fingerprint)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1145 new_public_keys_metadata.add(PublicKeyMetadata(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1146 fingerprint=missing_key.public_key.fingerprint,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1147 timestamp=datetime.now(timezone.utc)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1148 ))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1149
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1150 await self.publish_public_keys_list(client, new_public_keys_metadata)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1151
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1152 await self.__storage[profile].force(storage_key, new_public_keys_metadata)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1153
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1154 def list_public_keys(self, client: SatXMPPClient, jid: jid.JID) -> Set[GPGPublicKey]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1155 """List GPG public keys available for a JID.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1156
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1157 @param client: The client to perform this operation with.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1158 @param jid: The JID. Can be a bare JID.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1159 @return: The set of public keys available for this JID.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1160 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1161
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1162 gpg_provider = get_gpg_provider(self.host, client)
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1163
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1164 return gpg_provider.list_public_keys(f"xmpp:{jid.userhost()}")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1165
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1166 def list_secret_keys(self, client: SatXMPPClient) -> Set[GPGSecretKey]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1167 """List GPG secret keys available for a JID.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1168
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1169 @param client: The client to perform this operation with.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1170 @return: The set of secret keys available for this JID.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1171 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1172
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1173 gpg_provider = get_gpg_provider(self.host, client)
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1174
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1175 return gpg_provider.list_secret_keys(f"xmpp:{client.jid.userhost()}")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1176
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1177 async def create_key(self, client: SatXMPPClient) -> GPGSecretKey:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1178 """Create a new GPG key, capable of signing and encryption.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1179
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1180 The key is generated without password protection and without expiration.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1181
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1182 @param client: The client to perform this operation with.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1183 @return: The new key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1184 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1185
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1186 gpg_provider = get_gpg_provider(self.host, client)
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1187
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1188 secret_key = gpg_provider.create_key(f"xmpp:{client.jid.userhost()}")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1189
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1190 await self.publish_public_key(client, secret_key.public_key)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1191
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1192 storage_key = STR_KEY_PUBLIC_KEYS_METADATA.format(client.jid.userhost())
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1193
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1194 public_keys_list = cast(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1195 Set[PublicKeyMetadata],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1196 await self.__storage[client.profile].get(storage_key, set())
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1197 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1198
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1199 public_keys_list.add(PublicKeyMetadata(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1200 fingerprint=secret_key.public_key.fingerprint,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1201 timestamp=datetime.now(timezone.utc)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1202 ))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1203
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1204 await self.publish_public_keys_list(client, public_keys_list)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1205
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1206 await self.__storage[client.profile].force(storage_key, public_keys_list)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1207
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1208 return secret_key
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1209
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1210 @staticmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1211 def __build_content_element(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1212 element_name: Literal["signcrypt", "sign", "crypt"],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1213 recipient_jids: Iterable[jid.JID],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1214 include_rpad: bool
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1215 ) -> Tuple[domish.Element, domish.Element]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1216 """Build a content element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1217
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1218 @param element_name: The name of the content element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1219 @param recipient_jids: The intended recipients of this content element. Can be
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1220 bare JIDs.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1221 @param include_rpad: Whether to include random-length random-content padding.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1222 @return: The content element and the ``<payload/>`` element to add the stanza
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1223 extension elements to.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1224 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1225
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1226 content_elt = domish.Element((NS_OX, element_name))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1227
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1228 for recipient_jid in recipient_jids:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1229 content_elt.addElement("to")["jid"] = recipient_jid.userhost()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1230
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1231 content_elt.addElement("time")["stamp"] = format_datetime()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1232
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1233 if include_rpad:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1234 # XEP-0373 doesn't specify bounds for the length of the random padding. This
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1235 # uses the bounds specified in XEP-0420 for the closely related rpad affix.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1236 rpad_length = secrets.randbelow(201)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1237 rpad_content = "".join(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1238 secrets.choice(string.digits + string.ascii_letters + string.punctuation)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1239 for __
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1240 in range(rpad_length)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1241 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1242 content_elt.addElement("rpad", content=rpad_content)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1243
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1244 payload_elt = content_elt.addElement("payload")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1245
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1246 return content_elt, payload_elt
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1247
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1248 @staticmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1249 def build_signcrypt_element(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1250 recipient_jids: Iterable[jid.JID]
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1251 ) -> Tuple[domish.Element, domish.Element]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1252 """Build a ``<signcrypt/>`` content element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1253
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1254 @param recipient_jids: The intended recipients of this content element. Can be
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1255 bare JIDs.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1256 @return: The ``<signcrypt/>`` element and the ``<payload/>`` element to add the
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1257 stanza extension elements to.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1258 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1259
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1260 if len(recipient_jids) == 0:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1261 raise ValueError("Recipient JIDs must be provided.")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1262
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1263 return XEP_0373.__build_content_element("signcrypt", recipient_jids, True)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1264
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1265 @staticmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1266 def build_sign_element(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1267 recipient_jids: Iterable[jid.JID],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1268 include_rpad: bool
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1269 ) -> Tuple[domish.Element, domish.Element]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1270 """Build a ``<sign/>`` content element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1271
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1272 @param recipient_jids: The intended recipients of this content element. Can be
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1273 bare JIDs.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1274 @param include_rpad: Whether to include random-length random-content padding,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1275 which is OPTIONAL for the ``<sign/>`` content element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1276 @return: The ``<sign/>`` element and the ``<payload/>`` element to add the stanza
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1277 extension elements to.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1278 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1279
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1280 if len(recipient_jids) == 0:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1281 raise ValueError("Recipient JIDs must be provided.")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1282
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1283 return XEP_0373.__build_content_element("sign", recipient_jids, include_rpad)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1284
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1285 @staticmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1286 def build_crypt_element(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1287 recipient_jids: Iterable[jid.JID]
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1288 ) -> Tuple[domish.Element, domish.Element]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1289 """Build a ``<crypt/>`` content element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1290
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1291 @param recipient_jids: The intended recipients of this content element. Specifying
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1292 the intended recipients is OPTIONAL for the ``<crypt/>`` content element. Can
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1293 be bare JIDs.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1294 @return: The ``<crypt/>`` element and the ``<payload/>`` element to add the stanza
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1295 extension elements to.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1296 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1297
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1298 return XEP_0373.__build_content_element("crypt", recipient_jids, True)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1299
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1300 async def build_openpgp_element(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1301 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1302 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1303 content_elt: domish.Element,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1304 recipient_jids: Set[jid.JID]
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1305 ) -> domish.Element:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1306 """Build an ``<openpgp/>`` element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1307
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1308 @param client: The client to perform this operation with.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1309 @param content_elt: The content element to contain in the ``<openpgp/>`` element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1310 @param recipient_jids: The recipient's JIDs. Can be bare JIDs.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1311 @return: The ``<openpgp/>`` element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1312 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1313
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1314 gpg_provider = get_gpg_provider(self.host, client)
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1315
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1316 # TODO: I'm not sure whether we want to sign with all keys by default or choose
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1317 # just one key/a subset of keys to sign with.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1318 signing_keys = set(filter(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1319 lambda secret_key: gpg_provider.can_sign(secret_key.public_key),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1320 self.list_secret_keys(client)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1321 ))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1322
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1323 encryption_keys: Set[GPGPublicKey] = set()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1324
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1325 for recipient_jid in recipient_jids:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1326 # import all keys of the recipient
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1327 all_public_keys = await self.import_all_public_keys(client, recipient_jid)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1328
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1329 # Filter for keys that can encrypt
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1330 encryption_keys \|= set(filter(gpg_provider.can_encrypt, all_public_keys))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1331
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1332 # TODO: Handle trust
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1333
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1334 content = content_elt.toXml().encode("utf-8")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1335 data: bytes
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1336
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1337 if content_elt.name == "signcrypt":
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1338 data = gpg_provider.encrypt(content, encryption_keys, signing_keys)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1339 elif content_elt.name == "sign":
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1340 data = gpg_provider.sign(content, signing_keys)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1341 elif content_elt.name == "crypt":
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1342 data = gpg_provider.encrypt(content, encryption_keys)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1343 else:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1344 raise ValueError(f"Unknown content element <{content_elt.name}/>")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1345
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1346 openpgp_elt = domish.Element((NS_OX, "openpgp"))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1347 openpgp_elt.addContent(base64.b64encode(data).decode("ASCII"))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1348 return openpgp_elt
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1349
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1350 async def unpack_openpgp_element(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1351 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1352 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1353 openpgp_elt: domish.Element,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1354 element_name: Literal["signcrypt", "sign", "crypt"],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1355 sender_jid: jid.JID
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1356 ) -> Tuple[domish.Element, datetime]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1357 """Verify, decrypt and unpack an ``<openpgp/>`` element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1358
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1359 @param client: The client to perform this operation with.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1360 @param openpgp_elt: The ``<openpgp/>`` element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1361 @param element_name: The name of the content element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1362 @param sender_jid: The sender's JID. Can be a bare JID.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1363 @return: The ``<payload/>`` element containing the decrypted/verified stanza
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1364 extension elements carried by this ``<openpgp/>`` element, and the timestamp
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1365 contained in the content element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1366 @raise exceptions.ParsingError: on syntactical verification errors.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1367 @raise VerificationError: on semantical verification errors accoding to XEP-0373.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1368 @raise DecryptionFailed: on decryption failure.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1369 @raise VerificationFailed: if the data could not be verified.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1370
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1371 @warning: The timestamp is not verified for plausibility; this SHOULD be done by
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1372 the calling code.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1373 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1374
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1375 gpg_provider = get_gpg_provider(self.host, client)
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1376
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1377 decryption_keys = set(filter(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1378 lambda secret_key: gpg_provider.can_encrypt(secret_key.public_key),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1379 self.list_secret_keys(client)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1380 ))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1381
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1382 # import all keys of the sender
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1383 all_public_keys = await self.import_all_public_keys(client, sender_jid)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1384
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1385 # Filter for keys that can sign
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1386 verification_keys = set(filter(gpg_provider.can_sign, all_public_keys))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1387
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1388 # TODO: Handle trust
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1389
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1390 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1391 OPENPGP_SCHEMA.validate(openpgp_elt.toXml())
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1392 except xmlschema.XMLSchemaValidationError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1393 raise exceptions.ParsingError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1394 "<openpgp/> element doesn't pass schema validation."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1395 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1396
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1397 openpgp_message = base64.b64decode(str(openpgp_elt))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1398 content: bytes
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1399
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1400 if element_name == "signcrypt":
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1401 content = gpg_provider.decrypt(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1402 openpgp_message,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1403 decryption_keys,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1404 public_keys=verification_keys
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1405 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1406 elif element_name == "sign":
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1407 content = gpg_provider.verify(openpgp_message, verification_keys)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1408 elif element_name == "crypt":
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1409 content = gpg_provider.decrypt(openpgp_message, decryption_keys)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1410 else:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1411 assert_never(element_name)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1412
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1413 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1414 content_elt = cast(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1415 domish.Element,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1416 xml_tools.ElementParser()(content.decode("utf-8"))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1417 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1418 except UnicodeDecodeError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1419 raise exceptions.ParsingError("UTF-8 decoding error") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1420
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1421 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1422 CONTENT_SCHEMA.validate(content_elt.toXml())
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1423 except xmlschema.XMLSchemaValidationError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1424 raise exceptions.ParsingError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1425 f"<{element_name}/> element doesn't pass schema validation."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1426 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1427
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1428 if content_elt.name != element_name:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1429 raise exceptions.ParsingError(f"Not a <{element_name}/> element.")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1430
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1431 recipient_jids = \
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1432 { jid.JID(to_elt["jid"]) for to_elt in content_elt.elements(NS_OX, "to") }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1433
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1434 if (
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1435 client.jid.userhostJID() not in { jid.userhostJID() for jid in recipient_jids }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1436 and element_name != "crypt"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1437 ):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1438 raise VerificationError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1439 f"Recipient list in <{element_name}/> element does not list our (bare)"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1440 f" JID."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1441 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1442
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1443 time_elt = next(content_elt.elements(NS_OX, "time"))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1444
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1445 timestamp = parse_datetime(time_elt["stamp"])
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1446
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1447 payload_elt = next(content_elt.elements(NS_OX, "payload"))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1448
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1449 return payload_elt, timestamp
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1450
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1451 async def publish_public_key(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1452 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1453 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1454 public_key: GPGPublicKey
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1455 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1456 """Publish a public key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1457
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1458 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1459 @param public_key: The public key to publish.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1460 @raise XMPPInteractionFailed: if any interaction via XMPP failed.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1461 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1462
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1463 gpg_provider = get_gpg_provider(self.host, client)
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1464
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1465 packet = gpg_provider.export_public_key(public_key)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1466
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1467 node = f"urn:xmpp:openpgp:0:public-keys:{public_key.fingerprint}"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1468
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1469 pubkey_elt = domish.Element((NS_OX, "pubkey"))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1470
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1471 pubkey_elt.addElement("data", content=base64.b64encode(packet).decode("ASCII"))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1472
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1473 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1474 await self.__xep_0060.send_item(
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1475 client,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1476 client.jid.userhostJID(),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1477 node,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1478 pubkey_elt,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1479 format_datetime(),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1480 extra={
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1481 XEP_0060.EXTRA_PUBLISH_OPTIONS: {
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1482 XEP_0060.OPT_PERSIST_ITEMS: "true",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1483 XEP_0060.OPT_ACCESS_MODEL: "open",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1484 XEP_0060.OPT_MAX_ITEMS: 1
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1485 },
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1486 # TODO: Do we really want publish_without_options here?
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1487 XEP_0060.EXTRA_ON_PRECOND_NOT_MET: "publish_without_options"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1488 }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1489 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1490 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1491 raise XMPPInteractionFailed("Publishing the public key failed.") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1492
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1493 async def import_all_public_keys(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1494 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1495 client: SatXMPPClient,
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1496 entity_jid: jid.JID
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1497 ) -> Set[GPGPublicKey]:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1498 """import all public keys of a JID that have not been imported before.
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1499
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1500 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1501 @param jid: The JID. Can be a bare JID.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1502 @return: The public keys.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1503 @note: Failure to import a key simply results in the key not being included in the
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1504 result.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1505 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1506
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1507 available_public_keys = self.list_public_keys(client, entity_jid)
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1508
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1509 storage_key = STR_KEY_PUBLIC_KEYS_METADATA.format(entity_jid.userhost())
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1510
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1511 public_keys_metadata = cast(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1512 Set[PublicKeyMetadata],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1513 await self.__storage[client.profile].get(storage_key, set())
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1514 )
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1515 if not public_keys_metadata:
a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1516 public_keys_metadata = await self.download_public_keys_list(
a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1517 client, entity_jid
a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1518 )
a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1519 if not public_keys_metadata:
a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1520 raise exceptions.NotFound(
a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1521 f"Can't find public keys for {entity_jid}"
a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1522 )
a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1523 else:
a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1524 await self.__storage[client.profile].aset(
a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1525 storage_key, public_keys_metadata
a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1526 )
a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1527
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1528
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1529 missing_keys = set(filter(lambda public_key_metadata: all(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1530 public_key_metadata.fingerprint != public_key.fingerprint
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1531 for public_key
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1532 in available_public_keys
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1533 ), public_keys_metadata))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1534
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1535 for missing_key in missing_keys:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1536 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1537 available_public_keys.add(
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1538 await self.import_public_key(client, entity_jid, missing_key.fingerprint)
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1539 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1540 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1541 log.warning(
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1542 f"import of public key {missing_key.fingerprint} owned by"
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1543 f" {entity_jid.userhost()} failed, ignoring: {e}"
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1544 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1545
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1546 return available_public_keys
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1547
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1548 async def import_public_key(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1549 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1550 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1551 jid: jid.JID,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1552 fingerprint: str
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1553 ) -> GPGPublicKey:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1554 """import a public key.
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1555
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1556 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1557 @param jid: The JID owning the public key. Can be a bare JID.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1558 @param fingerprint: The fingerprint of the public key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1559 @return: The public key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1560 @raise exceptions.NotFound: if the public key was not found.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1561 @raise exceptions.ParsingError: on XML-level parsing errors.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1562 @raise InvalidPacket: if the packet is either syntactically or semantically deemed
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1563 invalid.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1564 @raise XMPPInteractionFailed: if any interaction via XMPP failed.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1565 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1566
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1567 gpg_provider = get_gpg_provider(self.host, client)
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1568
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1569 node = f"urn:xmpp:openpgp:0:public-keys:{fingerprint}"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1570
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1571 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1572 items, __ = await self.__xep_0060.get_items(
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1573 client,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1574 jid.userhostJID(),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1575 node,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1576 max_items=1
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1577 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1578 except exceptions.NotFound as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1579 raise exceptions.NotFound(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1580 f"No public key with fingerprint {fingerprint} published by JID"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1581 f" {jid.userhost()}."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1582 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1583 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1584 raise XMPPInteractionFailed("Fetching the public keys list failed.") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1585
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1586 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1587 item_elt = cast(domish.Element, items[0])
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1588 except IndexError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1589 raise exceptions.NotFound(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1590 f"No public key with fingerprint {fingerprint} published by JID"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1591 f" {jid.userhost()}."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1592 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1593
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1594 pubkey_elt = cast(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1595 Optional[domish.Element],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1596 next(item_elt.elements(NS_OX, "pubkey"), None)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1597 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1598
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1599 if pubkey_elt is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1600 raise exceptions.ParsingError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1601 f"Publish-Subscribe item of JID {jid.userhost()} doesn't contain pubkey"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1602 f" element."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1603 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1604
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1605 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1606 PUBKEY_SCHEMA.validate(pubkey_elt.toXml())
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1607 except xmlschema.XMLSchemaValidationError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1608 raise exceptions.ParsingError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1609 f"Publish-Subscribe item of JID {jid.userhost()} doesn't pass pubkey"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1610 f" schema validation."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1611 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1612
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1613 public_key = gpg_provider.import_public_key(base64.b64decode(str(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1614 next(pubkey_elt.elements(NS_OX, "data"))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1615 )))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1616
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1617 return public_key
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1618
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1619 async def publish_public_keys_list(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1620 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1621 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1622 public_keys_list: Iterable[PublicKeyMetadata]
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1623 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1624 """Publish/update the own public keys list.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1625
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1626 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1627 @param public_keys_list: The public keys list.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1628 @raise XMPPInteractionFailed: if any interaction via XMPP failed.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1629
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1630 @warning: All public keys referenced in the public keys list MUST be published
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1631 beforehand.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1632 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1633
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1634 if len({ pkm.fingerprint for pkm in public_keys_list }) != len(public_keys_list):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1635 raise ValueError("Public keys list contains duplicate fingerprints.")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1636
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1637 node = "urn:xmpp:openpgp:0:public-keys"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1638
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1639 public_keys_list_elt = domish.Element((NS_OX, "public-keys-list"))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1640
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1641 for public_key_metadata in public_keys_list:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1642 pubkey_metadata_elt = public_keys_list_elt.addElement("pubkey-metadata")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1643 pubkey_metadata_elt["v4-fingerprint"] = public_key_metadata.fingerprint
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1644 pubkey_metadata_elt["date"] = format_datetime(public_key_metadata.timestamp)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1645
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1646 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1647 await self.__xep_0060.send_item(
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1648 client,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1649 client.jid.userhostJID(),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1650 node,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1651 public_keys_list_elt,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1652 item_id=XEP_0060.ID_SINGLETON,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1653 extra={
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1654 XEP_0060.EXTRA_PUBLISH_OPTIONS: {
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1655 XEP_0060.OPT_PERSIST_ITEMS: "true",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1656 XEP_0060.OPT_ACCESS_MODEL: "open",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1657 XEP_0060.OPT_MAX_ITEMS: 1
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1658 },
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1659 # TODO: Do we really want publish_without_options here?
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1660 XEP_0060.EXTRA_ON_PRECOND_NOT_MET: "publish_without_options"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1661 }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1662 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1663 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1664 raise XMPPInteractionFailed("Publishing the public keys list failed.") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1665
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1666 async def download_public_keys_list(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1667 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1668 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1669 jid: jid.JID
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1670 ) -> Optional[Set[PublicKeyMetadata]]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1671 """Download the public keys list of a JID.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1672
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1673 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1674 @param jid: The JID. Can be a bare JID.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1675 @return: The public keys list or ``None`` if the JID hasn't published a public
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1676 keys list. An empty list means the JID has published an empty list.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1677 @raise exceptions.ParsingError: on XML-level parsing errors.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1678 @raise XMPPInteractionFailed: if any interaction via XMPP failed.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1679 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1680
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1681 node = "urn:xmpp:openpgp:0:public-keys"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1682
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1683 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1684 items, __ = await self.__xep_0060.get_items(
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1685 client,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1686 jid.userhostJID(),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1687 node,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1688 max_items=1
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1689 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1690 except exceptions.NotFound:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1691 return None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1692 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1693 raise XMPPInteractionFailed() from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1694
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1695 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1696 item_elt = cast(domish.Element, items[0])
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1697 except IndexError:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1698 return None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1699
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1700 public_keys_list_elt = cast(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1701 Optional[domish.Element],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1702 next(item_elt.elements(NS_OX, "public-keys-list"), None)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1703 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1704
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1705 if public_keys_list_elt is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1706 return None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1707
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1708 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1709 PUBLIC_KEYS_LIST_SCHEMA.validate(public_keys_list_elt.toXml())
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1710 except xmlschema.XMLSchemaValidationError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1711 raise exceptions.ParsingError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1712 f"Publish-Subscribe item of JID {jid.userhost()} doesn't pass public keys"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1713 f" list schema validation."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1714 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1715
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1716 return {
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1717 PublicKeyMetadata(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1718 fingerprint=pubkey_metadata_elt["v4-fingerprint"],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1719 timestamp=parse_datetime(pubkey_metadata_elt["date"])
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1720 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1721 for pubkey_metadata_elt
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1722 in public_keys_list_elt.elements(NS_OX, "pubkey-metadata")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1723 }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1724
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1725 async def __prepare_secret_key_synchronization(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1726 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1727 client: SatXMPPClient
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1728 ) -> Optional[domish.Element]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1729 """Prepare for secret key synchronization.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1730
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1731 Makes sure the relative protocols and protocol extensions are supported by the
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1732 server and makes sure that the PEP node for secret synchronization exists and is
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1733 configured correctly. The node is created if necessary.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1734
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1735 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1736 @return: As part of the preparations, the secret key synchronization PEP node is
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1737 fetched. The result of that fetch is returned here.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1738 @raise exceptions.FeatureNotFound: if the server lacks support for the required
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1739 protocols or protocol extensions.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1740 @raise XMPPInteractionFailed: if any interaction via XMPP failed.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1741 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1742
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1743 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1744 infos = cast(DiscoInfo, await self.host.memory.disco.get_infos(
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1745 client,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1746 client.jid.userhostJID()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1747 ))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1748 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1749 raise XMPPInteractionFailed(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1750 "Error performing service discovery on the own bare JID."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1751 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1752
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1753 identities = cast(Dict[Tuple[str, str], str], infos.identities)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1754 features = cast(Set[DiscoFeature], infos.features)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1755
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1756 if ("pubsub", "pep") not in identities:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1757 raise exceptions.FeatureNotFound("Server doesn't support PEP.")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1758
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1759 if "http://jabber.org/protocol/pubsub#access-whitelist" not in features:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1760 raise exceptions.FeatureNotFound(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1761 "Server doesn't support the whitelist access model."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1762 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1763
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1764 persistent_items_supported = \
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1765 "http://jabber.org/protocol/pubsub#persistent-items" in features
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1766
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1767 # TODO: persistent-items is a SHOULD, how do we handle the feature missing?
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1768
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1769 node = "urn:xmpp:openpgp:0:secret-key"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1770
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1771 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1772 items, __ = await self.__xep_0060.get_items(
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1773 client,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1774 client.jid.userhostJID(),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1775 node,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1776 max_items=1
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1777 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1778 except exceptions.NotFound:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1779 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1780 await self.__xep_0060.createNode(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1781 client,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1782 client.jid.userhostJID(),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1783 node,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1784 {
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1785 XEP_0060.OPT_PERSIST_ITEMS: "true",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1786 XEP_0060.OPT_ACCESS_MODEL: "whitelist",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1787 XEP_0060.OPT_MAX_ITEMS: "1"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1788 }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1789 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1790 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1791 raise XMPPInteractionFailed(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1792 "Error creating the secret key synchronization node."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1793 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1794 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1795 raise XMPPInteractionFailed(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1796 "Error fetching the secret key synchronization node."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1797 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1798
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1799 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1800 return cast(domish.Element, items[0])
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1801 except IndexError:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1802 return None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1803
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1804 async def export_secret_keys(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1805 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1806 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1807 secret_keys: Iterable[GPGSecretKey]
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1808 ) -> str:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1809 """Export secret keys to synchronize them with other devices.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1810
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1811 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1812 @param secret_keys: The secret keys to export.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1813 @return: The backup code needed to decrypt the exported secret keys.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1814 @raise exceptions.FeatureNotFound: if the server lacks support for the required
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1815 protocols or protocol extensions.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1816 @raise XMPPInteractionFailed: if any interaction via XMPP failed.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1817 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1818
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1819 gpg_provider = get_gpg_provider(self.host, client)
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1820
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1821 await self.__prepare_secret_key_synchronization(client)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1822
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1823 backup_code = generate_passphrase()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1824
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1825 plaintext = b"".join(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1826 gpg_provider.backup_secret_key(secret_key) for secret_key in secret_keys
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1827 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1828
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1829 ciphertext = gpg_provider.encrypt_symmetrically(plaintext, backup_code)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1830
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1831 node = "urn:xmpp:openpgp:0:secret-key"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1832
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1833 secretkey_elt = domish.Element((NS_OX, "secretkey"))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1834 secretkey_elt.addContent(base64.b64encode(ciphertext).decode("ASCII"))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1835
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1836 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1837 await self.__xep_0060.send_item(
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1838 client,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1839 client.jid.userhostJID(),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1840 node,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1841 secretkey_elt
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1842 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1843 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1844 raise XMPPInteractionFailed("Publishing the secret keys failed.") from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1845
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1846 return backup_code
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1847
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1848 async def download_secret_keys(self, client: SatXMPPClient) -> Optional[bytes]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1849 """Download previously exported secret keys to import them in a second step.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1850
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1851 The downloading and importing steps are separate since a backup code is required
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1852 for the import and it should be possible to try multiple backup codes without
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1853 redownloading the data every time. The second half of the import procedure is
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1854 provided by :meth:`import_secret_keys`.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1855
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1856 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1857 @return: The encrypted secret keys previously exported, if any.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1858 @raise exceptions.FeatureNotFound: if the server lacks support for the required
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1859 protocols or protocol extensions.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1860 @raise exceptions.ParsingError: on XML-level parsing errors.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1861 @raise XMPPInteractionFailed: if any interaction via XMPP failed.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1862 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1863
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1864 item_elt = await self.__prepare_secret_key_synchronization(client)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1865 if item_elt is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1866 return None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1867
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1868 secretkey_elt = cast(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1869 Optional[domish.Element],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1870 next(item_elt.elements(NS_OX, "secretkey"), None)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1871 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1872
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1873 if secretkey_elt is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1874 return None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1875
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1876 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1877 SECRETKEY_SCHEMA.validate(secretkey_elt.toXml())
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1878 except xmlschema.XMLSchemaValidationError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1879 raise exceptions.ParsingError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1880 "Publish-Subscribe item doesn't pass secretkey schema validation."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1881 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1882
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1883 return base64.b64decode(str(secretkey_elt))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1884
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1885 def import_secret_keys(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1886 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1887 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1888 ciphertext: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1889 backup_code: str
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1890 ) -> Set[GPGSecretKey]:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1891 """import previously downloaded secret keys.
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1892
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1893 The downloading and importing steps are separate since a backup code is required
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1894 for the import and it should be possible to try multiple backup codes without
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1895 redownloading the data every time. The first half of the import procedure is
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1896 provided by :meth:`download_secret_keys`.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1897
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1898 @param client: The client to perform this operation with.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1899 @param ciphertext: The ciphertext, i.e. the data returned by
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1900 :meth:`download_secret_keys`.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1901 @param backup_code: The backup code needed to decrypt the data.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1902 @raise InvalidPacket: if one of the GPG packets building the secret key data is
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1903 either syntactically or semantically deemed invalid.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1904 @raise DecryptionFailed: on decryption failure.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1905 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1906
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1907 gpg_provider = get_gpg_provider(self.host, client)
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1908
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1909 return gpg_provider.restore_secret_keys(gpg_provider.decrypt_symmetrically(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1910 ciphertext,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1911 backup_code
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1912 ))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1913
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1914 @staticmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1915 def __get_joined_muc_users(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1916 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1917 xep_0045: XEP_0045,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1918 room_jid: jid.JID
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1919 ) -> Set[jid.JID]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1920 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1921 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1922 @param xep_0045: A MUC plugin instance.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1923 @param room_jid: The room JID.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1924 @return: A set containing the bare JIDs of the MUC participants.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1925 @raise InternalError: if the MUC is not joined or the entity information of a
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1926 participant isn't available.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1927 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1928 # TODO: This should probably be a global helper somewhere
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1929
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1930 bare_jids: Set[jid.JID] = set()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1931
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1932 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1933 room = cast(muc.Room, xep_0045.get_room(client, room_jid))
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1934 except exceptions.NotFound as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1935 raise exceptions.InternalError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1936 "Participant list of unjoined MUC requested."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1937 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1938
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1939 for user in cast(Dict[str, muc.User], room.roster).values():
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1940 entity = cast(Optional[SatXMPPEntity], user.entity)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1941 if entity is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1942 raise exceptions.InternalError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1943 f"Participant list of MUC requested, but the entity information of"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1944 f" the participant {user} is not available."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1945 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1946
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1947 bare_jids.add(entity.jid.userhostJID())
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1948
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1949 return bare_jids
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1950
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1951 async def get_trust(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1952 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1953 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1954 public_key: GPGPublicKey,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1955 owner: jid.JID
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1956 ) -> TrustLevel:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1957 """Query the trust level of a public key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1958
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1959 @param client: The client to perform this operation under.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1960 @param public_key: The public key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1961 @param owner: The owner of the public key. Can be a bare JID.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1962 @return: The trust level.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1963 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1964
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1965 key = f"/trust/{owner.userhost()}/{public_key.fingerprint}"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1966
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1967 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1968 return TrustLevel(await self.__storage[client.profile][key])
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1969 except KeyError:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1970 return TrustLevel.UNDECIDED
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1971
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1972 async def set_trust(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1973 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1974 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1975 public_key: GPGPublicKey,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1976 owner: jid.JID,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1977 trust_level: TrustLevel
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1978 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1979 """Set the trust level of a public key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1980
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1981 @param client: The client to perform this operation under.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1982 @param public_key: The public key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1983 @param owner: The owner of the public key. Can be a bare JID.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1984 @param trust_leve: The trust level.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1985 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1986
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1987 key = f"/trust/{owner.userhost()}/{public_key.fingerprint}"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1988
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1989 await self.__storage[client.profile].force(key, trust_level.name)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1990
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1991 async def get_trust_ui( # pylint: disable=invalid-name
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1992 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1993 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1994 entity: jid.JID
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1995 ) -> xml_tools.XMLUI:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1996 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1997 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1998 @param entity: The entity whose device trust levels to manage.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1999 @return: An XMLUI instance which opens a form to manage the trust level of all
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2000 devices belonging to the entity.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2001 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2002
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2003 if entity.resource:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2004 raise ValueError("A bare JID is expected.")
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2005
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2006 bare_jids: Set[jid.JID]
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	2007 if self.__xep_0045 is not None and self.__xep_0045.is_joined_room(client, entity):
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2008 bare_jids = self.__get_joined_muc_users(client, self.__xep_0045, entity)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2009 else:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2010 bare_jids = { entity.userhostJID() }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2011
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2012 all_public_keys = list({
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2013 bare_jid: list(self.list_public_keys(client, bare_jid))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2014 for bare_jid
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2015 in bare_jids
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2016 }.items())
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2017
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2018 async def callback(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2019 data: Any,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2020 profile: str # pylint: disable=unused-argument
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2021 ) -> Dict[Never, Never]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2022 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2023 @param data: The XMLUI result produces by the trust UI form.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2024 @param profile: The profile.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2025 @return: An empty dictionary. The type of the return value was chosen
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2026 conservatively since the exact options are neither known not needed here.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2027 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2028
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2029 if C.bool(data.get("cancelled", "false")):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2030 return {}
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2031
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2032 data_form_result = cast(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2033 Dict[str, str],
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	2034 xml_tools.xmlui_result_2_data_form_result(data)
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2035 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2036 for key, value in data_form_result.items():
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2037 if not key.startswith("trust_"):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2038 continue
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2039
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2040 outer_index, inner_index = key.split("_")[1:]
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2041
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2042 owner, public_keys = all_public_keys[int(outer_index)]
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2043 public_key = public_keys[int(inner_index)]
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2044 trust = TrustLevel(value)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2045
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2046 if (await self.get_trust(client, public_key, owner)) is not trust:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2047 await self.set_trust(client, public_key, owner, value)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2048
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2049 return {}
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2050
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	2051 submit_id = self.host.register_callback(callback, with_data=True, one_shot=True)
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2052
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2053 result = xml_tools.XMLUI(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2054 panel_type=C.XMLUI_FORM,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2055 title=D_("OX trust management"),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2056 submit_id=submit_id
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2057 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2058 # Casting this to Any, otherwise all calls on the variable cause type errors
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2059 # pylint: disable=no-member
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2060 trust_ui = cast(Any, result)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2061 trust_ui.addText(D_(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2062 "This is OX trusting system. You'll see below the GPG keys of your "
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2063 "contacts, and a list selection to trust them or not. A trusted key "
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2064 "can read your messages in plain text, so be sure to only validate "
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2065 "keys that you are sure are belonging to your contact. It's better "
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2066 "to do this when you are next to your contact, so "
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2067 "you can check the \"fingerprint\" of the key "
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2068 "yourself. Do not validate a key if the fingerprint is wrong!"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2069 ))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2070
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2071 own_secret_keys = self.list_secret_keys(client)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2072
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	2073 trust_ui.change_container("label")
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2074 for index, secret_key in enumerate(own_secret_keys):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2075 trust_ui.addLabel(D_(f"Own secret key {index} fingerprint"))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2076 trust_ui.addText(secret_key.public_key.fingerprint)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2077 trust_ui.addEmpty()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2078 trust_ui.addEmpty()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2079
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2080 for outer_index, [ owner, public_keys ] in enumerate(all_public_keys):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2081 for inner_index, public_key in enumerate(public_keys):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2082 trust_ui.addLabel(D_("Contact"))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2083 trust_ui.addJid(jid.JID(owner))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2084 trust_ui.addLabel(D_("Fingerprint"))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2085 trust_ui.addText(public_key.fingerprint)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2086 trust_ui.addLabel(D_("Trust this device?"))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2087
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2088 current_trust_level = await self.get_trust(client, public_key, owner)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2089 avaiable_trust_levels = \
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2090 { TrustLevel.DISTRUSTED, TrustLevel.TRUSTED, current_trust_level }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2091
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2092 trust_ui.addList(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2093 f"trust_{outer_index}_{inner_index}",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2094 options=[ trust_level.name for trust_level in avaiable_trust_levels ],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2095 selected=current_trust_level.name,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2096 styles=[ "inline" ]
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2097 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2098
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2099 trust_ui.addEmpty()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2100 trust_ui.addEmpty()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2101
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2102 return result

Mercurial > libervia-backend

annotate sat/plugins/plugin_xep_0373.py @ 4048:04e21d6c9188