0.11 RC2 added structure, many clarifications

git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@162 4b5297f7-1745-476d-ba37-a9c6900126ab

xep-0155.xml

@@ -23,13 +23,13 @@
   <supersedes/>
   <supersededby/>
   <shortname>chatneg</shortname>
-  &stpeter;
   &ianpaterson;
+  &stpeter;
   <revision>
     <version>0.11</version>
-    <date>2006-11-02</date>
+    <date>2006-11-03</date>
     <initials>ip</initials>
-    <remark><p>Removed reason field; clarified handling of required fields</p></remark>
+    <remark><p>Removed reason field; added new implementation notes; many clarifications including the handling of required fields</p></remark>
   </revision>
   <revision>
     <version>0.10</version>
@@ -108,8 +108,8 @@
   </ul>
   <p>This proposal defines best practices for such a negotiation, re-using the protocol defined in &xep0020;.</p>
 </section1>
-<section1 topic='Use Cases' anchor='usecases'>
+<section1 topic='Negotiating a New Chat Session' anchor='new'>
-  <section2 topic='Initiating a Chat' anchor='initiate'>
+  <section2 topic='Initiating a Chat' anchor='new-initiate'>
     <p>In order to initiate a negotiated chat session, the initiating party ("user") sends a &MESSAGE; <note>The &MESSAGE; stanza is used because the user does not necessarily know which of the contact's resources is most available (or indeed if the contact is online).</note> stanza to the receiving party ("contact") containing a &lt;feature/&gt; child qualified by the 'http://jabber.org/protocol/feature-neg' namespace. The &MESSAGE; stanza MUST NOT contain a &BODY; child element (as specified in &rfc3921;). The &MESSAGE; stanza type SHOULD be "normal" (either explicitly or by non-inclusion of the 'type' attribute). The stanza MUST contain a &THREAD; element for tracking purposes (where the newly-generated ThreadID is unique to the proposed session). The data form MUST contain a hidden FORM_TYPE field whose value is "http://jabber.org/protocol/chatneg" and MUST contain a boolean field named "accept". &BOOLEANNOTE; The inclusion of "otr" and "security" fields is also RECOMMENDED. Note: The options within any 'list-single' fields SHOULD appear in order of preference.</p>
     <p>Note: Chat sessions may be conducted between entities who are never online at the same time. However, if the user is interested only in an <em>immediate</em> chat session then the user SHOULD instruct the contact's server not to store the message for later delivery using the &xep0079; protocol.</p>
     <p>In the following example of a negotiation request, Romeo requests a chat with Juliet and also queries her regarding whether she wants to enable all message logging (see &xep0136;) <note>A client MUST NOT set the 'otr' field to 'true' unless it has confirmed that its server will allow it to switch off Automated Archiving (see <cite>Message Archiving</cite>).</note> and support the &xep0071; and &xep0085; extensions during this chat session. He also requires that they are both connected securely to their servers, and asks which language she prefers amoungst those he can write. (Note: These fields are examples only; a full set of chat session negotiation parameters will be registered as described in the <link url='#registrar'>XMPP Registrar Considerations</link> section of this document.)</p>
@@ -175,9 +175,11 @@
   </amp>
 </message>
     ]]></example>
-    <p>The user MAY request a session with a specific resource of the contact. However, if the user specifies no resource (or if the specified resource is not available), then the contact's server delivers the request to the contact's most available resource (which in the examples below happens to be "balcony"). If no resource is available (and no <cite>Advanced Message Processing</cite> rule included in the request specifies otherwise) then the server MAY store the request for later delivery. In this case, if the contact is interested only in an <em>immediate</em> chat session when it eventually receives the request, it SHOULD initiate a new chat session negotiation (including a newly-generated ThreadID) instead of responding to the user's request. Note: Sending any response to the user's original request would leak presence information since it would divulge the fact that the contact had been offline rather than just ignoring the user.</p>
+    <p>The user MAY request a session with a specific resource of the contact. However, if the user specifies no resource (or if the specified resource is not available), then the contact's server delivers the request to the contact's most available resource (which in the examples below happens to be "balcony"). If no resource is available (and no <cite>Advanced Message Processing</cite> rule included in the request specifies otherwise) then the server MAY store the request for later delivery.</p>
+  </section2>
+  <section2 topic='Accepting a Chat' anchor='new-accept'>
+    <p>If, upon reception of a user's chat session request, a contact finds that the request had been stored for later delivery, and if the contact is interested only in an <em>immediate</em> chat session, then it SHOULD initiate a new chat session negotiation (including a newly-generated ThreadID) instead of responding to the user's request. Note: Sending any response to the user's original request would leak presence information since it would divulge the fact that the contact had been offline rather than just ignoring the user.</p>
     <p>In any response to the user's request, the contact's client MUST mirror the &THREAD; value so that the user's client can correctly track the response.</p>
