]> Trilliant Networks Inc.

610 Rue du Luxembourg Granby Quebec J2J 2V2 Canada michel.veillette@trilliant.com

consultant

+31-492474673 (Netherlands), +33-966015248 (France) stokcons@bbhmail.nl www.vanderstok.org

Acklio

2bis rue de la Chataigneraie Cesson-Sevigne 35510 France a@ackl.io

YumaWorks

685 Cochran St. Suite #160 Simi Valley CA 93065 USA andy@yumaworks.com

Universität Bremen TZI

Postfach 330440 Bremen D-28359 Germany +49-421-218-63921 cabo@tzi.org

Applications CoRE This document describes a network management interface for constrained devices and networks, called CoAP Management Interface (CORECONF). The Constrained Application Protocol (CoAP) is used to access datastore and data node resources specified in YANG, or SMIv2 converted to YANG. CORECONF uses the YANG to CBOR mapping and converts YANG identifier strings to numeric identifiers for payload size reduction. CORECONF extends the set of YANG based protocols, NETCONF and RESTCONF, with the capability to manage constrained devices and networks. About This Document The latest revision of this draft can be found at . Status information for this document may be found at . Discussion of this document takes place on the core Working Group mailing list (), which is archived at . Subscribe at . Source for this draft and an issue tracker can be found at .

Introduction The Constrained Application Protocol (CoAP) is designed for Machine to Machine (M2M) applications such as smart energy, smart city, and building control. Constrained devices need to be managed in an automatic fashion to handle the large quantities of devices that are expected in future installations. Messages between devices need to be as small and infrequent as possible. The implementation complexity and runtime resources need to be as small as possible. This draft describes the CoAP Management Interface (CORECONF) which uses CoAP methods to access structured data defined in YANG . This draft is complementary to which describes a REST-like interface called RESTCONF, which uses HTTP methods to access structured data defined in YANG. The use of standardized data models specified in a standardized language, such as YANG, promotes interoperability between devices and applications from different manufacturers. CORECONF and RESTCONF are intended to work in a stateless client-server fashion. They use a single round-trip to complete a single editing transaction, where NETCONF needs multiple round trips. To promote small messages, CORECONF uses a YANG to CBOR mapping and numeric identifiers to minimize CBOR payloads and URI length.

Terminology The following terms are defined in the YANG data modeling language : action, anydata, anyxml, client, container, data model, data node, identity, instance identifier, leaf, leaf-list, list, module, RPC, schema node, server, submodule. The following terms are defined in : configuration data, datastore, state data. The following term is defined in : YANG schema item identifier (YANG SID, often shortened to simply SID). The following terms are defined in the CoAP protocol : Confirmable Message, Content-Format, Endpoint. The following terms are defined in this document:

data node resource:

a CoAP resource that models a YANG data node.

datastore resource:

a CoAP resource that models a YANG datastore.

event stream resource:

a CoAP resource used by clients to observe YANG notifications.

notification instance:

An instance of a schema node of type notification, specified in a YANG module implemented by the server. The instance is generated in the server at the occurrence of the corresponding event and reported by an event stream resource.

list instance identifier:

Handle used to identify a YANG data node that is an instance of a YANG "list", specified with the values of the key leaves of the list.

single instance identifier:

Handle used to identify a specific data node which can be instantiated only once. This includes data nodes defined at the root of a YANG module and data nodes defined within a container. This excludes data nodes defined within a list or any children of these data nodes.

instance-identifier:

List instance identifier or single instance identifier.

instance-value:

The value assigned to a data node instance. Instance-values are serialized into the payload according to the rules defined in .

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 when, and only when, they appear in all capitals, as shown here.

CORECONF Architecture This section describes the CORECONF architecture to use CoAP for reading and modifying the content of datastore(s) used for the management of the instrumented node.

Abstract CORECONF architecture CoAP request(3) -->| Indication | | Confirm |<-- CoAP response(3)<--+ Response (4) | | | | | | |<==== Security (7) ===>| +---------------------+ | +--------------+ | | Datastore(s) (5) | | | +---------------------+ | | | | +---------------------+ | | | Event stream(s) (6) | | | +---------------------+ | +-------------------------+ ]]>

is a high-level representation of the main elements of the CORECONF management architecture. The different numbered components of are discussed according to the component number.

(1) YANG specification:

contains a set of named and versioned modules.

(2) SMIv2 specification:

Optional part that consists of a named module which, specifies a set of variables and "conceptual tables". There is an algorithm to translate SMIv2 specifications to YANG specifications.

(3) CoAP request/response messages:

The CORECONF client sends request messages to and receives response messages from the CORECONF server.

(4) Request, Indication, Response, Confirm:

Processes performed by the CORECONF clients and servers.

(5) Datastore:

A resource used to access configuration data, state data, RPCs, and actions. A CORECONF server may support a single unified datastore or multiple datastores as those defined by Network Management Datastore Architecture (NMDA) .

(6) Event stream:

A resource used to get real-time notifications. A CORECONF server may support multiple Event streams serving different purposes such as normal monitoring, diagnostic, syslog, security monitoring.

(7) Security:

The server MUST prevent unauthorized users from reading or writing any CORECONF resources. CORECONF relies on security protocols such as DTLS or OSCORE to secure CoAP communications.

Major differences between RESTCONF and CORECONF CORECONF is a RESTful protocol for small devices where saving bytes to transport a message is very important. Contrary to RESTCONF, many design decisions are motivated by the saving of bytes. Consequently, CORECONF is not a RESTCONF over CoAP protocol, but differs more significantly from RESTCONF.

Differences due to CoAP and its efficient usage

• CORECONF uses CoAP/UDP as transport protocol and CBOR as payload format . RESTCONF uses HTTP/TCP as transport protocol and JSON or XML as payload formats.
• CORECONF uses the methods FETCH and iPATCH to access data nodes. RESTCONF uses instead the HTTP method PATCH and the HTTP method GET with the "fields" Query parameter.
• RESTCONF uses the HTTP methods HEAD, and OPTIONS, which are not supported by CoAP.
• CORECONF does not support "insert" query parameter (first, last, before, after) and the "point" query parameter which are supported by RESTCONF.
• CORECONF does not support the "start-time" and "stop-time" query parameters to retrieve past notifications.

