[sipcore] Comments on draft-ietf-sipcore-content-id-01

worley@ariadne.com (Dale R. Worley) Mon, 10 April 2017 21:49 UTC

Return-Path: <worley@alum.mit.edu>
X-Original-To: sipcore@ietfa.amsl.com
Delivered-To: sipcore@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id B5E91128708 for <sipcore@ietfa.amsl.com>; Mon, 10 Apr 2017 14:49:44 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.934
X-Spam-Level:
X-Spam-Status: No, score=-1.934 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, HEADER_FROM_DIFFERENT_DOMAINS=0.001, RCVD_IN_DNSWL_LOW=-0.7, SPF_SOFTFAIL=0.665] autolearn=no autolearn_force=no
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id H6IBQCLEs0KE for <sipcore@ietfa.amsl.com>; Mon, 10 Apr 2017 14:49:43 -0700 (PDT)
Received: from resqmta-ch2-04v.sys.comcast.net (resqmta-ch2-04v.sys.comcast.net [IPv6:2001:558:fe21:29:69:252:207:36]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 9365F128B38 for <sipcore@ietf.org>; Mon, 10 Apr 2017 14:49:43 -0700 (PDT)
Received: from resomta-ch2-06v.sys.comcast.net ([69.252.207.102]) by resqmta-ch2-04v.sys.comcast.net with SMTP id xhB9cWfMnscBPxhBucHl33; Mon, 10 Apr 2017 21:49:42 +0000
Received: from hobgoblin.ariadne.com ([IPv6:2601:192:4603:9471:222:fbff:fe91:d396]) by resomta-ch2-06v.sys.comcast.net with SMTP id xhBtchNjJeyvGxhBtccujS; Mon, 10 Apr 2017 21:49:42 +0000
Received: from hobgoblin.ariadne.com (hobgoblin.ariadne.com [127.0.0.1]) by hobgoblin.ariadne.com (8.14.7/8.14.7) with ESMTP id v3ALne0m029781 for <sipcore@ietf.org>; Mon, 10 Apr 2017 17:49:40 -0400
Received: (from worley@localhost) by hobgoblin.ariadne.com (8.14.7/8.14.7/Submit) id v3ALnebJ029778; Mon, 10 Apr 2017 17:49:40 -0400
X-Authentication-Warning: hobgoblin.ariadne.com: worley set sender to worley@alum.mit.edu using -f
From: worley@ariadne.com
To: sipcore@ietf.org
Sender: worley@ariadne.com
Date: Mon, 10 Apr 2017 17:49:40 -0400
Message-ID: <87shlgndaj.fsf@hobgoblin.ariadne.com>
X-CMAE-Envelope: MS4wfKHDw7N0bFOSMMTe8exSEMkxCFuiZFVeLPiGYff2VsJ/Ma4seC7vfja4H0k2zQZ38gincpq5D3IeRQdFuMjnZg0PoBLqyQhojmbxjur2TjOgejGKv+nF 9gOW5hsMDzmclJtGV7FDhIiLRjouceCL56ISSYZ+q00Bay66rItjwCHh
Archived-At: <https://mailarchive.ietf.org/arch/msg/sipcore/S9kKpJhj4QaMcWbIKuhNbHftWz4>
Subject: [sipcore] Comments on draft-ietf-sipcore-content-id-01
X-BeenThere: sipcore@ietf.org
X-Mailman-Version: 2.1.22
Precedence: list
List-Id: SIP Core Working Group <sipcore.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/sipcore>, <mailto:sipcore-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/sipcore/>
List-Post: <mailto:sipcore@ietf.org>
List-Help: <mailto:sipcore-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/sipcore>, <mailto:sipcore-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 10 Apr 2017 21:49:45 -0000

The short title is "Content-ID-in-SIP", whereas it seems more natural
to use "Content-ID in SIP".

Table of Contents

     1.1.  Setting up ID value uniquely identifying body . . . . . .   2
     1.2.  Referencing the ID value uniquely identifying body  . . .   3

This seems an awkward way of phrasing it.  In particular, there seems
to be no reason to emphasize uniqueness here.  Perhaps

     1.1.  Establishing a Content-ID identifying the body
     1.2.  Referencing the Content-ID value identifying the body

--

     5.1.  Header Field  . . . . . . . . . . . . . . . . . . . . . .   6
   6.  Change Log  . . . . . . . . . . . . . . . . . . . . . . . . .   7
   7.  Normative References  . . . . . . . . . . . . . . . . . . . .   7
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .   8

These items capitalize later words, whereas the other items capitalize
only initial words.  It seems that the current RFC style heavily
favors capitalizing all the "important" words in section titles.

1.  Introduction

   A message-body of the SIP message can contain one body only or can
   contain several body parts, as specified in [RFC3261] and [RFC5621].

Strictly speaking, a SIP message containing several body parts also
has a body (whose MIME type is multipart/something).  I think it would
be better to phrase this

   A message-body of the SIP message can be a non-multipart body or
   can be a multipart body that contains several body parts, as
   specified in [RFC3261] and [RFC5621].

I think this can be carried through to other places that use the
phrase "one body".  (Although "one body" is a close version of the
phrase "unitary body", which would be a good term for "non-multipart
body", though nobody uses the phrase!)

1.5.  Solution

Section 1.5 looks much like section 3.3, and I think the duplication
should be reduced.  Perhaps the text in 1.5 could be reduced to

   The Content-ID header field included in header fields of a SIP
   message identifies a body part consisting of the message-body of
   the SIP message.  The metadata provided by some additional header
   fields also applies to the message body as a whole.

3.2.  Syntax

   The ABNF for the Content-ID header fields is:

   Content-ID = "Content-ID" HCOLON msg-id

   NOTE: msg-id is specified in [RFC5322].

Comparing with RFC 5322, I see:

   msg-id          =   [CFWS] "<" id-left "@" id-right ">" [CFWS]

   CFWS            =   (1*([FWS] comment) [FWS]) / FWS

   comment         =   "(" *([FWS] ccontent) [FWS] ")"

I'm sure we don't want to allow comments!

I can see a couple of ways to avoid this.  One is to annotate it:

   The ABNF for the Content-ID header fields is:

   Content-ID = "Content-ID" HCOLON msg-id

   NOTE: msg-id is specified in [RFC5322], but may not contain
   "comment".

But this allows RFC 5322's FWS, which is slightly broader than RFC
3261's SWS.  Probably best is to force the whitespace to be in the
style of RFC 3261:

   The ABNF for the Content-ID header fields is:

   Content-ID = "Content-ID" HCOLON msg-id

   msg-id     = "<" id-left "@" id-right ">"

   NOTE: id-left and id-right are specified in [RFC5322].

Note that SIP header fields generally do not allow trailing
whitespace.

3.3.  Semantic

I think you want "Semantics" as the section title.

I notice this item in the list (which is duplicated in section 1.5):

   o  a Content-ID header field, if included in the header fields of the
      SIP message;

This reads awkwardly, because the beginning of the paragraph has
specified that there is a Content-ID header field in the message.  I
think this could be clarified by promoting this item to the top of the
list and explicitly labeling it all as metadata:

   The Content-ID header field included in header fields of a SIP
   message identifies a body part consisting of the message-body of
   the SIP message and the following metadata:

   o  the Content-ID header field itself;

and then continuing with "a MIME-Version header field", etc.

Dale