-    <p>If the contact's client is configured to show the form to the client instead of responding automatically it SHOULD replace the content of the &lt;title/&gt; element and of all label attributes of the &lt;field/&gt; and &lt;option/&gt; elements with it's own localised versions before showing the form to the client - even if the form already appears to be in the correct language. Note: If a client fails to localise the form then an malicious contact might, for examples, either switch the labels on the 'security' and 'otr' fields, or use the &lt;title/&gt; to mislead the user regarding the identity of the contact.</p>
     <p>If the request is accepted then the client MUST include in its response values for all the fields that the request indicated are required. If the contact's client does not support one of the default values or if the contact has disabled its support (as for Chat State Notifications and XHTML formatting in the example below), and the client can still accept the request, then it MUST set that field to a value that it can support.</p>
     <p>In the example below we assume that Juliet accepts the chat and specifies that she prefers to speak Italian with Romeo:</p>
     <example caption="Contact accepts chat and specifies parameters"><![CDATA[
@@ -204,8 +206,10 @@
   </feature>
 </message>
     ]]></example>
-    <p>Note: Both entities MUST assume the session has been established with the resource of the contact that sends the reply, even if the user sent its request to a different resource of the contact.</p>
+    <p>Note: Both entities MUST assume the session is being established with the resource of the contact that sends the reply, even if the user sent its request to a different resource of the contact.</p>
-    <p>If the contact does not want to reveal presence to the user for whatever reason then the contact's client SHOULD return no response or error (see <link url='#security'>Security Considerations</link>). Also, if the contact is using a legacy client then it MAY not support returning any response or error. In both these cases the user MAY, proceed to send stanzas to the contact outside the context of a negotiated chat session.</p>
+  </section2>
+  <section2 topic='Rejecting a Chat' anchor='new-reject'>
+    <p>If the contact does not want to reveal presence to the user for whatever reason then the contact's client SHOULD return no response or error (see <link url='#secure-leak'>Presence Leaks</link>). Also, if the contact is using a legacy client then it MAY not support returning any response or error. In both these cases the user MAY, proceed to send stanzas to the contact outside the context of a negotiated chat session.</p>
     <p>However, if the contact simply prefers not to chat then the client SHOULD decline the invitation. The data form MUST contain the FORM_TYPE field and the "accept" field set to "0" or "false". It is RECOMMENDED that the form does not contain any other fields even if the request indicated they are required. The client MAY include a reason in the &BODY; child of the &MESSAGE; stanza:</p>
     <example caption="Contact declines offer and specifies reason"><![CDATA[
 <message type='normal'
@@ -286,8 +290,10 @@
   </error>
 </message>
     ]]></example>
