| Internet-Draft | anydata validation | March 2024 |
| Elhassany | Expires 18 September 2024 | [Page] |
This document describes a method to use YANG Library [RFC8525] to validate YANG data nodes that are children of an "anydata" data node.¶
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 on 18 September 2024.¶
Copyright (c) 2024 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 Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
YANG [RFC7950] defines the "anydata" statement to represent an unknown set of YANG nodes for which the data model is not known at module design time. However, YANG [RFC7950] left the verification of the "anydata" tree open to be done using external means. Several IETF models, e.g., [RFC8526], [RFC9144], [RFC8639], [RFC8641], and [RFC8040], use "anydata" in their definitions. Current YANG implementations accept syntactically valid YANG data nodes as children of an "anydata" node but do not check the data type of these data nodes against a YANG schema. This creates a real problem for any consumer of these models when validating all leaves of the YANG data tree. For instance, a YANG-Push receiver described in [I-D.netana-nmop-yang-kafka-integration] is not able to fully validate the messages streamed by network nodes.¶
YANG Schema Mount [RFC8528] allows mounting complete data models at implementation and run time. While powerful, schema mount cannot address use cases where the user selects an arbitrary subset of an instantiated data tree, such as YANG-Push [RFC8641]. A current proposed approach, YANG Full Include YANG Full Include [I-D.jouqui-netmod-yang-full-include], complements YANG Schema Mount and applies at design time, yet cannot address dynamic filtering of an instantiated YANG data tree.¶
This document propeses using the YANG Library [RFC8525] to define the context in which anydata trees are validated. This would require the YANG tooling to implement an optional flag that enables a flag for validating "anydata" subtrees in the context of a YANG Library.¶
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 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶
This document uses the terminology defined in YANG [RFC7950] for schema node and schema tree but refines data node and data tree to be more precise.¶
The current YANG encodings, XML, JSON, and CBOR, encode instantiated data nodes with fully qualified name using the module's namespace and a local name. The module's namespace can be either explicit or assumed from a default namespace defined in the top data tree.¶
This document introduces a new YANG validation option: anydata-subtree-validation. In this mode, a YANG data parser MUST accept a YANG Library as input along the YANG data file. When this option is enabled, any instantiated data node (NodeB) that is a child of anydata node (NodeA) is accepted to be valid only if (i) the qualified name of the node NodeB is found in one of the data trees defined by the YANG library AND (ii) the instantiated data tree rooted by NodeB is valid incomplete instantiated data tree according to the data node of NodeB.¶
The first condition ensures the completeness of the YANG Library, and no subtree can be included as a child of anydata node unless a schema is defined for all the children of anydata subtree and specified in the YANG Library. The second condition applies a regular YANG validation against the subtree of anydata, considering that the subtree of anydata could be generated using an XPath [RFC8641] or a subtree filter [RFC6241]. Thus, the validator MUST consider this subtree incomplete and ignore any missing leaves.¶
This memo includes no request to IANA.¶
The authors would like to thank Jean Quilbeuf, Thomas Graf, Benoit Claise, and Alex Huang Feng for their review and valuable comments.¶