Differences due to the use of CBOR

• CORECONF encodes YANG identifier strings as numbers, where RESTCONF does not.
• CORECONF also differs in the handling of default values, only 'report-all' and 'trim' options are supported.

Compression of YANG identifiers In the YANG specification, items are identified with a name string. In order to significantly reduce the size of identifiers used in CORECONF, numeric identifiers called YANG Schema Item iDentifier (YANG SID or simply SID) are used instead.

Instance-identifier Instance-identifiers are used to uniquely identify data node instances within a datastore. This YANG built-in type is defined in . An instance-identifier is composed of the data node identifier (i.e. a SID) and, for data nodes within list(s), the keys used to index within these list(s). In CORECONF, instance-identifiers are carried in the payload of FETCH and PATCH requests. They are encoded in CBOR based on the rules defined in .

Media-Types CORECONF uses Media-Types based on the YANG to CBOR mapping specified in . The following new Media-Types based on CBOR sequences are defined in this document:

application/yang-identifiers+cbor:

This Media-Type represents a CBOR YANG document containing a list of instance-identifiers used to target specific data node instances within a datastore.

FORMAT: CBOR sequence of instance-identifiers

The message payload of Media-Type 'application/yang-identifiers+cbor' is encoded using a CBOR sequence. Each item of this CBOR sequence contains an instance-identifier encoded as defined in .

application/yang-instances+cbor:

This Media-Type represents a CBOR YANG document containing a list of data node instances. Each data node instance is identified by its associated instance-identifier.

FORMAT: CBOR sequence of CBOR maps of instance-identifier, instance-value

The message payload of Media-Type 'application/yang-instances+cbor' is encoded using a CBOR sequence. Each item within this CBOR sequence contains a CBOR map carrying an instance-identifier and associated instance-value. Instance-identifiers are encoded using the rules defined in , instance-values are encoded using the rules defined in .

When present in an iPATCH request payload, this Media-Type carry a list of data node instances to be replaced, created, or deleted. For each data node instance D, for which the instance-identifier is the same as a data node instance I, in the targeted datastore resource: the value of D replaces the value of I. When the value of D is null, the data node instance I is removed. When the targeted datastore resource does not contain a data node instance with the same instance-identifier as D, a new instance is created with the same instance-identifier and value as D (unless the value of D is null).

The different Media-Type usages are summarized in the table below:

Method	Resource	Media-Type
FETCH request	datastore	application/yang-identifiers+cbor
FETCH response	datastore	application/yang-instances+cbor
iPATCH request	datastore	application/yang-instances+cbor
GET response	event stream	application/yang-instances+cbor
POST request	rpc, action	application/yang-instances+cbor
POST response	rpc, action	application/yang-instances+cbor

Unified datastore CORECONF supports a simple datastore model consisting of a single unified datastore. This datastore provides access to both configuration and operational data. Configuration updates performed on this datastore are reflected immediately or with a minimal delay as operational data. Alternatively, CORECONF servers MAY implement a more complex datastore model such as the Network Management Datastore Architecture (NMDA) as defined by . Each datastore supported is implemented as a datastore resource. Characteristics of the unified datastore are summarized in the table below:

Name	Value
Name	unified
YANG modules	all modules
YANG nodes	all data nodes ("config true" and "config false")
Access	read-write
How applied	changes applied in place immediately or with a minimal delay
Protocols	CORECONF
Defined in	"ietf-coreconf"

Example syntax CBOR is used to encode CORECONF request and response payloads. The CBOR syntax of the YANG payloads is specified in , based on and . The payload examples are notated in Diagnostic notation (defined in ) that can be automatically converted to CBOR.

CoAP Interface This document specifies a Management Interface. CoAP endpoints that implement the CORECONF management protocol, support at least one discoverable management resource of resource type (rt): core.c.ds. The path of the discoverable management resource is left to implementers to select (see ). YANG data node instances are accessible by performing FETCH and iPATCH operations on the datastore resource. CORECONF also supports event stream resources used to observe notification instances. Event stream resources can be discovered using resource type (rt): core.c.ev. The description of the CORECONF management interface is shown in the table below: Resources, example paths, and resource types (rt)

CoAP resource	Example path	rt
Datastore resource	/c	core.c.ds
Default event stream resource	/s	core.c.ev

The path values in the table are example ones. On discovery, the server makes the actual path values known for these resources. The methods used by CORECONF are: CoAP Methods in CORECONF

Operation	Description
FETCH	Retrieve specific data nodes within a datastore resource
iPATCH	Idempotently create, replace, and delete data node(s) within a datastore resource
POST	Invoke an RPC or action
GET	Retrieve the datastore resource or event stream resource
PUT	Create or replace a datastore resource
DELETE	Delete a datastore resource

Data Retrieval One or more data nodes can be retrieved by the client. The operation is mapped to the FETCH method defined in . There are two additional query parameters for the FETCH method:

query parameters	Description
c	Control selection of configuration and non-configuration data nodes (GET and FETCH)
d	Control retrieval of default values.

Using the 'c' query parameter The 'c' (content) option controls how descendant nodes of the requested data nodes will be processed in the reply. The allowed values are: Values for the 'c' query parameter

Value	Description
c	Return only configuration descendant data nodes
n	Return only non-configuration descendant data nodes
a	Return all descendant data nodes

This option is only allowed for GET and FETCH methods on datastore and data node resources. A 4.02 (Bad Option) error is returned if used for other methods or resource types. If this query parameter is not present, the default value is "a" (the quotes are added for readability, but they are not part of the payload).

Using the 'd' query parameter The 'd' (with-defaults) option controls how the default values of the descendant nodes of the requested data nodes will be processed. The allowed values are: Values for the 'd' query parameter

Value	Description
a	All data nodes are reported. Defined as 'report-all' in .
t	Data nodes set to the YANG default are not reported. Defined as 'trim' in .

If the target of a GET or FETCH method is a data node that represents a leaf that has a default value, and the leaf has not been given a value by any client yet, the server MUST return the default value of the leaf. If the target of a GET method is a data node that represents a container or list that has child resources with default values, and these have not been given a value yet,

