xep-0183.xml

<?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>Jingle Telepathy Transport</title>
  <abstract>This document defines a telepathic transport method for establishing Extra-Sensory Perception (ESP) streams.</abstract>
  &LEGALNOTICE;
  <number>0183</number>
  <status>Active</status>
  <type>Humorous</type>
  <sig>Standards</sig>
  <approver>Council</approver>
  <dependencies>
    <spec>XMPP Core</spec>
    <spec>XEP-0166</spec>
  </dependencies>
  <supersedes/>
  <supersededby/>
  <shortname>telepathy</shortname>
  &stpeter;
  <revision>
    <version>1.0</version>
    <date>2006-04-01</date>
    <initials>psa</initials>
    <remark><p>April Fools!</p></remark>
  </revision>
</header>
<section1 topic='Introduction' anchor='intro'>
  <p>&xep0166; defines a framework for negotiating and managing out-of-band multimedia sessions over XMPP. In order to provide a flexible framework, the base Jingle specification defines neither data transport methods nor media (session) types, leaving that up to separate specifications.</p>
  <p>Typical peer-to-peer session types include voice chat (see &xep0167;) and video chat (see &xep0180;). But Jingle can go farther. Indeed, why not support not only physical multimedia sessions (limited to the five physical senses) but also psychical multimedia sessions (which go beyond the basic physical senses to include advanced, extra-sensory perception)? The media (or medium) may be different, but the underlying principles are the same: fostering freedom of conversation by connecting people (e.g., through mind-reading and s&#233;ances) and even applications such as accessing information from the future (e.g., in clairvoyance and precognition). Indeed, the ability to communicate with the spirit world will push Jabber/XMPP technologies into a new age of real-time communications (light years ahead of traditional IM and VoIP systems). Beyond Internet telephony, our innovations in Internet telepathy will give new meaning to the term "voice chat" as users are able to hear voices from the past, present, or future.</p>
  <p>Unfortunately, these advanced session types cannot be supported using existing transport mechanisms such as &xep0176;, &xep0177;, and &xep0179;. Therefore, this document defines a new Jingle transport method for establishing and managing Extra-Sensory Perception (ESP) streams: the "telepathy" method.</p>
</section1>
<section1 topic='Requirements' anchor='reqs'>
  <p>The Jingle telepathy transport method is designed to meet the following requirements:</p>
  <ol>
    <li>Make it possible to establish and manage extra-sensory perception (ESP) streams between two XMPP entities.</li>
    <li>Make it relatively easy to implement support in standard Jabber/XMPP clients.</li>
    <li>Where communication with non-XMPP (indeed, non-material) entities is needed, push as much complexity as possible onto gateways between this world and the spirit world.</li>
  </ol>
  <p>Note: Whether or not an ESP stream can be established depends on the user's native telepathic abilities as well as acquired telepathic skills such as grounding, centering, pinging, pulse-sending, broadcasting, scanning, probing, suggestion, and projection. <note>For a good introduction to telepathic skills, see <cite>The Telepathy Manual</cite> located at &lt;<link url='http://www.psipog.net/art-telepathy-manual.html'>http://www.psipog.net/art-telepathy-manual.html</link>&gt;.</note> Your mileage may vary.</p>
</section1>
<section1 topic='Protocol Description' anchor='protocol'>
  <section2 topic='Transport Initiation' anchor='protocol-initiate'>
    <p>In order for the initiating entity in a Jingle exchange to start the negotiation, it MUST send a Jingle "session-initiate" stanza as described in &xep0166;. This stanza MUST include at least one transport method. If the initiating entity wishes to negotiate the telepathy transport, it MUST include a &TRANSPORT; child element qualified by the 'http://jabber.org/protocol/jingle/transport/telepathy' namespace.</p>
    <p>This &TRANSPORT; element MUST include one and only one &CANDIDATE; element per channel specifying the parameters that the initiator believes will be most likely to succeed for that channel. (Note: You have to believe.) This is not necessarily the initiator's preferred address for spiritual communication, but instead is the "address most likely to succeed", i.e., the address that is assumed to be reachable by the vast majority of target entities. (Establishing direct spiritual communication is hard enough as it is.) Here is an example:</p>
    <example caption="Initiation Example"><![CDATA[
<iq from='medium@example.com/seance' to='psychic@example.net/spiritworld' id='jingle1' type='set'>
  <jingle xmlns='http://jabber.org/protocol/jingle'
          action='session-initiate'
          initiator='medium@example.com/seance'
          sid='a73sjjvkla37jfea'>
    <description xmlns='urn:xmpp:example'/>
    <transport xmlns='http://jabber.org/protocol/jingle/transport/telepathy'>
      <candidate name='ihearvoices' generation='0' plane='9' pulse='80'
                 psi-sig='yellow happy bright open no-shields'
                 sign='Pisces' time='present'/>
    </transport>
  </jingle>
</iq>
]]></example>
    <p>The attributes of the &lt;candidate/&gt; element are as follows:</p>
    <ul>
      <li>The 'generation' attribute is an index, starting at 0, that enables the parties to keep track of updates to the candidate throughout the life of the session.</li>
      <li>The 'name' attribute specifies a unique name for the channel.</li>
      <li>The 'plane' attribute is used for diagnostics; it is an index, starting at 1, referencing which astral plane this candidate is on for a given peer.</li>
      <li>The 'pulse' attribute specifies the initiator's heart rate at the moment; this helps establish communications through pulse-sending of informational messages in time with the beat of your heart.</li>
      <li>The 'psi-sig' attribute is the initiator's Psi Signature or "energy fingerprint"; because scanning people for their psi-sig can take time and is often a challenge, advertising one's psi-sig ahead of time makes it easier to establish a spiritual connection. The format of the 'psi-sig' attribute is a space-delimited set of descriptive words, often including colors, feelings, and emotions characterizing the person's energy state at the moment. Note: A person's psi-sig can change from moment to moment; therefore, it is advisable to also advertise it using &xep0163;.</li>
      <li>The 'sign' attribute represents the initiator's Zodiac sign; including this value obviates the need for asking "what's your sign?"</li>
      <li>The 'time' attribute is used for diagnostics; the allowable values are "past", "present", and "future".</li>
    </ul>
  </section2>
  <section2 topic='Receiver Response' anchor='protocol-response'>
    <p>As described in &xep0166;, to provisionally accept the session initiation request, the receiver returns an IQ-result:</p>
    <example caption="Receiver Provisionally Accepts the Session Request"><![CDATA[
<iq type='result' from='psychic@example.net/spiritworld' to='medium@example.com/seance' id='jingle1'/>
]]></example>
    <p>To definitively accept the telepathy transport method, the receiver MUST send a &JINGLE; element with an action of 'transport-accept', specifying the transport method desired.</p>
    <example caption="Receiver Accepts the Telepathy Transport Method"><![CDATA[
<iq type='set' from='psychic@example.net/spiritworld' to='medium@example.com/seance' id='jingle2'>
  <jingle xmlns='http://jabber.org/protocol/jingle'
          action='transport-accept'
          initiator='medium@example.com/seance'
          sid='a73sjjvkla37jfea'>
    <transport xmlns='http://jabber.org/protocol/jingle/transport/telepathy'>
      <candidate name='ihearvoices'/>
    </transport>
  </jingle>
</iq>
]]></example>
    <p>The initiating entity then acknowledges the receiver's acceptance:</p>
    <example caption="Initiating Entity Acknowledges Definitive Acceptance"><![CDATA[
<iq from='medium@example.com/seance' to='psychic@example.net/spiritworld' id='jingle2' type='result'/>
]]></example>
    <p>Now the initiating entity and receiver can begin sending appropriate psychical media over the negotiated ESP stream.</p>
    <p>In the event that the receiver cannot establish a channel, it SHOULD terminate the session (see &xep0176; or <cite>XEP-0177</cite> for examples).</p>
  </section2>
  <section2 topic='Informational Messages' anchor='protocol-info'>
    <p>Because the informational message payloads specific to the telepathy transport method cannot be tied down to the arbitrary conventions of XML syntax, a &lt;message/&gt; element qualified by the 'http://jabber.org/protocol/info/telepathy' namespace may include any character data that either party feels like communicating.</p>
  </section2>
</section1>

<section1 topic='Deployment Notes' anchor='deploy'>
  <p>This specification applies exclusively to Jabber/XMPP clients and places no additional requirements on Jabber/XMPP servers. However, service administrators may wish to deploy a gateway to the spirit world in order to ease the channel negotiation process. How to develop such gateways is an inexact science (but it <em>is</em> a science!) and therefore is outside the scope of this document.</p>
</section1>

<section1 topic='Security Considerations' anchor='security'>
  <p>To the author's knowledge, no channel encryption technologies exist for direct spiritual connections. Although this vulnerability can be mitigated through speaking in tongues and the use of various alternative languages such as Runic and Mumbo-Jumbo, the result is only security through obscurity, not channel encryption as those familiar with the merely material world understand it. If only benighted materialist scientists and technologists would recognize the validity of psychical experience and extra-sensory perception, progress in applying encryption principles to psychical channeling and the exchange of pure spiritual energy would rapidly ensue.</p>
</section1>

<section1 topic='IANA Considerations' anchor='iana'>
  <p>This document requires no interaction with &IANA;.</p>
</section1>

<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
  <section2 topic='Protocol Namespaces' anchor='registrar-ns'>
    <p>The &REGISTRAR; shall include 'http://jabber.org/protocol/jingle/transport/telepathy' and 'http://jabber.org/protocol/jingle/info/telepathy' in its registry of protocol namespaces.</p>
  </section2>
  <section2 topic='Jingle Transport Methods' anchor='registrar-transports'>
    <p>The XMPP Registrar shall include "http://jabber.org/protocol/jingle/transport/telepathy" in its registry of Jingle transport methods. The registry submission is as follows:</p>
    <code><![CDATA[
<transport>
  <name>telepathy</name>
  <desc>
    A method for the negotiation of Extra-Sensory Perception (ESP) streams.
  </desc>
  <doc>XEP-0183</doc>
</transport>
]]></code>
  </section2>
</section1>

<section1 topic='XML Schemas' anchor='schema'>
  <section2 topic='Transport Method' anchor='schema-transport'>
    <code><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>

<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='http://jabber.org/protocol/jingle/transport/telepathy'
    xmlns='http://jabber.org/protocol/jingle/transport/telepathy'
    elementFormDefault='qualified'>

  <xs:element name='transport'>
    <xs:complexType>
      <xs:choice>
        <xs:sequence>
          <xs:element ref='candidate' minOccurs='0' maxOccurs='1'/>
        </xs:sequence>
      </xs:choice>
    </xs:complexType>
  </xs:element>

  <xs:element name='candidate'>
    <xs:complexType>
      <xs:simpleContent>
        <xs:extension base='empty'>
          <xs:attribute name='generation' type='xs:unsignedByte' use='required'/>
          <xs:attribute name='name' type='xs:string' use='required'/>
          <xs:attribute name='plane' type='xs:positiveInteger' use='optional'/>
          <xs:attribute name='pulse' type='xs:positiveInteger' use='optional'/>
          <xs:attribute name='psi-sig' type='xs:string' use='optional'/>
          <xs:attribute name='sign' use='optional'>
            <xs:simpleType>
              <xs:restriction base='xs:NCName'>
                <xs:enumeration value='Aquarius'/>
                <xs:enumeration value='Aries'/>
                <xs:enumeration value='Cancer'/>
                <xs:enumeration value='Capricorn'/>
                <xs:enumeration value='Gemini'/>
                <xs:enumeration value='Leo'/>
                <xs:enumeration value='Libra'/>
                <xs:enumeration value='Pisces'/>
                <xs:enumeration value='Sagittarius'/>
                <xs:enumeration value='Scorpio'/>
                <xs:enumeration value='Taurus'/>
                <xs:enumeration value='Virgo'/>
              </xs:restriction>
            </xs:simpleType>
          </xs:attribute>
          <xs:attribute name='time' use='optional'>
            <xs:simpleType>
              <xs:restriction base='xs:NCName'>
                <xs:enumeration value='future'/>
                <xs:enumeration value='past'/>
                <xs:enumeration value='present'/>
              </xs:restriction>
            </xs:simpleType>
          </xs:attribute>
        </xs:extension>
      </xs:simpleContent>
    </xs:complexType>
  </xs:element>

  <xs:simpleType name='empty'>
    <xs:restriction base='xs:string'>
      <xs:enumeration value=''/>
    </xs:restriction>
  </xs:simpleType>

</xs:schema>
]]></code>
  </section2>
  <section2 topic='Informational Messages' anchor='schema-info'>
    <code><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>

<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='http://jabber.org/protocol/jingle/info/telepathy'
    xmlns='http://jabber.org/protocol/jingle/info/telepathy'
    elementFormDefault='qualified'>

  <xs:element name='message' type='xs:string'/>

</xs:schema>
]]></code>
  </section2>
</section1>
</xep>