moparisthebest
/
xeps
mirror of https://github.com/moparisthebest/xeps
1
0
Fork 0
Code Issues Releases Wiki Activity

0.10

This commit is contained in:
Peter Saint-Andre 2012-05-29 13:13:57 -06:00
parent 48aa55da25
commit 15e686a21a
1 changed files with 30 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
xep-0186.xml Normal file → Executable file
View File

@ -10,7 +10,7 @@
<abstract>This document specifies an XMPP-compatible protocol for user invisibility.</abstract>
&LEGALNOTICE;
<number>0186</number>
<status>Deferred</status>
<status>Experimental</status>
<type>Standards Track</type>
<sig>Standards</sig>
<dependencies>
@ -24,6 +24,12 @@
<supersededby>None</supersededby>
<shortname>invisible</shortname>
&stpeter;
<revision>
<version>0.10</version>
<date>2012-05-29</date>
<initials>psa</initials>
<remark><p>Further clarified server and client handling of stanzas during an invisibility session; updated RFC references.</p></remark>
</revision>
<revision>
<version>0.9</version>
<date>2008-10-07</date>
@ -93,9 +99,9 @@
</header>
<section1 topic='Introduction' anchor='intro'>
<p>Some instant messaging implementations of the Jabber/XMPP protocols have long supported the ability for IM users to be online but appear invisible. The existing protocols for doing so are:</p>
<p>Some XMPP-based instant messaging systems have long supported the ability for users to be online but to appear invisible. The existing protocols for doing so are:</p>
<ul>
<li><p>&xep0018; -- this protocol is not compatible with &xmppcore; and &xmppim;, and the specification does not provide reliable documentation of the protocol in use since many server implementations support presence of type "invisible" but not presence of type "visible".</p></li>
<li><p>&xep0018; -- this protocol is not compatible with &xmppcore; and &xmppim; (also, the specification does not provide reliable documentation of the protocol in use, since many server implementations support presence of type "invisible" but not presence of type "visible").</p></li>
<li><p>&xep0126; -- this protocol is a somewhat complicated use of &xep0016; for the temporary purpose of appearing invisible rather than the intended purpose of permanently blocking communications; however, the invisible command defined herein can provide a client-friendly interface to the same data store used for privacy lists.</p></li>
</ul>
<p>In order to provide a standards-compliant protocol that can be used in the long term, this document defines an IQ-based protocol that enables an IM user to become "invisible" and "visible" at will within the context of a given session. This protocol is intended to supersede the protocol described in <cite>XEP-0018</cite> and to provide a more client-friendly approach to invisibility than <cite>XEP-0126</cite>.</p>
@ -112,7 +118,7 @@
<section1 topic='Use Cases' anchor='usecases'>
<section2 topic='User Becomes Invisible' anchor='invisible'>
<p>In order for a client to go invisible, it shall send an IQ-set with no 'to' address (thus handled by the user's server) containing an &lt;invisible/&gt; element qualified by the 'urn:xmpp:invisible:0' namespace &VNOTE;.</p>
<p>In order for a client to go invisible, it sends an IQ-set with no 'to' address (thus handled by the user's server) containing an &lt;invisible/&gt; element qualified by the 'urn:xmpp:invisible:0' namespace &VNOTE;.</p>
<example caption='Invisible command'><![CDATA[
<iq from='bilbo@tolkien.lit/shire'
id='inv1'
@ -126,16 +132,16 @@
id='inv1'
type='result'/>
]]></example>
<p>(Standard XMPP stanza errors apply; see <cite>RFC 3920</cite> and &xep0086;.)</p>
<p>When the client enters invisible mode in the midst of a presence session (i.e., after having previously sent undirected presence with no 'type' attribute), the server MUST send &UNAVAILABLE; presence from the specified resource to all contacts who would receive unavailable presence if the client sent &UNAVAILABLE;.</p>
<p>The following sections define how the server and the client shall handle inbound and outbound XML stanzas while the client is invisible.</p>
<p>(Standard XMPP stanza errors apply; see <cite>RFC 6120</cite>.)</p>
<p>When the client enters invisible mode in the midst of a presence session (i.e., after having previously sent undirected available presence with no 'type' attribute), the server MUST send &UNAVAILABLE; presence from the specified resource to all contacts who would receive unavailable presence if the client sent &UNAVAILABLE;.</p>
<p>The following sections define how the server and the client handling of inbound and outbound XML stanzas while the client is invisible.</p>
<section3 topic='Server Handling' anchor='invisible-server'>
<p>While the client is in invisible mode, the server:</p>
<ol start='1'>
<li><p>MUST NOT broadcast presence notifications as a result of receiving any subsequent undirected presence notifications from the client.</p></li>
<li><p>MUST deliver directed presence stanzas generated by the client.</p></li>
<li><p>MUST NOT broadcast outbound presence notifications as a result of receiving any subsequent undirected presence notifications from the client.</p></li>
<li><p>MUST deliver outbound directed presence stanzas generated by the client.</p></li>
<li><p>MUST deliver inbound &PRESENCE; stanzas.</p></li>
<li><p>SHOULD deliver inbound &MESSAGE; stanzas whose 'to' address is the bare JID &LOCALBARE; of the user (subject to standard XMPP stanza handling rules).</p></li>
<li><p>SHOULD deliver inbound &MESSAGE; stanzas whose 'to' address is the bare JID &LOCALBARE; of the user (subject to standard XMPP stanza handling rules from <cite>RFC 6120</cite> and <cite>RFC 6121</cite>).</p></li>
<li><p>MUST deliver inbound &MESSAGE; and &IQ; stanzas whose 'to' address is the full JID &LOCALFULL; corresponding to the resource of the client.</p></li>
<li><p>MUST deliver outbound &MESSAGE; and &IQ; stanzas generated by the client (for an important note regarding presence leaks, see the <link url='#security'>Security Considerations</link> section of this document).</p></li>
<li>
@ -150,15 +156,15 @@
</ol>
</section3>
<section3 topic='Client Handling' anchor='invisible-client'>
<p>While the client is in invisible mode, the client:</p>
<p>While the client is in invisible mode, it is suggested that the client behave as follows:</p>
<ul>
<li><p>MUST maintain a temporary list of entities with which communication is allowed, and prompt the user before adding any entity to that "communicants list" for this invisibility session; the list MAY be auto-populated with trusted entities if so configured by the user.</p></li>
<li><p>MUST prompt the user before sending any outbound traffic (message, presence, or IQ stanza) to a contact even if the user generated such traffic; upon receiving authorization from the user, the client SHOULD add the authorized entity to the communicants list for this invisibility session.</p></li>
<li><p>Maintain a temporary list of entities with which communication is allowed and prompt the user before adding any entity to that "communicants list" for this invisibility session; for user convenience, this list might be auto-populated with trusted entities if so configured by the user.</p></li>
<li><p>Prompt the user before sending any outbound traffic (message, presence, or IQ stanza) to another user, even if the user generated such traffic; upon receiving authorization from the user, the client might then add the authorized entity to the communicants list for this invisibility session.</p></li>
</ul>
</section3>
</section2>
<section2 topic='User Becomes Visible' anchor='visible'>
<p>In order for a client to become visible again, it shall send an IQ-set with no 'to' address (thus handled by the user's server) containing a &lt;visible/&gt; element qualified by the 'urn:xmpp:invisible:0' namespace &VNOTE;.</p>
<p>In order for a client to become visible again, it sends an IQ-set with no 'to' address (thus handled by the user's server) containing a &lt;visible/&gt; element qualified by the 'urn:xmpp:invisible:0' namespace &VNOTE;.</p>
<example caption='Visible command'><![CDATA[
<iq from='bilbo@tolkien.lit/shire'
id='vis1'
@ -173,16 +179,16 @@
type='result'/>
]]></example>
<p>When the client becomes visible, the server MUST treat that state as equivalent to an active session before receiving initial presence from the client.</p>
<p>It is the responsibility of the client to send an undirected presence notification to the server.</p>
<p>If the user wishes to then send presence to contacts, it is the responsibility of the client to send an undirected available presence notification to the server.</p>
<example caption='Client sends presence'><![CDATA[
<presence/>
]]></example>
<p>The server then MUST broadcast that presence to all entities who would normally receive presence broadcasts from the client (as well as any other entities to which the client sent directed presence while invisible).</p>
<p>The server would then broadcast that presence notification to all entities who would normally receive presence broadcasts from the client (the server MAY also send that notification to any entities to which the client sent directed presence while invisible).</p>
</section2>
</section1>
<section1 topic='Discovering Support' anchor='support'>
<p>In order for a client to discover whether its server supports the protocol defined herein, it MUST send a &xep0030; information request to the server:</p>
<p>In order for a client to discover whether its server supports the invisible command, it sends a &xep0030; information request to the server:</p>
<example caption='Service discovery request'><![CDATA[
<iq from='bilbo@tolkien.lit/shire'
id='disco1'
@ -191,7 +197,7 @@
<query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>
]]></example>
<p>If the server supports the protocol defined herein, it MUST return a feature of "urn:xmpp:invisible:0" &VNOTE;.</p>
<p>If the server supports the invisible command, it MUST return a feature of "urn:xmpp:invisible:0" &VNOTE;.</p>
<example caption='Service discovery response'><![CDATA[
<iq from='bilbo@tolkien.lit/shire'
id='disco1'
@ -206,7 +212,7 @@
</section1>
<section1 topic='Integration With Privacy Lists' anchor='priv'>
<p>A server MAY use the same backend data store for invisibility mode as defined herein and &xep0016; as used for invisibility (see <cite>XEP-0126</cite>). If so, the server MUST update the relevant privacy lists on behalf of the user when the client requests initiation or termination of invisible mode.</p>
<p>A server MAY use the same backend data store for this invisibility mode as for &xep0016; when used for invisibility (see <cite>XEP-0126</cite>). If so, the server MUST update the relevant privacy lists on behalf of the user when the client requests initiation or termination of invisible mode.</p>
</section1>
<section1 topic='Security Considerations' anchor='security'>
@ -253,4 +259,9 @@
</xs:schema>
]]></code>
</section1>
<section1 topic='Acknowledgements' anchor='ack'>
<p>Thanks to Philipp Hancke, Kevin Smith, and Matthew Wild for their feedback.</p>
</section1>
</xep>