• The server MUST NOT return the child resource if d=t.

• The server MUST return the child resource if d=a.

If this query parameter is not present, the default value is "t" (the quotes are added for readability, but they are not part of the payload).

FETCH The FETCH is used to retrieve one or more instance-values. The FETCH request payload contains the list of instance-identifiers of the data node instances requested. The return response payload contains a list of data node instance-values in the same order as requested. A CBOR null is returned for each data node requested by the client, not supported by the server or not currently instantiated. For compactness, indexes of the list instance identifiers returned by the FETCH response SHOULD be elided, only the SID is provided. This approach may also help reduce implementation complexity since the format of each entry within the CBOR sequence of the FETCH response is identical to the format of the corresponding GET response. (Content-Format: application/yang-identifiers+cbor) CBOR sequence of instance-identifiers 2.05 Content (Content-Format: application/yang-instances+cbor) CBOR sequence of CBOR maps of SID, instance-value ]]>

FETCH examples This example uses the current-datetime leaf from module ietf-system and the interface list from module ietf-interfaces . In this example the value of current-datetime (SID 1723) and the interface list (SID 1533) instance identified with name="eth0" are queried. (Content-Format: application/yang-identifiers+cbor) 1723, / current-datetime (SID 1723) / [1533, "eth0"] / interface (SID 1533) with name = "eth0" / RES: 2.05 Content (Content-Format: application/yang-instances+cbor) { 1723 : "2014-10-26T12:16:31Z" / current-datetime (SID 1723) / }, { 1533 : { 4 : "eth0", / name (SID 1537) / 1 : "Ethernet adaptor", / description (SID 1534) / 5 : 1880, / type (SID 1538), identity / / ethernetCsmacd (SID 1880) / 2 : true, / enabled (SID 1535) / 11 : 3 / oper-status (SID 1544), value is testing / } } ]]>

Data Editing CORECONF allows datastore contents to be created, modified and deleted using CoAP methods.

Data Ordering A CORECONF server MUST preserve the relative order of all user-ordered list and leaf-list entries that are received in a single edit request. As per , these YANG data node types are encoded as CBOR arrays, so messages will preserve their order.

POST The CoAP POST operation is used in CORECONF for the invocation of "ACTION" and "RPC" resources. Refer to for details on "ACTION" and "RPC" resources.

iPATCH One or multiple data node instances are replaced with the idempotent CoAP iPATCH method . There are no query parameters for the iPATCH method. The processing of the iPATCH command is specified by Media-Type 'application/yang-instances+cbor'. In summary, if the CBOR patch payload contains a data node instance that is not present in the target, this instance is added. If the target contains the specified instance, the content of this instance is replaced with the value of the payload. A null value indicates the removal of an existing data node instance. (Content-Format: application/yang-instances+cbor) CBOR sequence of CBOR maps of instance-identifier, instance-value 2.04 Changed ]]>

iPATCH example In this example, a CORECONF client requests the following operations:

• Set "/ietf-system:system/ntp/enabled" (SID 1755) to true.
• Remove the server "tac.nrc.ca" from the "/ietf-system:system/ntp/server" (SID 1756) list.
• Add/set the server "NTP Pool server 2" to the list "/ietf-system:system/ntp/server" (SID 1756).

(Content-Format: application/yang-instances+cbor) { 1755 : true / enabled (SID 1755) / }, { [1756, "tac.nrc.ca"] : null / server (SID 1756) / }, { 1756 : { / server (SID 1756) / 3 : "tic.nrc.ca", / name (SID 1759) / 4 : true, / prefer (SID 1760) / 5 : { / udp (SID 1761) / 1 : "132.246.11.231" / address (SID 1762) / } } } RES: 2.04 Changed ]]> A data node resource is deleted using an iPATCH with a null value, as seen in this example.

Full datastore access The methods GET, PUT, POST, and DELETE can be used to request, replace, create, and delete a whole datastore respectively. 2.05 Content (Content-Format: application/yang-data+cbor; id=sid) CBOR map of SID, instance-value ]]> (Content-Format: application/yang-data+cbor; id=sid) CBOR map of SID, instance-value 2.04 Changed ]]> (Content-Format: application/yang-data+cbor; id=sid) CBOR map of SID, instance-value 2.01 Created ]]> 2.02 Deleted ]]> The content of the CBOR map represents the complete datastore of the server at the GET indication of after a successful processing of a PUT or POST request.

Full datastore examples The example uses the interface list from module ietf-interfaces and the clock container from module ietf-system . We assume that the datastore contains two modules ietf-system (SID 1700) and ietf-interfaces (SID 1500); they contain the 'interface' list (SID 1533) with one instance and the 'clock' container (SID 1721). After invocation of GET, a CBOR map with data nodes from these two modules is returned: RES: 2.05 Content (Content-Format: application/yang-data+cbor; id=sid) { 1721 : { / Clock (SID 1721) / 2: "2016-10-26T12:16:31Z", / current-datetime (SID 1723) / 1: "2014-10-05T09:00:00Z" / boot-datetime (SID 1722) / }, 1533 : [ { / interface (SID 1533) / 4 : "eth0", / name (SID 1537) / 1 : "Ethernet adaptor", / description (SID 1534) / 5 : 1880, / type (SID 1538), identity: / / ethernetCsmacd (SID 1880) / 2 : true, / enabled (SID 1535) / 11 : 3 / oper-status (SID 1544), value is testing / } ] } ]]>

Event stream Event notification is an essential function for the management of servers. CORECONF allows notifications specified in YANG to be reported to a list of clients. The path for the default event stream can be discovered as described in . The server MAY support additional event stream resources to address different notification needs. Reception of notification instances is enabled with the CoAP Observe function. Clients subscribe to the notifications by sending a GET request with an "Observe" option to the stream resource. Each response payload carries one or multiple notifications. The number of notifications reported, and the conditions used to remove notifications from the reported list are left to implementers. When multiple notifications are reported, they MUST be ordered starting from the newest notification at index zero. Note that this could lead to notifications being sent multiple times, which increases the probability for the client to receive them, but it might potentially lead to messages that exceed the MTU of a single CoAP packet. If such cases could arise, implementers should make sure appropriate fragmentation is available - for example the one described in . The format of notifications is a CBOR sequence, where each item in the sequence is a single notification as described in . (Accordingly, a notification without any content is an empty CBOR sequence, i.e., zero bytes.) Observe(0) 2.05 Content (Content-Format: application/yang-instances+cbor) CBOR sequence of CBOR maps of instance-identifier, instance-value ]]> The sequence of data node instances may contain identical items which have been generated at different times. An example implementation is:

