%ents; ]>
Private Information via Pubsub This document specifies protocol semantics for using the XMPP publish-subscribe extension to persistently store private information such as bookmarks and client configuration options. &LEGALNOTICE; 0223 Experimental Standards Track Standards JIG Council XMPP Core XMPP IM XEP-0030 XEP-0060 XEP-0115 TO BE ASSIGNED &stpeter; 0.1 2007-08-08 psa

Initial published version.

 0.0.1 2007-07-18 psa

First draft.

&xep0163; introduced the idea of a virtual &xep0060; service associated with an IM user's bare JID (&BAREJID;). However, personal eventing (PEP) is not optimized for the persistent storage of data objects that are meant to be accessed only by the account owner, à la &xep0049;. Therefore this document defines a set of best practices that enable a user to persistently store private information at their virtual pubsub service; in effect, we "sub-class" PEP by showing how a particular pubsub node can be configured for storing private information (we call such a node a "PIP node").

This section provides a friendly introduction to private information via pubsub (a.k.a. PIP).

Imagine that you are a Shakespearean character named Juliet and that you want to persistently store some private information such as bookmarks (&xep0048;).

We assume that your server (capulet.lit) supports PEP along with the "publish-options" feature, and that your client discovered that support when you logged in.

You want to start bookmarking &xep0045; rooms so your client stores that data privately:

JC Gl0b3 http://jabber.org/protocol/pubsub#publish-options true whitelist ]]>

Your publish request is a standard pubsub request except that:

  1. The item is persisted (pubsub#persist_items is true).
  2. In this case, access is limited to yourself (the "whitelist" access model defaults to allowing access for the account owner, i.e., you).

If all goes well (see Storing Data), your bookmarks will be stored and the information will be pushed out to all of your resources (here "balcony" and "chamber").

JC Gl0b3 JC Gl0b3 ]]>

So that's the general idea.

Personal information via pubsub ("PIP") re-uses the concepts already defined in XEP-0060 and XEP-0163. In order to optimize for object persistence of private information instead of transient event notifications related to semi-public data, a PIP node MUST be configured as follows:

  1. Set pubsub#access_model to "whitelist".
  2. Set pubsub#persist_items to true.

An account owner publishes an item to a node by following the protocol specified in XEP-0060:

JC Gl0b3 ]]>

If the node does not already exist, the virtual pubsub service MUST create the node. As described in XEP-0163, this "auto-create" feature (defined in XEP-0060) MUST be supported by a PEP service. (Naturally, the account owner's client MAY follow the node creation use case specified in XEP-0060 before attempting to publish an item.)

In order for the client to reliably persist private information, the virtual pubsub service must also support the "publish-options" feature defined in XEP-0060. Typically, a client will publish with options so that the object is privately stored.

JC Gl0b3 http://jabber.org/protocol/pubsub#publish-options true whitelist ]]>

If the publication logic dictates that event notifications shall be sent, the account owner's server generates notifications and sends them to all appropriate entities as described in the Receiving Event Notifications section of XEP-0163.

Before an account owner attempts to complete any of the use cases defined herein, its client SHOULD verify that the account owner's server supports both PEP and the "publish-options" feature; to do so, it MUST send a &xep0030; information request to the server:

]]>

The server MUST return an identity of "pubsub/pep" and include the "publish-options" feauture in the list of the namespaces and other features it supports:

... ... ]]>

This document introduces no security considerations above and beyond those specified in XEP-0060 and XEP-0163.

This document requires no interaction with &IANA;.

This document requires no interaction with the ®ISTRAR;.