annotate xmpp/xep-proto-privileged-component.xml @ 22:2c861d6aa446

docker: added "latest" tag when pulling in libervia_cont.sh update
author Goffi <goffi@goffi.org>
date Sun, 19 Oct 2014 19:40:45 +0200
parents c6824592e3ef
children 91d56a6e4b0d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
1 <?xml version='1.0' encoding='UTF-8'?>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
2 <!DOCTYPE xep SYSTEM 'xep.dtd' [
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
3 <!ENTITY % ents SYSTEM 'xep.ent'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
4 %ents;
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
5 ]>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
6 <?xml-stylesheet type='text/xsl' href='xep.xsl'?>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
7 <xep>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
8 <header>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
9 <title>privileged entity</title>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
10 <abstract>This specification provides a way for XMPP entities to have a privileged access to other entities data</abstract>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
11 <legal>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
12 <copyright>This XMPP Extension Protocol is copyright (c) 1999 - 2014 by the XMPP Standards Foundation (XSF).</copyright>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
13 <permissions>Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the &quot;Specification&quot;), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.</permissions>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
14 <warranty>## NOTE WELL: This Specification is provided on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. In no event shall the XMPP Standards Foundation or the authors of this Specification be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification. ##</warranty>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
15 <liability>In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising out of the use or inability to use the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.</liability>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
16 <conformance>This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which may be found at &lt;<link url='http://xmpp.org/extensions/ipr-policy.shtml'>http://xmpp.org/extensions/ipr-policy.shtml</link>&gt; or obtained by writing to XSF, P.O. Box 1641, Denver, CO 80201 USA).</conformance>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
17 </legal>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
18 <number>xxxx</number>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
19 <status>ProtoXEP</status>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
20 <type>Standards Track</type>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
21 <sig>Standards</sig>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
22 <approver>Council</approver>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
23 <dependencies>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
24 <spec>XMPP Core</spec>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
25 <spec>XEP-0114</spec>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
26 <spec>XEP-0004</spec>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
27 </dependencies>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
28 <supersedes/>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
29 <supersededby/>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
30 <shortname>NOT_YET_ASSIGNED</shortname>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
31 <author>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
32 <firstname>Jérôme</firstname>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
33 <surname>Poisson</surname>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
34 <email>goffi@goffi.org</email>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
35 <jid>goffi@jabber.fr</jid>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
36 </author>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
37 <revision>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
38 <version>0.0.2</version>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
39 <date>2014-09-17</date>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
40 <initials>jp</initials>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
41 <remark><ul>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
42 <li>changed for privileged entity</li>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
43 <li>fixes after feedbacks on standard mailing list</li>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
44 <li>completed missing required parts</li>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
45 </ul>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
46 </remark>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
47 </revision>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
48 <revision>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
49 <version>0.0.1</version>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
50 <date>2014-05-09</date>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
51 <initials>jp</initials>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
52 <remark><p>First draft.</p></remark>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
53 </revision>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
54 </header>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
55 <section1 topic='Introduction' anchor='intro'>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
56 <p>XMPP components are used for long through &xep0114;, but are quite limited: they have a restricted access to other entities data, similar to what a client can do. This is sufficient for components like gateways, but very limiting for more complex components like a PubSub service. The goal of this XEP is to allow a component or any entity to have a "privileged" status, and access an other entity data with the same privileges than the entity itself, that means send and receive IQ stanzas on its behalf.</p>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
57 <p>Privileged entity have numerous advantages, including:</p>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
58 <ul>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
59 <li>a step forward in decentralization: it is possible for an entity to do tasks which were before reserved to server itself. For example, a privileged pubsub component can offer access model based on publisher's roster</li>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
60 <li>better integration of components: a gateway can add items to an entity roster itself</li>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
61 <li>possibility to overpass a server limitation</li>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
62 <li>quick development cycle: developers can implement the components they need without waiting for a new server release</li>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
63 <li>server agnostic</li>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
64 </ul>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
65 </section1>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
66 <section1 topic='Requirements' anchor='reqs'>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
67 <p>A privileged entity can be used in two modes:</p>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
68 <ul>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
69 <li><strong>admin</strong> mode, where it is installed by the server administrator</li>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
70 <li><strong>client</strong> mode, where it can be installed by any user</li>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
71 </ul>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
72 <p>In <em>admin</em> mode, the privileged entity MAY be able to emit IQ stanzas in the same way as any entity, including managing roster or accessing persistent storage.</p>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
73 <p>In <em>client</em> mode, a privileged entity MUST have an explicit autorization for any IQ 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>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
74 </section1>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
75 <section1 topic='Glossary' anchor='glossary'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
76 <ul>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
77 <li><strong>Privileged entity</strong> the entity which has or wants a privileged status.</li>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
78 <li><strong>Managed entity</strong> the entity that the privileged entity wants to manage.</li>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
79 </ul>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
80 </section1>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
81 <section1 topic='Admin Mode Use Cases' anchor='admin_usecases'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
82
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
83 <section2 topic='Permission Request Use Case' anchor='admin_perm'>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
84 <section3 topic='Entity request privileged status of admin' anchor='req_status'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
85 <p>Once the privileged entity is authentified and stream is started, the entity can request its privileged status. It do it by sending an IQ stanza with <strong>'urn:xmpp:privilege:0'</strong> namespace</p>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
86 <p>Namespace permissions are asked with a &lt;perm/&gt; element, which MUST contain a 'namespace' attribute set to the requested namespace and a 'type' attribute which can be:</p>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
87 <ul>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
88 <li><strong>get</strong> the entity wants to send &IQ; stanza of type <em>'get'</em></li>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
89 <li><strong>set</strong> the entity wants to send &IQ; stanza of type <em>'set'</em></li>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
90 <li><strong>both</strong> the entity wants to send &IQ; stanza of type <em>'get'</em> and <em>'set'</em></li>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
91 </ul>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
92 <example caption='Entity asks for admin privilege'><![CDATA[
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
93 <iq from='pubsub.capulet.net' type='get' id='privilege1'>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
94 <query xmlns='urn:xmpp:privilege:0' type='request' privilege='admin'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
95 <perm namespace='jabber:iq:roster' type='both'/>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
96 <perm namespace='http://jabber.org/protocol/pubsub' type='both'/>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
97 </query>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
98 </iq>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
99 ]]></example>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
100 </section3>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
101 <section3 topic='Server Accept Admin Privilege' anchor='accept_status'>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
102 <p>If the server accept the privileged status (e.g.: admin status specified in configuration), it MUST return an IQ result stanza, with allowed permissions in &lt;perm/&gt; elements:</p>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
103 <example caption='Server accept admin privilege'><![CDATA[
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
104 <iq from='capulet.net' to='pubsub.capulet.net' type='result' id='privilege1'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
105 <query xmlns='urn:xmpp:privilege:0'
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
106 type='allowed'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
107 <perm namespace='jabber:iq:roster' type='both'/>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
108 <perm namespace='http://jabber.org/protocol/pubsub' type='both'/>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
109 </query>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
110 </iq>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
111 ]]></example>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
112 <p>Note: the granted permissions MAY be different from the requested ones, according to server's configuration.</p>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
113 </section3>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
114 <section3 topic='Server Reject Admin Privilege' anchor='reject_status'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
115 <p>If the server reject the privileged status, it MUST return a &forbidden; error:</p>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
116 <example caption='Server reject admin privilege'><![CDATA[
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
117 <iq from='capulet.net' to='pubsub.capulet.net' type='error' id='privilege1'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
118 <error type='cancel'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
119 <forbidden xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
120 </error>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
121 </iq>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
122 ]]></example>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
123 </section3>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
124 </section2>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
125
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
126 <section2 topic='Privileged Entity Send IQ Stanzas' anchor='priv_iq_admin'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
127 <p>Sending an IQ stanzas is done by sending the stanza the way it would be done by the managed entity, except that its jid is in the 'to' attribute. In the following example, the PubSub service want to know juliet's roster because she own a node with access model based on publiser's roster:</p>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
128 <example caption='Privileged Entity Send A Roster Stanza'><![CDATA[
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
129 <iq id='roster1'
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
130 xmlns='urn:xmpp:privilege:0'
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
131 to='juliet@example.com'
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
132 type='get'
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
133 id='roster1'>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
134 <query xmlns='jabber:iq:roster'/>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
135 </iq>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
136 ]]></example>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
137
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
138 <p>The server then answer normaly, as it would have done with the managed entity:</p>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
139 <example caption='Server Answer To Privileged Entity'><![CDATA[
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
140 <iq id='roster1'
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
141 to='pubsub.capulet.net'
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
142 type='result'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
143 <query xmlns='jabber:iq:roster' ver='ver7'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
144 <item jid='nurse@example.com'/>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
145 <item jid='romeo@example.net'/>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
146 </query>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
147 </iq>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
148 ]]></example>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
149
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
150 <p>In the following example, the sync.capulet.net privileged entity want to access managed entity's bookmarks to synchronize them with an online service. It can request the bookmarks in the following way:</p>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
151 <example caption='Privileged Entity Request Bookmarks'><![CDATA[
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
152 <iq id='bookmark1'
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
153 to='juliet@capulet.lit'
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
154 type='get'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
155 <pubsub xmlns='http://jabber.org/protocol/pubsub'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
156 <items node='storage:bookmarks'/>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
157 </pubsub>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
158 </iq>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
159 ]]></example>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
160 <p>and server answer:</p>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
161
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
162 <example caption='Server Return Bookmarks'><![CDATA[
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
163 <iq id='bookmark1'
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
164 to='pubsub.capulet.net'
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
165 type='result'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
166 <pubsub xmlns='http://jabber.org/protocol/pubsub'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
167 <items node='storage:bookmarks'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
168 <item id='current'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
169 <storage xmlns='storage:bookmarks'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
170 <conference name='The Play&apos;s the Thing'
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
171 autojoin='true'
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
172 jid='theplay@conference.shakespeare.lit'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
173 <nick>JC</nick>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
174 </conference>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
175 </storage>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
176 </item>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
177 </items>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
178 </pubsub>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
179 </iq>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
180 ]]></example>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
181 </section2>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
182 </section1>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
183
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
184
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
185 <section1 topic='Client Mode Use Cases' anchor='client_usecases'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
186 <section2 topic='Permission Request Use Case' anchor='client_perm'>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
187 <p>In <em>client</em> mode, the privileged entity is not certified by the server administrator, so the permissions MUST be <strong>explicitly</strong> allowed by the managed entity. This is initiated by the privileged entity (it can be after an interaction with a managed entity, like a subscription). It's done in the same way as for <em>admin</em> mode with the following exceptions:</p>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
188 <ol>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
189 <li>the privilege type is <em>client</em> instead of <em>admin</em></li>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
190 <li>the privilege is done per entity, so the managed entity MUST be specified in a 'to' attribute</li>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
191 </ol>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
192 <p>If an entity want a read/write access to a client's roster (juliet) and a read only access to her pubsub, it can ask the permission like this:
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
193 </p>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
194 <example caption='Entity Asks For User Privilege'><![CDATA[
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
195 <iq from='priv.montaigu.net' to='capulet.net' type='get' id='privilege1'>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
196 <query xmlns='urn:xmpp:privilege:0'
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
197 type='request'
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
198 privilege='client'
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
199 to='juliet@capulet.net'>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
200 <perm namespace='jabber:iq:roster' type='both'/>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
201 <perm namespace='http://jabber.org/protocol/pubsub' type='get'/>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
202 </query>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
203 </iq>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
204 ]]></example>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
205 <p>Once received the permission request, the server ask to the client if it grant access to the requested permission using &xep0004;. The form SHOULD allow to fine tune the granted permissions. The server use a challenge which it MUST have generated himself.
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
206 </p>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
207 <example caption='Server Asks User For The Permission'><![CDATA[
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
208 <message from='capulet.net' to='juliet@capulet.net'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
209 <body>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
210 priv.montaigu.net wants some privileges.
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
211 Do you you allow him to use the following features ?
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
212
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
213 Be careful ! According permissions to entity is a serious thing,
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
214 think twice that you can trust the entity before doing this.
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
215 </body>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
216 <x xmlns='jabber:x:data' type='form'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
217 <title>Privileges request</title>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
218 <instructions>priv.montaigu.net wants to use the following features:
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
219 Do you allow it?</instructions>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
220 <field type='hidden' var='challenge'><value>5439123</value></field>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
221 <field type='hidden' var='FORM_TYPE'>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
222 <value>urn:xmpp:privilege:0</value>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
223 </field>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
224 <field type='list-single'
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
225 label='Manage roster (jabber:iq:roster) READ/WRITE'
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
226 var='jabber:iq:roster'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
227 <value>0</value>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
228 <option label='None'><value>none</value></option>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
229 <option label='Read only (get)'><value>get</value></option>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
230 <option label='Write only (set)'><value>set</value></option>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
231 <option label='Read and write (both)'><value>both</value></option>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
232 </field>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
233 <field type='list-single'
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
234 label='Manage PubSub (http://jabber.org/protocol/pubsub) READ'
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
235 var='http://jabber.org/protocol/pubsub'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
236 <value>0</value>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
237 <option label='None'><value>none</value></option>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
238 <option label='Read only (get)'><value>get</value></option>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
239 </field>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
240 </x>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
241 </message>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
242 ]]></example>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
243 <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>none</strong>' (permission refused). The server SHOULD use namespace as field var, so a client can use it to have a customized display.</p>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
244 <p>The client can then answer to the form:</p>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
245 <example caption='Client Answer To The Form'><![CDATA[
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
246 <message from='juliet@capulet.net' to='capulet.net'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
247 <x xmlns='jabber:x:data' type='submit'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
248 <field var='FORM_TYPE'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
249 <value></value>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
250 </field>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
251 <field var='challenge'><value>5439123</value></field>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
252 <field var='jabber:iq:roster'><value>both</value></field>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
253 <field var='http://jabber.org/protocol/pubsub'><value>none</value></field>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
254 </x>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
255 </message>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
256 ]]></example>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
257 <p>Here juliet accept that <em>priv.montaigu.net</em> use 'set' and 'get' to manage her roster, but doesn't want it to do any 'get' on her pubsub nodes.</p>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
258 <p>Finaly, the server notify the entity of the permissions granted. For this it use a &QUERY; element with the 'allowed' type, and put the client jid in a 'from' attribute:</p>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
259 <example caption='Server notify accepted permissions'><![CDATA[
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
260 <iq from='capulet.net' to='priv.montaigu.net' type='set' id='privilege2'>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
261 <query xmlns='urn:xmpp:privilege:0'
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
262 type='allowed'
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
263 from='juliet@capulet.net'>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
264 <perm namespace='jabber:iq:roster' type='both'/>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
265 <perm namespace='http://jabber.org/protocol/pubsub' type='none'/>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
266 </query>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
267 </iq>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
268 ]]></example>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
269 <p>The privileged entity can now act according to permission granted to him.</p>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
270 </section2>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
271 <section2 topic='Privileged Entity Send IQ Stanzas' anchor='priv_iq_client'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
272 <p>sending IQ stanza is done in the exact same way as for <link url='#priv_iq_admin'>admin mode</link>. If an entity want to sent a non authorized IQ, it get a &forbidden; error:</p>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
273 <example caption='Entity Request bookmarks'><![CDATA[
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
274 <iq to='juliet@capulet.lit' type='get' id='bookmark1'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
275 <pubsub xmlns='http://jabber.org/protocol/pubsub'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
276 <items node='storage:bookmarks'/>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
277 </pubsub>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
278 </iq>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
279 ]]></example>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
280
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
281 <example caption='The Stanza Is Not Autorized !'><![CDATA[
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
282 <iq from='capulet.net' to='priv.montaigu.net' type='error' id='bookmark1'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
283 <error type='cancel'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
284 <forbidden xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
285 </error>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
286 </iq>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
287 ]]></example>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
288 </section2>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
289
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
290 </section1>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
291 <section1 topic='Discovering Support' anchor='disco'>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
292 <p>If a server or an entity supports the entity privilege protocol, it MUST report that fact by including a service discovery feature of "urn:xmpp:privilege:0" in response to a &xep0030; information request:</p>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
293 <example caption="Service Discovery information request"><![CDATA[
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
294 <iq from='pubsub.capulet.net'
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
295 id='disco1'
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
296 to='capulet.net'
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
297 type='get'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
298 <query xmlns='http://jabber.org/protocol/disco#info'/>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
299 </iq>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
300 ]]></example>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
301 <example caption="Service Discovery information response"><![CDATA[
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
302 <iq from='capulet.net'
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
303 id='disco1'
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
304 to='pubsub.capulet.net'
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
305 type='result'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
306 <query xmlns='http://jabber.org/protocol/disco#info'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
307 ...
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
308 <feature var='urn:xmpp:privilege:0'/>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
309 ...
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
310 </query>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
311 </iq>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
312 ]]></example>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
313 </section1>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
314 <section1 topic='Business Rules' anchor='rules'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
315 <ol>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
316 <li>Server MAY keep permission granted to an entity by a client from one session to an other, but if it do so, it MUST provide a way to client to check already granted permission, and revoke them (possibly using &xep0050;).</li>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
317 <li>If a client can't check or revoke permission (e.g. it doesn't support &xep0050;), the server MUST NOT keep granted permission from one session to an other, and permission will be asked on each new session.</li>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
318 <li>If permissions are changed during a session, server MUST notify privileged entity of the new permissions, like in <link url='#client_perm'>permission request use case</link> </li>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
319 </ol>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
320 </section1>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
321 <section1 topic='Implementation Notes' anchor='impl'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
322 <p>As admin mode is far more easy to implement than client mode, a server MAY choose to only implement the former</p>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
323 </section1>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
324 <section1 topic='Security Considerations' anchor='security'>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
325 <ol>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
326 <li>Privileged entity nearly have the same possibility as the server itself, <em>admin</em> permission should be granted carefuly, only if you absolutely trust the entity.</li>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
327 <li>A server MAY choose to filter allowed namespaces, to avoid giving dangerous permissions. In this case, it MUST always set the allowed type of filtered namespaces to <strong>none</strong></li>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
328
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
329 <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>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
330 </ol>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
331 </section1>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
332 <section1 topic='IANA Considerations' anchor='iana'>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
333 <p>This document requires no interaction with &IANA;.</p>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
334 </section1>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
335 <section1 topic='XMPP Registrar Considerations' anchor='registrar'>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
336 <section2 topic='Protocol Namespaces' anchor='ns'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
337 <p>The &REGISTRAR; includes 'urn:xmpp:privilege:0' in its registry of protocol namespaces (see &NAMESPACES;).</p>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
338 <ul>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
339 <li>urn:xmpp:privilege:0</li>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
340 </ul>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
341 </section2>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
342 <section2 topic='Protocol Versioning' anchor='registrar-versioning'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
343 &NSVER;
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
344 </section2>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
345 </section1>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
346 <section1 topic='XML Schema' anchor='schema'>
17
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
347 <code><![CDATA[
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
348 <?xml version='1.0' encoding='UTF-8'?>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
349
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
350 <xs:schema
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
351 xmlns:xs='http://www.w3.org/2001/XMLSchema'
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
352 targetNamespace='urn:xmpp:privilege:0'
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
353 xmlns='urn:xmpp:privilege:0'
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
354 elementFormDefault='qualified'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
355
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
356 <xs:element name='query'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
357 <xs:complexType>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
358 <xs:attribute name='type' use='required'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
359 <xs:simpleType base='xs:NMTOKEN'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
360 <xs:enumeration value='request'/>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
361 <xs:enumeration value='allowed'/>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
362 </xs:simpleType>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
363 </xs:attribute>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
364 <xs:attribute name='privilege' use='optional'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
365 <xs:simpleType base='xs:NMTOKEN'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
366 <xs:enumeration value='admin'/>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
367 <xs:enumeration value='client'/>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
368 </xs:simpleType>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
369 </xs:attribute>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
370 <xs:attribute name='to' use='optional' type='xs:string'/>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
371 </xs:attribute>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
372 <xs:element name='perm'
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
373 maxOccurs='unbounded'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
374 <xs:complexType>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
375 <xs:attribute name='namespace' use='required' type='xs:string'/>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
376 <xs:attribute name='type' use='required'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
377 <xs:simpleType base='xs:NMTOKEN'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
378 <xs:enumeration value='none'/>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
379 <xs:enumeration value='get'/>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
380 <xs:enumeration value='set'/>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
381 <xs:enumeration value='both'/>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
382 </xs:simpleType>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
383 </xs:attribute>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
384 </xs:complexType>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
385 </xs:element>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
386 </xs:complexType>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
387 </xs:element>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
388
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
389 </xs:schema>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
390 ]]></code>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
391 </section1>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
392 <section1 topic='Acknowledgements' anchor='acks'>
c6824592e3ef privileged entity xep update:
Goffi <goffi@goffi.org>
parents: 0
diff changeset
393 <p>Thanks to Sergey Dobrov, Dave Cridland and Steven Lloyd Watkin for their feedbacks.</p>
0
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
394 </section1>
677de998f9d9 XMPP: added privileged component protoXEP
Goffi <goffi@goffi.org>
parents:
diff changeset
395 </xep>