draft-ietf-core-yang-cbor-01.txt   draft-ietf-core-yang-cbor-02.txt 
Internet Engineering Task Force M. Veillette, Ed. Internet Engineering Task Force M. Veillette, Ed.
Internet-Draft Trilliant Networks Inc. Internet-Draft Trilliant Networks Inc.
Intended status: Standards Track A. Pelov, Ed. Intended status: Standards Track A. Pelov, Ed.
Expires: December 25, 2016 Acklio Expires: January 9, 2017 Acklio
A. Somaraju A. Somaraju
Tridonic GmbH & Co KG Tridonic GmbH & Co KG
R. Turner R. Turner
Landis+Gyr Landis+Gyr
A. Minaburo A. Minaburo
Acklio Acklio
June 23, 2016 July 08, 2016
CBOR Encoding of Data Modeled with YANG CBOR Encoding of Data Modeled with YANG
draft-ietf-core-yang-cbor-01 draft-ietf-core-yang-cbor-02
Abstract Abstract
This document defines encoding rules for serializing configuration This document defines encoding rules for serializing configuration
data, state data, RPC input and RPC output, Action input, Action data, state data, RPC input and RPC output, Action input, Action
output and notifications defined within YANG modules using the output and notifications defined within YANG modules using the
Concise Binary Object Representation (CBOR) [RFC7049]. Concise Binary Object Representation (CBOR) [RFC7049].
Status of This Memo Status of This Memo
skipping to change at page 1, line 40 skipping to change at page 1, line 40
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 http://datatracker.ietf.org/drafts/current/. Drafts is at http://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 December 25, 2016. This Internet-Draft will expire on January 9, 2017.
Copyright Notice Copyright Notice
Copyright (c) 2016 IETF Trust and the persons identified as the Copyright (c) 2016 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
(http://trustee.ietf.org/license-info) in effect on the date of (http://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
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
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 . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Terminology and Notation . . . . . . . . . . . . . . . . . . 3 2. Terminology and Notation . . . . . . . . . . . . . . . . . . 3
2.1. CBOR diagnostic notation . . . . . . . . . . . . . . . . 4 2.1. CBOR diagnostic notation . . . . . . . . . . . . . . . . 4
3. Properties of the CBOR Encoding . . . . . . . . . . . . . . . 5 3. Properties of the CBOR Encoding . . . . . . . . . . . . . . . 5
4. Encoding of YANG Schema Node Instances . . . . . . . . . . . 6 4. Encoding of YANG Data Node Instances . . . . . . . . . . . . 6
4.1. The 'leaf' Schema Node . . . . . . . . . . . . . . . . . 6 4.1. The 'leaf' Data Node . . . . . . . . . . . . . . . . . . 6
4.2. The 'container' Schema Node . . . . . . . . . . . . . . . 6 4.2. The 'container' Data Node . . . . . . . . . . . . . . . . 6
4.3. The 'leaf-list' Schema Node . . . . . . . . . . . . . . . 10 4.2.1. SIDs as keys . . . . . . . . . . . . . . . . . . . . 7
4.4. The 'list' Schema Node . . . . . . . . . . . . . . . . . 10 4.2.2. Member names as keys . . . . . . . . . . . . . . . . 8
4.5. The 'anydata' Schema Node . . . . . . . . . . . . . . . . 16 4.3. The 'leaf-list' Data Node . . . . . . . . . . . . . . . . 9
4.6. The 'anyxml' Schema Node . . . . . . . . . . . . . . . . 17 4.4. The 'list' Data Node . . . . . . . . . . . . . . . . . . 9
5. Representing YANG Data Types in CBOR . . . . . . . . . . . . 17 4.4.1. SIDs as keys . . . . . . . . . . . . . . . . . . . . 10
5.1. The unsigned integer Types . . . . . . . . . . . . . . . 17 4.4.2. Member names as keys . . . . . . . . . . . . . . . . 13
5.2. The integer Types . . . . . . . . . . . . . . . . . . . . 17 4.5. The 'anydata' Data Node . . . . . . . . . . . . . . . . . 14
5.3. The 'decimal64' Type . . . . . . . . . . . . . . . . . . 18 4.6. The 'anyxml' Data Node . . . . . . . . . . . . . . . . . 15
5.4. The 'string' Type . . . . . . . . . . . . . . . . . . . . 18 5. Representing YANG Data Types in CBOR . . . . . . . . . . . . 15
5.5. The 'boolean' Type . . . . . . . . . . . . . . . . . . . 19 5.1. The unsigned integer Types . . . . . . . . . . . . . . . 15
5.6. The 'enumeration' Type . . . . . . . . . . . . . . . . . 19 5.2. The integer Types . . . . . . . . . . . . . . . . . . . . 15
5.7. The 'bits' Type . . . . . . . . . . . . . . . . . . . . . 19 5.3. The 'decimal64' Type . . . . . . . . . . . . . . . . . . 16
5.8. The 'binary' Type . . . . . . . . . . . . . . . . . . . . 20 5.4. The 'string' Type . . . . . . . . . . . . . . . . . . . . 16
5.9. The 'leafref' Type . . . . . . . . . . . . . . . . . . . 21 5.5. The 'boolean' Type . . . . . . . . . . . . . . . . . . . 17
5.10. The 'identityref' Type . . . . . . . . . . . . . . . . . 21 5.6. The 'enumeration' Type . . . . . . . . . . . . . . . . . 17
5.11. The 'empty' Type . . . . . . . . . . . . . . . . . . . . 23 5.7. The 'bits' Type . . . . . . . . . . . . . . . . . . . . . 18
5.12. The 'union' Type . . . . . . . . . . . . . . . . . . . . 23 5.8. The 'binary' Type . . . . . . . . . . . . . . . . . . . . 18
5.13. The 'instance-identifier' Type . . . . . . . . . . . . . 24 5.9. The 'leafref' Type . . . . . . . . . . . . . . . . . . . 19
6. Security Considerations . . . . . . . . . . . . . . . . . . . 29 5.10. The 'identityref' Type . . . . . . . . . . . . . . . . . 19
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 29 5.10.1. SIDs as identityref . . . . . . . . . . . . . . . . 20
7.1. Tags Registry . . . . . . . . . . . . . . . . . . . . . . 29 5.10.2. Name as identityref . . . . . . . . . . . . . . . . 20
8. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 30 5.11. The 'empty' Type . . . . . . . . . . . . . . . . . . . . 21
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 30 5.12. The 'union' Type . . . . . . . . . . . . . . . . . . . . 21
9.1. Normative References . . . . . . . . . . . . . . . . . . 30 5.13. The 'instance-identifier' Type . . . . . . . . . . . . . 22
9.2. Informative References . . . . . . . . . . . . . . . . . 31 5.13.1. SIDs as instance-identifier . . . . . . . . . . . . 22
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 31 5.13.2. Names as instance-identifier . . . . . . . . . . . . 25
6. Security Considerations . . . . . . . . . . . . . . . . . . . 26
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 26
7.1. Tags Registry . . . . . . . . . . . . . . . . . . . . . . 26
8. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 26
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 27
9.1. Normative References . . . . . . . . . . . . . . . . . . 27
9.2. Informative References . . . . . . . . . . . . . . . . . 27
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 28
1. Introduction 1. Introduction
The specification of the YANG 1.1 data modelling language The specification of the YANG 1.1 data modelling language
[I-D.ietf-netmod-rfc6020bis] defines only an XML encoding for data [I-D.ietf-netmod-rfc6020bis] defines an XML encoding for data
instances, i.e. contents of configuration datastores, state data, RPC instances, i.e. contents of configuration datastores, state data, RPC
inputs and outputs, action inputs and outputs, and event inputs and outputs, action inputs and outputs, and event
notifications. notifications.
A new set of encoding rules has been defined to allow the use of the A new set of encoding rules has been defined to allow the use of the
same data models in environments based on the JavaScript Object same data models in environments based on the JavaScript Object
Notation (JSON) Data Interchange Format [RFC7159]. This is Notation (JSON) Data Interchange Format [RFC7159]. This is
accomplished in the JSON Encoding of Data Modeled with YANG accomplished in the JSON Encoding of Data Modeled with YANG
specification [I-D.ietf-netmod-yang-json]. specification [I-D.ietf-netmod-yang-json].
skipping to change at page 3, line 44 skipping to change at page 4, line 4
o data tree o data tree
o module o module
o notification o notification
o RPC o RPC
o schema node o schema node
o schema tree o schema tree
o submodule o submodule
The following terms are defined in [I-D.ietf-netmod-yang-json]: The following terms are defined in [I-D.ietf-netmod-yang-json]:
o member name o member name
o name of an identity
The following term is defined in [I-D.vanderstok-core-comi]: o name of an identity
o YANG hash o namespace-qualified
This specification also makes use of the following terminology: This specification also makes use of the following terminology:
o child: A schema node defined within a collection such as a o child: A schema node defined within a collection such as a
container, a list, a case, a notification, an RPC input, an RPC container, a list, a case, a notification, an RPC input, an RPC
output, an action input, an action output. output, an action input, an action output.
o delta : Difference between the SID assigned to the current schema o delta : Difference between the SID assigned to the current schema
node and the SID assigned to the parent. node and the SID assigned to the parent.
skipping to change at page 5, line 4 skipping to change at page 4, line 36
o structured identifier or SID: Unsigned integer used to identify o structured identifier or SID: Unsigned integer used to identify
different YANG items. different YANG items.
2.1. CBOR diagnostic notation 2.1. CBOR diagnostic notation
Within this document, CBOR binary contents are represented using an Within this document, CBOR binary contents are represented using an
equivalent textual form called CBOR diagnostic notation as defined in equivalent textual form called CBOR diagnostic notation as defined in
[RFC7049] section 6. This notation is used strictly for [RFC7049] section 6. This notation is used strictly for
documentation purposes and is never used in the data serialization. documentation purposes and is never used in the data serialization.
Table 1 below provides a summary of this notation.
+----------+------+--------------------------+-----------+----------+ +----------+------+--------------------------+-----------+----------+
| CBOR | CBOR | Diagnostic notation | Example | CBOR | | CBOR | CBOR | Diagnostic notation | Example | CBOR |
| content | type | | | encoding | | content | type | | | encoding |
+----------+------+--------------------------+-----------+----------+ +----------+------+--------------------------+-----------+----------+
| Unsigned | 0 | Decimal digits | 123 or | 18 7b | | Unsigned | 0 | Decimal digits | 123 | 18 7b |
| integer | | | +123 | | | integer | | | | |
| Negative | 1 | Decimal digits prefixed | -123 | 38 7a | | Negative | 1 | Decimal digits prefixed | -123 | 38 7a |
| integer | | by a minus sign | | | | integer | | by a minus sign | | |
| Byte | 2 | Hexadecimal value | h'f15c' | 42 f15c | | Byte | 2 | Hexadecimal value | h'f15c' | 42 f15c |
| string | | enclosed between single | | | | string | | enclosed between single | | |
| | | quotes and prefixed by | | | | | | quotes and prefixed by | | |
| | | an 'h' | | | | | | an 'h' | | |
| Text | 3 | String of Unicode | "txt" | 63 | | Text | 3 | String of Unicode | "txt" | 63 |
| string | | characters enclosed | | 747874 | | string | | characters enclosed | | 747874 |
| | | between double quotes | | | | | | between double quotes | | |
| Array | 4 | Comma-separated list of | [ 1, 2 ] | 82 01 02 | | Array | 4 | Comma-separated list of | [ 1, 2 ] | 82 01 02 |
skipping to change at page 5, line 33 skipping to change at page 5, line 33
| Map | 5 | Comma-separated list of | { 1: 123, | a2 | | Map | 5 | Comma-separated list of | { 1: 123, | a2 |
| | | key : value pairs within | 2: 456 } | 01187b | | | | key : value pairs within | 2: 456 } | 01187b |
| | | curly braces | | 021901c8 | | | | curly braces | | 021901c8 |
| Boolean | 7/20 | false | false | f4 | | Boolean | 7/20 | false | false | f4 |
| | 7/21 | true | true | f5 | | | 7/21 | true | true | f5 |
| Null | 7/22 | null | null | f6 | | Null | 7/22 | null | null | f6 |
| Not | 7/23 | undefined | undefined | f7 | | Not | 7/23 | undefined | undefined | f7 |
| assigned | | | | | | assigned | | | | |
+----------+------+--------------------------+-----------+----------+ +----------+------+--------------------------+-----------+----------+
Table 1: CBOR diagnostic notation summary
The following extensions to the CBOR diagnostic notation are The following extensions to the CBOR diagnostic notation are
supported: supported:
o Comments can be added to the end of each line. Any characters o Comments can be added to the end of each line. Any characters
after a Pound sign ('#') outside of a string, up to the end of the after a Pound sign ('#') outside of a string, up to the end of the
line, are treated as a comment. line, are treated as a comment.
o Deltas are represented as positive numbers (e.g. +123). o Deltas are represented as numbers preceded by a '+' or '-' sign.
The use of the '+' sign for positive deltas represents an
extension to the CBOR diagnostic notation as defined by [RFC7049]
section 6.
3. Properties of the CBOR Encoding 3. Properties of the CBOR Encoding
This document defines CBOR encoding rules for YANG schema trees and This document defines CBOR encoding rules for YANG schema trees and
their subtrees. their subtrees.
Basic schema nodes such as leaf, leaf-list, list, anydata and anyxml Basic schema nodes such as leaf, leaf-list, list, anydata and anyxml
can be encoded standalone. In this case, only the value of this can be encoded standalone. In this case, only the value of this
schema node is encoded in CBOR. Identification of this value need to schema node is encoded in CBOR. Identification of this value needs
be provided by some external means when needed. to be provided by some external means when required.
A collection such as container, list instance, notification, RPC A collection such as container, list instance, notification, RPC
input, RPC output, action input and action output is serialized using input, RPC output, action input and action output is serialized using
a CBOR map in which each child schema node is encoded using a key and a CBOR map in which each child schema node is encoded using a key and
a value. This specification supports three type of keys; SID as a value. This specification supports two type of keys; SID as
defined in [I-D.somaraju-core-sid], member names as defined in defined in [I-D.somaraju-core-sid] and member names as defined in
[I-D.ietf-netmod-yang-json] and YANG hash as defined by [I-D.ietf-netmod-yang-json]. Each of these key type is encoded using
[I-D.vanderstok-core-comi]. Each of these key type is encoded using
a specific CBOR type which allows their interpretation during the a specific CBOR type which allows their interpretation during the
deserialization process. The end user of this mapping specification deserialization process. The end user of this mapping specification
can mandate the use of a specific key type or a specific subset of can mandate the use of a specific key type or a specific subset of
key types. key types.
In order to minimize the size of the encoded data, the proposed In order to minimize the size of the encoded data, the proposed
mapping avoid any unnecessary meta-information beyond those natively mapping avoid any unnecessary meta-information beyond those natively
supported by CBOR. For instance, CBOR tags are used sorely in the supported by CBOR. For instance, CBOR tags are used sorely in the
case of the union datatype to distinguish explicitly the use of case of the union datatype to distinguish explicitly the use of
different YANG datatypes encoded using the same CBOR major type. different YANG datatypes encoded using the same CBOR major type.
It is expected that entities generating and decoding CBOR contents It is expected that application entities generating and decoding CBOR
have enough knowledge about the information processed in order to contents have enough knowledge about the information processed in
perform the expected task without the need of such extra meta- order to perform the expected task without the need of such extra
information. The CoAP Content-Format Option, or an HTTP Content-Type meta-information.
header field, conveys that the data is YANG-encoded CBOR in the first
place.
4. Encoding of YANG Schema Node Instances 4. Encoding of YANG Data Node Instances
Schema node instances defined using the YANG modeling language are Schema node instances defined using the YANG modeling language are
encoded using CBOR [RFC7049] based on the rules defined in this encoded using CBOR [RFC7049] based on the rules defined in this
section. We assume that the reader is already familiar with both section. We assume that the reader is already familiar with both
YANG [I-D.ietf-netmod-rfc6020bis] and CBOR [RFC7049]. YANG [I-D.ietf-netmod-rfc6020bis] and CBOR [RFC7049].
4.1. The 'leaf' Schema Node 4.1. The 'leaf' Data Node
Leafs MUST be encoded based on the encoding rules specified in Leafs MUST be encoded based on the encoding rules specified in
Section 5. Section 5.
4.2. The 'container' Schema Node 4.2. The 'container' Data Node
Collections such as containers, list instances, notifications, RPC Collections such as containers, list instances, notifications, RPC
inputs, RPC outputs, action inputs and action outputs MUST be encoded inputs, RPC outputs, action inputs and action outputs MUST be encoded
using a CBOR map data item (major type 5). A map is comprised of using a CBOR map data item (major type 5). A map is comprised of
pairs of data items, with each data item consisting of a key and a pairs of data items, with each data item consisting of a key and a
value. Each key within the CBOR map is set to a data node value. Each key within the CBOR map is set to a data node
identifier, each value is set to the value of this data node identifier, each value is set to the value of this data node
instance. instance.
This specification supports three type of keys; SID as defined in This specification supports two type of keys; SID as defined in
[I-D.somaraju-core-sid], member names as defined in [I-D.somaraju-core-sid] encoded using CBOR unsigned or signed
[I-D.ietf-netmod-yang-json] and YANG hash as defined by integers and member names as defined in [I-D.ietf-netmod-yang-json]
[I-D.vanderstok-core-comi]. encoded using CBOR text strings. The use of CBOR byte strings for
keys is reserved for future extensions.
*SIDs as keys* 4.2.1. SIDs as keys
Keys implemented using SIDs MUST be encoded using a CBOR unsigned Keys implemented using SIDs MUST be encoded using a CBOR unsigned
integer (major type 0) or CBOR signed integer (major type 1), integer (major type 0) or CBOR signed integer (major type 1),
depending on the actual value. Keys are set to the delta of the depending on the actual value. Keys are set to the delta of the
associated SID, delta values are computed as follows: associated SID, delta values are computed as follows:
o The delta value is equal to the SID of the current schema node o The delta value is equal to the SID of the current schema node
minus the SID of the parent schema node. When no parent exists in minus the SID of the parent schema node. When no parent exists in
the context of use of this container, the delta is set to the SID the context of use of this container, the delta is set to the SID
of the current schema node (a parent with SID equal to zero is of the current schema node (a parent with SID equal to zero is
assumed). assumed).
o Delta values may result in a negative number, clients and servers o Delta values may result in a negative number, clients and servers
MUST support negative deltas. MUST support negative deltas.
*Member names as keys* The following example shows the encoding of the 'system' container
using the SIDs defined in [I-D.somaraju-core-sid] Appendix C.
Keys implemented using member names MUST be encoded using a CBOR text
string data item (major type 3). A namespace-qualified member name
MUST be used for all members of a top-level collection, and then also
whenever the namespaces of the schema node and its parent are
different. In all other cases, the simple form of the member name
MUST be used. Member names and namespaces are defined in
[I-D.ietf-netmod-yang-json] section 4.
*YANG hashes as keys*
Keys implemented using YANG hashes MUST be encoded using a CBOR byte
string data item (major type 2).
Values MUST be encoded using the appropriate rules defined in
Section 4 and Section 5.
Definition example [RFC7317]: Definition example from [RFC7317]:
typedef date-and-time { typedef date-and-time {
type string { type string {
pattern '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[\+\-] pattern '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[\+\-]
\d{2}:\d{2})'; \d{2}:\d{2})';
} }
} }
container system { container system {
leaf hostname { leaf hostname {
skipping to change at page 8, line 26 skipping to change at page 8, line 4
container clock { container clock {
leaf current-datetime { leaf current-datetime {
type date-and-time; type date-and-time;
} }
leaf boot-datetime { leaf boot-datetime {
type date-and-time; type date-and-time;
} }
} }
} }
*SIDs example*
This example is encoded using the SIDs defined in
[I-D.somaraju-core-sid] Appendix C.
CBOR diagnostic notation: CBOR diagnostic notation:
{ {
1708 : { # clock 1717 : { # clock (SID 1717)
+2 : "2015-10-02T14:47:24Z-05:00", # current-datetime, SID 1710 +2 : "2015-10-02T14:47:24Z-05:00", # current-datetime (SID 1719)
+1 : "2015-09-15T09:12:58Z-05:00" # boot-datetime, SID 1709 +1 : "2015-09-15T09:12:58Z-05:00" # boot-datetime (SID 1718)
} }
} }
CBOR encoding: CBOR encoding:
a1 # map(1) a1 # map(1)
19 06ac # unsigned(1708) 19 06b5 # unsigned(1717)
a2 # map(2) a2 # map(2)
02 # unsigned(2) 02 # unsigned(2)
78 1a # text(26) 78 1a # text(26)
323031352d31302d30325431343a34373a32345a2d30353a3030 323031352d31302d30325431343a34373a32345a2d30353a3030
01 # unsigned(1) 01 # unsigned(1)
78 1a # text(26) 78 1a # text(26)
323031352d30392d31355430393a31323a35385a2d30353a3030 323031352d30392d31355430393a31323a35385a2d30353a3030
*Member names example* 4.2.2. Member names as keys
Keys implemented using member names MUST be encoded using a CBOR text
string data item (major type 3). A namespace-qualified member name
MUST be used for all members of a top-level collection, and then also
whenever the namespaces of the schema node and its parent are
different. In all other cases, the simple form of the member name
MUST be used. Names and namespaces are defined in
[I-D.ietf-netmod-yang-json] section 4.
The following example shows the encoding of the the 'system'
container using names. This example is described in Section 4.2.1.
CBOR diagnostic notation: CBOR diagnostic notation:
{ {
"ietf-system:clock" : { "ietf-system:clock" : {
"current-datetime" : "2015-10-02T14:47:24Z-05:00", "current-datetime" : "2015-10-02T14:47:24Z-05:00",
"boot-datetime" : "2015-09-15T09:12:58Z-05:00" "boot-datetime" : "2015-09-15T09:12:58Z-05:00"
} }
} }
skipping to change at page 9, line 31 skipping to change at page 9, line 18
a2 # map(2) a2 # map(2)
70 # text(16) 70 # text(16)
63757272656e742d6461746574696d65 # "current-datetime" 63757272656e742d6461746574696d65 # "current-datetime"
78 1a # text(26) 78 1a # text(26)
323031352d31302d30325431343a34373a32345a2d30353a3030 323031352d31302d30325431343a34373a32345a2d30353a3030
6d # text(13) 6d # text(13)
626f6f742d6461746574696d65 # "boot-datetime" 626f6f742d6461746574696d65 # "boot-datetime"
78 1a # text(26) 78 1a # text(26)
323031352d30392d31355430393a31323a35385a2d30353a3030 323031352d30392d31355430393a31323a35385a2d30353a3030
*YANG Hashes example* 4.3. The 'leaf-list' Data Node
CBOR diagnostic notation:
{
h'334c67d9' : { # clock
h'047c468b' : "2015-10-02T14:47:24Z-05:00", # current-datetime
h'2fe1a167' : "2015-09-15T09:12:58Z-05:00" # boot-datetime
}
}
CBOR encoding:
a1 # map(1)
44 # bytes(4)
334c67d9
a2 # map(2)
44 # bytes(4)
047c468b
78 1a # text(26)
323031352d31302d30325431343a34373a32345a2d30353a3030
44 # bytes(4)
2fe1a167
78 1a # text(26)
323031352d30392d31355430393a31323a35385a2d30353a3030
4.3. The 'leaf-list' Schema Node
A leaf-list MUST be encoded using a CBOR array data item (major type A leaf-list MUST be encoded using a CBOR array data item (major type
4). Each entry of this array MUST be encoded using the rules defined 4). Each entry of this array MUST be encoded using the rules defined
by the YANG type specified. by the YANG type specified.
The following example shows the encoding the 'search' leaf-list
containing the two entries, "ietf.org" and "ieee.org".
Definition example [RFC7317]: Definition example [RFC7317]:
typedef domain-name { typedef domain-name {
type string { type string {
length "1..253"; length "1..253";
pattern '((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9].) pattern '((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9].)
*([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.? *([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?
)|\.'; )|\.';
} }
} }
leaf-list search { leaf-list search {
type domain-name; type domain-name;
ordered-by user; ordered-by user;
} }
CBOR diagnostic notation: [ "ietf.org", "ieee.org" ] CBOR diagnostic notation: [ "ietf.org", "ieee.org" ]
CBOR encoding: 82 68 696574662e6f7267 68 696565652e6f7267 CBOR encoding: 82 68 696574662e6f7267 68 696565652e6f7267
4.4. The 'list' Schema Node 4.4. The 'list' Data Node
A list MUST be encoded using a CBOR array data item (major type 4). A list MUST be encoded using a CBOR array data item (major type 4).
Each list instance within this CBOR array is encoded using a CBOR map Each list instance within this CBOR array is encoded using a CBOR map
data item (major type 5) based on the same rules as a YANG container data item (major type 5) based on the same rules as a YANG container
as defined in Section 4.2. as defined in Section 4.2.
Definition example [RFC7317]: 4.4.1. SIDs as keys
The follwoing example show the encoding a the 'server' list using the
SIDs defined in [I-D.somaraju-core-sid] Appendix C. It is important
to note that the protocol or method using this mapping may carry a
parent SID or may have the knowledge of this parent SID based on its
context. In these cases, delta encoding can be performed based on
this parent SID which minimizes the size of the encoded data.
The following example shows the encoding of the 'server' list
containing two enties. SIDs used in this example are defined in
[I-D.somaraju-core-sid] Appendix C. It is important to note that the
protocol or method using this mapping may carry a parent SID or may
have the knowledge of this parent SID based on its context. In these
cases, delta encoding can be performed based on this parent SID which
minimizes the size of the encoded data.
Definition example from [RFC7317]:
list server { list server {
key name; key name;
leaf name { leaf name {
type string; type string;
} }
choice transport { choice transport {
case udp { case udp {
container udp { container udp {
skipping to change at page 11, line 42 skipping to change at page 11, line 42
leaf iburst { leaf iburst {
type boolean; type boolean;
default false; default false;
} }
leaf prefer { leaf prefer {
type boolean; type boolean;
default false; default false;
} }
} }
*SIDs example*
SIDs used in this example are defined in [I-D.somaraju-core-sid]
Appendix C. It is important to note that the protocol or method
using this mapping may carry a parent SID or may have the knowledge
of this parent SID based on its context. In these cases, delta
encoding can be performed based on this parent SID which minimizes
the size of the encoded data.
CBOR diagnostic notation: CBOR diagnostic notation:
[ [
{ {
1746 : "NRC TIC server", # name 1755 : "NRC TIC server", # name (SID 1755)
1748 : { # udp 1757 : { # udp (SID 1757)
+1 : "tic.nrc.ca", # address, SID 1749 +1 : "tic.nrc.ca", # address (SID 1758)
+2 : 123 # port, SID 1750 +2 : 123 # port (SID 1759)
}, },
1744 : 0, # association-type 1753 : 0, # association-type (SID 1753)
1745 : false, # iburst 1754 : false, # iburst (SID 1754)
1747 : true # prefer 1756 : true # prefer (SID 1756)
}, },
{ {
1746 : "NRC TAC server", # name 1755 : "NRC TAC server", # name (SID 1755)
1748 : { # udp 1757 : { # udp (SID 1757)
+1 : "tac.nrc.ca" # address, SID 1749 +1 : "tac.nrc.ca" # address (SID 1758)
} }
} }
] ]
CBOR encoding: CBOR encoding:
82 # array(2) 82 # array(2)
a5 # map(5) a5 # map(5)
19 06d2 # unsigned(1746) 19 06db # unsigned(1755)
6e # text(14) 6e # text(14)
4e52432054494320736572766572 # "NRC TIC server" 4e52432054494320736572766572 # "NRC TIC server"
19 06d4 # unsigned(1748) 19 06dd # unsigned(1757)
a2 # map(2) a2 # map(2)
01 # unsigned(1) 01 # unsigned(1)
6a # text(10) 6a # text(10)
7469632e6e72632e6361 # "tic.nrc.ca" 7469632e6e72632e6361 # "tic.nrc.ca"
02 # unsigned(2) 02 # unsigned(2)
18 7b # unsigned(123) 18 7b # unsigned(123)
19 06d0 # unsigned(1744) 19 06d9 # unsigned(1753)
00 # unsigned(0) 00 # unsigned(0)
19 06d1 # unsigned(1745) 19 06da # unsigned(1754)
f4 # primitive(20) f4 # primitive(20)
19 06d3 # unsigned(1747) 19 06dc # unsigned(1756)
f5 # primitive(21) f5 # primitive(21)
a2 # map(2) a2 # map(2)
19 06d2 # unsigned(1746) 19 06db # unsigned(1755)
6e # text(14) 6e # text(14)
4e52432054414320736572766572 # "NRC TAC server" 4e52432054414320736572766572 # "NRC TAC server"
19 06d4 # unsigned(1748) 19 06dd # unsigned(1757)
a1 # map(1) a1 # map(1)
01 # unsigned(1) 01 # unsigned(1)
6a # text(10) 6a # text(10)
7461632e6e72632e6361 # "tac.nrc.ca" 7461632e6e72632e6361 # "tac.nrc.ca"
*Member names example* 4.4.2. Member names as keys
The following example shows the encoding of the the 'server' list
using names. This example is described in Section 4.4.1.
CBOR diagnostic notation: CBOR diagnostic notation:
[ [
{ {
"ietf-system:name" : "NRC TIC server", "ietf-system:name" : "NRC TIC server",
"ietf-system:udp" : { "ietf-system:udp" : {
"address" : "tic.nrc.ca", "address" : "tic.nrc.ca",
"port" : 123 "port" : 123
}, },
skipping to change at page 14, line 43 skipping to change at page 14, line 43
6e # text(14) 6e # text(14)
4e52432054414320736572766572 # "NRC TAC server" 4e52432054414320736572766572 # "NRC TAC server"
6f # text(15) 6f # text(15)
696574662d73797374656d3a756470 # "ietf-system:udp" 696574662d73797374656d3a756470 # "ietf-system:udp"
a1 # map(1) a1 # map(1)
67 # text(7) 67 # text(7)
61646472657373 # "address" 61646472657373 # "address"
6a # text(10) 6a # text(10)
7461632e6e72632e6361 # "tac.nrc.ca" 7461632e6e72632e6361 # "tac.nrc.ca"
*YANG hashes example* 4.5. The 'anydata' Data Node
CBOR diagnostic notation:
[
{
h'06c32032' : "NRC TIC server", # name
h'11889c84' : { # udp
h'3158c529' : "tic.nrc.ca", # address
h'34492d05' : 123 # port
},
h'2c2c2ccf' : 0, # association-type
h'1058dc5d' : false, # iburst
h'390e346a' : true # prefer
},
{
h'06c32032' : "NRC TAC server", # name
h'11889c84' : { # udp
h'3158c529' : "tac.nrc.ca" # address
}
}
]
CBOR encoding:
82 # array(2)
a5 # map(5)
44 # bytes(4)
06c32032"
6e # text(14)
4e52432054494320736572766572 # "NRC TIC server"
44 # bytes(4)
11889c84 "
a2 # map(2)
44 # bytes(4)
3158c529
6a # text(10)
7469632e6e72632e6361 # "tic.nrc.ca"
44 # bytes(4)
34492d05
18 7b # unsigned(123)
44 # bytes(4)
2c2c2ccf
00 # unsigned(0)
44 # bytes(4)
1058dc5d
f4 # primitive(20)
44 # bytes(4)
390e346a
f5 # primitive(21)
a2 # map(2)
44 # bytes(4)
06c32032
6e # text(14)
4e52432054414320736572766572 # "NRC TAC server"
44 # bytes(4)
11889c84
a1 # map(1)
44 # bytes(4)
3158c529
6a # text(10)
7461632e6e72632e6361 # "tac.nrc.ca"
4.5. The 'anydata' Schema Node
An anydata serves as a container for an arbitrary set of schema nodes An anydata serves as a container for an arbitrary set of schema nodes
that otherwise appear as normal YANG-modeled data. An anydata that otherwise appear as normal YANG-modeled data. An anydata
instance is encoded using the same rules as a container, i.e., CBOR instance is encoded using the same rules as a container, i.e., CBOR
map. The requirement that anydata content can be modeled by YANG map. The requirement that anydata content can be modeled by YANG
implies the following: implies the following:
o Keys MUST be set to valid SIDs, member names or YANG hashes. This o Keys of any inner data nodes MUST be set to valid deltas or member
rule applies to the key of the anydata node and the key of any names.
inner schema node.
o The CBOR array MUST contain either unique scalar values (as a o The CBOR array MUST contain either unique scalar values (as a
leaf-list, see Section 4.3), or maps (as a list, see Section 4.4). leaf-list, see Section 4.3), or maps (as a list, see Section 4.4).
o Values MUST follow the encoding rules of one of the datatypes o Values MUST follow the encoding rules of one of the datatypes
listed in Section 5. listed in Section 5.
4.6. The 'anyxml' Schema Node 4.6. The 'anyxml' Data Node
An anyxml instance is encoded as a CBOR key/value pair. The key of An anyxml schema node is used to serialize an arbitrary CBOR content,
the anyxml schema node MUST be a valid SID, member name or YANG hash i.e., its value can be any CBOR binary object.
but the value is unrestricted, i.e., the value can be any CBOR
encoded content.
5. Representing YANG Data Types in CBOR 5. Representing YANG Data Types in CBOR
5.1. The unsigned integer Types 5.1. The unsigned integer Types
Leafs of type uint8, uint16, uint32 and uint64 MUST be encoded using Leafs of type uint8, uint16, uint32 and uint64 MUST be encoded using
a CBOR unsigned integer data item (major type 0). a CBOR unsigned integer data item (major type 0).
Definition example [RFC7277]: The following example shows the encoding of leaf 'mtu' set to 1280
bytes.
Definition example from [RFC7277]:
leaf mtu { leaf mtu {
type uint16 { type uint16 {
range "68..max"; range "68..max";
} }
} }
CBOR diagnostic notation: 1280 CBOR diagnostic notation: 1280
CBOR encoding: 19 0500 CBOR encoding: 19 0500
5.2. The integer Types 5.2. The integer Types
Leafs of type int8, int16, int32 and int64 MUST be encoded using Leafs of type int8, int16, int32 and int64 MUST be encoded using
either CBOR unsigned integer (major type 0) or CBOR signed integer either CBOR unsigned integer (major type 0) or CBOR signed integer
(major type 1), depending on the actual value. (major type 1), depending on the actual value.
Definition example [RFC7317]: The following example shows the encoding of leaf 'timezone-utc-
offset' set to -300 minutes.
Definition example from [RFC7317]:
leaf timezone-utc-offset { leaf timezone-utc-offset {
type int16 { type int16 {
range "-1500 .. 1500"; range "-1500 .. 1500";
} }
} }
CBOR diagnostic notation: -300 CBOR diagnostic notation: -300
CBOR encoding: 39 012b CBOR encoding: 39 012b
5.3. The 'decimal64' Type 5.3. The 'decimal64' Type
f type decimal64 MUST be encoded using either CBOR unsigned integer Leafs of type decimal64 MUST be encoded using either CBOR unsigned
(major type 0) or CBOR signed integer (major type 1), depending on integer (major type 0) or CBOR signed integer (major type 1),
the actual value. Leafs oThe position of the decimal point is depending on the actual value. The position of the decimal point is
defined by the fraction-digits YANG statement and is not available in defined by the fraction-digits YANG statement and is not available in
the CBOR encoding. the CBOR encoding.
Definition example [RFC7317]: The following example shows the encoding of leaf 'my-decimal' set to
2.57.
Definition example from [RFC7317]:
leaf my-decimal { leaf my-decimal {
type decimal64 { type decimal64 {
fraction-digits 2; fraction-digits 2;
range "1 .. 3.14 | 10 | 20..max"; range "1 .. 3.14 | 10 | 20..max";
} }
} }
CBOR diagnostic notation: 257 (Represents decimal value 2.57) CBOR diagnostic notation: 257
CBOR encoding: 19 0101 CBOR encoding: 19 0101
5.4. The 'string' Type 5.4. The 'string' Type
Leafs of type string MUST be encoded using a CBOR text string data Leafs of type string MUST be encoded using a CBOR text string data
item (major type 3). item (major type 3).
Definition example [RFC7223]: The following example shows the encoding of leaf 'name' set to
"eth0".
Definition example from [RFC7223]:
leaf name { leaf name {
type string; type string;
} }
CBOR diagnostic notation: "eth0" CBOR diagnostic notation: "eth0"
CBOR encoding: 64 65746830 CBOR encoding: 64 65746830
5.5. The 'boolean' Type 5.5. The 'boolean' Type
Leafs of type boolean MUST be encoded using a CBOR true (major type Leafs of type boolean MUST be encoded using a CBOR true (major type
7, additional information 21) or false data item (major type 7, 7, additional information 21) or false data item (major type 7,
additional information 20). additional information 20).
skipping to change at page 19, line 11 skipping to change at page 17, line 14
CBOR diagnostic notation: "eth0" CBOR diagnostic notation: "eth0"
CBOR encoding: 64 65746830 CBOR encoding: 64 65746830
5.5. The 'boolean' Type 5.5. The 'boolean' Type
Leafs of type boolean MUST be encoded using a CBOR true (major type Leafs of type boolean MUST be encoded using a CBOR true (major type
7, additional information 21) or false data item (major type 7, 7, additional information 21) or false data item (major type 7,
additional information 20). additional information 20).
Definition example [RFC7317]: The following example shows the encoding of leaf 'enabled' set to
'true'.
Definition example from [RFC7317]:
leaf enabled { leaf enabled {
type boolean; type boolean;
} }
CBOR diagnostic notation: true CBOR diagnostic notation: true
CBOR encoding: f5 CBOR encoding: f5
5.6. The 'enumeration' Type 5.6. The 'enumeration' Type
Leafs of type enumeration MUST be encoded using a CBOR unsigned Leafs of type enumeration MUST be encoded using a CBOR unsigned
integer (major type 0) or CBOR signed integer (major type 1), integer (major type 0) or CBOR signed integer (major type 1),
depending on the actual value. Enumeration values are either depending on the actual value. Enumeration values are either
explicitly assigned using the YANG statement 'value' or automatically explicitly assigned using the YANG statement 'value' or automatically
assigned based on the algorithm defined in assigned based on the algorithm defined in
[I-D.ietf-netmod-rfc6020bis] section 9.6.4.2. [I-D.ietf-netmod-rfc6020bis] section 9.6.4.2.
Definition example [RFC7317]: The following example shows the encoding of leaf 'oper-status' set to
'testing'.
Definition example from [RFC7317]:
leaf oper-status { leaf oper-status {
type enumeration { type enumeration {
enum up { value 1; } enum up { value 1; }
enum down { value 2; } enum down { value 2; }
enum testing { value 3; } enum testing { value 3; }
enum unknown { value 4; } enum unknown { value 4; }
enum dormant { value 5; } enum dormant { value 5; }
enum not-present { value 6; } enum not-present { value 6; }
enum lower-layer-down { value 7; } enum lower-layer-down { value 7; }
} }
} }
CBOR diagnostic notation: 3
CBOR diagnostic notation: 3 (Represents enumeration value 'testing')
CBOR encoding: 03 CBOR encoding: 03
5.7. The 'bits' Type 5.7. The 'bits' Type
Leafs of type bits MUST be encoded using a CBOR byte string data item Leafs of type bits MUST be encoded using a CBOR byte string data item
(major type 2). Bits position are either explicitly assigned using (major type 2). Bits position are either explicitly assigned using
the YANG statement 'position' or automatically assigned based on the the YANG statement 'position' or automatically assigned based on the
algorithm defined in [I-D.ietf-netmod-rfc6020bis] section 9.7.4.2. algorithm defined in [I-D.ietf-netmod-rfc6020bis] section 9.7.4.2.
Bits position 0 to 7 are assigned to the first byte within the byte Bits position 0 to 7 are assigned to the first byte within the byte
string, bits 8 to 15 to the second byte, and subsequent bytes are string, bits 8 to 15 to the second byte, and subsequent bytes are
assigned similarly. Within each byte, bits are assigned from least assigned similarly. Within each byte, bits are assigned from least
to most significant. to most significant.
Definition example [I-D.ietf-netmod-rfc6020bis]: The following example shows the encoding of leaf 'mybits' with the
'disable-nagle' and '10-Mb-only' flags set.
Definition example from [I-D.ietf-netmod-rfc6020bis]:
leaf mybits { leaf mybits {
type bits { type bits {
bit disable-nagle { bit disable-nagle {
position 0; position 0;
} }
bit auto-sense-speed { bit auto-sense-speed {
position 1; position 1;
} }
bit 10-Mb-only { bit 10-Mb-only {
position 2; position 2;
} }
} }
} }
CBOR diagnostic notation: h'05' (Represents bits disable-nagle and CBOR diagnostic notation: h'05'
10-Mb-only set)
CBOR encoding: 41 05 CBOR encoding: 41 05
5.8. The 'binary' Type 5.8. The 'binary' Type
Leafs of type binary MUST be encoded using a CBOR byte string data Leafs of type binary MUST be encoded using a CBOR byte string data
item (major type 2). item (major type 2).
The following example shows the encoding of leaf 'aes128-key' set to
0x1f1ce6a3f42660d888d92a4d8030476e.
Definition example: Definition example:
leaf aes128-key { leaf aes128-key {
type binary { type binary {
length 16; length 16;
} }
} }
CBOR diagnostic notation: h'1f1ce6a3f42660d888d92a4d8030476e' CBOR diagnostic notation: h'1f1ce6a3f42660d888d92a4d8030476e'
CBOR encoding: 50 1f1ce6a3f42660d888d92a4d8030476e CBOR encoding: 50 1f1ce6a3f42660d888d92a4d8030476e
5.9. The 'leafref' Type 5.9. The 'leafref' Type
Leafs of type leafref MUST be encoded using the rules of the schema Leafs of type leafref MUST be encoded using the rules of the schema
node referenced by the 'path' YANG statement. node referenced by the 'path' YANG statement.
Definition example [RFC7223]: The following example shows the encoding of leaf 'interface-state-
ref' set to the value "eth1".
Definition example from [RFC7223]:
typedef interface-state-ref { typedef interface-state-ref {
type leafref { type leafref {
path "/interfaces-state/interface/name"; path "/interfaces-state/interface/name";
} }
} }
container interfaces-state { container interfaces-state {
list interface { list interface {
key "name"; key "name";
skipping to change at page 21, line 40 skipping to change at page 20, line 5
CBOR diagnostic notation: "eth1" CBOR diagnostic notation: "eth1"
CBOR encoding: 64 65746831 CBOR encoding: 64 65746831
5.10. The 'identityref' Type 5.10. The 'identityref' Type
This specification supports two approaches for encoding identityref, This specification supports two approaches for encoding identityref,
a SID as defined in [I-D.somaraju-core-sid] or a name as defined in a SID as defined in [I-D.somaraju-core-sid] or a name as defined in
[I-D.ietf-netmod-yang-json] section 6.8. [I-D.ietf-netmod-yang-json] section 6.8.
*SIDs as identityref* 5.10.1. SIDs as identityref
SIDs are globally unique and can be used as identityref. This SIDs are globally unique and may be used as identityref. This
approach is both compact and simple to implement. When SIDs are approach is both compact and simple to implement. When SIDs are
used, identityref MUST be encoded using a CBOR unsigned integer data used, identityref MUST be encoded using a CBOR unsigned integer data
item (major type 0) or CBOR signed integer (major type 1), depending item (major type 0) and set to a SID allocated from a registered SID
on the actual value. The value represents the delta between the SID range.
of the identity assigned to the leaf and the SID of the base identity
defined for this leaf.
*Name as identityref* The following example shows the encoding of leaf 'type' set to the
Alternatively, an identityref may be encoded using a name as defined value 'iana-if-type:ethernetCsmacd' (SID 1180).
in [I-D.ietf-netmod-yang-json] section 6.8. When names are used,
identityref MUST be encoded using a CBOR text string data item (major
type 3). If the identity is defined in another module than the leaf
node containing the identityref value, the namespace-qualified form
MUST be used. Otherwise, both the simple and namespace-qualified
forms are permitted.
Definition example [RFC7317]: Definition example from [RFC7317]:
identity radius-authentication-type { identity interface-type {
description
"Base identity for RADIUS authentication types.";
} }
identity radius-chap { identity iana-interface-type {
base radius-authentication-type; base interface-type;
} }
identity radius-pap { identity ethernetCsmacd {
base radius-authentication-type; base iana-interface-type;
} }
leaf authentication-type { leaf type {
type identityref { type identityref {
base radius-authentication-type; base interface-type;
} }
} }
*SIDs as identityref* CBOR diagnostic notation: 1180
This example represents the encoding of identity "radius-pap" (SID CBOR encoding: 19 049c
1705) assuming the base identity "radius-authentication-type" (SID
1703).
CBOR diagnostic notation: 2 5.10.2. Name as identityref
CBOR encoding: 02 Alternatively, an identityref may be encoded using a name as defined
in [I-D.ietf-netmod-yang-json] section 6.8. When names are used,
identityref MUST be encoded using a CBOR text string data item (major
type 3). If the identity is defined in another module than the leaf
node containing the identityref value, the namespace-qualified form
MUST be used. Otherwise, both the simple and namespace-qualified
forms are permitted. Names and namespaces are defined in
[I-D.ietf-netmod-yang-json] section 4.
*Name as identityref* The following example shows the encoding of the identity 'iana-if-
type:ethernetCsmacd' using its name. This example is described in
Section 5.10.1.
CBOR diagnostic notation: "ietf-system:radius-pap" CBOR diagnostic notation: "iana-if-type:ethernetCsmacd"
CBOR encoding: 76 696574662d73797374656d3a7261646975732d706170 CBOR encoding: 78 1b
69616e612d69662d747970653a65746865726e657443736d616364
5.11. The 'empty' Type 5.11. The 'empty' Type
Leafs of type empty MUST be encoded using the CBOR null value (major Leafs of type empty MUST be encoded using the CBOR null value (major
type 7, additional information 22). type 7, additional information 22).
Definition example [RFC7277]: The following example shows the encoding of leaf 'is-router' when
present.
Definition example from [RFC7277]:
leaf is-router { leaf is-router {
type empty; type empty;
} }
CBOR diagnostic notation: null CBOR diagnostic notation: null
CBOR encoding: f6 CBOR encoding: f6
5.12. The 'union' Type 5.12. The 'union' Type
skipping to change at page 23, line 42 skipping to change at page 21, line 50
o identityref o identityref
o instance-identifier o instance-identifier
o leafref (Only when the datatype of the leaf referenced using the o leafref (Only when the datatype of the leaf referenced using the
'path' YANG statement require a CBOR tag) 'path' YANG statement require a CBOR tag)
See Section 7.1 for more information about these CBOR tags. See Section 7.1 for more information about these CBOR tags.
Definition example [RFC7317]: The following example shows the encoding of leaf 'ip-address' when
set to "2001:db8:a0b:12f0::1".
Definition example from [RFC7317]:
typedef ipv4-address { typedef ipv4-address {
type string { type string {
pattern '(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3} pattern '(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}
([0-9][1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N} ([0-9][1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}
\p{L}]+)?'; \p{L}]+)?';
} }
} }
typedef ipv6-address { typedef ipv6-address {
skipping to change at page 24, line 41 skipping to change at page 22, line 43
leaf address { leaf address {
type inet:ip-address; type inet:ip-address;
} }
CBOR diagnostic notation: "2001:db8:a0b:12f0::1" CBOR diagnostic notation: "2001:db8:a0b:12f0::1"
CBOR encoding: 74 323030313a6462383a6130623a313266303a3a31 CBOR encoding: 74 323030313a6462383a6130623a313266303a3a31
5.13. The 'instance-identifier' Type 5.13. The 'instance-identifier' Type
This specification supports three approaches for encoding an This specification supports two approaches for encoding an instance-
instance-identifier, one based on SIDs as defined in identifier, one based on SIDs as defined in [I-D.somaraju-core-sid]
[I-D.somaraju-core-sid], one based on names as defined in and one based on names as defined in [I-D.ietf-netmod-yang-json]
[I-D.ietf-netmod-yang-json] section 6.13 and one based on YANG hashes section 6.13.
as defined in [I-D.vanderstok-core-comi].
*SIDs as instance-identifier* 5.13.1. SIDs as instance-identifier
SIDs uniquely identify a data node. For a single instance data node, SIDs uniquely identify a data node. For a single instance data node,
the SID is sufficient to identify this instance. For a multi- the SID is sufficient to identify this instance. For a multi-
instance data node, a SID is combined with the list key(s) to instance data node, a SID is combined with the list key(s) to
identify each instance of this data node within the YANG list(s). identify each instance of this data node within the YANG list(s).
Single instance data nodes MUST be encoded using a CBOR unsigned Single instance data nodes MUST be encoded using a CBOR unsigned
integer data item (major type 0) and set to the targeted data node integer data item (major type 0) and set to the targeted data node
SID. SID.
skipping to change at page 25, line 21 skipping to change at page 23, line 23
o The first entry MUST be encoded as a CBOR unsigned integer data o The first entry MUST be encoded as a CBOR unsigned integer data
item (major type 0) and set to the targeted data node SID. item (major type 0) and set to the targeted data node SID.
o The following entries MUST contain the value of each key required o The following entries MUST contain the value of each key required
to identify the instance of the targeted data node. These keys to identify the instance of the targeted data node. These keys
MUST be ordered as defined in the 'key' YANG statement, starting MUST be ordered as defined in the 'key' YANG statement, starting
from top level list, and follow by each of the subordinate from top level list, and follow by each of the subordinate
list(s). list(s).
*Names as instance-identifier* *First example:*
The use of names as instance-identifier is defined in
[I-D.ietf-netmod-yang-json] section 6.11. The resulting xpath MUST
be encoded using a CBOR text string data item (major type 3).
*YANG hashes as instance-identifier*
When YANG hashes are used, xpath can be compressed based on the The following example shows the encoding of a leaf of type instance-
method defined by [I-D.vanderstok-core-comi] sections 4.1.4.1 and identifier which identify the data node "/system/contact" (SID 1737).
4.1.4.2. The resulting hash MUST be encoded using a CBOR byte string
data item (major type 2).
Definition example [RFC7317]: Definition example from [RFC7317]:
container system { container system {
leaf contact { leaf contact {
type string; type string;
} }
leaf hostname { leaf hostname {
type inet:domain-name; type inet:domain-name;
} }
} }
*First example based on SID* CBOR diagnostic notation: 1737
In this example, a field of type instance-identifier identifies the
data node "/system/contact" (SID 1728).
1728
CBOR encoding:
19 06c0
*First example based on name*
Same example as above based on names.
"/ietf-system:system/contact"
CBOR encoding:
78 1c 2f20696574662d73797374656d3a73797374656d2f636f6e74616374
*First example based on YANG hash*
Same example assuming data node "/system/contact" is associated to
YANG hash 0x09b06d17 or "JsG0X" in base64.
CBOR diagnostic notation:
"/JsG0X" CBOR encoding: 19 06c9
CBOR encoding: *Second example:*
66 2f4a73473058 The following example shows the encoding of a leaf of type instance-
identifier which identify the data node instance
"/system/authentication/user/authorized-key/key-data" (SID 1730) for
user name "bob" and authorized-key "admin".
Definition example [RFC7317]: Definition example from [RFC7317]:
list user { list user {
key name; key name;
leaf name { leaf name {
type string; type string;
} }
leaf password { leaf password {
type ianach:crypt-hash; type ianach:crypt-hash;
} }
skipping to change at page 27, line 29 skipping to change at page 24, line 31
type string; type string;
} }
leaf algorithm { leaf algorithm {
type string; type string;
} }
leaf key-data { leaf key-data {
type binary; type binary;
} }
} }
*Second example based on SID* CBOR diagnostic notation: [1730, "bob", "admin"]
In this example, a field of type instance-identifier identify the
data node "/system/authentication/user/authorized-key/key-data" (SID
1721) for the user name "bob" and the authorized-key name "admin".
CBOR diagnostic notation:
[1721, "bob", "admin"]
CBOR encoding: CBOR encoding:
83 # array(3) 83 # array(3)
19 06b9 # unsigned(1721) 19 06c2 # unsigned(1730)
63 # text(3) 63 # text(3)
626f62 # "bob" 626f62 # "bob"
65 # text(5) 65 # text(5)
61646d696e # "admin" 61646d696e # "admin"
*Second example based on name* *Third example:*
Same example as above based on names.
CBOR diagnostic notation: The following example shows the encoding of a leaf of type instance-
identifier which identify the list instance "/system/authentication/
user" (SID 1726) corresponding to the user name "jack".
"/ietf-system:system/authentication/user[name='bob']/authorized-key CBOR diagnostic notation: [1726, "jack"]
[name='admin']/key-data"
CBOR encoding: CBOR encoding:
78 59 82 # array(2)
2f696574662d73797374656d3a73797374656d2f61757468656e74696361 19 06be # unsigned(1726)
74696f6e2f757365725b6e616d653d27626f62275d2f617574686f72697a 64 # text(4)
65642d6b65795b6e616d653d2761646d696e275d2f6b65792d64617461 6a61636b # "jack"
*Second example based on YANG hash* 5.13.2. Names as instance-identifier
Same example assuming data node "/ietf- The use of names as instance-identifier is defined in
system:system/authentication/user/authorized-key/key-data" is [I-D.ietf-netmod-yang-json] section 6.11. The resulting xpath MUST
associated to YANG hash 0x0d6e7afb or "Nbnr7" in base64. be encoded using a CBOR text string data item (major type 3).
CBOR diagnostic notation: *First example:*
"/Nbnr7?keys=\"bob\",\"admin\"" This example is described in Section 5.13.1.
CBOR diagnostic notation: "/ietf-system:system/contact"
CBOR encoding: CBOR encoding:
78 19 2f4e626e72373f6b6579733d22626f62222c2261646d696e22 78 1c 2f20696574662d73797374656d3a73797374656d2f636f6e74616374
*Third example based on SID* *Second example:*
This third example identify an instance within the list This example is described in Section 5.13.1.
"/system/authentication/user" (SID 1717) corresponding to the user
name "jack".
CBOR diagnostic notation: CBOR diagnostic notation:
[1717, "jack"] "/ietf-system:system/authentication/user[name='bob']/authorized-key
[name='admin']/key-data"
CBOR encoding: CBOR encoding:
82 # array(2) 78 59
19 06b5 # unsigned(1717) 2f696574662d73797374656d3a73797374656d2f61757468656e74696361
64 # text(4) 74696f6e2f757365725b6e616d653d27626f62275d2f617574686f72697a
6a61636b # "jack" 65642d6b65795b6e616d653d2761646d696e275d2f6b65792d64617461
*Third example based on name* *Third example:*
Same example as above based on names. This example is described in Section 5.13.1.
CBOR diagnostic notation: CBOR diagnostic notation:
"/ietf-system:system/authentication/user[name='bob']" "/ietf-system:system/authentication/user[name='bob']"
CBOR encoding: CBOR encoding:
78 33 78 33
2f696574662d73797374656d3a73797374656d2f61757468656e74696361 2f696574662d73797374656d3a73797374656d2f61757468656e74696361
74696f6e2f757365725b6e616d653d27626f62275d 74696f6e2f757365725b6e616d653d27626f62275d
*Third example based on YANG hash*
Same example assuming data node "/ietf-system:system/authentication/
user" is associated to YANG hash 0x2677c6c1 or "md8bB" in base64.
CBOR diagnostic notation:
"/md8bB?keys=\"bob\""
CBOR encoding:
71 2f6d643862423f6b6579733d22626f6222
6. Security Considerations 6. Security Considerations
The security considerations of [RFC7049] and The security considerations of [RFC7049] and
[I-D.ietf-netmod-rfc6020bis] apply. [I-D.ietf-netmod-rfc6020bis] apply.
This document defines an alternative encoding for data modeled in the This document defines an alternative encoding for data modeled in the
YANG data modeling language. As such, this encoding does not YANG data modeling language. As such, this encoding does not
contribute any new security issues in addition of those identified contribute any new security issues in addition of those identified
for the specific protocol or context for which it is used. for the specific protocol or context for which it is used.
 End of changes. 111 change blocks. 
370 lines changed or deleted 269 lines changed or added

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