NETCONF Working Group K. Watsen Internet-Draft Watsen Networks Intended status: Standards Track M. Scharf Expires: December 18, 2020 Hochschule Esslingen June 16, 2020 YANG Groupings for TCP Clients and TCP Servers draft-ietf-netconf-tcp-client-server-06 Abstract This document defines three YANG modules: the first defines a grouping for configuring a generic TCP client, the second defines a grouping for configuring a generic TCP server, and the third defines a grouping common to the TCP clients and TCP servers. Editorial Note (To be removed by RFC Editor) 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: o "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: o "2020-06-16" --> the publication date of this draft The following Appendix section is to be removed prior to publication: o Appendix A. Change Log Note to Reviewers (To be removed by RFC Editor) This document presents a YANG module or modules that is/are part of a collection of drafts that work together to produce the ultimate goal of the NETCONF WG: to define configuration modules for NETCONF client and servers, and RESTCONF client and servers. The relationship between the various drafts in the collection is presented in the below diagram. Watsen & Scharf Expires December 18, 2020 [Page 1] Internet-Draft Groupings for TCP Clients and Servers June 2020 crypto-types ^ ^ / \ / \ trust-anchors keystore ^ ^ ^ ^ | +---------+ | | | | | | | +------------+ | tcp-client-server | / | | ^ ^ ssh-client-server | | | | ^ tls-client-server | | | ^ ^ http-client-server | | | | | ^ | | | +-----+ +---------+ | | | | | | | | +-----------|--------|--------------+ | | | | | | | | +-----------+ | | | | | | | | | | | | | | | | | netconf-client-server restconf-client-server Full draft names and link to drafts: o draft-ietf-netconf-crypto-types (html [1]) o draft-ietf-netconf-trust-anchors (html [2]) o draft-ietf-netconf-keystore (html [3]) o draft-ietf-netconf-tcp-client-server (html [4]) o draft-ietf-netconf-ssh-client-server (html [5]) o draft-ietf-netconf-tls-client-server (html [6]) o draft-ietf-netconf-http-client-server (html [7]) o draft-ietf-netconf-netconf-client-server (html [8]) o draft-ietf-netconf-restconf-client-server (html [9]) Watsen & Scharf Expires December 18, 2020 [Page 2] Internet-Draft Groupings for TCP Clients and Servers June 2020 Status of This Memo 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 December 18, 2020. Copyright Notice Copyright (c) 2020 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 Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 4 3. The TCP Common Model . . . . . . . . . . . . . . . . . . . . 4 3.1. Model Scope . . . . . . . . . . . . . . . . . . . . . . . 4 3.2. Usage Guidelines for Configuring TCP Keep-Alives . . . . 5 3.3. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 6 3.4. Example Usage . . . . . . . . . . . . . . . . . . . . . . 6 3.5. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 6 4. The TCP Client Model . . . . . . . . . . . . . . . . . . . . 9 4.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 9 4.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 10 4.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 11 5. The TCP Server Model . . . . . . . . . . . . . . . . . . . . 18 5.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 18 Watsen & Scharf Expires December 18, 2020 [Page 3] Internet-Draft Groupings for TCP Clients and Servers June 2020 5.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 18 5.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 18 6. Security Considerations . . . . . . . . . . . . . . . . . . . 21 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 22 7.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 22 7.2. The YANG Module Names Registry . . . . . . . . . . . . . 22 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 22 8.1. Normative References . . . . . . . . . . . . . . . . . . 22 8.2. Informative References . . . . . . . . . . . . . . . . . 23 8.3. URIs . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 25 A.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 25 A.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 25 A.3. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 25 A.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 25 A.5. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 25 A.6. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 25 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 25 1. Introduction This document defines three YANG 1.1 [RFC7950] modules: the first defines a grouping for configuring a generic TCP client, the second defines a grouping for configuring a generic TCP server, and the third defines a grouping common to the TCP clients and TCP servers. It is intended that these groupings will be used either standalone, for TCP-based protocols, as part of a stack of protocol-specific configuration models. For instance, these groupings could help define the configuration module for SSH, TLS, or HTTP based applications. 2. Terminology 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. 3. The TCP Common Model 3.1. Model Scope This document defines a common "grouping" statement for basic TCP connection parameters that matter to applications. In some TCP stacks, such parameters can also directly be set by an application using system calls, such as the socket API. The base YANG model in Watsen & Scharf Expires December 18, 2020 [Page 4] Internet-Draft Groupings for TCP Clients and Servers June 2020 this document focuses on modeling TCP keep-alives. This base model can be extended as needed. 3.2. Usage Guidelines for Configuring TCP Keep-Alives Network stacks may include "keep-alives" in their TCP implementations, although this practice is not universally accepted. If keep-alives are included, [RFC1122] [RFC793bis] 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 aliveness 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 [RFC1122]. 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: o The default idle interval (leaf "idle-time") MUST default to no less than two hours, i.e., 7200 seconds [RFC1122]. A lower value MAY be configured, but keep-alive messages SHOULD NOT be transmitted more frequently than once every 15 seconds. Longer intervals SHOULD be used when possible. o The maximum number of sequential keep-alive probes that can fail (leaf "max-probes") trades off responsiveness and robustness against packet loss. ACK segments that contain no data are not reliably transmitted by TCP. Consequently, if a keep-alive mechanism is implemented it MUST NOT interpret failure to respond to any specific probe as a dead connection [RFC1122]. Typically a single-digit number should suffice. o TCP implementations may include a parameter for the number of seconds between TCP keep-alive probes (leaf "probe-interval"). In order to avoid congestion, the time interval between probes MUST NOT be smaller than one second. Significantly longer intervals Watsen & Scharf Expires December 18, 2020 [Page 5] Internet-Draft Groupings for TCP Clients and Servers June 2020 SHOULD be used. It is important to note that keep-alive probes (or replies) can get dropped due to network congestion. Sending further probe messages into a congested path after a short interval, without backing off timers, could cause harm and result in a congestion collapse. Therefore it is essential to pick a large, conservative value for this interval. 3.3. Tree Diagram This section provides a tree diagram [RFC8340] for the "ietf-tcp- common" module. module: ietf-tcp-common grouping tcp-common-grouping +-- keepalives! {keepalives-supported}? +-- idle-time uint16 +-- max-probes uint16 +-- probe-interval uint16 grouping tcp-connection-grouping +-- keepalives! {keepalives-supported}? +-- idle-time uint16 +-- max-probes uint16 +-- probe-interval uint16 3.4. Example Usage This section presents an example showing the "tcp-common-grouping" populated with some data. 15 3 30 3.5. YANG Module The ietf-tcp-common YANG module references [RFC6991]. file "ietf-tcp-common@2020-06-16.yang" module ietf-tcp-common { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-tcp-common"; prefix tcpcmn; Watsen & Scharf Expires December 18, 2020 [Page 6] Internet-Draft Groupings for TCP Clients and Servers June 2020 organization "IETF NETCONF (Network Configuration) Working Group and the IETF TCP Maintenance and Minor Extensions (TCPM) Working Group"; contact "WG Web: WG List: Authors: Kent Watsen Michael Scharf "; description "This module defines reusable groupings for TCP commons that can be used as a basis for specific TCP common instances. Copyright (c) 2020 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 Simplified 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 2020-06-16 { description "Initial version"; reference "RFC DDDD: YANG Groupings for TCP Clients and TCP Servers"; } // Features feature keepalives-supported { description Watsen & Scharf Expires December 18, 2020 [Page 7] Internet-Draft Groupings for TCP Clients and Servers June 2020 "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."; 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."; leaf idle-time { type uint16 { range "1..max"; } units "seconds"; mandatory true; 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 1122."; reference "RFC 1122: Requirements for Internet Hosts -- Communication Layers"; } leaf max-probes { type uint16 { range "1..max"; } mandatory true; 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"; Watsen & Scharf Expires December 18, 2020 [Page 8] Internet-Draft Groupings for TCP Clients and Servers June 2020 mandatory true; 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 grouping tcp-connection-grouping { description "A reusable grouping for configuring TCP parameters common to TCP connections."; uses tcp-common-grouping; } } 4. The TCP Client Model 4.1. Tree Diagram This section provides a tree diagram [RFC8340] for the "ietf-tcp- client" module. Watsen & Scharf Expires December 18, 2020 [Page 9] Internet-Draft Groupings for TCP Clients and Servers June 2020 module: ietf-tcp-client 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 | +-- password? string +-- keepalives! {keepalives-supported}? +-- idle-time uint16 +-- max-probes uint16 +-- probe-interval uint16 4.2. Example Usage This section presents an example showing the "tcp-client-grouping" populated with some data. Watsen & Scharf Expires December 18, 2020 [Page 10] Internet-Draft Groupings for TCP Clients and Servers June 2020 www.example.com 443 0.0.0.0 0 15 3 30 4.3. YANG Module The ietf-tcp-client YANG module references [RFC6991]. file "ietf-tcp-client@2020-06-16.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-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: WG List: Authors: Kent Watsen Michael Scharf "; Watsen & Scharf Expires December 18, 2020 [Page 11] Internet-Draft Groupings for TCP Clients and Servers June 2020 description "This module defines reusable groupings for TCP clients that can be used as a basis for specific TCP client instances. Copyright (c) 2020 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 Simplified 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 2020-06-16 { 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."; } feature proxy-connect { Watsen & Scharf Expires December 18, 2020 [Page 12] Internet-Draft Groupings for TCP Clients and Servers June 2020 description "Proxy connection configuration is configurable for TCP clients on the server implementing this feature."; } feature socks5-gss-api { description "Indicates that the server supports authenticating using GSSAPI when initiating TCP connections via and SOCKS Version 5 proxy server."; reference "RFC 1928: SOCKS Protocol Version 5"; } feature socks5-username-password { description "Indicates that the server supports authenticating using username/password when initiating TCP connections via and SOCKS Version 5 proxy server."; 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 descendent 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 Watsen & Scharf Expires December 18, 2020 [Page 13] Internet-Draft Groupings for TCP Clients and Servers June 2020 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 (0) is used (instead of 'mandatory true') so that as application level data model may 'refine' it with an application specific default port number value."; } leaf local-address { if-feature "local-binding-supported"; type inet:ip-address; description "The local IP address/interface (VRF?) 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 is configured. Present so that the 'proxy-type' node's 'mandatory true' doesn't imply that the proxy connection must be configured."; choice proxy-type { mandatory true; description "Selects a proxy connection protocol."; case socks4 { container socks4-parameters { Watsen & Scharf Expires December 18, 2020 [Page 14] Internet-Draft Groupings for TCP Clients and Servers June 2020 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; Watsen & Scharf Expires December 18, 2020 [Page 15] Internet-Draft Groupings for TCP Clients and Servers June 2020 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 'auth-type' node's 'mandatory true' doesn't imply that an authentication mechanism 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; Watsen & Scharf Expires December 18, 2020 [Page 16] Internet-Draft Groupings for TCP Clients and Servers June 2020 container username-password { leaf username { type string; description "The 'username' value to use."; } leaf password { type string; description "The 'password' value to use."; } 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-connection-grouping { augment "keepalives" { if-feature "tcp-client-keepalives"; description "Add an if-feature statement so that implementations can choose to support TCP client keepalives."; } } } } Watsen & Scharf Expires December 18, 2020 [Page 17] Internet-Draft Groupings for TCP Clients and Servers June 2020 5. The TCP Server Model 5.1. Tree Diagram This section provides a tree diagram [RFC8340] for the "ietf-tcp- server" module. module: ietf-tcp-server grouping tcp-server-grouping +-- local-address inet:ip-address +-- local-port? inet:port-number +-- keepalives! {keepalives-supported}? +-- idle-time uint16 +-- max-probes uint16 +-- probe-interval uint16 5.2. Example Usage This section presents an example showing the "tcp-server-grouping" populated with some data. 10.20.30.40 7777 15 3 30 5.3. YANG Module The ietf-tcp-server YANG module references [RFC6991]. file "ietf-tcp-server@2020-06-16.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"; } Watsen & Scharf Expires December 18, 2020 [Page 18] Internet-Draft Groupings for TCP Clients and Servers June 2020 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: WG List: Authors: Kent Watsen Michael Scharf "; description "This module defines reusable groupings for TCP servers that can be used as a basis for specific TCP server instances. Copyright (c) 2020 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 Simplified 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 2020-06-16 { description "Initial version"; reference Watsen & Scharf Expires December 18, 2020 [Page 19] Internet-Draft Groupings for TCP Clients and Servers June 2020 "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."; } // Groupings grouping tcp-server-grouping { description "A reusable grouping for configuring a TCP server. Note that this grouping uses fairly typical descendent 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-connection-grouping { augment "keepalives" { Watsen & Scharf Expires December 18, 2020 [Page 20] Internet-Draft Groupings for TCP Clients and Servers June 2020 if-feature "tcp-server-keepalives"; description "Add an if-feature statement so that implementations can choose to support TCP server keepalives."; } } } } 6. Security Considerations The YANG modules defined in this document 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, TCP) with mutual authentication. The NETCONF 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 modules defined in this document only define groupings, these considerations are primarily for the designers of other modules that use these groupings. There are a number of data nodes defined in the YANG modules that are writable/creatable/deletable (i.e., config true, which is the default). These data nodes may be considered sensitive or vulnerable in some network environments. Write operations (e.g., edit-config) to these data nodes without proper protection can have a negative effect on network operations. These are the subtrees and data nodes and their sensitivity/vulnerability: None of the writable/creatable/deletable data nodes in the YANG modules defined in this document are considered more sensitive or vulnerable then standard configuration. Some of the readable data nodes in the YANG modules may be considered sensitive or vulnerable in some network environments. It is thus important to control read access (e.g., via get, get-config, or notification) to these data nodes. These are the subtrees and data nodes and their sensitivity/vulnerability: None of the readable data nodes in the YANG modules defined in this document are considered more sensitive or vulnerable then standard configuration. Watsen & Scharf Expires December 18, 2020 [Page 21] Internet-Draft Groupings for TCP Clients and Servers June 2020 This document does not define any RPC actions and hence this section does not consider the security of RPCs. 7. IANA Considerations 7.1. The IETF XML Registry This document registers two 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-client Registrant Contact: The NETCONF WG of the IETF. XML: N/A, the requested URI is an XML namespace. URI: urn:ietf:params:xml:ns:yang:ietf-tcp-server Registrant Contact: The NETCONF WG of the IETF. XML: N/A, the requested URI is an XML namespace. 7.2. The YANG Module Names Registry 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-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 8. References 8.1. Normative References [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . Watsen & Scharf Expires December 18, 2020 [Page 22] Internet-Draft Groupings for TCP Clients and Servers June 2020 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, DOI 10.17487/RFC6020, October 2010, . [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", RFC 6991, DOI 10.17487/RFC6991, July 2013, . [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", RFC 7950, DOI 10.17487/RFC7950, August 2016, . [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, . [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration Access Control Model", STD 91, RFC 8341, DOI 10.17487/RFC8341, March 2018, . 8.2. Informative References [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, . [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., and A. Bierman, Ed., "Network Configuration Protocol (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, . [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, . [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, . 8.3. URIs [1] https://tools.ietf.org/html/draft-ietf-netconf-crypto-types [2] https://tools.ietf.org/html/draft-ietf-netconf-trust-anchors [3] https://tools.ietf.org/html/draft-ietf-netconf-keystore Watsen & Scharf Expires December 18, 2020 [Page 23] Internet-Draft Groupings for TCP Clients and Servers June 2020 [4] https://tools.ietf.org/html/draft-ietf-netconf-tcp-client-server [5] https://tools.ietf.org/html/draft-ietf-netconf-ssh-client-server [6] https://tools.ietf.org/html/draft-ietf-netconf-tls-client-server [7] https://tools.ietf.org/html/draft-ietf-netconf-http-client-server [8] https://tools.ietf.org/html/draft-ietf-netconf-netconf-client- server [9] https://tools.ietf.org/html/draft-ietf-netconf-restconf-client- server Watsen & Scharf Expires December 18, 2020 [Page 24] Internet-Draft Groupings for TCP Clients and Servers June 2020 Appendix A. Change Log A.1. 00 to 01 o Added 'local-binding-supported' feature to TCP-client model. o Added 'keepalives-supported' feature to TCP-common model. o Added 'external-endpoint-values' container and 'external- endpoints' feature to TCP-server model. A.2. 01 to 02 o Removed the 'external-endpoint-values' container and 'external- endpoints' feature from the TCP-server model. A.3. 02 to 03 o Moved the common model section to be before the client and server specific sections. o Added sections "Model Scope" and "Usage Guidelines for Configuring TCP Keep-Alives" to the common model section. A.4. 03 to 04 o Fixed a few typos. A.5. 04 to 05 o Removed commented out "grouping tcp-system-grouping" statement kept for reviewers. o Added a "Note to Reviewers" note to first page. A.6. 05 to 06 o Added support for TCP proxies. Authors' Addresses Kent Watsen Watsen Networks EMail: kent+ietf@watsen.net Watsen & Scharf Expires December 18, 2020 [Page 25] Internet-Draft Groupings for TCP Clients and Servers June 2020 Michael Scharf Hochschule Esslingen - University of Applied Sciences EMail: michael.scharf@hs-esslingen.de Watsen & Scharf Expires December 18, 2020 [Page 26]