xep-0222.xml

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE xep SYSTEM 'xep.dtd' [
  <!ENTITY % ents SYSTEM 'xep.ent'>
%ents;
]>
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep>
<header>
  <title>Persistent Storage of Public Data via PubSub</title>
  <abstract>This specification defines best practices for using the XMPP publish-subscribe extension to persistently store semi-public data objects such as public keys and personal profiles.</abstract>
  &LEGALNOTICE;
  <number>0222</number>
  <status>Active</status>
  <type>Informational</type>
  <sig>Standards JIG</sig>
  <approver>Council</approver>
  <dependencies>
    <spec>XMPP Core</spec>
    <spec>XMPP IM</spec>
    <spec>XEP-0030</spec>
    <spec>XEP-0060</spec>
    <spec>XEP-0115</spec>
  </dependencies>
  <supersedes/>
  <supersededby/>
  <shortname>N/A</shortname>
  &stpeter;
  <revision>
    <version>1.0</version>
    <date>2008-09-08</date>
    <initials>psa</initials>
    <remark><p>Per a vote of the XMPP Council, advanced specification to Active.</p></remark>
  </revision>
  <revision>
    <version>0.3</version>
    <date>2008-06-20</date>
    <initials>psa</initials>
    <remark><p>Added text about composition model, and modified examples accordingly.</p></remark>
  </revision>
  <revision>
    <version>0.2</version>
    <date>2008-03-03</date>
    <initials>psa</initials>
    <remark><p>Removed hokey acronym; changed type to Informational; clarified text.</p></remark>
  </revision>
  <revision>
    <version>0.1</version>
    <date>2007-08-08</date>
    <initials>psa</initials>
    <remark><p>Initial published version.</p></remark>
  </revision>
  <revision>
    <version>0.0.1</version>
    <date>2007-07-18</date>
    <initials>psa</initials>
    <remark><p>First draft.</p></remark>
  </revision>
</header>

