]> University of Liege

10, Allee de la decouverte (B28) 4000 Sart-Tilman Belgium justin.iurman@uliege.be

Huawei

156 Beiqing Rd. Beijing 100095 China zhoutianran@huawei.com

ops ippm OAM In Situ OAM IOAM Integrity Configuration YANG In Situ Operations, Administration, and Maintenance (IOAM) is an example of an on-path hybrid measurement method to collect operational and telemetry information. The collected data may then be exported to systems that will use it to, e.g., monitor, measure, or (re)configure the network. I-D.ietf-ippm-ioam-data-integrity (RFC Ed.: to be replaced by RFC YYYY) defines IOAM Options with integrity protection, also called Integrity Protected Options. This document defines a YANG module for the configuration of these Integrity Protected Options.

In Situ Operations, Administration, and Maintenance (IOAM) is an example of an on-path hybrid measurement method to collect operational and telemetry information. The collected data may then be exported to systems that will use it to, e.g., monitor, measure, or (re)configure the network. defines IOAM Options with integrity protection, also called Integrity Protected Options. This document defines a data model for the configuration of these Integirty Protected Options using the YANG data modeling language. This YANG data model supports four IOAM Integrity Protected Options, which are as follows:

• Integrity Protected Incremental Trace-Option
• Integrity Protected Pre-allocated Trace-Option
• Integrity Protected Proof of Transit (POT) Option
• Integrity Protected Edge-to-Edge (E2E) Option

Abbreviations used in this document:

OAM:

Operations, Administration, and Maintenance

IOAM:

In Situ OAM

POT:

Proof of Transit

E2E:

Edge to Edge

The following terms are defined in and are used in this specification:

• augment
• data model
• data node

The terminology for describing YANG data models is found in .

Tree diagrams used in this document follow the notation defined in .

The IOAM Integrity model is organized as a list of profiles, as shown in the following figure. This document uses the "ietf-ioam" YANG module and augments its definition of a profile. The supported profiles are indicated by four defined features, i.e., "int-incremental-trace", "int-preallocated-trace", "int-proof-of-transit", and "int-edge-to-edge" (i.e., "int" prefix for "INTegrity protection"). Although these four new profiles resemble those defined in , they are distinct profiles since they represent different IOAM Option-Type code points. The YANG data model in this document conforms to the Network Management Datastore Architecture (NMDA) defined in .

The "int-preallocated-tracing-profile" parameter contains the detailed information for the pre-allocated tracing data with integrity protection. This information is the same as for the Pre-allocated Tracing Profile; see , Sec. 3.2. This information also includes:

int-method:

indicates which Integrity Protection Method is used.

The "int-incremental-tracing-profile" parameter contains the detailed information for the incremental tracing data with integrity protection. This information is the same as for the Incremental Tracing Profile; see , Sec. 3.3. This information also includes:

int-method:

indicates which Integrity Protection Method is used.

The "int-pot-profile" parameter is intended to contain the detailed information for the proof of transit data with integrity protection. This information is the same as for the Proof of Transit Profile; see , Sec. 3.5. This information also includes:

node-action:

imported from the "ietf-ioam" YANG module with the same definition.

int-method:

indicates which Integrity Protection Method is used.

The "int-e2e-profile" parameter contains the detailed information for the edge-to-edge data with integrity protection. This information is the same as for the Edge-to-Edge Profile; see , Sec. 3.6. This information also includes:

int-method:

indicates which Integrity Protection Method is used.

