Mercurial > libervia-backend
annotate sat/plugins/plugin_xep_0203.py @ 3934:e345d93fb6e5
plugin OXPS: OpenPGP for XMPP Pubsub implementation:
OpenPGP for XMPP Pubsub (https://xmpp.org/extensions/inbox/pubsub-encryption.html,
currently a protoXEP) is implemented and activated when `encrypted` is set to `True` in
pubsub's `extra` data.
On item retrieval, the decryption is transparent if the key is known, except if the
`decrypt` key in `extra` is set to `False` (notably useful when one wants to checks that
data is well encrypted).
Methods and corresponding bridge methods have been implemented to manage shared secrets
(to share, revoke or rotate the secrets).
plugin XEP-0060's `XEP-0060_publish` trigger point as been move before actual publish so
item can be modified (here e2ee) by the triggers. A new `XEP-0060_items` trigger point has
also been added.
`encrypted` flag can be used with plugin XEP-0277's microblog data
rel 380
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sat, 15 Oct 2022 20:36:53 +0200 |
| parents | be6d91572633 |
| children | 524856bd7b19 |
| rev | line source |
|---|---|
| 3028 | 1 #!/usr/bin/env python3 |
| 3137 | 2 |
| 1273 | 3 |
| 4 # SAT plugin for Delayed Delivery (XEP-0203) | |
| 3479 | 5 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org) |
| 1766 | 6 # Copyright (C) 2013-2016 Adrien Cossa (souliane@mailoo.org) |
| 1273 | 7 |
| 8 # This program is free software: you can redistribute it and/or modify | |
| 9 # it under the terms of the GNU Affero General Public License as published by | |
| 10 # the Free Software Foundation, either version 3 of the License, or | |
| 11 # (at your option) any later version. | |
| 12 | |
| 13 # This program is distributed in the hope that it will be useful, | |
| 14 # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 16 # GNU Affero General Public License for more details. | |
| 17 | |
| 18 # You should have received a copy of the GNU Affero General Public License | |
| 19 # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 20 | |
| 21 from sat.core.i18n import _ | |
|
2145
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
22 from sat.core.constants import Const as C |
| 1273 | 23 from sat.core.log import getLogger |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
24 |
| 1273 | 25 log = getLogger(__name__) |
| 26 | |
| 27 from wokkel import disco, iwokkel, delay | |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
28 |
| 1273 | 29 try: |
| 30 from twisted.words.protocols.xmlstream import XMPPHandler | |
| 31 except ImportError: | |
| 32 from wokkel.subprotocols import XMPPHandler | |
| 3028 | 33 from zope.interface import implementer |
| 1273 | 34 |
| 35 | |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
36 NS_DD = "urn:xmpp:delay" |
| 1273 | 37 |
| 38 PLUGIN_INFO = { | |
|
2145
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
39 C.PI_NAME: "Delayed Delivery", |
|
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
40 C.PI_IMPORT_NAME: "XEP-0203", |
|
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
41 C.PI_TYPE: "XEP", |
|
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
42 C.PI_PROTOCOLS: ["XEP-0203"], |
|
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
43 C.PI_MAIN: "XEP_0203", |
|
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
44 C.PI_HANDLER: "yes", |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
45 C.PI_DESCRIPTION: _("""Implementation of Delayed Delivery"""), |
| 1273 | 46 } |
| 47 | |
| 48 | |
| 49 class XEP_0203(object): | |
| 50 def __init__(self, host): | |
| 51 log.info(_("Delayed Delivery plugin initialization")) | |
| 52 self.host = host | |
| 53 | |
|
2144
1d3f73e065e1
core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
54 def getHandler(self, client): |
|
1d3f73e065e1
core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
55 return XEP_0203_handler(self, client.profile) |
| 1273 | 56 |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
57 def delay(self, stamp, sender=None, desc="", parent=None): |
| 1273 | 58 """Build a delay element, eventually append it to the given parent element. |
| 59 | |
| 60 @param stamp (datetime): offset-aware timestamp of the original sending. | |
| 61 @param sender (JID): entity that originally sent or delayed the message. | |
| 62 @param desc (unicode): optional natural language description. | |
| 63 @param parent (domish.Element): add the delay element to this element. | |
| 64 @return: the delay element (domish.Element) | |
| 65 """ | |
| 66 elt = delay.Delay(stamp, sender).toElement() | |
| 67 if desc: | |
| 68 elt.addContent(desc) | |
| 69 if parent: | |
| 70 parent.addChild(elt) | |
| 71 return elt | |
| 72 | |
| 73 | |
| 3028 | 74 @implementer(iwokkel.IDisco) |
| 1273 | 75 class XEP_0203_handler(XMPPHandler): |
| 76 | |
| 77 def __init__(self, plugin_parent, profile): | |
| 78 self.plugin_parent = plugin_parent | |
| 79 self.host = plugin_parent.host | |
| 80 self.profile = profile | |
| 81 | |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
82 def getDiscoInfo(self, requestor, target, nodeIdentifier=""): |
| 1273 | 83 return [disco.DiscoFeature(NS_DD)] |
| 84 | |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
85 def getDiscoItems(self, requestor, target, nodeIdentifier=""): |
| 1273 | 86 return [] |