Mercurial > sat_docs
annotate xmpp/xep-0355.xml @ 94:eeff161a19e8
docker (base): add dokuwiki module for dokuwiki importer + fixed /etc/hosts for subdomains
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Wed, 24 Feb 2016 20:21:34 +0100 |
| parents | bbb900a768ea |
| children |
| rev | line source |
|---|---|
| 30 | 1 <?xml version='1.0' encoding='UTF-8'?> |
| 2 <!DOCTYPE xep SYSTEM 'xep.dtd' [ | |
| 3 <!ENTITY % ents SYSTEM 'xep.ent'> | |
| 4 %ents; | |
| 5 ]> | |
| 6 <?xml-stylesheet type='text/xsl' href='xep.xsl'?> | |
| 7 <xep> | |
| 8 <header> | |
|
41
21d0d0ab7aa0
xeps: renamed published proto-xeps, and updated them according to published version
Goffi <goffi@goffi.org>
parents:
34
diff
changeset
|
9 <title>Namespace Delegation</title> |
| 30 | 10 <abstract>This specification provides a way for XMPP server to delegate treatments for a namespace to an other entity</abstract> |
|
41
21d0d0ab7aa0
xeps: renamed published proto-xeps, and updated them according to published version
Goffi <goffi@goffi.org>
parents:
34
diff
changeset
|
11 &LEGALNOTICE; |
|
21d0d0ab7aa0
xeps: renamed published proto-xeps, and updated them according to published version
Goffi <goffi@goffi.org>
parents:
34
diff
changeset
|
12 <number>0355</number> |
|
21d0d0ab7aa0
xeps: renamed published proto-xeps, and updated them according to published version
Goffi <goffi@goffi.org>
parents:
34
diff
changeset
|
13 <status>Experimental</status> |
| 30 | 14 <type>Standards Track</type> |
| 15 <sig>Standards</sig> | |
| 16 <approver>Council</approver> | |
| 17 <dependencies> | |
| 18 <spec>XMPP Core</spec> | |
| 19 <spec>XEP-0004</spec> | |
| 20 <spec>XEP-0297</spec> | |
| 21 </dependencies> | |
| 22 <supersedes/> | |
| 23 <supersededby/> | |
| 24 <shortname>NOT_YET_ASSIGNED</shortname> | |
| 25 <author> | |
| 26 <firstname>Jérôme</firstname> | |
| 27 <surname>Poisson</surname> | |
| 28 <email>goffi@goffi.org</email> | |
| 29 <jid>goffi@jabber.fr</jid> | |
| 30 </author> | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
31 |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
32 <revision> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
33 <version>0.2</version> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
34 <date>2014-03-21</date> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
35 <initials>jp</initials> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
36 <remark><p>Several updates according to feedbacks:</p> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
37 <ul> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
38 <li>Added attribute filtering, mainly to manage correctly MAM</li> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
39 <li>Simplification of configuration in admin mode: no more &IQ; negociation</li> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
40 <li>Delegations notifications to the managing entity are now done with a &MESSAGE; stanza</li> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
41 <li>Forwarding now use &xep0297; to avoid server to parse every stanza and a to have a cleaner separation</li> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
42 <li>The behaviour when managing entity is unavailable is specified</li> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
43 <li>Use of namespace in field var for client mode negociation is now mandatory</li> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
44 <li>Behaviour when managing a delegation kept between session in client mode, when managing entity is not available, is specified</li> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
45 <li>Implementation note added for in-order processing issue (thanks to Kurt Zeilenga for pointing this)</li> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
46 <li>Added an note for discovery nesting with attribute filtering</li> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
47 <li>Updated namespace to reflect incompatible changes</li> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
48 </ul> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
49 </remark> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
50 </revision> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
51 |
| 30 | 52 <revision> |
|
41
21d0d0ab7aa0
xeps: renamed published proto-xeps, and updated them according to published version
Goffi <goffi@goffi.org>
parents:
34
diff
changeset
|
53 <version>0.1</version> |
|
21d0d0ab7aa0
xeps: renamed published proto-xeps, and updated them according to published version
Goffi <goffi@goffi.org>
parents:
34
diff
changeset
|
54 <date>2014-12-18</date> |
|
21d0d0ab7aa0
xeps: renamed published proto-xeps, and updated them according to published version
Goffi <goffi@goffi.org>
parents:
34
diff
changeset
|
55 <initials>XEP Editor (mam)</initials> |
|
21d0d0ab7aa0
xeps: renamed published proto-xeps, and updated them according to published version
Goffi <goffi@goffi.org>
parents:
34
diff
changeset
|
56 <remark><p>Initial published version approved by the XMPP Council.</p></remark> |
|
34
db9316a75306
XEP: updated privileged entity according to discussions following the council's veto (see http://mail.jabber.org/pipermail/standards/2014-December/029378.html):
Goffi <goffi@goffi.org>
parents:
33
diff
changeset
|
57 </revision> |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
58 |
|
34
db9316a75306
XEP: updated privileged entity according to discussions following the council's veto (see http://mail.jabber.org/pipermail/standards/2014-December/029378.html):
Goffi <goffi@goffi.org>
parents:
33
diff
changeset
|
59 <revision> |
| 30 | 60 <version>0.0.1</version> |
| 61 <date>2014-11-13</date> | |
| 62 <initials>jp</initials> | |
| 63 <remark><p>First draft.</p></remark> | |
| 64 </revision> | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
65 |
| 30 | 66 </header> |
| 67 <section1 topic='Introduction' anchor='intro'> | |
| 32 | 68 <p>Some XMPP features must be offered by the server itself, or can't be available, that's the case of &xep0163; which is used in several places (e.g. bookmarks storage). But it can be desirable to use an external entity to manage some of these features, because it implements things that the server don't, or because it uses a special implementation useful in a particular case. Some people may also want to decentralize a feature on an entity under their control. This XEP try to solve these cases.<br/>Additionaly, a method to do generic treatments (independent of server) on stanza is also provided.</p> |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
69 <p>This XEP is complementary to &xep0356; (and works in a similar way), although they can be used together or separately.</p> |
| 30 | 70 <p>Here are some use cases of namespace delegation:</p> |
| 71 <ul> | |
| 32 | 72 <li>use an external component for a PEP service because the server doesn't implement it or lacks some features</li> |
| 30 | 73 <li>decentralize a server feature to an entity under client control</li> |
| 32 | 74 <li>make a component which react on new user registration, independent of server implementation</li> |
| 30 | 75 <li>server agnostic roster filtering</li> |
| 76 </ul> | |
| 77 </section1> | |
| 78 <section1 topic='Requirements' anchor='reqs'> | |
| 79 <p>Namespace delegation can be used in two modes:</p> | |
| 80 <ul> | |
| 81 <li><strong>admin</strong> mode, where delegation is specified by the server administrator.</li> | |
| 82 <li><strong>client</strong> mode, where it can be requested by any user.</li> | |
| 83 </ul> | |
| 32 | 84 <p>In <em>admin</em> mode, the managing entity manages stanza of the delegated namespace for all users registered on the server. The namespace delegation MUST be totally transparent for the managed entities.</p> |
| 85 <p>In <em>client</em> mode, a managing entity MUST have an explicit authorization for any namespace he wants to use. Client SHOULD be able to check and revoke granted permissions, and if it's not possible, permissions MUST be revoked after a disconnection.</p> | |
| 30 | 86 </section1> |
| 87 <section1 topic='Glossary' anchor='glossary'> | |
| 88 <ul> | |
| 89 <li><strong>Delegated namespace</strong> — the namespace being managed by an external entity.</li> | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
90 <li><strong>Filtering attribute</strong> — an attribute which must be present in first &IQ; child element to delegate the namespace.</li> |
| 32 | 91 <li><strong>Managing entity</strong> — the entity which actualy manages the delegated namespace.</li> |
| 30 | 92 <li><strong>Managed entity</strong> — an entity which wants to have a namespace of its server delegated to a managing entity.</li> |
| 93 </ul> | |
| 94 </section1> | |
| 95 <section1 topic='Admin Mode Use Cases' anchor='admin_usecases'> | |
| 96 | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
97 <section2 topic='Server Allows Namespaces Delegations' anchor='server_config'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
98 <p>Namespaces delegations are granted in the server configuration. Only &IQ; stanza namespaces can be delegated.</p> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
99 <p>A feature is delegated using:</p> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
100 <ol> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
101 <li>it's namespace: e.g. <em>'urn:xmpp:mam:0'</em></li> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
102 <li>zero or more filtering attribute (attributes which must be present in the initial &IQ; child element): e.g. <em>'node'</em></li> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
103 <li>the jid of the managing entity: e.g. <em>'managing.capulet.lit'</em></li> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
104 </ol> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
105 </section2> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
106 |
| 30 | 107 <section2 topic='Delegation Request Use Case' anchor='admin_perm'> |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
108 <p>Once the managing entity is authenticated and stream is started, the server send it a &MESSAGE; stanza with a <delegation/> elements which MUST have the <strong>'urn:xmpp:delegation:1'</strong> namespace. This element contains <delegated/> elements which MUST contain a 'namespace' attribute indicating the delegated namespace. If there is additional attribute filtering, the <delegated/> can have children <attribute/> elements which MUST contain a 'name' attribute with the name of the filtering attribute.</p> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
109 <example caption='server advertise delegated namespaces'><![CDATA[ |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
110 <message from='capulet.net' to='pubub.capulet.lit' id='12345'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
111 <delegation xmlns='urn:xmpp:delegation:1'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
112 <delegated namespace='urn:xmpp:mam:0'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
113 <attribute name='node' /> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
114 <delegated/> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
115 <delegated namespace='http://jabber.org/protocol/pubsub'/> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
116 </delegation> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
117 </message> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
118 ]]></example> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
119 <p>Here <em>pubsub.capulet.lit</em> will received all stanzas of pubsub namespace sent to <em>capulet.lit</em>. It will also receive MAM stanzas, but only if the 'node' attribute is present in &QUERY;.</p> |
| 30 | 120 </section2> |
| 121 | |
| 32 | 122 <section2 topic='Server Forwards Delegated &IQ; Stanza' anchor='stanza_forward'> |
| 123 <p>When a server receives a stanza for a delegated namespace which is either directed to him (no 'to' attribute, or 'to' attribute with its own JID), or directed to the bare JID of the sender (e.g. if 'from' attribute is "<em>juliet@capulet.lit/balcony</em>" and 'to' attribute is "<em>juliet@capulet.lit</em>"), it MUST forward it to the managing entity by replacing the 'to' attribute with the JID of the managing entity:</p> | |
| 124 <example caption='Juliet sends her mood to her server via PEP'><![CDATA[ | |
| 30 | 125 <iq from='juliet@capulet.lit/balcony' |
| 126 id='pep1' | |
| 127 type='set'> | |
| 128 <pubsub xmlns='http://jabber.org/protocol/pubsub'> | |
| 129 <publish node='http://jabber.org/protocol/mood'> | |
| 130 <item> | |
| 131 <mood xmlns='http://jabber.org/protocol/mood'> | |
| 132 <annoyed/> | |
| 133 <text>curse my nurse!</text> | |
| 134 </mood> | |
| 135 </item> | |
| 136 </publish> | |
| 137 </pubsub> | |
| 138 </iq> | |
| 139 ]]></example> | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
140 <p>The server gets this stanza, sees that this namespace is delegated to <em>pubsub.capulet.lit</em>, so it forwards it.</p> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
141 <p>To forward, an &IQ; stanza of type "set" is used which contain a <delegation/> element (with namespace<em>'urn:xmpp:delegation:1'</em>) which in turn contain a <forwarded/> element encapsulating the initial stanza, according to &xep0297;:</p> |
| 30 | 142 |
| 32 | 143 <example caption='server delegate the stanza to pubsub.capulet.lit'><![CDATA[ |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
144 <iq from='capulet.lit' |
| 30 | 145 to='pubsub.capulet.lit' |
| 146 id='delegate1' | |
| 147 type='set'> | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
148 <delegation xmlns='urn:xmpp:delegation:1'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
149 <forwarded xmlns='urn:xmpp:forward:0'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
150 <iq from='juliet@capulet.lit/balcony' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
151 id='pep1' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
152 type='set'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
153 <pubsub xmlns='http://jabber.org/protocol/pubsub'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
154 <publish node='http://jabber.org/protocol/mood'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
155 <item> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
156 <mood xmlns='http://jabber.org/protocol/mood'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
157 <annoyed/> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
158 <text>curse my nurse!</text> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
159 </mood> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
160 </item> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
161 </publish> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
162 </pubsub> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
163 </iq> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
164 </forwarded> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
165 </delegation> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
166 </iq> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
167 ]]></example> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
168 <p>The managing entity replies to the stanza by encapsulating its &IQ; result in the same way:</p> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
169 <example caption='pubsub.capulet.lit replies badly to juliet'><![CDATA[ |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
170 <iq from='pubsub.capulet.lit' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
171 to='capulet.lit' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
172 id='delegate1' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
173 type='result'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
174 <delegation xmlns='urn:xmpp:delegation:1'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
175 <forwarded xmlns='urn:xmpp:forward:0'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
176 <iq to='juliet@capulet.lit/balcony' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
177 id='pep1' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
178 type='result'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
179 <pubsub xmlns='http://jabber.org/protocol/pubsub' /> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
180 </iq> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
181 </forwarded> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
182 </delegation> |
| 30 | 183 </iq> |
| 184 ]]></example> | |
| 185 | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
186 <p>Then the server MUST decapsulate the &IQ; result, MUST insure that the 'to' and the 'from' attribute corresponds to respectively the 'from' and the 'to' attributes of the initial stanza, MUST insure that the 'id' attribute of the decapsulated stanza is the same as the initial 'id' attribute and that 'type' is "result". If everything is alright, it can send the decapsulated stanza to Juliet.</p> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
187 <p>If the forwarded result from managing entity is bad (i.e. wrong 'to', 'from', 'id' or 'result' attributes), the server MUST send an &IQ; error with condition <service-unavailable/> to managed entity, and MAY close the connexion with managing entity.</p> |
| 30 | 188 |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
189 <example caption='capulet.lit replies to Juliet'><![CDATA[ |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
190 <iq to='juliet@capulet.lit/balcony' |
| 30 | 191 id='pep1' |
| 192 type='result'> | |
| 193 <pubsub xmlns='http://jabber.org/protocol/pubsub' /> | |
| 194 </iq> | |
| 195 ]]></example> | |
| 196 | |
| 32 | 197 <p>The workflow is fully transparent for Juliet.</p> |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
198 <p><strong>N.B.₁:</strong> If the server encounter a delegated namespace and the managing entity is not available, it MUST return an &IQ; stanza of type "error" with an error condition of <service-unavailable/></p> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
199 <p><strong>N.B.₂:</strong> If the server encounter a delegated namespace but the filtering attribute does not match, it MUST follow its normal behaviour, i.e. it must follow the same behaviour it would have had if the namespace was not delegated at all</p> |
| 30 | 200 <section3 topic='Stanzas from managing entity' anchor='managing_entity_stanzas'> |
| 32 | 201 <p>If a stanza is sent by the managing entity on a managed namespace, the server MUST NOT forward it. This way, the managing entity can use privileged entity to do special treatments.</p> |
| 202 <p>In the following examples, <em>juliet@capulet.lit</em> has its "<em>jabber:iq:roster</em>" namespace delegated to <em>filter.capulet.lit</em>. <em>filter.capulet.lit</em> is a server agnostic component which filters allowed entities (which can be added to a roster), and sort them in enforced groups.</p> | |
| 30 | 203 |
| 32 | 204 <example caption='Juliet adds Romeo to her roster'><![CDATA[ |
| 30 | 205 <iq from='juliet@capulet.lit/balcony' |
| 206 id='roster1' | |
| 207 type='set'> | |
| 208 <query xmlns='jabber:iq:roster'> | |
| 209 <item jid='romeo@montaigu.lit' | |
| 210 name='My Romeo'> | |
| 211 </item> | |
| 212 </query> | |
| 213 </iq> | |
| 214 ]]></example> | |
| 215 | |
| 32 | 216 <example caption='server forwards stanza to managing entity'><![CDATA[ |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
217 <iq from='capulet.lit' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
218 to='pubsub.capulet.lit' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
219 id='delegate1' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
220 type='set'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
221 <delegation xmlns='urn:xmpp:delegation:1'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
222 <forwarded xmlns='urn:xmpp:forward:0'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
223 <iq from='juliet@capulet.lit/balcony' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
224 id='roster1' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
225 type='set'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
226 <query xmlns='jabber:iq:roster'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
227 <item jid='romeo@montaigu.lit' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
228 name='My Romeo'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
229 </item> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
230 </query> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
231 </iq> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
232 </forwarded> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
233 </delegation> |
| 30 | 234 </iq> |
| 235 ]]></example> | |
| 236 | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
237 <p><em>filter.capulet.lit</em> accepts to add Romeo, but all JIDs with a <em>montaigu.lit</em> must be in a "Rivals" group, so it first returns a success result (Romeo is accepted).</p> |
| 30 | 238 <example caption='filtering component accept Romeo'><![CDATA[ |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
239 <iq from='pubsub.capulet.lit' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
240 to='capulet.lit' |
| 30 | 241 id='delegate1' |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
242 type='result'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
243 <delegation xmlns='urn:xmpp:delegation:1'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
244 <forwarded xmlns='urn:xmpp:forward:0'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
245 <iq to='juliet@capulet.lit/balcony' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
246 id='roster1' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
247 type='result' /> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
248 </forwarded> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
249 </delegation> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
250 </iq> |
| 30 | 251 ]]></example> |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
252 <example caption='server decapsulate and send the result with the initial id'><![CDATA[ |
| 30 | 253 <iq to='juliet@capulet.lit/balcony' |
| 254 id='roster1' | |
| 255 type='result' /> | |
| 256 ]]></example> | |
| 257 | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
258 <p>At this stade, the entity is accepted, but not added to the roster. <em>filter.capulet.lit</em> is also a privileged entity which can manage "<em>jabber:iq:roster</em>", so it uses this ability to add Romeo in the enforced group:</p> |
| 32 | 259 <example caption='filter.capulet.lit uses privileged entity to add Romeo'><![CDATA[ |
| 30 | 260 <iq to='juliet@capulet.lit' |
| 261 from='filter.capulet.lit' | |
| 262 id='roster2' | |
| 263 type='set'> | |
| 264 <query xmlns='jabber:iq:roster'> | |
| 265 <item jid='romeo@montaigu.lit' | |
| 266 name='My Romeo'> | |
| 267 <group>Rivals</group> | |
| 268 </item> | |
| 269 </query> | |
| 270 </iq> | |
| 271 ]]></example> | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
272 <p>The namespace is delegated, but as the stanza is from the managing entity, the server manages it normally. The entity is also privileged, so it can change the stanza of Juliet, the server accepts:</p> |
| 30 | 273 |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
274 <example caption='server accept new entity in roster'><![CDATA[ |
| 30 | 275 <iq to='filter.capulet.lit' |
| 276 from='juliet@capulet.lit' | |
| 277 id='roster2' | |
| 278 type='result'/> | |
| 279 ]]></example> | |
| 280 | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
281 <p>The server will then send the roster pushes (with the enforced group) normally.</p> |
| 30 | 282 |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
283 </section3> |
| 30 | 284 |
| 285 </section2> | |
| 286 | |
| 287 | |
| 288 </section1> | |
| 289 | |
| 290 <section1 topic='Client Mode Use Cases' anchor='client_usecases'> | |
| 291 <section2 topic='Client Delegation Request Use Case' anchor='client_delegation'> | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
292 <p>In <em>client</em> mode, the managing entity is not certified by the server administrator, so the delegation MUST be <strong>explicitly</strong> allowed by the managed entity. This is initiated by the managing entity (it can be after an interaction with a managed entity, like a subscription).</p> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
293 <p>To request delegation for a particular entity, the managing entity MUST have an &IQ; stanza with <em>'urn:xmpp:delegation:1'</em> namespace. The &QUERY; element MUST have a 'to' attribute which specify the entity it wants to manage.</p> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
294 <p>Namespace delegations are asked with a <delegate/> element, which MUST contain a 'namespace' attribute set to the requested namespace.</p> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
295 |
| 32 | 296 <p>If an entity want to manage PEP service for Juliet, it can ask the delegation like this: |
| 30 | 297 </p> |
| 298 <example caption='managing entity asks for namespace delegation for one particular entity'><![CDATA[ | |
| 299 <iq from='pubsub.montaigu.lit' to='capulet.lit' type='get' id='delegation1'> | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
300 <query xmlns='urn:xmpp:delegation:1' |
| 30 | 301 to='juliet@capulet.lit'> |
| 302 <delegate namespace='http://jabber.org/protocol/pubsub'/> | |
| 303 </query> | |
| 304 </iq> | |
| 305 ]]></example> | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
306 <p>Once received the delegation request, the server ask to the client if it grants access to the requested namespace using &xep0004;. The server use a challenge which it MUST have generated itself. |
| 30 | 307 </p> |
| 308 <example caption='server asks user for the namespace delegation'><![CDATA[ | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
309 <message from='capulet.lit' to='juliet@capulet.lit/balcony'> |
| 30 | 310 <body> |
| 311 pubsub.montaigu.lit wants to manage a feature normally managed by the server. | |
| 32 | 312 Do you allow it to manage the following features? |
| 30 | 313 |
| 32 | 314 Be careful! According management to an entity is a serious thing, |
| 30 | 315 think twice that you can trust the entity before doing this. |
| 316 </body> | |
| 317 <x xmlns='jabber:x:data' type='form'> | |
| 318 <title>Delegation request</title> | |
| 319 <instructions>pubsub.montaigu.lit wants to manage the following features: | |
| 320 Do you allow it?</instructions> | |
| 321 <field type='hidden' var='challenge'><value>5439123</value></field> | |
| 322 <field type='hidden' var='FORM_TYPE'> | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
323 <value>urn:xmpp:delegation:1</value> |
| 30 | 324 </field> |
| 325 <field type='list-single' | |
| 326 label='Manage PubSub (http://jabber.org/protocol/pubsub)' | |
| 327 var='http://jabber.org/protocol/pubsub'> | |
| 328 <value>0</value> | |
| 329 <option label='No'><value>0</value></option> | |
| 330 <option label='Yes'><value>1</value></option> | |
| 331 </field> | |
| 332 </x> | |
| 333 </message> | |
| 334 ]]></example> | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
335 <p>The server SHOULD include a warning message, SHOULD translate the namespace to human friendly names (and MAY keep the original namespace in addition) and MUST set the default value to '<strong>0</strong>' (permission refused). The server MUST use namespaces as field var, so a client can use them to have a customized display.</p> |
| 30 | 336 <p>The client can then answer to the form:</p> |
| 337 <example caption='client answer to the form'><![CDATA[ | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
338 <message from='juliet@capulet.lit/balcony' to='capulet.lit'> |
| 30 | 339 <x xmlns='jabber:x:data' type='submit'> |
| 340 <field var='FORM_TYPE'> | |
| 341 <value></value> | |
| 342 </field> | |
| 343 <field var='challenge'><value>5439123</value></field> | |
| 344 <field var='http://jabber.org/protocol/pubsub'><value>1</value></field> | |
| 345 </x> | |
| 346 </message> | |
| 347 ]]></example> | |
| 32 | 348 <p>Here Juliet allows <em>pubsub.montaigu.lit</em> to manage the PubSub (and then PEP) service.</p> |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
349 |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
350 |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
351 <p>Finaly, the server notifies the entity of the granted delegation. It do this in the same way as for <link url='#admin_perm'>admin mode</link>, except that the <delegation/> element has an attitional 'to' attribute set to the managed entity bare jid:</p> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
352 <example caption='server advertise delegated namespaces for juliet'><![CDATA[ |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
353 <message from='capulet.net' to='pubub.capulet.lit' id='6789'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
354 <delegation xmlns='urn:xmpp:delegation:1' to='juliet@capulet.lit'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
355 <delegated namespace='http://jabber.org/protocol/pubsub'/> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
356 </delegation> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
357 </message> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
358 ]]></example> |
| 30 | 359 <p>The managing entity can now manage the namespace the same way as in <link url='#stanza_forward'>admin mode</link>.</p> |
| 360 </section2> | |
| 361 | |
| 362 </section1> | |
| 363 | |
| 364 <section1 topic='Configuration' anchor='configuration'> | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
365 <p>Server SHOULD provide a way for clients to check already delegated namespaces, and revoke them by using &xep0050; on the well-defined command node <strong>'urn:xmpp:delegation:1#configure'</strong>.</p> |
| 32 | 366 <p>If present, the configuration commands MUST allow at least to check delegations granted to a managing entity, and to revoke them. A server MAY offer an option to keep delegations from one session to an other (see <link url='#rules'>business rules</link>).</p> |
| 30 | 367 </section1> |
| 368 | |
| 369 <section1 topic='Discovering Support' anchor='disco'> | |
| 370 <section2 topic='Announce' anchor='disco_announce'> | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
371 <p>If a server or an entity supports the namespace delegation protocol, it MUST report that fact by including a service discovery feature of "<em>urn:xmpp:delegation:1</em>" in response to a &xep0030; information request:</p> |
| 30 | 372 <example caption="service discovery information request"><![CDATA[ |
| 373 <iq from='pubsub.capulet.lit' | |
| 374 id='disco1' | |
| 375 to='capulet.lit' | |
| 376 type='get'> | |
| 377 <query xmlns='http://jabber.org/protocol/disco#info'/> | |
| 378 </iq> | |
| 379 ]]></example> | |
| 380 <example caption="service discovery information response"><![CDATA[ | |
| 381 <iq from='capulet.lit' | |
| 382 id='disco1' | |
| 383 to='pubsub.capulet.lit' | |
| 384 type='result'> | |
| 385 <query xmlns='http://jabber.org/protocol/disco#info'> | |
| 386 ... | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
387 <feature var='urn:xmpp:delegation:1'/> |
| 30 | 388 ... |
| 389 </query> | |
| 390 </iq> | |
| 391 ]]></example> | |
| 392 </section2> | |
| 393 <section2 topic='Nesting' anchor='disco_nesting'> | |
| 394 <section3 topic='General Case'> | |
| 32 | 395 <p>When a server delegates a namespace to a managing entity, the later can have particular features which must be advertised by the former with disco protocol.</p> |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
396 <p>This is done by using a disco node, which is done the following way: if pubsub.capulet.int manages pubsub namespace, it MUST report that fact in discovery feature, and have a '<strong>urn:xmpp:delegation:1::http://jabber.org/protocol/pubsub</strong>' node which reports the managed features.</p><p>The node name is obtained by concatenating this XEP namespace (<strong>urn:xmpp:delegation:1</strong>), a '<strong>::</strong>' separator, and the delegated namespace (here <strong>http://jabber.org/protocol/pubsub</strong>).<br/>The server MUST advertise the result in its own discovery answer, and MUST ignore features of its internal component (here internal PubSub service).</p> |
| 32 | 397 <p>In the following example, the capulet.int server delegates its internal PEP component to pubsub.capulet.int. capulet.int only supports REQUIRED PubSub features and auto-create, while pubsub.capulet.int supports REQUIRED PubSub features and publish-options, but not auto-create. <br/>juliet@capulet.int asks its server what it is capable of, she is specially interested in PubSub capabilities.</p> |
| 398 <example caption="Juliet asks her server its available features"><![CDATA[ | |
| 30 | 399 <iq from='juliet@capulet.lit/balcony' |
| 400 id='disco1' | |
| 401 to='capulet.lit' | |
| 402 type='get'> | |
| 403 <query xmlns='http://jabber.org/protocol/disco#info'/> | |
| 404 </iq> | |
| 405 ]]> | |
| 406 </example> | |
| 32 | 407 <p>Server delegates its PubSub namespace to <em>pubsub.capulet.lit</em>, so it asks its available features for this namespace like this:</p> |
| 408 <example caption="capulet.lit requests disco infos for pubsub namespace to pubsub.capulet.lit"><![CDATA[ | |
| 30 | 409 <iq from='capulet.lit' |
| 410 id='disco2' | |
| 411 to='pubsub.capulet.lit' | |
| 412 type='get'> | |
| 413 <query xmlns='http://jabber.org/protocol/disco#info' | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
414 node='urn:xmpp:delegation:1::http://jabber.org/protocol/pubsub'/> |
| 30 | 415 </iq> |
| 416 ]]> | |
| 417 </example> | |
| 418 <p>Note that in real situation, server has probably this information already in cache (see <link url='#impl'>Implementation Notes</link>).<br/> | |
| 32 | 419 <em>pubsub.capulet.lit</em> returns its available features:</p> |
| 30 | 420 <example caption="pubsub.capulet.lit returns features to nest"><![CDATA[ |
| 421 <iq from='pubsub.capulet.lit' | |
| 422 id='disco2' | |
| 423 to='capulet.lit' | |
| 424 type='result'> | |
| 425 <query xmlns='http://jabber.org/protocol/disco#info' | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
426 node='urn:xmpp:delegation:1::http://jabber.org/protocol/pubsub'> |
| 30 | 427 <feature var='http://jabber.org/protocol/pubsub'/> |
| 428 <feature var='http://jabber.org/protocol/pubsub#publish'/> | |
| 429 <feature var='http://jabber.org/protocol/pubsub#subscribe'/> | |
| 430 <feature var='http://jabber.org/protocol/pubsub#publish-options'/> | |
| 431 </query> | |
| 432 </iq> | |
| 433 ]]> | |
| 434 </example> | |
| 435 <p>Server include the results in its own discovery info results:</p> | |
| 436 <example caption="capulet.lit return disco info including features from pubsub.capulet.lit"><![CDATA[ | |
| 437 <iq from='capulet.lit' | |
| 438 id='disco1' | |
| 439 to='juliet@capulet.lit/balcony' | |
| 440 type='result'> | |
| 441 <query xmlns='http://jabber.org/protocol/disco#info' | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
442 node='urn:xmpp:delegation:1::http://jabber.org/protocol/pubsub'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
443 <feature var='urn:xmpp:delegation:1'/> |
| 30 | 444 ... |
| 445 <feature var='http://jabber.org/protocol/pubsub'/> | |
| 446 <feature var='http://jabber.org/protocol/pubsub#publish'/> | |
| 447 <feature var='http://jabber.org/protocol/pubsub#subscribe'/> | |
| 448 <feature var='http://jabber.org/protocol/pubsub#publish-options'/> | |
| 449 ... | |
| 450 </query> | |
| 451 </iq> | |
| 452 ]]> | |
| 453 </example> | |
| 454 <p>Note that '<em>http://jabber.org/protocol/pubsub#auto-create</em>' is not available.</p> | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
455 <p><strong>N.B.:</strong> In the special case of attribute filtering, the server still display managing entity's features for the whole delegated namespace instead of its own internal ones.</p> |
| 30 | 456 </section3> |
| 32 | 457 <section3 topic='Rediction Of Bare JID Disco Info'> |
| 458 <p>As an entity may ask for discovery information on bare JID, which the server would answer, the managing entity must be able to send this kind of information.</p> | |
| 30 | 459 <p>To do so, the mechanism is the same as for server features, but the separator is '<strong>:bare:</strong>' instead of '<strong>::</strong>':</p> |
| 460 | |
| 32 | 461 <example caption="Juliet asks features for its own bare JID"><![CDATA[ |
| 30 | 462 <iq from='juliet@capulet.lit/balcony' |
| 463 id='disco3' | |
| 464 to='juliet@capulet.lit' | |
| 465 type='get'> | |
| 466 <query xmlns='http://jabber.org/protocol/disco#info'/> | |
| 467 </iq> | |
| 468 ]]> | |
| 469 </example> | |
| 32 | 470 <p>Server delegate its PubSub namespace to <em>pubsub.capulet.lit</em>, so it ask its available features for this namespace like this:</p> |
| 471 <example caption="capulet.lit requests disco infos for pubsub namespace to pubsub.capulet.lit"><![CDATA[ | |
| 30 | 472 <iq from='capulet.lit' |
| 473 id='disco4' | |
| 474 to='pubsub.capulet.lit' | |
| 475 type='get'> | |
| 476 <query xmlns='http://jabber.org/protocol/disco#info' | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
477 node='urn:xmpp:delegation:1:bare:http://jabber.org/protocol/pubsub'/> |
| 30 | 478 </iq> |
| 479 ]]> | |
| 480 </example> | |
| 481 <p>As for general case, server has probably <link url='#impl'>this information already in cache</link>.<br/> | |
| 32 | 482 <em>pubsub.capulet.lit</em> returns its available features:</p> |
| 30 | 483 <example caption="pubsub.capulet.lit returns features to nest"><![CDATA[ |
| 484 <iq from='pubsub.capulet.lit' | |
| 485 id='disco4' | |
| 486 to='capulet.lit' | |
| 487 type='result'> | |
| 488 <query xmlns='http://jabber.org/protocol/disco#info' | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
489 node='urn:xmpp:delegation:1:bare:http://jabber.org/protocol/pubsub'> |
| 30 | 490 <identity category='pubsub' type='pep'/> |
| 491 <feature var='http://jabber.org/protocol/pubsub#access-presence'/> | |
| 492 <feature var='http://jabber.org/protocol/pubsub#auto-create'/> | |
| 493 <feature var='http://jabber.org/protocol/pubsub#auto-subscribe'/> | |
| 494 <feature var='http://jabber.org/protocol/pubsub#config-node'/> | |
| 495 <feature var='http://jabber.org/protocol/pubsub#create-and-configure'/> | |
| 496 <feature var='http://jabber.org/protocol/pubsub#create-nodes'/> | |
| 497 <feature var='http://jabber.org/protocol/pubsub#filtered-notifications'/> | |
| 498 <feature var='http://jabber.org/protocol/pubsub#persistent-items'/> | |
| 499 <feature var='http://jabber.org/protocol/pubsub#publish'/> | |
| 500 <feature var='http://jabber.org/protocol/pubsub#retrieve-items'/> | |
| 501 <feature var='http://jabber.org/protocol/pubsub#subscribe'/> | |
| 502 ... | |
| 503 </query> | |
| 504 </iq> | |
| 505 ]]> | |
| 506 </example> | |
| 32 | 507 <p>Then the server returns the answer to Juliet, as in general case, with requested bare JID in 'from' field.</p> |
| 508 <example caption="capulet.lit returns disco info to Juliet"><![CDATA[ | |
| 30 | 509 <iq from='juliet@capulet.lit' |
| 510 id='disco3' | |
| 511 to='juliet@capulet.lit/balcony' | |
| 512 type='result'> | |
| 513 <query xmlns='http://jabber.org/protocol/disco#info'> | |
| 514 <identity category='account' type='registered'/> | |
| 515 <identity category='pubsub' type='pep'/> | |
| 516 <feature var='http://jabber.org/protocol/pubsub#access-presence'/> | |
| 517 <feature var='http://jabber.org/protocol/pubsub#auto-create'/> | |
| 518 <feature var='http://jabber.org/protocol/pubsub#auto-subscribe'/> | |
| 519 <feature var='http://jabber.org/protocol/pubsub#config-node'/> | |
| 520 <feature var='http://jabber.org/protocol/pubsub#create-and-configure'/> | |
| 521 <feature var='http://jabber.org/protocol/pubsub#create-nodes'/> | |
| 522 <feature var='http://jabber.org/protocol/pubsub#filtered-notifications'/> | |
| 523 <feature var='http://jabber.org/protocol/pubsub#persistent-items'/> | |
| 524 <feature var='http://jabber.org/protocol/pubsub#publish'/> | |
| 525 <feature var='http://jabber.org/protocol/pubsub#retrieve-items'/> | |
| 526 <feature var='http://jabber.org/protocol/pubsub#subscribe'/> | |
| 527 ... | |
| 528 </query> | |
| 529 </iq> | |
| 530 ]]> | |
| 531 </example> | |
| 532 | |
| 533 </section3> | |
| 534 </section2> | |
| 535 </section1> | |
| 536 | |
| 537 <section1 topic='Business Rules' anchor='rules'> | |
| 538 <ol> | |
| 32 | 539 <li>In client mode, server MAY keep delegations granted to an entity by a client from one session to an other, but if it does so, it MUST provide configuration like explained in the <link url='#configuration'>suitable section</link>. If server offers this feature, it SHOULD add a field directly in configuration commands.</li> |
| 30 | 540 <li>If a client can't check or revoke delegations (i.e. it doesn't support &xep0050;) when granting them, the server MUST NOT keep granted delegations from one session to an other, and delegations will be asked on each new session.</li> |
| 32 | 541 <li>If delegations are changed during a session, server MUST notify managing entity of the new delegations, like in <link url='#client_delegation'>client delegation request use case</link>.</li> |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
542 <li>If delegations are kept between sessions in client mode, and the managing entity is not available, the server MUST return an &IQ; error with condition <service-unavailable/> when a delegated namespace is requested, like explained in <link url='#stanza_forward'>"Server Forwards Delegated &IQ; Stanza" section</link>.</li> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
543 <li>The namespace of this XEP (<strong>urn:xmpp:delegation:1</strong>) MUST NOT be delegated. If an entity requests it, the server MUST return a &forbidden; error.</li> |
| 30 | 544 </ol> |
| 545 </section1> | |
| 546 <section1 topic='Implementation Notes' anchor='impl'> | |
| 547 <ol> | |
| 548 <li>As admin mode is far more easy to implement than client mode, and client mode may impact performances, a server MAY choose to only implement the former.</li> | |
| 549 <li>Because of the performance impact, a server SHOULD ask for <link url='#disco_nesting'>disco features to nest</link> to managing entity when delegation is accepted, and keep them in cache.</li> | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
550 <li>&rfc6120; section 10.1 require in-order processing of stanzas, which may be problematic for this extension: either the server blocks the traffic until the managing entity answer - which can lead to severe performance impact -, or the server doesn't block and may loose order. The recommended way is to not block the traffic while waiting for managing entity answer to avoid performance issues. A future version of this XEP may include an attribute to request traffic blocking. In admin mode the server implementation MAY chooses to have a blocking option (which SHOULD be per namespace, not global). |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
551 </li> |
| 30 | 552 </ol> |
| 553 </section1> | |
| 554 <section1 topic='Security Considerations' anchor='security'> | |
| 555 <ol> | |
| 556 <li>Managing entity can manage sensitive data, <em>admin</em> delegation should be granted carefuly, only if you absolutely trust the entity.</li> | |
| 32 | 557 <li>A server MAY choose to filter allowed namespaces. In this case, it MUST always set the allowed type of filtered namespaces to <strong>0</strong>.</li> |
| 30 | 558 |
| 32 | 559 <li>In case of filtering, a whitelist system is more secure and SHOULD be prefered to a blacklist (idealy, configuration would allow no filtering, whitelist filtering and blacklist filtering).</li> |
| 30 | 560 </ol> |
| 561 </section1> | |
| 562 <section1 topic='IANA Considerations' anchor='iana'> | |
| 563 <p>This document requires no interaction with &IANA;.</p> | |
| 564 </section1> | |
| 565 <section1 topic='XMPP Registrar Considerations' anchor='registrar'> | |
| 566 <section2 topic='Protocol Namespaces' anchor='ns'> | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
567 <p>The ®ISTRAR; includes 'urn:xmpp:delegation:1' in its registry of protocol namespaces (see &NAMESPACES;).</p> |
| 30 | 568 <ul> |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
569 <li>urn:xmpp:delegation:1</li> |
| 30 | 570 </ul> |
| 571 </section2> | |
| 572 <section2 topic='Protocol Versioning' anchor='registrar-versioning'> | |
| 573 &NSVER; | |
| 574 </section2> | |
| 575 </section1> | |
| 576 <section1 topic='XML Schema' anchor='schema'> | |
| 577 <code><![CDATA[ | |
| 578 <?xml version='1.0' encoding='UTF-8'?> | |
| 579 | |
| 580 <xs:schema | |
| 581 xmlns:xs='http://www.w3.org/2001/XMLSchema' | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
582 targetNamespace='urn:xmpp:delegation:1' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
583 xmlns='urn:xmpp:delegation:1' |
| 30 | 584 elementFormDefault='qualified'> |
| 585 | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
586 <xs:import namespace='urn:xmpp:forward:0' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
587 schemaLocation='http://xmpp.org/schemas/forward.xsd'/> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
588 |
| 30 | 589 <xs:element name='query'> |
| 590 <xs:complexType> | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
591 <xs:attribute name='to' use='required' type='xs:string'/> |
|
41
21d0d0ab7aa0
xeps: renamed published proto-xeps, and updated them according to published version
Goffi <goffi@goffi.org>
parents:
34
diff
changeset
|
592 </xs:attribute> |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
593 <xs:element name='delegate' |
| 30 | 594 maxOccurs='unbounded'> |
| 595 <xs:complexType> | |
| 596 <xs:attribute name='namespace' use='required' type='xs:string'/> | |
| 597 </xs:complexType> | |
| 598 </xs:element> | |
| 599 </xs:complexType> | |
| 600 </xs:element> | |
| 601 | |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
602 <xs:element name='delegation'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
603 <xs:complexType> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
604 <xs:element ref='urn:xmpp:forward:0' minOccurs='0' maxOccurs='1' /> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
605 <xs:element name='delegated' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
606 minOccurs='0' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
607 maxOccurs='unbounded'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
608 <xs:complexType> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
609 <xs:attribute name='namespace' use='required' type='xs:string'/> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
610 <xs:element name='attribute' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
611 minOccurs='0' |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
612 maxOccurs='unbounded'> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
613 <xs:complexType> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
614 <xs:attribute name='name' use='required' type='xs:string'/> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
615 </xs:complexType> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
616 </xs:element> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
617 </xs:complexType> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
618 </xs:element> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
619 </xs:complexType> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
620 </xs:element> |
|
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
621 |
| 30 | 622 </xs:schema> |
| 623 ]]></code> | |
| 624 </section1> | |
| 625 <section1 topic='Acknowledgements' anchor='acks'> | |
|
41
21d0d0ab7aa0
xeps: renamed published proto-xeps, and updated them according to published version
Goffi <goffi@goffi.org>
parents:
34
diff
changeset
|
626 <p>This XEP is linked with &xep0356; and works in a similar way.</p> |
| 30 | 627 <p>The client mode delegation mechanism is inspired from &xep0321; permission request.</p> |
|
33
b70084aa0af7
xeps: added thanks to souliane for his corrections
Goffi <goffi@goffi.org>
parents:
32
diff
changeset
|
628 <p>Thanks to Adrien Cossa for his typos/style corrections</p> |
|
42
bbb900a768ea
xeps: updated xep-0355 (namespace delegation):
Goffi <goffi@goffi.org>
parents:
41
diff
changeset
|
629 <p>Thanks to Philipp Hancke, Dave Cridland, Kurt Zeilenga and Sergey Dobrov for their feedbacks.</p> |
| 30 | 630 </section1> |
| 631 </xep> |