mirror of https://github.com/moparisthebest/xeps
urn namespace
git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@206 4b5297f7-1745-476d-ba37-a9c6900126ab
This commit is contained in:
Ian Paterson
parent
970132490a
commit
5d50f50fbe
46
xep-0155.xml
46
xep-0155.xml
|
|
@ -29,7 +29,7 @@
|
|||
<version>0.13</version>
|
||||
<date>2006-11-16</date>
|
||||
<initials>ip</initials>
|
||||
<remark><p>Added disclosure field</p></remark>
|
||||
<remark><p>Added disclosure field; changed namespace</p></remark>
|
||||
</revision>
|
||||
<revision>
|
||||
<version>0.12</version>
|
||||
|
|
@ -122,9 +122,9 @@
|
|||
</section1>
|
||||
<section1 topic='Negotiating a New Chat Session' anchor='new'>
|
||||
<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 <feature/> 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", "disclosure" and "security" fields is also RECOMMENDED. Note: The options within any 'list-single' fields SHOULD appear in order of preference.</p>
|
||||
<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 <feature/> 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 "urn:xmpp:chatneg" and MUST contain a boolean field named "accept". &BOOLEANNOTE; The inclusion of "otr", "disclosure" 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 asks Juliet's client if it is prepared to make a (legally binding) guarantee that it does not intentionally implement any feature (not even a disabled feature) that might disclose the content of the chat, any associated (decryption) keys or his identity to any third-party (see <cite>Encrypted Sessions</cite>). 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>
|
||||
<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 asks Juliet's client if it is prepared to make a (legally binding) guarantee that it does not intentionally implement any feature (not even a disabled feature) that might disclose the content of the chat, any associated (decryption) keys or his identity to any third-party (see <cite>Encrypted Session Negotiation</cite>). 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>
|
||||
<example caption="User requests chat session"><![CDATA[
|
||||
<message type='normal'
|
||||
from='romeo@montague.net/orchard'
|
||||
|
|
@ -134,7 +134,7 @@
|
|||
<x xmlns='jabber:x:data' type='form'>
|
||||
<title>Open chat with Romeo?</title>
|
||||
<field var='FORM_TYPE' type='hidden'>
|
||||
<value>http://jabber.org/protocol/chatneg</value>
|
||||
<value>urn:xmpp:chatneg</value>
|
||||
</field>
|
||||
<field label='Accept this chat?' type='boolean' var='accept'>
|
||||
<value>true</value>
|
||||
|
|
@ -215,7 +215,7 @@
|
|||
<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>
|
||||
<value>urn:xmpp:chatneg</value>
|
||||
</field>
|
||||
<field var='accept'><value>true</value></field>
|
||||
<field var='otr'><value>0</value></field>
|
||||
|
|
@ -245,7 +245,7 @@
|
|||
<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>
|
||||
<value>urn:xmpp:chatneg</value>
|
||||
</field>
|
||||
<field var='accept'><value>0</value></field>
|
||||
</x>
|
||||
|
|
@ -253,7 +253,7 @@
|
|||
<body>Sorry, can't chat now! How about tonight?</body>
|
||||
</message>
|
||||
]]></example>
|
||||
<p>If the contact's client does not support feature negotiation or does not support the "http://jabber.org/protocol/chatneg" FORM_TYPE, it SHOULD return a &unavailable; error:</p>
|
||||
<p>If the contact's client does not support feature negotiation or does not support the "urn:xmpp:chatneg" FORM_TYPE, it SHOULD return a &unavailable; error:</p>
|
||||
<example caption="Contact returns service unavailable error"><![CDATA[
|
||||
<message type='error'
|
||||
from='juliet@capulet.com/balcony'
|
||||
|
|
@ -262,7 +262,7 @@
|
|||
<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>
|
||||
<value>urn:xmpp:chatneg</value>
|
||||
</field>
|
||||
...
|
||||
</x>
|
||||
|
|
@ -281,7 +281,7 @@
|
|||
<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>
|
||||
<value>urn:xmpp:chatneg</value>
|
||||
</field>
|
||||
...
|
||||
</x>
|
||||
|
|
@ -303,7 +303,7 @@
|
|||
<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>
|
||||
<value>urn:xmpp:chatneg</value>
|
||||
</field>
|
||||
...
|
||||
</x>
|
||||
|
|
@ -318,7 +318,7 @@
|
|||
]]></example>
|
||||
</section2>
|
||||
<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". The user MAY include other content (e.g., a &BODY; element) in the confirmation stanza:</p>
|
||||
<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 Session Negotiation</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". 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'
|
||||
|
|
@ -327,7 +327,7 @@
|
|||
<feature xmlns='http://jabber.org/protocol/feature-neg'>
|
||||
<x xmlns='jabber:x:data' type='result'>
|
||||
<field var='FORM_TYPE'>
|
||||
<value>http://jabber.org/protocol/chatneg</value>
|
||||
<value>urn:xmpp:chatneg</value>
|
||||
</field>
|
||||
<field var='accept'><value>true</value></field>
|
||||
</x>
|
||||
|
|
@ -344,7 +344,7 @@
|
|||
<feature xmlns='http://jabber.org/protocol/feature-neg'>
|
||||
<x xmlns='jabber:x:data' type='result'>
|
||||
<field var='FORM_TYPE'>
|
||||
<value>http://jabber.org/protocol/chatneg</value>
|
||||
<value>urn:xmpp:chatneg</value>
|
||||
</field>
|
||||
<field var='accept'><value>0</value></field>
|
||||
</x>
|
||||
|
|
@ -364,7 +364,7 @@
|
|||
<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>
|
||||
<value>urn:xmpp:chatneg</value>
|
||||
</field>
|
||||
<field var='continue'><value>PDA</value></field>
|
||||
</x>
|
||||
|
|
@ -381,7 +381,7 @@
|
|||
<feature xmlns='http://jabber.org/protocol/feature-neg'>
|
||||
<x xmlns='jabber:x:data' type='result'>
|
||||
<field var='FORM_TYPE'>
|
||||
<value>http://jabber.org/protocol/chatneg</value>
|
||||
<value>urn:xmpp:chatneg</value>
|
||||
</field>
|
||||
<field var='continue'><value>PDA</value></field>
|
||||
</x>
|
||||
|
|
@ -400,7 +400,7 @@
|
|||
<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>
|
||||
<value>urn:xmpp:chatneg</value>
|
||||
</field>
|
||||
<field label='Off-The-Record?' type='list-single' var='otr'>
|
||||
<value>1</value>
|
||||
|
|
@ -422,7 +422,7 @@
|
|||
<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>
|
||||
<value>urn:xmpp:chatneg</value>
|
||||
</field>
|
||||
<field var='otr'><value>1</value></field>
|
||||
</x>
|
||||
|
|
@ -443,7 +443,7 @@
|
|||
<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>
|
||||
<value>urn:xmpp:chatneg</value>
|
||||
</field>
|
||||
<field var='terminate'><value>1</value></field>
|
||||
</x>
|
||||
|
|
@ -451,7 +451,7 @@
|
|||
</message>
|
||||
]]></example>
|
||||
<p>Both parties MUST then consider the chat session to be ended.</p>
|
||||
<p>The other party's client MAY explicitly acknowledge the termination of the chat by sending a &MESSAGE; containing a data form of type "result", and the value of the "terminate" field set to "1" or "true" (see <cite>Encrypted Sessions</cite> for a practical example). The client MUST mirror the &THREAD; value it received.</p>
|
||||
<p>The other party's client MAY explicitly acknowledge the termination of the chat by sending a &MESSAGE; containing a data form of type "result", and the value of the "terminate" field set to "1" or "true" (see <cite>Encrypted Session Negotiation</cite> for a practical example). The client MUST mirror the &THREAD; value it received.</p>
|
||||
<example caption="Other party acknowledges chat termination"><![CDATA[
|
||||
<message type='normal'
|
||||
from='romeo@montague.net/orchard'
|
||||
|
|
@ -460,7 +460,7 @@
|
|||
<feature xmlns='http://jabber.org/protocol/feature-neg'>
|
||||
<x xmlns='jabber:x:data' type='result'>
|
||||
<field var='FORM_TYPE'>
|
||||
<value>http://jabber.org/protocol/chatneg</value>
|
||||
<value>urn:xmpp:chatneg</value>
|
||||
</field>
|
||||
<field var='terminate'><value>1</value></field>
|
||||
</x>
|
||||
|
|
@ -504,10 +504,10 @@
|
|||
</section1>
|
||||
<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
|
||||
<section2 topic='Service Discovery Features' anchor='registrar-features'>
|
||||
<p>The ®ISTRAR; shall include 'http://jabber.org/protocol/chatneg' in its registry of Service Discovery features.</p>
|
||||
<p>The ®ISTRAR; shall include 'urn:xmpp:chatneg' in its registry of Service Discovery features.</p>
|
||||
<code caption='Registry Submission'><![CDATA[
|
||||
<var>
|
||||
<name>http://jabber.org/protocol/chatneg</name>
|
||||
<name>urn:xmpp:chatneg</name>
|
||||
<desc>Support for Chat Session Negotiation and its FORM_TYPE</desc>
|
||||
<doc>XEP-0155</doc>
|
||||
</var>
|
||||
|
|
@ -517,7 +517,7 @@
|
|||
<p>&xep0068; defines a process for standardizing the fields used within Data Forms qualified by a particular namespace. The following fields shall be registered for use in Chat Session Negotiation:</p>
|
||||
<code caption='Registry Submission'><![CDATA[
|
||||
<form_type>
|
||||
<name>http://jabber.org/protocol/chatneg</name>
|
||||
<name>urn:xmpp:chatneg</name>
|
||||
<doc>XEP-0155</doc>
|
||||
<desc>
|
||||
Forms enabling negotation of a one-to-one
|
||||
|
|
|
|||
Loading…
Reference in New Issue