From 55b2c54bd5f94cda3a8a377e03b2a530343ba68a Mon Sep 17 00:00:00 2001 From: "Matthew A. Miller" Date: Tue, 18 Nov 2014 08:25:08 -0700 Subject: [PATCH] proto-xep privilege-component v0.0.3 --- inbox/privilege-component.xml | 296 ++++++++++++++++++++++++++++------ 1 file changed, 245 insertions(+), 51 deletions(-) diff --git a/inbox/privilege-component.xml b/inbox/privilege-component.xml index 58f4a030..ce61e582 100644 --- a/inbox/privilege-component.xml +++ b/inbox/privilege-component.xml @@ -6,7 +6,7 @@
- Privileged Entity + privileged entity This specification provides a way for XMPP entities to have a privileged access to other entities data This XMPP Extension Protocol is copyright (c) 1999 - 2014 by the XMPP Standards Foundation (XSF). @@ -34,6 +34,20 @@ goffi@goffi.org goffi@jabber.fr + + 0.0.3 + 2014-11-13 + jp +
    +
  • giving permission to manage this XEP namespace is forbidden
    • +
  • Added configuration section; with well-defined command node
    • +
  • better specification of persistent permissions
    • +
  • fixed erroneous example (server returns bookmarks)
    • +
  • added special permissions
    • +
  • better specification of &QUERY; element
    • +
+ + 0.0.2 2014-09-17 @@ -52,9 +66,10 @@

First draft.
+ -

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.

-

Privileged entity have numerous advantages, including:

+

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 entities have numerous advantages, including:

  • 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
  • better integration of components: a gateway can add items to an entity roster itself
    • @@ -63,31 +78,35 @@
  • server agnostic
 +

A privileged entity can be used in two modes:

    -
  • admin mode, where it is installed by the server administrator
    • +
  • admin mode, where it is installed by the server administrator.
  • client mode, where it can be installed by any user
-

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.

-

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 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 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.

 +
    -
  • Privileged entity — the entity which has or wants a privileged status.
    • -
  • Managed entity — the entity that the privileged entity wants to manage.
    • +
  • Privileged entity — the entity which has a privileged status.
    • +
  • Managed entity — the entity that is managed by a privileged entity.
 + - -

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

-

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:

+ +

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:

    -
  • get — the entity wants to send &IQ; stanza of type 'get'
    • -
  • set — the entity wants to send &IQ; stanza of type 'set'
    • -
  • both — the entity wants to send &IQ; stanza of type 'get' and 'set'
    • +
  • get — the entity needs the privilege to send &IQ; stanzas of type 'get'
    • +
  • set — the entity needs the privilege to send &IQ; stanzas of type 'set'
    • +
  • both — the entity needs the privilege to send &IQ; stanzas of type 'get' and 'set'
@@ -98,9 +117,9 @@ ]]> - -

If the server accept the privileged status (e.g.: admin status specified in configuration), it MUST return an IQ result stanza, with allowed permissions in <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:

+ @@ -111,9 +130,9 @@ ]]>

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:

+ @@ -123,9 +142,9 @@ - -

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:

- The server then answers normally, as it would have done to the managed entity:

+ @@ -157,17 +177,17 @@ ]]> -

and server answer:

+

and server answers:

- - JC @@ -181,17 +201,16 @@ -

In client mode, the privileged entity is not certified by the server administrator, so the permissions MUST be explicitly 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 admin mode with the following exceptions:

  1. the privilege type is client instead of admin
    2. -
  2. the privilege is done per entity, so the managed entity MUST be specified in a 'to' attribute
    3. +
  3. the privilege is given per entity, so the managed entity MUST be specified in a 'to' attribute
-

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.

- 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. @@ -240,7 +259,7 @@ ]]> -

The server SHOULD include a warning message, SHOULD translate the namespace to human friendly names (and MAY keep the original namespace in addition) and MUST set the default value to 'none' (permission refused). The server SHOULD use namespace as field var, so a client can use it to have a customized display.

+

The server SHOULD include a warning message, SHOULD translate the namespace to human friendly names (and MAY keep the original namespace in addition) and MUST set the default value to "none" (permission refused). The server SHOULD use namespace as field var, so a client can use it to have a customized display.

The client can then answer to the form:

@@ -254,8 +273,8 @@ ]]> -

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:

@@ -286,10 +305,174 @@ ]]> - + + +

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:

+
    +
  1. forwarded &MESSAGE; 'type' attribute has the value of "headline"
    2. +
  2. forwarded &MESSAGE; 'from' attribute MUST be a bare JID from the server, no resource is allowed
    3. +
  3. in client mode, the forwarded &MESSAGE; 'from' attribute can only be one of a managed entity which has explicitly accepted the delegation
    4. +
+

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 asks for pubsub and outgoing messages permission

+ + + + + + + ]]> + + + + + + + + ]]> +

Now that pubsub.capulet.lit is allowed, it can send messages using <forwarded/> elements.

+ + + + + + + + Gerald Finzi + 255 + Music for "Love's Labors Lost" (Suite for small orchestra) + Introduction (Allegro vigoroso) + 1 + + + + + + + + + ]]> +

The server sees 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:

+ + + + + + Gerald Finzi + 255 + Music for "Love's Labors Lost" (Suite for small orchestra) + Introduction (Allegro vigoroso) + 1 + + + + + + + ]]> + + + +

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, 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.

+ + + + + + +]]> + + + + + + + +]]> + + + chat + Staying on the balcony + +]]> + + chat + Staying on the balcony + +]]> + + + +

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).

+

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 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 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:

]]> +
    -
  1. Server MAY keep permission granted to an entity by a client from one session to an other, but if it do so, it MUST provide a way to client to check already granted permission, and revoke them (possibly using &xep0050;).
    2. -
  2. If a client can't check or revoke permission (e.g. it doesn't support &xep0050;), the server MUST NOT keep granted permission from one session to an other, and permission will be asked on each new session.
    3. -
  3. If permissions are changed during a session, server MUST notify privileged entity of the new permissions, like in permission request use case
    4. +
  4. 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 suitable section. If server offers this feature, it SHOULD add a field directly in configuration commands.
    5. +
  5. 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.
    6. +
  6. If permissions are changed during a session, server MUST notify privileged entity of the new permissions, like in permission request use case.
    7. +
  7. A server MUST NOT grant permission for this XEP namespace ('urn:xmpp:privilege:0').
 + -

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.

 +
  1. Privileged entity nearly have the same possibility as the server itself, admin permission should be granted carefuly, only if you absolutely trust the entity.
    2. -
  2. 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 none
    3. +
  3. 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 "none"
    4. +
  4. Roster presence 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 "none"). A server SHOULD at least disallow it in default configuration.
    5. -
  5. 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)
    6. +
  6. 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).
 +

This document requires no interaction with &IANA;.

 +

The ®ISTRAR; includes 'urn:xmpp:privilege:0' in its registry of protocol namespaces (see &NAMESPACES;).

@@ -343,6 +533,7 @@ &NSVER; + @@ -389,7 +580,10 @@ ]]> + -

Thanks to Sergey Dobrov, Dave Cridland and Steven Lloyd Watkin for their feedbacks.

+

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.

+

The client mode permission mechanism is inspired from &xep0321; permission request.

 +