Internet-Draft | Groupings for HTTP Clients and Servers | September 2025 |
Watsen | Expires 2 April 2026 | [Page] |
This document presents four YANG 1.1 modules. The 'ietf-uri' module defines a YANG 'grouping' for the URI described in Section 3 of RFC 3986. The 'ietf-http-client' module defines a YANG 'grouping' for configuring a minimal HTTP client. The 'ietf-http-server' module defines a 'grouping' for configuring a minimal HTTP server. Lastly, the 'iana-http-versions' module defines a YANG 'typedef' for HTTP protocol versions.¶
This draft contains placeholder values that need to be replaced with finalized values at the time of publication. This note summarizes all of the substitutions that are needed. No other RFC Editor instructions are specified elsewhere in this document.¶
Artwork in this document contains shorthand references to drafts in progress. Please apply the following replacements (note: not all may be present):¶
GGGG
--> the assigned RFC value for this draft¶
HHHH
--> the assigned RFC value for draft-ietf-netconf-netconf-client-server¶
IIII
--> the assigned RFC value for draft-ietf-netconf-restconf-client-server¶
JJJJ
--> the assigned RFC value for draft-ietf-netconf-udp-client-server¶
Artwork in this document contains placeholder values for the date of publication of this draft. Please apply the following replacement:¶
2025-09-29
--> the publication date of this draft¶
The "Relation to other RFCs" section Section 1.1 contains the text "one or more YANG modules" and, later, "modules". This text is sourced from a file in a context where it is unknown how many modules a draft defines. The text is not wrong as is, but it may be improved by stating more directly how many modules are defined.¶
The "Relation to other RFCs" section Section 1.1 contains a self-reference to this draft, along with a corresponding reference in the Appendix. Please replace the self-reference in this section with "This RFC" (or similar) and remove the self-reference in the "Normative/Informative References" section, whichever it is in.¶
Tree-diagrams in this draft may use the '\' line-folding mode defined in RFC 8792. However, nicer-to-the-eye is when the '\\' line-folding mode is used. The AD suggested suggested putting a request here for the RFC Editor to help convert "ugly" '\' folded examples to use the '\\' folding mode. "Help convert" may be interpreted as, identify what looks ugly and ask the authors to make the adjustment.¶
Due to a bug in the pyang tool used to create tree diagrams, some "key" nodes appear as optional (i.e., have a '?' postfix). Ideally the '?' character is removed in the tree diagrams for "key" nodes. Recipe: search for lists using the string "* [", then note the nodes appearing in the square brackets (e.g., "* [name]"), then look for matching child nodes and remove the '?' characters (e.g., "name?" becomes "name").¶
The following Appendix section is to be removed prior to publication:¶
Appendix A. Change Log¶
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 2 April 2026.¶
Copyright (c) 2025 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.¶
This document presents four YANG 1.1 [RFC7950] modules.¶
This document presents one or more YANG modules [RFC7950] that are part of a collection of RFCs that work together to, ultimately, support the configuration of both the clients and servers of both the NETCONF [RFC6241] and RESTCONF [RFC8040] protocols.¶
Primary dependency relationships between the YANG groupings defined in the various RFCs is presented in the below diagram. In some cases, a draft may define secondary groupings that introduce dependencies not illustrated in the diagram. The labels in the diagram are a shorthand name for the defining RFC. The citation reference for shorthand name is provided below the diagram.¶
Please note that the arrows in the diagram point from referencer to referenced. For example, the "crypto-types" RFC does not have any dependencies, whilst the "keystore" RFC depends on the "crypto-types" RFC.¶
crypto-types ^ ^ / \ / \ truststore keystore ^ ^ ^ ^ | +---------+ | | | | | | | +------------+ | tcp-client-server | / | | ^ ^ ssh-client-server | | | | ^ tls-client-server | | | ^ ^ http-client-server | | | | | ^ | | | +-----+ +---------+ | | | | | | | | +-----------|--------|--------------+ | | | | | | | | +-----------+ | | | | | | | | | | | | | | | | | netconf-client-server restconf-client-server¶
Label in Diagram | Originating RFC |
---|---|
crypto-types | [RFC9640] |
truststore | [RFC9641] |
keystore | [RFC9642] |
tcp-client-server | [RFC9643] |
ssh-client-server | [RFC9644] |
tls-client-server | [RFC9645] |
http-client-server | [I-D.ietf-netconf-http-client-server] |
netconf-client-server | [I-D.ietf-netconf-netconf-client-server] |
restconf-client-server | [I-D.ietf-netconf-restconf-client-server] |
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 is compliant with the Network Management Datastore Architecture (NMDA) [RFC8342]. For instance, as described in [RFC9641] and [RFC9642], trust anchors and keys installed during manufacturing are expected to appear in <operational> (Section 5.3 of [RFC8342]), and <system> [I-D.ietf-netmod-system-config], if implemented.¶
This section describes a YANG 1.1 module called "ietf-uri". This module defines a YANG grouping called "uri" for the URI described in Section 3 of RFC 3986. A structured URI is defined in order to both be more explicit and enhance YANG validation, more so than when using the unstructured 'uri' type defined in [RFC6991].¶
This section contains three sub-sections. A high-level overview of the "ietf-uri" module is provided in Section 2.1. Examples illustrating the module's use are provided in Section 2.2. The YANG module itself is defined in Section 2.3.¶
This section provides an overview of the "ietf-uri" module, which defines a single grouping called "uri" presenting a data model for the URI defined in Section 3 of [RFC3986].¶
The following tree diagram [RFC8340] illustrates the "uri" grouping:¶
grouping uri: +-- scheme string +-- authority! | +-- userinfo? string | +-- host inet:host | +-- port? inet:port-number +-- path? string +-- query? string +-- fragment? string¶
The "ietf-uri" module defines only a "grouping" statement that is used by other modules to instantiate protocol-accessible nodes. This module, when implemented, does not define any protocol-accessible nodes.¶
This section presents two examples showing the "uri" grouping populated with some data.¶
The first example illustrates the case where the URI represents the string "https://example.com".¶
<!-- The outermost element below doesn't exist in the data model. --> <!-- It simulates if the "grouping" were a "container" instead. --> <uri xmlns="urn:ietf:params:xml:ns:yang:ietf-uri"> <scheme>https</scheme> <authority> <host>example.com</host> </authority> </uri>¶
The second example illustrates the case where the URI represents the string "https://user:pass@example.com:443/foo/bar?query#fragment".¶
<!-- The outermost element below doesn't exist in the data model. --> <!-- It simulates if the "grouping" were a "container" instead. --> <uri xmlns="urn:ietf:params:xml:ns:yang:ietf-uri"> <scheme>https</scheme> <authority> <userinfo>user:pass</userinfo> <host>example.com</host> <port>443</port> </authority> <path>/foo/bar</path> <query>query</query> <fragment>fragment</fragment> </uri>¶
This YANG module has references to [RFC3986], [RFC6991] and [RFC8341].¶
<CODE BEGINS> file "ietf-uri@2025-09-29.yang"¶
module ietf-uri { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-uri"; prefix uri; import ietf-inet-types { prefix inet; reference "RFC 6991: Common YANG Data Types"; } import ietf-netconf-acm { prefix nacm; reference "RFC 8341: Network Configuration Access Control Model"; } organization "IETF NETCONF (Network Configuration) Working Group"; contact "WG Web: https://datatracker.ietf.org/wg/netconf WG List: NETCONF WG list <mailto:netconf@ietf.org> Author: Kent Watsen <mailto:kent+ietf@watsen.net>"; description "This module defines a grouping for the URI described in Section 3 of RFC 3986. 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 GGGG (https://www.rfc-editor.org/info/rfcGGGG); 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-09-29 { description "Initial version"; reference "RFC GGGG: YANG Groupings for HTTP Clients and HTTP Servers"; } // Grouping grouping uri { description "A grouping that defines leafs for each component of the URI described in Section 3 of RFC 3986. This grouping may be preferred, to the 'uri' typedef in Section 4 of RFC 6991, when validation is important. This grouping does not define an outer container, e.g., called 'uri', thus enabling consuming YANG modules to chose the appropriate name for the data model."; reference "RFC 3986: URI Generic Syntax RFC 6991: Common YANG Data Types"; leaf scheme { type string; mandatory true; description "The 'Scheme' as described in Section 3.1 of RFC 3986."; } container authority { presence "Indicates that 'authority' has been configured."; description "The 'Authority' as described in Section 3.2 of RFC 3986."; leaf userinfo { nacm:default-deny-all; type string; description "The 'User Information' as described in Section 3.2.1 of RFC 3986."; } leaf host { type inet:host; mandatory true; description "The 'Host' as described in Section 3.2.2 of RFC 3986."; } leaf port { type inet:port-number; description "The 'Port' as described in Section 3.2.3 of RFC 3986."; } } leaf path { type string; description "The 'Path' as described in Section 3.3 of RFC 3986."; } leaf query { type string; description "The 'Query' as described in Section 3.4 of RFC 3986."; } leaf fragment { type string; description "The 'Fragment' as described in Section 3.5 of RFC 3986."; } } }¶
<CODE ENDS>¶
This section describes a YANG 1.1 module called "ietf-http-client". This module defines a YANG grouping called "http-client-grouping" for configuring an HTTP client's ability to communicate with an HTTP service endpoint. Unlike other groupings in the suite a "client-server" drafts mentioned in Section 1.1, this grouping is not intended to be used in conjunction with others to define a complete protocol stack. This is due to the "uri" node encoding configuration for lower protocol stack layers. For instance, the "scheme" and "authority" parts of the URI encode information that portains to lower-level to transport layers.¶
This section contains three sub-sections. A high-level overview of the "ietf-http-client" module is provided in Section 3.1. Examples illustrating the module's use are provided in Section 3.2. The YANG module itself is defined in Section 3.3.¶
This section provides an overview of the "ietf-http-client" module in terms of its features and groupings.¶
The following diagram lists all the "feature" statements defined in the "ietf-http-client" module:¶
Features: +-- proxy-connect +-- version-discovery¶
The diagram above uses syntax that is similar to but not defined in [RFC8340].¶
The "ietf-http-client" module defines one "grouping" statement called "http-client-grouping".¶
The following tree diagram [RFC8340] illustrates the "http-client-grouping" grouping:¶
grouping http-client-grouping: +-- uri | +---u uri:uri +-- protocol-versions! | +-- protocol-version* httpv:http-protocol-version +-- tls-client-parameters! | +---u tlsc:tls-client-grouping +-- proxy-connect! {proxy-connect}? | +-- protocol enumeration | +-- host inet:host | +-- port uint16 +--ro supported-versions {version-discovery}? +--ro supported-version* httpv:http-protocol-version¶
Comments:¶
The "ietf-http-client" module defines only "grouping" statements that are used by other modules to instantiate protocol-accessible nodes. Thus this module, when implemented, does not define any protocol-accessible nodes.¶
This section presents three examples showing the http-client-grouping populated with some data. All three examples show both configuration and state data (i.e., the "supported-versions" node).¶
The first example illustrates the case where the HTTP client is configured to connect directly to an HTTP server without TLS.¶
<!-- The outermost element below doesn't exist in the data model. --> <!-- It simulates if the "grouping" were a "container" instead. --> <http-client xmlns="urn:ietf:params:xml:ns:yang:ietf-http-client"> <uri> <scheme>http</scheme> <authority> <userinfo>user</userinfo> <host>example.com</host> <port>80</port> </authority> <path>/foo/bar</path> <query>query</query> <fragment>fragment</fragment> </uri> <protocol-versions> <protocol-version>HTTP/2 over TCP</protocol-version> </protocol-versions> <supported-versions> <supported-version>HTTP/1.1</supported-version> <supported-version>HTTP/2 over TCP</supported-version> <supported-version>HTTP/2 over TLS</supported-version> <supported-version>HTTP/3</supported-version> </supported-versions> </http-client>¶
The second example illustrates the case where the HTTP client is configured to connect directly to an HTTP server with TLS.¶
This example is consistent with examples presented in Section 2.2.1 of [RFC9641] and Section 2.2.1 of [RFC9642].¶
=============== NOTE: '\' line wrapping per RFC 8792 ================ <!-- The outermost element below doesn't exist in the data model. --> <!-- It simulates if the "grouping" were a "container" instead. --> <http-client xmlns="urn:ietf:params:xml:ns:yang:ietf-http-client"> <uri> <scheme>https</scheme> <authority> <userinfo>user:pass</userinfo> <host>example.com</host> <port>443</port> </authority> <path>/foo/bar</path> <query>query</query> <fragment>fragment</fragment> </uri> <protocol-versions> <protocol-version>HTTP/1.1</protocol-version> <protocol-version>HTTP/3</protocol-version> </protocol-versions> <supported-versions> <supported-version>HTTP/1.1</supported-version> <supported-version>HTTP/2 over TCP</supported-version> <supported-version>HTTP/2 over TLS</supported-version> <supported-version>HTTP/3</supported-version> </supported-versions> <tls-client-parameters> <client-identity> <certificate> <central-keystore-reference> <asymmetric-key>rsa-asymmetric-key</asymmetric-key> <certificate>ex-rsa-cert</certificate> </central-keystore-reference> </certificate> </client-identity> <server-authentication> <ca-certs> <central-truststore-reference>trusted-server-ca-certs</centr\ al-truststore-reference> </ca-certs> <ee-certs> <central-truststore-reference>trusted-server-ee-certs</centr\ al-truststore-reference> </ee-certs> </server-authentication> </tls-client-parameters> </http-client>¶
The following example illustrates the case where the HTTP client is configured to connect through an HTTP proxy.¶
This example also is consistent with examples presented in Section 2.2.1 of [RFC9641] and Section 2.2.1 of [RFC9642].¶
=============== NOTE: '\' line wrapping per RFC 8792 ================ <!-- The outermost element below doesn't exist in the data model. --> <!-- It simulates if the "grouping" were a "container" instead. --> <http-client xmlns="urn:ietf:params:xml:ns:yang:ietf-http-client"> <uri> <scheme>https</scheme> <authority> <userinfo>user:pass</userinfo> <host>example.com</host> <port>443</port> </authority> <path>/foo/bar</path> <query>query</query> <fragment>fragment</fragment> </uri> <protocol-versions> <protocol-version>HTTP/1.1</protocol-version> <protocol-version>HTTP/3</protocol-version> </protocol-versions> <supported-versions> <supported-version>HTTP/1.1</supported-version> <supported-version>HTTP/2 over TCP</supported-version> <supported-version>HTTP/2 over TLS</supported-version> <supported-version>HTTP/3</supported-version> </supported-versions> <tls-client-parameters> <client-identity> <certificate> <central-keystore-reference> <asymmetric-key>rsa-asymmetric-key</asymmetric-key> <certificate>ex-rsa-cert</certificate> </central-keystore-reference> </certificate> </client-identity> <server-authentication> <ca-certs> <central-truststore-reference>trusted-server-ca-certs</centr\ al-truststore-reference> </ca-certs> <ee-certs> <central-truststore-reference>trusted-server-ee-certs</centr\ al-truststore-reference> </ee-certs> </server-authentication> </tls-client-parameters> <proxy-connect> <protocol>CONNECT</protocol> <host>proxy.example.org</host> <port>4443</port> </proxy-connect> </http-client>¶
This YANG module has references to [RFC3986], [RFC6991], [RFC8341], [RFC9110], and [RFC9645].¶
<CODE BEGINS> file "ietf-http-client@2025-09-29.yang"¶
module ietf-http-client { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-http-client"; prefix httpc; import ietf-inet-types { prefix inet; reference "RFC 6991: Common YANG Data Types"; } import ietf-tls-client { prefix tlsc; reference "RFC FFFF: YANG Groupings for TLS Clients and TLS Servers"; } import ietf-uri { prefix uri; reference "RFC GGGG: YANG Groupings for HTTP Clients and HTTP Servers"; } import iana-http-versions { prefix httpv; reference "RFC GGGG: YANG Groupings for HTTP Clients and HTTP Servers"; } organization "IETF NETCONF (Network Configuration) Working Group"; contact "WG Web: https://datatracker.ietf.org/wg/netconf WG List: NETCONF WG list <mailto:netconf@ietf.org> Author: Kent Watsen <mailto:kent+ietf@watsen.net>"; description "This module defines groupings for HTTP clients that can be used as a basis for specific HTTP client instances. 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 GGGG (https://www.rfc-editor.org/info/rfcGGGG); 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-09-29 { description "Initial version"; reference "RFC GGGG: YANG Groupings for HTTP Clients and HTTP Servers"; } // Features feature proxy-connect { description "Indicates that the server supports configuring HTTP clients to connect to a remote HTTP server via a proxy, per Section 9.3.6 of RFC 9110."; reference "RFC 9110: HTTP Semantics"; } feature version-discovery { description "Indicates that the server implements the discovery for which HTTP versions are supported for HTTP clients."; } // Groupings grouping http-client-grouping { description "A grouping for HTTP client level configuration. This grouping is not expected to be used with groupings for lower protocol layer (e.g., the 'tcp-client-grouping' found in RFC 9643), as equivalent information is encoded into the URI."; reference "RFC 9643: YANG Groupings for TCP Clients and TCP Servers"; container uri { must "scheme != 'https' or ../tls-client-parameters"; description "The URI, described in Section 3 of RFC 3986, the HTTP client establishes a connection to."; reference "RFC 3986 URI Generic Syntax"; uses uri:uri; } container protocol-versions { presence "If unconfigured, all supported HTTP versions are acceptable."; description "HTTP protocol versions the client accepts."; leaf-list protocol-version { type httpv:http-protocol-version; min-elements 1; description "Indicates that the client is configured to support this HTTP version. The value must be one of the 'supported-versions' values."; } } // container protocol-versions container tls-client-parameters { presence "Indicates that TLS-client parameters have been configured."; description "TLS client parameters for 'https' connections."; uses tlsc:tls-client-grouping; } container proxy-connect { if-feature proxy-connect; presence "Indicates that the HTTP-client connects through the configured proxy."; description "Configures how to connect to the proxy."; leaf protocol { type enumeration { enum CONNECT { description "Use the 'CONNECT' method described in Section 9.3.6 of RFC 9110. This option is availble for HTTP/2 and earlier."; reference "RFC 9110: HTTP Semantics"; } enum CONNECT-UDP { description "Use the 'connect-udp' upgrade token described in Section 3 of RFC 9298. This option is available starting with HTTP/3."; reference "RFC 9298: Proxying UDP in HTTP"; } } mandatory true; description "The protocol to use when connecting to the proxy."; } leaf host { type inet:host; mandatory true; description "The 'Host' subcomponent, as described in Section 3.2.2 of RFC 3986, of the proxy."; reference "RFC 3986 URI Generic Syntax"; } leaf port { type uint16; mandatory true; description "The 'Port' subcomponent, as described in Section 3.2.3 of RFC 3986, of the proxy."; reference "RFC 3986 URI Generic Syntax"; } } container supported-versions { if-feature "version-discovery"; config false; description "A container for a list of HTTP protocol versions supported by the client."; leaf-list supported-version { type httpv:http-protocol-version; description "An HTTP protocol version supported by the client."; } } } // http-client-grouping }¶
<CODE ENDS>¶
This section describes a YANG 1.1 module called "ietf-http-server". This module defines a YANG grouping called "http-server-grouping" for configuring an HTTP server's service endpoints, used in conjunction with others described in Section 1.1 to define a complete protocol stack. This module defines an additional YANG grouping called "http-server-listen-stack-grouping" as a convenience for such a complete protocol stack.¶
This section contains three sub-sections. A high-level overview of the "ietf-http-server" module is provided in Section 4.1. Examples illustrating the module's use are provided in Section 4.2. The YANG module itself is defined in Section 4.3.¶
This section provides an overview of the "ietf-http-server" module in terms of its features and groupings.¶
The following diagram lists all the "feature" statements defined in the "ietf-http-server" module:¶
Features: +-- client-auth-supported +-- local-users-supported {client-auth-supported}? +-- basic-auth {local-users-supported}? +-- tcp-supported +-- tls-supported +-- quic-supported +-- version-discovery¶
The diagram above uses syntax that is similar to but not defined in [RFC8340].¶
The "ietf-http-server" module defines two "grouping" statements:¶
Each of these groupings are presented in the following subsections.¶
The following tree diagram [RFC8340] illustrates the "http-server-grouping" grouping:¶
grouping http-server-grouping: +-- server-name? string +-- client-authentication! {client-auth-supported}? | +-- users {local-users-supported}? | +-- user* [user-id] | +-- user-id? string | +-- (auth-type) | +--:(basic) | +-- basic {basic-auth}? | +-- username? string | +-- password | +-- hashed-password? ianach:crypt-hash | +--ro last-modified? yang:date-and-time +-- protocol-versions! | +-- protocol-version* httpv:http-protocol-version +--ro supported-versions {version-discovery}? +--ro supported-version* httpv:http-protocol-version¶
Comments:¶
The following tree diagram [RFC8340] illustrates the "http-server-listen-stack-grouping" grouping:¶
grouping http-server-listen-stack-grouping: +-- (transport) +--:(http-over-tcp) | +-- http-over-tcp | +-- tcp-server-parameters | | +---u tcps:tcp-server-grouping | +-- http-server-parameters | +---u http-server-grouping +--:(http-over-tls) | +-- http-over-tls | +-- tcp-server-parameters | | +---u tcps:tcp-server-grouping | +-- tls-server-parameters | | +---u tlss:tls-server-grouping | +-- http-server-parameters | +---u http-server-grouping +--:(http-over-quic) +-- http-over-quic +-- udp-server-parameters | +---u udps:udp-server +-- tls-server-parameters | +---u tlss:tls-server-grouping +-- http-server-parameters +---u http-server-grouping¶
Comments:¶
For the referenced grouping statement(s):¶
The "ietf-http-server" module defines only "grouping" statements that are used by other modules to instantiate protocol-accessible nodes. Thus this module, when implemented, does not define any protocol-accessible nodes.¶
This section presents an example showing the http-server-grouping populated with some data. All three examples show both configuration and state data (i.e., the "supported-versions" node).¶
<!-- The outermost element below doesn't exist in the data model. --> <!-- It simulates if the "grouping" were a "container" instead. --> <http-server xmlns="urn:ietf:params:xml:ns:yang:ietf-http-server"> <server-name>foo.example.com</server-name> <protocol-versions> <protocol-version>HTTP/1.1</protocol-version> <protocol-version>HTTP/3</protocol-version> </protocol-versions> <supported-versions> <supported-version>HTTP/1.1</supported-version> <supported-version>HTTP/2 over TCP</supported-version> <supported-version>HTTP/2 over TLS</supported-version> <supported-version>HTTP/3</supported-version> </supported-versions> </http-server>¶
This YANG module has references to [RFC6991], [RFC7317], [RFC7617], [RFC8341], [RFC9110], [RFC9643], [RFC9645], and [I-D.ietf-netconf-udp-client-server].¶
<CODE BEGINS> file "ietf-http-server@2025-09-29.yang"¶
module ietf-http-server { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-http-server"; prefix https; import ietf-yang-types { prefix yang; reference "RFC 6991: Common YANG Data Types"; } import iana-crypt-hash { prefix ianach; reference "RFC 7317: A YANG Data Model for System Management"; } import ietf-netconf-acm { prefix nacm; reference "RFC 8341: Network Configuration Access Control Model"; } import ietf-tcp-server { prefix tcps; reference "RFC DDDD: YANG Groupings for TCP Clients and TCP Servers"; } import ietf-tls-server { prefix tlss; reference "RFC FFFF: YANG Groupings for TLS Clients and TLS Servers"; } import ietf-udp-server { prefix udps; reference "RFC JJJJ: YANG Groupings for UDP Clients and UDP Servers"; } import iana-http-versions { prefix httpv; reference "RFC GGGG: YANG Groupings for HTTP Clients and HTTP Servers"; } organization "IETF NETCONF (Network Configuration) Working Group"; contact "WG Web: https://datatracker.ietf.org/wg/netconf WG List: NETCONF WG list <mailto:netconf@ietf.org> Author: Kent Watsen <mailto:kent+ietf@watsen.net>"; description "This module defines groupings for HTTP servers that can be used as a basis for specific HTTP server instances. 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 GGGG (https://www.rfc-editor.org/info/rfcGGGG); 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-09-29 { description "Initial version"; reference "RFC GGGG: YANG Groupings for HTTP Clients and HTTP Servers"; } // Features feature client-auth-supported { description "Indicates that the server supports configuring HTTP servers to authenticate HTTP clients. HTTP-level client authentication may not be needed when client authentication is expected to occur only at another protocol layer (e.g., TLS)."; } feature local-users-supported { if-feature "client-auth-supported"; description "Indicates that the server supports configuring client authentication with its own database of local users, as opposed to in an application specific location."; } feature basic-auth { if-feature "local-users-supported"; description "Indicates that the server supports configuring 'basic' authentication credentials in its local user database."; reference "RFC 7617: The 'Basic' HTTP Authentication Scheme"; } feature tcp-supported { description "Indicates that the server supports configuring HTTP servers to listen for HTTP 1.1/2.0 connections over TCP."; reference "RFC 9110: HTTP Semantics"; } feature tls-supported { description "Indicates that the server supports configuring HTTP servers to listen for HTTP 1.1/2.0 connections over TLS."; reference "RFC 9110: HTTP Semantics"; } feature quic-supported { description "Indicates that the server supports configuring HTTP servers to listen for HTTP/3 connections over QUIC."; reference "RFC 9114: HTTP/3"; } feature version-discovery { description "Indicates that the server implements the discovery for which HTTP versions are supported for HTTP servers."; } // Groupings grouping http-server-grouping { description "A grouping for configuring HTTP server level parameters. Note that this grouping uses fairly typical descendant node names such that a stack of 'uses' statements will have name conflicts. It is intended that the consuming data model will resolve the issue (e.g., by wrapping the 'uses' statement in a container called 'http-server-parameters'). This model purposely does not do this itself so as to provide maximum flexibility to consuming models."; leaf server-name { nacm:default-deny-write; type string; description "The value of the 'Server' header field. If not set, then underlying software's default value is used. Set to the empty string to disable."; } container client-authentication { if-feature "client-auth-supported"; nacm:default-deny-write; presence "Indicates that HTTP based client authentication is configured. This statement is present so the mandatory descendant nodes do not imply that this node must be configured."; description "Configures how the HTTP server can authenticate HTTP clients. The HTTP server will request that the HTTP client send authentication when needed."; container users { if-feature "local-users-supported"; description "A list of locally configured users."; list user { key "user-id"; description "The list of local users configured on this device."; leaf user-id { type string; description "The user-id for the authenticating client."; } choice auth-type { mandatory true; description "The authentication type."; case basic { container basic { if-feature "basic-auth"; leaf username { type string; description "The username for the authenticating HTTP client."; } container password { description "The hashed password the HTTP server uses to authenticate this user. A user is authenticated if the hash of the supplied password matches this value."; leaf hashed-password { type ianach:crypt-hash; description "The password for the authenticating client."; } leaf last-modified { type yang:date-and-time; config false; description "Identifies when the password was last set."; } } description "The 'basic' HTTP scheme credentials."; reference "RFC 7617: The 'Basic' HTTP Authentication Scheme"; } } } } } } container protocol-versions { presence "If unconfigured, all supported HTTP versions are acceptable."; description "HTTP protocol versions the server accepts."; leaf-list protocol-version { type httpv:http-protocol-version; min-elements 1; description "Indicates that the server is configured to support this HTTP version. The value must be one of the 'supported-versions' values."; } } container supported-versions { if-feature "version-discovery"; config false; description "A container for a list of HTTP protocol versions supported by the server."; leaf-list supported-version { type httpv:http-protocol-version; description "An HTTP protocol version supported by the server."; } } } // grouping http-server-grouping grouping http-server-listen-stack-grouping { description "A grouping that defines a single instance of an HTTP-based protocol stack to listen for HTTP connections."; choice transport { mandatory true; description "Choice amongst various transports type."; case http-over-tcp { container http-over-tcp { description "Container for TCP-based HTTP/1 or HTTP/2 protocols."; container tcp-server-parameters { description "TCP-level server parameters to listen for HTTP connections."; uses tcps:tcp-server-grouping { refine "local-bind/local-port" { default "80"; description "The HTTP server will attempt to connect to the IANA-assigned well-known port for 'http' (80) if no value is specified."; } } } container http-server-parameters { description "HTTP-level server parameters to listen for HTTP connections."; uses http-server-grouping; } } } case http-over-tls { container http-over-tls { description "Container for TLS-based HTTP/1 or HTTP/2 protocols."; container tcp-server-parameters { description "TCP-level server parameters to listen for HTTPS connections."; uses tcps:tcp-server-grouping { refine "local-bind/local-port" { default "443"; description "The HTTP server will attempt to connect to the IANA-assigned well-known port for 'https' (443) if no value is specified."; } } } container tls-server-parameters { description "TLS-level server parameters to listen for HTTPS connections."; uses tlss:tls-server-grouping; } container http-server-parameters { description "HTTP-level server parameters to listen for HTTPS connections."; uses http-server-grouping; } } } case http-over-quic { container http-over-quic { description "Container for the QUIC-based HTTP/3 protocol."; container udp-server-parameters { description "UDP-level server parameters."; uses udps:udp-server; } container tls-server-parameters { description "TLS-level server parameters."; uses tlss:tls-server-grouping; } container http-server-parameters { description "HTTP-level server parameters."; uses http-server-grouping; } } } } } // http-server-listen-stack-grouping }¶
<CODE ENDS>¶
This document defines four YANG modules, one that defines only a "typedef" and the other three defining only "grouping" statements. These modules will not be deployed as standalone modules. Their security implications may be context dependent based on their use in other modules. The designers of modules which import these grouping must conduct their own analysis of the security considerations.¶
This section is modeled after the template defined in Section 3.7.1 of [RFC8407].¶
The "iana-http-versions" YANG module defines a data model that is designed to be accessed via YANG based management protocols, such as NETCONF [RFC6241] and RESTCONF [RFC8040]. Both of these protocols have mandatory-to-implement secure transport layers (e.g., SSH, TLS) with mutual authentication.¶
The Network Access Control Model (NACM) [RFC8341] provides the means to restrict access for particular users to a pre-configured subset of all available protocol operations and content.¶
This YANG module defines YANG enumerations for a public IANA-maintained registry.¶
YANG enumerations are not security-sensitive, as they are statically defined in the publicly-accessible YANG module. IANA MAY deprecate and/or obsolete HTTP versions over time as needed.¶
This module does not define any writable-nodes, RPCs, actions, or notifications, and thus the security consideration for such is not provided here.¶
This section is modeled after the template defined in Section 3.7.1 of [RFC8407].¶
The "ietf-uri" YANG module defines data nodes that are designed to be accessed via YANG-based management protocols, such as NETCONF [RFC6241] and RESTCONF [RFC8040]. The YANG-based management protocols have to use a secure transport layer such as SSH [RFC4252], TLS [RFC8446], or QUIC [RFC9000]. The YANG-based management protocols also have to use mutual authentication.¶
The Network Access Control Model (NACM) [RFC8341] provides the means to restrict access for particular users to a pre-configured subset of all available protocol operations and content.¶
Some of the readable data nodes defined in this YANG module, i.e., excluding imported modules, may be considered sensitive or vulnerable in some network environments. It is thus important to control read access to these data nodes. The following data nodes have particular sensitivity/vulnerability:¶
The "userinfo" node:¶
None of the writable data nodes defined in this YANG module, i.e., excluding imported modules, are considered sensitive or vulnerable in network environments.¶
This module does not define any RPCs, actions, or notifications, and thus the security consideration for such is not provided here.¶
This section is modeled after the template defined in Section 3.7.1 of [RFC8407].¶
The "ietf-http-client" YANG module defines data nodes that are designed to be accessed via YANG-based management protocols, such as NETCONF [RFC6241] and RESTCONF [RFC8040]. The YANG-based management protocols have to use a secure transport layer such as SSH [RFC4252], TLS [RFC8446], or QUIC [RFC9000]. The YANG-based management protocols also have to use mutual authentication.¶
The Network Access Control Model (NACM) [RFC8341] provides the means to restrict access for particular users to a pre-configured subset of all available protocol operations and content.¶
Please be aware that this YANG module uses groupings from other YANG modules that define nodes that may be considered sensitive or vulnerable in network environments. Please review the Security Considerations for dependent YANG modules for information as to which nodes may be considered sensitive or vulnerable in network environments.¶
None of the readable data nodes defined in this YANG module, i.e., excluding imported modules, are considered sensitive or vulnerable in some network environments.¶
None of the writable data nodes defined in this YANG module, i.e., excluding imported modules, are considered sensitive or vulnerable in network environments.¶
This module does not define any RPCs, actions, or notifications, and thus the security consideration for such is not provided here.¶
This section is modeled after the template defined in Section 3.7.1 of [RFC8407].¶
The "ietf-http-server" YANG module defines data nodes that are designed to be accessed via YANG-based management protocols, such as NETCONF [RFC6241] and RESTCONF [RFC8040]. The YANG-based management protocols have to use a secure transport layer such as SSH [RFC4252], TLS [RFC8446], or QUIC [RFC9000]. The YANG-based management protocols also have to use mutual authentication.¶
The Network Access Control Model (NACM) [RFC8341] provides the means to restrict access for particular users to a pre-configured subset of all available protocol operations and content.¶
Please be aware that this YANG module uses groupings from other YANG modules that define nodes that may be considered sensitive or vulnerable in network environments. Please review the Security Considerations for dependent YANG modules for information as to which nodes may be considered sensitive or vulnerable in network environments.¶
None of the readable data nodes defined in this YANG module, i.e., excluding imported modules, are considered sensitive or vulnerable in network environments. The NACM "default-deny-all" extension has not been set for any data nodes defined in this module.¶
The following writable data nodes defined in this YANG module, i.e., excluding imported modules, are considered sensitive or vulnerable in network environments:¶
The "server-name" node in the "http-server-grouping" grouping may be considered sensitive or vulnerable in some network environments. For this reason, the NACM extension "default-deny-write" has been applied to it. A misconfigured "server-name" may mislead clients into not knowing how to interoperate with the server (e.g., "foo v1.0" vs "foo 2.0").¶
The "client-authentication" node in the "http-server-grouping" grouping may be considered sensitive or vulnerable in some network environments. For this reason, the NACM extension "default-deny-write" has been applied to it. Misconfigured "client-authentication" may lead the server to authenticate invalid client credentials.¶
This module does not define any RPCs, actions, or notifications, and thus the security consideration for such is not provided here.¶
This document registers four URIs in the "ns" subregistry of the IETF XML Registry [RFC3688]. Following the format in [RFC3688], the following registrations are requested:¶
URI: urn:ietf:params:xml:ns:yang:iana-http-versions Registrant Contact: The IESG XML: N/A, the requested URI is an XML namespace. URI: urn:ietf:params:xml:ns:yang:ietf-uri Registrant Contact: The IESG XML: N/A, the requested URI is an XML namespace. URI: urn:ietf:params:xml:ns:yang:ietf-http-client Registrant Contact: The IESG XML: N/A, the requested URI is an XML namespace. URI: urn:ietf:params:xml:ns:yang:ietf-http-server Registrant Contact: The IESG XML: N/A, the requested URI is an XML namespace.¶
This document registers two YANG modules in the YANG Module Names registry [RFC6020]. Following the format in [RFC6020], the following registrations are requested:¶
Name: ietf-http-versions Namespace: urn:ietf:params:xml:ns:yang:ietf-http-versions Prefix: httpv Reference: RFC GGGG Maintained by IANA: Y Name: ietf-uri Namespace: urn:ietf:params:xml:ns:yang:ietf-uri Prefix: uri Reference: RFC GGGG Maintained by IANA: N Name: ietf-http-client Namespace: urn:ietf:params:xml:ns:yang:ietf-http-client Prefix: httpc Reference: RFC GGGG Maintained by IANA: N Name: ietf-http-server Namespace: urn:ietf:params:xml:ns:yang:ietf-http-server Prefix: https Reference: RFC GGGG Maintained by IANA: N¶
This section follows the template defined in Section 4.30.3.1 of [I-D.ietf-netmod-rfc8407bis].¶
IANA is requested to add the following note to the registry:¶
New values must not be directly added to the "iana-http-versions" YANG module. They must instead be added to the "TLS Application-Layer Protocol Negotiation (ALPN) Protocol IDs" sub-registry of the "Transport Layer Security (TLS) Extensions" registry [IANA-TLS-ALPN-IDS].¶
When an HTTP-specific value is added to the "TLS Application-Layer Protocol Negotiation (ALPN) Protocol IDs" sub-registry, a new "enum" statement must be added to the "iana-http-versions" YANG module. The "enum" statement, and sub-statements thereof, should be defined as follows:¶
When the "iana-http-versions" YANG module is updated, a new "revision" statement with a unique revision date must be added in front of the existing revision statements. The "revision" must have a "description" statement explaining why the the update occurred, and must have a "reference" substatement that points to the document defining the registry update that resulted in this change. For instance:¶
revision yyyy-mm-dd { description "This revision reflects the update made to the underlying 'TLS Application-Layer Protocol Negotiation (ALPN) Protocol IDs' registry per RFC XXXX."; reference "RFC XXXX: RFC Title for Some New HTTP Version"; }¶
IANA is requested to add the following note to the "TLS Application-Layer Protocol Negotiation (ALPN) Protocol IDs" sub-registry of the "Transport Layer Security (TLS) Extensions" registry [IANA-TLS-ALPN-IDS].¶
When this registry has an HTTP-specific version added or modified, the YANG module "iana-http-versions" [IANA-YANG-PARAMETERS] must be updated as defined in RFC GGGG.¶
This section is to be removed before publishing as an RFC.¶
<CODE BEGINS> file "iana-http-versions@2025-09-29.yang"¶
module iana-http-versions { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:iana-http-versions"; prefix httpv; organization "Internet Assigned Numbers Authority (IANA)"; contact "Postal: ICANN 12025 Waterfront Drive, Suite 300 Los Angeles, CA 90094-2536 United States of America Tel: +1 310 301 5800 Email: iana@iana.org"; description "This module defines enumerations for the HTTP versions defined in the 'TLS Application-Layer Protocol Negotiation (ALPN) Protocol IDs' sub-registry of the 'Transport Layer Security (TLS) Extensions' registry maintained by IANA. 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). The initial version of this YANG module is part of RFC GGGG (https://www.rfc-editor.org/info/rfcGGGG); see the RFC itself for full legal notices. All versions of this module are published by IANA at https://www.iana.org/assignments/yang-parameters."; revision 2025-09-29 { description "This initial version of the module was manually created, to reflect the 'HTTP' specific contents of the 'TLS Application-Layer Protocol Negotiation (ALPN) Protocol IDs' registry' (RFC 7301) maintained by IANA."; reference "RFC 7301: Transport Layer Security (TLS) Application-Layer Protocol Negotiation Extension"; } typedef http-protocol-version { type enumeration { enum 'HTTP/0.9' { description "Enumeration for the 'HTTP/0.9' HTTP protocol version."; reference "RFC 1945: Hypertext Transfer Protocol -- HTTP/1.0"; } enum 'HTTP/1.0' { description "Enumeration for the 'HTTP/1.0' HTTP protocol version."; reference "RFC 1945: Hypertext Transfer Protocol -- HTTP/1.0"; } enum 'HTTP/1.1' { description "Enumeration for the 'HTTP/1.1' HTTP protocol version."; reference "RFC 9112: HTTP/1.1"; } enum 'HTTP/2 over TLS' { description "Enumeration for the 'HTTP/2 over TLS' HTTP protocol version."; reference "RFC 9113: HTTP/2"; } enum 'HTTP/2 over TCP' { description "Enumeration for the 'HTTP/2 over TCP' HTTP protocol version."; reference "RFC 9113: HTTP/2"; } enum 'HTTP/3' { description "Enumeration for the 'HTTP/3' HTTP protocol version."; reference "RFC 9114: HTTP/3"; } } description "An enumeration for HTTP protocol versions."; } }¶
<CODE ENDS>¶
Modified Abstract and Intro to be more accurate wrt intended applicability.¶
In ietf-http-client, removed "protocol-version" and all auth schemes except "basic".¶
In ietf-http-client, factored out "client-identity-grouping" for proxy connections.¶
In ietf-http-server, removed "choice required-or-optional" and "choice inline-or-external".¶
In ietf-http-server, moved the basic auth under a "choice auth-type" limited by new "feature basic-auth".¶
Removed the unused "external-client-auth-supported" feature from ietf-http-server.¶
Added a parent "container" to "client-identity-grouping" so that it could be better used by the proxy model.¶
Added a "choice" to the proxy model enabling selection of proxy types.¶
Added 'http-client-stack-grouping' and 'http-server-listen-stack-grouping' convenience groupings.¶
Expanded "Data Model Overview section(s) [remove "wall" of tree diagrams].¶
Updated the Security Considerations section.¶
Added XML-comment above examples explaining the reason for the unusual top-most element's presence.¶
Renamed 'client-auth-config-supported' to 'client-auth-supported' consistent with other drafts.¶
Wrapped 'container basic' choice inside a 'case basic' per best practice.¶
Aligned modules with `pyang -f` formatting.¶
Fixed nits found by YANG Doctor reviews.¶
NO UPDATE.¶
Updated per Shepherd reviews impacting the suite of drafts.¶
Updated per Shepherd reviews impacting the suite of drafts.¶
Addresses AD review comments.¶
Added note to Editor to fix line foldings.¶
Removed "Conventions" section as there are no "BASE64VALUE=" values used in draft.¶
Clarified that the modules, when implemented, do not define any protocol-accessible nodes.¶
Added Security Considerations text to also look a SC-section from imported modules.¶
Removed "A wrapper around the foobar parameters to avoid name collisions" text.¶
Removed "public-key-format" and "public-key" nodes from examples.¶
Addresses AD review by Rob Wilton.¶
Addresses 1st-round of IESG reviews.¶
Addresses issues found in OpsDir review of the ssh-client-server draft.¶
s/defines/presents/ in a few places.¶
Add refs to where the 'operational' and 'system' datastores are defined.¶
Renamed Security Considerations section s/Template for/Considerations for/.¶
Updated "http-client-stack-grouping" and "http-server-listen-stack-grouping" for HTTP/3.¶
Address IESG review comments.¶
Updated to reflect comments from Paul Wouters.¶
Replaced 'uri' as string with a container with components.¶
Added 'if-feature full-uri-supported' statement to the 'path', 'query' and 'fragment' components¶
Replaced 'protocol-versions' as 'bits' with a min/max range¶
Fixed 'proxy-connect' to reflect RFC 9110 (not legacy the HTTP/S Proxy mechanism)¶
Added support for CONNECT-UDP per RFC 9298¶
Eliminated the 'http-client-common-grouping' grouping (not needed after updating the proxy solution)¶
Renamed 'http-server-stack-grouping' to 'http-server-listen-stack-grouping', to make way for a possible future 'http-server-callhome-stack-grouping'¶
Updated to reflect some of Med's AD-review comments¶
Added ability for HTTP server's to also limit what HTTP versions are supported.¶
Factored the "uri" node into a grouping defined in another module.¶
Replaced min/max versions with a list of versions, defined by an IANA-maintained YANG module.¶
Since "feature" statements cannot be used with IANA-maintained modules, a new conifg false "supported-versions" list is used to express which HTTP versions the implementation programatically supports.¶
Notably, the "supported-versions" list, which is "config false", is defined per use (not globally), which is actually very cool, as it enables various parts of the data tree to express support for different HTTP versions.¶
The authors would like to thank the following for lively discussions on list and in the halls (ordered by first name): Ben Schwartz, Darrel Miller, Éric Vyncke, Francesca Palombini, Mark Nottingham, Mahesh Jethanandani, Med Boucladair, Mike Bishop, Murray Kucherawy, Orie Steele, Rob Wilton, Robert Varga, Roman Danyliw, Shivan Sahib, Willy Tarreau, and Zaheduzzaman Sarker.¶