The "ietf-ioam-integrity" module defined in this document imports the "ietf-ioam" module defined in . This document also references . WG List: Author: Tianran Zhou Author: Justin Iurman "; description "This YANG module specifies a vendor-independent data model for In Situ Operations, Administration, and Maintenance (IOAM) Integrity Protected Options. Copyright (c) 2025 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 2025-11-13 { description "Initial revision."; reference "RFC XXXX: A YANG Data Model for In Situ Operations, Administration, and Maintenance (IOAM) Integrity Protected Options"; } /* * FEATURES */ feature int-incremental-trace { description "This feature indicates that the Integrity Protected Incremental Trace-Option is supported."; reference "RFC YYYY: Integrity Protection of In Situ Operations, Administration, and Maintenance (IOAM) Data Fields"; } feature int-preallocated-trace { description "This feature indicates that the Integrity Protected Pre-allocated Trace-Option is supported."; reference "RFC YYYY: Integrity Protection of In Situ Operations, Administration, and Maintenance (IOAM) Data Fields"; } feature int-proof-of-transit { description "This feature indicates that the Integrity Protected Proof of Transit Option is supported."; reference "RFC YYYY: Integrity Protection of In Situ Operations, Administration, and Maintenance (IOAM) Data Fields"; } feature int-edge-to-edge { description "This feature indicates that the Integrity Protected Edge-to-Edge Option is supported."; reference "RFC YYYY: Integrity Protection of In Situ Operations, Administration, and Maintenance (IOAM) Data Fields"; } /* * IDENTITIES */ identity method { description "Base identity to represent the Integrity Protection Method."; } identity method-0 { base method; description "The Integrity Protection Method 0 uses AES-GMAC with a 12-byte Nonce and a 16-byte ICV."; reference "RFC YYYY: Integrity Protection of In Situ Operations, Administration, and Maintenance (IOAM) Data Fields"; } /* * TYPE DEFINITIONS */ typedef method-type { type identityref { base method; } description "It specifies the Integrity Protection Method."; } /* * DATA NODES */ augment "/ioam:ioam/ioam:profiles/ioam:profile" { description "This augmentation adds 4 profiles for the Integrity Protected Options."; container int-incremental-tracing-profile { if-feature "int-incremental-trace"; presence "Enables the Integrity Protected Incremental Trace-Option."; description "This container describes the profile for the Integrity Protected Incremental Trace-Option."; uses ioam:ioam-incremental-tracing-profile; leaf int-method { when "derived-from-or-self(../node-action, 'ioam:action-encapsulate')"; type method-type; default "method-0"; description "This object indicates the Integrity Protection Method for this profile."; } } container int-preallocated-tracing-profile { if-feature "int-preallocated-trace"; presence "Enables the Integrity Protected Pre-allocated Trace-Option."; description "This container describes the profile for the Integrity Protected Pre-allocated Trace-Option."; uses ioam:ioam-preallocated-tracing-profile; leaf int-method { when "derived-from-or-self(../node-action, 'ioam:action-encapsulate')"; type method-type; default "method-0"; description "This object indicates the Integrity Protection Method for this profile."; } } container int-pot-profile { if-feature "int-proof-of-transit"; presence "Enables the Integrity Protected Proof of Transit Option."; description "This container describes the profile for the Integrity Protected Proof of Transit Option."; leaf use-namespace { type ioam:ioam-namespace; default "ioam:default-namespace"; description "This object indicates the namespace used for the POT types."; } leaf pot-type { type ioam:ioam-pot-type; description "The type of a particular POT variant that specifies the POT data that is included."; } leaf node-action { type ioam:ioam-node-action; default "ioam:action-transit"; description "This object indicates the action the node needs to take, e.g., encapsulation."; } leaf int-method { when "derived-from-or-self(../node-action, 'ioam:action-encapsulate')"; type method-type; default "method-0"; description "This object indicates the Integrity Protection Method for this profile."; } } container int-e2e-profile { if-feature "int-edge-to-edge"; presence "Enables the Integrity Protected Edge-to-Edge Option."; description "This container describes the profile for the Integrity Protected Edge-to-Edge Option."; uses ioam:ioam-e2e-profile; leaf int-method { when "derived-from-or-self(../node-action, 'ioam:action-encapsulate')"; type method-type; default "method-0"; description "This object indicates the Integrity Protection Method for this profile."; } } } } ]]>

This section is modeled after the template described in Section 3.7.1 of . The "ietf-ioam-integrity" YANG module defines a data model that is designed to be accessed via YANG-based management protocols, such as NETCONF and RESTCONF . These protocols have to use a secure transport layer (e.g., SSH , TLS , and QUIC ) and have to use mutual authentication. The Network Configuration Access Control Model (NACM) provides the means to restrict access for particular NETCONF or RESTCONF users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and content. There are a number of data nodes defined in this YANG module that are writable/creatable/deletable (i.e., "config true", which is the default). All writable data nodes are likely to be sensitive or vulnerable in some network environments. Write operations (e.g., edit-config) and delete operations to these data nodes without proper protection or authentication can have a negative effect on network operations. The following subtrees and data nodes have particular sensitivities/vulnerabilities:

