%ents; ]>
Remote Roster Management This document defines a way remote entities may manage user's roster to provide a simple way to keep rosters in sync. &LEGALNOTICE; 0321 Deferred Standards Track Standards Council XMPP Core XEP-0001 XEP-0004 XEP-0100 NOT_YET_ASSIGNED Sergey Dobrov binary@jrudevels.org binary@jrudevels.org Jan Kaluža hanzz.k@gmail.com hanzz@njs.netlab.cz 0.1.1 2018-11-03 pep Fix a bunch of typos, batch-style. 0.1 2013-04-16 psa

Initial published version approved by the XMPP Council.

0.0.1 2012-12-07 snd

First draft.

It's often desirable for some XMPP based services to make it possible to manage user's roster to provide some contacts there. The most obvious example of such kind of service is a gateway to some legacy IM system (see &xep0100;). The current way that's recommended by the &xep0100; is to use the &xep0144; to synchronize items that's not sutiable in certain situations.

This document addresses the following requirements:

  1. Make it possible for remote services or entities to manage user's roster by the same mechanisms that descibed in the &rfc6121;.
  2. Provide a way for users to control which services have permission to manage their roster.
Remote entity
the entity that wants to modify user's roster.
User
the entity which roster the remote entity wants to have access to.
User's server
the XMPP server User connected to.
Roster
the list of User's contacts as defined in the &rfc6121;.

In order to be able to make any changes to the user's roster the remote entity MUST ask permission to do so first.

NOTE: in order to be able to perform the query, the remote entity MUST have a presence subscription to the User

]]>

If the presence subscription is absent, the server MUST NOT proceed with the request but MUST respond with the "forbidden" error:

You must have a presence subscription to be able to request remote roster management service. ]]>

The user's server SHOULD then generate a form request using &xep0004; to client in order to ask user if they are OK with granting the permission to the remote entity. The "challenge" form field is generated by the server and is used to identify the client's response. The server also MUST immediatly answer to the request IQ.

NOTE: if the entity is already granted with the permission, the server SHOULD immediatly answer with a success response and skip querying the user.

icq.example.com wants to be able to manage your roster with following reason: Manage contacts in the ICQ contact list Do you want to allow it? Send "yes 5439123" or "no 5439123" back, pleas. Roster management permission request icq.example.com wants to be able to manage your roster with following reason: Manage contacts in the ICQ contact list. Do you allow it? 5439123 urn:xmpp:tmp:roster-management:0 1 ]]>

The client can answer by submit the form or with a text message response:

urn:xmpp:tmp:roster-management:0 5439123 1 ]]> yes 5439123 ]]>

If the user allowed the roster management then the server MUST inform the remote entity that it has been granted the permission:

]]>

If the user disallowed the roster management then the server MUST inform the remote entity that it hasn't been granted the permission:

]]>

In order to reject the permission to manage roster it's enough to reject entity's presence subscription:

]]>

If the presence subscription is restored then the permission is needed to be rerequested as defined above.

The remote entity being granted the permission to manage roster can request it from the User's server using usual jabber:iq:roster protocol to be able to edit it:

]]>

The server MUST then answer with User's roster including there only the items that belongs to the entity's hostname:

Friends Friends Friends ]]>

If client updates roster and this update affects the remote entity's contacts (i.e. belongs to its hostname) then the server MUST forward these items to the remote entity:

Friends Lovers ]]> Friends Lovers ]]>

The remote entity can also send the push query to the roster with the same semantics as specified for the jabber:iq:roster protocol described in the &rfc6121;:

Friends Lovers ]]>

The server MUST then inform the remote entity of success or an error and in the case of success also forward the push request to all connected User's resources.

If the entity tries to make changes into the items it's not allowed to, the server MUST NOT do any changes in the User's roster but respond to the entity with an error:

You have tried to modify the item you don't allowed to. ]]>

User can ask the server to provide a list of components or servers which have permissions to edit their roster.

]]>

In this case, server responds with list of components or servers which can edit user's roster.

]]>

Eventually, user can reject permission granted to component to edit their roster.

]]>
The protocol documented by this schema is defined in XEP-XXXX: http://www.xmpp.org/extensions/xep-xxxx.html ]]>