Mercurial > sat_docs
diff xmpp/xep-0356.xml @ 43:4c5bd7ddaaca
xep: updated XEP-0356 (privileged entity):
Several updates according to feedbacks + review:
- added links to PEP and namespace delegation XEPs
- removed MUST for default values in configuration
- <forwarded/> element is now a child of a <privilege/> element
- <perm/> "namespace" attribute has been renamed to "access"
- "headline" type restriction for "message" privilege has been removed
- "message" permission violation now result in a "forbidden" message error
- for "presence" permission, only <presence/> stanza with no type or with a "unavailable" type are sent to privileged entity
- added specifitation for "presence" if a managed entity is unavailable and if a privileged entity is available after first <presence/> stanzas have been received
- added Business Rules section
- Updated namespace to reflect incompatible changes
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Mon, 23 Mar 2015 18:41:01 +0100 |
| parents | 21d0d0ab7aa0 |
| children |
line wrap: on
line diff
--- a/xmpp/xep-0356.xml Sat Mar 21 20:07:46 2015 +0100 +++ b/xmpp/xep-0356.xml Mon Mar 23 18:41:01 2015 +0100 @@ -27,6 +27,26 @@ <jid>goffi@jabber.fr</jid> </author> <revision> + <version>0.2</version> + <date>2015-03-23</date> + <initials>jp</initials> + <remark> + <p>Several updates according to feedbacks + review:</p> + <ul> + <li>added links to PEP and namespace delegation XEPs</li> + <li>removed MUST for default values in configuration</li> + <li><forwarded/> element is now a child of a <privilege/> element</li> + <li><perm/> "namespace" attribute has been renamed to "access"</li> + <li>"headline" type restriction for "message" privilege has been removed</li> + <li>"message" permission violation now result in a "forbidden" message error</li> + <li>for "presence" permission, only &PRESENCE; stanza with no type or with a "unavailable" type are sent to privileged entity</li> + <li>added specifitation for "presence" if a managed entity is unavailable and if a privileged entity is available after first &PRESENCE; stanzas have been received</li> + <li>added Business Rules section</li> + <li>Updated namespace to reflect incompatible changes</li> + </ul> + </remark> + </revision> + <revision> <version>0.1</version> <date>2015-01-27</date> <initials>XEP Editor (mam)</initials> @@ -84,11 +104,12 @@ <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> - <li>possibility to overpass a server limitation (typically: incomplete PEP implementation)</li> + <li>possibility to overpass a server limitation (typically: incomplete &xep0163; implementation)</li> <li>quick development cycle: developers can implement the components they need without waiting for a new server release</li> <li>server agnostic</li> </ul> - <p>Privileged entity has been created with the main goal to create an external, server agnostic, PEP service. It is restricted to only a couple of features, see <link url='#acks'>Acknowledgements section</link> for more details</p> + <p>Privileged entity has been created with the main goal to create an external, server agnostic, PEP service. It is restricted to only a couple of features, see <link url='#acks'>Acknowledgements section</link> for more details.</p> + <p>This XEP is complementary to &xep0355; (and works in a similar way), although they can be used together or separately. To build something like an external PEP service, it is necessary to use both XEPs.</p> </section1> <section1 topic='Requirements' anchor='reqs'> @@ -113,19 +134,19 @@ <section2 topic='Server Allows Roster Access' anchor='server_roster'> <p>Roster access is granted in the server configuration. Roster access can have 4 types:</p> <ul> - <li><strong>none</strong> — the entity is not allowed to access managed entity roster at all. This MUST be the default value.</li> + <li><strong>none</strong> — the entity is not allowed to access managed entity roster at all. This is usually the default value.</li> <li><strong>get</strong> — the entity is allowed to send &IQ; stanzas of type <em>'get'</em> for the namespace 'jabber:iq:roster'.</li> <li><strong>set</strong> — the entity is allowed to send &IQ; stanzas of type <em>'set'</em> for namespace 'jabber:iq:roster'.</li> <li><strong>both</strong> — the entity is allowed to send &IQ; stanzas of type <em>'get'</em> and <em>'set'</em> for namespace 'jabber:iq:roster'.</li> </ul> </section2> - <section2 topic='Server Advertise Entity Of Allowed Permission' anchor='advertise_roster'> - <p>Once an entity is authenticated and stream is started, the server send it a &MESSAGE; stanza with a <privilege> elements which MUST have the namespace 'urn:xmpp:privilege:0'. This element contains <perm> elements which MUST contain a 'namespace' attribute of the value "jabber:iq:roster" and a 'type' attribute which must correspond to the type configured as specified in <link url='#server_roster'>"Server Allows Roster Access" section</link></p> - <example caption='Server Advertise Roster Privilege'><![CDATA[ + <section2 topic='Server Advertises Entity Of Allowed Permission' anchor='advertise_roster'> + <p>Once a privileged entity is authenticated and stream is started, the server send it a &MESSAGE; stanza with a <privilege/> elements which MUST have the namespace 'urn:xmpp:privilege:1'. This element contains <perm/> elements which MUST contain a 'access' attribute of the value "roster" and a 'type' attribute which must correspond to the type configured as specified in <link url='#server_roster'>"Server Allows Roster Access" section</link></p> + <example caption='Server Advertises Roster Privilege'><![CDATA[ <message from='capulet.net' to='pubub.capulet.lit' id='12345'> - <privilege xmlns='urn:xmpp:privilege:0'> - <perm namespace='jabber:iq:roster' type='both'/> + <privilege xmlns='urn:xmpp:privilege:1'> + <perm access='roster' type='both'/> </privilege> </message> ]]></example> @@ -164,24 +185,23 @@ <section2 topic='Authorizing Messages' anchor='auth_mess'> <p>In some cases, it can be desirable to send notifications (e.g. PEP service), so the privileged entity must be able to send &MESSAGE; stanzas. This is allowed in server configuration in the same way as for roster permission. The permission type can have the following values:</p> <ul> - <li><strong>none</strong> — the entity is not allowed to send &MESSAGE; stanza in the name of the server. This MUST be the default value.</li> + <li><strong>none</strong> — the entity is not allowed to send &MESSAGE; stanza in the name of the server. This is usually the default value.</li> <li><strong>outgoing</strong> — the entity is allowed to send &MESSAGE; stanzas in the name of the server, according to following restrictions.</li> </ul> - <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 an entity managed by the server (i.e. a bare jid with the same domain as the server), using &xep0297;. The <forwarded/> element MUST be a child of a <privilege/> element with a namespace of <em>'urn:xmpp:privilege:1'</em>, with the following restriction:</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> </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>If this rule is violated, the server MUST return a &MESSAGE; error with condition <forbidden/>, as in &rfc6120; section 8.3.3.4.</p> </section2> <section2 topic='Advertising Permission' anchor='advertise_mess'> - <p>Server advertise "message" permission in the same way as for "roster" permission, except that 'namespace' attribute has the value of "message", and the 'type' attribute as a value of 'outgoing':</p> - <example caption='Server Advertise Roster And Message Privileges'><![CDATA[ + <p>Server advertises "message" permission in the same way as for "roster" permission, except that 'access' attribute has the value of "message", and the 'type' attribute as a value of 'outgoing':</p> + <example caption='Server Advertises Roster And Message Privileges'><![CDATA[ <message from='capulet.net' to='pubub.capulet.lit' id='54321'> - <privilege xmlns='urn:xmpp:privilege:0'> - <perm namespace='jabber:iq:roster' type='both'/> - <perm namespace='message' type='outgoing'/> + <privilege xmlns='urn:xmpp:privilege:1'> + <perm access='roster' type='both'/> + <perm access='message' type='outgoing'/> </privilege> </message> ]]></example> @@ -191,36 +211,36 @@ <p>Now that <em>pubsub.capulet.lit</em> is allowed, it can send messages using <forwarded/> elements.</p> <example caption='privileged entity send a notificaction message'><![CDATA[ <message from='pubsub.capulet.lit' to='capulet.lit' id='notif1'> - <forwarded xmlns='urn:xmpp:forward:0'> - <message from='juliet@capulet.lit' - id='foo' - to='romeo@montague.lit/orchard' - type='headline' - xmlns='jabber:client'> - <event xmlns='http://jabber.org/protocol/pubsub#event'> - <items node='http://jabber.org/protocol/tune'> - <item> - <tune xmlns='http://jabber.org/protocol/tune'> - <artist>Gerald Finzi</artist> - <length>255</length> - <source>Music for "Love's Labors Lost" (Suite for small orchestra)</source> - <title>Introduction (Allegro vigoroso)</title> - <track>1</track> - </tune> - </item> - </items> - </event> - <delay xmlns='urn:xmpp:delay' stamp='2014-11-25T14:34:32Z'/> - </message> - </forwarded> + <privilege xmlns='urn:xmpp:privilege:1'> + <forwarded xmlns='urn:xmpp:forward:0'> + <message from='juliet@capulet.lit' + id='foo' + to='romeo@montague.lit/orchard' + xmlns='jabber:client'> + <event xmlns='http://jabber.org/protocol/pubsub#event'> + <items node='http://jabber.org/protocol/tune'> + <item> + <tune xmlns='http://jabber.org/protocol/tune'> + <artist>Gerald Finzi</artist> + <length>255</length> + <source>Music for "Love's Labors Lost" (Suite for small orchestra)</source> + <title>Introduction (Allegro vigoroso)</title> + <track>1</track> + </tune> + </item> + </items> + </event> + <delay xmlns='urn:xmpp:delay' stamp='2014-11-25T14:34:32Z'/> + </message> + </forwarded> + </privilege> </message> ]]></example> - <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> + <p>The server sees that forwarded message 'from' attribute (<em>juliet@capulet.lit</em>) is a bare JID of the server, and that outgoing message permission was granted; 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' - type='headline'> + to='romeo@montague.lit/orchard'> <event xmlns='http://jabber.org/protocol/pubsub#event'> <items node='http://jabber.org/protocol/tune'> <item> @@ -245,15 +265,16 @@ <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 them notificiations). As privileges must be transparent for the managed entity, this presence has to be sent by the server without modifying managed entity roster.</p> <p>This is allowed in server configuration in the same way as for <em>roster</em> and <em>message</em> permissions. The "presence" type can have the following values:</p> <ul> - <li><strong>none</strong> — the entity is not allowed to access &PRESENCE; informations at all. This MUST be the default value.</li> + <li><strong>none</strong> — the entity is not allowed to access &PRESENCE; informations at all. This is usually the default value.</li> <li><strong>managed_entity</strong> — the entity is allowed to receive managed entity presence (see below).</li> <li><strong>roster</strong> — the entity is allowed to receive presence informations of managed entity contacts, see <link url='#roster_presence'>Roster Presence section</link>.</li> </ul> - <p>If the privilege 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>If the privilege is granted, the server MUST use a directed presence from the full jid of the managed entity, to the privileged entity, as specified in &rfc6121; section 4.6, on the behalf of managed entity each time its presence information change.</p> + <p>Only presences with no 'type' attribute or with a 'type' attribute with the value "unavailable" are transmitted to the privileged entity, the server MUST NOT transmit &PRESENCE; stanza of any other type.</p> </section2> <section2 topic='Advertising Permission' anchor='advertise_managed_presence'> - <p>Server advertise "presence" permission in the same way as for "roster" or "message" permissions, except that 'namespace' attribute has the value of "presence", and the 'type' attribute has a value of "managed_entity"</p> + <p>Server advertises "presence" permission in the same way as for "roster" or "message" permissions, except that 'access' attribute has the value of "presence", and the 'type' attribute has a value of "managed_entity"</p> </section2> <section2 topic="Server Send presence informations" anchor='server_send_presence'> @@ -281,23 +302,25 @@ <section2 topic='Roster Presence' anchor='roster_presence'> <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>As for other permissions, the access in granted in server's configuration, but there is a additional restriction: 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 privileged entity is receiving. Having "roster" type for "presence" permission imply that you have also implicitly "managed_entity" type.</p><p>The server MUST reject the permission if the privileged entity doesn't have read permission on roster namespace.</p> + <p>As for other permissions, the access is granted in server's configuration, but there is an additional restriction: the privileged entity MUST have read permission on roster namespace (i.e. 'type' attribute in allowed <perm> of access <em>roster</em> MUST have a value of either <strong>get</strong> or <strong>both</strong>).</p> + <p>If the privilege is granted, the server MUST send to the privileged entity every presence information with no 'type' attribute or with a 'type' with a value of 'unavailable' that the privileged entity is receiving or would receive if it were available. It do it in the same way as for <link url='#managed_ent_presence'>managing entity</link> by using directed &PRESENCE; from the full jid of the entity from which presence information has changed, to the privileged entity. If the managed entity is unavailable but the privileged entity is available, the server MUST send &PRESENCE; stanza to the later anyway.</p> + <p>Having "roster" type for "presence" permission imply that you have also implicitly "managed_entity" type.</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 gives access to presence of potentially a lot of entities to the privileged entity (see <link url='#security'>security considerations</link>).</p> </section2> <section2 topic='Advertising Permission' anchor='advertise_roster_presence'> - <p>Server advertise roster "presence" permission in the same way as for other permissions, except that the 'namespace' attribute has the value of "presence", and the 'type' attribute has a value of "roster"</p> - <example caption='Server Advertise Roster, Message, Managed Entity Presence and Roster Presence Privileges'><![CDATA[ + <p>Server advertises roster "presence" permission in the same way as for other permissions, except that the 'access' attribute has the value of "presence", and the 'type' attribute has a value of "roster"</p> + <example caption='Server Advertises Roster, Message, Managed Entity Presence and Roster Presence Privileges'><![CDATA[ <message from='capulet.net' to='pubub.capulet.lit' id='54321'> - <privilege xmlns='urn:xmpp:privilege:0'> - <perm namespace='jabber:iq:roster' type='both'/> - <perm namespace='message'/> - <perm namespace='presence' type='roster'/> + <privilege xmlns='urn:xmpp:privilege:1'> + <perm access='roster' type='both'/> + <perm access='message'/> + <perm access='presence' type='roster'/> </privilege> </message> ]]></example> -<p>Note the presence of <em>jabber:iq:roster</em> permission request.</p> +<p>Note the presence of <em>roster</em> permission request.</p> </section2> <section2 topic="Privileged Entity Receive Roster Presences" anchor='priv_rec_roster_presence'> @@ -313,10 +336,18 @@ </section2> </section1> +<section1 topic='Business Rules' anchor='rules'> + <ol> + <li>For "presence" access, if a privileged entity is connected after first &PRESENCE; stanzas have been received, the server MUST send it all the &PRESENCE; stanzas with no 'type' attribute it would have had if it was connected first (in other words: all the presences informations for connected entities it has access to).</li> + <li>For "presence" access, if a privileged entity is supposed to received several time the same &PRESENCE; stanza, the server SHOULD send it only once. For example: if <em>pubsub.capulet.lit</em> has a "presence" access with a "roster" type for <em>capulet.lit</em>, and <em>juliet@capulet.lit</em> and <em>nurse@capulet.it</em> both have <em>romeo@montague.lit</em> in their roster. When romeo is available, <em>pubsub.capulet.lit</em> shoud have its &PRESENCE; stanza only once (instead of 2 times).</li> + </ol> +</section1> + <section1 topic='Security Considerations' anchor='security'> <ol> <li>Privileged entitiy has access to sensitive data, and can act as the server itself, permissions should be granted carefuly, only if you absolutely trust the entity.</li> <li><link url='#roster_presence'>Roster presence</link> is particulary sensitive, because presence informations of whole rosters are shared.</li> + <li>Generaly, the server MUST NOT allow the privileged entity to do anything that the managed entity could not do.</li> </ol> </section1> @@ -326,9 +357,9 @@ <section1 topic='XMPP Registrar Considerations' anchor='registrar'> <section2 topic='Protocol Namespaces' anchor='ns'> - <p>The ®ISTRAR; includes 'urn:xmpp:privilege:0' in its registry of protocol namespaces (see &NAMESPACES;).</p> + <p>The ®ISTRAR; includes 'urn:xmpp:privilege:1' in its registry of protocol namespaces (see &NAMESPACES;).</p> <ul> - <li>urn:xmpp:privilege:0</li> + <li>urn:xmpp:privilege:1</li> </ul> </section2> <section2 topic='Protocol Versioning' anchor='registrar-versioning'> @@ -342,8 +373,8 @@ <xs:schema xmlns:xs='http://www.w3.org/2001/XMLSchema' - targetNamespace='urn:xmpp:privilege:0' - xmlns='urn:xmpp:privilege:0' + targetNamespace='urn:xmpp:privilege:1' + xmlns='urn:xmpp:privilege:1' elementFormDefault='qualified'> <xs:element name='privilege'> @@ -351,9 +382,9 @@ <xs:element name='perm' maxOccurs='unbounded'> <xs:complexType> - <xs:attribute name='namespace' use='required' type='xs:string'/> + <xs:attribute name='access' use='required' type='xs:string'/> <xs:simpleType base='xs:NMTOKEN'> - <xs:enumeration value='jabber:iq:roster'/> + <xs:enumeration value='roster'/> <xs:enumeration value='message'/> <xs:enumeration value='presence'/> </xs:simpleType> @@ -378,7 +409,7 @@ </section1> <section1 topic='Acknowledgements' anchor='acks'> - <p>Thanks to Sergey Dobrov, Dave Cridland, Steven Lloyd Watkin, Lance Stout and Johannes Hund for their feedbacks. Thanks to Adrien Cossa for his typos/style corrections.</p> + <p>Thanks to Sergey Dobrov, Dave Cridland, Steven Lloyd Watkin, Lance Stout, Johannes Hund, Kurt Zeilenga and Kevin Smith for their feedbacks. Thanks to Adrien Cossa for his typos/style corrections.</p> <p>Privileged entity was initialy written to be a generic identity based access control (IBAC) which allows an entity to access sensitive data. After <link url='http://mail.jabber.org/pipermail/standards/2014-December/029378.html'>a discussion on standard mailing list</link>, it has been decided to restrict the current XEP to immediate needs to build an external PEP service, and to implement separately an Attribute Based Access Control (ABAC) which is more modern, generic and flexible. This XEP is still interesting for being easy to implement and doing the job.</p> </section1>