]> Telefonica

diego.r.lopez@telefonica.com

Telefonica

antonio.pastorperales@telefonica.com

INSA-Lyon

alex.huang-feng@insa-lyon.fr

Telefonica

ana.mendezperez@telefonica.com

Fraunhofer SIT

Rheinstrasse 75 Darmstadt 64295 Germany henk.birkholz@sit.fraunhofer.de

UC3M

sofia.garciarincon.practicas@telefonica.com

Operations and Management Operations and Management Area Working Group provenance signature COSE metadata This document defines a mechanism based on COSE signatures to provide and verify the provenance of YANG data, so it is possible to verify the origin and integrity of a dataset, even when those data are going to be processed and/or applied in workflows where a crypto-enabled data transport directly from the original data stream is not available. As the application of evidence-based OAM automation and the use of tools such as AI/ML grow, provenance validation becomes more relevant in all scenarios. The use of compact signatures facilitates the inclusion of provenance strings in any YANG schema requiring them. 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 Operations and Management Area Working Group Working Group mailing list (), which is archived at . Subscribe at . Source for this draft and an issue tracker can be found at .

Introduction OAM automation, generally based on closed-loop principles, requires at least two datasets to be used. Using the common terms in Control Theory, we need those from the plant (the network device or segment under control) and those to be used as reference (the desired values of the relevant data). The usual automation behavior compares these values and takes a decision, by whatever the method (algorithmic, rule-based, an AI model tuned by ML...) to decide on a control action according to this comparison. Assurance of the origin and integrity of these datasets, what we refer in this document as "provenance", becomes essential to guarantee a proper behavior of closed-loop automation. When datasets are made available as an online data flow, provenance can be assessed by properties of the data transport protocol, as long as some kind of cryptographic protocol is used for source authentication, with TLS, SSH and IPsec as the main examples. But when these datasets are stored, go through some pre-processing or aggregation stages, or even cryptographic data transport is not available, provenance must be assessed by other means. The original use case for this provenance mechanism is associated with , in order to provide a proof of the origin and integrity of the provided metadata, and therefore the examples in this document use the modules described there, but it soon became clear that it could be extended to any YANG datamodel to support provenance evidence. An analysis of other potential use cases suggested the interest of defining an independent, generally applicable mechanism. Provenance verification by signatures incorporated in YANG data can be applied to any data processing pipeline, whether they rely on an online flow or use some kind of data store, such as data lakes or time-series databases. The application of recorded data for ML training or validation constitute the most relevant examples of these scenarios. This document provides a mechanism for including digital signatures within YANG data. It applies COSE to make the signature compact and reduce the resources required for calculating it. This mechanism is applicable to any serialization of the YANG data supporting a clear method for canonicalization, but this document considers three base ones: CBOR, JSON and XML.

Conventions and Definitions 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. The term "data provenance" refers to a documented trail accounting for the origin of a piece of data and where it has moved from to where it is presently. The signature mechanism provided here can be recursively applied to allow this accounting for YANG data.

Defining Provenance Elements The provenance for a given YANG element MUST be convened by a leaf element, containing the COSE signature bitstring built according to the procedure defined below in this section. The provenance leaf MUST be of type provenance-signature, defined as follows:

Provenance Signature Strings Provenance signature strings are COSE single signature messages with [nil] payload, according to COSE conventions and registries, and with the following structure (as defined by ): The COSE_Sign1 procedure yields a bitstring when building the signature and expects a bitstring for checking it, hence the proposed type for provenance signature leaves. The structure of the COSE_Sign1 consists of:

• The algorithm-identifier, which MUST follow COSE conventions and registries.
• The kid (Key ID), to be locally agreed, used and interpreted by the signer and the signature validator. URIs and RFC822-style identifiers are typical values to be used as kid.
• The serialization-method, a string identifying the YANG serialization in use. It MUST be one of the three possible values "xml" (for XML serialization ), "json" (for JSON serialization ) or "cbor" (for CBOR serialization ).
• The value algorithm-parameters, which MUST follow the COSE conventions for providing relevant parameters to the signing algorithm.
• The signature for the YANG element provenance is being established for, to be produced and verified according to the procedure described below for each one of the enclosing methods for the provenance string described below.

