Mercurial > libervia-backend
annotate libervia/backend/plugins/plugin_comp_email_gateway/__init__.py @ 4357:f43cbceba2a0
various minor fixes.
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Fri, 11 Apr 2025 18:19:28 +0200 |
| parents | 6baea959dc33 |
| children |
| rev | line source |
|---|---|
| 4303 | 1 #!/usr/bin/env python3 |
| 2 | |
| 3 # Libervia Email Gateway Component | |
| 4 # Copyright (C) 2009-2024 Jérôme Poisson (goffi@goffi.org) | |
| 5 | |
| 6 # This program is free software: you can redistribute it and/or modify | |
| 7 # it under the terms of the GNU Affero General Public License as published by | |
| 8 # the Free Software Foundation, either version 3 of the License, or | |
| 9 # (at your option) any later version. | |
| 10 | |
| 11 # This program is distributed in the hope that it will be useful, | |
| 12 # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 14 # GNU Affero General Public License for more details. | |
| 15 | |
| 16 # You should have received a copy of the GNU Affero General Public License | |
| 17 # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 18 | |
|
4347
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
19 import base64 |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
20 from email import encoders |
| 4303 | 21 from email.header import decode_header |
| 22 from email.message import EmailMessage | |
|
4347
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
23 from email.mime.application import MIMEApplication |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
24 from email.mime.multipart import MIMEMultipart |
| 4303 | 25 from email.mime.text import MIMEText |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
26 from email.utils import formataddr, getaddresses, parseaddr |
| 4303 | 27 from functools import partial |
|
4337
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
28 import hashlib |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
29 from pathlib import Path |
| 4303 | 30 import re |
|
4337
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
31 import shutil |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
32 import tempfile |
|
4347
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
33 from typing import NamedTuple, TYPE_CHECKING, cast |
| 4303 | 34 |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
35 from pydantic import BaseModel |
| 4303 | 36 from twisted.internet import defer, reactor |
|
4337
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
37 from twisted.internet.threads import deferToThread |
| 4303 | 38 from twisted.mail import smtp |
| 39 from twisted.words.protocols.jabber import jid | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
40 from twisted.words.protocols.jabber import error as jabber_error |
| 4303 | 41 from twisted.words.protocols.jabber.error import StanzaError |
| 42 from twisted.words.protocols.jabber.xmlstream import XMPPHandler | |
| 43 from twisted.words.xish import domish | |
| 44 from wokkel import data_form, disco, iwokkel | |
| 45 from zope.interface import implementer | |
| 46 | |
| 47 from libervia.backend.core import exceptions | |
| 48 from libervia.backend.core.constants import Const as C | |
|
4337
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
49 from libervia.backend.core.core_types import SatXMPPComponent, SatXMPPEntity |
| 4303 | 50 from libervia.backend.core.i18n import D_, _ |
| 51 from libervia.backend.core.log import getLogger | |
| 52 from libervia.backend.memory.persistent import LazyPersistentBinaryDict | |
| 53 from libervia.backend.memory.sqla import select | |
| 54 from libervia.backend.memory.sqla_mapping import PrivateIndBin | |
| 55 from libervia.backend.models.core import MessageData | |
|
4338
7c0b7ecb816f
component email gateway: Add a pubsub service:
Goffi <goffi@goffi.org>
parents:
4337
diff
changeset
|
56 from libervia.backend.plugins.plugin_comp_email_gateway.pubsub_service import ( |
|
7c0b7ecb816f
component email gateway: Add a pubsub service:
Goffi <goffi@goffi.org>
parents:
4337
diff
changeset
|
57 EmailGWPubsubService, |
|
7c0b7ecb816f
component email gateway: Add a pubsub service:
Goffi <goffi@goffi.org>
parents:
4337
diff
changeset
|
58 ) |
|
4347
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
59 from libervia.backend.plugins.plugin_exp_gre import GRE, GetDataHandler |
|
4350
6baea959dc33
component email gateway: convert `autocrypt` header:
Goffi <goffi@goffi.org>
parents:
4347
diff
changeset
|
60 from libervia.backend.plugins.plugin_sec_gre_encrypter_openpgp import NS_GRE_OPENPGP |
|
4347
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
61 from libervia.backend.plugins.plugin_sec_gre_formatter_mime import NS_GRE_MIME |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
62 from libervia.backend.plugins.plugin_xep_0033 import ( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
63 AddressType, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
64 AddressesData, |
|
4337
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
65 RECIPIENT_FIELDS, |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
66 ) |
| 4303 | 67 from libervia.backend.plugins.plugin_xep_0077 import XEP_0077 |
| 68 from libervia.backend.plugins.plugin_xep_0106 import XEP_0106 | |
|
4337
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
69 from libervia.backend.plugins.plugin_xep_0131 import HeadersData, Urgency, XEP_0131 |
|
4347
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
70 from libervia.backend.plugins.plugin_xep_0373 import binary_to_ascii_armor |
|
4337
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
71 from libervia.backend.plugins.plugin_xep_0498 import XEP_0498 |
|
4350
6baea959dc33
component email gateway: convert `autocrypt` header:
Goffi <goffi@goffi.org>
parents:
4347
diff
changeset
|
72 from libervia.backend.tools.common import regex |
| 4303 | 73 from libervia.backend.tools.utils import aio |
| 74 | |
|
4337
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
75 from .imap import IMAPClientFactory |
| 4303 | 76 from .models import Credentials, UserData |
|
4337
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
77 |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
78 if TYPE_CHECKING: |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
79 from libervia.backend.core.main import LiberviaBackend |
| 4303 | 80 |
| 81 | |
| 82 log = getLogger(__name__) | |
| 83 | |
| 84 IMPORT_NAME = "email-gateway" | |
| 85 NAME = "Libervia Email Gateway" | |
| 86 | |
| 87 PLUGIN_INFO = { | |
| 88 C.PI_NAME: "Email Gateway Component", | |
| 89 C.PI_IMPORT_NAME: IMPORT_NAME, | |
| 90 C.PI_MODES: [C.PLUG_MODE_COMPONENT], | |
| 91 C.PI_TYPE: C.PLUG_TYPE_ENTRY_POINT, | |
| 92 C.PI_PROTOCOLS: [], | |
|
4347
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
93 C.PI_DEPENDENCIES: [ |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
94 "XEP-0033", "XEP-0077", "XEP-0106", "XEP-0498", "GRE", "GRE-MIME", "GRE-OpenPGP" |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
95 ], |
| 4303 | 96 C.PI_RECOMMENDATIONS: [], |
| 97 C.PI_MAIN: "EmailGatewayComponent", | |
| 98 C.PI_HANDLER: C.BOOL_TRUE, | |
| 99 C.PI_DESCRIPTION: D_( | |
| 100 "Gateway to handle email. Usual emails are handled as message, while mailing " | |
| 101 "lists are converted to pubsub blogs." | |
| 102 ), | |
| 103 } | |
| 104 | |
| 105 CONF_SECTION = f"component {IMPORT_NAME}" | |
| 106 PREFIX_KEY_CREDENTIALS = "CREDENTIALS_" | |
| 107 KEY_CREDENTIALS = f"{PREFIX_KEY_CREDENTIALS}{{from_jid}}" | |
| 108 | |
| 109 | |
|
4337
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
110 class FileMetadata(NamedTuple): |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
111 path: Path |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
112 hash: str |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
113 size: int |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
114 |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
115 |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
116 class SendMailExtra(BaseModel): |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
117 addresses: AddressesData | None = None |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
118 headers: HeadersData | None = None |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
119 |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
120 |
|
4347
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
121 class EmailGatewayComponent(GetDataHandler): |
| 4303 | 122 IMPORT_NAME = IMPORT_NAME |
|
4347
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
123 gre_formatters = [NS_GRE_MIME] |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
124 gre_encrypters = [NS_GRE_OPENPGP] |
| 4303 | 125 verbose = 0 |
| 126 | |
|
4337
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
127 def __init__(self, host: "LiberviaBackend") -> None: |
| 4357 | 128 """ |
| 129 Initialize the Email Gateway component. | |
| 130 | |
| 131 @param host: The Libervia backend instance. | |
| 132 """ | |
| 4303 | 133 self.host = host |
|
4337
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
134 self.client: SatXMPPComponent | None = None |
| 4303 | 135 self.initalized = False |
| 136 self.storage: LazyPersistentBinaryDict | None = None | |
| 137 self._iq_register = cast(XEP_0077, host.plugins["XEP-0077"]) | |
| 138 self._iq_register.register_handler( | |
| 139 self._on_registration_form, self._on_registration_submit | |
| 140 ) | |
| 141 self._e = cast(XEP_0106, host.plugins["XEP-0106"]) | |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
142 self._shim = cast(XEP_0131, host.plugins["XEP-0131"]) |
|
4337
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
143 self._pfs = cast(XEP_0498, host.plugins["XEP-0498"]) |
|
4347
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
144 self._gre = cast(GRE, host.plugins["GRE"]) |
| 4303 | 145 # TODO: For the moment, all credentials are kept in cache; we should only keep the |
| 146 # X latest. | |
| 147 self.users_data: dict[jid.JID, UserData] = {} | |
|
4337
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
148 self.files_path = self.host.get_local_path(None, C.FILES_DIR) |
| 4303 | 149 host.trigger.add_with_check( |
| 150 "message_received", self, self._message_received_trigger, priority=-1000 | |
| 151 ) | |
| 152 | |
| 153 async def _init(self) -> None: | |
| 154 """Initialisation done after profile is connected""" | |
| 155 assert self.client is not None | |
| 156 self.client.identities.append(disco.DiscoIdentity("gateway", "smtp", NAME)) | |
| 157 self.storage = LazyPersistentBinaryDict(IMPORT_NAME, self.client.profile) | |
| 158 await self.connect_registered_users() | |
| 159 | |
| 160 @aio | |
| 161 async def get_registered_users(self) -> dict[jid.JID, Credentials]: | |
| 162 """Retrieve credentials for all registered users | |
| 163 | |
| 164 @return: a mapping from user JID to credentials data. | |
| 165 """ | |
| 166 assert self.client is not None | |
| 167 profile_id = self.host.memory.storage.profiles[self.client.profile] | |
| 168 async with self.host.memory.storage.session() as session: | |
| 169 query = select(PrivateIndBin).where( | |
| 170 PrivateIndBin.profile_id == profile_id, | |
| 171 PrivateIndBin.namespace == IMPORT_NAME, | |
| 172 PrivateIndBin.key.startswith(PREFIX_KEY_CREDENTIALS), | |
| 173 ) | |
| 174 result = await session.execute(query) | |
| 175 return { | |
| 176 jid.JID(p.key[len(PREFIX_KEY_CREDENTIALS) :]): p.value | |
| 177 for p in result.scalars() | |
| 178 } | |
| 179 | |
| 180 async def connect_registered_users(self) -> None: | |
| 181 """Connected users already registered to the gateway.""" | |
| 182 registered_data = await self.get_registered_users() | |
| 183 for user_jid, credentials in registered_data.items(): | |
| 184 user_data = self.users_data[user_jid] = UserData(credentials=credentials) | |
| 185 if not credentials["imap_success"]: | |
| 186 log.warning( | |
| 187 f"Ignoring unsuccessful IMAP credentials of {user_jid}. This user " | |
| 188 "won't receive message from this gateway." | |
| 189 ) | |
| 190 else: | |
| 191 try: | |
| 192 await self.connect_imap(user_jid, user_data) | |
| 193 except Exception as e: | |
| 194 log.warning(f"Can't connect {user_jid} to IMAP: {e}.") | |
| 195 else: | |
| 196 log.debug(f"Connection to IMAP server successful for {user_jid}.") | |
| 197 | |
|
4338
7c0b7ecb816f
component email gateway: Add a pubsub service:
Goffi <goffi@goffi.org>
parents:
4337
diff
changeset
|
198 def get_handler(self, __) -> tuple[XMPPHandler, XMPPHandler]: |
|
7c0b7ecb816f
component email gateway: Add a pubsub service:
Goffi <goffi@goffi.org>
parents:
4337
diff
changeset
|
199 return EmailGatewayHandler(), EmailGWPubsubService(self) |
| 4303 | 200 |
| 201 async def profile_connecting(self, client: SatXMPPEntity) -> None: | |
|
4337
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
202 assert isinstance(client, SatXMPPComponent) |
| 4303 | 203 self.client = client |
|
4347
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
204 self._gre.register_get_data_handler(client, self) |
| 4303 | 205 if not self.initalized: |
| 206 await self._init() | |
| 207 self.initalized = True | |
| 208 | |
| 209 def _message_received_trigger( | |
| 210 self, | |
| 211 client: SatXMPPEntity, | |
| 212 message_elt: domish.Element, | |
| 213 post_treat: defer.Deferred, | |
| 214 ) -> bool: | |
| 215 """add the gateway workflow on post treatment""" | |
| 216 if client != self.client: | |
| 217 return True | |
| 218 post_treat.addCallback( | |
| 219 lambda mess_data: defer.ensureDeferred( | |
| 220 self.on_message(client, mess_data, message_elt) | |
| 221 ) | |
| 222 ) | |
| 223 return True | |
| 224 | |
| 225 async def on_message( | |
| 226 self, client: SatXMPPEntity, mess_data: MessageData, message_elt: domish.Element | |
| 227 ) -> dict: | |
| 228 """Called once message has been parsed | |
| 229 | |
| 230 @param client: Client session. | |
| 231 @param mess_data: Message data. | |
| 232 @return: Message data. | |
| 233 """ | |
| 234 if client != self.client: | |
| 235 return mess_data | |
| 236 from_jid = mess_data["from"].userhostJID() | |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
237 extra_kw = {} |
| 4303 | 238 if mess_data["type"] not in ("chat", "normal"): |
| 239 log.warning(f"ignoring message with unexpected type: {mess_data}") | |
| 240 return mess_data | |
| 241 if not client.is_local(from_jid): | |
| 242 log.warning(f"ignoring non local message: {mess_data}") | |
| 243 return mess_data | |
| 244 if not mess_data["to"].user: | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
245 addresses = mess_data["extra"].get("addresses") |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
246 if not addresses: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
247 log.warning(f"ignoring message addressed to gateway itself: {mess_data}") |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
248 return mess_data |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
249 else: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
250 to_email = None |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
251 extra_kw["addresses"] = addresses |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
252 else: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
253 try: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
254 to_email = self._e.unescape(mess_data["to"].user) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
255 except ValueError: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
256 raise exceptions.DataError( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
257 f'Invalid "to" JID, can\'t send message: {message_elt.toXml()}.' |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
258 ) |
| 4303 | 259 |
|
4347
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
260 encrypted_payload = self._gre.get_encrypted_payload(message_elt) |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
261 |
| 4303 | 262 try: |
|
4347
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
263 if encrypted_payload is not None: |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
264 # We convert the base64 datat to ASCII Armor |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
265 encrypted_binary = base64.b64decode(encrypted_payload) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
266 encrypted_payload = binary_to_ascii_armor(encrypted_binary) |
| 4303 | 267 |
|
4347
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
268 assert to_email is not None |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
269 subject = "This is an encrypted message." |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
270 outer = MIMEMultipart('encrypted', protocol="application/pgp-encrypted") |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
271 outer["Subject"] = subject |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
272 # FIXME: use credentials here. |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
273 outer["From"] = from_jid.userhost() |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
274 outer["To"] = to_email |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
275 outer["Content-Type"] = "multipart/encrypted; protocol=\"application/pgp-encrypted\"" |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
276 version = MIMEApplication( |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
277 "Version: 1\n", |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
278 _subtype='pgp-encrypted', |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
279 _encoder=encoders.encode_7or8bit |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
280 ) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
281 version["Content-Description"] = "PGP/MIME version identification" |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
282 encrypted_part = MIMEApplication( |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
283 encrypted_payload, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
284 _subtype='octet-stream', |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
285 _encoder=encoders.encode_7or8bit |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
286 ) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
287 encrypted_part["Content-Description"] = "OpenPGP encrypted message" |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
288 encrypted_part["Content-Type"] = "application/octet-stream; name=\"encrypted.asc\"" |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
289 encrypted_part["Content-Disposition"] = "inline; filename=\"encrypted.asc\"" |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
290 outer.attach(version) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
291 outer.attach(encrypted_part) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
292 body = outer.as_bytes() |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
293 await self.send_encrypted_email( |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
294 from_jid=from_jid, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
295 to_email=to_email, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
296 body=body, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
297 extra=SendMailExtra(**extra_kw) if extra_kw else None, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
298 ) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
299 else: |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
300 self._shim.move_keywords_to_headers(mess_data["extra"]) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
301 headers = mess_data["extra"].get("headers") |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
302 if headers: |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
303 extra_kw["headers"] = headers |
| 4303 | 304 |
|
4347
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
305 try: |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
306 body_lang, body = next(iter(mess_data["message"].items())) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
307 except (KeyError, StopIteration): |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
308 log.warning(f"No body found: {mess_data}") |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
309 body_lang, body = "", "" |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
310 try: |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
311 subject_lang, subject = next(iter(mess_data["subject"].items())) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
312 except (KeyError, StopIteration): |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
313 subject_lang, subject = "", None |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
314 |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
315 if not body and not subject: |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
316 log.warning(f"Ignoring empty message: {mess_data}") |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
317 return mess_data |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
318 |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
319 await self.send_email( |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
320 from_jid=from_jid, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
321 to_email=to_email, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
322 body=body, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
323 subject=subject, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
324 extra=SendMailExtra(**extra_kw) if extra_kw else None, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
325 ) |
| 4303 | 326 except exceptions.UnknownEntityError: |
| 327 log.warning(f"Can't send message, user {from_jid} is not registered.") | |
| 328 message_error_elt = StanzaError( | |
| 329 "subscription-required", | |
| 330 text="User need to register to the gateway before sending emails.", | |
| 331 ).toResponse(message_elt) | |
| 332 await client.a_send(message_error_elt) | |
| 333 raise exceptions.CancelError("User not registered.") | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
334 except StanzaError as e: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
335 log.warning("Can't send message: {e}") |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
336 message_error_elt = e.toResponse(message_elt) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
337 await client.a_send(message_error_elt) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
338 raise exceptions.CancelError("Can't send message: {e}") |
| 4303 | 339 |
| 340 return mess_data | |
| 341 | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
342 def jid_to_email( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
343 self, client: SatXMPPEntity, address_jid: jid.JID, credentials: dict[str, str] |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
344 ) -> str: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
345 """Convert a JID to an email address. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
346 |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
347 If JID is from the gateway, email address will be extracted. Otherwise, the |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
348 gateway email will be used, with XMPP address specified in name part. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
349 |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
350 @param address_jid: JID of the recipient. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
351 @param credentials: Sender credentials. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
352 @return: Email address. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
353 """ |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
354 if address_jid and address_jid.host.endswith(str(client.jid)): |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
355 return self._e.unescape(address_jid.user) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
356 else: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
357 email_address = credentials["user_email"] |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
358 if address_jid: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
359 email_address = formataddr((f"xmpp:{address_jid}", email_address)) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
360 return email_address |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
361 |
|
4347
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
362 async def get_credentials(self, from_jid: jid.JID) -> Credentials: |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
363 """Retrieve user credentials from a bare JID. |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
364 |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
365 @param from_jid: Entity to retrieve credentials from. |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
366 @return: Credentials. |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
367 |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
368 @raise UnknownEntityError: If no credentials are found for the given JID. |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
369 """ |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
370 # We need a bare jid. |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
371 assert self.storage is not None |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
372 assert not from_jid.resource |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
373 try: |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
374 user_data = self.users_data[from_jid] |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
375 except KeyError: |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
376 key = KEY_CREDENTIALS.format(from_jid=from_jid) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
377 credentials = await self.storage.get(key) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
378 if credentials is None: |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
379 raise exceptions.UnknownEntityError( |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
380 f"No credentials found for {from_jid}." |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
381 ) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
382 self.users_data[from_jid] = UserData(credentials) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
383 else: |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
384 credentials = user_data.credentials |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
385 return credentials |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
386 |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
387 async def send_encrypted_email( |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
388 self, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
389 from_jid: jid.JID, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
390 to_email: str | None, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
391 body: bytes, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
392 extra: SendMailExtra | None = None, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
393 ) -> None: |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
394 """Send an email using sender credentials. |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
395 |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
396 Credentials will be retrieved from cache or database. |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
397 |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
398 @param from_jid: Bare JID of the sender. |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
399 @param to_email: Email address of the recipient. |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
400 @param body: Encrypted body of the email. |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
401 @param extra: Extra data. |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
402 """ |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
403 assert self.client is not None |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
404 assert isinstance(body, bytes) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
405 credentials = await self.get_credentials(from_jid) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
406 |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
407 sender_domain = credentials["user_email"].split("@", 1)[-1] |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
408 recipients = [] |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
409 if to_email is not None: |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
410 recipients.append(to_email.encode()) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
411 if extra is not None and extra.addresses is not None: |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
412 for address in extra.addresses.addresses: |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
413 recipient_jid = address.jid |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
414 if recipient_jid is None: |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
415 continue |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
416 recipient_email = self.jid_to_email( |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
417 self.client, recipient_jid, credentials |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
418 ) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
419 recipients.append(recipient_email.encode()) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
420 |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
421 if not recipients: |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
422 raise exceptions.InternalError("No recipient found.") |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
423 |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
424 await smtp.sendmail( |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
425 credentials["smtp_host"].encode(), |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
426 credentials["user_email"].encode(), |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
427 recipients, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
428 body, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
429 senderDomainName=sender_domain, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
430 port=int(credentials["smtp_port"]), |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
431 username=credentials["smtp_username"].encode(), |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
432 password=credentials["smtp_password"].encode(), |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
433 requireAuthentication=True, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
434 # TODO: only STARTTLS is supported right now, implicit TLS should be supported |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
435 # too. |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
436 requireTransportSecurity=True, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
437 ) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
438 |
| 4303 | 439 async def send_email( |
| 440 self, | |
| 441 from_jid: jid.JID, | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
442 to_email: str | None, |
| 4303 | 443 body: str, |
| 444 subject: str | None, | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
445 extra: SendMailExtra | None = None, |
| 4303 | 446 ) -> None: |
| 447 """Send an email using sender credentials. | |
| 448 | |
| 449 Credentials will be retrieve from cache, or database. | |
| 450 | |
| 451 @param from_jid: Bare JID of the sender. | |
| 452 @param to_email: Email address of the destinee. | |
| 453 @param body: Body of the email. | |
| 454 @param subject: Subject of the email. | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
455 @param extra: Extra data. |
| 4303 | 456 |
| 457 @raise exceptions.UnknownEntityError: Credentials for "from_jid" can't be found. | |
| 458 """ | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
459 assert self.client is not None |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
460 if extra is None: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
461 extra = SendMailExtra() |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
462 if to_email is None and (extra.addresses is None or not extra.addresses.to): |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
463 raise exceptions.InternalError( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
464 '"to_email" can\'t be None if there is no "to" address!' |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
465 ) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
466 |
|
4347
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
467 credentials = await self.get_credentials(from_jid) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
468 |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
469 if isinstance(body, bytes): |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
470 assert to_email is not None |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
471 sender_domain = credentials["user_email"].split("@", 1)[-1] |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
472 await smtp.sendmail( |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
473 credentials["smtp_host"].encode(), |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
474 credentials["user_email"].encode(), |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
475 [to_email.encode()], |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
476 body, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
477 senderDomainName=sender_domain, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
478 port=int(credentials["smtp_port"]), |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
479 username=credentials["smtp_username"].encode(), |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
480 password=credentials["smtp_password"].encode(), |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
481 requireAuthentication=True, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
482 # TODO: only STARTTLS is supported right now, implicit TLS should be supported |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
483 # too. |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
484 requireTransportSecurity=True, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
485 ) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
486 return |
| 4303 | 487 |
| 488 msg = MIMEText(body, "plain", "UTF-8") | |
| 489 if subject is not None: | |
| 490 msg["Subject"] = subject | |
| 491 msg["From"] = formataddr( | |
| 492 (credentials["user_name"] or None, credentials["user_email"]) | |
| 493 ) | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
494 if extra.addresses: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
495 assert extra.addresses.to |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
496 main_to_address = extra.addresses.to[0] |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
497 assert main_to_address.jid |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
498 to_email = self.jid_to_email(self.client, main_to_address.jid, credentials) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
499 for field in RECIPIENT_FIELDS: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
500 addresses = getattr(extra.addresses, field) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
501 if not addresses: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
502 continue |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
503 for address in addresses: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
504 if not address.delivered and ( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
505 address.jid is None or address.jid.host != str(self.client.jid) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
506 ): |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
507 log.warning( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
508 "Received undelivered message to external JID, this is not " |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
509 "allowed! Cancelling the message sending." |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
510 ) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
511 stanza_err = jabber_error.StanzaError( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
512 "forbidden", |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
513 text="Multicasting (XEP-0033 addresses) can only be used " |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
514 "with JID from this gateway, not external ones. " |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
515 f" {address.jid} can't be delivered by this gateway and " |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
516 "should be delivered by server instead.", |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
517 ) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
518 raise stanza_err |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
519 email_addresses = [ |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
520 self.jid_to_email(self.client, address.jid, credentials) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
521 for address in addresses |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
522 if address.jid |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
523 ] |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
524 if email_addresses: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
525 msg[field.upper()] = ", ".join(email_addresses) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
526 else: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
527 assert to_email is not None |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
528 msg["To"] = to_email |
| 4303 | 529 |
| 530 sender_domain = credentials["user_email"].split("@", 1)[-1] | |
| 531 | |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
532 if extra.headers: |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
533 if extra.headers.keywords: |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
534 msg["Keywords"] = extra.headers.keywords |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
535 if extra.headers.urgency: |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
536 urgency = extra.headers.urgency |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
537 if urgency == Urgency.medium: |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
538 importance = "normal" |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
539 else: |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
540 importance = urgency |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
541 msg["Importance"] = importance |
|
4350
6baea959dc33
component email gateway: convert `autocrypt` header:
Goffi <goffi@goffi.org>
parents:
4347
diff
changeset
|
542 if getattr(extra.headers, "autocrypt", None): |
|
6baea959dc33
component email gateway: convert `autocrypt` header:
Goffi <goffi@goffi.org>
parents:
4347
diff
changeset
|
543 msg["Autocrypt"] = extra.headers.autocrypt |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
544 |
| 4303 | 545 await smtp.sendmail( |
| 546 credentials["smtp_host"].encode(), | |
| 547 credentials["user_email"].encode(), | |
| 548 [to_email.encode()], | |
| 549 msg.as_bytes(), | |
| 550 senderDomainName=sender_domain, | |
| 551 port=int(credentials["smtp_port"]), | |
| 552 username=credentials["smtp_username"].encode(), | |
| 553 password=credentials["smtp_password"].encode(), | |
| 554 requireAuthentication=True, | |
| 555 # TODO: only STARTTLS is supported right now, implicit TLS should be supported | |
| 556 # too. | |
| 557 requireTransportSecurity=True, | |
| 558 ) | |
| 559 | |
| 560 async def _on_registration_form( | |
| 561 self, client: SatXMPPEntity, iq_elt: domish.Element | |
| 562 ) -> tuple[bool, data_form.Form] | None: | |
| 563 if client != self.client: | |
| 564 return | |
| 565 assert self.storage is not None | |
| 566 from_jid = jid.JID(iq_elt["from"]) | |
| 567 key = KEY_CREDENTIALS.format(from_jid=from_jid.userhost()) | |
| 568 credentials = await self.storage.get(key) or {} | |
| 569 | |
| 570 form = data_form.Form(formType="form", title="IMAP/SMTP Credentials") | |
| 571 | |
| 572 # Add instructions | |
| 573 form.instructions = [ | |
| 574 D_( | |
| 575 "Please provide your IMAP and SMTP credentials to configure the " | |
| 576 "connection." | |
| 577 ) | |
| 578 ] | |
| 579 | |
| 580 # Add identity fields | |
| 581 form.addField( | |
| 582 data_form.Field( | |
| 583 fieldType="text-single", | |
| 584 var="user_name", | |
| 585 label="User Name", | |
| 586 desc=D_('The display name to use in the "From" field of sent emails.'), | |
| 587 value=credentials.get("user_name"), | |
| 588 required=True, | |
| 589 ) | |
| 590 ) | |
| 591 | |
| 592 form.addField( | |
| 593 data_form.Field( | |
| 594 fieldType="text-single", | |
| 595 var="user_email", | |
| 596 label="User Email", | |
| 597 desc=D_('The email address to use in the "From" field of sent emails.'), | |
| 598 value=credentials.get("user_email"), | |
| 599 required=True, | |
| 600 ) | |
| 601 ) | |
| 602 | |
| 603 # Add fields for IMAP credentials | |
| 604 form.addField( | |
| 605 data_form.Field( | |
| 606 fieldType="text-single", | |
| 607 var="imap_host", | |
| 608 label="IMAP Host", | |
| 609 desc=D_("IMAP server hostname or IP address"), | |
| 610 value=credentials.get("imap_host"), | |
| 611 required=True, | |
| 612 ) | |
| 613 ) | |
| 614 form.addField( | |
| 615 data_form.Field( | |
| 616 fieldType="text-single", | |
| 617 var="imap_port", | |
| 618 label="IMAP Port", | |
| 619 desc=D_("IMAP server port (default: 993)"), | |
| 620 value=credentials.get("imap_port", "993"), | |
| 621 ) | |
| 622 ) | |
| 623 form.addField( | |
| 624 data_form.Field( | |
| 625 fieldType="text-single", | |
| 626 var="imap_username", | |
| 627 label="IMAP Username", | |
| 628 desc=D_("Username for IMAP authentication"), | |
| 629 value=credentials.get("imap_username"), | |
| 630 required=True, | |
| 631 ) | |
| 632 ) | |
| 633 form.addField( | |
| 634 data_form.Field( | |
| 635 fieldType="text-private", | |
| 636 var="imap_password", | |
| 637 label="IMAP Password", | |
| 638 desc=D_("Password for IMAP authentication"), | |
| 639 value=credentials.get("imap_password"), | |
| 640 required=True, | |
| 641 ) | |
| 642 ) | |
| 643 | |
| 644 # Add fields for SMTP credentials | |
| 645 form.addField( | |
| 646 data_form.Field( | |
| 647 fieldType="text-single", | |
| 648 var="smtp_host", | |
| 649 label="SMTP Host", | |
| 650 desc=D_("SMTP server hostname or IP address"), | |
| 651 value=credentials.get("smtp_host"), | |
| 652 required=True, | |
| 653 ) | |
| 654 ) | |
| 655 form.addField( | |
| 656 data_form.Field( | |
| 657 fieldType="text-single", | |
| 658 var="smtp_port", | |
| 659 label="SMTP Port", | |
| 660 desc=D_("SMTP server port (default: 587)"), | |
| 661 value=credentials.get("smtp_port", "587"), | |
| 662 ) | |
| 663 ) | |
| 664 form.addField( | |
| 665 data_form.Field( | |
| 666 fieldType="text-single", | |
| 667 var="smtp_username", | |
| 668 label="SMTP Username", | |
| 669 desc=D_("Username for SMTP authentication"), | |
| 670 value=credentials.get("smtp_username"), | |
| 671 required=True, | |
| 672 ) | |
| 673 ) | |
| 674 form.addField( | |
| 675 data_form.Field( | |
| 676 fieldType="text-private", | |
| 677 var="smtp_password", | |
| 678 label="SMTP Password", | |
| 679 desc=D_("Password for SMTP authentication"), | |
| 680 value=credentials.get("smtp_password"), | |
| 681 required=True, | |
| 682 ) | |
| 683 ) | |
| 684 | |
| 685 return bool(credentials), form | |
| 686 | |
| 687 def validate_field( | |
| 688 self, | |
| 689 form: data_form.Form, | |
| 690 key: str, | |
| 691 field_type: str, | |
| 692 min_value: int | None = None, | |
| 693 max_value: int | None = None, | |
| 694 default: str | int | None = None, | |
| 695 ) -> None: | |
| 696 """Validate a single field. | |
| 697 | |
| 698 @param form: The form containing the fields. | |
| 699 @param key: The key of the field to validate. | |
| 700 @param field_type: The expected type of the field value. | |
| 701 @param min_value: Optional minimum value for integer fields. | |
| 702 @param max_value: Optional maximum value for integer fields. | |
| 703 @param default: Default value to use if the field is missing. | |
| 704 @raise StanzaError: If the field value is invalid or missing. | |
| 705 """ | |
| 706 field = form.fields.get(key) | |
| 707 if field is None: | |
| 708 if default is None: | |
| 709 raise StanzaError("bad-request", text=f"{key} is required") | |
| 710 field = data_form.Field(var=key, value=str(default)) | |
| 711 form.addField(field) | |
| 712 | |
| 713 value = field.value | |
| 714 if field_type == "int": | |
| 715 try: | |
| 716 value = int(value) | |
| 717 if (min_value is not None and value < min_value) or ( | |
| 718 max_value is not None and value > max_value | |
| 719 ): | |
| 720 raise ValueError | |
| 721 except (ValueError, TypeError): | |
| 722 raise StanzaError("bad-request", text=f"Invalid value for {key}: {value}") | |
| 723 elif field_type == "str": | |
| 724 if not isinstance(value, str): | |
| 725 raise StanzaError("bad-request", text=f"Invalid value for {key}: {value}") | |
| 726 | |
| 727 # Basic email validation for user_email field | |
| 728 if key == "user_email": | |
| 729 # XXX: This is a minimal check. A complete email validation is notoriously | |
| 730 # difficult. | |
|
4350
6baea959dc33
component email gateway: convert `autocrypt` header:
Goffi <goffi@goffi.org>
parents:
4347
diff
changeset
|
731 if not regex.RE_EMAIL.match(value): |
| 4303 | 732 raise StanzaError( |
| 733 "bad-request", text=f"Invalid email address: {value}" | |
| 734 ) | |
| 735 | |
| 736 def validate_imap_smtp_form(self, submit_form: data_form.Form) -> None: | |
| 737 """Validate the submitted IMAP/SMTP credentials form. | |
| 738 | |
| 739 @param submit_form: The submitted form containing IMAP/SMTP credentials. | |
| 740 @raise StanzaError: If any of the values are invalid. | |
| 741 """ | |
| 742 # Validate identity fields | |
| 743 self.validate_field(submit_form, "user_name", "str") | |
| 744 self.validate_field(submit_form, "user_email", "str") | |
| 745 | |
| 746 # Validate IMAP fields | |
| 747 self.validate_field(submit_form, "imap_host", "str") | |
| 748 self.validate_field( | |
| 749 submit_form, "imap_port", "int", min_value=1, max_value=65535, default=993 | |
| 750 ) | |
| 751 self.validate_field(submit_form, "imap_username", "str") | |
| 752 self.validate_field(submit_form, "imap_password", "str") | |
| 753 | |
| 754 # Validate SMTP fields | |
| 755 self.validate_field(submit_form, "smtp_host", "str") | |
| 756 self.validate_field( | |
| 757 submit_form, "smtp_port", "int", min_value=1, max_value=65535, default=587 | |
| 758 ) | |
| 759 self.validate_field(submit_form, "smtp_username", "str") | |
| 760 self.validate_field(submit_form, "smtp_password", "str") | |
| 761 | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
762 def email_to_jid( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
763 self, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
764 client: SatXMPPEntity, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
765 user_email: str, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
766 user_jid: jid.JID, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
767 email_name: str, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
768 email_addr: str, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
769 ) -> tuple[jid.JID, str | None]: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
770 """Convert an email address to a JID and extract the name if present. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
771 |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
772 @param client: Client session. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
773 @param user_email: Email address of the gateway user. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
774 @param user_jid: JID of the gateway user. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
775 @param email_name: Email associated name. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
776 @param email_addr: Email address. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
777 @return: Tuple of JID and name (if present). |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
778 """ |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
779 email_name = email_name.strip() |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
780 if email_name.startswith("xmpp:"): |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
781 return jid.JID(email_name[5:]), None |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
782 elif email_addr == user_email: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
783 return (user_jid, None) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
784 else: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
785 return ( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
786 jid.JID(None, (self._e.escape(email_addr), client.jid.host, None)), |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
787 email_name or None, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
788 ) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
789 |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
790 async def on_new_email( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
791 self, user_data: UserData, user_jid: jid.JID, email: EmailMessage |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
792 ) -> None: |
| 4303 | 793 """Called when a new message has been received. |
| 794 | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
795 @param user_data: user data, used to map registered user email to corresponding |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
796 jid. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
797 @param user_jid: JID of the recipient. |
| 4303 | 798 @param email: Parsed email. |
| 799 """ | |
| 800 assert self.client is not None | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
801 user_email = user_data.credentials["user_email"] |
| 4303 | 802 name, email_addr = parseaddr(email["from"]) |
| 803 email_addr = email_addr.lower() | |
| 804 from_jid = jid.JID(None, (self._e.escape(email_addr), self.client.jid.host, None)) | |
| 805 | |
| 806 # Get the email body | |
| 807 body_mime = email.get_body(("plain",)) | |
| 808 if body_mime is not None: | |
| 809 charset = body_mime.get_content_charset() or "utf-8" | |
| 810 body = body_mime.get_payload(decode=True).decode(charset, errors="replace") | |
| 811 else: | |
| 812 log.warning(f"No body found in email:\n{email}") | |
| 813 body = "" | |
| 814 | |
| 815 # Decode the subject | |
| 816 subject = email.get("subject") | |
| 817 if subject: | |
| 818 decoded_subject = decode_header(subject) | |
| 819 subject = "".join( | |
| 820 [ | |
| 821 part.decode(encoding or "utf-8") if isinstance(part, bytes) else part | |
| 822 for part, encoding in decoded_subject | |
| 823 ] | |
| 824 ).strip() | |
| 825 else: | |
| 826 subject = None | |
| 827 | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
828 # Parse recipient fields |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
829 kwargs = {} |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
830 for field in RECIPIENT_FIELDS: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
831 email_addresses = email.get_all(field) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
832 if email_addresses: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
833 jids_and_names = [ |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
834 self.email_to_jid(self.client, user_email, user_jid, name, addr) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
835 for name, addr in getaddresses(email_addresses) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
836 ] |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
837 kwargs[field] = [ |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
838 AddressType(jid=jid, desc=name) for jid, name in jids_and_names |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
839 ] |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
840 |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
841 # At least "to" header should be set, so kwargs should never be empty |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
842 assert kwargs |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
843 addresses_data = AddressesData(**kwargs) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
844 |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
845 # Parse reply-to field |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
846 reply_to_addresses = email.get_all("reply-to") |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
847 if reply_to_addresses: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
848 jids_with_names = [ |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
849 self.email_to_jid(self.client, user_email, user_jid, name, addr) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
850 for name, addr in getaddresses(reply_to_addresses) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
851 ] |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
852 addresses_data.replyto = [ |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
853 AddressType(jid=jid, desc=name) for jid, name in jids_with_names |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
854 ] |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
855 |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
856 # Set noreply flag |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
857 # The is no flag to indicate a no-reply message, so we check common user parts in |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
858 # from and reply-to headers. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
859 from_addresses = [email_addr] |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
860 if reply_to_addresses: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
861 from_addresses.extend( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
862 addr for a in reply_to_addresses if (addr := parseaddr(a)[1]) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
863 ) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
864 for from_address in from_addresses: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
865 from_user_part = from_address.split("@", 1)[0].lower() |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
866 if from_user_part in ( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
867 "no-reply", |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
868 "noreply", |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
869 "do-not-reply", |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
870 "donotreply", |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
871 "notification", |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
872 "notifications", |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
873 ): |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
874 addresses_data.noreply = True |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
875 break |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
876 extra = {} |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
877 |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
878 if ( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
879 not addresses_data.replyto |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
880 and not addresses_data.noreply |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
881 and not addresses_data.cc |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
882 and not addresses_data.bcc |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
883 and addresses_data.to == [AddressType(jid=user_jid)] |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
884 ): |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
885 # The main recipient is the only one, and there is no other metadata: there is |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
886 # no need to add addresses metadata. |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
887 pass |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
888 else: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
889 for address in addresses_data.addresses: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
890 if address.jid and ( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
891 address.jid == user_jid or address.jid.host == str(self.client.jid) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
892 ): |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
893 # Those are email address, and have been delivered by the sender, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
894 # other JID addresses will have to be delivered by us. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
895 address.delivered = True |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
896 |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
897 extra["addresses"] = addresses_data.model_dump(mode="json", exclude_none=True) |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
898 |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
899 # We look for interesting headers |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
900 headers = {} |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
901 keywords_headers = email.get_all("keywords") |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
902 if keywords_headers: |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
903 keywords = ",".join(keywords_headers) |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
904 headers["keywords"] = keywords |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
905 |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
906 importance = email["importance"] |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
907 if importance: |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
908 # We convert to urgency |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
909 if importance in ("low", "high"): |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
910 headers["urgency"] = importance |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
911 elif importance == "normal": |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
912 headers["urgency"] = "medium" |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
913 else: |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
914 log.warning("Ignoring invalid importance header: {importance!r}") |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
915 |
|
4350
6baea959dc33
component email gateway: convert `autocrypt` header:
Goffi <goffi@goffi.org>
parents:
4347
diff
changeset
|
916 autocrypt = email["autocrypt"] |
|
6baea959dc33
component email gateway: convert `autocrypt` header:
Goffi <goffi@goffi.org>
parents:
4347
diff
changeset
|
917 if autocrypt: |
|
6baea959dc33
component email gateway: convert `autocrypt` header:
Goffi <goffi@goffi.org>
parents:
4347
diff
changeset
|
918 headers["autocrypt"] = autocrypt |
|
6baea959dc33
component email gateway: convert `autocrypt` header:
Goffi <goffi@goffi.org>
parents:
4347
diff
changeset
|
919 |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
920 if headers: |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
921 extra["headers"] = HeadersData(**headers).model_dump( |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
922 mode="json", exclude_none=True |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
923 ) |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
924 |
|
4337
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
925 # Handle attachments |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
926 for part in email.iter_attachments(): |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
927 await self.handle_attachment(part, user_jid) |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
928 |
| 4303 | 929 client = self.client.get_virtual_client(from_jid) |
|
4337
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
930 |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
931 await client.sendMessage( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
932 user_jid, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
933 {"": body}, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
934 {"": subject} if subject else None, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
935 extra=extra, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
936 ) |
| 4303 | 937 |
|
4337
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
938 async def handle_attachment(self, part: EmailMessage, recipient_jid: jid.JID) -> None: |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
939 """Handle an attachment from an email. |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
940 |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
941 @param part: The object representing the attachment. |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
942 @param recipient_jid: JID of the recipient to whom the attachment is being sent. |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
943 """ |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
944 assert self.client is not None |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
945 content_type = part.get_content_type() |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
946 filename = part.get_filename() or "attachment" |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
947 log.debug(f"Handling attachment: {filename} ({content_type})") |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
948 file_metadata = await deferToThread(self._save_attachment, part) |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
949 if file_metadata is not None: |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
950 log.debug(f"Attachment {filename!r} saved to {file_metadata.path}") |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
951 try: |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
952 await self.host.memory.set_file( |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
953 self.client, |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
954 filename, |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
955 file_hash=file_metadata.hash, |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
956 hash_algo="sha-256", |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
957 size=file_metadata.size, |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
958 namespace=PLUGIN_INFO[C.PI_IMPORT_NAME], |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
959 mime_type=content_type, |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
960 owner=recipient_jid, |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
961 ) |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
962 except Exception: |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
963 log.exception(f"Failed to register file {filename!r}") |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
964 |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
965 def _save_attachment(self, part: EmailMessage) -> FileMetadata | None: |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
966 """Save the attachment to files path. |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
967 |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
968 This method must be executed in a thread with deferToThread to avoid blocking the |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
969 reactor with IO operations if the attachment is large. |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
970 |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
971 @param part: The object representing the attachment. |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
972 @return: Attachment data, or None if an error occurs. |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
973 @raises IOError: Can't save the attachment. |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
974 """ |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
975 temp_file = None |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
976 try: |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
977 with tempfile.NamedTemporaryFile(delete=False) as temp_file: |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
978 payload = part.get_payload(decode=True) |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
979 if isinstance(payload, bytes): |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
980 temp_file.write(payload) |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
981 file_hash = hashlib.sha256(payload).hexdigest() |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
982 file_path = self.files_path / file_hash |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
983 shutil.move(temp_file.name, file_path) |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
984 file_size = len(payload) |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
985 return FileMetadata(path=file_path, hash=file_hash, size=file_size) |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
986 else: |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
987 log.warning(f"Can't write payload of type {type(payload)}.") |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
988 return None |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
989 except Exception as e: |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
990 raise IOError(f"Failed to save attachment: {e}") |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
991 finally: |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
992 if temp_file is not None and Path(temp_file.name).exists(): |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
993 Path(temp_file.name).unlink() |
|
95792a1f26c7
component email gateway: attachments handling:
Goffi <goffi@goffi.org>
parents:
4317
diff
changeset
|
994 |
| 4303 | 995 async def connect_imap(self, from_jid: jid.JID, user_data: UserData) -> None: |
| 996 """Connect to IMAP service. | |
| 997 | |
| 998 [self.on_new_email] will be used as callback on new messages. | |
| 999 | |
| 1000 @param from_jid: JID of the user associated with given credentials. | |
| 1001 @param credentials: Email credentials. | |
| 1002 """ | |
| 1003 credentials = user_data.credentials | |
| 1004 | |
| 1005 connected = defer.Deferred() | |
| 1006 factory = IMAPClientFactory( | |
| 1007 user_data, | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
1008 partial(self.on_new_email, user_data, from_jid.userhostJID()), |
| 4303 | 1009 connected, |
| 1010 ) | |
| 1011 reactor.connectTCP( | |
| 1012 credentials["imap_host"], int(credentials["imap_port"]), factory | |
| 1013 ) | |
| 1014 await connected | |
| 1015 | |
| 1016 async def _on_registration_submit( | |
| 1017 self, | |
| 1018 client: SatXMPPEntity, | |
| 1019 iq_elt: domish.Element, | |
| 1020 submit_form: data_form.Form | None, | |
| 1021 ) -> bool | None: | |
| 1022 """Handle registration submit request. | |
| 1023 | |
| 1024 Submit form is validated, and credentials are stored. | |
| 1025 @param client: client session. | |
| 1026 iq_elt: IQ stanza of the submission request. | |
| 1027 submit_form: submit form. | |
| 1028 @return: True if successful. | |
| 1029 None if the callback is not relevant for this request. | |
| 1030 """ | |
| 1031 if client != self.client: | |
| 1032 return | |
| 1033 assert self.storage is not None | |
| 1034 from_jid = jid.JID(iq_elt["from"]).userhostJID() | |
| 1035 | |
| 1036 if submit_form is None: | |
| 1037 # This is an unregistration request. | |
| 1038 try: | |
| 1039 user_data = self.users_data[from_jid] | |
| 1040 except KeyError: | |
| 1041 pass | |
| 1042 else: | |
| 1043 if user_data.imap_client is not None: | |
| 1044 try: | |
| 1045 await user_data.imap_client.logout() | |
| 1046 except Exception: | |
| 1047 log.exception(f"Can't log out {from_jid} from IMAP server.") | |
| 1048 key = KEY_CREDENTIALS.format(from_jid=from_jid) | |
| 1049 await self.storage.adel(key) | |
| 1050 log.info(f"{from_jid} unregistered from this gateway.") | |
| 1051 return True | |
| 1052 | |
| 1053 self.validate_imap_smtp_form(submit_form) | |
| 1054 credentials = {key: field.value for key, field in submit_form.fields.items()} | |
| 1055 user_data = self.users_data.get(from_jid) | |
| 1056 if user_data is None: | |
| 1057 # The user is not in cache, we cache current credentials. | |
| 1058 user_data = self.users_data[from_jid] = UserData(credentials=credentials) | |
| 1059 else: | |
| 1060 # The user is known, we update credentials. | |
| 1061 user_data.credentials = credentials | |
| 1062 key = KEY_CREDENTIALS.format(from_jid=from_jid) | |
| 1063 try: | |
| 1064 await self.connect_imap(from_jid, user_data) | |
| 1065 except Exception as e: | |
| 1066 log.warning(f"Can't connect to IMAP server for {from_jid}") | |
| 1067 credentials["imap_success"] = False | |
| 1068 await self.storage.aset(key, credentials) | |
| 1069 raise e | |
| 1070 else: | |
| 1071 log.debug(f"Connection successful to IMAP server for {from_jid}") | |
| 1072 credentials["imap_success"] = True | |
| 1073 await self.storage.aset(key, credentials) | |
| 1074 return True | |
| 1075 | |
| 1076 | |
|
4347
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
1077 async def on_relayed_encryption_data( |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
1078 self, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
1079 client: SatXMPPEntity, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
1080 iq_elt: domish.Element, |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
1081 form: data_form.Form |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
1082 ) -> None: |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
1083 from_jid = jid.JID(iq_elt["from"]).userhostJID() |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
1084 credentials = await self.get_credentials(from_jid) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
1085 form.addField(data_form.Field(var="sender_id", value=credentials["user_email"])) |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
1086 |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
1087 |
|
54df67d5646c
component email gateway: implement Gateway Relayed Encryption:
Goffi <goffi@goffi.org>
parents:
4338
diff
changeset
|
1088 |
| 4303 | 1089 @implementer(iwokkel.IDisco) |
| 1090 class EmailGatewayHandler(XMPPHandler): | |
| 1091 | |
| 1092 def getDiscoInfo(self, requestor, target, nodeIdentifier=""): | |
| 1093 return [] | |
| 1094 | |
| 1095 def getDiscoItems(self, requestor, target, nodeIdentifier=""): | |
| 1096 return [] |