NETCONF Working Group K. Watsen Internet-Draft Watsen Networks Intended status: Standards TrackMay 20,8 July 2020 Expires:November 21, 20209 January 2021 NETCONF Client and Server Modelsdraft-ietf-netconf-netconf-client-server-19draft-ietf-netconf-netconf-client-server-20 Abstract This document defines two YANG modules, one module to configure a NETCONF client and the other module to configure a NETCONF server. Both modules support both the SSH and TLS transport protocols, and support both standard NETCONF and NETCONF Call Home connections. 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 (note: not all may be present):o* "AAAA" --> the assigned RFC value for draft-ietf-netconf-crypto- typeso* "BBBB" --> the assigned RFC value for draft-ietf-netconf-trust- anchorso* "CCCC" --> the assigned RFC value for draft-ietf-netconf-keystoreo* "DDDD" --> the assigned RFC value for draft-ietf-netconf-tcp- client-servero* "EEEE" --> the assigned RFC value for draft-ietf-netconf-ssh- client-servero* "FFFF" --> the assigned RFC value for draft-ietf-netconf-tls- client-servero* "GGGG" --> the assigned RFC value for draft-ietf-netconf-http- client-servero* "HHHH" --> 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-05-20"* "2020-07-08" --> the publication date of this draft The following Appendix section is to be removed prior to publication:o* AppendixB.A. Change LogNote 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. 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])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 onNovember 21, 2020.9 January 2021. 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)(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 . . . . . . . . . . . . . . . . . . . . . . . .5 2. Terminology3 1.1. Relation to other RFCs . . . . . . . . . . . . . . . . . 4 1.2. Specification Language . . . . . . . . . . . . . . . . . 53. The NETCONF Client Model1.3. Adherence to the NMDA . . . . . . . . . . . . . . . . . . 53.1. Tree Diagram2. The "ietf-netconf-client" Module . . . . . . . . . . . . . . 5 2.1. Data Model Overview . . . . . . . . .5 3.2. Example Usage. . . . . . . . . . 6 2.2. Example Usage . . . . . . . . . . . .7 3.3. YANG Module. . . . . . . . . . 10 2.3. YANG Module . . . . . . . . . . . . . . . .11 4. The NETCONF Server Model. . . . . . . 14 3. The "ietf-netconf-server" Module . . . . . . . . . . .22 4.1. Tree Diagram. . . 25 3.1. Data Model Overview . . . . . . . . . . . . . . . . . . .22 4.2.25 3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . .24 4.3.30 3.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . .31 5.36 4. Security Considerations . . . . . . . . . . . . . . . . . . .43 6. IANA Considerations49 4.1. The "ietf-netconf-client" YANG Module . . . . . . . . . . 49 4.2. The "ietf-netconf-server" YANG Module . . . . . . . . . . 49 5. IANA Considerations .44 6.1. The IETF XML Registry. . . . . . . . . . . . . . . . . .44 6.2. The YANG Module Names Registry . . . . .. . 50 5.1. The IETF XML Registry . . . . . .44 7. References. . . . . . . . . . . . 50 5.2. The YANG Module Names Registry . . . . . . . . . . . . .45 7.1. Normative50 6. References . . . . . . . . . . . . . . . . . .45 7.2. Informative References .. . . . . . . 50 6.1. Normative References . . . . . . . . .46 7.3. URIs. . . . . . . . . 50 6.2. Informative References . . . . . . . . . . . . . . . . .4752 Appendix A.Expanded Tree Diagrams . . . . . . . . . . . . . . . 48 A.1. Expanded Tree Diagram for 'ietf-netconf-client' . . . . . 48 A.2. Expanded Tree Diagram for 'ietf-netconf-server' . . . . . 70 Appendix B.Change Log . . . . . . . . . . . . . . . . . . . . .94 B.1.53 A.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . .94 B.2.53 A.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . .94 B.3.53 A.3. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . .94 B.4.54 A.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . .94 B.5.54 A.5. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . .95 B.6.54 A.6. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . .95 B.7.54 A.7. 06 to 07 . . . . . . . . . . . . . . . . . . . . . . . .95 B.8.54 A.8. 07 to 08 . . . . . . . . . . . . . . . . . . . . . . . .95 B.9.55 A.9. 08 to 09 . . . . . . . . . . . . . . . . . . . . . . . .95 B.10.55 A.10. 09 to 10 . . . . . . . . . . . . . . . . . . . . . . . .96 B.11.55 A.11. 10 to 11 . . . . . . . . . . . . . . . . . . . . . . . .96 B.12.55 A.12. 11 to 12 . . . . . . . . . . . . . . . . . . . . . . . .96 B.13.55 A.13. 12 to 13 . . . . . . . . . . . . . . . . . . . . . . . .97 B.14.56 A.14. 13 to 14 . . . . . . . . . . . . . . . . . . . . . . . .97 B.15.56 A.15. 14 to 15 . . . . . . . . . . . . . . . . . . . . . . . .97 B.16.56 A.16. 15 to 16 . . . . . . . . . . . . . . . . . . . . . . . .97 B.17.56 A.17. 16 to 17 . . . . . . . . . . . . . . . . . . . . . . . .97 B.18.56 A.18. 17 to 18 . . . . . . . . . . . . . . . . . . . . . . . .97 B.19.57 A.19. 18 to 19 . . . . . . . . . . . . . . . . . . . . . . . .9757 A.20. 19 to 20 . . . . . . . . . . . . . . . . . . . . . . . . 57 Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . .9857 Author's Address . . . . . . . . . . . . . . . . . . . . . . . .9857 1. Introduction This document defines two YANG [RFC7950] modules, one module to configure a NETCONF [RFC6241] client and the other module to configure a NETCONF server. Both modules support both NETCONF over SSH [RFC6242] and NETCONF over TLS [RFC7589] and NETCONF Call Home connections [RFC8071].2. Terminology The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this1.1. Relation to other RFCs This document presents one or more YANG modules [RFC7950] that are part of a collection of RFCs that work together tobe interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here. 3. The NETCONF Client Model The NETCONF client model presented in this section supports both clients initiating connections to servers, as well as clients listeningdefine configuration modules forconnections fromclients and serverscalling home, using eitherof both theSSHNETCONF [RFC6241] andTLS transportRESTCONF [RFC8040] protocols.YANG feature statements are usedThe modules have been defined in a modular fashion to enableimplementations to advertisetheir use by other efforts, some of whichpotentially uncommon partsare known to be in progress at the time of this writing, with many more expected to be defined in time. The relationship between themodelvarious RFCs in theNETCONF client supports. 3.1. Tree Diagram The following tree diagram [RFC8340] provides an overview ofcollection is presented in thedata model forbelow diagram. The labels in the"ietf-netconf-client" module. This treediagramonly shows the nodes defined in this module; it does showrepresent thenodes defined by "grouping" statements usedprimary purpose provided bythis module. Please see Appendix A.1 for a tree diagram that illustrates whateach RFC. Links themodule looks like with alleach RFC are provided below the"grouping" statements expanded. module: ietf-netconf-client +--rw netconf-client +---u netconf-client-app-grouping grouping netconf-client-grouping grouping netconf-client-initiate-stack-grouping +-- (transport) +--:(ssh) {ssh-initiate}?diagram. crypto-types ^ ^ / \ / \ truststore keystore ^ ^ ^ ^ |+-- ssh+---------+ |+-- tcp-client-parameters| |+---u tcpc:tcp-client-grouping|+-- ssh-client-parameters| |+---u sshc:ssh-client-grouping|+-- netconf-client-parameters +--:(tls) {tls-initiate}? +-- tls +-- tcp-client-parameters+------------+ |+---u tcpc:tcp-client-grouping +-- tls-client-parameterstcp-client-server |+---u tlsc:tls-client-grouping +-- netconf-client-parameters grouping netconf-client-listen-stack-grouping +-- (transport) +--:(ssh) {ssh-listen}?/ |+-- ssh|+-- tcp-server-parameters^ ^ ssh-client-server | |+---u tcps:tcp-server-grouping|+-- ssh-client-parameters| ^ tls-client-server |+---u sshc:ssh-client-grouping|+-- netconf-client-parameters +--:(tls) {tls-listen}? +-- tls +-- tcp-server-parameters|+---u tcps:tcp-server-grouping +-- tls-client-parameters^ ^ http-client-server |+---u tlsc:tls-client-grouping +-- netconf-client-parameters grouping netconf-client-app-grouping +-- initiate! {ssh-initiate or tls-initiate}?|+-- netconf-server* [name]|+-- name? string|+-- endpoints| ^ |+-- endpoint* [name]| |+-- name? string+-----+ +---------+ | |+---u netconf-client-initiate-stack-grouping|+-- connection-type| |+-- (connection-type)| |+--:(persistent-connection)| +-----------|--------|--------------+ | |+-- persistent!| |+--:(periodic-connection)| |+-- periodic!| |+-- period? uint16+-----------+ | |+-- anchor-time? yang:date-and-time| |+-- idle-timeout? uint16|+-- reconnect-strategy|+-- start-with? enumeration|+-- max-attempts? uint8 +-- listen! {ssh-listen or tls-listen}? +-- idle-timeout? uint16 +-- endpoint* [name] +-- name? string +---u netconf-client-listen-stack-grouping 3.2. Example Usage The following example illustrates configuring a NETCONF client to initiate connections, using both the SSH and TLS transport protocols, as well as listening for call-home connections, again using both the SSH| | | | | | | | | | 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] | +-----------------------+-------------------------------------------+ Table 1: Label to RFC Mapping 1.2. Specification Language The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", andTLS transport protocols."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. 1.3. Adherence to the NMDA Thisexample is consistentdocument in compliant with theexamples presentedNetwork Management Datastore Architecture (NMDA) [RFC8342]. For instance, as described inSection 2 of[I-D.ietf-netconf-trust-anchors] andSection 3.2 of [I-D.ietf-netconf-keystore]. ========== NOTE: '\' line wrapping per BCP XXX (RFC XXXX) =========== <netconf-client xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-client" xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types"> <!--[I-D.ietf-netconf-keystore], trust anchors and keys installed during manufacturing are expected to appear in <operational>. 2. The "ietf-netconf-client" Module The NETCONFserversclient model presented in this section supports both clients initiating connections toinitiateservers, as well as clients listening for connections from servers calling home, using either the SSH and TLS transport protocols. YANG feature statements are used to--> <initiate> <netconf-server> <name>corp-fw1</name> <endpoints> <endpoint> <name>corp-fw1.example.com</name> <ssh> <tcp-client-parameters> <remote-address>corp-fw1.example.com</remote-address> <keepalives> <idle-time>15</idle-time> <max-probes>3</max-probes> <probe-interval>30</probe-interval> </keepalives> </tcp-client-parameters> <ssh-client-parameters> <client-identity> <username>foobar</username> <public-key> <local-definition> <public-key-format>ct:ssh-public-key-format</pub\ lic-key-format> <public-key>base64encodedvalue==</public-key> <private-key-format>ct:rsa-private-key-format</p\ rivate-key-format> <private-key>base64encodedvalue==</private-key> </local-definition> </public-key> </client-identity> <server-authentication> <ca-certs> <truststore-reference>trusted-server-ca-certs</tru\ ststore-reference> </ca-certs> <ee-certs> <truststore-reference>trusted-server-ee-certs</tru\ ststore-reference> </ee-certs> </server-authentication> <keepalives> <max-wait>30</max-wait> <max-attempts>3</max-attempts> </keepalives> </ssh-client-parameters> <netconf-client-parameters> <!-- nothingenable implementations toconfigure --> </netconf-client-parameters> </ssh> </endpoint> <endpoint> <name>corp-fw2.example.com</name> <tls> <tcp-client-parameters> <remote-address>corp-fw2.example.com</remote-address> <keepalives> <idle-time>15</idle-time> <max-probes>3</max-probes> <probe-interval>30</probe-interval> </keepalives> </tcp-client-parameters> <tls-client-parameters> <client-identity> <certificate> <local-definition> <public-key-format>ct:subject-public-key-info-fo\ rmat</public-key-format> <public-key>base64encodedvalue==</public-key> <private-key-format>ct:rsa-private-key-format</p\ rivate-key-format> <private-key>base64encodedvalue==</private-key> <cert>base64encodedvalue==</cert> </local-definition> </certificate> </client-identity> <server-authentication> <ca-certs> <truststore-reference>trusted-server-ca-certs</tru\ ststore-reference> </ca-certs> <ee-certs> <truststore-reference>trusted-server-ee-certs</tru\ ststore-reference> </ee-certs> </server-authentication> <keepalives> <test-peer-aliveness> <max-wait>30</max-wait> <max-attempts>3</max-attempts> </test-peer-aliveness> </keepalives> </tls-client-parameters> <netconf-client-parameters> <!-- nothing to configure --> </netconf-client-parameters> </tls> </endpoint> </endpoints> <connection-type> <persistent/> </connection-type> <reconnect-strategy> <start-with>last-connected</start-with> </reconnect-strategy> </netconf-server> </initiate> <!-- endpoints to listenadvertise which potentially uncommon parts of the model the NETCONF client supports. 2.1. Data Model Overview 2.1.1. Features The following diagram lists all the "feature" statements defined in the "ietf-netconf-client" module: Features: +-- ssh-initiate +-- tls-initiate +-- ssh-listen +-- tls-listen 2.1.2. Groupings The following diagram lists all the "grouping" statements defined in the "ietf-netconf-client" module: Groupings: +-- netconf-client-grouping +-- netconf-client-initiate-stack-grouping +-- netconf-client-listen-stack-grouping +-- netconf-client-app-grouping Each of these groupings are presented in the following subsections. 2.1.2.1. The "netconf-client-grouping" Grouping The following tree diagram [RFC8340] illustrates the "netconf-client- grouping" grouping: grouping netconf-client-grouping ---> <empty> Comments: * This grouping does not define any nodes, but is maintained so that downstream modules can augment nodes into it if needed. * The "netconf-client-grouping" defines, if it can be called that, the configuration for just "NETCONF" part of a protocol stack. It does not, for instance, define any configuration for the "TCP", "SSH" or "TLS" protocol layers (for that, see Section 2.1.2.2 and Section 2.1.2.3). 2.1.2.2. The "netconf-client-initiate-stack-grouping" Grouping The following tree diagram [RFC8340] illustrates the "netconf-client- initiate-stack-grouping" grouping: grouping netconf-client-initiate-stack-grouping +-- (transport) +--:(ssh) {ssh-initiate}? | +-- ssh | +-- tcp-client-parameters | | +---u tcpc:tcp-client-grouping | +-- ssh-client-parameters | | +---u sshc:ssh-client-grouping | +-- netconf-client-parameters | +--u ncc:netconf-client-grouping +--:(tls) {tls-initiate}? +-- tls +-- tcp-client-parameters | +---u tcpc:tcp-client-grouping +-- tls-client-parameters | +---u tlsc:tls-client-grouping +-- netconf-client-parameters +---u ncc:netconf-client-grouping Comments: * The "netconf-client-initiate-stack-grouping" defines the configuration for a full NETCONFCall Homeprotocol stack, for NETCONF clients that initiate connectionson --> <listen> <endpoint> <name>Intranet-facing SSH listener</name> <ssh> <tcp-server-parameters> <local-address>192.0.2.7</local-address> </tcp-server-parameters> <ssh-client-parameters> <client-identity> <username>foobar</username> <public-key> <local-definition> <public-key-format>ct:ssh-public-key-format</public-\ key-format> <public-key>base64encodedvalue==</public-key> <private-key-format>ct:rsa-private-key-format</priva\ te-key-format> <private-key>base64encodedvalue==</private-key> </local-definition> </public-key> </client-identity> <server-authentication> <ca-certs> <truststore-reference>trusted-server-ca-certs</trustst\ ore-reference> </ca-certs> <ee-certs> <truststore-reference>trusted-server-ee-certs</trustst\ ore-reference> </ee-certs> <ssh-host-keys> <truststore-reference>trusted-ssh-public-keys</trustst\ ore-reference> </ssh-host-keys> </server-authentication> </ssh-client-parameters> <netconf-client-parameters> <!-- nothingtoconfigure --> </netconf-client-parameters> </ssh> </endpoint> <endpoint> <name>Intranet-facing TLS listener</name> <tls> <tcp-server-parameters> <local-address>192.0.2.7</local-address> </tcp-server-parameters> <tls-client-parameters> <client-identity> <certificate> <local-definition> <public-key-format>ct:subject-public-key-info-format\ </public-key-format> <public-key>base64encodedvalue==</public-key> <private-key-format>ct:rsa-private-key-format</priva\ te-key-format> <private-key>base64encodedvalue==</private-key> <cert>base64encodedvalue==</cert> </local-definition> </certificate> </client-identity> <server-authentication> <ca-certs> <truststore-reference>trusted-server-ca-certs</trustst\ ore-reference> </ca-certs> <ee-certs> <truststore-reference>trusted-server-ee-certs</trustst\ ore-reference> </ee-certs> </server-authentication> <keepalives> <peer-allowed-to-send/> </keepalives> </tls-client-parameters> <netconf-client-parameters> <!-- nothing to configure --> </netconf-client-parameters> </tls> </endpoint> </listen> </netconf-client> 3.3. YANG Module This YANG module has normative referencesNETCONF servers, as opposed to[RFC6242], [RFC6991], [RFC7589], [RFC8071], [I-D.kwatsen-netconf-tcp-client-server], [I-D.ietf-netconf-ssh-client-server], and [I-D.ietf-netconf-tls-client-server]. <CODE BEGINS> file "ietf-netconf-client@2020-05-20.yang" module ietf-netconf-client { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-client"; prefix ncc; import ietf-yang-types { prefix yang; reference "RFC 6991: Common YANG Data Types"; } import ietf-tcp-client { prefix tcpc; reference "RFC DDDD: YANG Groupings for TCP Clients and TCP Servers"; } import ietf-tcp-server { prefix tcps; reference "RFC DDDD: YANG Groupings for TCP Clients and TCP Servers"; } import ietf-ssh-client { prefix sshc; revision-date 2020-05-20; // stable grouping definitions reference "RFC EEEE: YANG Groupings for SSH Clients andreceiving call-home [RFC8071] connections. * The "transport" choice node enables both the SSHServers"; } import ietf-tls-client { prefix tlsc; revision-date 2020-05-20; // stable grouping definitions reference "RFC FFFF: YANG Groupings for TLS Clientsand TLSServers"; } organization "IETF NETCONF (Network Configuration) Working Group"; contact "WG Web: <http://datatracker.ietf.org/wg/netconf/> WG List: <mailto:netconf@ietf.org> Author: Kent Watsen <mailto:kent+ietf@watsen.net> Author: Gary Wu <mailto:garywu@cisco.com>"; description "This module containstransports to be configured, with each option enabled by acollection of YANG definitions for configuring NETCONF clients. Copyright (c) 2020 IETF Trust and"feature" statement. * For thepersons identified as authorsreferenced grouping statement(s): - The "tcp-client-grouping" grouping is discussed in Section 3.1.2.1 ofthe code. All rights reserved. Redistribution and use[I-D.ietf-netconf-tcp-client-server]. - The "ssh-client-grouping" grouping is discussed insource and binary forms, with or without modification,Section 3.1.2.1 of [I-D.ietf-netconf-ssh-client-server]. - The "tls-client-grouping" grouping ispermitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forthdiscussed in Section4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info). This version3.1.2.1 ofthis YANG module[I-D.ietf-netconf-tls-client-server]. - The "netconf-client-grouping" grouping ispart of RFC HHHH (https://www.rfc-editor.org/info/rfcHHHH); seediscussed in Section 2.1.2.1 in this document. 2.1.2.3. The "netconf-client-listen-stack-grouping" Grouping The following tree diagram [RFC8340] illustrates theRFC itself"netconf-client- listen-stack-grouping" grouping: grouping netconf-client-listen-stack-grouping +-- (transport) +--:(ssh) {ssh-listen}? | +-- ssh | +-- tcp-server-parameters | | +---u tcps:tcp-server-grouping | +-- ssh-client-parameters | | +---u sshc:ssh-client-grouping | +-- netconf-client-parameters | +--u ncc:netconf-client-grouping +--:(tls) {tls-listen}? +-- tls +-- tcp-server-parameters | +---u tcps:tcp-server-grouping +-- tls-client-parameters | +---u tlsc:tls-client-grouping +-- netconf-client-parameters +---u ncc:netconf-client-grouping Comments: * The "netconf-client-listen-stack-grouping" defines the configuration for a fulllegal 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-05-20 { description "Initial version"; reference "RFC HHHH:NETCONFClient and Server Models"; } // Features feature ssh-initiate { description "The 'ssh-initiate' feature indicates that theprotocol stack, for NETCONFclient supports initiating SSHclients that receive call-home [RFC8071] connectionsto NETCONF servers."; reference "RFC 6242: Using thefrom NETCONFProtocol over Secure Shell (SSH)"; } feature tls-initiate { description "The 'tls-initiate' feature indicates thatservers. * The "transport" choice node enables both theNETCONF client supports initiatingSSH and TLSconnectionstransports toNETCONF servers."; reference "RFC 7589: Using the NETCONF Protocol over Transport Layer Security (TLS)be configured, withMutual X.509 Authentication"; } feature ssh-listen { description "The 'ssh-listen' feature indicates that the NETCONF client supports openingeach option enabled by aport to listen for incoming NETCONF server call-home SSH connections."; reference "RFC 8071: NETCONF Call Home and RESTCONF Call Home"; } feature tls-listen { description "The 'tls-listen' feature indicates that"feature" statement. * For the referenced grouping statement(s): - The "tcp-server-grouping" grouping is discussed in Section 4.1.2.1 of [I-D.ietf-netconf-tcp-client-server]. - The "ssh-client-grouping" grouping is discussed in Section 3.1.2.1 of [I-D.ietf-netconf-ssh-client-server]. - The "tls-client-grouping" grouping is discussed in Section 3.1.2.1 of [I-D.ietf-netconf-tls-client-server]. - The "netconf-client-grouping" grouping is discussed in Section 2.1.2.1 in this document. 2.1.2.4. The "netconf-client-app-grouping" Grouping The following tree diagram [RFC8340] illustrates the "netconf-client- app-grouping" grouping: grouping netconf-client-app-grouping +-- initiate! {ssh-initiate or tls-initiate}? | +-- netconf-server* [name] | +-- name? string | +-- endpoints | | +-- endpoint* [name] | | +-- name? string | | +---u netconf-client-initiate-stack-grouping | +-- connection-type | | +-- (connection-type) | | +--:(persistent-connection) | | | +-- persistent! | | +--:(periodic-connection) | | +-- periodic! | | +-- period? uint16 | | +-- anchor-time? yang:date-and-time | | +-- idle-timeout? uint16 | +-- reconnect-strategy | +-- start-with? enumeration | +-- max-attempts? uint8 +-- listen! {ssh-listen or tls-listen}? +-- idle-timeout? uint16 +-- endpoint* [name] +-- name? string +---u netconf-client-listen-stack-grouping Comments: * The "netconf-client-app-grouping" defines the configuration for a NETCONF client that supportsopening a portboth initiating connections tolisten for incomingNETCONFserverservers as well as receiving call-homeTLS connections."; reference "RFC 8071:connections from NETCONFCall Homeservers. * Both the "initiate" andRESTCONF Call Home"; } // Groupings grouping netconf-client-grouping { description "A reusable"listen" subtrees must be enabled by "feature" statements. * For the referenced groupingfor configuring a NETCONF client without any consideration for how underlying transport sessions are established. Thisstatement(s): - The "netconf-client-initiate-stack-grouping" groupingcurrently doesn't define any nodes."; }is discussed in Section 2.1.2.2 in this document. - The "netconf-client-listen-stack-grouping" groupingnetconf-client-initiate-stack-grouping { description "A reusable grouping for configuring a NETCONF client 'initiate' protocol stack for a single connection."; choice transport { mandatory true; description "Selects between available transports."; case ssh { if-feature "ssh-initiate"; container ssh { description "Specifies IP and SSH specific configuration foris discussed in Section 2.1.2.3 in this document. 2.1.3. Protocol-accessible Nodes The following diagram lists all theconnection."; container tcp-client-parameters { description "A wrapper aroundprotocol-accessible nodes defined in theTCP client parameters to avoid name collisions."; uses tcpc:tcp-client-grouping { refine "remote-port" { default "830"; description "The NETCONF client will attempt to connect to"ietf-netconf-client" module: module: ietf-netconf-client +--rw netconf-client +---u netconf-client-app-grouping Comments: * Protocol-accessible nodes are those nodes that are accessible when theIANA-assigned well-known port value for 'netconf-ssh' (830) if no valuemodule isspecified."; } } } container ssh-client-parameters { description "A wrapper around"implemented", as described in Section 5.6.5 of [RFC7950]. * For theSSH client parameters to avoid name collisions."; uses sshc:ssh-client-grouping; } container netconf-client-parameters { description "A wrapper around"ietf-netconf-client" module, the protocol-accessible nodes are an instance of the "netconf-client-app-grouping" discussed in Section 2.1.2.4 grouping. * The reason for why "netconf-client-app-grouping" exists separate from the protocol-accessible nodes definition is so as to enable instances of netconf-client-app-grouping to be instantiated in other locations, as may be needed or desired by some modules. 2.2. Example Usage The following example illustrates configuring a NETCONF clientparameterstoavoid name collisions."; uses ncc:netconf-client-grouping; } } } case tls { if-feature "tls-initiate"; container tls { description "Specifies IPinitiate connections, using both the SSH and TLSspecific configurationtransport protocols, as well as to listen for call-home connections, again using both theconnection."; container tcp-client-parameters { description "A wrapper aroundSSH and TLS transport protocols. This example is consistent with theTCP client parameters to avoid name collisions."; uses tcpc:tcp-client-grouping { refine "remote-port" { default "6513"; description "Theexamples presented in Section 2.2 of [I-D.ietf-netconf-trust-anchors] and Section 2.2 of [I-D.ietf-netconf-keystore]. =============== NOTE: '\' line wrapping per RFC 8792 ================ <netconf-client xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-client" xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types"> <!-- NETCONFclient will attemptservers toconnectinitiate connections tothe IANA-assigned well-known port value for 'netconf-tls' (6513) if no value is specified."; } } } container tls-client-parameters { must "client-identity" { description "NETCONF/TLS clients MUST pass some authentication credentials."; } description "A wrapper around the TLS client parameters--> <initiate> <netconf-server> <name>corp-fw1</name> <endpoints> <endpoint> <name>corp-fw1.example.com</name> <ssh> <tcp-client-parameters> <remote-address>corp-fw1.example.com</remote-address> <keepalives> <idle-time>15</idle-time> <max-probes>3</max-probes> <probe-interval>30</probe-interval> </keepalives> </tcp-client-parameters> <ssh-client-parameters> <client-identity> <username>foobar</username> <public-key> <keystore-reference>ssh-rsa-key</keystore-referenc\ e> </public-key> </client-identity> <server-authentication> <ca-certs> <truststore-reference>trusted-server-ca-certs</tru\ ststore-reference> </ca-certs> <ee-certs> <truststore-reference>trusted-server-ee-certs</tru\ ststore-reference> </ee-certs> </server-authentication> <keepalives> <max-wait>30</max-wait> <max-attempts>3</max-attempts> </keepalives> </ssh-client-parameters> <netconf-client-parameters> <!-- nothing toavoid name collisions."; uses tlsc:tls-client-grouping; } container netconf-client-parameters { description "A wrapper around the NETCONF client parametersconfigure --> </netconf-client-parameters> </ssh> </endpoint> <endpoint> <name>corp-fw2.example.com</name> <tls> <tcp-client-parameters> <remote-address>corp-fw2.example.com</remote-address> <keepalives> <idle-time>15</idle-time> <max-probes>3</max-probes> <probe-interval>30</probe-interval> </keepalives> </tcp-client-parameters> <tls-client-parameters> <client-identity> <certificate> <keystore-reference> <asymmetric-key>rsa-asymmetric-key</asymmetric-k\ ey> <certificate>ex-rsa-cert</certificate> </keystore-reference> </certificate> </client-identity> <server-authentication> <ca-certs> <truststore-reference>trusted-server-ca-certs</tru\ ststore-reference> </ca-certs> <ee-certs> <truststore-reference>trusted-server-ee-certs</tru\ ststore-reference> </ee-certs> </server-authentication> <keepalives> <test-peer-aliveness> <max-wait>30</max-wait> <max-attempts>3</max-attempts> </test-peer-aliveness> </keepalives> </tls-client-parameters> <netconf-client-parameters> <!-- nothing toavoid name collisions."; uses ncc:netconf-client-grouping; } } } } } // netconf-client-initiate-stack-grouping grouping netconf-client-listen-stack-grouping { description "A reusable grouping for configuring a NETCONF client 'listen' protocol stackconfigure --> </netconf-client-parameters> </tls> </endpoint> </endpoints> <connection-type> <persistent/> </connection-type> <reconnect-strategy> <start-with>last-connected</start-with> </reconnect-strategy> </netconf-server> </initiate> <!-- endpoints to listen fora single connection. The 'listen' stack supports call home connections, as described in RFC 8071"; reference "RFC 8071:NETCONF Call Homeand RESTCONF Call Home"; choice transport { mandatory true; description "Selects between available transports."; case ssh { if-feature "ssh-listen"; container ssh { description "SSH-specific listening configuration for inbound connections."; container tcp-server-parameters { description "A wrapper around the TCP server parametersconnections on --> <listen> <endpoint> <name>Intranet-facing SSH listener</name> <ssh> <tcp-server-parameters> <local-address>192.0.2.7</local-address> </tcp-server-parameters> <ssh-client-parameters> <client-identity> <username>foobar</username> <public-key> <keystore-reference>ssh-rsa-key</keystore-reference> </public-key> </client-identity> <server-authentication> <ca-certs> <truststore-reference>trusted-server-ca-certs</trustst\ ore-reference> </ca-certs> <ee-certs> <truststore-reference>trusted-server-ee-certs</trustst\ ore-reference> </ee-certs> <ssh-host-keys> <truststore-reference>trusted-ssh-public-keys</trustst\ ore-reference> </ssh-host-keys> </server-authentication> </ssh-client-parameters> <netconf-client-parameters> <!-- nothing toavoid name collisions."; uses tcps:tcp-server-groupingconfigure --> </netconf-client-parameters> </ssh> </endpoint> <endpoint> <name>Intranet-facing TLS listener</name> <tls> <tcp-server-parameters> <local-address>192.0.2.7</local-address> </tcp-server-parameters> <tls-client-parameters> <client-identity> <certificate> <keystore-reference> <asymmetric-key>rsa-asymmetric-key</asymmetric-key> <certificate>ex-rsa-cert</certificate> </keystore-reference> </certificate> </client-identity> <server-authentication> <ca-certs> <truststore-reference>trusted-server-ca-certs</trustst\ ore-reference> </ca-certs> <ee-certs> <truststore-reference>trusted-server-ee-certs</trustst\ ore-reference> </ee-certs> </server-authentication> <keepalives> <peer-allowed-to-send/> </keepalives> </tls-client-parameters> <netconf-client-parameters> <!-- nothing to configure --> </netconf-client-parameters> </tls> </endpoint> </listen> </netconf-client> 2.3. YANG Module This YANG module has normative references to [RFC6242], [RFC6991], [RFC7589], [RFC8071], [I-D.ietf-netconf-tcp-client-server], [I-D.ietf-netconf-ssh-client-server], and [I-D.ietf-netconf-tls-client-server]. <CODE BEGINS> file "ietf-netconf-client@2020-07-08.yang" module ietf-netconf-client {refine "local-port"yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-client"; prefix ncc; import ietf-yang-types {default "4334"; description "The NETCONF client will listen on the IANA- assigned well-known port for 'netconf-ch-ssh' (4334) if no value is specified."; } }prefix yang; reference "RFC 6991: Common YANG Data Types"; }container ssh-client-parametersimport ietf-tcp-client {description "A wrapper around the SSH client parameters to avoid name collisions."; uses sshc:ssh-client-grouping;prefix tcpc; reference "RFC DDDD: YANG Groupings for TCP Clients and TCP Servers"; }container netconf-client-parametersimport ietf-tcp-server {description "A wrapper around the NETCONF client parameters to avoid name collisions."; uses ncc:netconf-client-grouping; }prefix tcps; reference "RFC DDDD: YANG Groupings for TCP Clients and TCP Servers"; } import ietf-ssh-client { prefix sshc; revision-date 2020-07-08; // stable grouping definitions reference "RFC EEEE: YANG Groupings for SSH Clients and SSH Servers"; }case tlsimport ietf-tls-client {if-feature "tls-listen"; container tls { description "TLS-specific listening configuration for inbound connections."; container tcp-server-parameters { description "A wrapper around the TCP server parameters to avoid name collisions."; uses tcps:tcp-server-grouping { refine "local-port" { default "4334"; description "The NETCONF client will listen on the IANA- assigned well-known portprefix tlsc; revision-date 2020-07-08; // stable grouping definitions reference "RFC FFFF: YANG Groupings for'netconf-ch-ssh' (4334) if no value is specified."; } } } container tls-client-parameters { must "client-identity" { description "NETCONF/TLS clients MUST pass some authentication credentials."; } description "A wrapper around theTLSclient parameters to avoid name collisions."; uses tlsc:tls-client-grouping;Clients and TLS Servers"; }container netconf-client-parameters { description "A wrapper around theorganization "IETF NETCONFclient parameters to avoid name collisions."; uses ncc:netconf-client-grouping; } } } } } // netconf-client-listen-stack-grouping grouping netconf-client-app-grouping {(Network Configuration) Working Group"; contact "WG Web: <http://datatracker.ietf.org/wg/netconf/> WG List: <mailto:netconf@ietf.org> Author: Kent Watsen <mailto:kent+ietf@watsen.net> Author: Gary Wu <mailto:garywu@cisco.com>"; description"A reusable grouping"This module contains a collection of YANG definitions for configuringaNETCONFclient application that supports both 'initiate'clients. Copyright (c) 2020 IETF Trust and'listen' protocol stacks for a multiplicity of connections."; container initiate { if-feature "ssh-initiate or tls-initiate"; presence "Enables client to initiate TCP connections"; description "Configures client initiating underlying TCP connections."; list netconf-server { key "name"; min-elements 1; description "Listthe persons identified as authors ofNETCONF serverstheNETCONF clientcode. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject tomaintain simultaneous connections with."; leaf name { type string; description "An arbitrary name fortheNETCONF server."; } container endpoints { description "Container forlicense terms contained in, thelist of endpoints."; list endpoint { key "name"; min-elements 1; ordered-by user; description "A user-ordered listSimplified BSD License set forth in Section 4.c ofendpoints thattheNETCONF client will attemptIETF Trust's Legal Provisions Relating toconnectIETF Documents (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFC HHHH (https://www.rfc-editor.org/info/rfcHHHH); 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 inthe specified sequence. Defining more than one enables high-availability."; leaf nameBCP 14 (RFC 2119) (RFC 8174) when, and only when, they appear in all capitals, as shown here."; revision 2020-07-08 {type string;description"An arbitrary name for the endpoint."; } uses netconf-client-initiate-stack-grouping; } // list endpoint"Initial version"; reference "RFC HHHH: NETCONF Client and Server Models"; } //container endpoints container connection-typeFeatures feature ssh-initiate { description"Indicates"The 'ssh-initiate' feature indicates that the NETCONFclient's preference for howclient supports initiating SSH connections to NETCONF servers."; reference "RFC 6242: Using the NETCONFconnection is maintained."; choice connection-typeProtocol over Secure Shell (SSH)"; } feature tls-initiate {mandatory true;description"Selects between available connection types."; case persistent-connection { container persistent { presence "Indicates"The 'tls-initiate' feature indicates thata persistent connection is to be maintained."; description "Maintain a persistent connection tothe NETCONFserver. If the connection goes down, immediately start trying to reconnectclient supports initiating TLS connections totheNETCONFserver, usingservers."; reference "RFC 7589: Using thereconnection strategy. This connection type minimizes any NETCONF server toNETCONFclient data-transfer delay, albeit at the expense of holding resources longer."; }Protocol over Transport Layer Security (TLS) with Mutual X.509 Authentication"; }case periodic-connection { container periodicfeature ssh-listen {presence "Indicatesdescription "The 'ssh-listen' feature indicates that the NETCONF client supports opening aperiodic connection isport tobe maintained.";listen for incoming NETCONF server call-home SSH connections."; reference "RFC 8071: NETCONF Call Home and RESTCONF Call Home"; } feature tls-listen { description"Periodically connect to"The 'tls-listen' feature indicates that the NETCONFserver. This connection type increases resource utilization, albeit with increased delay inclient supports opening a port to listen for incoming NETCONF servertocall-home TLS connections."; reference "RFC 8071: NETCONFclient interactions. TheCall Home and RESTCONF Call Home"; } // Groupings grouping netconf-client-grouping { description "A reusable grouping for configuring a NETCONF clientshould close thewithout any consideration for how underlyingTCP connection upon completing planned activities. In the case that the previous connection is still active, establishingtransport sessions are established. This grouping currently doesn't define any nodes."; } grouping netconf-client-initiate-stack-grouping { description "A reusable grouping for configuring anew connection is NOT RECOMMENDED."; leaf periodNETCONF client 'initiate' protocol stack for a single connection."; choice transport {type uint16; units "minutes"; default "60";mandatory true; description"Duration of time"Selects betweenperiodic connections."; } leaf anchor-timeavailable transports."; case ssh {type yang:date-and-timeif-feature "ssh-initiate"; container ssh {// constrained to minute-level granularity pattern '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}' + '(Z|[\+\-]\d{2}:\d{2})'; }description"Designates a timestamp before or after which a series of periodic connections are determined. The periodic connections occur at a whole multiple interval from the anchor time. For example, for an anchor time is 15 minutes past midnight"Specifies IP anda period interval of 24 hours, then a periodic connection will occur 15 minutes past midnight everyday."; } leaf idle-timeoutSSH specific configuration for the connection."; container tcp-client-parameters {type uint16; units "seconds"; default 120; // two minutesdescription"Specifies"A wrapper around themaximum number of seconds that a NETCONF session may remain idle. A NETCONF session will be dropped if it is idle for an interval longer then this number of seconds. If setTCP client parameters tozero, then theavoid name collisions."; uses tcpc:tcp-client-grouping { refine "remote-port" { default "830"; description "The NETCONF client willnever drop a session because itattempt to connect to the IANA-assigned well-known port value for 'netconf-ssh' (830) if no value isidle."; } }specified."; } } } containerreconnect-strategyssh-client-parameters { description"The reconnection strategy directs how a NETCONF"A wrapper around the SSH clientreconnects to a NETCONF server, after discovering its connectionparameters to avoid name collisions."; uses sshc:ssh-client-grouping; } container netconf-client-parameters { description "A wrapper around theserver has dropped, even if due to a reboot. TheNETCONF clientstarts with the specified endpoint and tries to connectparameters toit max-attempts times before trying the next endpoint in the list (round robin)."; leaf start-with { type enumerationavoid name collisions."; uses ncc:netconf-client-grouping; } } } case tls {enum first-listedif-feature "tls-initiate"; container tls { description"Indicates that reconnections should start with"Specifies IP and TLS specific configuration for thefirst endpoint listed."; } enum last-connectedconnection."; container tcp-client-parameters { description"Indicates that reconnections should start with"A wrapper around theendpoint last connected to. If no previous connection has ever been established, then the first endpoint configured is used. NETCONF clients SHOULD be able to remember the last endpoint connectedTCP client parameters toacross reboots."; } enum random-selectionavoid name collisions."; uses tcpc:tcp-client-grouping { refine "remote-port" {description "Indicates that reconnections should start with a random endpoint."; } }default"first-listed";"6513"; description"Specifies which of the NETCONF server's endpoints the"The NETCONF clientshould start with when tryingwill attempt to connect to theNETCONF server.";IANA-assigned well-known port value for 'netconf-tls' (6513) if no value is specified."; }leaf max-attempts} } container tls-client-parameters {type uint8must "client-identity" {range "1..max";description "NETCONF/TLS clients MUST pass some authentication credentials."; }default "3";description"Specifies the number times"A wrapper around theNETCONFTLS clienttries to connect to a specific endpoint before moving onparameters tothe next endpoint in the list (round robin)."; } } } // netconf-serveravoid name collisions."; uses tlsc:tls-client-grouping; }// initiatecontainerlistennetconf-client-parameters {if-feature "ssh-listen or tls-listen"; presence "Enables client to accept call-home connections";description"Configures"A wrapper around the NETCONF client parameters toaccept call-home TCP connections."; leaf idle-timeout { type uint16; units "seconds"; default "3600";avoid name collisions."; uses ncc:netconf-client-grouping; } } } } } //one hournetconf-client-initiate-stack-grouping grouping netconf-client-listen-stack-grouping { description"Specifies the maximum number of seconds that"A reusable grouping for configuring a NETCONFsession may remain idle. A NETCONF session will be dropped if it is idleclient 'listen' protocol stack foran interval longer than this number of seconds. If set to zero, then the server will never drop a session because it is idle. Sessions that haveanotification subscription active are never dropped."; } list endpointsingle connection. The 'listen' stack supports call home connections, as described in RFC 8071"; reference "RFC 8071: NETCONF Call Home and RESTCONF Call Home"; choice transport {key "name"; min-elements 1;mandatory true; description"List of endpoints to listen"Selects between available transports."; case ssh { if-feature "ssh-listen"; container ssh { description "SSH-specific listening configuration forNETCONFinbound connections.";leaf namecontainer tcp-server-parameters {type string;description"An arbitrary name for"A wrapper around the TCP server parameters to avoid name collisions."; uses tcps:tcp-server-grouping { refine "local-port" { default "4334"; description "The NETCONF client will listenendpoint."; } uses netconf-client-listen-stack-grouping;on the IANA- assigned well-known port for 'netconf-ch-ssh' (4334) if no value is specified."; }// endpoint}// listen}// netconf-client-app-grouping // Protocol accessible node, for servers that implement // this module.containernetconf-clientssh-client-parameters {uses netconf-client-app-grouping;description"Top-level"A wrapper around the SSH client parameters to avoid name collisions."; uses sshc:ssh-client-grouping; } containerfornetconf-client-parameters { description "A wrapper around the NETCONF clientconfiguration.";parameters to avoid name collisions."; uses ncc:netconf-client-grouping; } }<CODE ENDS> 4. The NETCONF Server Model The NETCONF server model presented in this section supports both} case tls { if-feature "tls-listen"; container tls { description "TLS-specific listening configuration forconnections as well as initiating call-home connections, using eitherinbound connections."; container tcp-server-parameters { description "A wrapper around theSSH and TLS transport protocols. YANG feature statements are used to enable implementationsTCP server parameters toadvertise which potentially uncommon parts of the model theavoid name collisions."; uses tcps:tcp-server-grouping { refine "local-port" { default "4334"; description "The NETCONFserver supports. 4.1. Tree Diagram The following tree diagram [RFC8340] provides an overview ofclient will listen on thedata modelIANA- assigned well-known port for 'netconf-ch-ssh' (4334) if no value is specified."; } } } container tls-client-parameters { must "client-identity" { description "NETCONF/TLS clients MUST pass some authentication credentials."; } description "A wrapper around the"ietf-netconf-server" module. This tree diagram only shows the nodes defined in this module; it does showTLS client parameters to avoid name collisions."; uses tlsc:tls-client-grouping; } container netconf-client-parameters { description "A wrapper around thenodes defined by "grouping" statements used by this module. Please see Appendix A.2NETCONF client parameters to avoid name collisions."; uses ncc:netconf-client-grouping; } } } } } // netconf-client-listen-stack-grouping grouping netconf-client-app-grouping { description "A reusable grouping for configuring atree diagramNETCONF client application thatillustrates whatsupports both 'initiate' and 'listen' protocol stacks for a multiplicity of connections."; container initiate { if-feature "ssh-initiate or tls-initiate"; presence "Enables client to initiate TCP connections"; description "Configures client initiating underlying TCP connections."; list netconf-server { key "name"; min-elements 1; description "List of NETCONF servers themodule looks like with allNETCONF client is to maintain simultaneous connections with."; leaf name { type string; description "An arbitrary name for the"grouping" statements expanded. module: ietf-netconf-server +--rw netconf-server +---u netconf-server-app-grouping grouping netconf-server-grouping +-- client-identity-mappings {tls-listen or tls-call-home or sshcmn:ssh-x509-certs}? +---u x509c2n:cert-to-name grouping netconf-server-listen-stack-grouping +-- (transport) +--:(ssh) {ssh-listen}? | +-- ssh | +-- tcp-server-parameters | | +---u tcps:tcp-server-grouping | +-- ssh-server-parameters | | +---u sshs:ssh-server-grouping | +-- netconf-server-parameters | +---u ncs:netconf-server-grouping +--:(tls) {tls-listen}? +-- tls +-- tcp-server-parameters | +---u tcps:tcp-server-grouping +-- tls-server-parameters | +---u tlss:tls-server-grouping +-- netconf-server-parameters +---u ncs:netconf-server-grouping grouping netconf-server-callhome-stack-grouping +-- (transport) +--:(ssh) {ssh-call-home}? | +-- ssh | +-- tcp-client-parameters | | +---u tcpc:tcp-client-grouping | +-- ssh-server-parameters | | +---u sshs:ssh-server-grouping | +-- netconf-server-parameters | +---u ncs:netconf-server-grouping +--:(tls) {tls-call-home}? +-- tls +-- tcp-client-parameters | +---u tcpc:tcp-client-grouping +-- tls-server-parameters | +---u tlss:tls-server-grouping +-- netconf-server-parameters +---u ncs:netconf-server-grouping grouping netconf-server-app-grouping +-- listen! {ssh-listen or tls-listen}? | +-- idle-timeout? uint16 | +-- endpoint* [name] | +-- name? string | +---u netconf-server-listen-stack-grouping +-- call-home! {ssh-call-home or tls-call-home}? +-- netconf-client* [name] +-- name? string +-- endpoints | +-- endpoint* [name] | +-- name? string | +---u netconf-server-callhome-stack-grouping +-- connection-type | +-- (connection-type) | +--:(persistent-connection) | | +-- persistent! | +--:(periodic-connection) | +-- periodic! | +-- period? uint16 | +-- anchor-time? yang:date-and-time | +-- idle-timeout? uint16 +-- reconnect-strategy +-- start-with? enumeration +-- max-attempts? uint8 4.2. Example Usage The following example illustrates configuring aNETCONFserver to listenserver."; } container endpoints { description "Container forNETCONF client connections using both the SSH and TLS transport protocols, as well as configuring call-home to two NETCONF clients, one using SSH and the other using TLS. This example is consistent withtheexamples presented in Section 2list of[I-D.ietf-netconf-trust-anchors] and Section 3.2endpoints."; list endpoint { key "name"; min-elements 1; ordered-by user; description "A user-ordered list of[I-D.ietf-netconf-keystore]. ========== NOTE: '\' line wrapping per BCP XXX (RFC XXXX) =========== <netconf-server xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-server" xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types" xmlns:x509c2n="urn:ietf:params:xml:ns:yang:ietf-x509-cert-to-name"> <!--endpointsto listen forthat the NETCONFconnections on --> <listen> <endpoint> <!-- listening for SSH connections --> <name>netconf/ssh</name> <ssh> <tcp-server-parameters> <local-address>192.0.2.7</local-address> </tcp-server-parameters> <ssh-server-parameters> <server-identity> <host-key> <name>deployment-specific-certificate</name> <public-key> <local-definition> <public-key-format>ct:ssh-public-key-format</publi\ c-key-format> <public-key>base64encodedvalue==</public-key> <private-key-format>ct:rsa-private-key-format</pri\ vate-key-format> <private-key>base64encodedvalue==</private-key> </local-definition> </public-key> </host-key> </server-identity> <client-authentication> <supported-authentication-methods> <publickey/> </supported-authentication-methods> </client-authentication> </ssh-server-parameters> <netconf-server-parameters> <!-- nothingclient will attempt toconfigure --> </netconf-server-parameters> </ssh> </endpoint> <endpoint> <!-- listeningconnect to in the specified sequence. Defining more than one enables high-availability."; leaf name { type string; description "An arbitrary name forTLS sessions --> <name>netconf/tls</name> <tls> <tcp-server-parameters> <local-address>192.0.2.7</local-address> </tcp-server-parameters> <tls-server-parameters> <server-identity> <certificate> <local-definition> <public-key-format>ct:subject-public-key-info-format\ </public-key-format> <public-key>base64encodedvalue==</public-key> <private-key-format>ct:rsa-private-key-format</priva\ te-key-format> <private-key>base64encodedvalue==</private-key> <cert>base64encodedvalue==</cert> </local-definition> </certificate> </server-identity> <client-authentication> <ca-certs> <truststore-reference>trusted-client-ca-certs</trustst\ ore-reference> </ca-certs> <ee-certs> <truststore-reference>trusted-client-ee-certs</trustst\ ore-reference> </ee-certs> </client-authentication> <keepalives> <peer-allowed-to-send/> </keepalives> </tls-server-parameters> <netconf-server-parameters> <client-identity-mappings> <cert-to-name> <id>1</id> <fingerprint>11:0A:05:11:00</fingerprint> <map-type>x509c2n:specified</map-type> <name>scooby-doo</name> </cert-to-name> <cert-to-name> <id>2</id> <map-type>x509c2n:san-any</map-type> </cert-to-name> </client-identity-mappings> </netconf-server-parameters> </tls> </endpoint> </listen> <!-- calling homethe endpoint."; } uses netconf-client-initiate-stack-grouping; } // list endpoint } // container endpoints container connection-type { description "Indicates the NETCONF client's preference for how the NETCONF connection is maintained."; choice connection-type { mandatory true; description "Selects between available connection types."; case persistent-connection { container persistent { presence "Indicates that a persistent connection is toSSH and TLS basedbe maintained."; description "Maintain a persistent connection to the NETCONFclients --> <call-home> <netconf-client> <!-- SSH-based client --> <name>config-mgr</name> <endpoints> <endpoint> <name>east-data-center</name> <ssh> <tcp-client-parameters> <remote-address>east.config-mgr.example.com</remote-ad\ dress> <keepalives> <idle-time>15</idle-time> <max-probes>3</max-probes> <probe-interval>30</probe-interval> </keepalives> </tcp-client-parameters> <ssh-server-parameters> <server-identity> <host-key> <name>deployment-specific-certificate</name> <public-key> <local-definition> <public-key-format>ct:ssh-public-key-format</p\ ublic-key-format> <public-key>base64encodedvalue==</public-key> <private-key-format>ct:rsa-private-key-format<\ /private-key-format> <private-key>base64encodedvalue==</private-key> </local-definition> </public-key> </host-key> </server-identity> <client-authentication> <supported-authentication-methods> <publickey/> </supported-authentication-methods> </client-authentication> </ssh-server-parameters> <netconf-server-parameters> <!-- nothingserver. If the connection goes down, immediately start trying toconfigure --> </netconf-server-parameters> </ssh> </endpoint> <endpoint> <name>west-data-center</name> <ssh> <tcp-client-parameters> <remote-address>west.config-mgr.example.com</remote-ad\ dress> </tcp-client-parameters> <ssh-server-parameters> <server-identity> <host-key> <name>deployment-specific-certificate</name> <public-key> <local-definition> <public-key-format>ct:ssh-public-key-format</p\ ublic-key-format> <public-key>base64encodedvalue==</public-key> <private-key-format>ct:rsa-private-key-format<\ /private-key-format> <private-key>base64encodedvalue==</private-key> </local-definition> </public-key> </host-key> </server-identity> <client-authentication> <supported-authentication-methods> <publickey/> </supported-authentication-methods> </client-authentication> </ssh-server-parameters> <netconf-server-parameters> <!-- nothingreconnect toconfigure --> </netconf-server-parameters> </ssh> </endpoint> </endpoints> <connection-type> <periodic> <idle-timeout>300</idle-timeout> <period>60</period> </periodic> </connection-type> <reconnect-strategy> <start-with>last-connected</start-with> <max-attempts>3</max-attempts> </reconnect-strategy> </netconf-client> <netconf-client> <!-- TLS-basedthe NETCONF server, using the reconnection strategy. This connection type minimizes any NETCONF server to NETCONF client--> <name>data-collector</name> <endpoints> <endpoint> <name>east-data-center</name> <tls> <tcp-client-parameters> <remote-address>east.analytics.example.com</remote-add\ ress> <keepalives> <idle-time>15</idle-time> <max-probes>3</max-probes> <probe-interval>30</probe-interval> </keepalives> </tcp-client-parameters> <tls-server-parameters> <server-identity> <certificate> <local-definition> <public-key-format>ct:subject-public-key-info-fo\ rmat</public-key-format> <public-key>base64encodedvalue==</public-key> <private-key-format>ct:rsa-private-key-format</p\ rivate-key-format> <private-key>base64encodedvalue==</private-key> <cert>base64encodedvalue==</cert> </local-definition> </certificate> </server-identity> <client-authentication> <ca-certs> <truststore-reference>trusted-client-ca-certs</tru\ ststore-reference> </ca-certs> <ee-certs> <truststore-reference>trusted-client-ee-certs</tru\ ststore-reference> </ee-certs> </client-authentication> <keepalives> <test-peer-aliveness> <max-wait>30</max-wait> <max-attempts>3</max-attempts> </test-peer-aliveness> </keepalives> </tls-server-parameters> <netconf-server-parameters> <client-identity-mappings> <cert-to-name> <id>1</id> <fingerprint>11:0A:05:11:00</fingerprint> <map-type>x509c2n:specified</map-type> <name>scooby-doo</name> </cert-to-name> <cert-to-name> <id>2</id> <map-type>x509c2n:san-any</map-type> </cert-to-name> </client-identity-mappings> </netconf-server-parameters> </tls> </endpoint> <endpoint> <name>west-data-center</name> <tls> <tcp-client-parameters> <remote-address>west.analytics.example.com</remote-add\ ress> <keepalives> <idle-time>15</idle-time> <max-probes>3</max-probes> <probe-interval>30</probe-interval> </keepalives> </tcp-client-parameters> <tls-server-parameters> <server-identity> <certificate> <local-definition> <public-key-format>ct:subject-public-key-info-fo\ rmat</public-key-format> <public-key>base64encodedvalue==</public-key> <private-key-format>ct:rsa-private-key-format</p\ rivate-key-format> <private-key>base64encodedvalue==</private-key> <cert>base64encodedvalue==</cert> </local-definition> </certificate> </server-identity> <client-authentication> <ca-certs> <truststore-reference>trusted-client-ca-certs</tru\ ststore-reference> </ca-certs> <ee-certs> <truststore-reference>trusted-client-ee-certs</tru\ ststore-reference> </ee-certs> </client-authentication> <keepalives> <test-peer-aliveness> <max-wait>30</max-wait> <max-attempts>3</max-attempts> </test-peer-aliveness> </keepalives> </tls-server-parameters> <netconf-server-parameters> <client-identity-mappings> <cert-to-name> <id>1</id> <fingerprint>11:0A:05:11:00</fingerprint> <map-type>x509c2n:specified</map-type> <name>scooby-doo</name> </cert-to-name> <cert-to-name> <id>2</id> <map-type>x509c2n:san-any</map-type> </cert-to-name> </client-identity-mappings> </netconf-server-parameters> </tls> </endpoint> </endpoints> <connection-type> <persistent/> </connection-type> <reconnect-strategy> <start-with>first-listed</start-with> <max-attempts>3</max-attempts> </reconnect-strategy> </netconf-client> </call-home> </netconf-server> 4.3. YANG Module This YANG module has normative references to [RFC6242], [RFC6991], [RFC7407], [RFC7589], [RFC8071], [I-D.kwatsen-netconf-tcp-client-server], [I-D.ietf-netconf-ssh-client-server], and [I-D.ietf-netconf-tls-client-server]. <CODE BEGINS> file "ietf-netconf-server@2020-05-20.yang" module ietf-netconf-server { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-server"; prefix ncs; import ietf-yang-types { prefix yang; reference "RFC 6991: Common YANG Data Types";data-transfer delay, albeit at the expense of holding resources longer."; }import ietf-x509-cert-to-name { prefix x509c2n; reference "RFC 7407: A YANG Data Model for SNMP Configuration";}import ietf-tcp-clientcase periodic-connection {prefix tcpc; reference "RFC DDDD: YANG Groupings for TCP Clients and TCP Servers"; } import ietf-tcp-servercontainer periodic {prefix tcps; reference "RFC DDDD: YANG Groupings for TCP Clients andpresence "Indicates that a periodic connection is to be maintained."; description "Periodically connect to the NETCONF server. This connection type increases resource utilization, albeit with increased delay in NETCONF server to NETCONF client interactions. The NETCONF client should close the underlying TCPServers"; } import ietf-ssh-common { prefix sshcmn; revision-date 2020-05-20; // stable grouping definitions reference "RFC EEEE: YANG Groupings for SSH Clients and SSH Servers"; } import ietf-ssh-serverconnection upon completing planned activities. In the case that the previous connection is still active, establishing a new connection is NOT RECOMMENDED."; leaf period {prefix sshs; revision-date 2020-05-20; // stable grouping definitions reference "RFC EEEE: YANG Groupings for SSH Clients and SSH Servers";type uint16; units "minutes"; default "60"; description "Duration of time between periodic connections."; }import ietf-tls-serverleaf anchor-time { type yang:date-and-time {prefix tlss; revision-date 2020-05-20;//stable grouping definitions reference "RFC FFFF: YANG Groupings for TLS Clients and TLS Servers";constrained to minute-level granularity pattern '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}' + '(Z|[\+\-]\d{2}:\d{2})'; }organization "IETF NETCONF (Network Configuration) Working Group"; contact "WG Web: <http://datatracker.ietf.org/wg/netconf/> WG List: <mailto:netconf@ietf.org> Author: Kent Watsen <mailto:kent+ietf@watsen.net> Author: Gary Wu <mailto:garywu@cisco.com> Author: Juergen Schoenwaelder <mailto:j.schoenwaelder@jacobs-university.de>";description"This module contains"Designates acollection of YANG definitions for configuring NETCONF servers. Copyright (c) 2020 IETF Trust and the persons identified as authorstimestamp before or after which a series of periodic connections are determined. The periodic connections occur at a whole multiple interval from thecode. All rights reserved. Redistribution and use in source and binary forms, with or without modification,anchor time. For example, for an anchor time ispermitted pursuant to,15 minutes past midnight andsubject to the license terms contained in, the Simplified BSD License set forth in Section 4.ca period interval of 24 hours, then a periodic connection will occur 15 minutes past midnight everyday."; } leaf idle-timeout { type uint16; units "seconds"; default 120; // two minutes description "Specifies theIETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info). This versionmaximum number ofthis YANG moduleseconds that a NETCONF session may remain idle. A NETCONF session will be dropped if it ispart of RFC HHHH (https://www.rfc-editor.org/info/rfcHHHH); see the RFC itselfidle forfull legal notices.; The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' inan interval longer then thisdocument arenumber of seconds. If set tobe interpreted as described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, they appear in all capitals, as shown here."; revision 2020-05-20 { description "Initial version"; reference "RFC HHHH:zero, then the NETCONFClient and Server Models";client will never drop a session because it is idle."; }// Features feature ssh-listen} } } } container reconnect-strategy { description "The'ssh-listen' feature indicates that the NETCONF server supports openingreconnection strategy directs how aport to acceptNETCONFover SSHclientconnections."; reference "RFC 6242: Using thereconnects to a NETCONFProtocol over Secure Shell (SSH)"; } feature tls-listen { description "The 'tls-listen' feature indicates thatserver, after discovering its connection to theNETCONFserversupports opening a porthas dropped, even if due toaccepta reboot. The NETCONFover TLSclientconnections."; reference "RFC 7589: Using the NETCONF Protocol over Transport Layer Security (TLS)starts withMutual X.509 Authentication"; } feature ssh-call-homethe specified endpoint and tries to connect to it max-attempts times before trying the next endpoint in the list (round robin)."; leaf start-with { type enumeration { enum first-listed { description"The 'ssh-call-home' feature indicates"Indicates that reconnections should start with theNETCONF server supports initiating a NETCONF over SSH call home connection to NETCONF clients."; reference "RFC 8071: NETCONF Call Home and RESTCONF Call Home";first endpoint listed."; }feature tls-call-homeenum last-connected { description"The 'tls-call-home' feature indicates"Indicates that reconnections should start with theNETCONF server supports initiating a NETCONF over TLS call homeendpoint last connected to. If no previous connectionto NETCONF clients."; reference "RFC 8071:has ever been established, then the first endpoint configured is used. NETCONFCall Home and RESTCONF Call Home";clients SHOULD be able to remember the last endpoint connected to across reboots."; }// Groupings grouping netconf-server-groupingenum random-selection { description"A reusable grouping for configuring a NETCONF server without any consideration for how underlying transport sessions are established. Note that this grouping uses a fairly typical descendent node name such"Indicates that reconnections should start with astackrandom endpoint."; } } default "first-listed"; description "Specifies which of'uses' statements will have name conflicts. It is intended that the consuming data model will resolvetheissue by wrappingNETCONF server's endpoints the'uses' statement in a container called, e.g., 'netconf-server-parameters'. This model purposely does not do this itself so asNETCONF client should start with when trying toprovide maximum flexibilityconnect toconsuming models."; container client-identity-mappingsthe NETCONF server."; } leaf max-attempts {if-feature "tls-listen or tls-call-home or sshcmn:ssh-x509-certs";type uint8 { range "1..max"; } default "3"; description "Specifiesmappings through whichthe number times the NETCONF clientX.509 certificates are usedtries to connect todetermineaNETCONF username. If no matching and valid cert-to-name list entry can be found, then the NETCONF server MUST closespecific endpoint before moving on to theconnection, and MUST NOT accept NETCONF messages over it."; reference "RFC 7407: A YANG Data Model for SNMP Configuration."; uses x509c2n:cert-to-name { refine "cert-to-name/fingerprint" { mandatory false; description "A 'fingerprint' value does not need to be specified when the 'cert-to-name' mapping is independent of fingerprint matching. A 'cert-to-name' having no fingerprint value will match any client certificate and therefore should only be present at the end ofnext endpoint in theuser-ordered 'cert-to-name' list.";list (round robin)."; } } } // netconf-server }grouping netconf-server-listen-stack-grouping { description "A reusable grouping for configuring a NETCONF server 'listen' protocol stack for a single connection."; choice transport { mandatory true; description "Selects between available transports."; case ssh { if-feature "ssh-listen"; container ssh { description "SSH-specific listening configuration for inbound connections.";// initiate containertcp-server-parameterslisten { if-feature "ssh-listen or tls-listen"; presence "Enables client to accept call-home connections"; description"A wrapper around"Configures theTCPclientparameterstoavoid name collisions."; uses tcps:tcp-server-grouping { refine "local-port"accept call-home TCP connections."; leaf idle-timeout { type uint16; units "seconds"; default"830";"3600"; // one hour description"The"Specifies the maximum number of seconds that a NETCONFserversession may remain idle. A NETCONF session willlisten on the IANA-assigned well-known port value for 'netconf-ssh' (830)be dropped ifno valueit isspecified."; } } } container ssh-server-parameters { description "A wrapper aroundidle for an interval longer than this number of seconds. If set to zero, then theSSHserverparameters to avoid name collisions."; uses sshs:ssh-server-grouping;will never drop a session because it is idle. Sessions that have a notification subscription active are never dropped."; }container netconf-server-parameters { description "A wrapper around the NETCONF server parameters to avoid name collisions."; uses ncs:netconf-server-grouping; } } } case tls { if-feature "tls-listen"; container tlslist endpoint { key "name"; min-elements 1; description"TLS-specific listening configuration"List of endpoints to listen forinboundNETCONF connections.";container tcp-server-parameters { description "A wrapper around the TCP client parameters to avoidleaf namecollisions."; uses tcps:tcp-server-grouping { refine "local-port"{default "6513";type string; description"The"An arbitrary name for the NETCONFserver willlistenon the IANA-assigned well-known port value for 'netconf-tls' (6513) if no value is specified."; } }endpoint."; }container tls-server-parameters { description "A wrapper around the TLS server parameters to avoid name collisions.";usestlss:tls-server-grouping { refine "client-authentication" { must 'ca-certs or ee-certs'; description "NETCONF/TLS servers MUST validate client certificates. This configures certificates at the socket-level (i.e. bags), more discriminating client-certificate checks SHOULD be implemented by the application."; reference "RFC 7589: Using the NETCONF Protocol over Transport Layer Security (TLS) with Mutual X.509 Authentication";netconf-client-listen-stack-grouping; } // endpoint } // listen } // netconf-client-app-grouping // Protocol accessible node, for servers that implement // this module. containernetconf-server-parametersnetconf-client { uses netconf-client-app-grouping; description"A wrapper around the"Top-level container for NETCONFserver parameters to avoid name collisions."; uses ncs:netconf-server-grouping; } } }client configuration."; } }grouping netconf-server-callhome-stack-grouping { description "A reusable grouping for configuring a<CODE ENDS> 3. The "ietf-netconf-server" Module The NETCONF server'call-home' protocol stack,model presented in this section supports both listening fora single connection."; choice transport { mandatory true; description "Selects between available transports."; case ssh { if-feature "ssh-call-home"; container ssh { description "Specifies SSH-specificconnections as well as initiating call-hometransport configuration."; container tcp-client-parameters { description "A wrapper around the TCP client parameters to avoid name collisions."; uses tcpc:tcp-client-grouping { refine "remote-port" { default "4334"; description "The NETCONF server will attempt to connect to the IANA-assigned well-known port for 'netconf-ch-tls' (4334) if no value is specified."; } } } container ssh-server-parameters { description "A wrapper aroundconnections, using either the SSHserver parametersand TLS transport protocols. YANG feature statements are used toavoid name collisions."; uses sshs:ssh-server-grouping; } container netconf-server-parameters { description "A wrapper around the NETCONF server parametersenable implementations toavoid name collisions."; uses ncs:netconf-server-grouping; } } } case tls { if-feature "tls-call-home"; container tls { description "Specifies TLS-specific call-home transport configuration."; container tcp-client-parameters { description "A wrapper aroundadvertise which potentially uncommon parts of the model theTCP client parameters to avoid name collisions."; uses tcpc:tcp-client-grouping { refine "remote-port" { default "4335"; description "TheNETCONF serverwill attempt to connect tosupports. 3.1. Data Model Overview 3.1.1. Features The following diagram lists all theIANA-assigned well-known port for 'netconf-ch-tls' (4335) if no value is specified."; } } } container tls-server-parameters { description "A wrapper around"feature" statements defined in theTLS server parameters to avoid name collisions."; uses tlss:tls-server-grouping { refine "client-authentication" { must 'ca-certs or ee-certs'; description "NETCONF/TLS servers MUST validate client certificates. This configures certificates at"ietf-netconf-server" module: Features: +-- ssh-listen +-- tls-listen +-- ssh-call-home +-- tls-call-home 3.1.2. Groupings The following diagram lists all thesocket-level (i.e. bags), more discriminating client-certificate checks SHOULD be implemented by"grouping" statements defined in theapplication."; reference "RFC 7589: Using"ietf-netconf-server" module: Groupings: +-- netconf-server-grouping +-- netconf-server-listen-stack-grouping +-- netconf-server-callhome-stack-grouping +-- netconf-server-app-grouping Each of these groupings are presented in theNETCONF Protocol over Transport Layer Security (TLS) with Mutual X.509 Authentication"; } } } container netconf-server-parameters { description "A wrapper aroundfollowing subsections. 3.1.2.1. The "netconf-server-grouping" Grouping The following tree diagram [RFC8340] illustrates theNETCONF server parameters to avoid name collisions."; uses ncs:netconf-server-grouping; } } } } } grouping netconf-server-app-grouping { description "A reusable"netconf-server- grouping" grouping: =============== NOTE: '\' line wrapping per RFC 8792 ================ grouping netconf-server-grouping +-- client-identity-mappings {(tls-listen or tls-call-home) and (sshcmn:ssh-x509-cert\ s)}? +---u x509c2n:cert-to-name Comments: * The "netconf-server-grouping" defines the configuration forconfiguringjust "NETCONF" part of aNETCONF server application that supports both 'listen' and 'call-home'protocolstacksstack. It does not, fora multiplicity of connections."; container listen { if-feature "ssh-listeninstance, define any configuration for the "TCP", "SSH" ortls-listen"; presence "Enables server"TLS" protocol layers (for that, see Section 3.1.2.2 and Section 3.1.2.3). * The "client-identity-mappings" node, which must be enabled by "feature" statements, defines a mapping from certificate fields tolisten forNETCONFclient connections."; description "Configures listen behavior"; leaf idle-timeout { type uint16; units "seconds"; default 3600; // one hour description "Specifiesuser names. * For themaximum numberreferenced grouping statement(s): - The "cert-to-name" grouping is discussed in Section 4.1 ofseconds that[RFC7407]. 3.1.2.2. The "netconf-server-listen-stack-grouping" Grouping The following tree diagram [RFC8340] illustrates the "netconf-server- listen-stack-grouping" grouping: grouping netconf-server-listen-stack-grouping +-- (transport) +--:(ssh) {ssh-listen}? | +-- ssh | +-- tcp-server-parameters | | +---u tcps:tcp-server-grouping | +-- ssh-server-parameters | | +---u sshs:ssh-server-grouping | +-- netconf-server-parameters | +---u ncs:netconf-server-grouping +--:(tls) {tls-listen}? +-- tls +-- tcp-server-parameters | +---u tcps:tcp-server-grouping +-- tls-server-parameters | +---u tlss:tls-server-grouping +-- netconf-server-parameters +---u ncs:netconf-server-grouping Comments: * The "netconf-server-listen-stack-grouping" defines the configuration for a full NETCONFsession may remain idle. Aprotocol stack for NETCONFsession will be dropped if it is idleservers that listen foran interval longer than this number of seconds. If setstandard connections from NETCONF clients, as opposed tozero, then the server will never drop a session because it is idle. Sessions that haveinitiating call-home [RFC8071] connections. * The "transport" choice node enables both the SSH and TLS transports to be configured, with each option enabled by anotification subscription active are never dropped."; } list endpoint { key "name"; min-elements 1; description "List"feature" statement. * For the referenced grouping statement(s): - The "tcp-server-grouping" grouping is discussed in Section 4.1.2.1 ofendpoints to listen[I-D.ietf-netconf-tcp-client-server]. - The "ssh-server-grouping" grouping is discussed in Section 4.1.2.1 of [I-D.ietf-netconf-ssh-client-server]. - The "tls-server-grouping" grouping is discussed in Section 4.1.2.1 of [I-D.ietf-netconf-tls-client-server]. - The "netconf-server-grouping" is discussed in Section 3.1.2.1 of this document. 3.1.2.3. The "netconf-server-callhome-stack-grouping" Grouping The following tree diagram [RFC8340] illustrates the "netconf-server- callhome-stack-grouping" grouping: grouping netconf-server-callhome-stack-grouping +-- (transport) +--:(ssh) {ssh-call-home}? | +-- ssh | +-- tcp-client-parameters | | +---u tcpc:tcp-client-grouping | +-- ssh-server-parameters | | +---u sshs:ssh-server-grouping | +-- netconf-server-parameters | +---u ncs:netconf-server-grouping +--:(tls) {tls-call-home}? +-- tls +-- tcp-client-parameters | +---u tcpc:tcp-client-grouping +-- tls-server-parameters | +---u tlss:tls-server-grouping +-- netconf-server-parameters +---u ncs:netconf-server-grouping Comments: * The "netconf-server-callhome-stack-grouping" defines the configuration for a full NETCONFconnections."; leaf name { type string; description "An arbitrary nameprotocol stack, forthe NETCONF listen endpoint."; } uses netconf-server-listen-stack-grouping; } } container call-home { if-feature "ssh-call-home or tls-call-home"; presence "Enables theNETCONFserver toservers that initiatethe underlying transport connectioncall-home [RFC8071] connections to NETCONFclients."; description "Configures call home behavior."; list netconf-client { key "name"; min-elements 1; description "List of NETCONF clientsclients. * The "transport" choice node enables both theNETCONF server isSSH and TLS transports tomaintain simultaneous call-home connections with."; leaf name { type string; description "An arbitrary name for the remote NETCONF client."; } container endpoints { description "Container forbe configured, with each option enabled by a "feature" statement. * For thelistreferenced grouping statement(s): - The "tcp-client-grouping" grouping is discussed in Section 3.1.2.1 ofendpoints."; list endpoint { key "name"; min-elements 1; ordered-by user; description "A non-empty user-ordered list[I-D.ietf-netconf-tcp-client-server]. - The "ssh-server-grouping" grouping is discussed in Section 4.1.2.1 ofendpoints for this NETCONF server to try to connect to[I-D.ietf-netconf-ssh-client-server]. - The "tls-server-grouping" grouping is discussed insequence. Defining more than one enables high-availability."; leaf name { type string; description "An arbitrary name forSection 4.1.2.1 of [I-D.ietf-netconf-tls-client-server]. - The "netconf-server-grouping" is discussed in Section 3.1.2.1 of thisendpoint."; } uses netconf-server-callhome-stack-grouping; } } containerdocument. 3.1.2.4. The "netconf-server-app-grouping" Grouping The following tree diagram [RFC8340] illustrates the "netconf-server- app-grouping" grouping: grouping netconf-server-app-grouping +-- listen! {ssh-listen or tls-listen}? | +-- idle-timeout? uint16 | +-- endpoint* [name] | +-- name? string | +---u netconf-server-listen-stack-grouping +-- call-home! {ssh-call-home or tls-call-home}? +-- netconf-client* [name] +-- name? string +-- endpoints | +-- endpoint* [name] | +-- name? string | +---u netconf-server-callhome-stack-grouping +-- connection-type{ description "Indicates| +-- (connection-type) | +--:(persistent-connection) | | +-- persistent! | +--:(periodic-connection) | +-- periodic! | +-- period? uint16 | +-- anchor-time? yang:date-and-time | +-- idle-timeout? uint16 +-- reconnect-strategy +-- start-with? enumeration +-- max-attempts? uint8 Comments: * The "netconf-server-app-grouping" defines theNETCONF server's preferenceconfiguration forhow thea NETCONFconnection is maintained."; choice connection-type { mandatory true; description "Selects between available connection types."; case persistent-connection { container persistent { presence "Indicatesserver thata persistent connection is to be maintained."; description "Maintain a persistent connection to thesupports both listening for connections from NETCONFclient. If the connection goes down, immediately start trying to reconnectclients as well as initiatiating call-home connections totheNETCONFclient, usingclients. * Both thereconnection strategy. This connection type minimizes any NETCONF client to NETCONF server data-transfer delay, albeit at"listen" and "call-home" subtrees must be enabled by "feature" statements. * For theexpense of holding resources longer."; } } case periodic-connection { container periodic { presence "Indicates that a periodic connectionreferenced grouping statement(s): - The "netconf-server-listen-stack-grouping" grouping isto be maintained."; description "Periodically connect to the NETCONF client. This connection type increases resource utilization, albeit with increased delaydiscussed inNETCONF client to NETCONF client interactions.Section 3.1.2.2 in this document. - TheNETCONF client SHOULD gracefully close the connection using <close-session> upon completing planned activities. If the NETCONF session"netconf-server-callhome-stack-grouping" grouping isnot closed gracefully, the NETCONF server MUST immediately attempt to reestablishdiscussed in Section 3.1.2.3 in this document. 3.1.3. Protocol-accessible Nodes The following diagram lists all theconnection. Inprotocol-accessible nodes defined in thecase"ietf-netconf-server" module: module: ietf-netconf-server +--rw netconf-server +---u netconf-server-app-grouping Comments: * Protocol-accessible nodes are those nodes that are accessible when theprevious connectionmodule isstill active (i.e.,"implemented", as described in Section 5.6.5 of [RFC7950]. * For theNETCONF client has not closed it yet), establishing a new connection"ietf-netconf-server" module, the protocol-accessible nodes are an instance of the "netconf-server-app-grouping" discussed in Section 3.1.2.4 grouping. * The reason for why "netconf-server-app-grouping" exists separate from the protocol-accessible nodes definition isNOT RECOMMENDED."; leaf period { type uint16; units "minutes"; default "60"; description "Durationso as to enable instances oftime between periodic connections."; } leaf anchor-time { type yang:date-and-time { // constrainednetconf-server-app-grouping tominute-level granularity pattern '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}' + '(Z|[\+\-]\d{2}:\d{2})'; } description "Designates a timestamp beforebe instantiated in other locations, as may be needed orafter which a series of periodic connections are determined.desired by some modules. 3.2. Example Usage Theperiodic connections occur atfollowing example illustrates configuring awhole multiple interval from the anchor time. For example,NETCONF server to listen foran anchor time is 15 minutes past midnightNETCONF client connections using both the SSH anda period interval of 24 hours, then a periodic connection will occur 15 minutes past midnight everyday."; } leaf idle-timeout { type uint16; units "seconds"; default 120; //TLS transport protocols, as well as configuring call-home to twominutes description "Specifies the maximum number of seconds that a NETCONF session may remain idle. ANETCONFsession will be dropped if it is idle for an interval longer than this number of seconds. If set to zero, thenclients, one using SSH and theserver will never drop a session because itother using TLS. This example isidle."; } } } // case periodic-connection } // choice connection-type } // container connection-type container reconnect-strategy { description "The reconnection strategy directs how a NETCONF server reconnects to a NETCONF client, after discovering its connection to the client has dropped, even if due to a reboot. The NETCONF server startsconsistent with thespecified endpointexamples presented in Section 2.2 of [I-D.ietf-netconf-trust-anchors] andtries to connectSection 2.2 of [I-D.ietf-netconf-keystore]. =============== NOTE: '\' line wrapping per RFC 8792 ================ <netconf-server xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-server" xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types" xmlns:x509c2n="urn:ietf:params:xml:ns:yang:ietf-x509-cert-to-name"> <!-- endpoints toit max-attempts times before trying the next endpoint in the list (round robin)."; leaf start-with { type enumeration { enum first-listed { description "Indicates that reconnections should start with the first endpoint listed."; } enum last-connected { description "Indicates that reconnections should start with the endpoint last connected to. If no previous connection has ever been established, then the first endpoint configured is used.listen for NETCONFservers SHOULD be able to remember the last endpoint connected to across reboots."; } enum random-selection { description "Indicates that reconnections should start with a random endpoint."; } } default "first-listed"; description "Specifies which of the NETCONF client's endpoints the NETCONF server should start with when trying to connect to the NETCONF client."; } leaf max-attempts { type uint8 { range "1..max"; } default "3"; description "Specifies the number times the NETCONF server tries to connect to a specific endpoint before movingconnections onto the next endpoint in the list (round robin)."; } } // container reconnect-strategy } // list netconf-client } // container call-home } // grouping netconf-server-app-grouping // Protocol accessible node, for servers that implement // this module. container netconf-server { uses netconf-server-app-grouping; description "Top-level container--> <listen> <endpoint> <!-- listening forNETCONF server configuration."; } } <CODE ENDS> 5. Security Considerations The YANG module defined in this document uses groupings defined in [I-D.kwatsen-netconf-tcp-client-server], [I-D.ietf-netconf-ssh-client-server], and [I-D.ietf-netconf-tls-client-server]. Please see the Security Considerations section in those documentsSSH connections --> <name>netconf/ssh</name> <ssh> <tcp-server-parameters> <local-address>192.0.2.7</local-address> </tcp-server-parameters> <ssh-server-parameters> <server-identity> <host-key> <name>deployment-specific-certificate</name> <public-key> <keystore-reference>ssh-rsa-key</keystore-reference> </public-key> </host-key> </server-identity> <client-authentication> <supported-authentication-methods> <publickey/> </supported-authentication-methods> </client-authentication> </ssh-server-parameters> <netconf-server-parameters> <!-- nothing to configure --> </netconf-server-parameters> </ssh> </endpoint> <endpoint> <!-- listening forconcerns related those groupings. The YANG modules defined in this document are designedTLS sessions --> <name>netconf/tls</name> <tls> <tcp-server-parameters> <local-address>192.0.2.7</local-address> </tcp-server-parameters> <tls-server-parameters> <server-identity> <certificate> <keystore-reference> <asymmetric-key>rsa-asymmetric-key</asymmetric-key> <certificate>ex-rsa-cert</certificate> </keystore-reference> </certificate> </server-identity> <client-authentication> <ca-certs> <truststore-reference>trusted-client-ca-certs</trustst\ ore-reference> </ca-certs> <ee-certs> <truststore-reference>trusted-client-ee-certs</trustst\ ore-reference> </ee-certs> </client-authentication> <keepalives> <peer-allowed-to-send/> </keepalives> </tls-server-parameters> <netconf-server-parameters> <client-identity-mappings> <cert-to-name> <id>1</id> <fingerprint>11:0A:05:11:00</fingerprint> <map-type>x509c2n:specified</map-type> <name>scooby-doo</name> </cert-to-name> <cert-to-name> <id>2</id> <map-type>x509c2n:san-any</map-type> </cert-to-name> </client-identity-mappings> </netconf-server-parameters> </tls> </endpoint> </listen> <!-- calling home tobe accessed via YANGSSH and TLS basedmanagement protocols, such asNETCONF[RFC6241] and RESTCONF [RFC8040]. Both of these protocols have mandatory-to- implement secure transport layers (e.g., SSH, TLS) with mutual authentication. The NETCONF access control model (NACM) [RFC8341] provides the meansclients --> <call-home> <netconf-client> <!-- SSH-based client --> <name>config-mgr</name> <endpoints> <endpoint> <name>east-data-center</name> <ssh> <tcp-client-parameters> <remote-address>east.config-mgr.example.com</remote-ad\ dress> <keepalives> <idle-time>15</idle-time> <max-probes>3</max-probes> <probe-interval>30</probe-interval> </keepalives> </tcp-client-parameters> <ssh-server-parameters> <server-identity> <host-key> <name>deployment-specific-certificate</name> <public-key> <keystore-reference>ssh-rsa-key</keystore-refere\ nce> </public-key> </host-key> </server-identity> <client-authentication> <supported-authentication-methods> <publickey/> </supported-authentication-methods> </client-authentication> </ssh-server-parameters> <netconf-server-parameters> <!-- nothing torestrict access for particular usersconfigure --> </netconf-server-parameters> </ssh> </endpoint> <endpoint> <name>west-data-center</name> <ssh> <tcp-client-parameters> <remote-address>west.config-mgr.example.com</remote-ad\ dress> </tcp-client-parameters> <ssh-server-parameters> <server-identity> <host-key> <name>deployment-specific-certificate</name> <public-key> <keystore-reference>ssh-rsa-key</keystore-refere\ nce> </public-key> </host-key> </server-identity> <client-authentication> <supported-authentication-methods> <publickey/> </supported-authentication-methods> </client-authentication> </ssh-server-parameters> <netconf-server-parameters> <!-- nothing toa pre-configured subset of all available protocol operations and content. There are a number of data nodes defined in theconfigure --> </netconf-server-parameters> </ssh> </endpoint> </endpoints> <connection-type> <periodic> <idle-timeout>300</idle-timeout> <period>60</period> </periodic> </connection-type> <reconnect-strategy> <start-with>last-connected</start-with> <max-attempts>3</max-attempts> </reconnect-strategy> </netconf-client> <netconf-client> <!-- TLS-based client --> <name>data-collector</name> <endpoints> <endpoint> <name>east-data-center</name> <tls> <tcp-client-parameters> <remote-address>east.analytics.example.com</remote-add\ ress> <keepalives> <idle-time>15</idle-time> <max-probes>3</max-probes> <probe-interval>30</probe-interval> </keepalives> </tcp-client-parameters> <tls-server-parameters> <server-identity> <certificate> <keystore-reference> <asymmetric-key>rsa-asymmetric-key</asymmetric-k\ ey> <certificate>ex-rsa-cert</certificate> </keystore-reference> </certificate> </server-identity> <client-authentication> <ca-certs> <truststore-reference>trusted-client-ca-certs</tru\ ststore-reference> </ca-certs> <ee-certs> <truststore-reference>trusted-client-ee-certs</tru\ ststore-reference> </ee-certs> </client-authentication> <keepalives> <test-peer-aliveness> <max-wait>30</max-wait> <max-attempts>3</max-attempts> </test-peer-aliveness> </keepalives> </tls-server-parameters> <netconf-server-parameters> <client-identity-mappings> <cert-to-name> <id>1</id> <fingerprint>11:0A:05:11:00</fingerprint> <map-type>x509c2n:specified</map-type> <name>scooby-doo</name> </cert-to-name> <cert-to-name> <id>2</id> <map-type>x509c2n:san-any</map-type> </cert-to-name> </client-identity-mappings> </netconf-server-parameters> </tls> </endpoint> <endpoint> <name>west-data-center</name> <tls> <tcp-client-parameters> <remote-address>west.analytics.example.com</remote-add\ ress> <keepalives> <idle-time>15</idle-time> <max-probes>3</max-probes> <probe-interval>30</probe-interval> </keepalives> </tcp-client-parameters> <tls-server-parameters> <server-identity> <certificate> <keystore-reference> <asymmetric-key>rsa-asymmetric-key</asymmetric-k\ ey> <certificate>ex-rsa-cert</certificate> </keystore-reference> </certificate> </server-identity> <client-authentication> <ca-certs> <truststore-reference>trusted-client-ca-certs</tru\ ststore-reference> </ca-certs> <ee-certs> <truststore-reference>trusted-client-ee-certs</tru\ ststore-reference> </ee-certs> </client-authentication> <keepalives> <test-peer-aliveness> <max-wait>30</max-wait> <max-attempts>3</max-attempts> </test-peer-aliveness> </keepalives> </tls-server-parameters> <netconf-server-parameters> <client-identity-mappings> <cert-to-name> <id>1</id> <fingerprint>11:0A:05:11:00</fingerprint> <map-type>x509c2n:specified</map-type> <name>scooby-doo</name> </cert-to-name> <cert-to-name> <id>2</id> <map-type>x509c2n:san-any</map-type> </cert-to-name> </client-identity-mappings> </netconf-server-parameters> </tls> </endpoint> </endpoints> <connection-type> <persistent/> </connection-type> <reconnect-strategy> <start-with>first-listed</start-with> <max-attempts>3</max-attempts> </reconnect-strategy> </netconf-client> </call-home> </netconf-server> 3.3. YANGmodules that are writable/creatable/deletable (i.e., config true, which is the default). Some of these data nodes may be considered sensitive or vulnerable in some network environments. Write operations (e.g., edit-config)Module This YANG module has normative references tothese data nodes without proper protection can have a negative effect on network operations. These are the subtrees[RFC6242], [RFC6991], [RFC7407], [RFC7589], [RFC8071], [I-D.ietf-netconf-tcp-client-server], [I-D.ietf-netconf-ssh-client-server], anddata nodes[I-D.ietf-netconf-tls-client-server]. <CODE BEGINS> file "ietf-netconf-server@2020-07-08.yang" module ietf-netconf-server { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-server"; prefix ncs; import ietf-yang-types { prefix yang; reference "RFC 6991: Common YANG Data Types"; } import ietf-x509-cert-to-name { prefix x509c2n; reference "RFC 7407: A YANG Data Model for SNMP Configuration"; } import ietf-tcp-client { prefix tcpc; reference "RFC DDDD: YANG Groupings for TCP Clients andtheir sensitivity/vulnerability: None of the subtrees or data nodes in the modules defined in this document need to be protected from write operations. Some of the readable data nodes in theTCP Servers"; } import ietf-tcp-server { prefix tcps; reference "RFC DDDD: YANGmodules 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 subtreesGroupings for TCP Clients anddata nodesTCP Servers"; } import ietf-ssh-common { prefix sshcmn; revision-date 2020-07-08; // stable grouping definitions reference "RFC EEEE: YANG Groupings for SSH Clients andtheir sensitivity/vulnerability: None of the subtrees or data nodes in the modules defined in this document need to be protected from read operations. Some of the RPC operations in theSSH Servers"; } import ietf-ssh-server { prefix sshs; revision-date 2020-07-08; // stable grouping definitions reference "RFC EEEE: YANGmodules may be considered sensitive or vulnerable in some network environments. It is thus important to control access to these operations. These are the operationsGroupings for SSH Clients andtheir sensitivity/vulnerability: The modules defined in this document do not define any 'RPC' or 'action' statements. 6. IANA Considerations 6.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-netconf-client Registrant Contact: TheSSH Servers"; } import ietf-tls-server { prefix tlss; revision-date 2020-07-08; // stable grouping definitions reference "RFC FFFF: YANG Groupings for TLS Clients and TLS Servers"; } organization "IETF NETCONF (Network Configuration) Working Group"; contact "WG Web: <http://datatracker.ietf.org/wg/netconf/> WG List: <mailto:netconf@ietf.org> Author: Kent Watsen <mailto:kent+ietf@watsen.net> Author: Gary Wu <mailto:garywu@cisco.com> Author: Juergen Schoenwaelder <mailto:j.schoenwaelder@jacobs-university.de>"; description "This module contains a collection ofthe IETF. XML: N/A, the requested URI is an XML namespace. URI: urn:ietf:params:xml:ns:yang:ietf-netconf-server Registrant Contact: TheYANG definitions for configuring NETCONFWG ofservers. Copyright (c) 2020 IETF Trust and theIETF. XML: N/A,persons identified as authors of therequested URI is an XML namespace. 6.2. The YANG Module Names Registry This document registers two YANG modulescode. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to theYANG Module Names registry [RFC6020]. Followinglicense terms contained in, theformatSimplified BSD License set forth in[RFC6020], theSection 4.c of thefollowing registrations are requested: name: ietf-netconf-client namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-client prefix: ncc reference: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 HHHHname: ietf-netconf-server namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-server prefix: ncs reference:(https://www.rfc-editor.org/info/rfcHHHH); see the RFCHHHH 7. References 7.1. Normative References [I-D.ietf-netconf-keystore] Watsen, K., "A YANG Data Modelitself fora Keystore", draft- ietf-netconf-keystore-16 (work in progress), March 2020. [I-D.ietf-netconf-ssh-client-server] Watsen, K., Wu, G., and L. Xia, "YANG Groupings for SSH Clientsfull legal notices.; The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 'MAY', andSSH Servers", draft-ietf-netconf-ssh-client- server-18 (work'OPTIONAL' inprogress), March 2020. [I-D.ietf-netconf-tls-client-server] Watsen, K., Wu, G., and L. Xia, "YANG Groupings for TLS Clients and TLS Servers", draft-ietf-netconf-tls-client- server-18 (workthis document are to be interpreted as described inprogress), March 2020. [I-D.kwatsen-netconf-tcp-client-server] Watsen, K. and M. Scharf, "YANG Groupings for TCP ClientsBCP 14 (RFC 2119) (RFC 8174) when, andTCP Servers", draft-kwatsen-netconf-tcp-client- server-02 (work in progress), April 2019. [RFC2119] Bradner, S., "Key words for useonly when, they appear inRFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, <https://www.rfc-editor.org/info/rfc2119>. [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, DOI 10.17487/RFC6020, October 2010, <https://www.rfc-editor.org/info/rfc6020>. [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,all capitals, as shown here."; revision 2020-07-08 { description "Initial version"; reference "RFC HHHH: NETCONF Client andA. Bierman, Ed., "Network Configuration Protocol (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, <https://www.rfc-editor.org/info/rfc6241>. [RFC6242] Wasserman, M., "UsingServer Models"; } // Features feature ssh-listen { description "The 'ssh-listen' feature indicates that the NETCONFProtocolserver supports opening a port to accept NETCONF overSecure Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, <https://www.rfc-editor.org/info/rfc6242>. [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", RFC 6991, DOI 10.17487/RFC6991, July 2013, <https://www.rfc-editor.org/info/rfc6991>. [RFC7407] Bjorklund, M. and J. Schoenwaelder, "A YANG Data Model for SNMP Configuration", RFC 7407, DOI 10.17487/RFC7407, December 2014, <https://www.rfc-editor.org/info/rfc7407>. [RFC7589] Badra, M., Luchuk, A., and J. Schoenwaelder, "UsingSSH client connections."; reference "RFC 6242: Using the NETCONF Protocol overTransport Layer Security (TLS) with Mutual X.509 Authentication", RFC 7589, DOI 10.17487/RFC7589, June 2015, <https://www.rfc-editor.org/info/rfc7589>. [RFC7950] Bjorklund, M., Ed.,Secure Shell (SSH)"; } feature tls-listen { description "TheYANG 1.1 Data Modeling Language", RFC 7950, DOI 10.17487/RFC7950, August 2016, <https://www.rfc-editor.org/info/rfc7950>. [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, <https://www.rfc-editor.org/info/rfc8174>. 7.2. Informative References [I-D.ietf-netconf-trust-anchors] Watsen, K., "A YANG Data Model for'tls-listen' feature indicates that the NETCONF server supports opening aTruststore", draft- ietf-netconf-trust-anchors-09 (work in progress), March 2020. [RFC3688] Mealling, M.,port to accept NETCONF over TLS client connections."; reference "RFC 7589: Using the NETCONF Protocol over Transport Layer Security (TLS) with Mutual X.509 Authentication"; } feature ssh-call-home { description "TheIETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, <https://www.rfc-editor.org/info/rfc3688>. [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, <https://www.rfc-editor.org/info/rfc8040>. [RFC8071] Watsen, K., "NETCONF'ssh-call-home' feature indicates that the NETCONF server supports initiating a NETCONF over SSH call home connection to NETCONF clients."; reference "RFC 8071: NETCONF Call Home and RESTCONF CallHome", RFC 8071, DOI 10.17487/RFC8071, February 2017, <https://www.rfc-editor.org/info/rfc8071>. [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, <https://www.rfc-editor.org/info/rfc8340>. [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration Access Control Model", STD 91, RFC 8341, DOI 10.17487/RFC8341, March 2018, <https://www.rfc-editor.org/info/rfc8341>. 7.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 [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 Appendix A. Expanded Tree Diagrams A.1. Expanded Tree Diagram for 'ietf-netconf-client' The following tree diagram [RFC8340] provides an overview of the data model for the "ietf-netconf-client" module. This tree diagram shows allHome"; } feature tls-call-home { description "The 'tls-call-home' feature indicates that thenodes defined in this module, including those defined by "grouping" statements used by this module. Please see Section 3.1NETCONF server supports initiating a NETCONF over TLS call home connection to NETCONF clients."; reference "RFC 8071: NETCONF Call Home and RESTCONF Call Home"; } // Groupings grouping netconf-server-grouping { description "A reusable grouping for configuring atree diagramNETCONF server without any consideration for how underlying transport sessions are established. Note that this grouping uses a fairly typical descendent node name such that a stack of 'uses' statements will have name conflicts. It is intended thatillustrates whatthemodule looks like without allconsuming data model will resolve the"grouping" statements expanded. ========== NOTE: '\\' lineissue by wrappingper BCP XXX (RFC XXXX) ========== module: ietf-netconf-client +--rw netconf-client +--rw initiate! {ssh-initiatethe 'uses' statement in a container called, e.g., 'netconf-server-parameters'. This model purposely does not do this itself so as to provide maximum flexibility to consuming models."; container client-identity-mappings { if-feature "(tls-listen ortls-initiate}? | +--rw netconf-server* [name] | +--rw name string | +--rw endpoints | | +--rw endpoint* [name] | | +--rw name string | | +--rw (transport) | | +--:(ssh) {ssh-initiate}? | | | +--rw ssh | | | +--rw tcp-client-parameters | | | | +--rw remote-address inet:host | | | | +--rw remote-port? inet:port-number | | | | +--rw local-address? inet:ip-address | | | | | {local-binding-supported}? | | | | +--rw local-port? inet:port-number | | | | | {local-binding-supported}? | | | | +--rw keepalives! | | | | {keepalives-supported}? | | | | +--rw idle-time uint16 | | | | +--rw max-probes uint16 | | | | +--rw probe-interval uint16 | | | +--rw ssh-client-parameters | | | | +--rw client-identity | | | | | +--rw username? string | | | | | +--rw public-key! | | | | | | {client-identity-publickey}? | | | | | | +--rw (local-or-keystore) | | | | | | +--:(local) | | | | | | | {local-definitions-su\ \pported}? | | | | | | | +--rw local-definition | | | | | | | +--rw public-key-format | | | | | | | | identityref | | | | | | | +--rw public-key | | | | | | | | binary | | | | | | | +--rw private-key-format? | | | | | | | | identityref | | | | | | | +--rw (private-key-type) | | | | | | | +--:(private-key) | | | | | | | | +--rw private-key? | | | | | | | | binary | | | | | | | +--:(hidden-private-k\ \ey) | | | | | | | | +--rw hidden-priva\ \te-key? | | | | | | | | empty | | | | | | | +--:(encrypted-privat\ \e-key) | | | | | | | +--rw encrypted-pr\ \ivate-key | | | | | | | +--rw (key-type) | | | | | | | | +--:(symmetr\ \ic-key-ref) | | | | | | | | | +--rw sym\ \metric-key-ref? leafref | | | | | | | | | {\ \keystore-supported}? | | | | | | | | +--:(asymmet\ \ric-key-ref) | | | | | | | | +--rw asy\ \mmetric-key-ref? leafref | | | | | | | | {\ \keystore-supported}? | | | | | | | +--rw value? | | | | | | | binary | | | | | | +--:(keystore) | | | | | | {keystore-supported}? | | | | | | +--rw keystore-reference? | | | | | | ks:asymmetric-key-r\ \ef | | | | | +--rw password? string | | | | | | {client-identity-password}? | | | | | +--rw hostbased! | | | | | | {client-identity-hostbased}? | | | | | | +--rw (local-or-keystore) | | | | | | +--:(local) | | | | | | | {local-definitions-su\ \pported}? | | | | | | | +--rw local-definition | | | | | | | +--rw public-key-format | | | | | | | | identityref | | | | | | | +--rw public-key | | | | | | | | binary | | | | | | | +--rw private-key-format? | | | | | | | | identityref | | | | | | | +--rw (private-key-type) | | | | | | | +--:(private-key) | | | | | | | | +--rw private-key? | | | | | | | | binary | | | | | | | +--:(hidden-private-k\ \ey) | | | | | | | | +--rw hidden-priva\ \te-key? | | | | | | | | empty | | | | | | | +--:(encrypted-privat\ \e-key) | | | | | | | +--rw encrypted-pr\ \ivate-key | | | | | | | +--rw (key-type) | | | | | | | | +--:(symmetr\ \ic-key-ref) | | | | | | | | | +--rw sym\ \metric-key-ref? leafref | | | | | | | | | {\ \keystore-supported}? | | | | | | | | +--:(asymmet\ \ric-key-ref) | | | | | | | | +--rw asy\ \mmetric-key-ref? leafref | | | | | | | | {\ \keystore-supported}? | | | | | | | +--rw value? | | | | | | | binary | | | | | | +--:(keystore) | | | | | | {keystore-supported}? | | | | | | +--rw keystore-reference? | | | | | | ks:asymmetric-key-r\ \ef | | | | | +--rw none? empty | | | | | | {client-identity-none}? | | | | | +--rw certificate! | | | | | {sshcmn:ssh-x509-certs}? | | | | | +--rw (local-or-keystore) | | | | | +--:(local) | | | | | | {local-definitions-su\ \pported}? | | | | | | +--rw local-definition | | | | | | +--rw public-key-format | | | | | | | identityref | | | | | | +--rw public-key | | | | | | | binary | | | | | | +--rw private-key-format? | | | | | | | identityref | | | | | | +--rw (private-key-type) | | | | | | | +--:(private-key) | | | | | | | | +--rw private-key? | | | | | | | | binary | | | | | | | +--:(hidden-private-k\ \ey) | | | | | | | | +--rw hidden-priva\ \te-key? | | | | | | | | empty | | | | | | | +--:(encrypted-privat\ \e-key) | | | | | | | +--rw encrypted-pr\ \ivate-key | | | | | | | +--rw (key-type) | | | | | | | | +--:(symmetr\ \ic-key-ref) | | | | | | | | | +--rw sym\ \metric-key-ref? leafref | | | | | | | | | {\ \keystore-supported}? | | | | | | | | +--:(asymmet\ \ric-key-ref) | | | | | | | | +--rw asy\ \mmetric-key-ref? leafref | | | | | | | | {\ \keystore-supported}? | | | | | | | +--rw value? | | | | | | | binary | | | | | | +--rw cert? | | | | | | | end-entity-cert-\ \cms | | | | | | +---n certificate-expira\ \tion | | | | | | | +-- expiration-date | | | | | | | yang:date-and\ \-time | | | | | | +---x generate-certifica\ \te-signing-request | | | | | | {certificate-sig\ \ning-request-generation}? | | | | | | +---w input | | | | | | | +---w subject | | | | | | | | binary | | | | | | | +---w attributes? | | | | | | | binary | | | | | | +--ro output | | | | | | +--ro certificate-\ \signing-request | | | | | | ct:csr | | | | | +--:(keystore) | | | | | {keystore-supported}? | | | | | +--rw keystore-reference | | | | | +--rw asymmetric-key? | | | | | | ks:asymmetric-ke\ \y-ref | | | | | +--rw certificate? \ \leafref | | | | +--rw server-authentication | | | | | +--rw ssh-host-keys! | | | | | | +--rw (local-or-truststore) | | | | | | +--:(local) | | | | | | | {local-definitions-su\ \pported}? | | | | | | | +--rw local-definition | | | | | | | +--rw public-key* [name] | | | | | | | +--rw name | | | | | | | | string | | | | | | | +--rw public-key-form\ \at | | | | | | | | identityref | | | | | | | +--rw public-key | | | | | | | binary | | | | | | +--:(truststore) | | | | | | {truststore-supported\ \,public-keys}? | | | | | | +--rw truststore-reference? | | | | | | ts:public-key-bag-r\ \ef | | | | | +--rw ca-certs! | | | | | | {sshcmn:ssh-x509-certs}? | | | | | | +--rw (local-or-truststore) | | | | | | +--:(local) | | | | | | | {local-definitions-su\ \pported}? | | | | | | | +--rw local-definition | | | | | | | +--rw cert* | | | | | | | | trust-anchor-cer\ \t-cms | | | | | | | +---n certificate-expira\ \tion | | | | | | | +-- expiration-date | | | | | | | yang:date-and\ \-time | | | | | | +--:(truststore) | | | | | | {truststore-supported\ \,certificates}? | | | | | | +--rw truststore-reference? | | | | | | ts:certificate-bag-\ \ref | | | | | +--rw ee-certs! | | | | | {sshcmn:ssh-x509-certs}? | | | | | +--rw (local-or-truststore) | | | | | +--:(local) | | | | | | {local-definitions-su\ \pported}? | | | | | | +--rw local-definition | | | | | | +--rw cert* | | | | | | | trust-anchor-cer\ \t-cms | | | | | | +---n certificate-expira\ \tion | | | | | | +-- expiration-date | | | | | | yang:date-and\ \-time | | | | | +--:(truststore) | | | | | {truststore-supported\ \,certificates}? | | | | | +--rw truststore-reference? | | | | | ts:certificate-bag-\ \ref | | | | +--rw transport-params | | | | | {ssh-client-transport-params-co\ \nfig}? | | | | | +--rw host-key | | | | | | +--rw host-key-alg* identityref | | | | | +--rw key-exchange | | | | | | +--rw key-exchange-alg* | | | | | | identityref | | | | | +--rw encryption | | | | | | +--rw encryption-alg* | | | | | | identityref | | | | | +--rw mac | | | | | +--rw mac-alg* identityref | | | | +--rw keepalives! | | | | {ssh-client-keepalives}? | | | | +--rw max-wait? uint16 | | | | +--rw max-attempts? uint8 | | | +--rw netconf-client-parameters | | +--:(tls) {tls-initiate}? | | +--rw tls | | +--rw tcp-client-parameters | | | +--rw remote-address inet:host | | | +--rw remote-port? inet:port-number | | | +--rw local-address? inet:ip-address | | | | {local-binding-supported}? | | | +--rw local-port? inet:port-number | | | | {local-binding-supported}? | | | +--rw keepalives! | | | {keepalives-supported}? | | | +--rw idle-time uint16 | | | +--rw max-probes uint16 | | | +--rw probe-interval uint16 | | +--rw tls-client-parameters | | | +--rw client-identity | | | | +--rw (auth-type)? | | | | +--:(certificate) | | | | | {x509-certificate-auth}? | | | | | +--rw certificate | | | | | +--rw (local-or-keystore) | | | | | +--:(local) | | | | | | {local-definiti\ \ons-supported}? | | | | | | +--rw local-definition | | | | | | +--rw public-key-f\ \ormat | | | | | | | identityref | | | | | | +--rw public-key | | | | | | | binary | | | | | | +--rw private-key-\ \format? | | | | | | | identityref | | | | | | +--rw (private-key\ \-type) | | | | | | | +--:(private-ke\ \y) | | | | | | | | +--rw privat\ \e-key? | | | | | | | | bina\ \ry | | | | | | | +--:(hidden-pri\ \vate-key) | | | | | | | | +--rw hidden\ \-private-key? | | | | | | | | empty | | | | | | | +--:(encrypted-\ \private-key) | | | | | | | +--rw encryp\ \ted-private-key | | | | | | | +--rw (ke\ \y-type) | | | | | | | | +--:(s\ \ymmetric-key-ref) | | | | | | | | | +--\ \rw symmetric-key-ref? leafref | | | | | | | | | \ \ {keystore-supported}? | | | | | | | | +--:(a\ \symmetric-key-ref) | | | | | | | | +--\ \rw asymmetric-key-ref? leafref | | | | | | | | \ \ {keystore-supported}? | | | | | | | +--rw val\ \ue? | | | | | | | b\ \inary | | | | | | +--rw cert? | | | | | | | end-entity\ \-cert-cms | | | | | | +---n certificate-\ \expiration | | | | | | | +-- expiration-\ \date | | | | | | | yang:da\ \te-and-time | | | | | | +---x generate-cer\ \tificate-signing-request | | | | | | {certifica\ \te-signing-request-generation}? | | | | | | +---w input | | | | | | | +---w subject | | | | | | | | bina\ \ry | | | | | | | +---w attrib\ \utes? | | | | | | | bina\ \ry | | | | | | +--ro output | | | | | | +--ro certif\ \icate-signing-request | | | | | | ct:c\ \sr | | | | | +--:(keystore) | | | | | {keystore-suppo\ \rted}? | | | | | +--rw keystore-refere\ \nce | | | | | +--rw asymmetric-k\ \ey? | | | | | | ks:asymmet\ \ric-key-ref | | | | | +--rw certificate?\ \ leafref | | | | +--:(raw-public-key) | | | | | {raw-public-key-auth}? | | | | | +--rw raw-private-key | | | | | +--rw (local-or-keystore) | | | | | +--:(local) | | | | | | {local-definiti\ \ons-supported}? | | | | | | +--rw local-definition | | | | | | +--rw public-key-f\ \ormat | | | | | | | identityref | | | | | | +--rw public-key | | | | | | | binary | | | | | | +--rw private-key-\ \format? | | | | | | | identityref | | | | | | +--rw (private-key\ \-type) | | | | | | +--:(private-ke\ \y) | | | | | | | +--rw privat\ \e-key? | | | | | | | bina\ \ry | | | | | | +--:(hidden-pri\ \vate-key) | | | | | | | +--rw hidden\ \-private-key? | | | | | | | empty | | | | | | +--:(encrypted-\ \private-key) | | | | | | +--rw encryp\ \ted-private-key | | | | | | +--rw (ke\ \y-type) | | | | | | | +--:(s\ \ymmetric-key-ref) | | | | | | | | +--\ \rw symmetric-key-ref? leafref | | | | | | | | \ \ {keystore-supported}? | | | | | | | +--:(a\ \symmetric-key-ref) | | | | | | | +--\ \rw asymmetric-key-ref? leafref | | | | | | | \ \ {keystore-supported}? | | | | | | +--rw val\ \ue? | | | | | | b\ \inary | | | | | +--:(keystore) | | | | | {keystore-suppo\ \rted}? | | | | | +--rw keystore-refere\ \nce? | | | | | ks:asymmetric\ \-key-ref | | | | +--:(psk) {psk-auth}? | | | | +--rw psk | | | | +--rw (local-or-keystore) | | | | +--:(local) | | | | | {local-definiti\ \ons-supported}? | | | | | +--rw local-definition | | | | | +--rw key-format? | | | | | | identityref | | | | | +--rw (key-type) | | | | | | +--:(key) | | | | | | | +--rw key? | | | | | | | bina\ \ry | | | | | | +--:(hidden-key) | | | | | | | +--rw hidden\ \-key? | | | | | | | empty | | | | | | +--:(encrypted-\ \key) | | | | | | +--rw encryp\ \ted-key | | | | | | +--rw (ke\ \y-type) | | | | | | | +--:(s\ \ymmetric-key-ref) | | | | | | | | +--\ \rw symmetric-key-ref? leafref | | | | | | | | \ \ {keystore-supported}? | | | | | | | +--:(a\ \symmetric-key-ref) | | | | | | | +--\ \rw asymmetric-key-ref? leafref | | | | | | | \ \ {keystore-supported}? | | | | | | +--rw val\ \ue? | | | | | | b\ \inary | | | | | +--rw id? | | | | | string | | | | | {ks:local-\ \definitions-supported}? | | | | +--:(keystore) | | | | {keystore-suppo\ \rted}? | | | | +--rw keystore-refere\ \nce? | | | | ks:symmetric-\ \key-ref | | | +--rw server-authentication | | | | +--rw ca-certs! | | | | | {x509-certificate-auth}? | | | | | +--rw (local-or-truststore) | | | | | +--:(local) | | | | | | {local-definitions-su\ \pported}? | | | | | | +--rw local-definition | | | | | | +--rw cert* | | | | | | | trust-anchor-cer\ \t-cms | | | | | | +---n certificate-expira\ \tion | | | | | | +-- expiration-date | | | | | | yang:date-and\ \-time | | | | | +--:(truststore) | | | | | {truststore-supported\ \,certificates}? | | | | | +--rw truststore-reference? | | | | | ts:certificate-bag-\ \ref | | | | +--rw ee-certs! | | | | | {x509-certificate-auth}? | | | | | +--rw (local-or-truststore) | | | | | +--:(local) | | | | | | {local-definitions-su\ \pported}? | | | | | | +--rw local-definition | | | | | | +--rw cert* | | | | | | | trust-anchor-cer\ \t-cms | | | | | | +---n certificate-expira\ \tion | | | | | | +-- expiration-date | | | | | | yang:date-and\ \-time | | | | | +--:(truststore) | | | | | {truststore-supported\ \,certificates}? | | | | | +--rw truststore-reference? | | | | | ts:certificate-bag-\ \ref | | | | +--rw raw-public-keys! | | | | | {raw-public-key-auth}? | | | | | +--rw (local-or-truststore) | | | | | +--:(local) | | | | | | {local-definitions-su\ \pported}? | | | | | | +--rw local-definition | | | | | | +--rw public-key* [name] | | | | | | +--rw name | | | | | | | string | | | | | | +--rw public-key-form\ \at | | | | | | | identityref | | | | | | +--rw public-key | | | | | | binary | | | | | +--:(truststore) | | | | | {truststore-supported\ \,public-keys}? | | | | | +--rw truststore-reference? | | | | | ts:public-key-bag-r\ \ef | | | | +--rw psks! {psk-auth}? | | | +--rw hello-params | | | | {tls-client-hello-params-config\ \}? | | | | +--rw tls-versions | | | | | +--rw tls-version* identityref | | | | +--rw cipher-suites | | | | +--rw cipher-suite* identityref | | | +--rw keepalives | | | {tls-client-keepalives}? | | | +--rw peer-allowed-to-send? empty | | | +--rw test-peer-aliveness! | | | +--rw max-wait? uint16 | | | +--rw max-attempts? uint8 | | +--rw netconf-client-parameters | +--rw connection-type | | +--rw (connection-type) | | +--:(persistent-connection) | | | +--rw persistent! | | +--:(periodic-connection) | | +--rw periodic! | | +--rw period? uint16 | | +--rw anchor-time? yang:date-and-time | | +--rw idle-timeout? uint16 | +--rw reconnect-strategy | +--rw start-with? enumeration | +--rw max-attempts? uint8 +--rw listen! {ssh-listen or tls-listen}? +--rw idle-timeout? uint16 +--rw endpoint* [name] +--rw name string +--rw (transport) +--:(ssh) {ssh-listen}? | +--rw ssh | +--rw tcp-server-parameters | | +--rw local-address inet:ip-address | | +--rw local-port? inet:port-number | | +--rw keepalives! {keepalives-supported}? | | +--rw idle-time uint16 | | +--rw max-probes uint16 | | +--rw probe-interval uint16 | +--rw ssh-client-parameters | | +--rw client-identity | | | +--rw username? string | | | +--rw public-key! | | | | {client-identity-publickey}? | | | | +--rw (local-or-keystore) | | | | +--:(local) | | | | | {local-definitions-supporte\ \d}? | | | | | +--rw local-definition | | | | | +--rw public-key-format | | | | | | identityref | | | | | +--rw public-key | | | | | | binary | | | | | +--rw private-key-format? | | | | | | identityref | | | | | +--rw (private-key-type) | | | | | +--:(private-key) | | | | | | +--rw private-key? | | | | | | binary | | | | | +--:(hidden-private-key) | | | | | | +--rw hidden-private-key? | | | | | | empty | | | | | +--:(encrypted-private-key) | | | | | +--rw encrypted-private-\ \key | | | | | +--rw (key-type) | | | | | | +--:(symmetric-key\ \-ref) | | | | | | | +--rw symmetric\ \-key-ref? leafref | | | | | | | {keysto\ \re-supported}? | | | | | | +--:(asymmetric-ke\ \y-ref) | | | | | | +--rw asymmetri\ \c-key-ref? leafref | | | | | | {keysto\ \re-supported}? | | | | | +--rw value? | | | | | binary | | | | +--:(keystore) {keystore-supported}? | | | | +--rw keystore-reference? | | | | ks:asymmetric-key-ref | | | +--rw password? string | | | | {client-identity-password}? | | | +--rw hostbased! | | | | {client-identity-hostbased}? | | | | +--rw (local-or-keystore) | | | | +--:(local) | | | | | {local-definitions-supporte\ \d}? | | | | | +--rw local-definition | | | | | +--rw public-key-format | | | | | | identityref | | | | | +--rw public-key | | | | | | binary | | | | | +--rw private-key-format? | | | | | | identityref | | | | | +--rw (private-key-type) | | | | | +--:(private-key) | | | | | | +--rw private-key? | | | | | | binary | | | | | +--:(hidden-private-key) | | | | | | +--rw hidden-private-key? | | | | | | empty | | | | | +--:(encrypted-private-key) | | | | | +--rw encrypted-private-\ \key | | | | | +--rw (key-type) | | | | | | +--:(symmetric-key\ \-ref) | | | | | | | +--rw symmetric\ \-key-ref? leafref | | | | | | | {keysto\ \re-supported}? | | | | | | +--:(asymmetric-ke\ \y-ref) | | | | | | +--rw asymmetri\ \c-key-ref? leafref | | | | | | {keysto\ \re-supported}? | | | | | +--rw value? | | | | | binary | | | | +--:(keystore) {keystore-supported}? | | | | +--rw keystore-reference? | | | | ks:asymmetric-key-ref | | | +--rw none? empty | | | | {client-identity-none}? | | | +--rw certificate! {sshcmn:ssh-x509-certs}? | | | +--rw (local-or-keystore) | | | +--:(local) | | | | {local-definitions-supporte\ \d}? | | | | +--rw local-definition | | | | +--rw public-key-format | | | | | identityref | | | | +--rw public-key | | | | | binary | | | | +--rw private-key-format? | | | | | identityref | | | | +--rw (private-key-type) | | | | | +--:(private-key) | | | | | | +--rw private-key? | | | | | | binary | | | | | +--:(hidden-private-key) | | | | | | +--rw hidden-private-key? | | | | | | empty | | | | | +--:(encrypted-private-key) | | | | | +--rw encrypted-private-\ \key | | | | | +--rw (key-type) | | | | | | +--:(symmetric-key\ \-ref) | | | | | | | +--rw symmetric\ \-key-ref? leafref | | | | | | | {keysto\ \re-supported}? | | | | | | +--:(asymmetric-ke\ \y-ref) | | | | | | +--rw asymmetri\ \c-key-ref? leafref | | | | | | {keysto\ \re-supported}? | | | | | +--rw value? | | | | | binary | | | | +--rw cert? | | | | | end-entity-cert-cms | | | | +---n certificate-expiration | | | | | +-- expiration-date | | | | | yang:date-and-time | | | | +---x generate-certificate-sig\ \ning-request | | | | {certificate-signing-r\ \equest-generation}? | | | | +---w input | | | | | +---w subject | | | | | | binary | | | | | +---w attributes? | | | | | binary | | | | +--ro output | | | | +--ro certificate-signin\ \g-request | | | | ct:csr | | | +--:(keystore) {keystore-supported}? | | | +--rw keystore-reference | | | +--rw asymmetric-key? | | | | ks:asymmetric-key-ref | | | +--rw certificate? leafref | | +--rw server-authentication | | | +--rw ssh-host-keys! | | | | +--rw (local-or-truststore) | | | | +--:(local) | | | | | {local-definitions-supporte\ \d}? | | | | | +--rw local-definition | | | | | +--rw public-key* [name] | | | | | +--rw name | | | | | | string | | | | | +--rw public-key-format | | | | | | identityref | | | | | +--rw public-key | | | | | binary | | | | +--:(truststore) | | | | {truststore-supported,publi\ \c-keys}? | | | | +--rw truststore-reference? | | | | ts:public-key-bag-ref | | | +--rw ca-certs! {sshcmn:ssh-x509-certs}? | | | | +--rw (local-or-truststore) | | | | +--:(local) | | | | | {local-definitions-supporte\ \d}? | | | | | +--rw local-definition | | | | | +--rw cert* | | | | | | trust-anchor-cert-cms | | | | | +---n certificate-expiration | | | | | +-- expiration-date | | | | | yang:date-and-time | | | | +--:(truststore) | | | | {truststore-supported,certi\ \ficates}? | | | | +--rw truststore-reference? | | | | ts:certificate-bag-ref | | | +--rw ee-certs! {sshcmn:ssh-x509-certs}? | | | +--rw (local-or-truststore) | | | +--:(local) | | | | {local-definitions-supporte\ \d}? | | | | +--rw local-definition | | | | +--rw cert* | | | | | trust-anchor-cert-cms | | | | +---n certificate-expiration | | | | +-- expiration-date | | | | yang:date-and-time | | | +--:(truststore) | | | {truststore-supported,certi\ \ficates}? | | | +--rw truststore-reference? | | | ts:certificate-bag-ref | | +--rw transport-params | | | {ssh-client-transport-params-config}? | | | +--rw host-key | | | | +--rw host-key-alg* identityref | | | +--rw key-exchange | | | | +--rw key-exchange-alg* identityref | | | +--rw encryption | | | | +--rw encryption-alg* identityref | | | +--rw mac | | | +--rw mac-alg* identityref | | +--rw keepalives! {ssh-client-keepalives}? | | +--rw max-wait? uint16 | | +--rw max-attempts? uint8 | +--rw netconf-client-parameters +--:(tls) {tls-listen}? +--rw tls +--rw tcp-server-parameters | +--rw local-address inet:ip-address | +--rw local-port? inet:port-number | +--rw keepalives! {keepalives-supported}? | +--rw idle-time uint16 | +--rw max-probes uint16 | +--rw probe-interval uint16 +--rw tls-client-parameters | +--rw client-identity | | +--rw (auth-type)? | | +--:(certificate) | | | {x509-certificate-auth}? | | | +--rw certificate | | | +--rw (local-or-keystore) | | | +--:(local) | | | | {local-definitions-su\ \pported}? | | | | +--rw local-definition | | | | +--rw public-key-format | | | | | identityref | | | | +--rw public-key | | | | | binary | | | | +--rw private-key-format? | | | | | identityref | | | | +--rw (private-key-type) | | | | | +--:(private-key) | | | | | | +--rw private-key? | | | | | | binary | | | | | +--:(hidden-private-k\ \ey) | | | | | | +--rw hidden-priva\ \te-key? | | | | | | empty | | | | | +--:(encrypted-privat\ \e-key) | | | | | +--rw encrypted-pr\ \ivate-key | | | | | +--rw (key-type) | | | | | | +--:(symmetr\ \ic-key-ref) | | | | | | | +--rw sym\ \metric-key-ref? leafref | | | | | | | {\ \keystore-supported}? | | | | | | +--:(asymmet\ \ric-key-ref) | | | | | | +--rw asy\ \mmetric-key-ref? leafref | | | | | | {\ \keystore-supported}? | | | | | +--rw value? | | | | | binary | | | | +--rw cert? | | | | | end-entity-cert-\ \cms | | | | +---n certificate-expira\ \tion | | | | | +-- expiration-date | | | | | yang:date-and\ \-time | | | | +---x generate-certifica\ \te-signing-request | | | | {certificate-sig\ \ning-request-generation}? | | | | +---w input | | | | | +---w subject | | | | | | binary | | | | | +---w attributes? | | | | | binary | | | | +--ro output | | | | +--ro certificate-\ \signing-request | | | | ct:csr | | | +--:(keystore) | | | {keystore-supported}? | | | +--rw keystore-reference | | | +--rw asymmetric-key? | | | | ks:asymmetric-ke\ \y-ref | | | +--rw certificate? \ \leafref | | +--:(raw-public-key) | | | {raw-public-key-auth}? | | | +--rw raw-private-key | | | +--rw (local-or-keystore) | | | +--:(local) | | | | {local-definitions-su\ \pported}? | | | | +--rw local-definition | | | | +--rw public-key-format | | | | | identityref | | | | +--rw public-key | | | | | binary | | | | +--rw private-key-format? | | | | | identityref | | | | +--rw (private-key-type) | | | | +--:(private-key) | | | | | +--rw private-key? | | | | | binary | | | | +--:(hidden-private-k\ \ey) | | | | | +--rw hidden-priva\ \te-key? | | | | | empty | | | | +--:(encrypted-privat\ \e-key) | | | | +--rw encrypted-pr\ \ivate-key | | | | +--rw (key-type) | | | | | +--:(symmetr\ \ic-key-ref) | | | | | | +--rw sym\ \metric-key-ref? leafref | | | | | | {\ \keystore-supported}? | | | | | +--:(asymmet\ \ric-key-ref) | | | | | +--rw asy\ \mmetric-key-ref? leafref | | | | | {\ \keystore-supported}? | | | | +--rw value? | | | | binary | | | +--:(keystore) | | | {keystore-supported}? | | | +--rw keystore-reference? | | | ks:asymmetric-key-r\ \ef | | +--:(psk) {psk-auth}? | | +--rw psk | | +--rw (local-or-keystore) | | +--:(local) | | | {local-definitions-su\ \pported}? | | | +--rw local-definition | | | +--rw key-format? | | | | identityref | | | +--rw (key-type) | | | | +--:(key) | | | | | +--rw key? | | | | | binary | | | | +--:(hidden-key) | | | | | +--rw hidden-key? | | | | | empty | | | | +--:(encrypted-key) | | | | +--rw encrypted-key | | | | +--rw (key-type) | | | | | +--:(symmetr\ \ic-key-ref) | | | | | | +--rw sym\ \metric-key-ref? leafref | | | | | | {\ \keystore-supported}? | | | | | +--:(asymmet\ \ric-key-ref) | | | | | +--rw asy\ \mmetric-key-ref? leafref | | | | | {\ \keystore-supported}? | | | | +--rw value? | | | | binary | | | +--rw id? | | | string | | | {ks:local-defini\ \tions-supported}? | | +--:(keystore) | | {keystore-supported}? | | +--rw keystore-reference? | | ks:symmetric-key-ref | +--rw server-authentication | | +--rw ca-certs! {x509-certificate-auth}? | | | +--rw (local-or-truststore) | | | +--:(local) | | | | {local-definitions-supporte\ \d}? | | | | +--rw local-definition | | | | +--rw cert* | | | | | trust-anchor-cert-cms | | | | +---n certificate-expiration | | | | +-- expiration-date | | | | yang:date-and-time | | | +--:(truststore) | | | {truststore-supported,certi\ \ficates}? | | | +--rw truststore-reference? | | | ts:certificate-bag-ref | | +--rw ee-certs! {x509-certificate-auth}? | | | +--rw (local-or-truststore) | | | +--:(local) | | | | {local-definitions-supporte\ \d}? | | | | +--rw local-definition | | | | +--rw cert* | | | | | trust-anchor-cert-cms | | | | +---n certificate-expiration | | | | +-- expiration-date | | | | yang:date-and-time | | | +--:(truststore) | | | {truststore-supported,certi\ \ficates}? | | | +--rw truststore-reference? | | | ts:certificate-bag-ref | | +--rw raw-public-keys! | | | {raw-public-key-auth}? | | | +--rw (local-or-truststore) | | | +--:(local) | | | | {local-definitions-supporte\ \d}? | | | | +--rw local-definition | | | | +--rw public-key* [name] | | | | +--rw name | | | | | string | | | | +--rw public-key-format | | | | | identityref | | | | +--rw public-key | | | | binary | | | +--:(truststore) | | | {truststore-supported,publi\ \c-keys}? | | | +--rw truststore-reference? | | | ts:public-key-bag-ref | | +--rw psks! {psk-auth}? | +--rw hello-params | | {tls-client-hello-params-config}? | | +--rw tls-versions | | | +--rw tls-version* identityref | | +--rw cipher-suites | | +--rw cipher-suite* identityref | +--rw keepalives {tls-client-keepalives}? | +--rw peer-allowed-to-send? empty | +--rw test-peer-aliveness! | +--rw max-wait? uint16 | +--rw max-attempts? uint8 +--rw netconf-client-parameters A.2. Expanded Tree Diagram for 'ietf-netconf-server' The following tree diagram [RFC8340] provides an overview of the data model for the "ietf-netconf-server" module. This tree diagram shows all the nodes defined in this module, including those defined by "grouping" statements used by this module. Please see Section 4.1 for a tree diagram that illustrates what the module looks like without all the "grouping" statements expanded. ========== NOTE: '\\' line wrapping per BCP XXX (RFC XXXX) ========== module: ietf-netconf-server +--rw netconf-server +--rw listen! {ssh-listen or tls-listen}? | +--rw idle-timeout? uint16 | +--rw endpoint* [name] | +--rw name string | +--rw (transport) | +--:(ssh) {ssh-listen}? | | +--rw ssh | | +--rw tcp-server-parameters | | | +--rw local-address inet:ip-address | | | +--rw local-port? inet:port-number | | | +--rw keepalives! {keepalives-supported}? | | | +--rw idle-time uint16 | | | +--rw max-probes uint16 | | | +--rw probe-interval uint16 | | +--rw ssh-server-parameters | | | +--rw server-identity | | | | +--rw host-key* [name] | | | | +--rw name string | | | | +--rw (host-key-type) | | | | +--:(public-key) | | | | | +--rw public-key | | | | | +--rw (local-or-keystore) | | | | | +--:(local) | | | | | | {local-definitions\ \-supported}? | | | | | | +--rw local-definition | | | | | | +--rw public-key-form\ \at | | | | | | | identityref | | | | | | +--rw public-key | | | | | | | binary | | | | | | +--rw private-key-for\ \mat? | | | | | | | identityref | | | | | | +--rw (private-key-ty\ \pe) | | | | | | +--:(private-key) | | | | | | | +--rw private-k\ \ey? | | | | | | | binary | | | | | | +--:(hidden-privat\ \e-key) | | | | | | | +--rw hidden-pr\ \ivate-key? | | | | | | | empty | | | | | | +--:(encrypted-pri\ \vate-key) | | | | | | +--rw encrypted\ \-private-key | | | | | | +--rw (key-t\ \ype) | | | | | | | +--:(symm\ \etric-key-ref) | | | | | | | | +--rw \ \symmetric-key-ref? leafref | | | | | | | | \ \ {keystore-supported}? | | | | | | | +--:(asym\ \metric-key-ref) | | | | | | | +--rw \ \asymmetric-key-ref? leafref | | | | | | | \ \ {keystore-supported}? | | | | | | +--rw value? | | | | | | bina\ \ry | | | | | +--:(keystore) | | | | | {keystore-supporte\ \d}? | | | | | +--rw keystore-reference? | | | | | ks:asymmetric-ke\ \y-ref | | | | +--:(certificate) | | | | +--rw certificate | | | | {sshcmn:ssh-x509-certs}? | | | | +--rw (local-or-keystore) | | | | +--:(local) | | | | | {local-definitions\ \-supported}? | | | | | +--rw local-definition | | | | | +--rw public-key-form\ \at | | | | | | identityref | | | | | +--rw public-key | | | | | | binary | | | | | +--rw private-key-for\ \mat? | | | | | | identityref | | | | | +--rw (private-key-ty\ \pe) | | | | | | +--:(private-key) | | | | | | | +--rw private-k\ \ey? | | | | | | | binary | | | | | | +--:(hidden-privat\ \e-key) | | | | | | | +--rw hidden-pr\ \ivate-key? | | | | | | | empty | | | | | | +--:(encrypted-pri\ \vate-key) | | | | | | +--rw encrypted\ \-private-key | | | | | | +--rw (key-t\ \ype) | | | | | | | +--:(symm\ \etric-key-ref) | | | | | | | | +--rw \ \symmetric-key-ref? leafref | | | | | | | | \ \ {keystore-supported}? | | | | | | | +--:(asym\ \metric-key-ref) | | | | | | | +--rw \ \asymmetric-key-ref? leafref | | | | | | | \ \ {keystore-supported}? | | | | | | +--rw value? | | | | | | bina\ \ry | | | | | +--rw cert? | | | | | | end-entity-ce\ \rt-cms | | | | | +---n certificate-exp\ \iration | | | | | | +-- expiration-date | | | | | | yang:date-\ \and-time | | | | | +---x generate-certif\ \icate-signing-request | | | | | {certificate-\ \signing-request-generation}? | | | | | +---w input | | | | | | +---w subject | | | | | | | binary | | | | | | +---w attribute\ \s? | | | | | | binary | | | | | +--ro output | | | | | +--ro certifica\ \te-signing-request | | | | | ct:csr | | | | +--:(keystore) | | | | {keystore-supporte\ \d}? | | | | +--rw keystore-reference | | | | +--rw asymmetric-key? | | | | | ks:asymmetric\ \-key-ref | | | | +--rw certificate? \ \ leafref | | | +--rw client-authentication | | | | +--rw supported-authentication-methods | | | | | +--rw publickey? empty | | | | | +--rw password? empty | | | | | | {client-auth-password}? | | | | | +--rw hostbased? empty | | | | | | {client-auth-hostbased}? | | | | | +--rw none? empty | | | | | {client-auth-none}? | | | | +--rw users {client-auth-config-supported}? | | | | | +--rw user* [name] | | | | | +--rw name string | | | | | +--rw public-keys! | | | | | | {client-auth-publickey}? | | | | | | +--rw (local-or-truststore) | | | | | | +--:(local) | | | | | | | {local-definitions-su\ \pported}? | | | | | | | +--rw local-definition | | | | | | | +--rw public-key* [name] | | | | | | | +--rw name | | | | | | | | string | | | | | | | +--rw public-key-form\ \at | | | | | | | | identityref | | | | | | | +--rw public-key | | | | | | | binary | | | | | | +--:(truststore) | | | | | | {truststore-supported\ \,public-keys}? | | | | | | +--rw truststore-reference? | | | | | | ts:public-key-bag-r\ \ef | | | | | +--rw password? | | | | | | ianach:crypt-hash | | | | | | {client-auth-password}? | | | | | +--rw hostbased! | | | | | | {client-auth-hostbased}? | | | | | | +--rw (local-or-truststore) | | | | | | +--:(local) | | | | | | | {local-definitions-su\ \pported}? | | | | | | | +--rw local-definition | | | | | | | +--rw public-key* [name] | | | | | | | +--rw name | | | | | | | | string | | | | | | | +--rw public-key-form\ \at | | | | | | | | identityref | | | | | | | +--rw public-key | | | | | | | binary | | | | | | +--:(truststore) | | | | | | {truststore-supported\ \,public-keys}? | | | | | | +--rw truststore-reference? | | | | | | ts:public-key-bag-r\ \ef | | | | | +--rw none? empty | | | | | {client-auth-none}? | | | | +--rw ca-certs! | | | | | {client-auth-config-supported,sshc\ \mn:ssh-x509-certs}? | | | | | +--rw (local-or-truststore) | | | | | +--:(local) | | | | | | {local-definitions-supporte\ \d}? | | | | | | +--rw local-definition | | | | | | +--rw cert* | | | | | | | trust-anchor-cert-cms | | | | | | +---n certificate-expiration | | | | | | +-- expiration-date | | | | | | yang:date-and-time | | | | | +--:(truststore) | | | | | {truststore-supported,certi\ \ficates}? | | | | | +--rw truststore-reference? | | | | | ts:certificate-bag-ref | | | | +--rw ee-certs! | | | | {client-auth-config-supported,sshc\ \mn:ssh-x509-certs}? | | | | +--rw (local-or-truststore) | | | | +--:(local) | | | | | {local-definitions-supporte\ \d}? | | | | | +--rw local-definition | | | | | +--rw cert* | | | | | | trust-anchor-cert-cms | | | | | +---n certificate-expiration | | | | | +-- expiration-date | | | | | yang:date-and-time | | | | +--:(truststore) | | | | {truststore-supported,certi\ \ficates}? | | | | +--rw truststore-reference? | | | | ts:certificate-bag-ref | | | +--rw transport-params | | | | {ssh-server-transport-params-config}? | | | | +--rw host-key | | | | | +--rw host-key-alg* identityref | | | | +--rw key-exchange | | | | | +--rw key-exchange-alg* identityref | | | | +--rw encryption | | | | | +--rw encryption-alg* identityref | | | | +--rw mac | | | | +--rw mac-alg* identityref | | | +--rw keepalives! {ssh-server-keepalives}? | | | +--rw max-wait? uint16 | | | +--rw max-attempts? uint8 | | +--rw netconf-server-parameters | | +--rw client-identity-mappings | | {tls-listen or tls-call-home or sshcm\ \n:ssh-x509-certs}? | | +--rw cert-to-name* [id] | | +--rw id uint32 | | +--rw fingerprint? | | | x509c2n:tls-fingerprint | | +--rw map-type identityref | | +--rw name string | +--:(tls) {tls-listen}? | +--rw tls | +--rw tcp-server-parameters | | +--rw local-address inet:ip-address | | +--rw local-port? inet:port-number | | +--rw keepalives! {keepalives-supported}? | | +--rw idle-time uint16 | | +--rw max-probes uint16 | | +--rw probe-interval uint16 | +--rw tls-server-parameters | | +--rw server-identity | | | +--rw (auth-type) | | | +--:(certificate) | | | | {x509-certificate-auth}? | | | | +--rw certificate | | | | +--rw (local-or-keystore) | | | | +--:(local) | | | | | {local-definitions-su\ \pported}? | | | | | +--rw local-definition | | | | | +--rw public-key-format | | | | | | identityref | | | | | +--rw public-key | | | | | | binary | | | | | +--rw private-key-format? | | | | | | identityref | | | | | +--rw (private-key-type) | | | | | | +--:(private-key) | | | | | | | +--rw private-key? | | | | | | | binary | | | | | | +--:(hidden-private-k\ \ey) | | | | | | | +--rw hidden-priva\ \te-key? | | | | | | | empty | | | | | | +--:(encrypted-privat\ \e-key) | | | | | | +--rw encrypted-pr\ \ivate-key | | | | | | +--rw (key-type) | | | | | | | +--:(symmetr\ \ic-key-ref) | | | | | | | | +--rw sym\ \metric-key-ref? leafref | | | | | | | | {\ \keystore-supported}? | | | | | | | +--:(asymmet\ \ric-key-ref) | | | | | | | +--rw asy\ \mmetric-key-ref? leafref | | | | | | | {\ \keystore-supported}? | | | | | | +--rw value? | | | | | | binary | | | | | +--rw cert? | | | | | | end-entity-cert-\ \cms | | | | | +---n certificate-expira\ \tion | | | | | | +-- expiration-date | | | | | | yang:date-and\ \-time | | | | | +---x generate-certifica\ \te-signing-request | | | | | {certificate-sig\ \ning-request-generation}? | | | | | +---w input | | | | | | +---w subject | | | | | | | binary | | | | | | +---w attributes? | | | | | | binary | | | | | +--ro output | | | | | +--ro certificate-\ \signing-request | | | | | ct:csr | | | | +--:(keystore) | | | | {keystore-supported}? | | | | +--rw keystore-reference | | | | +--rw asymmetric-key? | | | | | ks:asymmetric-ke\ \y-ref | | | | +--rw certificate? \ \leafref | | | +--:(raw-private-key) | | | | {raw-public-key-auth}? | | | | +--rw raw-private-key | | | | +--rw (local-or-keystore) | | | | +--:(local) | | | | | {local-definitions-su\ \pported}? | | | | | +--rw local-definition | | | | | +--rw public-key-format | | | | | | identityref | | | | | +--rw public-key | | | | | | binary | | | | | +--rw private-key-format? | | | | | | identityref | | | | | +--rw (private-key-type) | | | | | +--:(private-key) | | | | | | +--rw private-key? | | | | | | binary | | | | | +--:(hidden-private-k\ \ey) | | | | | | +--rw hidden-priva\ \te-key? | | | | | | empty | | | | | +--:(encrypted-privat\ \e-key) | | | | | +--rw encrypted-pr\ \ivate-key | | | | | +--rw (key-type) | | | | | | +--:(symmetr\ \ic-key-ref) | | | | | | | +--rw sym\ \metric-key-ref? leafref | | | | | | | {\ \keystore-supported}? | | | | | | +--:(asymmet\ \ric-key-ref) | | | | | | +--rw asy\ \mmetric-key-ref? leafref | | | | | | {\ \keystore-supported}? | | | | | +--rw value? | | | | | binary | | | | +--:(keystore) | | | | {keystore-supported}? | | | | +--rw keystore-reference? | | | | ks:asymmetric-key-r\ \ef | | | +--:(psk) {psk-auth}? | | | +--rw psk | | | +--rw (local-or-keystore) | | | +--:(local) | | | | {local-definitions-su\ \pported}? | | | | +--rw local-definition | | | | +--rw key-format? | | | | | identityref | | | | +--rw (key-type) | | | | | +--:(key) | | | | | | +--rw key? | | | | | | binary | | | | | +--:(hidden-key) | | | | | | +--rw hidden-key? | | | | | | empty | | | | | +--:(encrypted-key) | | | | | +--rw encrypted-key | | | | | +--rw (key-type) | | | | | | +--:(symmetr\ \ic-key-ref) | | | | | | | +--rw sym\ \metric-key-ref? leafref | | | | | | | {\ \keystore-supported}? | | | | | | +--:(asymmet\ \ric-key-ref) | | | | | | +--rw asy\ \mmetric-key-ref? leafref | | | | | | {\ \keystore-supported}? | | | | | +--rw value? | | | | | binary | | | | +--rw id? | | | | string | | | | {ks:local-defini\ \tions-supported}? | | | +--:(keystore) | | | {keystore-supported}? | | | +--rw keystore-reference? | | | ks:symmetric-key-ref | | +--rw client-authentication! | | | {client-auth-config-supported}? | | | +--rw ca-certs! {x509-certificate-auth}? | | | | +--rw (local-or-truststore) | | | | +--:(local) | | | | | {local-definitions-supporte\ \d}? | | | | | +--rw local-definition | | | | | +--rw cert* | | | | | | trust-anchor-cert-cms | | | | | +---n certificate-expiration | | | | | +-- expiration-date | | | | | yang:date-and-time | | | | +--:(truststore) | | | | {truststore-supported,certi\ \ficates}? | | | | +--rw truststore-reference? | | | | ts:certificate-bag-ref | | | +--rw ee-certs! {x509-certificate-auth}? | | | | +--rw (local-or-truststore) | | | | +--:(local) | | | | | {local-definitions-supporte\ \d}? | | | | | +--rw local-definition | | | | | +--rw cert* | | | | | | trust-anchor-cert-cms | | | | | +---n certificate-expiration | | | | | +-- expiration-date | | | | | yang:date-and-time | | | | +--:(truststore) | | | | {truststore-supported,certi\ \ficates}? | | | | +--rw truststore-reference? | | | | ts:certificate-bag-ref | | | +--rw raw-public-keys! | | | | {raw-public-key-auth}? | | | | +--rw (local-or-truststore) | | | | +--:(local) | | | | | {local-definitions-supporte\ \d}? | | | | | +--rw local-definition | | | | | +--rw public-key* [name] | | | | | +--rw name | | | | | | string | | | | | +--rw public-key-format | | | | | | identityref | | | | | +--rw public-key | | | | | binary | | | | +--:(truststore) | | | | {truststore-supported,publi\ \c-keys}? | | | | +--rw truststore-reference? | | | | ts:public-key-bag-ref | | | +--rw psks! {psk-auth}? | | +--rw hello-params | | | {tls-server-hello-params-config}? | | | +--rw tls-versions | | | | +--rw tls-version* identityref | | | +--rw cipher-suites | | | +--rw cipher-suite* identityref | | +--rw keepalives {tls-server-keepalives}? | | +--rw peer-allowed-to-send? empty | | +--rw test-peer-aliveness! | | +--rw max-wait? uint16 | | +--rw max-attempts? uint8 | +--rw netconf-server-parameters | +--rw client-identity-mappings | {tls-listen or tls-call-home or sshcm\ \n:ssh-x509-certs}? | +--rw cert-to-name* [id] | +--rw id uint32 | +--rw fingerprint? | | x509c2n:tls-fingerprint | +--rw map-type identityref | +--rw name string +--rw call-home! {ssh-call-home or tls-call-home}? +--rw netconf-client* [name] +--rw name string +--rw endpoints | +--rw endpoint* [name] | +--rw name string | +--rw (transport) | +--:(ssh) {ssh-call-home}? | | +--rw ssh | | +--rw tcp-client-parameters | | | +--rw remote-address inet:host | | | +--rw remote-port? inet:port-number | | | +--rw local-address? inet:ip-address | | | | {local-binding-supported}? | | | +--rw local-port? inet:port-number | | | | {local-binding-supported}? | | | +--rw keepalives! | | | {keepalives-supported}? | | | +--rw idle-time uint16 | | | +--rw max-probes uint16 | | | +--rw probe-interval uint16 | | +--rw ssh-server-parameters | | | +--rw server-identity | | | | +--rw host-key* [name] | | | | +--rw name string | | | | +--rw (host-key-type) | | | | +--:(public-key) | | | | | +--rw public-key | | | | | +--rw (local-or-keystore) | | | | | +--:(local) | | | | | | {local-defin\ \itions-supported}? | | | | | | +--rw local-defini\ \tion | | | | | | +--rw public-ke\ \y-format | | | | | | | identit\ \yref | | | | | | +--rw public-key | | | | | | | binary | | | | | | +--rw private-k\ \ey-format? | | | | | | | identit\ \yref | | | | | | +--rw (private-\ \key-type) | | | | | | +--:(private\ \-key) | | | | | | | +--rw pri\ \vate-key? | | | | | | | b\ \inary | | | | | | +--:(hidden-\ \private-key) | | | | | | | +--rw hid\ \den-private-key? | | | | | | | e\ \mpty | | | | | | +--:(encrypt\ \ed-private-key) | | | | | | +--rw enc\ \rypted-private-key | | | | | | +--rw \ \(key-type) | | | | | | | +--\ \:(symmetric-key-ref) | | | | | | | | \ \+--rw symmetric-key-ref? leafref | | | | | | | | \ \ {keystore-supported}? | | | | | | | +--\ \:(asymmetric-key-ref) | | | | | | | \ \+--rw asymmetric-key-ref? leafref | | | | | | | \ \ {keystore-supported}? | | | | | | +--rw \ \value? | | | | | | \ \ binary | | | | | +--:(keystore) | | | | | {keystore-su\ \pported}? | | | | | +--rw keystore-ref\ \erence? | | | | | ks:asymmet\ \ric-key-ref | | | | +--:(certificate) | | | | +--rw certificate | | | | {sshcmn:ssh-x509-ce\ \rts}? | | | | +--rw (local-or-keystore) | | | | +--:(local) | | | | | {local-defin\ \itions-supported}? | | | | | +--rw local-defini\ \tion | | | | | +--rw public-ke\ \y-format | | | | | | identit\ \yref | | | | | +--rw public-key | | | | | | binary | | | | | +--rw private-k\ \ey-format? | | | | | | identit\ \yref | | | | | +--rw (private-\ \key-type) | | | | | | +--:(private\ \-key) | | | | | | | +--rw pri\ \vate-key? | | | | | | | b\ \inary | | | | | | +--:(hidden-\ \private-key) | | | | | | | +--rw hid\ \den-private-key? | | | | | | | e\ \mpty | | | | | | +--:(encrypt\ \ed-private-key) | | | | | | +--rw enc\ \rypted-private-key | | | | | | +--rw \ \(key-type) | | | | | | | +--\ \:(symmetric-key-ref) | | | | | | | | \ \+--rw symmetric-key-ref? leafref | | | | | | | | \ \ {keystore-supported}? | | | | | | | +--\ \:(asymmetric-key-ref) | | | | | | | \ \+--rw asymmetric-key-ref? leafref | | | | | | | \ \ {keystore-supported}? | | | | | | +--rw \ \value? | | | | | | \ \ binary | | | | | +--rw cert? | | | | | | end-ent\ \ity-cert-cms | | | | | +---n certifica\ \te-expiration | | | | | | +-- expirati\ \on-date | | | | | | yang\ \:date-and-time | | | | | +---x generate-\ \certificate-signing-request | | | | | {certif\ \icate-signing-request-generation}? | | | | | +---w input | | | | | | +---w sub\ \ject | | | | | | | b\ \inary | | | | | | +---w att\ \ributes? | | | | | | b\ \inary | | | | | +--ro output | | | | | +--ro cer\ \tificate-signing-request | | | | | c\ \t:csr | | | | +--:(keystore) | | | | {keystore-su\ \pported}? | | | | +--rw keystore-ref\ \erence | | | | +--rw asymmetri\ \c-key? | | | | | ks:asym\ \metric-key-ref | | | | +--rw certifica\ \te? leafref | | | +--rw client-authentication | | | | +--rw supported-authentication-metho\ \ds | | | | | +--rw publickey? empty | | | | | +--rw password? empty | | | | | | {client-auth-password}? | | | | | +--rw hostbased? empty | | | | | | {client-auth-hostbased}? | | | | | +--rw none? empty | | | | | {client-auth-none}? | | | | +--rw users | | | | | {client-auth-config-supporte\ \d}? | | | | | +--rw user* [name] | | | | | +--rw name string | | | | | +--rw public-keys! | | | | | | {client-auth-publickey\ \}? | | | | | | +--rw (local-or-truststore) | | | | | | +--:(local) | | | | | | | {local-definiti\ \ons-supported}? | | | | | | | +--rw local-definition | | | | | | | +--rw public-key* | | | | | | | [name] | | | | | | | +--rw name | | | | | | | | string | | | | | | | +--rw public-ke\ \y-format | | | | | | | | identit\ \yref | | | | | | | +--rw public-key | | | | | | | binary | | | | | | +--:(truststore) | | | | | | {truststore-sup\ \ported,public-keys}? | | | | | | +--rw truststore-refe\ \rence? | | | | | | ts:public-key\ \-bag-ref | | | | | +--rw password? | | | | | | ianach:crypt-hash | | | | | | {client-auth-password}? | | | | | +--rw hostbased! | | | | | | {client-auth-hostbased\ \}? | | | | | | +--rw (local-or-truststore) | | | | | | +--:(local) | | | | | | | {local-definiti\ \ons-supported}? | | | | | | | +--rw local-definition | | | | | | | +--rw public-key* | | | | | | | [name] | | | | | | | +--rw name | | | | | | | | string | | | | | | | +--rw public-ke\ \y-format | | | | | | | | identit\ \yref | | | | | | | +--rw public-key | | | | | | | binary | | | | | | +--:(truststore) | | | | | | {truststore-sup\ \ported,public-keys}? | | | | | | +--rw truststore-refe\ \rence? | | | | | | ts:public-key\ \-bag-ref | | | | | +--rw none? empty | | | | | {client-auth-none}? | | | | +--rw ca-certs! | | | | | {client-auth-config-supporte\ \d,sshcmn:ssh-x509-certs}? | | | | | +--rw (local-or-truststore) | | | | | +--:(local) | | | | | | {local-definitions-su\ \pported}? | | | | | | +--rw local-definition | | | | | | +--rw cert* | | | | | | | trust-anchor-cer\ \t-cms | | | | | | +---n certificate-expira\ \tion | | | | | | +-- expiration-date | | | | | | yang:date-and\ \-time | | | | | +--:(truststore) | | | | | {truststore-supported\ \,certificates}? | | | | | +--rw truststore-reference? | | | | | ts:certificate-bag-\ \ref | | | | +--rw ee-certs! | | | | {client-auth-config-supporte\ \d,sshcmn:ssh-x509-certs}? | | | | +--rw (local-or-truststore) | | | | +--:(local) | | | | | {local-definitions-su\ \pported}? | | | | | +--rw local-definition | | | | | +--rw cert* | | | | | | trust-anchor-cer\ \t-cms | | | | | +---n certificate-expira\ \tion | | | | | +-- expiration-date | | | | | yang:date-and\ \-time | | | | +--:(truststore) | | | | {truststore-supported\ \,certificates}? | | | | +--rw truststore-reference? | | | | ts:certificate-bag-\ \ref | | | +--rw transport-params | | | | {ssh-server-transport-params-co\ \nfig}? | | | | +--rw host-key | | | | | +--rw host-key-alg* identityref | | | | +--rw key-exchange | | | | | +--rw key-exchange-alg* | | | | | identityref | | | | +--rw encryption | | | | | +--rw encryption-alg* | | | | | identityref | | | | +--rw mac | | | | +--rw mac-alg* identityref | | | +--rw keepalives! | | | {ssh-server-keepalives}? | | | +--rw max-wait? uint16 | | | +--rw max-attempts? uint8 | | +--rw netconf-server-parameters | | +--rw client-identity-mappings | | {tls-listen or tls-call-home or\ \ sshcmn:ssh-x509-certs}? | | +--rw cert-to-name* [id] | | +--rw id uint32 | | +--rw fingerprint? | | | x509c2n:tls-fingerprint | | +--rw map-type identityref | | +--rw name string | +--:(tls) {tls-call-home}? | +--rw tls | +--rw tcp-client-parameters | | +--rw remote-address inet:host | | +--rw remote-port? inet:port-number | | +--rw local-address? inet:ip-address | | | {local-binding-supported}? | | +--rw local-port? inet:port-number | | | {local-binding-supported}? | | +--rw keepalives! | | {keepalives-supported}? | | +--rw idle-time uint16 | | +--rw max-probes uint16 | | +--rw probe-interval uint16 | +--rw tls-server-parameters | | +--rw server-identity | | | +--rw (auth-type) | | | +--:(certificate) | | | | {x509-certificate-auth}? | | | | +--rw certificate | | | | +--rw (local-or-keystore) | | | | +--:(local) | | | | | {local-definiti\ \ons-supported}? | | | | | +--rw local-definition | | | | | +--rw public-key-f\ \ormat | | | | | | identityref | | | | | +--rw public-key | | | | | | binary | | | | | +--rw private-key-\ \format? | | | | | | identityref | | | | | +--rw (private-key\ \-type) | | | | | | +--:(private-ke\ \y) | | | | | | | +--rw privat\ \e-key? | | | | | | | bina\ \ry | | | | | | +--:(hidden-pri\ \vate-key) | | | | | | | +--rw hidden\ \-private-key? | | | | | | | empty | | | | | | +--:(encrypted-\ \private-key) | | | | | | +--rw encryp\ \ted-private-key | | | | | | +--rw (ke\ \y-type) | | | | | | | +--:(s\ \ymmetric-key-ref) | | | | | | | | +--\ \rw symmetric-key-ref? leafref | | | | | | | | \ \ {keystore-supported}? | | | | | | | +--:(a\ \symmetric-key-ref) | | | | | | | +--\ \rw asymmetric-key-ref? leafref | | | | | | | \ \ {keystore-supported}? | | | | | | +--rw val\ \ue? | | | | | | b\ \inary | | | | | +--rw cert? | | | | | | end-entity\ \-cert-cms | | | | | +---n certificate-\ \expiration | | | | | | +-- expiration-\ \date | | | | | | yang:da\ \te-and-time | | | | | +---x generate-cer\ \tificate-signing-request | | | | | {certifica\ \te-signing-request-generation}? | | | | | +---w input | | | | | | +---w subject | | | | | | | bina\ \ry | | | | | | +---w attrib\ \utes? | | | | | | bina\ \ry | | | | | +--ro output | | | | | +--ro certif\ \icate-signing-request | | | | | ct:c\ \sr | | | | +--:(keystore) | | | | {keystore-suppo\ \rted}? | | | | +--rw keystore-refere\ \nce | | | | +--rw asymmetric-k\ \ey? | | | | | ks:asymmet\ \ric-key-ref | | | | +--rw certificate?\ \ leafref | | | +--:(raw-private-key) | | | | {raw-public-key-auth}? | | | | +--rw raw-private-key | | | | +--rw (local-or-keystore) | | | | +--:(local) | | | | | {local-definiti\ \ons-supported}? | | | | | +--rw local-definition | | | | | +--rw public-key-f\ \ormat | | | | | | identityref | | | | | +--rw public-key | | | | | | binary | | | | | +--rw private-key-\ \format? | | | | | | identityref | | | | | +--rw (private-key\ \-type) | | | | | +--:(private-ke\ \y) | | | | | | +--rw privat\ \e-key? | | | | | | bina\ \ry | | | | | +--:(hidden-pri\ \vate-key) | | | | | | +--rw hidden\ \-private-key? | | | | | | empty | | | | | +--:(encrypted-\ \private-key) | | | | | +--rw encryp\ \ted-private-key | | | | | +--rw (ke\ \y-type) | | | | | | +--:(s\ \ymmetric-key-ref) | | | | | | | +--\ \rw symmetric-key-ref? leafref | | | | | | | \ \ {keystore-supported}? | | | | | | +--:(a\ \symmetric-key-ref) | | | | | | +--\ \rw asymmetric-key-ref? leafref | | | | | | \ \ {keystore-supported}? | | | | | +--rw val\ \ue? | | | | | b\ \inary | | | | +--:(keystore) | | | | {keystore-suppo\ \rted}? | | | | +--rw keystore-refere\ \nce? | | | | ks:asymmetric\ \-key-ref | | | +--:(psk) {psk-auth}? | | | +--rw psk | | | +--rw (local-or-keystore) | | | +--:(local) | | | | {local-definiti\ \ons-supported}? | | | | +--rw local-definition | | | | +--rw key-format? | | | | | identityref | | | | +--rw (key-type) | | | | | +--:(key) | | | | | | +--rw key? | | | | | | bina\ \ry | | | | | +--:(hidden-key) | | | | | | +--rw hidden\ \-key? | | | | | | empty | | | | | +--:(encrypted-\ \key) | | | | | +--rw encryp\ \ted-key | | | | | +--rw (ke\ \y-type) | | | | | | +--:(s\ \ymmetric-key-ref) | | | | | | | +--\ \rw symmetric-key-ref? leafref | | | | | | | \ \ {keystore-supported}? | | | | | | +--:(a\ \symmetric-key-ref) | | | | | | +--\ \rw asymmetric-key-ref? leafref | | | | | | \ \ {keystore-supported}? | | | | | +--rw val\ \ue? | | | | | b\ \inary | | | | +--rw id? | | | | string | | | | {ks:local-\ \definitions-supported}? | | | +--:(keystore) | | | {keystore-suppo\ \rted}? | | | +--rw keystore-refere\ \nce? | | | ks:symmetric-\ \key-ref | | +--rw client-authentication! | | | {client-auth-config-supported}? | | | +--rw ca-certs! | | | | {x509-certificate-auth}? | | | | +--rw (local-or-truststore) | | | | +--:(local) | | | | | {local-definitions-su\ \pported}? | | | | | +--rw local-definition | | | | | +--rw cert* | | | | | | trust-anchor-cer\ \t-cms | | | | | +---n certificate-expira\ \tion | | | | | +-- expiration-date | | | | | yang:date-and\ \-time | | | | +--:(truststore) | | | | {truststore-supported\ \,certificates}? | | | | +--rw truststore-reference? | | | | ts:certificate-bag-\ \ref | | | +--rw ee-certs! | | | | {x509-certificate-auth}? | | | | +--rw (local-or-truststore) | | | | +--:(local) | | | | | {local-definitions-su\ \pported}? | | | | | +--rw local-definition | | | | | +--rw cert* | | | | | | trust-anchor-cer\ \t-cms | | | | | +---n certificate-expira\ \tion | | | | | +-- expiration-date | | | | | yang:date-and\ \-time | | | | +--:(truststore) | | | | {truststore-supported\ \,certificates}? | | | | +--rw truststore-reference? | | | | ts:certificate-bag-\ \ref | | | +--rw raw-public-keys! | | | | {raw-public-key-auth}? | | | | +--rw (local-or-truststore) | | | | +--:(local) | | | | | {local-definitions-su\ \pported}? | | | | | +--rw local-definition | | | | | +--rw public-key* [name] | | | | | +--rwtls-call-home) and (sshcmn:ssh-x509-certs)"; description "Specifies mappings through which NETCONF client X.509 certificates are used to determine a NETCONF username. If no matching and valid cert-to-name list entry can be found, then the NETCONF server MUST close the connection, and MUST NOT accept NETCONF messages over it."; reference "RFC 7407: A YANG Data Model for SNMP Configuration."; uses x509c2n:cert-to-name { refine "cert-to-name/fingerprint" { mandatory false; description "A 'fingerprint' value does not need to be specified when the 'cert-to-name' mapping is independent of fingerprint matching. A 'cert-to-name' having no fingerprint value will match any client certificate and therefore should only be present at the end of the user-ordered 'cert-to-name' list."; } } } } grouping netconf-server-listen-stack-grouping { description "A reusable grouping for configuring a NETCONF server 'listen' protocol stack for a single connection."; choice transport { mandatory true; description "Selects between available transports."; case ssh { if-feature "ssh-listen"; container ssh { description "SSH-specific listening configuration for inbound connections."; container tcp-server-parameters { description "A wrapper around the TCP client parameters to avoid name collisions."; uses tcps:tcp-server-grouping { refine "local-port" { default "830"; description "The NETCONF server will listen on the IANA-assigned well-known port value for 'netconf-ssh' (830) if no value is specified."; } } } container ssh-server-parameters { description "A wrapper around the SSH server parameters to avoid name collisions."; uses sshs:ssh-server-grouping; } container netconf-server-parameters { description "A wrapper around the NETCONF server parameters to avoid name collisions."; uses ncs:netconf-server-grouping; } } } case tls { if-feature "tls-listen"; container tls { description "TLS-specific listening configuration for inbound connections."; container tcp-server-parameters { description "A wrapper around the TCP client parameters to avoid name collisions."; uses tcps:tcp-server-grouping { refine "local-port" { default "6513"; description "The NETCONF server will listen on the IANA-assigned well-known port value for 'netconf-tls' (6513) if no value is specified."; } } } container tls-server-parameters { description "A wrapper around the TLS server parameters to avoid name collisions."; uses tlss:tls-server-grouping { refine "client-authentication" { must 'ca-certs or ee-certs'; description "NETCONF/TLS servers MUST validate client certificates. This configures certificates at the socket-level (i.e. bags), more discriminating client-certificate checks SHOULD be implemented by the application."; reference "RFC 7589: Using the NETCONF Protocol over Transport Layer Security (TLS) with Mutual X.509 Authentication"; } } } container netconf-server-parameters { description "A wrapper around the NETCONF server parameters to avoid name collisions."; uses ncs:netconf-server-grouping; } } } } } grouping netconf-server-callhome-stack-grouping { description "A reusable grouping for configuring a NETCONF server 'call-home' protocol stack, for a single connection."; choice transport { mandatory true; description "Selects between available transports."; case ssh { if-feature "ssh-call-home"; container ssh { description "Specifies SSH-specific call-home transport configuration."; container tcp-client-parameters { description "A wrapper around the TCP client parameters to avoid name collisions."; uses tcpc:tcp-client-grouping { refine "remote-port" { default "4334"; description "The NETCONF server will attempt to connect to the IANA-assigned well-known port for 'netconf-ch-tls' (4334) if no value is specified."; } } } container ssh-server-parameters { description "A wrapper around the SSH server parameters to avoid name collisions."; uses sshs:ssh-server-grouping; } container netconf-server-parameters { description "A wrapper around the NETCONF server parameters to avoid name collisions."; uses ncs:netconf-server-grouping; } } } case tls { if-feature "tls-call-home"; container tls { description "Specifies TLS-specific call-home transport configuration."; container tcp-client-parameters { description "A wrapper around the TCP client parameters to avoid name collisions."; uses tcpc:tcp-client-grouping { refine "remote-port" { default "4335"; description "The NETCONF server will attempt to connect to the IANA-assigned well-known port for 'netconf-ch-tls' (4335) if no value is specified."; } } } container tls-server-parameters { description "A wrapper around the TLS server parameters to avoid name collisions."; uses tlss:tls-server-grouping { refine "client-authentication" { must 'ca-certs or ee-certs'; description "NETCONF/TLS servers MUST validate client certificates. This configures certificates at the socket-level (i.e. bags), more discriminating client-certificate checks SHOULD be implemented by the application."; reference "RFC 7589: Using the NETCONF Protocol over Transport Layer Security (TLS) with Mutual X.509 Authentication"; } } } container netconf-server-parameters { description "A wrapper around the NETCONF server parameters to avoid name collisions."; uses ncs:netconf-server-grouping; } } } } } grouping netconf-server-app-grouping { description "A reusable grouping for configuring a NETCONF server application that supports both 'listen' and 'call-home' protocol stacks for a multiplicity of connections."; container listen { if-feature "ssh-listen or tls-listen"; presence "Enables server to listen for NETCONF client connections."; description "Configures listen behavior"; leaf idle-timeout { type uint16; units "seconds"; default 3600; // one hour description "Specifies the maximum number of seconds that a NETCONF session may remain idle. A NETCONF session will be dropped if it is idle for an interval longer than this number of seconds. If set to zero, then the server will never drop a session because it is idle. Sessions that have a notification subscription active are never dropped."; } list endpoint { key "name"; min-elements 1; description "List of endpoints to listen for NETCONF connections."; leaf name { type string; description "An arbitrary name| | | | | | string | | | | | +--rw public-key-form\ \at | | | | | | identityref | | | | | +--rw public-key | | | | | binary | | | | +--:(truststore) | | | | {truststore-supported\ \,public-keys}? | | | | +--rw truststore-reference? | | | | ts:public-key-bag-r\ \ef | | | +--rw psks! {psk-auth}? | | +--rw hello-params | | | {tls-server-hello-params-config\ \}? | | | +--rw tls-versions | | | | +--rw tls-version* identityref | | | +--rw cipher-suites | | | +--rw cipher-suite* identityref | | +--rw keepalives | | {tls-server-keepalives}? | | +--rw peer-allowed-to-send? empty | | +--rw test-peer-aliveness! | | +--rw max-wait? uint16 | | +--rw max-attempts?for the NETCONF listen endpoint."; } uses netconf-server-listen-stack-grouping; } } container call-home { if-feature "ssh-call-home or tls-call-home"; presence "Enables the NETCONF server to initiate the underlying transport connection to NETCONF clients."; description "Configures call home behavior."; list netconf-client { key "name"; min-elements 1; description "List of NETCONF clients the NETCONF server is to maintain simultaneous call-home connections with."; leaf name { type string; description "An arbitrary name for the remote NETCONF client."; } container endpoints { description "Container for the list of endpoints."; list endpoint { key "name"; min-elements 1; ordered-by user; description "A non-empty user-ordered list of endpoints for this NETCONF server to try to connect to in sequence. Defining more than one enables high-availability."; leaf name { type string; description "An arbitrary name for this endpoint."; } uses netconf-server-callhome-stack-grouping; } } container connection-type { description "Indicates the NETCONF server's preference for how the NETCONF connection is maintained."; choice connection-type { mandatory true; description "Selects between available connection types."; case persistent-connection { container persistent { presence "Indicates that a persistent connection is to be maintained."; description "Maintain a persistent connection to the NETCONF client. If the connection goes down, immediately start trying to reconnect to the NETCONF client, using the reconnection strategy. This connection type minimizes any NETCONF client to NETCONF server data-transfer delay, albeit at the expense of holding resources longer."; } } case periodic-connection { container periodic { presence "Indicates that a periodic connection is to be maintained."; description "Periodically connect to the NETCONF client. This connection type increases resource utilization, albeit with increased delay in NETCONF client to NETCONF client interactions. The NETCONF client SHOULD gracefully close the connection using <close-session> upon completing planned activities. If the NETCONF session is not closed gracefully, the NETCONF server MUST immediately attempt to reestablish the connection. In the case that the previous connection is still active (i.e., the NETCONF client has not closed it yet), establishing a new connection is NOT RECOMMENDED."; leaf period { type uint16; units "minutes"; default "60"; description "Duration of time between periodic connections."; } leaf anchor-time { type yang:date-and-time { // constrained to minute-level granularity pattern '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}' + '(Z|[\+\-]\d{2}:\d{2})'; } description "Designates a timestamp before or after which a series of periodic connections are determined. The periodic connections occur at a whole multiple interval from the anchor time. For example, for an anchor time is 15 minutes past midnight and a period interval of 24 hours, then a periodic connection will occur 15 minutes past midnight everyday."; } leaf idle-timeout { type uint16; units "seconds"; default 120; // two minutes description "Specifies the maximum number of seconds that a NETCONF session may remain idle. A NETCONF session will be dropped if it is idle for an interval longer than this number of seconds. If set to zero, then the server will never drop a session because it is idle."; } } } // case periodic-connection } // choice connection-type } // container connection-type container reconnect-strategy { description "The reconnection strategy directs how a NETCONF server reconnects to a NETCONF client, after discovering its connection to the client has dropped, even if due to a reboot. The NETCONF server starts with the specified endpoint and tries to connect to it max-attempts times before trying the next endpoint in the list (round robin)."; leaf start-with { type enumeration { enum first-listed { description "Indicates that reconnections should start with the first endpoint listed."; } enum last-connected { description "Indicates that reconnections should start with the endpoint last connected to. If no previous connection has ever been established, then the first endpoint configured is used. NETCONF servers SHOULD be able to remember the last endpoint connected to across reboots."; } enum random-selection { description "Indicates that reconnections should start with a random endpoint."; } } default "first-listed"; description "Specifies which of the NETCONF client's endpoints the NETCONF server should start with when trying to connect to the NETCONF client."; } leaf max-attempts { type uint8| +--rw netconf-server-parameters | +--rw client-identity-mappings | {tls-listen{ range "1..max"; } default "3"; description "Specifies the number times the NETCONF server tries to connect to a specific endpoint before moving on to the next endpoint in the list (round robin)."; } } // container reconnect-strategy } // list netconf-client } // container call-home } // grouping netconf-server-app-grouping // Protocol accessible node, for servers that implement // this module. container netconf-server { uses netconf-server-app-grouping; description "Top-level container for NETCONF server configuration."; } } <CODE ENDS> 4. Security Considerations 4.1. The "ietf-netconf-client" YANG Module The "ietf-netconf-client" YANG module defines data nodes 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 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. 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. Please be aware that this module uses groupings defined in other RFCs that define data nodes that do set the NACM "default-deny-all" and "default-deny-write" extensions. 4.2. The "ietf-netconf-server" YANG Module The "ietf-netconf-server" YANG module defines data nodes 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 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. None of the readable data nodes defined in this YANG module are considered sensitive ortls-call-home or\ \ sshcmn:ssh-x509-certs}? | +--rw cert-to-name* [id] | +--rw id uint32 | +--rw fingerprint? | | x509c2n:tls-fingerprint | +--rw map-type identityref | +--rw name string +--rw connection-type | +--rw (connection-type) | +--:(persistent-connection) | | +--rw persistent! | +--:(periodic-connection) | +--rw periodic! | +--rw period? uint16 | +--rw anchor-time? yang:date-and-time | +--rw idle-timeout? uint16 +--rw reconnect-strategy +--rw start-with? enumeration +--rw max-attempts? uint8vulnerable 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. Please be aware that this module uses groupings defined in other RFCs that define data nodes that do set the NACM "default-deny-all" and "default-deny-write" extensions. 5. IANA Considerations 5.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-netconf-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-netconf-server Registrant Contact: The NETCONF WG of the IETF. XML: N/A, the requested URI is an XML namespace. 5.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 the following registrations are requested: name: ietf-netconf-client namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-client prefix: ncc reference: RFC HHHH name: ietf-netconf-server namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-server prefix: ncs reference: RFC HHHH 6. References 6.1. Normative References [I-D.ietf-netconf-keystore] Watsen, K., "A YANG Data Model for a Keystore", Work in Progress, Internet-Draft, draft-ietf-netconf-keystore-17, 20 May 2020, <https://tools.ietf.org/html/draft-ietf- netconf-keystore-17>. [I-D.ietf-netconf-ssh-client-server] Watsen, K. and G. Wu, "YANG Groupings for SSH Clients and SSH Servers", Work in Progress, Internet-Draft, draft- ietf-netconf-ssh-client-server-19, 20 May 2020, <https://tools.ietf.org/html/draft-ietf-netconf-ssh- client-server-19>. [I-D.ietf-netconf-tcp-client-server] Watsen, K. and M. Scharf, "YANG Groupings for TCP Clients and TCP Servers", Work in Progress, Internet-Draft, draft- ietf-netconf-tcp-client-server-06, 16 June 2020, <https://tools.ietf.org/html/draft-ietf-netconf-tcp- client-server-06>. [I-D.ietf-netconf-tls-client-server] Watsen, K. and G. Wu, "YANG Groupings for TLS Clients and TLS Servers", Work in Progress, Internet-Draft, draft- ietf-netconf-tls-client-server-19, 20 May 2020, <https://tools.ietf.org/html/draft-ietf-netconf-tls- client-server-19>. [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, <https://www.rfc-editor.org/info/rfc2119>. [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, DOI 10.17487/RFC6020, October 2010, <https://www.rfc-editor.org/info/rfc6020>. [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, <https://www.rfc-editor.org/info/rfc6241>. [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, <https://www.rfc-editor.org/info/rfc6242>. [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", RFC 6991, DOI 10.17487/RFC6991, July 2013, <https://www.rfc-editor.org/info/rfc6991>. [RFC7407] Bjorklund, M. and J. Schoenwaelder, "A YANG Data Model for SNMP Configuration", RFC 7407, DOI 10.17487/RFC7407, December 2014, <https://www.rfc-editor.org/info/rfc7407>. [RFC7589] Badra, M., Luchuk, A., and J. Schoenwaelder, "Using the NETCONF Protocol over Transport Layer Security (TLS) with Mutual X.509 Authentication", RFC 7589, DOI 10.17487/RFC7589, June 2015, <https://www.rfc-editor.org/info/rfc7589>. [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", RFC 7950, DOI 10.17487/RFC7950, August 2016, <https://www.rfc-editor.org/info/rfc7950>. [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, <https://www.rfc-editor.org/info/rfc8174>. 6.2. Informative References [I-D.ietf-netconf-crypto-types] Watsen, K., "Common YANG Data Types for Cryptography", Work in Progress, Internet-Draft, draft-ietf-netconf- crypto-types-15, 20 May 2020, <https://tools.ietf.org/html/draft-ietf-netconf-crypto- types-15>. [I-D.ietf-netconf-http-client-server] Watsen, K., "YANG Groupings for HTTP Clients and HTTP Servers", Work in Progress, Internet-Draft, draft-ietf- netconf-http-client-server-03, 20 May 2020, <https://tools.ietf.org/html/draft-ietf-netconf-http- client-server-03>. [I-D.ietf-netconf-netconf-client-server] Watsen, K., "NETCONF Client and Server Models", Work in Progress, Internet-Draft, draft-ietf-netconf-netconf- client-server-19, 20 May 2020, <https://tools.ietf.org/html/draft-ietf-netconf-netconf- client-server-19>. [I-D.ietf-netconf-restconf-client-server] Watsen, K., "RESTCONF Client and Server Models", Work in Progress, Internet-Draft, draft-ietf-netconf-restconf- client-server-19, 20 May 2020, <https://tools.ietf.org/html/draft-ietf-netconf-restconf- client-server-19>. [I-D.ietf-netconf-trust-anchors] Watsen, K., "A YANG Data Model for a Truststore", Work in Progress, Internet-Draft, draft-ietf-netconf-trust- anchors-10, 20 May 2020, <https://tools.ietf.org/html/ draft-ietf-netconf-trust-anchors-10>. [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, <https://www.rfc-editor.org/info/rfc3688>. [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, <https://www.rfc-editor.org/info/rfc8040>. [RFC8071] Watsen, K., "NETCONF Call Home and RESTCONF Call Home", RFC 8071, DOI 10.17487/RFC8071, February 2017, <https://www.rfc-editor.org/info/rfc8071>. [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, <https://www.rfc-editor.org/info/rfc8340>. [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration Access Control Model", STD 91, RFC 8341, DOI 10.17487/RFC8341, March 2018, <https://www.rfc-editor.org/info/rfc8341>. [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., and R. Wilton, "Network Management Datastore Architecture (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, <https://www.rfc-editor.org/info/rfc8342>. AppendixB.A. Change LogB.1.This section is to be removed before publishing as an RFC. A.1. 00 to 01o* Renamed "keychain" to "keystore".B.2.A.2. 01 to 02o* Added to ietf-netconf-client ability to connected to a cluster of endpoints, including a reconnection-strategy.o* Added to ietf-netconf-client the ability to configure connection- type and also keep-alive strategy.o* Updated both modules to accommodate new groupings in the ssh/tls drafts.B.3.A.3. 02 to 03o* Refined use of tls-client-grouping to add a must statement indicating that the TLS client must specify a client-certificate.o* Changed 'netconf-client' to be a grouping (not a container).B.4.A.4. 03 to 04o* Added RFC 8174 to Requirements Language Section.o* Replaced refine statement in ietf-netconf-client to add a mandatory true.o* Added refine statement in ietf-netconf-server to add a must statement.o* Now there are containers and groupings, for both the client and server models.B.5.A.5. 04 to 05o* Now tree diagrams reference ietf-netmod-yang-tree-diagramso* Updated examples to inline key and certificates (no longer a leafref to keystore)B.6.A.6. 05 to 06o* Fixed change log missing section issue.o* Updated examples to match latest updates to the crypto-types, trust-anchors, and keystore drafts.o* Reduced line length of the YANG modules to fit within 69 columns.B.7.A.7. 06 to 07o* Removed "idle-timeout" from "persistent" connection config.o* Added "random-selection" for reconnection-strategy's "starts-with" enum.o* Replaced "connection-type" choice default (persistent) with "mandatory true".o* Reduced the periodic-connection's "idle-timeout" from 5 to 2 minutes.o* Replaced reconnect-timeout with period/anchor-time combo.B.8.A.8. 07 to 08o* Modified examples to be compatible with new crypto-types algsB.9.A.9. 08 to 09o* Corrected use of "mandatory true" for "address" leafs.o* Updated examples to reflect update to groupings defined in the keystore draft.o* Updated to use groupings defined in new TCP and HTTP drafts.o* Updated copyright date, boilerplate template, affiliation, and folding algorithm.B.10.A.10. 09 to 10o* Reformatted YANG modules.B.11.A.11. 10 to 11o* Adjusted for the top-level "demux container" added to groupings imported from other modules.o* Added "must" expressions to ensure that keepalives are not configured for "periodic" connections.o* Updated the boilerplate text in module-level "description" statement to match copyeditor convention.o* Moved "expanded" tree diagrams to the Appendix.B.12.A.12. 11 to 12o* Removed the "Design Considerations" section.o* Removed the 'must' statement limiting keepalives in periodic connections.o* Updated models and examples to reflect removal of the "demux" containers in the imported models.o* Updated the "periodic-connnection" description statements to be more like the RESTCONF draft, especially where it described dropping the underlying TCP connection.o* Updated text to better reference where certain examples come from (e.g., which Section in which draft).o* In the server model, commented out the "must 'pinned-ca-certs or pinned-client-certs'" statement to reflect change made in the TLS draft whereby the trust anchors MAY be defined externally.o* Replaced the 'listen', 'initiate', and 'call-home' features with boolean expressions.B.13.A.13. 12 to 13o* Updated to reflect changes in trust-anchors drafts (e.g., s/trust- anchors/truststore/g + s/pinned.//)B.14.A.14. 13 to 14o* Adjusting from change in TLS client model (removing the top-level 'certificate' container), by swapping refining-in a 'mandatory true' statement with a 'must' statement outside the 'uses' statement.o* Updated examples to reflect ietf-crypto-types change (e.g., identities --> enumerations)B.15.A.15. 14 to 15o* Refactored both the client and server modules similar to how the ietf-restconf-server module was refactored in -13 of that draft, and the ietf-restconf-client grouping.B.16.A.16. 15 to 16o* Added refinement to make "cert-to-name/fingerprint" be mandatory false.o* Commented out refinement to "tls-server-grouping/client- authentication" until a better "must" expression is defined.B.17.A.17. 16 to 17o* Updated examples to include the "*-key-format" nodes.o* Updated examples to remove the "required" nodes.o* Updated examples to remove the "client-auth-defined-elsewhere" nodes.B.18.A.18. 17 to 18o* Updated examples to reflect new "bag" addition to truststore.B.19.A.19. 18 to 19o* Updated examples to remove the 'algorithm' nodes.o* Updated examples to reflect the new TLS keepalives structure.o* Added keepalives to the tcp-client-parameters section in the netconf-server SSH-based call-home example.o* Added a TLS-based call-home example to the netconf-client example.o* Added a "Note to Reviewers" note to first page. A.20. 19 to 20 * Expanded "Data Model Overview section(s) [remove "wall" of tree diagrams]. * Removed expanded tree diagrams that were listed in the Appendix. * Updated the Security Considerations section. Acknowledgements The authors would like to thank for following for lively discussions on list and in the halls (ordered by last name): Andy Bierman, Martin Bjorklund, Benoit Claise, Ramkumar Dhanapal, Mehmet Ersue, Balazs Kovacs, David Lamparter, Ladislav Lhotka, Alan Luchuk, Radek Krejci, Tom Petch, Juergen Schoenwaelder, Phil Shafer, Sean Turner, and Bert Wijnen. Author's Address Kent Watsen Watsen NetworksEMail:Email: kent+ietf@watsen.net