1
0
mirror of https://github.com/moparisthebest/xeps synced 2024-11-27 19:52:18 -05:00
git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@886 4b5297f7-1745-476d-ba37-a9c6900126ab
This commit is contained in:
Peter Saint-Andre 2007-05-30 19:15:11 +00:00
parent 706994fe3b
commit 994eb574b0
2 changed files with 38 additions and 65 deletions

View File

@ -2,43 +2,6 @@
<!DOCTYPE xep SYSTEM 'xep.dtd' [ <!DOCTYPE xep SYSTEM 'xep.dtd' [
<!ENTITY % ents SYSTEM 'xep.ent'> <!ENTITY % ents SYSTEM 'xep.ent'>
%ents; %ents;
<!ENTITY esupy "e<span class='super'>y</span>">
<!ENTITY dsupx "d<span class='super'>x</span>">
<!ENTITY gsupx "g<span class='super'>x</span>">
<!ENTITY gsupy "g<span class='super'>y</span>">
<!ENTITY NsubA "N<span class='sub'>A</span>">
<!ENTITY NsubB "N<span class='sub'>B</span>">
<!ENTITY CsubA "C<span class='sub'>A</span>">
<!ENTITY CsubB "C<span class='sub'>B</span>">
<!ENTITY MsubA "M<span class='sub'>A</span>">
<!ENTITY MsubB "M<span class='sub'>B</span>">
<!ENTITY KMsubA "KM<span class='sub'>A</span>">
<!ENTITY KMsubB "KM<span class='sub'>B</span>">
<!ENTITY KCsubA "KC<span class='sub'>A</span>">
<!ENTITY KCsubB "KC<span class='sub'>B</span>">
<!ENTITY KSsubA "KS<span class='sub'>A</span>">
<!ENTITY KSsubB "KS<span class='sub'>B</span>">
<!ENTITY twosup32 "2<span class='super'>32</span>">
<!ENTITY twosup2n "2<span class='super'>2n-1</span>">
<!ENTITY CBeCAx2n1 "&CsubB; = &CsubA; XOR 2<span class='super'>n-1</span>">
<!ENTITY IDA "ID<span class='sub'>A</span>">
<!ENTITY IDB "ID<span class='sub'>B</span>">
<!ENTITY formA "form<span class='sub'>A</span>">
<!ENTITY formB "form<span class='sub'>B</span>">
<!ENTITY macA "mac<span class='sub'>A</span>">
<!ENTITY macB "mac<span class='sub'>B</span>">
<!ENTITY signA "sign<span class='sub'>A</span>">
<!ENTITY signB "sign<span class='sub'>B</span>">
<!ENTITY signsA "signs<span class='sub'>A</span>">
<!ENTITY signsB "signs<span class='sub'>B</span>">
<!ENTITY pubKeyA "pubKey<span class='sub'>A</span>">
<!ENTITY pubKeyB "pubKey<span class='sub'>B</span>">
<!ENTITY signKeyA "signKey<span class='sub'>A</span>">
<!ENTITY signKeyB "signKey<span class='sub'>B</span>">
<!ENTITY pubKeysA "pubKeys<span class='sub'>A</span>">
<!ENTITY signKeysA "signKeys<span class='sub'>A</span>">
<!ENTITY x1xZ "x<span class='sub'>1</span>...x<span class='sub'>Z</span>">
<!ENTITY e1eZ "e<span class='sub'>1</span>...e<span class='sub'>Z</span>">
]> ]>
<?xml-stylesheet type='text/xsl' href='xep.xsl'?> <?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep> <xep>
@ -68,13 +31,13 @@
</dependencies> </dependencies>
<supersedes>None</supersedes> <supersedes>None</supersedes>
<supersededby>None</supersededby> <supersededby>None</supersededby>
<shortname>offlineesession</shortname> <shortname>TO BE ASSIGNED</shortname>
&ianpaterson; &ianpaterson;
<revision> <revision>
<version>0.5</version> <version>0.5</version>
<date>2007-05-30</date> <date>2007-05-30</date>
<initials>ip</initials> <initials>ip/psa</initials>
<remark><p>Added reference to Requirements for Encrypted Sessions</p></remark> <remark><p>Added reference to Requirements for Encrypted Sessions; modified namespaces to reflect XMPP Registrar procedures regarding URN issuance.</p></remark>
</revision> </revision>
<revision> <revision>
<version>0.4</version> <version>0.4</version>
@ -138,7 +101,7 @@
<example caption='Alice Creates PEP Node for ESession Options for Presence Subscribers'><![CDATA[ <example caption='Alice Creates PEP Node for ESession Options for Presence Subscribers'><![CDATA[
<iq from='alice@example.org/pda' type='set' id='create1'> <iq from='alice@example.org/pda' type='set' id='create1'>
<pubsub xmlns='http://jabber.org/protocol/pubsub'> <pubsub xmlns='http://jabber.org/protocol/pubsub'>
<create node='urn:xmpp:esession#subscription'/> <create node='http://www.xmpp.org/extensions/xep-0187.html#ns'/>
<configure> <configure>
<x xmlns='jabber:x:data' type='form'> <x xmlns='jabber:x:data' type='form'>
<field var='FORM_TYPE' type='hidden'> <field var='FORM_TYPE' type='hidden'>
@ -161,7 +124,7 @@
<example caption='Alice Creates PEP Node for ESession Options for All Entities'><![CDATA[ <example caption='Alice Creates PEP Node for ESession Options for All Entities'><![CDATA[
<iq from='alice@example.org/pda' type='set' id='create2'> <iq from='alice@example.org/pda' type='set' id='create2'>
<pubsub xmlns='http://jabber.org/protocol/pubsub'> <pubsub xmlns='http://jabber.org/protocol/pubsub'>
<create node='urn:xmpp:esession'/> <create node='http://www.xmpp.org/extensions/xep-0116.html#ns'/>
<configure> <configure>
<x xmlns='jabber:x:data' type='form'> <x xmlns='jabber:x:data' type='form'>
<field var='FORM_TYPE' type='hidden'> <field var='FORM_TYPE' type='hidden'>
@ -185,7 +148,7 @@
<example caption='Alice Publishes Her ESession Options for Her Presence Subscribers'><![CDATA[ <example caption='Alice Publishes Her ESession Options for Her Presence Subscribers'><![CDATA[
<iq from='alice@example.org/pda' type='set' id='pub1'> <iq from='alice@example.org/pda' type='set' id='pub1'>
<pubsub xmlns='http://jabber.org/protocol/pubsub'> <pubsub xmlns='http://jabber.org/protocol/pubsub'>
<publish node='urn:xmpp:esession#subscription'> <publish node='http://www.xmpp.org/extensions/xep-0187.html#ns'>
<item> <item>
<x type='form' xmlns='jabber:x:data'> <x type='form' xmlns='jabber:x:data'>
<field type="hidden" var="FORM_TYPE"> <field type="hidden" var="FORM_TYPE">
@ -260,7 +223,7 @@
<example caption='Alice Publishes Her ESession Options for All Entities'><![CDATA[ <example caption='Alice Publishes Her ESession Options for All Entities'><![CDATA[
<iq type='set' from='alice@example.org/pda' id='pub2'> <iq type='set' from='alice@example.org/pda' id='pub2'>
<pubsub xmlns='http://jabber.org/protocol/pubsub'> <pubsub xmlns='http://jabber.org/protocol/pubsub'>
<publish node='urn:xmpp:esession'> <publish node='http://www.xmpp.org/extensions/xep-0116.html#ns'>
... ...
</publish> </publish>
</pubsub> </pubsub>
@ -276,7 +239,7 @@
to='alice@example.org' to='alice@example.org'
id='es4'> id='es4'>
<pubsub xmlns='http://jabber.org/protocol/pubsub'> <pubsub xmlns='http://jabber.org/protocol/pubsub'>
<items node='urn:xmpp:esession#subscription'/> <items node='http://www.xmpp.org/extensions/xep-0187.html#ns'/>
</pubsub> </pubsub>
</iq> </iq>
]]></example> ]]></example>
@ -287,7 +250,7 @@
to='alice@example.org' to='alice@example.org'
id='es4'> id='es4'>
<pubsub xmlns='http://jabber.org/protocol/pubsub'> <pubsub xmlns='http://jabber.org/protocol/pubsub'>
<items node='urn:xmpp:esession'/> <items node='http://www.xmpp.org/extensions/xep-0116.html#ns'/>
</pubsub> </pubsub>
</iq> </iq>
]]></example> ]]></example>
@ -308,7 +271,7 @@
<p>After sending &formB; to Alice, Bob can assume that the ESession negotiation is complete.</p> <p>After sending &formB; to Alice, Bob can assume that the ESession negotiation is complete.</p>
<example caption='Bob Establishes an ESession Without Negotiation'><![CDATA[ <example caption='Bob Establishes an ESession Without Negotiation'><![CDATA[
<message from='bob@example.com/laptop' to='alice@example.org/pda' type='chat'> <message from='bob@example.com/laptop' to='alice@example.org/pda' type='chat'>
<init xmlns='urn:xmpp:esession#init'> <init xmlns='http://www.xmpp.org/extensions/xep-0116.html#ns-init'>
<x type='submit' xmlns='jabber:x:data'> <x type='submit' xmlns='jabber:x:data'>
<field var="FORM_TYPE"> <field var="FORM_TYPE">
<value>urn:xmpp:ssn</value> <value>urn:xmpp:ssn</value>
@ -344,10 +307,10 @@
</field> </field>
</x> </x>
</init> </init>
<encrypted xmlns='urn:xmpp:crypt'> <c xmlns='http://www.xmpp.org/extensions/xep-0200.html#ns'>
<data> ** Base64 encoded m_final ** </data> <data> ** Base64 encoded m_final ** </data>
<mac> ** Base64 encoded a_mac ** </mac> <mac> ** Base64 encoded a_mac ** </mac>
</encrypted> </c>
<amp xmlns='http://jabber.org/protocol/amp'> <amp xmlns='http://jabber.org/protocol/amp'>
<rule action='??????' condition='match-resource' value='exact'/> <rule action='??????' condition='match-resource' value='exact'/>
</amp> </amp>
@ -361,7 +324,7 @@
<example caption='Alice Stops Publishing Her ESession Options'><![CDATA[ <example caption='Alice Stops Publishing Her ESession Options'><![CDATA[
<iq type='set' from='alice@example.org/pda' id='es5'> <iq type='set' from='alice@example.org/pda' id='es5'>
<pubsub xmlns='http://jabber.org/protocol/pubsub'> <pubsub xmlns='http://jabber.org/protocol/pubsub'>
<publish node='urn:xmpp:esession#subscription'> <publish node='http://www.xmpp.org/extensions/xep-0187.html#ns'>
<item/> <item/>
</publish> </publish>
</pubsub> </pubsub>
@ -436,11 +399,13 @@
</section1> </section1>
<section1 topic='IANA Considerations' anchor='iana'> <section1 topic='IANA Considerations' anchor='iana'>
<p>This document requires no interaction with &IANA;. </p> <p>This document requires no interaction with &IANA;.</p>
</section1> </section1>
<section1 topic='XMPP Registrar Considerations' anchor='registrar'> <section1 topic='XMPP Registrar Considerations' anchor='registrar'>
<p>The &REGISTRAR; shall add 'urn:xmpp:esession#subscription' to its registry of protocol namespaces.</p> <section2 topic='Protocol Namespaces' anchor='ns'>
<p>Until this specification advances to a status of Draft, its associated namespace shall be "http://www.xmpp.org/extensions/xep-0187.html#ns"; upon advancement of this specification, the &REGISTRAR; shall issue a permanent namespace in accordance with the process defined in Section 4 of &xep0053;.</p>
</section2>
</section1> </section1>
</xep> </xep>

View File

@ -21,6 +21,12 @@
<supersededby/> <supersededby/>
<shortname>TO BE ASSIGNED</shortname> <shortname>TO BE ASSIGNED</shortname>
&stpeter; &stpeter;
<revision>
<version>0.5</version>
<date>2007-05-30</date>
<initials>psa</initials>
<remark><p>Clarified error handling and recommended against sending to bare JIDs.</p></remark>
</revision>
<revision> <revision>
<version>0.4</version> <version>0.4</version>
<date>2007-05-21</date> <date>2007-05-21</date>
@ -47,7 +53,7 @@
</revision> </revision>
</header> </header>
<section1 topic='Introduction' anchor='intro'> <section1 topic='Introduction' anchor='intro'>
<p>As specified in &rfc3920;, the XML streams used in XMPP are bound to TCP. Unfortunately, TCP connections can go down without the application (XMPP) layer knowing about it. The traditional approach to solving this issue has been to periodically send so-called "whitespace pings" over the XML stream. This document recommends a more XML-friendly approach, which can also be used with other bindings such as the &xep0124; method for which &xep0206; is the XMPP profile.</p> <p>As specified in &rfc3920;, the XML streams used in XMPP are bound to TCP. Unfortunately, TCP connections can go down without the application (XMPP) layer knowing about it. The traditional approach to solving this issue has been to periodically send so-called "whitespace pings" over the XML stream. This document recommends a more XML-friendly approach, which can be used over more than one hop in the communication path (e.g., from one client to another) and can also be used with other bindings such as the &xep0124; method for which &xep0206; is the XMPP profile.</p>
</section1> </section1>
<section1 topic='Requirements' anchor='reqs'> <section1 topic='Requirements' anchor='reqs'>
<p>This specification addresses the following requirements:</p> <p>This specification addresses the following requirements:</p>
@ -72,11 +78,11 @@
<ping xmlns='http://www.xmpp.org/extensions/xep-0199.html#ns'/> <ping xmlns='http://www.xmpp.org/extensions/xep-0199.html#ns'/>
</iq> </iq>
]]></example> ]]></example>
<p>If the client supports the ping namespace, it MUST return an IQ result:</p> <p>If the client supports the ping namespace, it MUST return an IQ-result, which functions as a "pong":</p>
<example caption="Pong"><![CDATA[ <example caption="Pong"><![CDATA[
<iq from='juliet@capulet.lit/balcony' to='capulet.lit' id='s2c1' type='result'/> <iq from='juliet@capulet.lit/balcony' to='capulet.lit' id='s2c1' type='result'/>
]]></example> ]]></example>
<p>If the client does not support the ping namespace, it MUST return an IQ error, which SHOULD be &unavailable;:</p> <p>If the client does not support the ping namespace, it MUST return a &unavailable; error:</p>
<example caption="Ping Not Supported"><![CDATA[ <example caption="Ping Not Supported"><![CDATA[
<iq from='juliet@capulet.lit/balcony' to='capulet.lit' id='s2c1' type='error'> <iq from='juliet@capulet.lit/balcony' to='capulet.lit' id='s2c1' type='error'>
<ping xmlns='http://www.xmpp.org/extensions/xep-0199.html#ns'/> <ping xmlns='http://www.xmpp.org/extensions/xep-0199.html#ns'/>
@ -88,18 +94,18 @@
<p>The other error conditions defined in <cite>RFC 3920</cite> could also be returned if appropriate.</p> <p>The other error conditions defined in <cite>RFC 3920</cite> could also be returned if appropriate.</p>
</section2> </section2>
<section2 topic='Client-To-Server Pings' anchor='c2s'> <section2 topic='Client-To-Server Pings' anchor='c2s'>
<p>A client may also ping its server by sending an &IQ; get over the stream between the two entities.</p> <p>A client may also ping its server by sending an IQ-get over the stream between the two entities.</p>
<example caption="Ping"><![CDATA[ <example caption="Ping"><![CDATA[
<iq from='juliet@capulet.lit/balcony' to='capulet.lit' id='c2s1' type='get'> <iq from='juliet@capulet.lit/balcony' to='capulet.lit' id='c2s1' type='get'>
<ping xmlns='http://www.xmpp.org/extensions/xep-0199.html#ns'/> <ping xmlns='http://www.xmpp.org/extensions/xep-0199.html#ns'/>
</iq> </iq>
]]></example> ]]></example>
<p>Note: The client MAY include a 'to' address of the client's bare JID (&BAREJID;, in this instance "juliet@capulet.lit" or MAY include no 'to' address (this signifies that the stanza shall be handled by the server on behalf of the connected user's bare JID, which in the case of &IQ; stanzas is equivalent to directing the IQ-get to the server itself).</p> <p>Note: The client MAY include a 'to' address of the client's bare JID (&BAREJID;, in this instance "juliet@capulet.lit" or MAY include no 'to' address (this signifies that the stanza shall be handled by the server on behalf of the connected user's bare JID, which in the case of &IQ; stanzas is equivalent to directing the IQ-get to the server itself).</p>
<p>If the server supports the ping namespace, it MUST return an IQ result:</p> <p>If the server supports the ping namespace, it MUST return an IQ-result:</p>
<example caption="Pong"><![CDATA[ <example caption="Pong"><![CDATA[
<iq from='capulet.lit' to='juliet@capulet.lit/balcony' id='c2s1' type='result'/> <iq from='capulet.lit' to='juliet@capulet.lit/balcony' id='c2s1' type='result'/>
]]></example> ]]></example>
<p>If the server does not support the ping namespace, it MUST return an IQ error, which SHOULD be &unavailable;:</p> <p>If the server does not support the ping namespace, it MUST return a &unavailable; error:</p>
<example caption="Ping Not Supported"><![CDATA[ <example caption="Ping Not Supported"><![CDATA[
<iq from='capulet.lit' to='juliet@capulet.lit/balcony' id='c2s1' type='error'> <iq from='capulet.lit' to='juliet@capulet.lit/balcony' id='c2s1' type='error'>
<ping xmlns='http://www.xmpp.org/extensions/xep-0199.html#ns'/> <ping xmlns='http://www.xmpp.org/extensions/xep-0199.html#ns'/>
@ -111,17 +117,17 @@
<p>The other error conditions defined in <cite>RFC 3920</cite> could also be returned if appropriate.</p> <p>The other error conditions defined in <cite>RFC 3920</cite> could also be returned if appropriate.</p>
</section2> </section2>
<section2 topic='Server-To-Server Pings' anchor='s2s'> <section2 topic='Server-To-Server Pings' anchor='s2s'>
<p>Pings can also be used to test a server-to-server connection. This is done by sending an &IQ; get over the stream from one server to another.</p> <p>Pings can also be used to test a server-to-server connection. This is done by sending an IQ-get over the stream from one server to another.</p>
<example caption="Ping"><![CDATA[ <example caption="Ping"><![CDATA[
<iq from='capulet.lit' to='montague.lit' id='s2s1' type='get'> <iq from='capulet.lit' to='montague.lit' id='s2s1' type='get'>
<ping xmlns='http://www.xmpp.org/extensions/xep-0199.html#ns'/> <ping xmlns='http://www.xmpp.org/extensions/xep-0199.html#ns'/>
</iq> </iq>
]]></example> ]]></example>
<p>If the other party to the stream supports the ping namespace, it MUST return an IQ result:</p> <p>If the other party to the stream supports the ping namespace, it MUST return an IQ-result:</p>
<example caption="Pong"><![CDATA[ <example caption="Pong"><![CDATA[
<iq from='montague.lit' to='capulet.lit' id='s2s1' type='result'/> <iq from='montague.lit' to='capulet.lit' id='s2s1' type='result'/>
]]></example> ]]></example>
<p>If the other party to the stream does not support the ping namespace, it MUST return an IQ error, which SHOULD be &unavailable;:</p> <p>If the other party to the stream does not support the ping namespace, it MUST return a &unavailable; error:</p>
<example caption="Ping Not Supported"><![CDATA[ <example caption="Ping Not Supported"><![CDATA[
<iq from='montague.lit' to='capulet.lit' id='s2s1' type='error'> <iq from='montague.lit' to='capulet.lit' id='s2s1' type='error'>
<ping xmlns='http://www.xmpp.org/extensions/xep-0199.html#ns'/> <ping xmlns='http://www.xmpp.org/extensions/xep-0199.html#ns'/>
@ -142,14 +148,15 @@
<ping xmlns='http://www.xmpp.org/extensions/xep-0199.html#ns'/> <ping xmlns='http://www.xmpp.org/extensions/xep-0199.html#ns'/>
</iq> </iq>
]]></example> ]]></example>
<p>If the pinged entity supports the ping namespace, it SHOULD return an IQ result:</p> <p>Note: The 'to' address should be a full JID (&FULLJID;), since a ping sent to a bare JID (&BAREJID;) will be handled by the server on behalf of the client.</p>
<p>If the pinged entity supports the ping namespace, it SHOULD return an IQ-result:</p>
<example caption="Pong"><![CDATA[ <example caption="Pong"><![CDATA[
<iq from='juliet@capulet.lit/chamber' <iq from='juliet@capulet.lit/chamber'
to='romeo@montague.lit/home' to='romeo@montague.lit/home'
id='e2e1' id='e2e1'
type='result'/> type='result'/>
]]></example> ]]></example>
<p>If the pinged entity does not support the ping namespace, it SHOULD return an IQ error, which SHOULD be &unavailable;:</p> <p>If the pinged entity does not support the ping namespace, it MUST return a &unavailable; error:</p>
<example caption="Ping Not Supported"><![CDATA[ <example caption="Ping Not Supported"><![CDATA[
<iq from='juliet@capulet.lit/chamber' <iq from='juliet@capulet.lit/chamber'
to='romeo@montague.lit/home' to='romeo@montague.lit/home'
@ -173,14 +180,15 @@
<ping xmlns='http://www.xmpp.org/extensions/xep-0199.html#ns'/> <ping xmlns='http://www.xmpp.org/extensions/xep-0199.html#ns'/>
</iq> </iq>
]]></example> ]]></example>
<p>If the pinged entity supports the ping namespace, it SHOULD return an IQ result:</p> <p>Note: The 'to' address should be a full JID (&FULLJID;), since a ping sent to a bare JID (&BAREJID;) will be handled by the server on behalf of the client.</p>
<p>If the pinged entity supports the ping namespace, it SHOULD return an IQ-result:</p>
<example caption="Pong"><![CDATA[ <example caption="Pong"><![CDATA[
<iq from='juliet@capulet.lit/chamber' <iq from='juliet@capulet.lit/chamber'
to='chat.shakespeare.lit' to='chat.shakespeare.lit'
id='comp1' id='comp1'
type='result'/> type='result'/>
]]></example> ]]></example>
<p>If the pinged entity does not support the ping namespace, it SHOULD return an IQ error, which SHOULD be &unavailable;:</p> <p>If the pinged entity does not support the ping namespace, it MUST return a &unavailable; error:</p>
<example caption="Ping Not Supported"><![CDATA[ <example caption="Ping Not Supported"><![CDATA[
<iq from='juliet@capulet.lit/chamber' <iq from='juliet@capulet.lit/chamber'
to='chat.shakespeare.lit' to='chat.shakespeare.lit'