libervia-backend: libervia/backend/plugins/plugin_xep

annotate libervia/backend/plugins/plugin_xep_0373.py @ 4268:51d004e50786

docker (backend): set `+use_local_shared_tmp` in conf.

author	Goffi <goffi@goffi.org>
date	Thu, 13 Jun 2024 13:22:41 +0200
parents	b53b6dc1f929
children	0d7bb4df2343

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
4212 5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	23 import json
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	24 import secrets
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	25 import string
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	26 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	27 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	28
4212 5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	29 from typing import Final, NamedTuple, Never, assert_never
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	30 from wokkel import muc, pubsub
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	31 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	32 import xmlschema
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	33
4071 4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4037 diff changeset	34 from libervia.backend.core import exceptions
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4037 diff changeset	35 from libervia.backend.core.constants import Const as C
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4037 diff changeset	36 from libervia.backend.core.core_types import SatXMPPEntity
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4037 diff changeset	37 from libervia.backend.core.i18n import _, D_
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4037 diff changeset	38 from libervia.backend.core.log import getLogger, Logger
4073 7c5654c54fed refactoring: rename `core.sat_main` to `core.main` Goffi <goffi@goffi.org> parents: 4072 diff changeset	39 from libervia.backend.core.main import LiberviaBackend
4071 4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4037 diff changeset	40 from libervia.backend.core.xmpp import SatXMPPClient
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4037 diff changeset	41 from libervia.backend.memory import persistent
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4037 diff changeset	42 from libervia.backend.plugins.plugin_xep_0045 import XEP_0045
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4037 diff changeset	43 from libervia.backend.plugins.plugin_xep_0060 import XEP_0060
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4037 diff changeset	44 from libervia.backend.plugins.plugin_xep_0163 import XEP_0163
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4037 diff changeset	45 from libervia.backend.tools.xmpp_datetime import format_datetime, parse_datetime
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4037 diff changeset	46 from libervia.backend.tools import xml_tools
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	47 from twisted.internet import defer
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	48 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	49 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	50
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	51 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	52 import gpg
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	53 except ImportError as import_error:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	54 raise exceptions.MissingModule(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	55 "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	56 " 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	57 " 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	58 " 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	59 ) from import_error
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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	62 __all__ = [ # pylint: disable=unused-variable
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	63 "PLUGIN_INFO",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	64 "NS_OX",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	65 "XEP_0373",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	66 "VerificationError",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	67 "XMPPInteractionFailed",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	68 "InvalidPacket",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	69 "DecryptionFailed",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	70 "VerificationFailed",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	71 "UnknownKey",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	72 "GPGProviderError",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	73 "GPGPublicKey",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	74 "GPGSecretKey",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	75 "GPGProvider",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	76 "PublicKeyMetadata",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	77 "gpg_provider",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	78 "TrustLevel"
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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	82 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	83
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	84
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	85 PLUGIN_INFO = {
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	86 C.PI_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_IMPORT_NAME: "XEP-0373",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	88 C.PI_TYPE: "SEC",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	89 C.PI_PROTOCOLS: [ "XEP-0373" ],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	90 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	91 C.PI_RECOMMENDATIONS: [],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	92 C.PI_MAIN: "XEP_0373",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	93 C.PI_HANDLER: "no",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	94 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	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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	98 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	99
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	100
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	101 PARAM_CATEGORY = "Security"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	102 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	103 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	104
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	105
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	106 class VerificationError(Exception):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	107 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	108 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	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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	112 class XMPPInteractionFailed(Exception):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	113 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	114 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	115 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	116 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	117 of this class.
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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	121 class InvalidPacket(ValueError):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	122 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	123 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	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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	127 class DecryptionFailed(Exception):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	128 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	129 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	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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	133 class VerificationFailed(Exception):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	134 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	135 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	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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	139 class UnknownKey(ValueError):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	140 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	141 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	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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	145 class GPGProviderError(Exception):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	146 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	147 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	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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	151 class GPGPublicKey(ABC):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	152 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	153 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	154 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	155
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	156 @property
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	157 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	158 def fingerprint(self) -> str:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	159 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	160 @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	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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	164 class GPGSecretKey(ABC):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	165 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	166 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	167 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	168
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	169 @property
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	170 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	171 def public_key(self) -> GPGPublicKey:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	172 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	173 @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	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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	177 class GPGProvider(ABC):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	178 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	179 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	180 encryption, signing and key management.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	181
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	182 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	183 listed explicitly.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	184
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	185 # 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	186 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	187
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	188 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	189 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	190 """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	191
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	192 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	193
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	194 @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	195 @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	196 @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	197 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	198
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	199 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	200 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	201 """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	202
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	203 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	204
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	205 @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	206 @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	207 @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	208 invalid.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	209
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	210 @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	211 version 4 MUST be rejected.
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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	214 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	215 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	216 """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	217
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	218 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	219 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	220 §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	221
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	222 @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	223 @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	224 @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	225 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	226
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	227 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	228 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	229 """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	230
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	231 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	232 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	233 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	234
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	235 @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	236 @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	237 @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	238 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	239
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	240 @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	241 version 4 MUST be rejected.
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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	244 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	245 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	246 """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	247
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	248 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	249 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	250
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	251 @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	252 @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	253 @return: The encrypted data.
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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	256 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	257 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	258 """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	259
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	260 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	261 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	262 password.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	263
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	264 @param ciphertext: The ciphertext.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	265 @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	266 @return: The plaintext.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	267 @raise DecryptionFailed: on decryption failure.
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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	270 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	271 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	272 """Sign some data.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	273
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	274 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	275
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	276 @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	277 @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	278 @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	279 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	280
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	281 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	282 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	283 """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	284
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	285 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	286
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	287 @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	288 @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	289 @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	290 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	291
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	292 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	293 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	294 """Verify signed data.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	295
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	296 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	297
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	298 @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	299 @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	300 @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	301 @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	302
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	303 @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	304 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	305 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	306
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	307 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	308 def verify_detached(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	309 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	310 data: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	311 signature: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	312 public_keys: Set[GPGPublicKey]
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	313 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	314 """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	315
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	316 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	317
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	318 @param data: The data.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	319 @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	320 @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	321 @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	322
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	323 @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	324 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	325 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	326
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	327 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	328 def encrypt(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	329 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	330 plaintext: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	331 public_keys: Set[GPGPublicKey],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	332 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	333 ) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	334 """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	335
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	336 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	337
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	338 @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	339 @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	340 @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	341 @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	342 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	343
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	344 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	345 def decrypt(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	346 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	347 ciphertext: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	348 secret_keys: Set[GPGSecretKey],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	349 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	350 ) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	351 """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	352
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	353 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	354
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	355 @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	356 @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	357 @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	358 @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	359 @raise DecryptionFailed: on decryption failure.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	360 @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	361
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	362 @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	363 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	364 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	365 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	366
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	367 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	368 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	369 """List public keys.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	370
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	371 @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	372 @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	373 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	374
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	375 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	376 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	377 """List secret keys.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	378
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	379 @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	380 @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	381 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	382
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	383 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	384 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	385 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	386 @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	387 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	388
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	389 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	390 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	391 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	392 @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	393 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	394
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	395 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	396 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	397 """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	398
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	399 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	400 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	401
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	402 @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	403 @return: The new key.
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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	407 class GPGME_GPGPublicKey(GPGPublicKey):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	408 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	409 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	410 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	411
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	412 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	413 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	414 @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	415 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	416
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	417 self.__key_obj = key_obj
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	418
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	419 @property
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	420 def fingerprint(self) -> str:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	421 return self.__key_obj.fpr
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	422
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	423 @property
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	424 def key_obj(self) -> Any:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	425 return self.__key_obj
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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	428 class GPGME_GPGSecretKey(GPGSecretKey):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	429 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	430 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	431 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	432
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	433 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	434 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	435 @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	436 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	437
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	438 self.__public_key = public_key
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	439
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	440 @property
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	441 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	442 return self.__public_key
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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	445 class GPGME_GPGProvider(GPGProvider):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	446 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	447 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	448 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	449
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	450 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	451 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	452 @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	453 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	454
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	455 self.__home_dir = home_dir
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	456
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	457 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	458 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	459
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	460 pattern = public_key.fingerprint
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	461
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	462 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	463 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	464 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	465 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	466 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	467
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	468 if result is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	469 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	470
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	471 return result
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	472
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	473 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	474 # TODO
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	475 # - 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	476 # - 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	477
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	478 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	479 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	480 result = c.key_import(packet)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	481 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	482 # 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	483 # 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	484 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	485
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	486 if not hasattr(result, "considered"):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	487 raise InvalidPacket(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	488 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	489 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	490
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	491 if len(result.imports) != 1:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	492 raise InvalidPacket(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	493 "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	494 " counting subkeys)."
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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	497 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	498 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	499 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	500 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	501 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	502 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	503
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	504 return GPGME_GPGPublicKey(key_obj)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	505
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	506 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	507 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	508 # TODO
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	509 # - Handle password protection/pinentry
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	510 # - 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	511
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	512 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	513
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	514 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	515 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	516 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	517 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	518 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	519
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	520 if result is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	521 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	522
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	523 return result
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	524
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	525 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	526 # TODO
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	527 # - 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	528 # - 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	529
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	530 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	531 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	532 result = c.key_import(data)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	533 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	534 # 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	535 # 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	536 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	537
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	538 if not hasattr(result, "considered"):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	539 raise InvalidPacket(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	540 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	541 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	542
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	543 if len(result.imports) == 0:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	544 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	545
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	546 secret_keys = set()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	547 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	548 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	549 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	550 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	551 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	552 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	553 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	554
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	555 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	556
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	557 return secret_keys
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	558
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	559 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	560 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	561 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	562 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	563 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	564 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	565
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	566 return ciphertext
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	567
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	568 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	569 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	570 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	571 plaintext, __, __ = c.decrypt(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	572 ciphertext,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	573 passphrase=password,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	574 verify=False
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	575 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	576 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	577 # 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	578 # 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	579 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	580 except gpg.UnsupportedAlgorithm as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	581 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	582
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	583 return plaintext
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	584
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	585 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	586 signers = []
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	587 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	588 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	589
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	590 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	591
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	592 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	593 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	594 signed_data, __ = c.sign(data)
3954 1ab16449577b plugin XEP-0373: typos Goffi <goffi@goffi.org> parents: 3942 diff changeset	595 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	596 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	597 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	598 raise GPGProviderError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	599 "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	600 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	601
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	602 return signed_data
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	603
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	604 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	605 signers = []
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	606 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	607 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	608
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	609 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	610
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	611 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	612 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	613 signature, __ = c.sign(data, mode=gpg.constants.sig.mode.DETACH)
3954 1ab16449577b plugin XEP-0373: typos Goffi <goffi@goffi.org> parents: 3942 diff changeset	614 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	615 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	616 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	617 raise GPGProviderError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	618 "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	619 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	620
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	621 return signature
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	622
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	623 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	624 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	625 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	626 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	627 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	628 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	629 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	630 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	631
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	632 valid_signature_found = False
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	633 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	634 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	635
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	636 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	637 for sig in result.signatures:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	638 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	639 valid_signature_found = True
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	640
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	641 if not valid_signature_found:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	642 raise VerificationFailed(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	643 "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	644 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	645
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	646 return data
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	647
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	648 def verify_detached(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	649 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	650 data: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	651 signature: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	652 public_keys: Set[GPGPublicKey]
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	653 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	654 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	655 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	656 __, 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	657 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	658 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	659 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	660 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	661
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	662 valid_signature_found = False
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	663 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	664 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	665
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	666 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	667 for sig in result.signatures:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	668 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	669 valid_signature_found = True
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	670
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	671 if not valid_signature_found:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	672 raise VerificationFailed(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	673 "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	674 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	675
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	676 def encrypt(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	677 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	678 plaintext: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	679 public_keys: Set[GPGPublicKey],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	680 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	681 ) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	682 recipients = []
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	683 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	684 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	685
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	686 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	687
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	688 signers = []
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	689 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	690 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	691 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	692
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	693 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	694
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	695 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	696
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	697 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	698 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	699 ciphertext, __, __ = c.encrypt(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	700 plaintext,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	701 recipients=recipients,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	702 sign=sign,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	703 always_trust=True,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	704 add_encrypt_to=True
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	705 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	706 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	707 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	708 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	709 raise GPGProviderError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	710 "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	711 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	712 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	713 raise GPGProviderError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	714 "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	715 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	716
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	717 return ciphertext
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	718
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	719 def decrypt(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	720 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	721 ciphertext: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	722 secret_keys: Set[GPGSecretKey],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	723 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	724 ) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	725 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	726
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	727 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	728 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	729 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	730 ciphertext,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	731 verify=verify
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	732 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	733 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	734 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	735 except gpg.UnsupportedAlgorithm as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	736 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	737
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	738 # 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	739 # keys
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	740
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	741 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	742 valid_signature_found = False
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	743 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	744 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	745
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	746 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	747 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	748 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	749 valid_signature_found = True
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	750
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	751 if not valid_signature_found:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	752 raise VerificationFailed(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	753 "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	754 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	755
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	756 return plaintext
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	757
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	758 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	759 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	760 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	761 return {
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	762 GPGME_GPGPublicKey(key)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	763 for key
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	764 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	765 }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	766 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	767 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	768
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	769 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	770 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	771 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	772 return {
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	773 GPGME_GPGSecretKey(GPGME_GPGPublicKey(key))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	774 for key
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	775 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	776 }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	777 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	778 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	779
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	780 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	781 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	782
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	783 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	784
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	785 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	786 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	787
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	788 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	789
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	790 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	791 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	792 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	793 result = c.create_key(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	794 user_id,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	795 expires=False,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	796 sign=True,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	797 encrypt=True,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	798 certify=False,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	799 authenticate=False,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	800 force=True
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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	803 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	804 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	805 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	806 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	807 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	808
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	809 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	810
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	811
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	812 class PublicKeyMetadata(NamedTuple):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	813 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	814 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	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
4212 5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	819 def to_dict(self) -> dict:
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	820 # Convert the instance to a dictionary and handle datetime serialization
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	821 data = self._asdict()
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	822 data['timestamp'] = self.timestamp.isoformat()
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	823 return data
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	824
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	825 @staticmethod
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	826 def from_dict(data: dict) -> 'PublicKeyMetadata':
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	827 # Load a serialised dictionary
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	828 data['timestamp'] = datetime.fromisoformat(data['timestamp'])
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	829 return PublicKeyMetadata(**data)
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	830
3933 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 @enum.unique
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	833 class TrustLevel(enum.Enum):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	834 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	835 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	836 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	837
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	838 TRUSTED: str = "TRUSTED"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	839 BLINDLY_TRUSTED: str = "BLINDLY_TRUSTED"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	840 UNDECIDED: str = "UNDECIDED"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	841 DISTRUSTED: str = "DISTRUSTED"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	842
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	843
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	844 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	845 <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	846 targetNamespace="urn:xmpp:openpgp:0"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	847 xmlns="urn:xmpp:openpgp:0">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	848
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	849 <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	850 </xs:schema>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	851 """)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	852
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	853
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	854 # 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	855 # 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	856 # 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	857 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	858 <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	859 targetNamespace="urn:xmpp:openpgp:0"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	860 xmlns="urn:xmpp:openpgp:0">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	861
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	862 <xs:element name="signcrypt">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	863 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	864 <xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	865 <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	866 <xs:element ref="time"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	867 <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	868 <xs:element ref="payload"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	869 </xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	870 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	871 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	872
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	873 <xs:element name="sign">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	874 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	875 <xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	876 <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	877 <xs:element ref="time"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	878 <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	879 <xs:element ref="payload"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	880 </xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	881 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	882 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	883
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	884 <xs:element name="crypt">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	885 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	886 <xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	887 <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	888 <xs:element ref="time"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	889 <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	890 <xs:element ref="payload"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	891 </xs:all>
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="to">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	896 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	897 <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	898 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	899 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	900
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	901 <xs:element name="time">
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: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	904 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	905 </xs:element>
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 <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	908
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	909 <xs:element name="payload">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	910 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	911 <xs:sequence>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	912 <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	913 </xs:sequence>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	914 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	915 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	916 </xs:schema>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	917 """)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	918
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	919
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	920 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	921 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	922 <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	923 targetNamespace="urn:xmpp:openpgp:0"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	924 xmlns="urn:xmpp:openpgp:0">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	925
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	926 <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	927 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	928 <xs:sequence>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	929 <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	930 </xs:sequence>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	931 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	932 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	933
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	934 <xs:element name="pubkey-metadata">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	935 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	936 <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	937 <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	938 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	939 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	940 </xs:schema>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	941 """)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	942
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	943
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	944 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	945 <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	946 targetNamespace="urn:xmpp:openpgp:0"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	947 xmlns="urn:xmpp:openpgp:0">
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 <xs:element name="pubkey">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	950 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	951 <xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	952 <xs:element ref="data"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	953 </xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	954 <xs:anyAttribute processContents="skip"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	955 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	956 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	957
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	958 <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	959 </xs:schema>
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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	962
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	963 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	964 <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	965 targetNamespace="urn:xmpp:openpgp:0"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	966 xmlns="urn:xmpp:openpgp:0">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	967
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	968 <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	969 </xs:schema>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	970 """)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	971
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	972
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	973 DEFAULT_TRUST_MODEL_PARAM = f"""
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	974 <params>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	975 <individual>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	976 <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	977 <param name="{PARAM_NAME}"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	978 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	979 type="list" security="3">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	980 <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	981 <option value="btbv"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	982 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	983 selected="true" />
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	984 </param>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	985 </category>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	986 </individual>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	987 </params>
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
4072 040095a5dc7f refactoring: rename `SAT` class to `LiberviaBackend` Goffi <goffi@goffi.org> parents: 4071 diff changeset	991 def get_gpg_provider(sat: LiberviaBackend, client: SatXMPPClient) -> GPGProvider:
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	992 """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	993
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	994 @param sat: The SAT instance.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	995 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	996 @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	997 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	998
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	999 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	1000
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1001
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1002 def generate_passphrase() -> str:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1003 """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	1004
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1005 @return: The passphrase.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1006 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1007
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1008 return "-".join("".join(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1009 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	1010 ) for __ in range(6))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1011
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1012
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1013 # 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	1014 class XEP_0373:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1015 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1016 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	1017 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1018
4072 040095a5dc7f refactoring: rename `SAT` class to `LiberviaBackend` Goffi <goffi@goffi.org> parents: 4071 diff changeset	1019 def __init__(self, host: LiberviaBackend) -> None:
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 @param sat: The SAT instance.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1022 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1023
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1024 self.host = host
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1025
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1026 # 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	1027 # model
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1028 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	1029
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1030 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	1031 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	1032
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1033 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	1034
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1035 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	1036 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	1037 "OX_PUBLIC_KEYS_LIST",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1038 PUBLIC_KEYS_LIST_NODE,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1039 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	1040 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	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
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1044 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	1045 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	1046
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1047 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	1048 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1049 client: SatXMPPClient
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1050 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1051 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1052 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1053 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1054
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1055 profile = cast(str, client.profile)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1056
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1057 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	1058 self.__storage[profile] = \
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1059 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	1060
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1061 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	1062 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	1063 await self.create_key(client)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1064
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1065 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	1066 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1067 items_event: pubsub.ItemsEvent,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1068 profile: str
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1069 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1070 """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	1071
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1072 @param items_event: The event.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1073 @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	1074 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1075
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1076 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	1077
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1078 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	1079 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	1080
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1081 if len(items) > 1:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1082 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	1083 return
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 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	1086 if item_elt is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1087 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	1088 return
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1089
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1090 public_keys_list_elt = cast(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1091 Optional[domish.Element],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1092 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	1093 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1094
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1095 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	1096
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1097 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	1098 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1099 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	1100 except xmlschema.XMLSchemaValidationError:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1101 pass
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1102 else:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1103 pubkey_metadata_elts = \
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1104 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	1105
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1106 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	1107 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	1108 return
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 new_public_keys_metadata = { PublicKeyMetadata(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1111 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	1112 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	1113 ) 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	1114
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1115 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	1116
4212 5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1117 local_public_keys_metadata = {
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1118 PublicKeyMetadata.from_dict(pkm)
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1119 for pkm in await self.__storage[profile].get(storage_key, [])
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1120 }
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1121
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1122 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	1123 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	1124 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	1125
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1126 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	1127 # 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	1128 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	1129 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1130 # 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	1131 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	1132 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1133 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	1134
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1135 # 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	1136 # 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	1137 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	1138
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1139 # 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	1140 # included in the update
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1141 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	1142 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	1143 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	1144 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	1145 for key_metadata
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1146 in new_public_keys_metadata
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1147 ), secret_keys))
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 if len(missing_keys) > 0:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1150 log.warning(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1151 "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	1152 f" {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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1155 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	1156 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	1157 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	1158 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	1159 timestamp=datetime.now(timezone.utc)
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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1162 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	1163
4212 5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1164 await self.__storage[profile].force(
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1165 storage_key,
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1166 [pkm.to_dict() for pkm in new_public_keys_metadata]
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1167 )
3933 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 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	1170 """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	1171
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1172 @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	1173 @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	1174 @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	1175 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1176
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1177 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	1178
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1179 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	1180
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1181 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	1182 """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	1183
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1184 @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	1185 @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	1186 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1187
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1188 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	1189
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1190 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	1191
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1192 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	1193 """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	1194
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1195 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	1196
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1197 @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	1198 @return: The new key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1199 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1200
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1201 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	1202
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1203 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	1204
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1205 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	1206
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1207 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	1208
4212 5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1209 public_keys_list = {
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1210 PublicKeyMetadata.from_dict(pkm)
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1211 for pkm in await self.__storage[client.profile].get(storage_key, [])
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1212 }
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1213
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1214 public_keys_list.add(PublicKeyMetadata(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1215 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	1216 timestamp=datetime.now(timezone.utc)
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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1219 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	1220
4217 b53b6dc1f929 plugin XEP-0373: fix serialisation of `public_key_list` Goffi <goffi@goffi.org> parents: 4212 diff changeset	1221 await self.__storage[client.profile].force(
b53b6dc1f929 plugin XEP-0373: fix serialisation of `public_key_list` Goffi <goffi@goffi.org> parents: 4212 diff changeset	1222 storage_key,
b53b6dc1f929 plugin XEP-0373: fix serialisation of `public_key_list` Goffi <goffi@goffi.org> parents: 4212 diff changeset	1223 [pkm.to_dict() for pkm in public_keys_list]
b53b6dc1f929 plugin XEP-0373: fix serialisation of `public_key_list` Goffi <goffi@goffi.org> parents: 4212 diff changeset	1224 )
3933 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 return secret_key
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 @staticmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1229 def __build_content_element(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1230 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	1231 recipient_jids: Iterable[jid.JID],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1232 include_rpad: bool
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1233 ) -> Tuple[domish.Element, domish.Element]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1234 """Build a content element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1235
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1236 @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	1237 @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	1238 bare JIDs.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1239 @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	1240 @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	1241 extension elements to.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1242 """
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 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	1245
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1246 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	1247 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	1248
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1249 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	1250
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1251 if include_rpad:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1252 # 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	1253 # 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	1254 rpad_length = secrets.randbelow(201)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1255 rpad_content = "".join(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1256 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	1257 for __
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1258 in range(rpad_length)
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 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	1261
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1262 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	1263
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1264 return content_elt, payload_elt
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1265
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1266 @staticmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1267 def build_signcrypt_element(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1268 recipient_jids: Iterable[jid.JID]
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 ``<signcrypt/>`` 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 @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	1275 stanza extension elements to.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1276 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1277
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1278 if len(recipient_jids) == 0:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1279 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	1280
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1281 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	1282
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1283 @staticmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1284 def build_sign_element(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1285 recipient_jids: Iterable[jid.JID],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1286 include_rpad: bool
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1287 ) -> Tuple[domish.Element, domish.Element]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1288 """Build a ``<sign/>`` content element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1289
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1290 @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	1291 bare JIDs.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1292 @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	1293 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	1294 @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	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 if len(recipient_jids) == 0:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1299 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	1300
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1301 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	1302
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1303 @staticmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1304 def build_crypt_element(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1305 recipient_jids: Iterable[jid.JID]
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1306 ) -> Tuple[domish.Element, domish.Element]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1307 """Build a ``<crypt/>`` content element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1308
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1309 @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	1310 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	1311 be bare JIDs.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1312 @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	1313 extension elements to.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1314 """
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 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	1317
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1318 async def build_openpgp_element(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1319 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1320 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1321 content_elt: domish.Element,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1322 recipient_jids: Set[jid.JID]
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1323 ) -> domish.Element:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1324 """Build an ``<openpgp/>`` element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1325
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1326 @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	1327 @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	1328 @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	1329 @return: The ``<openpgp/>`` element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1330 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1331
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1332 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	1333
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1334 # 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	1335 # 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	1336 signing_keys = set(filter(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1337 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	1338 self.list_secret_keys(client)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1339 ))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1340
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1341 encryption_keys: Set[GPGPublicKey] = set()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1342
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1343 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	1344 # 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	1345 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	1346
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1347 # 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	1348 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	1349
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1350 # TODO: Handle trust
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1351
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1352 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	1353 data: bytes
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1354
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1355 if content_elt.name == "signcrypt":
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1356 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	1357 elif content_elt.name == "sign":
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1358 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	1359 elif content_elt.name == "crypt":
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1360 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	1361 else:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1362 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	1363
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1364 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	1365 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	1366 return openpgp_elt
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1367
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1368 async def unpack_openpgp_element(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1369 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1370 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1371 openpgp_elt: domish.Element,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1372 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	1373 sender_jid: jid.JID
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1374 ) -> Tuple[domish.Element, datetime]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1375 """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	1376
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1377 @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	1378 @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	1379 @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	1380 @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	1381 @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	1382 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	1383 contained in the content element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1384 @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	1385 @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	1386 @raise DecryptionFailed: on decryption failure.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1387 @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	1388
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1389 @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	1390 the calling code.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1391 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1392
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1393 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	1394
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1395 decryption_keys = set(filter(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1396 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	1397 self.list_secret_keys(client)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1398 ))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1399
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1400 # 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	1401 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	1402
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1403 # 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	1404 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	1405
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1406 # TODO: Handle trust
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1407
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1408 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1409 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	1410 except xmlschema.XMLSchemaValidationError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1411 raise exceptions.ParsingError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1412 "<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	1413 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1414
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1415 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	1416 content: bytes
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 if element_name == "signcrypt":
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1419 content = gpg_provider.decrypt(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1420 openpgp_message,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1421 decryption_keys,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1422 public_keys=verification_keys
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1423 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1424 elif element_name == "sign":
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1425 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	1426 elif element_name == "crypt":
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1427 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	1428 else:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1429 assert_never(element_name)
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 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1432 content_elt = cast(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1433 domish.Element,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1434 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	1435 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1436 except UnicodeDecodeError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1437 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	1438
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1439 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1440 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	1441 except xmlschema.XMLSchemaValidationError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1442 raise exceptions.ParsingError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1443 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	1444 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1445
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1446 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	1447 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	1448
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1449 recipient_jids = \
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1450 { 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	1451
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1452 if (
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1453 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	1454 and element_name != "crypt"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1455 ):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1456 raise VerificationError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1457 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	1458 f" JID."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1459 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1460
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1461 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	1462
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1463 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	1464
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1465 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	1466
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1467 return payload_elt, timestamp
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 async def publish_public_key(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1470 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1471 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1472 public_key: GPGPublicKey
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1473 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1474 """Publish a public key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1475
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1476 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1477 @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	1478 @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	1479 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1480
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1481 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	1482
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1483 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	1484
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1485 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	1486
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1487 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	1488
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1489 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	1490
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1491 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1492 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	1493 client,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1494 client.jid.userhostJID(),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1495 node,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1496 pubkey_elt,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1497 format_datetime(),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1498 extra={
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1499 XEP_0060.EXTRA_PUBLISH_OPTIONS: {
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1500 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	1501 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	1502 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	1503 },
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1504 # 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	1505 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	1506 }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1507 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1508 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1509 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	1510
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1511 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	1512 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1513 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	1514 entity_jid: jid.JID
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1515 ) -> Set[GPGPublicKey]:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1516 """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	1517
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1518 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1519 @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	1520 @return: The public keys.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1521 @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	1522 result.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1523 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1524
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1525 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	1526
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1527 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	1528
4212 5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1529 public_keys_metadata = {
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1530 PublicKeyMetadata.from_dict(pkm)
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1531 for pkm in await self.__storage[client.profile].get(storage_key, [])
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1532 }
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1533 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	1534 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	1535 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	1536 )
a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1537 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	1538 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	1539 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	1540 )
a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1541 else:
a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1542 await self.__storage[client.profile].aset(
4212 5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1543 storage_key,
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1544 [pkm.to_dict() for pkm in public_keys_metadata]
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1545 )
a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1546
3933 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 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	1549 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	1550 for public_key
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1551 in available_public_keys
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1552 ), public_keys_metadata))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1553
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1554 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	1555 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1556 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	1557 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	1558 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1559 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1560 log.warning(
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1561 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	1562 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	1563 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1564
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1565 return available_public_keys
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1566
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1567 async def import_public_key(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1568 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1569 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1570 jid: jid.JID,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1571 fingerprint: str
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1572 ) -> GPGPublicKey:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1573 """import a public key.
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1574
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1575 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1576 @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	1577 @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	1578 @return: The public key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1579 @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	1580 @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	1581 @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	1582 invalid.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1583 @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	1584 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1585
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1586 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	1587
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1588 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	1589
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1590 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1591 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	1592 client,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1593 jid.userhostJID(),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1594 node,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1595 max_items=1
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1596 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1597 except exceptions.NotFound as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1598 raise exceptions.NotFound(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1599 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	1600 f" {jid.userhost()}."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1601 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1602 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1603 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	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 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	1607 except IndexError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1608 raise exceptions.NotFound(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1609 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	1610 f" {jid.userhost()}."
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 pubkey_elt = cast(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1614 Optional[domish.Element],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1615 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	1616 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1617
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1618 if pubkey_elt is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1619 raise exceptions.ParsingError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1620 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	1621 f" element."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1622 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1623
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1624 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1625 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	1626 except xmlschema.XMLSchemaValidationError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1627 raise exceptions.ParsingError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1628 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	1629 f" schema validation."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1630 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1631
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1632 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	1633 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	1634 )))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1635
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1636 return public_key
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1637
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1638 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	1639 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1640 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1641 public_keys_list: Iterable[PublicKeyMetadata]
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1642 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1643 """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	1644
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1645 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1646 @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	1647 @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	1648
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1649 @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	1650 beforehand.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1651 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1652
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1653 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	1654 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	1655
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1656 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	1657
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1658 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	1659
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1660 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	1661 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	1662 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	1663 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	1664
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1665 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1666 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	1667 client,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1668 client.jid.userhostJID(),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1669 node,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1670 public_keys_list_elt,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1671 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	1672 extra={
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1673 XEP_0060.EXTRA_PUBLISH_OPTIONS: {
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1674 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	1675 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	1676 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	1677 },
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1678 # 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	1679 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	1680 }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1681 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1682 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1683 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	1684
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1685 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	1686 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1687 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1688 jid: jid.JID
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1689 ) -> Optional[Set[PublicKeyMetadata]]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1690 """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	1691
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1692 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1693 @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	1694 @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	1695 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	1696 @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	1697 @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	1698 """
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 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	1701
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1702 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1703 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	1704 client,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1705 jid.userhostJID(),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1706 node,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1707 max_items=1
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1708 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1709 except exceptions.NotFound:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1710 return None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1711 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1712 raise XMPPInteractionFailed() from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1713
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1714 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1715 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	1716 except IndexError:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1717 return None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1718
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1719 public_keys_list_elt = cast(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1720 Optional[domish.Element],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1721 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	1722 )
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 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	1725 return None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1726
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1727 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1728 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	1729 except xmlschema.XMLSchemaValidationError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1730 raise exceptions.ParsingError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1731 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	1732 f" list schema validation."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1733 ) from e
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 return {
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1736 PublicKeyMetadata(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1737 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	1738 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	1739 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1740 for pubkey_metadata_elt
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1741 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	1742 }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1743
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1744 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	1745 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1746 client: SatXMPPClient
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1747 ) -> Optional[domish.Element]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1748 """Prepare for secret key synchronization.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1749
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1750 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	1751 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	1752 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	1753
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1754 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1755 @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	1756 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	1757 @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	1758 protocols or protocol extensions.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1759 @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	1760 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1761
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1762 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1763 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	1764 client,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1765 client.jid.userhostJID()
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 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1768 raise XMPPInteractionFailed(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1769 "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	1770 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1771
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1772 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	1773 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	1774
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1775 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	1776 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	1777
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1778 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	1779 raise exceptions.FeatureNotFound(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1780 "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	1781 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1782
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1783 persistent_items_supported = \
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1784 "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	1785
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1786 # 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	1787
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1788 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	1789
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1790 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1791 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	1792 client,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1793 client.jid.userhostJID(),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1794 node,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1795 max_items=1
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1796 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1797 except exceptions.NotFound:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1798 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1799 await self.__xep_0060.createNode(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1800 client,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1801 client.jid.userhostJID(),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1802 node,
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 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	1805 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	1806 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	1807 }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1808 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1809 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1810 raise XMPPInteractionFailed(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1811 "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	1812 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1813 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1814 raise XMPPInteractionFailed(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1815 "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	1816 ) from e
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 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1819 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	1820 except IndexError:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1821 return None
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 async def export_secret_keys(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1824 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1825 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1826 secret_keys: Iterable[GPGSecretKey]
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1827 ) -> str:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1828 """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	1829
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1830 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1831 @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	1832 @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	1833 @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	1834 protocols or protocol extensions.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1835 @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	1836 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1837
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1838 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	1839
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1840 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	1841
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1842 backup_code = generate_passphrase()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1843
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1844 plaintext = b"".join(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1845 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	1846 )
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 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	1849
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1850 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	1851
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1852 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	1853 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	1854
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1855 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1856 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	1857 client,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1858 client.jid.userhostJID(),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1859 node,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1860 secretkey_elt
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1861 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1862 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1863 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	1864
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1865 return backup_code
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1866
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1867 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	1868 """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	1869
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1870 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	1871 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	1872 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	1873 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	1874
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1875 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1876 @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	1877 @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	1878 protocols or protocol extensions.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1879 @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	1880 @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	1881 """
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 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	1884 if item_elt is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1885 return None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1886
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1887 secretkey_elt = cast(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1888 Optional[domish.Element],
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1889 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	1890 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1891
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1892 if secretkey_elt is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1893 return None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1894
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1895 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1896 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	1897 except xmlschema.XMLSchemaValidationError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1898 raise exceptions.ParsingError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1899 "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	1900 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1901
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1902 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	1903
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1904 def import_secret_keys(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1905 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1906 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1907 ciphertext: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1908 backup_code: str
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1909 ) -> Set[GPGSecretKey]:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1910 """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	1911
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1912 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	1913 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	1914 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	1915 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	1916
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1917 @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	1918 @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	1919 :meth:`download_secret_keys`.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1920 @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	1921 @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	1922 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	1923 @raise DecryptionFailed: on decryption failure.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1924 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1925
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1926 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	1927
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1928 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	1929 ciphertext,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1930 backup_code
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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1933 @staticmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1934 def __get_joined_muc_users(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1935 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1936 xep_0045: XEP_0045,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1937 room_jid: jid.JID
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1938 ) -> Set[jid.JID]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1939 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1940 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1941 @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	1942 @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	1943 @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	1944 @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	1945 participant isn't available.
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 # 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	1948
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1949 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	1950
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1951 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1952 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	1953 except exceptions.NotFound as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1954 raise exceptions.InternalError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1955 "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	1956 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1957
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1958 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	1959 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	1960 if entity is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1961 raise exceptions.InternalError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1962 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	1963 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	1964 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1965
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1966 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	1967
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1968 return bare_jids
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1969
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1970 async def get_trust(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1971 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1972 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1973 public_key: GPGPublicKey,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1974 owner: jid.JID
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1975 ) -> TrustLevel:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1976 """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	1977
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1978 @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	1979 @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	1980 @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	1981 @return: The trust level.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1982 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1983
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1984 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	1985
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1986 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1987 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	1988 except KeyError:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1989 return TrustLevel.UNDECIDED
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1990
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1991 async def set_trust(
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 public_key: GPGPublicKey,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1995 owner: jid.JID,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1996 trust_level: TrustLevel
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1997 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1998 """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	1999
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2000 @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	2001 @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	2002 @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	2003 @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	2004 """
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 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	2007
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2008 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	2009
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	2010 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	2011 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2012 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2013 entity: jid.JID
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2014 ) -> xml_tools.XMLUI:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2015 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2016 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2017 @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	2018 @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	2019 devices belonging to the entity.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2020 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2021
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2022 if entity.resource:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2023 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	2024
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2025 bare_jids: Set[jid.JID]
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	2026 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	2027 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	2028 else:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2029 bare_jids = { entity.userhostJID() }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2030
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2031 all_public_keys = list({
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2032 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	2033 for bare_jid
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2034 in bare_jids
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2035 }.items())
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2036
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2037 async def callback(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2038 data: Any,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2039 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	2040 ) -> Dict[Never, Never]:
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 @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	2043 @param profile: The profile.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2044 @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	2045 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	2046 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2047
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2048 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	2049 return {}
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2050
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2051 data_form_result = cast(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2052 Dict[str, str],
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	2053 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	2054 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2055 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	2056 if not key.startswith("trust_"):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2057 continue
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2058
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2059 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	2060
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2061 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	2062 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	2063 trust = TrustLevel(value)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2064
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2065 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	2066 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	2067
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2068 return {}
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2069
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	2070 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	2071
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2072 result = xml_tools.XMLUI(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2073 panel_type=C.XMLUI_FORM,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2074 title=D_("OX trust management"),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2075 submit_id=submit_id
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2076 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2077 # 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	2078 # pylint: disable=no-member
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2079 trust_ui = cast(Any, result)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2080 trust_ui.addText(D_(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2081 "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	2082 "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	2083 "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	2084 "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	2085 "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	2086 "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	2087 "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	2088 ))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2089
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2090 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	2091
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	2092 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	2093 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	2094 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	2095 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	2096 trust_ui.addEmpty()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2097 trust_ui.addEmpty()
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 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	2100 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	2101 trust_ui.addLabel(D_("Contact"))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2102 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	2103 trust_ui.addLabel(D_("Fingerprint"))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2104 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	2105 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	2106
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2107 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	2108 avaiable_trust_levels = \
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2109 { 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	2110
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2111 trust_ui.addList(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2112 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	2113 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	2114 selected=current_trust_level.name,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2115 styles=[ "inline" ]
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2116 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2117
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2118 trust_ui.addEmpty()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2119 trust_ui.addEmpty()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2120
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2121 return result

Mercurial > libervia-backend

annotate libervia/backend/plugins/plugin_xep_0373.py @ 4268:51d004e50786