|
514
|
1 #summary XEP-0355 (Namespace Delegation) implementation |
|
|
2 #labels Stage-Alpha |
|
|
3 |
|
|
4 = Introduction = |
|
|
5 |
|
|
6 Namespace Delegation is an extension which allows server to delegate some features handling to an entity/component. |
|
|
7 Typical use case is an external PEP service, but it can be used more generally when your prefered server lack one internal feature and you found an external component which can do it. |
|
|
8 |
|
|
9 = Details = |
|
|
10 |
|
|
11 You can have all the details by reading the [http://xmpp.org/extensions/xep-0355.html XEP-0355]. Only the admin mode is implemented so far. |
|
|
12 |
|
|
13 If you use it with a component, you need to patch core/mod_component.lua to fire a new signal. To do it, copy the following patch in a, for example, /tmp/component.patch file: |
|
|
14 {{{ |
|
|
15 diff --git a/plugins/mod_component.lua b/plugins/mod_component.lua |
|
|
16 --- a/plugins/mod_component.lua |
|
|
17 +++ b/plugins/mod_component.lua |
|
|
18 @@ -85,6 +85,7 @@ |
|
|
19 session.type = "component"; |
|
|
20 module:log("info", "External component successfully authenticated"); |
|
|
21 session.send(st.stanza("handshake")); |
|
|
22 + module:fire_event("component-authenticated", { session = session }); |
|
|
23 |
|
|
24 return true; |
|
|
25 end |
|
|
26 }}} |
|
|
27 |
|
|
28 Then, at the root of prosody, enter: |
|
|
29 |
|
|
30 {{{patch -p1 < /tmp/component.patch}}} |
|
|
31 |
|
|
32 = Usage = |
|
|
33 |
|
|
34 To use the module, like usual add *"delegation"* to your modules_enabled. Note that if you use it with a local component, you also need to activate the module in your component section: |
|
|
35 |
|
|
36 {{{ |
|
|
37 modules_enabled = { |
|
|
38 [...] |
|
|
39 |
|
|
40 "delegation"; |
|
|
41 } |
|
|
42 |
|
|
43 [...] |
|
|
44 |
|
|
45 Component "youcomponent.yourdomain.tld" |
|
|
46 component_secret = "yourpassword" |
|
|
47 modules_enabled = {"delegation"} |
|
|
48 }}} |
|
|
49 |
|
|
50 then specify delegated namespaces *in your host section* like that: |
|
|
51 |
|
|
52 {{{ |
|
|
53 VirtualHost "yourdomain.tld" |
|
|
54 |
|
|
55 delegations = { |
|
|
56 ["urn:xmpp:mam:0"] = { |
|
|
57 filtering = {"node"}; |
|
|
58 jid = "pubsub.yourdomain.tld"; |
|
|
59 }, |
|
|
60 ["http://jabber.org/protocol/pubsub"] = { |
|
|
61 jid = "pubsub.yourdomain.tld"; |
|
|
62 }, |
|
|
63 } |
|
|
64 }}} |
|
|
65 |
|
|
66 Here all MAM requests with a "node" attribute (i.e. all MAM pubsub request) will be delegated to pubsub.yourdomain.tld. Similarly, all pubsub request to the host (i.e. the PEP requests) will be delegated to pubsub.yourdomain.tld. |
|
|
67 |
|
|
68 */!\ Be extra careful when you give a delegation to an entity/component, it's a powerful access, only do it if you absoly trust the component/entity, and you know where the software is coming from* |
|
|
69 |
|
|
70 = Configuration = |
|
|
71 The configuration is done with a table which map delegated namespace to namespace data. |
|
|
72 Namespace data MUST have a *jid* (in the form *jid = "delegated@domain.tld"*) and MAY have an additional *filtering* array. If filtering is present, request with attributes in the array will be delegated, other will be treated normally (i.e. by Prosody). |
|
|
73 |
|
|
74 If your are not a developper, the delegated namespace(s)/attribute(s) are most probably specified with the external component/entity you want to use. |
|
|
75 |
|
|
76 = Compatibility = |
|
|
77 ||dev||Need a patched core/mod_component.lua (see above)|| |
|
|
78 ||0.9||Need a patched core/mod_component.lua (see above)|| |
|
|
79 |
|
|
80 = Note = |
|
|
81 This module is often used with mod_privilege (c.f. XEP for more details) |
