idnits 2.17.1 draft-ietf-insipid-session-id-12.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (January 7, 2015) is 3390 days in the past. Is this intentional? -- Found something which looks like a code comment -- if you have code sections in the document, please surround them with '' and '' lines. Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Missing Reference: '0-9a-f' is mentioned on line 279, but not defined == Missing Reference: 'RFCXXXX' is mentioned on line 1406, but not defined ** Obsolete normative reference: RFC 7329 (Obsoleted by RFC 7989) -- Obsolete informational reference (is this intentional?): RFC 2543 (Obsoleted by RFC 3261, RFC 3262, RFC 3263, RFC 3264, RFC 3265) Summary: 1 error (**), 0 flaws (~~), 3 warnings (==), 3 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group P. Jones (Ed.) 3 Internet Draft J. Polk (Ed.) 4 Intended status: Standards Track G. Salgueiro 5 Expires: July 7, 2015 C. Pearce 6 Cisco Systems 7 January 7, 2015 9 End-to-End Session Identification in IP-Based Multimedia 10 Communication Networks 11 draft-ietf-insipid-session-id-12 13 Abstract 15 This document describes an end-to-end Session Identifier for use in 16 IP-based multimedia communication systems that enables endpoints, 17 intermediate devices, and management systems to identify a session 18 end-to-end, associate multiple endpoints with a given multipoint 19 conference, track communication sessions when they are redirected, 20 and associate one or more media flows with a given communication 21 session. 23 This document also describes a backwards compatibility mechanism for 24 an existing (RFC 7329) session identifier implementation that is 25 sufficiently different from the procedures defined in this document. 27 Status of this Memo 29 This Internet-Draft is submitted to IETF in full conformance with the 30 provisions of BCP 78 and BCP 79. 32 Internet-Drafts are working documents of the Internet Engineering 33 Task Force (IETF), its areas, and its working groups. Note that 34 other groups may also distribute working documents as Internet- 35 Drafts. 37 Internet-Drafts are draft documents valid for a maximum of six months 38 and may be updated, replaced, or obsoleted by other documents at any 39 time. It is inappropriate to use Internet-Drafts as reference 40 material or to cite them other than as "work in progress." 42 The list of current Internet-Drafts can be accessed at 43 http://www.ietf.org/ietf/1id-abstracts.txt 45 The list of Internet-Draft Shadow Directories can be accessed at 46 http://www.ietf.org/shadow.html 48 This Internet-Draft will expire on July 7, 2015. 50 Copyright Notice 52 Copyright (c) 2014 IETF Trust and the persons identified as the 53 document authors. All rights reserved. 55 This document is subject to BCP 78 and the IETF Trust's Legal 56 Provisions Relating to IETF Documents 57 (http://trustee.ietf.org/license-info) in effect on the date of 58 publication of this document. Please review these documents 59 carefully, as they describe your rights and restrictions with respect 60 to this document. Code Components extracted from this document must 61 include Simplified BSD License text as described in Section 4.e of 62 the Trust Legal Provisions and are provided without warranty as 63 described in the Simplified BSD License. 65 Table of Contents 67 1. Introduction...................................................3 68 2. Conventions used in this document..............................3 69 3. Session Identifier Requirements and Use Cases..................4 70 4. Constructing and Conveying the Session Identifier..............4 71 4.1. Constructing the Session Identifier.......................4 72 4.2. Conveying the Session Identifier..........................5 73 5. The Session-ID Header Field....................................6 74 6. Endpoint Behavior..............................................7 75 7. Processing by Intermediaries...................................8 76 8. Associating Endpoints in a Multipoint Conference...............9 77 9. Various Call Flow Operations..................................10 78 9.1. Basic Call with 2 UUIDs..................................10 79 9.2. Basic Call Transfer using REFER..........................14 80 9.3. Basic Call Transfer using re-INVITE......................16 81 9.4. Single Focus Conferencing................................17 82 9.5. Single Focus Conferencing using WebEx....................19 83 9.6. Cascading Conference Bridges.............................20 84 9.6.1. Establishing a Cascaded Conference..................20 85 9.6.2. Calling into Cascaded Conference Bridges............21 86 9.7. Basic 3PCC for two UAs...................................22 87 9.8. Handling in 100 Trying SIP Response and CANCEL Request...23 88 9.8.1. Handling in a 100 Trying SIP Response...............23 89 9.8.2. Handling a CANCEL SIP Request.......................24 90 9.9. Out-of-dialog REFER Transaction..........................25 91 10. Compatibility with a Previous Implementation.................26 92 11. Security Considerations......................................28 93 12. IANA Considerations..........................................28 94 12.1. Registration of the "Session-ID" Header Field...........28 95 12.2. Registration of the "remote" Parameter..................29 96 13. Acknowledgments..............................................29 97 14. References...................................................29 98 14.1. Normative References....................................29 99 14.2. Informative References..................................30 100 Authors' Addresses...............................................31 102 1. Introduction 104 IP-based multimedia communication systems like SIP [RFC3261] and 105 H.323 [H.323] have the concept of a "call identifier" that is 106 globally unique. The identifier is intended to represent an end-to- 107 end communication session from the originating device to the 108 terminating device. Such an identifier is useful for 109 troubleshooting, session tracking, and so forth. 111 For several reasons, however, the current call identifiers defined in 112 SIP and H.323 are not suitable for end-to-end session identification. 113 A fundamental issue in protocol interworking is the fact that the 114 syntax for the call identifier in SIP and H.323 is different. Thus, 115 if both protocols are used in a call, it is impossible to exchange 116 the call identifier end-to-end. 118 Another reason why the current call identifiers are not suitable to 119 identify a session end-to-end is that, in real-world deployments, 120 devices like session border controllers often change the session 121 signaling as it passes through the device, including the value of the 122 call identifier. While this is deliberate and useful, it makes it 123 very difficult to track a session end-to-end. 125 This draft presents a new identifier, referred to as the Session 126 Identifier, and associated syntax intended to overcome the issues 127 that exist with the currently defined call identifiers used in SIP. 128 The procedures specified in this document attempt to comply with the 129 requirements specified in [RFC7206]. The procedures also specify 130 capabilities not mentioned in [RFC7206], shown in call flows in 131 section 9. Additionally, the specification attempts to account for a 132 previous, proprietary version of a SIP Session Identifier header 133 [RFC7329], specifying a backwards compatibility approach in section 134 10. 136 2. Conventions used in this document 138 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 139 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 140 document are to be interpreted as described in RFC 2119 [RFC2119] 141 when they appear in ALL CAPS. These words may also appear in this 142 document in lower case as plain English words, absent their normative 143 meanings. 145 The term "Session Identifier" refers to the value of the identifier, 146 whereas "Session-ID" refers to the header field used to convey the 147 identifier. 149 3. Session Identifier Requirements and Use Cases 151 Requirements and use cases for the end-to-end Session Identifier, 152 along with a definition of "session identifier" and "communication 153 session", can be found in [RFC7206]. 155 As mentioned in section 6.1 of RFC 7206, the ITU-T undertook a 156 parallel effort to define compatible procedures for an H.323 Session 157 Identifier. They are documented in [H.460.27]. 159 4. Constructing and Conveying the Session Identifier 161 4.1. Constructing the Session Identifier 163 The Session Identifier comprises two UUIDs [RFC4122], with each UUID 164 representing one of the endpoints participating in the session. 166 The version number in the UUID indicates the manner in which the UUID 167 is generated, such as using random values or using the MAC address of 168 the endpoint. To satisfy the requirement that no user or device 169 information be conveyed, endpoints SHOULD generate version 4 (random) 170 or version 5 (SHA-1) UUIDs to address relevant privacy concerns. 172 When generating a version 5 UUID, endpoints or intermediaries MUST 173 utilize the procedures defined in Section 4.3 of [RFC4122] and employ 174 the following "name space ID": 176 uuid_t NameSpace_SessionID = { 177 /* a58587da-c93d-11e2-ae90-f4ea67801e29 */ 178 0xa58587da, 179 0xc93d, 180 0x11e2, 181 0xae, 0x90, 0xf4, 0xea, 0x67, 0x80, 0x1e, 0x29 182 } 184 Further, the "name" to utilize for version 5 UUIDs is the 185 concatenation of the Call-ID header value and the "tag" parameter 186 that appears on the "From" or "To" line associated with the device 187 for which the UUID is created. Once an endpoint generates a UUID for 188 a session, the UUID never changes, even if values originally used as 189 input into its construction change over time. 191 Stateless intermediaries that insert a Session-ID header into a SIP 192 message on behalf of a sending User Agent MUST utilize version 5 193 UUIDs to ensure that UUIDs for the communication session are 194 consistently generated. If a stateless intermediary does not know 195 the tag value for the endpoint (e.g., a new INVITE without a To: tag 196 value or an older SIP [RFC2543] implementation that did not include a 197 tag parameter), the intermediary MUST NOT attempt to generate a UUID 198 for that endpoint. Note that if an intermediary is stateless and the 199 endpoint on one end of the call is replaced with another endpoint due 200 to some service interaction, the values used to create the UUID 201 should change and, if so, the intermediary will compute a different 202 UUID. 204 4.2. Conveying the Session Identifier 206 The SIP user agent (UA) initially transmitting the SIP request, i.e., 207 a User Agent Client (UAC), will create a UUID and transmit that to 208 the ultimate destination UA. Likewise, the responding UA, i.e., a 209 User Agent Server (UAS), will create a UUID and transmit that to the 210 first UA. These two distinct UUIDs form what is referred to as the 211 Session Identifier and is represented in this document in set 212 notation of the form {A,B}, where A is UUID value from the UA 213 transmitting a message and B is the UUID value of the intended 214 recipient of the message, i.e., not an intermediary server along the 215 signaling path. The Session Identifier {A,B} is equal to the Session 216 Identifier {B,A}. 218 In the case where only one UUID is known, such as when a UA first 219 initiates a SIP request, the Session Identifier would be {A,N}, where 220 "A" represents the UUID value transmitted by the UA and "N" is what 221 is referred to as the null UUID (see section 5). 223 Since SIP sessions are subject to any number of service interactions, 224 SIP INVITE messages might be forked as sessions are established, and 225 since conferences might be established or expanded with endpoints 226 calling in or the conference focus calling out, the construction of 227 the Session Identifier as a set of UUIDs is important. 229 To understand this better, consider that a UA participating in a 230 communication session might be replaced with another, such as the 231 case where two "legs" of a call are joined together by a PBX. 232 Suppose that UA A and UA B both call UA C. Further suppose that UA C 233 uses a local PBX function to join the call between itself and UA A 234 with the call between itself and UA B, resulting in a single 235 remaining call between UA A and UA B. This merged call can be 236 identified using two UUID values assigned by each entity in the 237 communication session, namely {A,B} in this example. 239 In the case of forking, UA A might send an INVITE that gets forked to 240 five different UAs, as an example. A means of identifying each of 241 these separate communication sessions is needed and allowing the set 242 of {A, B1}, {A, B2}, {A, B3}, {A, B4}, and {A, B5} makes this 243 possible. 245 For conferencing scenarios, it is also useful to have a two-part 246 Session Identifier where the conference focus specifies the same UUID 247 for each conference participant. This will allow for correlation 248 among the participants in a single conference. For example, in a 249 conference with three participants, the Session Identifiers might be 250 {A,M}, {B,M}, and {C,M}, where "M" is assigned by the conference 251 focus. 253 How a device acting on Session Identifiers stores, processes, or 254 utilizes the Session Identifier is outside the scope of this 255 document. 257 5. The Session-ID Header Field 259 The syntax specified here replaces the Session-ID header field syntax 260 defined in RFC 7329 [RFC7329]. 262 Each session initiated or accepted MUST have a unique local UA- 263 generated UUID. This value MUST remain unchanged throughout the 264 duration of the session. 266 A SIP UA or proxy that generates a Session-ID header on behalf of a 267 UA MUST convey its Session Identifier UUID in all transmitted 268 messages by including the Session-ID header. The Session-ID header 269 has the following ABNF [RFC5234] syntax: 271 session-id = "Session-ID" HCOLON session-id-value 273 session-id-value = local-uuid *(SEMI sess-id-param) 275 local-uuid = sess-uuid / null 277 remote-uuid = sess-uuid / null 279 sess-uuid = 32(DIGIT / %x61-66) ;32 chars of [0-9a-f] 281 sess-id-param = remote-param / generic-param 283 remote-param = "remote" EQUAL remote-uuid 285 null = 32("0") 287 The productions "SEMI", "EQUAL", and "generic-param" are defined in 288 [RFC3261]. The production DIGIT is defined in [RFC5234]. 290 The Session-ID header MUST NOT have more than one "remote" parameter. 291 In the case where an entity compliant with this specification is 292 interworking with an entity that implemented [RFC7329], the "remote" 293 parameter may be absent, but otherwise the remote parameter MUST be 294 present. The details under which those conditions apply are 295 described in Section 10. Except for backwards compatibility with 296 [RFC7329], the "remote" parameter MUST be present. 298 A special null UUID value composed of 32 zeros is required in certain 299 situations. A null UUID is expected as the "remote-uuid" of every 300 initial standard SIP request since the initiating endpoint would not 301 initially know the UUID value of the remote endpoint. This null value 302 will get replaced by the ultimate destination UAS when that UA 303 generates a UUID in response. One caveat is explained in Section 10 304 for a possible backwards compatibility case. A null UUID value is 305 also returned by some intermediary devices that send provisional 306 replies as a "local-uuid", as described in Section 7. 308 The "local-uuid" in the Session-ID header represents the UUID value 309 of the UA transmitting the message. If the UA transmitting the 310 message previously received a UUID value from its peer endpoint, it 311 MUST include that UUID as the "remote" parameter in each message it 312 transmits. For example, a Session-ID header might appear like this: 314 Session-ID: ab30317f1a784dc48ff824d0d3715d86; 315 remote=47755a9de7794ba387653f2099600ef2 317 The UUID values are presented as strings of lower-case hexadecimal 318 characters, with the most significant octet of the UUID appearing 319 first. 321 6. Endpoint Behavior 323 To comply with this specification, non-intermediary SIP UAs MUST 324 include a Session-ID header-value in all SIP messages transmitted as 325 a part of a communication session. The UUID of the transmitter of 326 the message MUST appear in the "local-uuid" portion of the Session-ID 327 header-value. The UUID of the peer device, if known, MUST appear as 328 the "remote" parameter following the transmitter's UUID. The null 329 UUID value MUST be used if the peer device's UUID is not known. 331 Once a UA allocates a UUID value for a communication session, the UA 332 MUST NOT change that UUID value for the duration of the session, 333 including when 335 - communication attempts are retried due to receipt of 4xx 336 messages or request timeouts; 338 - the session is redirected in response to a 3xx message; or 340 - a session is transferred via a REFER message [RFC3515]; or 342 - a SIP dialog is replaced via an INVITE with Replaces [RFC3891]. 344 A non-intermediary UA that receives a Session-ID header MUST take 345 note of the "local-uuid" value that it receives and assume that is 346 the UUID of the peer endpoint within that communications session. 347 UAs MUST include this received UUID value as the "remote" parameter 348 when transmitting subsequent messages, making sure not to change this 349 UUID value in the process of moving the value internally from the 350 "local-uuid" field to the "remote-uuid" field. 352 It should be noted that messages received by a UA might contain a 353 "local-uuid" value that does not match what the UA expected the far 354 end UA's UUID to be. It is also possible for the UA to receive a 355 "remote-uuid" value that does not match the UA's assigned UUID for 356 the session. Either might happen as a result of service interactions 357 by intermediaries and MUST NOT negatively affect the communication 358 session. However, the UA may log this event for the purposes of 359 troubleshooting. 361 A UA MUST assume that the UUID value of the peer UA MAY change at any 362 time due to service interactions. If the UUID value of the peer UA 363 changes, the UA MUST accept the new UUID as the peer's UUID and 364 include this new UUID as the "remote" parameter in any subsequent 365 messages. 367 It is also important to note that if an intermediary in the network 368 forks a session, the initiating UA may receive multiple responses 369 back from different endpoints, each of which contains a different 370 UUID ("local-uuid") value. UAs MUST take care to ensure that the 371 correct UUID value is returned in the "remote" parameter when 372 interacting with each endpoint. The one exception is when the UA 373 sends a CANCEL message, in which case the Session-ID header value 374 MUST be identical to the Session-ID header value sent in the original 375 INVITE. 377 A Multipoint Control Unit (MCU) is a special type of conferencing 378 endpoint and is discussed in Section 8. 380 7. Processing by Intermediaries 382 The Call-ID often reveals personal, device, domain or other sensitive 383 information associated with a user, which is why intermediaries, such 384 as session border controllers, sometimes alter the Call-ID. In order 385 to ensure the integrity of the end-to-end Session Identifier, it is 386 constructed in a way which does not reveal such information, removing 387 the need for intermediaries to alter it. As such, intermediaries 388 MUST NOT alter the UUID values found in the Session-ID header, except 389 as described in this section. 391 Intermediary devices that transfer a call, such as by joining 392 together two different "call legs", MUST properly construct a 393 Session-ID header that contains the correct UUID values and correct 394 placement of those values. As described above, the recipient of any 395 message initiated by the intermediary will assume that the first UUID 396 value belongs to the peer endpoint. 398 If an intermediary receives a SIP message without a Session-ID header 399 field or valid header value, the intermediary MAY assign a "local- 400 uuid" value to represent the sending endpoint and insert that value 401 into all signaling messages on behalf of the sending endpoint for 402 that dialog. If the intermediary is aware of a "remote-uuid" value 403 that identifies the receiving UA, it MUST insert that value if also 404 inserting the "local-uuid" value. 406 Whenever there is a UA that does not implement this specification 407 communicating through a B2BUA, the B2BUA MAY become dialog stateful 408 and insert a UUID value into the Session-ID header on behalf of the 409 UA according to the rules stated in Section 6. 411 When an intermediary transmits a provisional response, the "remote- 412 uuid" field will contain the UUID value of the UA that sent the 413 message that prompted the transmission of the provisional response. 414 When the UUID of the destination UA for the message that prompted the 415 transmission of the provisional response is known, the intermediary 416 MUST insert the UUID of the destination UA in the "local-uuid" field 417 of the provisional response. Otherwise, the intermediary MAY set the 418 "local-uuid" field of the provisional response to a locally generated 419 UUID value or the null UUID value. 421 A CANCEL request sent by an intermediary MUST construct a Session-ID 422 header value exactly like the INVITE's Session-ID.. 424 Devices that initiate communication sessions following the procedures 425 for third party call control MUST fabricate a UUID value that will be 426 utilized only temporarily. Once the responding endpoint provides a 427 UUID value in a response message, the temporary value MUST be 428 discarded and replaced with the endpoint-provided UUID value. Refer 429 to the third-party call control example for an illustration. If the 430 third-party call controller sends a re-INVITE to obtain an offer for 431 connecting the endpoint to a different session, the Session-ID MAY 432 reflect the current session; the ACK's Session-ID would reflect the 433 newly connected session. 435 If a SIP intermediary initiates a dialog between two UAs in a 3PCC 436 scenario, the SIP request in the initial INVITE will have a non-null 437 "local-uuid" value; call this temporary UUID X. The request will 438 still have a null "remote-uuid" value; call this value N. The SIP 439 server MUST be transaction stateful. The UUID pair in the INVITE 440 will be {X,N}. A non-redirected or rejected response will have a 441 UUID pair {A,X}. This transaction stateful, dialog initiating SIP 442 server MUST replace its own UUID, i.e., X, with a null UUID (i.e., 443 {A,N}) as expected by other UAS (see Section 9.7 for an example). 445 8. Associating Endpoints in a Multipoint Conference 447 Multipoint Control Units (MCUs) group two or more sessions into a 448 single multipoint conference. MCUs, including cascaded MCUs, MUST 449 utilize the same UUID value ("local-uuid" portion of the Session-ID 450 header-value) with all participants in the conference. In so doing, 451 each individual session in the conference will have a unique Session 452 Identifier (since each endpoint will create a unique UUID of its 453 own), but will also have one UUID in common with all other 454 participants in the conference. 456 When creating a cascaded conferencing, an MCU MUST convey the UUID 457 value to utilize for a conference via the "local-uuid" portion of the 458 Session-ID header-value in an INVITE to a second MCU when using SIP 459 to establish the cascaded conference. A conference bridge, or MCU, 460 needs a way to identify itself when contacting another MCU. RFC 4579 461 [RFC4579] defines the "isfocus" Contact: header parameter just for 462 this purpose. The initial MCU MUST include the UUID of that 463 particular conference in the "local-uuid" of an INVITE to the other 464 MCU(s) participating in that conference. Also included in this 465 INVITE is an "isfocus" Contact header parameter identifying that this 466 INVITE is coming from an MCU and that this UUID is to be given out in 467 all responses from UAs into those MCUs participating in this same 468 conference. This ensures a single UUID is common across all 469 participating MCUs of the same conference, but is unique between 470 different conferences. 472 Intermediary devices or network diagnostics equipment might assume 473 that when they see two or more sessions with different Session 474 Identifiers, but with one UUID in common, that the sessions are part 475 of the same conference. However, the assumption that two sessions 476 having one common UUID being part of the same conference is not 477 always correct. In a SIP forking scenario, for example, there might 478 also be what appears to be multiple sessions with a shared UUID 479 value; this is intended. The desire is to allow for the association 480 of related sessions, regardless of whether a session is forked or 481 part of a conference. 483 9. Various Call Flow Operations 485 Seeing something frequently makes understanding easier. With that in 486 mind, we include several call flow examples with the initial UUID and 487 the complete Session Identifier indicated per message, as well as 488 when the Session Identifier changes according to the rules within 489 this document during certain operations/functions. 491 This section is for illustrative purposes only and is non-normative. 492 In the following flows, RTP refers to the Real-time Transport 493 Protocol [RFC3550]. 495 In the examples in this section, "N" represents a null UUID and other 496 letters represents the unique UUID values corresponding to endpoints 497 or MCUs. 499 9.1. Basic Call with 2 UUIDs 501 Session-ID 502 --- Alice B2BUA Bob Carol 503 {A,N} |---INVITE F1--->| | 504 {A,N} | |---INVITE F2--->| 505 {B,A} | |<---200 OK F3---| 506 {B,A} |<---200 OK F4---| | 507 {A,B} |-----ACK F5---->| | 508 {A,B} | |-----ACK F6---->| 509 |<==============RTP==============>| 511 Figure 1 - Session-ID Creation when Alice calls Bob 513 General operation of this example: 515 o UA-Alice populates the "local-uuid" portion of the Session-ID 516 header-value. 518 o UA-Alice sends its UUID in the SIP INVITE, and populates the 519 "remote" parameter with a null value (32 zeros). 521 o B2BUA receives an INVITE with both a "local-uuid" portion of 522 the Session-ID header-value from UA-Alice as well as the null 523 "remote-uuid" value, and transmits the INVITE towards UA-Bob 524 with an unchanged Session-ID header-value. 526 o UA-Bob receives Session-ID and generates its "local-uuid" 527 portion of the Session-ID header-value UUID to construct the 528 whole/complete Session-ID header-value, at the same time 529 transferring Alice's UUID unchanged to the "remote-uuid" 530 portion of the Session-ID header-value in the 200 OK SIP 531 response. 533 o B2BUA receives the 200 OK response with a complete Session-ID 534 header-value from UA-Bob, and transmits 200 OK towards UA-Alice 535 with an unchanged Session-ID header-value. 537 o UA-Alice, upon reception of the 200 OK from the B2BUA, 538 transmits the ACK towards the B2BUA. The construction of the 539 Session-ID header-value in this ACK is that of Alice's UUID is 540 the "local-uuid", and Bob's UUID populates the "remote-uuid" 541 portion of the header-value. 543 o B2BUA receives the ACK with a complete Session-ID header-value 544 from UA-Alice, and transmits ACK towards UA-Bob with an 545 unchanged Session-ID header-value. 547 Below is a complete SIP message exchange illustrating proper use of 548 the Session-ID header. For the sake of brevity, non-essential headers 549 and message bodies are omitted. 551 F1 INVITE Alice -> B2BUA 552 INVITE sip:bob@biloxi.com SIP/2.0 553 Via: SIP/2.0/TCP pc33.atlanta.example.com 554 ;branch=z9hG4bK776asdhds 555 Max-Forwards: 70 556 To: Bob 557 From: Alice ;tag=1928301774 558 Call-ID: a84b4c76e66710@pc33.atlanta.example.com 559 Session-ID: ab30317f1a784dc48ff824d0d3715d86 560 ;remote=00000000000000000000000000000000 561 CSeq: 314159 INVITE 562 Contact: 563 Content-Type: application/sdp 564 Content-Length: 142 566 (Alice's SDP not shown) 568 F2 INVITE B2BUA -> Bob 570 INVITE sip:bob@192.168.10.20 SIP/2.0 571 Via: SIP/2.0/TCP server10.biloxi.example.com 572 ;branch=z9hG4bK4b43c2ff8.1 573 Via: SIP/2.0/TCP pc33.atlanta.example.com 574 ;branch=z9hG4bK776asdhds;received=10.1.3.33 575 Max-Forwards: 69 576 To: Bob 577 From: Alice ;tag=1928301774 578 Call-ID: a84b4c76e66710@pc33.atlanta.example.com 579 Session-ID: ab30317f1a784dc48ff824d0d3715d86 580 ;remote=00000000000000000000000000000000 581 CSeq: 314159 INVITE 582 Contact: 583 Record-Route: 584 Content-Type: application/sdp 585 Content-Length: 142 587 (Alice's SDP not shown) 589 F3 200 OK Bob -> B2BUA 591 SIP/2.0 200 OK 592 Via: SIP/2.0/TCP server10.biloxi.example.com 593 ;branch=z9hG4bK4b43c2ff8.1;received=192.168.10.1 594 Via: SIP/2.0/TCP pc33.atlanta.example.com 595 ;branch=z9hG4bK776asdhds;received=10.1.3.33 596 Route: 597 To: Bob ;tag=a6c85cf 598 From: Alice ;tag=1928301774 599 Call-ID: a84b4c76e66710@pc33.atlanta.example.com 600 Session-ID: 47755a9de7794ba387653f2099600ef2 601 ;remote=ab30317f1a784dc48ff824d0d3715d86 602 CSeq: 314159 INVITE 603 Contact: 604 Record-Route: sip:server10.biloxi.example.com;lr 605 Content-Type: application/sdp 606 Content-Length: 131 608 (Bob's SDP not shown) 610 F4 200 OK B2BUA -> Alice 612 SIP/2.0 200 OK 613 Via: SIP/2.0/TCP pc33.atlanta.example.com 614 ;branch=z9hG4bK776asdhds;received=10.1.3.33 615 To: Bob ;tag=a6c85cf 616 From: Alice ;tag=1928301774 617 Call-ID: a84b4c76e66710@pc33.atlanta.example.com 618 Session-ID: 47755a9de7794ba387653f2099600ef2 619 ;remote=ab30317f1a784dc48ff824d0d3715d86 620 CSeq: 314159 INVITE 621 Contact: 622 Record-Route: 623 Content-Type: application/sdp 624 Content-Length: 131 626 (Bob's SDP not shown) 628 F5 ACK Alice -> B2BUA 630 ACK sip:bob@192.168.10.20 SIP/2.0 631 Via: SIP/2.0/TCP pc33.atlanta.example.com 632 ;branch=z9hG4bKnashds8 633 Route: sip:server10.biloxi.example.com;lr 634 Max-Forwards: 70 635 To: Bob ;tag=a6c85cf 636 From: Alice ;tag=1928301774 637 Call-ID: a84b4c76e66710@pc33.atlanta.example.com 638 Session-ID: ab30317f1a784dc48ff824d0d3715d86 639 ;remote=47755a9de7794ba387653f2099600ef2 640 CSeq: 314159 ACK 641 Content-Length: 0 643 F6 ACK B2BUA -> Bob 645 ACK sip:bob@192.168.10.20 SIP/2.0 646 Via: SIP/2.0/TCP server10.biloxi.example.com 647 ;branch=z9hG4bK4b43c2ff8.2 648 Via: SIP/2.0/TCP pc33.atlanta.example.com 649 ;branch=z9hG4bKnashds8;received=10.1.3.33 650 Max-Forwards: 70 651 To: Bob ;tag=a6c85cf 652 From: Alice ;tag=1928301774 653 Call-ID: a84b4c76e66710@pc33.atlanta.example.com 654 Session-ID: ab30317f1a784dc48ff824d0d3715d86 655 ;remote=47755a9de7794ba387653f2099600ef2 656 CSeq: 314159 ACK 657 Content-Length: 0 659 The remaining examples in this Section do not display the complete 660 SIP message exchange. Instead, they simply use the set notation 661 described in Section 4.2 to show the Session Identifier exchange 662 throughout the particular call flow being illustrated. 664 9.2. Basic Call Transfer using REFER 666 From the example built within Section 9.1, we proceed to this 'Basic 667 Call Transfer using REFER' example. Note that this is a mid-dialog 668 REFER in contrast with the out-of-dialog REFER in Section 9.9. 670 Session-ID 671 --- Alice B2BUA Bob Carol 672 | | | | 673 |<==============RTP==============>| | 674 {B,A} | |<---re-INVITE---| | 675 {B,A} |<---re-INVITE---| (puts Alice on Hold) | 676 {A,B} |-----200 OK---->| | | 677 {A,B} | |-----200 OK---->| | 678 {B,A} | |<-----ACK-------| | 679 {B,A} |<-----ACK-------| | | 680 | | | | 682 {B,A} | |<----REFER------| | 683 {B,A} |<----REFER------| | | 684 {A,B} |-----200 OK---->| | | 685 {A,B} | |-----200 OK---->| | 686 {A,B} |-----NOTIFY---->| | | 687 {A,B} | |-----NOTIFY---->| | 688 {B,A} | |<----200 OK-----| | 689 {B,A} |<----200 OK-----| | | 690 | | | | 691 {A,N} |-----INVITE---->| | 692 {A,N} | |-----INVITE-------------------->| 693 {C,A} | |<----200 OK---------------------| 694 {C,A} |<----200 OK-----| | 695 {A,C} |------ACK------>| | 696 {A,C} | |------ACK---------------------->| 697 | | | | 698 |<======================RTP======================>| 699 | | | | 700 {A,B} |-----NOTIFY---->| | | 701 {A,B} | |-----NOTIFY---->| | 702 {B,A} | |<----200 OK-----| | 703 {B,A} |<----200 OK-----| | | 704 {B,A} | |<-----BYE-------| | 705 {B,A} |<-----BYE-------| | | 706 {A,B} |-----200 OK---->| | | 707 {A,B} | |-----200 OK---->| | 708 | | | | 710 Figure 2 - Call Transfer using REFER 712 General operation of this example: 714 Starting from the existing Alice/Bob call described in Figure 1 of 715 this document, which established an existing Session-ID header- 716 value... 718 o UA-Bob requests Alice to call Carol, using a REFER transaction, 719 as described in [RFC3515]. UA-Alice is initially put on hold, 720 then told in the REFER who to contact with a new INVITE, in 721 this case UA-Carol. This Alice-to-Carol dialog will have a new 722 Call-ID, therefore it requires a new Session-ID header-value. 723 The wrinkle here is we can, and will, use Alice's UUID from her 724 existing dialog with Bob in the new INVITE to Carol. 726 o UA-Alice retains her UUID from the Alice-to-Bob call {A} when 727 requesting a call with UA-Carol. This is placed in the "local- 728 uuid" portion of the Session-ID header-value, at the same time 729 inserting a null "remote-uuid" value (because Carol's UA has 730 not yet received the UUID value). This same UUID traverses the 731 B2BUA unchanged. 733 o UA-Carol receives the INVITE with a Session Identifier UUID 734 {A,N}, replaces the A UUID value into the "remote-uuid" portion 735 of the Session-ID header-value and creates its own UUID {C} and 736 places this value in the "local-uuid" portion of the Session-ID 737 header-value - thereby removing the N (null) value altogether. 738 This combination forms a full Session Identifier {C,A} in the 739 200 OK to the INVITE. This Session-ID header-value traverses 740 the B2BUA unchanged towards UA-Alice. 742 o UA-Alice receives the 200 OK with the Session Identifier {C,A} 743 and responds to UA-Carol with an ACK (just as in Figure 1 - 744 switches places of the two UUID fields), and generates a NOTIFY 745 to Bob with a Session Identifier {A,B} indicating the call 746 transfer was successful. 748 o It does not matter which UA terminates the Alice-to-Bob call; 749 Figure 2 shows UA-Bob doing this transaction. 751 9.3. Basic Call Transfer using re-INVITE 753 From the example built within Section 9.1, we proceed to this 'Basic 754 Call Transfer using re-INVITE' example. 756 Alice is talking to Bob. Bob pushes a button on his phone to transfer 757 Alice to Carol via the B2BUA (using re-INVITE). 759 Session-ID 760 --- Alice B2BUA Bob Carol 761 | | | | 762 |<==============RTP==============>| | 763 | | | | 764 | | <--- (non-standard signaling) | 765 {A,B} | |---re-INVITE--->| | 766 {B,A} | |<-----200 OK----| | 767 {B,A} | |-----ACK------->| | 768 | | | | 769 {A,N} | |-----INVITE-------------------->| 770 {C,A} | |<----200 OK---------------------| 771 {A,C} | |------ACK---------------------->| 772 | | | | 773 |<======================RTP======================>| 774 | | | | 775 {A,B} | |------BYE------>| | 776 {B,A} | |<----200 OK-----| | 777 | | | | 779 Figure 3 - Call transfer using re-INVITE 781 General operation of this example: 783 o We assume the call between Alice and Bob from Section 9.1 is 784 operational with Session Identifier {A,B}. 786 o Bob uses non-standard signaling to the B2BUA to initiate a call 787 transfer from Alice to Carol. This could also be initiated via 788 a REFER message from Bob, but the signaling that follows might 789 still be similar to the above flow. In either case, Alice is 790 completely unaware of the call transfer until a future point in 791 time when Alice receives a message from Carol. 793 o The B2BUA sends a new INVITE with Alice's UUID {"local-uuid" = 794 "A"} to Carol. 796 o Carol receives the INVITE and accepts the request and adds her 797 UUID {C} to the Session Identifier for this session {"local- 798 uuid" = "C", "remote-uuid" = "A"}. 800 o The B2BUA then terminates the call to Bob with a BYE using the 801 Session Identifier {"local-uuid" = "A", "remote-uuid" = "B"}. 803 9.4. Single Focus Conferencing 805 Multiple users call into a conference server (say, an MCU) to attend 806 one of many conferences hosted on or managed by that server. Each 807 user has to identify which conference they want to join, but this 808 information is not necessarily in the SIP messaging. It might be 809 done by having a dedicated address for the conference or via an IVR, 810 as assumed in this example and depicted with the use of M1, M2, and 811 M3. Each user in this example goes through a two-step process of 812 signaling to gain entry onto their conference call, which the 813 conference focus identifies as M'. 815 Session-ID Conference 816 --- Alice Focus Bob Carol 817 | | | | 818 | | | | 819 {A,N} |----INVITE----->| | | 820 {M1,A} |<---200 OK------| | | 821 {A,M1} |-----ACK------->| | | 822 |<====RTP=======>| | | 823 {M',A} |<---re-INVITE---| | | 824 {A,M'} |-----200 OK---->| | | 825 {M',A} |<-----ACK-------| | | 826 | | | | 827 | | | | 828 {B,N} | |<----INVITE-----| | 829 {M2,B} | |-----200 OK---->| | 830 {B,M2} | |<-----ACK-------| | 831 | |<=====RTP======>| | 832 {M',B} | |---re-INVITE--->| | 833 {B,M'} | |<----200 OK-----| | 834 {M',B} | |------ACK------>| | 835 | | | | 836 | | | | 837 {C,N} | |<--------------------INVITE-----| 838 {M3,C} | |---------------------200 OK---->| 839 {C,M3} | |<---------------------ACK-------| 840 | |<=====================RTP======>| 841 {M',C} | |-------------------re-INVITE--->| 842 {C,M'} | |<--------------------200 OK-----| 843 {M',C} | |----------------------ACK------>| 845 Figure 4 - Single Focus Conference Bridge 847 General operation of this example: 849 Alice calls into a conference server to attend a certain conference. 850 This is a two-step operation since Alice cannot include the 851 conference ID at this time and/or any passcode in the INVITE request. 852 The first step is Alice's UA calling another UA to participate in a 853 session. This will appear to be similar as the call-flow in Figure 1 854 (in section 9.1). What is unique about this call is the second step: 855 the conference server sends a re-INVITE request with its second UUID, 856 but maintaining the UUID Alice sent in the first INVITE. This 857 subsequent UUID from the conference server will be the same for each 858 UA that calls into this conference server participating in this same 859 conference bridge/call, which is generated once Alice typically 860 authenticates and identifies which bridge she wants to participate 861 on. 863 o Alice sends an INVITE to the conference server with her UUID 864 {A} and a "remote-uuid" = N. 866 o The conference server responds with a 200 OK response which 867 replaces the N UUID with a temporary UUID ("M1") as the "local- 868 uuid" and a "remote-uuid" = "A". 870 NOTE: this 'temporary' UUID is a real UUID; it is only temporary 871 to the conference server because it knows that it is going to 872 generate another UUID to replace the one just send in the 200 OK. 874 o Once Alice, the user, gains access to the IVR for this 875 conference server, she enters a specific conference ID and 876 whatever passcode (if needed) to enter a specific conference 877 call. 879 o Once the conference server is satisfied Alice has identified 880 which conference she wants to attend (including any passcode 881 verification), the conference server re-INVITEs Alice to the 882 specific conference and includes the Session-ID header-value of 883 "local-uuid" = "M'" (and "remote-uuid" = "A") for that 884 conference. All valid participants in the same conference will 885 receive this same UUID for identification purposes and to 886 better enable monitoring, and tracking functions. 888 o Bob goes through this two-step process of an INVITE 889 transaction, followed by a re-INVITE transaction to get this 890 same UUID ("M'") for that conference. 892 o In this example, Carol (and each additional user) goes through 893 the same procedures and steps as Alice and Bob to get on this 894 same conference. 896 9.5. Single Focus Conferencing using WebEx 898 Alice, Bob and Carol call into same WebEx conference. 900 Session-ID Conference 901 --- Alice Focus Bob Carol 902 | | | | 903 |<** HTTPS *****>| | | 904 | Transaction | | | 905 | | | | 906 {M,N} |<----INVITE-----| | | 907 {A,M} |-----200 OK---->| | | 908 {M,A} |<-----ACK-------| | | 909 |<=====RTP======>| | | 910 | | | | 911 | |<** HTTPS *****>| | 912 | | Transaction | | 913 | | | | 914 {M,N} | |-----INVITE---->| | 915 {B,M} | |<----200 OK-----| | 916 {M,B} | |------ACK------>| | 917 | |<=====RTP======>| | 918 | | | | 919 | |<****************** HTTPS *****>| 920 | | Transaction | 921 | | | | 922 {M,N} | |--------------------INVITE----->| 923 {C,M} | |<-------------------200 OK------| 924 {M,C} | |---------------------ACK------->| 925 | |<====================RTP=======>| 927 Figure 5 - Single Focus WebEx Conference 929 General operation of this example: 931 o Alice communicates with WebEx server with desire to join a 932 certain meeting, by meeting number; also includes UA-Alice's 933 contact information (phone number, URI and/or IP address, etc.) 934 for each device she wants for this conference call. For 935 example, the audio and video play-out devices could be separate 936 units. 938 o Conference Focus server sends INVITE (Session-ID header-value 939 "local-uuid" = M and a remote UUID of N, where M equals the 940 "local-uuid" for each participant on this conference bridge) to 941 UA-Alice to start session with that server for this A/V 942 conference call. 944 o Upon receiving the INVITE request from the conference focus 945 server, Alice responds with a 200 OK. Her UA moves the "local- 946 uuid" unchanged into the "remote-uuid" field, and generates her 947 own UUID and places that into the "local-uuid" field to 948 complete the Session-ID construction. 950 o Bob and Carol perform same function to join this same A/V 951 conference call as Alice. 953 9.6. Cascading Conference Bridges 955 9.6.1. Establishing a Cascaded Conference 957 To expand conferencing capabilities requires cascading conference 958 bridges. A conference bridge, or MCU, needs a way to identify itself 959 when contacting another MCU. RFC 4579 [RFC4579] defines the 'isfocus' 960 Contact: header parameter just for this purpose. 962 Session-ID 963 --- MCU-1 MCU-2 MCU-3 MCU-4 964 | | | | 965 {M',N} |----INVITE----->| | | 966 {J,M'} |<---200 OK------| | | 967 {M',J} |-----ACK------->| | | 969 Figure 6 - MCUs Communicating Session Identifier UUID for Bridge 971 Regardless of which MCU (1 or 2) a UA contacts for this conference, 972 once the above exchange has been received and acknowledged, the UA 973 will get the same {M',N} UUID pair from the MCU for the complete 974 Session Identifier. 976 A more complex form would be a series of MCUs all being informed of 977 the same UUID to use for a specific conference. This series of MCUs 978 can either be informed 980 o All by one MCU (that initially generates the UUID for the 981 conference). 983 o The MCU that generates the UUID informs one or several MCUs of 984 this common UUID, and they inform downstream MCUs of this 985 common UUID that each will be using for this one conference. 987 Session-ID 988 --- MCU-1 MCU-2 MCU-3 MCU-4 989 | | | | 990 {M',N} |----INVITE----->| | | 991 {J,M'} |<---200 OK------| | | 992 {M',J} |-----ACK------->| | | 993 | | | | 994 {M',N} |---------------------INVITE----->| | 995 {K,M'} |<--------------------200 OK------| | 996 {M',K} |----------------------ACK------->| | 997 | | | | 998 {M',N} |-------------------------------------INVITE----->| 999 {L,M'} |<------------------------------------200 OK------| 1000 {M',L} |--------------------------------------ACK------->| 1002 Figure 7 - MCU Communicating Session Identifier UUID to More than 1003 One MCU 1005 General operation of this example: 1007 o The MCU generating the Session Identifier UUID communicates 1008 this in a separate INVITE, having a Contact header with the 1009 'isfocus' header parameter. This will identify the MCU as what 1010 RFC 4579 calls a conference-aware SIP entity. 1012 o An MCU that receives this {M',N} UUID pair in an inter-MCU 1013 transaction can communicate the M' UUID in a manner in which it 1014 was received to construct a hierarchical cascade (though this 1015 time this second MCU would be the UAC MCU). 1017 o Once the conference is terminated, the cascaded MCUs will 1018 receive a BYE message to terminate the cascade. 1020 9.6.2. Calling into Cascaded Conference Bridges 1022 Here is an example of how a UA, say Robert, calls into a cascaded 1023 conference focus. Because MCU-1 has already contacted MCU-3, the MCU 1024 where Robert is going to join the conference, MCU-3 already has the 1025 Session-ID (M') for this particular conference call. 1027 Session-ID 1028 --- MCU-1 MCU-2 MCU-3 Robert 1029 | | | | 1030 {M',N} |----INVITE----->| | | 1031 {J,M'} |<---200 OK------| | | 1032 {M',J} |-----ACK------->| | | 1033 | | | | 1034 {M',N} |---------------------INVITE----->| | 1035 {K,M'} |<--------------------200 OK------| | 1036 {M',K} |----------------------ACK------->| | 1037 | | | | 1039 {R,N} | | |<---INVITE-----| 1040 (M',R} | | |----200 OK---->| 1041 {R,M'} | | |<----ACK-------| 1043 Figure 8 - A UA Calling into a Cascaded MCU UUID 1045 General operation of this example: 1047 o The UA, Robert in this case, INVITEs the MCU to join a 1048 particular conference call. Robert's UA does not know anything 1049 about whether this is the main MCU of the conference call, or a 1050 cascaded MCU. Robert likely does not know MCUs can be cascaded, 1051 he just wants to join a particular call. Like as with any 1052 standard implementation, he includes a null "remote-uuid". 1054 o The cascaded MCU, upon receiving this INVITE from Robert, 1055 replaces the null UUID with the UUID value communicated from 1056 MCU-1 for this conference call as the "local-uuid" in the SIP 1057 response. Thus, moving Robert's UUID "R" to the "remote-uuid" 1058 value. 1060 o The ACK has the Session-ID {R,M'}, completing the 3-way 1061 handshake for this call establishment. Robert has now joined 1062 the conference call originated from MCU-1. 1064 o Once the conference is terminated, the cascaded MCUs will 1065 receive a BYE message to terminate the cascade. 1067 9.7. Basic 3PCC for two UAs 1069 External entity sets up call to both Alice and Bob for them to talk 1070 to each other. 1072 Session-ID 1073 --- Alice B2BUA Bob Carol 1074 | | | 1075 {X,N} |<----INVITE-----| | 1076 {A,X} |-----200 OK---->| | 1077 {A,N} | |----INVITE----->| 1078 {B,A} | |<---200 OK------| 1079 {B,A} |<-----ACK-------| | 1080 {A,B} | |------ACK------>| 1081 |<==============RTP==============>| 1083 Figure 9 - 3PCC initiated call between Alice and Bob 1085 General operation of this example: 1087 o Some out of band procedure directs a B2BUA (or other SIP 1088 server) to have Alice and Bob talk to each other. In this case, 1089 the SIP server MUST be transaction stateful, if not dialog 1090 stateful. 1092 o The SIP server INVITEs Alice to a session and uses a temporary 1093 UUID {X} and a null UUID pairing. 1095 o Alice receives and accepts this call set-up and replaces the 1096 null UUID with her UUID {A} in the Session Identifier, now 1097 {A,X}. 1099 o The transaction stateful SIP server receives Alice's UUID {A} 1100 in the local UUID portion and keeps it there, and discards its 1101 own UUID {X}, replacing this with a null UUID value in the 1102 INVITE to Bob as if this came from Alice originally. 1104 o Bob receives and accepts this INVITE and adds his own UUID {B} 1105 to the Session Identifier, now {B,A} for the response. 1107 o And the session is established. 1109 9.8. Handling in 100 Trying SIP Response and CANCEL Request 1111 The following two subsections show examples of the Session Identifier 1112 for a 100 Trying response and a CANCEL request in a single call-flow. 1114 9.8.1. Handling in a 100 Trying SIP Response 1116 The following 100 Trying response is taken from an existing RFC, from 1117 [RFC5359] Section 2.9 ("Call Forwarding - No Answer"). 1119 Session-ID Alice SIP Server Bob-1 Bob-2 1120 | | | | 1121 {A,N} |----INVITE----->| | | 1122 {A,N} | |---INVITE---->| | 1123 {N,A} |<--100 Trying---| | | 1124 {B1,A} | |<-180 Ringing-| | 1125 {B1,A} |<--180 Ringing--| | | 1126 | | | | 1127 | *Request Timeout* | 1128 | | | | 1129 {A,N} | |---CANCEL---->| | 1130 {B1,A} | |<--200 OK-----| | 1131 {B1,A} | |<---487-------| | 1132 {A,B1} | |---- ACK ---->| | 1133 | | | | 1134 {N,A} |<-181 Call Fwd--| | | 1135 | | | | 1136 {A,N} | |------------------INVITE------>| 1137 {B2,A} | |<----------------180 Ringing---| 1138 {B2,A} |<-180 Ringing---| | | 1139 {B2,A} | |<-----------------200 OK ------| 1140 {B2,A} |<--200 OK-------| | | 1141 {A,B2} |----ACK-------->| | | 1142 {A,B2} | |------------------ACK--------->| 1143 | | | | 1144 |<=========== Both way RTP Established =========>| 1145 | | | | 1146 {A,B2} |----BYE-------->| | | 1147 {A,B2} | |--------------------BYE------->| 1148 {B2,A} | |<------------------200 OK------| 1149 {B2,A} |<--200 OK-------| | | 1150 | | | | 1152 Figure 10 - Session Identifier in the 100 Trying and CANCEL Messaging 1154 Below is the explanatory text from RFC 5359 Section 2.9 detailing 1155 what the desired behavior is in the above call flow (i.e., what the 1156 call-flow is attempting to achieve). 1158 "Bob wants calls to B1 forwarded to B2 if B1 is not answered 1159 (information is known to the SIP server). Alice calls B1 and no 1160 one answers. The SIP server then places the call to B2." 1162 General operation of this example: 1164 o Alice generates an INVITE request because she wants to invite 1165 Bob to join her session. She creates a UUID as described in 1166 section 9.1, and places that value in the "local-uuid" field of 1167 the Session-ID header-value. Alice also generates a "remote- 1168 uuid" of null and sends this along with the "local-uuid". 1170 o The SIP server (imagine this is a B2BUA), upon receiving 1171 Alice's INVITE, generates the optional provisional response 100 1172 Trying. Since the SIP server has no knowledge Bob's UUID for 1173 his part of the Session Identifier value, it cannot include his 1174 "local-uuid". Rather, any 100 Trying response includes Alice's 1175 UUID in the "remote-uuid" portion of the Session-ID header- 1176 value with a null "local-uuid" value in the response. This is 1177 consistent with what Alice's UA expects to receive in any SIP 1178 response containing this UUID. 1180 9.8.2. Handling a CANCEL SIP Request 1182 In the same call-flow example as the 100 Trying response is a CANCEL 1183 request. Please refer to Figure 10 for the CANCEL request example. 1185 General operation of this example: 1187 o In Figure 10 above, Alice generates an INVITE with her UUID 1188 value in the Session-ID header-value. 1190 o Bob-1 responds to this INVITE with a 180 Ringing. In that 1191 response, he includes his UUID in the Session-ID header-value 1192 (i.e., {B1,A}); thus completing the Session-ID header-value for 1193 this session, even though no final response has been generated 1194 by any of Bob's UAs. 1196 o While this means that if the SIP server were to generate a SIP 1197 request within this session it could include the complete 1198 SessionID, the server sends a CANCEL and a CANCEL MUST always 1199 use the same Session-ID header value as the original INVITE. 1200 Thus, the CANCEL would have a Session Identifier with the 1201 "local-uuid" = "A", and the "remote-uuid" = "N". 1203 o As it happens with this CANCEL, the SIP server intends to 1204 invite another UA of Bob (i.e., B2) for Alice to communicate 1205 with. 1207 o In this example call-flow, taken from RFC 5359, Section 2.9, a 1208 181 (Call is being Forwarded) response is sent to Alice. Since 1209 the SIP server generated this SIP request, and has no knowledge 1210 of Bob-2's UUID value, it cannot include that value in this 1211 181. Thus, and for the exact reasons the 100 Trying including 1212 the Session Identifier value, only Alice's UUID is included in 1213 the remote-uuid field of the Session-ID header-value, with a 1214 null UUID present in the "local-uuid" field. 1216 9.9. Out-of-dialog REFER Transaction 1218 The following call-flow was extracted from Section 6.1 of [RFC5589] 1219 ("Successful Transfer"), with the only changes being the names of the 1220 UAs to maintain consistency within this document. 1222 Alice is the transferee 1223 Bob is the transferer 1224 and Carol is the transfer-target 1226 Session-ID Bob Alice Carol 1227 | | | 1228 {A,N} |<-----INVITE--------| | 1229 {B,A} |------200 OK------->| | 1230 {A,B} |<------ACK----------| | 1231 | | | 1232 {B,A} |--INVITE {hold}---->| | 1233 {A,B} |<-200 OK------------| | 1234 {B,A} |--- ACK ----------->| | 1235 | | | 1236 {B,A} |--REFER------------>|(Refer-To:Carol) | 1237 {A,B} |<-202 Accepted------| | 1238 | | | 1239 {A,B} || | 1241 | | | 1242 {A,N} | |--INVITE------------>| 1243 {C,A} | |<-200 OK-------------| 1244 {A,C} | |---ACK-------------->| 1245 | | | 1246 {A,B} |<--NOTIFY {200 OK}--| | 1247 {B,A} |---200 OK---------->| | 1248 | | | 1249 {B,A} |--BYE-------------->| | 1250 {A,B} |<-200 OK------------| | 1251 {C,A} | |<------------BYE-----| 1252 {A,C} | |-------------200 OK->| 1254 Figure 11: Out-Of-Dialog Call Transfer 1256 General operation of this example: 1258 o Just as in Section 9.2, Figure 2, Alice invites Bob to a 1259 session, and Bob eventually transfers Alice to communicate with 1260 Carol. 1262 o What is different about the call-flow in Figure 11 is that 1263 Bob's REFER is not in-dialog. Even so, this is treated as part 1264 of the same communication session and, thus, the Session 1265 Identifier in those messages is {A,B}. 1267 o Alice will use her existing UUID and the null UUID ({A,N}) in 1268 the INVITE towards Carol (who generates UUID "C" for this 1269 session), thus maintaining the common UUID within the Session 1270 Identifier for this new Alice-to-Carol session. 1272 10. Compatibility with a Previous Implementation 1274 There is a much earlier and proprietary document that specifies the 1275 use of a Session-ID header (namely, [RFC7329]) that we will herewith 1276 attempt to achieve backwards compatibility. Neither Session-ID 1277 header has any versioning information, so merely adding that this 1278 document describes "version 2" is insufficient. Here are the set of 1279 rules for compatibility between the two specifications. For the 1280 purposes of this discussion, we will label the proprietary 1281 specification of the Session-ID as the "old" version and this 1282 specification as the "new" version of the Session-ID. 1284 The previous (i.e., "old") version only has a single value as a 1285 Session-ID, but has a generic-parameter value that can be of use. 1287 In order to have an "old" version talk to an "old" version 1288 implementation, nothing needs to be done as far as the IETF is 1289 concerned. 1291 In order to have a "new" version talk to a "new" version 1292 implementation, both implementations need to follow this document (to 1293 the letter) and everything should be just fine. 1295 But that is where compatibility is not ensured, given the unknowns 1296 related to the behavior of entities implementing the pre-standard 1297 implementation. For this "new" implementation to work with the "old" 1298 implementation and an "old" implementation to work with "new" 1299 implementations, there needs to be a set of rules that all "new" 1300 implementations MUST follow. 1302 - Since no option tags or feature tags are to be used for 1303 distinguishing versions, the presence and order of any "remote- 1304 uuid" value within the Session-ID header value is to be used to 1305 distinguish implementation versions. 1307 - If a SIP request has a "remote-uuid" value, this comes from a 1308 standard implementation, and not a pre-standard one. 1310 - If a SIP request has no "remote-uuid" value, this comes from a pre- 1311 standard implementation, and not a standard one. In this case, one 1312 UUID is used to identify this dialog, even if the responder is a 1313 standard implementation of this specification. 1315 - If a SIP response has a non-null "local-uuid" that is 32 octets 1316 long and differs from the endpoint's own UUID value, this response 1317 comes from a standard implementation. 1319 - If a SIP response has a non-null "local-uuid" that is not 32 octets 1320 long, this response comes from a misbehaving implementation, and 1321 its Session-ID header value MUST be discarded. That said, the 1322 response might still be valid according to the rules within SIP 1323 [RFC3261], and SHOULD be checked further. 1325 - If a SIP response arrives that has the same value of Session-ID 1326 UUIDs in the same order as was sent, this comes from a pre-standard 1327 implementation, and MUST NOT be discarded for not altering the null 1328 "remote-uuid". In this case, any new transaction within this 1329 dialog MUST preserve the order of the two UUIDs within all Session- 1330 ID header-values, including the ACK, until this dialog is 1331 terminated. 1333 - If a SIP response only contains the "local-uuid" that was sent 1334 originally, this comes from a pre-standard implementation and MUST 1335 NOT be discarded for removing the null "remote-uuid". In this 1336 case, all future transactions within this dialog MUST contain only 1337 the UUID received in the first SIP response. Any new transaction 1338 starting a new dialog from the standard Session-ID implementation 1339 MUST include a "local-uuid" and a null "remote-uuid", even if that 1340 new dialog is between the same two UAs. 1342 - Standard implementations SHOULD NOT expect pre-standard 1343 implementations to be consistent in their implementation, even 1344 within the same dialog. For example, perhaps the first, third and 1345 tenth responses contain a "remote-uuid", but all the others do not. 1346 This behavior MUST be allowed by implementations of this 1347 specification. 1349 - The foregoing does not apply to other, presently unknown parameters 1350 that might be defined in the future. They are ignored for the 1351 purposes of interoperability with previous implementations. 1353 11. Security Considerations 1355 When creating a UUID value, endpoints MUST ensure that there is no 1356 user or device-identifying information contained within the UUID. In 1357 particular, this means that a UUID MUST NOT be constructed using a 1358 MAC address on the host. 1360 The Session Identifier might be utilized for logging or 1361 troubleshooting, but MUST NOT be used for billing purposes. 1363 The Session Identifier could be misused to discover relationships 1364 between two or more parties. For example, suppose that Alice calls 1365 Bob and Bob, via his PBX, forwards or transfers the call to Carol. 1366 Without use of the Session Identifier, an unauthorized third party 1367 that is observing the communications between Alice and Bob might not 1368 know that Alice is actually communicating with Carol. If Alice, Bob, 1369 and Carol include the Session Identifier as a part of the signaling 1370 messages, it is possible for the third party to observe that the 1371 endpoint associated with Bob changed to some other endpoint. If the 1372 third party also has access to signaling messages between Bob and 1373 Carol, the third party can then discover that Alice is communicating 1374 with Carol. This would be true even if all other information 1375 relating to the session is changed by the PBX, including both 1376 signaling information and media address information. 1378 12. IANA Considerations 1380 12.1. Registration of the "Session-ID" Header Field 1382 The following is the registration for the 'Session-ID' header field 1383 to the "Header Name" registry at 1384 http://www.iana.org/assignments/sip-parameters: 1386 RFC number: RFC XXXX 1388 Header name: 'Session-ID' 1390 Compact form: none 1391 Note: This document replaces the "Session-ID" header originally 1392 registered via [RFC7329]. 1394 [RFC Editor: Please replace XXXX in this section and the next with 1395 the this RFC number of this document.] 1397 12.2. Registration of the "remote" Parameter 1399 The following parameter is to be added to the "Header Field 1400 Parameters and Parameter Values" section of the SIP parameter 1401 registry: 1403 +------------------+----------------+-------------------+-----------+ 1404 | Header Field | Parameter Name | Predefined Values | Reference | 1405 +------------------+----------------+-------------------+-----------+ 1406 | Session-ID | remote | No | [RFCXXXX] | 1407 +------------------+----------------+-------------------+-----------+ 1409 13. Acknowledgments 1411 The authors would like to thank Robert Sparks, Hadriel Kaplan, 1412 Christer Holmberg, Paul Kyzivat, Brett Tate, Keith Drage, Mary 1413 Barnes, Charles Eckel, Peter Dawes, Andrew Hutton, Arun Arunachalam, 1414 Adam Gensler, Roland Jesske, and Faisal Siyavudeen for their 1415 invaluable comments during the development of this document. 1417 14. References 1419 14.1. Normative References 1421 [RFC3261] Rosenberg, J., et al., "SIP: Session Initiation 1422 Protocol", RFC 3261, June 2002. 1424 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1425 Requirement Levels", BCP 14, RFC 2119, March 1997. 1427 [RFC4122] Leach, P., Mealling, M., Salz, R., "A Universally Unique 1428 IDentifier (UUID) URN Namespace", RFC 4122, July 2005. 1430 [RFC5234] Crocker, D., Overell, P, "Augmented BNF for Syntax 1431 Specifications: ABNF", RFC 5234, January 2008. 1433 [RFC4579] Johnston, A., Levin, O., "Session Initiation Protocol 1434 (SIP) Call Control - Conferencing for User Agents", RFC 1435 4579, August 2006. 1437 [RFC3891] Mahy, R., Biggs, B., Dean, R., 'The Session Initiation 1438 Protocol (SIP) "Replaces" Header', RFC 3891, September 1439 2004. 1441 [RFC3515] Sparks, R., "The Session Initiation Protocol (SIP) Refer 1442 Method", RFC 3515, April 2003. 1444 [RFC7329] Kaplan, H., "A Session Identifier for the Session 1445 Initiation Protocol (SIP)", RFC 7329, August 2014. 1447 14.2. Informative References 1449 [H.323] Recommendation ITU-T H.323, "Packet-based multimedia 1450 communications systems", December 2009. 1452 [RFC3550] Schulzrinne, H., et al., "RTP: A Transport Protocol for 1453 Real-Time Applications", RFC 3550, July 2003. 1455 [RFC7206] Jones, et al., "Requirements for an End-to-End Session 1456 Identification in IP-Based Multimedia Communication 1457 Networks", RFC 7206, May 2014. 1459 [RFC5359] Johnston, A., et al., "Session Initiation Protocol 1460 Service Examples", RFC 5359, October 2008. 1462 [RFC5589] Sparks, R., Johnston, A., and D. Petrie, "Session 1463 Initiation Protocol (SIP) Call Control - Transfer", RFC 1464 5589, June 2009. 1466 [RFC2543] Handley, M., Schulzrinne, H., Schooler, E. and J. 1467 Rosenberg, "SIP: Session Initiation Protocol", RFC 2543, 1468 March 1999. 1470 [H.460.27] Recommendation ITU-T H.460.27, "End-to-End Session 1471 Identification", Work In Progress. 1473 Authors' Addresses 1475 Paul E. Jones (Ed.) 1476 Cisco Systems, Inc. 1477 7025 Kit Creek Rd. 1478 Research Triangle Park, NC 27709 1479 USA 1481 Phone: +1 919 476 2048 1482 Email: paulej@packetizer.com 1483 IM: xmpp:paulej@packetizer.com 1485 Chris Pearce 1486 Cisco Systems, Inc. 1487 2300 East President George Bush Highway 1488 Richardson, TX 75082 1489 USA 1491 Phone: +1 972 813 5123 1492 Email: chrep@cisco.com 1493 IM: xmpp:chrep@cisco.com 1495 James Polk (Ed.) 1496 Cisco Systems, Inc. 1497 3913 Treemont Circle 1498 Colleyville, Texas 1499 USA 1501 Phone: +1 817 271 3552 1502 Email: jmpolk@cisco.com 1503 IM: xmpp:jmpolk@cisco.com 1505 Gonzalo Salgueiro 1506 Cisco Systems, Inc. 1507 7025 Kit Creek Rd. 1508 Research Triangle Park, NC 27709 1509 USA 1511 Phone: +1 919 392 3266 1512 Email: gsalguei@cisco.com 1513 IM: xmpp:gsalguei@cisco.com