-    <p>Finally, if the contact accepted the chat then the user SHOULD reply with a result form containing an 'accept' field set to 'true' (or '1') to confirm to the contact that the combination of values it submitted was acceptable, and that the chat session is open. <note>See <cite>Encrypted Sessions</cite> for examples where the user might find the values submitted by the contact unacceptable.</note> The user MAY include other content (e.g., a &BODY; element) in the confirmation stanza:</p>
+  </section2>
-    <example caption="User confirms session is open"><![CDATA[
+  <section2 topic='Completing or Canceling the Negotitation' anchor='new-complete'>
+    <p>If the contact accepted the chat (see <link url='#new-accept'>Accepting a Chat</link>) then the user MUST either complete or cancel the session negotitation. If the contact chose an option other than the default (prefered) value for one or more of the fields, then instead of having the client accept the session automatically the user may prefer to review the values that the contact selected before confirming that the session is open. <note>See <cite>Encrypted Sessions</cite> for examples of other instances where the user might find the values submitted by the contact unacceptable.</note> In any case the user's client SHOULD verify that the selected values are acceptable before completing the session negotitation - and confirming that the chat session is open - by replying with a form with the form 'type' attribute set to 'result'. The form MUST contain the FORM_TYPE field and the "accept" field set to "1" or "true". It MAY contain the other fields received from the contact. The user MAY include other content (e.g., a &BODY; element) in the confirmation stanza:</p>
+    <example caption="User completes negotitation and confirms session is open"><![CDATA[
 <message type='normal'
          from='romeo@montague.net/orchard'
          to='juliet@capulet.com/balcony'>
@@ -297,54 +303,40 @@
       <field var='FORM_TYPE'>
         <value>http://jabber.org/protocol/chatneg</value>
       </field>
-      <field var='accept'><value>1</value></field>
+      <field var='accept'><value>true</value></field>
+      <field var='otr'><value>false</value></field>
+      <field var='http://jabber.org/protocol/xhtml-im'>
+        <value>false</value>
+      </field>
+      <field var='http://jabber.org/protocol/chatstates'>
+        <value>false</value>
+      </field>
+      <field var='security'><value>c2s</value></field>
+      <field var='language'><value>it</value></field>
     </x>
   </feature>
   <body>I forgot what I wanted to say!</body>
 </message>
     ]]></example>
-  </section2>
+    <p>Alternatively, if the user decides to cancel the session negotitation then the client MUST reply with a data form containing the FORM_TYPE field and the "accept" field set to "0" or "false":</p>
-  <section2 topic='Renegotiating a Chat' anchor='renegotiate'>
+    <example caption="User cancels session negotitation"><![CDATA[
-    <p>At any time during an existing chat session, either party MAY attempt to renegotiate the parameters of the session. The requesting party does this by sending a new &MESSAGE; stanza containing a feature negotiation form and a &THREAD; element with the same value as that of the existing chat session.</p>
-    <p>Note: The "accept" field SHOULD NOT be included in a renegotiation form. The set of other fields in the form MAY be different from the set included in the initial session negotitation.</p>
-    <example caption="One party requests renegotiation"><![CDATA[
-<message type='normal'
-         from='juliet@capulet.com/balcony'
-         to='romeo@montague.net/orchard'>
-  <thread>ffd7076498744578d10edabfe7f4a866</thread>
-  <feature xmlns='http://jabber.org/protocol/feature-neg'>
-    <x xmlns='jabber:x:data' type='form'>
-      <field var='FORM_TYPE' type='hidden'>
-        <value>http://jabber.org/protocol/chatneg</value>
-      </field>
-      <field label='Off-The-Record?' type='list-single' var='otr'>
-        <value>true</value>
-        <option label='Disable all message logging'>
-          <value>true</value>
-        </option>
-        <required/>
-      </field>
-    </x>
-  </feature>
-</message>
-    ]]></example>
-    <example caption="Other party accepts offer and specifies parameters"><![CDATA[
 <message type='normal'
          from='romeo@montague.net/orchard'
          to='juliet@capulet.com/balcony'>
   <thread>ffd7076498744578d10edabfe7f4a866</thread>
   <feature xmlns='http://jabber.org/protocol/feature-neg'>
-    <x xmlns='jabber:x:data' type='submit'>
+    <x xmlns='jabber:x:data' type='result'>
       <field var='FORM_TYPE'>
         <value>http://jabber.org/protocol/chatneg</value>
       </field>
-      <field var='otr'><value>true</value></field>
+      <field var='accept'><value>0</value></field>
     </x>
   </feature>
 </message>
     ]]></example>
-    <p>If the other party's client does not support one or more of the <em>required</em> features, it SHOULD return a &feature; error instead, while if it supports <em>none</em> of the options for one or more fields, it SHOULD return a &notacceptable; error instead (see <link url='#initiate'>Initiating a Chat</link>). In either of these cases the existing negotiated chat session parameters are maintained. Either party MAY then terminate the chat session as specified in the section <link url='#terminate'>Terminating a Chat</link>.</p>
   </section2>
+</section1>
+<section1 topic='Other Use Cases' anchor='usecases'>
   <section2 topic='Switching Resources' anchor='switch'>
     <p>Either party MAY ask to continue the session using another of its resources. The requesting party does this by submitting a form with a "continue" field containing the value of the new resource:</p>
     <example caption="One party asks to switch session to another of its resources"><![CDATA[
@@ -362,9 +354,9 @@
   </feature>
 </message>
     ]]></example>
-    <p>The requesting party SHOULD NOT send stanzas within the session from either resource until the other party has accepted or rejected (with a &feature; error) the switch to the new resource.</p>
+    <p>The requesting party SHOULD NOT send stanzas within the session from either resource until the other party has accepted the switch to the new resource.</p>
-    <p>The other party SHOULD accept the switch since the requesting party might otherwise be unable to continue the session:</p>
+    <p>The other client SHOULD accept the switch automatically since the requesting party might otherwise be unable to continue the session:</p>
-    <example caption="Other party accepts switch"><![CDATA[
+    <example caption="Other client accepts switch"><![CDATA[
 <message type='normal'
          from='romeo@montague.net/orchard'
          to='juliet@capulet.com/balcony'>
@@ -381,6 +373,69 @@
     ]]></example>
     <p>Once the other party has accepted the switch then all stanzas sent within the chat session MUST be to or from the new resource. Note: Both parties MUST ensure that they comply with all the other chat session negotiation parameters that were previously agreed for this session.</p>
   </section2>
+  <section2 topic='Renegotiating a Chat' anchor='renegotiate'>
+    <p>At any time during an existing chat session, either party MAY attempt to renegotiate the parameters of the session using the protocol described in <link url='#new'>Negotiating a New Chat Session</link>. The requesting party does this by sending a new &MESSAGE; stanza containing a feature negotiation form and a &THREAD; element with the <em>same</em> value as that of the existing chat session. Note: Although the "accept" field MUST be included in a renegotiation form, the other fields MAY be different from the set of fields included in the initial session negotitation form.</p>
+    <example caption="One party requests renegotiation"><![CDATA[
+<message type='normal'
+         from='juliet@capulet.com/balcony'
+         to='romeo@montague.net/orchard'>
+  <thread>ffd7076498744578d10edabfe7f4a866</thread>
+  <feature xmlns='http://jabber.org/protocol/feature-neg'>
+    <x xmlns='jabber:x:data' type='form'>
+      <field var='FORM_TYPE' type='hidden'>
+        <value>http://jabber.org/protocol/chatneg</value>
+      </field>
+      <field label='Accept this change?' type='boolean' var='accept'>
+        <value>true</value>
+        <required/>
+      </field>
+      <field label='Off-The-Record?' type='list-single' var='otr'>
+        <value>true</value>
+        <option label='Disable all message logging'>
+          <value>true</value>
+        </option>
+        <required/>
+      </field>
+    </x>
+  </feature>
+</message>
+    ]]></example>
+    <p>The requesting party MAY continue to send stanzas within the session while it is waiting for the other party to either accept or reject the renegotiation.</p>
+    <example caption="Other party accepts renegotiation and specifies parameters"><![CDATA[
+<message type='normal'
+         from='romeo@montague.net/orchard'
+         to='juliet@capulet.com/balcony'>
+  <thread>ffd7076498744578d10edabfe7f4a866</thread>
+  <feature xmlns='http://jabber.org/protocol/feature-neg'>
+    <x xmlns='jabber:x:data' type='submit'>
+      <field var='FORM_TYPE'>
+        <value>http://jabber.org/protocol/chatneg</value>
+      </field>
+      <field var='accept'><value>1</value></field>
+      <field var='otr'><value>true</value></field>
+    </x>
+  </feature>
+</message>
+    ]]></example>
+    <p>Note: Both parties MUST consider the renegotiation to be complete as soon as the acceptance message has been sent (or received). The requesting party SHOULD NOT send a renegotiation completion or cancelation message (see <link url='#new-complete'>Completing or Canceling the Negotitation</link>).</p>
+    <p>Note: Both parties MUST ensure that they comply with all the chat session negotiation parameters that were not renegotiated but had previously been agreed for this session.</p>
+    <p>If the other party's client does not support one or more of the <em>required</em> features, it SHOULD return a &feature; error instead, while if it supports <em>none</em> of the options for one or more fields, it SHOULD return a &notacceptable; error instead (see <link url='#new-reject'>Rejecting a Chat</link>). However, if the other party simply prefers to maintain the existing negotiated parameters then it SHOULD decline the renegotiation as in the example below. Note: In any of these cases the existing negotiated chat session parameters are maintained. Either party MAY choose to terminate the chat session only as specified in the section <link url='#terminate'>Terminating a Chat</link>.</p>
+    <example caption="Other party declines renegotiation"><![CDATA[
+<message type='normal'
+         from='romeo@montague.net/orchard'
+         to='juliet@capulet.com/balcony'>
+  <thread>ffd7076498744578d10edabfe7f4a866</thread>
+  <feature xmlns='http://jabber.org/protocol/feature-neg'>
+    <x xmlns='jabber:x:data' type='submit'>
+      <field var='FORM_TYPE'>
+        <value>http://jabber.org/protocol/chatneg</value>
+      </field>
+      <field var='accept'><value>0</value></field>
+    </x>
+  </feature>
+</message>
+    ]]></example>
+  </section2>
   <section2 topic='Terminating a Chat' anchor='terminate'>
     <p>In order to explicitly terminate a negotiated chat, the party that wishes to end the chat MUST do so by sending a &MESSAGE; containing a data form of type "submit". The &MESSAGE; stanza MUST contain a &THREAD; element with the same XML character data as the original initiation request. The data form containing a boolean field named "terminate" set to a value of "1" or "true".</p>
     <example caption="One party terminates chat"><![CDATA[
@@ -429,7 +484,10 @@
 </section1>
 <section1 topic='Implementation Notes' anchor='impl'>
   <section2 topic='Auto Accept or Reject' anchor='impl-auto'>
-    <p>A client MAY require a human user to approve each chat session negotiation request or MAY auto-accept and auto-reject requests based on some user-configurable policy (see <link url='#security'>Security Considerations</link>).</p>
+    <p>A client MAY require a human user to approve each chat session negotiation request, however it is RECOMMENDED that it accepts or rejects automatically as many requests as possible, based on a set of user-configurable policies (see <link url='#secure-leak'>Presence Leaks</link>).</p>
+  </section2>
+  <section2 topic='Persisting Sessions' anchor='impl-close'>
+    <p>Chat session negotiation sometimes requires the involvement of either or both human users, and if human input is required but the user is away then session establishment may be delayed indefinitely. So, in order to minimise the number of user interruptions and delays, clients SHOULD reuse existing chat sessions whenever possible. For example, a client SHOULD NOT terminate chat sessions unless the user is going offline, even if its user closes a chat window.</p>
   </section2>
   <section2 topic='Unavailable Presence' anchor='impl-unavail'>
     <p>If a party receives an XMPP presence stanza of type "unavailable" from the full JID (&FULLJID;) of the other party (i.e., the resource with which it has had an active session) during a chat session, the receiving party SHOULD assume that the other client will still be able to continue the session (perhaps it simply became "invisible", or it is persisting the state of the negotiated chat until it reconnects and receives "offline" messages).</p>
@@ -437,7 +495,12 @@
   </section2>
 </section1>
 <section1 topic='Security Considerations' anchor='security'>
+  <section2 topic='Presence Leaks' anchor='secure-leak'>
     <p>If a contact accepts a user's chat session negotiation request or returns an error to the user, the user will effectively discover the presence of the contact's resource. Due care must therefore be exercised in determining whether to accept the request or return an error. For examples, the contact's client SHOULD NOT <em>automatically</em> (i.e. without first asking the contact) either accept the user's request or return an error to the user unless the user is subscribing to the contact's presence (and the contact's presence is not currently "invisible" to the user). Note: There should be no need for the contact's client to consult the contact's block list, since if the user is on the list then the contact would not receive any request messages from the user anyway.</p>
+  </section2>
+  <section2 topic='Localization' anchor='secure-local'>
+    <p>If a client is configured to show a request &lt;form/&gt; to a human user instead of responding automatically, the client SHOULD replace the content of the &lt;title/&gt; element and of all label attributes of the &lt;field/&gt; and &lt;option/&gt; elements with it's own localised versions before showing the form to the client - even if the form already appears to be in the correct language. Note: If a client fails to localize the form then a malicious contact might, for examples, either switch the labels on the 'security' and 'otr' fields, or use the &lt;title/&gt; to mislead the user regarding the identity of the contact.</p>
+  </section2>
 </section1>
 <section1 topic='IANA Considerations' anchor='iana'>
   <p>This document requires no interaction with &IANA;.</p>