Signature and Verification Procedures To keep a concise signature and avoid the need for wrapping YANG constructs in COSE envelopes, the whole signature MUST be built and verified by means of externally supplied data, as defined in , with a [nil] payload. The byte strings to be used as input to the signature and verification procedures MUST be built by:

• Selecting the exact YANG content to be used, according to the corresponding enclosing methods.
• Applying the corresponding canonicalization method as described in the following section.

Canonicalization Signature generation and verification require a canonicalization method to be applied, that depends on the serialization used. According to the three types of serialization defined, the following canonicalization methods MUST be applied:

• For CBOR, length-first core deterministic encoding, as defined by .
• For JSON, JSON Canonicalization Scheme (JCS), as defined by .
• For XML, Exclusive XML Canonicalization 1.0, as defined by .

Provenance-Signature YANG Module This module defines a provenance-signature type to be used in other YANG modules. WG List: Authors: Alex Huang Feng Diego Lopez Antonio Pastor Henk Birkholz "; description "Defines a binary provenance-signature type to be used in other YANG modules. Copyright (c) 2024 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 Revised 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 2024-02-28 { description "First revision"; reference "RFC XXXX: Applying COSE Signatures for YANG Data Provenance"; } typedef provenance-signature { type binary; description "The provenance-signature type represents a digital signature corresponding to the associated YANG element. The signature is based on COSE and generated using a canonicalized version of the associated element."; reference "RFC XXXX: Applying COSE Signatures for YANG Data Provenance"; } } ]]>

Enclosing Methods Once defined the procedures for generating and verifying the provenance signature string, let's consider how these signatures can be integrated with the associated YANG data by enclosing the signature in the data structure. This document considers four different enclosing methods, suitable for different stages of the YANG schema and usage patterns of the YANG data. The enclosing method defines not only how the provenance signature string is combined with the signed YANG data but also the specific procedure for selecting the specific YANG content to be processed when signing and verifying. Appendix A includes a set of exmaples of the different enclosing methods, applied to the same YANG fragment, to illustrate their use.

Including a Provenance Leaf in a YANG Element This enclosing method requires a specific element in the YANG schema defining the element to be signed (the enclosing element), and thus implies considering provenance signatures when creating the corresponding YANG module, or the update of existing modules willing to support this provenance enclosing method. When using this enclosing method, a provenance-signature leaf MAY appear at any position in the enclosing element, but only one such leaf MUST be defined for the enclosing element. If the enclosing element contains other non-leaf elements, they MAY provide their own provenance-signature leaf, according to the same rule. In this case, the provenance-signature leaves in the children elements are applicable to the specific child element where they are enclosed, while the provenance-signature leaf enclosed in the top-most element is applicable to the whole element contents, including the children provenance-signature leaf themselves. This allows for recursive provenance validation, data aggregation, and the application of provenance verification of relevant children elements at different stages of any data processing pipeline. The specific YANG content to be processed SHALL be generated by taking the whole enclosing element and eliminiating the leaf containing the provenance signature string. As example, let us consider the two modules proposed in . For the platform-manifest module, the provenance for a platform would be provided by the optional platform-provenance leaf shown below: For data collections, the provenance of each one would be provided by the optional collector-provenance leaf, as shown below: /p-mf:platforms/platform/id +--ro collector-provenance? provenance-signature +--ro yang-push-subscriptions +--ro subscription* [id] +--ro id | sn:subscription-id + . . . + . . . | . . . ]]> Note how, in the two examples, the element bearing the provenance signature appears at different positions in the enclosing element. And note that, for processing the element for signature generation and verification, the signature element MUST be eliminated from the enclosing element before applying the corresponding canonicalization method. Note that, in application of the recursion mechanism described above, a provenance element could be included at the top of any of the collections, supporting the verification of the provenance of the collection itself (as provided by a specific collector), without interfering with the verification of the provenance of each of the collection elements. As an example, in the case of the platform manifests it would look like: Note here that, to generate the YANG content to be processed in the case of the collection the provenance leafs of the indivual elements SHALL NOT be eliminated, as it SHALL be the case when generating the YANG content to be processed for each individual element in the collection.

