| Network Working Group | R. Sparks |
| Internet-Draft | Oracle |
| Updates: 3261, 3515, 5002, 5318, 5360, | June 07, 2016 |
| 5502 (if approved) | |
| Intended status: Standards Track | |
| Expires: December 9, 2016 |
Clarifications for when to use the name-addr production in SIP messages
draft-sparks-sipcore-name-addr-guidance-00
RFC3261 constrained several SIP header fields whose grammar contains the “name-addr / addr-spec” alternative to use name-addr when certain characters appear. Unfortunately it expressed the constraints with prose copied into each header field definition, and at least one header field was missed. Further, the constraint has not been copied into documents defining extension headers whose grammar contains the alternative.
This document updates RFC3261 to state the constraint generically, and clarifies that the constraint applies to all SIP header fields where there is a choice between using name-addr or addr-spec. It also updates those extension SIP header fields that use the alternative to clarify that the constraint applies (RFCs 3261, 3515, 5002, 5318, 5360, and 5502).
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 9, 2016.
Copyright (c) 2016 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.
[RFC3261] defines several header fields that contain URIs to allow both a form that contains the bare URI (addr-spec) and one that provides a name and the URI (name-addr). This subset, taken from the ABNF [RFC5234] specified in [RFC3261] shows the relevant part of the definition of the syntax of the “From” header field:
From = ( "From" / "f" ) HCOLON from-spec
from-spec = ( name-addr / addr-spec )
*( SEMI from-param )
name-addr = [ display-name ] LAQUOT addr-spec RAQUOT
addr-spec = SIP-URI / SIPS-URI / absoluteURI
The prose in section 20.20 of [RFC3261], which discusses the “From” header field, constrains how the production may be used by saying:
Even if the "display-name" is empty, the "name-addr" form MUST be used if the "addr-spec" contains a comma, question mark, or semicolon.
Section 20.39, which discusses the “To” header field contains no such constraining text.
This constraint is specified slightly differently, but with the same intent, in the introduction to section 20:
The Contact, From, and To header fields contain a URI. If the URI contains a comma, question mark or semicolon, the URI MUST be enclosed in angle brackets (< and >).
Unfortunately, this can be read to only apply to the Contact, From, and To header fields, making it necessary to provide the constraint explicitly in the prose discussing any other header field using the name-addr or addr-spec alternative.
As extension header fields were standardized, the specifications sometimes failed to include the constraint. Many errata have been entered to correct this omission. When the constraint was called out, the form has not been consistent.
This memo updates the specifications of SIP and its extensions to clarify that the constraint to use the name-addr form applies anywhere there is a choice between the name-addr and addr-spec production rules in the grammar for SIP header fields.
It is important to note that a message formed without honoring the constraint will still be syntactically valid, but would be interpreted differently. The characters after the comma, question mark, or semicolon would be interpreted as header field parameters or additional header field values as discussed in section 7.3.1 of [RFC3261].
This text from the introduction to section 20 of [RFC3261]:
The Contact, From, and To header fields contain a URI. If the URI contains a comma, question mark or semicolon, the URI MUST be enclosed in angle brackets (< and >).
is replaced with:
When constructing the value of any SIP header field whose grammar allows choosing between name-addr and addr-spec, such as those that use the form '(name-addr / addr-spec)', the "addr-spec" form MUST NOT be used if its value would contain a comma, semicolon, or question mark. The header fields defined in this specification that allow this choice are "To", "From", "Contact", and "Reply-To".
[RFC3515], [RFC5002], [RFC5318], [RFC5360], and [RFC5502] are updated to include:
This RFC contains the definition of one or more SIP header fields that allow choosing between addr-spec and name-addr when constructing header field values. As specified in RFCxxxx, the "addr-spec" form MUST NOT be used if its value would contain a comma, semicolon, or question mark.
This memo has no considerations for IANA.
The updates specified in this memo clarify a constraint on the grammar for producing SIP messages. It introduces no new security considerations. One pre-existing consideration is worth reiterating: messages produced without honoring the constraint will be mis-interpreted by the receiving element.
Brett Tate identified this issue in several extension documents, submitted several corresponding errata, and drove the discussion that led to this memo. Substantive comments leading to this text were provided by Paul Kyzivat, Gonzalo Camarillo, and Dale Worley.
Please remove this section in its entirety before publication as an RFC.
Please replace any instances of RFCxxxx with the RFC number assigned to this memo.
This memo, if it is approved, obviates Errata 3744, 3894, and 4648-4652 inclusive.