/ioam:ioam/ioam:profiles/ioam:profile:

Please refer to the Security Considerations of .

Some of the readable data nodes in this YANG module may be considered sensitive or vulnerable in some network environments. It is thus important to control read access (e.g., via get, get-config, or notification) to these data nodes. Specifically, the following subtrees and data nodes have particular sensitivities/vulnerabilities:

/ioam:ioam/ioam:profiles/ioam:profile:

Please refer to the Security Considerations of .

This YANG module uses groupings from other YANG modules that define nodes that may be considered sensitive or vulnerable in network environments. Refer to the Security Considerations of for information as to which nodes may be considered sensitive or vulnerable in network environments.

RFC Ed.: In this section and in , please replace all occurrences of 'RFC XXXX' with the actual RFC number. Also in and in the Abstract, please replace all occurrences of 'RFC YYYY' with the actual RFC number of (and remove this note). IANA is requested to assign a new URI from the "IETF XML Registry" . The following URI is suggested:

URI:

urn:ietf:params:xml:ns:yang:ietf-ioam-integrity

Registrant Contact:

The IESG.

XML:

N/A; the requested URI is an XML namespace.

This document also requests a new YANG module name in the "YANG Module Names" registry with the following suggestion:

Name:

ietf-ioam-integrity

Namespace:

urn:ietf:params:xml:ns:yang:ietf-ioam-integrity

Prefix:

ioam-int

Reference:

RFC XXXX

The authors would like to thank Alex Huang Feng and Will Hawkins for their valuable feedback.

&RFC3688; &RFC6020; &RFC7950; &RFC8340; &RFC8341; &RFC8342; &RFC9617; &I-D.ietf-ippm-ioam-data-integrity; &RFC4252; &RFC6241; &RFC7799; &RFC8040; &RFC8446; &RFC9000; &I-D.ietf-netmod-rfc8407bis;

An example of the Integrity Protected Incremental Tracing Profile is depicted in the following figure. This configuration is received by an IOAM ingress node. This node encapsulates the IOAM data in the IPv6 Hop-by-Hop option header. The Integrity Protection Method to be used is method 0. The trace type indicates that each on-path node needs to capture the transit delay and add the data to the IOAM node data list. The incremental tracing data space is variable; however, the node data list must not exceed 512 bytes. true ietf-test-profile ipv6 action-encapsulate default-namespace trace-transit-delay 512 method-0 ]]>

An example of the Integrity Protected Pre-allocated Tracing Profile is depicted in the following figure. This configuration is received by an IOAM ingress node. This node first identifies the target flow by using the ACL parameter "test-acl" and then encapsulates the IOAM data in the NSH. The Integrity Protection Method to be used is method 0. The trace type indicates that each on-path node needs to capture the namespace-specific data in short format and add the data to the IOAM node data list. This node pre-allocates the node data list in the packet with 512 bytes. true ietf-test-profile acl-filter test-acl nsh action-encapsulate default-namespace trace-namespace-data 512 method-0 ]]>

An example of the Integrity Protected Proof of Transit Profile is depicted in the following figure. This configuration is received by an IOAM ingress node. This node encapsulates the IOAM data (POT Type 0) in the IPv6 Hop-by-Hop option header. The Integrity Protection Method to be used is method 0. true ietf-test-profile ipv6 pot-type-0 action-encapsulate method-0 ]]>

An example of the Integrity Protected Edge-to-Edge Profile is depicted in the following figure. This configuration is received by an IOAM ingress node. This node encapsulates the IOAM data in the IPv6 Destination option header. The Integrity Protection Method to be used is method 0. The Edge-to-Edge type indicates the presence of a 64-bit sequence number. true ietf-test-profile ipv6 action-encapsulate default-namespace e2e-seq-num-64 method-0 ]]>