libervia-backend: libervia/backend/plugins/plugin_xep

annotate libervia/backend/plugins/plugin_xep_0373.py @ 4329:73d83cb53673

plugin blog import dotclear: repalce deprecated `cgi` by `html`

author	Goffi <goffi@goffi.org>
date	Wed, 20 Nov 2024 14:35:09 +0100
parents	0d7bb4df2343
children	71c939e34ca6

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",
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	78 "TrustLevel",
3933 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",
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	89 C.PI_PROTOCOLS: ["XEP-0373"],
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	90 C.PI_DEPENDENCIES: ["XEP-0060", "XEP-0163"],
3933 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(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	309 self, data: bytes, signature: bytes, public_keys: Set[GPGPublicKey]
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	310 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	311 """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	312
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	313 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	314
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	315 @param data: The data.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	316 @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	317 @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	318 @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	319
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	320 @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	321 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	322 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	323
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	324 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	325 def encrypt(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	326 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	327 plaintext: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	328 public_keys: Set[GPGPublicKey],
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	329 signing_keys: Optional[Set[GPGSecretKey]] = None,
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	330 ) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	331 """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	332
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	333 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	334
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	335 @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	336 @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	337 @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	338 @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	339 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	340
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	341 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	342 def decrypt(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	343 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	344 ciphertext: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	345 secret_keys: Set[GPGSecretKey],
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	346 public_keys: Optional[Set[GPGPublicKey]] = None,
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	347 ) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	348 """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	349
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	350 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	351
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	352 @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	353 @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	354 @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	355 @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	356 @raise DecryptionFailed: on decryption failure.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	357 @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	358
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	359 @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	360 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	361 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	362 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	363
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	364 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	365 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	366 """List public keys.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	367
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	368 @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	369 @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	370 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	371
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	372 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	373 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	374 """List secret keys.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	375
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	376 @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	377 @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	378 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	379
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	380 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	381 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	382 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	383 @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	384 """
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 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	387 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	388 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	389 @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	390 """
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 @abstractmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	393 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	394 """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	395
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	396 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	397 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	398
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	399 @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	400 @return: The new key.
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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	403
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	404 class GPGME_GPGPublicKey(GPGPublicKey):
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 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	407 """
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 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	410 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	411 @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	412 """
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 self.__key_obj = key_obj
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 @property
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	417 def fingerprint(self) -> str:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	418 return self.__key_obj.fpr
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	419
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	420 @property
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	421 def key_obj(self) -> Any:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	422 return self.__key_obj
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	423
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	424
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	425 class GPGME_GPGSecretKey(GPGSecretKey):
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 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	428 """
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 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	431 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	432 @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	433 """
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 self.__public_key = public_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 @property
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	438 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	439 return self.__public_key
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	440
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	441
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	442 class GPGME_GPGProvider(GPGProvider):
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 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	445 """
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 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	448 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	449 @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	450 """
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 self.__home_dir = home_dir
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 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	455 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	456
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	457 pattern = public_key.fingerprint
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	458
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	459 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	460 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	461 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	462 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	463 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	464
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	465 if result is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	466 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	467
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	468 return result
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	469
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	470 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	471 # TODO
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	472 # - 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	473 # - 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	474
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	475 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	476 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	477 result = c.key_import(packet)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	478 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	479 # 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	480 # 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	481 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	482
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	483 if not hasattr(result, "considered"):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	484 raise InvalidPacket(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	485 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	486 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	487
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	488 if len(result.imports) != 1:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	489 raise InvalidPacket(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	490 "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	491 " counting subkeys)."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	492 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	493
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	494 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	495 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	496 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	497 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	498 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	499 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	500
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	501 return GPGME_GPGPublicKey(key_obj)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	502
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	503 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	504 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	505 # TODO
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	506 # - Handle password protection/pinentry
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	507 # - 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	508
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	509 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	510
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	511 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	512 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	513 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	514 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	515 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	516
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	517 if result is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	518 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	519
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	520 return result
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	521
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	522 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	523 # TODO
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	524 # - 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	525 # - 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	526
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	527 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	528 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	529 result = c.key_import(data)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	530 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	531 # 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	532 # 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	533 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	534
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	535 if not hasattr(result, "considered"):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	536 raise InvalidPacket(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	537 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	538 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	539
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	540 if len(result.imports) == 0:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	541 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	542
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	543 secret_keys = set()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	544 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	545 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	546 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	547 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	548 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	549 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	550 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	551
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	552 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	553
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	554 return secret_keys
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	555
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	556 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	557 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	558 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	559 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	560 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	561 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	562
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	563 return ciphertext
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	564
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	565 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	566 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	567 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	568 plaintext, __, __ = c.decrypt(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	569 ciphertext, passphrase=password, verify=False
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	570 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	571 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	572 # 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	573 # 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	574 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	575 except gpg.UnsupportedAlgorithm as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	576 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	577
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	578 return plaintext
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	579
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	580 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	581 signers = []
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	582 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	583 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	584
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	585 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	586
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	587 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	588 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	589 signed_data, __ = c.sign(data)
3954 1ab16449577b plugin XEP-0373: typos Goffi <goffi@goffi.org> parents: 3942 diff changeset	590 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	591 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	592 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	593 raise GPGProviderError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	594 "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	595 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	596
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	597 return signed_data
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	598
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	599 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	600 signers = []
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	601 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	602 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	603
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	604 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	605
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	606 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	607 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	608 signature, __ = c.sign(data, mode=gpg.constants.sig.mode.DETACH)
3954 1ab16449577b plugin XEP-0373: typos Goffi <goffi@goffi.org> parents: 3942 diff changeset	609 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	610 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	611 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	612 raise GPGProviderError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	613 "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	614 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	615
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	616 return signature
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	617
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	618 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	619 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	620 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	621 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	622 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	623 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	624 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	625 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	626
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	627 valid_signature_found = False
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	628 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	629 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	630
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	631 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	632 for sig in result.signatures:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	633 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	634 valid_signature_found = True
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 if not valid_signature_found:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	637 raise VerificationFailed(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	638 "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	639 )
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 return data
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	642
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	643 def verify_detached(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	644 self, data: bytes, signature: bytes, public_keys: Set[GPGPublicKey]
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	645 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	646 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	647 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	648 __, 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	649 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	650 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	651 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	652 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	653
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	654 valid_signature_found = False
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	655 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	656 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	657
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	658 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	659 for sig in result.signatures:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	660 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	661 valid_signature_found = True
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	662
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	663 if not valid_signature_found:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	664 raise VerificationFailed(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	665 "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	666 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	667
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	668 def encrypt(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	669 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	670 plaintext: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	671 public_keys: Set[GPGPublicKey],
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	672 signing_keys: Optional[Set[GPGSecretKey]] = None,
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	673 ) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	674 recipients = []
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	675 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	676 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	677
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	678 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	679
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	680 signers = []
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	681 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	682 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	683 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	684
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	685 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	686
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	687 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	688
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	689 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	690 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	691 ciphertext, __, __ = c.encrypt(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	692 plaintext,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	693 recipients=recipients,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	694 sign=sign,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	695 always_trust=True,
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	696 add_encrypt_to=True,
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	697 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	698 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	699 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	700 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	701 raise GPGProviderError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	702 "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	703 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	704 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	705 raise GPGProviderError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	706 "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	707 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	708
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	709 return ciphertext
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	710
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	711 def decrypt(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	712 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	713 ciphertext: bytes,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	714 secret_keys: Set[GPGSecretKey],
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	715 public_keys: Optional[Set[GPGPublicKey]] = None,
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	716 ) -> bytes:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	717 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	718
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	719 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	720 try:
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	721 plaintext, result, verify_result = c.decrypt(ciphertext, verify=verify)
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	722 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	723 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	724 except gpg.UnsupportedAlgorithm as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	725 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	726
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	727 # 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	728 # keys
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	729
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	730 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	731 valid_signature_found = False
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	732 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	733 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	734
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	735 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	736 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	737 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	738 valid_signature_found = True
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	739
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	740 if not valid_signature_found:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	741 raise VerificationFailed(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	742 "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	743 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	744
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	745 return plaintext
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	746
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	747 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	748 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	749 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	750 return {
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	751 GPGME_GPGPublicKey(key)
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	752 for key in c.keylist(pattern=user_id, secret=False)
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	753 }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	754 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	755 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	756
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	757 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	758 with gpg.Context(home_dir=self.__home_dir) as c:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	759 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	760 return {
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	761 GPGME_GPGSecretKey(GPGME_GPGPublicKey(key))
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	762 for key in c.keylist(pattern=user_id, secret=True)
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	763 }
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	764 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	765 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	766
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	767 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	768 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	769
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	770 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	771
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	772 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	773 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	774
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	775 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	776
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	777 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	778 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	779 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	780 result = c.create_key(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	781 user_id,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	782 expires=False,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	783 sign=True,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	784 encrypt=True,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	785 certify=False,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	786 authenticate=False,
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	787 force=True,
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	788 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	789
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	790 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	791 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	792 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	793 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	794 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	795
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	796 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	797
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	798
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	799 class PublicKeyMetadata(NamedTuple):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	800 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	801 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	802 """
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	803
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	804 fingerprint: str
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	805 timestamp: datetime
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	806
4212 5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	807 def to_dict(self) -> dict:
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	808 # Convert the instance to a dictionary and handle datetime serialization
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	809 data = self._asdict()
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	810 data["timestamp"] = self.timestamp.isoformat()
4212 5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	811 return data
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	812
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	813 @staticmethod
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	814 def from_dict(data: dict) -> "PublicKeyMetadata":
4212 5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	815 # Load a serialised dictionary
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	816 data["timestamp"] = datetime.fromisoformat(data["timestamp"])
4212 5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	817 return PublicKeyMetadata(**data)
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	818
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	819
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	820 @enum.unique
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	821 class TrustLevel(enum.Enum):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	822 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	823 The trust levels required for BTBV and manual trust.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	824 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	825
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	826 TRUSTED: str = "TRUSTED"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	827 BLINDLY_TRUSTED: str = "BLINDLY_TRUSTED"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	828 UNDECIDED: str = "UNDECIDED"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	829 DISTRUSTED: str = "DISTRUSTED"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	830
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	831
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	832 OPENPGP_SCHEMA = xmlschema.XMLSchema(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	833 """<?xml version="1.0" encoding="utf8"?>
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	834 <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	835 targetNamespace="urn:xmpp:openpgp:0"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	836 xmlns="urn:xmpp:openpgp:0">
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 <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	839 </xs:schema>
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	840 """
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	841 )
3933 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 # 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	845 # 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	846 # implementation of XML Schema, including version 1.1.
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	847 CONTENT_SCHEMA = xmlschema.XMLSchema11(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	848 """<?xml version="1.1" encoding="utf8"?>
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	849 <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	850 targetNamespace="urn:xmpp:openpgp:0"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	851 xmlns="urn:xmpp:openpgp:0">
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 <xs:element name="signcrypt">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	854 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	855 <xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	856 <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	857 <xs:element ref="time"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	858 <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	859 <xs:element ref="payload"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	860 </xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	861 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	862 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	863
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	864 <xs:element name="sign">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	865 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	866 <xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	867 <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	868 <xs:element ref="time"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	869 <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	870 <xs:element ref="payload"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	871 </xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	872 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	873 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	874
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	875 <xs:element name="crypt">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	876 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	877 <xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	878 <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	879 <xs:element ref="time"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	880 <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	881 <xs:element ref="payload"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	882 </xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	883 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	884 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	885
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	886 <xs:element name="to">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	887 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	888 <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	889 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	890 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	891
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	892 <xs:element name="time">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	893 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	894 <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	895 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	896 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	897
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	898 <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	899
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	900 <xs:element name="payload">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	901 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	902 <xs:sequence>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	903 <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	904 </xs:sequence>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	905 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	906 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	907 </xs:schema>
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	908 """
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	909 )
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	910
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	911
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	912 PUBLIC_KEYS_LIST_NODE = "urn:xmpp:openpgp:0:public-keys"
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	913 PUBLIC_KEYS_LIST_SCHEMA = xmlschema.XMLSchema(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	914 """<?xml version="1.0" encoding="utf8"?>
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	915 <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	916 targetNamespace="urn:xmpp:openpgp:0"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	917 xmlns="urn:xmpp:openpgp:0">
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 <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	920 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	921 <xs:sequence>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	922 <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	923 </xs:sequence>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	924 </xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	925 </xs:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	926
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	927 <xs:element name="pubkey-metadata">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	928 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	929 <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	930 <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	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 </xs:schema>
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	934 """
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	935 )
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	936
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	937
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	938 PUBKEY_SCHEMA = xmlschema.XMLSchema(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	939 """<?xml version="1.0" encoding="utf8"?>
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	940 <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	941 targetNamespace="urn:xmpp:openpgp:0"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	942 xmlns="urn:xmpp:openpgp:0">
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 <xs:element name="pubkey">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	945 <xs:complexType>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	946 <xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	947 <xs:element ref="data"/>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	948 </xs:all>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	949 <xs:anyAttribute processContents="skip"/>
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:element>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	952
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	953 <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	954 </xs:schema>
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	955 """
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	956 )
3933 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
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	959 SECRETKEY_SCHEMA = xmlschema.XMLSchema(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	960 """<?xml version="1.0" encoding="utf8"?>
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	961 <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	962 targetNamespace="urn:xmpp:openpgp:0"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	963 xmlns="urn:xmpp:openpgp:0">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	964
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	965 <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	966 </xs:schema>
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	967 """
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	968 )
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	969
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 DEFAULT_TRUST_MODEL_PARAM = f"""
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	972 <params>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	973 <individual>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	974 <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	975 <param name="{PARAM_NAME}"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	976 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	977 type="list" security="3">
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	978 <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	979 <option value="btbv"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	980 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	981 selected="true" />
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	982 </param>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	983 </category>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	984 </individual>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	985 </params>
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	986 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	987
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	988
4072 040095a5dc7f refactoring: rename `SAT` class to `LiberviaBackend` Goffi <goffi@goffi.org> parents: 4071 diff changeset	989 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	990 """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	991
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	992 @param sat: The SAT instance.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	993 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	994 @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	995 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	996
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	997 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	998
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	999
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1000 def generate_passphrase() -> str:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1001 """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	1002
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1003 @return: The passphrase.
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
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1006 return "-".join(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1007 "".join(secrets.choice("123456789ABCDEFGHIJKLMNPQRSTUVWXYZ") for __ in range(4))
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1008 for __ in range(6)
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1009 )
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1010
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1011
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1012 # 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	1013 class XEP_0373:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1014 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1015 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	1016 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1017
4072 040095a5dc7f refactoring: rename `SAT` class to `LiberviaBackend` Goffi <goffi@goffi.org> parents: 4071 diff changeset	1018 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	1019 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1020 @param sat: The SAT instance.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1021 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1022
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1023 self.host = host
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1024
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1025 # 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	1026 # model
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1027 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	1028
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1029 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	1030 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	1031
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1032 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	1033
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1034 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	1035 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	1036 "OX_PUBLIC_KEYS_LIST",
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1037 PUBLIC_KEYS_LIST_NODE,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1038 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	1039 self.__on_public_keys_list_update(items_event, profile)
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1040 ),
3933 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
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1043 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	1044 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	1045
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1046 async def profile_connected( # pylint: disable=invalid-name
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1047 self, client: SatXMPPClient
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1048 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1049 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1050 @param client: The client.
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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1053 profile = cast(str, client.profile)
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 if not profile in self.__storage:
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1056 self.__storage[profile] = persistent.LazyPersistentBinaryDict(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1057 "XEP-0373", client.profile
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1058 )
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1059
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1060 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	1061 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	1062 await self.create_key(client)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1063
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1064 async def __on_public_keys_list_update(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1065 self, items_event: pubsub.ItemsEvent, profile: str
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1066 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1067 """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	1068
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1069 @param items_event: The event.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1070 @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	1071 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1072
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1073 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	1074
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1075 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	1076 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	1077
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1078 if len(items) > 1:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1079 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	1080 return
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1081
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1082 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	1083 if item_elt is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1084 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	1085 return
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1086
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1087 public_keys_list_elt = cast(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1088 Optional[domish.Element],
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1089 next(item_elt.elements(NS_OX, "public-keys-list"), None),
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1090 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1091
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1092 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	1093
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1094 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	1095 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1096 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	1097 except xmlschema.XMLSchemaValidationError:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1098 pass
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1099 else:
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1100 pubkey_metadata_elts = list(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1101 public_keys_list_elt.elements(NS_OX, "pubkey-metadata")
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1102 )
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1103
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1104 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	1105 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	1106 return
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1107
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1108 new_public_keys_metadata = {
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1109 PublicKeyMetadata(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1110 fingerprint=cast(str, pubkey_metadata_elt["v4-fingerprint"]),
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1111 timestamp=parse_datetime(cast(str, pubkey_metadata_elt["date"])),
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1112 )
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1113 for pubkey_metadata_elt in pubkey_metadata_elts
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1114 }
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1115
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1116 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	1117
4212 5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1118 local_public_keys_metadata = {
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1119 PublicKeyMetadata.from_dict(pkm)
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1120 for pkm in await self.__storage[profile].get(storage_key, [])
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1121 }
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1122
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1123 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	1124 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	1125 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	1126
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1127 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	1128 # 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	1129 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	1130 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1131 # 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	1132 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	1133 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1134 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	1135
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1136 # 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	1137 # 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	1138 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	1139
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1140 # 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	1141 # included in the update
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1142 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	1143 secret_keys = self.list_secret_keys(client)
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1144 missing_keys = set(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1145 filter(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1146 lambda secret_key: all(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1147 key_metadata.fingerprint != secret_key.public_key.fingerprint
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1148 for key_metadata in new_public_keys_metadata
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1149 ),
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1150 secret_keys,
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1151 )
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1152 )
3933 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 if len(missing_keys) > 0:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1155 log.warning(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1156 "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	1157 f" {new_public_keys_metadata}"
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1158 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1159
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1160 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	1161 log.warning(missing_key.public_key.fingerprint)
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1162 new_public_keys_metadata.add(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1163 PublicKeyMetadata(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1164 fingerprint=missing_key.public_key.fingerprint,
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1165 timestamp=datetime.now(timezone.utc),
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1166 )
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 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 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	1170
4212 5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1171 await self.__storage[profile].force(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1172 storage_key, [pkm.to_dict() for pkm in new_public_keys_metadata]
4212 5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1173 )
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1174
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1175 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	1176 """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	1177
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1178 @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	1179 @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	1180 @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	1181 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1182
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1183 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	1184
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1185 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	1186
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1187 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	1188 """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	1189
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1190 @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	1191 @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	1192 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1193
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1194 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	1195
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1196 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	1197
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1198 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	1199 """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	1200
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1201 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	1202
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1203 @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	1204 @return: The new key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1205 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1206
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1207 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	1208
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1209 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	1210
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1211 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	1212
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1213 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	1214
4212 5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1215 public_keys_list = {
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1216 PublicKeyMetadata.from_dict(pkm)
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1217 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	1218 }
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1219
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1220 public_keys_list.add(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1221 PublicKeyMetadata(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1222 fingerprint=secret_key.public_key.fingerprint,
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1223 timestamp=datetime.now(timezone.utc),
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1224 )
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1225 )
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1226
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1227 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	1228
4217 b53b6dc1f929 plugin XEP-0373: fix serialisation of `public_key_list` Goffi <goffi@goffi.org> parents: 4212 diff changeset	1229 await self.__storage[client.profile].force(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1230 storage_key, [pkm.to_dict() for pkm in public_keys_list]
4217 b53b6dc1f929 plugin XEP-0373: fix serialisation of `public_key_list` Goffi <goffi@goffi.org> parents: 4212 diff changeset	1231 )
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1232
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1233 return secret_key
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1234
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1235 @staticmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1236 def __build_content_element(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1237 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	1238 recipient_jids: Iterable[jid.JID],
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1239 include_rpad: bool,
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1240 ) -> Tuple[domish.Element, domish.Element]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1241 """Build a content element.
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 @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	1244 @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	1245 bare JIDs.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1246 @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	1247 @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	1248 extension elements to.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1249 """
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 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	1252
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1253 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	1254 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	1255
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1256 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	1257
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1258 if include_rpad:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1259 # 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	1260 # 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	1261 rpad_length = secrets.randbelow(201)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1262 rpad_content = "".join(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1263 secrets.choice(string.digits + string.ascii_letters + string.punctuation)
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1264 for __ in range(rpad_length)
3933 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 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	1267
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1268 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	1269
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1270 return content_elt, payload_elt
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 @staticmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1273 def build_signcrypt_element(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1274 recipient_jids: Iterable[jid.JID],
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1275 ) -> Tuple[domish.Element, domish.Element]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1276 """Build a ``<signcrypt/>`` content element.
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 @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	1279 bare JIDs.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1280 @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	1281 stanza extension elements to.
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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1284 if len(recipient_jids) == 0:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1285 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	1286
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1287 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	1288
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1289 @staticmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1290 def build_sign_element(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1291 recipient_jids: Iterable[jid.JID], include_rpad: bool
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1292 ) -> Tuple[domish.Element, domish.Element]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1293 """Build a ``<sign/>`` content element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1294
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1295 @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	1296 bare JIDs.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1297 @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	1298 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	1299 @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	1300 extension elements to.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1301 """
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 if len(recipient_jids) == 0:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1304 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	1305
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1306 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	1307
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1308 @staticmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1309 def build_crypt_element(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1310 recipient_jids: Iterable[jid.JID],
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1311 ) -> Tuple[domish.Element, domish.Element]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1312 """Build a ``<crypt/>`` content element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1313
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1314 @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	1315 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	1316 be bare JIDs.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1317 @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	1318 extension elements to.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1319 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1320
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1321 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	1322
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1323 async def build_openpgp_element(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1324 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1325 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1326 content_elt: domish.Element,
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1327 recipient_jids: Set[jid.JID],
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1328 ) -> domish.Element:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1329 """Build an ``<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 @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	1332 @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	1333 @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	1334 @return: The ``<openpgp/>`` element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1335 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1336
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1337 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	1338
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1339 # 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	1340 # just one key/a subset of keys to sign with.
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1341 signing_keys = set(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1342 filter(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1343 lambda secret_key: gpg_provider.can_sign(secret_key.public_key),
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1344 self.list_secret_keys(client),
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1345 )
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1346 )
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1347
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1348 encryption_keys: Set[GPGPublicKey] = set()
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 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	1351 # 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	1352 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	1353
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1354 # 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	1355 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	1356
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1357 # TODO: Handle trust
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1358
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1359 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	1360 data: bytes
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1361
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1362 if content_elt.name == "signcrypt":
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1363 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	1364 elif content_elt.name == "sign":
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1365 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	1366 elif content_elt.name == "crypt":
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1367 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	1368 else:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1369 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	1370
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1371 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	1372 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	1373 return openpgp_elt
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1374
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1375 async def unpack_openpgp_element(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1376 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1377 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1378 openpgp_elt: domish.Element,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1379 element_name: Literal["signcrypt", "sign", "crypt"],
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1380 sender_jid: jid.JID,
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1381 ) -> Tuple[domish.Element, datetime]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1382 """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	1383
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1384 @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	1385 @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	1386 @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	1387 @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	1388 @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	1389 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	1390 contained in the content element.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1391 @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	1392 @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	1393 @raise DecryptionFailed: on decryption failure.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1394 @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	1395
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1396 @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	1397 the calling code.
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
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1400 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	1401
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1402 decryption_keys = set(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1403 filter(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1404 lambda secret_key: gpg_provider.can_encrypt(secret_key.public_key),
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1405 self.list_secret_keys(client),
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1406 )
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1407 )
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1408
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1409 # 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	1410 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	1411
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1412 # 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	1413 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	1414
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1415 # TODO: Handle trust
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1416
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1417 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1418 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	1419 except xmlschema.XMLSchemaValidationError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1420 raise exceptions.ParsingError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1421 "<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	1422 ) from e
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 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	1425 content: bytes
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1426
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1427 if element_name == "signcrypt":
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1428 content = gpg_provider.decrypt(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1429 openpgp_message, decryption_keys, public_keys=verification_keys
3933 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 elif element_name == "sign":
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1432 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	1433 elif element_name == "crypt":
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1434 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	1435 else:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1436 assert_never(element_name)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1437
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1438 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1439 content_elt = cast(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1440 domish.Element, xml_tools.ElementParser()(content.decode("utf-8"))
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1441 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1442 except UnicodeDecodeError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1443 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	1444
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1445 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1446 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	1447 except xmlschema.XMLSchemaValidationError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1448 raise exceptions.ParsingError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1449 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	1450 ) from e
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 content_elt.name != element_name:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1453 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	1454
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1455 recipient_jids = {
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1456 jid.JID(to_elt["jid"]) for to_elt in content_elt.elements(NS_OX, "to")
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1457 }
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1458
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1459 if (
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1460 client.jid.userhostJID() not in {jid.userhostJID() for jid in recipient_jids}
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1461 and element_name != "crypt"
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 raise VerificationError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1464 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	1465 f" JID."
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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1468 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	1469
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1470 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	1471
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1472 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	1473
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1474 return payload_elt, timestamp
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 async def publish_public_key(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1477 self, client: SatXMPPClient, public_key: GPGPublicKey
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1478 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1479 """Publish a public key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1480
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1481 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1482 @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	1483 @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	1484 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1485
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1486 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	1487
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1488 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	1489
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1490 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	1491
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1492 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	1493
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1494 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	1495
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1496 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1497 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	1498 client,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1499 client.jid.userhostJID(),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1500 node,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1501 pubkey_elt,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1502 format_datetime(),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1503 extra={
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1504 XEP_0060.EXTRA_PUBLISH_OPTIONS: {
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1505 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	1506 XEP_0060.OPT_ACCESS_MODEL: "open",
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1507 XEP_0060.OPT_MAX_ITEMS: 1,
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1508 },
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1509 # TODO: Do we really want publish_without_options here?
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1510 XEP_0060.EXTRA_ON_PRECOND_NOT_MET: "publish_without_options",
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1511 },
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1512 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1513 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1514 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	1515
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1516 async def import_all_public_keys(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1517 self, client: SatXMPPClient, entity_jid: jid.JID
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1518 ) -> Set[GPGPublicKey]:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1519 """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	1520
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1521 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1522 @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	1523 @return: The public keys.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1524 @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	1525 result.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1526 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1527
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1528 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	1529
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1530 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	1531
4212 5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1532 public_keys_metadata = {
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1533 PublicKeyMetadata.from_dict(pkm)
5f2d496c633f core: get rid of `pickle`: Goffi <goffi@goffi.org> parents: 4073 diff changeset	1534 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	1535 }
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1536 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	1537 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	1538 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	1539 )
a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1540 if not public_keys_metadata:
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1541 raise exceptions.NotFound(f"Can't find public keys for {entity_jid}")
3942 a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1542 else:
a92eef737703 plugin XEP-0373: download public keys if they are not found in local storage: Goffi <goffi@goffi.org> parents: 3933 diff changeset	1543 await self.__storage[client.profile].aset(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1544 storage_key, [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
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1547 missing_keys = set(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1548 filter(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1549 lambda public_key_metadata: all(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1550 public_key_metadata.fingerprint != public_key.fingerprint
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1551 for public_key in available_public_keys
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1552 ),
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1553 public_keys_metadata,
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1554 )
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1555 )
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1556
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1557 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	1558 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1559 available_public_keys.add(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1560 await self.import_public_key(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1561 client, entity_jid, missing_key.fingerprint
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1562 )
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 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1565 log.warning(
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1566 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	1567 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	1568 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1569
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1570 return available_public_keys
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1571
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1572 async def import_public_key(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1573 self, client: SatXMPPClient, jid: jid.JID, fingerprint: str
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1574 ) -> GPGPublicKey:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1575 """import a public key.
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1576
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1577 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1578 @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	1579 @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	1580 @return: The public key.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1581 @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	1582 @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	1583 @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	1584 invalid.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1585 @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	1586 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1587
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1588 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	1589
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1590 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	1591
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1592 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1593 items, __ = await self.__xep_0060.get_items(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1594 client, jid.userhostJID(), node, max_items=1
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1595 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1596 except exceptions.NotFound as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1597 raise exceptions.NotFound(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1598 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	1599 f" {jid.userhost()}."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1600 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1601 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1602 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	1603
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1604 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1605 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	1606 except IndexError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1607 raise exceptions.NotFound(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1608 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	1609 f" {jid.userhost()}."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1610 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1611
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1612 pubkey_elt = cast(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1613 Optional[domish.Element], next(item_elt.elements(NS_OX, "pubkey"), None)
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1614 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1615
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1616 if pubkey_elt is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1617 raise exceptions.ParsingError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1618 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	1619 f" element."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1620 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1621
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1622 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1623 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	1624 except xmlschema.XMLSchemaValidationError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1625 raise exceptions.ParsingError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1626 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	1627 f" schema validation."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1628 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1629
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1630 public_key = gpg_provider.import_public_key(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1631 base64.b64decode(str(next(pubkey_elt.elements(NS_OX, "data"))))
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1632 )
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1633
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1634 return public_key
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 async def publish_public_keys_list(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1637 self, client: SatXMPPClient, public_keys_list: Iterable[PublicKeyMetadata]
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1638 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1639 """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	1640
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1641 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1642 @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	1643 @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	1644
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1645 @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	1646 beforehand.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1647 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1648
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1649 if len({pkm.fingerprint for pkm in public_keys_list}) != len(public_keys_list):
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1650 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	1651
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1652 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	1653
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1654 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	1655
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1656 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	1657 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	1658 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	1659 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	1660
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1661 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1662 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	1663 client,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1664 client.jid.userhostJID(),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1665 node,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1666 public_keys_list_elt,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1667 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	1668 extra={
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1669 XEP_0060.EXTRA_PUBLISH_OPTIONS: {
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1670 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	1671 XEP_0060.OPT_ACCESS_MODEL: "open",
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1672 XEP_0060.OPT_MAX_ITEMS: 1,
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1673 },
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1674 # TODO: Do we really want publish_without_options here?
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1675 XEP_0060.EXTRA_ON_PRECOND_NOT_MET: "publish_without_options",
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1676 },
3933 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 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1679 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	1680
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1681 async def download_public_keys_list(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1682 self, client: SatXMPPClient, jid: jid.JID
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1683 ) -> Optional[Set[PublicKeyMetadata]]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1684 """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	1685
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1686 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1687 @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	1688 @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	1689 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	1690 @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	1691 @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	1692 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1693
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1694 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	1695
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1696 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1697 items, __ = await self.__xep_0060.get_items(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1698 client, jid.userhostJID(), node, max_items=1
3933 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 except exceptions.NotFound:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1701 return None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1702 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1703 raise XMPPInteractionFailed() from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1704
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1705 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1706 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	1707 except IndexError:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1708 return None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1709
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1710 public_keys_list_elt = cast(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1711 Optional[domish.Element],
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1712 next(item_elt.elements(NS_OX, "public-keys-list"), None),
3933 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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1715 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	1716 return None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1717
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1718 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1719 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	1720 except xmlschema.XMLSchemaValidationError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1721 raise exceptions.ParsingError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1722 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	1723 f" list schema validation."
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1724 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1725
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1726 return {
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1727 PublicKeyMetadata(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1728 fingerprint=pubkey_metadata_elt["v4-fingerprint"],
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1729 timestamp=parse_datetime(pubkey_metadata_elt["date"]),
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1730 )
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1731 for pubkey_metadata_elt in public_keys_list_elt.elements(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1732 NS_OX, "pubkey-metadata"
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1733 )
3933 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
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1736 async def __prepare_secret_key_synchronization(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1737 self, client: SatXMPPClient
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1738 ) -> Optional[domish.Element]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1739 """Prepare for secret key synchronization.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1740
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1741 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	1742 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	1743 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	1744
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1745 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1746 @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	1747 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	1748 @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	1749 protocols or protocol extensions.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1750 @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	1751 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1752
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1753 try:
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1754 infos = cast(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1755 DiscoInfo,
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1756 await self.host.memory.disco.get_infos(client, client.jid.userhostJID()),
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1757 )
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1758 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1759 raise XMPPInteractionFailed(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1760 "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	1761 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1762
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1763 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	1764 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	1765
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1766 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	1767 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	1768
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1769 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	1770 raise exceptions.FeatureNotFound(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1771 "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	1772 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1773
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1774 persistent_items_supported = (
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1775 "http://jabber.org/protocol/pubsub#persistent-items" in features
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1776 )
3933 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 # 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	1779
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1780 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	1781
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1782 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1783 items, __ = await self.__xep_0060.get_items(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1784 client, client.jid.userhostJID(), node, max_items=1
3933 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 except exceptions.NotFound:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1787 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1788 await self.__xep_0060.createNode(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1789 client,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1790 client.jid.userhostJID(),
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1791 node,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1792 {
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1793 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	1794 XEP_0060.OPT_ACCESS_MODEL: "whitelist",
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1795 XEP_0060.OPT_MAX_ITEMS: "1",
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1796 },
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1797 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1798 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1799 raise XMPPInteractionFailed(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1800 "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	1801 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1802 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1803 raise XMPPInteractionFailed(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1804 "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	1805 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1806
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1807 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1808 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	1809 except IndexError:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1810 return None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1811
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1812 async def export_secret_keys(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1813 self, client: SatXMPPClient, secret_keys: Iterable[GPGSecretKey]
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1814 ) -> str:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1815 """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	1816
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1817 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1818 @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	1819 @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	1820 @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	1821 protocols or protocol extensions.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1822 @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	1823 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1824
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1825 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	1826
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1827 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	1828
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1829 backup_code = generate_passphrase()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1830
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1831 plaintext = b"".join(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1832 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	1833 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1834
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1835 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	1836
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1837 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	1838
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1839 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	1840 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	1841
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1842 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1843 await self.__xep_0060.send_item(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1844 client, client.jid.userhostJID(), node, secretkey_elt
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1845 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1846 except Exception as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1847 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	1848
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1849 return backup_code
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1850
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1851 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	1852 """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	1853
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1854 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	1855 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	1856 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	1857 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	1858
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1859 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1860 @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	1861 @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	1862 protocols or protocol extensions.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1863 @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	1864 @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	1865 """
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 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	1868 if item_elt is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1869 return None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1870
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1871 secretkey_elt = cast(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1872 Optional[domish.Element], next(item_elt.elements(NS_OX, "secretkey"), None)
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1873 )
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 if secretkey_elt is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1876 return None
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1877
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1878 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1879 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	1880 except xmlschema.XMLSchemaValidationError as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1881 raise exceptions.ParsingError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1882 "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	1883 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1884
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1885 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	1886
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1887 def import_secret_keys(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1888 self, client: SatXMPPClient, ciphertext: bytes, backup_code: str
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1889 ) -> Set[GPGSecretKey]:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1890 """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	1891
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1892 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	1893 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	1894 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	1895 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	1896
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1897 @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	1898 @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	1899 :meth:`download_secret_keys`.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1900 @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	1901 @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	1902 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	1903 @raise DecryptionFailed: on decryption failure.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1904 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1905
3960 4836b81c5f31 plugin XEP-0373: minor renaming + set `gpg_provider` in client: Goffi <goffi@goffi.org> parents: 3954 diff changeset	1906 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	1907
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1908 return gpg_provider.restore_secret_keys(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1909 gpg_provider.decrypt_symmetrically(ciphertext, backup_code)
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1910 )
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 @staticmethod
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1913 def __get_joined_muc_users(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1914 client: SatXMPPClient, xep_0045: XEP_0045, room_jid: jid.JID
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1915 ) -> Set[jid.JID]:
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.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1918 @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	1919 @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	1920 @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	1921 @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	1922 participant isn't available.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1923 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1924 # 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	1925
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1926 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	1927
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1928 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1929 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	1930 except exceptions.NotFound as e:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1931 raise exceptions.InternalError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1932 "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	1933 ) from e
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1934
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1935 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	1936 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	1937 if entity is None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1938 raise exceptions.InternalError(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1939 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	1940 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	1941 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1942
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1943 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	1944
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1945 return bare_jids
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 async def get_trust(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1948 self, client: SatXMPPClient, public_key: GPGPublicKey, owner: jid.JID
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1949 ) -> TrustLevel:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1950 """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	1951
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1952 @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	1953 @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	1954 @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	1955 @return: The trust level.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1956 """
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 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	1959
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1960 try:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1961 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	1962 except KeyError:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1963 return TrustLevel.UNDECIDED
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 async def set_trust(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1966 self,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1967 client: SatXMPPClient,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1968 public_key: GPGPublicKey,
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1969 owner: jid.JID,
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1970 trust_level: TrustLevel,
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1971 ) -> None:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1972 """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	1973
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1974 @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	1975 @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	1976 @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	1977 @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	1978 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1979
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1980 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	1981
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1982 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	1983
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1984 async def get_trust_ui( # pylint: disable=invalid-name
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	1985 self, client: SatXMPPClient, entity: jid.JID
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1986 ) -> xml_tools.XMLUI:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1987 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1988 @param client: The client.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1989 @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	1990 @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	1991 devices belonging to the entity.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1992 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1993
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1994 if entity.resource:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1995 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	1996
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	1997 bare_jids: Set[jid.JID]
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	1998 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	1999 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	2000 else:
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2001 bare_jids = {entity.userhostJID()}
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2002
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2003 all_public_keys = list(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2004 {
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2005 bare_jid: list(self.list_public_keys(client, bare_jid))
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2006 for bare_jid in bare_jids
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2007 }.items()
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2008 )
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2009
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2010 async def callback(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2011 data: Any, profile: str # pylint: disable=unused-argument
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2012 ) -> Dict[Never, Never]:
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2013 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2014 @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	2015 @param profile: The profile.
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2016 @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	2017 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	2018 """
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2019
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2020 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	2021 return {}
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2022
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2023 data_form_result = cast(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2024 Dict[str, str], 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	2025 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2026 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	2027 if not key.startswith("trust_"):
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2028 continue
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2029
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2030 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	2031
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2032 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	2033 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	2034 trust = TrustLevel(value)
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2035
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2036 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	2037 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	2038
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2039 return {}
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2040
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	2041 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	2042
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2043 result = xml_tools.XMLUI(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2044 panel_type=C.XMLUI_FORM, title=D_("OX trust management"), submit_id=submit_id
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2045 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2046 # 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	2047 # pylint: disable=no-member
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2048 trust_ui = cast(Any, result)
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2049 trust_ui.addText(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2050 D_(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2051 "This is OX trusting system. You'll see below the GPG keys of your "
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2052 "contacts, and a list selection to trust them or not. A trusted key "
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2053 "can read your messages in plain text, so be sure to only validate "
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2054 "keys that you are sure are belonging to your contact. It's better "
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2055 "to do this when you are next to your contact, so "
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2056 'you can check the "fingerprint" of the key '
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2057 "yourself. Do not validate a key if the fingerprint is wrong!"
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2058 )
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2059 )
3933 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 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	2062
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3960 diff changeset	2063 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	2064 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	2065 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	2066 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	2067 trust_ui.addEmpty()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2068 trust_ui.addEmpty()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2069
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2070 for outer_index, [owner, public_keys] in enumerate(all_public_keys):
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2071 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	2072 trust_ui.addLabel(D_("Contact"))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2073 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	2074 trust_ui.addLabel(D_("Fingerprint"))
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2075 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	2076 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	2077
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2078 current_trust_level = await self.get_trust(client, public_key, owner)
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2079 avaiable_trust_levels = {
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2080 TrustLevel.DISTRUSTED,
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2081 TrustLevel.TRUSTED,
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2082 current_trust_level,
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2083 }
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2084
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2085 trust_ui.addList(
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2086 f"trust_{outer_index}_{inner_index}",
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2087 options=[trust_level.name for trust_level in avaiable_trust_levels],
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2088 selected=current_trust_level.name,
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4217 diff changeset	2089 styles=["inline"],
3933 cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2090 )
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2091
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2092 trust_ui.addEmpty()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2093 trust_ui.addEmpty()
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2094
cecf45416403 plugin XEP-0373 and XEP-0374: Implementation of OX and OXIM: Syndace <me@syndace.dev> parents: diff changeset	2095 return result

Mercurial > libervia-backend

annotate libervia/backend/plugins/plugin_xep_0373.py @ 4329:73d83cb53673