• Every time an event is generated, the generated notification instance is appended to the chosen stream(s). After an aggregation period, which may be limited by the maximum number of notifications supported, the content of the instance is sent to all clients observing the modified stream.

Notify Examples Let suppose the server generates the example-port-fault event as defined below. In this example the default event stream resource path /s is an example location discovered with a request similar to . By executing a GET with Observe 0 on the default event stream resource the client receives the following response: Observe(0) RES: 2.05 Content (Content-Format: application/yang-instances+cbor) Observe(12) { 60010 : { / example-port-fault (SID 60010) / 1 : "0/4/21", / port-name (SID 60011) / 2 : "Open pin 2" / port-fault (SID 60012) / } }, { 60010 : { / example-port-fault (SID 60010) / 1 : "1/4/21", / port-name (SID 60011) / 2 : "Open pin 5" / port-fault (SID 60012) / } } ]]> In the example, the request returns a success response with the contents of the last two generated events. Consecutively the server will regularly notify the client when a new event is generated.

The 'f' query parameter The 'f' (filter) option is used to indicate which subset of all possible notifications is of interest. If not present, all notifications supported by the event stream are reported. When not supported by a CORECONF server, this option shall be ignored, all events notifications are reported independently of the presence and content of the 'f' (filter) option. When present, this option contains a comma-separated list of notification SIDs. For example, the following request returns notifications 60010 and 60020. Observe(0) ]]> This is one place where SIDs are used in the URI. Do we want to replace this with FETCH as well?

RPC statements The YANG "action" and "RPC" statements specify the execution of a Remote Procedure Call (RPC) in the server. It is invoked using a POST method to an "Action" or "RPC" resource instance. The request payload contains the values assigned to the input container when specified. The response payload contains the values of the output container when specified. Both the input and output containers are encoded in CBOR using the rules defined in . The returned success response code is 2.05 Content. (Content-Format: application/yang-instances+cbor) CBOR sequence of CBOR maps of instance-identifier, instance-value 2.05 (Content-Format: application/yang-instances+cbor) CBOR sequence of CBOR maps of instance-identifier, instance-value ]]>

RPC Example The example is based on the YANG action "reset" as defined in and annotated below with SIDs. This example invokes the 'reset' action (SID 60002, base64: Opq), of the server instance with name equal to "myserver". (Content-Format: application/yang-instances+cbor) [60002, "myserver"], { 60002 : { 1 : "2016-02-08T14:10:08Z09:00" / reset-at (SID 60003) / } } RES: 2.05 Content (Content-Format: application/yang-instances+cbor) [60002, "myserver"], { 60002 : { 2 : "2016-02-08T14:10:08Z09:18" / reset-finished-at (SID 60004)/ } } ]]>

Use of Block-wise Transfers The CoAP protocol provides reliability by acknowledging the UDP datagrams. However, when large pieces of data need to be transported, datagrams get fragmented, thus creating constraints on the resources in the client, server and intermediate routers. The block option allows the transport of the total payload in individual blocks of which the size can be adapted to the underlying transport sizes such as: (UDP datagram size ~64KiB, IPv6 MTU of 1280, IEEE 802.15.4 payload of 60-80 bytes). Each block is individually acknowledged to guarantee reliability. Notice that the Block mechanism splits the data at fixed positions, such that individual data fields may become fragmented. Therefore, assembly of multiple blocks may be required to process complete data fields. Beware of race conditions. In case blocks are filled one at a time, care should be taken that the whole and consistent data representation is sent in multiple blocks sequentially without interruption. On the server, values might change, lists might get re-ordered, extended or reduced. When these actions happen during the serialization of the contents of the resource, the transported results do not correspond with a state having occurred in the server; or worse the returned values are inconsistent. For example: array length does not correspond with the actual number of items. It may be advisable to use Indefinite-length CBOR arrays and maps, which are foreseen for data streaming purposes. (Note that the outer structure of yang-identifiers and yang-instances is a CBOR sequence, which already behaves similar to an indefinite-length encoded array.)

Application Discovery Two application discovery mechanisms are supported by CORECONF, the YANG library data model as defined by and the CORE resource discovery . Implementers may choose to implement one or the other or both.

YANG library The YANG library data model provides a high-level description of the resources available. The YANG library contains the list of modules, features, and deviations supported by the CORECONF server. From this information, CORECONF clients can infer the list of data nodes supported and the interaction model to be used to access them. This module also contains the list of datastores implemented. As described in , the location of the YANG library can be found by sending a GET request to "/.well-known/core" including a resource type (RT) parameter with the value "core.c.yl". Upon success, the return payload will contain the root resource of the YANG library module. The following example assumes that the SID of the YANG library is 2351 (kv after encoding as specified in ) and that the server uses /c as datastore resource path. RES: 2.05 Content (Content-Format: application/link-format) ;rt="core.c.yl" ]]>

Resource Discovery As some CoAP interfaces and services might not support the YANG library interface and still be interested to discover resources that are available, implementations MAY choose to support discovery of all available resources using "/.well-known/core" as defined by .

Datastore Resource Discovery The presence and location of (path to) each datastore implemented by the CORECONF server can be discovered by sending a GET request to "/.well-known/core" including a resource type (RT) parameter with the value "core.c.ds". Upon success, the return payload contains the list of datastore resources. Each datastore returned is further qualified using the "ds" Link-Format attribute. This attribute is set to the SID assigned to the datastore identity. When a unified datastore is implemented, the ds attribute is set to 1029 as specified in . For other examples of datastores, see the Network Management Datastore Architecture (NMDA) . The following example assumes that the server uses /c as datastore resource path.

RES: 2.05 Content (Content-Format: application/link-format) ; rt="core.c.ds";ds=1029 ]]>

