-
Notifications
You must be signed in to change notification settings - Fork 116
/
xep-0251.xml
589 lines (574 loc) · 23.4 KB
/
xep-0251.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
<?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 Session Transfer</title>
<abstract>This specification defines an extension to XMPP Jingle for transferring a session (such as a voice call) from one person to another.</abstract>
&LEGALNOTICE;
<number>0251</number>
<status>Deferred</status>
<type>Standards Track</type>
<sig>Standards</sig>
<approver>Council</approver>
<dependencies>
<spec>XMPP Core</spec>
<spec>XEP-0166</spec>
</dependencies>
<supersedes/>
<supersededby/>
<shortname>NOT_YET_ASSIGNED</shortname>
<author>
<firstname>Marian</firstname>
<surname>Podgoreanu</surname>
<email>marian@null.ro</email>
</author>
<author>
<firstname>Paul</firstname>
<surname>Chitescu</surname>
<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>
<initials>psa</initials>
<remark><p>Initial published version.</p></remark>
</revision>
<revision>
<version>0.0.2</version>
<date>2008-10-22</date>
<initials>psa</initials>
<remark><p>Added XML schema.</p></remark>
</revision>
<revision>
<version>0.0.1</version>
<date>2008-10-21</date>
<initials>dc/pc/psa</initials>
<remark><p>First draft.</p></remark>
</revision>
</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 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'>
<p>The session flow for negotiating an unattended transfer is as follows:</p>
<code><![CDATA[
Caller Attendant Callee
| | |
| session-initiate | |
|----------------------->| |
| ack | |
|<-----------------------| |
| session-accept | |
|<-----------------------| |
| ack | |
|----------------------->| |
| transfer | |
|<-----------------------| |
| ack | |
|----------------------->| |
| hold | |
|----------------------->| |
| ack | |
|<-----------------------| |
| session-initiate |
|------------------------------------------------>|
| ack |
|<------------------------------------------------|
| terminate | |
|----------------------->| |
| ack | |
|<-----------------------| |
| session-accept |
|<------------------------------------------------|
| ack |
|------------------------------------------------>|
| AUDIO (RTP) |
|<===============================================>|
| |
]]></code>
<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@example.net/phone'
id='i3hd81k8'
to='attendant@office.example.com/desk'
type='set'>
<jingle xmlns='urn:xmpp:jingle:1'
action='session-initiate'
initiator='caller@example.net/phone'
sid='851ba2'>
<content creator='initiator'
disposition='session'
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: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.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.example.com/desk'
id='k1d26dcv'
to='caller@example.net/phone'
type='set'>
<jingle xmlns='urn:xmpp:jingle:1'
action='session-accept'
initiator='caller@example.net/phone'
responder='attendant@office.example.com/desk'
sid='851ba2'>
<content creator='initiator'
disposition='session'
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:1'>
...
</transport>
</jingle>
</iq>
]]></example>
<p>The caller acknowledges the session-accept.</p>
<example caption='Caller acks session-accept'><![CDATA[
<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 a <transfer/> element qualified by the "urn:xmpp:jingle:transfer:0" namespace &VNOTE;.</p>
<example caption='Attendant transfers the call'><![CDATA[
<iq from='attendant@office.example.com/desk'
id='a0pl3v76'
to='caller@example.net/phone'
type='set'>
<jingle xmlns='urn:xmpp:jingle:1'
action='session-info'
initiator='caller@example.net/phone'
responder='attendant@office.example.com/desk'
sid='851ba2'>
<transfer xmlns='urn:xmpp:jingle:transfer:0'
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.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.example.com/desk'
id='o4bd91v4'
to='caller@example.net/phone'
type='set'>
<jingle xmlns='urn:xmpp:jingle:1'
action='session-info'
initiator='caller@example.net/phone'
sid='851ba2'>
<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 a <transfer/> element that specifies the attendant's address.</p>
<example caption='Caller initiates new call to callee'><![CDATA[
<iq from='caller@example.net/phone'
id='r7y2nxv3'
to='boss@execs.example.com/phone'
type='set'>
<jingle xmlns='urn:xmpp:jingle:1'
action='session-initiate'
initiator='caller@example.net/phone'
sid='1a332d'>
<content creator='initiator'
disposition='session'
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:1'>
...
</transport>
</content>
<transfer xmlns='urn:xmpp:jingle:transfer:0'
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@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@example.net/phone'
id='hg34cx20'
to='attendant@office.example.com/desk'
type='set'>
<jingle xmlns='urn:xmpp:jingle:1'
action='session-terminate'
initiator='attendant@office.example.com/desk'
sid='851ba2'>
<reason>
<success/>
<transferred xmlns='urn:xmpp:jingle:transfer:0'/>
<text>Unattended transfer success</text>
</reason>
</jingle>
</iq>
]]></example>
</section1>
<section1 topic='Attended Transfer' anchor='attended'>
<p>The session flow for negotiating an attended transfer is as follows:</p>
<code><![CDATA[
Caller Attendant Callee
| | |
| session-initiate | |
|----------------------->| |
| ack | |
|<-----------------------| |
| session-accept | |
|<-----------------------| |
| ack | |
|----------------------->| |
| | session-initiate |
| |----------------------->|
| | ack |
| |<-----------------------|
| transfer | |
|<-----------------------| |
| ack | |
|----------------------->| |
| hold | |
|----------------------->| |
| ack | |
|<-----------------------| |
| session-initiate |
|------------------------------------------------>|
| ack |
|<------------------------------------------------|
| terminate | |
|----------------------->| |
| ack | |
|<-----------------------| |
| session-accept |
|<------------------------------------------------|
| ack |
|------------------------------------------------>|
| AUDIO (RTP) |
|<===============================================>|
| |
]]></code>
<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@example.net/phone'
id='m4hs861b'
to='attendant@office.example.com/desk'
type='set'>
<jingle xmlns='urn:xmpp:jingle:1'
action='session-initiate'
initiator='caller@example.net/phone'
sid='851ba2'>
<content creator='initiator'
disposition='session'
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: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.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.example.com/desk'
to='caller@example.net/phone'
id='u72bx793'
type='set'>
<jingle xmlns='urn:xmpp:jingle:1'
action='session-accept'
initiator='caller@example.net/phone'
responder='attendant@office.example.com/desk'
sid='851ba2'>
<content creator='initiator'
disposition='session'
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:1'>
...
</transport>
</jingle>
</iq>
]]></example>
<p>The caller acknowledges the session-accept.</p>
<example caption='Caller acks session-accept'><![CDATA[
<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 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.example.com/desk'
id='t57caw2r'
to='boss@execs.example.com/phone'
type='set'>
<jingle xmlns='urn:xmpp:jingle:1'
action='session-initiate'
initiator='attendant@office.example.com/desk'
sid='663e9f'>
<content creator='initiator'
disposition='session'
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:1'>
...
</transport>
</content>
</jingle>
</iq>
]]></example>
<p>The callee acknowledges the session-initiate.</p>
<example caption='Callee acks session-initiate'><![CDATA[
<iq from='boss@execs.example.com/phone'
id='t57caw2r'
to='attendant@office.example.com/desk'
type='result'/>
]]></example>
<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.example.com/desk'
id='p4hslk49'
to='caller@example.net/phone'
type='set'>
<jingle xmlns='urn:xmpp:jingle:1'
action='session-info'
initiator='caller@example.net/phone'
responder='attendant@office.example.com/desk'
sid='851ba2'>
<transfer xmlns='urn:xmpp:jingle:transfer:0'
from='attendant@office.example.com/desk'
sid='663e9f'
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.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.example.com/desk'
id='o4bd91v4'
to='caller@example.net/phone'
type='set'>
<jingle xmlns='urn:xmpp:jingle:1'
action='session-info'
initiator='caller@example.net/phone'
sid='851ba2'>
<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 a <transfer/> 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@example.net/phone'
id='w93b461v'
to='boss@execs.example.com/phone'
type='set'>
<jingle xmlns='urn:xmpp:jingle:1'
action='session-initiate'
initiator='caller@example.net/phone'
sid='851ba2'>
<content creator='initiator'
disposition='session'
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:1'>
...
</transport>
</content>
<transfer xmlns='urn:xmpp:jingle:transfer:0'
from='attendant@office.example.com/desk'
sid='663e9f'
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@execs.example.com/phone'
id='yh2f36s5'
to='attendant@office.example.com/desk'
type='set'>
<jingle xmlns='urn:xmpp:jingle:1'
action='session-terminate'
initiator='attendant@office.example.com/desk'
sid='663e9f'>
<reason>
<success/>
<transferred xmlns='urn:xmpp:jingle:transfer:0'/>
<text>Attended transfer success</text>
</reason>
</jingle>
</iq>
]]></example>
<p>The callee then acknowledges the session request from the caller.</p>
<example caption='Callee acks session-initiate'><![CDATA[
<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@example.net/phone'
id='yh2f36s5'
to='attendant@office.example.com/desk'
type='set'>
<jingle xmlns='urn:xmpp:jingle:1'
action='session-terminate'
initiator='attendant@office.example.com/desk'
sid='851ba2'>
<reason>
<success/>
<transferred xmlns='urn:xmpp:jingle:transfer:0'/>
<text>Unattended transfer success</text>
</reason>
</jingle>
</iq>
]]></example>
</section1>
<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@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.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:1'/>
<feature var='urn:xmpp:jingle:transfer:0'/>
</query>
</iq>
]]></example>
<p>In order for an application to determine whether an entity supports this protocol, where possible it SHOULD use the dynamic, presence-based profile of service discovery defined in &xep0115;. However, if an application has not received entity capabilities information from an entity, it SHOULD use explicit service discovery instead.</p>
</section1>
<section1 topic='Security Considerations' anchor='security'>
<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'>
<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>This specification defines the following XML namespace:</p>
<ul>
<li>urn:xmpp:jingle:transfer:0</li>
</ul>
<p>Upon advancement of this specification from a status of Experimental to a status of Draft, the ®ISTRAR; shall add the foregoing namespaces to the registry located at &NAMESPACES;, as described in Section 4 of &xep0053;.</p>
</section2>
<section2 topic='Protocol Versioning' anchor='registrar-versioning'>
&NSVER;
</section2>
</section1>
<section1 topic='XML Schemas' anchor='schema'>
<code><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>
<xs:schema
xmlns:xs='http://www.w3.org/2001/XMLSchema'
targetNamespace='urn:xmpp:jingle:transfer:0'
xmlns='urn:xmpp:jingle:transfer:0'
elementFormDefault='qualified'>
<xs:element name='transfer'>
<xs:complexType>
<xs:simpleContent>
<xs:extension base='empty'>
<xs:attribute name='from' type='xs:string' use='optional'/>
<xs:attribute name='sid' type='xs:string' use='optional'/>
<xs:attribute name='to' type='xs:string' use='optional'/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name='transferred' type='empty'/>
<xs:simpleType name='empty'>
<xs:restriction base='xs:string'>
<xs:enumeration value=''/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
]]></code>
</section1>
<section1 topic='Acknowledgements' anchor='ack'>
<p>Thanks to Robert McQueen for his feedback.</p>
</section1>
</xep>