<section1 topic='Introduction' anchor='intro'>
  <section2 topic='Motivation' anchor='motivation'>
    <p>&xep0163; introduced the idea of a virtual &xep0060; service associated with an IM user's bare JID &LOCALBARE;. However, the default node configuration options associated with PEP nodes are not optimized for the persistent storage of semi-public data objects such as public keys or user profiles. Therefore this document defines a set of best practices that enable IM users to persistently store semi-public data objects at their virtual pubsub service; in effect, we "sub-class" PEP by showing how a particular pubsub node can be configured for persisting objects.</p>
  </section2>
  <section2 topic='How It Works' anchor='howitworks'>
    <p>Imagine that you are a Shakespearean character named Juliet and that you want to persistently store information such as your public keys (see &xep0189;) and user profile (see &xep0154;).</p>
    <p>We assume that you have three contacts with the following relationship to you:</p>
    <ol start='1'>
      <li>benvolio@montague.lit, who has no subscription to your presence</li>
      <li>nurse@capulet.lit, who has a bidirectional subscription to your presence and who is in your "Servants" roster group</li>
      <li>romeo@montague.lit, who has a bidirectional subscription to your presence and who is in your "Friends" roster group</li>
    </ol>
    <p>We also 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.</p>
    <p>Because you want to keep your communications with Romeo confidential, you decide to start encrypting your messages. Therefore you reconfigure your client, which generates an RSA key that it publishes to the virtual pubsub service hosted at your bare JID &lt;juliet@capulet.lit&gt;.</p>
    <example caption='Publishing a key'><![CDATA[
<iq from='juliet@capulet.lit/balcony' type='set' id='pub1'>
  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
    <publish node='urn:xmpp:tmp:pubkey'>
      <item id='julietRSAkey1hash'>
        <key xmlns='urn:xmpp:tmp:pubkey'>
          <x509cert>
            der-encoded-cert
          </x509cert>
        </key>
      </item>
    </publish>
    <publish-options>
      <x xmlns='jabber:x:data' type='submit'>
        <field var='FORM_TYPE' type='hidden'>
          <value>http://jabber.org/protocol/pubsub#publish-options</value>
        </field>
        <field var='pubsub#persist_items'>
          <value>true</value>
        </field>
        <field var='pubsub#send_last_published_item'>
          <value>never</value>
        </field>
        <field var='pubsub#access_model'>
          <value>roster</value>
        </field>
        <field var='pubsub#roster_groups_allowed'>
          <value>Friends</value>
        </field>
      </x>
    </publish-options>
  </pubsub>
</iq>
]]></example>
    <p>Your publish request is a standard pubsub request except that:</p>
    <ol start='1'>
      <li>The item is persisted (pubsub#persist_items is true).</li>
      <li>The last published item is never sent (pubsub#send_last_published_item is set to "never" so that items are pushed out only when modified).</li>
    </ol>
    <p>(In this case, access is limited to people in your Friends roster group.)</p>
    <p>If all goes well (see <link url='#publish'>Publishing an Item</link>), your key will be pushed out to all appropriate individuals (in this case only Romeo). In particular, Romeo receives your key because he has auto-subscribed to the virtual pubsub service at your bare JID via a presence subscription and because his &xep0115; data indicated that he is interested in the "urn:xmpp:tmp:pubkey" payload type.</p>
    <example caption='Appropriate entities receive event notifications'><![CDATA[
<message from='juliet@capulet.lit'
         to='romeo@montague.lit/orchard'
         type='headline'
         id='keyfoo1'>
  <event xmlns='http://jabber.org/protocol/pubsub#event'>
    <items node='urn:xmpp:tmp:pubkey'>
      <item id='julietRSAkey1hash'>
        <key xmlns='urn:xmpp:tmp:pubkey'>
          <x509cert>
            der-encoded-cert
          </x509cert>
        </key>
      </item>
    </items>
  </event>
</message>
]]></example>
    <p>Because PEP services must send notifications to the account owner, you too receive the notification at each of your resources (here "balcony" and "chamber").</p>
    <example caption='Publisher receives event notification'><![CDATA[
<message from='juliet@capulet.lit'
         to='juliet@capulet.lit/balcony'
         type='headline'
         id='keyfoo2'>
  <event xmlns='http://jabber.org/protocol/pubsub#event'>
    <items node='urn:xmpp:tmp:pubkey'>
      <item id='julietRSAkey1hash'>
        <key xmlns='urn:xmpp:tmp:pubkey'>
          <x509cert>
            der-encoded-cert
          </x509cert>
        </key>
      </item>
    </items>
  </event>
</message>

<message from='juliet@capulet.lit'
         to='juliet@capulet.lit/chamber'
         type='headline'
         id='keyfoo3'>
  <event xmlns='http://jabber.org/protocol/pubsub#event'>
    <items node='urn:xmpp:tmp:pubkey'>
      <item id='julietRSAkey1hash'>
        <key xmlns='urn:xmpp:tmp:pubkey'>
          <x509cert>
            der-encoded-cert
          </x509cert>
        </key>
      </item>
    </items>
  </event>
</message>
]]></example>
    <p>So that's the general idea.</p>
  </section2>
</section1>

<section1 topic='Concepts and Approach' anchor='approach'>
  <p>The best practices described herein re-use the concepts already defined in &xep0060; and <cite>XEP-0163</cite>. In order to optimize for object persistence instead of transient event notifications, a node MUST be configured as follows:</p>
  <ol start='1'>
    <li>Set pubsub#persist_items to true.</li>
    <li>Set pubsub#send_last_published_item to "never".</li>
  </ol>
  <p>The access model MAY be any model defined in &xep0060;.</p>
</section1>

<section1 topic='Publishing an Item' anchor='publish'>
  <p>An account owner publishes an item to a node by following the protocol specified in &xep0060;:</p>
  <example caption='Account owner publishes item'><![CDATA[
<iq from='juliet@capulet.lit/balcony' type='set' id='pub1'>
  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
    <publish node='urn:xmpp:tmp:pubkey'>
      <item id='julietRSAkey1hash'>
        <key xmlns='urn:xmpp:tmp:pubkey'>
          <x509cert>
            der-encoded-cert
          </x509cert>
        </key>
      </item>
    </publish>
  </pubsub>
</iq>
]]></example>
  <p>If the node does not already exist, the virtual pubsub service MUST create the node. As described in &xep0163;, this "auto-create" feature (defined in <cite>XEP-0060</cite>) MUST be supported by a PEP service. (Naturally, the account owner's client MAY follow the node creation use case specified in <cite>XEP-0060</cite> before attempting to publish an item.)</p>
  <p>In order for the client to reliably persist objects, the virtual pubsub service must also support the "publish-options" feature defined in &xep0060;. Typically, a client will publish with options so that the object is properly persisted.</p>
  <example caption='Publishing a key'><![CDATA[
<iq from='juliet@capulet.lit/balcony' type='set' id='pub1'>
  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
    <publish node='urn:xmpp:tmp:pubkey'>
      <item id='julietRSAkey1hash'>
        <key xmlns='urn:xmpp:tmp:pubkey'>
          <x509cert>
            der-encoded-cert
          </x509cert>
        </key>
      </item>
    </publish>
    <publish-options>
      <x xmlns='jabber:x:data' type='submit'>
        <field var='FORM_TYPE' type='hidden'>
          <value>http://jabber.org/protocol/pubsub#publish-options</value>
        </field>
        <field var='pubsub#persist_items'>
          <value>true</value>
        </field>
        <field var='pubsub#send_last_published_item'>
          <value>never</value>
        </field>
        <field var='pubsub#access_model'>
          <value>roster</value>
        </field>
        <field var='pubsub#roster_groups_allowed'>
          <value>Friends</value>
        </field>
      </x>
    </publish-options>
  </pubsub>
</iq>
]]></example>
  <p>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 &xep0163;.</p>
</section1>

<section1 topic='Composition' anchor='composition'>
  <p>Each item published to the node is a logically separate instance of the data to be stored. It is the responsibility of the publishing and receiving entities to construct a complete view of all such items, if desired. For example, each bookmark published to a private data node is a separate piece of data, whereas the history of all items published to the node provides a complete list of the user's bookmarks. This history may include items that are republished with an existing ItemID (thus overwriting the previous version of that item).</p>
</section1>

<section1 topic='Determining Support' anchor='support'>
  <p>Before an account owner attempts to complete 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 (or cache <cite>Entity Capabilities</cite> information received from the server).</p>
  <example caption='Account owner queries server regarding protocol support'><![CDATA[
<iq from='juliet@capulet.lit/balcony'
    to='capulet.lit'
    id='disco1'
    type='get'>
  <query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>
]]></example>
    <p>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:</p>
    <example caption='Server communicates protocol support'><![CDATA[
<iq from='capulet.lit'
    to='juliet@capulet.lit/balcony'
    id='disco1'
    type='result'>
  <query xmlns='http://jabber.org/protocol/disco#info'>
    <identity category='server' type='im'/>
    <identity category='pubsub' type='pep'/>
    ...
    <feature var='http://jabber.org/protocol/pubsub#publish-options'/>
    ...
  </query>
</iq>
]]></example>
</section1>

<section1 topic='Security Considerations' anchor='security'>
  <p>This document introduces no security considerations above and beyond those specified in &xep0060; and <cite>XEP-0163</cite>.</p>
</section1>

<section1 topic='IANA Considerations' anchor='iana'>
  <p>This document requires no interaction with &IANA;.</p>
</section1>

<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
  <p>This document requires no interaction with the &REGISTRAR;.</p>
</section1>

</xep>