Data node Resource Discovery If implemented, the presence and location of (path to) each data node implemented by the CORECONF server are discovered by sending a GET request to "/.well-known/core" including a resource type (RT) parameter with the value "core.c.dn". Upon success, the return payload contains the SID assigned to each data node and their location. The example below shows the discovery of the presence and location of data nodes. Data nodes '/ietf-system:system-state/clock/boot-datetime' (SID 1722) and '/ietf-system:system-state/clock/current-datetime' (SID 1723) are returned. The example assumes that the server uses /c as datastore resource path. RES: 2.05 Content (Content-Format: application/link-format) ;rt="core.c.dn", ;rt="core.c.dn" ]]> Without additional filtering, the list of data nodes may become prohibitively long. If this is the case implementations SHOULD support a way to obtain all links using multiple GET requests (for example through some form of pagination).

Event stream Resource Discovery The presence and location of (path to) each event stream implemented by the CORECONF server are discovered by sending a GET request to "/.well-known/core" including a resource type (RT) parameter with the value "core.c.es". Upon success, the return payload contains the list of event stream resources. The following example assumes that the server uses /s as the default event stream resource.

RES: 2.05 Content (Content-Format: application/link-format) ;rt="core.c.es" ]]>

Error Handling In case a request is received which cannot be processed properly, the CORECONF server MUST return an error response. This error response MUST contain a CoAP 4.xx or 5.xx response code. Errors returned by a CORECONF server can be broken into two categories, those associated with the CoAP protocol itself and those generated during the validation of the YANG data model constraints as described in . The following list of common CoAP errors should be implemented by CORECONF servers. This list is not exhaustive, other errors defined by CoAP and associated RFCs may be applicable.

• Error 4.01 (Unauthorized) is returned by the CORECONF server when the CORECONF client is not authorized to perform the requested action on the targeted resource (i.e. data node, datastore, rpc, action or event stream).
• Error 4.02 (Bad Option) is returned by the CORECONF server when one or more CoAP options are unknown or malformed.
• Error 4.04 (Not Found) is returned by the CORECONF server when the CORECONF client is requesting a non-instantiated resource (i.e. data node, datastore, rpc, action or event stream).
• Error 4.05 (Method Not Allowed) is returned by the CORECONF server when the CORECONF client is requesting a method not supported on the targeted resource. (e.g. GET on an rpc, PUT or POST on a data node with "config" set to false).
• Error 4.08 (Request Entity Incomplete) is returned by the CORECONF server if one or multiple blocks of a block transfer request is missing, see for more details.
• Error 4.13 (Request Entity Too Large) may be returned by the CORECONF server during a block transfer request, see for more details.
• Error 4.15 (Unsupported Content-Format) is returned by the CORECONF server when the Content-Format used in the request does not match those specified in .

The CORECONF server MUST also enforce the different constraints associated with the YANG data models implemented. These constraints are described in . These errors are reported using the CoAP error code 4.00 (Bad Request) and may have the following error container as payload. The YANG definition and associated .sid file are available in and . The error container is encoded using the encoding rules of a YANG data template as defined in . The following 'error-tag' and 'error-app-tag' are defined by the ietf-coreconf YANG module, these tags are implemented as YANG identity and can be extended as needed.

• error-tag 'operation-failed' is returned by the CORECONF server when the operation request cannot be processed successfully.
  • error-app-tag 'malformed-message' is returned by the CORECONF server when the payload received from the CORECONF client does not contain a well-formed CBOR content as defined in or does not comply with the CBOR structure defined within this document.
  • error-app-tag 'data-not-unique' is returned by the CORECONF server when the validation of the 'unique' constraint of a list or leaf-list fails.
  • error-app-tag 'too-many-elements' is returned by the CORECONF server when the validation of the 'max-elements' constraint of a list or leaf-list fails.
  • error-app-tag 'too-few-elements' is returned by the CORECONF server when the validation of the 'min-elements' constraint of a list or leaf-list fails.
  • error-app-tag 'must-violation' is returned by the CORECONF server when the restrictions imposed by a 'must' statement are violated.
  • error-app-tag 'duplicate' is returned by the CORECONF server when a client tries to create a duplicate list or leaf-list entry.
• error-tag 'invalid-value' is returned by the CORECONF server when the CORECONF client tries to update or create a leaf with a value encoded using an invalid CBOR datatype or if the 'range', 'length', 'pattern' or 'require-instance' constrain is not fulfilled.
  • error-app-tag 'invalid-datatype' is returned by the CORECONF server when CBOR encoding does not follow the rules set by the YANG Build-In type or when the value is incompatible with it (e.g. a value greater than 127 for an int8, undefined enumeration).
  • error-app-tag 'not-in-range' is returned by the CORECONF server when the validation of the 'range' property fails.
  • error-app-tag 'invalid-length' is returned by the CORECONF server when the validation of the 'length' property fails.
  • error-app-tag 'pattern-test-failed' is returned by the CORECONF server when the validation of the 'pattern' property fails.
• error-tag 'missing-element' is returned by the CORECONF server when the operation requested by a CORECONF client fails to comply with the 'mandatory' constraint defined. The 'mandatory' constraint is enforced for leafs and choices, unless the node or any of its ancestors have a 'when' condition or 'if-feature' expression that evaluates to 'false'.
  • error-app-tag 'missing-key' is returned by the CORECONF server to further qualify a missing-element error. This error is returned when the CORECONF client tries to create or list instance, without all the 'key' specified or when the CORECONF client tries to delete a leaf listed as a 'key'.
  • error-app-tag 'missing-input-parameter' is returned by the CORECONF server when the input parameters of an RPC or action are incomplete.
• error-tag 'unknown-element' is returned by the CORECONF server when the CORECONF client tries to access a data node of a YANG module not supported, of a data node associated with an 'if-feature' expression evaluated to 'false' or to a 'when' condition evaluated to 'false'.
• error-tag 'bad-element' is returned by the CORECONF server when the CORECONF client tries to create data nodes for more than one case in a choice.
• error-tag 'data-missing' is returned by the CORECONF server when a data node required to accept the request is not present.
  • error-app-tag 'instance-required' is returned by the CORECONF server when a leaf of type 'instance-identifier' or 'leafref' marked with require-instance set to 'true' refers to an instance that does not exist.
  • error-app-tag 'missing-choice' is returned by the CORECONF server when no nodes exist in a mandatory choice.
