| SIPCORE Working Group | C. Holmberg |
| Internet-Draft | I. Sedlacek |
| Updates: 5621 (if approved) | Ericsson |
| Intended status: Standards Track | June 28, 2017 |
| Expires: December 30, 2017 |
Content-ID header field in Session Initiation Protocol (SIP)
draft-ietf-sipcore-content-id-07
This document specifies the Content-ID header field for usage in the Session Initiation Protocol (SIP). The document also updates RFC 5621, which only allows a Content-ID URL to reference a body-part that is part of a multipart message-body. This update enables a Content-ID URL to reference a complete message-body and metadata provided by some additional SIP header fields.
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."
This Internet-Draft will expire on December 30, 2017.
Copyright (c) 2017 IETF Trust and the persons identified as the document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
A SIP message consists of a start-line, one or more header fields, an empty line indicating the end of the header fields, and an optional message-body, as specified in [RFC3261].
The message-body can be a non-multipart message-body or a multipart message-body as specified in [RFC3261].
[RFC5621] defines generic handling of a multipart message-body in a SIP message.
A multipart message-body contains zero, one or several body parts, encoded using [RFC2045] format.
A body part in the multipart message-body is described using header fields such as Content-Disposition, Content-Encoding, and Content-Type, which provide information on the content of the body part, as specified in [RFC5621]. A body part in the multipart message-body can also contain a Content-ID header field with an ID value uniquely identifying the body part, as specified in [RFC2045].
A SIP header field can reference a body part using a Content-ID URL, as specified in [RFC5621].
The Content-ID URL is specified in [RFC2392]. [RFC2392] specifies how to identify the body part referenced by a Content-ID URL. The Content-ID URL value is included in the Content-ID header field of the body part.
Examples of SIP header fields referencing a body part using a Content-ID URL are:
It is currently not specified how to uniquely identify a complete message-body of a SIP message using a Content-ID header field, and how to reference a complete message-body using a Content-ID URL.
NOTE: In [RFC5621], the Content-ID URL references a specific body part only.
The examples below shows the consequences of the problem described above.
If a User Agent Client (UAC) sends an INVITE request conveying location as specified in [RFC6442], if the UAC decides not to include an SDP offer, and if the location is conveyed by value, then the UAC needs to include only one MIME entity in the INVITE request. This MIME entity can be, for example, of the application/pidf+xml MIME type.
However, due to [RFC6442] requiring inclusion of a Geolocation header field referencing the body part with the location information, the UAC includes a multipart message-body with single body part in the INVITE request, and includes the location information of application/pidf+xml MIME type and an associated Content-ID header field in the body part.
Example message (SIP INVITE):
INVITE sips:bob@biloxi.example.com SIP/2.0
Via: SIPS/2.0/TLS pc33.atlanta.example.com;branch=z9hG4bK74bf9
Max-Forwards: 70
To: Bob <sips:bob@biloxi.example.com>
From: Alice <sips:alice@atlanta.example.com>;tag=9fxced76sl
Call-ID: 3848276298220188511@atlanta.example.com
Geolocation: <cid:target123@atlanta.example.com>
Geolocation-Routing: no
Accept: application/sdp, application/pidf+xml
CSeq: 31862 INVITE
Contact: <sips:alice@atlanta.example.com>
Content-Type: multipart/mixed; boundary=boundary1
Content-Length: ...
--boundary1
Content-Type: application/pidf+xml
Content-ID: <target123@atlanta.example.com>
<?xml version="1.0" encoding="UTF-8"?>
<presence
xmlns="urn:ietf:params:xml:ns:pidf"
xmlns:gp="urn:ietf:params:xml:ns:pidf:geopriv10"
xmlns:gbp="urn:ietf:params:xml:ns:pidf:geopriv10:basicPolicy"
xmlns:cl="urn:ietf:params:xml:ns:pidf:geopriv10:civicAddr"
xmlns:gml="http://www.opengis.net/gml"
xmlns:dm="urn:ietf:params:xml:ns:pidf:data-model"
entity="pres:alice@atlanta.example.com"
>
<dm:device id="target123-1">
<gp:geopriv>
<gp:location-info>
<gml:location>
<gml:Point srsName="urn:ogc:def:crs:EPSG::4326">
<gml:pos>32.86726 -97.16054</gml:pos>
</gml:Point>
</gml:location>
</gp:location-info>
<gp:usage-rules>
<gbp:retransmission-allowed>false
</gbp:retransmission-allowed>
<gbp:retention-expiry>2010-11-14T20:00:00Z
</gbp:retention-expiry>
</gp:usage-rules>
<gp:method>802.11</gp:method>
</gp:geopriv>
<dm:deviceID>mac:1234567890ab</dm:deviceID>
<dm:timestamp>2010-11-04T20:57:29Z</dm:timestamp>
</dm:device>
</presence>
--boundary1--
If a UAC sends an REFER request including a list of targets as specified in [RFC5368], then the UAC needs to include only one MIME entity in the REFER request. This MIME entity is of the application/resource-lists+xml MIME type.
However, due to [RFC5368] requiring inclusion of a Refer-To header field referencing the body part containing the list of targets, the UAC includes a multipart message-body with single body part in the REFER request, and includes the list of targets of application/resource-lists+xml MIME type and an associated Content-ID header field in the body part.
Example message (SIP REFER):
REFER sip:conf-123@example.com;gruu;opaque=hha9s8d-999a SIP/2.0
Via: SIP/2.0/TCP client.chicago.example.com;branch=z9hG4bKhjhs8ass83
Max-Forwards: 70
To: "Conference 123" <sip:conf-123@example.com>
From: Carol <sip:carol@chicago.example.com>;tag=32331
Call-ID: d432fa84b4c76e66710
CSeq: 2 REFER
Contact: <sip:carol@client.chicago.example.com>
Refer-To: <cid:cn35t8jf02@example.com>
Refer-Sub: false
Require: multiple-refer, norefersub
Allow: INVITE, ACK, CANCEL, OPTIONS, BYE, REFER, SUBSCRIBE, NOTIFY
Allow-Events: dialog
Accept: application/sdp, message/sipfrag
Content-Type: multipart/mixed; boundary=boundary1
Content-Length: ...
--boundary1
Content-Type: application/resource-lists+xml
Content-Disposition: recipient-list
Content-ID: <cn35t8jf02@example.com>
<?xml version="1.0" encoding="UTF-8"?>
<resource-lists
xmlns="urn:ietf:params:xml:ns:resource-lists"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
>
<list>
<entry uri="sip:bill@example.com?method=BYE"/>
<entry uri="sip:joe@example.org?method=BYE"/>
<entry uri="sip:ted@example.net?method=BYE"/>
</list>
</resource-lists>
--boundary1--
In order to solve the problems described above, this document:
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119].
This section defines the usage of the Content-ID header field for SIP.
The ABNF [RFC5234] for the Content-ID header field is:
Content-ID = "Content-ID" HCOLON msg-id
msg-id = "<" id-left "@" id-right ">"
NOTE: id-left and id-right are specified in [RFC5322]. HCOLON is
defined in [RFC3261].
NOTE: When used in a SIP header field, the msg-id syntax has been
simplified, compared to the syntax in [RFC5322], to disallow the use
of comments and to adopt to the SIP usage of leading white space.
The value of Content-Id header field value must be unique in the
context of a given SIP message, including any embedded MIME
Content-Id header field values. Note that the SIP Content-ID header
field value is not expected to be unique among all SIP messages; it
has no meaning outside of the message in which it is included.
The Content-ID header field included in the header fields of a SIP message identifies the message-body of the SIP message, and the metadata provided by:
The Content-ID header field can be included in any SIP message which is allowed to contain a message-body.
NOTE: The message body identified by the Content-ID header field can be a non-multipart message-body or a multipart message-body.
A UA MAY include a Content-ID header field in any SIP message that is allowed to contain a message-body.
A UA MUST NOT include a Content-ID header field in any SIP message that is not allowed to contain a message-body.
The UA MUST set the value of the Content-ID header field to a value that is unique in the context of the SIP message.
A proxy MUST NOT add a Content-ID header field in a SIP message.
A proxy MUST NOT modify a Content-ID header field included in a SIP message.
A proxy MUST NOT delete a Content-ID header field from a SIP message.
The figure shows an example from [RFC5368], where the SIP Content-ID header field is used to reference the message body (non-multipart) of a SIP message.
REFER sip:conf-123@example.com;gruu;opaque=hha9s8d-999a SIP/2.0
Via: SIP/2.0/TCP client.chicago.example.com
;branch=z9hG4bKhjhs8ass83
Max-Forwards: 70
To: "Conference 123" <sip:conf-123@example.com>
From: Carol <sip:carol@chicago.example.com>;tag=32331
Call-ID: d432fa84b4c76e66710
CSeq: 2 REFER
Contact: <sip:carol@client.chicago.example.com>
Refer-To: <cid:cn35t8jf02@example.com>
Refer-Sub: false
Require: multiple-refer, norefersub
Allow: INVITE, ACK, CANCEL, OPTIONS, BYE, REFER, SUBSCRIBE, NOTIFY
Allow-Events: dialog
Accept: application/sdp, message/sipfrag
Content-Type: application/resource-lists+xml
Content-Disposition: recipient-list
Content-Length: 362
Content-ID: <cn35t8jf02@example.com>
<?xml version="1.0" encoding="UTF-8"?>
<resource-lists xmlns="urn:ietf:params:xml:ns:resource-lists"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<list>
<entry uri="sip:bill@example.com?method=BYE" />
<entry uri="sip:joe@example.org?method=BYE" />
<entry uri="sip:ted@example.net?method=BYE" />
</list>
</resource-lists>
This section updates section 9.1 of [RFC5621], by allowing a Content-ID URL to reference a message-body and the related metadata (Section 3.3), in addition to allowing a reference to a body part.
OLD TEXT:
Content-ID URLs allow creating references to body parts. A given
Content-ID URL [RFC2392], which can appear in a header field or
within a body part (e.g., in an SDP attribute), points to a
particular body part.
NEW TEXT:
Content-ID URLs allow the creation of references to body parts or
message-bodies (and the header fields describing the
message-bodies). A given Content-ID URL [RFC2392], which can appear
in a header field or within a body part (e.g., in an SDP attribute),
points to a particular body part or the message-body (and the
header fields describing the message-body).
The Content-ID header field value MUST NOT reveal sensitive user information.
If the message-body associated with the Content-ID header field is an encrypted body, it MUST NOT be possible to derive a key that can be used to decrypt the body from the Content-ID header field value.
This specification registers a new SIP header field according to the procedures in [RFC3261].
The header field described in Section 3 has been registered in the "Header Fields" sub-registry of the "Session Initiation Protocol (SIP) Parameters" registry by adding a row with these values:
[RFC EDITOR NOTE: Please replace XXXX with the RFC number of this document when publishing]
Header Name: Content-ID
compact:
Reference: RFCXXXX
[RFC EDITOR NOTE: Please remove this section when publishing]
Changes from draft-ietf-sipcore-content-id-06
Changes from draft-ietf-sipcore-content-id-05
Changes from draft-ietf-sipcore-content-id-04
Changes from draft-ietf-sipcore-content-id-03
Changes from draft-ietf-sipcore-content-id-02
Changes from draft-ietf-sipcore-content-id-01