NETCONF Working Group K. Watsen Internet-Draft Watsen Networks Intended status: Standards TrackJuly 2,October 18, 2019 Expires:January 3,April 20, 2020 NETCONF Client and Server Modelsdraft-ietf-netconf-netconf-client-server-14draft-ietf-netconf-netconf-client-server-15 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 many 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. This document contains references to other drafts in progress, both in the Normative References section, as well as in body text throughout. Please update the following references to reflect their final RFC assignments: o I-D.ietf-netconf-keystore o I-D.ietf-netconf-tcp-client-server o I-D.ietf-netconf-ssh-client-server o I-D.ietf-netconf-tls-client-server Artwork in this document contains shorthand references to drafts in progress. Please apply the following replacements: o "XXXX" --> the assigned RFC value for this draft o "AAAA" --> the assigned RFC value for I-D.ietf-netconf-tcp-client- server o "YYYY" --> the assigned RFC value for I-D.ietf-netconf-ssh-client- server o "ZZZZ" --> the assigned RFC value for I-D.ietf-netconf-tls-client- server Artwork in this document contains placeholder values for the date of publication of this draft. Please apply the following replacement: o"2019-07-02""2019-10-18" --> the publication date of this draft The following Appendix section is to be removed prior to publication: o Appendix B. Change Log 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 onJanuary 3,April 20, 2020. Copyright Notice Copyright (c) 2019 IETF Trust and the persons identified as the document authors. All rights reserved. This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 4 3. The NETCONF Client Model . . . . . . . . . . . . . . . . . . 4 3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 4 3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . .56 3.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . .89 4. The NETCONF Server Model . . . . . . . . . . . . . . . . . .1820 4.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . .1820 4.2. Example Usage . . . . . . . . . . . . . . . . . . . . . .2022 4.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . .2528 5. Security Considerations . . . . . . . . . . . . . . . . . . .3640 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . .3741 6.1. The IETF XML Registry . . . . . . . . . . . . . . . . . .3741 6.2. The YANG Module Names Registry . . . . . . . . . . . . .3842 7. References . . . . . . . . . . . . . . . . . . . . . . . . .3842 7.1. Normative References . . . . . . . . . . . . . . . . . .3842 7.2. Informative References . . . . . . . . . . . . . . . . .3943 Appendix A. Expanded Tree Diagrams . . . . . . . . . . . . . . .4145 A.1. Expanded Tree Diagram for 'ietf-netconf-client' . . . . .4145 A.2. Expanded Tree Diagram for 'ietf-netconf-server' . . . . .5260 Appendix B. Change Log . . . . . . . . . . . . . . . . . . . . .6679 B.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . .6679 B.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . .6679 B.3. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . .6679 B.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . .6679 B.5. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . .6680 B.6. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . .6780 B.7. 06 to 07 . . . . . . . . . . . . . . . . . . . . . . . .6780 B.8. 07 to 08 . . . . . . . . . . . . . . . . . . . . . . . .6780 B.9. 08 to 09 . . . . . . . . . . . . . . . . . . . . . . . .6780 B.10. 09 to 10 . . . . . . . . . . . . . . . . . . . . . . . .6781 B.11. 10 to 11 . . . . . . . . . . . . . . . . . . . . . . . .6881 B.12. 11 to 12 . . . . . . . . . . . . . . . . . . . . . . . .6881 B.13. 12 to 13 . . . . . . . . . . . . . . . . . . . . . . . .6882 B.14. 13 to 14 . . . . . . . . . . . . . . . . . . . . . . . .6882 B.15. 14 to 15 . . . . . . . . . . . . . . . . . . . . . . . . 82 Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . .6982 Author's Address . . . . . . . . . . . . . . . . . . . . . . . .6982 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 this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here. 3. The NETCONF Client Model The NETCONF client model presented in this section supports both clients initiating connections to servers, 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 enable implementations to advertise which potentially uncommon parts of the model the NETCONF client supports. 3.1. Tree Diagram The following tree diagram [RFC8340] provides an overview of the data model for the "ietf-netconf-client" module. This tree diagram only shows the nodes defined in this module; it does show the nodes defined by "grouping" statements used by this module. Please see Appendix A.1 for a tree diagram that illustrates what the module looks like with all the "grouping" statements expanded. module: ietf-netconf-client +--rw netconf-client +---unetconf-client-groupingnetconf-client-app-grouping grouping netconf-client-grouping grouping netconf-client-initiate-stack-grouping +--initiate! {ssh-initiate or tls-initiate}?(transport) +--:(ssh) {ssh-initiate}? | +--netconf-server* [name]ssh | +--name? stringtcp-client-parameters |+-- endpoints| +---u tcpc:tcp-client-grouping | +--endpoint* [name]ssh-client-parameters | | +---u sshc:ssh-client-grouping | +--name? stringnetconf-client-parameters +--:(tls) {tls-initiate}? +-- tls +-- tcp-client-parameters | +---u tcpc:tcp-client-grouping +-- tls-client-parameters | +---u tlsc:tls-client-grouping +-- netconf-client-parameters grouping netconf-client-listen-stack-grouping +-- (transport)| |+--:(ssh){ssh-initiate}? | |{ssh-listen}? | +-- ssh || |+--tcp-client-parameters | |tcp-server-parameters | | +---utcpc:tcp-client-grouping | |tcps:tcp-server-grouping | +-- ssh-client-parameters | ||+---u sshc:ssh-client-grouping ||+-- netconf-client-parameters +--:(tls){tls-initiate}?{tls-listen}? +-- tls +-- tcp-server-parameters | +---u tcps:tcp-server-grouping +-- tls-client-parameters | +---u tlsc:tls-client-grouping +--tlsnetconf-client-parameters grouping netconf-client-app-grouping +-- initiate! {ssh-initiate or tls-initiate}? | +-- netconf-server* [name] | +--tcp-client-parametersname? string | +-- endpoints | |+---u tcpc:tcp-client-grouping+-- endpoint* [name] | | +--tls-client-parametersname? string | | +---utlsc:tls-client-groupingnetconf-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+-- (transport) +--:(ssh) {ssh-listen}? | +-- ssh | +-- tcp-server-parameters | | +---u tcps:tcp-server-grouping | +-- ssh-client-parameters | +---u sshc:ssh-client-grouping +--:(tls) {tls-listen}? +-- tls +-- tcp-server-parameters | +---u tcps:tcp-server-grouping +-- tls-client-parameters+---utlsc:tls-client-groupingnetconf-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 and TLS transport protocols. This example is consistent with the examples presented in Section 2 of [I-D.ietf-netconf-trust-anchors] and Section 3.2 of [I-D.ietf-netconf-keystore].===================== NOTE: '\' line wrapping per BCPXXXXX (RFC XXXX) =========== <netconf-client xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-client"> <!-- NETCONF servers to initiate connections 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> <algorithm>rsa2048</algorithm> <private-key>base64encodedvalue==</private-key> <public-key>base64encodedvalue==</public-key> </local-definition> </public-key> </client-identity> <server-authentication><ca-certs>explicitly-trusted-server-ca-certs</ca-cer\ ts> <server-certs>explicitly-trusted-server-certs</serve\ r-certs><ca-certs> <truststore-reference>explicitly-trusted-server-ca\ -certs</truststore-reference> </ca-certs> <server-certs> <truststore-reference>explicitly-trusted-server-ce\ rts</truststore-reference> </server-certs> </server-authentication> <keepalives> <max-wait>30</max-wait> <max-attempts>3</max-attempts> </keepalives> </ssh-client-parameters> <netconf-client-parameters> <!-- nothing to configure --> </netconf-client-parameters> </ssh> </endpoint> <endpoint> <name>corp-fw2.example.com</name><ssh><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><ssh-client-parameters><tls-client-parameters> <client-identity><username>foobar</username> <public-key><local-definition> <algorithm>rsa2048</algorithm> <private-key>base64encodedvalue==</private-key> <public-key>base64encodedvalue==</public-key> <cert>base64encodedvalue==</cert> </local-definition></public-key></client-identity> <server-authentication><ca-certs>explicitly-trusted-server-ca-certs</ca-cer\ ts> <server-certs>explicitly-trusted-server-certs</serve\ r-certs><ca-certs> <truststore-reference>explicitly-trusted-server-ca\ -certs</truststore-reference> </ca-certs> <server-certs> <truststore-reference>explicitly-trusted-server-ce\ rts</truststore-reference> </server-certs> </server-authentication> <keepalives> <max-wait>30</max-wait> <max-attempts>3</max-attempts> </keepalives></ssh-client-parameters> </ssh></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 listen for NETCONF Call Home connections on --> <listen> <endpoint> <name>Intranet-facing 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> <algorithm>rsa2048</algorithm> <private-key>base64encodedvalue==</private-key> <public-key>base64encodedvalue==</public-key> </local-definition> </public-key> </client-identity> <server-authentication><ca-certs>explicitly-trusted-server-ca-certs</ca-certs> <server-certs>explicitly-trusted-server-certs</server-ce\ rts> <ssh-host-keys>explicitly-trusted-ssh-host-keys</ssh-hos\ t-keys><ca-certs> <truststore-reference>explicitly-trusted-server-ca-cer\ ts</truststore-reference> </ca-certs> <server-certs> <truststore-reference>explicitly-trusted-server-certs<\ /truststore-reference> </server-certs> <ssh-host-keys> <truststore-reference>explicitly-trusted-ssh-host-keys\ </truststore-reference> </ssh-host-keys> </server-authentication> </ssh-client-parameters> <netconf-client-parameters> <!-- nothing to configure --> </netconf-client-parameters> </ssh> </endpoint> </listen> </netconf-client> 3.3. YANG Module This YANG module has normative references 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@2019-07-02.yang""ietf-netconf-client@2019-10-18.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 AAAA: YANG Groupings for TCP Clients and TCP Servers"; } import ietf-tcp-server { prefix tcps; reference "RFC AAAA: YANG Groupings for TCP Clients and TCP Servers"; } import ietf-ssh-client { prefix sshc; revision-date2019-07-02;2019-10-18; // stable grouping definitions reference "RFC BBBB: YANG Groupings for SSH Clients and SSH Servers"; } import ietf-tls-client { prefix tlsc; revision-date2019-07-02;2019-10-18; // stable grouping definitions reference "RFC CCCC: 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>"; description "This module contains a collection of YANG definitions for configuring NETCONF clients. Copyright (c) 2019 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself for full legal notices.; The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document are to be interpreted as described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, they appear in all capitals, as shown here."; revision2019-07-022019-10-18 { description "Initial version"; reference "RFC XXXX: NETCONF Client and Server Models"; } // Features feature ssh-initiate { description "The 'ssh-initiate' feature indicates that the NETCONF client supports initiating SSH connections to NETCONF servers."; reference "RFC 6242: Using the NETCONF Protocol over Secure Shell (SSH)"; } feature tls-initiate { description "The 'tls-initiate' feature indicates that the NETCONF client supports initiating TLS connections to NETCONF servers."; reference "RFC 7589: Using the NETCONF Protocol over Transport Layer Security (TLS) with Mutual X.509 Authentication"; } feature ssh-listen { description "The 'ssh-listen' feature indicates that the NETCONF client supports opening a port 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 the NETCONF client supports opening a port to listen for incoming NETCONF server call-home TLS connections."; reference "RFC 8071: NETCONF Call Home and RESTCONF Call Home"; } // Groupings grouping netconf-client-grouping { description"Top-level"A reusable grouping for configuring a NETCONF clientconfiguration."; container initiate { if-feature "ssh-initiate or tls-initiate"; presence "Enables client to initiate TCP connections"; description "Configures client initiatingwithout any consideration for how underlyingTCP connections."; list netconf-servertransport sessions are established. This grouping currently doesn't define any nodes."; } grouping netconf-client-initiate-stack-grouping {key "name"; min-elements 1;description"List of NETCONF servers the"A reusable grouping for configuring a NETCONF clientis to initiate connections to in parallel."; leaf name { type string; description "An arbitrary name for the NETCONF server."; } container endpoints { description "Container for the list of endpoints."; list endpoint { key "name"; min-elements 1; ordered-by user; description "A user-ordered list of endpoints that the NETCONF client will attempt to connect to in the specified sequence. Defining more than one enables high-availability."; leaf name { type string; description "An arbitrary name'initiate' protocol stack forthe endpoint."; }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 for the connection."; 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 "830"; description "The NETCONF client will attempt to connect to the IANA-assigned well-known port value for 'netconf-ssh' (443) if no value is specified."; } } } container ssh-client-parameters { description "A wrapper around the SSH client parameters to avoid name collisions."; uses sshc:ssh-client-grouping; } container netconf-client-parameters { description "A wrapper around the NETCONF client parameters to avoid name collisions."; uses ncc:netconf-client-grouping; } } } case tls { if-feature "tls-initiate"; container tls { description "Specifies IP and TLS specific configuration for the connection."; 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 "6513"; description "The NETCONF client will attempt to connect to the 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 to avoid name collisions."; uses tlsc:tls-client-grouping; } container netconf-client-parameters { description "A wrapper around the NETCONF client parameters to avoid name collisions."; uses ncc:netconf-client-grouping; } } }// choice transport}// list endpoint} //container endpoints container connection-typenetconf-client-initiate-stack-grouping grouping netconf-client-listen-stack-grouping { description"Indicates the NETCONF client's preference"A reusable grouping forhow theconfiguring a NETCONFconnection is maintained.";client 'listen' protocol stack for a single connection."; choiceconnection-typetransport { mandatory true; description "Selects between availableconnection types.";transports."; casepersistent-connectionssh { if-feature "ssh-listen"; containerpersistentssh {presence "Indicates that a persistent connection is to be maintained.";description"Maintain a persistent connection to the NETCONF server. If the connection goes down, immediately start trying to reconnect to the NETCONF server, using"SSH-specific listening configuration for inbound connections."; container tcp-server-parameters { description "A wrapper around thereconnection strategy. This connection type minimizes any NETCONFTCP server parameters to avoid name collisions."; uses tcps:tcp-server-grouping { refine "local-port" { default "4334"; description "The NETCONF clientdata-transfer delay, albeit atwill listen on theexpense of holding resources longer.";IANA- assigned well-known port for 'netconf-ch-ssh' (4334) if no value is specified."; } } }case periodic-connection {containerperiodicssh-client-parameters {presence "Indicates that a periodic connection is to be maintained.";description"Periodically connect to"A wrapper around theNETCONF server. This connection type increases resource utilization, albeit with increased delay in NETCONF server to NETCONFSSH clientinteractions. Theparameters to avoid name collisions."; uses sshc:ssh-client-grouping; } container netconf-client-parameters { description "A wrapper around the NETCONF clientshould close the underlying TCP connection upon completing planned activities. In theparameters to avoid name collisions."; uses ncc:netconf-client-grouping; } } } casethattls { if-feature "tls-listen"; container tls { description "TLS-specific listening configuration for inbound connections."; container tcp-server-parameters { description "A wrapper around theprevious connection is still active, establishing a new connection is NOT RECOMMENDED."; leaf periodTCP server parameters to avoid name collisions."; uses tcps:tcp-server-grouping { refine "local-port" {type uint16; units "minutes";default"60";"4334"; description"Duration of time between periodic connections.";"The NETCONF client will listen on the IANA- assigned well-known port for 'netconf-ch-ssh' (4334) if no value is specified."; }leaf anchor-time} } container tls-client-parameters {type yang:date-and-timemust "client-identity" {// constrained to minute-level granularity pattern '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}' + '(Z|[\+\-]\d{2}:\d{2})';description "NETCONF/TLS clients MUST pass some authentication credentials."; } 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"A wrapper around theanchor 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.";TLS client parameters to avoid name collisions."; uses tlsc:tls-client-grouping; }leaf idle-timeoutcontainer netconf-client-parameters {type uint16; units "seconds"; default 120; // two minutesdescription"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 then this number of seconds. If set to zero, then"A wrapper around the NETCONF clientwill never drop a session because it is idle.";parameters to avoid name collisions."; uses ncc:netconf-client-grouping; } } } } }container reconnect-strategy// netconf-client-listen-stack-grouping grouping netconf-client-app-grouping { description"The reconnection strategy directs how"A reusable grouping for configuring a NETCONF clientreconnects toapplication that supports both 'initiate' and 'listen' protocol stacks for aNETCONF server, after discovering its connectionmultiplicity 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 theserver has dropped, even if due to a reboot. TheNETCONF clientstarts with the specified endpoint and tries to connectis toit max-attempts times before trying the next endpoint in the list (round robin).";maintain simultaneous connections with."; leafstart-withname { typeenumeration { enum first-listed {string; description"Indicates that reconnections should start with"An arbitrary name for thefirst endpoint listed.";NETCONF server."; }enum last-connectedcontainer endpoints { 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 clients SHOULD be able to remember"Container for thelastlist of endpoints."; list endpointconnected to across reboots."; } enum random-selection{ key "name"; min-elements 1; ordered-by user; description"Indicates that reconnections should start with a random endpoint."; } } default "first-listed"; description "Specifies which"A user-ordered list ofthe NETCONF server'sendpoints that the NETCONF clientshould start with when tryingwill attempt to connect to in theNETCONF server."; } leaf max-attempts { type uint8specified sequence. Defining more than one enables high-availability."; leaf name {range "1..max"; } default "3";type string; description"Specifies the number times the NETCONF client tries to connect to a specific endpoint before moving on to the next endpoint in"An arbitrary name for thelist (round robin)."; }endpoint."; } uses netconf-client-initiate-stack-grouping; } //netconf-serverlist endpoint } //initiatecontainerlisten { if-feature "ssh-listen or tls-listen"; presence "Enables client to accept call-home connections"; description "Configures client accepting call-home TCP connections."; leaf idle-timeoutendpoints container connection-type {type uint16; units "seconds"; default "3600"; // one hourdescription"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"Indicates theserver 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 forNETCONFconnections."; leaf name { type string; description "An arbitrary nameclient's preference for how the NETCONFlisten endpoint."; }connection is maintained."; choicetransportconnection-type { mandatory true; description "Selects between availabletransports.";connection types."; casessh { if-feature "ssh-listen"; container sshpersistent-connection {description "SSH-specific listening configuration for inbound connections.";containertcp-server-parameterspersistent { presence "Indicates that a persistent connection is to be maintained."; description"A wrapper around"Maintain a persistent connection to theTCP server parametersNETCONF server. If the connection goes down, immediately start trying toavoid name collisions."; uses tcps:tcp-server-grouping { refine "local-port" { default "4334"; description "Thereconnect to the NETCONFclient will listen onserver, using theIANA- assigned well-known port for 'netconf-ch-ssh' (4334) if no value is specified."; } } } container ssh-client-parameters { description "A wrapper around the SSH client parametersreconnection strategy. This connection type minimizes any NETCONF server toavoid name collisions."; uses sshc:ssh-client-grouping; }NETCONF client data-transfer delay, albeit at the expense of holding resources longer."; } } casetls { if-feature "tls-listen"; container tlsperiodic-connection {description "TLS-specific listening configuration for inbound connections.";containertcp-server-parametersperiodic { presence "Indicates that a periodic connection is to be maintained."; description"A wrapper around"Periodically connect to theTCPNETCONF server. This connection type increases resource utilization, albeit with increased delay in NETCONF serverparameterstoavoid name collisions."; uses tcps:tcp-server-grouping { refine "local-port" { default "4334"; description "TheNETCONF clientwill listen oninteractions. The NETCONF client should close theIANA- assigned well-known port for 'netconf-ch-ssh' (4334) if no valueunderlying TCP connection upon completing planned activities. In the case that the previous connection isspecified."; } } } container tls-client-parameters { must "client-identity"still active, establishing a new connection is NOT RECOMMENDED."; leaf period { type uint16; units "minutes"; default "60"; description"NETCONF/TLS clients MUST pass some authentication credentials."; } description "A wrapper around the TLS client parameters to avoid name collisions."; uses tlsc:tls-client-grouping; } } } } // transport } // endpoint"Duration of time between periodic connections."; } leaf anchor-time { type yang:date-and-time { //listenconstrained to minute-level granularity pattern '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}' + '(Z|[\+\-]\d{2}:\d{2})'; }// netconf-client // Protocol accessible node, for servers that implement this // module. container netconf-client { uses netconf-client-grouping;description"Top-level container for NETCONF client configuration."; } } <CODE ENDS> 4. The NETCONF Server Model The NETCONF server model presented in this section supports both listening for"Designates a timestamp before or after which a series of periodic connectionsas well as initiating call-home connections, using eitherare determined. The periodic connections occur at a whole multiple interval from theSSHanchor time. For example, for an anchor time is 15 minutes past midnight andTLS transport protocols. YANG feature statements are used to enable implementations to advertise which potentially uncommon partsa 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 themodel themaximum number of seconds that a NETCONFserver supports. 4.1. Tree Diagram The following tree diagram [RFC8340] providessession may remain idle. A NETCONF session will be dropped if it is idle for anoverviewinterval longer then this number of seconds. If set to zero, then thedata model for the "ietf-netconf-server" module. This tree diagram only shows the nodes defined in this module;NETCONF client will never drop a session because itdoes show the nodes defined by "grouping" statements used by this module. Please see Appendix A.2 foris idle."; } } } } } container reconnect-strategy { description "The reconnection strategy directs how atree diagram that illustrates whatNETCONF client reconnects to a NETCONF server, after discovering its connection to themodule looks likeserver has dropped, even if due to a reboot. The NETCONF client starts withallthe"grouping" statements expanded. module: ietf-netconf-server +--rw netconf-server +---u netconf-server-grouping grouping netconf-server-grouping +-- listen! {ssh-listen or tls-listen}? | +-- idle-timeout? uint16 | +-- endpoint* [name] | +-- name? string | +-- (transport) | +--:(ssh) {ssh-listen}? | | +-- ssh | | +-- tcp-server-parameters | | | +---u tcps:tcp-server-grouping | | +-- ssh-server-parameters | | +---u sshs:ssh-server-grouping | +--:(tls) {tls-listen}? | +-- tls | +-- tcp-server-parameters | | +---u tcps:tcp-server-grouping | +-- tls-server-parameters | +---u tlss:tls-server-grouping +-- call-home! {ssh-call-home or tls-call-home}? +-- netconf-client* [name] +-- name? string +-- endpoints | +-- endpoint* [name] | +-- name? string | +-- (transport) | +--:(ssh) {ssh-call-home}? | | +-- ssh | | +-- tcp-client-parameters | | | +---u tcpc:tcp-client-grouping | | +-- ssh-server-parameters | | +---u sshs:ssh-server-grouping | +--:(tls) {tls-call-home}? | +-- tls | +-- tcp-client-parameters | | +---u tcpc:tcp-client-grouping | +-- tls-server-parameters | +---u tlss:tls-server-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 a NETCONF server to listen for NETCONF client connections using both the SSHspecified endpoint andTLS transport protocols, as well as configuring call-hometries totwo NETCONF clients, one using SSH andconnect to it max-attempts times before trying theother using TLS. This example is consistentnext endpoint in the list (round robin)."; leaf start-with { type enumeration { enum first-listed { description "Indicates that reconnections should start with theexamples presented in Section 2 of [I-D.ietf-netconf-trust-anchors] and Section 3.2 of [I-D.ietf-netconf-keystore]. =========== NOTE: '\' line wrapping per BCP XX (RFC XXXX) =========== <netconf-server xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-server" xmlns:x509c2n="urn:ietf:params:xml:ns:yang:ietf-x509-cert-to-name"> <!--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 clients 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 server's endpoints the NETCONF client should start with when trying tolisten forconnect to the NETCONFconnectionsserver."; } leaf max-attempts { type uint8 { range "1..max"; } default "3"; description "Specifies the number times the NETCONF client tries to connect to a specific endpoint before moving 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> <algorithm>rsa2048</algorithm> <private-key>base64encodedvalue==</private-key> <public-key>base64encodedvalue==</public-key> </local-definition> </public-key> </host-key> </server-identity> <client-authentication> <supported-authentication-methods> <publickey/> </supported-authentication-methods> <client-auth-defined-elsewhere/> </client-authentication> </ssh-server-parameters> </ssh> </endpoint> <endpoint> <!-- listening for TLS 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> <local-definition> <algorithm>rsa2048</algorithm> <private-key>base64encodedvalue==</private-key> <public-key>base64encodedvalue==</public-key> <cert>base64encodedvalue==</cert> </local-definition> </server-identity> <client-authentication> <required/> <ca-certs>explicitly-trusted-client-ca-certs</ca-certs> <client-certs>explicitly-trusted-client-certs</client-ce\ rts> <cert-maps> <cert-to-name> <id>1</id> <fingerprint>11:0A:05:11:00</fingerprint> <map-type>x509c2n:san-any</map-type> </cert-to-name> <cert-to-name> <id>2</id> <fingerprint>B3:4F:A1:8C:54</fingerprint> <map-type>x509c2n:specified</map-type> <name>scooby-doo</name> </cert-to-name> </cert-maps> </client-authentication> </tls-server-parameters> </tls> </endpoint> </listen> <!-- calling hometoSSH and TLS based NETCONF clients --> <call-home> <netconf-client> <!-- SSH-basedthe next endpoint in the list (round robin)."; } } } // netconf-server } // initiate container listen { if-feature "ssh-listen or tls-listen"; presence "Enables 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> </tcp-client-parameters> <ssh-server-parameters> <server-identity> <host-key> <name>deployment-specific-certificate</name> <public-key> <local-definition> <algorithm>rsa2048</algorithm> <private-key>base64encodedvalue==</private-key> <public-key>base64encodedvalue==</public-key> </local-definition> </public-key> </host-key> </server-identity> <client-authentication> <supported-authentication-methods> <publickey/> </supported-authentication-methods> <client-auth-defined-elsewhere/> </client-authentication> </ssh-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> <algorithm>rsa2048</algorithm> <private-key>base64encodedvalue==</private-key> <public-key>base64encodedvalue==</public-key> </local-definition> </public-key> </host-key> </server-identity> <client-authentication> <supported-authentication-methods> <publickey/> </supported-authentication-methods> <client-auth-defined-elsewhere/> </client-authentication> </ssh-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> <local-definition> <algorithm>rsa2048</algorithm> <private-key>base64encodedvalue==</private-key> <public-key>base64encodedvalue==</public-key> <cert>base64encodedvalue==</cert> </local-definition> </server-identity> <client-authentication> <required/> <ca-certs>explicitly-trusted-client-ca-certs</ca-cer\ ts> <client-certs>explicitly-trusted-client-certs</clien\ t-certs> <cert-maps> <cert-to-name> <id>1</id> <fingerprint>11:0A:05:11:00</fingerprint> <map-type>x509c2n:san-any</map-type> </cert-to-name> <cert-to-name> <id>2</id> <fingerprint>B3:4F:A1:8C:54</fingerprint> <map-type>x509c2n:specified</map-type> <name>scooby-doo</name> </cert-to-name> </cert-maps> </client-authentication> <keepalives> <max-wait>30</max-wait> <max-attempts>3</max-attempts> </keepalives> </tls-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> <local-definition> <algorithm>rsa2048</algorithm> <private-key>base64encodedvalue==</private-key> <public-key>base64encodedvalue==</public-key> <cert>base64encodedvalue==</cert> </local-definition> </server-identity> <client-authentication> <required/> <ca-certs>explicitly-trusted-client-ca-certs</ca-cer\ ts> <client-certs>explicitly-trusted-client-certs</clien\ t-certs> <cert-maps> <cert-to-name> <id>1</id> <fingerprint>11:0A:05:11:00</fingerprint> <map-type>x509c2n:san-any</map-type> </cert-to-name> <cert-to-name> <id>2</id> <fingerprint>B3:4F:A1:8C:54</fingerprint> <map-type>x509c2n:specified</map-type> <name>scooby-doo</name> </cert-to-name> </cert-maps> </client-authentication> <keepalives> <max-wait>30</max-wait> <max-attempts>3</max-attempts> </keepalives> </tls-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 referencesto[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@2019-07-02.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 AAAA: YANG Groupings for TCP Clients andaccept call-home connections"; description "Configures client accepting call-home TCPServers"; } import ietf-tcp-serverconnections."; leaf idle-timeout {prefix tcps; reference "RFC AAAA: YANG Groupingstype 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 forTCP Clients and TCP Servers";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."; }import ietf-ssh-serverlist endpoint {prefix sshs; revision-date 2019-07-02; // stable grouping definitions reference "RFC BBBB: YANG Groupingskey "name"; min-elements 1; description "List of endpoints to listen forSSH Clients and SSH Servers"; } import ietf-tls-serverNETCONF connections."; leaf name {prefix tlss; revision-date 2019-07-02; // stable grouping definitions reference "RFC CCCC: YANG Groupingstype string; description "An arbitrary name forTLS Clients and TLS Servers"; } organization "IETFthe 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>";listen endpoint."; } uses netconf-client-listen-stack-grouping; } // endpoint } // listen } // netconf-client-app-grouping // Protocol accessible node, for servers that implement this // module. container netconf-client { uses netconf-client-app-grouping; description"This module contains a collection of YANG definitions"Top-level container forconfiguringNETCONFservers. Copyright (c) 2019 IETF Trust and the persons identifiedclient configuration."; } } <CODE ENDS> 4. The NETCONF Server Model The NETCONF server model presented in this section supports both listening for connections asauthors ofwell as initiating call-home connections, using either thecode. All rights reserved. Redistribution and use in sourceSSH andbinary forms, with or without modification, is permitted pursuant to, and subjectTLS transport protocols. YANG feature statements are used to enable implementations to advertise which potentially uncommon parts of thelicense terms contained in,model theSimplified BSD License set forth in Section 4.cNETCONF server supports. 4.1. Tree Diagram The following tree diagram [RFC8340] provides an overview of theIETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info).data model for the "ietf-netconf-server" module. Thisversion of this YANG module is part of RFC XXXX (https://www.rfc-editor.org/info/rfcXXXX); seetree diagram only shows theRFC itself for full legal notices.; The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL'nodes defined in thisdocument 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 2019-07-02 { description "Initial version"; reference "RFC XXXX: NETCONF Client and Server Models"; } // Features feature ssh-listen { description "The 'ssh-listen' feature indicates thatmodule; it does show theNETCONF server supports openingnodes defined by "grouping" statements used by this module. Please see Appendix A.2 for aport to accept NETCONF over SSH client connections."; reference "RFC 6242: Using the NETCONF Protocol over Secure Shell (SSH)"; } feature tls-listen { description "The 'tls-listen' feature indicatestree diagram that illustrates what theNETCONF server supports opening a port to accept NETCONF over TLS client connections."; reference "RFC 7589: Using the NETCONF Protocol over Transport Layer Security (TLS)module looks like withMutual X.509 Authentication"; } feature ssh-call-home { description "The 'ssh-call-home' feature indicates thatall theNETCONF server supports initiating"grouping" statements expanded. module: ietf-netconf-server +--rw netconf-server +---u netconf-server-app-grouping grouping netconf-server-grouping +-- client-identification +-- cert-maps +---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 a NETCONFover SSH call home connectionserver to listen for NETCONFclients."; reference "RFC 8071: NETCONF Call Home and RESTCONF Call Home"; } feature tls-call-home { description "The 'tls-call-home' feature indicates thatclient connections using both theNETCONF server supports initiating a NETCONF overSSH and TLScall home connectiontransport protocols, as well as configuring call-home to two NETCONFclients."; reference "RFC 8071: NETCONF Call Homeclients, one using SSH andRESTCONF Call Home"; } // Groupings grouping netconf-server-grouping { description "Top-level grouping for NETCONF server configuration."; 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 "Specifiesthemaximum number of seconds that a NETCONF session may remain idle. A NETCONF session will be dropped if itother using TLS. This example isidle for an interval longer than this number of seconds. If set to zero, thenconsistent with theserver 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 "Listexamples presented in Section 2 of [I-D.ietf-netconf-trust-anchors] and Section 3.2 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:x509c2n="urn:ietf:params:xml:ns:yang:ietf-x509-cert-to-name"> <!-- endpoints to listen for NETCONFconnections."; leaf name { type string; description "An arbitrary name for the NETCONF listen endpoint."; } 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 listenconnections onthe IANA-assigned well-known port value--> <listen> <endpoint> <!-- listening for'netconf-ssh' (830) if no value is specified."; } } } container ssh-server-parameters { description "A wrapper around theSSHserver parameters to avoid name collisions."; uses sshs:ssh-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 parametersconnections --> <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> <algorithm>rsa2048</algorithm> <private-key>base64encodedvalue==</private-key> <public-key>base64encodedvalue==</public-key> </local-definition> </public-key> </host-key> </server-identity> <client-authentication> <supported-authentication-methods> <publickey/> </supported-authentication-methods> <client-auth-defined-elsewhere/> </client-authentication> </ssh-server-parameters> <netconf-server-parameters> <!-- nothing toavoid 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 valueconfigure --> </netconf-server-parameters> </ssh> </endpoint> <endpoint> <!-- listening for'netconf-tls' (6513) if no value is specified."; } } } container tls-server-parameters { description "A wrapper around theTLSserver parameterssessions --> <name>netconf/tls</name> <tls> <tcp-server-parameters> <local-address>192.0.2.7</local-address> </tcp-server-parameters> <tls-server-parameters> <server-identity> <local-definition> <algorithm>rsa2048</algorithm> <private-key>base64encodedvalue==</private-key> <public-key>base64encodedvalue==</public-key> <cert>base64encodedvalue==</cert> </local-definition> </server-identity> <client-authentication> <required/> <ca-certs> <truststore-reference>explicitly-trusted-client-ca-cer\ ts</truststore-reference> </ca-certs> <client-certs> <truststore-reference>explicitly-trusted-client-certs<\ /truststore-reference> </client-certs> </client-authentication> </tls-server-parameters> <netconf-server-parameters> <client-identification> <cert-maps> <cert-to-name> <id>1</id> <fingerprint>11:0A:05:11:00</fingerprint> <map-type>x509c2n:san-any</map-type> </cert-to-name> <cert-to-name> <id>2</id> <fingerprint>B3:4F:A1:8C:54</fingerprint> <map-type>x509c2n:specified</map-type> <name>scooby-doo</name> </cert-to-name> </cert-maps> </client-identification> </netconf-server-parameters> </tls> </endpoint> </listen> <!-- calling home toavoid name collisions."; uses tlss:tls-server-grouping { refine "client-authentication" { //must 'ca-certs or client-certs'; description "NETCONF/TLS servers MUST validate client certificates."; } augment "client-authentication" { description "Augments in the cert-to-name structure."; container cert-maps { uses x509c2n:cert-to-name; description "The cert-maps container is used by a TLS-SSH and TLS based NETCONFserver to map the NETCONF client's presented X.509 certificateclients --> <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> </tcp-client-parameters> <ssh-server-parameters> <server-identity> <host-key> <name>deployment-specific-certificate</name> <public-key> <local-definition> <algorithm>rsa2048</algorithm> <private-key>base64encodedvalue==</private-key> <public-key>base64encodedvalue==</public-key> </local-definition> </public-key> </host-key> </server-identity> <client-authentication> <supported-authentication-methods> <publickey/> </supported-authentication-methods> <client-auth-defined-elsewhere/> </client-authentication> </ssh-server-parameters> <netconf-server-parameters> <!-- nothing toa NETCONF username. If no matching and valid cert-to-name list entry can be found, then the NETCONF server MUST close the connection,configure --> </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> <algorithm>rsa2048</algorithm> <private-key>base64encodedvalue==</private-key> <public-key>base64encodedvalue==</public-key> </local-definition> </public-key> </host-key> </server-identity> <client-authentication> <supported-authentication-methods> <publickey/> </supported-authentication-methods> <client-auth-defined-elsewhere/> </client-authentication> </ssh-server-parameters> <netconf-server-parameters> <!-- nothing to configure --> </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> <local-definition> <algorithm>rsa2048</algorithm> <private-key>base64encodedvalue==</private-key> <public-key>base64encodedvalue==</public-key> <cert>base64encodedvalue==</cert> </local-definition> </server-identity> <client-authentication> <required/> <ca-certs> <truststore-reference>explicitly-trusted-client-ca\ -certs</truststore-reference> </ca-certs> <client-certs> <truststore-reference>explicitly-trusted-client-ce\ rts</truststore-reference> </client-certs> </client-authentication> <keepalives> <max-wait>30</max-wait> <max-attempts>3</max-attempts> </keepalives> </tls-server-parameters> <netconf-server-parameters> <client-identification> <cert-maps> <cert-to-name> <id>1</id> <fingerprint>11:0A:05:11:00</fingerprint> <map-type>x509c2n:san-any</map-type> </cert-to-name> <cert-to-name> <id>2</id> <fingerprint>B3:4F:A1:8C:54</fingerprint> <map-type>x509c2n:specified</map-type> <name>scooby-doo</name> </cert-to-name> </cert-maps> </client-identification> </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> <local-definition> <algorithm>rsa2048</algorithm> <private-key>base64encodedvalue==</private-key> <public-key>base64encodedvalue==</public-key> <cert>base64encodedvalue==</cert> </local-definition> </server-identity> <client-authentication> <required/> <ca-certs> <truststore-reference>explicitly-trusted-client-ca\ -certs</truststore-reference> </ca-certs> <client-certs> <truststore-reference>explicitly-trusted-client-ce\ rts</truststore-reference> </client-certs> </client-authentication> <keepalives> <max-wait>30</max-wait> <max-attempts>3</max-attempts> </keepalives> </tls-server-parameters> <netconf-server-parameters> <client-identification> <cert-maps> <cert-to-name> <id>1</id> <fingerprint>11:0A:05:11:00</fingerprint> <map-type>x509c2n:san-any</map-type> </cert-to-name> <cert-to-name> <id>2</id> <fingerprint>B3:4F:A1:8C:54</fingerprint> <map-type>x509c2n:specified</map-type> <name>scooby-doo</name> </cert-to-name> </cert-maps> </client-identification> </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], andMUST NOT accept NETCONF messages over it.";[I-D.ietf-netconf-tls-client-server]. <CODE BEGINS> file "ietf-netconf-server@2019-10-18.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 "RFCWWWW: NETCONF over TLS, Section 7"; } } } } } }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 AAAA: YANG Groupings for TCP Clients and TCP Servers"; }container call-homeimport ietf-tcp-server {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-clientprefix tcps; reference "RFC AAAA: YANG Groupings for TCP Clients and TCP Servers"; } import ietf-ssh-server {key "name"; min-elements 1;prefix sshs; revision-date 2019-10-18; // stable grouping definitions reference "RFC BBBB: YANG Groupings for SSH Clients and SSH Servers"; } import ietf-tls-server { prefix tlss; revision-date 2019-10-18; // stable grouping definitions reference "RFC CCCC: 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"List"This module contains a collection of YANG definitions for configuring NETCONFclientsservers. Copyright (c) 2019 IETF Trust and theNETCONF serverpersons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject toinitiate call-home connections to in parallel."; leaf name { type string; description "An arbitrary name fortheremote NETCONF client."; } container endpoints { description "Container forlicense terms contained in, thelistSimplified BSD License set forth in Section 4.c ofendpoints."; list endpoint { key "name"; min-elements 1; ordered-by user; description "A non-empty user-ordered listthe IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info). This version ofendpointsthis YANG module is part of RFC XXXX (https://www.rfc-editor.org/info/rfcXXXX); 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 thisNETCONF server to try to connectdocument are to be interpreted as described insequence. 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 2019-10-18 {type string;description"An arbitrary name for this endpoint.";"Initial version"; reference "RFC XXXX: NETCONF Client and Server Models"; }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// Features feature ssh-listen { description"A wrapper around"The 'ssh-listen' feature indicates that theTCP client parametersNETCONF server supports opening a port toavoid name collisions."; uses tcpc:tcp-client-grouping { refine "remote-port"accept NETCONF over SSH client connections."; reference "RFC 6242: Using the NETCONF Protocol over Secure Shell (SSH)"; } feature tls-listen {default "4334";description "The 'tls-listen' feature indicates that the NETCONF serverwill attempt to connectsupports opening a port to accept NETCONF over TLS client connections."; reference "RFC 7589: Using theIANA-assigned well-known port for 'netconf-ch-tls' (4334) if no value is specified."; } }NETCONF Protocol over Transport Layer Security (TLS) with Mutual X.509 Authentication"; }container ssh-server-parametersfeature ssh-call-home { description"A wrapper around"The 'ssh-call-home' feature indicates that theSSHNETCONF serverparameterssupports initiating a NETCONF over SSH call home connection toavoid name collisions."; uses sshs:ssh-server-grouping; } }NETCONF clients."; reference "RFC 8071: NETCONF Call Home and RESTCONF Call Home"; }case tls { if-feature "tls-call-home"; container tls { description "Specifies TLS-specific call-home transport configuration."; container tcp-client-parametersfeature tls-call-home { description"A wrapper around"The 'tls-call-home' feature indicates that theTCP client parameters to avoid name collisions."; uses tcpc:tcp-client-grouping { refine "remote-port" { default "4335"; description "TheNETCONF serverwill attempt to connectsupports initiating a NETCONF over TLS call home connection tothe IANA-assigned well-known port for 'netconf-ch-tls' (4335) if no value is specified."; } }NETCONF clients."; reference "RFC 8071: NETCONF Call Home and RESTCONF Call Home"; }container tls-server-parameters// Groupings grouping netconf-server-grouping { description "Awrapper around the TLSreusable grouping for configuring a NETCONF serverparameters to avoid name collisions.";without any consideration for how underlying transport sessions are established. Note that this grouping usestlss:tls-server-grouping { refine "client-authentication"a fairly typical descendent node name such that a stack of 'uses' statements will have name conflicts. It is intended that the consuming data model will resolve the issue by wrapping the '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-identification {/* commented out since auth could be external must 'ca-certs or client-certs'; */description"NETCONF/TLS servers MUST validate"Specifies a mapping through which clients MAY be identified (i.e., the NETCONF username) from a supplied certificate. Note that a clientcertificates."; } augment "client-authentication" { description "Augments inMAY alternatively be identified via an HTTP-level authentication schema. This configuration does not necessitate clients send a certificate (that can be controlled via thecert-to-name structure.";ietf-netconf-server module)."; container cert-maps { when "../../../../tls"; uses x509c2n:cert-to-name; description "The cert-maps container is used byaTLS-based NETCONFserverservers (even if the TLS sessions are terminated externally) to map the NETCONF client's presented X.509 certificate to 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 "RFCWWWW: NETCONF over TLS, Section 7"; } } } } } } // tls7407: A YANG Data Model for SNMP Configuration."; }// choice}// endpoint}// endpoints container connection-typegrouping netconf-server-listen-stack-grouping { description"Indicates the NETCONF server's preference"A reusable grouping forhow theconfiguring a NETCONFconnection is maintained.";server 'listen' protocol stack for a single connection."; choiceconnection-typetransport { mandatory true; description "Selects between availableconnection types.";transports."; casepersistent-connectionssh { if-feature "ssh-listen"; containerpersistentssh {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"SSH-specific listening configuration for inbound connections."; container tcp-server-parameters { description "A wrapper around thereconnection strategy. This connection type minimizes any NETCONFTCP client parameters to avoid name collisions."; uses tcps:tcp-server-grouping { refine "local-port" { default "830"; description "The NETCONF serverdata-transfer delay, albeit atwill listen on theexpense of holding resources longer.";IANA-assigned well-known port value for 'netconf-ssh' (830) if no value is specified."; } }// container persistent}// case persistent-connection case periodic-connection {containerperiodicssh-server-parameters {presence "Indicates that a periodic connection is to be maintained.";description"Periodically connect to"A wrapper around theNETCONF client. This connection type increases resource utilization, albeit with increased delay in NETCONF clientSSH server parameters toNETCONF 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,avoid name collisions."; uses sshs:ssh-server-grouping; } container netconf-server-parameters { description "A wrapper around the NETCONF serverMUST immediately attemptparameters toreestablish the connection. In theavoid name collisions."; uses ncs:netconf-server-grouping; } } } casethat the previous connection is still active (i.e., the NETCONF client has not closed it yet), establishing a new connection is NOT RECOMMENDED."; leaf periodtls { if-feature "tls-listen"; container tls {type uint16; units "minutes"; default "60";description"Duration of time between periodic"TLS-specific listening configuration for inbound connections.";} leaf anchor-time { type yang:date-and-timecontainer tcp-server-parameters {// 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"A wrapper around theanchor 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-timeoutTCP client parameters to avoid name collisions."; uses tcps:tcp-server-grouping { refine "local-port" {type uint16; units "seconds";default120; // two minutes"6513"; description"Specifies the maximum number of seconds that a NETCONF session may remain idle. A"The NETCONFsession will be dropped if it is idle for an interval longer than this number of seconds. If set to zero, then theserver willnever drop a session because itlisten on the IANA-assigned well-known port value for 'netconf-tls' (6513) if no value isidle.";specified."; } } }//containerperiodictls-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 client-certs'; description "NETCONF/TLS servers MUST validate client certificates."; }// case periodic-connection}// choice connection-type}// container connection-typecontainerreconnect-strategynetconf-server-parameters { description"The reconnection strategy directs how a"A wrapper around the NETCONF serverreconnectsparameters to avoid name collisions."; uses ncs:netconf-server-grouping; } } } } } grouping netconf-server-callhome-stack-grouping { description "A reusable grouping for configuring a NETCONFclient, after discovering its connection toserver '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 clienthas dropped, even if dueparameters toa reboot. Theavoid name collisions."; uses tcpc:tcp-client-grouping { refine "remote-port" { default "4334"; description "The NETCONF serverstarts with the specified endpoint and trieswill attempt to connect toit max-attempts times before trying the next endpoint inthelist (round robin)."; leaf start-with { type enumeration { enum first-listedIANA-assigned well-known port for 'netconf-ch-tls' (4334) if no value is specified."; } } } container ssh-server-parameters { description"Indicates that reconnections should start with"A wrapper around thefirst endpoint listed.";SSH server parameters to avoid name collisions."; uses sshs:ssh-server-grouping; }enum last-connectedcontainer netconf-server-parameters { description"Indicates that reconnections should start with the endpoint last connected to. If no previous connection has ever been established, then"A wrapper around thefirst endpoint configured is used.NETCONFservers SHOULD be able to remember the last endpoint connectedserver parameters toacross reboots.";avoid name collisions."; uses ncs:netconf-server-grouping; }enum random-selection { description "Indicates that reconnections should start with a random endpoint.";} }default "first-listed";case tls { if-feature "tls-call-home"; container tls { description "Specifieswhich of the NETCONF client's endpointsTLS-specific call-home transport configuration."; container tcp-client-parameters { description "A wrapper around theNETCONF server should start with when trying to connectTCP client parameters tothe NETCONF client."; } leaf max-attemptsavoid name collisions."; uses tcpc:tcp-client-grouping {type uint8refine "remote-port" {range "1..max"; }default"3";"4335"; description"Specifies the number times the"The NETCONF servertrieswill attempt to connect toa specific endpoint before moving on to the next endpoint inthelist (round robin)."; }IANA-assigned well-known port for 'netconf-ch-tls' (4335) if no value is specified."; }// container reconnect-strategy}// list netconf-client}//containercall-home } // grouping netconf-server-grouping // Protocol accessible node, fortls-server-parameters { description "A wrapper around the TLS server parameters to avoid name collisions."; uses tlss:tls-server-grouping { refine "client-authentication" { /* commented out since auth could be external must 'ca-certs or client-certs'; */ description "NETCONF/TLS serversthat implement this // module.MUST validate client certificates."; } augment "client-authentication" { description "Augments in the cert-to-name structure."; containernetconf-servercert-maps { usesnetconf-server-grouping;x509c2n:cert-to-name; description"Top-level"The cert-maps containerforis used by a TLS-based NETCONF serverconfiguration."; } } <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 seeto map theSecurity Considerations section in those documents for concerns related those groupings. The YANG modules defined in this document are designedNETCONF client's presented X.509 certificate to a NETCONF username. If no matching and valid cert-to-name list entry can beaccessed via YANG based management protocols, such asfound, then the NETCONF[RFC6241]server MUST close the connection, andRESTCONF [RFC8040]. Both of these protocols have mandatory-to- implement secure transport layers (e.g., SSH, TLS) with mutual authentication. TheMUST NOT accept NETCONFaccess control model (NACM) [RFC8341] providesmessages over it."; reference "RFC WWWW: NETCONF over TLS, Section 7"; } } } } container netconf-server-parameters { description "A wrapper around themeansNETCONF server parameters torestrict accessavoid name collisions."; uses ncs:netconf-server-grouping; } } } } } grouping netconf-server-app-grouping { description "A reusable grouping forparticular users toconfiguring apre-configured subset of all available protocol operationsNETCONF server application that supports both 'listen' andcontent. There are'call-home' protocol stacks for anumbermultiplicity ofdata nodes defined in the YANG modules that are writable/creatable/deletable (i.e., config true, which isconnections."; 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 thedefault). Somemaximum number ofthese data nodesseconds that a NETCONF session may remain idle. A NETCONF session will beconsidered sensitive or vulnerable in some network environments. Write operations (e.g., edit-config)dropped if it is idle for an interval longer than this number of seconds. If set tothese data nodes without proper protection canzero, then the server will never drop a session because it is idle. Sessions that have anegative effect on network operations. Thesenotification subscription active arethe subtrees and data nodes and their sensitivity/vulnerability: Nonenever 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 for thesubtreesNETCONF listen endpoint."; } uses netconf-server-listen-stack-grouping; } } container call-home { if-feature "ssh-call-home ordata nodes intls-call-home"; presence "Enables themodules defined in this document needNETCONF server tobe protected from write operations. Some of the readable data nodes ininitiate theYANG modules may be considered sensitive or vulnerable in some network environments. It is thus important to control read access (e.g., via get, get-config, or notification)underlying transport connection tothese data nodes. These are the subtrees and data nodes and their sensitivity/vulnerability: NoneNETCONF clients."; description "Configures call home behavior."; list netconf-client { key "name"; min-elements 1; description "List of NETCONF clients thesubtrees or data nodes in the modules defined in this document needNETCONF server is tobe protected from read operations. Some ofmaintain simultaneous call-home connections with."; leaf name { type string; description "An arbitrary name for theRPC operations inremote NETCONF client."; } container endpoints { description "Container for theYANG modules may be considered sensitive or vulnerable in some network environments. It is thus importantlist 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 tocontrol accesstry to connect tothese operations. These are the operations and their sensitivity/vulnerability: The modules definedin sequence. Defining more than one enables high-availability."; leaf name { type string; description "An arbitrary name for thisdocument 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 ofendpoint."; } uses netconf-server-callhome-stack-grouping; } } container connection-type { description "Indicates theIETF XML Registry [RFC3688]. FollowingNETCONF server's preference for how theformat in [RFC3688],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 thefollowing registrations are requested: URI: urn:ietf:params:xml:ns:yang:ietf-netconf-client Registrant Contact: TheNETCONFWG ofclient. If theIETF. XML: N/A,connection goes down, immediately start trying to reconnect to therequested URI is an XML namespace. URI: urn:ietf:params:xml:ns:yang:ietf-netconf-server Registrant Contact: TheNETCONFWG of the IETF. XML: N/A,client, using therequested URI is an XML namespace. 6.2. The YANG Module Names Registryreconnection strategy. Thisdocument registers two YANG modules inconnection type minimizes any NETCONF client to NETCONF server data-transfer delay, albeit at theYANG Module Names registry [RFC6020]. Followingexpense of holding resources longer."; } } case periodic-connection { container periodic { presence "Indicates that a periodic connection is to be maintained."; description "Periodically connect to theformatNETCONF client. This connection type increases resource utilization, albeit with increased delay in[RFC6020],NETCONF client to NETCONF client interactions. The NETCONF client SHOULD gracefully close the connection using <close-session> upon completing planned activities. If thefollowing registrationsNETCONF 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 arerequested: name: ietf-netconf-client namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-client prefix: ncc reference: RFC XXXX name: ietf-netconf-server namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-server prefix: ncs reference: RFC XXXX 7. References 7.1. Normative References [I-D.ietf-netconf-keystore] Watsen, K., "A YANG Data Model fordetermined. The periodic connections occur at aKeystore", draft- ietf-netconf-keystore-11 (work in progress), June 2019. [I-D.ietf-netconf-ssh-client-server] Watsen, K., Wu, G., and L. Xia, "YANG Groupingswhole multiple interval from the anchor time. For example, forSSH Clientsan anchor time is 15 minutes past midnight andSSH Servers", draft-ietf-netconf-ssh-client- server-14 (work in progress), June 2019. [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-13 (work in progress), June 2019. [I-D.kwatsen-netconf-tcp-client-server] Watsen, K. and M. Scharf, "YANG Groupings for TCP Clients and TCP Servers", draft-kwatsen-netconf-tcp-client- server-02 (work in progress), April 2019. [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 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. AData Modeling LanguageNETCONF session will be dropped if it is idle for an interval longer than this number of seconds. If set to zero, then theNetwork 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., "Usingserver 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 NETCONFProtocol 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.,server starts with the specified endpoint andJ. Schoenwaelder, "Usingtries 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. NETCONFProtocol over Transport Layer Security (TLS)servers SHOULD be able to remember the last endpoint connected to across reboots."; } enum random-selection { description "Indicates that reconnections should start withMutual 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., "Ambiguitya random endpoint."; } } default "first-listed"; description "Specifies which ofUppercase vs Lowercasethe 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 moving on to the next endpoint inRFC 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 a Truststore", draft- ietf-netconf-trust-anchors-05 (work in progress), June 2019. [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>. Appendix A. Expanded Tree Diagrams A.1. Expanded Tree Diagram for 'ietf-netconf-client' The following tree diagram [RFC8340] provides an overview ofthedata modellist (round robin)."; } } // container reconnect-strategy } // list netconf-client } // container call-home } // grouping netconf-server-app-grouping // Protocol accessible node, forthe "ietf-netconf-client"servers that implement this // module.This tree diagram shows all the nodescontainer netconf-server { uses netconf-server-app-grouping; description "Top-level container for NETCONF server configuration."; } } <CODE ENDS> 5. Security Considerations The YANG module defined in thismodule, including thosedocument uses groupings definedby "grouping" statements used by this module.in [I-D.kwatsen-netconf-tcp-client-server], [I-D.ietf-netconf-ssh-client-server], and [I-D.ietf-netconf-tls-client-server]. Please seeSection 3.1 for a tree diagram that illustrates what the module looks like without allthe"grouping" statements expanded. ========== NOTE: '\\' line wrapping per BCP XX (RFC XXXX) =========== module: ietf-netconf-client +--rw netconf-client +--rw initiate! {ssh-initiate or tls-initiate}?Security Considerations section in those documents for concerns related those groupings. The YANG modules defined in this document are designed to be accessed via YANG based management protocols, such as NETCONF [RFC6241] and RESTCONF [RFC8040]. Both of these protocols have mandatory-to- implement secure transport layers (e.g., SSH, 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. There are a number of data nodes defined in the YANG modules that are writable/creatable/deletable (i.e., config true, which is the default). Some of these data nodes may be considered sensitive or vulnerable in some network environments. Write operations (e.g., edit-config) to these data nodes without proper protection can have a negative effect on network operations. These are the subtrees and data nodes and their sensitivity/vulnerability: None of the 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 the YANG modules may be considered sensitive or vulnerable in some network environments. It is thus important to control read access (e.g., via get, get-config, or notification) to these data nodes. These are the subtrees and data nodes and their sensitivity/vulnerability: None of the subtrees or data nodes in the modules defined in this document need to be protected from read operations. Some of the RPC operations in the YANG modules may be considered sensitive or vulnerable in some network environments. It is thus important to control access to these operations. These are the operations and their 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: 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. 6.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 XXXX name: ietf-netconf-server namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-server prefix: ncs reference: RFC XXXX 7. References 7.1. Normative References [I-D.ietf-netconf-keystore] Watsen, K., "A YANG Data Model for a Keystore", draft- ietf-netconf-keystore-12 (work in progress), July 2019. [I-D.ietf-netconf-ssh-client-server] Watsen, K., Wu, G., and L. Xia, "YANG Groupings for SSH Clients and SSH Servers", draft-ietf-netconf-ssh-client- server-14 (work in progress), June 2019. [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-14 (work in progress), July 2019. [I-D.kwatsen-netconf-tcp-client-server] Watsen, K. and M. Scharf, "YANG Groupings for TCP Clients and TCP Servers", draft-kwatsen-netconf-tcp-client- server-02 (work in progress), April 2019. [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>. 7.2. Informative References [I-D.ietf-netconf-trust-anchors] Watsen, K., "A YANG Data Model for a Truststore", draft- ietf-netconf-trust-anchors-05 (work in progress), June 2019. [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>. 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 all the nodes defined in this module, including those defined by "grouping" statements used by this module. Please see Section 3.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-client +--rw netconf-client +--rw initiate! {ssh-initiate or tls-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 (auth-type) | | | | | +--:(password) | | | | | | +--rw password? string | | | | | +--:(public-key) | | | | | | +--rw public-key | | | | | | +--rw (local-or-keystore) | | | | | | +--:(local) | | | | | | | {local-definiti\ \ons-supported}? | | | | | | | +--rw local-definition | | | | | | | +--rw algorithm | | | | | | | | asymmetric\ \-key-algorithm-t | | | | | | | +--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 | | | | | +--:(certificate) | | | | | +--rw certificate | | | | | {sshcmn:ssh-x509-certs\ \}? | | | | | +--rw (local-or-keystore) | | | | | +--:(local) | | | | | | {local-definiti\ \ons-supported}? | | | | | | +--rw local-definition | | | | | | +--rw algorithm | | | | | | | asymmetric\ \-key-algorithm-t | | | | | | +--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 | | | | | | +---w input | | | | | | | +---w subject | | | | | | | | bina\ \ry | | | | | | | +---w attrib\ \utes? | | | | | | | bina\ \ry | | | | | | +--ro output | | | | | | +--ro certif\ \icate-signing-request | | | | | | bina\ \ry | | | | | +--:(keystore) | | | | | {keystore-suppo\ \rted}? | | | | | +--rw keystore-refere\ \nce | | | | | +--rw asymmetric-k\ \ey? | | | | | | ks:asymmet\ \ric-key-ref | | | | | +--rw certificate?\ \ leafref | | | | +--rw server-authentication | | | | | +--rw ssh-host-keys! | | | | | | {ts:ssh-host-keys}? | | | | | | +--rw (local-or-truststore) | | | | | | +--:(local) | | | | | | | {local-definitions-su\ \pported}? | | | | | | | +--rw local-definition | | | | | | | +--rw host-key* | | | | | | | ct:ssh-host-key | | | | | | +--:(truststore) | | | | | | {truststore-supported\ \,ssh-host-keys}? | | | | | | +--rw truststore-reference? | | | | | | ts:host-keys-ref | | | | | +--rw ca-certs! | | | | | | {sshcmn:ssh-x509-certs,ts:x5\ \09-certificates}? | | | | | | +--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\ \,x509-certificates}? | | | | | | +--rw truststore-reference? | | | | | | ts:certificates-ref | | | | | +--rw server-certs! | | | | | {sshcmn:ssh-x509-certs,ts:x5\ \09-certificates}? | | | | | +--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\ \,x509-certificates}? | | | | | +--rw truststore-reference? | | | | | ts:certificates-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 (local-or-keystore) | | | | +--:(local) | | | | | {local-definitions-suppo\ \rted}? | | | | | +--rw local-definition | | | | | +--rw algorithm | | | | | | asymmetric-key-algo\ \rithm-t | | | | | +--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-k\ \ey) | | | | | | +--rw encrypted-priva\ \te-key | | | | | | +--rw (key-type) | | | | | | | +--:(symmetric-\ \key-ref) | | | | | | | | +--rw symmet\ \ric-key-ref? leafref | | | | | | | | {key\ \store-supported}? | | | | | | | +--:(asymmetric\ \-key-ref) | | | | | | | +--rw asymme\ \tric-key-ref? leafref | | | | | | | {key\ \store-supported}? | | | | | | +--rw value? | | | | | | binary | | | | | +--rw cert? | | | | | | end-entity-cert-cms | | | | | +---n certificate-expiration | | | | | | +-- expiration-date | | | | | | yang:date-and-ti\ \me | | | | | +---x generate-certificate-\ \signing-request | | | | | +---w input | | | | | | +---w subject | | | | | | | binary | | | | | | +---w attributes? | | | | | | binary | | | | | +--ro output | | | | | +--ro certificate-sig\ \ning-request | | | | | binary | | | | +--:(keystore) | | | | {keystore-supported}? | | | | +--rw keystore-reference | | | | +--rw asymmetric-key? | | | | | ks:asymmetric-key-r\ \ef | | | | +--rw certificate? lea\ \fref | | | +--rw server-authentication | | | | +--rw ca-certs! | | | | | {ts:x509-certificates}? | | | | | +--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\ \,x509-certificates}? | | | | | +--rw truststore-reference? | | | | | ts:certificates-ref | | | | +--rw server-certs! | | | | {ts:x509-certificates}? | | | | +--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\ \,x509-certificates}? | | | | +--rw truststore-reference? | | | | ts:certificates-ref | | | +--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 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 (auth-type) | | | +--:(password) | | | | +--rw password? string | | | +--:(public-key) | | | | +--rw public-key | | | | +--rw (local-or-keystore) | | | | +--:(local) | | | | | {local-definitions-su\ \pported}? | | | | | +--rw local-definition | | | | | +--rw algorithm | | | | | | asymmetric-key-a\ \lgorithm-t | | | | | +--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 | | | +--:(certificate) | | | +--rw certificate | | | {sshcmn:ssh-x509-certs}? | | | +--rw (local-or-keystore) | | | +--:(local) | | | | {local-definitions-su\ \pported}? | | | | +--rw local-definition | | | | +--rw algorithm | | | | | asymmetric-key-a\ \lgorithm-t | | | | +--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 | | | | +---w input | | | | | +---w subject | | | | | | binary | | | | | +---w attributes? | | | | | binary | | | | +--ro output | | | | +--ro certificate-\ \signing-request | | | | binary | | | +--:(keystore) | | | {keystore-supported}? | | | +--rwnetconf-server* [name]keystore-reference | | | +--rwname stringasymmetric-key? | | | | ks:asymmetric-ke\ \y-ref | | | +--rwendpointscertificate? \ \leafref | | +--rwendpoint* [name]server-authentication | | | +--rwname stringssh-host-keys! {ts:ssh-host-keys}? | | | | +--rw(transport)(local-or-truststore) | |+--:(ssh) {ssh-initiate}?| | +--:(local) |+--rw ssh| | |+--rw tcp-client-parameters| {local-definitions-supporte\ \d}? | | | | | +--rwremote-address inet:hostlocal-definition | | | | | +--rwremote-port? inet:port-numberhost-key* | | | |+--rw local-address? inet:ip-address| ct:ssh-host-key | | | |{local-binding-supported}?+--:(truststore) | | | |+--rw local-port? inet:port-number{truststore-supported,ssh-h\ \ost-keys}? | | | | +--rw truststore-reference? | |{local-binding-supported}?| | ts:host-keys-ref | | | +--rwkeepalives!ca-certs! | | | |{keepalives-supported}?{sshcmn:ssh-x509-certs,ts:x509-cer\ \tificates}? | | | | +--rwidle-time uint16(local-or-truststore) | | | |+--rw max-probes uint16+--:(local) | | | | | {local-definitions-supporte\ \d}? | | | | | +--rwprobe-interval uint16local-definition | | | | | +--rwssh-client-parameterscert* | | | | | | trust-anchor-cert-cms | | | | | +---n certificate-expiration | | | | | +-- expiration-date | | | | | yang:date-and-time | | | | +--:(truststore) | | | | {truststore-supported,x509-\ \certificates}? | | | | +--rwclient-identitytruststore-reference? | | | | ts:certificates-ref | | | +--rwusername? stringserver-certs! | | | {sshcmn:ssh-x509-certs,ts:x509-cer\ \tificates}? | | | +--rw(auth-type)(local-or-truststore) | | | +--:(local) | | |+--:(password)| {local-definitions-supporte\ \d}? | | | | +--rwpassword? stringlocal-definition | | | |+--:(public-key)+--rw cert* | | | | |+--rw public-keytrust-anchor-cert-cms | | | | +---n certificate-expiration |+--rw (local-or-keystore)| | | +-- expiration-date | | |+--:(local)| yang:date-and-time | | | +--:(truststore) | |{local-definiti\ \ons-supported}?| {truststore-supported,x509-\ \certificates}? | | | +--rw truststore-reference? | | | ts:certificates-ref | | +--rwlocal-definitiontransport-params | | | {ssh-client-transport-params-config}? | | | +--rwalgorithmhost-key | | | | +--rw host-key-alg* identityref | | | +--rw key-exchange |asymmetric\ \-key-algorithm-t| | | +--rw key-exchange-alg* identityref | | | +--rwpublic-key |encryption | | | | +--rw encryption-alg* identityref | |binary| +--rw mac | | | +--rw mac-alg* identityref | | +--rw(private-key\ \-type) |keepalives! {ssh-client-keepalives}? | | +--rw max-wait? uint16 | | +--rw max-attempts? uint8 |+--:(private-ke\ \y)+--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 | +--rwprivat\ \e-key?client-identity | | +--rw (local-or-keystore) | | +--:(local) | | |bina\ \ry{local-definitions-supported}? | | | +--rw local-definition | | |+--:(hidden-pri\ \vate-key)+--rw algorithm | | | | asymmetric-key-algorithm-t | | | +--rwhidden\ \-private-key?public-key-format? | | | | identityref | | |empty+--rw public-key | | | | binary | |+--:(encrypted-\ \private-key)| +--rw private-key-format? | | | | identityref |+--rw encryp\ \ted-private-key| | +--rw (private-key-type) | | | |+--rw (ke\ \y-type)+--:(private-key) | | | | | +--rw private-key? | |+--:(s\ \ymmetric-key-ref)| | | binary | | | | +--:(hidden-private-key) |+--\ \rw symmetric-key-ref? leafref| | | | +--rw hidden-private-key? | | | |\ \ {keystore-supported}?| empty | | | | +--:(encrypted-private-key) | |+--:(a\ \symmetric-key-ref)| | +--rw encrypted-private-key | | | | +--rw (key-type) |+--\ \rw asymmetric-key-ref? leafref| | | | +--:(symmetric-key-re\ \f) | | |\ \ {keystore-supported}?| | | +--rw symmetric-ke\ \y-ref? leafref | | | |+--rw val\ \ue?| | {keystore-\ \supported}? | | | |b\ \inary| +--:(asymmetric-key-r\ \ef) | | | |+--:(keystore)| +--rw asymmetric-k\ \ey-ref? leafref | | | |{keystore-suppo\ \rted}?| {keystore-\ \supported}? | | | | +--rwkeystore-refere\ \nce?value? | | | | binary |ks:asymmetric\ \-key-ref| | +--rw cert? | |+--:(certificate)| | end-entity-cert-cms | |+--rw certificate| +---n certificate-expiration | | |{sshcmn:ssh-x509-certs\ \}?| +-- expiration-date | | |+--rw (local-or-keystore)| yang:date-and-time | | |+--:(local)+---x generate-certificate-signin\ \g-request | | | +---w input | |{local-definiti\ \ons-supported}?| | +---w subject binary | | |+--rw local-definition| +---w attributes? binary | | | +--ro output |+--rw algorithm| | +--ro certificate-signing-r\ \equest | | | binary |asymmetric\ \-key-algorithm-t| +--:(keystore) {keystore-supported}? | | +--rw keystore-reference | | +--rwpublic-keyasymmetric-key? | | | ks:asymmetric-key-ref | | +--rw certificate? leafref |binary+--rw server-authentication | | +--rw ca-certs! {ts:x509-certificates}? | | | +--rw(private-key\ \-type) | |(local-or-truststore) | | | +--:(local) |+--:(private-ke\ \y)| | | {local-definitions-supporte\ \d}? | | | | +--rwprivat\ \e-key? | |local-definition | | | | +--rw cert* |bina\ \ry| | | | trust-anchor-cert-cms | |+--:(hidden-pri\ \vate-key)| | +---n certificate-expiration | | | | +-- expiration-date |+--rw hidden\ \-private-key?| | | yang:date-and-time | | | +--:(truststore) |empty| | {truststore-supported,x509-\ \certificates}? | | | +--rw truststore-reference? |+--:(encrypted-\ \private-key)| | ts:certificates-ref | | +--rw server-certs! {ts:x509-certificates}? | | +--rwencryp\ \ted-private-key(local-or-truststore) | | +--:(local) | | | {local-definitions-supporte\ \d}? |+--rw (ke\ \y-type)| | +--rw local-definition | | | +--rw cert* | |+--:(s\ \ymmetric-key-ref)| | trust-anchor-cert-cms | | | +---n certificate-expiration | | |+--\ \rw symmetric-key-ref? leafref+-- expiration-date | | | yang:date-and-time | | +--:(truststore) | | {truststore-supported,x509-\ \certificates}? |\ \ {keystore-supported}?| +--rw truststore-reference? | | ts:certificates-ref | +--rw hello-params | | {tls-client-hello-params-config}? |+--:(a\ \symmetric-key-ref)| +--rw tls-versions | | | +--rw tls-version* identityref | | +--rw cipher-suites |+--\ \rw asymmetric-key-ref? leafref| +--rw cipher-suite* identityref | +--rw keepalives! {tls-client-keepalives}? | +--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] |\ \ {keystore-supported}?+--rw name string | +--rw (transport) | +--:(ssh) {ssh-listen}? | | +--rw ssh | | +--rwval\ \ue?tcp-server-parameters | | | +--rw local-address inet:ip-address | | | +--rw local-port? inet:port-number |b\ \inary| | +--rw keepalives! {keepalives-supported}? | | | +--rwcert?idle-time uint16 | | | +--rw max-probes uint16 | | |end-entity\ \-cert-cms+--rw probe-interval uint16 | | +--rw ssh-server-parameters | | |+---n certificate-\ \expiration+--rw server-identity | | | | +--rw host-key* [name] | |+-- expiration-\ \date| | +--rw name string | | | |yang:da\ \te-and-time+--rw (host-key-type) | | | | +--:(public-key) |+---x generate-cer\ \tificate-signing-request| | | | +--rw public-key |+---w input| | | | +--rw (local-or-keystore) | |+---w subject| | | +--:(local) | | | |bina\ \ry| | {local-definitions\ \-supported}? | | | |+---w attrib\ \utes?| | +--rw local-definition | | | |bina\ \ry| | +--rw algorithm | | |+--ro output| | | | asymmetric-ke\ \y-algorithm-t |+--ro certif\ \icate-signing-request| | | | |bina\ \ry+--rw public-key-form\ \at? | | | |+--:(keystore)| | | identityref | |{keystore-suppo\ \rted}?| | | | +--rwkeystore-refere\ \ncepublic-key | | | |+--rw asymmetric-k\ \ey?| | | binary | |ks:asymmet\ \ric-key-ref| | | | +--rwcertificate?\ \ leafrefprivate-key-for\ \mat? | | |+--rw server-authentication| | | |+--rw ssh-host-keys?identityref | | | | |ts:host-keys-ref| +--rw (private-key-ty\ \pe) | | | |{ts:ssh-host-keys}?| | +--:(private-key) | |+--rw ca-certs?| | | | |ts:certificates-ref+--rw private-k\ \ey? | | | | |{sshcmn:ssh-x509-certs,ts:x5\ \09-certificates}?| | binary | |+--rw server-certs?| | | |ts:certificates-ref+--:(hidden-privat\ \e-key) | | | |{sshcmn:ssh-x509-certs,ts:x5\ \09-certificates}?| | | +--rwtransport-paramshidden-pr\ \ivate-key? | | | |{ssh-client-transport-params-co\ \nfig}?| | | empty |+--rw host-key| | | | |+--rw host-key-alg* identityref+--:(encrypted-pri\ \vate-key) | | | | | | +--rwkey-exchangeencrypted\ \-private-key | | | | | | +--rwkey-exchange-alg*(key-t\ \ype) | | | | |identityref| | +--:(symm\ \etric-key-ref) | | |+--rw encryption| | | | | +--rwencryption-alg*\ \symmetric-key-ref? leafref | | | | |identityref| | | \ \ {keystore-supported}? |+--rw mac| | | |+--rw mac-alg* identityref| | +--:(asym\ \metric-key-ref) |+--rw keepalives!| | |{ssh-client-keepalives}?| | | +--rwmax-wait? uint16\ \asymmetric-key-ref? leafref | | |+--rw max-attempts? uint8| |+--:(tls) {tls-initiate}?| |+--rw tls\ \ {keystore-supported}? | | |+--rw tcp-client-parameters| | | +--rwremote-address inet:hostvalue? | | |+--rw remote-port? inet:port-number| | |+--rw local-address? inet:ip-addressbina\ \ry | | | |{local-binding-supported}?| +--:(keystore) | |+--rw local-port? inet:port-number| | | {keystore-supporte\ \d}? | |{local-binding-supported}?| | | +--rwkeepalives!keystore-reference? | | |{keepalives-supported}?| | ks:asymmetric-ke\ \y-ref |+--rw idle-time uint16| | |+--rw max-probes uint16+--:(certificate) | | | | +--rwprobe-interval uint16certificate | |+--rw tls-client-parameters| |+--rw client-identity{sshcmn:ssh-x509-certs}? | | | | +--rw (local-or-keystore) | | | | +--:(local) | | | |{local-definitions-suppo\ \rted}?| {local-definitions\ \-supported}? | | | | | +--rw local-definition | | | | | +--rw algorithm | | | | |asymmetric-key-algo\ \rithm-t | || asymmetric-ke\ \y-algorithm-t |+--rw public-key| | | | +--rw public-key-form\ \at? |binary| | | |+--rw (private-key-type)| identityref | | | |+--:(private-key)| +--rw public-key | | | | |+--rw private-key?| binary | | | | |binary+--rw private-key-for\ \mat? | | | | |+--:(hidden-private-key)| identityref | | | | | +--rwhidden-private-\ \key? |(private-key-ty\ \pe) | | | | |empty| +--:(private-key) | | | |+--:(encrypted-private-k\ \ey)| | | +--rw private-k\ \ey? | |+--rw encrypted-priva\ \te-key| | | | |+--rw (key-type)binary | | | | | |+--:(symmetric-\ \key-ref)+--:(hidden-privat\ \e-key) | | | | | | | +--rwsymmet\ \ric-key-ref? leafrefhidden-pr\ \ivate-key? | | | | | | |{key\ \store-supported}?empty | | | | | |+--:(asymmetric\ \-key-ref)+--:(encrypted-pri\ \vate-key) | | | | | | +--rwasymme\ \tric-key-ref? leafref | | |encrypted\ \-private-key | | |{key\ \store-supported}?| | | +--rw (key-t\ \ype) | |+--rw value?| | | | |binary+--:(symm\ \etric-key-ref) | | | |+--rw cert?| | | | +--rw \ \symmetric-key-ref? leafref |end-entity-cert-cms| | | |+---n certificate-expiration| | | \ \ {keystore-supported}? | |+-- expiration-date| | | | |yang:date-and-ti\ \me+--:(asym\ \metric-key-ref) | | | |+---x generate-certificate-\ \signing-request| | | +--rw \ \asymmetric-key-ref? leafref |+---w input| | | | |+---w subject| \ \ {keystore-supported}? | | | | |binary| +--rw value? | | | |+---w attributes?| | bina\ \ry | | |binary| | +--rw cert? | |+--ro output| | | |+--ro certificate-sig\ \ning-requestend-entity-ce\ \rt-cms | | | |binary| +---n certificate-exp\ \iration | |+--:(keystore)| | |{keystore-supported}?| +-- expiration-date | |+--rw keystore-reference| | |+--rw asymmetric-key?| yang:date-\ \and-time | | |ks:asymmetric-key-r\ \ef| | +---x generate-certif\ \icate-signing-request |+--rw certificate? lea\ \fref| |+--rw server-authentication| | +---w input |+--rw ca-certs?| | | |ts:certificates-ref| +---w subject | | |{ts:x509-certificates}?| | |+--rw server-certs?| binary | |ts:certificates-ref| | |{ts:x509-certificates}?| +---w attribute\ \s? |+--rw hello-params| | |{tls-client-hello-params-config\ \}?| | binary |+--rw tls-versions| | | |+--rw tls-version* identityref+--ro output | | |+--rw cipher-suites| | +--ro certifica\ \te-signing-request |+--rw cipher-suite* identityref| |+--rw keepalives!| |{tls-client-keepalives}?binary | |+--rw max-wait? uint16| |+--rw max-attempts? uint8+--:(keystore) |+--rw connection-type| |+--rw (connection-type)| {keystore-supporte\ \d}? |+--:(persistent-connection)| | | +--rwpersistent!keystore-reference | |+--:(periodic-connection)| | +--rwperiodic!asymmetric-key? | |+--rw period? uint16| |+--rw anchor-time? yang:date-and-time| ks:asymmetric\ \-key-ref |+--rw idle-timeout? uint16|+--rw reconnect-strategy|+--rw start-with? enumeration| +--rwmax-attempts? uint8 +--rw listen! {ssh-listen or tls-listen}? +--rw idle-timeout? uint16 +--rw endpoint* [name] +--rw name string +--rw (transport) +--:(ssh) {ssh-listen}?certificate? \ \ leafref | |+--rw ssh| +--rwtcp-server-parametersclient-authentication | |+--rw local-address inet:ip-address| | +--rwlocal-port? inet:port-numbersupported-authentication-methods | | |+--rw keepalives! {keepalives-supported}?| | +--rwidle-time uint16publickey? empty | |+--rw max-probes uint16| |+--rw probe-interval uint16| +--rwssh-client-parameterspasssword? empty |+--rw client-identity| |+--rw username? string| | +--rw(auth-type)hostbased? empty | |+--:(password)| | | +--rwpassword? stringnone? empty | |+--:(public-key)| | | +--rwpublic-keyother* string | | |+--rw (local-or-keystore)| +--rw (local-or-external) | |+--:(local)| | +--:(local) | |{local-definitions-su\ \pported}?| | | {local-client-auth-supported}? |+--rw local-definition| | | | +--rwalgorithm | | | |users |asymmetric-key-a\ \lgorithm-t| | | | +--rwpublic-keyuser* [name] | | | | |binary+--rw name string | | | | | +--rw(private-key-type)password? | | | |+--:(private-key)| | ianach:crypt-hash | | |+--rw private-key?| | +--rw host-keys! | | |binary| | | {ts:ssh-host-keys}? |+--:(hidden-private-k\ \ey)| | | | | +--rwhidden-priva\ \te-key?(local-or-truststore) | | | | |empty || +--:(local) | |+--:(encrypted-privat\ \e-key)| | | |+--rw encrypted-pr\ \ivate-key| {local-definiti\ \ons-supported}? | | |+--rw (key-type)| | | | +--rw local-definition |+--:(symmetr\ \ic-key-ref)| | | | | | +--rwsym\ \metric-key-ref? leafrefhost-key* | | | | | |{\ \keystore-supported}?| ct:ssh-hos\ \t-key | | | |+--:(asymmet\ \ric-key-ref)| | +--:(truststore) | | |+--rw asy\ \mmetric-key-ref? leafref| | | {truststore-sup\ \ported,ssh-host-keys}? | |{\ \keystore-supported}?| | | | +--rwvalue? |truststore-refe\ \rence? | | |binary || |+--:(keystore)| ts:host-keys-\ \ref | |{keystore-supported}?| | | +--rwkeystore-reference?ca-certs! | | |ks:asymmetric-key-r\ \ef| |+--:(certificate)| {sshcmn:ssh-x509-certs\ \,ts:x509-certificates}? | |+--rw certificate| |{sshcmn:ssh-x509-certs}?| | +--rw(local-or-keystore)(local-or-truststore) | |+--:(local)| | |{local-definitions-su\ \pported}?| +--:(local) | |+--rw local-definition| | |+--rw algorithm| | {local-definiti\ \ons-supported}? | | | |asymmetric-key-a\ \lgorithm-t| | | +--rwpublic-keylocal-definition | | | |binary| | | +--rw(private-key-type)cert* | | | |+--:(private-key)| | | | trust-anch\ \or-cert-cms |+--rw private-key?| | | | |binary| +---n certificate-\ \expiration | | |+--:(hidden-private-k\ \ey)| | | | +-- expiration-\ \date |+--rw hidden-priva\ \te-key?| | | | |empty| yang:da\ \te-and-time | | |+--:(encrypted-privat\ \e-key)| | | +--:(truststore) |+--rw encrypted-pr\ \ivate-key| | | |+--rw (key-type)| {truststore-sup\ \ported,x509-certificates}? | | | |+--:(symmetr\ \ic-key-ref)| | +--rw truststore-refe\ \rence? | | | |+--rw sym\ \metric-key-ref? leafref| | ts:certificat\ \es-ref | | | |{\ \keystore-supported}?| +--rw client-certs! | | | |+--:(asymmet\ \ric-key-ref)| {sshcmn:ssh-x509-certs\ \,ts:x509-certificates}? | | | | | +--rwasy\ \mmetric-key-ref? leafref(local-or-truststore) | | | | |{\ \keystore-supported}?+--:(local) | | | |+--rw value?| | {local-definiti\ \ons-supported}? | | |binary| | | +--rwcert?local-definition | | | |end-entity-cert-\ \cms| | +--rw cert* |+---n certificate-expira\ \tion| | | |+-- expiration-date| | trust-anch\ \or-cert-cms | |yang:date-and\ \-time| | |+---x generate-certifica\ \te-signing-request| +---n certificate-\ \expiration | |+---w input| | | |+---w subject+-- expiration-\ \date | | | | |binary| yang:da\ \te-and-time | | |+---w attributes?| | +--:(truststore) | |binary| | |+--ro output{truststore-sup\ \ported,x509-certificates}? | | |+--ro certificate-\ \signing-request| | +--rw truststore-refe\ \rence? |binary| |+--:(keystore)| |{keystore-supported}?ts:certificat\ \es-ref | |+--rw keystore-reference| |+--rw asymmetric-key?+--:(external) | | |ks:asymmetric-ke\ \y-ref| {external-client-auth-supporte\ \d}? |+--rw certificate? \ \leafref|+--rw server-authentication| | +--rwssh-host-keys? ts:host-keys-ref | | | {ts:ssh-host-keys}?client-auth-defined-elsewhere? | |+--rw ca-certs? ts:certificates-ref| | empty |{sshcmn:ssh-x509-certs,ts:x509-cer\ \tificates}?| | +--rwserver-certs? ts:certificates-reftransport-params | |{sshcmn:ssh-x509-certs,ts:x509-cer\ \tificates}?|+--rw transport-params| {ssh-server-transport-params-config}? | |{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}?{ssh-server-keepalives}? | | | +--rw max-wait? uint16 | | | +--rw max-attempts? uint8 | | +--rw netconf-server-parameters | | +--rw client-identification | | +--rw cert-maps | | +--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 | +--rwtls-client-parameterstls-server-parameters | | +--rwclient-identityserver-identity | | | +--rw (local-or-keystore) | | | +--:(local) | | | | {local-definitions-supported}? | | | | +--rw local-definition | | | | +--rw algorithm | | | | | asymmetric-key-algorithm-t | | | | +--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-re\ \f) | | | | | | | +--rw symmetric-ke\ \y-ref? leafref | | | | | | | {keystore-\ \supported}? | | | | | | +--:(asymmetric-key-r\ \ef) | | | | | | +--rw asymmetric-k\ \ey-ref? leafref | | | | | | {keystore-\ \supported}? | | | | | +--rw value? | | | | | binary | | | | +--rw cert? | | | | | end-entity-cert-cms | | | | +---n certificate-expiration | | | | | +-- expiration-date | | | | | yang:date-and-time | | | | +---x generate-certificate-signin\ \g-request | | | | +---w input | | | | | +---w subject binary | | | | | +---w attributes? binary | | | | +--ro output | | | | +--ro certificate-signing-r\ \equest | | | | binary | | | +--:(keystore) {keystore-supported}? | | | +--rw keystore-reference | | | +--rw asymmetric-key? | | | | ks:asymmetric-key-ref | | | +--rw certificate? leafref+--rw server-authentication| | +--rwca-certs? ts:certificates-refclient-authentication! | |{ts:x509-certificates}?| +--rwserver-certs? ts:certificates-ref(required-or-optional) |{ts:x509-certificates}? +--rw hello-params|{tls-client-hello-params-config}?|+--rw tls-versions| +--:(required) |+--rw tls-version* identityref|+--rw cipher-suites|+--rw cipher-suite* identityref +--rw keepalives! {tls-client-keepalives}? +--rw max-wait? uint16 +--rw max-attempts? uint8 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 XX (RFC XXXX) =========== module: ietf-netconf-server +--rw netconf-server +--rw listen! {ssh-listen or tls-listen}?|+--rw idle-timeout? uint16| +--rwendpoint* [name]required? |+--rw name string|+--rw (transport)|+--:(ssh) {ssh-listen}?| |+--rw sshempty | |+--rw tcp-server-parameters| | +--:(optional) |+--rw local-address inet:ip-address| | | +--rwlocal-port? inet:port-numberoptional? | | |+--rw keepalives! {keepalives-supported}?| empty | | | +--rwidle-time uint16(local-or-external) | | |+--rw max-probes uint16+--:(local) | | |+--rw probe-interval uint16| {local-client-auth-supported}? | |+--rw ssh-server-parameters| | +--rwserver-identityca-certs! | | | |+--rw host-key* [name]| {ts:x509-certificates}? | |+--rw name string| | | +--rw(host-key-type)(local-or-truststore) | | | | | +--:(local) | | |+--:(public-key)| | | {local-definitions-su\ \pported}? | | | | | | +--rwpublic-keylocal-definition | | | | | | +--rw(local-or-keystore)cert* | | | |+--:(local)| | | trust-anchor-cer\ \t-cms | | | | | | +---n certificate-expira\ \tion | | | |{local-definitions\ \-supported}?| | +-- expiration-date | | |+--rw local-definition| | | yang:date-and\ \-time | |+--rw algorithm| | | +--:(truststore) | | |asymmetric-ke\ \y-algorithm-t| | {truststore-supported\ \,x509-certificates}? | | |+--rw public-key| | +--rw truststore-reference? | | | |binary| ts:certificates-ref | | | | +--rw(private-key-ty\ \pe) |client-certs! | | | |+--:(private-key){ts:x509-certificates}? | | | | +--rw (local-or-truststore) | |+--rw private-k\ \ey?| | +--:(local) | | | |binary| {local-definitions-su\ \pported}? | | | |+--:(hidden-privat\ \e-key)| +--rw local-definition | | | | | +--rwhidden-pr\ \ivate-key?cert* | | | | | |empty |trust-anchor-cer\ \t-cms | | | |+--:(encrypted-pri\ \vate-key)| +---n certificate-expira\ \tion | | | |+--rw encrypted\ \-private-key| +-- expiration-date | | | |+--rw (key-t\ \ype)| yang:date-and\ \-time | | | | +--:(truststore) |+--:(symm\ \etric-key-ref)| | | {truststore-supported\ \,x509-certificates}? | | | | +--rw\ \symmetric-key-ref? leafref |truststore-reference? | | | | ts:certificates-ref | |\ \ {keystore-supported}?| +--:(external) | | | {external-client-auth-supporte\ \d}? | |+--:(asym\ \metric-key-ref)| +--rw client-auth-defined-elsewhere? | | | empty | | +--rw\ \asymmetric-key-ref? leafref |hello-params | | | {tls-server-hello-params-config}? | |\ \ {keystore-supported}?| +--rw tls-versions | | | | +--rwvalue?tls-version* identityref | | | +--rw cipher-suites | |bina\ \ry| +--rw cipher-suite* identityref | | +--rw keepalives! {tls-server-keepalives}? |+--:(keystore)| +--rw max-wait? uint16 | | +--rw max-attempts? uint8 |{keystore-supporte\ \d}?+--rw netconf-server-parameters | +--rw client-identification | +--rw cert-maps | +--rw cert-to-name* [id] | +--rwkeystore-reference?id uint32 | +--rw fingerprint | | x509c2n:tls-fingerprint |ks:asymmetric-ke\ \y-ref+--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 |+--:(certificate)+--rw (transport) | +--:(ssh) {ssh-call-home}? | | +--rwcertificate |ssh | |{sshcmn:ssh-x509-certs}?+--rw tcp-client-parameters | | | +--rw(local-or-keystore)remote-address inet:host | | |+--:(local)+--rw remote-port? inet:port-number | | | +--rw local-address? inet:ip-address |{local-definitions\ \-supported}?| | | {local-binding-supported}? | | | +--rwlocal-definitionlocal-port? inet:port-number | | | |+--rw algorithm{local-binding-supported}? | | | +--rw keepalives! | |asymmetric-ke\ \y-algorithm-t| {keepalives-supported}? | | | +--rwpublic-key |idle-time uint16 | | | +--rw max-probes uint16 |binary| | +--rw probe-interval uint16 | | +--rw(private-key-ty\ \pe)ssh-server-parameters | | | +--rw server-identity | |+--:(private-key)| | +--rw host-key* [name] | | | | +--rwprivate-k\ \ey?name string | | | | +--rw (host-key-type) | | |binary| +--:(public-key) | | | |+--:(hidden-privat\ \e-key)| +--rw public-key | | | | | +--rwhidden-pr\ \ivate-key?(local-or-keystore) | | | | | +--:(local) |empty| | | | |+--:(encrypted-pri\ \vate-key){local-defin\ \itions-supported}? | | | | | | +--rwencrypted\ \-private-keylocal-defini\ \tion | | | | | | +--rw(key-t\ \ype)algorithm | | | | | |+--:(symm\ \etric-key-ref)| asymmet\ \ric-key-algorithm-t | | | | | | +--rw\ \symmetric-key-ref? leafrefpublic-ke\ \y-format? | | | | | | |\ \ {keystore-supported}?identit\ \yref | | | | | |+--:(asym\ \metric-key-ref)+--rw public-key | | | | | |+--rw \ \asymmetric-key-ref? leafref| binary | | | | |\ \ {keystore-supported}?| +--rw private-k\ \ey-format? | | | |+--rw value?| | | identit\ \yref | |bina\ \ry| | | | +--rwcert?(private-\ \key-type) | | | | |end-entity-ce\ \rt-cms| +--:(private\ \-key) | | |+---n certificate-exp\ \iration| | | | +--rw pri\ \vate-key? |+-- expiration-date| | | | |yang:date-\ \and-time| b\ \inary | | |+---x generate-certif\ \icate-signing-request| | | +--:(hidden-\ \private-key) |+---w input| | | | |+---w subject| +--rw hid\ \den-private-key? | | | | |binary| | e\ \mpty | | |+---w attribute\ \s?| | | +--:(encrypt\ \ed-private-key) | |binary| | | |+--ro output+--rw enc\ \rypted-private-key | | | |+--ro certifica\ \te-signing-request| | +--rw \ \(key-type) | |binary| | |+--:(keystore)| | +--\ \:(symmetric-key-ref) |{keystore-supporte\ \d}?| | |+--rw keystore-reference| | |+--rw asymmetric-key?| \ \+--rw symmetric-key-ref? leafref | | | | |ks:asymmetric\ \-key-ref| | |+--rw certificate?\ \leafref |{keystore-supported}? |+--rw client-authentication| | |+--rw supported-authentication-methods| | | +--\ \:(asymmetric-key-ref) |+--rw publickey? empty| | | |+--rw passsword? empty| | \ \+--rw asymmetric-key-ref? leafref | |+--rw hostbased? empty| | | |+--rw none? empty| \ \ {keystore-supported}? | | |+--rw other* string| | | +--rw(local-or-external) | |\ \value? |+--:(local)| | | |{local-client-auth-supported}?| \ \ binary | | |+--rw users| | +--:(keystore) | |+--rw user* [name]| | | {keystore-su\ \pported}? |+--rw name string| | | | +--rwpassword?keystore-ref\ \erence? | | | | |ianach:crypt-hashks:asymmet\ \ric-key-ref | | | |+--rw authorized-key* [name]+--:(certificate) | | | | +--rwname stringcertificate | | | |+--rw algorithm string{sshcmn:ssh-x509-ce\ \rts}? | | | | +--rwkey-data binary(local-or-keystore) | | |+--:(external)| +--:(local) | |{external-client-auth-supporte\ \d}?| | |+--rw client-auth-defined-elsewhere?{local-defin\ \itions-supported}? | | |empty| | +--rwtransport-params |local-defini\ \tion | |{ssh-server-transport-params-config}?| | | +--rwhost-keyalgorithm | | | |+--rw host-key-alg* identityref| | asymmet\ \ric-key-algorithm-t |+--rw key-exchange| | | | +--rwkey-exchange-alg* identityrefpublic-ke\ \y-format? | | |+--rw encryption| | | identit\ \yref | |+--rw encryption-alg* identityref| | | +--rwmacpublic-key | | |+--rw mac-alg* identityref| |+--rw keepalives! {ssh-server-keepalives}?| binary |+--rw max-wait? uint16| |+--rw max-attempts? uint8|+--:(tls) {tls-listen}?| +--rwtlsprivate-k\ \ey-format? |+--rw tcp-server-parameters| |+--rw local-address inet:ip-address| |+--rw local-port? inet:port-number| identit\ \yref |+--rw keepalives! {keepalives-supported}?| |+--rw idle-time uint16| | +--rwmax-probes uint16 |(private-\ \key-type) |+--rw probe-interval uint16|+--rw tls-server-parameters|+--rw server-identity| |+--rw (local-or-keystore)| +--:(private\ \-key) |+--:(local)| | |{local-definitions-supported}?| | | +--rwlocal-definitionpri\ \vate-key? | | |+--rw algorithm| | | |asymmetric-key-algorithm-tb\ \inary | | | |+--rw public-key| | +--:(hidden-\ \private-key) | | | |binary| | | +--rw(private-key-type)hid\ \den-private-key? | | | |+--:(private-key)| | | e\ \mpty | | |+--rw private-key?| | | +--:(encrypt\ \ed-private-key) | | |binary| | | +--rw enc\ \rypted-private-key |+--:(hidden-private-key)| | | | | +--rwhidden-private-key? |\ \(key-type) | | | |empty| | | +--\ \:(symmetric-key-ref) |+--:(encrypted-private-key)| | | |+--rw encrypted-private-key| | | \ \+--rw symmetric-key-ref? leafref |+--rw (key-type)| | | | |+--:(symmetric-key-re\ \f)| | \ \ {keystore-supported}? | | | |+--rw symmetric-ke\ \y-ref? leafref| | | +--\ \:(asymmetric-key-ref) | | |{keystore-\ \supported}?| | | | \ \+--rw asymmetric-key-ref? leafref |+--:(asymmetric-key-r\ \ef)| | | | |+--rw asymmetric-k\ \ey-ref? leafref| \ \ {keystore-supported}? | | | |{keystore-\ \supported}?| | +--rw \ \value? | |+--rw value?| | | | \ \ binary | | | | | +--rw cert? | | | |end-entity-cert-cms| | end-ent\ \ity-cert-cms |+---n certificate-expiration| | | |+-- expiration-date+---n certifica\ \te-expiration | | | |yang:date-and-time| | +-- expirati\ \on-date |+---x generate-certificate-signin\ \g-request| | |+---w input| | yang\ \:date-and-time | |+---w subject binary| | | +---x generate-\ \certificate-signing-request |+---w attributes? binary| | |+--ro output| +---w input | |+--ro certificate-signing-r\ \equest| | |binary| +---w sub\ \ject |+--:(keystore) {keystore-supported}?| |+--rw keystore-reference| |+--rw asymmetric-key?| | b\ \inary |ks:asymmetric-key-ref| |+--rw certificate? leafref|+--rw client-authentication!| |+--rw (required-or-optional)+---w att\ \ributes? | | |+--:(required)| | | b\ \inary |+--rw required?| | | |empty+--ro output | | |+--:(optional)| | +--ro cer\ \tificate-signing-request |+--rw optional?| | |empty| b\ \inary |+--rw (local-or-external)| | |+--:(local)+--:(keystore) | | | |{local-client-auth-supported}?{keystore-su\ \pported}? | | | | +--rwca-certs? |keystore-ref\ \erence | | | |ts:certificates-ref+--rw asymmetri\ \c-key? | | | | |{ts:x509-certificates}?ks:asym\ \metric-key-ref | | | | +--rwclient-certs?certifica\ \te? leafref | | | +--rw client-authentication |ts:certificates-ref| | | +--rw supported-authentication-metho\ \ds |{ts:x509-certificates}?| | |+--:(external)| +--rw publickey? empty | |{external-client-auth-supporte\ \d}?| | | +--rwclient-auth-defined-elsewhere?passsword? empty | | |empty| | +--rwcert-maps |hostbased? empty |+--rw cert-to-name* [id]| |+--rw id uint32| | +--rwfingerprint | |none? empty |x509c2n:tls-fingerprint| |+--rw map-type identityref| | +--rwnameother* string |+--rw hello-params ||{tls-server-hello-params-config}?| | +--rwtls-versions(local-or-external) | | |+--rw tls-version* identityref| +--:(local) |+--rw cipher-suites| |+--rw cipher-suite* identityref|+--rw keepalives! {tls-server-keepalives}?|+--rw max-wait? uint16{local-client-auth-suppo\ \rted}? | |+--rw max-attempts? uint8 +--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)users |+--:(ssh) {ssh-call-home}?| |+--rw ssh| | +--rwtcp-client-parameters |user* [name] | |+--rw remote-address inet:host| | | +--rwremote-port? inet:port-numbername | | | |+--rw local-address? inet:ip-address| | string | |{local-binding-supported}?| | | +--rwlocal-port? inet:port-numberpassword? | | | |{local-binding-supported}?| | ianach:crypt-hash |+--rw keepalives!| | |{keepalives-supported}?| +--rw host-keys! | |+--rw idle-time uint16| | |+--rw max-probes uint16| {ts:ssh-host-key\ \s}? | |+--rw probe-interval uint16| |+--rw ssh-server-parameters| | +--rwserver-identity(local-or-trust\ \store) | | |+--rw host-key* [name]| | |+--rw name string+--:(local) | | |+--rw (host-key-type)| | |+--:(public-key)| {local-de\ \finitions-supported}? | | |+--rw public-key| | | | +--rw(local-or-keystore)local-def\ \inition | | | |+--:(local)| | | +--rw host-k\ \ey* | |{local-defin\ \itions-supported}?| | | | |+--rw local-defini\ \tionct:s\ \sh-host-key | | | | |+--rw algorithm| +--:(truststore) | | | | |asymmet\ \ric-key-algorithm-t| {truststo\ \re-supported,ssh-host-keys}? | | | | | | +--rwpublic-keytruststor\ \e-reference? | | | | | |binaryts:host\ \-keys-ref | | | | | +--rw(private-\ \key-type)ca-certs! | | | | |+--:(private\ \-key)| {sshcmn:ssh-x509\ \-certs,ts:x509-certificates}? | | | | | | +--rwpri\ \vate-key?(local-or-trust\ \store) | | | | | |b\ \inary+--:(local) | | | | | |+--:(hidden-\ \private-key)| {local-de\ \finitions-supported}? | | | | | | | +--rwhid\ \den-private-key?local-def\ \inition | | | | | |e\ \mpty| +--rw cert* | | | |+--:(encrypt\ \ed-private-key)| | | | trus\ \t-anchor-cert-cms |+--rw enc\ \rypted-private-key| | | | |+--rw \ \(key-type)| +---n certif\ \icate-expiration | | | | |+--\ \:(symmetric-key-ref)| | +-- expir\ \ation-date | | | | |\ \+--rw symmetric-key-ref? leafref| | y\ \ang:date-and-time | | | | |\ \ {keystore-supported}?| +--:(truststore) | | | | |+--\ \:(asymmetric-key-ref)| {truststo\ \re-supported,x509-certificates}? | | | | |\ \+--rw asymmetric-key-ref? leafref| +--rw truststor\ \e-reference? | | | | |\ \ {keystore-supported}?| ts:cert\ \ificates-ref | | | | | +--rw\ \value?client-certs! | | | | |\ \ binary{sshcmn:ssh-x509\ \-certs,ts:x509-certificates}? | | | |+--:(keystore)| +--rw (local-or-trust\ \store) | | |{keystore-su\ \pported}?| | +--:(local) | |+--rw keystore-ref\ \erence?| | | |ks:asymmet\ \ric-key-ref{local-de\ \finitions-supported}? | | |+--:(certificate)| | | +--rwcertificatelocal-def\ \inition | | |{sshcmn:ssh-x509-ce\ \rts}?| | | +--rw(local-or-keystore)cert* | | |+--:(local)| | | |{local-defin\ \itions-supported}?trus\ \t-anchor-cert-cms | | | |+--rw local-defini\ \tion| | +---n certif\ \icate-expiration | |+--rw algorithm| | | | +-- expir\ \ation-date |asymmet\ \ric-key-algorithm-t| | | |+--rw public-key| y\ \ang:date-and-time | | | |binary| +--:(truststore) | | |+--rw (private-\ \key-type)| | {truststo\ \re-supported,x509-certificates}? | | | |+--:(private\ \-key)| +--rw truststor\ \e-reference? | | | | |+--rw pri\ \vate-key?ts:cert\ \ificates-ref | | | | +--:(external) | | |b\ \inary| {external-client-auth-su\ \pported}? | | | |+--:(hidden-\ \private-key)+--rw client-auth-defined-else\ \where? | | | | empty | | | +--rwhid\ \den-private-key?transport-params | | | | {ssh-server-transport-params-co\ \nfig}? | |e\ \mpty| | +--rw host-key | | |+--:(encrypt\ \ed-private-key)| | +--rw host-key-alg* identityref | | | | +--rwenc\ \rypted-private-keykey-exchange | | | | | +--rw\ \(key-type)key-exchange-alg* | | | | | identityref |+--\ \:(symmetric-key-ref)| | | +--rw encryption | | | |\ \+--rw symmetric-key-ref? leafref| +--rw encryption-alg* | | | | | identityref |\ \ {keystore-supported}?| | | +--rw mac | | |+--\ \:(asymmetric-key-ref)| +--rw mac-alg* identityref | | | +--rw keepalives! | | |\ \+--rw asymmetric-key-ref? leafref{ssh-server-keepalives}? | | | +--rw max-wait? uint16 | | |\ \ {keystore-supported}?+--rw max-attempts? uint8 | | +--rw netconf-server-parameters | | +--rw client-identification | | +--rw\ \value?cert-maps | | +--rw cert-to-name* [id] | | +--rw id uint32 | | +--rw fingerprint |\ \ binary| | x509c2n:tls-fingerprint | | +--rwcert?map-type | | | identityref | | +--rw name string |end-ent\ \ity-cert-cms+--:(tls) {tls-call-home}? | +--rw tls | +--rw tcp-client-parameters | |+---n certifica\ \te-expiration+--rw remote-address inet:host | | +--rw remote-port? inet:port-number | | +--rw local-address? inet:ip-address |+-- expirati\ \on-date| | {local-binding-supported}? | | +--rw local-port? inet:port-number |yang\ \:date-and-time| | {local-binding-supported}? | |+---x generate-\ \certificate-signing-request+--rw keepalives! | | {keepalives-supported}? | |+---w input+--rw idle-time uint16 | | +--rw max-probes uint16 | | +--rw probe-interval uint16 |+---w sub\ \ject+--rw tls-server-parameters | | +--rw server-identity | | | +--rw (local-or-keystore) |b\ \inary| | +--:(local) | | |+---w att\ \ributes?| {local-definitions-suppo\ \rted}? | | | |b\ \inary+--rw local-definition | | | |+--ro output+--rw algorithm | | | |+--ro cer\ \tificate-signing-request| asymmetric-key-algo\ \rithm-t | | |b\ \inary| +--rw public-key-format? | |+--:(keystore)| | |{keystore-su\ \pported}?identityref | | |+--rw keystore-ref\ \erence| +--rw public-key | |+--rw asymmetri\ \c-key?| | | binary |ks:asym\ \metric-key-ref| | | +--rwcertifica\ \te? leafrefprivate-key-format? | |+--rw client-authentication| | |+--rw supported-authentication-metho\ \dsidentityref | | | | +--rwpublickey? empty |(private-key-type) | | |+--rw passsword? empty| | +--:(private-key) | |+--rw hostbased? empty| | | | +--rwnone? empty |private-key? | | |+--rw other* string| | |+--rw (local-or-external)binary | | |+--:(local)| | +--:(hidden-private-key) | |{local-client-auth-suppo\ \rted}?| | | | +--rwusers |hidden-private-\ \key? | | |+--rw user* [name]| | | empty |+--rw name| | | | +--:(encrypted-private-k\ \ey) |string| | | | +--rwpassword?encrypted-priva\ \te-key | | | | |ianach:crypt-hash+--rw (key-type) | | | |+--rw authorized-key*| | +--:(symmetric-\ \key-ref) | | |[name]| | | | +--rwnamesymmet\ \ric-key-ref? leafref | | | | |string| | {key\ \store-supported}? | | |+--rw algorithm| | | +--:(asymmetric\ \-key-ref) | |string| | | | +--rwkey-dataasymme\ \tric-key-ref? leafref | | | |binary| | {key\ \store-supported}? |+--:(external)| | |{external-client-auth-su\ \pported}?| +--rw value? | |+--rw client-auth-defined-else\ \where?| | |emptybinary | | | | +--rwtransport-paramscert? | | |{ssh-server-transport-params-co\ \nfig}?| | end-entity-cert-cms |+--rw host-key| | | +---n certificate-expiration |+--rw host-key-alg* identityref| | |+--rw key-exchange| +-- expiration-date | | |+--rw key-exchange-alg*| | yang:date-and-ti\ \me | |identityref| | +---x generate-certificate-\ \signing-request |+--rw encryption| | | +---w input |+--rw encryption-alg*| | | |identityref+---w subject | | |+--rw mac| | |+--rw mac-alg* identityrefbinary | |+--rw keepalives!| |{ssh-server-keepalives}?| +---w attributes? |+--rw max-wait? uint16| |+--rw max-attempts? uint8|+--:(tls) {tls-call-home}?|+--rw tlsbinary |+--rw tcp-client-parameters| |+--rw remote-address inet:host| +--ro output |+--rw remote-port? inet:port-number| |+--rw local-address? inet:ip-address| +--ro certificate-sig\ \ning-request | |{local-binding-supported}?| |+--rw local-port? inet:port-numberbinary | | |{local-binding-supported}?+--:(keystore) | |+--rw keepalives!| {keystore-supported}? |{keepalives-supported}?| | +--rwidle-time uint16keystore-reference | | | +--rwmax-probes uint16asymmetric-key? | |+--rw probe-interval uint16|+--rw tls-server-parameters|+--rw server-identityks:asymmetric-key-r\ \ef | | | +--rw(local-or-keystore)certificate? lea\ \fref | |+--:(local)+--rw client-authentication! | | |{local-definitions-suppo\ \rted}?+--rw (required-or-optional) | | |+--rw local-definition| +--:(required) | |+--rw algorithm| | | +--rw required? |asymmetric-key-algo\ \rithm-t| | |+--rw public-key| empty | | |binary| +--:(optional) | |+--rw (private-key-type)| | +--rw optional? | |+--:(private-key)| | empty | | | +--rwprivate-key?(local-or-external) | | | | +--:(local) |binary| | | |+--:(hidden-private-key){local-client-auth-suppo\ \rted}? | | | | | +--rwhidden-private-\ \key? |ca-certs! | | | |empty| | {ts:x509-certificates}? | |+--:(encrypted-private-k\ \ey)| | | | +--rwencrypted-priva\ \te-key(local-or-truststore) | | | |+--rw (key-type)| | +--:(local) | | |+--:(symmetric-\ \key-ref)| | | | {local-definiti\ \ons-supported}? | |+--rw symmet\ \ric-key-ref? leafref| | | | | +--rw local-definition |{key\ \store-supported}?| | | | |+--:(asymmetric\ \-key-ref)| +--rw cert* | | | |+--rw asymme\ \tric-key-ref? leafref| | | | trust-anch\ \or-cert-cms |{key\ \store-supported}?| | | |+--rw value?| | +---n certificate-\ \expiration | |binary| | |+--rw cert?| | +-- expiration-\ \date | |end-entity-cert-cms| | |+---n certificate-expiration| | yang:da\ \te-and-time | |+-- expiration-date| | | |yang:date-and-ti\ \me+--:(truststore) | | |+---x generate-certificate-\ \signing-request| | |+---w input{truststore-sup\ \ported,x509-certificates}? | | | |+---w subject| | +--rw truststore-refe\ \rence? | | |binary| | | ts:certificat\ \es-ref |+---w attributes?| | | |binary+--rw client-certs! | | |+--ro output| | {ts:x509-certificates}? |+--ro certificate-sig\ \ning-request| | |binary| +--rw (local-or-truststore) |+--:(keystore)| |{keystore-supported}?| |+--rw keystore-reference+--:(local) | |+--rw asymmetric-key?| | |ks:asymmetric-key-r\ \ef| {local-definiti\ \ons-supported}? |+--rw certificate? lea\ \fref|+--rw client-authentication!| |+--rw (required-or-optional)| | +--rw local-definition | |+--:(required)| | | | +--rwrequired?cert* | | | |empty| | |+--:(optional)trust-anch\ \or-cert-cms | | |+--rw optional?| | |empty+---n certificate-\ \expiration | |+--rw (local-or-external)| | |+--:(local)| +-- expiration-\ \date | | |{local-client-auth-suppo\ \rted}?| | | yang:da\ \te-and-time |+--rw ca-certs?| | | | +--:(truststore) |ts:certificates-ref| | | | {truststore-sup\ \ported,x509-certificates}? |{ts:x509-certificates}?| | | | +--rwclient-certs?truststore-refe\ \rence? | | | |ts:certificates-ref || ts:certificat\ \es-ref | |{ts:x509-certificates}? || | +--:(external) | | | | {external-client-auth-su\ \pported}? | | | | +--rw client-auth-defined-else\ \where? | | | | empty | | | +--rw cert-maps | | | +--rw cert-to-name* [id] | | | +--rw id uint32 | | | +--rw fingerprint | | | | x509c2n:tls-fingerprint | | | +--rw map-type | | | | identityref | | | +--rw name string | | +--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 max-wait? uint16 | | +--rw max-attempts? uint8 | +--rw netconf-server-parameters | +--rw client-identification | +--rw cert-maps | +--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? uint8 Appendix B. Change Log B.1. 00 to 01 o Renamed "keychain" to "keystore". B.2. 01 to 02 o 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. 02 to 03 o 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. 03 to 04 o 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. 04 to 05 o Now tree diagrams reference ietf-netmod-yang-tree-diagrams o Updated examples to inline key and certificates (no longer a leafref to keystore) B.6. 05 to 06 o 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. 06 to 07 o 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. 07 to 08 o Modified examples to be compatible with new crypto-types algs B.9. 08 to 09 o 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. 09 to 10 o Reformatted YANG modules. B.11. 10 to 11 o 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. 11 to 12 o 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. 12 to 13 o Updated to reflect changes in trust-anchors drafts (e.g., s/trust- anchors/truststore/g + s/pinned.//) B.14. 13 to 14 o 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. 14 to 15 o 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. 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, Alan Luchuk, Ladislav Lhotka, Radek Krejci, Tom Petch, Juergen Schoenwaelder, Phil Shafer, Sean Turner, and Bert Wijnen. Author's Address Kent Watsen Watsen Networks EMail: kent+ietf@watsen.net