• error-tag 'error' is returned by the CORECONF server when an unspecified error has occurred.

For example, the CORECONF server might return the following error. I don't quite know how to use application/yang-instances+cbor here, if we don't have an instance?

Security Considerations For secure network management, it is important to restrict access to configuration variables only to authorized parties. CORECONF re-uses the security mechanisms already available to CoAP, this includes DTLS and OSCORE for protected access to resources, as well as suitable authentication and authorization mechanisms, for example those defined in ACE OAuth . All the security considerations of , , and apply to this document as well. The use of NoSec (), when OSCORE is not used, is NOT RECOMMENDED. In addition, mechanisms for authentication and authorization may need to be selected if not provided with the CoAP security mode. As and are used for payload and SID encoding, the security considerations of those documents also need to be well-understood.

IANA Considerations

Resource Type (rt=) Link Target Attribute Values Registry This document adds the following resource type to the "Resource Type (rt=) Link Target Attribute Values", within the "Constrained RESTful Environments (CoRE) Parameters" registry.

Value	Description	Reference
core.c.ds	YANG datastore	RFC XXXX
core.c.dn	YANG data node	RFC XXXX
core.c.yl	YANG module library	RFC XXXX
core.c.es	YANG event stream	RFC XXXX

// RFC Ed.: replace RFC XXXX with this RFC number and remove this note.

CoAP Content-Formats Registry This document adds the following Content-Format to the "CoAP Content-Formats", within the "Constrained RESTful Environments (CoRE) Parameters" registry.

Media Type	Content Coding	ID	Reference
application/yang-identifiers+cbor		TBD2	RFC XXXX
application/yang-instances+cbor		TBD3	RFC XXXX

// RFC Ed.: replace TBD1, TBD2 and TBD3 with assigned IDs and remove this note. // RFC Ed.: replace RFC XXXX with this RFC number and remove this note.

Media Types Registry This document adds the following media types to the "Media Types" registry.

Name	Template	Reference
yang-identifiers+cbor	application/	RFC XXXX
	yang-identifiers+cbor
yang-instances+cbor	application/	RFC XXXX
	yang-instances+cbor

Each of these media types share the following information:

• Subtype name: <as listed in table>
• Required parameters: N/A
• Optional parameters: N/A
• Encoding considerations: binary
• Security considerations: See the Security Considerations section of RFC XXXX
• Interoperability considerations: N/A
• Published specification: RFC XXXX
• Applications that use this media type: CORECONF
• Fragment identifier considerations: N/A
• Additional information:

• Person & email address to contact for further information: iesg&ietf.org
• Intended usage: COMMON
• Restrictions on usage: N/A
• Author: Michel Veillette
• Change Controller: IESG
• Provisional registration? No

// RFC Ed.: replace RFC XXXX with this RFC number and remove this note.

YANG Namespace Registration This document registers the following XML namespace URN in the "IETF XML Registry", following the format defined in : URI: please assign urn:ietf:params:xml:ns:yang:ietf-coreconf Registrant Contact: The IESG. XML: N/A, the requested URI is an XML namespace. Reference: RFC XXXX // RFC Ed.: please replace XXXX with RFC number and remove this note

