Internet-Draft | Groupings for TCP Clients and Servers | February 2024 |
Watsen & Scharf | Expires 11 August 2024 | [Page] |
This document defines three YANG 1.1 modules to support the configuration of TCP clients and TCP servers. The modules include basic parameters of a TCP connection relevant for client or server applications, as well as client configuration required for traversing proxies. The modules can be used either standalone or in conjunction with configuration of other stack protocol layers.¶
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:¶
AAAA
--> the assigned RFC value for draft-ietf-netconf-crypto-types¶
DDDD
--> the assigned RFC value for this draft¶
Artwork in this document contains placeholder values for the date of publication of this draft. Please apply the following replacement:¶
2024-02-08
--> 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.¶
The following Appendix section is to be removed prior to publication:¶
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 11 August 2024.¶
Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
This document defines three YANG 1.1 [RFC7950] modules to support the configuration of TCP clients and TCP servers (TCP is defined in [RFC9293]), either as standalone or in conjunction with configuration of other stack protocol layers.¶
The modules focus on three different types of base TCP parameters that matter for TCP-based applications: First, the modules cover fundamental configuration of a TCP client or TCP server application, such as addresses and port numbers. Second, a reusable grouping enables modification of application-specific parameters for a TCP connections, such as use of TCP keep-alives. And third, client configuration for traversing proxies is included as well. In each case, the modules have a very narrow scope and focus on a minimum set of required parameters.¶
This document presents one or more YANG modules [RFC7950] that are part of a collection of RFCs that work together to, ultimately, enable the configuration of both the clients and servers of both the NETCONF [RFC6241] and RESTCONF [RFC8040] protocols.¶
The dependency relationship between the primary 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 | [I-D.ietf-netconf-crypto-types] |
truststore | [I-D.ietf-netconf-trust-anchors] |
keystore | [I-D.ietf-netconf-keystore] |
tcp-client-server | [I-D.ietf-netconf-tcp-client-server] |
ssh-client-server | [I-D.ietf-netconf-ssh-client-server] |
tls-client-server | [I-D.ietf-netconf-tls-client-server] |
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]. It does not define any protocol accessible nodes that are "config false".¶
This section defines a YANG 1.1 module called "ietf-tcp-common". A high-level overview of the module is provided in Section 2.1. Examples illustrating the module's use are provided in Examples (Section 2.2). The YANG module itself is defined in Section 2.3.¶
This section provides an overview of the "ietf-tcp-common" module in terms of its features and groupings.¶
This document defines a common "grouping" statement for basic TCP connection parameters that matter to applications. It is "common" in that this grouping is used by both the "ietf-tcp-client" and "ietf-tcp-server" modules. In some TCP stacks, such parameters can also directly be set by an application using system calls, such as the sockets API. The base YANG model in this document focuses on modeling TCP keep-alives. This base model can be extended as needed.¶
The following diagram lists all the "feature" statements defined in the "ietf-tcp-common" module:¶
Features: +-- keepalives-supported¶
The diagram above uses syntax that is similar to but not defined in [RFC8340].¶
The "ietf-tcp-common" module defines the following "grouping" statement:¶
This grouping is presented in the following subsection.¶
The following tree diagram [RFC8340] illustrates the "tcp-common-grouping" grouping:¶
grouping tcp-common-grouping: +-- keepalives! {keepalives-supported}? +-- idle-time? uint16 +-- max-probes? uint16 +-- probe-interval? uint16¶
Comments:¶
The "ietf-tcp-common" module defines only "grouping" statements that are used by other modules to instantiate protocol-accessible nodes. Thus this module, when implemented, does not itself define any protocol-accessible nodes.¶
Network stacks may include "keep-alives" in their TCP implementations, although this practice is not universally accepted. If keep-alives are included, [RFC9293] mandates that the application MUST be able to turn them on or off for each TCP connection, and that they MUST default to off.¶
Keep-alive mechanisms exist in many protocols. Depending on the protocol stack, TCP keep-alives may only be one out of several alternatives. Which mechanism(s) to use depends on the use case and application requirements. If keep-alives are needed by an application, it is RECOMMENDED that the liveness check happens only at the protocol layers that are meaningful to the application.¶
A TCP keep-alive mechanism SHOULD only be invoked in server applications that might otherwise hang indefinitely and consume resources unnecessarily if a client crashes or aborts a connection during a network failure [RFC9293]. TCP keep-alives may consume significant resources both in the network and in endpoints (e.g., battery power). In addition, frequent keep-alives risk network congestion. The higher the frequency of keep-alives, the higher the overhead.¶
Given the cost of keep-alives, parameters have to be configured carefully:¶
This section presents an example showing the "tcp-common-grouping" populated with some data.¶
<!-- The outermost element below doesn't exist in the data model. --> <!-- It simulates if the "grouping" were a "container" instead. --> <tcp-common xmlns="urn:ietf:params:xml:ns:yang:ietf-tcp-common"> <keepalives> <idle-time>7200</idle-time> <max-probes>9</max-probes> <probe-interval>75</probe-interval> </keepalives> </tcp-common>¶
The ietf-tcp-common YANG module references [RFC6991] and [RFC9293].¶
<CODE BEGINS> file "ietf-tcp-common@2024-02-08.yang"¶
module ietf-tcp-common { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-tcp-common"; prefix tcpcmn; organization "IETF NETCONF (Network Configuration) Working Group and the IETF TCP Maintenance and Minor Extensions (TCPM) Working Group"; contact "WG Web: https://datatracker.ietf.org/wg/netconf https://datatracker.ietf.org/wg/tcpm WG List: NETCONF WG list <mailto:netconf@ietf.org> TCPM WG list <mailto:tcpm@ietf.org> Authors: Kent Watsen <mailto:kent+ietf@watsen.net> Michael Scharf <mailto:michael.scharf@hs-esslingen.de>"; description "This module define a reusable 'grouping' that is common to both TCP-clients and TCP-servers. This grouping statement is used by both the 'ietf-tcp-client' and 'ietf-tcp-server' modules. Copyright (c) 2023 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 DDDD (https://www.rfc-editor.org/info/rfcDDDD); 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 2024-02-08 { description "Initial version"; reference "RFC DDDD: YANG Groupings for TCP Clients and TCP Servers"; } // Features feature keepalives-supported { description "Indicates that keepalives are supported."; } // Groupings grouping tcp-common-grouping { description "A reusable grouping for configuring TCP parameters common to TCP connections as well as the operating system as a whole."; container keepalives { if-feature "keepalives-supported"; presence "Indicates that keepalives are enabled, aligning to the requirement in Section 3.8.4 RFC 9293 that keepalives are off by default."; description "Configures the keep-alive policy, to proactively test the aliveness of the TCP peer. An unresponsive TCP peer is dropped after approximately (idle-time + max-probes * probe-interval) seconds. Further guidance can be found in Section 2.1.5 of RFC DDDD."; reference "RFC 9293: Transmission Control Protocol (TCP)"; leaf idle-time { type uint16 { range "1..max"; } units "seconds"; default 7200; description "Sets the amount of time after which if no data has been received from the TCP peer, a TCP-level probe message will be sent to test the aliveness of the TCP peer. Two hours (7200 seconds) is safe value, per RFC 9293 Section 3.8.4."; reference "RFC 9293: Transmission Control Protocol (TCP)"; } leaf max-probes { type uint16 { range "1..max"; } default 9; description "Sets the maximum number of sequential keep-alive probes that can fail to obtain a response from the TCP peer before assuming the TCP peer is no longer alive."; } leaf probe-interval { type uint16 { range "1..max"; } units "seconds"; default 75; description "Sets the time interval between failed probes. The interval SHOULD be significantly longer than one second in order to avoid harm on a congested link."; } } // container keepalives } // grouping tcp-common-grouping }¶
<CODE ENDS>¶
This section defines a YANG 1.1 module called "ietf-tcp-client". A high-level overview of the module is provided in Section 3.1. Examples illustrating the module's use are provided in Examples (Section 3.2). The YANG module itself is defined in Section 3.3.¶
This section provides an overview of the "ietf-tcp-client" module in terms of its features and groupings.¶
The following diagram lists all the "feature" statements defined in the "ietf-tcp-client" module:¶
Features: +-- local-binding-supported +-- tcp-client-keepalives +-- proxy-connect +-- socks5-gss-api +-- socks5-username-password¶
The diagram above uses syntax that is similar to but not defined in [RFC8340].¶
The "ietf-tcp-client" module defines the following "grouping" statement:¶
This grouping is presented in the following subsection.¶
The following tree diagram [RFC8340] illustrates the "tcp-client-grouping" grouping:¶
grouping tcp-client-grouping: +-- remote-address inet:host +-- remote-port? inet:port-number +-- local-address? inet:ip-address | {local-binding-supported}? +-- local-port? inet:port-number | {local-binding-supported}? +-- proxy-server! {proxy-connect}? | +-- (proxy-type) | +--:(socks4) | | +-- socks4-parameters | | +-- remote-address inet:ip-address | | +-- remote-port? inet:port-number | +--:(socks4a) | | +-- socks4a-parameters | | +-- remote-address inet:host | | +-- remote-port? inet:port-number | +--:(socks5) | +-- socks5-parameters | +-- remote-address inet:host | +-- remote-port? inet:port-number | +-- authentication-parameters! | +-- (auth-type) | +--:(gss-api) {socks5-gss-api}? | | +-- gss-api | +--:(username-password) | {socks5-username-password}? | +-- username-password | +-- username string | +---u ct:password-grouping +---u tcpcmn:tcp-common-grouping¶
Comments:¶
The "ietf-tcp-client" module defines only "grouping" statements that are used by other modules to instantiate protocol-accessible nodes. Thus this module, when implemented, does not itself define any protocol-accessible nodes.¶
This section presents two examples showing the "tcp-client-grouping" populated with some data. This example shows a TCP-client configured to not connect via a proxy:¶
<!-- The outermost element below doesn't exist in the data model. --> <!-- It simulates if the "grouping" were a "container" instead. --> <tcp-client xmlns="urn:ietf:params:xml:ns:yang:ietf-tcp-client"> <remote-address>www.example.com</remote-address> <remote-port>8443</remote-port> <local-address>192.0.2.2</local-address> <local-port>12345</local-port> <keepalives> <idle-time>7200</idle-time> <max-probes>9</max-probes> <probe-interval>75</probe-interval> </keepalives> </tcp-client>¶
This example shows a TCP-client configured to connect via a proxy:¶
<!-- The outermost element below doesn't exist in the data model. --> <!-- It simulates if the "grouping" were a "container" instead. --> <tcp-client xmlns="urn:ietf:params:xml:ns:yang:ietf-tcp-client"> <remote-address>www.example.com</remote-address> <remote-port>8443</remote-port> <local-address>192.0.2.2</local-address> <local-port>12345</local-port> <proxy-server> <socks5-parameters> <remote-address>proxy.example.com</remote-address> <remote-port>1080</remote-port> <authentication-parameters> <username-password> <username>foobar</username> <cleartext-password>secret</cleartext-password> </username-password> </authentication-parameters> </socks5-parameters> </proxy-server> <keepalives> <idle-time>7200</idle-time> <max-probes>9</max-probes> <probe-interval>75</probe-interval> </keepalives> </tcp-client>¶
The ietf-tcp-client YANG module references [SOCKS_4A], [RFC1928], [RFC1929], [RFC2743], [RFC6991], [RFC9293], and [I-D.ietf-netconf-crypto-types].¶
<CODE BEGINS> file "ietf-tcp-client@2024-02-08.yang"¶
module ietf-tcp-client { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-tcp-client"; prefix tcpc; import ietf-inet-types { prefix inet; reference "RFC 6991: Common YANG Data Types"; } import ietf-crypto-types { prefix ct; reference "RFC AAAA: YANG Data Types and Groupings for Cryptography"; } import ietf-tcp-common { prefix tcpcmn; reference "RFC DDDD: YANG Groupings for TCP Clients and TCP Servers"; } organization "IETF NETCONF (Network Configuration) Working Group and the IETF TCP Maintenance and Minor Extensions (TCPM) Working Group"; contact "WG Web: https://datatracker.ietf.org/wg/netconf https://datatracker.ietf.org/wg/tcpm WG List: NETCONF WG list <mailto:netconf@ietf.org> TCPM WG list <mailto:tcpm@ietf.org> Authors: Kent Watsen <mailto:kent+ietf@watsen.net> Michael Scharf <mailto:michael.scharf@hs-esslingen.de>"; description "This module defines reusable groupings for TCP clients that can be used as a basis for specific TCP client instances. 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 DDDD (https://www.rfc-editor.org/info/rfcDDDD); 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 2024-02-08 { description "Initial version"; reference "RFC DDDD: YANG Groupings for TCP Clients and TCP Servers"; } // Features feature local-binding-supported { description "Indicates that the server supports configuring local bindings (i.e., the local address and local port) for TCP clients."; } feature tcp-client-keepalives { description "Per socket TCP keepalive parameters are configurable for TCP clients on the server implementing this feature."; reference "RFC 9293: Transmission Control Protocol (TCP)"; } feature proxy-connect { description "Proxy connection configuration is configurable for TCP clients on the server implementing this feature. Currently supports SOCKS 4, SOCKS 4a, and SOCKS 5."; reference "SOCKS Proceedings: 1992 Usenix Security Symposium. OpenSSH message: SOCKS 4A: A Simple Extension to SOCKS 4 Protocol https://www.openssh.com/txt/socks4a.protocol RFC 1928: SOCKS Protocol Version 5"; } feature socks5-gss-api { description "Indicates that the server, when acting as a TCP-client, supports authenticating to a SOCKS Version 5 proxy server using GSSAPI credentials."; reference "RFC 1928: SOCKS Protocol Version 5"; } feature socks5-username-password { description "Indicates that the server, when acting as a TCP-client, supports authenticating to a SOCKS Version 5 proxy server using 'username' and 'password' credentials."; reference "RFC 1928: SOCKS Protocol Version 5"; } // Groupings grouping tcp-client-grouping { description "A reusable grouping for configuring a TCP client. 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 'tcp-client-parameters'). This model purposely does not do this itself so as to provide maximum flexibility to consuming models."; leaf remote-address { type inet:host; mandatory true; description "The IP address or hostname of the remote peer to establish a connection with. If a domain name is configured, then the DNS resolution should happen on each connection attempt. If the DNS resolution results in multiple IP addresses, the IP addresses are tried according to local preference order until a connection has been established or until all IP addresses have failed."; } leaf remote-port { type inet:port-number; default "0"; description "The IP port number for the remote peer to establish a connection with. An invalid default value is used so that importing modules may 'refine' it with the appropriate default port number value."; } leaf local-address { if-feature "local-binding-supported"; type inet:ip-address; description "The local IP address/interface to bind to for when connecting to the remote peer. INADDR_ANY ('0.0.0.0') or INADDR6_ANY ('0:0:0:0:0:0:0:0' a.k.a. '::') MAY be used to explicitly indicate the implicit default, that the server can bind to any IPv4 or IPv6 addresses, respectively."; } leaf local-port { if-feature "local-binding-supported"; type inet:port-number; default "0"; description "The local IP port number to bind to for when connecting to the remote peer. The port number '0', which is the default value, indicates that any available local port number may be used."; } container proxy-server { if-feature "proxy-connect"; presence "Indicates that a proxy connection has been configured. Present so that the mandatory descendant nodes do not imply that this node must be configured."; choice proxy-type { mandatory true; description "Selects a proxy connection protocol."; case socks4 { container socks4-parameters { leaf remote-address { type inet:ip-address; mandatory true; description "The IP address of the proxy server."; } leaf remote-port { type inet:port-number; default "1080"; description "The IP port number for the proxy server."; } description "Parameters for connecting to a TCP-based proxy server using the SOCKS4 protocol."; reference "SOCKS, Proceedings: 1992 Usenix Security Symposium."; } } case socks4a { container socks4a-parameters { leaf remote-address { type inet:host; mandatory true; description "The IP address or hostname of the proxy server."; } leaf remote-port { type inet:port-number; default "1080"; description "The IP port number for the proxy server."; } description "Parameters for connecting to a TCP-based proxy server using the SOCKS4a protocol."; reference "SOCKS Proceedings: 1992 Usenix Security Symposium. OpenSSH message: SOCKS 4A: A Simple Extension to SOCKS 4 Protocol https://www.openssh.com/txt/socks4a.protocol"; } } case socks5 { container socks5-parameters { leaf remote-address { type inet:host; mandatory true; description "The IP address or hostname of the proxy server."; } leaf remote-port { type inet:port-number; default "1080"; description "The IP port number for the proxy server."; } container authentication-parameters { presence "Indicates that an authentication mechanism has been configured. Present so that the mandatory descendant nodes do not imply that this node must be configured."; description "A container for SOCKS Version 5 authentication mechanisms. A complete list of methods is defined at: https://www.iana.org/assignments/socks-methods /socks-methods.xhtml."; reference "RFC 1928: SOCKS Protocol Version 5"; choice auth-type { mandatory true; description "A choice amongst supported SOCKS Version 5 authentication mechanisms."; case gss-api { if-feature "socks5-gss-api"; container gss-api { description "Contains GSS-API configuration. Defines as an empty container to enable specific GSS-API configuration to be augmented in by future modules."; reference "RFC 1928: SOCKS Protocol Version 5 RFC 2743: Generic Security Service Application Program Interface Version 2, Update 1"; } } case username-password { if-feature "socks5-username-password"; container username-password { leaf username { type string; mandatory true; description "The 'username' value to use for client identification."; } uses ct:password-grouping { description "The password to be used for client authentication."; } description "Contains Username/Password configuration."; reference "RFC 1929: Username/Password Authentication for SOCKS V5"; } } } } description "Parameters for connecting to a TCP-based proxy server using the SOCKS5 protocol."; reference "RFC 1928: SOCKS Protocol Version 5"; } } } description "Proxy server settings."; } uses tcpcmn:tcp-common-grouping { refine "keepalives" { if-feature "tcp-client-keepalives"; description "An if-feature statement so that implementations can choose to support TCP client keepalives."; } } } }¶
<CODE ENDS>¶
This section defines a YANG 1.1 module called "ietf-tcp-server". A high-level overview of the module is provided in Section 4.1. Examples illustrating the module's use are provided in Examples (Section 4.2). The YANG module itself is defined in Section 4.3.¶
This section provides an overview of the "ietf-tcp-server" module in terms of its features and groupings.¶
The following diagram lists all the "feature" statements defined in the "ietf-tcp-server" module:¶
Features: +-- tcp-server-keepalives¶
The diagram above uses syntax that is similar to but not defined in [RFC8340].¶
The "ietf-tcp-server" module defines the following "grouping" statement:¶
This grouping is presented in the following subsection.¶
The following tree diagram [RFC8340] illustrates the "tcp-server-grouping" grouping:¶
grouping tcp-server-grouping: +-- local-address inet:ip-address +-- local-port? inet:port-number +---u tcpcmn:tcp-common-grouping¶
Comments:¶
The "ietf-tcp-server" module defines only "grouping" statements that are used by other modules to instantiate protocol-accessible nodes. Thus this module, when implemented, does not itself define any protocol-accessible nodes.¶
This section presents an example showing the "tcp-server-grouping" populated with some data.¶
<!-- The outermost element below doesn't exist in the data model. --> <!-- It simulates if the "grouping" were a "container" instead. --> <tcp-server xmlns="urn:ietf:params:xml:ns:yang:ietf-tcp-server"> <local-address>192.0.2.2</local-address> <local-port>49152</local-port> <keepalives> <idle-time>7200</idle-time> <max-probes>9</max-probes> <probe-interval>75</probe-interval> </keepalives> </tcp-server>¶
The ietf-tcp-server YANG module references [RFC6991] and [RFC9293].¶
<CODE BEGINS> file "ietf-tcp-server@2024-02-08.yang"¶
module ietf-tcp-server { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-tcp-server"; prefix tcps; import ietf-inet-types { prefix inet; reference "RFC 6991: Common YANG Data Types"; } import ietf-tcp-common { prefix tcpcmn; reference "RFC DDDD: YANG Groupings for TCP Clients and TCP Servers"; } organization "IETF NETCONF (Network Configuration) Working Group and the IETF TCP Maintenance and Minor Extensions (TCPM) Working Group"; contact "WG Web: https://datatracker.ietf.org/wg/netconf https://datatracker.ietf.org/wg/tcpm WG List: NETCONF WG list <mailto:netconf@ietf.org> TCPM WG list <mailto:tcpm@ietf.org> Authors: Kent Watsen <mailto:kent+ietf@watsen.net> Michael Scharf <mailto:michael.scharf@hs-esslingen.de>"; description "This module defines reusable groupings for TCP servers that can be used as a basis for specific TCP server instances. 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 DDDD (https://www.rfc-editor.org/info/rfcDDDD); 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 2024-02-08 { description "Initial version"; reference "RFC DDDD: YANG Groupings for TCP Clients and TCP Servers"; } // Features feature tcp-server-keepalives { description "Per socket TCP keepalive parameters are configurable for TCP servers on the server implementing this feature."; reference "RFC 9293: Transmission Control Protocol (TCP)"; } // Groupings grouping tcp-server-grouping { description "A reusable grouping for configuring a TCP server. 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 'tcp-server-parameters'). This model purposely does not do this itself so as to provide maximum flexibility to consuming models."; leaf local-address { type inet:ip-address; mandatory true; description "The local IP address to listen on for incoming TCP client connections. INADDR_ANY (0.0.0.0) or INADDR6_ANY (0:0:0:0:0:0:0:0 a.k.a. ::) MUST be used when the server is to listen on all IPv4 or IPv6 addresses, respectively."; } leaf local-port { type inet:port-number; default "0"; description "The local port number to listen on for incoming TCP client connections. An invalid default value (0) is used (instead of 'mandatory true') so that an application level data model may 'refine' it with an application specific default port number value."; } uses tcpcmn:tcp-common-grouping { refine "keepalives" { if-feature "tcp-server-keepalives"; description "An if-feature statement so that implementations can choose to support TCP server keepalives."; } } } }¶
<CODE ENDS>¶
This section follows the template defined in Section 3.7.1 of [RFC8407].¶
The "ietf-tcp-common" YANG module defines "grouping" statements that are 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.¶
Since the module in this document only define groupings, these considerations are primarily for the designers of other modules that use these groupings.¶
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 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.¶
None of the writable data nodes defined in this YANG module are considered sensitive or vulnerable in network environments. The NACM "default-deny-write" extension has not been set for any data nodes defined in this module.¶
This module does not define any RPCs, actions, or notifications, and thus the security consideration for such is not provided here.¶
This section follows the template defined in Section 3.7.1 of [RFC8407].¶
The "ietf-tcp-client" YANG module defines "grouping" statements that are 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.¶
Since the module in this document only define groupings, these considerations are primarily for the designers of other modules that use these groupings.¶
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.¶
One readable data node defined in this YANG module may be considered sensitive or vulnerable in some network environments. This node is as follows:¶
The "proxy-server/socks5-parameters/authentication-parameters/username-password/password" node:¶
None of the writable data nodes defined in this YANG module are considered sensitive or vulnerable in network environments. The NACM "default-deny-write" extension has not been set for any data nodes defined in this module.¶
This module does not define any RPCs, actions, or notifications, and thus the security consideration for such is not provided here.¶
Implementations are RECOMMENDED to implement the "local-binding-supported" feature for cryptographically-secure protocols, so as to enable more granular ingress/egress firewall rulebases. It is NOT RECOMMENDED to implement this feature for unsecure protocols, as per [RFC6056].¶
This section follows the template defined in Section 3.7.1 of [RFC8407].¶
The "ietf-tcp-server" YANG module defines "grouping" statements that are 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.¶
Since the module in this document only define groupings, these considerations are primarily for the designers of other modules that use these groupings.¶
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 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.¶
None of the writable data nodes defined in this YANG module are considered sensitive or vulnerable in network environments. The NACM "default-deny-write" extension has not been set for any data nodes defined in this module.¶
This module does not define any RPCs, actions, or notifications, and thus the security consideration for such is not provided here.¶
This document registers three 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:ietf-tcp-common Registrant Contact: The IESG XML: N/A, the requested URI is an XML namespace. URI: urn:ietf:params:xml:ns:yang:ietf-tcp-client Registrant Contact: The IESG XML: N/A, the requested URI is an XML namespace. URI: urn:ietf:params:xml:ns:yang:ietf-tcp-server Registrant Contact: The IESG XML: N/A, the requested URI is an XML namespace.¶
This document registers three YANG modules in the YANG Module Names registry [RFC6020]. Following the format in [RFC6020], the following registrations are requested:¶
name: ietf-tcp-common namespace: urn:ietf:params:xml:ns:yang:ietf-tcp-common prefix: tcpcmn reference: RFC DDDD name: ietf-tcp-client namespace: urn:ietf:params:xml:ns:yang:ietf-tcp-client prefix: tcpc reference: RFC DDDD name: ietf-tcp-server namespace: urn:ietf:params:xml:ns:yang:ietf-tcp-server prefix: tcps reference: RFC DDDD¶
This section is to be removed before publishing as an RFC.¶
The authors would like to thank for following for lively discussions on list and in the halls (ordered by first name): Jürgen Schönwälder, Ladislav Lhotka, Nick Hancock, Per Andersson, Rob Wilton, and Tom Petch.¶