NETCONF over QUIC

Introduction The Network Configuration Protocol (NETCONF) defines a mechanism through which the configuration of network devices can be installed, manipulated, and deleted. NETCONF can be conceptually partitioned into four layers: content, operation, message and security transport layers. The Secure Transport layer provides a communication path between the client and server. NETCONF can be layered over any transport protocol that provides a set of basic requirements, such as:

NETCONF is connection-oriented, requiring a persistent connection between peers. This connection MUST provide reliable and sequenced data delivery. NETCONF connections are long-lived, persisting between protocol operations.
NETCONF connections MUST provide authentication, data integrity, confidentiality, and replay protection. NETCONF depends on the transport protocol for this capability.

The NETCONF protocol is not bound to any particular transport protocol, but allows a mapping to define how it can be implemented over any specific protocol. However, because of the connection-oriented feature, almost all of the current secure transport protocols used by NETCONF are TCP based. As is well known, TCP has some shortcomings such as head-of-line blocking. QUIC () conforms to the above requirements, therefore is also an appropriate transport protocol for NETCONF. Moreover, QUIC provides the following additional benefits not present in the other NETCONF transports:

Single connection can be long lived and support multiple NETCONF RPC calls and responses within the same connection, using streams. This is very useful for a network management control station who is regularly monitoring devices and therefore having a long lived connection requires way less resources on both peers.
1 RTT initial handshake that includes TLS.
Adaptable to more difficult environments such as those with long delays (, .

Therefore, QUIC is a proper transport protocol for the secure transport layer of NETCONF. This document specifies how to use QUIC as the secure transport protocol for NETCONF.

Terminology and Definitions The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 .

Connection Management

Connection establishment QUIC connections are established as described in . During connection establishment, NETCONF over QUIC support is indicated by selecting the ALPN token as listed in in the cryptographic handshake.

Connection Termination

QUIC Connection Termination Process The typical QUIC connection termination process is described in

Considerations for Connection Termination When a NETCONF session is implemented based on a QUIC connection, the idle timeout should be set appropriately in order to keep the QUIC connection persistent even if the NETCONF session is idle. In some cases, disabling it may be a possible option. When a NETCONF server receives a <close-session> request, it will gracefully close the NETCONF session. The server SHOULD close the associated QUIC connection. When a NETCONF entity receives a <kill-session> request for an open session, it SHOULD close the associated QUIC connection. When a NETCONF entity is detecting the interruption of the QUIC connection, it SHOULD send a <close-session> request to the peer NETCONF entity. When a stateless reset event occurs, nothing needs to be done by either the client or the server.

Stream mapping and usage specifies protocol layers of NETCONF as shown below.

NETCONF Protocol Layers | | | | | | | +-------------+ +-----------------+ | | | | +-------------+ +-----------------+ +----------------+ (2) | Messages | | , | | | | | | | | | +-------------+ +-----------------+ +----------------+ | | | +-------------+ +-----------------------------------------+ (1) | Secure | | SSH, TLS, ... | | Transport | | | +-------------+ +-----------------------------------------+ ]]> shows that there are two kinds of main data flow exchanged between client and server:

Configuration data from client to server.
Notification data from server to client.

The two kinds of data flow need to be mapped into QUIC streams. QUIC Streams provide a lightweight, ordered byte-stream abstraction to an application. Streams can be unidirectional or bidirectional meanwhile streams can be initiated by either the client or the server. Unidirectional streams carry data in one direction: from the initiator of the stream to its peer. Bidirectional streams allow for data to be sent in both directions. QUIC uses Stream ID to identify the stream. The least significant bit (0x1) of the stream ID identifies the initiator of the stream. The second least significant bit (0x2) of the stream ID distinguishes between bidirectional streams (with the bit set to 0) and unidirectional streams. Table 1 describes the four types of streams and this table can also be seen from . Stream ID Types

Bits	Stream Type
0x0	Client-Initiated, Bidirectional
0x1	Server-Initiated, Bidirectional
0x2	Client-Initiated, Unidirectional
0x3	Server-Initiated, Unidirectional

Bidirectional Stream Between client and server NETCONF protocol uses an RPC-based communication model. Configuration data from client to server is exchanged based on '<rpc>' (the client initiating) and '<rpc-reply>' (sent by the server) and so on. The messages used to exchange configuration data MUST be mapped into one or more bidirectional stream whose stream type is 0x0 according to the above table. Since RPC processing is serialized and ordered within a session ( section 4.5), a bidirectional stream MUST be used for each NETCONF session.

Unidirectional Stream from server to client There are some notification data exchanged between the client and the server. Notification is an server initiated message indicating that a certain event has been recognized by the server. Notification messages are initiated by the server and no reply is needed from the client. So the messages used to exchange configuration data SHOULD be mapped into one unidirectional stream whose stream type is 0x3 according to the above table.

