idnits 2.17.1 draft-ram-siprec-metadata-04.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 500 has weird spacing: '... |codec param...' == Line 718 has weird spacing: '...|codec params...' == Line 820 has weird spacing: '... |codec param...' == Line 837 has weird spacing: '... |codec param...' -- The document date (March 7, 2011) is 4798 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-06 == 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: September 8, 2011 Cisco Systems, Inc. 5 March 7, 2011 7 Session Initiation Protocol (SIP) Recording Metadata 8 draft-ram-siprec-metadata-04 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 to IETF 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 September 8, 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 . . . . . . . . . . . . . . . . . . . . . 7 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 data that describes the communication session. Below 116 diagram shows a model for Metadata as viewed by Session Recording 117 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 metamodel. 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 in 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 the different elements and its attributes of 178 the metadata model shown above. This section also describes in brief 179 on how the different elements of metadata are associated. 181 4.1. Recording Session 183 +-------------------------------+ 184 | Recording Session (RS) | 185 +-------------------------------+ 186 | Recording RequestorID(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 ID(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 creates this unique-ID 246 and ensures its uniqueness is outside the scope of SIPREC. 248 NOTE: Need more clarity/use cases on how the unique-ID SHALL be used 250 4.2.2. Associations 252 A communication Session Group SHALL be associated with RS and CS in 253 the following manner: 255 o There can be one or more Recording Session elements per 256 Communication Session Group. 257 o Each Communication Session Group MUST be associated with one or 258 more RS [ setup by the same SRC] 259 o There MAY be one or more Communication Sessions per CS Group [e.g. 260 Consult Transfer] 261 o Each CS MUST be associated to one CS-Group 263 4.3. Communication Session 265 Communication Session Group(CS Group) 266 | 1 267 | 268 | 1..* 269 +-------------------------------+ +-----------------+ 270 | Communication Session (CS) | 1 0..* | | 271 | |---------------|Extension Data | 272 +-------------------------------+ | | 273 | CS Identifier | +-----------------+ 274 | Call Termination Reason | 275 | | 276 +-------------------------------+ 277 | | 278 | 0..* |1..* 279 | | 280 | 2..* |0..* 281 Participant Media Stream 283 A Communication Session block/element in the metadata model 284 represents Communication Session and its properties needed as seen by 285 SRC. 287 4.3.1. Attributes 289 A communication Session block SHALL have the following attributes: 291 o Call Termination Reason - This represents the reason why a CS was 292 terminated. The communication session MAY contain a Call 293 Termination Reason. This MAY be derived from SIP Reason header of 294 CS. 295 o CS Identifier - This attribute is used to uniquely identify a CS. 297 NOTE: Attributes like Retention (represent the value/duration for 298 which Media streams of the CS needs to be retained), Force Deletion, 299 Access Information e.t.c that are primarily related to policy will 300 not be passed in metadata from SRC to SRS. However if there are 301 implementations where SRC has enough information, this could be sent 302 as Extension Data attached to CS 304 4.3.2. Associations 306 A Communication Session SHALL be associated to CS-Group,Participant 307 and Media Stream. Cardinalities between CS and Participant allows: 309 o CS to have atleast two or more participants 310 o Participant may be associated with zero or more CS's (It is 311 possible, though unlikely, that there are participants who are not 312 part of any CS). An example of such a case is participants in a 313 premixed media stream. The SRC may have knowledge of such 314 Participants, yet not have any signaling relationship with them. 315 This might arise if one participant in CS is a conf focus. 316 Another use case is if one UA in CS works in 3pcc mode to acquire 317 an MoH media stream, this might be reflected as unique source for 318 media stream without having a reported signaling relationship to 319 it. 320 o The model also allows participants in CS that are not participants 321 in the media. An example is the identity of a 3pcc controller 322 that has initiated a CS to two or more participants of the CS. 323 Another example is the identity of a conference focus. Of course 324 a focus is probably in the media, but since it may only be there 325 as a mixer, it may not report itself as a participant in any of 326 the media streams. 328 Cardinalities between CS and Media Stream allows: 330 o A CS to have zero or more Streams 331 o A stream can be associated with 1 or more CS. An example is 332 multicast MoH stream which might be associated with many CSs. 333 Also if we were to consider a B2BUA to have a separate CS on each 334 "side" then they might share a stream.(Though more likely this 335 would be treated as a single CS.) 337 4.4. Participant 338 Communication Session (CS) 339 | 0..* 340 | 341 | 2..* 342 +-------------------------------+ 343 | Participant | 344 | | 345 +-------------------------------+ 346 | AoR list | +-----------------+ 347 | Name | 1 0..* | | 348 | Participant Type |------------|Extension Data | 349 | | | | 350 +-------------------------------+ +-----------------+ 351 | 0..* 1..*| 352 receives| |sends 353 | 0..* 0..*| 354 Media Stream 356 A Participant block has information about a device that is part of a 357 CS and/or contributes/consumes media stream(s) belonging to a CS. 359 4.4.1. Attributes 361 Participant has attributes like: 363 o AoR list - Has list of AoRs. An AoR MAY be SIP/SIPS/TEL URI. 364 There MAY be cases where a participant can have more than one AoR 365 [ e.g. P-Asserted-ID which can have both SIP and TEL URIs] 366 o Name - This attribute represents Participant name(SIP display 367 name) or DN number ( in case it is known) 368 o Participant Type - This attribute can have values as "internal" or 369 "external" or "don't know" (in cases where it is not possible to 370 determine). 372 NOTE: Other attributes [ like Participant Role ] MAY be carried as 373 part of extension data to Participant from SRC to SRS. 375 4.4.2. Associations 377 Cardinalities between participant and Media Stream allows: 379 o Participant to receives zero or more media streams 380 o Participant to send zero or more media streams. (Same participant 381 provides multiple streams e.g. audio and video) 383 o Media stream to be received by zero or more participants. Its 384 possible, though perhaps unlikely, that a stream is generated but 385 sent only to the SRC and SRS, not to any participant. E.g. In 386 conferencing where all participants are on hold and the SRC is 387 collocated with the focus. Also a media stream may be received by 388 multiple participants (e.g. Whisper calls, side conversations). 389 o Media stream to be sent by one or more participants (pre-mixed 390 streams). 392 NOTE: Example of a case where a participant may receive Zero or more 393 streams - a Supervisor may have side conversation with Agent, while 394 Agent converses with customer. 396 4.5. Media Stream 398 Participant 399 | 0..* 1..*| 400 receives| |sends 401 | 0..* 0..*| 402 +-------------------------+ 403 | Media Stream | 404 | | 405 Communication 1..* 0..* +-------------------------+ 406 Session ------------| Start Time | +----------+ 407 | End Time |1 0..* | | 408 | Codec params |--------|Extension | 409 | Media Stream Reference | | Data | 410 +-------------------------+ +----------+ 412 A Media Stream block shall have properties of media as seen by SRC 413 and sent to SRS. Different instances of Media Stream block would be 414 created whenever there is a change in media (e.g. dir change like 415 pause/resume and/or codec change and/or participant change.). 417 4.5.1. Attributes 419 A Media Stream block SHALL have the following attributes: 421 o Start Time - Represents Media Start time at SRC. 422 o End Time - Represents Media End time at SRC. This is an optional 423 attribute and MAY be included after a stream ends 424 o Codec params - represents codec parameters of the CS media 425 o Media Stream Reference - In implementations this can reference to 426 m-line 428 There may cases where SRC offered certain media types but SRS chooses 429 to accept only a subset of them OR an SRC may not even offer a 430 certain media type due it its restrictions to record. In such cases 431 SRC MAY continue to send information about media streams that are not 432 recorded to SRS in the metadata. 434 4.5.2. Associations 436 A Media Stream SHALL be associated with Participant and CS. The 437 details of association with the Participant are described in the 438 Participant block section. The details of association with CS is 439 mentioned in the CS section. 441 4.6. Extension Data 443 A recording metadata object contains additional data not specified as 444 part of siprec. This is intended to accommodate future standards 445 track extensions, as well as vendor and user specific extensions. 446 The mechanism MUST provide a means of unambiguously distinguishing 447 such extension data. 449 5. Metadata Model Object Instances 451 This section describes the metadata model object instances for 452 different use cases of SIPREC. For the sake of simplicity as the 453 media streams sent by each of the participants is received by every 454 other participant in these use cases, it is NOT shown in the object 455 instance diagrams below. 457 5.1. Use case 1: Basic Call 459 Basic call between two Participants A and B. In this use case each 460 participant sends one Media Stream. For the sake of simplicity 461 "receives" lines are not shown in this instance diagram. Media 462 Streams sent by each participant is received all other participants 463 of that CS. 465 +-------------------------------+ 466 | Recording Session (RS) | 467 +-------------------------------+ 468 | 469 | 470 | 471 +-------------------------------+ 472 | Communication Session (CS) | 473 | Group(CSG) | 474 +-------------------------------+ 475 | Unique-id1 | 476 +-------------------------------+ 477 | 478 | 479 | 480 +----------------+ 481 | Communication | 482 | Session (CS) | 483 +----------------+ 484 | | 485 +----------------+ 486 | 487 |-------------------+ 488 | | | 489 +---------------+ | +---------------+ 490 | ParticipantA | | | ParticipantB | 491 | | | | | 492 +---------------+ | +---------------+ 493 | | | 494 sends | | | sends 495 | | | 496 +---------------+ | +---------------+ 497 |Media Stream A1| | |Media Stream B1| 498 +---------------+ | +---------------+ 499 |MediaStream Ref| | |MediaStream Ref| 500 |codec params |---+---|codec params | 501 +---------------+ +---------------+ 503 5.2. Use case 2: Basic Call with hold/resume 505 Basic call between two Participants A and B and with Participant A or 506 B doing a Hold/Resume. In this use case each participant sends one 507 Media Stream. After Hold/Resume the properties of Media MAY change. 508 For the sake of simplicity "receives" lines are not shown in this 509 instance diagram. Media Streams sent by each participant is received 510 all other participants of that CS. 512 +-------------------------------+ 513 | Recording Session (RS) | 514 +-------------------------------+ 515 | 516 | 517 | 518 +-------------------------------+ 519 | Communication Session (CS) | 520 | Group(CSG) | 521 +-------------------------------+ 522 | Unique-id1 | 523 +-------------------------------+ 524 | 525 | 526 | 527 +----------------+ 528 | Communication | 529 +-| Session (CS) |----------------------------------------------+ 530 | +----------------+ | 531 | | | | 532 | +----------------+ | 533 | | | 534 | |-------------------+ | 535 | | | | 536 | +---------------+ +---------------+ | 537 | | ParticipantA | | ParticipantB |-----------+ | 538 | | |--+ | | | | 539 | +---------------+ | +---------------+ |sends(After | 540 | | | | | | | Resume) | 541 | | | | | | +--------------+ | 542 | sends | | +--+ | sends | |MediaStream B3| | 543 | | -----+ | | +-----+ +--------------+ | 544 | +---------------+ | | +---------------+ | |MediaStreamRef|-| 545 | |Media Stream A1| | | |Media Stream B1| | |Codec Params | | 546 | +---------------+ | | +---------------+ | | | | 547 +-|MediaStreamref | | | |MediaStreamRef | | +--------------+ | 548 |codec params | | | |codec params |-|-------------------| 549 +---------------+ | | +---------------+ | | 550 | | | | 551 +------------+ |sends |sends (hold) | 552 | sends |(Resume) | | 553 | (hold) +-------+ +-------+ | 554 | | | | 555 +---------------+ +---------------+ +--------------+ | 556 |Media Stream A2| |Media Stream A3| |MediaStream B2| | 557 +---------------+ +---------------+ | | | 558 |MediaStreamref | |MediaStreamRef | +--------------+ | 559 |codec params | |codec params | |Codec Params | | 560 +---------------+ +---------------+ |MediaStreamRef| | 561 | | | | | 562 | | +--------------+ | 563 | | | | 564 +------------------------------------------------------+ 566 NOTE: Need discssions on how to represent Hold/Resume from SRC to SRS 567 and Pause/Resume from SRS to SRC. 569 5.3. Use case 3: Basic call with Transfer 571 Basic call between two Participants A and B and with Participant A 572 transfer(consult transfer) to Participant C. In this use case each 573 participant sends one Media Stream. After transfer the properties of 574 Participant A Media MAY change. For the sake of simplicity 575 "receives" lines are not shown in this instance diagram. Media 576 Streams sent by each participant is received all other participants 577 of that CS. 579 +-------------------------------+ 580 | Recording Session (RS) | 581 +-------------------------------+ 582 | 583 | 584 | 585 +-------------------------------+ 586 | Communication Session (CS) | 587 | Group(CSG) | 588 +-------------------------------+ 589 | Unique-id1 | 590 +-------------------------------+ 591 | 592 |----------------- 593 | | 594 +----------------+ +----------------+ 595 | Communication | | Communication | 596 | Session (CS)1 | | Session (CS)2 | 597 +----------------+ +----------------+-----------+ 598 | | | | | 599 +----------------+ +----------------+ | 600 | | 601 |-------------------+ | 602 | | | | 603 +---------------+ | +---------------+ | 604 | ParticipantA | | | ParticipantB | | 605 | | | | | | 606 +---------------+ | +---------------+ | 607 | | | | 608 sends | | | sends | 609 | | | | 610 +---------------+ | +---------------+ | 611 |Media Stream A1| | |Media Stream B1| | 612 +---------------+ | +---------------+ | 613 | | | | | | 614 |codec params | | | Media Stream | | 615 | Media Stream |---+---| Ref | | 616 | Ref | |codec params | | 617 +---------------+ +---------------+ | 618 | 619 | 620 +----------------------------| 621 | | 622 +--------------------------------+ | 623 | | | 624 +---------------+ +---------------+ | 625 | Participant A | | Participant C | | 626 | (same) | | | | 627 +---------------+ +---------------+ | 628 | | | 629 | sends (After transfer) | sends | 630 +----------------+ +----------------+| 631 | Media Stream A2| | Media Stream C1|| 632 +----------------+ +----------------+| 633 | Media StreamRef| | Media StreamRef|| 634 | Codec params | | Codecparams || 635 | | | || 636 +----------------+ +----------------+| 637 | | | 638 | | | 639 | | | 640 +-------------------------------------------+ 642 5.4. Conference Use Cases 644 Depending on who act as SRC and the information that an SRC has there 645 can be several ways to model conference use cases. This section has 646 instance diagrams for the following cases: 648 o A CS where one of the participant (which is also SRC) is a user in 649 a conference 650 o A CS where one of the participant is focus ( which is also SRC) 651 o A CS where one of the participant is user and the SRC is a 652 different entity like B2BUA 653 o A CS where one of the participant is focus and the SRC is a 654 different entity like B2BUA 656 NOTE: There MAY be other ways to model the same use cases depending 657 on what information the SRC has. 659 5.4.1. Case 1: 661 This is the usecase where there is a CS with one of the participant 662 (who is also SRC) as a user in a conference. For the sake of 663 simplicity the receive lines for each of the participant is not 664 shown. 666 +---------------------------------------------------+ 667 | Communication Session | 668 | +-------------+ +--------------+ | 669 | | | | | | 670 | |Participant B| | Participant A| | 671 | | (User in |--------------| | | 672 | | conf/SRC) | | | | 673 | +-------------+ +--------------+ | 674 | | | | | | 675 +---------------------------------------------------+ 676 | | | | 677 | | | | 678 D E F G (Participants of Conference) 680 Instance Diagram: 682 +-------------------------------+ 683 | Recording Session (RS) | 684 +-------------------------------+ 685 | 686 | 687 | 688 +-------------------------------+ 689 | Communication Session (CS) | 690 | Group(CSG) | 691 +-------------------------------+ 692 | Unique-id1 | 693 +-------------------------------+ 694 | 695 | 696 | 698 +----------------+ 699 | Communication | 700 | Session (CS) |--+ 701 +----------------+ | 702 | | | 703 +----------------+ | 704 | | 705 | | 706 | | 707 +---------------+ | 708 | ParticipantA | | 709 | | | 710 +---------------+ | 711 | | 712 sends | | 713 | | 714 +---------------+ | 715 |Media Stream A1| | 716 +---------------+ | 717 |MediaStream Ref| | 718 |codec params | | 719 +---------------+ | 720 | 721 | 722 +-------------+ 723 | | 724 | | 725 +----------------+ | 726 | Participant B | | 727 | (in conf) | | 728 +----------------+ | 729 | | 730 sends | +-------+ 731 | | 732 +----------------+ 733 | Media Stream B1| 734 +----------------+ sends ( not sure if sends is right word) 735 | MediaStream Ref|-----+-----------+-------------+---------+ 736 | Codec Params | | | | | 737 +----------------+ | | | | 738 +------------+ +------------+ +------------+ +-------------+ 739 |participantD| |ParticipantE| |ParticipantF| |Participant G| 740 +------------+ +------------+ +------------+ +-------------+ 742 In this example we have two participants A and B who are part of a 743 Communication Session(CS). One of the participants B is part of a 744 conference and also acts as SRC.There can be two cases here. B can 745 be a participant of the conference or B can be a focus. In this 746 instance diagram Participant B is a user in a conference. The SRC 747 (Participant B) SHALL subscribe to conference event package to get 748 the details of other particiants. Participant B(SRC) SHALL send the 749 same through the metadata to SRS. In this instance diagram the Media 750 Stream(mixed stream) sent from Participant B SHALL have media streams 751 contributed by conference participants (D,E,F and G). For the sake 752 of simplicity the "receives" line is not shown here. In this example 753 the media stream sent by each participant(A or B) of CS is received 754 by all other participant(A or B). 756 5.4.2. Case 2: 758 This is the usecase where there is a CS where one of the participant 759 is focus ( which is also SRC). 761 +---------------------------------------------------+ 762 | Communication Session | 763 | +--------------+ +--------------+ | 764 | | |--------------| | | 765 | |Participant C | | Participant A| | 766 | | (Focus in |------+ | | | 767 | | conf and SRC)|---+ | +--------------+ | 768 | +--------------+ | | | 769 | | | +---------+ | 770 | | | | | 771 | +--------------+ | +---------------+ | 772 | | Participant B| +---+ | Participant D | | 773 | | | | | | | 774 | +--------------+ | +---------------+ | 775 | | | 776 | +--------------+ | 777 | |Participant E | | 778 | | | | 779 | +--------------+ | 780 | | 781 +---------------------------------------------------+ 783 Instance Diagram: 785 +-------------------------------+ 786 | Recording Session (RS) | 787 +-------------------------------+ 788 | 789 | 790 | 791 +-------------------------------+ 792 | Communication Session (CS) | 793 | Group(CSG) | 794 +-------------------------------+ 795 | Unique-id1 | 796 +-------------------------------+ 797 | 798 | 799 | 800 +----------------+ 801 | Communication | 802 | Session (CS) |----------------------+ 803 +----------------+ | 804 | | | 805 +----------------+ | 806 | | 807 |-------------------+ | 808 | | | | 809 +---------------+ | +---------------+ | 810 | ParticipantA | | | ParticipantB | | 811 | | | | | | 812 +---------------+ | +---------------+ | 813 | | | | 814 sends | | | sends | 815 | | | | 816 +---------------+ | +---------------+ | 817 |Media Stream A1| | |Media Stream B1| | 818 +---------------+ | +---------------+ | 819 |MediaStream Ref| | |MediaStream Ref| | 820 |codec params |---+---|codec params | | 821 +---------------+ +---------------+ | 822 | 823 +----------------------------------+ 824 | | | | 825 | | | | 826 +---------------+ | +---------------+ | 827 | ParticipantD | | | ParticipantE | | 828 | | | | | | 829 +---------------+ | +---------------+ | 830 | | | | 831 sends | | | sends | 832 | | | | 833 +---------------+ | +---------------+ | 834 |Media Stream D1| | |Media Stream E1| | 835 +---------------+ | +---------------+ | 836 |MediaStream Ref| | |MediaStream Ref| | 837 |codec params |---+---|codec params | | 838 +---------------+ +---------------+ | 839 | 840 | 841 +----------+ 842 +-----------------| 843 | | 844 | | 845 +----------------+ | 846 | Participant C | | 847 | (focus +src) | | 848 +----------------+ | 849 | | 850 Sends | +-------+ 851 | | 852 "sends" OR | | 853 contributed +----------------+ 854 by | Media Stream C1| 855 Participants+----------------+ "receives" by participants A,B,D,E 856 A,B,D,E | MediaStream Ref|------------------------------------ 857 ------------| Codec Params | 858 +----------------+ 860 In this example we have two participants A and B who are part of a 861 Communication Session(CS). One of the participants (C) is focus of a 862 conference and also acts as SRC. The SRC (Participant C) being the 863 Focus of the conference SHALL have access to the details of other 864 particiants. SRC (Participant C) SHALL send the same through the 865 metadata to SRS. In this instance diagram the Media Stream(mixed 866 stream) sent by C SHALL have media streams contributed by conference 867 participants (A, B, D and E). Participants A, B,D and E SHALL send 868 Media Streams A1, B1, D1 and E1 respectively. The media stream sent 869 by Participant C(Focus) shall be received by all other participants 870 of CS. For the sake of simplicity the "receives" line is not shown 871 linked to all other participants. 873 NOTE: SRC ( Participant C) MAY send mixed stream or seperate streams 874 to SRS 876 5.4.3. Case 3: 878 A CS where one of the participant is user and the SRC is a different 879 entity like B2BUA. In this case the SRC MAY not know that one of the 880 user is part of conference. Hence the instance diagram will not have 881 information about the conference participants. 883 +---------------------------------------------------+ 884 | Communication Session | 885 | +-------------+ +------+ +--------------+ | 886 | | | | (SRC)| | | | 887 | |Participant B|--|B2BUA |----| Participant A| | 888 | | (User in | +------+ | | | 889 | | conf) | | | | 890 | +-------------+ +--------------+ | 891 | | | | | | 892 +---------------------------------------------------+ 893 | | | | 894 | | | | 895 D E F G (Participants of Conference) 897 5.4.4. Case 4: 899 A CS where one of the participant is focus and the SRC is a different 900 entity like B2BUA. In this case the participant which is focus MAY 901 send "isfocus" in SIP message to SRC. The SRC MAY subscribe to 902 conference event package on seeing this "isfocus". SRC SHALL learn 903 the details of other participants of conference from the conference 904 package and send the same in metadata to SRS. The instance diagram 905 for this use case SHALL be same as Case 1. 907 +--------------------------------+ 908 | Conference Event Package | 909 | | 910 +--------------------------------+ 911 | 912 | subscribes 913 | 914 +---------------------|-----------------------------+ 915 | Communication |Session | 916 | +-------------+ +------+ +--------------+ | 917 | | | | (SRC)| | | | 918 | |Participant B|--|B2BUA |----| Participant A| | 919 | | (FOCUS in | +------+ | | | 920 | | conf) | | | | 921 | +-------------+ +--------------+ | 922 | | | | | | 923 +---------------------------------------------------+ 924 | | | | 925 | | | | 926 D E F G (Participants of Conference) 928 6. Security Considerations 930 The metadata information sent from SRC to SRS MAY reveal sensitive 931 Information about different participants of CS. For this reason, it 932 is RECOMMENDED that a SRC use a strong means for authentication and 933 metadata information protection and that it apply comprehensive 934 authorization rules when using the metadata model defined in this 935 document. The security considerations for this SHALL be defined in 936 the solution document. 938 7. IANA Considerations 940 Not Applicable 942 8. Acknowledgement 944 We wish to thank John Elwell, Henry Lum, Leon Portman, De Villers, 945 Andrew Hutton, Deepanshu Gautam, Charles Eckel for their valuable 946 comments. 948 9. References 950 9.1. Normative References 952 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 953 Requirement Levels", BCP 14, RFC 2119, March 1997. 955 9.2. Informative References 957 [I-D.ietf-siprec-req] 958 Rehor, K., Portman, L., Hutton, A., and R. Jain, 959 "Requirements for SIP-based Media Recording (SIPREC)", 960 draft-ietf-siprec-req-06 (work in progress), 961 December 2010. 963 [I-D.ietf-siprec-architecture] 964 Hutton, A., Portman, L., Jain, R., and K. Rehor, "An 965 Architecture for Media Recording using the Session 966 Initiation Protocol", draft-ietf-siprec-architecture-01 967 (work in progress), October 2010. 969 Authors' Addresses 971 Ram Mohan R 972 Cisco Systems, Inc. 973 Cessna Business Park, 974 Kadabeesanahalli Village, Varthur Hobli, 975 Sarjapur-Marathahalli Outer Ring Road 976 Bangalore, Karnataka 560103 977 India 979 Email: rmohanr@cisco.com 981 Parthasarathi R 982 Cisco Systems, Inc. 983 Cessna Business Park, 984 Kadabeesanahalli Village, Varthur Hobli, 985 Sarjapur-Marathahalli Outer Ring Road 986 Bangalore, Karnataka 560103 987 India 989 Email: partr@cisco.com 991 P. Kyzivat 992 Cisco Systems, Inc. 993 1414 Massachusetts Avenue 994 Boxborough, MA 01719 995 USA 997 Email: pkyzivat@cisco.com