Including a Provenance Signature in NETCONF Event Notifications and YANG-Push Notifications The signature mechanism proposed in this document MAY be used with NETCONF Event Notifications and YANG-Push to sign the generated notifications directly from the publisher nodes. The signature is added to the header of the Notification along with the eventTime leaf. The YANG content to be processed MUST consist of the content of the notificationContent element. The following sections define the YANG module augmenting the ietf-notification module.

YANG Tree Diagram The following is the YANG tree diagram for the ietf-notification-provenance augmentation within the ietf-notification. And the following is the full YANG tree diagram for the notification.

YANG Module The module augments ietf-notification module adding the signature leaf in the notification header. WG List: Authors: Alex Huang Feng Diego Lopez Antonio Pastor Henk Birkholz "; description "Defines a binary provenance-signature type to be used in other YANG modules. Copyright (c) 2024 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 Revised 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 2024-02-28 { description "First revision"; reference "RFC XXXX: Applying COSE Signatures for YANG Data Provenance"; } sx:augment-structure "/inotif:notification" { leaf notification-provenance { type iyangprov:provenance-signature; description "COSE signature of the content of the Notification for provenance verification."; } } } ]]>

Including Provenance as Metadata in YANG Instance Data Provenance signature strings can be included as part of the metadata in YANG instance data files, as defined in for data at rest. The augmented YANG tree diagram including the provenance signature is as follows: The provenance signature string in this enclosing method applies to whole content-data element in instance-data-set, independently of whether those data contain other provenance signature strings by applying other enclosing methods. The specific YANG content to be processed SHALL be generated by taking the contents of the content-data element and applying the corresponding canonicalization method.

YANG Module

This module defines the provenance signature element to be included as metadata of a YANG data instance.

YANG module derived from , named "ietf-yang-instance-data-provenance"

Including Provenance in YANG Annotations The use of annotations as defined in seems a natural enclosing method, dealing with the provenance signature string as metadata and not requiring modification of existing YANG schemas.The provenance-string annotation is defined as follows: The specific YANG content to be processed SHALL be generated by eliminating the provenance-string (encoded according to what is described in Section 5 of ) from the element it applies to, before invoking the corresponding canonicalization method. In application of the general recursion principle for provenance signature strings, any other provenance strings within the element to which the provenance-string applies SHALL be left as they appear, whatever the enclosing method used for them.

YANG Module This module defines a metadata annotation to include a provenance signature for a YANG element. WG List: Authors: Diego Lopez Alex Huang Feng Antonio Pastor Henk Birkholz "; description "Defines a binary provenance-signature type to be used in YANG metadata annotations Copyright (c) 2024 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 Revised 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 2024-02-28 { description "First revision"; reference "RFC XXXX: Applying COSE Signatures for YANG Data Provenance"; } md:annotation provenance-string { type yang:provenance-signature; description "This annotation contains the provenance signature for the YANG element associated with it"; } } ]]> TBD: Provide a final URL for the "ypmd" prefix.

Security Considerations The provenance assessment mechanism described in this document relies on COSE and the deterministic encoding or canonicalization procedures described by , and . The security considerations made in these references are fully applicable here. The verification step depends on the association of the kid (Key ID) with the proper public key. This is a local matter for the verifier and its specification is out of the scope of this document. The use of certificates, PKI mechanisms, or any other secure distribution of id-public key mappings is RECOMMENDED.

IANA Considerations

IETF XML Registry This document registers the following URIs in the "IETF XML Registry" :

YANG Module Name This document registers the following YANG modules in the "YANG Module Names" registry : TBD: Others? At least for the two additional enclosing methods (instance files and annotations)