References Normative References This document describes an IANA maintained registry for IETF standards which use Extensible Markup Language (XML) related items such as Namespaces, Document Type Declarations (DTDs), Schemas, and Resource Description Framework (RDF) Schemas. This document describes the commonly used base 64, base 32, and base 16 encoding schemes. It also discusses the use of line-feeds in encoded data, use of padding in encoded data, use of non-alphabet characters in encoded data, use of different encoding alphabets, and canonical encodings. [STANDARDS-TRACK] This document defines mechanisms that provide an asynchronous message notification delivery service for the Network Configuration protocol (NETCONF). This is an optional capability built on top of the base NETCONF definition. This document defines the capabilities and operations necessary to support this service. [STANDARDS-TRACK] The Network Configuration Protocol (NETCONF) defined in this document provides mechanisms to install, manipulate, and delete the configuration of network devices. It uses an Extensible Markup Language (XML)-based data encoding for the configuration data as well as the protocol messages. The NETCONF protocol operations are realized as remote procedure calls (RPCs). This document obsoletes RFC 4741. [STANDARDS-TRACK] The Network Configuration Protocol (NETCONF) defines ways to read and edit configuration data from a NETCONF server. In some cases, part of this data may not be set by the NETCONF client, but rather a default value known to the server is used instead. In many situations the NETCONF client has a priori knowledge about default data, so the NETCONF server does not need to save it in a NETCONF configuration datastore or send it to the client in a retrieval operation reply. In other situations the NETCONF client will need this data from the server. Not all server implementations treat this default data the same way. This document defines a capability-based extension to the NETCONF protocol that allows the NETCONF client to identify how defaults are processed by the server, and also defines new mechanisms for client control of server processing of default data. [STANDARDS-TRACK] The Concise Binary Object Representation (CBOR) is a data format whose design goals include the possibility of extremely small code size, fairly small message size, and extensibility without the need for version negotiation. These design goals make it different from earlier binary serializations such as ASN.1 and MessagePack. This document obsoletes RFC 7049, providing editorial improvements, new details, and errata fixes while keeping full compatibility with the interchange format of RFC 7049. It does not create a new version of the format. This document describes the Concise Binary Object Representation (CBOR) Sequence format and associated media type "application/cbor-seq". A CBOR Sequence consists of any number of encoded CBOR data items, simply concatenated in sequence. Structured syntax suffixes for media types allow other media types to build on them and make it explicit that they are built on an existing media type as their foundation. This specification defines and registers "+cbor-seq" as a structured syntax suffix for CBOR Sequences. The Constrained Application Protocol (CoAP) is a specialized web transfer protocol for use with constrained nodes and constrained (e.g., low-power, lossy) networks. The nodes often have 8-bit microcontrollers with small amounts of ROM and RAM, while constrained networks such as IPv6 over Low-Power Wireless Personal Area Networks (6LoWPANs) often have high packet error rates and a typical throughput of 10s of kbit/s. The protocol is designed for machine- to-machine (M2M) applications such as smart energy and building automation. CoAP provides a request/response interaction model between application endpoints, supports built-in discovery of services and resources, and includes key concepts of the Web such as URIs and Internet media types. CoAP is designed to easily interface with HTTP for integration with the Web while meeting specialized requirements such as multicast support, very low overhead, and simplicity for constrained environments. YANG is a data modeling language used to model configuration data, state data, Remote Procedure Calls, and notifications for network management protocols. This document describes the syntax and semantics of version 1.1 of the YANG language. YANG version 1.1 is a maintenance release of the YANG language, addressing ambiguities and defects in the original specification. There are a small number of backward incompatibilities from YANG version 1. This document also specifies the YANG mappings to the Network Configuration Protocol (NETCONF). The Constrained Application Protocol (CoAP) is a RESTful transfer protocol for constrained nodes and networks. Basic CoAP messages work well for small payloads from sensors and actuators; however, applications will need to transfer larger payloads occasionally -- for instance, for firmware updates. In contrast to HTTP, where TCP does the grunt work of segmenting and resequencing, CoAP is based on datagram transports such as UDP or Datagram Transport Layer Security (DTLS). These transports only offer fragmentation, which is even more problematic in constrained nodes and networks, limiting the maximum size of resource representations that can practically be transferred. Instead of relying on IP fragmentation, this specification extends basic CoAP with a pair of "Block" options for transferring multiple blocks of information from a resource representation in multiple request-response pairs. In many important cases, the Block options enable a server to be truly stateless: the server can handle each block transfer separately, with no need for a connection setup or other server-side memory of previous block transfers. Essentially, the Block options provide a minimal way to transfer larger representations in a block-wise fashion. A CoAP implementation that does not support these options generally is limited in the size of the representations that can be exchanged, so there is an expectation that the Block options will be widely used in CoAP implementations. Therefore, this specification updates RFC 7252. The Constrained Application Protocol (CoAP) is a RESTful application protocol for constrained nodes and networks. The state of a resource on a CoAP server can change over time. This document specifies a simple protocol extension for CoAP that enables CoAP clients to "observe" resources, i.e., to retrieve a representation of a resource and keep this representation updated by the server over a period of time. The protocol follows a best-effort approach for sending new representations to clients and provides eventual consistency between the state observed by each client and the actual resource state at the server. The methods defined in RFC 7252 for the Constrained Application Protocol (CoAP) only allow access to a complete resource, not to parts of a resource. In case of resources with larger or complex data, or in situations where resource continuity is required, replacing or requesting the whole resource is undesirable. Several applications using CoAP need to access parts of the resources. This specification defines the new CoAP methods, FETCH, PATCH, and iPATCH, which are used to access and update parts of a resource. This document describes an HTTP-based protocol that provides a programmatic interface for accessing data defined in YANG, using the datastore concepts defined in the Network Configuration Protocol (NETCONF). YANG (RFC 7950) is a data modeling language used to model configuration data, state data, parameters and results of Remote Procedure Call (RPC) operations or actions, and notifications. This document defines encoding rules for YANG in the Concise Binary Object Representation (CBOR) (RFC 8949). Trilliant Networks Inc. Acklio Google Switzerland GmbH Universität Bremen TZI Sandelman Software Works YANG Schema Item iDentifiers (YANG SID) are globally unique 63-bit unsigned integers used to identify YANG items, as a more compact method to identify YANG items that can be used for efficiency and in constrained environments (RFC 7228). This document defines the semantics, the registration, and assignment processes of YANG SIDs for IETF managed YANG modules. To enable the implementation of these processes, this document also defines a file format used to persist and publish assigned YANG SIDs. // The present version (-20) is intended to address all IESG // feedback. It has significantly progressed from -16, which was the // original submission to the IESG. Trilliant Networks Inc. Acklio This document describes a constrained version of the YANG library that provides information about the YANG modules, datastores, and datastore schemas used by a constrained network management server (e.g., a CORECONF server). In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements. RFC 2119 specifies common key words that may be used in protocol specifications. This document aims to reduce the ambiguity by clarifying that only UPPERCASE usage of the key words have the defined special meanings. Informative References This document specifies version 1.2 of the Datagram Transport Layer Security (DTLS) protocol. The DTLS protocol provides communications privacy for datagram protocols. The protocol allows client/server applications to communicate in a way that is designed to prevent eavesdropping, tampering, or message forgery. The DTLS protocol is based on the Transport Layer Security (TLS) protocol and provides equivalent security guarantees. Datagram semantics of the underlying transport are preserved by the DTLS protocol. This document updates DTLS 1.0 to work with TLS version 1.2. [STANDARDS-TRACK] This specification defines Web Linking using a link format for use by constrained web servers to describe hosted resources, their attributes, and other relationships between links. Based on the HTTP Link Header field defined in RFC 5988, the Constrained RESTful Environments (CoRE) Link Format is carried as a payload and is assigned an Internet media type. "RESTful" refers to the Representational State Transfer (REST) architecture. A well-known URI is defined as a default entry point for requesting the links hosted by a server. [STANDARDS-TRACK] This document defines a YANG data model for the management of network interfaces. It is expected that interface-type-specific data models augment the generic interfaces data model defined in this document. The data model includes definitions for configuration and system state (status information and counters for the collection of statistics). The YANG data model in this document conforms to the Network Management Datastore Architecture (NMDA) defined in RFC 8342. This document obsoletes RFC 7223. This document defines a YANG data model for the configuration and identification of some common system properties within a device containing a Network Configuration Protocol (NETCONF) server. This document also includes data node definitions for system identification, time-of-day management, user management, DNS resolver configuration, and some protocol operations for system management. Datastores are a fundamental concept binding the data models written in the YANG data modeling language to network management protocols such as the Network Configuration Protocol (NETCONF) and RESTCONF. This document defines an architectural framework for datastores based on the experience gained with the initial simpler model, addressing requirements that were not well supported in the initial model. This document updates RFC 7950. This document defines Object Security for Constrained RESTful Environments (OSCORE), a method for application-layer protection of the Constrained Application Protocol (CoAP), using CBOR Object Signing and Encryption (COSE). OSCORE provides end-to-end protection between endpoints communicating using CoAP or CoAP-mappable HTTP. OSCORE is designed for constrained nodes and networks supporting a range of proxy operations, including translation between different transport protocols. Although an optional functionality of CoAP, OSCORE alters CoAP options processing and IANA registration. Therefore, this document updates RFC 7252. This document specifies version 1.3 of the Datagram Transport Layer Security (DTLS) protocol. DTLS 1.3 allows client/server applications to communicate over the Internet in a way that is designed to prevent eavesdropping, tampering, and message forgery. The DTLS 1.3 protocol is based on the Transport Layer Security (TLS) 1.3 protocol and provides equivalent security guarantees with the exception of order protection / non-replayability. Datagram semantics of the underlying transport are preserved by the DTLS protocol. This document obsoletes RFC 6347. This specification defines a framework for authentication and authorization in Internet of Things (IoT) environments called ACE-OAuth. The framework is based on a set of building blocks including OAuth 2.0 and the Constrained Application Protocol (CoAP), thus transforming a well-known and widely used authorization solution into a form suitable for IoT devices. Existing specifications are used where possible, but extensions are added and profiles are defined to better serve the IoT use cases.

