idnits 2.17.1
draft-ietf-siprec-metadata-12.txt:
Checking boilerplate required by RFC 5378 and the IETF Trust (see
https://trustee.ietf.org/license-info):
----------------------------------------------------------------------------
No issues found here.
Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt:
----------------------------------------------------------------------------
No issues found here.
Checking nits according to https://www.ietf.org/id-info/checklist :
----------------------------------------------------------------------------
No issues found here.
Miscellaneous warnings:
----------------------------------------------------------------------------
== The copyright year in the IETF Trust and authors Copyright Line does not
match the current year
-- The document date (May 28, 2013) is 3986 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-08
Summary: 2 errors (**), 0 flaws (~~), 2 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 Cisco Systems, Inc.
3 Intended status: Standards Track Parthasarathi. Ravindran
4 Expires: November 29, 2013 Nokia Siemens Networks
5 Paul. Kyzivat
6 Huawei
7 May 28, 2013
9 Session Initiation Protocol (SIP) Recording Metadata
10 draft-ietf-siprec-metadata-12
12 Abstract
14 Session recording is a critical requirement in many communications
15 environments such as call centers and financial trading. In some of
16 these environments, all calls must be recorded for regulatory,
17 compliance, and consumer protection reasons. Recording of a session
18 is typically performed by sending a copy of a media stream to a
19 recording device. This document describes the metadata model as
20 viewed by Session Recording Server(SRS) and the Recording metadata
21 format.
23 Status of this Memo
25 This Internet-Draft is submitted in full conformance with the
26 provisions of BCP 78 and BCP 79.
28 Internet-Drafts are working documents of the Internet Engineering
29 Task Force (IETF). Note that other groups may also distribute
30 working documents as Internet-Drafts. The list of current Internet-
31 Drafts is at http://datatracker.ietf.org/drafts/current/.
33 Internet-Drafts are draft documents valid for a maximum of six months
34 and may be updated, replaced, or obsoleted by other documents at any
35 time. It is inappropriate to use Internet-Drafts as reference
36 material or to cite them other than as "work in progress."
38 This Internet-Draft will expire on November 29, 2013.
40 Copyright Notice
42 Copyright (c) 2013 IETF Trust and the persons identified as the
43 document authors. All rights reserved.
45 This document is subject to BCP 78 and the IETF Trust's Legal
46 Provisions Relating to IETF Documents
47 (http://trustee.ietf.org/license-info) in effect on the date of
48 publication of this document. Please review these documents
49 carefully, as they describe your rights and restrictions with respect
50 to this document. Code Components extracted from this document must
51 include Simplified BSD License text as described in Section 4.e of
52 the Trust Legal Provisions and are provided without warranty as
53 described in the Simplified BSD License.
55 Table of Contents
57 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4
58 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 4
59 3. Definitions . . . . . . . . . . . . . . . . . . . . . . . . . 4
60 4. Metadata Model . . . . . . . . . . . . . . . . . . . . . . . . 5
61 5. Recording Metadata Format . . . . . . . . . . . . . . . . . . 6
62 5.1. XML data format . . . . . . . . . . . . . . . . . . . . . 6
63 5.1.1. Namespace . . . . . . . . . . . . . . . . . . . . . . 7
64 5.1.2. recording . . . . . . . . . . . . . . . . . . . . . . 7
65 6. Recording Metadata classes . . . . . . . . . . . . . . . . . . 7
66 6.1. Recording Session . . . . . . . . . . . . . . . . . . . . 7
67 6.1.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 8
68 6.1.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 8
69 6.1.3. XML element . . . . . . . . . . . . . . . . . . . . . 8
70 6.2. Communication Session Group . . . . . . . . . . . . . . . 9
71 6.2.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 9
72 6.2.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 9
73 6.2.3. XML element . . . . . . . . . . . . . . . . . . . . . 10
74 6.3. Communication Session . . . . . . . . . . . . . . . . . . 10
75 6.3.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 11
76 6.3.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 11
77 6.3.3. XML element . . . . . . . . . . . . . . . . . . . . . 12
78 6.4. CSRSAssociation . . . . . . . . . . . . . . . . . . . . . 12
79 6.4.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 13
80 6.4.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 13
81 6.4.3. XML element . . . . . . . . . . . . . . . . . . . . . 13
82 6.5. Participant . . . . . . . . . . . . . . . . . . . . . . . 13
83 6.5.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 14
84 6.5.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 14
85 6.5.3. XML element . . . . . . . . . . . . . . . . . . . . . 14
86 6.6. ParticipantCSAssociation . . . . . . . . . . . . . . . . . 15
87 6.6.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 15
88 6.6.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 16
89 6.6.3. XML element . . . . . . . . . . . . . . . . . . . . . 16
90 6.7. Media Stream . . . . . . . . . . . . . . . . . . . . . . . 16
91 6.7.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 17
92 6.7.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 17
93 6.7.3. XML element . . . . . . . . . . . . . . . . . . . . . 17
94 6.8. ParticipantStream Association . . . . . . . . . . . . . . 17
95 6.8.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 18
96 6.8.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 18
97 6.8.3. XML element . . . . . . . . . . . . . . . . . . . . . 18
98 6.9. associate-time/disassociate-time . . . . . . . . . . . . . 19
99 6.10. Unique ID format . . . . . . . . . . . . . . . . . . . . . 19
100 6.11. Metadata version Indicator . . . . . . . . . . . . . . . . 19
101 7. SIP Recording Metadata Example . . . . . . . . . . . . . . . . 20
102 7.1. Complete SIP Recording Metadata Example . . . . . . . . . 20
103 7.2. Partial Update of Recording metadata XML body . . . . . . 22
104 8. XML Schema definition for Recording metadata . . . . . . . . . 22
105 9. Security Considerations . . . . . . . . . . . . . . . . . . . 26
106 9.1. Connection Security . . . . . . . . . . . . . . . . . . . 26
107 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 26
108 10.1. SIP recording metadata Schema Registration . . . . . . . . 27
109 11. Acknowledgement . . . . . . . . . . . . . . . . . . . . . . . 27
110 12. References . . . . . . . . . . . . . . . . . . . . . . . . . . 27
111 12.1. Normative References . . . . . . . . . . . . . . . . . . . 27
112 12.2. Informative References . . . . . . . . . . . . . . . . . . 28
113 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 28
115 1. Introduction
117 Session recording is a critical requirement in many communications
118 environments such as call centers and financial trading. In some of
119 these environments, all calls must be recorded for regulatory,
120 compliance, and consumer protection reasons. Recording of a session
121 is typically performed by sending a copy of a media stream to a
122 recording device. This document focuses on the Recording metadata
123 which describes the communication session. The document describes a
124 metadata model as viewed by Session Recording Server and the
125 Recording metadata format, the requirements for which are described
126 in [RFC6341] and the architecture for which is described in
127 [I-D.ietf-siprec-architecture].
129 2. Terminology
131 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
132 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
133 document are to be interpreted as described in [RFC2119]. This
134 document only uses these key words when referencing normative
135 statements in existing RFCs."
137 3. Definitions
139 Metadata Model: An abstract representation of metadata using a
140 Unified Modelling Language(UML) class diagram.
142 Metadata classes: Each block in the model represents a class. A
143 class is a construct that is used as a blueprint to create
144 instances(called objects) of itself. The description of each class
145 also has representation of its attributes in a second compartment
146 below the class name.
148 Attributes: Attributes represents the attributes listed in each of
149 the classes. The attributes of a class are listed in the second
150 compartment below the class name. Each instance of class conveys
151 values for these attributes which adds to the recording's Metadata.
153 Linkages: Linkages represents the relationship between the classes in
154 the model. It represents the logical connections betweens classes(or
155 objects) in class diagrams/ object diagrams. The linkages used in
156 the Metadata model of this document are associations.
158 4. Metadata Model
160 Metadata is the information that describes recorded media and the CS
161 to which they relate. Below diagram shows a model for Metadata as
162 viewed by Session Recording Server (SRS).
164 +-------------------------------+
165 | Recording Session (RS) |
166 +-------------------------------+
167 |1..* | 1..*
168 | |
169 | | 0..*
170 | +-----------------+
171 +------------+ | | Communication |
172 | CSRS | | | Session (CS) |
173 | Association|--+ | Group |
174 | | | +-----------------+
175 +------------+ | | 0..1
176 | |
177 |0..* | 1..*
178 +-------------------------------+
179 | Communication Session (CS) |
180 | |
181 +-------------------------------+
182 | 1..* |0..1
183 +-----+ |
184 | | 0..* |0..*
185 | +-------------+ receives +----------------+
186 | | Participant |----------| Media Streams |
187 | | |0..* 0..*| |
188 | | | | |
189 | | | | |
190 | | | sends | |
191 | | |----------| |
192 | | |1.* 0..*| |
193 | +-------------+ +----------------+
194 | | |
195 | | |
196 | +------------------------+------------+
197 | |
198 | |
199 | +------------------+ +----------------------+
200 | |ParticipantCS | | ParticipantStream |
201 +-----------| Association | | Association |
202 | | | |
203 +------------------+ +----------------------+
205 The Metadata model is a class diagram in Unified Modelling
206 Language(UML). The model describes the structure of a metadata in
207 general by showing the classes, their attributes, and the
208 relationships among the classes. Each block in the model above
209 represents a class. The linkages between the classes represents the
210 relationships which can be associations or Composition. The metadata
211 is conveyed from SRC to SRS.
213 The model allows the capture of a snapshot of a recording's Metadata
214 at a given instant in time. Metadata changes to reflect changes in
215 what is being recorded. For example, if in a conference a
216 participant joins SRC sends a snapshot of metadata having that
217 participant information (with attributes like name/AoR pair and
218 associate-time) to the SRS.
220 Some of the metadata is not required to be conveyed explicitly from
221 the SRC to the SRS, if it can be obtained contextually by the
222 SRS(e.g., from SIP or SDP signalling).
224 5. Recording Metadata Format
226 This section gives an overview of Recording Metadata Format. Some
227 data from the metadata model is assumed to be made available to the
228 SRS through Session Description Protocol (SDP)[RFC4566], and
229 therefore this data is not represented in the XML document format
230 specified in this document. SDP attributes describes about different
231 media formats like audio, video. The other metadata attributes like
232 participant details are represented in a new Recording specific XML
233 document namely application/rs-metadata+xml. The SDP label attribute
234 [RFC4574] provides an identifier by which a metadata XML document can
235 refer to a specific media description in the SDP sent from the SRC to
236 the SRS.
238 The XML document format can be used to represent either the complete
239 metadata or a partial update to the metadata. The latter includes
240 only elements that have changed compared to the previously reported
241 metadata.
243 5.1. XML data format
245 Recording Metadata document is an XML document. recording element
246 MUST be present in all recording metadata XML document. recording
247 acts as container for all other elements in this XML document.
249 Recording object is a XML document. It MUST have the XML declaration
250 and it SHOULD contain an encoding declaration in the XML declaration,
251 e.g., "". If the charset
252 parameter of the MIME content type declaration is present and it is
253 different from the encoding declaration, the charset parameter takes
254 precedence.
256 Every application conforming to this specification MUST accept the
257 UTF-8 character encoding to ensure the minimal interoperability.
259 Syntax and semantics error in recording XML document has to be
260 informed to the originator using application specific mechanism.
262 5.1.1. Namespace
264 The namespace URI for elements defined by this specification is a
265 Uniform Resource Namespace (URN) [RFC2141], using the namespace
266 identifier 'ietf' defined by [RFC2648] and extended by [RFC3688].
268 The URN is as follows: urn:ietf:params:xml:ns:recording
270 5.1.2. recording
272 recording element MUST contain an xmlns namespace attribute with
273 value as urn:ietf:params:xml:ns:recording. One recording element
274 MUST be present in the all recording metadata XML document.
276 dataMode element shows whether the XML document is complete document
277 or partial update. The default value is complete.
279 6. Recording Metadata classes
281 This section describes each class of the metadata model, and the
282 attributes of each class. This section also describes how different
283 classes are linked and the XML element for each of them.
285 6.1. Recording Session
286 +-------------------------------+
287 | Recording Session (RS) |
288 +-------------------------------+
289 | |
290 | Start/End Time |
291 | |
292 | |
293 | |
294 +-------------------------------+
295 |1..* | 1..*
296 | |
297 |0..* | 0..*
298 Communication Communication
299 Session Session Group(CS Group)
301 Each instance of a Recording Session class (namely the Recording
302 Session Object) represents a SIP session created between an SRC and
303 SRS for the purpose of recording a Communication Session.
305 6.1.1. Attributes
307 A Recording Session class has the following attributes:
308 o Start/End Time - Represents the Start/End time of a Recording
309 Session object.
311 6.1.2. Linkages
313 Each instance of Recording Session has:
315 o Zero or more instances of Communication Session Group. CSG may be
316 zero because it is optional metadata object. Also the allowance
317 of zero instances is to accommodate persistent recording, where
318 there may be none.
319 o Zero or more instances of Communication Session objects.
321 6.1.3. XML element
323 Recording Session object is represented by recording XML element.
324 That in turn relies on the SIP/SDP session with which the XML
325 document is associated to provide some of the attributes of the
326 Recording Session element.
328 Start and End time value are derivable from Date header(if present in
329 SIP message) in RS. In cases where Date header is not present,
330 Start/End time are derivable from the time at which SRS receives the
331 notification of SIP message to setup RS / disconnect RS.
333 6.2. Communication Session Group
335 Recording Session (RS)
336 | 1..*
337 |
338 | 0..*
339 +-------------------------------+
340 | Communication Session |
341 | Group |
342 +-------------------------------+
343 | Unique-ID |
344 | associate-time |
345 | disassociate-time |
346 | |
347 +-------------------------------+
348 | 0..1
349 |
350 | 1..*
351 Communication Session (CS)
353 One instance of a Communication Session Group class (namely the
354 Communication Session Group object) provides association or linking
355 of Communication Sessions.
357 6.2.1. Attributes
359 A CS Group has the following attributes:
360 o Unique-ID - This Unique-ID is to group different CSs that are
361 related. SRC (or SRS) is responsible for ensuring the uniqueness
362 of Unique-ID in case multiple SRC interacts with the same SRS.
363 The mechanism by which SRC groups the CS is outside the scope of
364 SIPREC.
365 o Associate-time - Associate-time for CS-Group shall be calculated
366 by SRC as the time when a grouping is formed. The rules that
367 determine how a grouping of different Communication Session
368 objects is done by SRC is outside the scope of SIPREC.
369 o Disassociate-time - Disassociate-time for CS-Group shall be
370 calculated by SRC as the time when the grouping ends
372 6.2.2. Linkages
374 The linkages between Communication Session Group class and other
375 classes is association. A communication Session Group is associated
376 with RS and CS in the following manner:
378 o There is one or more Recording Session objects per Communication
379 Session Group.
380 o Each Communication Session Group object has to be associated with
381 one or more RS [Here each RS can be setup by the potentially
382 different SRCs]
383 o There is one or more Communication Sessions per CS Group [e.g.
384 Consult Transfer]
386 6.2.3. XML element
388 Group element is an optional element provides the information about
389 the communication session group
391 Each communication session group (CSG)object is represented using one
392 group element. Each group element has unique Base 64 URN UUID
393 attribute which helps to uniquely identify CSG.
395 6.3. Communication Session
397 Recording Communication
398 Session Session Group(CS Group)
399 |1..* | 0..1
400 | |
401 |0..* | 1..*
402 +-------------------------------+
403 | Communication Session (CS) |
404 | |
405 +-------------------------------+
406 | CS Identifier |
407 | Termination Reason |
408 | Start-time |
409 | Stop-time |
410 +-------------------------------+
411 | |
412 | 0..* |0..1
413 | |
414 | 0..* |0..*
415 Participant Media Stream
417 A Communication Session class and its object in the metadata model
418 represents Communication Session and its properties needed as seen by
419 SRC.
421 6.3.1. Attributes
423 A communication Session class has the following attributes:
425 o Termination Reason - This represents the reason why a CS was
426 terminated. The communication session MAY contain a Call
427 Termination Reason. This MAY be derived from SIP Reason header
428 [RFC3326] of CS.
429 o CS Identifier - This attribute is used to uniquely identify a CS.
430 o Start-time - This optional attribute represents start time of CS
431 as seen by SRC
432 o Stop-time - This optional attribute represents stop time of CS as
433 seen by SRC
435 This document does not specify attributes relating to what should
436 happen to a recording of a CS after it has been delivered to the SRS,
437 e.g., how long to retain the recording, what access controls to
438 apply. The SRS is assumed to behave in accordance with policy. The
439 ability for the SRC to influence this policy is outside the scope of
440 this document. However if there are implementations where SRC has
441 enough information, this could be sent as Extension Data attached to
442 CS
444 6.3.2. Linkages
446 A Communication Session is linked to CS-Group, Participant, Media
447 Stream and Recording Session classes using the association
448 relationship. Association between CS and Participant allows:
450 o CS to have atleast zero or more participants
451 o Participant is associated with zero or more CSs. This includes
452 participants who are not directly part of any CS. An example of
453 such a case is participants in a premixed media stream. The SRC
454 may have knowledge of such Participants, yet not have any
455 signaling relationship with them. This might arise if one
456 participant in CS is a conf focus. To summarize even if SRC does
457 not have direct signalling relationships with all participants in
458 a CS, it should nevertheless create a Participant object for each
459 participant that it knows about.
460 o The model also allows participants in CS that are not participants
461 in the media. An example is the identity of a 3pcc controller
462 that has initiated a CS to two or more participants of the CS.
463 Another example is the identity of a conference focus. Of course
464 a focus is probably in the media, but since it may only be there
465 as a mixer, it may not report itself as a participant in any of
466 the media streams.
468 Association between CS and Media Stream allows:
470 o A CS to have zero or more Streams
471 o A stream can be associated with at most one CS. Stream in
472 persistent RS is not required to be associated with any CS before
473 CS is created and hence the zero association is allowed.
475 Association between CS and RS allows:
477 o Each instance of RS has Zero or more instances of Communication
478 Session objects.
479 o Each CS has to be associated with one more RS [ Here each RS can
480 be potentially setup by different SRCs]
482 6.3.3. XML element
484 Session element provides the information about the communication
485 session
487 Each communication session(CS) object is represented by one session
488 element. Each session element has unique Base 64 URN UUID attribute
489 which helps to uniquely identify CS.
491 The XML reason element MAY be included in metadata to represent a CS
492 Termination Reason. There MAY be multiple instances of the XML
493 reason element inside a session element. The reason XML element has
494 'protocol' as an attribute, which indicates the protocol from which
495 the reason string is derived. The default value for protocol
496 attribute is "SIP".
498 group-ref element MAY exist to indicate the group where the mentioned
499 session belongs.
501 6.4. CSRSAssociation
503 1..* 0..*
504 Recording Communication
505 Session ----------+---------- Session
506 |
507 |
508 |
509 +-------------------+
510 | CSRSAssociation |
511 +-------------------+
512 | Association-Time |
513 | Disassociaton-Time|
514 +-------------------+
516 A CSRS Association class and its objects has attributes of CS object
517 which are attributes of association of a session to a RS.
519 6.4.1. Attributes
521 CSRS association class has the following attributes:
523 o Associate-time - associate-time is calculated by SRC as the time
524 it sees a CS is associated to a RS
525 o Disassociate-time- Disassociate-time is calculated by SRC as the
526 time it see a CS disassociate from a RS.
527 It is possible that a given CS can have multiple associate/
528 disassociate times within given RS.
530 6.4.2. Linkages
532 CSRS association class is linked to CS and RS classes. There are no
533 cardinalties for this linkage.
535 6.4.3. XML element
537 sessionrecordingassoc is the XML element to represent CSRS
538 association object. session URN UUID is used to uniquely identify
539 this element and link with the specific session.
541 6.5. Participant
543 Communication Session (CS)
544 | 0..*
545 |
546 | 0..*
547 +-------------------------------+
548 | Participant |
549 | |
550 +-------------------------------+
551 | AoR / Name Pair list |
552 | |
553 | |
554 +-------------------------------+
555 | 0..* 1..*|
556 receives| |sends
557 | 0..* 0..*|
558 Media Stream
560 A Participant class and its objects has information about a device
561 that is part of a CS and/or contributes/consumes media stream(s)
562 belonging to a CS.
564 6.5.1. Attributes
566 Participant has attributes like:
568 o AoR / Name pair list - This attribute is a list of Name/AoR tuple.
569 An AoR MAY be SIP/SIPS/TEL URI. Name represents Participant
570 name(SIP display name) or DN number ( in case it is known). There
571 are cases where a participant can have more than one AoR [e.g.
572 P-Asserted-identity header [RFC3325] which can have both SIP and
573 TEL URIs]
575 This document does not specify other attributes relating to
576 participant e.g. Participant Role, Participant type. An SRC which
577 has information of these attributes can indicate the same as part of
578 extension data to Participant from SRC to SRS.
580 6.5.2. Linkages
582 The participant class is linked to MS and CS class using association
583 relationship. The association between participant and Media Stream
584 allows:
586 o Participant to receives zero or more media streams
587 o Participant to send zero or more media streams. (Same participant
588 provides multiple streams e.g. audio and video)
589 o Media stream to be received by zero or more participants. Its
590 possible, though perhaps unlikely, that a stream is generated but
591 sent only to the SRC and SRS, not to any participant. E.g. In
592 conferencing where all participants are on hold and the SRC is
593 collocated with the focus. Also a media stream may be received by
594 multiple participants (e.g. Whisper calls, side conversations).
595 o Media stream to be sent by one or more participants (pre-mixed
596 streams).
598 Example of a case where a participant receives Zero or more streams -
599 a Supervisor may have side conversation with Agent, while Agent
600 converses with customer.
602 6.5.3. XML element
604 A participant element represents a Participant object.
606 Participant MUST have a NameID complex element which contains AoR as
607 attribute and Name as element. AOR element is SIP/SIPS URI FQDN or
608 IP address which represents the user. name is an optional element to
609 represent display name.
611 Each participant element has unique ID (Base 64 URN UUID) attribute
612 which helps to uniquely identify participant and session Base 64 URN
613 UUID to associate participant with specific session element. Base 64
614 URN UUID of participant MUST used in the scope of CSG and no new Base
615 64 URN UUID has to be created for the same element (participant,
616 stream) between different CS in the same CSG. In case Base 64 URN
617 UUID has to be used permanent, careful usage of Base 64 URN UUID to
618 original AoR has to be decided by the implementers and it is
619 implementer's choice.
621 6.6. ParticipantCSAssociation
623 1..* 0..*
624 Communication
625 Session ----------+---------- Participant
626 |
627 |
628 |
629 +-------------------+
630 | ParticipantCS |
631 | Association |
632 +-------------------+
633 | Capabilities |
634 | Association-Time |
635 | Disassociaton-Time|
636 +-------------------+
638 A participantCS Association class and its objects has attributes of
639 participant object which are attributes of association of a
640 participant to a Session.
642 6.6.1. Attributes
644 ParticipantCS association class has the following attributes:
646 o Associate-time - associate-time is calculated by SRC as the time
647 it sees a participant is associated to CS
648 o Disassociate-time- Disassociate-time is calculated by SRC as the
649 time it see a participant disassociate from a CS. It is possible
650 that a given participant can have multiple associate/disassociate
651 times within given communication session.
653 o Capabilities - A participant capabilities as defined in [RFC3840]
654 which is an optional attribute that includes the capabilities of a
655 participant in a CS. Each participant shall have Zero or more
656 capabilities. A participant may use different capabilities
657 depending on the role it plays at a particular instance. IOW if a
658 participants moves across different CSs ( due to transfer e.t.c)
659 OR is simultaneously present in different CSs its role may be
660 different and hence the capability used.
662 6.6.2. Linkages
664 The participantCS association class is linked to participant and CS
665 classes. There are no cardinalties for this linkage.
667 6.6.3. XML element
669 participantsessionassoc XML element represent participantCS
670 association object. participant and session id is used to uniquely
671 identify this element
673 NOTE: RFC 4235 encoding shall be used to represent capabilities
674 attribute in XML.
676 6.7. Media Stream
678 Participant
679 | 0..* 1..*|
680 receives| |sends
681 | 0..* 0..*|
682 +-------------------------+
683 | Media Stream |
684 | |
685 Communication 0..1 0..* +-------------------------+
686 Session ------------| |
687 | Media Stream Reference |
688 | Content-type |
689 | |
690 +-------------------------+
692 A Media Stream class (and its objects) has the properties of media as
693 seen by SRC and sent to SRS. Different snapshots of media stream
694 object may be sent whenever there is a change in media (e.g. dir
695 change like pause/resume and/or codec change and/or participant
696 change.).
698 6.7.1. Attributes
700 A Media Stream class has the the following attributes:
702 o Media Stream Reference - In implementations this can reference to
703 m-line
704 o Content - The content of an MS element will be described in terms
705 of value from the [RFC4796] registry.
707 The metadata model should include media streams that are not being
708 delivered to the SRS. Examples include cases where SRC offered
709 certain media types but SRS chooses to accept only a subset of them
710 OR an SRC may not even offer a certain media type due it its
711 restrictions to record
713 6.7.2. Linkages
715 A Media Stream is linked to participant and CS classes using the
716 association relationship. The details of association with the
717 Participant are described in the Participant class section. The
718 details of association with CS is mentioned in the CS section.
720 6.7.3. XML element
722 stream element represents a Media Stream object. Stream element
723 indicates SDP media lines associated with the session and
724 participants.
726 This element indicates the SDP m-line properties like label
727 attributes. Label attribute is used to link m-line SDP body using
728 label attribute in SDP m-line.
730 Each stream element has unique Base 64 URN UUID attribute which helps
731 to uniquely identify stream and session Base 64 URN UUID to associate
732 stream with specific session element.
734 The content attribute if an SRC wishes to send is conveyed in RS SDP.
736 6.8. ParticipantStream Association
737 +-------------------+
738 | ParticipantSteam |
739 | Association |
740 +-------------------+ +----------Participant
741 | Association-Time | | 0..*| 1..*|
742 | Disassociaton-Time|---+ recv| |sends
743 | Recv | | 0..*| 0..*|
744 | Send | | | |
745 +-------------------+ | | |
746 +----------Media Stream
748 A ParticipantStream association class and its object has attributes
749 that are attributes of association of a Participant to a Stream.
751 6.8.1. Attributes
753 A participantStream association class has the following attributes:
755 o Associate-Time: This attributes indicates the time a Participant
756 started contributing to a Media Stream
757 o Disassociate-Time: This attribute indicates the time a Participant
758 stopped contributing to a Media Stream
759 o Recv: This attribute indicates whether a Participant is receiving
760 a media stream or not. This attribute has a value which points to
761 a stream represented by its Unique_id. The presence of this
762 attribute indicates that a participant is receiving a stream
763 represented by the Unique_id. If due to changes in CS(like hold)
764 the participants stops receiving a stream, a snapshot MUST be sent
765 from SRC to SRS with no Recv element for that stream.
766 o Send: This attribute indicates whether a participant is
767 contributing to a stream or not. This attribute has a value which
768 points to stream represented by its unique_id. The presence of
769 this attribute indicates that a participant is contributing to a
770 stream represented by the Unique_id. If due to changes in CS if a
771 participant stops contributing to a stream, a snapshot MUST be
772 sent from SRC to SRS with no Send element for that stream.
774 6.8.2. Linkages
776 The participantStream association class is linked to participant and
777 Stream classes. There are no cardinalties for this linkage.
779 6.8.3. XML element
781 The participantstreamassoc complex XML element represents the
782 participant to stream association object. This XML element is used
783 to represent a snapshot of a participant association with a stream.
784 The send and recv XML elements MUST be used to indicate whether a
785 participant is contributing to a stream or receiving a stream. There
786 MAY be multiple instances of the send and recv XML elements inside a
787 particpantstreamassoc element. If a metadata snapshot is sent with a
788 participantstreamassoc that does not have any send and recv elements,
789 it means that participant is neither contributing to any streams nor
790 receiving any streams.
792 6.9. associate-time/disassociate-time
794 associate-time/disassociate-time contains a string indicating the
795 date and time of the status change of this tuple. The value of this
796 element MUST follow the IMPP datetime format [RFC3339]. Timestamps
797 that contain 'T' or 'Z' MUST use the capitalized forms. At a time,
798 any of the time tuple associate-time or disassociate-time MAY exist
799 in the element namely group, session, participant and not both
800 timestamp at the same time.
802 As a security measure, the timestamp element SHOULD be included in
803 all tuples unless the exact time of the status change cannot be
804 determined.
806 6.10. Unique ID format
808 Unique id is generated in two steps:
809 o UUID is created using [RFC4122])
810 o UUID is encoded using base64 as defined in [RFC4648]
812 The above mentioned unique-id mechanism SHOULD be used for each
813 metadata element. Multiple SRCs can refer to the same element/UUID
814 (how each SRC learns the UUID here is out of scope of SIPREC)
816 6.11. Metadata version Indicator
818 This section defines a version indicator for metadata XML.
820 This version value allows the SRS to know the exact metadata XML
821 schema sent by the SRC. This document describes version 1. The
822 value '1' represent SIPREC metadata version. Implementations may not
823 interoperate if the version implemented by the sender is not known by
824 the receiver. No negotiation of versions is provided. There is no
825 significance to the version number although documents which update or
826 obsolete this document (possibly including drafts of such documents)
827 should include a higher version number if the metadata XML schema
828 changes.
830 7. SIP Recording Metadata Example
832 7.1. Complete SIP Recording Metadata Example
834 The following example provides all the tuples involved in Recording
835 Metadata XML body.
837
838
839 complete
840
841 2010-12-16T23:41:07Z
842
843
844 sip:alice@atlanta.com
845
846
847 FOO!
848 bar
849
850
851
852 7+OTCyoxTmqmqyA/1weDAg==
853
854
855 FaXHlc+3WruaroDaNE87am==
856 FOO!
857 bar
858
859
860 2010-12-16T23:41:07Z
861
862
864
865 Bob B
866
867
868 FOO!
869 bar
870
871
874 2010-12-16T23:41:07Z
875
876
878 i1Pz3to5hGk8fuXl+PbwCw==
879 UAAMm5GRQKSCMVvLyl4rFw==
880 8zc6e0lYTlWIINA6GR+3ag==
881 EiXGlc+4TruqqoDaNE76ag==
882
883
885
886 Paul
887
888
889 FOO!
890 bar
891
892
895 2010-12-16T23:41:07Z
896
897
899 8zc6e0lYTlWIINA6GR+3ag==
900 EiXGlc+4TruqqoDaNE76ag==
901 UAAMm5GRQKSCMVvLyl4rFw==
902 i1Pz3to5hGk8fuXl+PbwCw==
903
904
906
907
908
910
911
912
914
915
916
918
919
920
922 SIP Recording Metadata Example XML body
924 7.2. Partial Update of Recording metadata XML body
926 The following example provides partial update in Recording Metadata
927 XML body for the above example. The example has a snapshot that
928 carries the disassociate-time for a participant from a session.
930
931
932 partial
933
935
936 Bob R
937
938 FOO!
939 bar
940
941
944 2010-12-16T23:41:07Z
945
946
948 Partial update of SIP Recording Example XML body
950 8. XML Schema definition for Recording metadata
952 This section defines XML schema for Recording metadata document
954
955
960
961
962
963
964
965
967
969
971
973
975
978
981
984
988
989
990
991
992
994
996
1000
1001
1003
1005
1006
1007
1009
1011
1013
1015
1019
1020
1022
1023
1024
1025
1027
1029
1033
1034
1036
1037
1038
1039
1041
1045
1046
1048
1049
1050
1051
1053
1055
1059
1060
1062
1065
1066
1067
1068
1070
1072
1074
1076
1080
1081
1083
1084
1085
1086
1088
1092
1093
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1127 9. Security Considerations
1129 The metadata information sent from SRC to SRS MAY reveal sensitive
1130 information about different participants in a session. For this
1131 reason, it is RECOMMENDED that a SRC use a strong means for
1132 authentication and metadata information protection and that it apply
1133 comprehensive authorization rules when using the metadata format
1134 defined in this document. The following sections will discuss each
1135 of these aspects in more detail.
1137 9.1. Connection Security
1139 It is RECOMMENDED that a SRC authenticate SRS using the normal SIP
1140 authentication mechanisms, such as Digest as defined in Section 22 of
1141 [RFC3261]. The mechanism used for conveying the metadata information
1142 MUST ensure integrity and SHOULD ensure confidentially of the
1143 information. In order to achieve these, an end-to-end SIP encryption
1144 mechanism, such as S/MIME described in [RFC3261], SHOULD be used.
1146 If a strong end-to-end security means (such as above) is not
1147 available, it is RECOMMENDED that a SRC use mutual hop-by-hop
1148 Transport Layer Security (TLS) authentication and encryption
1149 mechanisms described in "SIPS URI Scheme" and "Interdomain Requests"
1150 of [RFC3261].
1152 10. IANA Considerations
1154 This specification registers a new XML namespace, and a new XML
1155 schema.
1157 10.1. SIP recording metadata Schema Registration
1159 URI: urn:ietf:params:xml:ns:recording
1161 Registrant Contact: IETF SIPREC working group, Ram mohan
1162 R(rmohanr@cisco.com)
1164 XML: the XML schema to be registered is contained in Section 6.
1166 Its first line is and its last
1167 line is
1169 11. Acknowledgement
1171 We wish to thank John Elwell, Henry Lum, Leon Portman, De Villers,
1172 Andrew Hutton(Siemens-Enterprise), Deepanshu Gautam(Huawei),Charles
1173 Eckel(Cisco), Muthu Arul Mozhi (Cisco), Michael Benenson(Cisco),
1174 Hadriel Kaplan (ACME), Brian Rosen, Scott Orton(Broadsoft), Ofir Roth
1175 (NICE), Mary Barnes(Polycom), Ken Rehor(Cisco) for their valuable
1176 comments and inputs.
1178 We wish to thank Joe Hildebrand(Cisco), Peter Saint-Andre(Cisco),
1179 Matt Miller(Cisco) for the valuable XML related guidance and Martin
1180 Thompson for validating the XML schema and providing comments on the
1181 same.
1183 12. References
1185 12.1. Normative References
1187 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
1188 Requirement Levels", BCP 14, RFC 2119, March 1997.
1190 [RFC2141] Moats, R., "URN Syntax", RFC 2141, May 1997.
1192 [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston,
1193 A., Peterson, J., Sparks, R., Handley, M., and E.
1194 Schooler, "SIP: Session Initiation Protocol", RFC 3261,
1195 June 2002.
1197 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
1198 January 2004.
1200 [RFC3339] Klyne, G., Ed. and C. Newman, "Date and Time on the
1201 Internet: Timestamps", RFC 3339, July 2002.
1203 [RFC4566] Handley, M., Jacobson, V., and C. Perkins, "SDP: Session
1204 Description Protocol", RFC 4566, July 2006.
1206 [RFC4574] Levin, O. and G. Camarillo, "The Session Description
1207 Protocol (SDP) Label Attribute", RFC 4574, August 2006.
1209 [RFC4796] Hautakorpi, J. and G. Camarillo, "The Session Description
1210 Protocol (SDP) Content Attribute", RFC 4796,
1211 February 2007.
1213 [RFC3840] Rosenberg, J., Schulzrinne, H., and P. Kyzivat,
1214 "Indicating User Agent Capabilities in the Session
1215 Initiation Protocol (SIP)", RFC 3840, August 2004.
1217 [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally
1218 Unique IDentifier (UUID) URN Namespace", RFC 4122,
1219 July 2005.
1221 [RFC4648] Josefsson, S., "The Base16, Base32, and Base64 Data
1222 Encodings", RFC 4648, October 2006.
1224 12.2. Informative References
1226 [RFC6341] Rehor, K., Portman, L., Hutton, A., and R. Jain, "Use
1227 Cases and Requirements for SIP-Based Media Recording
1228 (SIPREC)", RFC 6341, August 2011.
1230 [I-D.ietf-siprec-architecture]
1231 Hutton, A., Portman, L., Jain, R., and K. Rehor, "An
1232 Architecture for Media Recording using the Session
1233 Initiation Protocol", draft-ietf-siprec-architecture-08
1234 (work in progress), May 2013.
1236 [RFC2648] Moats, R., "A URN Namespace for IETF Documents", RFC 2648,
1237 August 1999.
1239 [RFC3326] Schulzrinne, H., Oran, D., and G. Camarillo, "The Reason
1240 Header Field for the Session Initiation Protocol (SIP)",
1241 RFC 3326, December 2002.
1243 [RFC3325] Jennings, C., Peterson, J., and M. Watson, "Private
1244 Extensions to the Session Initiation Protocol (SIP) for
1245 Asserted Identity within Trusted Networks", RFC 3325,
1246 November 2002.
1248 Authors' Addresses
1250 Ram Mohan Ravindranath
1251 Cisco Systems, Inc.
1252 Cessna Business Park,
1253 Kadabeesanahalli Village, Varthur Hobli,
1254 Sarjapur-Marathahalli Outer Ring Road
1255 Bangalore, Karnataka 560103
1256 India
1258 Email: rmohanr@cisco.com
1260 Parthasarathi Ravindran
1261 Nokia Siemens Networks
1262 Bangalore, Karnataka
1263 India
1265 Email: partha@parthasarathi.co.in
1267 Paul Kyzivat
1268 Huawei
1269 Hudson, MA
1270 USA
1272 Email: pkyzivat@alum.mit.edu