Mercurial > libervia-pubsub
annotate sat_pubsub/delegation.py @ 477:9125a6e440c0
install (setup): installation is actually not zip safe:
`zip_safe` cause trouble when set and the package is zipped:
- Twisted doesn't seem to handle correctly the plugin
- `VERSION` can't be loaded
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Mon, 03 Jan 2022 16:48:22 +0100 |
| parents | 607616f9ef5b |
| children | b544109ab4c4 |
| rev | line source |
|---|---|
| 414 | 1 #!/usr/bin/env python3 |
| 242 | 2 # |
|
459
cebcb7f56889
backend, delegation: update to XEP-0355 v0.5 (namespace bump) + disco:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
3 # Copyright (c) 2015-2021 Jérôme Poisson |
| 242 | 4 |
| 5 | |
|
312
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
6 # This program is free software: you can redistribute it and/or modify |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
7 # it under the terms of the GNU Affero General Public License as published by |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
8 # the Free Software Foundation, either version 3 of the License, or |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
9 # (at your option) any later version. |
| 242 | 10 |
|
312
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
11 # This program is distributed in the hope that it will be useful, |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
14 # GNU Affero General Public License for more details. |
| 242 | 15 |
|
312
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
16 # You should have received a copy of the GNU Affero General Public License |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
17 # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 242 | 18 |
|
312
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
19 # --- |
| 242 | 20 |
|
312
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
21 # This module implements XEP-0355 (Namespace delegation) to use SàT Pubsub as PEP service |
| 242 | 22 |
|
285
a87c155d0fd5
replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far
Goffi <goffi@goffi.org>
parents:
283
diff
changeset
|
23 from wokkel.subprotocols import XMPPHandler |
|
287
61f92273fb69
implementation of XEP-0355 (Namespace Delegation) to use SàT Pubsub as PEP service, first draft
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
24 from wokkel import pubsub |
|
289
f08f8536cab8
mod delegation: extensions management (XEP-0128)
Goffi <goffi@goffi.org>
parents:
288
diff
changeset
|
25 from wokkel import data_form |
|
459
cebcb7f56889
backend, delegation: update to XEP-0355 v0.5 (namespace bump) + disco:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
26 from wokkel import disco, iwokkel, generic |
|
292
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
27 from wokkel.iwokkel import IPubSubService |
| 322 | 28 from wokkel import mam |
|
285
a87c155d0fd5
replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far
Goffi <goffi@goffi.org>
parents:
283
diff
changeset
|
29 from twisted.python import log |
|
459
cebcb7f56889
backend, delegation: update to XEP-0355 v0.5 (namespace bump) + disco:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
30 from twisted.words.protocols.jabber import ijabber, jid, error |
|
291
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
31 from twisted.words.protocols.jabber.xmlstream import toResponse |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
32 from twisted.words.xish import domish |
| 414 | 33 from zope.interface import implementer |
| 242 | 34 |
|
459
cebcb7f56889
backend, delegation: update to XEP-0355 v0.5 (namespace bump) + disco:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
35 DELEGATION_NS = 'urn:xmpp:delegation:2' |
|
287
61f92273fb69
implementation of XEP-0355 (Namespace Delegation) to use SàT Pubsub as PEP service, first draft
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
36 FORWARDED_NS = 'urn:xmpp:forward:0' |
|
61f92273fb69
implementation of XEP-0355 (Namespace Delegation) to use SàT Pubsub as PEP service, first draft
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
37 DELEGATION_ADV_XPATH = '/message/delegation[@xmlns="{}"]'.format(DELEGATION_NS) |
|
291
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
38 DELEGATION_FWD_XPATH = '/iq[@type="set"]/delegation[@xmlns="{}"]/forwarded[@xmlns="{}"]'.format(DELEGATION_NS, FORWARDED_NS) |
|
285
a87c155d0fd5
replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far
Goffi <goffi@goffi.org>
parents:
283
diff
changeset
|
39 |
|
288
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
40 DELEGATION_MAIN_SEP = "::" |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
41 DELEGATION_BARE_SEP = ":bare:" |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
42 |
| 322 | 43 TO_HACK = ((IPubSubService, pubsub, "PubSubRequest"), |
|
459
cebcb7f56889
backend, delegation: update to XEP-0355 v0.5 (namespace bump) + disco:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
44 (mam.IMAMService, mam, "MAMRequest"), |
|
cebcb7f56889
backend, delegation: update to XEP-0355 v0.5 (namespace bump) + disco:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
45 (None, disco, "_DiscoRequest")) |
| 322 | 46 |
| 47 | |
|
285
a87c155d0fd5
replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far
Goffi <goffi@goffi.org>
parents:
283
diff
changeset
|
48 class InvalidStanza(Exception): |
|
a87c155d0fd5
replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far
Goffi <goffi@goffi.org>
parents:
283
diff
changeset
|
49 pass |
|
a87c155d0fd5
replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far
Goffi <goffi@goffi.org>
parents:
283
diff
changeset
|
50 |
|
292
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
51 |
| 414 | 52 @implementer(iwokkel.IDisco) |
|
287
61f92273fb69
implementation of XEP-0355 (Namespace Delegation) to use SàT Pubsub as PEP service, first draft
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
53 class DelegationsHandler(XMPPHandler): |
|
292
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
54 _service_hacked = False |
| 242 | 55 |
|
285
a87c155d0fd5
replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far
Goffi <goffi@goffi.org>
parents:
283
diff
changeset
|
56 def __init__(self): |
|
287
61f92273fb69
implementation of XEP-0355 (Namespace Delegation) to use SàT Pubsub as PEP service, first draft
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
57 super(DelegationsHandler, self).__init__() |
| 460 | 58 self.backend = None |
|
285
a87c155d0fd5
replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far
Goffi <goffi@goffi.org>
parents:
283
diff
changeset
|
59 |
|
292
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
60 def _service_hack(self): |
| 322 | 61 """Patch the request classes of services to track delegated stanzas""" |
|
292
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
62 # XXX: we need to monkey patch to track origin of the stanza in PubSubRequest. |
|
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
63 # As PubSubRequest from sat.tmp.wokkel.pubsub use _request_class while |
|
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
64 # original wokkel.pubsub use directly pubsub.PubSubRequest, we need to |
|
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
65 # check which version is used before monkeypatching |
|
459
cebcb7f56889
backend, delegation: update to XEP-0355 v0.5 (namespace bump) + disco:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
66 for service, module, default_base_cls in TO_HACK: |
|
cebcb7f56889
backend, delegation: update to XEP-0355 v0.5 (namespace bump) + disco:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
67 module_patched = False |
|
cebcb7f56889
backend, delegation: update to XEP-0355 v0.5 (namespace bump) + disco:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
68 for handler in self.parent.handlers: |
|
cebcb7f56889
backend, delegation: update to XEP-0355 v0.5 (namespace bump) + disco:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
69 if not service or service.providedBy(handler): |
| 322 | 70 if hasattr(handler, '_request_class'): |
| 71 request_base_class = handler._request_class | |
| 72 else: | |
| 73 request_base_class = getattr(module, default_base_cls) | |
|
292
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
74 |
| 322 | 75 class RequestWithDelegation(request_base_class): |
| 76 """A XxxRequest which put an indicator if the stanza comme from delegation""" | |
|
292
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
77 |
| 322 | 78 @classmethod |
| 79 def fromElement(cls, element): | |
| 80 """Check if element comme from delegation, and set a delegated flags | |
|
292
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
81 |
| 322 | 82 delegated flag is either False, or it's a jid of the delegating server |
| 83 the delegated flag must be set on element before use | |
| 84 """ | |
| 85 try: | |
| 86 # __getattr__ is overriden in domish.Element, so we use __getattribute__ | |
| 87 delegated = element.__getattribute__('delegated') | |
| 88 except AttributeError: | |
| 89 delegated = False | |
| 90 instance = cls.__base__.fromElement(element) | |
| 91 instance.delegated = delegated | |
|
459
cebcb7f56889
backend, delegation: update to XEP-0355 v0.5 (namespace bump) + disco:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
92 try: |
|
cebcb7f56889
backend, delegation: update to XEP-0355 v0.5 (namespace bump) + disco:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
93 instance.recipient.delegated = delegated |
|
cebcb7f56889
backend, delegation: update to XEP-0355 v0.5 (namespace bump) + disco:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
94 except (AttributeError, TypeError): |
|
cebcb7f56889
backend, delegation: update to XEP-0355 v0.5 (namespace bump) + disco:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
95 pass |
| 322 | 96 return instance |
|
292
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
97 |
| 322 | 98 if hasattr(handler, '_request_class'): |
| 99 handler._request_class = RequestWithDelegation | |
|
459
cebcb7f56889
backend, delegation: update to XEP-0355 v0.5 (namespace bump) + disco:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
100 elif not module_patched: |
| 322 | 101 setattr(module, default_base_cls, RequestWithDelegation) |
|
459
cebcb7f56889
backend, delegation: update to XEP-0355 v0.5 (namespace bump) + disco:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
102 module_patched = True |
|
292
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
103 DelegationsHandler._service_hacked = True |
|
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
104 |
|
285
a87c155d0fd5
replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far
Goffi <goffi@goffi.org>
parents:
283
diff
changeset
|
105 def connectionInitialized(self): |
| 460 | 106 self.backend = self.parent.parent.getServiceNamed('backend') |
|
292
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
107 if not self._service_hacked: |
|
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
108 self._service_hack() |
|
287
61f92273fb69
implementation of XEP-0355 (Namespace Delegation) to use SàT Pubsub as PEP service, first draft
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
109 self.xmlstream.addObserver(DELEGATION_ADV_XPATH, self.onAdvertise) |
|
291
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
110 self.xmlstream.addObserver(DELEGATION_FWD_XPATH, self._obsWrapper, 0, self.onForward) |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
111 self._current_iqs = {} # dict of iq being handler by delegation |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
112 self._xs_send = self.xmlstream.send |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
113 self.xmlstream.send = self._sendHack |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
114 |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
115 def _sendHack(self, elt): |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
116 """This method is called instead of xmlstream to control sending |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
117 |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
118 @param obj(domsish.Element, unicode, str): obj sent to real xmlstream |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
119 """ |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
120 if isinstance(elt, domish.Element) and elt.name=='iq': |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
121 try: |
|
292
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
122 id_ = elt.getAttribute('id') |
|
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
123 ori_iq, managed_entity = self._current_iqs[id_] |
|
291
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
124 if jid.JID(elt['to']) != managed_entity: |
|
292
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
125 log.msg("IQ id conflict: the managed entity doesn't match (got {got} was expecting {expected})" |
|
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
126 .format(got=jid.JID(elt['to']), expected=managed_entity)) |
|
291
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
127 raise KeyError |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
128 except KeyError: |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
129 # the iq is not a delegated one |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
130 self._xs_send(elt) |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
131 else: |
|
292
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
132 del self._current_iqs[id_] |
|
291
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
133 iq_result_elt = toResponse(ori_iq, 'result') |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
134 fwd_elt = iq_result_elt.addElement('delegation', DELEGATION_NS).addElement('forwarded', FORWARDED_NS) |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
135 fwd_elt.addChild(elt) |
|
292
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
136 elt.uri = elt.defaultUri = 'jabber:client' |
|
291
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
137 self._xs_send(iq_result_elt) |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
138 else: |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
139 self._xs_send(elt) |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
140 |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
141 def _obsWrapper(self, observer, stanza): |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
142 """Wrapper to observer which catch StanzaError |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
143 |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
144 @param observer(callable): method to wrap |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
145 """ |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
146 try: |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
147 observer(stanza) |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
148 except error.StanzaError as e: |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
149 error_elt = e.toResponse(stanza) |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
150 self._xs_send(error_elt) |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
151 stanza.handled = True |
|
285
a87c155d0fd5
replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far
Goffi <goffi@goffi.org>
parents:
283
diff
changeset
|
152 |
|
a87c155d0fd5
replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far
Goffi <goffi@goffi.org>
parents:
283
diff
changeset
|
153 def onAdvertise(self, message): |
|
291
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
154 """Manage the <message/> advertising delegations""" |
| 460 | 155 if self.backend.config["server_jid"] is None: |
| 156 # if server_jid is not specified in config, we use the advertising message | |
| 157 # to get it (and replace the one found from this component jid) | |
| 158 self.backend.server_jid = self.backend.config["server_jid"] = jid.JID( | |
| 159 message["from"] | |
| 160 ) | |
| 161 else: | |
| 162 if jid.JID(message["from"]) != self.backend.server_jid: | |
| 163 log.err( | |
| 164 f"Delagation advertising message received from {message['from']}, " | |
| 165 f"while expected server jid is {self.backend.server_jid}, this may " | |
| 166 "be a security threat, please check your configuration and network." | |
| 167 ) | |
| 168 raise error.StanzaError("not-allowed") | |
| 414 | 169 delegation_elt = next(message.elements(DELEGATION_NS, 'delegation')) |
|
287
61f92273fb69
implementation of XEP-0355 (Namespace Delegation) to use SàT Pubsub as PEP service, first draft
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
170 delegated = {} |
|
61f92273fb69
implementation of XEP-0355 (Namespace Delegation) to use SàT Pubsub as PEP service, first draft
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
171 for delegated_elt in delegation_elt.elements(DELEGATION_NS): |
|
285
a87c155d0fd5
replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far
Goffi <goffi@goffi.org>
parents:
283
diff
changeset
|
172 try: |
|
287
61f92273fb69
implementation of XEP-0355 (Namespace Delegation) to use SàT Pubsub as PEP service, first draft
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
173 if delegated_elt.name != 'delegated': |
| 414 | 174 raise InvalidStanza('unexpected element {}'.format(delegated_elt.name)) |
|
285
a87c155d0fd5
replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far
Goffi <goffi@goffi.org>
parents:
283
diff
changeset
|
175 try: |
|
287
61f92273fb69
implementation of XEP-0355 (Namespace Delegation) to use SàT Pubsub as PEP service, first draft
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
176 namespace = delegated_elt['namespace'] |
|
285
a87c155d0fd5
replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far
Goffi <goffi@goffi.org>
parents:
283
diff
changeset
|
177 except KeyError: |
| 414 | 178 raise InvalidStanza('was expecting a "namespace" attribute in delegated element') |
|
287
61f92273fb69
implementation of XEP-0355 (Namespace Delegation) to use SàT Pubsub as PEP service, first draft
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
179 delegated[namespace] = [] |
|
61f92273fb69
implementation of XEP-0355 (Namespace Delegation) to use SàT Pubsub as PEP service, first draft
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
180 for attribute_elt in delegated_elt.elements(DELEGATION_NS, 'attribute'): |
|
61f92273fb69
implementation of XEP-0355 (Namespace Delegation) to use SàT Pubsub as PEP service, first draft
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
181 try: |
|
61f92273fb69
implementation of XEP-0355 (Namespace Delegation) to use SàT Pubsub as PEP service, first draft
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
182 delegated[namespace].append(attribute_elt["name"]) |
|
61f92273fb69
implementation of XEP-0355 (Namespace Delegation) to use SàT Pubsub as PEP service, first draft
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
183 except KeyError: |
| 414 | 184 raise InvalidStanza('was expecting a "name" attribute in attribute element') |
|
285
a87c155d0fd5
replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far
Goffi <goffi@goffi.org>
parents:
283
diff
changeset
|
185 except InvalidStanza as e: |
|
287
61f92273fb69
implementation of XEP-0355 (Namespace Delegation) to use SàT Pubsub as PEP service, first draft
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
186 log.msg("Invalid stanza received ({})".format(e)) |
|
285
a87c155d0fd5
replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far
Goffi <goffi@goffi.org>
parents:
283
diff
changeset
|
187 |
| 414 | 188 log.msg('delegations updated:\n{}'.format( |
| 189 '\n'.join([" - namespace {}{}".format(ns, | |
| 190 "" if not attributes else " with filtering on {} attribute(s)".format( | |
| 191 ", ".join(attributes))) for ns, attributes in list(delegated.items())]))) | |
| 242 | 192 |
|
287
61f92273fb69
implementation of XEP-0355 (Namespace Delegation) to use SàT Pubsub as PEP service, first draft
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
193 if not pubsub.NS_PUBSUB in delegated: |
| 414 | 194 log.msg("Didn't got pubsub delegation from server, can't act as a PEP service") |
| 242 | 195 |
|
291
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
196 def onForward(self, iq): |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
197 """Manage forwarded iq |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
198 |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
199 @param iq(domish.Element): full delegation stanza |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
200 """ |
| 460 | 201 if jid.JID(iq['from']) != self.backend.server_jid: |
| 202 log.err("SECURITY WARNING: forwarded stanza doesn't come from our server: " | |
| 203 f"{iq.toXml()}") | |
|
310
e6a9a3c93314
delegation: fixed bad security check which was rejecting all delegations from external servers:
Goffi <goffi@goffi.org>
parents:
292
diff
changeset
|
204 raise error.StanzaError('not-allowed') |
|
e6a9a3c93314
delegation: fixed bad security check which was rejecting all delegations from external servers:
Goffi <goffi@goffi.org>
parents:
292
diff
changeset
|
205 |
|
291
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
206 try: |
| 414 | 207 delegation_elt = next(iq.elements(DELEGATION_NS, 'delegation')) |
| 208 forwarded_elt = next(delegation_elt.elements(FORWARDED_NS, 'forwarded')) | |
| 209 fwd_iq = next(forwarded_elt.elements('jabber:client', 'iq')) | |
|
291
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
210 except StopIteration: |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
211 raise error.StanzaError('not-acceptable') |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
212 |
|
292
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
213 managed_entity = jid.JID(fwd_iq['from']) |
|
291
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
214 |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
215 self._current_iqs[fwd_iq['id']] = (iq, managed_entity) |
|
292
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
216 fwd_iq.delegated = True |
|
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
217 |
|
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
218 # we need a recipient in pubsub request for PEP |
|
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
219 # so we set "to" attribute if it doesn't exist |
|
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
220 if not fwd_iq.hasAttribute('to'): |
|
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
221 fwd_iq["to"] = jid.JID(fwd_iq["from"]).userhost() |
|
6918a0dad359
delegation: delegated stanza are tracked
Goffi <goffi@goffi.org>
parents:
291
diff
changeset
|
222 |
|
291
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
223 # we now inject the element in the stream |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
224 self.xmlstream.dispatch(fwd_iq) |
|
61fb4817b77f
delegation: iq forwarded management:
Goffi <goffi@goffi.org>
parents:
289
diff
changeset
|
225 |
|
288
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
226 def getDiscoInfo(self, requestor, target, nodeIdentifier=''): |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
227 """Manage disco nesting |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
228 |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
229 This method looks for DiscoHandler in sibling handlers and use it to |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
230 collect main disco infos. It then filters by delegated namespace and return it. |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
231 An identity is added for PEP if pubsub namespace is requested. |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
232 |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
233 The same features/identities are returned for main and bare nodes |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
234 """ |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
235 if not nodeIdentifier.startswith(DELEGATION_NS): |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
236 return [] |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
237 try: |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
238 _, namespace = nodeIdentifier.split(DELEGATION_MAIN_SEP, 1) |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
239 except ValueError: |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
240 try: |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
241 _, namespace = nodeIdentifier.split(DELEGATION_BARE_SEP, 1) |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
242 except ValueError: |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
243 log.msg("Unexpected disco node: {}".format(nodeIdentifier)) |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
244 raise error.StanzaError('not-acceptable') |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
245 |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
246 if not namespace: |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
247 log.msg("No namespace found in node {}".format(nodeIdentifier)) |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
248 return [] |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
249 |
|
334
0a93d71f9503
delegation: use same disco for all pubsub namespaces
Goffi <goffi@goffi.org>
parents:
322
diff
changeset
|
250 if namespace.startswith(pubsub.NS_PUBSUB): |
|
0a93d71f9503
delegation: use same disco for all pubsub namespaces
Goffi <goffi@goffi.org>
parents:
322
diff
changeset
|
251 # pubsub use several namespaces starting with NS_PUBSUB (e.g. http://jabber.org/protocol/pubsub#owner) |
|
0a93d71f9503
delegation: use same disco for all pubsub namespaces
Goffi <goffi@goffi.org>
parents:
322
diff
changeset
|
252 # we return the same disco for all of them |
|
0a93d71f9503
delegation: use same disco for all pubsub namespaces
Goffi <goffi@goffi.org>
parents:
322
diff
changeset
|
253 namespace = pubsub.NS_PUBSUB |
|
0a93d71f9503
delegation: use same disco for all pubsub namespaces
Goffi <goffi@goffi.org>
parents:
322
diff
changeset
|
254 |
|
288
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
255 def gotInfos(infos): |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
256 ns_features = [] |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
257 for info in infos: |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
258 if isinstance(info, disco.DiscoFeature) and info.startswith(namespace): |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
259 ns_features.append(info) |
|
289
f08f8536cab8
mod delegation: extensions management (XEP-0128)
Goffi <goffi@goffi.org>
parents:
288
diff
changeset
|
260 elif (isinstance(info, data_form.Form) and info.formNamespace |
|
f08f8536cab8
mod delegation: extensions management (XEP-0128)
Goffi <goffi@goffi.org>
parents:
288
diff
changeset
|
261 and info.formNamespace.startwith(namespace)): |
|
f08f8536cab8
mod delegation: extensions management (XEP-0128)
Goffi <goffi@goffi.org>
parents:
288
diff
changeset
|
262 # extensions management (XEP-0128) |
|
f08f8536cab8
mod delegation: extensions management (XEP-0128)
Goffi <goffi@goffi.org>
parents:
288
diff
changeset
|
263 ns_features.append(info) |
|
288
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
264 |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
265 if namespace == pubsub.NS_PUBSUB: |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
266 ns_features.append(disco.DiscoIdentity('pubsub', 'pep')) |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
267 |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
268 return ns_features |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
269 |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
270 for handler in self.parent.handlers: |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
271 if isinstance(handler, disco.DiscoHandler): |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
272 break |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
273 |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
274 if not isinstance(handler, disco.DiscoHandler): |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
275 log.err("Can't find DiscoHandler") |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
276 return [] |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
277 |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
278 d = handler.info(requestor, target, '') |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
279 d.addCallback(gotInfos) |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
280 return d |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
281 |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
282 def getDiscoItems(self, requestor, target, nodeIdentifier=''): |
|
073161f6f143
namespace delegation: disco nesting management
Goffi <goffi@goffi.org>
parents:
287
diff
changeset
|
283 return [] |
| 346 | 284 |
| 285 | |
| 286 # we monkeypatch DiscoHandler to add delegation informations | |
| 287 def _onDiscoItems(self, iq): | |
| 288 request = disco._DiscoRequest.fromElement(iq) | |
| 289 # it's really ugly to attach pep data to recipient | |
| 290 # but we don't have many options | |
| 291 request.recipient.pep = iq.delegated | |
| 292 | |
| 293 def toResponse(items): | |
| 294 response = disco.DiscoItems() | |
| 295 response.nodeIdentifier = request.nodeIdentifier | |
| 296 | |
| 297 for item in items: | |
| 298 response.append(item) | |
| 299 | |
| 300 return response.toElement() | |
| 301 | |
| 302 d = self.items(request.sender, request.recipient, | |
| 303 request.nodeIdentifier) | |
| 304 d.addCallback(toResponse) | |
| 305 return d | |
| 306 | |
| 307 | |
| 308 disco.DiscoHandler._onDiscoItems = _onDiscoItems |