idnits 2.17.1
draft-ietf-siprec-metadata-13.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 (November 24, 2013) is 3799 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)
** Obsolete normative reference: RFC 2141 (Obsoleted by RFC 8141)
** Obsolete normative reference: RFC 4566 (Obsoleted by RFC 8866)
== Outdated reference: A later version (-12) exists of
draft-ietf-siprec-architecture-09
Summary: 2 errors (**), 0 flaws (~~), 2 warnings (==), 1 comment (--).
Run idnits with the --verbose option for more detailed information about
the items above.
--------------------------------------------------------------------------------
2 SIPREC Ram Mohan. Ravindranath
3 Internet-Draft Cisco Systems, Inc.
4 Intended status: Standards Track Parthasarathi. Ravindran
5 Expires: May 28, 2014 Nokia Solutions and Networks
6 Paul. Kyzivat
7 Huawei
8 November 24, 2013
10 Session Initiation Protocol (SIP) Recording Metadata
11 draft-ietf-siprec-metadata-13
13 Abstract
15 Session recording is a critical requirement in many communications
16 environments such as call centers and financial trading. In some of
17 these environments, all calls must be recorded for regulatory,
18 compliance, and consumer protection reasons. Recording of a session
19 is typically performed by sending a copy of a media stream to a
20 recording device. This document describes the metadata model as
21 viewed by Session Recording Server(SRS) and the Recording metadata
22 format.
24 Status of this Memo
26 This Internet-Draft is submitted in full conformance with the
27 provisions of BCP 78 and BCP 79.
29 Internet-Drafts are working documents of the Internet Engineering
30 Task Force (IETF). Note that other groups may also distribute
31 working documents as Internet-Drafts. The list of current Internet-
32 Drafts is at http://datatracker.ietf.org/drafts/current/.
34 Internet-Drafts are draft documents valid for a maximum of six months
35 and may be updated, replaced, or obsoleted by other documents at any
36 time. It is inappropriate to use Internet-Drafts as reference
37 material or to cite them other than as "work in progress."
39 This Internet-Draft will expire on May 28, 2014.
41 Copyright Notice
43 Copyright (c) 2013 IETF Trust and the persons identified as the
44 document authors. All rights reserved.
46 This document is subject to BCP 78 and the IETF Trust's Legal
47 Provisions Relating to IETF Documents
48 (http://trustee.ietf.org/license-info) in effect on the date of
49 publication of this document. Please review these documents
50 carefully, as they describe your rights and restrictions with respect
51 to this document. Code Components extracted from this document must
52 include Simplified BSD License text as described in Section 4.e of
53 the Trust Legal Provisions and are provided without warranty as
54 described in the Simplified BSD License.
56 Table of Contents
58 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4
59 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 4
60 3. Definitions . . . . . . . . . . . . . . . . . . . . . . . . . 4
61 4. Metadata Model . . . . . . . . . . . . . . . . . . . . . . . . 5
62 5. Recording Metadata Format . . . . . . . . . . . . . . . . . . 6
63 5.1. XML data format . . . . . . . . . . . . . . . . . . . . . 6
64 5.1.1. Namespace . . . . . . . . . . . . . . . . . . . . . . 7
65 5.1.2. recording . . . . . . . . . . . . . . . . . . . . . . 7
66 6. Recording Metadata classes . . . . . . . . . . . . . . . . . . 7
67 6.1. Recording Session . . . . . . . . . . . . . . . . . . . . 7
68 6.1.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 8
69 6.1.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 8
70 6.1.3. XML element . . . . . . . . . . . . . . . . . . . . . 8
71 6.2. Communication Session Group . . . . . . . . . . . . . . . 9
72 6.2.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 9
73 6.2.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 9
74 6.2.3. XML element . . . . . . . . . . . . . . . . . . . . . 10
75 6.3. Communication Session . . . . . . . . . . . . . . . . . . 10
76 6.3.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 11
77 6.3.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 11
78 6.3.3. XML element . . . . . . . . . . . . . . . . . . . . . 12
79 6.4. CSRSAssociation . . . . . . . . . . . . . . . . . . . . . 12
80 6.4.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 13
81 6.4.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 13
82 6.4.3. XML element . . . . . . . . . . . . . . . . . . . . . 13
83 6.5. Participant . . . . . . . . . . . . . . . . . . . . . . . 13
84 6.5.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 14
85 6.5.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 14
86 6.5.3. XML element . . . . . . . . . . . . . . . . . . . . . 14
87 6.6. ParticipantCSAssociation . . . . . . . . . . . . . . . . . 15
88 6.6.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 15
89 6.6.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 16
90 6.6.3. XML element . . . . . . . . . . . . . . . . . . . . . 16
91 6.7. Media Stream . . . . . . . . . . . . . . . . . . . . . . . 16
92 6.7.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 17
93 6.7.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 17
94 6.7.3. XML element . . . . . . . . . . . . . . . . . . . . . 17
95 6.8. ParticipantStream Association . . . . . . . . . . . . . . 17
96 6.8.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 18
97 6.8.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 18
98 6.8.3. XML element . . . . . . . . . . . . . . . . . . . . . 18
99 6.9. associate-time/disassociate-time . . . . . . . . . . . . . 19
100 6.10. Unique ID format . . . . . . . . . . . . . . . . . . . . . 19
101 6.11. Metadata version Indicator . . . . . . . . . . . . . . . . 19
102 7. SIP Recording Metadata Example . . . . . . . . . . . . . . . . 20
103 7.1. Complete SIP Recording Metadata Example . . . . . . . . . 20
104 7.2. Partial Update of Recording metadata XML body . . . . . . 22
105 8. XML Schema definition for Recording metadata . . . . . . . . . 22
106 9. Security Considerations . . . . . . . . . . . . . . . . . . . 26
107 9.1. Connection Security . . . . . . . . . . . . . . . . . . . 26
108 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 26
109 10.1. SIP recording metadata Schema Registration . . . . . . . . 27
110 11. Acknowledgement . . . . . . . . . . . . . . . . . . . . . . . 27
111 12. References . . . . . . . . . . . . . . . . . . . . . . . . . . 27
112 12.1. Normative References . . . . . . . . . . . . . . . . . . . 27
113 12.2. Informative References . . . . . . . . . . . . . . . . . . 28
114 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 28
116 1. Introduction
118 Session recording is a critical requirement in many communications
119 environments such as call centers and financial trading. In some of
120 these environments, all calls must be recorded for regulatory,
121 compliance, and consumer protection reasons. Recording of a session
122 is typically performed by sending a copy of a media stream to a
123 recording device. This document focuses on the Recording metadata
124 which describes the communication session. The document describes a
125 metadata model as viewed by Session Recording Server and the
126 Recording metadata format, the requirements for which are described
127 in [RFC6341] and the architecture for which is described in
128 [I-D.ietf-siprec-architecture].
130 2. Terminology
132 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
133 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
134 document are to be interpreted as described in [RFC2119]. This
135 document only uses these key words when referencing normative
136 statements in existing RFCs."
138 3. Definitions
140 Metadata Model: An abstract representation of metadata using a
141 Unified Modelling Language(UML) class diagram.
143 Metadata classes: Each block in the model represents a class. A
144 class is a construct that is used as a blueprint to create
145 instances(called objects) of itself. The description of each class
146 also has representation of its attributes in a second compartment
147 below the class name.
149 Attributes: Attributes represents the attributes listed in each of
150 the classes. The attributes of a class are listed in the second
151 compartment below the class name. Each instance of class conveys
152 values for these attributes which adds to the recording's Metadata.
154 Linkages: Linkages represents the relationship between the classes in
155 the model. It represents the logical connections betweens classes(or
156 objects) in class diagrams/ object diagrams. The linkages used in
157 the Metadata model of this document are associations.
159 4. Metadata Model
161 Metadata is the information that describes recorded media and the CS
162 to which they relate. Below diagram shows a model for Metadata as
163 viewed by Session Recording Server (SRS).
165 +-------------------------------+
166 | Recording Session (RS) |
167 +-------------------------------+
168 |1..* | 1..*
169 | |
170 | | 0..*
171 | +-----------------+
172 +------------+ | | Communication |
173 | CSRS | | | Session (CS) |
174 | Association|--+ | Group |
175 | | | +-----------------+
176 +------------+ | | 0..1
177 | |
178 |0..* | 1..*
179 +-------------------------------+
180 | Communication Session (CS) |
181 | |
182 +-------------------------------+
183 | 1..* |0..1
184 +-----+ |
185 | | 0..* |0..*
186 | +-------------+ receives +----------------+
187 | | Participant |----------| Media Streams |
188 | | |0..* 0..*| |
189 | | | | |
190 | | | | |
191 | | | sends | |
192 | | |----------| |
193 | | |1.* 0..*| |
194 | +-------------+ +----------------+
195 | | |
196 | | |
197 | +------------------------+------------+
198 | |
199 | |
200 | +------------------+ +----------------------+
201 | |ParticipantCS | | ParticipantStream |
202 +-----------| Association | | Association |
203 | | | |
204 +------------------+ +----------------------+
206 The Metadata model is a class diagram in Unified Modelling
207 Language(UML). The model describes the structure of a metadata in
208 general by showing the classes, their attributes, and the
209 relationships among the classes. Each block in the model above
210 represents a class. The linkages between the classes represents the
211 relationships which can be associations or Composition. The metadata
212 is conveyed from SRC to SRS.
214 The model allows the capture of a snapshot of a recording's Metadata
215 at a given instant in time. Metadata changes to reflect changes in
216 what is being recorded. For example, if in a conference a
217 participant joins SRC sends a snapshot of metadata having that
218 participant information (with attributes like name/AoR pair and
219 associate-time) to the SRS.
221 Some of the metadata is not required to be conveyed explicitly from
222 the SRC to the SRS, if it can be obtained contextually by the
223 SRS(e.g., from SIP or SDP signalling).
225 5. Recording Metadata Format
227 This section gives an overview of Recording Metadata Format. Some
228 data from the metadata model is assumed to be made available to the
229 SRS through Session Description Protocol (SDP)[RFC4566], and
230 therefore this data is not represented in the XML document format
231 specified in this document. SDP attributes describes about different
232 media formats like audio, video. The other metadata attributes like
233 participant details are represented in a new Recording specific XML
234 document namely application/rs-metadata+xml. The SDP label attribute
235 [RFC4574] provides an identifier by which a metadata XML document can
236 refer to a specific media description in the SDP sent from the SRC to
237 the SRS.
239 The XML document format can be used to represent either the complete
240 metadata or a partial update to the metadata. The latter includes
241 only elements that have changed compared to the previously reported
242 metadata.
244 5.1. XML data format
246 Recording Metadata document is an XML document. recording element
247 MUST be present in all recording metadata XML document. recording
248 acts as container for all other elements in this XML document.
250 Recording object is a XML document. It MUST have the XML declaration
251 and it SHOULD contain an encoding declaration in the XML declaration,
252 e.g., "". If the charset
253 parameter of the MIME content type declaration is present and it is
254 different from the encoding declaration, the charset parameter takes
255 precedence.
257 Every application conforming to this specification MUST accept the
258 UTF-8 character encoding to ensure the minimal interoperability.
260 Syntax and semantics error in recording XML document has to be
261 informed to the originator using application specific mechanism.
263 5.1.1. Namespace
265 The namespace URI for elements defined by this specification is a
266 Uniform Resource Namespace (URN) [RFC2141], using the namespace
267 identifier 'ietf' defined by [RFC2648] and extended by [RFC3688].
269 The URN is as follows: urn:ietf:params:xml:ns:recording
271 5.1.2. recording
273 recording element MUST contain an xmlns namespace attribute with
274 value as urn:ietf:params:xml:ns:recording. One recording element
275 MUST be present in the all recording metadata XML document.
277 dataMode element shows whether the XML document is complete document
278 or partial update. The default value is complete.
280 6. Recording Metadata classes
282 This section describes each class of the metadata model, and the
283 attributes of each class. This section also describes how different
284 classes are linked and the XML element for each of them.
286 6.1. Recording Session
287 +-------------------------------+
288 | Recording Session (RS) |
289 +-------------------------------+
290 | |
291 | Start/End Time |
292 | |
293 | |
294 | |
295 +-------------------------------+
296 |1..* | 1..*
297 | |
298 |0..* | 0..*
299 Communication Communication
300 Session Session Group(CS Group)
302 Each instance of a Recording Session class (namely the Recording
303 Session Object) represents a SIP session created between an SRC and
304 SRS for the purpose of recording a Communication Session.
306 6.1.1. Attributes
308 A Recording Session class has the following attributes:
309 o Start/End Time - Represents the Start/End time of a Recording
310 Session object.
312 6.1.2. Linkages
314 Each instance of Recording Session has:
316 o Zero or more instances of Communication Session Group. CSG may be
317 zero because it is optional metadata object. Also the allowance
318 of zero instances is to accommodate persistent recording, where
319 there may be none.
320 o Zero or more instances of Communication Session objects.
322 6.1.3. XML element
324 Recording Session object is represented by recording XML element.
325 That in turn relies on the SIP/SDP session with which the XML
326 document is associated to provide some of the attributes of the
327 Recording Session element.
329 Start and End time value are derivable from Date header(if present in
330 SIP message) in RS. In cases where Date header is not present,
331 Start/End time are derivable from the time at which SRS receives the
332 notification of SIP message to setup RS / disconnect RS.
334 6.2. Communication Session Group
336 Recording Session (RS)
337 | 1..*
338 |
339 | 0..*
340 +-------------------------------+
341 | Communication Session |
342 | Group |
343 +-------------------------------+
344 | Unique-ID |
345 | associate-time |
346 | disassociate-time |
347 | |
348 +-------------------------------+
349 | 0..1
350 |
351 | 1..*
352 Communication Session (CS)
354 One instance of a Communication Session Group class (namely the
355 Communication Session Group object) provides association or linking
356 of Communication Sessions.
358 6.2.1. Attributes
360 A CS Group has the following attributes:
361 o Unique-ID - This Unique-ID is to group different CSs that are
362 related. SRC (or SRS) is responsible for ensuring the uniqueness
363 of Unique-ID in case multiple SRC interacts with the same SRS.
364 The mechanism by which SRC groups the CS is outside the scope of
365 SIPREC.
366 o Associate-time - Associate-time for CS-Group shall be calculated
367 by SRC as the time when a grouping is formed. The rules that
368 determine how a grouping of different Communication Session
369 objects is done by SRC is outside the scope of SIPREC.
370 o Disassociate-time - Disassociate-time for CS-Group shall be
371 calculated by SRC as the time when the grouping ends
373 6.2.2. Linkages
375 The linkages between Communication Session Group class and other
376 classes is association. A communication Session Group is associated
377 with RS and CS in the following manner:
379 o There is one or more Recording Session objects per Communication
380 Session Group.
381 o Each Communication Session Group object has to be associated with
382 one or more RS [Here each RS can be setup by the potentially
383 different SRCs]
384 o There is one or more Communication Sessions per CS Group [e.g.
385 Consult Transfer]
387 6.2.3. XML element
389 Group element is an optional element provides the information about
390 the communication session group
392 Each communication session group (CSG)object is represented using one
393 group element. Each group element has unique Base 64 URN UUID
394 attribute which helps to uniquely identify CSG.
396 6.3. Communication Session
398 Recording Communication
399 Session Session Group(CS Group)
400 |1..* | 0..1
401 | |
402 |0..* | 1..*
403 +-------------------------------+
404 | Communication Session (CS) |
405 | |
406 +-------------------------------+
407 | CS Identifier |
408 | Termination Reason |
409 | Start-time |
410 | Stop-time |
411 +-------------------------------+
412 | |
413 | 0..* |0..1
414 | |
415 | 0..* |0..*
416 Participant Media Stream
418 A Communication Session class and its object in the metadata model
419 represents Communication Session and its properties needed as seen by
420 SRC.
422 6.3.1. Attributes
424 A communication Session class has the following attributes:
426 o Termination Reason - This represents the reason why a CS was
427 terminated. The communication session MAY contain a Call
428 Termination Reason. This MAY be derived from SIP Reason header
429 [RFC3326] of CS.
430 o CS Identifier - This attribute is used to uniquely identify a CS.
431 o Start-time - This optional attribute represents start time of CS
432 as seen by SRC
433 o Stop-time - This optional attribute represents stop time of CS as
434 seen by SRC
436 This document does not specify attributes relating to what should
437 happen to a recording of a CS after it has been delivered to the SRS,
438 e.g., how long to retain the recording, what access controls to
439 apply. The SRS is assumed to behave in accordance with policy. The
440 ability for the SRC to influence this policy is outside the scope of
441 this document. However if there are implementations where SRC has
442 enough information, this could be sent as Extension Data attached to
443 CS
445 6.3.2. Linkages
447 A Communication Session is linked to CS-Group, Participant, Media
448 Stream and Recording Session classes using the association
449 relationship. Association between CS and Participant allows:
451 o CS to have atleast zero or more participants
452 o Participant is associated with zero or more CSs. This includes
453 participants who are not directly part of any CS. An example of
454 such a case is participants in a premixed media stream. The SRC
455 may have knowledge of such Participants, yet not have any
456 signaling relationship with them. This might arise if one
457 participant in CS is a conf focus. To summarize even if SRC does
458 not have direct signalling relationships with all participants in
459 a CS, it should nevertheless create a Participant object for each
460 participant that it knows about.
461 o The model also allows participants in CS that are not participants
462 in the media. An example is the identity of a 3pcc controller
463 that has initiated a CS to two or more participants of the CS.
464 Another example is the identity of a conference focus. Of course
465 a focus is probably in the media, but since it may only be there
466 as a mixer, it may not report itself as a participant in any of
467 the media streams.
469 Association between CS and Media Stream allows:
471 o A CS to have zero or more Streams
472 o A stream can be associated with at most one CS. Stream in
473 persistent RS is not required to be associated with any CS before
474 CS is created and hence the zero association is allowed.
476 Association between CS and RS allows:
478 o Each instance of RS has Zero or more instances of Communication
479 Session objects.
480 o Each CS has to be associated with one more RS [ Here each RS can
481 be potentially setup by different SRCs]
483 6.3.3. XML element
485 Session element provides the information about the communication
486 session
488 Each communication session(CS) object is represented by one session
489 element. Each session element has unique Base 64 URN UUID attribute
490 which helps to uniquely identify CS.
492 The XML reason element MAY be included in metadata to represent a CS
493 Termination Reason. There MAY be multiple instances of the XML
494 reason element inside a session element. The reason XML element has
495 'protocol' as an attribute, which indicates the protocol from which
496 the reason string is derived. The default value for protocol
497 attribute is "SIP".
499 group-ref element MAY exist to indicate the group where the mentioned
500 session belongs.
502 6.4. CSRSAssociation
504 1..* 0..*
505 Recording Communication
506 Session ----------+---------- Session
507 |
508 |
509 |
510 +-------------------+
511 | CSRSAssociation |
512 +-------------------+
513 | Association-Time |
514 | Disassociaton-Time|
515 +-------------------+
517 A CSRS Association class and its objects has attributes of CS object
518 which are attributes of association of a session to a RS.
520 6.4.1. Attributes
522 CSRS association class has the following attributes:
524 o Associate-time - associate-time is calculated by SRC as the time
525 it sees a CS is associated to a RS
526 o Disassociate-time- Disassociate-time is calculated by SRC as the
527 time it see a CS disassociate from a RS.
528 It is possible that a given CS can have multiple associate/
529 disassociate times within given RS.
531 6.4.2. Linkages
533 CSRS association class is linked to CS and RS classes. There are no
534 cardinalties for this linkage.
536 6.4.3. XML element
538 sessionrecordingassoc is the XML element to represent CSRS
539 association object. session URN UUID is used to uniquely identify
540 this element and link with the specific session.
542 6.5. Participant
544 Communication Session (CS)
545 | 0..*
546 |
547 | 0..*
548 +-------------------------------+
549 | Participant |
550 | |
551 +-------------------------------+
552 | AoR / Name Pair list |
553 | |
554 | |
555 +-------------------------------+
556 | 0..* 1..*|
557 receives| |sends
558 | 0..* 0..*|
559 Media Stream
561 A Participant class and its objects has information about a device
562 that is part of a CS and/or contributes/consumes media stream(s)
563 belonging to a CS.
565 6.5.1. Attributes
567 Participant has attributes like:
569 o AoR / Name pair list - This attribute is a list of Name/AoR tuple.
570 An AoR MAY be SIP/SIPS/TEL URI. Name represents Participant
571 name(SIP display name) or DN number ( in case it is known). There
572 are cases where a participant can have more than one AoR [e.g.
573 P-Asserted-identity header [RFC3325] which can have both SIP and
574 TEL URIs]
576 This document does not specify other attributes relating to
577 participant e.g. Participant Role, Participant type. An SRC which
578 has information of these attributes can indicate the same as part of
579 extension data to Participant from SRC to SRS.
581 6.5.2. Linkages
583 The participant class is linked to MS and CS class using association
584 relationship. The association between participant and Media Stream
585 allows:
587 o Participant to receives zero or more media streams
588 o Participant to send zero or more media streams. (Same participant
589 provides multiple streams e.g. audio and video)
590 o Media stream to be received by zero or more participants. Its
591 possible, though perhaps unlikely, that a stream is generated but
592 sent only to the SRC and SRS, not to any participant. E.g. In
593 conferencing where all participants are on hold and the SRC is
594 collocated with the focus. Also a media stream may be received by
595 multiple participants (e.g. Whisper calls, side conversations).
596 o Media stream to be sent by one or more participants (pre-mixed
597 streams).
599 Example of a case where a participant receives Zero or more streams -
600 a Supervisor may have side conversation with Agent, while Agent
601 converses with customer.
603 6.5.3. XML element
605 A participant element represents a Participant object.
607 Participant MUST have a NameID complex element which contains AoR as
608 attribute and Name as element. AOR element is SIP/SIPS URI FQDN or
609 IP address which represents the user. name is an optional element to
610 represent display name.
612 Each participant element has unique ID (Base 64 URN UUID) attribute
613 which helps to uniquely identify participant and session Base 64 URN
614 UUID to associate participant with specific session element. Base 64
615 URN UUID of participant MUST used in the scope of CSG and no new Base
616 64 URN UUID has to be created for the same element (participant,
617 stream) between different CS in the same CSG. In case Base 64 URN
618 UUID has to be used permanent, careful usage of Base 64 URN UUID to
619 original AoR has to be decided by the implementers and it is
620 implementer's choice.
622 6.6. ParticipantCSAssociation
624 1..* 0..*
625 Communication
626 Session ----------+---------- Participant
627 |
628 |
629 |
630 +-------------------+
631 | ParticipantCS |
632 | Association |
633 +-------------------+
634 | Capabilities |
635 | Association-Time |
636 | Disassociaton-Time|
637 +-------------------+
639 A participantCS Association class and its objects has attributes of
640 participant object which are attributes of association of a
641 participant to a Session.
643 6.6.1. Attributes
645 ParticipantCS association class has the following attributes:
647 o Associate-time - associate-time is calculated by SRC as the time
648 it sees a participant is associated to CS
649 o Disassociate-time- Disassociate-time is calculated by SRC as the
650 time it see a participant disassociate from a CS. It is possible
651 that a given participant can have multiple associate/disassociate
652 times within given communication session.
654 o Capabilities - A participant capabilities as defined in [RFC3840]
655 which is an optional attribute that includes the capabilities of a
656 participant in a CS. Each participant shall have Zero or more
657 capabilities. A participant may use different capabilities
658 depending on the role it plays at a particular instance. IOW if a
659 participants moves across different CSs ( due to transfer e.t.c)
660 OR is simultaneously present in different CSs its role may be
661 different and hence the capability used.
663 6.6.2. Linkages
665 The participantCS association class is linked to participant and CS
666 classes. There are no cardinalties for this linkage.
668 6.6.3. XML element
670 participantsessionassoc XML element represent participantCS
671 association object. participant and session id is used to uniquely
672 identify this element
674 NOTE: RFC 4235 encoding shall be used to represent capabilities
675 attribute in XML.
677 6.7. Media Stream
679 Participant
680 | 0..* 1..*|
681 receives| |sends
682 | 0..* 0..*|
683 +-------------------------+
684 | Media Stream |
685 | |
686 Communication 0..1 0..* +-------------------------+
687 Session ------------| |
688 | Media Stream Reference |
689 | Content-type |
690 | |
691 +-------------------------+
693 A Media Stream class (and its objects) has the properties of media as
694 seen by SRC and sent to SRS. Different snapshots of media stream
695 object may be sent whenever there is a change in media (e.g. dir
696 change like pause/resume and/or codec change and/or participant
697 change.).
699 6.7.1. Attributes
701 A Media Stream class has the the following attributes:
703 o Media Stream Reference - In implementations this can reference to
704 m-line
705 o Content - The content of an MS element will be described in terms
706 of value from the [RFC4796] registry.
708 The metadata model should include media streams that are not being
709 delivered to the SRS. Examples include cases where SRC offered
710 certain media types but SRS chooses to accept only a subset of them
711 OR an SRC may not even offer a certain media type due it its
712 restrictions to record
714 6.7.2. Linkages
716 A Media Stream is linked to participant and CS classes using the
717 association relationship. The details of association with the
718 Participant are described in the Participant class section. The
719 details of association with CS is mentioned in the CS section.
721 6.7.3. XML element
723 stream element represents a Media Stream object. Stream element
724 indicates SDP media lines associated with the session and
725 participants.
727 This element indicates the SDP m-line properties like label
728 attributes. Label attribute is used to link m-line SDP body using
729 label attribute in SDP m-line.
731 Each stream element has unique Base 64 URN UUID attribute which helps
732 to uniquely identify stream and session Base 64 URN UUID to associate
733 stream with specific session element.
735 The content attribute if an SRC wishes to send is conveyed in RS SDP.
737 6.8. ParticipantStream Association
738 +-------------------+
739 | ParticipantSteam |
740 | Association |
741 +-------------------+ +----------Participant
742 | Association-Time | | 0..*| 1..*|
743 | Disassociaton-Time|---+ recv| |sends
744 | Recv | | 0..*| 0..*|
745 | Send | | | |
746 +-------------------+ | | |
747 +----------Media Stream
749 A ParticipantStream association class and its object has attributes
750 that are attributes of association of a Participant to a Stream.
752 6.8.1. Attributes
754 A participantStream association class has the following attributes:
756 o Associate-Time: This attributes indicates the time a Participant
757 started contributing to a Media Stream
758 o Disassociate-Time: This attribute indicates the time a Participant
759 stopped contributing to a Media Stream
760 o Recv: This attribute indicates whether a Participant is receiving
761 a media stream or not. This attribute has a value which points to
762 a stream represented by its Unique_id. The presence of this
763 attribute indicates that a participant is receiving a stream
764 represented by the Unique_id. If due to changes in CS(like hold)
765 the participants stops receiving a stream, a snapshot MUST be sent
766 from SRC to SRS with no Recv element for that stream.
767 o Send: This attribute indicates whether a participant is
768 contributing to a stream or not. This attribute has a value which
769 points to stream represented by its unique_id. The presence of
770 this attribute indicates that a participant is contributing to a
771 stream represented by the Unique_id. If due to changes in CS if a
772 participant stops contributing to a stream, a snapshot MUST be
773 sent from SRC to SRS with no Send element for that stream.
775 6.8.2. Linkages
777 The participantStream association class is linked to participant and
778 Stream classes. There are no cardinalties for this linkage.
780 6.8.3. XML element
782 The participantstreamassoc complex XML element represents the
783 participant to stream association object. This XML element is used
784 to represent a snapshot of a participant association with a stream.
785 The send and recv XML elements MUST be used to indicate whether a
786 participant is contributing to a stream or receiving a stream. There
787 MAY be multiple instances of the send and recv XML elements inside a
788 particpantstreamassoc element. If a metadata snapshot is sent with a
789 participantstreamassoc that does not have any send and recv elements,
790 it means that participant is neither contributing to any streams nor
791 receiving any streams.
793 6.9. associate-time/disassociate-time
795 associate-time/disassociate-time contains a string indicating the
796 date and time of the status change of this tuple. The value of this
797 element MUST follow the IMPP datetime format [RFC3339]. Timestamps
798 that contain 'T' or 'Z' MUST use the capitalized forms. At a time,
799 any of the time tuple associate-time or disassociate-time MAY exist
800 in the element namely group, session, participant and not both
801 timestamp at the same time.
803 As a security measure, the timestamp element SHOULD be included in
804 all tuples unless the exact time of the status change cannot be
805 determined.
807 6.10. Unique ID format
809 Unique id is generated in two steps:
810 o UUID is created using [RFC4122])
811 o UUID is encoded using base64 as defined in [RFC4648]
813 The above mentioned unique-id mechanism SHOULD be used for each
814 metadata element. Multiple SRCs can refer to the same element/UUID
815 (how each SRC learns the UUID here is out of scope of SIPREC)
817 6.11. Metadata version Indicator
819 This section defines a version indicator for metadata XML.
821 This version value allows the SRS to know the exact metadata XML
822 schema sent by the SRC. This document describes version 1. The
823 value '1' represent SIPREC metadata version. Implementations may not
824 interoperate if the version implemented by the sender is not known by
825 the receiver. No negotiation of versions is provided. There is no
826 significance to the version number although documents which update or
827 obsolete this document (possibly including drafts of such documents)
828 should include a higher version number if the metadata XML schema
829 changes.
831 7. SIP Recording Metadata Example
833 7.1. Complete SIP Recording Metadata Example
835 The following example provides all the tuples involved in Recording
836 Metadata XML body.
838
839
840 complete
841
842 2010-12-16T23:41:07Z
843
844
845 sip:alice@atlanta.com
846
847
848 FOO!
849 bar
850
851
852
853 7+OTCyoxTmqmqyA/1weDAg==
854
855
856 FaXHlc+3WruaroDaNE87am==
857 FOO!
858 bar
859
860
861 2010-12-16T23:41:07Z
862
863
865
866 Bob B
867
868
869 FOO!
870 bar
871
872
875 2010-12-16T23:41:07Z
876
877
879 i1Pz3to5hGk8fuXl+PbwCw==
880 UAAMm5GRQKSCMVvLyl4rFw==
881 8zc6e0lYTlWIINA6GR+3ag==
882 EiXGlc+4TruqqoDaNE76ag==
883
884
886
887 Paul
888
889
890 FOO!
891 bar
892
893
896 2010-12-16T23:41:07Z
897
898
900 8zc6e0lYTlWIINA6GR+3ag==
901 EiXGlc+4TruqqoDaNE76ag==
902 UAAMm5GRQKSCMVvLyl4rFw==
903 i1Pz3to5hGk8fuXl+PbwCw==
904
905
907
908
909
911
912
913
915
916
917
919
920
921
923 SIP Recording Metadata Example XML body
925 7.2. Partial Update of Recording metadata XML body
927 The following example provides partial update in Recording Metadata
928 XML body for the above example. The example has a snapshot that
929 carries the disassociate-time for a participant from a session.
931
932
933 partial
934
936
937 Bob R
938
939 FOO!
940 bar
941
942
945 2010-12-16T23:41:07Z
946
947
949 Partial update of SIP Recording Example XML body
951 8. XML Schema definition for Recording metadata
953 This section defines XML schema for Recording metadata document
955
956
961
962
963
964
965
966
968
970
972
974
976
979
982
985
989
990
991
992
993
995
997
1001
1002
1004
1006
1007
1008
1010
1012
1014
1016
1020
1021
1023
1024
1025
1026
1028
1030
1034
1035
1037
1038
1039
1040
1042
1046
1047
1049
1050
1051
1052
1054
1056
1060
1061
1063
1066
1067
1068
1069
1071
1073
1075
1077
1081
1082
1084
1085
1086
1087
1089
1093
1094
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1128 9. Security Considerations
1130 The metadata information sent from SRC to SRS MAY reveal sensitive
1131 information about different participants in a session. For this
1132 reason, it is RECOMMENDED that a SRC use a strong means for
1133 authentication and metadata information protection and that it apply
1134 comprehensive authorization rules when using the metadata format
1135 defined in this document. The below section discusses each of these
1136 aspects in more detail.
1138 9.1. Connection Security
1140 It is RECOMMENDED that a SRC authenticate SRS using the normal SIP
1141 authentication mechanisms, such as Digest as defined in Section 22 of
1142 [RFC3261]. The mechanism used for conveying the metadata information
1143 MUST ensure integrity and SHOULD ensure confidentially of the
1144 information. In order to achieve these, an end-to-end SIP encryption
1145 mechanism, such as S/MIME described in [RFC3261], SHOULD be used.
1147 If a strong end-to-end security means (such as above) is not
1148 available, it is RECOMMENDED that a SRC use mutual hop-by-hop
1149 Transport Layer Security (TLS) authentication and encryption
1150 mechanisms described in "SIPS URI Scheme" and "Interdomain Requests"
1151 of [RFC3261].
1153 10. IANA Considerations
1155 This specification registers a new XML namespace, and a new XML
1156 schema.
1158 10.1. SIP recording metadata Schema Registration
1160 URI: urn:ietf:params:xml:ns:recording
1162 Registrant Contact: IETF SIPREC working group, Ram mohan
1163 R(rmohanr@cisco.com)
1165 XML: the XML schema to be registered is contained in Section 8.
1167 Its first line is and its last
1168 line is
1170 11. Acknowledgement
1172 We wish to thank John Elwell, Henry Lum, Leon Portman, De Villers,
1173 Andrew Hutton(Siemens-Enterprise), Deepanshu Gautam(Huawei),Charles
1174 Eckel(Cisco), Muthu Arul Mozhi (Cisco), Michael Benenson(Cisco),
1175 Hadriel Kaplan (ACME), Brian Rosen, Scott Orton(Broadsoft), Ofir Roth
1176 (NICE), Mary Barnes(Polycom), Ken Rehor(Cisco) for their valuable
1177 comments and inputs.
1179 We wish to thank Joe Hildebrand(Cisco), Peter Saint-Andre(Cisco),
1180 Matt Miller(Cisco) for the valuable XML related guidance and Martin
1181 Thompson for validating the XML schema and providing comments on the
1182 same.
1184 12. References
1186 12.1. Normative References
1188 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
1189 Requirement Levels", BCP 14, RFC 2119, March 1997.
1191 [RFC2141] Moats, R., "URN Syntax", RFC 2141, May 1997.
1193 [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston,
1194 A., Peterson, J., Sparks, R., Handley, M., and E.
1195 Schooler, "SIP: Session Initiation Protocol", RFC 3261,
1196 June 2002.
1198 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
1199 January 2004.
1201 [RFC3339] Klyne, G., Ed. and C. Newman, "Date and Time on the
1202 Internet: Timestamps", RFC 3339, July 2002.
1204 [RFC4566] Handley, M., Jacobson, V., and C. Perkins, "SDP: Session
1205 Description Protocol", RFC 4566, July 2006.
1207 [RFC4574] Levin, O. and G. Camarillo, "The Session Description
1208 Protocol (SDP) Label Attribute", RFC 4574, August 2006.
1210 [RFC4796] Hautakorpi, J. and G. Camarillo, "The Session Description
1211 Protocol (SDP) Content Attribute", RFC 4796,
1212 February 2007.
1214 [RFC3840] Rosenberg, J., Schulzrinne, H., and P. Kyzivat,
1215 "Indicating User Agent Capabilities in the Session
1216 Initiation Protocol (SIP)", RFC 3840, August 2004.
1218 [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally
1219 Unique IDentifier (UUID) URN Namespace", RFC 4122,
1220 July 2005.
1222 [RFC4648] Josefsson, S., "The Base16, Base32, and Base64 Data
1223 Encodings", RFC 4648, October 2006.
1225 12.2. Informative References
1227 [RFC6341] Rehor, K., Portman, L., Hutton, A., and R. Jain, "Use
1228 Cases and Requirements for SIP-Based Media Recording
1229 (SIPREC)", RFC 6341, August 2011.
1231 [I-D.ietf-siprec-architecture]
1232 Hutton, A., Portman, L., Jain, R., and K. Rehor, "An
1233 Architecture for Media Recording using the Session
1234 Initiation Protocol", draft-ietf-siprec-architecture-09
1235 (work in progress), October 2013.
1237 [RFC2648] Moats, R., "A URN Namespace for IETF Documents", RFC 2648,
1238 August 1999.
1240 [RFC3326] Schulzrinne, H., Oran, D., and G. Camarillo, "The Reason
1241 Header Field for the Session Initiation Protocol (SIP)",
1242 RFC 3326, December 2002.
1244 [RFC3325] Jennings, C., Peterson, J., and M. Watson, "Private
1245 Extensions to the Session Initiation Protocol (SIP) for
1246 Asserted Identity within Trusted Networks", RFC 3325,
1247 November 2002.
1249 Authors' Addresses
1251 Ram Mohan Ravindranath
1252 Cisco Systems, Inc.
1253 Cessna Business Park,
1254 Kadabeesanahalli Village, Varthur Hobli,
1255 Sarjapur-Marathahalli Outer Ring Road
1256 Bangalore, Karnataka 560103
1257 India
1259 Email: rmohanr@cisco.com
1261 Parthasarathi Ravindran
1262 Nokia Solutions and Networks
1263 Bangalore, Karnataka
1264 India
1266 Email: partha@parthasarathi.co.in
1268 Paul Kyzivat
1269 Huawei
1270 Hudson, MA
1271 USA
1273 Email: pkyzivat@alum.mit.edu