diff --git a/xep-0222.xml b/xep-0222.xml new file mode 100644 index 00000000..1ecb4677 --- /dev/null +++ b/xep-0222.xml @@ -0,0 +1,284 @@ + + +%ents; +]> + + +
+ Persisting Objects via Publish-Subscribe + This document specifies protocol semantics for using the XMPP publish-subscribe extension to persistently store semi-public data objects such as public keys and personal profiles. + &LEGALNOTICE; + 0222 + 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 semi-public data objects such as public keys or user profiles. Therefore this document defines a set of best practices that enable an IM user 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 (we call such a node a "POP node").

+
+ +

This section provides a friendly introduction to persisting objects via pubsub (a.k.a. POP).

+

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

+

We assume that you have three contacts with the following relationship to you:

+
    +
  1. benvolio@montague.lit, who has no subscription to your presence
  2. +
  3. nurse@capulet.lit, who has a bidirectional subscription to your presence and who is in your "Servants" roster group
  4. +
  5. romeo@montague.lit, who has a bidirectional subscription to your presence and who is in your "Friends" roster group
  6. +
+

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.

+

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 <juliet@capulet.lit>.

+ + + + + + julietRSAkey1hash + + + ... + AQAB + + + + + + + + + http://jabber.org/protocol/pubsub#publish-options + + + true + + + never + + + roster + + + Friends + + + + + + ]]> +

Your publish request is a standard pubsub request except that:

+
    +
  1. The item is persisted (pubsub#persist_items is true).
  2. +
  3. The last published item is never sent (i.e., items are pushed out only when modified).
  4. +
  5. In this case, access is limited to people in your Friends roster group.
  6. +
+

If all goes well (see Publishing an Item), 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 "http://www.xmpp.org/extensions/xep-0189.html#ns" payload type.

+ + + + + + julietRSAkey1hash + + + ... + AQAB + + + + + + + + ]]> +

Because PEP services must send notifications to the account owner, you too receive the notification at each of your resources (here "balcony" and "chamber").

+ + + + + + julietRSAkey1hash + + + ... + AQAB + + + + + + + + + + + + + + julietRSAkey1hash + + + ... + AQAB + + + + + + + + ]]> +

So that's the general idea.

+
+
+ + +

Persisting objects via pubsub ("POP") re-uses the concepts already defined in XEP-0060 and XEP-0163. In order to optimize for object persistence instead of transient event notifications, a POP node MUST be configured as follows:

+
    +
  1. Set pubsub#persist_items to true.
  2. +
  3. Set pubsub#last_published_item to "never".
  4. +
+

The access model MAY be any model defined in XEP-0060.

+
+ + +

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

+ + + + + + julietRSAkey1hash + + + ... + AQAB + + + + + + + + ]]> +

If the node does not already exist, the virtual pubsubservice 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 objects, 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 properly persisted.

+ + + + + + julietRSAkey1hash + + + ... + AQAB + + + + + + + + + http://jabber.org/protocol/pubsub#publish-options + + + true + + + never + + + roster + + + Friends + + + + + + ]]> +

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

+
+ +
diff --git a/xep-0223.xml b/xep-0223.xml new file mode 100644 index 00000000..2ca7fcfb --- /dev/null +++ b/xep-0223.xml @@ -0,0 +1,236 @@ + + +%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 privata 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. +
  3. In this case, access is limited to yourself (the "whitelist" access model defaults to allowing access for the account owner, i.e., you).
  4. +
+

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. +
  3. Set pubsub#persist_items to true.
  4. +
+
+ + +

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

+
+ +