Implementation Status An open-source reference implementation, written in Java, is available at https://github.com/tefiros/cose-provenance. This implementation has been used to generate the examples in the appendix of this document, and was first demonstrated at the IETF 122 Hackathon. Work is ongoing to explore its integration with other open-source YANG modules.

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. A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource. This specification defines the generic URI syntax and a process for resolving URI references that might be in relative form, along with guidelines and security considerations for the use of URIs on the Internet. The URI syntax defines a grammar that is a superset of all valid URIs, allowing an implementation to parse the common components of a URI reference without knowing the scheme-specific requirements of every possible identifier. This specification does not define a generative grammar for URIs; that task is performed by the individual specifications of each URI scheme. [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] This document specifies the Internet Message Format (IMF), a syntax for text messages that are sent between computer users, within the framework of "electronic mail" messages. This specification is a revision of Request For Comments (RFC) 2822, which itself superseded Request For Comments (RFC) 822, "Standard for the Format of ARPA Internet Text Messages", updating it to reflect current practice and incorporating incremental changes that were specified in other RFCs. [STANDARDS-TRACK] YANG is a data modeling language used to model configuration and state data manipulated by the Network Configuration Protocol (NETCONF), NETCONF remote procedure calls, and NETCONF notifications. [STANDARDS-TRACK] 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). This document defines encoding rules for representing configuration data, state data, parameters of Remote Procedure Call (RPC) operations or actions, and notifications defined using YANG as JavaScript Object Notation (JSON) text. This document defines a YANG extension that allows for defining metadata annotations in YANG modules. The document also specifies XML and JSON encoding of annotations and other rules for annotating instances of YANG data nodes. This document captures the current syntax used in YANG module tree diagrams. The purpose of this document is to provide a single location for this definition. This syntax may be updated from time to time based on the evolution of the YANG language. This document describes a mechanism that allows subscriber applications to request a continuous and customized stream of updates from a YANG datastore. Providing such visibility into updates enables new capabilities based on the remote mirroring and monitoring of configuration and operational state. Cryptographic operations like hashing and signing need the data to be expressed in an invariant format so that the operations are reliably repeatable. One way to address this is to create a canonical representation of the data. Canonicalization also permits data to be exchanged in its original form on the "wire" while cryptographic operations performed on the canonicalized counterpart of the data in the producer and consumer endpoints generate consistent results. This document describes the JSON Canonicalization Scheme (JCS). This specification defines how to create a canonical representation of JSON data by building on the strict serialization methods for JSON primitives defined by ECMAScript, constraining JSON data to the Internet JSON (I-JSON) subset, and by using deterministic property sorting. 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. Concise Binary Object Representation (CBOR) is a data format designed for small code size and small message size. There is a need to be able to define basic security services for this data format. This document defines the CBOR Object Signing and Encryption (COSE) protocol. This specification describes how to create and process signatures, message authentication codes, and encryption using CBOR for serialization. This specification additionally describes how to represent cryptographic keys using CBOR. This document, along with RFC 9053, obsoletes RFC 8152. There is a need to document data defined in YANG models at design time, implementation time, or when a live server is unavailable. This document specifies a standard file format for YANG instance data, which follows the syntax and semantics of existing YANG models and annotates it with metadata. 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). INSA-Lyon INSA-Lyon Swisscom Huawei This document defines the structure of NETCONF Event Notification in a YANG model to be used in NETCONF environments. The definition of this YANG model allows the encoding of NETCONF Event Notifications in YANG compatible encodings such as JSON and CBOR. n.d. 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 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 configuration data and state data (status information and counters for the collection of statistics). Huawei Huawei Telefonica I+D Telefonica I+D Swisscom Network platforms use Model-driven Telemetry, such as YANG-Push, to continuously stream information, including both counters and state information. This document describes the metadata that ensure that the collected data can be interpreted correctly. This document specifies the data manifest, composed of two YANG data models (the platform manifest and the data collection manifest). These YANG modules are specified at the network (e.g. controller) level to provide a model that encompasses several network platforms. The data manifest must be streamed and stored along with the data, up to the collection and analytics systems in order to keep the collected data fully exploitable by the data scientists and relevant tools. Additionally, this document proposes an augmentation of the YANG-Push model to include the actual collection period, in case it differs from the configured collection period.

