Parametrized Content-Format for CoAP

Status of This Memo

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 https://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 12 December 2022.¶

Copyright Notice

Copyright (c) 2022 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 (https://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 Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶

Table of Contents

1. Introduction

CoAP squashes the combination of a media type, media type parameters and content coding into a single Content-Format number. (For an example, see Section 16.10 of [RFC8152].) This number is carried in the Content-Format and Accept Options.¶

This compression strategy is ideal in cases where the set of possible combinations is known upfront and has small cardinality. However, it lacks the flexibility to deal smoothly with situations where the number of combinations can grow unbounded.¶

An example is [I-D.lundblade-rats-eat-media-type], in which the "profile" media type parameter can carry a number of different values that are constantly minted through a loosely regulated process.¶

To avoid the combinatorial explosion that derives from such premises, this document defines the "parametrized" Content-Format data item (Section 3) as a mechanism to enrich a given Content-Format with additional media type parameters.¶

Two new CoAP Options that build upon such data item are also defined:¶

• Parametrized-Content-Format (Section 4)¶
• Parametrized-Multi-Valued-Accept (Section 5)¶

The latter also works around the limited content negotiation capabilities of the CoAP Accept Option by allowing to accept more than one Content-Format per request.¶

2. Conventions and Definitions

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶

3. Parametrized Content-Format

The Parametrized Content-Format is a CBOR [STD94] data item defined by the CDDL [RFC8610] in Figure 1.¶

The first element in the tuple is the Content-Format identifier, followed by zero or more name-value pairs representing the additional media type parameters.¶

The name-value pairs are optional to support the case where the Parametrized Content-Format is used in Parametrized Multi-Valued Accept Option (Section 5).¶

parametrized-content-format = [
  content-format,
  * [ parameter-name, parameter-value ]
]

content-format = 0..65535

parameter-name = textual / numeric
parameter-value = any

textual = text .abnf ("parameter-name" .det RFC6838-parameter-name)
numeric = int

RFC6838-parameter-name = '
  parameter-name = restricted-name

  restricted-name = restricted-name-first *126restricted-name-chars
  restricted-name-first  = ALPHA / DIGIT
  restricted-name-chars  = ALPHA / DIGIT / "!" / "#" /
                           "$" / "&" / "-" / "^" / "_"
  restricted-name-chars =/ "." ; Characters before first dot always
                               ; specify a facet name
  restricted-name-chars =/ "+" ; Characters after last plus always
                               ; specify a structured syntax suffix

  ALPHA         =  %x41-5A / %x61-7A  ; A-Z / a-z
  DIGIT         =  %x30-39            ; 0-9
'

TODO describe use of numeric identifiers as alias for parameter names (requires a new registry).¶

[
  65000,
  [ "p1", "a-string-value" ],
  [ "p2", 128 ]
]

4. Parametrized Content-Format Option

The Parametrized Content-Format Option carries a CBOR-encoded Parametrized Content-Format data item.¶

pcf-option-fmt = bytes .cbor parametrized-content-format

The semantic is identical to the Content-Format Option described in Section 5.10.3 of [RFC7252].¶

5. Parametrized Multi-Valued Accept Option

The Parametrized Multi-Valued Accept Option carries a single CBOR-encoded Parametrized Content-Format data item or two or more Parametrized Content-Format data items as a CBOR array.¶

one-or-more<T> = T / [ 2* T ]

pmva-option-fmt = bytes .cbor one-or-more<parametrized-content-format>

The semantic is identical to the Accept Option described in Section 5.10.4 of [RFC7252], except for the ability to list more than one acceptable (parametrized) Content-Format, which is key to enable finer-grained content negotiation.¶

The Content-Formats are listed in order of preference. If more than one match is found, the entry with the lowest index in the array MUST be selected.¶

6. Security Considerations

TODO Security¶

7. IANA Considerations

TODO IANA¶

Acknowledgments

TODO acknowledge.¶

Authors' Addresses