One document matched: draft-ietf-core-http-mapping-06.xml
<?xml version="1.0" encoding="us-ascii"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
<!ENTITY RFC2119 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml">
<!ENTITY RFC2616 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2616.xml">
<!ENTITY RFC3040 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.3040.xml">
<!ENTITY RFC3986 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.3986.xml">
<!ENTITY RFC4732 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.4732.xml">
<!ENTITY RFC6570 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.6570.xml">
<!ENTITY RFC6690 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.6690.xml">
<!ENTITY RFC7049 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.7049.xml">
<!ENTITY RFC7230 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.7230.xml">
<!ENTITY RFC7231 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.7231.xml">
<!ENTITY RFC7235 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.7235.xml">
<!ENTITY RFC7252 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.7252.xml">
<!ENTITY RFC7390 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.7390.xml">
<!ENTITY I-D.ietf-core-observe SYSTEM "http://xml.resource.org/public/rfc/bibxml3/reference.I-D.ietf-core-observe.xml">
<!ENTITY I-D.ietf-core-block SYSTEM "http://xml.resource.org/public/rfc/bibxml3/reference.I-D.ietf-core-block.xml">
<!ENTITY I-D.shelby-core-resource-directory SYSTEM "http://xml.resource.org/public/rfc/bibxml3/reference.I-D.shelby-core-resource-directory.xml">
<!ENTITY I-D.bormann-core-links-json SYSTEM "http://xml.resource.org/public/rfc/bibxml3/reference.I-D.bormann-core-links-json.xml">
]>
<?xml-stylesheet type="text/xsl" href="rfc2629.xslt"?>
<?rfc strict="no"?>
<?rfc toc="yes"?>
<?rfc tocdepth="3"?>
<?rfc symrefs="yes"?>
<?rfc sortrefs="yes"?>
<?rfc compact="yes"?>
<?rfc subcompact="no"?>
<rfc ipr="trust200902" docName="draft-ietf-core-http-mapping-06" category="info">
<front>
<title abbrev="HTTP-CoAP Mapping">
Guidelines for HTTP-CoAP Mapping Implementations
</title>
<author initials="A.P." surname="Castellani" fullname="Angelo P. Castellani">
<organization>University of Padova</organization>
<address>
<postal>
<street>Via Gradenigo 6/B</street>
<code>35131</code>
<city>Padova</city>
<country>Italy</country>
</postal>
<email>angelo@castellani.net</email>
</address>
</author>
<author initials="S." surname="Loreto" fullname="Salvatore Loreto">
<organization>Ericsson</organization>
<address>
<postal>
<street>Hirsalantie 11</street>
<code>02420</code>
<city>Jorvas</city>
<country>Finland</country>
</postal>
<email>salvatore.loreto@ericsson.com</email>
</address>
</author>
<author initials="A." surname="Rahman" fullname="Akbar Rahman">
<organization>InterDigital Communications, LLC</organization>
<address>
<postal>
<street>1000 Sherbrooke Street West</street>
<city>Montreal</city>
<code>H3A 3G4</code>
<country>Canada</country>
</postal>
<phone>+1 514 585 0761</phone>
<email>Akbar.Rahman@InterDigital.com</email>
</address>
</author>
<author initials="T." surname="Fossati" fullname="Thomas Fossati">
<organization>Alcatel-Lucent</organization>
<address>
<postal>
<street>3 Ely Road</street>
<city>Milton, Cambridge</city>
<code>CB24 6DD</code>
<country>UK</country>
</postal>
<email>thomas.fossati@alcatel-lucent.com</email>
</address>
</author>
<author initials="E." surname="Dijk" fullname="Esko Dijk">
<organization>Philips Research</organization>
<address>
<postal>
<street>High Tech Campus 34</street>
<city>Eindhoven</city>
<code>5656 AE</code>
<country>The Netherlands</country>
</postal>
<email>esko.dijk@philips.com</email>
</address>
</author>
<date year="2015"/>
<area>APP</area>
<workgroup>CoRE Working Group</workgroup>
<keyword>CoAP</keyword>
<keyword>HTTP-CoAP mapping</keyword>
<keyword>HTTP-CoAP translation</keyword>
<keyword>proxy implementation</keyword>
<abstract>
<t>This document provides reference information for implementing a proxy that performs translation between
the HTTP protocol and the CoAP protocol, focusing on the reverse proxy case. It describes how a HTTP
request is mapped to a CoAP request and how a CoAP response is mapped back to a HTTP response.
Furthermore it defines a template for URI mapping and provides a set of guidelines for HTTP to
CoAP protocol translation and related proxy implementations.</t>
</abstract>
</front>
<middle>
<section title="Introduction">
<t>CoAP <xref target="RFC7252"/> has been designed with the twofold aim to be an application
protocol specialized for constrained environments and to be easily used in REST architectures such as the Web.
The latter goal has led to define CoAP to easily interoperate with HTTP <xref target="RFC7230"/> through an
intermediary proxy which performs cross-protocol conversion.</t>
<t>Section 10 of <xref target="RFC7252"/> describes the fundamentals of the CoAP-to-HTTP and the HTTP-to-CoAP
cross-protocol mapping process. However, implementing such a cross-protocol proxy can be complex,
and many details regarding its internal procedures and design choices require further elaboration.
Therefore a first goal of this document is to provide more detailed information to proxy designers and
implementers, to help build proxies that correctly inter-work with existing CoAP and HTTP
implementations.</t>
<t>The second goal of this informational document is to define a consistent set of guidelines that a HTTP-to-CoAP proxy
implementation MAY adhere to. The main reason for adhering to such guidelines is to reduce variation
between proxy implementations, thereby increasing interoperability. (For example,
a proxy conforming to these guidelines made by vendor A can be easily replaced by a proxy from
vendor B that also conforms to the guidelines.)</t>
<t>This document is organized as follows:
<list style="symbols">
<t><xref target="terminology"/> describes terminology to identify proxy types, mapping approaches and proxy deployments;</t>
<t><xref target="hc"/> introduces the reverse HTTP-CoAP proxy;</t>
<t><xref target="usecases"/> lists use cases in which HTTP clients need to contact CoAP servers;</t>
<t><xref target="URI-mapping"/> introduces a default HTTP-to-CoAP URI mapping syntax;</t>
<t><xref target="hc-media"/> describes how to map HTTP media types to CoAP content formats and vice versa;</t>
<t><xref target="hc-resp"/> describes how to map CoAP responses to HTTP responses;</t>
<t><xref target="hc-additional"/> describes additional mapping guidelines related to caching, congestion, timeouts
and CoAP blockwise <xref target="I-D.ietf-core-block"/> transfers;</t>
<t><xref target="sec"/> discusses possible security impact of HTTP-CoAP protocol mapping.</t>
</list>
</t>
</section>
<!-- MAIN SECTION ***************************************************************************** -->
<!-- note the terminology section uses capitalization of all terms, while capitals not used in other sections; similar in style to RFC7252. -->
<section title="Terminology" anchor="terminology">
<t>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 <xref target="RFC2119"/>.</t>
<t>HC Proxy: a proxy performing a cross-protocol mapping,
in the context of this document a HTTP-CoAP mapping. A Cross-Protocol Proxy can behave
as a Forward Proxy, Reverse Proxy or Interception Proxy. In this document we focus on
the Reverse Proxy case.</t>
<t>Forward Proxy: a message forwarding agent that is selected by the
client, usually via local configuration rules, to receive requests
for some type(s) of absolute URI and to attempt to satisfy those
requests via translation to the protocol indicated by the absolute URI.
The user decides (is willing to) use the proxy as the forwarding/dereferencing
agent for a predefined subset of the URI space. In [RFC7230] this is called a Proxy.
[RFC7252] defines Forward-Proxy similarly.</t>
<t>Reverse Proxy: as in [RFC7230], a receiving agent that acts
as a layer above some other server(s) and translates the received
requests to the underlying server's protocol. A Reverse HC Proxy behaves as an origin (HTTP)
server on its connection towards the (HTTP) client and
as a (CoAP) client on its connection towards the (CoAP) origin server.
The (HTTP) client uses the "origin-form"
(Section 5.3.1 of <xref target="RFC7230"/>) as a request-target URI.</t>
<t>Interception Proxy <xref target="RFC3040"/>: a proxy that receives inbound traffic flows through the
process of traffic redirection; transparent to the client.</t>
<t>Placement terms: a Server-Side proxy is placed in the same network domain as the server;
conversely a Client-Side proxy is placed in the same network domain as the client.
In any other case, the proxy is said to be External.</t>
<t>Note that a Reverse Proxy appears to a client as an origin server while
a Forward Proxy does not. So when communicating with a Reverse Proxy a client may be
unaware it is communicating with a proxy at all.</t>
</section>
<!-- MAIN SECTION ***************************************************************************** -->
<section title="HTTP-CoAP Reverse Proxy" anchor="hc">
<t>A Reverse HTTP-CoAP Proxy (HC proxy) is accessed by clients only supporting HTTP,
and handles their HTTP requests by mapping these to CoAP requests, which are forwarded to CoAP servers;
mapping back received CoAP responses to HTTP responses.
This mechanism is transparent to the client, which may
assume that it is communicating with the intended target HTTP server. In other words, the client
accesses the proxy as an origin server using the "origin-form" (Section 5.3.1 of <xref target="RFC7230"/>)
as a request target.</t>
<!-- note any references to figure entities will use capitalization because they are named instances of the generic entities.
The instance name happens to be equal to the generic name. -->
<t>See <xref target="fig-http-coap-deployment"/> for an example deployment scenario. Here an HC Proxy
is placed server-side, at the boundary of the Constrained Network domain, to avoid any HTTP traffic
on the Constrained Network and to avoid any (unsecured) CoAP multicast traffic outside the Constrained Network.
The DNS server is used by the HTTP Client to resolve the IP address of the HC Proxy and optionally also
by the HC Proxy to resolve IP addresses of CoAP servers.</t>
<figure title="Reverse Cross-Protocol Proxy Deployment Scenario" anchor="fig-http-coap-deployment">
<artwork><![CDATA[
Constrained Network
.-------------------.
/ .------. \
/ | CoAP | \
/ |server| \
|| '------' ||
|| ||
.--------. HTTP Request .-----------. CoAP Req .------. ||
| HTTP |----------------->| HTTP-CoAP |----------->| CoAP | ||
| Client |<-----------------| Proxy |<-----------|Server| ||
'--------' HTTP Response '-----------' CoAP Resp '------' ||
|| ||
|| .------. ||
|| | CoAP | ||
\ |server| .------. /
\ '------' | CoAP | /
\ |server| /
\ '------' /
'-----------------'
]]></artwork>
</figure>
<t>Other placement options for the HC Proxy (not shown) are client-side, which is in the same domain as the HTTP Client; or
external, which is both outside the HTTP Client's domain and the CoAP servers' domain.</t>
<t>Normative requirements on the translation of HTTP requests to CoAP requests and of the CoAP responses back
to HTTP responses are defined in Section 10.2 of <xref target="RFC7252"/>.
However, that section only
considers the case of a Forward HC Proxy in which a client explicitly indicates it targets a request
to a CoAP server, and does not cover all aspects of proxy implementation in detail. This document provides
guidelines and more details for the implementation
of a Reverse HC Proxy, which MAY be followed in addition to the normative requirements.
Note that most of the guidelines also apply to an Intercepting HC Proxy.
</t>
</section>
<!-- MAIN SECTION ***************************************************************************** -->
<section anchor="usecases" title="Use Cases">
<t>To illustrate in which situations HTTP to CoAP protocol translation may be used, three use cases are described below.
</t>
<t>
1. Smartphone and home sensor: A smartphone can access directly a CoAP home sensor using an authenticated 'https' request,
if its home router contains an HC proxy. An HTML5 application on the smartphone can provide
a friendly UI to the user using standard (HTTP) networking functions of HTML5.
</t>
<t>
2. Legacy building control application without CoAP: A building control application that uses HTTP but not CoAP,
can check the status of CoAP sensors and/or actuators via an HC proxy.
</t>
<t>
3. Making sensor data available to 3rd parties:
For demonstration or public interest purposes,
a HC proxy may be configured to expose the contents of a CoAP sensor to the world via the web (HTTP and/or HTTPS).
Some sensors might only handle secure 'coaps' requests, therefore the proxy is configured to translate any request to a 'coaps' secured request.
The HC proxy is furthermore configured to only pass through GET requests in order to protect the constrained network.
In this way even unattended HTTP clients, such as web crawlers, may index sensor data as regular web pages.
</t>
</section>
<!-- MAIN SECTION ***************************************************************************** -->
<section anchor="URI-mapping" title="URI Mapping">
<t>Though, in principle, a CoAP URI could be directly used by a HTTP user agent to de-reference a CoAP resource through an HC proxy, the reality is that all major web browsers, networking libraries and command line tools do not allow making HTTP requests using URIs with a scheme "coap" or "coaps".</t>
<t>Thus, there is a need for web applications to "pack" a CoAP URI into a HTTP URI so that it can be (non-destructively) transported from the user agent to the HC proxy. The HC proxy can then "unpack" the CoAP URI and finally de-reference it via a CoAP request to the target Server.</t>
<t>URI Mapping is the process through which the URI of a CoAP resource is transformed into an HTTP URI so that:
<list style="symbols"><t>the requesting HTTP user agent can handle it;</t><t>the receiving HC proxy can extract the intended CoAP URI unambiguously.</t></list>
</t>
<t>To this end, the remainder of this section will identify:
<list style="symbols"><t>the default mechanism to map a CoAP URI into a HTTP URI;</t><t>the URI template format to express a class of CoAP-HTTP URI mapping functions;</t><t>the discovery mechanism based on
CoRE Link Format <xref target="RFC6690"/> through which clients of an HC proxy can dynamically discover information about the supported URI Mapping Template(s), as well as the base URI where the HC proxy function is anchored.</t></list>
</t>
<section title="URI Terminology">
<t>In the remainder of this section, the following terms will be used with a distinctive meaning:
<list style="hanging" hangIndent="8"><t hangText="Target CoAP URI:"><vspace/>URI which refers to the (final) CoAP resource that has to be de-referenced. It conforms to syntax defined in Section 6 of <xref target="RFC7252"/>. Specifically, its scheme is either "coap" or "coaps".</t><t hangText="Hosting HTTP URI:"><vspace/>URI that conforms to syntax in
Section 2.7 of <xref target="RFC7230"/>. Its authority component refers to an HC proxy, whereas path (and query) component(s) embed the information used by an HC proxy to extract the Target CoAP URI.</t></list>
</t>
</section>
<!-- Terminology -->
<section title="Default Mapping" anchor="section.default-mapping">
<t>The default mapping is for the Target CoAP URI to be appended as-is to a base URI provided by the HC proxy, to form the Hosting HTTP URI.</t>
<t>For example: given a base URI http://p.example.com/hc and a Target CoAP URI coap://s.example.com/light, the resulting Hosting HTTP URI would be http://p.example.com/hc/coap://s.example.com/light.</t>
<t>Provided a correct Target CoAP URI, the Hosting HTTP URI resulting from the default mapping is always syntactically correct.
Furthermore, the Target CoAP URI can always be extracted in an
unambiguous way from the Hosting HTTP URI. Also it is worth noting that, using the default mapping, a query component in the target CoAP resource URI is
naturally encoded into the query component of the Hosting URI, e.g.:
coap://s.example.com/light?dim=5 becomes http://p.example.com/hc/coap://s.example.com/light?dim=5.
</t>
<t>There is no default for the base URI. Therefore it is either known in advance, e.g. as a configuration preset, or dynamically discovered using the mechanism described in <xref target="section.discovery"/>.</t>
<t>The default URI mapping function is RECOMMENDED to be implemented and activated by default in an HC proxy, unless there are valid reasons, e.g. application specific, to use a different mapping function.</t>
<section title="Optional Scheme Omission" anchor="section.optional-scheme">
<t>When found in a Hosting HTTP URI, the scheme (i.e., "coap" or "coaps"), the scheme component delimiter (":"), and the double slash ("//") preceding the authority MAY be omitted. In such case, a local default - not defined by this document - applies.</t>
<t>So, http://p.example.com/hc/s.coap.example.com/foo could either represent the target coap://s.coap.example.com/foo or coaps://s.coap.example.com/foo depending on application specific presets.</t>
</section>
<!-- Optional scheme -->
<section title="Encoding Caveats" anchor="section.encoding-caveats">
<t>When the authority of the Target CoAP URI is given as an IPv6address, then the surrounding square brackets MUST be percent-encoded in the Hosting HTTP URI, in order to comply with the syntax defined in Section 3.3. of <xref target="RFC3986"/> for a URI path segment. E.g.: coap://[2001:db8::1]/light?on becomes http://p.example.com/hc/coap://%5B2001:db8::1%5D/light?on.</t>
<t>Everything else can be safely copied verbatim from the Target CoAP URI to the Hosting HTTP URI.</t>
</section>
<!-- Encoding Caveats -->
</section>
<!-- Default Mapping -->
<section title="URI Mapping Template">
<t>This section defines a format for the URI template <xref target="RFC6570"/> used by an HC proxy to inform its clients about the expected syntax for the Hosting HTTP URI.</t>
<t>When instantiated, an URI Mapping Template is always concatenated to a base URI provided by the HC proxy via discovery (see <xref target="section.discovery"/>), or by other means.</t>
<t>A simple form (<xref target="section.simple-form"/>) and an enhanced form (<xref target="section.enhanced-form"/>) are provided to fit different users' requirements.</t>
<t>Both forms are expressed as level 2 URI templates [RFC6570] to take care of the expansion of values that are allowed to include reserved URI characters.
The syntax of all URI formats is specified in this section in Augmented Backus-Naur Form (ABNF) [RFC5234].</t>
<section title="Simple Form" anchor="section.simple-form">
<t>The simple form MUST be used for mappings where the Target CoAP URI is going to be copied (using rules of <xref target="section.encoding-caveats"/>) at some fixed position into the Hosting HTTP URI.</t>
<t>The following template variables MUST be used in mutual exclusion in a template definition:
<figure><artwork>
cu = coap-URI ; from [RFC7252], Section 6.1
su = coaps-URI ; from [RFC7252], Section 6.2
tu = cu / su
</artwork></figure>
The same considerations as in <xref target="section.optional-scheme"/> apply, in that the CoAP scheme may be omitted from the Hosting HTTP URI.
</t>
<section title="Examples">
<t>All the following examples (given as a specific URI mapping template, a Target CoAP URI, and the produced Hosting HTTP URI) use http://p.example.com/hc as the base URI.
Note that these examples all define mapping templates that deviate from the default template of <xref target="section.default-mapping"/> to be able
to illustrate the use of the above template variables.
</t>
<t>
<list style="numbers">
<t>"coap" URI is a query argument of the Hosting HTTP URI:
<figure><artwork>
?coap_target_uri={+cu}
coap://s.example.com/light
http://p.example.com/hc?coap_target_uri=coap://s.example.com/light
</artwork></figure>
</t>
<t>"coaps" URI is a query argument of the Hosting HTTP URI:
<figure><artwork><![CDATA[
?coaps_target_uri={+su}
coaps://s.example.com/light
http://p.example.com/hc?coaps_target_uri=coaps://s.example.com/light
]]></artwork></figure>
</t>
<t>Target CoAP URI as a query argument of the Hosting HTTP URI:
<figure><artwork><![CDATA[
?target_uri={+tu}
coap://s.example.com/light
http://p.example.com/hc?target_uri=coap://s.example.com/light
or
coaps://s.example.com/light
http://p.example.com/hc?target_uri=coaps://s.example.com/light
]]></artwork></figure>
</t>
<t>Target CoAP URI in the path component of the Hosting HTTP URI (i.e., the default URI Mapping template):
<figure><artwork><![CDATA[
/{+tu}
coap://s.example.com/light
http://p.example.com/hc/coap://s.example.com/light
or
coaps://s.example.com/light
http://p.example.com/hc/coaps://s.example.com/light
]]></artwork></figure>
</t>
<t>"coap" URI is a query argument of the Hosting HTTP URI; client decides to omit scheme
because a default scheme is agreed beforehand between client and proxy:
<figure><artwork>
?coap_uri={+cu}
coap://s.example.com/light
http://p.example.com/hc?coap_uri=s.example.com/light
</artwork></figure>
</t>
</list>
</t>
</section>
<!-- Examples -->
</section>
<!-- Simple Form -->
<section title="Enhanced Form" anchor="section.enhanced-form">
<t>The enhanced form can be used to express more sophisticated mappings, i.e., those that do not fit into the simple form.</t>
<t>There MUST be at most one instance of each of the following template variables in a template definition:
<figure><artwork>
s = "coap" / "coaps" ; from [RFC7252], Sections 6.1 and 6.2
hp = host [":" port] ; from [RFC3986] Sections 3.2.2 and 3.2.3
p = path-abempty ; from [RFC3986] Section 3.3
q = query ; from [RFC3986] Section 3.4
qq = [ "?" query ] ; qq is empty iff 'query' is empty
</artwork></figure>
</t>
<section title="Examples">
<t>All the following examples (given as a specific URI mapping template, a Target CoAP URI, and the produced Hosting HTTP URI) use http://p.example.com/hc as the base URI.</t>
<t>
<list style="numbers">
<t>Target CoAP URI components in path segments, and optional query in query component:
<figure><artwork>
{+s}{+hp}{+p}{+qq}
coap://s.example.com/light
http://p.example.com/hc/coap/s.example.com/light
or
coap://s.example.com/light?on
http://p.example.com/hc/coap/s.example.com/light?on
</artwork></figure>
</t>
<t>Target CoAP URI components split in individual query arguments:
<figure><artwork><![CDATA[
?s={+s}&hp={+hp}&p={+p}&q={+q}
coap://s.example.com/light
http://p.example.com/hc?s=coap&hp=s.example.com&p=/light&q=
or
coaps://s.example.com/light?on
http://p.example.com/hc?s=coaps&hp=s.example.com&p=/light&q=on
]]></artwork></figure>
</t>
</list>
</t>
</section>
<!-- Examples -->
</section>
<!-- Enhanced Form -->
</section>
<!-- URI Mapping Template -->
<section title="Discovery" anchor="section.discovery">
<t>In order to accommodate site specific needs while allowing third parties to discover the proxy function, the HC proxy SHOULD
publish information related to the location and syntax of the HC proxy function using the CoRE Link Format <xref target="RFC6690"/> interface.</t>
<t>To this aim a new Resource Type, "core.hc", is defined in this document. It is associated with a base URI, and can be used as the value for the "rt" attribute in
a query to the /.well-known/core in order to locate the base URI where the HC proxy function is anchored.</t>
<t>Along with it, the new target attribute "hct" is defined in this document. This attribute MAY be returned in a "core.hc" link to provide the URI Mapping Template associated to the mapping resource.
The default template given in <xref target="section.default-mapping"/>, i.e., {+tu}, MUST be assumed if no "hct" attribute is found
in the returned link. If an "hct" attribute is present in the returned link, then a compliant client MUST use it to create the Hosting HTTP URI.</t>
<t>Discovery as specified in [RFC6690] SHOULD be available on both the HTTP and the CoAP side of the HC proxy, with one important difference: on the CoAP side the
link associated to the "core.hc" resource needs an explicit anchor referring to the HTTP origin, while on the HTTP interface the link context
is already the HTTP origin carried in the request's Host header, and doesn't have to be made explicit.</t>
<section title="Examples">
<t><list style="symbols"><t>The first example exercises the CoAP interface, and assumes that the default template, {+tu}, is used:
<figure><artwork><![CDATA[
Req: GET coap://[ff02::1]/.well-known/core?rt=core.hc
Res: 2.05 Content
</hc>;anchor="http://p.example.com";rt="core.hc"
]]></artwork></figure>
</t><t>The second example - also on the CoAP side of the HC proxy - uses a custom template, i.e., one where the CoAP URI is carried inside the query component, thus the returned link carries the URI template to be used in an explicit "hct" attribute:
<figure><artwork><![CDATA[
Req: GET coap://[ff02::1]/.well-known/core?rt=core.hc
Res: 2.05 Content
</hc>;anchor="http://p.example.com";
rt="core.hc";hct="?uri={+tu}"
]]></artwork></figure>
</t></list>
On the HTTP side link information can be serialised in more than one way:
<list style="symbols"><t>using the 'application/link-format' content type:
<figure><artwork><![CDATA[
Req: GET /.well-known/core?rt=core.hc HTTP/1.1
Host: p.example.com
Res: HTTP/1.1 200 OK
Content-Type: application/link-format
Content-Length: 18
</hc>;rt="core.hc"
]]></artwork></figure>
</t><t>using the 'application/link-format+json' content type as defined in <xref target="I-D.bormann-core-links-json"/>:
<figure><artwork><![CDATA[
Req: GET /.well-known/core?rt=core.hc HTTP/1.1
Host: p.example.com
Res: HTTP/1.1 200 OK
Content-Type: application/link-format+json
Content-Length: 31
[{"href":"/hc","rt":"core.hc"}]
]]></artwork></figure>
</t><t>using the Link header:
<figure><artwork><![CDATA[
Req: GET /.well-known/core?rt=core.hc HTTP/1.1
Host: p.example.com
Res: HTTP/1.1 200 OK
Link: </hc>;rt="core.hc"
]]></artwork></figure>
</t><t>An HC proxy may expose two different base URIs to differentiate between Target CoAP resources in the "coap" and "coaps" scheme:
<figure><artwork><![CDATA[
Req: GET /.well-known/core?rt=core.hc
Host: p.example.com
Res: HTTP/1.1 200 OK
Content-Type: application/link-format+json
Content-Length: 111
[
{"href":"/hc/plaintext","rt":"core.hc","hct":"{+cu}"},
{"href":"/hc/secure","rt":"core.hc","hct":"{+su}"}
]
]]></artwork></figure>
</t></list>
</t>
</section>
<!-- Examples -->
</section>
<!-- Discovery -->
</section>
<!-- URI Mapping -->
<!-- MAIN SECTION ***************************************************************************** -->
<section title="Media Type Mapping" anchor="hc-media">
<section title="Overview">
<t>An HC proxy needs to translate HTTP media types (Section 3.1.1.1 of <xref target="RFC7231"/>) and content encodings (Section 3.1.2.2 of <xref target="RFC7231"/>) into CoAP content formats (Section 12.3 of <xref target="RFC7252"/>) and vice versa.</t>
<t>Media type translation can happen in GET, PUT or POST requests going from HTTP to CoAP, and in 2.xx (i.e., successful) responses going from CoAP to HTTP. Specifically, PUT and POST need to map both the Content-Type and Content-Encoding HTTP headers into a single CoAP Content-Format option, whereas GET needs to map Accept and Accept-Encoding HTTP headers into a single CoAP Accept option. To generate the HTTP response, the CoAP Content-Format option is mapped back to a suitable HTTP Content-Type and Content-Encoding combination.</t>
<t>An HTTP request carrying a Content-Type and Content-Encoding combination which the HC proxy is unable to map to an equivalent CoAP Content-Format, SHALL elicit a 415 (Unsupported Media Type) response by the HC proxy.</t>
<t>If the HC proxy receives a CoAP response with a Content-Format that it does not recognise (for example because the value has been registered after the proxy has been implemented), then it is allowed to either return a HTTP entity without a Content-Type header, or examine the data to determine its type on the fly.</t>
<t>On the content negotiation side, failure to map Accept and Accept-* headers SHOULD be silently ignored: the HC proxy SHOULD therefore forward as a CoAP request with no Accept option.
The HC proxy thus disregards the Accept/Accept-* header fields by treating the response as if it is not subject to content negotiation, as mentioned in Sections 5.3.* of [RFC7231].
However, an HC proxy implementation is free to attempt mapping a single Accept header in a GET request to multiple CoAP GET requests, each with a single Accept option,
which are then tried in sequence until one succeeds.
Note that an HTTP Accept */* MUST be mapped to a CoAP request without Accept option.</t>
<t>While the CoAP to HTTP direction has always a well defined mapping, the HTTP to CoAP direction is more problematic because the source set, i.e., potentially 1000+ IANA registered media types, is much bigger than the destination set, i.e., the mere 6 values initially defined in Section 12.3 of <xref target="RFC7252"/>.</t>
<t>Depending on the tight/loose coupling with the application(s) for which it proxies, the HC proxy could implement different media type mappings.</t>
<t>When tightly coupled, the HC proxy knows exactly which content formats are supported by the applications, and can be strict when enforcing its forwarding policies in general, and the media type mapping in particular.</t>
<t>On the other side, when the HC proxy is a general purpose application layer gateway, being too strict could significantly reduce the amount of traffic that it'd be able to successfully forward. In this cases, the "loose" media type mapping detailed in <xref target="sec-loose-mt-mapping"/> MAY be implemented.</t>
<!-- TODO/tbd move it to Sec Cons -->
<t>The latter grants more evolution of the surrounding ecosystem, at the cost of allowing more attack surface. In fact, as a result of such strategy, payloads would be forwarded more liberally across the unconstrained/constrained network boundary of the communication path. Therefore, when applied, other forms of access control must be set in place to avoid unauthorised users to deplete or abuse systems and network resources.</t>
</section>
<section title="Loose Media Type Mapping" anchor="sec-loose-mt-mapping">
<t>By structuring the type information in a super-class (e.g. "text") followed by a finer grained sub-class (e.g. "html"), and optional parameters (e.g. "charset=utf-8"), Internet media types provide a rich and scalable framework for encoding the type of any given entity.</t>
<t>This approach is not applicable to CoAP, where Content Formats conflate an Internet media type (potentially with specific parameters) and a content encoding into one small integer value.</t>
<t>To remedy this loss of flexibility, we introduce the concept of a "loose" media type mapping, where media types that are specialisations of a more generic media type can be aliased to their super-class and then mapped (if possible) to one of the CoAP content formats. For example, "application/soap+xml" can be aliased to "application/xml", which has a known conversion to CoAP. In the context of this "loose" media type mapping, "application/octet-stream" can be used as a fallback when no better alias is found for a specific media type.</t>
<t><xref target="tab-generalised-mt"/> defines the default lookup table for the "loose" media type mapping. Given an input media type, the table returns its best generalised media type using the most specific match i.e. the table entries are compared to the input in top to bottom order until an entry matches.</t>
<texttable anchor="tab-generalised-mt" title="Media type generalisation lookup table">
<ttcol align="left">Internet media type</ttcol>
<ttcol align="left">Generalised media type</ttcol>
<c>application/*+xml</c><c>application/xml</c>
<c>application/*+json</c><c>application/json</c>
<c>text/xml</c><c>application/xml</c>
<c>text/*</c><c>text/plain</c>
<c>*/*</c><c>application/octet-stream</c>
</texttable>
<t>The "loose" media type mapping is an OPTIONAL feature. Implementations supporting this kind of mapping SHOULD provide a flexible way to define the set of media type generalisations allowed.</t>
</section>
<section title="Media Type to Content Format Mapping Algorithm" anchor="sec-mt2cf">
<t>This section defines the algorithm used to map an HTTP Internet media type to its correspondent CoAP content format.</t>
<t>The algorithm uses the mapping table Table 9 defined in Section 12.3 of <xref target="RFC7252"/> plus, possibly, any locally defined extension of it.
Optionally, the table and lookup mechanism described in <xref target="sec-loose-mt-mapping"/> can be used if the implementation chooses so.</t>
<t>Note that the algorithm may have side effects on the associated representation (see also <xref target="sec-content-trans"/>).</t>
<t>In the following:
<list style="symbols">
<t>C-T, C-E, and C-F stand for the values of the Content-Type (or Accept) HTTP header, Content-Encoding (or Accept-Encoding) HTTP header, and Content-Format CoAP option respectively.</t>
<t>If C-E is not given it is assumed to be "identity".</t>
<t>MAP is the mandatory lookup table, GMAP is the optional generalised table.</t>
</list>
</t>
<figure anchor="fig-mt2cf">
<artwork>
INPUT: C-T and C-E
OUTPUT: C-F or Fail
1. if no C-T: return Fail
2. C-F = MAP[C-T, C-E]
3. if C-F is not None: return C-F
4. if C-E is not "identity":
5. if C-E is supported (e.g. gzip):
6. decode the representation accordingly
7. set C-E to "identity"
8. else:
9. return Fail
10. repeat steps 2. and 3.
11. if C-T allows a non-lossy transformation into \
12. one of the supported C-F:
13. transcode the representation accordingly
14. return C-F
15. if GMAP is defined:
16. C-F = GMAP[C-T]
17. if C-F is not None: return C-F
18. return Fail
</artwork>
</figure>
<!-- TODO maybe describe the algorithm? -->
<!-- TODO provide examples -->
</section>
<section title="Content Transcoding" anchor="sec-content-trans">
<section title="General">
<t>Payload content transcoding (e.g. see steps 11-14 of <xref target="fig-mt2cf"/>) is an OPTIONAL feature. Implementations supporting this feature
should provide a flexible way to define the set of transcodings allowed.</t>
<t>As noted in <xref target="sec-mt2cf"/>, the process of mapping the media type can have side effects on the forwarded entity body.
This may be caused by the removal or addition of a specific content encoding, or because the HC proxy decides to transcode the representation
to a different (compatible) format. The latter proves useful when an optimised version of a specific format exists. For example an XML-encoded
resource could be transcoded to Efficient XML Interchange (EXI) format, or a JSON-encoded resource into CBOR <xref target="RFC7049"/>, effectively
achieving compression without losing any information.</t>
<t>However, it should be noted that in certain cases, transcoding can lose information in a non-obvious manner. For example, encoding an XML document using schema-informed EXI encoding
leads to a loss of information when the destination does not know the exact schema version used by the encoder. So whenever the HC proxy transcodes
an application/XML to application/EXI in-band meta data could be lost. Therefore, the implementer should always carefully verify such lossy payload
transformations before triggering the transcoding.</t>
</section>
<section title="CoRE Link Format">
<t>The CoRE Link Format <xref target="RFC6690"/> is a set of links (i.e., URIs and their formal relationships) which is carried as
content payload in a CoAP response. These links usually include CoAP URIs that might be translated by the HC proxy to the correspondent
HTTP URIs using the implemented URI mapping function (see <xref target="URI-mapping"/>). Such a process would inspect
the forwarded traffic and attempt to re-write the body of resources with an application/link-format
media type, mapping the embedded CoAP URIs to their HTTP counterparts. Some potential issues with this approach are:
<list style="numbers">
<t>The client may be interested to retrieve original (unaltered) CoAP payloads through the HC proxy, not modified
versions.</t>
<t>Tampering with payloads is incompatible with resources that are integrity protected
(although this is a problem with transcoding in general).</t>
<t>The HC proxy needs to fully understand <xref target="RFC6690"/> syntax and semantics, otherwise
there is an inherent risk to corrupt the payloads.</t>
</list>
Therefore, CoRE Link Format payload should only be transcoded at the risk and discretion of the proxy implementer.</t>
</section>
<section title="Diagnostic Messages">
<t>CoAP responses may, in certain error cases, contain a diagnostic message in the payload explaining
the error situation, as described in Section 5.5.2 of <xref target="RFC7252"/>. In this scenario, the
CoAP response diagnostic payload MUST NOT be returned as the regular HTTP payload (message body). Instead, the CoAP diagnostic payload must
be used as the HTTP reason-phrase of the HTTP status line, as defined in Section 3.1.2 of <xref target="RFC7230"/>, without any alterations.</t>
</section>
</section>
<!-- Content Transcoding -->
</section>
<!-- Media Type Mapping -->
<!-- MAIN SECTION ***************************************************************************** -->
<section title="Response Code Mapping" anchor="hc-resp">
<t><xref target="tab-http-coap"/> defines the HTTP response status codes to which
each CoAP response code SHOULD be mapped. This table complies with the requirements in Section 10.2
of <xref target="RFC7252"/> and is intended to cover all possible cases. Multiple appearances of a
HTTP status code in the second column indicates multiple equivalent HTTP responses are possible
based on the same CoAP response code, depending on the conditions cited in the Notes (third column
and text below table).
</t>
<texttable anchor="tab-http-coap" title="CoAP-HTTP Response Code Mappings">
<ttcol align="left">CoAP Response Code</ttcol>
<ttcol align="left">HTTP Status Code</ttcol>
<ttcol align="left">Notes</ttcol>
<c>2.01 Created </c>
<c>201 Created </c>
<c>1</c>
<c>2.02 Deleted </c>
<c>200 OK </c>
<c>2</c>
<c> </c>
<c>204 No Content </c>
<c>2</c>
<c>2.03 Valid </c>
<c>304 Not Modified </c>
<c>3</c>
<c> </c>
<c>200 OK </c>
<c>4</c>
<c>2.04 Changed </c>
<c>200 OK </c>
<c>2</c>
<c> </c>
<c>204 No Content </c>
<c>2</c>
<c>2.05 Content </c>
<c>200 OK </c>
<c> </c>
<c>4.00 Bad Request </c>
<c>400 Bad Request </c>
<c> </c>
<c>4.01 Unauthorized </c>
<c>401 Unauthorized </c>
<c>5</c>
<c>4.02 Bad Option </c>
<c>400 Bad Request </c>
<c>6</c>
<c>4.03 Forbidden </c>
<c>403 Forbidden </c>
<c> </c>
<c>4.04 Not Found </c>
<c>404 Not Found </c>
<c> </c>
<c>4.05 Method Not Allowed </c>
<c>405 Method Not Allowed </c>
<c>7</c>
<c>4.06 Not Acceptable </c>
<c>406 Not Acceptable </c>
<c> </c>
<c>4.12 Precondition Failed </c>
<c>412 Precondition Failed </c>
<c> </c>
<c>4.13 Request Ent. Too Large</c>
<c>413 Request Repr. Too Large </c>
<c> </c>
<c>4.15 Unsupported Media Type </c>
<c>415 Unsupported Media Type </c>
<c> </c>
<c>5.00 Internal Server Error </c>
<c>500 Internal Server Error </c>
<c> </c>
<c>5.01 Not Implemented </c>
<c>501 Not Implemented </c>
<c> </c>
<c>5.02 Bad Gateway </c>
<c>502 Bad Gateway </c>
<c> </c>
<c>5.03 Service Unavailable </c>
<c>503 Service Unavailable </c>
<c>8</c>
<c>5.04 Gateway Timeout </c>
<c>504 Gateway Timeout </c>
<c> </c>
<c>5.05 Proxying Not Supported </c>
<c>502 Bad Gateway </c>
<c>9</c>
</texttable>
<t>Notes:
<list style="numbers"><t>A CoAP server may return an arbitrary format payload along with this response. This
payload SHOULD be returned as entity in the HTTP 201 response. Section 7.3.2 of
<xref target="RFC7231"/> does not put any requirement on the
format of the entity. (In the past, <xref target="RFC2616"/> did.)</t>
<t>The HTTP code is 200 or 204 respectively for the case that a CoAP server returns a
payload or not. <xref target="RFC7231"/> Section 5.3
requires code 200 in case a representation of the action result is returned
for DELETE/POST/PUT, and code 204 if not. Hence, a proxy SHOULD
transfer any CoAP payload contained in a CoAP 2.02 response to the HTTP client using a
200 OK response.</t>
<t>HTTP code 304 (Not Modified) is sent if the HTTP client performed a conditional HTTP request and the CoAP
server responded with 2.03 (Valid) to the corresponding CoAP validation request. Note that Section 4.1 of [RFC7232]
puts some requirements on header fields that must be present in the HTTP 304 response.</t>
<t>A 200 response to a CoAP 2.03 occurs only when the HC proxy, for efficiency reasons, is caching resources
and translated a HTTP request (without conditional request) to a CoAP request
that includes ETag validation. The proxy receiving 2.03 updates
the freshness of its cached representation and returns the entire representation
to the HTTP client.</t>
<t>A HTTP 401 Unauthorized (Section 3.1 of <xref target="RFC7235"/>) response MUST include a WWW-Authenticate header.
Since there is no CoAP equivalent of WWW-Authenticate, the HC proxy must generate this header itself
including at least one challenge (Section 4.1 of [RFC7235]).
If the HC proxy does not implement a proper authentication method that can be used to gain access to
the target CoAP resource, it can include a 'dummy' challenge for example "WWW-Authenticate: None".
</t>
<t>A proxy receiving 4.02 may first retry the request with less CoAP Options
in the hope that the CoAP server will understand the newly formulated request.
For example, if the proxy tried using a Block Option <xref target="I-D.ietf-core-block"/> which was not recognised by
the CoAP server it may retry without that Block Option. Note that HTTP 402 MUST NOT be returned because
it is reserved for future use [RFC7231].
</t>
<t>HTTP code 405 (Method Not Allowed) MUST include an "Allow" response-header field
(Section 7.4.1 of [RFC7231]). However, a CoAP response does not include information
about which methods are allowed on the resource. Therefore, if the proxy does not have
further information about which methods are allowed on the resource it SHOULD include
an empty field value in the Allow header field. The intended interpretation of an empty Allow
in this case is "resource temporarily allows no methods" which complies fully to [RFC7231].
</t>
<t>The value of the HTTP "Retry-After" response-header field is taken from the
value of the CoAP Max-Age Option, if present.</t>
<t>This CoAP response can only happen if the proxy itself is configured to use a
CoAP forward-proxy (Section 5.7 of [RFC7252]) to execute some, or all, of its CoAP requests.
</t></list>
</t>
</section>
<!-- Response Mapping -->
<!-- MAIN SECTION ***************************************************************************** -->
<section title="Additional Mapping Guidelines" anchor="hc-additional">
<section title="Caching and Congestion Control" anchor="hc-caching">
<!-- discuss cache-control -->
<t>An HC proxy SHOULD limit the number of requests to CoAP servers
by responding, where applicable, with a cached representation of the resource.</t>
<t>Duplicate idempotent pending requests by an HC proxy to the same CoAP resource SHOULD in general be avoided,
by using the same response for multiple requesting HTTP clients without duplicating the CoAP request.
<!--
The same consideration apply if multiple active HTTP subscriptions involve the same observe relationship.
-->
</t>
<t>If the HTTP client times out and drops the HTTP session to the HC proxy (closing the TCP connection)
after the HTTP request was made,
an HC proxy SHOULD wait for the associated CoAP response and cache it if possible.
Further requests to the HC proxy for the same resource can use the result present in cache,
or, if a response has still to come, the HTTP requests will wait on the open CoAP request.</t>
<t>According to <xref target="RFC7252"/>, a proxy MUST limit the number
of outstanding interactions to a given CoAP server to NSTART. To limit the amount of
aggregate traffic to a constrained network,
the HC proxy SHOULD also pose a limit to the number of concurrent CoAP requests pending
on the same constrained network; further incoming requests MAY either be queued or dropped
(returning 503 Service Unavailable). This limit and the proxy queueing/dropping behavior SHOULD be
configurable.
In order to effectively apply above congestion control, the HC proxy should be server-side placed.</t>
<t>Resources experiencing a high access rate coupled with high volatility MAY be observed
<xref target="I-D.ietf-core-observe"/> by the HC proxy
to keep their cached representation fresh while minimizing the number of CoAP traffic in the constrained network.
See <xref target="refresh_via_observe"/>.
</t>
</section>
<section title="Cache Refresh via Observe" anchor="refresh_via_observe">
<t>There are cases where using the CoAP observe protocol <xref target="I-D.ietf-core-observe"/>
to handle proxy cache refresh
is preferable to the validation mechanism based on ETag as defined in <xref target="RFC7252"/>.
Such scenarios include, but are not limited to, sleepy CoAP nodes
-- with possibly high variance in requests' distribution --
which would greatly benefit from a server driven cache update mechanism.
Ideal candidates for CoAP observe are also crowded or very low throughput networks,
where reduction of the total number of exchanged messages is an important requirement.</t>
<t>This subsection aims at providing a practical evaluation method to decide
whether the refresh of a cached resource R is more efficiently handled
via ETag validation or by establishing an observation on R.</t>
<t>Let T_R be the mean time between two client requests to resource R,
let T_C be the mean time between two representation changes of R,
and let M_R be the mean number of CoAP messages per second exchanged to and from resource R.
If we assume that the initial cost for establishing the observation is negligible,
an observation on R reduces M_R iff T_R < 2*T_C with respect to using ETag validation,
that is iff the mean arrival rate of requests for resource R is greater than half the change rate of R.</t>
<t>When observing the resource R, M_R is always upper bounded by 2/T_C.</t>
</section>
<section title="Use of CoAP Blockwise Transfer" anchor="hc-block">
<t>
An HC proxy SHOULD support CoAP blockwise transfers <xref target="I-D.ietf-core-block"/> to
allow transport of large CoAP payloads while avoiding excessive link-layer fragmentation in constrained networks,
and to cope with small datagram buffers in CoAP end-points as described in
<xref target="RFC7252"/> Section 4.6.
</t>
<t>
An HC proxy SHOULD attempt to retry a payload-carrying CoAP PUT or POST request with
blockwise transfer if the destination CoAP server responded with 4.13
(Request Entity Too Large) to the original request.
An HC proxy SHOULD attempt to use blockwise transfer when sending a CoAP PUT or
POST request message that is larger than BLOCKWISE_THRESHOLD bytes. The value of
BLOCKWISE_THRESHOLD is implementation-specific, for example it can be:
<list style="symbols">
<t>calculated based on a known or typical UDP datagram buffer size for CoAP end-points, or</t>
<t>set to N times the known size of a link-layer frame in a constrained network where e.g. N=5, or</t>
<t>preset to a known IP MTU value, or</t>
<t>set to a known Path MTU value.</t>
</list>
The value BLOCKWISE_THRESHOLD, or the
parameters from which it is calculated, should be configurable in a proxy implementation. The maximum
block size the proxy will attempt to use in CoAP requests should also be configurable.
</t>
<t>
The HC proxy SHOULD detect CoAP end-points not supporting blockwise transfers by checking for a
4.02 (Bad Option) response returned by an end-point in response to a CoAP request with a Block* Option,
and subsequent absence of the 4.02 in response to the same request without Block* Options.
This allows the HC proxy to be more efficient, not attempting repeated blockwise transfers to CoAP servers
that do not support it. However if a request payload is too large to be sent as a single CoAP request
and blockwise transfer would be unavoidable, the proxy still SHOULD attempt blockwise transfer on
such an end-point before returning the response 413 (Request Entity Too Large) to the HTTP client.
</t>
<!-- rationale: coap server might have had a software update in the meantime with block support -->
<t>
For improved latency an HC proxy MAY initiate a blockwise CoAP request triggered by
an incoming HTTP request even when the HTTP request message has not yet been fully
received, but enough data has been received to send one or more data blocks to a CoAP
server already. This is particularly useful on slow client-to-proxy connections.
</t>
</section>
<section title="Security Translation" anchor="hc-sec">
<t>
For the guidelines on security context translations for an HC proxy, see <xref target="sec-exchanges"/>.
A translation may involve e.g. applying a rule that any "https" request is translated to a "coaps" request, or e.g.
applying a rule that a "https" request is translated to an unsecured "coap" request.
</t>
</section>
<section title="CoAP Multicast" anchor="hc-multicast">
<t>An HC proxy MAY support CoAP multicast. If it does, the HC proxy sends out a multicast CoAP request if
the Target CoAP URI's authority is a multicast IP literal
or resolves to a multicast IP address; assuming the proper security measures are in place to mitigate
security risks of CoAP multicast (<xref target="sec"/>). If the security policies do not allow the
specific CoAP multicast request to be made, the HC proxy SHOULD respond 403 (Forbidden).</t>
<!-- 501 (Not Implemented) is not better than 403 in below case. An HC proxy should use 501 for CoAP-unsupported methods used in the HTTP request -->
<t>If an HC proxy does not support CoAP multicast, it SHOULD respond 403 (Forbidden) to any valid HTTP request
that maps to a CoAP multicast request.</t>
<t>However, details of supporting CoAP multicast are currently out of scope
of this document since in a reverse proxy scenario a HTTP client typically expects to receive a single
response, not multiple. However an HC proxy supporting CoAP multicast MAY include application-specific functions to
aggregate multiple CoAP responses into a single HTTP response.
We suggest using the "application/http" internet media type (Section 8.3.2 of [RFC7230]) to enclose a set of one or more HTTP response messages,
each representing the mapping of one CoAP response.</t>
</section>
<section title="Timeouts" anchor="hc-timeouts">
<t>When facing long delays of a CoAP server in responding, the HTTP client or any other proxy in between MAY timeout.
Further discussion of timeouts in HTTP is available in Section 6.2.4 of <xref target="RFC7230"/>.</t>
<t>An HC proxy MUST define an internal timeout for each pending CoAP request,
because the CoAP server may silently die before completing the request.
Assuming the Proxy may use confirmable CoAP requests, such timeout value T SHOULD be at least</t>
<t>T = MAX_RTT + MAX_SERVER_RESPONSE_DELAY</t>
<t>where MAX_RTT is defined in [RFC7252] and MAX_SERVER_RESPONSE_DELAY is defined in <xref target="RFC7390"/>. An exception
to this rule occurs when the
HC proxy is configured with a HTTP response timeout value that is lower than above value T; then the
lower value should be also used as the CoAP request timeout.</t>
</section>
<section title="Miscellaneous" anchor="hc-misc">
<t>In certain use cases, constrained CoAP nodes do not make use of the DNS protocol.
However even when the DNS protocol is not used in a constrained network,
defining valid FQDN (i.e., DNS entries) for constrained CoAP servers, where possible, may help HTTP clients
to access the resources offered by these servers via an HC proxy.</t>
<t>HTTP connection pipelining (section 6.3.2 of <xref target="RFC7230"/>)
may be supported by an HC proxy. This is transparent to the CoAP servers:
the HC proxy will serve the pipelined requests by issuing different CoAP requests.
The HC proxy in this case needs to respect the NSTART limit of Section 4.7 of [RFC7252].</t>
</section>
</section>
<!-- Additional Guidelines -->
<!-- MAIN SECTION ***************************************************************************** -->
<section anchor="IANA" title="IANA Considerations">
<t>This document registers a new Resource Type (rt=) Link Target Attribute,
'core.hc', in the "Resource Type (rt=) Link Target Attribute Values"
subregistry under the "Constrained RESTful Environments (CoRE)
Parameters" registry.</t>
<t>Attribute Value: core.hc
</t>
<t>Description: HTTP to CoAP mapping base resource.
</t>
<t>Reference: See <xref target="section.discovery"/>.
</t>
</section>
<!-- MAIN SECTION ***************************************************************************** -->
<section title="Security Considerations" anchor="sec">
<t>The security concerns raised in Section 9.2 of [RFC7230] also apply to the HC proxy scenario.
In fact, the HC proxy is a trusted (not rarely a transparently trusted) component in the network path.</t>
<t>The trustworthiness assumption on the HC proxy cannot be dropped, because the protocol translation function
is the core duty of the HC proxy: it is a necessarily trusted, impossible to bypass, component in the communication path.</t>
<t>A reverse proxy deployed at the boundary of a constrained network is an easy single point of failure for reducing availability.
As such, special care should be taken in designing, developing and operating it, keeping in mind that, in most cases,
it has fewer limitations than the constrained devices it is serving.</t>
<t>The following sub paragraphs categorize and discuss a set of specific security issues related to the translation,
caching and forwarding functionality exposed by an HC proxy.</t>
<section title="Traffic Overflow">
<t>Due to the typically constrained nature of CoAP nodes,
particular attention SHOULD be given to the implementation of traffic reduction
mechanisms (see <xref target="hc-caching"/>),
because inefficient proxy implementations can be targeted by unconstrained Internet attackers.
Bandwidth or complexity involved in such attacks is very low.</t>
<t>An amplification attack to the constrained network may be triggered by a multicast request
generated by a single HTTP request which is mapped to a CoAP multicast resource,
as considered in Section 11.3 of <xref target="RFC7252"/>.</t>
<t>The risk likelihood of this amplification technique is higher than an amplification attack
carried out by a malicious constrained device
(e.g. ICMPv6 flooding, like Packet Too Big, or Parameter Problem on a multicast
destination <xref target="RFC4732"/>),
since it does not require direct access to the constrained network.</t>
<t>The feasibility of this attack, disruptive in terms of CoAP server availability, can be limited by
access controlling the exposed HTTP multicast resources, so that only known/authorized users access such URIs.</t>
</section>
<section title="Handling Secured Exchanges" anchor="sec-exchanges">
<t>An HTTP request can be sent to the HC proxy over a secured connection.
However, there may not always exist a secure connection mapping to CoAP.
For example, a secure distribution method for multicast traffic is complex and MAY not be
implemented (see [RFC7390]).</t>
<t>An HC proxy SHOULD implement explicit rules for security context translations. A translation
may involve e.g. applying a rule that any "https" unicast request is translated to a "coaps" request, or e.g.
applying a rule that a "https" request is translated to an unsecured "coap" request. Another rule
could specify the security policy and parameters used for DTLS connections. Such
rules will largely depend on the application and network context in which a proxy operates.
These rules SHOULD be configurable in an HC proxy.
</t>
<t>
If a policy for access to 'coaps' URIs is configurable in an HC proxy, it is RECOMMENDED that the policy
is by default configured to disallow access to any 'coaps' URI by a HTTP client using an unsecured
(non-TLS) connection. Naturally, a user MAY reconfigure the policy to allow such access in specific cases.
</t>
<t>By default, an HC proxy SHOULD reject any secured client request if there is no configured security policy mapping.
This recommendation MAY be relaxed in case the destination network is believed to be secured by other, complementary, means. E.g.: assumed that CoAP nodes are isolated behind a firewall (e.g. as in the SS HC proxy deployment shown in <xref target="fig-http-coap-deployment"/>), the HC proxy may be configured to translate the incoming HTTPS request using plain CoAP (NoSec mode).</t>
<t>The HTTP-CoAP URI mapping (defined in <xref target="URI-mapping"/>) MUST NOT map to HTTP
a CoAP resource intended to be accessed exclusively in a secure manner.</t>
<t>A secured connection that is terminated at the HC proxy, i.e., the proxy decrypts secured data locally,
raises an ambiguity about the cacheability of the requested resource.
The HC proxy SHOULD NOT cache any secured content to avoid any leak of secured information.
However in some specific scenario, a security/efficiency trade-off could motivate caching secured information;
in that case the caching behavior MAY be tuned to some extent on a per-resource basis.</t>
</section>
<section title="Proxy and CoAP Server Resource Exhaustion">
<t>If the HC proxy implements the low-latency optimization of <xref target="hc-block"/> intended for slow client-to-proxy connections, the Proxy
may become vulnerable to a resource exhaustion attack. In this case an attacking client could initiate multiple requests using a relatively
large message body which is (after an initial fast transfer) transferred very slowly to the Proxy. This would trigger the HC proxy to
create state for a blockwise CoAP request per HTTP request, waiting for the arrival of more data over the HTTP/TCP connection. Such attacks
can be mitigated in the usual ways for HTTP servers using for example a connection time limit along with a limit on the number of open TCP
connections per IP address.
</t>
</section>
<section title="URI Mapping">
<t>The following risks related to the URI mapping described in <xref target="URI-mapping"/> and its use by HC proxies have been identified:
<list style="hanging">
<t hangText="DoS attack on the constrained/CoAP network.">
<vspace/>To mitigate, by default deny any Target CoAP URI whose authority is (or maps to) a multicast address. Then explicitly whitelist multicast resources/authorities that are allowed to be de-referenced. See also <xref target="hc-multicast"/>.</t>
<t hangText="Leaking information on the constrained/CoAP network resources and topology.">
<vspace/>To mitigate, by default deny any Target CoAP URI (especially /.well-known/core is a resource to be protected), and then explicit whitelist resources that are allowed to be seen from outside.</t>
<t hangText="Reduced privacy due to the mechanics of the URI mapping.">
<vspace/>The internal CoAP Target resource is totally transparent from outside. An HC proxy can mitigate by implementing a HTTPS-only interface, making the Target CoAP URI totally opaque to a passive attacker.</t>
</list>
</t>
</section>
<!-- Security and privacy considerations for "URI Mapping" -->
</section>
<section title="Acknowledgements">
<t>An initial version of <xref target="tab-http-coap"/> in <xref target="hc-resp"/>
has been provided in revision -05 of <xref target="RFC7252"/>.
Special thanks to Peter van der Stok for countless comments and discussions
on this document, that contributed to its current structure and text.</t>
<t>Thanks to
Carsten Bormann,
Zach Shelby,
Michele Rossi,
Nicola Bui,
Michele Zorzi,
Klaus Hartke,
Cullen Jennings,
Kepeng Li,
Brian Frank,
Peter Saint-Andre,
Kerry Lynn,
Linyi Tian,
Dorothy Gellert,
Francesco Corazza
for helpful comments and discussions that have shaped the document.</t>
<t>The research leading to these results has received funding from the European Community's
Seventh Framework Programme [FP7/2007-2013] under grant agreement n. [251557].</t>
</section>
</middle>
<back>
<references title="Normative References">
&RFC2119;
&RFC3986;
&RFC6570;
&RFC6690;
&RFC7230;
&RFC7231;
&RFC7235;
&RFC7252;
&I-D.ietf-core-observe;
&I-D.ietf-core-block;
</references>
<references title="Informative References">
&RFC2616;
&RFC3040;
&RFC4732;
&RFC7049;
&RFC7390;
&I-D.bormann-core-links-json;
</references>
<section title="Change Log">
<t>[Note to RFC Editor: Please remove this section before publication.]</t>
<t>Changes from ietf-05 to ietf-06:
<list style="symbols">
<t>Fully restructured the draft, bringing introductory text more to the front and allocating main sections to each of the key topics; addressing Ticket #379;</t>
<t>Addressed Ticket #382, fix of enhanced form URI template definition of q in Section 5.3.2;</t>
<t>Addressed Ticket #381, found a mapping 4.01 to 401 Unauthorized in Section 7;</t>
<t>Addressed Ticket #380 (Add IANA registration for "core.hc" Resource Type) in Section 9;</t>
<t>Addressed Ticket #376 (CoAP 4.05 response can't be translated to HTTP 405 by HC proxy) in Section 7 by use of empty 'Allow' header;</t>
<t>Removed details on the pros and cons of HC proxy placement options;</t>
<t>Addressed review comments of Carsten Bormann;</t>
<t>Clarified failure in mapping of HTTP Accept headers (Section 6.3);</t>
<t>Clarified detection of CoAP servers not supporting blockwise (Section 8.3);</t>
<t>Changed CoAP request timeout min value to MAX_RTT + MAX_SERVER_RESPONSE_DELAY (Section 8.6);</t>
<t>Added security section item (Section 10.3) related to use of CoAP blockwise transfers;</t>
<t>Many editorial improvements.</t>
</list>
</t>
<t>Changes from ietf-04 to ietf-05:
<list style="symbols">
<t>Addressed Ticket #366 (Mapping of CoRE Link Format payloads to be valid in HTTP Domain?) in Section 6.3.3.2 (Content Transcoding - CORE Link Format);</t>
<t>Addressed Ticket #375 (Add requirement on mapping of CoAP diagnostic payload) in Section 6.3.3.3 (Content Transcoding - Diagnostic Messages);</t>
<t>Addressed comment from Yusuke (http://www.ietf.org/mail-archive/web/core/current/msg05491.html) in Section 6.3.3.1 (Content Transcoding - General);</t>
<t>Various editorial improvements.</t>
</list>
</t>
<t>Changes from ietf-03 to ietf-04:
<list style="symbols">
<t>Expanded use case descriptions in Section 4;</t>
<t>Fixed/enhanced discovery examples in Section 5.4.1;</t>
<t>Addressed Ticket #365 (Add text on media type conversion by HTTP-CoAP proxy) in
new Section 6.3.1 (Generalized media type mapping) and new Section 6.3.2 (Content translation);</t>
<t>Updated HTTPBis WG draft references to recently published RFC numbers.</t>
<t>Various editorial improvements.</t>
</list>
</t>
<t>Changes from ietf-02 to ietf-03:
<list style="symbols">
<t>Closed Ticket #351 "Add security implications of proposed default HTTP-CoAP URI mapping";</t>
<t>Closed Ticket #363 "Remove CoAP scheme in default HTTP-CoAP URI mapping";</t>
<t>Closed Ticket #364 "Add discovery of HTTP-CoAP mapping resource(s)".</t>
</list>
</t>
<t>Changes from ietf-01 to ietf-02:
<list style="symbols"><t>Selection of single default URI mapping proposal as proposed to WG mailing list 2013-10-09.</t></list>
</t>
<t>Changes from ietf-00 to ietf-01:
<list style="symbols"><t>Added URI mapping proposals to Section 4 as per the Email proposals to WG mailing list from Esko.</t></list>
</t>
</section>
</back>
</rfc>
<!-- LocalWords: xref CDATA exploders BUA -->
| PAFTECH AB 2003-2026 | 2026-04-23 02:45:39 |