2011-03-23 11:41:53 -04:00
<?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 > Message Forwarding</title>
<abstract > This document defines a protocol to forward a message from one entity to another.</abstract>
&LEGALNOTICE;
2011-04-11 18:26:41 -04:00
<number > 0297</number>
<status > Experimental</status>
2011-03-23 11:41:53 -04:00
<type > Standards Track</type>
<sig > Standards</sig>
<dependencies >
<spec > XMPP Core</spec>
</dependencies>
<supersedes />
<supersededby />
<shortname > forwarding</shortname>
2011-04-11 18:26:41 -04:00
<schemaloc />
2011-03-23 11:41:53 -04:00
<author >
<firstname > Matthew</firstname>
<surname > Wild</surname>
<email > me@matthewwild.co.uk</email>
<jid > me@matthewwild.co.uk</jid>
</author>
&ksmith;
2011-07-11 12:30:43 -04:00
<revision >
<version > 0.3</version>
<date > 2011-07-11</date>
<initials > ks</initials>
<remark > <p > Made security considerations more explicit.</p> </remark>
</revision>
2011-07-06 11:21:30 -04:00
<revision >
<version > 0.2</version>
<date > 2011-07-06</date>
<initials > psa</initials>
<remark > <p > Corrected XML namespace to reflect official publication.</p> </remark>
</revision>
2011-04-11 18:26:41 -04:00
<revision >
<version > 0.1</version>
<date > 2011-04-11</date>
<initials > psa</initials>
<remark > <p > Initial published version.</p> </remark>
</revision>
2011-03-23 11:41:53 -04:00
<revision >
<version > 0.0.1</version>
<date > 2011-03-22</date>
<initials > mw/ks</initials>
<remark > <p > First draft.</p> </remark>
</revision>
</header>
<section1 topic= 'Introduction' anchor= 'intro' >
2011-07-11 12:30:43 -04:00
<p > There are many situations is which an entity needs to forward a previously sent message to another entity, such as forwarding an interesting message to a friend, or a server forwarding stored messages from an archive. Here we specify a simple encapsulation method for such forwarded messages. This format can be used in other specifications requiring the forwarding of messages, or used in isolation for a user to forward a message to another user (rather like email forwards).</p>
2011-03-23 11:41:53 -04:00
</section1>
<section1 topic= 'Requirements' anchor= 'requirements' >
<p > Several properties are desirable when forwarding messages:</p>
<ul >
<li > The original sender and receiver should be identified.</li>
<li > Extension payloads should be included (not only a message < body/> </li>
<li > It should be possible to annotate the message (e.g. with a timestamp) without ambiguity as to the original message.</li>
<li > It should allow features such as encryption or signing of the original message to survive the forwarding.</li>
</ul>
</section1>
<section1 topic= 'Forwarding a message' >
<section2 topic= 'Overview' >
<p > Let us suppose that a Romeo receives a message from Juliet:</p>
<example caption= 'Receiving a message' > < ![CDATA[
<message to= 'romeo@montague.lit' from= 'juliet@capulet.lit/orchard' type= 'chat' id= '0202197' >
<body > Yet I should kill thee with much cherishing.</body>
<mood xmlns= 'http://jabber.org/protocol/mood' >
<amorous />
</mood>
</message>
]]></example>
2011-07-06 11:21:30 -04:00
<p > To forward this to Mercutio, Romeo would send a new message with a < forwarded/> payload of namespace 'urn:xmpp:forward:0'.</p>
2011-03-23 11:41:53 -04:00
<example caption= 'Forwarding a message' > < ![CDATA[
<message to= 'mercutio@verona.lit' from= 'romeo@montague.lit/orchard' type= 'chat' id= '28gs' >
<body > A most courteous exposition!</body>
2011-07-06 11:21:30 -04:00
<forwarded xmlns= 'urn:xmpp:forward:0' >
2011-03-23 11:41:53 -04:00
<delay xmlns= 'urn:xmpp:delay' stamp= '2010-07-10T23:08:25Z' />
<message to= 'romeo@montague.lit' from= 'juliet@capulet.lit/orchard' type= 'chat' id= '0202197' xmlns= 'jabber:client' >
<body > Yet I should kill thee with much cherishing.</body>
<mood xmlns= 'http://jabber.org/protocol/mood' >
<amorous />
</mood>
</message>
</forwarded>
</message>
]]></example>
</section2>
<section2 topic= 'Business rules' >
<ul >
<li > Forwarded messages SHOULD include all relevant child elements of the original message by default.
However, an implementation MAY omit elements it deems irrelevant and safe to discard. An example
would be omitting &xep0085; elements which typically do not make sense outside the context of a
conversation session. However it should be noted that removing such elements can invalidate any
digital signature on a stanza. If preserving a signature is important in the context this extension
is used then child elements SHOULD NOT be removed.</li>
<li > The forwarding entity SHOULD add a < delay/> child to the < forwarded/> element
to indicate to the recipient the date/time that the forwarding entity received the original
message. The format of this element is described in &xep0203; .</li>
<li > The namespace of the forwarded stanza MUST be preserved (this is typically 'jabber:client').
If no 'xmlns' is set for the stanza then as per XML namespacing rules it would inherit the
2011-07-06 11:21:30 -04:00
'urn:xmpp:forward:0' namespace, which is wrong.</li>
2011-03-23 11:41:53 -04:00
<li > When this extension is employed simply for a user to forward a given message to a contact, the
outer < message/> SHOULD contain a body (even if empty) and a receiving client should pay
particular attention to ensure it renders both the sender's text and the forwarded message
unambiguously.</li>
</ul>
</section2>
</section1>
<section1 topic= 'Security Considerations' anchor= 'security' >
<p > Forwarding messages can reveal information about the original sender, including possible presence leaks as well as the message payloads themselves. Any extensions using this format must therefore consider the implications of this.</p>
2011-07-11 12:30:43 -04:00
<p > Forwarding can either be used as-is, or in the context of another specification, with different security considerations:</p>
<section2 topic= 'As-is' anchor= 'as-is-sc' >
2011-03-23 11:41:53 -04:00
<p > Receipt of a forwarded message from a third-party does not guarantee that the original message was actually received, or that the content has not been modified, by the forwarder. Integrity of the original message can only be determined through digital signing mechanisms such as described in &xep0285; and &xep0290; .</p>
<p > Considering the above an end-user client should take special care in its rendering of a forwarded message to ensure that the user cannot mistake it for a message received directly from the original sender.</p>
2011-07-11 12:30:43 -04:00
<p > An entity SHOULD NOT trust that forwards are genuine when receiving them unprovoked (i.e. outside the scope of another specification).</p>
</section2>
<section2 topic= 'Extensions' anchor= 'extensions-sc' >
<p > While security considerations are ultimately dependent upon the specifications using the format defined herein, forwarding introduces scope for message forgery such that authors of derivative specifications will need to address security considerations themselves. These need to cover which entities a client should accept forwards from, and which entities those are permitted to forward messages for. For example, a specification may choose to only trust forwards if they are received from the user's client, another client on the bare JID, or the user's server.</p>
</section2>
2011-03-23 11:41:53 -04:00
</section1>
<section1 topic= 'XML Schema' anchor= 'schema' >
<code > < ![CDATA[
<?xml version='1.0' encoding='UTF-8'?>
<xs:schema
xmlns:xs='http://www.w3.org/2001/XMLSchema'
2011-07-06 11:21:30 -04:00
targetNamespace='urn:xmpp:forward:0'
xmlns='urn:xmpp:forward:0'
2011-03-23 11:41:53 -04:00
elementFormDefault='qualified'>
<xs:annotation >
<xs:documentation >
The protocol documented by this schema is defined in
XEP-xxxx: http://www.xmpp.org/extensions/inbox/forwarding.html
</xs:documentation>
</xs:annotation>
<xs:element name= 'forwarded' >
<xs:complexType >
<xs:sequence xmlns:delay= 'urn:xmpp:delay' >
<xs:element ref= 'delay:delay' minOccurs= '0' maxOccurs= '1' />
<xs:any namespace= '##other' minOccurs= '1' maxOccurs= '1' />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
]]></code>
</section1>
<section1 topic= 'Acknowledgements' anchor= 'ack' >
2011-07-06 11:21:30 -04:00
<p > Thanks to Matt Miller and Florian Zeitz for feedback.</p>
2011-03-23 11:41:53 -04:00
</section1>
</xep>