Endpoint Authentication Since QUIC uses TLS 1.3 this is used to verify server identity and client identity.

Server Identity A server's identity MUST be verified according to .

Client Identity A client's identity MUST be verified according to .

Overview of YANG Module This document defines one YANG module that augments the NETCONF YANG groupings with the QUIC transport YANG groupings . This section presents an overview of the YANG Module.

The "netconf-client" augmentation The following tree diagram illustrates the augmentation of the QUIC client grouping into the NETCONF client container:

Comments:

This augmentation to the "ncc:transport" container in "ietf-netconf-client.yang" adds a "quic" case with a "quic" container which uses the "quicc:quic-client" grouping.
Note that the if-feature "quic-initiate" conditions if the "quic" container is available in the schema.

The "netconf-server" augmentation The following tree diagram illustrates the augmentation of the QUIC server grouping into the NETCONF server container:

Comments:

This augmentation to the "ncs:transport" container in "ietf-netconf-server.yang" adds a "quic" case with a "quic" container which uses the "quics:quic-server" grouping.
Note that the if-feature "quic-listen" conditions if the "quic" container is available in the schema.

YANG Module This YANG module has normative references to and . <CODE BEGINS> file "ietf-netconf-quic@2025-02-25.yang"

Author: Jinyou Dai Author: Shaohua Yu Author: Weiqiang Cheng Author: March Blanchet Author: Per Andersson "; description "This module defines augmentations for a NETCONF server to also support the QUIC transport. 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 AAAA (https://www.rfc-editor.org/info/rfcAAAA); see the RFC itself for full legal notices. 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 (RFC 2119) (RFC 8174) when, and only when, they appear in all capitals, as shown here."; revision 2025-02-25 { description "Initial version"; reference "RFC AAAA: NETCONF over QUIC"; } // Features feature quic-initiate { description "The 'quic-initiate' feature indicates that the NETCONF client supports initiating QUIC connections to NETCONF servers."; reference "RFC CCCC: YANG Groupings for QUIC Clients and QUIC Servers"; } feature quic-listen { description "The 'quic-listen' feature indicates that the NETCONF server supports the QUIC transport."; reference "RFC AAAA: NETCONF over QUIC"; } // Augments /* FIXME seems pyang don't support this augment */ augment "/ncc:netconf-client/ncc:initiate" { if-feature "quic-initiate"; description "Add 'quic-initate' feature to the NETCONF client connection configuration."; } augment "/ncc:netconf-client/ncc:initiate/ncc:netconf-server" + "/ncc:endpoints/ncc:endpoint/ncc:transport" { description "Add QUIC transport to the NETCONF client connection configuration"; case quic { if-feature "quic-initiate"; container quic { description "QUIC-level client parameters to initiate a NETCONF over QUIC connection."; uses quicc:quic-client; } } } /* FIXME seems pyang don't support this augment */ augment "/ncs:netconf-server/ncs:listen" { if-feature "quic-listen"; description "Add 'quic-listen' feature to the NETCONF server listen configuration."; } augment "/ncs:netconf-server/ncs:listen/ncs:endpoints" + "/ncs:endpoint/ncs:transport" { description "Add QUIC transport to the NETCONF server listen configuration."; case quic { if-feature "quic-listen"; container quic { description "QUIC-level server parameters to listen for NETCONF over QUIC connections."; uses quics:quic-server; } } } } ]]> <CODE ENDS>

Security Considerations The security considerations described throughout and apply here as well.This document requires verification of server identity and client identity according to . An attacker might be able to inject arbitrary NETCONF messages via some application that does not carefully check exchanged messages deliberately insert the delimiter sequence in a NETCONF message to create a DoS attack. Hence, applications and NETCONF APIs MUST ensure that the delimiter sequence defined in Section 2.1 never appears in NETCONF messages; otherwise, those messages can be dropped, garbled, or misinterpreted. If invalid data or malformed messages are encountered, a robust implementation of this document MUST silently discard the message without further processing and then stop the NETCONF session. Finally, this document does not introduce any new security considerations compared to .

IANA Considerations This document creates a new registration for the identification of NETCONF over QUIC in the "Application Layer Protocol Negotiation (ALPN) Protocol IDs registry established in . The "noq" string identifies NETCONF over QUIC:

Protocol: NETCONF over QUIC
Identification Sequence: 0x6e 0x6f 0x71 ("noq")
Specification: This document

In addition, it is requested for IANA to reserve a UDP port TBD for 'NETCONF over QUIC'.

Acknowledgements The authors would like to acknowledge all contributors including Yang Kou, Xueshun Wang, Kent Watsen, Jeffrey Haas, Balázs Lengyel, Robert Wilton, Huaimo Chen, Lifen Zhou, Andy Bierman et al. for their beneficial comments. The authors would like to acknowledge the very useful feedback from an early implementor: Adolfo Ochagavia.