idnits 2.17.1 draft-ietf-siprec-metadata-00.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 == Line 502 has weird spacing: '... |codec param...' == Line 720 has weird spacing: '...|codec params...' == Line 822 has weird spacing: '... |codec param...' == Line 839 has weird spacing: '... |codec param...' -- The document date (April 13, 2011) is 4763 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Outdated reference: A later version (-12) exists of draft-ietf-siprec-req-09 == Outdated reference: A later version (-12) exists of draft-ietf-siprec-architecture-01 Summary: 0 errors (**), 0 flaws (~~), 7 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 SIPREC Ram Mohan. Ravindranath 2 Internet-Draft Parthasarathi. Ravindran 3 Intended status: Standards Track Paul. Kyzivat 4 Expires: October 15, 2011 Cisco Systems, Inc. 5 April 13, 2011 7 Session Initiation Protocol (SIP) Recording Metadata 8 draft-ietf-siprec-metadata-00 10 Abstract 12 Session recording is a critical requirement in many communications 13 environments such as call centers and financial trading. In some of 14 these environments, all calls must be recorded for regulatory, 15 compliance, and consumer protection reasons. Recording of a session 16 is typically performed by sending a copy of a media stream to a 17 recording device. This document describes the metadata model as 18 viewed by Session Recording Server(SRS). 20 Status of this Memo 22 This Internet-Draft is submitted in full conformance with the 23 provisions of BCP 78 and BCP 79. 25 Internet-Drafts are working documents of the Internet Engineering 26 Task Force (IETF). Note that other groups may also distribute 27 working documents as Internet-Drafts. The list of current Internet- 28 Drafts is at http://datatracker.ietf.org/drafts/current/. 30 Internet-Drafts are draft documents valid for a maximum of six months 31 and may be updated, replaced, or obsoleted by other documents at any 32 time. It is inappropriate to use Internet-Drafts as reference 33 material or to cite them other than as "work in progress." 35 This Internet-Draft will expire on October 15, 2011. 37 Copyright Notice 39 Copyright (c) 2011 IETF Trust and the persons identified as the 40 document authors. All rights reserved. 42 This document is subject to BCP 78 and the IETF Trust's Legal 43 Provisions Relating to IETF Documents 44 (http://trustee.ietf.org/license-info) in effect on the date of 45 publication of this document. Please review these documents 46 carefully, as they describe your rights and restrictions with respect 47 to this document. Code Components extracted from this document must 48 include Simplified BSD License text as described in Section 4.e of 49 the Trust Legal Provisions and are provided without warranty as 50 described in the Simplified BSD License. 52 Table of Contents 54 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 55 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3 56 3. Metadata Model . . . . . . . . . . . . . . . . . . . . . . . . 3 57 4. Recording Metadata elements . . . . . . . . . . . . . . . . . 5 58 4.1. Recording Session . . . . . . . . . . . . . . . . . . . . 5 59 4.1.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 5 60 4.1.2. Associations . . . . . . . . . . . . . . . . . . . . . 6 61 4.2. Communication Session Group . . . . . . . . . . . . . . . 6 62 4.2.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 6 63 4.2.2. Associations . . . . . . . . . . . . . . . . . . . . . 6 64 4.3. Communication Session . . . . . . . . . . . . . . . . . . 7 65 4.3.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 7 66 4.3.2. Associations . . . . . . . . . . . . . . . . . . . . . 8 67 4.4. Participant . . . . . . . . . . . . . . . . . . . . . . . 8 68 4.4.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 9 69 4.4.2. Associations . . . . . . . . . . . . . . . . . . . . . 9 70 4.5. Media Stream . . . . . . . . . . . . . . . . . . . . . . . 10 71 4.5.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 10 72 4.5.2. Associations . . . . . . . . . . . . . . . . . . . . . 11 73 4.6. Extension Data . . . . . . . . . . . . . . . . . . . . . . 11 74 5. Metadata Model Object Instances . . . . . . . . . . . . . . . 11 75 5.1. Use case 1: Basic Call . . . . . . . . . . . . . . . . . . 11 76 5.2. Use case 2: Basic Call with hold/resume . . . . . . . . . 12 77 5.3. Use case 3: Basic call with Transfer . . . . . . . . . . . 14 78 5.4. Conference Use Cases . . . . . . . . . . . . . . . . . . . 15 79 5.4.1. Case 1: . . . . . . . . . . . . . . . . . . . . . . . 16 80 5.4.2. Case 2: . . . . . . . . . . . . . . . . . . . . . . . 18 81 5.4.3. Case 3: . . . . . . . . . . . . . . . . . . . . . . . 20 82 5.4.4. Case 4: . . . . . . . . . . . . . . . . . . . . . . . 21 83 6. Security Considerations . . . . . . . . . . . . . . . . . . . 22 84 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 22 85 8. Acknowledgement . . . . . . . . . . . . . . . . . . . . . . . 22 86 9. References . . . . . . . . . . . . . . . . . . . . . . . . . . 22 87 9.1. Normative References . . . . . . . . . . . . . . . . . . . 22 88 9.2. Informative References . . . . . . . . . . . . . . . . . . 22 89 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 22 91 1. Introduction 93 Session recording is a critical requirement in many communications 94 environments such as call centers and financial trading. In some of 95 these environments, all calls must be recorded for regulatory, 96 compliance, and consumer protection reasons. Recording of a session 97 is typically performed by sending a copy of a media stream to a 98 recording device. This document focuses on the Recording metadata 99 which describes the communication session. The document describes a 100 metadata model as viewed by Session Recording Server, the 101 requirements for which are described in [I-D.ietf-siprec-req] and the 102 architecture for which is described in 103 [I-D.ietf-siprec-architecture]. 105 2. Terminology 107 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 108 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 109 document are to be interpreted as described in [RFC2119]. This 110 document only uses these key words when referencing normative 111 statements in existing RFCs." 113 3. Metadata Model 115 Metadata is the information that describes recorded media and the CS 116 to which they relate. Below diagram shows a model for Metadata as 117 viewed by Session Recording Server (SRS). 119 +-------------------------------+ 1 120 | Recording Session (RS) |---------------+ 121 +-------------------------------+ | 122 | 1..* | 123 | | 124 | 0..* | 125 +-------------------------------+ | 126 | Communication Session (CS) | 1 | 127 | Group |---------------| 128 +-------------------------------+ | 129 | 1 | 130 | | 131 | 1..* | 132 +-------------------------------+ | 133 | Communication Session (CS) | 1 | 134 | |---------------| 135 +-------------------------------+ | +------------+ 136 | 0..* |1..* | | | 137 | | | 0..* |Extension | 138 | 2..* |0..* |-------| Data | 139 +-------------+ receives +----------------+ | | | 140 | Participant |----------| Media Streams | | +------------+ 141 | |0..* 0..*| | | 142 | | | | | 143 | | | | | 144 | | sends | | | 145 | |----------| | | 146 | |1.* 0..*| | | 147 +-------------+ +----------------+ | 148 | | | 149 |1 |1 | 150 | | | 151 +----------------------------------------+ 153 The mechanism MUST provide a means to convey every attribute 154 mentioned in the metadata model. Session Recording Client (SRC) MAY 155 initiate the Recording Session. It should be noted that the 156 Recording Session is a completely independent from the Communication 157 Session that is being recorded at both the SIP dialog level and at 158 the session level. The metadata MUST be conveyed from SRC to SRS. 159 The metadata MAY be conveyed within the Recording Session Dialog. 161 Note that the metadata model captures changes that occur over the 162 duration of the recording session. For example, if the call is 163 transferred from one participant to another, then the SRC SHALL 164 convey a change of participant and the properties of the new media 165 stream to the SRS. 167 Some of the data in the model may not be conveyed explicitly from the 168 SRC to the SRS, if it can be obtained contextually by the SRS. For 169 instance, the timing of changes may not explicitly conveyed from the 170 SRC to the SRC, because the mechanism (yet to be defined) which 171 conveys the metadata may implicitly provide the timing. (E.g. the 172 time a change occurred by be assumed to be the same as the time when 173 notification of the change is received by the SRS.) 175 4. Recording Metadata elements 177 This section describes each element of the metadata model, and the 178 attributes of each element. This section also describes how 179 different elements are associated. 181 4.1. Recording Session 183 +-------------------------------+ 184 | Recording Session (RS) | 185 +-------------------------------+ 186 | Recording Requestor(SRC or | +-----------------+ 187 | SRS) | 1 0..* | | 188 | |------------|Extension Data | 189 | Recording Type (Selective | | | 190 | Persistant) | +-----------------+ 191 +-------------------------------+ 192 | 1..* 193 | 194 | 0..* 195 Communication Session Group(CS Group) 197 A Recording Session element represents one instance of a Recording 198 Session. 200 4.1.1. Attributes 202 A Recording Session element MAY have attributes like: 203 o Recording requestor(which could be SRS or SRC). 204 o Recording type - This attribute indicates whether the recording 205 session is selective or persistent. 207 4.1.2. Associations 209 One instance of Recording Session SHALL have: 211 o Zero or more instances of Communication Session Group.The 212 allowance of zero instances is to accommodate persistent 213 recording, where there may be none. 214 o Each CS Group MUST be associated with one or more Recording 215 Sessions [ setup by the same SRC.] 217 4.2. Communication Session Group 219 Recording Session (RS) 220 | 1..* 221 | 222 | 0..* 223 +-------------------------------+ 224 | Communication Session | 225 | Group | 226 +-------------------------------+ 227 | Unique-ID | +----------------+ 228 | | 1 0..* | | 229 | |-----------|Extension Data | 230 | | | | 231 +-------------------------------+ +----------------+ 232 | 1 233 | 234 | 1..* 235 Communication Session (CS) 237 A Communication Session Group provides association or linking of 238 Communication Sessions. 240 4.2.1. Attributes 242 A CS Group MUST have a Unique-ID attribute. This Unique-ID is to 243 group different CSs that are related. SRC (or MAY be SRS) MUST 244 ensure the uniqueness of Unique-ID in case multiple SRC interacts 245 with the same SRS. The mechanism by which SRC groups the CS is 246 outside the scope of SIPREC. 248 4.2.2. Associations 250 A communication Session Group SHALL be associated with RS and CS in 251 the following manner: 253 o There can be one or more Recording Session elements per 254 Communication Session Group. 255 o Each Communication Session Group MUST be associated with one or 256 more RS [ setup by the same SRC] 257 o There MAY be one or more Communication Sessions per CS Group [e.g. 258 Consult Transfer] 259 o Each CS MUST be associated to one CS-Group 261 4.3. Communication Session 263 Communication Session Group(CS Group) 264 | 1 265 | 266 | 1..* 267 +-------------------------------+ +-----------------+ 268 | Communication Session (CS) | 1 0..* | | 269 | |---------------|Extension Data | 270 +-------------------------------+ | | 271 | CS Identifier | +-----------------+ 272 | Call Termination Reason | 273 | Start Time | 274 | End Time | 275 +-------------------------------+ 276 | | 277 | 0..* |1..* 278 | | 279 | 2..* |0..* 280 Participant Media Stream 282 A Communication Session block/element in the metadata model 283 represents Communication Session and its properties needed as seen by 284 SRC. 286 4.3.1. Attributes 288 A communication Session block SHALL have the following attributes: 290 o Call Termination Reason - This represents the reason why a CS was 291 terminated. The communication session MAY contain a Call 292 Termination Reason. This MAY be derived from SIP Reason header of 293 CS. 294 o CS Identifier - This attribute is used to uniquely identify a CS. 296 o Start Time - This attribute represents CS start time 297 o End Time - This attribute represents CS end time 299 Attributes like Retention (represent the value/duration for which 300 Media streams of the CS needs to be retained), Force Deletion, Access 301 Information e.t.c that are primarily related to policy will not be 302 passed in metadata from SRC to SRS. However if there are 303 implementations where SRC has enough information, this could be sent 304 as Extension Data attached to CS 306 4.3.2. Associations 308 A Communication Session SHALL be associated to CS-Group,Participant 309 and Media Stream. Cardinalities between CS and Participant allows: 311 o CS to have atleast two or more participants 312 o Participant may be associated with zero or more CS's (It is 313 possible, though unlikely, that there are participants who are not 314 part of any CS). An example of such a case is participants in a 315 premixed media stream. The SRC may have knowledge of such 316 Participants, yet not have any signaling relationship with them. 317 This might arise if one participant in CS is a conf focus. 318 Another use case is if one UA in CS works in 3pcc mode to acquire 319 an MoH media stream, this might be reflected as unique source for 320 media stream without having a reported signaling relationship to 321 it. 322 o The model also allows participants in CS that are not participants 323 in the media. An example is the identity of a 3pcc controller 324 that has initiated a CS to two or more participants of the CS. 325 Another example is the identity of a conference focus. Of course 326 a focus is probably in the media, but since it may only be there 327 as a mixer, it may not report itself as a participant in any of 328 the media streams. 330 Cardinalities between CS and Media Stream allows: 332 o A CS to have zero or more Streams 333 o A stream can be associated with 1 or more CS. An example is 334 multicast MoH stream which might be associated with many CSs. 335 Also if we were to consider a B2BUA to have a separate CS on each 336 "side" then they might share a stream.(Though more likely this 337 would be treated as a single CS.) 339 4.4. Participant 340 Communication Session (CS) 341 | 0..* 342 | 343 | 2..* 344 +-------------------------------+ 345 | Participant | 346 | | 347 +-------------------------------+ 348 | AoR list | +-----------------+ 349 | Name | 1 0..* | | 350 | Participant Type |------------|Extension Data | 351 | | | | 352 +-------------------------------+ +-----------------+ 353 | 0..* 1..*| 354 receives| |sends 355 | 0..* 0..*| 356 Media Stream 358 A Participant block has information about a device that is part of a 359 CS and/or contributes/consumes media stream(s) belonging to a CS. 361 4.4.1. Attributes 363 Participant has attributes like: 365 o AoR list - Has list of AoRs. An AoR MAY be SIP/SIPS/TEL URI. 366 There MAY be cases where a participant can have more than one AoR 367 [ e.g. P-Asserted-ID which can have both SIP and TEL URIs] 368 o Name - This attribute represents Participant name(SIP display 369 name) or DN number ( in case it is known) 370 o Participant Type - This attribute can have values as "internal" or 371 "external" or "don't know" (in cases where it is not possible to 372 determine). 374 Other attributes [ like Participant Role ] MAY be carried as part of 375 extension data to Participant from SRC to SRS. 377 4.4.2. Associations 379 Cardinalities between participant and Media Stream allows: 381 o Participant to receives zero or more media streams 382 o Participant to send zero or more media streams. (Same participant 383 provides multiple streams e.g. audio and video) 385 o Media stream to be received by zero or more participants. Its 386 possible, though perhaps unlikely, that a stream is generated but 387 sent only to the SRC and SRS, not to any participant. E.g. In 388 conferencing where all participants are on hold and the SRC is 389 collocated with the focus. Also a media stream may be received by 390 multiple participants (e.g. Whisper calls, side conversations). 391 o Media stream to be sent by one or more participants (pre-mixed 392 streams). 394 Example of a case where a participant may receive Zero or more 395 streams - a Supervisor may have side conversation with Agent, while 396 Agent converses with customer. 398 4.5. Media Stream 400 Participant 401 | 0..* 1..*| 402 receives| |sends 403 | 0..* 0..*| 404 +-------------------------+ 405 | Media Stream | 406 | | 407 Communication 1..* 0..* +-------------------------+ 408 Session ------------| Start Time | +----------+ 409 | End Time |1 0..* | | 410 | Codec params |--------|Extension | 411 | Media Stream Reference | | Data | 412 +-------------------------+ +----------+ 414 A Media Stream block shall have properties of media as seen by SRC 415 and sent to SRS. Different instances of Media Stream block would be 416 created whenever there is a change in media (e.g. dir change like 417 pause/resume and/or codec change and/or participant change.). 419 4.5.1. Attributes 421 A Media Stream block SHALL have the following attributes: 423 o Start Time - Represents Media Start time at SRC. 424 o End Time - Represents Media End time at SRC. This is an optional 425 attribute and MAY be included after a stream ends 426 o Codec params - represents codec parameters of the CS media 427 o Media Stream Reference - In implementations this can reference to 428 m-line 430 The metadata model should include media streams that are not being 431 delivered to the SRS. Examples include cases where SRC offered 432 certain media types but SRS chooses to accept only a subset of them 433 OR an SRC may not even offer a certain media type due it its 434 restrictions to record 436 4.5.2. Associations 438 A Media Stream SHALL be associated with Participant and CS. The 439 details of association with the Participant are described in the 440 Participant block section. The details of association with CS is 441 mentioned in the CS section. 443 4.6. Extension Data 445 A recording metadata object contains additional data not specified as 446 part of siprec. This is intended to accommodate future standards 447 track extensions, as well as vendor and user specific extensions. 448 The mechanism MUST provide a means of unambiguously distinguishing 449 such extension data. 451 5. Metadata Model Object Instances 453 This section describes the metadata model object instances for 454 different use cases of SIPREC. For the sake of simplicity as the 455 media streams sent by each of the participants is received by every 456 other participant in these use cases, it is NOT shown in the object 457 instance diagrams below. 459 5.1. Use case 1: Basic Call 461 Basic call between two Participants A and B. In this use case each 462 participant sends one Media Stream. For the sake of simplicity 463 "receives" lines are not shown in this instance diagram. Media 464 Streams sent by each participant is received all other participants 465 of that CS. 467 +-------------------------------+ 468 | Recording Session (RS) | 469 +-------------------------------+ 470 | 471 | 472 | 473 +-------------------------------+ 474 | Communication Session (CS) | 475 | Group(CSG) | 476 +-------------------------------+ 477 | Unique-id1 | 478 +-------------------------------+ 479 | 480 | 481 | 482 +----------------+ 483 | Communication | 484 | Session (CS) | 485 +----------------+ 486 | | 487 +----------------+ 488 | 489 |-------------------+ 490 | | | 491 +---------------+ | +---------------+ 492 | ParticipantA | | | ParticipantB | 493 | | | | | 494 +---------------+ | +---------------+ 495 | | | 496 sends | | | sends 497 | | | 498 +---------------+ | +---------------+ 499 |Media Stream A1| | |Media Stream B1| 500 +---------------+ | +---------------+ 501 |MediaStream Ref| | |MediaStream Ref| 502 |codec params |---+---|codec params | 503 +---------------+ +---------------+ 505 5.2. Use case 2: Basic Call with hold/resume 507 Basic call between two Participants A and B and with Participant A or 508 B doing a Hold/Resume. In this use case each participant sends one 509 Media Stream. After Hold/Resume the properties of Media MAY change. 510 For the sake of simplicity "receives" lines are not shown in this 511 instance diagram. Media Streams sent by each participant is received 512 all other participants of that CS. 514 +-------------------------------+ 515 | Recording Session (RS) | 516 +-------------------------------+ 517 | 518 | 519 | 520 +-------------------------------+ 521 | Communication Session (CS) | 522 | Group(CSG) | 523 +-------------------------------+ 524 | Unique-id1 | 525 +-------------------------------+ 526 | 527 | 528 | 529 +----------------+ 530 | Communication | 531 +-| Session (CS) |----------------------------------------------+ 532 | +----------------+ | 533 | | | | 534 | +----------------+ | 535 | | | 536 | |-------------------+ | 537 | | | | 538 | +---------------+ +---------------+ | 539 | | ParticipantA | | ParticipantB |-----------+ | 540 | | |--+ | | | | 541 | +---------------+ | +---------------+ |sends(After | 542 | | | | | | | Resume) | 543 | | | | | | +--------------+ | 544 | sends | | +--+ | sends | |MediaStream B3| | 545 | | -----+ | | +-----+ +--------------+ | 546 | +---------------+ | | +---------------+ | |MediaStreamRef|-| 547 | |Media Stream A1| | | |Media Stream B1| | |Codec Params | | 548 | +---------------+ | | +---------------+ | | | | 549 +-|MediaStreamref | | | |MediaStreamRef | | +--------------+ | 550 |codec params | | | |codec params |-|-------------------| 551 +---------------+ | | +---------------+ | | 552 | | | | 553 +------------+ |sends |sends (hold) | 554 | sends |(Resume) | | 555 | (hold) +-------+ +-------+ | 556 | | | | 557 +---------------+ +---------------+ +--------------+ | 558 |Media Stream A2| |Media Stream A3| |MediaStream B2| | 559 +---------------+ +---------------+ | | | 560 |MediaStreamref | |MediaStreamRef | +--------------+ | 561 |codec params | |codec params | |Codec Params | | 562 +---------------+ +---------------+ |MediaStreamRef| | 563 | | | | | 564 | | +--------------+ | 565 | | | | 566 +------------------------------------------------------+ 568 NOTE: Need discssions on how to represent Hold/Resume from SRC to SRS 569 and Pause/Resume from SRS to SRC. 571 5.3. Use case 3: Basic call with Transfer 573 Basic call between two Participants A and B and with Participant A 574 transfer(consult transfer) to Participant C. In this use case each 575 participant sends one Media Stream. After transfer the properties of 576 Participant A Media MAY change. For the sake of simplicity 577 "receives" lines are not shown in this instance diagram. Media 578 Streams sent by each participant is received all other participants 579 of that CS. 581 +-------------------------------+ 582 | Recording Session (RS) | 583 +-------------------------------+ 584 | 585 | 586 | 587 +-------------------------------+ 588 | Communication Session (CS) | 589 | Group(CSG) | 590 +-------------------------------+ 591 | Unique-id1 | 592 +-------------------------------+ 593 | 594 |----------------- 595 | | 596 +----------------+ +----------------+ 597 | Communication | | Communication | 598 | Session (CS)1 | | Session (CS)2 | 599 +----------------+ +----------------+-----------+ 600 | | | | | 601 +----------------+ +----------------+ | 602 | | 603 |-------------------+ | 604 | | | | 605 +---------------+ | +---------------+ | 606 | ParticipantA | | | ParticipantB | | 607 | | | | | | 608 +---------------+ | +---------------+ | 609 | | | | 610 sends | | | sends | 611 | | | | 612 +---------------+ | +---------------+ | 613 |Media Stream A1| | |Media Stream B1| | 614 +---------------+ | +---------------+ | 615 | | | | | | 616 |codec params | | | Media Stream | | 617 | Media Stream |---+---| Ref | | 618 | Ref | |codec params | | 619 +---------------+ +---------------+ | 620 | 621 | 622 +----------------------------| 623 | | 624 +--------------------------------+ | 625 | | | 626 +---------------+ +---------------+ | 627 | Participant A | | Participant C | | 628 | (same) | | | | 629 +---------------+ +---------------+ | 630 | | | 631 | sends (After transfer) | sends | 632 +----------------+ +----------------+| 633 | Media Stream A2| | Media Stream C1|| 634 +----------------+ +----------------+| 635 | Media StreamRef| | Media StreamRef|| 636 | Codec params | | Codecparams || 637 | | | || 638 +----------------+ +----------------+| 639 | | | 640 | | | 641 | | | 642 +-------------------------------------------+ 644 5.4. Conference Use Cases 646 Depending on who act as SRC and the information that an SRC has there 647 can be several ways to model conference use cases. This section has 648 instance diagrams for the following cases: 650 o A CS where one of the participant (which is also SRC) is a user in 651 a conference 652 o A CS where one of the participant is focus ( which is also SRC) 653 o A CS where one of the participant is user and the SRC is a 654 different entity like B2BUA 655 o A CS where one of the participant is focus and the SRC is a 656 different entity like B2BUA 658 NOTE: There MAY be other ways to model the same use cases depending 659 on what information the SRC has. 661 5.4.1. Case 1: 663 This is the usecase where there is a CS with one of the participant 664 (who is also SRC) as a user in a conference. For the sake of 665 simplicity the receive lines for each of the participant is not 666 shown. 668 +---------------------------------------------------+ 669 | Communication Session | 670 | +-------------+ +--------------+ | 671 | | | | | | 672 | |Participant B| | Participant A| | 673 | | (User in |--------------| | | 674 | | conf/SRC) | | | | 675 | +-------------+ +--------------+ | 676 | | | | | | 677 +---------------------------------------------------+ 678 | | | | 679 | | | | 680 D E F G (Participants of Conference) 682 Instance Diagram: 684 +-------------------------------+ 685 | Recording Session (RS) | 686 +-------------------------------+ 687 | 688 | 689 | 690 +-------------------------------+ 691 | Communication Session (CS) | 692 | Group(CSG) | 693 +-------------------------------+ 694 | Unique-id1 | 695 +-------------------------------+ 696 | 697 | 698 | 700 +----------------+ 701 | Communication | 702 | Session (CS) |--+ 703 +----------------+ | 704 | | | 705 +----------------+ | 706 | | 707 | | 708 | | 709 +---------------+ | 710 | ParticipantA | | 711 | | | 712 +---------------+ | 713 | | 714 sends | | 715 | | 716 +---------------+ | 717 |Media Stream A1| | 718 +---------------+ | 719 |MediaStream Ref| | 720 |codec params | | 721 +---------------+ | 722 | 723 | 724 +-------------+ 725 | | 726 | | 727 +----------------+ | 728 | Participant B | | 729 | (in conf) | | 730 +----------------+ | 731 | | 732 sends | +-------+ 733 | | 734 +----------------+ 735 | Media Stream B1| 736 +----------------+ sends ( not sure if sends is right word) 737 | MediaStream Ref|-----+-----------+-------------+---------+ 738 | Codec Params | | | | | 739 +----------------+ | | | | 740 +------------+ +------------+ +------------+ +-------------+ 741 |participantD| |ParticipantE| |ParticipantF| |Participant G| 742 +------------+ +------------+ +------------+ +-------------+ 744 In this example we have two participants A and B who are part of a 745 Communication Session(CS). One of the participants B is part of a 746 conference and also acts as SRC.There can be two cases here. B can 747 be a participant of the conference or B can be a focus. In this 748 instance diagram Participant B is a user in a conference. The SRC 749 (Participant B) SHALL subscribe to conference event package to get 750 the details of other particiants. Participant B(SRC) SHALL send the 751 same through the metadata to SRS. In this instance diagram the Media 752 Stream(mixed stream) sent from Participant B SHALL have media streams 753 contributed by conference participants (D,E,F and G). For the sake 754 of simplicity the "receives" line is not shown here. In this example 755 the media stream sent by each participant(A or B) of CS is received 756 by all other participant(A or B). 758 5.4.2. Case 2: 760 This is the usecase where there is a CS where one of the participant 761 is focus ( which is also SRC). 763 +---------------------------------------------------+ 764 | Communication Session | 765 | +--------------+ +--------------+ | 766 | | |--------------| | | 767 | |Participant C | | Participant A| | 768 | | (Focus in |------+ | | | 769 | | conf and SRC)|---+ | +--------------+ | 770 | +--------------+ | | | 771 | | | +---------+ | 772 | | | | | 773 | +--------------+ | +---------------+ | 774 | | Participant B| +---+ | Participant D | | 775 | | | | | | | 776 | +--------------+ | +---------------+ | 777 | | | 778 | +--------------+ | 779 | |Participant E | | 780 | | | | 781 | +--------------+ | 782 | | 783 +---------------------------------------------------+ 785 Instance Diagram: 787 +-------------------------------+ 788 | Recording Session (RS) | 789 +-------------------------------+ 790 | 791 | 792 | 793 +-------------------------------+ 794 | Communication Session (CS) | 795 | Group(CSG) | 796 +-------------------------------+ 797 | Unique-id1 | 798 +-------------------------------+ 799 | 800 | 801 | 802 +----------------+ 803 | Communication | 804 | Session (CS) |----------------------+ 805 +----------------+ | 806 | | | 807 +----------------+ | 808 | | 809 |-------------------+ | 810 | | | | 811 +---------------+ | +---------------+ | 812 | ParticipantA | | | ParticipantB | | 813 | | | | | | 814 +---------------+ | +---------------+ | 815 | | | | 816 sends | | | sends | 817 | | | | 818 +---------------+ | +---------------+ | 819 |Media Stream A1| | |Media Stream B1| | 820 +---------------+ | +---------------+ | 821 |MediaStream Ref| | |MediaStream Ref| | 822 |codec params |---+---|codec params | | 823 +---------------+ +---------------+ | 824 | 825 +----------------------------------+ 826 | | | | 827 | | | | 828 +---------------+ | +---------------+ | 829 | ParticipantD | | | ParticipantE | | 830 | | | | | | 831 +---------------+ | +---------------+ | 832 | | | | 833 sends | | | sends | 834 | | | | 835 +---------------+ | +---------------+ | 836 |Media Stream D1| | |Media Stream E1| | 837 +---------------+ | +---------------+ | 838 |MediaStream Ref| | |MediaStream Ref| | 839 |codec params |---+---|codec params | | 840 +---------------+ +---------------+ | 841 | 842 | 843 +----------+ 844 +-----------------| 845 | | 846 | | 847 +----------------+ | 848 | Participant C | | 849 | (focus +src) | | 850 +----------------+ | 851 | | 852 Sends | +-------+ 853 | | 854 "sends" OR | | 855 contributed +----------------+ 856 by | Media Stream C1| 857 Participants+----------------+ "receives" by participants A,B,D,E 858 A,B,D,E | MediaStream Ref|------------------------------------ 859 ------------| Codec Params | 860 +----------------+ 862 In this example we have two participants A and B who are part of a 863 Communication Session(CS). One of the participants (C) is focus of a 864 conference and also acts as SRC. The SRC (Participant C) being the 865 Focus of the conference SHALL have access to the details of other 866 particiants. SRC (Participant C) SHALL send the same through the 867 metadata to SRS. In this instance diagram the Media Stream(mixed 868 stream) sent by C SHALL have media streams contributed by conference 869 participants (A, B, D and E). Participants A, B,D and E SHALL send 870 Media Streams A1, B1, D1 and E1 respectively. The media stream sent 871 by Participant C(Focus) shall be received by all other participants 872 of CS. For the sake of simplicity the "receives" line is not shown 873 linked to all other participants. 875 NOTE: SRC ( Participant C) MAY send mixed stream or seperate streams 876 to SRS 878 5.4.3. Case 3: 880 A CS where one of the participant is user and the SRC is a different 881 entity like B2BUA. In this case the SRC MAY not know that one of the 882 user is part of conference. Hence the instance diagram will not have 883 information about the conference participants. 885 +---------------------------------------------------+ 886 | Communication Session | 887 | +-------------+ +------+ +--------------+ | 888 | | | | (SRC)| | | | 889 | |Participant B|--|B2BUA |----| Participant A| | 890 | | (User in | +------+ | | | 891 | | conf) | | | | 892 | +-------------+ +--------------+ | 893 | | | | | | 894 +---------------------------------------------------+ 895 | | | | 896 | | | | 897 D E F G (Participants of Conference) 899 5.4.4. Case 4: 901 A CS where one of the participant is focus and the SRC is a different 902 entity like B2BUA. In this case the participant which is focus MAY 903 send "isfocus" in SIP message to SRC. The SRC MAY subscribe to 904 conference event package on seeing this "isfocus". SRC SHALL learn 905 the details of other participants of conference from the conference 906 package and send the same in metadata to SRS. The instance diagram 907 for this use case SHALL be same as Case 1. 909 +--------------------------------+ 910 | Conference Event Package | 911 | | 912 +--------------------------------+ 913 | 914 | subscribes 915 | 916 +---------------------|-----------------------------+ 917 | Communication |Session | 918 | +-------------+ +------+ +--------------+ | 919 | | | | (SRC)| | | | 920 | |Participant B|--|B2BUA |----| Participant A| | 921 | | (FOCUS in | +------+ | | | 922 | | conf) | | | | 923 | +-------------+ +--------------+ | 924 | | | | | | 925 +---------------------------------------------------+ 926 | | | | 927 | | | | 928 D E F G (Participants of Conference) 930 6. Security Considerations 932 The metadata information sent from SRC to SRS MAY reveal sensitive 933 Information about different participants of CS. For this reason, it 934 is RECOMMENDED that a SRC use a strong means for authentication and 935 metadata information protection and that it apply comprehensive 936 authorization rules when using the metadata model defined in this 937 document. The security considerations for this SHALL be defined in 938 the solution document. 940 7. IANA Considerations 942 Not Applicable 944 8. Acknowledgement 946 We wish to thank John Elwell, Henry Lum, Leon Portman, De Villers, 947 Andrew Hutton, Deepanshu Gautam, Charles Eckel for their valuable 948 comments. 950 9. References 952 9.1. Normative References 954 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 955 Requirement Levels", BCP 14, RFC 2119, March 1997. 957 9.2. Informative References 959 [I-D.ietf-siprec-req] 960 Rehor, K., Portman, L., Hutton, A., and R. Jain, "Use 961 Cases and Requirements for SIP-based Media Recording 962 (SIPREC)", draft-ietf-siprec-req-09 (work in progress), 963 March 2011. 965 [I-D.ietf-siprec-architecture] 966 Hutton, A., Portman, L., Jain, R., and K. Rehor, "An 967 Architecture for Media Recording using the Session 968 Initiation Protocol", draft-ietf-siprec-architecture-01 969 (work in progress), October 2010. 971 Authors' Addresses 973 Ram Mohan Ravindranath 974 Cisco Systems, Inc. 975 Cessna Business Park, 976 Kadabeesanahalli Village, Varthur Hobli, 977 Sarjapur-Marathahalli Outer Ring Road 978 Bangalore, Karnataka 560103 979 India 981 Email: rmohanr@cisco.com 983 Parthasarathi Ravindran 984 Cisco Systems, Inc. 985 Cessna Business Park, 986 Kadabeesanahalli Village, Varthur Hobli, 987 Sarjapur-Marathahalli Outer Ring Road 988 Bangalore, Karnataka 560103 989 India 991 Email: partr@cisco.com 993 Paul Kyzivat 994 Cisco Systems, Inc. 995 1414 Massachusetts Avenue 996 Boxborough, MA 01719 997 USA 999 Email: pkyzivat@cisco.com