< draft-ietf-core-senml-etch-04.txt   draft-ietf-core-senml-etch-05.txt >
Network Working Group A. Keranen Network Working Group A. Keranen
Internet-Draft Ericsson Internet-Draft Ericsson
Intended status: Standards Track M. Mohajer Intended status: Standards Track M. Mohajer
Expires: January 9, 2020 u-blox UK Expires: February 18, 2020 u-blox UK
July 8, 2019 August 17, 2019
FETCH & PATCH with Sensor Measurement Lists (SenML) FETCH & PATCH with Sensor Measurement Lists (SenML)
draft-ietf-core-senml-etch-04 draft-ietf-core-senml-etch-05
Abstract Abstract
The Sensor Measurement Lists (SenML) media type and data model can be The Sensor Measurement Lists (SenML) media type and data model can be
used to send collections of resources, such as batches of sensor data used to send collections of resources, such as batches of sensor data
or configuration parameters. The CoAP iPATCH, PATCH, and FETCH or configuration parameters. The CoAP iPATCH, PATCH, and FETCH
methods enable accessing and updating parts of a resource or multiple methods enable accessing and updating parts of a resource or multiple
resources with one request. This document defines new media types resources with one request. This document defines new media types
for the CoAP iPATCH, PATCH, and FETCH methods for resources for the CoAP iPATCH, PATCH, and FETCH methods for resources
represented with the SenML data model. represented with the SenML data model.
skipping to change at page 1, line 37 skipping to change at page 1, line 37
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on January 9, 2020. This Internet-Draft will expire on February 18, 2020.
Copyright Notice Copyright Notice
Copyright (c) 2019 IETF Trust and the persons identified as the Copyright (c) 2019 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
skipping to change at page 2, line 15 skipping to change at page 2, line 15
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3
3. Using FETCH and (i)PATCH with SenML . . . . . . . . . . . . . 3 3. Using FETCH and (i)PATCH with SenML . . . . . . . . . . . . . 3
3.1. SenML FETCH . . . . . . . . . . . . . . . . . . . . . . . 4 3.1. SenML FETCH . . . . . . . . . . . . . . . . . . . . . . . 4
3.2. SenML (i)PATCH . . . . . . . . . . . . . . . . . . . . . 4 3.2. SenML (i)PATCH . . . . . . . . . . . . . . . . . . . . . 4
4. Security Considerations . . . . . . . . . . . . . . . . . . . 5 4. Fragment Identification . . . . . . . . . . . . . . . . . . . 5
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6 5. Security Considerations . . . . . . . . . . . . . . . . . . . 6
5.1. CoAP Content-Format Registration . . . . . . . . . . . . 6 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6
5.2. senml-etch+json Media Type . . . . . . . . . . . . . . . 6 6.1. CoAP Content-Format Registration . . . . . . . . . . . . 6
5.3. senml-etch+cbor Media Type . . . . . . . . . . . . . . . 7 6.2. senml-etch+json Media Type . . . . . . . . . . . . . . . 6
6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 8 6.3. senml-etch+cbor Media Type . . . . . . . . . . . . . . . 7
7. References . . . . . . . . . . . . . . . . . . . . . . . . . 9 7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 9
7.1. Normative References . . . . . . . . . . . . . . . . . . 9 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 9
7.2. Informative References . . . . . . . . . . . . . . . . . 9 8.1. Normative References . . . . . . . . . . . . . . . . . . 9
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 9 8.2. Informative References . . . . . . . . . . . . . . . . . 10
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 10
1. Introduction 1. Introduction
The Sensor Measurement Lists (SenML) media type [RFC8428] and data The Sensor Measurement Lists (SenML) media type [RFC8428] and data
model can be used to transmit collections of resources, such as model can be used to transmit collections of resources, such as
batches of sensor data or configuration parameters. batches of sensor data or configuration parameters.
An example of a SenML collection is shown below: An example of a SenML collection is shown below:
[ [
skipping to change at page 5, line 43 skipping to change at page 5, line 45
] ]
As another example, the following document could be given as an As another example, the following document could be given as an
(i)PATCH payload to remove the two SenML Records: (i)PATCH payload to remove the two SenML Records:
[ [
{"bn":"2001:db8::2/3311/0/", "n":"5850", "v":null}, {"bn":"2001:db8::2/3311/0/", "n":"5850", "v":null},
{"n":"5851", "v":null} {"n":"5851", "v":null}
] ]
4. Security Considerations 4. Fragment Identification
Fragment identification is supported by analogously applying fragment
identifiers as specified in Section 9 of [RFC8428] to the Fetch/Patch
Records.
5. Security Considerations
The security and privacy considerations of SenML apply also with the The security and privacy considerations of SenML apply also with the
FETCH and (i)PATCH methods. FETCH and (i)PATCH methods.
In FETCH and (i)PATCH requests, the client can pass arbitrary names In FETCH and (i)PATCH requests, the client can pass arbitrary names
to the target resource for manipulation. The resource implementer to the target resource for manipulation. The resource implementer
must take care to only allow access to names that are actually part must take care to only allow access to names that are actually part
of (or accessible through) the target resource. of (or accessible through) the target resource.
If the client is not allowed to do a GET or PUT on the full target If the client is not allowed to do a GET or PUT on the full target
resource (and thus all the names accessible through it), access resource (and thus all the names accessible through it), access
control rules must be evaluated for each record in the pack. control rules must be evaluated for each record in the pack.
5. IANA Considerations 6. IANA Considerations
This document registers two new media types and CoAP Content-Format This document registers two new media types and CoAP Content-Format
IDs for both media types. IDs for both media types.
Note to RFC Editor: Please replace all occurrences of "RFC-AAAA" with Note to RFC Editor: Please replace all occurrences of "RFC-AAAA" with
the RFC number of this document. the RFC number of this document.
5.1. CoAP Content-Format Registration 6.1. CoAP Content-Format Registration
IANA is requested to assign CoAP Content-Format IDs for the SenML IANA is requested to assign CoAP Content-Format IDs for the SenML
PATCH and FETCH media types in the "CoAP Content-Formats" sub- PATCH and FETCH media types in the "CoAP Content-Formats" sub-
registry, within the "CoRE Parameters" registry [RFC7252]. The registry, within the "CoRE Parameters" registry [RFC7252]. The
assigned IDs are shown in Table 1. assigned IDs are shown in Table 1.
+-----------------------------+----------+---------+ +-----------------------------+----------+---------+
| Media type | Encoding | ID | | Media type | Encoding | ID |
+-----------------------------+----------+---------+ +-----------------------------+----------+---------+
| application/senml-etch+json | - | TBD-320 | | application/senml-etch+json | - | TBD-320 |
| | | | | | | |
| application/senml-etch+cbor | - | TBD-322 | | application/senml-etch+cbor | - | TBD-322 |
+-----------------------------+----------+---------+ +-----------------------------+----------+---------+
Table 1: CoAP Content-Format IDs Table 1: CoAP Content-Format IDs
5.2. senml-etch+json Media Type 6.2. senml-etch+json Media Type
Type name: application Type name: application
Subtype name: senml-etch+json Subtype name: senml-etch+json
Required parameters: none Required parameters: none
Optional parameters: none Optional parameters: none
Encoding considerations: binary
Encoding considerations: Must be encoded as using a subset of the Security considerations: See Section 5 of RFC-AAAA.
encoding allowed in [RFC8259]. This simplifies implementation of a
very simple system and does not impose any significant limitations as
all this data is meant for machine to machine communications and is
not meant to be human readable.
Security considerations: See Section 4 of RFC-AAAA.
Interoperability considerations: Applications MUST ignore any key Interoperability considerations: Applications MUST ignore any key
value pairs that they do not understand unless the key ends with the value pairs that they do not understand unless the key ends with the
'_' character in which case an error MUST be generated. This allows '_' character in which case an error MUST be generated. This allows
backwards compatible extensions to this specification. backwards compatible extensions to this specification.
Published specification: RFC-AAAA Published specification: RFC-AAAA
Applications that use this media type: Applications that use the Applications that use this media type: Applications that use the
SenML media type for resource representation. SenML media type for resource representation.
Fragment identifier considerations: N/A Fragment identifier considerations: Fragment identification for
application/senml-etch+json is supported by using fragment
identifiers as specified by RFC AAAA.
Additional information: Additional information:
Magic number(s): none Magic number(s): none
File extension(s): senml-etchj File extension(s): senml-etchj
Windows Clipboard Name: "SenML FETCH/PATCH format" Windows Clipboard Name: "SenML FETCH/PATCH format"
Macintosh file type code(s): none Macintosh file type code(s): none
skipping to change at page 7, line 41 skipping to change at page 7, line 46
Keranen ari.keranen@ericsson.com Keranen ari.keranen@ericsson.com
Intended usage: COMMON Intended usage: COMMON
Restrictions on usage: None Restrictions on usage: None
Author: Ari Keranen ari.keranen@ericsson.com Author: Ari Keranen ari.keranen@ericsson.com
Change controller: IESG Change controller: IESG
5.3. senml-etch+cbor Media Type 6.3. senml-etch+cbor Media Type
Type name: application Type name: application
Subtype name: senml-etch+cbor Subtype name: senml-etch+cbor
Required parameters: none Required parameters: none
Optional parameters: none Optional parameters: none
Encoding considerations: Must be encoded as using [RFC7049]. Encoding considerations: binary
Security considerations: See Section 4 of RFC-AAAA. Security considerations: See Section 5 of RFC-AAAA.
Interoperability considerations: Applications MUST ignore any key Interoperability considerations: Applications MUST ignore any key
value pairs that they do not understand unless the key ends with the value pairs that they do not understand unless the key ends with the
'_' character in which case an error MUST be generated. This allows '_' character in which case an error MUST be generated. This allows
backwards compatible extensions to this specification. backwards compatible extensions to this specification.
Published specification: RFC-AAAA Published specification: RFC-AAAA
Applications that use this media type: Applications that use the Applications that use this media type: Applications that use the
SenML media type for resource representation. SenML media type for resource representation.
Fragment identifier considerations: N/A Fragment identifier considerations: Fragment identification for
application/senml-etch+cbor is supported by using fragment
identifiers as specified by RFC AAAA.
Additional information: Additional information:
Magic number(s): none Magic number(s): none
File extension(s): senml-etchc File extension(s): senml-etchc
Macintosh file type code(s): none Macintosh file type code(s): none
Macintosh Universal Type Identifier code: org.ietf.senml-etch-cbor Macintosh Universal Type Identifier code: org.ietf.senml-etch-cbor
skipping to change at page 8, line 41 skipping to change at page 9, line 5
Keranen ari.keranen@ericsson.com Keranen ari.keranen@ericsson.com
Intended usage: COMMON Intended usage: COMMON
Restrictions on usage: None Restrictions on usage: None
Author: Ari Keranen ari.keranen@ericsson.com Author: Ari Keranen ari.keranen@ericsson.com
Change controller: IESG Change controller: IESG
6. Acknowledgements 7. Acknowledgements
The use of FETCH and (i)PATCH methods with SenML was first introduced The use of FETCH and (i)PATCH methods with SenML was first introduced
by the OMA SpecWorks LwM2M v1.1 specification. This document by the OMA SpecWorks LwM2M v1.1 specification. This document
generalizes the use to any SenML representation. The authors would generalizes the use to any SenML representation. The authors would
like to thank Carsten Bormann, Christian Amsuess, Jaime Jimenez, like to thank Carsten Bormann, Christian Amsuess, Jaime Jimenez,
Klaus Hartke, Michael Richardson, and other participants from the Klaus Hartke, Michael Richardson, and other participants from the
IETF CoRE and OMA SpecWorks DMSE working groups who have contributed IETF CoRE and OMA SpecWorks DMSE working groups who have contributed
ideas and reviews. ideas and reviews.
7. References 8. References
7.1. Normative References 8.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997, DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>. <https://www.rfc-editor.org/info/rfc2119>.
[RFC7049] Bormann, C. and P. Hoffman, "Concise Binary Object [RFC7049] Bormann, C. and P. Hoffman, "Concise Binary Object
Representation (CBOR)", RFC 7049, DOI 10.17487/RFC7049, Representation (CBOR)", RFC 7049, DOI 10.17487/RFC7049,
October 2013, <https://www.rfc-editor.org/info/rfc7049>. October 2013, <https://www.rfc-editor.org/info/rfc7049>.
skipping to change at page 9, line 42 skipping to change at page 10, line 5
[RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data [RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data
Interchange Format", STD 90, RFC 8259, Interchange Format", STD 90, RFC 8259,
DOI 10.17487/RFC8259, December 2017, DOI 10.17487/RFC8259, December 2017,
<https://www.rfc-editor.org/info/rfc8259>. <https://www.rfc-editor.org/info/rfc8259>.
[RFC8428] Jennings, C., Shelby, Z., Arkko, J., Keranen, A., and C. [RFC8428] Jennings, C., Shelby, Z., Arkko, J., Keranen, A., and C.
Bormann, "Sensor Measurement Lists (SenML)", RFC 8428, Bormann, "Sensor Measurement Lists (SenML)", RFC 8428,
DOI 10.17487/RFC8428, August 2018, DOI 10.17487/RFC8428, August 2018,
<https://www.rfc-editor.org/info/rfc8428>. <https://www.rfc-editor.org/info/rfc8428>.
7.2. Informative References 8.2. Informative References
[IPSO] IPSO, "IPSO Light Control Smart Object", 2018, [IPSO] IPSO, "IPSO Light Control Smart Object", 2018,
<http://www.openmobilealliance.org/tech/profiles/ <http://www.openmobilealliance.org/tech/profiles/
lwm2m/3311.xml>. lwm2m/3311.xml>.
Authors' Addresses Authors' Addresses
Ari Keranen Ari Keranen
Ericsson Ericsson
Email: ari.keranen@ericsson.com Email: ari.keranen@ericsson.com
Mojan Mohajer Mojan Mohajer
u-blox UK u-blox UK
Email: Mojan.Mohajer@u-blox.com Email: Mojan.Mohajer@u-blox.com
 End of changes. 21 change blocks. 
35 lines changed or deleted 41 lines changed or added

This html diff was produced by rfcdiff 1.48. The latest version is available from http://tools.ietf.org/tools/rfcdiff/