moparisthebest/xeps
1
0
Fork 0
mirror of https://github.com/moparisthebest/xeps synced 2024-11-28 04:02:20 -05:00
Code Issues Releases Wiki Activity

0.2

Browse Source 
git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@3494 4b5297f7-1745-476d-ba37-a9c6900126ab
This commit is contained in:
Peter Saint-Andre 2009-10-05 22:30:36 +00:00
parent c558fb630e
commit 37bf350324
1 changed files with 171 additions and 151 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

318
xep-0251.xml
View File

@ -32,6 +32,12 @@
<email>paulc@null.ro</email>
</author>
&stpeter;
<revision>
<version>0.2</version>
<date>2009-10-05</date>
<initials>psa</initials>
<remark><p>Updated examples; added reference to RFC 5359; added security considerations regarding unattended transfer.</p></remark>
</revision>
<revision>
<version>0.1</version>
<date>2008-10-22</date>
@ -53,7 +59,7 @@
</header>
<section1 topic='Introduction' anchor='intro'>
<p>The &xep0166; extensions to XMPP provide a technology for setup, management, and teardown of multimedia sessions between two entities, with an initial focus on voice over Internet Protocol (VoIP). By design, Jingle has been kept relatively simple and it does not cover the kind of advanced features that are available on the public switched telephone network (PSTN) and traditional private branch exchange (PBX) systems. However, because Jingle and XMPP itself provide an extensible technology for the real-time exchange of XML data, more advanced use cases can be defined through additional extensions. This document specifies one such extension, for the transfer of a session from one entity to another entity; although this extension will likely be used mainly in the context of VoIP interactions, it could also be used for any Jingle application type, such as video chat or screen sharing.</p>
<p>The &xep0166; extensions to XMPP provide a technology for setup, management, and teardown of multimedia sessions between two entities, with an initial focus on voice over Internet Protocol (VoIP). By design, Jingle has been kept relatively simple and it does not cover the kind of advanced features that are available on the public switched telephone network (PSTN) and traditional private branch exchange (PBX) systems. However, because Jingle and XMPP itself provide an extensible technology for the real-time exchange of XML data, more advanced use cases can be defined through additional extensions. This document specifies one such extension, for the transfer of a session from one entity to another entity using either attended transfer or unattended transfer (for the difference between these scenarios, see for example &rfc5359;). Although this extension will likely be used mainly in the context of VoIP interactions, it could also be used for any Jingle application type, such as video chat or screen sharing.</p>
</section1>
<section1 topic='Unattended Transfer' anchor='unattended'>
@ -93,144 +99,148 @@ Caller Attendant Callee
|<===============================================>|
| |
]]></code>
<p>The protocol flow is shown below, where the caller is "caller@world.sun", the attendant is "attendant@office.biz", and the callee is "boss@bigdesk.biz".</p>
<p>The protocol flow is shown below, where the caller is "caller@example.net", the attendant is "attendant@office.example.com", and the callee is "boss@execs.example.com".</p>
<p>First the caller initiates a normal call to the attendant.</p>
<example caption='Caller calls attendant'><![CDATA[
<iq from='caller@world.sun/phone'
id='jingle1'
to='attendant@office.biz/desk'
<iq from='caller@example.net/phone'
id='i3hd81k8'
to='attendant@office.example.com/desk'
type='set'>
<jingle xmlns='urn:xmpp:jingle:0'
<jingle xmlns='urn:xmpp:jingle:1'
action='session-initiate'
initiator='caller@world.sun/phone'
initiator='caller@example.net/phone'
sid='851ba2'>
<content creator='initiator'
disposition='session'
name='voice'>
<description xmlns='urn:xmpp:jingle:apps:rtp:0'
name='urgent-communication'>
<description xmlns='urn:xmpp:jingle:apps:rtp:1'
media='audio'>
<payload-type id='0' name='PCMU' />
</description>
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'/>
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:1'>
...
</transport>
</content>
</jingle>
</iq>
]]></example>
<p>The attendant's phone then acknowledges the session request.</p>
<example caption='Attendant acks session-initiate'><![CDATA[
<iq from='attendant@office.biz/desk'
to='caller@world.sun/phone'
id='jingle1'
<iq from='attendant@office.example.com/desk'
id='i3hd81k8'
to='caller@example.net/phone'
type='result'/>
]]></example>
<p>Next the attendant answers the call.</p>
<example caption='Attendant sends session-accept'><![CDATA[
<iq from='attendant@office.biz/desk'
to='caller@world.sun/phone'
id='accept1'
<iq from='attendant@office.example.com/desk'
id='k1d26dcv'
to='caller@example.net/phone'
type='set'>
<jingle xmlns='urn:xmpp:jingle:0'
<jingle xmlns='urn:xmpp:jingle:1'
action='session-accept'
initiator='caller@world.sun/phone'
responder='attendant@office.biz/desk'
initiator='caller@example.net/phone'
responder='attendant@office.example.com/desk'
sid='851ba2'>
<content creator='initiator'
disposition='session'
name='voice'>
<description xmlns='urn:xmpp:jingle:apps:rtp:0'
name='urgent-communication'>
<description xmlns='urn:xmpp:jingle:apps:rtp:1'
media='audio'>
<payload-type id='0' name='PCMU' />
</description>
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'>
<candidate .../>
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:1'>
...
</transport>
</jingle>
</iq>
]]></example>
<p>The caller acknowledges the session-accept.</p>
<example caption='Caller acks session-accept'><![CDATA[
<iq from='caller@world.sun/phone'
id='accept1'
to='attendant@office.biz/desk'
<iq from='caller@example.net/phone'
id='k1d26dcv'
to='attendant@office.example.com/desk'
type='result'/>
]]></example>
<p>Now the attendant decides to transfer the call. It does this by sending a Jingle action of type session-info to the caller, specifying the address of the callee via an &lt;transfer/&gt; element qualified by the "urn:xmpp:jingle:transfer:0" namespace &VNOTE;.</p>
<p>Now the attendant decides to transfer the call. It does this by sending a Jingle action of type session-info to the caller, specifying the address of the callee via a &lt;transfer/&gt; element qualified by the "urn:xmpp:jingle:transfer:0" namespace &VNOTE;.</p>
<example caption='Attendant transfers the call'><![CDATA[
<iq from='attendant@office.biz/desk'
id='transfer1'
to='caller@world.sun/phone'
<iq from='attendant@office.example.com/desk'
id='a0pl3v76'
to='caller@example.net/phone'
type='set'>
<jingle xmlns='urn:xmpp:jingle:0'
<jingle xmlns='urn:xmpp:jingle:1'
action='session-info'
initiator='caller@world.sun/phone'
responder='attendant@office.biz/desk'
initiator='caller@example.net/phone'
responder='attendant@office.example.com/desk'
sid='851ba2'>
<transfer xmlns='urn:xmpp:jingle:transfer:0'
to='boss@bigdesk.biz/phone'/>
to='boss@execs.example.com/phone'/>
</jingle>
</iq>
]]></example>
<p>If the caller understands the transfer request, it acknowledges the request (if not, it MUST return a &feature; error as specified in <cite>XEP-0166</cite>).</p>
<example caption='Caller acks transfer request'><![CDATA[
<iq from='attendant@office.biz/desk'
to='caller@world.sun/phone'
id='transfer1'
<iq from='attendant@office.example.com/desk'
to='caller@example.net/phone'
id='a0pl3v76'
type='result'/>
]]></example>
<p>Now the caller puts the attendant on hold.</p>
<example caption='Caller puts attendant on hold'><![CDATA[
<iq from='attendant@office.biz/desk'
id='hold1'
to='caller@world.sun/phone'
<iq from='attendant@office.example.com/desk'
id='o4bd91v4'
to='caller@example.net/phone'
type='set'>
<jingle xmlns='urn:xmpp:jingle:0'
<jingle xmlns='urn:xmpp:jingle:1'
action='session-info'
initiator='caller@world.sun/phone'
initiator='caller@example.net/phone'
sid='851ba2'>
<hold xmlns='urn:xmpp:jingle:apps:rtp:info:0'/>
<hold xmlns='urn:xmpp:jingle:apps:rtp:info:1'/>
</jingle>
</iq>
]]></example>
<p>While the attendant is on hold, the caller initiates a new call to the callee. The session-initiation request includes an &lt;transfer/&gt; element that specifies the attendant's address.</p>
<p>While the attendant is on hold, the caller initiates a new call to the callee. The session-initiation request includes a &lt;transfer/&gt; element that specifies the attendant's address.</p>
<example caption='Caller initiates new call to callee'><![CDATA[
<iq from='caller@world.sun/phone'
id='jingle3'
to='boss@bigdesk.biz/phone'
<iq from='caller@example.net/phone'
id='r7y2nxv3'
to='boss@execs.example.com/phone'
type='set'>
<jingle xmlns='urn:xmpp:jingle:0'
<jingle xmlns='urn:xmpp:jingle:1'
action='session-initiate'
initiator='caller@world.sun/phone'
initiator='caller@example.net/phone'
sid='1a332d'>
<content creator='initiator'
disposition='session'
name='voice'>
<description xmlns='urn:xmpp:jingle:apps:rtp:0'
name='urgent-communication'>
<description xmlns='urn:xmpp:jingle:apps:rtp:1'
media='audio'>
<payload-type id='0' name='PCMU' />
</description>
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'/>
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:1'>
...
</transport>
</content>
<transfer xmlns='urn:xmpp:jingle:transfer:0'
from='attendant@office.biz/desk'/>
from='attendant@office.example.com/desk'/>
</jingle>
</iq>
]]></example>
<p>The callee acknowledges the call.</p>
<example caption='Callee acks session-initiate'><![CDATA[
<iq from='boss@bigdesk.biz/phone'
to='caller@world.sun/phone'
id='jingle3'
<iq from='boss@execs.example.com/phone'
to='caller@example.net/phone'
id='r7y2nxv3'
type='result'/>
]]></example>
<p>Now the caller's phone detects the successful transfer, so it hangs up on the attendant:</p>
<example caption='Caller terminates session with attendant'><![CDATA[
<iq from='caller@world.sun/phone'
id='hangup1'
to='attendant@office.biz/desk'
<iq from='caller@example.net/phone'
id='hg34cx20'
to='attendant@office.example.com/desk'
type='set'>
<jingle xmlns='urn:xmpp:jingle:0'
<jingle xmlns='urn:xmpp:jingle:1'
action='session-terminate'
initiator='attendant@office.biz/desk'
initiator='attendant@office.example.com/desk'
sid='851ba2'>
<reason>
<success/>
@ -243,7 +253,7 @@ Caller Attendant Callee
</section1>
<section1 topic='Attended Transfer' anchor='attended'>
<p>The session flow for negotiating an unattended transfer is as follows:</p>
<p>The session flow for negotiating an attended transfer is as follows:</p>
<code><![CDATA[
Caller Attendant Callee
| | |
@ -283,170 +293,176 @@ Caller Attendant Callee
|<===============================================>|
| |
]]></code>
<p>The protocol flow is shown below, where the caller is "caller@world.sun", the attendant is "attendant@office.biz", and the callee is "boss@bigdesk.biz".</p>
<p>The protocol flow is shown below, where the caller is "caller@example.net", the attendant is "attendant@office.example.com", and the callee is "boss@execs.example.com".</p>
<p>First the caller initiates a normal call to the attendant.</p>
<example caption='Caller calls attendant'><![CDATA[
<iq from='caller@world.sun/phone'
id='jingle1'
to='attendant@office.biz/desk'
<iq from='caller@example.net/phone'
id='m4hs861b'
to='attendant@office.example.com/desk'
type='set'>
<jingle xmlns='urn:xmpp:jingle:0'
<jingle xmlns='urn:xmpp:jingle:1'
action='session-initiate'
initiator='caller@world.sun/phone'
initiator='caller@example.net/phone'
sid='851ba2'>
<content creator='initiator'
disposition='session'
name='voice'>
<description xmlns='urn:xmpp:jingle:apps:rtp:0'
name='urgent-communication'>
<description xmlns='urn:xmpp:jingle:apps:rtp:1'
media='audio'>
<payload-type id='0' name='PCMU' />
</description>
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'/>
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:1'>
...
</transport>
</content>
</jingle>
</iq>
]]></example>
<p>The attendant's phone then acknowledges the session request.</p>
<example caption='Attendant acks session-initiate'><![CDATA[
<iq from='attendant@office.biz/desk'
to='caller@world.sun/phone'
id='jingle1'
<iq from='attendant@office.example.com/desk'
to='caller@example.net/phone'
id='m4hs861b'
type='result'/>
]]></example>
<p>Next the attendant answers the call.</p>
<example caption='Attendant sends session-accept'><![CDATA[
<iq from='attendant@office.biz/desk'
to='caller@world.sun/phone'
id='accept1'
<iq from='attendant@office.example.com/desk'
to='caller@example.net/phone'
id='u72bx793'
type='set'>
<jingle xmlns='urn:xmpp:jingle:0'
<jingle xmlns='urn:xmpp:jingle:1'
action='session-accept'
initiator='caller@world.sun/phone'
responder='attendant@office.biz/desk'
initiator='caller@example.net/phone'
responder='attendant@office.example.com/desk'
sid='851ba2'>
<content creator='initiator'
disposition='session'
name='voice'>
<description xmlns='urn:xmpp:jingle:apps:rtp:0'
name='urgent-communication'>
<description xmlns='urn:xmpp:jingle:apps:rtp:1'
media='audio'>
<payload-type id='0' name='PCMU' />
</description>
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'>
<candidate .../>
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:1'>
...
</transport>
</jingle>
</iq>
]]></example>
<p>The caller acknowledges the session-accept.</p>
<example caption='Caller acks session-accept'><![CDATA[
<iq from='caller@world.sun/phone'
id='accept1'
to='attendant@office.biz/desk'
<iq from='caller@example.net/phone'
id='u72bx793'
to='attendant@office.example.com/desk'
type='result'/>
]]></example>
<p>Next the attendant makes a call to the callee for the purpose of making an attended transfer:</p>
<p>Next the attendant makes a call to the callee for the purpose of completing an attended transfer. Before doing so, the attendant SHOULD verify that the callee supports Jingle session transfer, as described under <link url='#support'>Determining Support</link>.</p>
<example caption='Attendant calls callee'><![CDATA[
<iq from='attendant@office.biz/desk'
id='jingle2'
to='boss@bigdesk.biz/phone'
<iq from='attendant@office.example.com/desk'
id='t57caw2r'
to='boss@execs.example.com/phone'
type='set'>
<jingle xmlns='urn:xmpp:jingle:0'
<jingle xmlns='urn:xmpp:jingle:1'
action='session-initiate'
initiator='attendant@office.biz/desk'
initiator='attendant@office.example.com/desk'
sid='663e9f'>
<content creator='initiator'
disposition='session'
name='voice'>
<description xmlns='urn:xmpp:jingle:apps:rtp:0'
name='urgent-communication'>
<description xmlns='urn:xmpp:jingle:apps:rtp:1'
media='audio'>
<payload-type id='0' name='PCMU' />
</description>
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'/>
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:1'>
...
</transport>
</content>
</jingle>
</iq>
]]></example>
<p>The callee acknowledges the session-initiate.</p>
<example caption='Callee acks session-initiate'><![CDATA[
<iq from='boss@bigdesk.biz/phone'
id='jingle2'
to='attendant@office.biz/desk'
<iq from='boss@execs.example.com/phone'
id='t57caw2r'
to='attendant@office.example.com/desk'
type='result'/>
]]></example>
<p>Now the attendant decides to transfer the call by sending a session-info action to the caller containing details about the attendant's session with the callee.</p>
<p>Now the attendant transfers the call by sending a session-info action to the caller containing details about the attendant's session with the callee.</p>
<example caption='Attendant transfers the call'><![CDATA[
<iq from='attendant@office.biz/desk'
id='transfer1'
to='caller@world.sun/phone'
<iq from='attendant@office.example.com/desk'
id='p4hslk49'
to='caller@example.net/phone'
type='set'>
<jingle xmlns='urn:xmpp:jingle:0'
<jingle xmlns='urn:xmpp:jingle:1'
action='session-info'
initiator='caller@world.sun/phone'
responder='attendant@office.biz/desk'
initiator='caller@example.net/phone'
responder='attendant@office.example.com/desk'
sid='851ba2'>
<transfer xmlns='urn:xmpp:jingle:transfer:0'
from='attendant@office.biz/desk'
from='attendant@office.example.com/desk'
sid='663e9f'
to='boss@bigdesk.biz/phone'/>
to='boss@execs.example.com/phone'/>
</jingle>
</iq>
]]></example>
<p>If the caller understands the transfer request, it acknowledges the request (if not, it MUST return a &feature; error as specified in <cite>XEP-0166</cite>).</p>
<example caption='Caller acks transfer request'><![CDATA[
<iq from='attendant@office.biz/desk'
id='transfer1'
to='caller@world.sun/phone'
<iq from='attendant@office.example.com/desk'
id='p4hslk49'
to='caller@example.net/phone'
type='result'/>
]]></example>
<p>Now the caller puts the attendant on hold.</p>
<example caption='Caller puts attendant on hold'><![CDATA[
<iq from='attendant@office.biz/desk'
id='hold1'
to='caller@world.sun/phone'
<iq from='attendant@office.example.com/desk'
id='o4bd91v4'
to='caller@example.net/phone'
type='set'>
<jingle xmlns='urn:xmpp:jingle:0'
<jingle xmlns='urn:xmpp:jingle:1'
action='session-info'
initiator='caller@world.sun/phone'
initiator='caller@example.net/phone'
sid='851ba2'>
<hold xmlns='urn:xmpp:jingle:apps:rtp:info:0'/>
<hold xmlns='urn:xmpp:jingle:apps:rtp:info:1'/>
</jingle>
</iq>
]]></example>
<p>While the attendant is on hold, the caller initiates a new call to the callee. The session-initiation request includes an &lt;transfer/&gt; element that specifies the attendant's address and the SessionID of the attendant's session with the callee.</p>
<p>While the attendant is on hold, the caller initiates a new call to the callee. The session-initiation request includes a &lt;transfer/&gt; element that specifies the attendant's address and the SessionID of the attendant's session with the callee.</p>
<example caption='Caller initiates new call to callee'><![CDATA[
<iq from='caller@world.sun/phone'
id='jingle3'
to='boss@bigdesk.biz/phone'
<iq from='caller@example.net/phone'
id='w93b461v'
to='boss@execs.example.com/phone'
type='set'>
<jingle xmlns='urn:xmpp:jingle:0'
<jingle xmlns='urn:xmpp:jingle:1'
action='session-initiate'
initiator='caller@world.sun/phone'
initiator='caller@example.net/phone'
sid='851ba2'>
<content creator='initiator'
disposition='session'
name='voice'>
<description xmlns='urn:xmpp:jingle:apps:rtp:0'
name='urgent-communication'>
<description xmlns='urn:xmpp:jingle:apps:rtp:1'
media='audio'>
<payload-type id='0' name='PCMU' />
</description>
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'/>
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:1'>
...
</transport>
</content>
<transfer xmlns='urn:xmpp:jingle:transfer:0'
from='attendant@office.biz/desk'
from='attendant@office.example.com/desk'
sid='663e9f'
to='boss@bigdesk.biz/phone'/>
to='boss@execs.example.com/phone'/>
</jingle>
</iq>
]]></example>
<p>The callee identifies an active session with the same from+to+sid and replaces that with the incoming call, so it hangs up on the existing session with the attendant.</p>
<example caption='Callee hangs up on attendant'><![CDATA[
<iq from='boss@bigdesk.biz/phone'
id='hangup2'
to='attendant@office.biz/desk'
<iq from='boss@execs.example.com/phone'
id='yh2f36s5'
to='attendant@office.example.com/desk'
type='set'>
<jingle xmlns='urn:xmpp:jingle:0'
<jingle xmlns='urn:xmpp:jingle:1'
action='session-terminate'
initiator='attendant@office.biz/desk'
initiator='attendant@office.example.com/desk'
sid='663e9f'>
<reason>
<success/>
@ -458,20 +474,20 @@ Caller Attendant Callee
]]></example>
<p>The callee then acknowledges the session request from the caller.</p>
<example caption='Callee acks session-initiate'><![CDATA[
<iq from='boss@bigdesk.biz/phone'
to='caller@world.sun/phone'
id='jingle3'
<iq from='boss@execs.example.com/phone'
to='caller@example.net/phone'
id='w93b461v'
type='result'/>
]]></example>
<p>Now the caller's phone detects the successful transfer, so it hangs up on the attendant:</p>
<example caption='Caller terminates session with attendant'><![CDATA[
<iq from='caller@world.sun/phone'
id='hangup2'
to='attendant@office.biz/desk'
<iq from='caller@example.net/phone'
id='yh2f36s5'
to='attendant@office.example.com/desk'
type='set'>
<jingle xmlns='urn:xmpp:jingle:0'
<jingle xmlns='urn:xmpp:jingle:1'
action='session-terminate'
initiator='attendant@office.biz/desk'
initiator='attendant@office.example.com/desk'
sid='851ba2'>
<reason>
<success/>
@ -486,20 +502,20 @@ Caller Attendant Callee
<section1 topic='Determining Support' anchor='support'>
<p>If an entity supports session transfers, it MUST advertise that fact by returning a feature of "urn:xmpp:jingle:transfer:0" &VNOTE; in response to &xep0030; information requests.</p>
<example caption="Service discovery information request"><![CDATA[
<iq from='caller@world.sun/phone
id='disco1'
to='attendant@office.biz/desk'
<iq from='caller@example.net/phone
id='u891vad3'
to='attendant@office.example.com/desk'
type='get'>
<query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>
]]></example>
<example caption="Service discovery information response"><![CDATA[
<iq from='attendant@office.biz/desk'
id='disco1'
to='caller@world.sun/phone
<iq from='attendant@office.example.com/desk'
id='u891vad3'
to='caller@example.net/phone
type='result'>
<query xmlns='http://jabber.org/protocol/disco#info'>
<feature var='urn:xmpp:jingle:0'/>
<feature var='urn:xmpp:jingle:1'/>
<feature var='urn:xmpp:jingle:transfer:0'/>
</query>
</iq>
@ -508,7 +524,11 @@ Caller Attendant Callee
</section1>
<section1 topic='Security Considerations' anchor='security'>
<p>To follow.</p>
<p>In unattended transfer, the callee has no way to verify that the attendant specified in the session-initiate request received from the caller was actually involved in the transaction. This implies that:</p>
<ol>
<li>A malicious caller could attribute its session-initiate request to an attendant, thus discrediting the attendant in the eyes of the callee.</li>
<li>A malicious attendant (or malicious code that has infected an attendant's legitimate client) could "transfer" all session requests it receives to the callee and disavow any responsibility.</li>
</ol>
</section1>
<section1 topic='IANA Considerations' anchor='iana'>