# HG changeset patch
# User souliane 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. This XEP is complementary to priviliged entity XEP (and works in a similar way), although they can be used together or separely 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. This XEP is complementary to priviliged entity XEP (and works in a similar way), although they can be used together or separately. Here are some use cases of namespace delegation: In admin 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. In client 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. In admin 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. In client 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. 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 'urn:xmpp:delegation:0' namespace. The &QUERY; element MUST have a type of value "request" and MAY have a 'delegation' attribute with the value "admin". Namespace delegations are asked with a <delegate/> element, which MUST contain a 'namespace' attribute set to the requested namespace 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 'urn:xmpp:delegation:0' namespace. The &QUERY; element MUST have a type of value "request" and MAY have a 'delegation' attribute with the value "admin". Namespace delegations are asked with a <delegate/> element, which MUST contain a 'namespace' attribute set to the requested namespace. Only <iq/> stanza namespaces can be delegated. 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: 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: Note: the granted delegations MAY be different from the requested ones, according to server's configuration. 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). 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). If the server reject the delegation, it MUST return a &forbidden; error: If the server rejects the delegation, it MUST return a &forbidden; error: 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 "juliet@capulet.lit/balcony" and 'to' attribute is "juliet@capulet.lit"), it MUST forward it to the managing entity by replacing the 'to' attribute with the jid of the managing entity: 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 "juliet@capulet.lit/balcony" and 'to' attribute is "juliet@capulet.lit"), it MUST forward it to the managing entity by replacing the 'to' attribute with the JID of the managing entity: The server get this stanza, see that this namespace is delegated to pubsub.capulet.lit, so it forward it: The server gets this stanza, sees that this namespace is delegated to pubsub.capulet.lit, so it forwards it: The managing entity reply normally to the stanza:
Additionaly, a method to do generic treatments (independant of server) on stanza is also provided.
Additionaly, a method to do generic treatments (independent of server) on stanza is also provided.
-
- The server MUST NOT forward any request done to an other entity than itself or a bare jid with its domain.
+ The server MUST NOT forward any request made to an other entity than itself or to a bare JID within its domain.
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
+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.
-The workflow is fully transparent for Juliet
+The workflow is fully transparent for Juliet.
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
-In the following examples, juliet@capulet.lit has its "jabber:iq:roster" namespace delegated to filter.capulet.lit. filter.capulet.lit is a server agnostic component which filter allowed entity (which can be added to a roster), and sort them in enforced groups
+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.
+In the following examples, juliet@capulet.lit has its "jabber:iq:roster" namespace delegated to filter.capulet.lit. filter.capulet.lit is a server agnostic component which filters allowed entities (which can be added to a roster), and sort them in enforced groups.
-filter.capulet.lit accept to add Romeo, but all jids with a montaigu.lit must be in a "Rivals" group, so it first return a success result (romeo is accepted)
+filter.capulet.lit accepts to add Romeo, but all JIDs with a montaigu.lit must be in a "Rivals" group, so it first returns a success result (Romeo is accepted).
At this stade, the entity is accepted, but not added to the roster. filter.capulet.lit is also a privileged entity which can manage "jabber:iq:roster", so it use this ability to add romeo with the enforced group:
-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:
+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:
If an entity want to manage PEP service for juliet, it can ask the delegation like this: +
If an entity want to manage PEP service for Juliet, it can ask the delegation like this:
Here juliet accept that pubsub.montaigu.lit manage the PubSub (and then PEP) service.
-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:
+Here Juliet allows pubsub.montaigu.lit to manage the PubSub (and then PEP) service.
+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:
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 'urn:xmpp:delegation:0#configure'.
-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 business rules).
+Server SHOULD provide a way for clients to check already delegated namespaces, and revoke them by using &xep0050; on the well-defined command node 'urn:xmpp:delegation:0#configure'.
+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 business rules).
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.
-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 'urn:xmpp:delegation:0::http://jabber.org/protocol/pubsub' node which report features managed.
The node name is obtained by concatenating this XEP namespace (urn:xmpp:delegation:0), a '::' separator, and the delegated namespace (here http://jabber.org/protocol/pubsub).
The server MUST advertise the result in its own discovery answer, and MUST ignore features of its internal component (here internal PubSub service).
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.
juliet@capulet.int ask its server what it is capable of, she is specially interested in PubSub capabilities.
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 'urn:xmpp:delegation:0::http://jabber.org/protocol/pubsub' node which reports the managed features.
The node name is obtained by concatenating this XEP namespace (urn:xmpp:delegation:0), a '::' separator, and the delegated namespace (here http://jabber.org/protocol/pubsub).
The server MUST advertise the result in its own discovery answer, and MUST ignore features of its internal component (here internal PubSub service).
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.
juliet@capulet.int asks its server what it is capable of, she is specially interested in PubSub capabilities.
Server delegate its PubSub namespace to pubsub.capulet.lit, so it ask its available features for this namespace like this
-Note that in real situation, server has probably this information already in cache (see Implementation Notes).
- pubsub.capulet.lit return its available features
Note that 'http://jabber.org/protocol/pubsub#auto-create' is not available.
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.
+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.
To do so, the mechanism is the same as for server features, but the separator is ':bare:' instead of '::':
-Server delegate its PubSub namespace to pubsub.capulet.lit, so it ask its available features for this namespace like this
-As for general case, server has probably this information already in cache.
- pubsub.capulet.lit return its available features
then the server return the answer to Juliet, as in general case, with requested bare jid in 'from' field.
-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 some cases, send &MESSAGE; or receive &PRESENCE; stanzas).
-Privileged entity have numerous advantages, including:
+Privileged entities have numerous advantages, including:
In admin 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.
-In client 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.
-In addition, some special permissions can permit to send &MESSAGE; stanzas on behalf of the server or access &PRESENCE; informations
+In client 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.
+In addition, some special permissions can permit to send &MESSAGE; stanzas on behalf of the server or access &PRESENCE; informations.
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 'urn:xmpp:privilege:0' namespace
+Once an entity is authenticated and stream is started, it can request a privileged status. It does it by sending an &IQ; stanza with 'urn:xmpp:privilege:0' namespace.
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:
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:
-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:
+Note: the granted permissions MAY be different from the requested ones, according to server's configuration.
If the server reject the privileged status, it MUST return a &forbidden; error:
-If the server rejects the privileged status, it MUST return a &forbidden; error:
+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:
-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:
+The server then answer normaly, as it would have done with the managed entity:
-and server answer:
+and server answers:
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: +
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:
-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. +
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.
-Here juliet accept that priv.montaigu.net use 'set' and 'get' to manage her roster, but doesn't want it to do any 'get' on her pubsub nodes.
-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:
+Here Juliet allows priv.montaigu.net to use 'set' and 'get' in order to manage her roster, but doesn't want it to do any 'get' on her pubsub nodes.
+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:
The privileged entity can now act according to permission granted to him.
sending &IQ; stanza is done in the exact same way as for admin mode. If an entity want to sent a non authorized &IQ;, it get a &forbidden; error:
+Sending &IQ; stanzas is done in the exact same way as for admin mode. If an entity wants to sent a non authorized &IQ;, it will get a &forbidden; error:
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.
+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.
-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).
-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:
+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:
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.
-In the following example, pubsub.capulet.lit ask for pubsub and outgoing messages permission
+In the following example, pubsub.capulet.lit asks for pubsub and outgoing messages permission
The server see that forwarded message type is 'headline', that juliet@capulet.lit 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:
-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.
-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".
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.
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.
+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".
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.
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.
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 jabber:iq:roster MUST have a value of either get or both).
If the delegation is granted, the server MUST send to the privileged entity every presence information that the managing entity is receiving.
The server MUST reject the permission if the privileged entity doesn't have read permission on roster namespace.
-Note: this permission should be given carefully, as it give access to presence of potentially a lot of entities to the privileged entity (see security considerations). If allowed in client mode, server SHOULD display an extra warning when requesting permissions to the managed entity.
+Note: this permission should be given carefully, as it gives access to presence of potentially a lot of entities to the privileged entity (see security considerations). If allowed in client mode, server SHOULD display an extra warning when requesting permissions to the managed entity.
Note the presence of jabber:iq:roster permission request.
-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 'urn:xmpp:privilege:0#configure'.
-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 business rules).
+Server SHOULD provide a way for clients to check already granted permission, and revoke them by using &xep0050; on the well-defined command node 'urn:xmpp:privilege:0#configure'.
+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 business rules).
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:
+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:
As admin mode is far more easy to implement than client mode, a server MAY choose to only implement the former
+As admin mode is far more easy to implement than client mode, a server MAY choose to only implement the former.