From 037c758021d5b795af51b34891f442d9aa26e249 Mon Sep 17 00:00:00 2001 From: Florian Schmaus Date: Thu, 27 Oct 2016 16:40:26 +0200 Subject: [PATCH] Bump XEP-0359 ("Stanza IDs)" to 0.3 Rename client-id element to origin-id and miscellaneous minor improvements. --- xep-0359.xml | 36 ++++++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/xep-0359.xml b/xep-0359.xml index 47a1665f..0a9ae580 100644 --- a/xep-0359.xml +++ b/xep-0359.xml @@ -1,5 +1,7 @@ + %ents; ]> @@ -21,6 +23,15 @@ stanza-id &flow; + + 0.3.0 + 2016-10-29 + fs + +

Rename client-id element to origin-id.

+

Minor improvements.

+ + 0.2.1 2015-09-22 @@ -66,10 +77,7 @@ -

Unique and stable IDs for stanzas, which are set by a XMPP service, are beneficial in various ways. They can be used together with &xep0313; to uniquely identify a message within an archive. They are also useful in the context of &xep0045; conferences, in order to identify a message reflected by a MUC service back to the originating entity.

- - -

The herein defined stanza IDs must be unique and stable within the scope of the generating XMPP entity.

+

This XEP introduces unique and stable IDs for stanzas, which are beneficial in various ways. For example, they can be used together with &xep0313; to uniquely identify a message within an archive. They are also useful in the context of &xep0045; conferences, as they allow to identify a message reflected by a MUC service back to the originating entity.

 @@ -78,21 +86,21 @@ id='de305d54-75b4-431b-adb2-eb6b9e546013' by='room@muc.xmpp.org'/> ]]> - In order to create a 'stanza-id' extension, the creating XMPP entity generates and sets the value of the 'id' attribute, and puts its own XMPP address as value of the 'by' attribute. The value of the 'id' attribute must be unique and stable, i.e. it MUST NOT change later for some reason, within the scope of the 'by' value. Thus the IDs defined in this extension MUST be unique and stable within the scope of the generating XMPP entity. It is RECOMMENDED that the ID generating service uses UUID and the algorithm defined in RFC 4122 to generate the IDs. + In order to create a &stanza-id; extension element, the creating XMPP entity generates and sets the value of the 'id' attribute, and puts its own XMPP address as value of the 'by' attribute. The value of the 'id' attribute must be unique and stable, i.e. it MUST NOT change later for some reason within the scope of the 'by' value. Thus the IDs defined in this extension MUST be unique and stable within the scope of the generating XMPP entity. It is RECOMMENDED that the ID generating service uses UUID and the algorithm defined in &rfc4122; to generate the IDs. - +

- Some use cases require the client to generate the stanza ID. In this case, the client MUST use the 'client-id' element. + Some use cases require the originating entity, e.g. a client, to generate the stanza ID. In this case, the client MUST use the &origin-id; element extension element qualified by the 'urn:xmpp:sid:0' namespace. Note that originating entities often want to conceal their XMPP address and therefore the &origin-id; element has no 'by' attribute.

Typical body text - + ]]>

- The server or component MAY add a stanza-id element. In that case, it MUST preserve the content of the 'client-id' element. + The server or component MAY add a &stanza-id; element. In that case, it MUST preserve the content of the &origin-id; element.

- + ]]> @@ -110,10 +118,10 @@
  1. XMPP entities, which are routing stanzas, MUST NOT strip any elements qualified by the 'urn:xmpp:sid:0' namespace from message stanzas. They SHOULD however ensure that those elements contain only the attributes defined herein, and take appropriate countermeasures if this is not the case (e.g. removing those attributes).
  2. The values of the 'id' attribute SHOULD be unpredictable.
    3. -
  3. Stanza ID generating entities, which encounter a <stanza-id/> element where 'id' is already set and where the 'by' attribute matches their own XMPP address, MUST ignore the existing value of 'id' and override it.
    4. -
  4. Stanzas MUST posses, in the direct child level of the stanza, at most one 'stanza-id' extension element with the same XMPP address as value of the 'by' attribute.
    5. -
  5. Every <stanza-id> extension element MUST have the 'id' attribute and the 'by' attribute set.
    6. -
  6. Every <stanza-id> and <client-id> extension element MUST always posses an 'id' attribute and MUST NOT have any child elements or text content.
    7. +
  7. Stanza ID generating entities, which encounter a &stanza-id; element where 'id' is already set and where the 'by' attribute matches their own XMPP address, MUST ignore the existing value of 'id' and override it.
    8. +
  8. Stanzas MUST posses, in the direct child level of the stanza, at most one &stanza-id; extension element with the same XMPP address as value of the 'by' attribute.
    9. +
  9. Every &stanza-id; extension element MUST have the 'id' attribute and the 'by' attribute set.
    10. +
  10. Every &stanza-id; and &origin-id; extension element MUST always posses an 'id' attribute and MUST NOT have any child elements or text content.
  11. The value of the 'by' attribute MUST be the XMPP address of the entity assigning the unique and stable stanza ID. Note that XMPP addresses are normalized as defined in &rfc6122;