XMPP components are used for long through Jabber Component Protocol (XEP-0114) [2], 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 some other entity data with the same privileges than the entity itself, that means manage an entity roster on its behalf, send <message/>, <iq/> or receive <presence/> stanzas in the name of the server.
Privileged entities have numerous advantages, including:
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 Acknowledgements section for more details.
This XEP is complementary to Namespace Delegation (XEP-0355) [4] (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.
A privileged entity must be able to do what a PEP service can do and to access roster, so it must be able to (according to configuration):
The privilege mechanism MUST be totally transparent for the managed entities.
Roster access is granted in the server configuration. Roster access can have 4 types:
Roster access MAY have an optional "push" argument which can be set to "true" or "false" and SHOULD default to "true" if roster permission access type is either "get" or "both", and to "false" otherwise.
If set to "true", the server will send roster pushes as explained below.. If set to "false", the server MUST NOT send roster pushes. The "false" value is mostly there to save resources if the managing entity knows that it doesn't need to be notified of roster updates. Roster pushes MUST NOT be sent if roster permission type is either "none" or "set".
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:2'.
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 "Server Allows Roster Access" section.
The <perm> element MAY contain a 'push' attribute with a value of either "true" or "false" according to configuration. If the 'push' attribute is omitted, it defaults to "true" if "roster" permission is "get" or "both", otherwise it's set to "false". If 'push' is "true", roster pushes MUST be transmitted, if 'push' is "false" they MUST NOT be transmitted.
<message from='capulet.net' to='pubub.capulet.lit' id='12345'>
<privilege xmlns='urn:xmpp:privilege:2'>
<perm access='roster' type='both' push='true'/>
</privilege>
</message>
Here pubsub.capulet.lit is allowed to do get and set operations on all entities managed by capulet.lit
Doing a get or set operation on the roster of a managed entity is done in the usual way (as described in RFC 6121 [5] section 2), except that the 'to' attribute is set to the attribute of the managed entity. The server MUST check that the privileged entity has right to get or set the roster of managed entity, and MUST return a <forbidden/> error if it is not the case:
<iq id='roster1'
from='pubsub.capulet.lit'
to='[email protected]'
type='get'
id='roster1'>
<query xmlns='jabber:iq:roster'/>
</iq>
The server then answers normally, as it would have done to the managed entity:
<iq id='roster1' from='[email protected]' to='pubsub.capulet.net' type='result'> <query xmlns='jabber:iq:roster' ver='ver7'> <item jid='[email protected]'/> <item jid='[email protected]'/> </query> </iq>
If "push" attribute is unset or set to "true" and roster permission type is either "get" or "both", the server MUST send roster pushes when there is a newly created, updated or deleted roster item for roster of any managed entity. A roster push is built as explained in XMPP IM [5] with a 'from' attribute explicitely set to the bare jid of the managed entity.
<iq id='roster_push_1' from='[email protected]' to='pubsub.capulet.lit' type='set'> <query xmlns='jabber:iq:roster'> <item jid='[email protected]'/> </query> </iq>
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:
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 Stanza Forwarding (XEP-0297) [6]. The <forwarded/> element MUST be a child of a <privilege/> element with a namespace of 'urn:xmpp:privilege:2', with the following restriction:
If this rule is violated, the server MUST return a <message/> error with condition <forbidden/>, as in RFC 6120 [7] section 8.3.3.4.
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':
<message from='capulet.net' to='pubub.capulet.lit' id='54321'>
<privilege xmlns='urn:xmpp:privilege:2'>
<perm access='roster' type='both' push='true'/>
<perm access='message' type='outgoing'/>
</privilege>
</message>
Now that pubsub.capulet.lit is allowed, it can send messages using <forwarded/> elements.
<message from='pubsub.capulet.lit' to='capulet.lit' id='notif1'>
<privilege xmlns='urn:xmpp:privilege:2'>
<forwarded xmlns='urn:xmpp:forward:0'>
<message from='[email protected]'
id='foo'
to='[email protected]/orchard'
xmlns='jabber:client'>
<event xmlns='https://jabber.org/protocol/pubsub#event'>
<items node='https://jabber.org/protocol/tune'>
<item>
<tune xmlns='https://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>
The server sees that forwarded message 'from' attribute ([email protected]) is a bare JID of the server, and that outgoing message permission was granted; it can now send the notification:
<message from='[email protected]' id='bar' to='[email protected]/orchard'> <event xmlns='https://jabber.org/protocol/pubsub#event'> <items node='https://jabber.org/protocol/tune'> <item> <tune xmlns='https://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>
It may be necessary for a component to send <iq/> stanzas on behalf of a server user. This is, for instance, the case for a pubsub component willing to implement Pubsub Account Management (XEP-0376) [1].
To do this, an "iq" permission must be granted in server configuration.
To grant an "iq" permission, authorised namespaces must be specified and associated to a value indicating the type of <iq/> request which are allowed. The value is similar to the roster access type, there are 4 values possible:
Server adversites "iq" permission by using a <perm> element with an 'access' attribute of the value "iq" and wihout 'type' attribute. This element MAY contain any number of <namespace> elements with a 'ns' attribute of the value of the granted namespace, and a 'type' attribute with one of the value indicated in previous section
<message from='capulet.net' to='pubub.capulet.lit' id='iq_perm_1'>
<privilege xmlns='urn:xmpp:privilege:2'>
<perm access='iq'>
<namespace ns='https://jabber.org/protocol/pubsub' type='set' />
</perm>
</privilege>
</message>
Here pubsub.capulet.lit is allowed to send <iq/> stanza of type set with the namespace 'https://jabber.org/protocol/pubsub' on behalf of any entity managed by capulet.lit
Sending an <iq/> stanza on behalf of a user is done by following those steps:
The server MUST refuse the request with a <forbidden/> error if any of the following condition happens:
Once the server gets the <iq/> response, it sends it back to privileged entity using a Stanza Forwarding (XEP-0297) [6] <forward> element encapsulated in a <privilege> element with a namespace of 'urn:xmpp'.
In following example, the pubsub component pubsub.capulet.lit handles Pubsub Account Management (XEP-0376) [1]. After getting a pubsub subscribe request, from Juliet to subscribe to Romeo's blog, it forward it to Romeo's server:
<iq
from='pubsub.capulet.lit'
to='[email protected]'
type='set'
id='priv_iq_1'>
<privileged_iq xmlns='urn:xmpp:privilege:2'>
<iq
xmlns='jabber:client'
type='set'
to='[email protected]'
id='sub_1'>
<pubsub xmlns='https://jabber.org/protocol/pubsub'>
<subscribe
node='urn:xmpp:microblog:0'
jid='[email protected]'/>
</pubsub>
</iq>
</privileged_iq>
</iq>
When receiving this stanza, the server does a couple of things:
<iq xmlns='jabber:client' type='set' from='[email protected]' to='[email protected]' id='sub_1'> <pubsub xmlns='https://jabber.org/protocol/pubsub'> <subscribe node='urn:xmpp:microblog:0' jid='[email protected]'/> </pubsub> </iq>
The server will then get the response with a type of either "result" or "error" as specified in XMPP Core [7]. It sends it back to pubsub.capulet.lit using a Stanza Forwarding (XEP-0297) [6] <forward> element:
<iq type='result'
from='[email protected]'
to='[email protected]'
id='sub_1'>
<pubsub xmlns='https://jabber.org/protocol/pubsub'>
<subscription
node='urn:xmpp:microblog:0'
jid='[email protected]'
subid='some_id'
subscription='subscribed'/>
</pubsub>
</iq>
<iq
type='result'
from='[email protected]'
to='pubsub.capulet.lit'
id='priv_iq_1'>
<privilege xmlns="urn:xmpp:privilege:2">
<forwarded xmlns='urn:xmpp:forward:0'>
<iq type='result'
from='[email protected]'
to='[email protected]'
id='sub_1'>
<pubsub xmlns='https://jabber.org/protocol/pubsub'>
<subscription
node='urn:xmpp:microblog:0'
jid='[email protected]'
subid='some_id'
subscription='subscribed'/>
</pubsub>
</iq>
</forwarded>
</privilege>
</iq>
pubsub.capulet.lit has now subscribed to Romeo's blog on behalf of Juliet.
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.
This is allowed in server configuration in the same way as for roster and message permissions. The "presence" type can have the following values:
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 RFC 6121 [5] section 4.6, on the behalf of managed entity each time its presence information change.
Only initial <presence/> stanzas and <presence/> stanzas with a 'type' attribute with the value "unavailable" are transmitted to the privileged entity, the server MUST NOT transmit any other <presence/> stanza.
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"
Once the "presence" permission is granted, the server send presence informations:
<presence from='[email protected]/balcony' id='presence1' xml:lang='en'> <show>chat</show> <status>Staying on the balcony</status> </presence>
<presence from='[email protected]/balcony' to='pubsub.capulet.lit' id='presence1' xml:lang='en'> <show>chat</show> <status>Staying on the balcony</status> </presence>
In addition to "managed entity presence", 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).
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 roster MUST have a value of either get or both).
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 managing entity 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.
Having "roster" type for "presence" permission imply that you have also implicitly "managed_entity" type.
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 gives access to presence of potentially a lot of entities to the privileged entity (see security considerations).
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"
<message from='capulet.net' to='pubub.capulet.lit' id='54321'>
<privilege xmlns='urn:xmpp:privilege:2'>
<perm access='roster' type='both' push='true'/>
<perm access='message' type='none'/>
<perm access='iq'>
<namespace ns='https://jabber.org/protocol/pubsub' type='set' />
</perm>
<perm access='presence' type='roster'/>
</privilege>
</message>
Note the presence of roster permission request.
<presence from='[email protected]/orchard'/>
<presence from='[email protected]/orchard' to='[email protected]'/> <presence from='[email protected]/orchard' to='pubsub.capulet.lit'/>
This document requires no interaction with the Internet Assigned Numbers Authority (IANA) [8].
The XMPP Registrar [9] includes 'urn:xmpp:privilege:2' in its registry of protocol namespaces (see <https://xmpp.org/registrar/namespaces.html>).
If the protocol defined in this specification undergoes a revision that is not fully backwards-compatible with an older version, the XMPP Registrar shall increment the protocol version number found at the end of the XML namespaces defined herein, as described in Section 4 of XEP-0053.
<?xml version='1.0' encoding='UTF-8'?>
<xs:schema
xmlns:xs='https://www.w3.org/2001/XMLSchema'
targetNamespace='urn:xmpp:privilege:2'
xmlns='urn:xmpp:privilege:2'
elementFormDefault='qualified'>
<xs:element name='privilege'>
<xs:complexType>
<xs:element name='perm'
maxOccurs='unbounded'>
<xs:complexType>
<xs:attribute name='access' use='required' type='xs:string'/>
<xs:simpleType base='xs:NMTOKEN'>
<xs:enumeration value='roster'/>
<xs:enumeration value='message'/>
<xs:enumeration value='presence'/>
</xs:simpleType>
<xs:attribute name='type' use='optional'>
<xs:simpleType base='xs:NMTOKEN'>
<xs:enumeration value='none'/>
<xs:enumeration value='get'/>
<xs:enumeration value='set'/>
<xs:enumeration value='both'/>
<xs:enumeration value='outgoing'/>
<xs:enumeration value='managed_entity'/>
<xs:enumeration value='roster'/>
</xs:simpleType>
</xs:attribute>
<xs:attribute name='push' type='xs:boolean' use='optional' default='true' />
<xs:element name='namespace'
maxOccurs='unbounded'
use='optional'>
<xs:complexType>
<xs:attribute name='ns' use='required' type='xs:string'/>
<xs:attribute name='type' use='required'>
<xs:simpleType base='xs:NMTOKEN'>
<xs:enumeration value='none'/>
<xs:enumeration value='get'/>
<xs:enumeration value='set'/>
<xs:enumeration value='both'/>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:complexType>
</xs:element>
</xs:complexType>
</xs:element>
<xs:element name='privileged_iq' />
</xs:schema>
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.
Privileged entity was initialy written to be a generic identity based access control (IBAC) which allows an entity to access sensitive data. After a discussion on standard mailing list, 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.
This document in other formats: XML PDF
This XMPP Extension Protocol is copyright © 1999 – 2024 by the XMPP Standards Foundation (XSF).
Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.
## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ##
In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.
This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at <https://xmpp.org/about/xsf/ipr-policy> or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).
The HTML representation (you are looking at) is maintained by the XSF. It is based on the YAML CSS Framework, which is licensed under the terms of the CC-BY-SA 2.0 license.
The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 6120) and XMPP IM (RFC 6121) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.
The primary venue for discussion of XMPP Extension Protocols is the <[email protected]> discussion list.
Discussion on other xmpp.org discussion lists might also be appropriate; see <https://xmpp.org/community/> for a complete list.
Errata can be sent to <[email protected]>.
The following requirements keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".
1. XEP-0376: Pubsub Account Management <https://xmpp.org/extensions/xep-0376.html>.
2. XEP-0114: Jabber Component Protocol <https://xmpp.org/extensions/xep-0114.html>.
3. XEP-0163: Personal Eventing Protocol <https://xmpp.org/extensions/xep-0163.html>.
4. XEP-0355: Namespace Delegation <https://xmpp.org/extensions/xep-0355.html>.
5. RFC 6121: Extensible Messaging and Presence Protocol (XMPP): Instant Messaging and Presence <https://tools.ietf.org/html/rfc6121>.
6. XEP-0297: Stanza Forwarding <https://xmpp.org/extensions/xep-0297.html>.
7. RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core <https://tools.ietf.org/html/rfc6120>.
8. The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <https://www.iana.org/>.
9. The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <https://xmpp.org/registrar/>.
Note: Older versions of this specification might be available at https://xmpp.org/extensions/attic/
Several updates according to feedbacks + review:
Initial published version approved by the XMPP Council.
First draft.
@report{poisson2014xep0356,
title = {Privileged Entity},
author = {Poisson, Jérôme},
type = {XEP},
number = {0356},
version = {0.4.1},
institution = {XMPP Standards Foundation},
url = {https://xmpp.org/extensions/xep-0356.html},
date = {2014-05-09/2023-04-24},
}END