Networklpwan Working Group A. Minaburo Internet-Draft Acklio Intended status:InformationalStandards Track L. Toutain Expires:October 23, 2019July 26, 2020 Institut MINESTELECOM ;TELECOM; IMT AtlantiqueApril 21, 2019January 23, 2020 Data Model for Static Context Header Compression (SCHC)draft-ietf-lpwan-schc-yang-data-model-00draft-ietf-lpwan-schc-yang-data-model-01 Abstract This document describes a YANG data model for the SCHC (Static Context HeaderCompression). A generic module is defined, that can be applied for any headersCompression) compression andalso a specific model for the IPv6 UDP protocol stack is also proposed. Note that this draft is a first attempt to define a YANG data module for SCHC, more work is needed to use all the YANG facilities.fragmentation rules. Status of This Memo This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet- Drafts is at https://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." This Internet-Draft will expire onOctober 23, 2019.July 26, 2020. Copyright Notice Copyright (c)20192020 IETF Trust and the persons identified as the document authors. All rights reserved. This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 2. SCHC[I-D.ietf-lpwan-ipv6-static-context-hc] definesrules . . . . . . . . . . . . . . . . . . . . . . . . . 2 2.1. Compression Rules . . . . . . . . . . . . . . . . . . . . 3 2.2. Field Identifier . . . . . . . . . . . . . . . . . . . . 4 2.3. Field length . . . . . . . . . . . . . . . . . . . . . . 6 2.4. Field position . . . . . . . . . . . . . . . . . . . . . 7 2.5. Direction Indicator . . . . . . . . . . . . . . . . . . . 7 2.6. Target Value . . . . . . . . . . . . . . . . . . . . . . 8 2.7. Matching Operator . . . . . . . . . . . . . . . . . . . . 9 2.7.1. Matching Operator arguments . . . . . . . . . . . . . 10 2.8. Compression Decompresison Actions . . . . . . . . . . . . 10 2.8.1. Compression Decompression Action arguments . . . . . 12 3. Rule definition . . . . . . . . . . . . . . . . . . . . . . . 12 3.1. Compression rule . . . . . . . . . . . . . . . . . . . . 14 3.1.1. Compression context representation. . . . . . . . . . 14 3.1.2. Rule definition . . . . . . . . . . . . . . . . . . . 16 3.2. Fragmentation rule . . . . . . . . . . . . . . . . . . . 16 3.3. YANG Tree . . . . . . . . . . . . . . . . . . . . . . . . 17 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 17 5. Security considerations . . . . . . . . . . . . . . . . . . . 17 6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 18 7. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 18 8. Normative References . . . . . . . . . . . . . . . . . . . . 18 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 18 1. Introduction 2. SCHC rules SCHC is a compressiontechniqueand fragmentation mechanism forLPWANconstrained networks defined in [I-D.ietf-lpwan-ipv6-static-context-hc] it is based on a staticcontext. Thecontextcontains a listshared by two entities at the boundary this contrained network. Draft [I-D.ietf-lpwan-ipv6-static-context-hc] provides an abstract representation of the rules(cf. Figure 1). Each rule contains itself a listused either for compression/decompression (or C/D) or fragmentation/reassembly (or F/ R). The goal offield descriptions composedthis document is to formalize the description of the rules to offer: o universal representation of the rule to allow the same rule represention on both ends. For instance; afield identifier (FID),device can provide the rule it uses to store them in the core SCHC C/D and F/R. o afield length (FID),device or the core SCHC instance may update the other end to set upsome specific values (e.g. IPv6 prefix, Destination address,...) o ... This document defines afield position (FP),YANG module to represent both compression and fragmentation rules, which leads to common representation and values for the elements of the rules. SCHC compression is generic, the main mechanism do no refers to a specific fields. A field is abstractedh through an ID, a position, a direction(DI),and atargetvalue(TV),that can be amatching operator (MO)numerical value or a string. [I-D.ietf-lpwan-ipv6-static-context-hc] and [I-D.ietf-lpwan-coap-static-context-hc] specifies fields for IPv6, UDP, CoAP and OSCORE. Fragmentation requires aCompression/ Decompression Action (CDA).set of common parameters that are included in a rule. 2.1. Compression Rules [I-D.ietf-lpwan-ipv6-static-context-hc] proposes an abstract representation of the compression rule. A compression context for a device is composed of a set of rules. Each rule contains information to describe a specific field in the header to be compressed. +-----------------------------------------------------------------+ | Rule N | +-----------------------------------------------------------------+| | Rule i || +-----------------------------------------------------------------+|| | (FID) Rule 1 ||| |+-------+--+--+--+------------+-----------------+---------------+||| ||Field 1|FL|FP|DI|Target Value|Matching Operator|Comp/Decomp Act|||| |+-------+--+--+--+------------+-----------------+---------------+||| ||Field 2|FL|FP|DI|Target Value|Matching Operator|Comp/Decomp Act|||| |+-------+--+--+--+------------+-----------------+---------------+||| ||... |..|..|..| ... | ... | ... |||| |+-------+--+--+--+------------+-----------------+---------------+||/ ||Field N|FL|FP|DI|Target Value|Matching Operator|Comp/Decomp Act||| |+-------+--+--+--+------------+-----------------+---------------+|/ | | \-----------------------------------------------------------------/ Figure 1: Compression Decompression ContextThe goal2.2. Field Identifier In the process ofthis document iscompression, the headers of the original packet are first parsed toprovide an YANG data modelcreate a list of fields. This list of fields is matched again the rules torepresent SCHC Compressionfind the appropriate one andFragmentation rules, to allow management over a LPWAN network.apply compression. Themain constraints are: o sincelink between thedevice maylist given by the parsed fields and the rules is doen through a field ID. [I-D.ietf-lpwan-ipv6-static-context-hc] do not state how the field ID value can bemanagedconstructed. In the given example, it was given through a string indexed by theLPWAN network, management messages mustprotocol name (e.g. IPv6.version, CoAP.version,...). Using the YANG model, each field can becompact. COREconf offersidentified through arepresentation based on CBOR. o this data modelglobal YANG identityref. A YANG field ID derives from the field-id-base- type. Figure 2 gives some field ID definitions. Note that some field IDs can beextendedsplitted is smaller pieces. This is the case for "fid-ipv6-trafficclass-ds" and "fid-ipv6-trafficclass-ecn" which are a subset of "fid-ipv6-trafficclass-ds". identity field-id-base-type { description "Field ID withnew values, such as newSID"; } identity fid-ipv6-version { base field-id-base-type; description "IPv6 version fieldid, new MO or CDA. 2. YANG types 2.1. Field Identifier Thefrom RFC8200"; } identity fid-ipv6-trafficclass { base field-id-base-type; description "IPv6 Traffic Class field from RFC8200"; } identity fid-ipv6-trafficclass-ds { base field-id-base-type; description "IPv6 Traffic Class field from RFC8200, DiffServ field from RFC3168"; } identity fid-ipv6-trafficclass-ecn { base field-id-base-type; description "IPv6 Traffic Class field from RFC8200, ECN field from RFC3168"; } ... identity fid-coap-option-if-match { base field-id-base-type; description "CoAP option If-Match from RFC 7252"; } identity fid-coap-option-uri-host { base field-id-base-type; description "CoAP option URI-Host from RFC 7252"; } ... Figure 2: Definition of indentityref for field IDs Figure 2 gives an example of fieldidentifierID identityref definitions. The base identity isused to identify a specific field. Itfield-id-base-type, and field id are derived for it. The naming convention isviewed as an uint32. 2.2. Target Value"fid" followed by the protocol name and the fieldA value may bename. The yang model in annex gives the full definition of the field ID for [I-D.ietf-lpwan-ipv6-static-context-hc] and [I-D.ietf-lpwan-coap-static-context-hc]. The type associated to this identity is field-id-type (cf. {{Fig-field-id-type}}) typedef field-id-type { description "Field ID generic type."; type identityref { base field-id-base-type; } } Figure 3: Definition of indentityref foreachfield IDs 2.3. Field length Field length is either an integer giving the size of a field in bits or arule. The value's type depends onfunction. [I-D.ietf-lpwan-ipv6-static-context-hc] defines the "var" function which allows variable length fields in byte and [I-D.ietf-lpwan-coap-static-context-hc] defines the "tkl" function for managing the CoAP Token length field.Itidentity field-length-base-type { description "used to extend field length functions"; } identity fl-variable { base field-length-base-type; description "residue length in Byte is sent"; } identity fl-token-length { base field-length-base-type; description "residue length in Byte is sent"; } Figure 4: Definition of indetntyref for field IDs As for field ID, field length function can bean integer, a prefix,defined as astring, or any otheridentityref as shown in Figure 4. Therefore the typecarried byfor field length is a union between an integer giving in bits thefield. The LPWA-types regroups allsize of thepossibles values.length and the identityref (cf. Figure2 gives its definition.5). typedeflpwan-typesfield-length-type { type union { typeuint8; type uint16; type uint32; type uint64; type inet:ipv6-prefix;int64; /* positive length */ typestring;identityref { /* function */ base field-length-base-type; } } } Figure2: Value types Note that5: Definition of indetntyref for field IDs The naming convention is fl followed by the function name as defined in[I-D.ietf-lpwan-ipv6-static-context-hc], Dev and App Prefixes can beSCHC specifications. 2.4. Field position Field position is a positive integer which gives the position oftype inet:ipv6-prefix-type, but this type derives from ASCII characters,abinary representation such as uint64 will be more compact. 2.3. Matching Operators A matching operator is used to checkfield, thefielddefault valuestored inis 1, but if therule againstfield is repeated several times, the valuecontained in the header field. If thereisno matchinghigher. value 0 indicates that theruleposition is notselected. Two instances of matching operator are defined to allowimportant and is not taken into account during the rule selectionfrom informations contained either in the compressed header or the uncompressed header.process. Field position is a positive integer. TheSCHC document [I-D.ietf-lpwan-ipv6-static-context-hc] defines four operators: o equal:type is an uint8. 2.5. Direction Indicator Therule's value must be equalDirection Indicator (DI) is used tothe packet header value fortell if aspecific field. o ignore: There is no checkfield appears in both direction (Bi) or only uplink (Up) or Downlink (Dw). identity direction-indicator-base-type { description "used to extend field length functions"; } identity di-bidirectional { base direction-indicator-base-type; description "Direction Indication of bi directionality"; } identity di-up { base direction-indicator-base-type; description "Direction Indication of upstream"; } identity di-down { base direction-indicator-base-type; description "Direction Indication of downstream"; } Figure 6: Definition of identityref forthis field. o MSB(x): This operator comparedirection indicators Figure 6 gives themost significant bits.identityref for Direction Indicators. Theoperator takes one argument representing the lengthtype is "direction-indicator-type" (cf. Figure 7). typedef direction-indicator-type { type identityref { base direction-indicator-base-type; } } Figure 7: Definition ofleast significant bit part, which willidentityref for direction indicators 2.6. Target Value Target Value may beignored during the matching but sent ifeither a string or binary sequence. For match- mapping, several of these values can be contained in a Target Value field. In therule matches. o match-mapping: Fromdata model, this is generalized by adding a position, which orders the list ofvaluesvalues. By default the position is set to 0. The leaf "value" is not mandatory to represent a non existing value in a TV. grouping target-values-struct { leaf value { type union { type binary; type string; } } leaf position { type uint16; } } Figure 8: Definition of target value Figure 8 gives the definition of a single element of a TargetValue, This operatorValue. In the rule, this willmatch if one of those valuesbe used as a list, with position as a key. 2.7. Matching Operator Matching Operator (MO) isequal to thea function applied between a field valueand will sendprovided by theindex ofparsed header and thelist representing thistarget value./**********************************/ /*[I-D.ietf-lpwan-ipv6-static-context-hc] defines 4 MO. identity matching-operator-base-type { description "used to extend Matching Operators with SID values"; } identity mo-equal { base matching-operator-base-type; description "SCHC draft"; } identity mo-ignore { base matching-operator-base-type; description "SCHC draft"; } identity mo-msb { base matching-operator-base-type; description "SCHC draft"; } identity mo-matching { base matching-operator-base-type; description "SCHC draft"; } Figure 9: Definition of MatchingoperatorOperator identity the type*/ /**********************************/is "matching-operator-type" (cf. Figure 10) typedef matching-operator-type { typeenumerationidentityref {enum equal; enum ignore; enum msb; enum match-mapping;base matching-operator-base-type; } } Figure3: Matching operators Figure 3 represents the10: Definition of Matching Operator typedefinition. 2.4. Compression Decompression Actions The SCHC document [I-D.ietf-lpwan-ipv6-static-context-hc] defines2.7.1. Matching Operator arguments Some Matching Operator such as MSB can take somecompression decompression actions (CDA). The CDA tells how to compress and decompressvalues. Even if currently LSB is thefield. They are definedonly MO takes only one argument, inFigure 4. they are codedthesame wayfuture some MO may require several arguments. They are viewed asMO. /***********************************************/ /* Compression-Decompression actiona list of target-values-type. 2.8. Compression Decompresison Actions Compresion Decompression Action (CDA) idenfied the function to use either for compression or decompression. [I-D.ietf-lpwan-ipv6-static-context-hc] defines 6 CDA. identity compression-decompression-action-base-type; identity cda-not-sent { base compression-decompression-action-base-type; description "from SCHC draft"; } identity cda-value-sent { base compression-decompression-action-base-type; description "from SCHC draft"; } identity cda-lsb { base compression-decompression-action-base-type; description "from SCHC draft"; } identity cda-mapping-sent { base compression-decompression-action-base-type; description "from SCHC draft"; } identity cda-compute-length { base compression-decompression-action-base-type; description "from SCHC draft"; } identity cda-compute-checksum { base compression-decompression-action-base-type; description "from SCHC draft"; } identity cda-deviid { base compression-decompression-action-base-type; description "from SCHC draft"; } identity cda-appiid { base compression-decompression-action-base-type; description "from SCHC draft"; } Figure 11: Definition of Compresion Decompression Action identity The type*/ /***********************************************/is "comp-decomp-action-type" (cf. Figure 12) typedefcompression-decompression-action-typecomp-decomp-action-type { typeenumerationidentityref {enum not-sent; enum value-sent; enum lsb; enum mapping-sent; enum compute-length; enum compute-checksum; enum esiid-did; enum laiid-did;base compression-decompression-action-base-type; } } Figure4:12: Definition of Compresion Decompression Action type 2.8.1. Compression Decompression Actionfunctionsarguments Currently no CDA requires argumetns, but the future some CDA may require several arguments. They are viewed as a list of target- values-type. 3.Generic ruleRule definitionEach rule's rowA rule isdefinedeither a C/D or an F/R rule. A rule is identified byseveral leaves,the rule ID value and its associated length. The YANG grouping rule-id- type defines the structure used to represent a rule ID. Length of 0 is allowed to represent an implicit rule. // Define rule ID. Rule ID is composedof: oof afield key which willRuleID value and a Rule ID Length grouping rule-id-type { leaf rule-id { type uint32; description "rule ID value, this value must be unique combined with the length"; } leaf rule-length { type uint8 { range 0..32; } description "rule ID length in bits, value 0 is for implicit rules"; } } // SCHC table for a specific device. container schc { leaf version{ type uint64; mandatory false; description "used as an indication for versioning"; } list rule { key "rule-id rule-length"; uses rule-id-type; choice nature { case fragmentation { uses fragmentation-content; } case compression { uses compression-content; } } } } Figure 13: Definition of a SCHC Context To access to a specfic rule, rule-id and its specific length is used as akey, okey. The rule is either afield name thatcompression or a fragmentation rule. Each context can beused for debugging purpose, oidentify though afield length that containing the lengthversion id. 3.1. Compression rule A compression rule is composed of entries describing its processing (cf. Figure 14). An entry contains all thefield, o a field position that givesinformation defined in Figure 1 with thenumber of instances, otypes defined above. 3.1.1. Compression context representation. The compression rule described Figure 1 is associated to afield direction indicatesrule ID. The compression rule entry is defined in Figure 14. Each column in thepacket direction, otable is either represented by afield target value containing the valueleaf or a list. Note thatwill be compared, oMatching Operators and Compression Decompression actions can have arguments. They are viewed amatching operators for rule selection o an compression/decompression action to compress/decompress the field. Figure 5 defines the format.ordered list of strings and numbers as in target values. groupingrule-entrycompression-rule-entry { leaf field-id { mandatory true; typeint32; description "Field ID unique value representing the Field";schc-id:field-id-type; } leaf field-length { mandatory true; typeuint8; description "size in bits of the field";schc-id:field-length-type; } leaf field-position { mandatory true; type uint8;description "For repeated fields, we need to be able to distinguish between successive occurences";} leafdirectiondirection-indicator { mandatory true; typedirection-type;schc-id:direction-indicator-type; } list target-values { keytv-key; leaf tv-key { type int8;position; uses target-values-struct; } leaftarget-valuemo { mandatory true; typelpwan-types;schc-id:matching-operator-type; }description "Target Values can be// /!\ Not always good, it allows to give several arguments to alist of value, for match-mapping. For otherMO, but // theses arguments are onlyone entry is specified"; } leaf matching-operatorint or strings, cannot be arrays. Is it necessary? list mo-value {type matching-operator-type;key position; uses target-values-struct; } leafmatching-operator-parametercda { mandatory true; typelpwan-types; description "If the matching operator requires a parameter (for example lsb or msb), the value is provided here.";schc-id:cda-type; }leaf compression-decompression-actionlist cda-value {type compression-decompression-action-type;key position; uses target-values-struct; }leaf compression-decompression-action-parameter { type lpwan-types; description "If the matching operator requires} Figure 14: Definition of aparameter (for example lsb or msb), the valuecompression entry 3.1.2. Rule definition A compression rule isprovided here.";a list of entries. grouping compression-content { list entry { key "field-id field-position direction-indicator"; // field-position direction-indicator"; uses compression-rule-entry; } } Figure5: Action functions 4. YANG static context model This lead to the generic15: Definition of a compression ruledefinition, represented Figure 7. It definesTo identify aset of rules.specific entry Field ID, position and direction is needed. 3.2. Fragmentation rule TBD groupingcompression-rulefragmentation-content { leafrule-iddtagsize { type uint8;description "The number of the context rule that should be applied.";} leafrule-id-lengthwsize { type uint8; }list rule-fieldsleaf fcnsize {key "field-id field-position direction"; uses rule-entry;type uint8; } choice mode { case no-ack; case ack-always; case ack-on-error { leaf ack-method { type enumeration { enum afterAll0; enum afterAll1; enum always; } } } } } Figure6: YANG definition16: Definition ofthe generic modulea fragmentation rule 3.3. YANG Tree module:ietf-lpwan-schc-ruleschc +--rw schc +--rw version? uint64 +--rw rule* [rule-id rule-length] +--rw rule-id uint32 +--rwrule-id?rule-length uint8 +--rwrule-id-length?(nature)? +--:(fragmentation) | +--rw dtagsize? uint8 | +--rw wsize? uint8 | +--rwrule-fields*fcnsize? uint8 | +--rw (mode)? | +--:(no-ack) | +--:(ack-always) | +--:(ack-on-error) | +--rw ack-method? enumeration +--:(compression) +--rw entry* [field-id field-positiondirection]direction-indicator] +--rw field-idint32schc-id:field-id-type +--rwfield-length? uint8field-length schc-id:field-length-type +--rw field-position uint8 +--rwdirection direction-typedirection-indicator schc-id:direction-indicator-type +--rw target-values*[tv-key][position] | +--rwtv-key int8value? union | +--rwtarget-value? lpwan-typesposition uint16 +--rwmatching-operator? m.-o.-typemo schc-id:matching-operator-type +--rwmatching-operator-parameter? lpwan-typesmo-value* [position] | +--rwcompression-decompression-action? c.-d.-a.-typevalue? union | +--rwcompression-decompression-action-parameter? lpwan-types Figure 7: Generic module tree The YANG tree is given Figure 7. SID Assigned to --------- -------------------------------------------------- 60000 node /rule-fields 60001 node /rule-fields/compression-decompression-action 60002 node /rule-fields/compression-decompression-action-parameter 60003 node /rule-fields/direction 60004 node /rule-fields/field-id 60005 node /rule-fields/field-length 60006 node /rule-fields/field-position 60007 node /rule-fields/matching-operator 60008 node /rule-fields/matching-operator-parameter 60009 node /rule-fields/target-values 60010 node /rule-fields/target-values/target-value 60011 node /rule-fields/target-values/tv-key 60012 node /rule-id 60013 node /rule-id-length File ietf-lpwan-schc-rule@2016-10-31.sid created Number of SIDs available : 100 Number of SIDs assigned : 14 Figure 8: Example of SID allocationposition uint16 +--rw cda schc-id:comp-decomp-action-type +--rw cda-value* [position] +--rw value? union +--rw position uint16 Figure8 gives a simple allocation for SID value. SID values from 100 to 113 are used for /generic-rules/context-rules/rule-fields/ field-compression-decompression-action. SID value from 100917 4. IANA Considerations This document has no request to1012 are used in /generic-rules/context-rules/rule-fields/field-matching- operator.IANA. 5.AcknowledgementSecurity considerations This document does not have any more Security consideration than the ones already raised on [I-D.ietf-lpwan-ipv6-static-context-hc] 6. Acknowledgements The authors would like to thankMichel Veillette,Dominique Barthel, Carsten Bormann, AlexanderPelov, Antoni Markovski for their help on COMI/CoOL and YANG. 6.Pelov. 7. YANG Module 8. Normative References[I-D.ietf-core-comi] Veillette, M., Stok, P., Pelov,[I-D.ietf-lpwan-coap-static-context-hc] Minaburo, A., Toutain, L., andA. Bierman, "CoAP Management Interface", draft-ietf-core-comi-04R. Andreasen, "LPWAN Static Context Header Compression (SCHC) for CoAP", draft-ietf- lpwan-coap-static-context-hc-12 (work in progress),November 2018.December 2019. [I-D.ietf-lpwan-ipv6-static-context-hc] Minaburo, A., Toutain, L., Gomez, C., Barthel, D., and J. Zuniga,"LPWAN Static"Static Context Header Compression (SCHC) and fragmentation forIPv6 and UDP", draft-ietf-lpwan- ipv6-static-context-hc-18LPWAN, application to UDP/IPv6", draft- ietf-lpwan-ipv6-static-context-hc-24 (work in progress), December2018.2019. [RFC7252] Shelby, Z., Hartke, K., and C. Bormann, "The Constrained Application Protocol (CoAP)", RFC 7252, DOI 10.17487/RFC7252, June 2014, <https://www.rfc-editor.org/info/rfc7252>. Authors' Addresses Ana Minaburo Acklio 1137AAvenueavenue des Champs Blancs 35510 Cesson-Sevigne Cedex France Email: ana@ackl.io Laurent Toutain Institut MINESTELECOM ;TELECOM; IMT Atlantique 2 rue de la Chataigneraie CS 17607 35576 Cesson-Sevigne Cedex France Email: Laurent.Toutain@imt-atlantique.fr