Mercurial > sat_docs
changeset 32:a3f262d5b594
xeps: typos/style fixes
| author | souliane <souliane@mailoo.org> |
|---|---|
| date | Tue, 18 Nov 2014 13:20:14 +0100 |
| parents | 91d56a6e4b0d |
| children | b70084aa0af7 |
| files | xmpp/xep-proto-namespace-delegation.xml xmpp/xep-proto-privileged-component.xml |
| diffstat | 2 files changed, 121 insertions(+), 121 deletions(-) [+] |
line wrap: on
line diff
--- a/xmpp/xep-proto-namespace-delegation.xml Thu Nov 13 14:12:19 2014 +0100 +++ b/xmpp/xep-proto-namespace-delegation.xml Tue Nov 18 13:20:14 2014 +0100 @@ -42,13 +42,13 @@ </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 use 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 (independant of server) on stanza is also provided.</p> - <p>This XEP is complementary to priviliged entity XEP (and works in a similar way), although they can be used together or separely</p> + <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 priviliged entity XEP (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 lack some features</li> + <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>do a component which react on new user registration, independent of server implementation</li> + <li>make a component which react on new user registration, independent of server implementation</li> <li>server agnostic roster filtering</li> </ul> </section1> @@ -58,22 +58,22 @@ <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 manage 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 autorization 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> + <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>Managing entity</strong> — the entity which actualy manage the delegated namespace.</li> + <li><strong>Managing entity</strong> — the entity which actualy manages the delegated namespace.</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='Delegation Request Use Case' anchor='admin_perm'> - <section3 topic='Entity Request Delegation Of Namespaces' anchor='req_delegation'> - <p>Once the managing entity is authentified and stream is started, the entity can request to manage a namespace. It do it by sending an &IQ; stanza with <strong>'urn:xmpp:delegation:0'</strong> namespace. The &QUERY; element MUST have a type of value "request" and MAY have a 'delegation' attribute with the value "admin".</p> - <p>Namespace delegations are asked with a <delegate/> element, which MUST contain a 'namespace' attribute set to the requested namespace</p> + <section3 topic='Entity Requests Namespace Delegation' anchor='req_delegation'> + <p>Once the managing entity is authenticated and stream is started, the entity can request to manage a namespace. It does it by sending an &IQ; stanza with <strong>'urn:xmpp:delegation:0'</strong> namespace. The &QUERY; element MUST have a type of value "request" and MAY have a 'delegation' attribute with the value "admin".</p> + <p>Namespace delegations are asked with a <delegate/> element, which MUST contain a 'namespace' attribute set to the requested namespace.</p> <p>Only <iq/> stanza namespaces can be delegated.</p> <example caption='entity asks for delegation in admin mode'><![CDATA[ <iq from='pubsub.capulet.lit' type='get' id='delegation1'> @@ -84,8 +84,8 @@ </iq> ]]></example> </section3> - <section3 topic='Server Accept Namespace Delegation' anchor='accept_delegation'> - <p>If the server accept the delegation (e.g.: namespace mapping specified in configuration), it MUST return an &IQ; result stanza, with allowed delegations in <delegate> elements:</p> + <section3 topic='Server Accepts Namespace Delegation' anchor='accept_delegation'> + <p>If the server accepts the delegation (e.g.: namespace mapping specified in configuration), it MUST return an &IQ; result stanza, with allowed delegations in <delegate> elements:</p> <example caption='server accept namespace delegations'><![CDATA[ <iq from='capulet.lit' to='pubsub.capulet.lit' type='result' id='delegation1'> <query xmlns='urn:xmpp:delegation:0' type='allowed'> @@ -95,11 +95,11 @@ </iq> ]]></example> <p>Note: the granted delegations MAY be different from the requested ones, according to server's configuration.</p> -<p>The server MUST then forward all requests done to itself on this namespace to the managing entity, except the request done by the managing entity itself (see below).<br/> - The server MUST NOT forward any request done to an other entity than itself or a bare jid with its domain.</p> +<p>The server MUST then forward all requests made to itself on this namespace to the managing entity, except the requests made by the managing entity itself (see below).<br/> + The server MUST NOT forward any request made to an other entity than itself or to a bare JID within its domain.</p> </section3> - <section3 topic='Server Reject Namespace Delegation' anchor='reject_delegation'> - <p>If the server reject the delegation, it MUST return a &forbidden; error:</p> + <section3 topic='Server Rejects Namespace Delegation' anchor='reject_delegation'> + <p>If the server rejects the delegation, it MUST return a &forbidden; error:</p> <example caption='server reject delegation'><![CDATA[ <iq from='capulet.lit' to='pubsub.capulet.lit' type='error' id='delegation1'> <error type='cancel'> @@ -110,9 +110,9 @@ </section3> </section2> - <section2 topic='Server Forward 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 the bare jid of the sender (e.g. if 'from' attribute is "<em>juliet@capulet.lit/balcony</em>" and 'to' attribute is "<em>juliet@capulet.lit</em>"), it MUST forward it to the managing entity by replacing the 'to' attribute with the jid of the managing entity:</p> - <example caption='juliet send her mood to her sever via pep'><![CDATA[ + <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 the bare JID of the sender (e.g. if 'from' attribute is "<em>juliet@capulet.lit/balcony</em>" and 'to' attribute is "<em>juliet@capulet.lit</em>"), it MUST forward it to the managing entity by replacing the 'to' attribute with the JID of the managing entity:</p> + <example caption='Juliet sends her mood to her server via PEP'><![CDATA[ <iq from='juliet@capulet.lit/balcony' id='pep1' type='set'> @@ -128,9 +128,9 @@ </pubsub> </iq> ]]></example> -<p>The server get this stanza, see that this namespace is delegated to <em>pubsub.capulet.lit</em>, so it forward it:</p> +<p>The server gets this stanza, sees that this namespace is delegated to <em>pubsub.capulet.lit</em>, so it forwards it:</p> -<example caption='sever delegate the stanza to pubsub.capulet.lit'><![CDATA[ +<example caption='server delegate the stanza to pubsub.capulet.lit'><![CDATA[ <iq from='juliet@capulet.lit/balcony' to='pubsub.capulet.lit' id='delegate1' @@ -148,33 +148,33 @@ </iq> ]]></example> -<p>The managing entity reply normally to the stanza:</p> -<example caption='pubsub.capulet.lit reply to juliet'><![CDATA[ +<p>The managing entity replies normally to the stanza:</p> +<example caption='pubsub.capulet.lit replies to Juliet'><![CDATA[ <iq from='pubsub.capulet.lit' - to='juliet.capulet.lit/balcony' + to='juliet@capulet.lit/balcony' id='delegate1' type='result'> <pubsub xmlns='http://jabber.org/protocol/pubsub' /> </iq> ]]></example> -<p>Then the server MUST change the from field of managing entity to its own field, and send the answer back to Julied with the original &IQ; id</p> +<p>Then the server MUST change the from field of managing entity to its own JID, and send the answer back to Juliet with the original &IQ; id.</p> -<example caption='capulet.lit reply to juliet'><![CDATA[ +<example caption='capulet.lit replies to Juliet'><![CDATA[ <iq from='capulet.lit' - to='juliet.capulet.lit/balcony' + 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>The workflow is fully transparent for Juliet.</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 special treatments</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 filter allowed entity (which can be added to a roster), and sort them in enforced groups</p> + <p>If a stanza is sent by the managing entity on a managed namespace, the server MUST NOT forward it. This way, the managing entity can use privileged entity to do special treatments.</p> + <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 add Romeo to her roster'><![CDATA[ + <example caption='Juliet adds Romeo to her roster'><![CDATA[ <iq from='juliet@capulet.lit/balcony' id='roster1' type='set'> @@ -186,7 +186,7 @@ </iq> ]]></example> - <example caption='server forward stanza to managing entity'><![CDATA[ + <example caption='server forwards stanza to managing entity'><![CDATA[ <iq from='juliet@capulet.lit/balcony' to='filter.capulet.lit' id='delegate1' @@ -199,7 +199,7 @@ </iq> ]]></example> -<p><em>filter.capulet.lit</em> accept to add Romeo, but all jids with a <em>montaigu.lit</em> must be in a "Rivals" group, so it first return a success result (romeo is accepted)</p> +<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='filter.capulet.lit' to='juliet@capulet.lit/balcony' @@ -212,8 +212,8 @@ 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 use this ability to add romeo with the enforced group:</p> - <example caption='filter.capulet.lit use privileged entity to add romeo'><![CDATA[ + <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' @@ -226,7 +226,7 @@ </query> </iq> ]]></example> - <p>The namespace is delegated, but as the stanza is from the managing entity, the server manage it normally. The entity is also privileged, so it can change the stanza of Juliet, the server accept:</p> + <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' @@ -251,7 +251,7 @@ <li>the delegation type is <em>client</em> instead of <em>admin</em></li> <li>the delegation is done per entity, so the managed entity MUST be specified in a 'to' attribute</li> </ol> - <p>If an entity want to manage PEP service for juliet, it can ask the delegation like this: + <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'> @@ -269,9 +269,9 @@ <message from='capulet.lit' to='juliet@capulet.lit'> <body> pubsub.montaigu.lit wants to manage a feature normally managed by the server. - Do you you allow him to manage the following features ? + Do you allow it to manage the following features? - Be careful ! According management to entity is a serious thing, + 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'> @@ -305,8 +305,8 @@ </x> </message> ]]></example> - <p>Here juliet accept that <em>pubsub.montaigu.lit</em> manage the PubSub (and then PEP) service.</p> - <p>Finaly, the server notify the entity of the delegation granted. For this it use a &QUERY; element with the 'allowed' type, and put the client jid in a 'from' attribute:</p> + <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. For this it uses a &QUERY; element with the 'allowed' type, and puts the client JID in a 'from' attribute:</p> <example caption='server notify accepted delegations'><![CDATA[ <iq from='capulet.lit' to='pubsub.montaigu.lit' type='set' id='delegation2'> <query xmlns='urn:xmpp:delegation:0' @@ -322,8 +322,8 @@ </section1> <section1 topic='Configuration' anchor='configuration'> - <p>Server SHOULD provide a way to clients to check already delegated namespaces, and revoke them by using &xep0050; on the well-defined command node of <strong>'urn:xmpp:delegation:0#configure'</strong>.</p> - <p>If present, the configurations 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> + <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:0#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'> @@ -352,10 +352,10 @@ </section2> <section2 topic='Nesting' anchor='disco_nesting'> <section3 topic='General Case'> - <p>When a server delegate 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 done in the following way: if pubsub.capulet.int manage pubsub namespace, it MUST report that fact in discovery feature, and have a '<strong>urn:xmpp:delegation:0::http://jabber.org/protocol/pubsub</strong>' node which report features managed.</p><p>The node name is obtained by concatenating this XEP namespace (<strong>urn:xmpp:delegation:0</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 delegate it's internal PEP component to pubsub.capulet.int. capulet.int only support REQUIRED PubSub features and auto-create, while pubsub.capulet.int support also REQUIRED PubSub features and publish-options, but not auto-create. <br/>juliet@capulet.int ask its server what it is capable of, she is specially interested in PubSub capabilities.</p> -<example caption="Juliet ask her server its available features"><![CDATA[ + <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 done the following way: if pubsub.capulet.int manages pubsub namespace, it MUST report that fact in discovery feature, and have a '<strong>urn:xmpp:delegation:0::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:0</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' @@ -364,8 +364,8 @@ </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 request disco infos for pubsub namespace to pubsub.capulet.lit"><![CDATA[ +<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' @@ -376,7 +376,7 @@ ]]> </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> return its available features</p> + <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' @@ -413,11 +413,11 @@ </example> <p>Note that '<em>http://jabber.org/protocol/pubsub#auto-create</em>' is not available.</p> </section3> - <section3 topic='rediction of bare jid disco info'> - <p>As an entity may ask for discovery informations on bare jid, which the server would answer, the managing entity must be able to send this kind of information.</p> + <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 ask features for its own bare jid"><![CDATA[ +<example caption="Juliet asks features for its own bare JID"><![CDATA[ <iq from='juliet@capulet.lit/balcony' id='disco3' to='juliet@capulet.lit' @@ -426,8 +426,8 @@ </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 request disco infos for pubsub namespace to pubsub.capulet.lit"><![CDATA[ +<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' @@ -438,7 +438,7 @@ ]]> </example> <p>As for general case, server has probably <link url='#impl'>this information already in cache</link>.<br/> - <em>pubsub.capulet.lit</em> return its available features</p> + <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' @@ -463,8 +463,8 @@ </iq> ]]> </example> -<p>then the server return the answer to Juliet, as in general case, with requested bare jid in 'from' field.</p> -<example caption="capulet.lit return disco info to Juliet"><![CDATA[ +<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' @@ -495,10 +495,10 @@ <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 do so, it MUST provide configuration like explained in the <link url='#configuration'>suitable section</link>. If server offer this feature, it SHOULD add a field directly in configuration commands.</li> + <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>The namespace of this XEP (<strong>urn:xmpp:delegation:0</strong>) MUST NOT be delegated. If an entity request it, the server MUST return a &forbidden; error</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>The namespace of this XEP (<strong>urn:xmpp:delegation:0</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'> @@ -510,9 +510,9 @@ <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>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> + <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'>
--- a/xmpp/xep-proto-privileged-component.xml Thu Nov 13 14:12:19 2014 +0100 +++ b/xmpp/xep-proto-privileged-component.xml Tue Nov 18 13:20:14 2014 +0100 @@ -69,7 +69,7 @@ <section1 topic='Introduction' anchor='intro'> <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 (and in <link url='#special'>some cases</link>, send &MESSAGE; or receive &PRESENCE; stanzas).</p> - <p>Privileged entity have numerous advantages, including:</p> + <p>Privileged entities have numerous advantages, including:</p> <ul> <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> <li>better integration of components: a gateway can add items to an entity roster itself</li> @@ -86,27 +86,27 @@ <li><strong>client</strong> mode, where it can be installed by any user</li> </ul> <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. The privilege mechanism MUST be totally transparent for the managed entities.</p> - <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> - <p>In addition, some <link url='#special'>special permissions</link> can permit to send &MESSAGE; stanzas on behalf of the server or access &PRESENCE; informations</p> + <p>In <em>client</em> mode, a privileged entity MUST have an explicit authorization 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> + <p>In addition, some <link url='#special'>special permissions</link> can permit to send &MESSAGE; stanzas on behalf of the server or access &PRESENCE; informations.</p> </section1> <section1 topic='Glossary' anchor='glossary'> <ul> - <li><strong>Privileged entity</strong> — the entity which has or wants a privileged status.</li> - <li><strong>Managed entity</strong> — the entity that the privileged entity wants to manage.</li> + <li><strong>Privileged entity</strong> — the entity which has a privileged status.</li> + <li><strong>Managed entity</strong> — the entity that is managed by a privileged entity.</li> </ul> </section1> <section1 topic='Admin Mode Use Cases' anchor='admin_usecases'> <section2 topic='Permission Request Use Case' anchor='admin_perm'> - <section3 topic='Entity request privileged status of admin' anchor='req_status'> - <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> + <section3 topic='Entity Requests Admin Privilege' anchor='req_status'> + <p>Once an entity is authenticated and stream is started, it can request a privileged status. It does it by sending an &IQ; stanza with <strong>'urn:xmpp:privilege:0'</strong> namespace.</p> <p>The &QUERY; element MUST have a "request" type and MAY have a 'privilege' attribute with the value "admin". Namespace permissions are asked with a <perm/> element, which MUST contain a 'namespace' attribute set to the requested namespace and a 'type' attribute which can be:</p> <ul> - <li><strong>get</strong> — the entity wants to send &IQ; stanza of type <em>'get'</em></li> - <li><strong>set</strong> — the entity wants to send &IQ; stanza of type <em>'set'</em></li> - <li><strong>both</strong> — the entity wants to send &IQ; stanza of type <em>'get'</em> and <em>'set'</em></li> + <li><strong>get</strong> — the entity needs the privilege to send &IQ; stanzas of type <em>'get'</em></li> + <li><strong>set</strong> — the entity needs the privilege to send &IQ; stanzas of type <em>'set'</em></li> + <li><strong>both</strong> — the entity needs the privilege to send &IQ; stanzas of type <em>'get'</em> and <em>'set'</em></li> </ul> <example caption='Entity asks for admin privilege'><![CDATA[ <iq from='pubsub.capulet.net' type='get' id='privilege1'> @@ -117,9 +117,9 @@ </iq> ]]></example> </section3> - <section3 topic='Server Accept Admin Privilege' anchor='accept_status'> - <p>If the server accept the privileged status (e.g.: admin status specified in configuration), it MUST return an &IQ; result stanza with a "allowed" &QUERY; type, and allowed permissions in <perm/> elements:</p> - <example caption='Server accept admin privilege'><![CDATA[ + <section3 topic='Server Accepts Admin Privilege' anchor='accept_status'> + <p>If the server accepts the privileged status (e.g.: admin status specified in configuration), it MUST return an &IQ; result stanza with a &QUERY; element of type "allowed", and listing the allowed permissions in <perm/> elements:</p> + <example caption='Server accepts admin privilege'><![CDATA[ <iq from='capulet.net' to='pubsub.capulet.net' type='result' id='privilege1'> <query xmlns='urn:xmpp:privilege:0' type='allowed'> @@ -130,9 +130,9 @@ ]]></example> <p>Note: the granted permissions MAY be different from the requested ones, according to server's configuration.</p> </section3> - <section3 topic='Server Reject Admin Privilege' anchor='reject_status'> - <p>If the server reject the privileged status, it MUST return a &forbidden; error:</p> - <example caption='Server reject admin privilege'><![CDATA[ + <section3 topic='Server Rejects Admin Privilege' anchor='reject_status'> + <p>If the server rejects the privileged status, it MUST return a &forbidden; error:</p> + <example caption='Server rejects admin privilege'><![CDATA[ <iq from='capulet.net' to='pubsub.capulet.net' type='error' id='privilege1'> <error type='cancel'> <forbidden xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> @@ -142,9 +142,9 @@ </section3> </section2> - <section2 topic='Privileged Entity Send &IQ; Stanzas' anchor='priv_iq_admin'> - <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> - <example caption='Privileged Entity Send A Roster Stanza'><![CDATA[ + <section2 topic='Privileged Entity Sends &IQ; Stanzas' anchor='priv_iq_admin'> + <p>Sending an &IQ; stanza 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 owns a node with access model based on publiser's roster:</p> + <example caption='Privileged Entity Sends A Roster Stanza'><![CDATA[ <iq id='roster1' xmlns='urn:xmpp:privilege:0' to='juliet@example.com' @@ -154,8 +154,8 @@ </iq> ]]></example> - <p>The server then answer normaly, as it would have done with the managed entity:</p> - <example caption='Server Answer To Privileged Entity'><![CDATA[ + <p>The server then answers normally, as it would have done to the managed entity:</p> + <example caption='Server Answers To Privileged Entity'><![CDATA[ <iq id='roster1' from='juliet@example.com' to='pubsub.capulet.net' @@ -177,7 +177,7 @@ </pubsub> </iq> ]]></example> - <p>and server answer:</p> + <p>and server answers:</p> <example caption='Server Returns Bookmarks'><![CDATA[ <iq id='bookmark1' @@ -206,11 +206,11 @@ <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> <ol> <li>the privilege type is <em>client</em> instead of <em>admin</em></li> - <li>the privilege is done per entity, so the managed entity MUST be specified in a 'to' attribute</li> + <li>the privilege is given per entity, so the managed entity MUST be specified in a 'to' attribute</li> </ol> - <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: + <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: </p> - <example caption='Entity Asks For User Privilege'><![CDATA[ + <example caption='Entity asks for user privilege'><![CDATA[ <iq from='priv.montaigu.net' to='capulet.net' type='get' id='privilege1'> <query xmlns='urn:xmpp:privilege:0' type='request' @@ -221,15 +221,15 @@ </query> </iq> ]]></example> -<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. +<p>Once received the permission request, the server asks the client to grant or deny the requested permission using &xep0004;. The form SHOULD allow to fine tune the granted permissions. The server uses a challenge which it MUST have generated himself. </p> - <example caption='Server Asks User For The Permission'><![CDATA[ + <example caption='Server asks user for the permission'><![CDATA[ <message from='capulet.net' to='juliet@capulet.net'> <body> priv.montaigu.net wants some privileges. - Do you you allow him to use the following features ? + Do you you allow him to use the following features? - Be careful ! According permissions to entity is a serious thing, + Be careful! According permissions 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'> @@ -273,8 +273,8 @@ </x> </message> ]]></example> -<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> -<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> +<p>Here Juliet allows <em>priv.montaigu.net</em> to use 'set' and 'get' in order to manage her roster, but doesn't want it to do any 'get' on her pubsub nodes.</p> +<p>Finaly, the server notify the entity of the granted permissions. For this it uses a &QUERY; element with the 'allowed' type, and puts the client JID in a 'from' attribute:</p> <example caption='Server notify accepted permissions'><![CDATA[ <iq from='capulet.net' to='priv.montaigu.net' type='set' id='privilege2'> <query xmlns='urn:xmpp:privilege:0' @@ -287,8 +287,8 @@ ]]></example> <p>The privileged entity can now act according to permission granted to him.</p> </section2> -<section2 topic='Privileged Entity Send &IQ; Stanzas' anchor='priv_iq_client'> - <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> +<section2 topic='Privileged Entity Sends &IQ; Stanzas' anchor='priv_iq_client'> + <p>Sending &IQ; stanzas is done in the exact same way as for <link url='#priv_iq_admin'>admin mode</link>. If an entity wants to sent a non authorized &IQ;, it will get a &forbidden; error:</p> <example caption='Entity Request bookmarks'><![CDATA[ <iq to='juliet@capulet.lit' type='get' id='bookmark1'> <pubsub xmlns='http://jabber.org/protocol/pubsub'> @@ -308,18 +308,18 @@ </section1> <section1 topic='Special permissions' anchor='special'> - <p>In some case, an entity may need extra permission beyond what &IQ; stanzas can do. An entity may want to send &MESSAGE; stanzas on behalf of the server, or get &PRESENCE; informations. The special permissions manage these cases with some restrictions.</p> + <p>In some cases, an entity may need extra permission beyond what &IQ; stanzas can do. An entity may want to send &MESSAGE; stanzas on behalf of the server, or get &PRESENCE; informations. The special permissions manage these cases with some restrictions.</p> - <section2 topic='message permission' anchor='message'> + <section2 topic='Message Permission' anchor='message'> <p>With some namespaces it can be desirable to send notifications (e.g. PEP service), so the privileged entity must be able to send &MESSAGE; stanzas. To do this, it MUST request it by using a <perm/> element with the special "message" namespace attribute and a 'type' attribute with the value "outgoing" (any other type MUST be rejected with a &forbidden; error).</p> - <p>A privileged entity can then send message on the behalf either of the server or of a bare jid of the server, using &xep0297;, with the following restrictions:</p> + <p>A privileged entity can then send message on the behalf either of the server or of a bare JID of the server, using &xep0297;, with the following restrictions:</p> <ol> <li>forwarded &MESSAGE; 'type' attribute has the value of "headline"</li> - <li>forwarded &MESSAGE; 'from' attribute MUST be a bare jid from the server, no resource is allowed</li> + <li>forwarded &MESSAGE; 'from' attribute MUST be a bare JID from the server, no resource is allowed</li> <li>in client mode, the forwarded &MESSAGE; 'from' attribute can only be one of a managed entity which has explicitly accepted the delegation</li> </ol> <p>If any of this rules is violated, the server MUST return a <not-authorized/> stream error and close the connection, as explained in &rfc6120; section 4.9.3.12.</p> - <p>In the following example, pubsub.capulet.lit ask for pubsub and outgoing messages permission</p> + <p>In the following example, <em>pubsub.capulet.lit</em> asks for pubsub and outgoing messages permission</p> <example caption='entity asks for outgoing messages permission'><![CDATA[ <iq from='pubsub.capulet.net' type='get' id='privilege1'> <query xmlns='urn:xmpp:privilege:0' type='request' privilege='admin'> @@ -329,7 +329,7 @@ </iq> ]]></example> - <example caption='server accept permissions'><![CDATA[ + <example caption='server accepts permission'><![CDATA[ <iq from='capulet.net' to='pubsub.capulet.net' type='result' id='privilege1'> <query xmlns='urn:xmpp:privilege:0' type='allowed'> <perm namespace='message' type='outgoing'/> @@ -364,8 +364,8 @@ </forwarded> </message> ]]></example> - <p>The server see that forwarded message type is '<em>headline</em>', that <em>juliet@capulet.lit</em> is a bare jid of the server, and that outgoing message permission was granted in admin mode (so all bare jids from server are allowed); it can now send the notification:</p> - <example caption='server send the notification as if it was originating from him'><![CDATA[ + <p>The server sees that forwarded message type is '<em>headline</em>', that <em>juliet@capulet.lit</em> is a bare JID of the server, and that outgoing message permission was granted in admin mode (so all bare JIDs from server are allowed); it can now send the notification:</p> + <example caption='server sends the notification as if it was originating from him'><![CDATA[ <message from='juliet@capulet.lit' id='bar' to='romeo@montague.lit/orchard' @@ -390,7 +390,7 @@ <section2 topic='Managed Entity Presence' anchor='managed_ent_presence'> <p>It can be often desirable for a privileged entity to have presence information of the managed entities (e.g. to know when to send it notificiations). As privileges must be transparent for the managed entity (in admin mode), this presence has to be sent by the server without modifying managed entity roster.</p> - <p>To do this, the privileged entity MUST ask for presence information when requesting privileges, using a special "presence" namespace attribute and a 'type' attribute with the value "managed_entity".</p><p>If the delegation is granted, the server MUST use a directed presence, as specified in &rfc6121; section 4.6 on the behalf of managed entity each time its presence information change.</p><p>This privilege MUST NOT be requested in client mode, and the server MUST reject the permission by setting the allowed type to "none". If an entity need presence information in client mode, it SHOULD request it using the normal &PRESENCE; subscription mechanism.</p> + <p>To do this, the privileged entity MUST ask for presence information when requesting privileges, using a special "presence" namespace attribute and a 'type' attribute with the value "managed_entity".</p><p>If the delegation is granted, the server MUST use a directed presence, as specified in &rfc6121; section 4.6 on the behalf of managed entity each time its presence information change.</p><p>This privilege MUST NOT be requested in client mode, if so the server MUST reject the request by setting the allowed type to "none". If an entity needs presence information in client mode, it SHOULD request it using the normal &PRESENCE; subscription mechanism.</p> <example caption='privileged entity asks for pusub privilege with presence'><![CDATA[ <iq from='pubsub.capulet.net' type='get' id='privilege1'> <query xmlns='urn:xmpp:privilege:0' type='request' privilege='admin'> @@ -400,7 +400,7 @@ </iq> ]]></example> -<example caption='server accept privileges'><![CDATA[ +<example caption='server accepts privileges'><![CDATA[ <iq from='capulet.net' to='pubsub.capulet.net' type='result' id='privilege1'> <query xmlns='urn:xmpp:privilege:0' type='allowed'> <perm namespace='presence' type='managed_entity'/> @@ -409,7 +409,7 @@ </iq> ]]></example> -<example caption='server receive new presence from juliet'><![CDATA[ +<example caption='server receives new presence from Juliet'><![CDATA[ <presence from='juliet@capulet.lit/balcony' id='presence1' xml:lang='en'> @@ -417,7 +417,7 @@ <status>Staying on the balcony</status> </presence> ]]></example> -<example caption='server redirect presence to privileged entity'><![CDATA[ +<example caption='server redirects presence to privileged entity'><![CDATA[ <presence from='juliet@capulet.lit/balcony' to='pubsub.capulet.lit' id='presence1' @@ -432,7 +432,7 @@ <p>In addition to "<link url='#managed_ent_presence'>managed entity presence</link>", a privileged entity may need to know when a contact in managed entity roster is online (for example, it's necessary for a PEP service because of the presence default access model).</p> <p>In this case, privileged entity MUST ask for presence information when requesting privileges, using a special "presence" namespace attribute (as in previous section) and a 'type' attribute with the value "roster". Furthermore, the privileged entity MUST have read permission on roster namespace (i.e. 'type' attribute in allowed <perm> of namespace <em>jabber:iq:roster</em> MUST have a value of either <strong>get</strong> or <strong>both</strong>).</p> <p>If the delegation is granted, the server MUST send to the privileged entity every presence information that the managing entity is receiving.</p><p>The server MUST reject the permission if the privileged entity doesn't have read permission on roster namespace.</p> - <p>Note: this permission should be given carefully, as it give access to presence of potentially a lot of entities to the privileged entity (see <link url='#security'>security considerations</link>). If allowed in client mode, server SHOULD display an extra warning when requesting permissions to the managed entity.</p> + <p>Note: this permission should be given carefully, as it gives access to presence of potentially a lot of entities to the privileged entity (see <link url='#security'>security considerations</link>). If allowed in client mode, server SHOULD display an extra warning when requesting permissions to the managed entity.</p> <example caption='privileged entity asks for pusub privilege with presence roster'><![CDATA[ <iq from='pubsub.capulet.net' type='get' id='privilege1'> <query xmlns='urn:xmpp:privilege:0' type='request' privilege='admin'> @@ -444,7 +444,7 @@ ]]></example> <p>Note the presence of <em>jabber:iq:roster</em> permission request.</p> -<example caption='server accept privileges'><![CDATA[ +<example caption='server accepts privileges'><![CDATA[ <iq from='capulet.net' to='pubsub.capulet.net' type='result' id='privilege1'> <query xmlns='urn:xmpp:privilege:0' type='allowed'> <perm namespace='presence' type='roster'/> @@ -454,10 +454,10 @@ </iq> ]]></example> -<example caption="server receive new presence from Romeo, which is in Juliet's roster"><![CDATA[ +<example caption="server receives new presence from Romeo, which is in Juliet's roster"><![CDATA[ <presence from='romeo@montaigu.lit/orchard'/> ]]></example> -<example caption='server send the presence as usually, but also to the privileged entity'><![CDATA[ +<example caption='server sends the presence as usually, but also to the privileged entity'><![CDATA[ <presence from='romeo@montaigu.lit/orchard' to='juliet@capulet.lit'/> <presence from='romeo@montaigu.lit/orchard' @@ -467,12 +467,12 @@ </section1> <section1 topic='Configuration' anchor='configuration'> - <p>Server SHOULD provide a way to clients to check already granted permission, and revoke them by using &xep0050; on the well-defined command node of <strong>'urn:xmpp:privilege:0#configure'</strong>.</p> - <p>If present, the configurations commands MUST allow at least to check permissions granted to a privileged entity, and to revoke them. A server MAY offer an option to keep permission from one session to an other (see <link url='#rules'>business rules</link>).</p> + <p>Server SHOULD provide a way for clients to check already granted permission, and revoke them by using &xep0050; on the well-defined command node <strong>'urn:xmpp:privilege:0#configure'</strong>.</p> + <p>If present, the configuration commands MUST allow at least to check permissions granted to a privileged entity, and to revoke them. A server MAY offer an option to keep permission from one session to an other (see <link url='#rules'>business rules</link>).</p> </section1> <section1 topic='Discovering Support' anchor='disco'> - <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> + <p>If a server or an entity supports the privileged entity 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> <example caption="Service Discovery information request"><![CDATA[ <iq from='pubsub.capulet.net' id='disco1' @@ -497,24 +497,24 @@ <section1 topic='Business Rules' anchor='rules'> <ol> - <li>In client mode, 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 configuration like explained in the <link url='#configuration'>suitable section</link>. If server offer this feature, it SHOULD add a field directly in configuration commands.</li> + <li>In client mode, 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 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 permission (i.e. it doesn't support &xep0050;) when granting permissions, the server MUST NOT keep granted permissions from one session to an other, and permissions will be asked on each new session.</li> - <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> - <li>A server MUST NOT grant permission for this XEP namespace (<strong>'urn:xmpp:privilege:0'</strong>)</li> + <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> + <li>A server MUST NOT grant permission for this XEP namespace (<strong>'urn:xmpp:privilege:0'</strong>).</li> </ol> </section1> <section1 topic='Implementation Notes' anchor='impl'> - <p>As admin mode is far more easy to implement than client mode, a server MAY choose to only implement the former</p> + <p>As admin mode is far more easy to implement than client mode, a server MAY choose to only implement the former.</p> </section1> <section1 topic='Security Considerations' anchor='security'> <ol> <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> <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> - <li><link url='#roster_presence'>Roster presence</link> is particulary sensitive, because if an entity accept this permission, it give presence information from its whole roster. For this reason, a server MAY choose to forbid its use in client mode (by always setting the allowed type to "<strong>none</strong>"). A server SHOULD at least disallow it in default configuration.</li> + <li><link url='#roster_presence'>Roster presence</link> is particulary sensitive, because if an entity accept this permission, it shares presence information of its whole roster. For this reason, a server MAY choose to forbid its use in client mode (by always setting the allowed type to "<strong>none</strong>"). A server SHOULD at least disallow it in default configuration.</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> + <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>