ietf-coreconf YANG module Alexander Pelov Peter van der Stok Andy Bierman "; description "This module contains the different definitions required by the CORECONF protocol. Copyright (c) 2019 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX; see the RFC itself for full legal notices."; revision 2023-03-13 { description "Initial revision."; reference "[I-D.ietf-core-comi] CoAP Management Interface"; } identity unified { base ds:datastore; description "Identifier of the unified configuration and operational state datastore."; } identity error-tag { description "Base identity for error-tag."; } identity operation-failed { base error-tag; description "Returned by the CORECONF server when the operation request can't be processed successfully."; } identity invalid-value { base error-tag; description "Returned by the CORECONF server when the CORECONF client tries to update or create a leaf with a value encoded using an invalid CBOR datatype or if the 'range', 'length', 'pattern' or 'require-instance' constrain is not fulfilled."; } identity missing-element { base error-tag; description "Returned by the CORECONF server when the operation requested by a CORECONF client fails to comply with the 'mandatory' constraint defined. The 'mandatory' constraint is enforced for leafs and choices, unless the node or any of its ancestors have a 'when' condition or 'if-feature' expression that evaluates to 'false'."; } identity unknown-element { base error-tag; description "Returned by the CORECONF server when the CORECONF client tries to access a data node of a YANG module not supported, of a data node associated with an 'if-feature' expression evaluated to 'false' or to a 'when' condition evaluated to 'false'."; } identity bad-element { base error-tag; description "Returned by the CORECONF server when the CORECONF client tries to create data nodes for more than one case in a choice."; } identity data-missing { base error-tag; description "Returned by the CORECONF server when a data node required to accept the request is not present."; } identity error { base error-tag; description "Returned by the CORECONF server when an unspecified error has occurred."; } identity error-app-tag { description "Base identity for error-app-tag."; } identity malformed-message { base error-app-tag; description "Returned by the CORECONF server when the payload received from the CORECONF client don't contain a well-formed CBOR content as defined in [RFC8949] or don't comply with the CBOR structure defined within this document."; } identity data-not-unique { base error-app-tag; description "Returned by the CORECONF server when the validation of the 'unique' constraint of a list or leaf-list fails."; } identity too-many-elements { base error-app-tag; description "Returned by the CORECONF server when the validation of the 'max-elements' constraint of a list or leaf-list fails."; } identity too-few-elements { base error-app-tag; description "Returned by the CORECONF server when the validation of the 'min-elements' constraint of a list or leaf-list fails."; } identity must-violation { base error-app-tag; description "Returned by the CORECONF server when the restrictions imposed by a 'must' statement are violated."; } identity duplicate { base error-app-tag; description "Returned by the CORECONF server when a client tries to create a duplicate list or leaf-list entry."; } identity invalid-datatype { base error-app-tag; description "Returned by the CORECONF server when CBOR encoding is incorect or when the value encoded is incompatible with the YANG Built-In type. (e.g. value greater than 127 for an int8, undefined enumeration)."; } identity not-in-range { base error-app-tag; description "Returned by the CORECONF server when the validation of the 'range' property fails."; } identity invalid-length { base error-app-tag; description "Returned by the CORECONF server when the validation of the 'length' property fails."; } identity pattern-test-failed { base error-app-tag; description "Returned by the CORECONF server when the validation of the 'pattern' property fails."; } identity missing-key { base error-app-tag; description "Returned by the CORECONF server to further qualify a missing-element error. This error is returned when the CORECONF client tries to create or list instance, without all the 'key' specified or when the CORECONF client tries to delete a leaf listed as a 'key'."; } identity missing-input-parameter { base error-app-tag; description "Returned by the CORECONF server when the input parameters of a RPC or action are incomplete."; } identity instance-required { base error-app-tag; description "Returned by the CORECONF server when a leaf of type 'instance-identifier' or 'leafref' marked with require-instance set to 'true' refers to an instance that does not exist."; } identity missing-choice { base error-app-tag; description "Returned by the CORECONF server when no nodes exist in a mandatory choice."; } rc:yang-data coreconf-error { container error { description "Optional payload of a 4.00 Bad Request CoAP error."; leaf error-tag { type identityref { base error-tag; } mandatory true; description "The enumerated error-tag."; } leaf error-app-tag { type identityref { base error-app-tag; } description "The application-specific error-tag."; } leaf error-data-node { type instance-identifier; description "When the error reported is caused by a specific data node, this leaf identifies the data node in error."; } leaf error-message { type string; description "A message describing the error."; } } } } ]]>

ietf-coreconf .sid file

Acknowledgments We are very grateful to who was one of the original authors of the CORECONF specification. and explained the encoding aspects of PDUs transported under SNMP. 's implementation input motivated massively simplifying (and fixing) the URI construction for GET/PUT/POST requests. The draft has further benefited from comments (alphabetical order) by , , , , , , , , , , , and .

Contributors Acklio

1137A avenue des Champs Blancs Cesson-Sevigne 35510 France ivaylo@ackl.io