Appendix A. Examples of Application of the Different Enclosing Methods

XML Let us consider the following YANG instance, corresponding to a monitoring interface statement, as defined in : GigabitEthernet1 ianaift:ethernetCsmacd up up 2024-02-03T11:22:41.081+00:00 1 0c:00:00:37:d6:00 1000000000 2024-02-03T11:20:38+00:00 8157 94 0 0 0 0 0 89363 209 0 0 0 0 ]]> Applying the first enclosing method, a provenance leaf at the top element (named "signature-string" in this case") would be included and produce the following output: 0oRRowNjeG1sBGdlYzIua2V5ASag9lhAvzyFP5HP0nONaqTRxKmSqerrDS6CQXJSK+5NdprzQZLf0QsHtAi2pxzbuDJDy9kZoy1JTvNaJmMxGTLdm4ktug== GigabitEthernet1 ianaift:ethernetCsmacd up up 2024-02-03T11:22:41.081+00:00 1 0c:00:00:37:d6:00 1000000000 2024-02-03T11:20:38+00:00 8157 94 0 0 0 0 0 89363 209 0 0 0 0 ]]> The second enclosing method would translate into a notification including the "notification-provenance" element as follows: 2024-02-03T11:37:25.94Z 0oRRowNjeG1sBGdlYzIua2V5ASag9lhADiPn3eMRclCAnMlauYyD5yKFvYeXipf4oAmQW5DUREizL59Xs5erOerbryu8vs+A8YOl8AhlAUFzvThffcKPZg== 2147483648 GigabitEthernet1 ianaift:ethernetCsmacd up up 2024-02-03T11:22:41.081+00:00 1 0c:00:00:37:d6:00 1000000000 2024-02-03T11:20:38+00:00 8157 94 0 0 0 0 0 89363 209 0 0 0 0 ]]> The third enclosing method, applicable if the instance is to be stored as YANG instance data at rest, by adding the corresponding metadata, would produce a results as shown below: atRestYANG 2024-11-03 For demos Sample for demonstrating provenance signatures diego.r.lopez@telefonica.com 0oRRowNjeG1sBGdlYzIua2V5ASag9lhAWff+fMbfNChKUYZ52UTOBmAlYPFe4vlZOLyZeW0CU7/2OutDeMCG28+m3rm58jqLjKbcueKLFq8qFJb4mvPY+Q== GigabitEthernet1 ianaift:ethernetCsmacd up up 2024-02-03T11:22:41.081+00:00 1 0c:00:00:37:d6:00 1000000000 2024-02-03T11:20:38+00:00 8157 94 0 0 0 0 0 89363 209 0 0 0 0 ]]> Finally, using the fourth enclosing method, the YANG instance would incorporate the corresponding provenance metadata as an annotation: GigabitEthernet1 ianaift:ethernetCsmacd up up 2024-02-03T11:22:41.081+00:00 1 0c:00:00:37:d6:00 1000000000 2024-02-03T11:20:38+00:00 8157 94 0 0 0 0 0 89363 209 0 0 0 0 ]]>

JSON Let us consider the following YANG instance, corresponding to the same monitoring interface statement, with JSON serialization: Applying the first enclosing method, a provenance leaf at the top element (named "provenance-string" in this case") would be included and produce the following output: The second enclosing method would translate into a notification including the "notification-provenance" element. For RESTCONF it would be as follows: And for NETCONF: The third enclosing method, applicable if the instance is to be stored as YANG instance data at rest, by adding the corresponding metadata, would produce a results as shown below: Finally, using the fourth enclosing method, the YANG instance would incorporate the corresponding provenance metadata as an annotation:

CBOR TBD, as the reference implementation evolves.

Acknowledgments This document is based on work partially funded by the EU H2020 project SPIRS (grant 952622), and the EU Horizon Europe projects PRIVATEER (grant 101096110), HORSE (grant 101096342), MARE (grant 101191436), ACROSS (grant 101097122) and CYBERNEMO (grant 101168182).