mirror of
https://github.com/moparisthebest/xeps
synced 2024-11-26 19:22:15 -05:00
684 lines
37 KiB
XML
684 lines
37 KiB
XML
<?xml version='1.0' encoding='UTF-8'?>
|
|
<!DOCTYPE xep SYSTEM 'xep.dtd' [
|
|
<!ENTITY % ents SYSTEM 'xep.ent'>
|
|
%ents;
|
|
]>
|
|
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
|
|
<xep>
|
|
<header>
|
|
<title>Namespace Delegation</title>
|
|
<abstract>This specification provides a way for XMPP server to delegate treatments for a namespace to an other entity</abstract>
|
|
&LEGALNOTICE;
|
|
<number>0355</number>
|
|
<status>Deferred</status>
|
|
<type>Standards Track</type>
|
|
<sig>Standards</sig>
|
|
<approver>Council</approver>
|
|
<dependencies>
|
|
<spec>XMPP Core</spec>
|
|
<spec>XEP-0004</spec>
|
|
<spec>XEP-0297</spec>
|
|
</dependencies>
|
|
<supersedes/>
|
|
<supersededby/>
|
|
<shortname>NOT_YET_ASSIGNED</shortname>
|
|
<author>
|
|
<firstname>Jérôme</firstname>
|
|
<surname>Poisson</surname>
|
|
<email>goffi@goffi.org</email>
|
|
<jid>goffi@jabber.fr</jid>
|
|
</author>
|
|
<revision>
|
|
<version>0.4.1</version>
|
|
<date>2018-11-03</date>
|
|
<initials>pep</initials>
|
|
<remark>Fix a bunch of typos, batch-style.</remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.4</version>
|
|
<date>2017-09-11</date>
|
|
<initials>XEP Editor (jwi)</initials>
|
|
<remark>Defer due to lack of activity.</remark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<version>0.3</version>
|
|
<date>2016-08-01</date>
|
|
<initials>jp</initials>
|
|
<remark>
|
|
<ul>
|
|
<li>added "Delegating server" in glossary</li>
|
|
<li>fixed <link url='#stanza_forward'>server forwarding</link> conditions</li>
|
|
<li>fixed missing 'jabber:client' namespaces</li>
|
|
<li><service-unavailable/> on managing entity &IQ; error</li>
|
|
<li>forwarding in client mode is now specified</li>
|
|
<li>removed wrong 'node' attribute in disco nesting example</li>
|
|
<li>disco extension explicitly need to be handled</li>
|
|
<li>minor typos/explanation improvments</li>
|
|
</ul>
|
|
</remark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<version>0.2.1</version>
|
|
<date>2015-10-15</date>
|
|
<initials>XEP Editor (mam)</initials>
|
|
<remark><p>Corrected examples (Stefan Strigler).</p></remark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<version>0.2</version>
|
|
<date>2014-03-21</date>
|
|
<initials>jp</initials>
|
|
<remark><p>Several updates according to feedbacks:</p>
|
|
<ul>
|
|
<li>Added attribute filtering, mainly to manage correctly MAM</li>
|
|
<li>Simplification of configuration in admin mode: no more &IQ; negociation</li>
|
|
<li>Delegations notifications to the managing entity are now done with a &MESSAGE; stanza</li>
|
|
<li>Forwarding now use &xep0297; to avoid server to parse every stanza and a to have a cleaner separation</li>
|
|
<li>The behaviour when managing entity is unavailable is specified</li>
|
|
<li>Use of namespace in field var for client mode negociation is now mandatory</li>
|
|
<li>Behaviour when managing a delegation kept between session in client mode, when managing entity is not available, is specified</li>
|
|
<li>Implementation note added for in-order processing issue (thanks to Kurt Zeilenga for pointing this)</li>
|
|
<li>Added an note for discovery nesting with attribute filtering</li>
|
|
<li>Updated namespace to reflect incompatible changes</li>
|
|
</ul>
|
|
</remark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<version>0.1</version>
|
|
<date>2014-12-18</date>
|
|
<initials>XEP Editor (mam)</initials>
|
|
<remark><p>Initial published version approved by the XMPP Council.</p></remark>
|
|
</revision>
|
|
|
|
<revision>
|
|
<version>0.0.1</version>
|
|
<date>2014-11-13</date>
|
|
<initials>jp</initials>
|
|
<remark><p>First draft.</p></remark>
|
|
</revision>
|
|
|
|
</header>
|
|
<section1 topic='Introduction' anchor='intro'>
|
|
<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>
|
|
<p>This XEP is complementary to &xep0356; (and works in a similar way), although they can be used together or separately.</p>
|
|
<p>Here are some use cases of namespace delegation:</p>
|
|
<ul>
|
|
<li>use an external component for a PEP service because the server doesn't implement it or lacks some features</li>
|
|
<li>decentralize a server feature to an entity under client control</li>
|
|
<li>make a component which react on new user registration, independent of server implementation</li>
|
|
<li>server agnostic roster filtering</li>
|
|
</ul>
|
|
</section1>
|
|
<section1 topic='Requirements' anchor='reqs'>
|
|
<p>Namespace delegation can be used in two modes:</p>
|
|
<ul>
|
|
<li><strong>admin</strong> mode, where delegation is specified by the server administrator.</li>
|
|
<li><strong>client</strong> mode, where it can be requested by any user.</li>
|
|
</ul>
|
|
<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>
|
|
<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>
|
|
</section1>
|
|
<section1 topic='Glossary' anchor='glossary'>
|
|
<ul>
|
|
<li><strong>Delegated namespace</strong> — the namespace being managed by an external entity.</li>
|
|
<li><strong>Filtering attribute</strong> — an attribute which must be present in first &IQ; child element to delegate the namespace.</li>
|
|
<li><strong>Managing entity</strong> — the entity which actualy manages the delegated namespace.</li>
|
|
<li><strong>Delegating server</strong> — the server which delegate the stanzas to the managing entity.</li>
|
|
<li><strong>Managed entity</strong> — an entity which wants to have a namespace of its server delegated to a managing entity.</li>
|
|
</ul>
|
|
</section1>
|
|
<section1 topic='Admin Mode Use Cases' anchor='admin_usecases'>
|
|
|
|
<section2 topic='Server Allows Namespaces Delegations' anchor='server_config'>
|
|
<p>Namespaces delegations are granted in the server configuration. Only &IQ; stanza namespaces can be delegated.</p>
|
|
<p>A feature is delegated using:</p>
|
|
<ol>
|
|
<li>its namespace: e.g. <em>'urn:xmpp:mam:0'</em></li>
|
|
<li>zero or more filtering attribute (attributes which must be present in the initial &IQ; child element): e.g. <em>'node'</em></li>
|
|
<li>the jid of the managing entity: e.g. <em>'managing.capulet.lit'</em></li>
|
|
</ol>
|
|
</section2>
|
|
|
|
<section2 topic='Delegation Request Use Case' anchor='admin_perm'>
|
|
<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>
|
|
<example caption='server advertise delegated namespaces'><![CDATA[
|
|
<message from='capulet.lit' to='pubub.capulet.lit' id='12345'>
|
|
<delegation xmlns='urn:xmpp:delegation:1'>
|
|
<delegated namespace='urn:xmpp:mam:0'>
|
|
<attribute name='node' />
|
|
</delegated>
|
|
<delegated namespace='http://jabber.org/protocol/pubsub'/>
|
|
</delegation>
|
|
</message>
|
|
]]></example>
|
|
<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>
|
|
</section2>
|
|
|
|
<section2 topic='Server Forwards Delegated &IQ; Stanza' anchor='stanza_forward'>
|
|
<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 any bare jid (and only bare jid) that it manages (i.e. the <em>domainpart</em> is a domain handled by the server where delegation is activated), it MUST forwards it to the managing entity:</p>
|
|
<example caption='Juliet sends her mood to her server via PEP'><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='pep1'
|
|
type='set'>
|
|
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
|
|
<publish node='http://jabber.org/protocol/mood'>
|
|
<item>
|
|
<mood xmlns='http://jabber.org/protocol/mood'>
|
|
<annoyed/>
|
|
<text>curse my nurse!</text>
|
|
</mood>
|
|
</item>
|
|
</publish>
|
|
</pubsub>
|
|
</iq>
|
|
]]></example>
|
|
<p>The server gets this stanza, sees that this namespace is delegated to <em>pubsub.capulet.lit</em>, so it forwards it.</p>
|
|
<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>
|
|
|
|
<example caption='server delegate the stanza to pubsub.capulet.lit'><![CDATA[
|
|
<iq from='capulet.lit'
|
|
to='pubsub.capulet.lit'
|
|
id='delegate1'
|
|
type='set'>
|
|
<delegation xmlns='urn:xmpp:delegation:1'>
|
|
<forwarded xmlns='urn:xmpp:forward:0'>
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='pep1'
|
|
type='set'
|
|
xmlns='jabber:client'>
|
|
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
|
|
<publish node='http://jabber.org/protocol/mood'>
|
|
<item>
|
|
<mood xmlns='http://jabber.org/protocol/mood'>
|
|
<annoyed/>
|
|
<text>curse my nurse!</text>
|
|
</mood>
|
|
</item>
|
|
</publish>
|
|
</pubsub>
|
|
</iq>
|
|
</forwarded>
|
|
</delegation>
|
|
</iq>
|
|
]]></example>
|
|
<p>The managing entity replies to the stanza by encapsulating its &IQ; result in the same way:</p>
|
|
<example caption='pubsub.capulet.lit replies to juliet'><![CDATA[
|
|
<iq from='pubsub.capulet.lit'
|
|
to='capulet.lit'
|
|
id='delegate1'
|
|
type='result'>
|
|
<delegation xmlns='urn:xmpp:delegation:1'>
|
|
<forwarded xmlns='urn:xmpp:forward:0'>
|
|
<iq to='juliet@capulet.lit/balcony'
|
|
id='pep1'
|
|
type='result'
|
|
xmlns='jabber:client'>
|
|
<pubsub xmlns='http://jabber.org/protocol/pubsub' />
|
|
</iq>
|
|
</forwarded>
|
|
</delegation>
|
|
</iq>
|
|
]]></example>
|
|
|
|
<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>
|
|
<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>
|
|
|
|
<example caption='capulet.lit replies to Juliet'><![CDATA[
|
|
<iq to='juliet@capulet.lit/balcony'
|
|
id='pep1'
|
|
type='result'>
|
|
<pubsub xmlns='http://jabber.org/protocol/pubsub' />
|
|
</iq>
|
|
]]></example>
|
|
|
|
<p>The workflow is fully transparent for Juliet.</p>
|
|
<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>
|
|
<p><strong>N.B.₂:</strong> Similarly, if the managing entity return an &IQ; stanza of type "error", the server must return itself an &IQ; stanza of type "error" with an error condition of <service-unavailable/></p>
|
|
<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>
|
|
<section3 topic='Stanzas from managing entity' anchor='managing_entity_stanzas'>
|
|
<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 specific treatments, a kind of universal plugin (i.e. working with all servers implementing &xep0355; and &xep0356;).</p>
|
|
<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>
|
|
|
|
<example caption='Juliet adds Romeo to her roster'><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='roster1'
|
|
type='set'>
|
|
<query xmlns='jabber:iq:roster'>
|
|
<item jid='romeo@montaigu.lit'
|
|
name='My Romeo'>
|
|
</item>
|
|
</query>
|
|
</iq>
|
|
]]></example>
|
|
|
|
<example caption='server forwards stanza to managing entity'><![CDATA[
|
|
<iq from='capulet.lit'
|
|
to='pubsub.capulet.lit'
|
|
id='delegate1'
|
|
type='set'>
|
|
<delegation xmlns='urn:xmpp:delegation:1'>
|
|
<forwarded xmlns='urn:xmpp:forward:0'>
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='roster1'
|
|
type='set'
|
|
xmlns='jabber:client'>
|
|
<query xmlns='jabber:iq:roster'>
|
|
<item jid='romeo@montaigu.lit'
|
|
name='My Romeo'>
|
|
</item>
|
|
</query>
|
|
</iq>
|
|
</forwarded>
|
|
</delegation>
|
|
</iq>
|
|
]]></example>
|
|
|
|
<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>
|
|
<example caption='filtering component accept Romeo'><![CDATA[
|
|
<iq from='pubsub.capulet.lit'
|
|
to='capulet.lit'
|
|
id='delegate1'
|
|
type='result'>
|
|
<delegation xmlns='urn:xmpp:delegation:1'>
|
|
<forwarded xmlns='urn:xmpp:forward:0'>
|
|
<iq to='juliet@capulet.lit/balcony'
|
|
id='roster1'
|
|
type='result'
|
|
xmlns='jabber:client' />
|
|
</forwarded>
|
|
</delegation>
|
|
</iq>
|
|
]]></example>
|
|
<example caption='server decapsulate and send the result with the initial id'><![CDATA[
|
|
<iq to='juliet@capulet.lit/balcony'
|
|
id='roster1'
|
|
type='result' />
|
|
]]></example>
|
|
|
|
<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>
|
|
<example caption='filter.capulet.lit uses privileged entity to add Romeo'><![CDATA[
|
|
<iq to='juliet@capulet.lit'
|
|
from='filter.capulet.lit'
|
|
id='roster2'
|
|
type='set'>
|
|
<query xmlns='jabber:iq:roster'>
|
|
<item jid='romeo@montaigu.lit'
|
|
name='My Romeo'>
|
|
<group>Rivals</group>
|
|
</item>
|
|
</query>
|
|
</iq>
|
|
]]></example>
|
|
<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>
|
|
|
|
<example caption='server accept new entity in roster'><![CDATA[
|
|
<iq to='filter.capulet.lit'
|
|
from='juliet@capulet.lit'
|
|
id='roster2'
|
|
type='result'/>
|
|
]]></example>
|
|
|
|
<p>The server will then send the roster pushes (with the enforced group) normally.</p>
|
|
|
|
</section3>
|
|
|
|
</section2>
|
|
|
|
|
|
</section1>
|
|
|
|
<section1 topic='Client Mode Use Cases' anchor='client_usecases'>
|
|
<section2 topic='Client Delegation Request Use Case' anchor='client_delegation'>
|
|
<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>
|
|
<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>
|
|
<p>Namespace delegations are asked with a <delegate/> element, which MUST contain a 'namespace' attribute set to the requested namespace.</p>
|
|
|
|
<p>If an entity want to manage PEP service for Juliet, it can ask the delegation like this:
|
|
</p>
|
|
<example caption='managing entity asks for namespace delegation for one particular entity'><![CDATA[
|
|
<iq from='pubsub.montaigu.lit' to='capulet.lit' type='get' id='delegation1'>
|
|
<query xmlns='urn:xmpp:delegation:1'
|
|
to='juliet@capulet.lit'>
|
|
<delegate namespace='http://jabber.org/protocol/pubsub'/>
|
|
</query>
|
|
</iq>
|
|
]]></example>
|
|
<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.
|
|
</p>
|
|
<example caption='server asks user for the namespace delegation'><![CDATA[
|
|
<message from='capulet.lit' to='juliet@capulet.lit/balcony'>
|
|
<body>
|
|
pubsub.montaigu.lit wants to manage a feature normally managed by the server.
|
|
Do you allow it to manage the following features?
|
|
|
|
Be careful! According management to an entity is a serious thing,
|
|
think twice that you can trust the entity before doing this.
|
|
</body>
|
|
<x xmlns='jabber:x:data' type='form'>
|
|
<title>Delegation request</title>
|
|
<instructions>pubsub.montaigu.lit wants to manage the following features:
|
|
Do you allow it?</instructions>
|
|
<field type='hidden' var='challenge'><value>5439123</value></field>
|
|
<field type='hidden' var='FORM_TYPE'>
|
|
<value>urn:xmpp:delegation:1</value>
|
|
</field>
|
|
<field type='list-single'
|
|
label='Manage PubSub (http://jabber.org/protocol/pubsub)'
|
|
var='http://jabber.org/protocol/pubsub'>
|
|
<value>0</value>
|
|
<option label='No'><value>0</value></option>
|
|
<option label='Yes'><value>1</value></option>
|
|
</field>
|
|
</x>
|
|
</message>
|
|
]]></example>
|
|
<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>
|
|
<p>The client can then answer to the form:</p>
|
|
<example caption='client answer to the form'><![CDATA[
|
|
<message from='juliet@capulet.lit/balcony' to='capulet.lit'>
|
|
<x xmlns='jabber:x:data' type='submit'>
|
|
<field var='FORM_TYPE'>
|
|
<value></value>
|
|
</field>
|
|
<field var='challenge'><value>5439123</value></field>
|
|
<field var='http://jabber.org/protocol/pubsub'><value>1</value></field>
|
|
</x>
|
|
</message>
|
|
]]></example>
|
|
<p>Here Juliet allows <em>pubsub.montaigu.lit</em> to manage the PubSub (and then PEP) service.</p>
|
|
|
|
|
|
<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>
|
|
<example caption='server advertise delegated namespaces for juliet'><![CDATA[
|
|
<message from='capulet.net' to='pubub.capulet.lit' id='6789'>
|
|
<delegation xmlns='urn:xmpp:delegation:1' to='juliet@capulet.lit'>
|
|
<delegated namespace='http://jabber.org/protocol/pubsub'/>
|
|
</delegation>
|
|
</message>
|
|
]]></example>
|
|
</section2>
|
|
<section2 topic='Server Forward Stanza' anchor='client_forward'>
|
|
<p>The managing entity can now manage the namespace in a similar way as in <link url='#stanza_forward'>admin mode</link> but with different rules:</p>
|
|
<ol>
|
|
<li>if the stanza is directed to the delegating server (no 'to' attribute, or 'to' attribute with the server own JID), <strong>and</strong> the 'from' attribute belong to a managed entity (e.g. <em>juliet@capulet.lit/balcony</em> if <em>juliet@capulet.lit</em> is a managed entity) <strong>and</strong> the namespace of the stanza has been delegated by the managed entity, then the delegating server MUST forward it to the managing entity accepted by the managed entity, in the same way as in <link url='#stanza_forward'>admin mode</link>.</li>
|
|
<li>if the stanza is directed to the bare jid (and only the bare jid) of the managed entity (e.g. the 'to' attribute is set to <em>juliet@capulet.lit</em> and the namespace has been delegated by the managed entity, then the server MUST forward it to the managing entity accepted by the managed entity, in the same way as in <link url='#stanza_forward'>admin mode</link>, for any 'from' attribute but the jid of the managing entity.</li>
|
|
<li>in all other cases, the server MUST NOT forward the stanza</li>
|
|
</ol>
|
|
</section2>
|
|
|
|
</section1>
|
|
|
|
<section1 topic='Configuration' anchor='configuration'>
|
|
<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>
|
|
<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>
|
|
</section1>
|
|
|
|
<section1 topic='Discovering Support' anchor='disco'>
|
|
<section2 topic='Announce' anchor='disco_announce'>
|
|
<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>
|
|
<example caption="service discovery information request"><![CDATA[
|
|
<iq from='pubsub.capulet.lit'
|
|
id='disco1'
|
|
to='capulet.lit'
|
|
type='get'>
|
|
<query xmlns='http://jabber.org/protocol/disco#info'/>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="service discovery information response"><![CDATA[
|
|
<iq from='capulet.lit'
|
|
id='disco1'
|
|
to='pubsub.capulet.lit'
|
|
type='result'>
|
|
<query xmlns='http://jabber.org/protocol/disco#info'>
|
|
...
|
|
<feature var='urn:xmpp:delegation:1'/>
|
|
...
|
|
</query>
|
|
</iq>
|
|
]]></example>
|
|
</section2>
|
|
<section2 topic='Nesting' anchor='disco_nesting'>
|
|
<section3 topic='General Case'>
|
|
<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>
|
|
<p>This is done by using a disco node, which is built in 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>
|
|
<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>
|
|
<example caption="Juliet asks her server its available features"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='disco1'
|
|
to='capulet.lit'
|
|
type='get'>
|
|
<query xmlns='http://jabber.org/protocol/disco#info'/>
|
|
</iq>
|
|
]]>
|
|
</example>
|
|
<p>Server delegates its PubSub namespace to <em>pubsub.capulet.lit</em>, so it asks its available features for this namespace like this:</p>
|
|
<example caption="capulet.lit requests disco infos for pubsub namespace to pubsub.capulet.lit"><![CDATA[
|
|
<iq from='capulet.lit'
|
|
id='disco2'
|
|
to='pubsub.capulet.lit'
|
|
type='get'>
|
|
<query xmlns='http://jabber.org/protocol/disco#info'
|
|
node='urn:xmpp:delegation:1::http://jabber.org/protocol/pubsub'/>
|
|
</iq>
|
|
]]>
|
|
</example>
|
|
<p>Note that in real situation, server has probably this information already in cache (see <link url='#impl'>Implementation Notes</link>).<br/>
|
|
<em>pubsub.capulet.lit</em> returns its available features:</p>
|
|
<example caption="pubsub.capulet.lit returns features to nest"><![CDATA[
|
|
<iq from='pubsub.capulet.lit'
|
|
id='disco2'
|
|
to='capulet.lit'
|
|
type='result'>
|
|
<query xmlns='http://jabber.org/protocol/disco#info'
|
|
node='urn:xmpp:delegation:1::http://jabber.org/protocol/pubsub'>
|
|
<feature var='http://jabber.org/protocol/pubsub'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#publish'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#subscribe'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#publish-options'/>
|
|
</query>
|
|
</iq>
|
|
]]>
|
|
</example>
|
|
<p>Server include the results in its own discovery info results:</p>
|
|
<example caption="capulet.lit return disco info including features from pubsub.capulet.lit"><![CDATA[
|
|
<iq from='capulet.lit'
|
|
id='disco1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='result'>
|
|
<query xmlns='http://jabber.org/protocol/disco#info'>
|
|
<feature var='urn:xmpp:delegation:1'/>
|
|
...
|
|
<feature var='http://jabber.org/protocol/pubsub'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#publish'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#subscribe'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#publish-options'/>
|
|
...
|
|
</query>
|
|
</iq>
|
|
]]>
|
|
</example>
|
|
<p>Note that '<em>http://jabber.org/protocol/pubsub#auto-create</em>' is not available.</p>
|
|
<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>
|
|
</section3>
|
|
<section3 topic='Rediction Of Bare JID Disco Info'>
|
|
<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>
|
|
<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>
|
|
|
|
<example caption="Juliet asks features for its own bare JID"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='disco3'
|
|
to='juliet@capulet.lit'
|
|
type='get'>
|
|
<query xmlns='http://jabber.org/protocol/disco#info'/>
|
|
</iq>
|
|
]]>
|
|
</example>
|
|
<p>Server delegate its PubSub namespace to <em>pubsub.capulet.lit</em>, so it ask its available features for this namespace like this:</p>
|
|
<example caption="capulet.lit requests disco infos for pubsub namespace to pubsub.capulet.lit"><![CDATA[
|
|
<iq from='capulet.lit'
|
|
id='disco4'
|
|
to='pubsub.capulet.lit'
|
|
type='get'>
|
|
<query xmlns='http://jabber.org/protocol/disco#info'
|
|
node='urn:xmpp:delegation:1:bare:http://jabber.org/protocol/pubsub'/>
|
|
</iq>
|
|
]]>
|
|
</example>
|
|
<p>As for general case, server has probably <link url='#impl'>this information already in cache</link>.<br/>
|
|
<em>pubsub.capulet.lit</em> returns its available features:</p>
|
|
<example caption="pubsub.capulet.lit returns features to nest"><![CDATA[
|
|
<iq from='pubsub.capulet.lit'
|
|
id='disco4'
|
|
to='capulet.lit'
|
|
type='result'>
|
|
<query xmlns='http://jabber.org/protocol/disco#info'
|
|
node='urn:xmpp:delegation:1:bare:http://jabber.org/protocol/pubsub'>
|
|
<identity category='pubsub' type='pep'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#access-presence'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#auto-create'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#auto-subscribe'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#config-node'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#create-and-configure'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#create-nodes'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#filtered-notifications'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#persistent-items'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#publish'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#retrieve-items'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#subscribe'/>
|
|
...
|
|
</query>
|
|
</iq>
|
|
]]>
|
|
</example>
|
|
<p>Then the server returns the answer to Juliet, as in general case, with requested bare JID in 'from' field.</p>
|
|
<example caption="capulet.lit returns disco info to Juliet"><![CDATA[
|
|
<iq from='juliet@capulet.lit'
|
|
id='disco3'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='result'>
|
|
<query xmlns='http://jabber.org/protocol/disco#info'>
|
|
<identity category='account' type='registered'/>
|
|
<identity category='pubsub' type='pep'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#access-presence'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#auto-create'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#auto-subscribe'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#config-node'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#create-and-configure'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#create-nodes'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#filtered-notifications'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#persistent-items'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#publish'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#retrieve-items'/>
|
|
<feature var='http://jabber.org/protocol/pubsub#subscribe'/>
|
|
...
|
|
</query>
|
|
</iq>
|
|
]]>
|
|
</example>
|
|
|
|
</section3>
|
|
<section3 topic='Service Discovery Extensions'>
|
|
<p>Extensions of Service Discovery as specified in &xep0128; follow the same rules: for the delegated namespace, internal extensions MUST be removed and extensions of managing entity MUST be included instead.</p>
|
|
</section3>
|
|
</section2>
|
|
</section1>
|
|
|
|
<section1 topic='Business Rules' anchor='rules'>
|
|
<ol>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<li>If delegations are kept between sessions in client mode, and the managing entity is not available or return an error, 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>
|
|
<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>
|
|
</ol>
|
|
</section1>
|
|
<section1 topic='Implementation Notes' anchor='impl'>
|
|
<ol>
|
|
<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>
|
|
<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>
|
|
<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).
|
|
</li>
|
|
</ol>
|
|
</section1>
|
|
<section1 topic='Security Considerations' anchor='security'>
|
|
<ol>
|
|
<li>Managing entity can manage sensitive data, <em>admin</em> delegation should be granted carefuly, only if you absolutely trust the entity.</li>
|
|
<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>
|
|
|
|
<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>
|
|
</ol>
|
|
</section1>
|
|
<section1 topic='IANA Considerations' anchor='iana'>
|
|
<p>This document requires no interaction with &IANA;.</p>
|
|
</section1>
|
|
<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
|
|
<section2 topic='Protocol Namespaces' anchor='ns'>
|
|
<p>The ®ISTRAR; includes 'urn:xmpp:delegation:1' in its registry of protocol namespaces (see &NAMESPACES;).</p>
|
|
<ul>
|
|
<li>urn:xmpp:delegation:1</li>
|
|
</ul>
|
|
</section2>
|
|
<section2 topic='Protocol Versioning' anchor='registrar-versioning'>
|
|
&NSVER;
|
|
</section2>
|
|
</section1>
|
|
<section1 topic='XML Schema' anchor='schema'>
|
|
<code><![CDATA[
|
|
<?xml version='1.0' encoding='UTF-8'?>
|
|
|
|
<xs:schema
|
|
xmlns:xs='http://www.w3.org/2001/XMLSchema'
|
|
targetNamespace='urn:xmpp:delegation:1'
|
|
xmlns='urn:xmpp:delegation:1'
|
|
elementFormDefault='qualified'>
|
|
|
|
<xs:import namespace='urn:xmpp:forward:0'
|
|
schemaLocation='http://xmpp.org/schemas/forward.xsd'/>
|
|
|
|
<xs:element name='query'>
|
|
<xs:complexType>
|
|
<xs:attribute name='to' use='required' type='xs:string'/>
|
|
</xs:attribute>
|
|
<xs:element name='delegate'
|
|
maxOccurs='unbounded'>
|
|
<xs:complexType>
|
|
<xs:attribute name='namespace' use='required' type='xs:string'/>
|
|
</xs:complexType>
|
|
</xs:element>
|
|
</xs:complexType>
|
|
</xs:element>
|
|
|
|
<xs:element name='delegation'>
|
|
<xs:complexType>
|
|
<xs:element ref='urn:xmpp:forward:0' minOccurs='0' maxOccurs='1' />
|
|
<xs:element name='delegated'
|
|
minOccurs='0'
|
|
maxOccurs='unbounded'>
|
|
<xs:complexType>
|
|
<xs:attribute name='namespace' use='required' type='xs:string'/>
|
|
<xs:element name='attribute'
|
|
minOccurs='0'
|
|
maxOccurs='unbounded'>
|
|
<xs:complexType>
|
|
<xs:attribute name='name' use='required' type='xs:string'/>
|
|
</xs:complexType>
|
|
</xs:element>
|
|
</xs:complexType>
|
|
</xs:element>
|
|
</xs:complexType>
|
|
</xs:element>
|
|
|
|
</xs:schema>
|
|
]]></code>
|
|
</section1>
|
|
<section1 topic='Acknowledgements' anchor='acks'>
|
|
<p>This XEP is linked with &xep0356; and works in a similar way.</p>
|
|
<p>The client mode delegation mechanism is inspired from &xep0321; permission request.</p>
|
|
<p>Thanks to Adrien Cossa for his typos/style corrections</p>
|
|
<p>Thanks to Philipp Hancke, Dave Cridland, Kurt Zeilenga, Sergey Dobrov and Анна Мухаррам for their feedbacks.</p>
|
|
</section1>
|
|
</xep>
|