idnits 2.17.1 draft-ietf-insipid-session-id-16.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 (October 19, 2015) is 3111 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 297, but not defined == Missing Reference: 'RFCXXXX' is mentioned on line 1519, 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 3 Internet Draft G. Salgueiro 4 Intended status: Standards Track C. Pearce 5 Expires: April 19, 2016 Cisco Systems 6 October 19, 2015 8 End-to-End Session Identification in IP-Based Multimedia 9 Communication Networks 10 draft-ietf-insipid-session-id-16 12 Abstract 14 This document describes an end-to-end Session Identifier for use in 15 IP-based multimedia communication systems that enables endpoints, 16 intermediary devices, and management systems to identify a session 17 end-to-end, associate multiple endpoints with a given multipoint 18 conference, track communication sessions when they are redirected, 19 and associate one or more media flows with a given communication 20 session. 22 This document also describes a backwards compatibility mechanism for 23 an existing (RFC 7329) session identifier implementation that is 24 sufficiently different from the procedures defined in this document. 26 Status of this Memo 28 This Internet-Draft is submitted to IETF in full conformance with the 29 provisions of BCP 78 and BCP 79. 31 Internet-Drafts are working documents of the Internet Engineering 32 Task Force (IETF), its areas, and its working groups. Note that 33 other groups may also distribute working documents as Internet- 34 Drafts. 36 Internet-Drafts are draft documents valid for a maximum of six months 37 and may be updated, replaced, or obsoleted by other documents at any 38 time. It is inappropriate to use Internet-Drafts as reference 39 material or to cite them other than as "work in progress." 41 The list of current Internet-Drafts can be accessed at 42 http://www.ietf.org/ietf/1id-abstracts.txt 44 The list of Internet-Draft Shadow Directories can be accessed at 45 http://www.ietf.org/shadow.html 47 This Internet-Draft will expire on April 19, 2016. 49 Copyright Notice 51 Copyright (c) 2015 IETF Trust and the persons identified as the 52 document authors. All rights reserved. 54 This document is subject to BCP 78 and the IETF Trust's Legal 55 Provisions Relating to IETF Documents 56 (http://trustee.ietf.org/license-info) in effect on the date of 57 publication of this document. Please review these documents 58 carefully, as they describe your rights and restrictions with respect 59 to this document. Code Components extracted from this document must 60 include Simplified BSD License text as described in Section 4.e of 61 the Trust Legal Provisions and are provided without warranty as 62 described in the Simplified BSD License. 64 Table of Contents 66 1. Introduction...................................................3 67 2. Conventions used in this document..............................3 68 3. Session Identifier Requirements and Use Cases..................4 69 4. Constructing and Conveying the Session Identifier..............4 70 4.1. Constructing the Session Identifier.......................4 71 4.2. Conveying the Session Identifier..........................5 72 5. The Session-ID Header Field....................................6 73 6. Endpoint Behavior..............................................7 74 7. Processing by Intermediaries...................................9 75 8. Associating Endpoints in a Multipoint Conference..............11 76 9. Examples of Various Call Flow Operations......................12 77 9.1. Basic Call with 2 UUIDs..................................12 78 9.2. Basic Call Transfer using REFER..........................16 79 9.3. Basic Call Transfer using re-INVITE......................18 80 9.4. Single Focus Conferencing................................19 81 9.5. Single Focus Conferencing using WebEx....................21 82 9.6. Cascading Conference Bridges.............................22 83 9.6.1. Establishing a Cascaded Conference..................22 84 9.6.2. Calling into Cascaded Conference Bridges............23 85 9.7. Basic 3PCC for two UAs...................................24 86 9.8. Handling in 100 Trying SIP Response and CANCEL Request...25 87 9.8.1. Handling in a 100 Trying SIP Response...............25 88 9.8.2. Handling a CANCEL SIP Request.......................26 89 9.9. Out-of-dialog REFER Transaction..........................27 90 10. Compatibility with a Previous Implementation.................28 91 11. Security Considerations......................................30 92 12. IANA Considerations..........................................30 93 12.1. Registration of the "Session-ID" Header Field...........30 94 12.2. Registration of the "remote" Parameter..................31 95 13. Acknowledgments..............................................31 96 14. Dedication...................................................31 97 15. References...................................................31 98 15.1. Normative References....................................31 99 15.2. Informative References..................................32 101 Authors' Addresses...............................................33 103 1. Introduction 105 IP-based multimedia communication systems like SIP [RFC3261] and 106 H.323 [H.323] have the concept of a "call identifier" that is 107 globally unique. The identifier is intended to represent an end-to- 108 end communication session from the originating device to the 109 terminating device. Such an identifier is useful for 110 troubleshooting, session tracking, and so forth. 112 For several reasons, however, the current call identifiers defined in 113 SIP and H.323 are not suitable for end-to-end session identification. 114 A fundamental issue in protocol interworking is the fact that the 115 syntax for the call identifier in SIP and H.323 is different. Thus, 116 if both protocols are used in a call, it is impossible to exchange 117 the call identifier end-to-end. 119 Another reason why the current call identifiers are not suitable to 120 identify a session end-to-end is that, in real-world deployments, 121 devices like session border controllers [RFC7092] often change the 122 session signaling as it passes through the device, including the 123 value of the call identifier. While this is deliberate and useful, 124 it makes it very difficult to track a session end-to-end. 126 This document defines a new identifier for SIP referred to as the 127 Session Identifier that is intended to overcome the issues that exist 128 with the currently defined call identifiers used in SIP. The 129 procedures specified in this document attempt to comply with the 130 requirements specified in [RFC7206]. The procedures also specify 131 capabilities not mentioned in [RFC7206], shown in call flows in 132 section 9. Additionally, the specification attempts to account for a 133 previous, proprietary version of a SIP Session Identifier header 134 [RFC7329], specifying a backwards compatibility approach in section 135 10. 137 2. Conventions used in this document 139 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 140 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 141 document are to be interpreted as described in RFC 2119 [RFC2119] 142 when they appear in ALL CAPS. These words may also appear in this 143 document in lower case as plain English words, absent their normative 144 meanings. 146 The term "Session Identifier" refers to the value of the identifier, 147 whereas "Session-ID" refers to the header field used to convey the 148 identifier. The Session Identifier is a set of two Universally 149 Unique Identifiers (UUIDs) and each element of that set is simply 150 referred to herein as a UUID. 152 Throughout this document, the term "endpoint" refers to a SIP User 153 Agent (UA) that either initiates or terminates a SIP session, such as 154 a user's mobile phone or a conference server, but excludes entities 155 like B2BUAs that are generally located along the call signaling path 156 between endpoints. The term "intermediary" refers to any SIP entity 157 along the call signaling path between the aforementioned endpoints, 158 including Back-to-Back User Agents (B2BUAs) and SIP proxies. 160 3. Session Identifier Requirements and Use Cases 162 Requirements and use cases for the end-to-end Session Identifier, 163 along with a definition of "session identifier" and "communication 164 session", can be found in [RFC7206]. 166 As mentioned in section 6.1 of RFC 7206, the ITU-T undertook a 167 parallel effort to define compatible procedures for an H.323 Session 168 Identifier. They are documented in [H.460.27]. 170 4. Constructing and Conveying the Session Identifier 172 4.1. Constructing the Session Identifier 174 The Session Identifier comprises two UUIDs [RFC4122], with each UUID 175 representing one of the endpoints participating in the session. 177 The version number in the UUID indicates the manner in which the UUID 178 is generated, such as using random values or using the MAC address of 179 the endpoint. To satisfy the requirement that no user or device 180 information be conveyed, endpoints SHOULD generate version 4 (random) 181 or version 5 (SHA-1) UUIDs to address privacy concerns related to use 182 of MAC addresses in UUIDs. 184 When generating a version 5 UUID, endpoints or intermediaries MUST 185 utilize the procedures defined in Section 4.3 of [RFC4122] and employ 186 the following "name space ID": 188 uuid_t NameSpace_SessionID = { 189 /* a58587da-c93d-11e2-ae90-f4ea67801e29 */ 190 0xa58587da, 191 0xc93d, 192 0x11e2, 193 0xae, 0x90, 0xf4, 0xea, 0x67, 0x80, 0x1e, 0x29 194 } 196 Further, the "name" to utilize for version 5 UUIDs is the 197 concatenation of the Call-ID header-value and the "tag" parameter 198 that appears on the "From" or "To" line associated with the device 199 for which the UUID is created. Once an endpoint generates a UUID for 200 a session, the UUID never changes, even if values originally used as 201 input into its construction change over time. 203 Stateless intermediaries that insert a Session-ID header field into a 204 SIP message on behalf of an endpoint MUST utilize version 5 UUIDs to 205 ensure that UUIDs for the communication session are consistently 206 generated. If a stateless intermediary does not know the tag value 207 for the endpoint (e.g., a new INVITE without a To: tag value or an 208 older SIP [RFC2543] implementation that did not include a tag 209 parameter), the intermediary MUST NOT attempt to generate a UUID for 210 that endpoint. Note that if an intermediary is stateless and the 211 endpoint on one end of the call is replaced with another endpoint due 212 to some service interaction, the values used to create the UUID 213 should change and, if so, the intermediary will compute a different 214 UUID. 216 4.2. Conveying the Session Identifier 218 The SIP User Agent (UA) initially transmitting the SIP request 219 ("Alice"), i.e., a User Agent Client (UAC), will create a UUID and 220 transmit that to the ultimate destination UA ("Bob"). Likewise, the 221 destination UA ("Bob"), i.e., a User Agent Server (UAS), will create 222 a UUID and transmit that to the first UA ("Alice"). These two 223 distinct UUIDs form what is referred to as the Session Identifier and 224 is represented in this document in set notation of the form {A,B}, 225 where "A" is UUID value created by UA "Alice" and "B" is the UUID 226 value created by UA "Bob". The Session Identifier {A,B} is equal to 227 the Session Identifier {B,A}. 229 In the case where only one UUID is known, such as when a UA first 230 initiates a SIP request, the Session Identifier would be {A,N}, where 231 "A" represents the UUID value transmitted by the UA "Alice" and "N" 232 is what is referred to as the null UUID (see section 5). 234 Since SIP sessions are subject to any number of service interactions, 235 SIP INVITE messages might be forked as sessions are established, and 236 since conferences might be established or expanded with endpoints 237 calling in or the conference focus calling out, the construction of 238 the Session Identifier as a set of UUIDs is important. 240 To understand this better, consider that an endpoint participating in 241 a communication session might be replaced with another, such as the 242 case where two "legs" of a call are joined together by a PBX. 243 Suppose "Alice" and "Bob" both call UA C ("Carol"). There would be 244 two distinctly identifiable Session Identifiers, namely {A,C} and 245 {B,C}. Then suppose that "Carol" uses a local PBX function to join 246 the call between herself and "Alice" with the call between herself 247 and "Bob", resulting in a single remaining call between "Alice" and 248 "Bob". This merged call can be identified using two UUID values 249 assigned by each entity in the communication session, namely {A,B} in 250 this example. 252 In the case of forking, "Alice" might send an INVITE that gets forked 253 to several different endpoints. A means of identifying each of these 254 separate communication sessions is needed and, since each of the 255 destination UAs will create its own UUID, each communication session 256 would be uniquely identified by the values {A, B1}, {A, B2}, {A, B3}, 257 and so on, where each of the Bn values refers to the UUID created by 258 the different UAs to which the SIP session is forked. 260 For conferencing scenarios, it is also useful to have a two-part 261 Session Identifier where the conference focus specifies the same UUID 262 for each conference participant. This allows for correlation among 263 the participants in a single conference. For example, in a 264 conference with three participants, the Session Identifiers might be 265 {A,M}, {B,M}, and {C,M}, where "M" is assigned by the conference 266 focus. Only a conference focus will purposely utilize the same UUID 267 for more than one SIP session and, even then, such reuse MUST be 268 restricted to the participants in the same conference. 270 How a device acting on Session Identifiers stores, processes, or 271 utilizes the Session Identifier is outside the scope of this 272 document. 274 5. The Session-ID Header Field 276 The syntax specified here replaces the Session-ID header field syntax 277 defined in RFC 7329 [RFC7329]. 279 Each endpoint participating in a communication session has a 280 distinct, preferably locally-generated, UUID associated with it. The 281 endpoint's UUID value remains unchanged throughout the duration of 282 the communication session. An intermediary MAY generate a UUID on 283 behalf of an endpoint that did not include a UUID of its own. 285 The UUID values for each endpoint are inserted into the "Session-ID" 286 header field of all transmitted SIP messages. The Session-ID header 287 field has the following ABNF [RFC5234] syntax: 289 session-id = "Session-ID" HCOLON session-id-value 291 session-id-value = local-uuid *(SEMI sess-id-param) 293 local-uuid = sess-uuid / null 295 remote-uuid = sess-uuid / null 297 sess-uuid = 32(DIGIT / %x61-66) ;32 chars of [0-9a-f] 299 sess-id-param = remote-param / generic-param 301 remote-param = "remote" EQUAL remote-uuid 303 null = 32("0") 305 The productions "SEMI", "EQUAL", and "generic-param" are defined in 306 [RFC3261]. The production DIGIT is defined in [RFC5234]. 308 The Session-ID header field MUST NOT have more than one "remote" 309 parameter. In the case where an entity compliant with this 310 specification is interworking with an entity that implemented 311 [RFC7329], the "remote" parameter may be absent, but otherwise the 312 remote parameter MUST be present. The details under which those 313 conditions apply are described in Section 10. Except for backwards 314 compatibility with [RFC7329], the "remote" parameter MUST be present. 316 A special null UUID value composed of 32 zeros is required in certain 317 situations. A null UUID is expected as the "remote-uuid" of every 318 initial standard SIP request since the initiating endpoint would not 319 initially know the UUID value of the remote endpoint. This null 320 value will get replaced by the ultimate destination UAS when that UAS 321 generates response message. One caveat is explained in Section 10 322 for a possible backwards compatibility case. A null UUID value is 323 also returned by some intermediary devices that send provisional or 324 other responses as the "local-uuid" component of the Session-ID 325 header field value, as described in Section 7. 327 The "local-uuid" in the Session-ID header field represents the UUID 328 value of the endpoint transmitting a message and the "remote-uuid" in 329 the Session-ID header field represents the UUID of the endpoint's 330 peer. For example, a Session-ID header field might appear like this: 332 Session-ID: ab30317f1a784dc48ff824d0d3715d86; 333 remote=47755a9de7794ba387653f2099600ef2 335 While this is the general form of the Session-ID header field, 336 exceptions to syntax and procedures are detailed in subsequent 337 sections. 339 The UUID values are presented as strings of lower-case hexadecimal 340 characters, with the most significant octet of the UUID appearing 341 first. 343 The Session-ID header field value is technically case-INSENSITIVE, 344 but only lowercase characters are allowed in the sess-uuid 345 components. Receiving entities MUST treat sess-uuid components as 346 case-insensitive and not produce an error if an uppercase hexadecimal 347 character is received. 349 6. Endpoint Behavior 351 To comply with this specification, endpoints (non-intermediaries) 352 MUST include a Session-ID header field value in all SIP messages 353 transmitted as a part of a communication session. The locally- 354 generated UUID of the transmitter of the message MUST appear in the 355 "local-uuid" portion of the Session-ID header field value. The UUID 356 of the peer device, if known, MUST appear as the "remote" parameter 357 following the transmitter's UUID. The null UUID value MUST be used 358 if the peer device's UUID is not known. 360 Once an endpoint allocates a UUID value for a communication session, 361 the endpoint MUST NOT change that UUID value for the duration of the 362 session, including when 364 - communication attempts are retried due to receipt of 4xx 365 messages or request timeouts; 367 - the session is redirected in response to a 3xx message; or 369 - a session is transferred via a REFER message [RFC3515]; or 371 - a SIP dialog is replaced via an INVITE with Replaces [RFC3891]. 373 An endpoint that receives a Session-ID header field MUST take note of 374 any non-null "local-uuid" value that it receives and assume that is 375 the UUID of the peer endpoint within that communications session. 376 Endpoints MUST include this received UUID value as the "remote" 377 parameter when transmitting subsequent messages, making sure not to 378 change this UUID value in the process of moving the value internally 379 from the "local-uuid" field to the "remote-uuid" field. 381 If an endpoint receives a 3xx message, receives a REFER that directs 382 the endpoint to a different peer, or receives an INVITE with Replaces 383 that also potentially results in communicating with a new peer, the 384 endpoint MUST complete any message exchanges with its current peer 385 using the existing Session Identifier, but MUST NOT use the current 386 peer's UUID value when sending the first message to what it believes 387 may be a new peer endpoint (even if the exchange results in 388 communicating with the same physical or logical entity). The 389 endpoint MUST retain its own UUID value, however, as described above. 391 It should be noted that messages received by an endpoint might 392 contain a "local-uuid" value that does not match what the endpoint 393 expected its peer's UUID to be. It is also possible for an endpoint 394 to receive a "remote-uuid" value that does not match its generated 395 UUID for the session. Either might happen as a result of service 396 interactions by intermediaries and MUST NOT negatively affect the 397 communication session. However, the endpoint may log this event for 398 the purposes of troubleshooting. 400 An endpoint MUST assume that the UUID value of the peer endpoint MAY 401 change at any time due to service interactions. If the UUID value of 402 the peer changes, the endpoint MUST accept the new UUID as the peer's 403 UUID and include this new UUID as the "remote" parameter in any 404 subsequent messages. 406 It is also important to note that if an intermediary in the network 407 forks a session, the endpoint initiating a session may receive 408 multiple responses back from different endpoints, each of which 409 contains a different UUID ("local-uuid") value. Endpoints MUST take 410 care to ensure that the correct UUID value is returned in the 411 "remote" parameter when interacting with each endpoint. The one 412 exception is when the endpoint sends a CANCEL message, in which case 413 the Session-ID header field value MUST be identical to the Session-ID 414 header field value sent in the original INVITE. 416 If an endpoint receives a message that does not contain a Session-ID 417 header field, that message MUST have no effect on what the endpoint 418 believes is the UUID value of the remote endpoint. That is, the 419 endpoint MUST NOT change the internally maintained "remote-uuid" 420 value for the peer. 422 A Multipoint Control Unit (MCU) is a special type of conferencing 423 endpoint and is discussed in Section 8. 425 7. Processing by Intermediaries 427 The following applies only to an intermediary that wishes to comply 428 with this specification and does not impose a conformance requirement 429 on intermediaries that elect to not provide any special treatment for 430 the Session-ID header field. 432 The Call-ID often reveals personal, device, domain or other sensitive 433 information associated with a user, which is why intermediaries, such 434 as session border controllers, sometimes alter the Call-ID. In order 435 to ensure the integrity of the end-to-end Session Identifier, it is 436 constructed in a way which does not reveal such information, removing 437 the need for intermediaries to alter it. 439 When an intermediary receives messages from one endpoint in a 440 communication session that causes the transmission of one or more 441 messages toward the second endpoint in a communication session, the 442 intermediary MUST include the Session-ID header field in the 443 transmitted messages with the same UUID values found in the received 444 message, except as outlined in this section. 446 If the intermediary aggregates several responses from different 447 endpoints, as described in Section 16.7 of [RFC3261], the 448 intermediary MUST set the local-uuid field to the null UUID value 449 when forwarding the aggregated response to the endpoint since the 450 true UUID value of the peer is undetermined at that point. 452 Intermediary devices that transfer a call, such as by joining 453 together two different "call legs", MUST properly construct a 454 Session-ID header field that contains the correct UUID values and 455 correct placement of those values. As described in Section 6, the 456 endpoint receiving a message transmitted by the intermediary will 457 assume that the first UUID value belongs to its peer endpoint. 459 If an intermediary receives a SIP message from an endpoint without a 460 Session-ID header field or valid header field value, the intermediary 461 MAY assign a "local-uuid" value to represent that endpoint and, 462 having done so, MUST insert that assigned value into all signaling 463 messages on behalf of the endpoint for that dialog. In effect, the 464 intermediary becomes dialog stateful and it MUST follow the endpoint 465 procedures in Section 6 with respect to Session-ID header field value 466 treatment with itself acting as the endpoint (for the purposes of the 467 Session-ID header field) for which it inserted a component into the 468 Session-ID header field value. If the intermediary is aware of the 469 UUID value that identifies the endpoint to which a message is 470 directed, it MUST insert that UUID value into the Session-ID header 471 field value as the "remote-uuid" value. If the intermediary is 472 unaware of the UUID value that identifies the receiving endpoint, it 473 MUST use the null UUID value as the "remote-uuid" value. 475 When an intermediary originates a response, such as a provisional 476 response or a response to a CANCEL request, the "remote-uuid" field 477 will contain the UUID value of the receiving endpoint. When the UUID 478 of the peer endpoint is known, the intermediary MUST insert the UUID 479 of the peer endpoint in the "local-uuid" field of the header value. 480 Otherwise, the intermediary MAY set the "local-uuid" field of the 481 header value to the "null" UUID value. 483 When an intermediary originates a request message without first 484 having received a SIP message that triggered the transmission of the 485 message (e.g., sending a BYE message to terminate a call for policy 486 reasons), the intermediary MUST, if it has knowledge of the UUID 487 values for the two communicating endpoints, insert a Session-ID 488 header field with the "remote-uuid" field of the header value set to 489 the UUID value of the receiving endpoint and the "local-uuid" field 490 of the header value set to the UUID value of the other endpoint. 491 When the intermediary does not have knowledge of the UUID value of an 492 endpoint in the communication session, the intermediary SHOULD set 493 the unknown UUID value(s) to the "null" UUID value. (If both are 494 unknown, the Session-ID header value SHOULD NOT be included at all, 495 since it would have no practical value.) 497 With respect to the previous two paragraphs, note that if an 498 intermediary transmits a "null" UUID value, the receiving endpoint 499 might use that value in subsequent messages it sends. This 500 effectively violates the requirement of maintaining an end-to-end 501 Session Identifier value for the communication session if a UUID for 502 the peer endpoint had been previously conveyed. Therefore, an 503 intermediary MUST only send the "null" UUID when the intermediary has 504 not communicated with the peer endpoint to learn its UUID. This 505 means that intermediaries SHOULD maintain state related to the UUID 506 values for both ends of a communication session if it intends to 507 originate messages (versus merely conveying messages). An 508 intermediary that does not maintain this state and that originates a 509 message as described in the previous two paragraphs MUST NOT insert a 510 Session-ID header field in order to avoid unintended, incorrect 511 reassignment of a UUID value. 513 The Session-ID header field value included in a CANCEL request MUST 514 be identical to the Session-ID header field value included in the 515 corresponding INVITE. 517 If a SIP intermediary initiates a dialog between two endpoints in a 518 3PCC [RFC3725] scenario, the SIP request in the initial INVITE will 519 have a non-null, locally-frabricated "local-uuid" value; call this 520 temporary UUID X. The request will still have a null "remote-uuid" 521 value; call this value N. The SIP server MUST be transaction 522 stateful. The UUID pair in the INVITE will be {X,N}. A non- 523 redirected or rejected response will have a UUID pair {A,X}. This 524 transaction stateful, dialog initiating SIP server MUST replace its 525 own UUID, i.e., X, with a null UUID (i.e., {A,N}) as expected by 526 other UAS (see Section 9.7 for an example). 528 Intermediaries that manipulate messages containing a Session-ID 529 header field SHOULD be aware of what UUID values it last sent towards 530 an endpoint and, following any kind of service interaction initiated 531 or affected by the intermediary, of what UUID values the receiving 532 endpoint should have knowledge to ensure that both endpoints in the 533 session have the correct and same UUID values. If an intermediary 534 can determine that an endpoint might not have received a current, 535 correct Session-ID field, the Intermediary SHOULD attempt to provide 536 the correct Session-ID header field to the endpoint such as by 537 sending a re-INVITE message. 539 8. Associating Endpoints in a Multipoint Conference 541 Multipoint Control Units (MCUs) group two or more sessions into a 542 single multipoint conference and have a conference Focus responsible 543 for maintaining the dialogs connected to it [RFC4353]. MCUs, 544 including cascaded MCUs, MUST utilize the same UUID value ("local- 545 uuid" portion of the Session-ID header field value) with all 546 participants in the conference. In so doing, each individual session 547 in the conference will have a unique Session Identifier (since each 548 endpoint will create a unique UUID of its own), but will also have 549 one UUID in common with all other participants in the conference. 551 When creating a cascaded conference, an MCU MUST convey the UUID 552 value to utilize for a conference via the "local-uuid" portion of the 553 Session-ID header field value in an INVITE to a second MCU when using 554 SIP to establish the cascaded conference. A conference bridge, or 555 MCU, needs a way to identify itself when contacting another MCU. 556 [RFC4579] defines the "isfocus" Contact header field value parameter 557 just for this purpose. The initial MCU MUST include the UUID of that 558 particular conference in the "local-uuid" of an INVITE to the other 559 MCU(s) participating in that conference. Also included in this 560 INVITE is an "isfocus" Contact header field value parameter 561 identifying that this INVITE is coming from an MCU and that this UUID 562 is to be given out in all responses from endpoints into those MCUs 563 participating in this same conference. This ensures a single UUID is 564 common across all participating MCUs of the same conference, but is 565 unique between different conferences. 567 Intermediary devices or network diagnostics equipment might assume 568 that when they see two or more sessions with different Session 569 Identifiers, but with one UUID in common, that the sessions are part 570 of the same conference. However, the assumption that two sessions 571 having one common UUID being part of the same conference is not 572 always correct. In a SIP forking scenario, for example, there might 573 also be what appears to be multiple sessions with a shared UUID 574 value; this is intended. The desire is to allow for the association 575 of related sessions, regardless of whether a session is forked or 576 part of a conference. 578 9. Examples of Various Call Flow Operations 580 Seeing something frequently makes understanding easier. With that in 581 mind, this section includes several call flow examples with the 582 initial UUID and the complete Session Identifier indicated per 583 message, as well as when the Session Identifier changes according to 584 the rules within this document during certain operations/functions. 586 This section is for illustrative purposes only and is non-normative. 587 In the following flows, RTP refers to the Real-time Transport 588 Protocol [RFC3550]. 590 In the examples in this section, "N" represents a null UUID and other 591 letters represents the unique UUID values corresponding to endpoints 592 or MCUs. 594 9.1. Basic Call with 2 UUIDs 596 Session-ID 597 --- Alice B2BUA Bob Carol 598 {A,N} |---INVITE F1--->| | 599 {A,N} | |---INVITE F2--->| 600 {B,A} | |<---200 OK F3---| 601 {B,A} |<---200 OK F4---| | 602 {A,B} |-----ACK F5---->| | 603 {A,B} | |-----ACK F6---->| 604 |<==============RTP==============>| 606 Figure 1 - Session-ID Creation when Alice calls Bob 608 General operation of this example: 610 o UA-Alice populates the "local-uuid" portion of the Session-ID 611 header field value. 613 o UA-Alice sends its UUID in the SIP INVITE, and populates the 614 "remote" parameter with a null value (32 zeros). 616 o B2BUA receives an INVITE with both a "local-uuid" portion of 617 the Session-ID header field value from UA-Alice as well as the 618 null "remote-uuid" value, and transmits the INVITE towards UA- 619 Bob with an unchanged Session-ID header field value. 621 o UA-Bob receives Session-ID and generates its "local-uuid" 622 portion of the Session-ID header field value UUID to construct 623 the whole/complete Session-ID header field value, at the same 624 time transferring Alice's UUID unchanged to the "remote-uuid" 625 portion of the Session-ID header field value in the 200 OK SIP 626 response. 628 o B2BUA receives the 200 OK response with a complete Session-ID 629 header field value from UA-Bob, and transmits 200 OK towards 630 UA-Alice with an unchanged Session-ID header field value. 632 o UA-Alice, upon reception of the 200 OK from the B2BUA, 633 transmits the ACK towards the B2BUA. The construction of the 634 Session-ID header field in this ACK is that of Alice's UUID is 635 the "local-uuid", and Bob's UUID populates the "remote-uuid" 636 portion of the header-value. 638 o B2BUA receives the ACK with a complete Session-ID header field 639 from UA-Alice, and transmits ACK towards UA-Bob with an 640 unchanged Session-ID header field value. 642 Below is a complete SIP message exchange illustrating proper use of 643 the Session-ID header field. For the sake of brevity, non-essential 644 headers and message bodies are omitted. 646 F1 INVITE Alice -> B2BUA 648 INVITE sip:bob@biloxi.com SIP/2.0 649 Via: SIP/2.0/UDP pc33.atlanta.example.com 650 ;branch=z9hG4bK776asdhds 651 Max-Forwards: 70 652 To: Bob 653 From: Alice ;tag=1928301774 654 Call-ID: a84b4c76e66710@pc33.atlanta.example.com 655 Session-ID: ab30317f1a784dc48ff824d0d3715d86 656 ;remote=00000000000000000000000000000000 658 CSeq: 314159 INVITE 659 Contact: 660 Content-Type: application/sdp 661 Content-Length: 142 663 (Alice's SDP not shown) 665 F2 INVITE B2BUA -> Bob 667 INVITE sip:bob@192.168.10.20 SIP/2.0 668 Via: SIP/2.0/UDP server10.biloxi.example.com 669 ;branch=z9hG4bK4b43c2ff8.1 670 Via: SIP/2.0/UDP pc33.atlanta.example.com 671 ;branch=z9hG4bK776asdhds;received=10.1.3.33 672 Max-Forwards: 69 673 To: Bob 674 From: Alice ;tag=1928301774 675 Call-ID: a84b4c76e66710@pc33.atlanta.example.com 676 Session-ID: ab30317f1a784dc48ff824d0d3715d86 677 ;remote=00000000000000000000000000000000 678 CSeq: 314159 INVITE 679 Contact: 680 Record-Route: 681 Content-Type: application/sdp 682 Content-Length: 142 684 (Alice's SDP not shown) 686 F3 200 OK Bob -> B2BUA 688 SIP/2.0 200 OK 689 Via: SIP/2.0/UDP server10.biloxi.example.com 690 ;branch=z9hG4bK4b43c2ff8.1;received=192.168.10.1 691 Via: SIP/2.0/UDP pc33.atlanta.example.com 692 ;branch=z9hG4bK776asdhds;received=10.1.3.33 693 To: Bob ;tag=a6c85cf 694 From: Alice ;tag=1928301774 695 Call-ID: a84b4c76e66710@pc33.atlanta.example.com 696 Session-ID: 47755a9de7794ba387653f2099600ef2 697 ;remote=ab30317f1a784dc48ff824d0d3715d86 698 CSeq: 314159 INVITE 699 Contact: 700 Record-Route: 701 Content-Type: application/sdp 702 Content-Length: 131 704 (Bob's SDP not shown) 706 F4 200 OK B2BUA -> Alice 708 SIP/2.0 200 OK 709 Via: SIP/2.0/UDP pc33.atlanta.example.com 710 ;branch=z9hG4bK776asdhds;received=10.1.3.33 711 To: Bob ;tag=a6c85cf 712 From: Alice ;tag=1928301774 713 Call-ID: a84b4c76e66710@pc33.atlanta.example.com 714 Session-ID: 47755a9de7794ba387653f2099600ef2 715 ;remote=ab30317f1a784dc48ff824d0d3715d86 716 CSeq: 314159 INVITE 717 Contact: 718 Record-Route: 719 Content-Type: application/sdp 720 Content-Length: 131 722 (Bob's SDP not shown) 724 F5 ACK Alice -> B2BUA 726 ACK sip:bob@192.168.10.20 SIP/2.0 727 Via: SIP/2.0/UDP pc33.atlanta.example.com 728 ;branch=z9hG4bKnashds8 729 Route: 730 Max-Forwards: 70 731 To: Bob ;tag=a6c85cf 732 From: Alice ;tag=1928301774 733 Call-ID: a84b4c76e66710@pc33.atlanta.example.com 734 Session-ID: ab30317f1a784dc48ff824d0d3715d86 735 ;remote=47755a9de7794ba387653f2099600ef2 736 CSeq: 314159 ACK 737 Content-Length: 0 739 F6 ACK B2BUA -> Bob 740 ACK sip:bob@192.168.10.20 SIP/2.0 741 Via: SIP/2.0/UDP server10.biloxi.example.com 742 ;branch=z9hG4bK4b43c2ff8.2 743 Via: SIP/2.0/UDP pc33.atlanta.example.com 744 ;branch=z9hG4bKnashds8;received=10.1.3.33 745 Max-Forwards: 70 746 To: Bob ;tag=a6c85cf 747 From: Alice ;tag=1928301774 748 Call-ID: a84b4c76e66710@pc33.atlanta.example.com 749 Session-ID: ab30317f1a784dc48ff824d0d3715d86 750 ;remote=47755a9de7794ba387653f2099600ef2 751 CSeq: 314159 ACK 752 Content-Length: 0 754 The remaining examples in this Section do not display the complete 755 SIP message exchange. Instead, they simply use the set notation 756 described in Section 4.2 to show the Session Identifier exchange 757 throughout the particular call flow being illustrated. 759 9.2. Basic Call Transfer using REFER 761 From the example built within Section 9.1, we proceed to this 'Basic 762 Call Transfer using REFER' example. Note that this is a mid-dialog 763 REFER in contrast with the out-of-dialog REFER in Section 9.9. 765 Session-ID 766 --- Alice B2BUA Bob Carol 767 | | | | 768 |<==============RTP==============>| | 769 {B,A} | |<---re-INVITE---| | 770 {B,A} |<---re-INVITE---| (puts Alice on Hold) | 771 {A,B} |-----200 OK---->| | | 772 {A,B} | |-----200 OK---->| | 773 {B,A} | |<-----ACK-------| | 774 {B,A} |<-----ACK-------| | | 775 | | | | 776 {B,A} | |<----REFER------| | 777 {B,A} |<----REFER------| | | 778 {A,B} |-----200 OK---->| | | 779 {A,B} | |-----200 OK---->| | 780 {A,B} |-----NOTIFY---->| | | 781 {A,B} | |-----NOTIFY---->| | 782 {B,A} | |<----200 OK-----| | 783 {B,A} |<----200 OK-----| | | 784 | | | | 785 {A,N} |-----INVITE---->| | 786 {A,N} | |-----INVITE-------------------->| 787 {C,A} | |<----200 OK---------------------| 788 {C,A} |<----200 OK-----| | 789 {A,C} |------ACK------>| | 790 {A,C} | |------ACK---------------------->| 791 | | | | 792 |<======================RTP======================>| 793 | | | | 794 {A,B} |-----NOTIFY---->| | | 795 {A,B} | |-----NOTIFY---->| | 796 {B,A} | |<----200 OK-----| | 797 {B,A} |<----200 OK-----| | | 798 {B,A} | |<-----BYE-------| | 799 {B,A} |<-----BYE-------| | | 800 {A,B} |-----200 OK---->| | | 801 {A,B} | |-----200 OK---->| | 802 | | | | 804 Figure 2 - Call Transfer using REFER 806 General operation of this example: 808 Starting from the existing Alice/Bob call described in Figure 1 of 809 this document, which established an existing Session-ID header field 810 value: 812 o UA-Bob requests Alice to call Carol, using a REFER transaction, 813 as described in [RFC3515]. UA-Alice is initially put on hold, 814 then told in the REFER who to contact with a new INVITE, in 815 this case UA-Carol. This Alice-to-Carol dialog will have a new 816 Call-ID, therefore it requires a new Session-ID header field 817 value. The wrinkle here is we can, and will, use Alice's UUID 818 from her existing dialog with Bob in the new INVITE to Carol. 820 o UA-Alice retains her UUID from the Alice-to-Bob call {A} when 821 requesting a call with UA-Carol. This is placed in the "local- 822 uuid" portion of the Session-ID header field value, at the same 823 time inserting a null "remote-uuid" value (because Carol's UA 824 has not yet received the UUID value). This same UUID traverses 825 the B2BUA unchanged. 827 o UA-Carol receives the INVITE with a Session Identifier UUID 828 {A,N}, replaces the A UUID value into the "remote-uuid" portion 829 of the Session-ID header field value and creates its own UUID 830 {C} and places this value in the "local-uuid" portion of the 831 Session-ID header field value, thereby removing the N (null) 832 value altogether. This combination forms a full Session 833 Identifier {C,A} in the 200 OK to the INVITE. This Session-ID 834 header field traverses the B2BUA unchanged towards UA-Alice. 836 o UA-Alice receives the 200 OK with the Session Identifier {C,A} 837 and responds to UA-Carol with an ACK (just as in Figure 1 - 838 switches places of the two UUID fields), and generates a NOTIFY 839 to Bob with a Session Identifier {A,B} indicating the call 840 transfer was successful. 842 o It does not matter which UA terminates the Alice-to-Bob call; 843 Figure 2 shows UA-Bob doing this transaction. 845 9.3. Basic Call Transfer using re-INVITE 847 From the example built within Section 9.1, we proceed to this 'Basic 848 Call Transfer using re-INVITE' example. 850 Alice is talking to Bob. Bob pushes a button on his phone to transfer 851 Alice to Carol via the B2BUA (using re-INVITE). 853 Session-ID 854 --- Alice B2BUA Bob Carol 855 | | | | 856 |<==============RTP==============>| | 857 | | | | 858 | | <--- (non-standard signaling) | 859 {A,B} | |---re-INVITE--->| | 860 {B,A} | |<-----200 OK----| | 861 {B,A} | |-----ACK------->| | 862 | | | | 863 {A,N} | |-----INVITE-------------------->| 864 {C,A} | |<----200 OK---------------------| 865 {A,C} | |------ACK---------------------->| 866 | | | | 867 |<======================RTP======================>| 868 | | | | 869 {A,B} | |------BYE------>| | 870 {B,A} | |<----200 OK-----| | 871 | | | | 872 | (Suppose Alice modifies the session) | 873 {A,B} |---re-INVITE--->| | | 874 {A,B} | |---re-INVITE------------------->| 875 {C,A} | |<---200 OK----------------------| 876 {C,A} |<---200 OK------| | | 877 {A,C} |------ACK------>| | | 878 {A,C} | |------ACK---------------------->| 879 | | | | 881 Figure 3 - Call transfer using re-INVITE 883 General operation of this example: 885 o We assume the call between Alice and Bob from Section 9.1 is 886 operational with Session Identifier {A,B}. 888 o Bob uses non-standard signaling to the B2BUA to initiate a call 889 transfer from Alice to Carol. This could also be initiated via 890 a REFER message from Bob, but the signaling that follows might 891 still be similar to the above flow. In either case, Alice is 892 completely unaware of the call transfer until a future point in 893 time when Alice receives a message from Carol. 895 o The B2BUA sends a new INVITE with Alice's UUID {"local-uuid" = 896 "A"} to Carol. 898 o Carol receives the INVITE and accepts the request and adds her 899 UUID {C} to the Session Identifier for this session {"local- 900 uuid" = "C", "remote-uuid" = "A"}. 902 o The B2BUA then terminates the call to Bob with a BYE using the 903 Session Identifier {"local-uuid" = "A", "remote-uuid" = "B"}. 905 o Since Alice never received Carol's UUID from the B2BUA, when 906 Alice later attempts to modify the session with a re-INVITE, 907 Alice would send the "remote-uuid" = "B" toward Carol. Carol 908 replies with the "local-uuid" = "A", "remote-uuid" = "A" to 909 reflect what was received in the INVITE (which Carol already 910 knew from previous exchanges with the B2BUA). Alice then 911 includes "remote-uuid" = "C" in the following ACK message. 913 9.4. Single Focus Conferencing 915 Multiple users call into a conference server (say, an MCU) to attend 916 one of many conferences hosted on or managed by that server. Each 917 user has to identify which conference they want to join, but this 918 information is not necessarily in the SIP messaging. It might be 919 done by having a dedicated address for the conference or via an IVR, 920 as assumed in this example and depicted with the use of M1, M2, and 921 M3. Each user in this example goes through a two-step process of 922 signaling to gain entry onto their conference call, which the 923 conference focus identifies as M'. 925 Session-ID Conference 926 --- Alice Focus Bob Carol 927 | | | | 928 | | | | 929 {A,N} |----INVITE----->| | | 930 {M1,A} |<---200 OK------| | | 931 {A,M1} |-----ACK------->| | | 932 |<====RTP=======>| | | 933 {M',A} |<---re-INVITE---| | | 934 {A,M'} |-----200 OK---->| | | 935 {M',A} |<-----ACK-------| | | 936 | | | | 937 | | | | 938 {B,N} | |<----INVITE-----| | 939 {M2,B} | |-----200 OK---->| | 940 {B,M2} | |<-----ACK-------| | 941 | |<=====RTP======>| | 942 {M',B} | |---re-INVITE--->| | 943 {B,M'} | |<----200 OK-----| | 944 {M',B} | |------ACK------>| | 945 | | | | 946 | | | | 947 {C,N} | |<--------------------INVITE-----| 948 {M3,C} | |---------------------200 OK---->| 949 {C,M3} | |<---------------------ACK-------| 950 | |<=====================RTP======>| 951 {M',C} | |-------------------re-INVITE--->| 952 {C,M'} | |<--------------------200 OK-----| 953 {M',C} | |----------------------ACK------>| 955 Figure 4 - Single Focus Conference Bridge 957 General operation of this example: 959 Alice calls into a conference server to attend a certain conference. 960 This is a two-step operation since Alice cannot include the 961 conference ID at this time and/or any passcode in the INVITE request. 962 The first step is Alice's UA calling another UA to participate in a 963 session. This will appear to be similar as the call-flow in Figure 1 964 (in section 9.1). What is unique about this call is the second step: 965 the conference server sends a re-INVITE request with its second UUID, 966 but maintaining the UUID Alice sent in the first INVITE. This 967 subsequent UUID from the conference server will be the same for each 968 UA that calls into this conference server participating in this same 969 conference bridge/call, which is generated once Alice typically 970 authenticates and identifies which bridge she wants to participate 971 on. 973 o Alice sends an INVITE to the conference server with her UUID 974 {A} and a "remote-uuid" = N. 976 o The conference server responds with a 200 OK response which 977 replaces the N UUID with a temporary UUID ("M1") as the "local- 978 uuid" and a "remote-uuid" = "A". 980 NOTE: this 'temporary' UUID is a real UUID; it is only temporary 981 to the conference server because it knows that it is going to 982 generate another UUID to replace the one just send in the 200 OK. 984 o Once Alice, the user, gains access to the IVR for this 985 conference server, she enters a specific conference ID and 986 whatever passcode (if needed) to enter a specific conference 987 call. 989 o Once the conference server is satisfied Alice has identified 990 which conference she wants to attend (including any passcode 991 verification), the conference server re-INVITEs Alice to the 992 specific conference and includes the Session-ID header field 993 value component "local-uuid" = "M'" (and "remote-uuid" = "A") 994 for that conference. All valid participants in the same 995 conference will receive this same UUID for identification 996 purposes and to better enable monitoring, and tracking 997 functions. 999 o Bob goes through this two-step process of an INVITE 1000 transaction, followed by a re-INVITE transaction to get this 1001 same UUID ("M'") for that conference. 1003 o In this example, Carol (and each additional user) goes through 1004 the same procedures and steps as Alice and Bob to get on this 1005 same conference. 1007 9.5. Single Focus Conferencing using WebEx 1009 Alice, Bob and Carol call into same WebEx conference. 1011 Session-ID Conference 1012 --- Alice Focus Bob Carol 1013 | | | | 1014 |<** HTTPS *****>| | | 1015 | Transaction | | | 1016 | | | | 1017 {M,N} |<----INVITE-----| | | 1018 {A,M} |-----200 OK---->| | | 1019 {M,A} |<-----ACK-------| | | 1020 |<=====RTP======>| | | 1021 | | | | 1022 | |<** HTTPS *****>| | 1023 | | Transaction | | 1024 | | | | 1025 {M,N} | |-----INVITE---->| | 1026 {B,M} | |<----200 OK-----| | 1027 {M,B} | |------ACK------>| | 1028 | |<=====RTP======>| | 1029 | | | | 1030 | |<****************** HTTPS *****>| 1031 | | Transaction | 1032 | | | | 1033 {M,N} | |--------------------INVITE----->| 1034 {C,M} | |<-------------------200 OK------| 1035 {M,C} | |---------------------ACK------->| 1036 | |<====================RTP=======>| 1038 Figure 5 - Single Focus WebEx Conference 1040 General operation of this example: 1042 o Alice communicates with WebEx server with desire to join a 1043 certain meeting, by meeting number; also includes UA-Alice's 1044 contact information (phone number, URI and/or IP address, etc.) 1045 for each device she wants for this conference call. For 1046 example, the audio and video play-out devices could be separate 1047 units. 1049 o Conference Focus server sends INVITE (Session-ID header field 1050 value components "local-uuid" = M and a remote UUID of N, where 1051 M equals the "local-uuid" for each participant on this 1052 conference bridge) to UA-Alice to start session with that 1053 server for this A/V conference call. 1055 o Upon receiving the INVITE request from the conference focus 1056 server, Alice responds with a 200 OK. Her UA moves the "local- 1057 uuid" unchanged into the "remote-uuid" field, and generates her 1058 own UUID and places that into the "local-uuid" field to 1059 complete the Session-ID construction. 1061 o Bob and Carol perform same function to join this same A/V 1062 conference call as Alice. 1064 9.6. Cascading Conference Bridges 1066 9.6.1. Establishing a Cascaded Conference 1068 To expand conferencing capabilities requires cascading conference 1069 bridges. A conference bridge, or MCU, needs a way to identify itself 1070 when contacting another MCU. RFC 4579 [RFC4579] defines the 'isfocus' 1071 Contact: header parameter just for this purpose. 1073 Session-ID 1074 --- MCU-1 MCU-2 MCU-3 MCU-4 1075 | | | | 1076 {M',N} |----INVITE----->| | | 1077 {J,M'} |<---200 OK------| | | 1078 {M',J} |-----ACK------->| | | 1080 Figure 6 - MCUs Communicating Session Identifier UUID for Bridge 1082 Regardless of which MCU (1 or 2) a UA contacts for this conference, 1083 once the above exchange has been received and acknowledged, the UA 1084 will get the same {M',N} UUID pair from the MCU for the complete 1085 Session Identifier. 1087 A more complex form would be a series of MCUs all being informed of 1088 the same UUID to use for a specific conference. This series of MCUs 1089 can either be informed 1091 o All by one MCU (that initially generates the UUID for the 1092 conference). 1094 o The MCU that generates the UUID informs one or several MCUs of 1095 this common UUID, and they inform downstream MCUs of this 1096 common UUID that each will be using for this one conference. 1098 Session-ID 1099 --- MCU-1 MCU-2 MCU-3 MCU-4 1100 | | | | 1101 {M',N} |----INVITE----->| | | 1102 {J,M'} |<---200 OK------| | | 1103 {M',J} |-----ACK------->| | | 1104 | | | | 1105 {M',N} |---------------------INVITE----->| | 1106 {K,M'} |<--------------------200 OK------| | 1107 {M',K} |----------------------ACK------->| | 1108 | | | | 1109 {M',N} |-------------------------------------INVITE----->| 1110 {L,M'} |<------------------------------------200 OK------| 1111 {M',L} |--------------------------------------ACK------->| 1113 Figure 7 - MCU Communicating Session Identifier UUID to More than 1114 One MCU 1116 General operation of this example: 1118 o The MCU generating the Session Identifier UUID communicates 1119 this in a separate INVITE, having a Contact header with the 1120 'isfocus' header parameter. This will identify the MCU as what 1121 RFC 4579 calls a conference-aware SIP entity. 1123 o An MCU that receives this {M',N} UUID pair in an inter-MCU 1124 transaction can communicate the M' UUID in a manner in which it 1125 was received to construct a hierarchical cascade (though this 1126 time this second MCU would be the UAC MCU). 1128 o Once the conference is terminated, the cascaded MCUs will 1129 receive a BYE message to terminate the cascade. 1131 9.6.2. Calling into Cascaded Conference Bridges 1133 Here is an example of how a UA, say Robert, calls into a cascaded 1134 conference focus. Because MCU-1 has already contacted MCU-3, the MCU 1135 where Robert is going to join the conference, MCU-3 already has the 1136 Session-ID (M') for this particular conference call. 1138 Session-ID 1139 --- MCU-1 MCU-2 MCU-3 Robert 1140 | | | | 1141 {M',N} |----INVITE----->| | | 1142 {J,M'} |<---200 OK------| | | 1143 {M',J} |-----ACK------->| | | 1144 | | | | 1146 {M',N} |---------------------INVITE----->| | 1147 {K,M'} |<--------------------200 OK------| | 1148 {M',K} |----------------------ACK------->| | 1149 | | | | 1150 {R,N} | | |<---INVITE-----| 1151 (M',R} | | |----200 OK---->| 1152 {R,M'} | | |<----ACK-------| 1154 Figure 8 - A UA Calling into a Cascaded MCU UUID 1156 General operation of this example: 1158 o The UA, Robert in this case, INVITEs the MCU to join a 1159 particular conference call. Robert's UA does not know anything 1160 about whether this is the main MCU of the conference call, or a 1161 cascaded MCU. Robert likely does not know MCUs can be cascaded, 1162 he just wants to join a particular call. Like as with any 1163 standard implementation, he includes a null "remote-uuid". 1165 o The cascaded MCU, upon receiving this INVITE from Robert, 1166 replaces the null UUID with the UUID value communicated from 1167 MCU-1 for this conference call as the "local-uuid" in the SIP 1168 response. Thus, moving Robert's UUID "R" to the "remote-uuid" 1169 value. 1171 o The ACK has the Session-ID {R,M'}, completing the 3-way 1172 handshake for this call establishment. Robert has now joined 1173 the conference call originated from MCU-1. 1175 o Once the conference is terminated, the cascaded MCUs will 1176 receive a BYE message to terminate the cascade. 1178 9.7. Basic 3PCC for two UAs 1180 External entity sets up call to both Alice and Bob for them to talk 1181 to each other. 1183 Session-ID 1184 --- Alice B2BUA Bob Carol 1185 | | | 1186 {X,N} |<----INVITE-----| | 1187 {A,X} |-----200 OK---->| | 1188 {A,N} | |----INVITE----->| 1189 {B,A} | |<---200 OK------| 1190 {B,A} |<-----ACK-------| | 1191 {A,B} | |------ACK------>| 1192 |<==============RTP==============>| 1194 Figure 9 - 3PCC initiated call between Alice and Bob 1196 General operation of this example: 1198 o Some out of band procedure directs a B2BUA (or other SIP 1199 server) to have Alice and Bob talk to each other. In this case, 1200 the SIP server has to be transaction stateful, if not dialog 1201 stateful. 1203 o The SIP server INVITEs Alice to a session and uses a temporary 1204 UUID {X} and a null UUID pairing. 1206 o Alice receives and accepts this call set-up and replaces the 1207 null UUID with her UUID {A} in the Session Identifier, now 1208 {A,X}. 1210 o The transaction stateful SIP server receives Alice's UUID {A} 1211 in the local UUID portion and keeps it there, and discards its 1212 own UUID {X}, replacing this with a null UUID value in the 1213 INVITE to Bob as if this came from Alice originally. 1215 o Bob receives and accepts this INVITE and adds his own UUID {B} 1216 to the Session Identifier, now {B,A} for the response. 1218 o And the session is established. 1220 9.8. Handling in 100 Trying SIP Response and CANCEL Request 1222 The following two subsections show examples of the Session Identifier 1223 for a 100 Trying response and a CANCEL request in a single call-flow. 1225 9.8.1. Handling in a 100 Trying SIP Response 1227 The following 100 Trying response is taken from an existing RFC, from 1228 [RFC5359] Section 2.9 ("Call Forwarding - No Answer"). 1230 Session-ID Alice SIP Server Bob-1 Bob-2 1231 | | | | 1232 {A,N} |----INVITE----->| | | 1233 {A,N} | |---INVITE---->| | 1234 {N,A} |<--100 Trying---| | | 1235 {B1,A} | |<-180 Ringing-| | 1236 {B1,A} |<--180 Ringing--| | | 1237 | | | | 1238 | *Request Timeout* | 1239 | | | | 1240 {A,N} | |---CANCEL---->| | 1241 {B1,A} | |<--200 OK-----| | 1242 {B1,A} | |<---487-------| | 1243 {A,B1} | |---- ACK ---->| | 1244 | | | | 1245 {N,A} |<-181 Call Fwd--| | | 1246 | | | | 1247 {A,N} | |------------------INVITE------>| 1248 {B2,A} | |<----------------180 Ringing---| 1249 {B2,A} |<-180 Ringing---| | | 1250 {B2,A} | |<-----------------200 OK ------| 1251 {B2,A} |<--200 OK-------| | | 1252 {A,B2} |----ACK-------->| | | 1253 {A,B2} | |------------------ACK--------->| 1254 | | | | 1255 |<=========== Both way RTP Established =========>| 1256 | | | | 1257 {A,B2} |----BYE-------->| | | 1258 {A,B2} | |--------------------BYE------->| 1259 {B2,A} | |<------------------200 OK------| 1260 {B2,A} |<--200 OK-------| | | 1261 | | | | 1263 Figure 10 - Session Identifier in the 100 Trying and CANCEL Messaging 1265 Below is the explanatory text from RFC 5359 Section 2.9 detailing 1266 what the desired behavior is in the above call flow (i.e., what the 1267 call-flow is attempting to achieve). 1269 "Bob wants calls to B1 forwarded to B2 if B1 is not answered 1270 (information is known to the SIP server). Alice calls B1 and no 1271 one answers. The SIP server then places the call to B2." 1273 General operation of this example: 1275 o Alice generates an INVITE request because she wants to invite 1276 Bob to join her session. She creates a UUID as described in 1277 section 9.1, and places that value in the "local-uuid" field of 1278 the Session-ID header field value. Alice also generates a 1279 "remote-uuid" of null and sends this along with the "local- 1280 uuid". 1282 o The SIP server (imagine this is a B2BUA), upon receiving 1283 Alice's INVITE, generates the optional provisional response 100 1284 Trying. Since the SIP server has no knowledge Bob's UUID for 1285 his part of the Session Identifier value, it cannot include his 1286 "local-uuid". Rather, any 100 Trying response includes Alice's 1287 UUID in the "remote-uuid" portion of the Session-ID header- 1288 value with a null "local-uuid" value in the response. This is 1289 consistent with what Alice's UA expects to receive in any SIP 1290 response containing this UUID. 1292 9.8.2. Handling a CANCEL SIP Request 1294 In the same call-flow example as the 100 Trying response is a CANCEL 1295 request. Please refer to Figure 10 for the CANCEL request example. 1297 General operation of this example: 1299 o In Figure 10 above, Alice generates an INVITE with her UUID 1300 value in the Session-ID header field. 1302 o Bob-1 responds to this INVITE with a 180 Ringing. In that 1303 response, he includes his UUID in the Session-ID header field 1304 value (i.e., {B1,A}); thus completing the Session-ID header 1305 field for this session, even though no final response has been 1306 generated by any of Bob's UAs. 1308 o While this means that if the SIP server were to generate a SIP 1309 request within this session it could include the complete 1310 SessionID, the server sends a CANCEL and a CANCEL always uses 1311 the same Session-ID header field as the original INVITE. Thus, 1312 the CANCEL would have a Session Identifier with the "local- 1313 uuid" = "A", and the "remote-uuid" = "N". 1315 o As it happens with this CANCEL, the SIP server intends to 1316 invite another UA of Bob (i.e., B2) for Alice to communicate 1317 with. 1319 o In this example call-flow, taken from RFC 5359, Section 2.9, a 1320 181 (Call is being Forwarded) response is sent to Alice. Since 1321 the SIP server generated this SIP request, and has no knowledge 1322 of Bob-2's UUID value, it cannot include that value in this 1323 181. Thus, and for the exact reasons the 100 Trying including 1324 the Session Identifier value, only Alice's UUID is included in 1325 the remote-uuid component of the Session-ID header field value, 1326 with a null UUID present in the "local-uuid" component. 1328 9.9. Out-of-dialog REFER Transaction 1330 The following call-flow was extracted from Section 6.1 of [RFC5589] 1331 ("Successful Transfer"), with the only changes being the names of the 1332 UAs to maintain consistency within this document. 1334 Alice is the transferee 1335 Bob is the transferer 1336 and Carol is the transfer-target 1338 Session-ID Bob Alice Carol 1339 | | | 1340 {A,N} |<-----INVITE--------| | 1341 {B,A} |------200 OK------->| | 1342 {A,B} |<------ACK----------| | 1343 | | | 1344 {B,A} |--INVITE {hold}---->| | 1345 {A,B} |<-200 OK------------| | 1346 {B,A} |--- ACK ----------->| | 1347 | | | 1348 {B,A} |--REFER------------>|(Refer-To:Carol) | 1349 {A,B} |<-202 Accepted------| | 1350 | | | 1351 {A,B} || | 1353 | | | 1354 {A,N} | |--INVITE------------>| 1355 {C,A} | |<-200 OK-------------| 1356 {A,C} | |---ACK-------------->| 1357 | | | 1358 {A,B} |<--NOTIFY {200 OK}--| | 1359 {B,A} |---200 OK---------->| | 1360 | | | 1361 {B,A} |--BYE-------------->| | 1362 {A,B} |<-200 OK------------| | 1363 {C,A} | |<------------BYE-----| 1364 {A,C} | |-------------200 OK->| 1366 Figure 11: Out-Of-Dialog Call Transfer 1368 General operation of this example: 1370 o Just as in Section 9.2, Figure 2, Alice invites Bob to a 1371 session, and Bob eventually transfers Alice to communicate with 1372 Carol. 1374 o What is different about the call-flow in Figure 11 is that 1375 Bob's REFER is not in-dialog. Even so, this is treated as part 1376 of the same communication session and, thus, the Session 1377 Identifier in those messages is {A,B}. 1379 o Alice will use her existing UUID and the null UUID ({A,N}) in 1380 the INVITE towards Carol (who generates UUID "C" for this 1381 session), thus maintaining the common UUID within the Session 1382 Identifier for this new Alice-to-Carol session. 1384 10. Compatibility with a Previous Implementation 1386 There is a much earlier and proprietary document that specifies the 1387 use of a Session-ID header field (namely, [RFC7329]) that we will 1388 herewith attempt to achieve backwards compatibility. Neither 1389 Session-ID header field has any versioning information, so merely 1390 adding that this document describes "version 2" is insufficient. 1391 Here are the set of rules for compatibility between the two 1392 specifications. For the purposes of this discussion, we will label 1393 the proprietary specification of the Session-ID as the "old" version 1394 and this specification as the "new" version of the Session-ID. 1396 The previous (i.e., "old") version only has a single UUID value as a 1397 Session-ID header field value, but has a generic-parameter value that 1398 can be of use. 1400 In order to have an "old" version talk to an "old" version 1401 implementation, nothing needs to be done as far as the IETF is 1402 concerned. 1404 In order to have a "new" version talk to a "new" version 1405 implementation, both implementations need to follow this document (to 1406 the letter) and everything should be just fine. 1408 But that is where compatibility is not ensured, given the unknowns 1409 related to the behavior of entities implementing the pre-standard 1410 implementation. For this "new" implementation to work with the "old" 1411 implementation and an "old" implementation to work with "new" 1412 implementations, there needs to be a set of rules that all "new" 1413 implementations MUST follow. 1415 - Since no option tags or feature tags are to be used for 1416 distinguishing versions, the presence and order of any "remote- 1417 uuid" value within the Session-ID header field value is to be used 1418 to distinguish implementation versions. 1420 - If a SIP request has a "remote-uuid" value, this comes from a 1421 standard implementation, and not a pre-standard one. 1423 - If a SIP request has no "remote-uuid" value, this comes from a pre- 1424 standard implementation, and not a standard one. In this case, one 1425 UUID is used to identify this dialog, even if the responder is a 1426 standard implementation of this specification. 1428 - If a SIP response has a non-null "local-uuid" that is 32 octets 1429 long and differs from the endpoint's own UUID value, this response 1430 comes from a standard implementation. 1432 - If a SIP response has a non-null "local-uuid" that is not 32 octets 1433 long, this response comes from a misbehaving implementation, and 1434 its Session-ID header field MUST be discarded. That said, the 1435 response might still be valid according to the rules within SIP 1436 [RFC3261], and SHOULD be checked further. 1438 - If a SIP response arrives that has the same value of Session-ID 1439 UUIDs in the same order as was sent, this comes from a pre-standard 1440 implementation, and MUST NOT be discarded for not altering the null 1441 "remote-uuid". In this case, any new transaction within this 1442 dialog MUST preserve the order of the two UUIDs within all Session- 1443 ID header field, including the ACK, until this dialog is 1444 terminated. 1446 - If a SIP response only contains the "local-uuid" that was sent 1447 originally, this comes from a pre-standard implementation and MUST 1448 NOT be discarded for removing the null "remote-uuid". In this 1449 case, all future transactions within this dialog MUST contain only 1450 the UUID received in the first SIP response. Any new transaction 1451 starting a new dialog from the standard Session-ID implementation 1452 MUST include a "local-uuid" and a null "remote-uuid", even if that 1453 new dialog is between the same two UAs. 1455 - Standard implementations SHOULD NOT expect pre-standard 1456 implementations to be consistent in their implementation, even 1457 within the same dialog. For example, perhaps the first, third and 1458 tenth responses contain a "remote-uuid", but all the others do not. 1459 This behavior MUST be allowed by implementations of this 1460 specification. 1462 - The foregoing does not apply to other, presently unknown parameters 1463 that might be defined in the future. They are ignored for the 1464 purposes of interoperability with previous implementations. 1466 11. Security Considerations 1468 When creating a UUID value, UAs MUST ensure that there is no user or 1469 device-identifying information contained within the UUID. In 1470 particular, this means that a UUID MUST NOT be constructed using a 1471 MAC address on the host. 1473 The Session Identifier might be utilized for logging or 1474 troubleshooting, but MUST NOT be used for billing purposes. 1476 The Session Identifier could be misused to discover relationships 1477 between two or more parties. For example, suppose that Alice calls 1478 Bob and Bob, via his PBX, forwards or transfers the call to Carol. 1479 Without use of the Session Identifier, an unauthorized third party 1480 that is observing the communications between Alice and Bob might not 1481 know that Alice is actually communicating with Carol. If Alice, Bob, 1482 and Carol include the Session Identifier as a part of the signaling 1483 messages, it is possible for the third party to observe that the UA 1484 associated with Bob changed to some other UA. If the third party 1485 also has access to signaling messages between Bob and Carol, the 1486 third party can then discover that Alice is communicating with Carol. 1487 This would be true even if all other information relating to the 1488 session is changed by the PBX, including both signaling information 1489 and media address information. 1491 12. IANA Considerations 1493 12.1. Registration of the "Session-ID" Header Field 1495 The following is the registration for the 'Session-ID' header field 1496 to the "Header Name" registry at 1497 http://www.iana.org/assignments/sip-parameters: 1499 RFC number: RFC XXXX 1501 Header name: 'Session-ID' 1502 Compact form: none 1504 Note: This document replaces the "Session-ID" header originally 1505 registered via [RFC7329]. 1507 [RFC Editor: Please replace XXXX in this section and the next with 1508 the this RFC number of this document.] 1510 12.2. Registration of the "remote" Parameter 1512 The following parameter is to be added to the "Header Field 1513 Parameters and Parameter Values" section of the SIP parameter 1514 registry: 1516 +------------------+----------------+-------------------+-----------+ 1517 | Header Field | Parameter Name | Predefined Values | Reference | 1518 +------------------+----------------+-------------------+-----------+ 1519 | Session-ID | remote | No | [RFCXXXX] | 1520 +------------------+----------------+-------------------+-----------+ 1522 13. Acknowledgments 1524 The authors would like to thank Robert Sparks, Hadriel Kaplan, 1525 Christer Holmberg, Paul Kyzivat, Brett Tate, Keith Drage, Mary 1526 Barnes, Charles Eckel, Peter Dawes, Andrew Hutton, Arun Arunachalam, 1527 Adam Gensler, Roland Jesske, and Faisal Siyavudeen for their 1528 invaluable comments during the development of this document. 1530 14. Dedication 1532 This document is dedicated to the memory of James Polk, a long-time 1533 friend and colleague. James made important contributions to this 1534 specification, including being one of its primary editors. The IETF 1535 global community mourns his loss and he will be missed dearly. 1537 15. References 1539 15.1. Normative References 1541 [RFC3261] Rosenberg, J., et al., "SIP: Session Initiation 1542 Protocol", RFC 3261, June 2002. 1544 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1545 Requirement Levels", BCP 14, RFC 2119, March 1997. 1547 [RFC4122] Leach, P., Mealling, M., Salz, R., "A Universally Unique 1548 IDentifier (UUID) URN Namespace", RFC 4122, July 2005. 1550 [RFC5234] Crocker, D., Overell, P, "Augmented BNF for Syntax 1551 Specifications: ABNF", RFC 5234, January 2008. 1553 [RFC4579] Johnston, A., Levin, O., "Session Initiation Protocol 1554 (SIP) Call Control - Conferencing for User Agents", RFC 1555 4579, August 2006. 1557 [RFC3891] Mahy, R., Biggs, B., Dean, R., 'The Session Initiation 1558 Protocol (SIP) "Replaces" Header', RFC 3891, September 1559 2004. 1561 [RFC3515] Sparks, R., "The Session Initiation Protocol (SIP) Refer 1562 Method", RFC 3515, April 2003. 1564 [RFC7329] Kaplan, H., "A Session Identifier for the Session 1565 Initiation Protocol (SIP)", RFC 7329, August 2014. 1567 15.2. Informative References 1569 [H.323] Recommendation ITU-T H.323, "Packet-based multimedia 1570 communications systems", December 2009. 1572 [RFC3550] Schulzrinne, H., et al., "RTP: A Transport Protocol for 1573 Real-Time Applications", RFC 3550, July 2003. 1575 [RFC7206] Jones, et al., "Requirements for an End-to-End Session 1576 Identification in IP-Based Multimedia Communication 1577 Networks", RFC 7206, May 2014. 1579 [RFC5359] Johnston, A., et al., "Session Initiation Protocol 1580 Service Examples", RFC 5359, October 2008. 1582 [RFC5589] Sparks, R., Johnston, A., and D. Petrie, "Session 1583 Initiation Protocol (SIP) Call Control - Transfer", RFC 1584 5589, June 2009. 1586 [RFC2543] Handley, M., Schulzrinne, H., Schooler, E. and J. 1587 Rosenberg, "SIP: Session Initiation Protocol", RFC 2543, 1588 March 1999. 1590 [H.460.27] Recommendation ITU-T H.460.27, "End-to-End Session 1591 Identifier in for H.323 Systems", Work in Progress {RFC 1592 Editor: A month and year should be available when the RFC 1593 is published}. 1595 [RFC3725] Rosenberg, J., Peterson, J., Schulzrinne, H., and G. 1596 Camarillo, "Best Current Practices for Third Party Call 1597 Control (3pcc) in the Session Initiation Protocol (SIP)", 1598 RFC 3725, April 2004. 1600 [RFC4353] Rosenberg, J., "A Framework for Conferencing with the 1601 Session Initiation Protocol (SIP)", RFC 4353, February 1602 2006. 1604 [RFC7092] Kaplan, H. and V. Pascual, "A Taxonomy of Session 1605 Initiation Protocol (SIP) Back-to-Back User Agents", RFC 1606 7092, December 2013. 1608 Authors' Addresses 1610 Paul E. Jones 1611 Cisco Systems, Inc. 1612 7025 Kit Creek Rd. 1613 Research Triangle Park, NC 27709 1614 USA 1616 Phone: +1 919 476 2048 1617 Email: paulej@packetizer.com 1618 IM: xmpp:paulej@packetizer.com 1620 Gonzalo Salgueiro 1621 Cisco Systems, Inc. 1622 7025 Kit Creek Rd. 1623 Research Triangle Park, NC 27709 1624 USA 1626 Phone: +1 919 392 3266 1627 Email: gsalguei@cisco.com 1628 IM: xmpp:gsalguei@cisco.com 1630 Chris Pearce 1631 Cisco Systems, Inc. 1632 2300 East President George Bush Highway 1633 Richardson, TX 75082 1634 USA 1636 Phone: +1 972 813 5123 1637 Email: chrep@cisco.com 1638 IM: xmpp:chrep@cisco.com