--- 1/draft-ietf-netconf-netconf-client-server-01.txt 2017-03-13 17:13:52.050815074 -0700 +++ 2/draft-ietf-netconf-netconf-client-server-02.txt 2017-03-13 17:13:52.130816994 -0700 @@ -1,64 +1,62 @@ NETCONF Working Group K. Watsen Internet-Draft Juniper Networks Intended status: Standards Track G. Wu -Expires: May 7, 2017 Cisco Networks +Expires: September 14, 2017 Cisco Networks J. Schoenwaelder Jacobs University Bremen - November 3, 2016 + March 13, 2017 NETCONF Client and Server Models - draft-ietf-netconf-netconf-client-server-01 + draft-ietf-netconf-netconf-client-server-02 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 draft-ietf-netconf-keystore + o I-D.ietf-netconf-keystore - o draft-ietf-netconf-ssh-client-server + o I-D.ietf-netconf-ssh-client-server - o draft-ietf-netconf-tls-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 "YYYY" --> the assigned RFC value for draft-ietf-netconf-ssh- - client-server - - o "ZZZZ" --> the assigned RFC value for draft-ietf-netconf-tls- - client-server + o "YYYY" --> the assigned RFC value for I-D.ietf-netconf-ssh-client- + server - o "AAAA" --> the assigned RFC value for draft-ietf-netconf-call-home + 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 "2016-11-02" --> the publication date of this draft + o "2017-03-13" --> the publication date of this draft The following two Appendix sections are to be removed prior to publication: o Appendix A. Change Log o Appendix B. Open Issues Status of This Memo @@ -68,89 +66,91 @@ 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 http://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." - This Internet-Draft will expire on May 7, 2017. + This Internet-Draft will expire on September 14, 2017. Copyright Notice - Copyright (c) 2016 IETF Trust and the persons identified as the + Copyright (c) 2017 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 (http://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 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 4 1.2. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 4 2. The NETCONF Client Model . . . . . . . . . . . . . . . . . . 4 2.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 5 - 2.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 6 - 2.3. YANG Model . . . . . . . . . . . . . . . . . . . . . . . 8 - 3. The NETCONF Server Model . . . . . . . . . . . . . . . . . . 14 - 3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 15 - 3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 17 - 3.3. YANG Model . . . . . . . . . . . . . . . . . . . . . . . 21 - 4. Design Considerations . . . . . . . . . . . . . . . . . . . . 31 - 4.1. Support all NETCONF transports . . . . . . . . . . . . . 31 - 4.2. Enable each transport to select which keys to use . . . . 32 - 4.3. Support authenticating NETCONF clients certificates . . . 32 + 2.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 8 + 2.3. YANG Model . . . . . . . . . . . . . . . . . . . . . . . 10 + 3. The NETCONF Server Model . . . . . . . . . . . . . . . . . . 19 + 3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 20 + 3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 23 + 3.3. YANG Model . . . . . . . . . . . . . . . . . . . . . . . 26 + 4. Design Considerations . . . . . . . . . . . . . . . . . . . . 37 + 4.1. Support all NETCONF transports . . . . . . . . . . . . . 37 + 4.2. Enable each transport to select which keys to use . . . . 37 + 4.3. Support authenticating NETCONF clients certificates . . . 37 4.4. Support mapping authenticated NETCONF client certificates - to usernames . . . . . . . . . . . . . . . . . . . . . . 32 - 4.5. Support both listening for connections and call home . . 32 - 4.6. For Call Home connections . . . . . . . . . . . . . . . . 32 - 4.6.1. Support more than one NETCONF client . . . . . . . . 32 - 4.6.2. Support NETCONF clients having more than one endpoint 33 - 4.6.3. Support a reconnection strategy . . . . . . . . . . . 33 - 4.6.4. Support both persistent and periodic connections . . 33 - 4.6.5. Reconnection strategy for periodic connections . . . 33 - 4.6.6. Keep-alives for persistent connections . . . . . . . 33 - 4.6.7. Customizations for periodic connections . . . . . . . 34 - 5. Security Considerations . . . . . . . . . . . . . . . . . . . 34 - 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 34 - 6.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 34 - 6.2. The YANG Module Names Registry . . . . . . . . . . . . . 34 - 7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 35 - 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 35 - 8.1. Normative References . . . . . . . . . . . . . . . . . . 35 - 8.2. Informative References . . . . . . . . . . . . . . . . . 36 - Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 38 - A.1. server-model-09 to 00 . . . . . . . . . . . . . . . . . . 38 - Appendix B. Open Issues . . . . . . . . . . . . . . . . . . . . 38 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 38 + to usernames . . . . . . . . . . . . . . . . . . . . . . 38 + 4.5. Support both listening for connections and call home . . 38 + 4.6. For Call Home connections . . . . . . . . . . . . . . . . 38 + 4.6.1. Support more than one NETCONF client . . . . . . . . 38 + 4.6.2. Support NETCONF clients having more than one endpoint 38 + 4.6.3. Support a reconnection strategy . . . . . . . . . . . 38 + 4.6.4. Support both persistent and periodic connections . . 39 + 4.6.5. Reconnection strategy for periodic connections . . . 39 + 4.6.6. Keep-alives for persistent connections . . . . . . . 39 + 4.6.7. Customizations for periodic connections . . . . . . . 39 + 5. Security Considerations . . . . . . . . . . . . . . . . . . . 39 + 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 41 + 6.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 41 + 6.2. The YANG Module Names Registry . . . . . . . . . . . . . 41 + 7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 41 + 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 42 + 8.1. Normative References . . . . . . . . . . . . . . . . . . 42 + 8.2. Informative References . . . . . . . . . . . . . . . . . 43 + Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 44 + A.1. server-model-09 to 00 . . . . . . . . . . . . . . . . . . 44 + A.2. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 44 + A.3. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 44 + Appendix B. Open Issues . . . . . . . . . . . . . . . . . . . . 44 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 44 1. Introduction - This document defines two YANG [RFC6020] modules, one module to + This document defines two YANG [RFC7950] 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. NETCONF is defined by [RFC6241]. SSH is defined by [RFC4252], [RFC4253], and [RFC4254]. TLS is defined by [RFC5246]. NETCONF Call - Home is defined by [draft-ietf-netconf-call-home]). + Home is defined by [RFC8071]). 1.1. Terminology The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 [RFC2119]. 1.2. Tree Diagrams A simplified graphical representation of the data models is used in @@ -175,255 +175,290 @@ shown. 2. 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. This model supports both the SSH and TLS transport protocols, using the SSH client and TLS client groupings defined in - [draft-ietf-netconf-ssh-client-server] and - [draft-ietf-netconf-tls-client-server] respectively. + [I-D.ietf-netconf-ssh-client-server] and + [I-D.ietf-netconf-tls-client-server] respectively. All private keys and trusted certificates are held in the keystore - model defined in [draft-ietf-netconf-keystore]. + model defined in [I-D.ietf-netconf-keystore]. YANG feature statements are used to enable implementations to advertise which parts of the model the NETCONF client supports. 2.1. Tree Diagram Note: all lines are folded at column 71 with no '\' character. module: ietf-netconf-client +--rw netconf-client +--rw initiate {initiate}? | +--rw netconf-server* [name] | +--rw name string | +--rw (transport) - | +--:(ssh) {ssh-initiate}? - | +--rw ssh - | +--rw address inet:host - | +--rw port? inet:port-number - | +--rw server-auth - | | +--rw trusted-ssh-host-keys? -> /ks:keystore - /trusted-ssh-host-keys/name - | | +--rw trusted-ca-certs? -> /ks:keystore - /trusted-certificates/name {ssh-x509-certs}? - | | +--rw trusted-server-certs? -> /ks:keystore - /trusted-certificates/name - | +--rw client-auth - | +--rw matches* [name] - | +--rw name string - | +--rw match* [name] - | | +--rw name string - | | +--rw trusted-ssh-host-keys? -> /ks:ke - ystore/trusted-ssh-host-keys/name - | | +--rw trusted-ca-certs? -> /ks:ke - ystore/trusted-certificates/name - | | +--rw trusted-server-certs? -> /ks:ke - ystore/trusted-certificates/name - | +--rw user-auth-credentials? -> /ks:keyst - ore/user-auth-credentials/user-auth-credential/username + | | +--:(ssh) {ssh-initiate}? + | | | +--rw ssh + | | | +--rw endpoints + | | | | +--rw endpoint* [name] + | | | | +--rw name string + | | | | +--rw address inet:host + | | | | +--rw port? inet:port-number + | | | +--rw server-auth + | | | | +--rw trusted-ssh-host-keys? + | | | | | -> /ks:keystore/trusted-host-keys/name + | | | | +--rw trusted-ca-certs? leafref + | | | | | {sshcom:ssh-x509-certs}? + | | | | +--rw trusted-server-certs? leafref + | | | | {sshcom:ssh-x509-certs}? + | | | +--rw client-auth + | | | | +--rw username? string + | | | | +--rw (auth-type)? + | | | | +--:(certificate) + | | | | | +--rw certificate? leafref + | | | | | {sshcom:ssh-x509-certs}? + | | | | +--:(public-key) + | | | | | +--rw public-key? + | | | | | -> /ks:keystore/keys/key/name + | | | | +--:(password) + | | | | +--rw password? union + | | | +--rw transport-params + | | | {ssh-client-transport-params-config}? + | | | +--rw host-key + | | | | +--rw host-key-alg* identityref + | | | +--rw key-exchange + | | | | +--rw key-exchange-alg* identityref + | | | +--rw encryption + | | | | +--rw encryption-alg* identityref + | | | +--rw mac + | | | | +--rw mac-alg* identityref + | | | +--rw compression + | | | +--rw compression-alg* identityref + | | +--:(tls) {tls-initiate}? + | | +--rw tls + | | +--rw endpoints + | | | +--rw endpoint* [name] + | | | +--rw name string + | | | +--rw address inet:host + | | | +--rw port? inet:port-number + | | +--rw server-auth + | | | +--rw trusted-ca-certs? leafref + | | | +--rw trusted-server-certs? leafref + | | +--rw client-auth + | | | +--rw (auth-type)? + | | | +--:(certificate) + | | | +--rw certificate? leafref + | | +--rw hello-params + | | {tls-client-hello-params-config}? + | | +--rw tls-versions + | | | +--rw tls-version* identityref + | | +--rw cipher-suites + | | +--rw cipher-suite* identityref + | +--rw connection-type + | | +--rw (connection-type)? + | | +--:(persistent-connection) + | | | +--rw persistent! + | | | +--rw idle-timeout? uint32 + | | | +--rw keep-alives + | | | +--rw max-wait? uint16 + | | | +--rw max-attempts? uint8 + | | +--:(periodic-connection) + | | +--rw periodic! + | | +--rw idle-timeout? uint16 + | | +--rw reconnect-timeout? uint16 + | +--rw reconnect-strategy + | +--rw start-with? enumeration + | +--rw max-attempts? uint8 +--rw listen {listen}? +--rw max-sessions? uint16 +--rw idle-timeout? uint16 +--rw endpoint* [name] +--rw name string +--rw (transport) +--:(ssh) {ssh-listen}? - +--rw ssh + | +--rw ssh + | +--rw address? inet:ip-address + | +--rw port? inet:port-number + | +--rw server-auth + | | +--rw trusted-ssh-host-keys? + | | | -> /ks:keystore/trusted-host-keys/name + | | +--rw trusted-ca-certs? leafref + | | | {sshcom:ssh-x509-certs}? + | | +--rw trusted-server-certs? leafref + | | {sshcom:ssh-x509-certs}? + | +--rw client-auth + | | +--rw username? string + | | +--rw (auth-type)? + | | +--:(certificate) + | | | +--rw certificate? leafref + | | | {sshcom:ssh-x509-certs}? + | | +--:(public-key) + | | | +--rw public-key? + | | | -> /ks:keystore/keys/key/name + | | +--:(password) + | | +--rw password? union + | +--rw transport-params + | {ssh-client-transport-params-config}? + | +--rw host-key + | | +--rw host-key-alg* identityref + | +--rw key-exchange + | | +--rw key-exchange-alg* identityref + | +--rw encryption + | | +--rw encryption-alg* identityref + | +--rw mac + | | +--rw mac-alg* identityref + | +--rw compression + | +--rw compression-alg* identityref + +--:(tls) {tls-listen}? + +--rw tls +--rw address? inet:ip-address +--rw port? inet:port-number +--rw server-auth - | +--rw trusted-ssh-host-keys? -> /ks:keystore - /trusted-ssh-host-keys/name - | +--rw trusted-ca-certs? -> /ks:keystore - /trusted-certificates/name {ssh-x509-certs}? - | +--rw trusted-server-certs? -> /ks:keystore - /trusted-certificates/name + | +--rw trusted-ca-certs? leafref + | +--rw trusted-server-certs? leafref +--rw client-auth - +--rw matches* [name] - +--rw name string - +--rw match* [name] - | +--rw name string - | +--rw trusted-ssh-host-keys? -> /ks:ke - ystore/trusted-ssh-host-keys/name - | +--rw trusted-ca-certs? -> /ks:ke - ystore/trusted-certificates/name - | +--rw trusted-server-certs? -> /ks:ke - ystore/trusted-certificates/name - +--rw user-auth-credentials? -> /ks:keyst - ore/user-auth-credentials/user-auth-credential/username + | +--rw (auth-type)? + | +--:(certificate) + | +--rw certificate? leafref + +--rw hello-params + {tls-client-hello-params-config}? + +--rw tls-versions + | +--rw tls-version* identityref + +--rw cipher-suites + +--rw cipher-suite* identityref 2.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.2 - of [draft-ietf-netconf-keystore]. + of [I-D.ietf-netconf-keystore]. - + corp-fw1 + + + corp-fw1.example.com
corp-fw1.example.com
+ + + corp-fw2.example.com +
corp-fw2.example.com
+ + - - deployment-specific-ca-certs - + deployment-specific-ca-certs - - - - deployment-specific-ca-certs - - - Bob - + foobar + ex-rsa-key Intranet-facing listener
11.22.33.44
- - deployment-specific-ca-certs - - - explicitly-trusted-server-certs - - - explicitly-trusted-ssh-host-keys - + deployment-specific-ca-certs + explicitly-trusted-server-certs + explicitly-trusted-ssh-host-keys - - - - deployment-specific-ca-certs - - - admin - - - - - explicitly-trusted-server-certs - - - admin - - - - - explicitly-trusted-ssh-host-keys - - - - admin - + foobar + ex-rsa-key - 2.3. YANG Model This YANG module imports YANG types from [RFC6991] and [RFC7407]. - file "ietf-netconf-client@2016-11-02.yang" + file "ietf-netconf-client@2017-03-13.yang" module ietf-netconf-client { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-client"; prefix "ncc"; import ietf-inet-types { prefix inet; 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-ssh-client { prefix ss; - revision-date 2016-11-02; // stable grouping definitions + revision-date 2017-03-13; // stable grouping definitions reference "RFC YYYY: SSH Client and Server Models"; } - // import ietf-tls-client { - // prefix ts; - // revision-date 2016-11-02; // stable grouping definitions - // reference - // "RFC ZZZZ: TLS Client and Server Models"; - // } + import ietf-tls-client { + prefix ts; + revision-date 2017-03-13; // stable grouping definitions + reference + "RFC ZZZZ: TLS Client and Server Models"; + } + organization "IETF NETCONF (Network Configuration) Working Group"; contact "WG Web: WG List: - WG Chair: Mehmet Ersue - - - WG Chair: Mahesh Jethanandani - - Author: Kent Watsen Author: Gary Wu "; description "This module contains a collection of YANG definitions for - configuring NETCONF servers. + configuring NETCONF clients. Copyright (c) 2014 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 (http://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX; see the RFC itself for full legal notices."; - revision "2016-11-02" { + revision "2017-03-13" { description "Initial version"; reference "RFC XXXX: NETCONF Client and Server Models"; } // Features feature initiate { description @@ -457,39 +493,40 @@ home connections using at least one transport (e.g., SSH, TLS, etc.)."; } 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 AAAA: NETCONF Call Home and RESTCONF Call Home"; + "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 AAAA: NETCONF Call Home and RESTCONF Call Home"; + "RFC 8071: NETCONF Call Home and RESTCONF Call Home"; } + container netconf-client { description "Top-level container for NETCONF client configuration."; container initiate { if-feature initiate; description - "Configures client intiating underlying TCP connections."; + "Configures client initiating underlying TCP connections."; list netconf-server { key name; description "List of NETCONF servers the NETCONF client is to initiate connections to."; leaf name { type string; description "An arbitrary name for the NETCONF server."; } @@ -490,85 +527,218 @@ connections to."; leaf name { type string; description "An arbitrary name for the NETCONF server."; } choice transport { mandatory true; description "Selects between available transports."; + case ssh { if-feature ssh-initiate; container ssh { description "Specifies SSH-specific transport configuration."; - leaf address { - type inet:host; - mandatory true; - description - "The IP address or hostname of the endpoint. If - a hostname is configured and the DNS resolution - results in more than one IP address, the NETCONF - client will process the IP addresses as if they - had been explicitly configured in place of the - hostname."; - } - leaf port { - type inet:port-number; + uses endpoints-container { + refine endpoints/endpoint/port { default 830; - description - "The IP port for this endpoint. The NETCONF client - will use the IANA-assigned well-known port if no - value is specified."; } - uses ss:initiating-ssh-client-grouping; } - + uses ss:ssh-client-grouping; } - /* + } // end ssh + case tls { if-feature tls-initiate; container tls { description "Specifies TLS-specific transport configuration."; uses endpoints-container { refine endpoints/endpoint/port { default 6513; } } - uses ts:listening-tls-client-grouping { - augment "client-auth" { + uses ts:tls-client-grouping; + } + } // end tls + + } // end transport + + container connection-type { description - "Augments in the cert-to-name structure."; - uses cert-maps-grouping; + "Indicates the kind of connection to use."; + choice connection-type { + description + "Selects between available connection types."; + case persistent-connection { + container persistent { + presence true; + description + "Maintain a persistent connection to the NETCONF + server. If the connection goes down, immediately + start trying to reconnect to it, using the + reconnection strategy. + + This connection type minimizes any NETCONF server + to NETCONF client data-transfer delay, albeit at + the expense of holding resources longer."; + leaf idle-timeout { + type uint32; + units "seconds"; + default 86400; // one day; + description + "Specifies the maximum number of seconds that a + a NETCONF session may remain idle. A NETCONF + session will be dropped if it is idle for an + interval longer than this number of seconds. + If set to zero, then the client will never drop + a session because it is idle. Sessions that + have a notification subscription active are + never dropped."; } + container keep-alives { + description + "Configures the keep-alive policy, to proactively + test the aliveness of the SSH/TLS server. An + unresponsive SSH/TLS server will be dropped after + approximately max-attempts * max-wait seconds."; + reference + "RFC 8071: NETCONF Call Home and RESTCONF Call + Home, Section 3.1, item S6"; + leaf max-wait { + type uint16 { + range "1..max"; } + units seconds; + default 30; + description + "Sets the amount of time in seconds after which + if no data has been received from the SSH/TLS + server, a SSH/TLS-level message will be sent + to test the aliveness of the SSH/TLS server."; + } + leaf max-attempts { + type uint8; + default 3; + description + "Sets the maximum number of sequential keep-alive + messages that can fail to obtain a response from + the SSH/TLS server before assuming the SSH/TLS + server is no longer alive."; } } - */ + } } + case periodic-connection { + container periodic { + presence true; + description + "Periodically connect to the NETCONF server, so that + the NETCONF server may deliver messages pending for + the NETCONF client. The NETCONF server must close + the connection when it is ready to release it. Once + the connection has been closed, the NETCONF client + will restart its timer until the next connection."; + leaf idle-timeout { + type uint16; + units "seconds"; + default 300; // five minutes + description + "Specifies the maximum number of seconds that a + a NETCONF session may remain idle. A NETCONF + session will be dropped if it is idle for an + interval longer than this number of seconds. + If set to zero, then the server will never drop + a session because it is idle. Sessions that + have a notification subscription active are + never dropped."; + } + leaf reconnect-timeout { + type uint16 { + range "1..max"; + } + units minutes; + default 60; + description + "Sets the maximum amount of unconnected time the + NETCONF client will wait before re-establishing + a connection to the NETCONF server. The NETCONF + client may initiate a connection before this + time if desired (e.g., to set configuration)."; + } + } + } + } + } + container reconnect-strategy { + description + "The reconnection strategy directs how a NETCONF client + reconnects to a NETCONF server, after discovering its + connection to the server has dropped, even if due to a + reboot. The NETCONF client starts with the specified + endpoint and tries to connect to it max-attempts times + before trying the next endpoint in the list (round + robin)."; + leaf start-with { + type enumeration { + enum first-listed { + description + "Indicates that reconnections should start with + the first endpoint listed."; + } + enum last-connected { + description + "Indicates that reconnections should start with + the endpoint last connected to. If no previous + connection has ever been established, then the + first endpoint configured is used. NETCONF + clients SHOULD be able to remember the last + endpoint connected to across reboots."; + } + } + default first-listed; + description + "Specifies which of the NETCONF server's endpoints the + NETCONF client should start with when trying to connect + to the NETCONF server."; + } + 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 to the + next endpoint in the list (round robin)."; + } + } + } // end netconf-server } // end initiate container listen { if-feature listen; description "Configures client accepting call-home TCP connections."; + leaf max-sessions { type uint16; default 0; description "Specifies the maximum number of concurrent sessions that can be active at one time. The value 0 indicates that no artificial session limit should be used."; } + leaf idle-timeout { type uint16; units "seconds"; default 3600; // one hour description "Specifies the maximum number of seconds that a NETCONF session may remain idle. A NETCONF session will be dropped if it is idle for an interval longer than this number of seconds. If set to zero, then the server will never drop a session because it is idle. Sessions that have a @@ -567,89 +737,122 @@ units "seconds"; default 3600; // one hour description "Specifies the maximum number of seconds that a NETCONF session may remain idle. A NETCONF session will be dropped if it is idle for an interval longer than this number of seconds. If set to zero, then the server will never drop a session because it is idle. Sessions that have a notification subscription active are never dropped."; } + list endpoint { key name; description - "List of endpoints to listen for NETCONF connections on."; + "List of endpoints to listen for NETCONF connections."; 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."; - uses ss:listening-ssh-client-grouping { - refine port { - default 4334; + leaf address { + type inet:ip-address; + description + "The IP address to listen for call-home connections."; } + leaf port { + type inet:port-number; + default 4334; + description + "The port number to listen for call-home connections."; } + uses ss:ssh-client-grouping; } } - /* case tls { if-feature tls-listen; container tls { description "TLS-specific listening configuration for inbound connections."; - uses ts:listening-tls-client-grouping { - refine port { - default 4335; - } - augment "client-auth" { + leaf address { + type inet:ip-address; description - "Augments in the cert-to-name structure."; - uses cert-maps-grouping; - } - } + "The IP address to listen for call-home connections."; } + leaf port { + type inet:port-number; + default 4335; + description + "The port number to listen for call-home connections."; } - */ + uses ts:tls-client-grouping; } } + } // end transport + } // end endpoint } // end listen - } - grouping cert-maps-grouping { + } // end netconf-client + + grouping endpoints-container { description - "A grouping that defines a container around the - cert-to-name structure defined in RFC 7407."; - container cert-maps { - uses x509c2n:cert-to-name; + "This grouping is used to configure a set of NETCONF servers + a NETCONF client may initiate connections to."; + container endpoints { description - "The cert-maps container is used by a TLS-based NETCONF - server 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 - "RFC WWWW: NETCONF over TLS, Section 7"; + "Container for the list of endpoints."; + list endpoint { + key name; + unique "address port"; + min-elements 1; + ordered-by user; + description + "A non-empty user-ordered list of endpoints for this NETCONF + client to try to connect to. Defining more than one enables + high-availability."; + + leaf name { + type string; + description + "An arbitrary name for this endpoint."; + } + leaf address { + type inet:host; + mandatory true; + description + "The IP address or hostname of the endpoint. If a + hostname is configured and the DNS resolution results + in more than one IP address, the NETCONF client + will process the IP addresses as if they had been + explicitly configured in place of the hostname."; + } + leaf port { + type inet:port-number; + description + "The IP port for this endpoint. The NETCONF client will + use the IANA-assigned well-known port (set via a refine + statement when uses) if no value is specified."; + } + } } } - } 3. The NETCONF Server Model The NETCONF server model presented in this section supports servers both listening for connections as well as initiating call-home connections. @@ -646,27 +849,27 @@ } 3. The NETCONF Server Model The NETCONF server model presented in this section supports servers both listening for connections as well as initiating call-home connections. - This model also supports both the SSH and TLS transport protocols, - using the SSH server and TLS server groupings defined in - [draft-ietf-netconf-ssh-client-server] and - [draft-ietf-netconf-tls-client-server] respectively. + This model supports both the SSH and TLS transport protocols, using + the SSH server and TLS server groupings defined in + [I-D.ietf-netconf-ssh-client-server] and + [I-D.ietf-netconf-tls-client-server] respectively. All private keys and trusted certificates are held in the keystore - model defined in [draft-ietf-netconf-keystore]. + model defined in [I-D.ietf-netconf-keystore]. YANG feature statements are used to enable implementations to advertise which parts of the model the NETCONF server supports. 3.1. Tree Diagram Note: all lines are folded at column 71 with no '\' character. module: ietf-netconf-server +--rw netconf-server @@ -680,171 +883,187 @@ | +--rw (transport) | +--:(ssh) {ssh-listen}? | | +--rw ssh | | +--rw address? inet:ip-address | | +--rw port? inet:port-number | | +--rw host-keys | | | +--rw host-key* [name] | | | +--rw name string | | | +--rw (host-key-type) | | | +--:(public-key) - | | | | +--rw public-key? -> /ks:keystore/ - private-keys/private-key/name + | | | | +--rw public-key? + | | | | -> /ks:keystore/keys/key/name | | | +--:(certificate) - | | | +--rw certificate? -> /ks:keystore/ - private-keys/private-key/certificate-chains/certificate-chain/name {ssh - -x509-certs}? - | | +--rw client-cert-auth {ssh-x509-certs}? - | | +--rw trusted-ca-certs? -> /ks:keystore/ - trusted-certificates/name - | | +--rw trusted-client-certs? -> /ks:keystore/ - trusted-certificates/name + | | | +--rw certificate? leafref + | | | {sshcom:ssh-x509-certs}? + | | +--rw client-cert-auth {sshcom:ssh-x509-certs}? + | | | +--rw trusted-ca-certs? leafref + | | | +--rw trusted-client-certs? leafref + | | +--rw transport-params + | | {ssh-server-transport-params-config}? + | | +--rw host-key + | | | +--rw host-key-alg* identityref + | | +--rw key-exchange + | | | +--rw key-exchange-alg* identityref + | | +--rw encryption + | | | +--rw encryption-alg* identityref + | | +--rw mac + | | | +--rw mac-alg* identityref + | | +--rw compression + | | +--rw compression-alg* identityref | +--:(tls) {tls-listen}? | +--rw tls | +--rw address? inet:ip-address | +--rw port? inet:port-number | +--rw certificates | | +--rw certificate* [name] - | | +--rw name -> /ks:keystore/private-keys/ - private-key/certificate-chains/certificate-chain/name + | | +--rw name leafref | +--rw client-auth - | +--rw trusted-ca-certs? -> /ks:keystore/ - trusted-certificates/name - | +--rw trusted-client-certs? -> /ks:keystore/ - trusted-certificates/name - | +--rw cert-maps - | +--rw cert-to-name* [id] - | +--rw id uint32 - | +--rw fingerprint x509c2n:tls-fingerp - rint - | +--rw map-type identityref - | +--rw name string + | | +--rw trusted-ca-certs? leafref + | | +--rw trusted-client-certs? leafref + | | +--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 call-home {call-home}? +--rw netconf-client* [name] +--rw name string +--rw (transport) | +--:(ssh) {ssh-call-home}? | | +--rw ssh | | +--rw endpoints | | | +--rw endpoint* [name] | | | +--rw name string | | | +--rw address inet:host | | | +--rw port? inet:port-number | | +--rw host-keys | | | +--rw host-key* [name] | | | +--rw name string | | | +--rw (host-key-type) | | | +--:(public-key) - | | | | +--rw public-key? -> /ks:keystore/ - private-keys/private-key/name + | | | | +--rw public-key? + | | | | -> /ks:keystore/keys/key/name | | | +--:(certificate) - | | | +--rw certificate? -> /ks:keystore/ - private-keys/private-key/certificate-chains/certificate-chain/name {ssh - -x509-certs}? - | | +--rw client-cert-auth {ssh-x509-certs}? - | | +--rw trusted-ca-certs? -> /ks:keystore/ - trusted-certificates/name - | | +--rw trusted-client-certs? -> /ks:keystore/ - trusted-certificates/name + | | | +--rw certificate? leafref + | | | {sshcom:ssh-x509-certs}? + | | +--rw client-cert-auth {sshcom:ssh-x509-certs}? + | | | +--rw trusted-ca-certs? leafref + | | | +--rw trusted-client-certs? leafref + | | +--rw transport-params + | | {ssh-server-transport-params-config}? + | | +--rw host-key + | | | +--rw host-key-alg* identityref + | | +--rw key-exchange + | | | +--rw key-exchange-alg* identityref + | | +--rw encryption + | | | +--rw encryption-alg* identityref + | | +--rw mac + | | | +--rw mac-alg* identityref + | | +--rw compression + | | +--rw compression-alg* identityref | +--:(tls) {tls-call-home}? | +--rw tls | +--rw endpoints | | +--rw endpoint* [name] | | +--rw name string | | +--rw address inet:host | | +--rw port? inet:port-number | +--rw certificates | | +--rw certificate* [name] - | | +--rw name -> /ks:keystore/private-keys/ - private-key/certificate-chains/certificate-chain/name + | | +--rw name leafref | +--rw client-auth - | +--rw trusted-ca-certs? -> /ks:keystore/ - trusted-certificates/name - | +--rw trusted-client-certs? -> /ks:keystore/ - - trusted-certificates/name - | +--rw cert-maps - | +--rw cert-to-name* [id] - | +--rw id uint32 - | +--rw fingerprint x509c2n:tls-fingerp - rint - | +--rw map-type identityref - | +--rw name string + | | +--rw trusted-ca-certs? leafref + | | +--rw trusted-client-certs? leafref + | | +--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 connection-type | +--rw (connection-type)? | +--:(persistent-connection) | | +--rw persistent! | | +--rw idle-timeout? uint32 | | +--rw keep-alives | | +--rw max-wait? uint16 | | +--rw max-attempts? uint8 | +--:(periodic-connection) | +--rw periodic! | +--rw idle-timeout? uint16 - | +--rw reconnect_timeout? uint16 + | +--rw reconnect-timeout? uint16 +--rw reconnect-strategy +--rw start-with? enumeration +--rw max-attempts? uint8 3.2. Example Usage The following example illustrates configuring a NETCONF server to listen for NETCONF client connections using both the SSH and TLS transport protocols, as well as configuring call-home to two NETCONF clients, one using SSH and the other using TLS. This example is consistent with the examples presented in Section 2.2 - of [draft-ietf-netconf-keystore]. + of [I-D.ietf-netconf-keystore]. - + xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-server" + xmlns:x509c2n="urn:ietf:params:xml:ns:yang:ietf-x509-cert-to-name"> - - + + + netconf/ssh
11.22.33.44
- my-rsa-key + public-key + ex-rsa-key - TPM key + certificate + builtin-idevid-cert - - deployment-specific-ca-certs - - - explicitly-trusted-client-certs - + deployment-specific-ca-certs + explicitly-trusted-client-certs - - - + netconf/tls
11.22.33.44
- ex-key-sect571r1-cert + + tls-ec-cert + - - deployment-specific-ca-certs - - - explicitly-trusted-client-certs - + deployment-specific-ca-certs + explicitly-trusted-client-certs 1 11:0A:05:11:00 x509c2n:san-any 2 B3:4F:A1:8C:54 x509c2n:specified @@ -847,88 +1066,81 @@ 2 B3:4F:A1:8C:54 x509c2n:specified scooby-doo - + + - - + config-mgr east-data-center
11.22.33.44
 west-data-center
55.66.77.88
 - TPM key + certificate + builtin-idevid-cert - - deployment-specific-ca-certs - - - explicitly-trusted-client-certs - + deployment-specific-ca-certs + explicitly-trusted-client-certs 300 60 + last-connected 3 - - - + event-correlator east-data-center
22.33.44.55
- west-data-center
33.44.55.66
 - ex-key-sect571r1-cert + + tls-ec-cert + - - deployment-specific-ca-certs - - - explicitly-trusted-client-certs - + deployment-specific-ca-certs + explicitly-trusted-client-certs 1 11:0A:05:11:00 x509c2n:san-any 2 B3:4F:A1:8C:54 x509c2n:specified @@ -944,29 +1156,28 @@ 30 3 first-listed 3 - 3.3. YANG Model This YANG module imports YANG types from [RFC6991] and [RFC7407]. - file "ietf-netconf-server@2016-11-02.yang" + file "ietf-netconf-server@2017-03-13.yang" module ietf-netconf-server { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-server"; prefix "ncs"; import ietf-inet-types { prefix inet; reference @@ -974,66 +1185,60 @@ } import ietf-x509-cert-to-name { prefix x509c2n; reference "RFC 7407: A YANG Data Model for SNMP Configuration"; } import ietf-ssh-server { prefix ss; - revision-date 2016-11-02; // stable grouping definitions + revision-date 2017-03-13; // stable grouping definitions reference "RFC YYYY: SSH Client and Server Models"; } import ietf-tls-server { prefix ts; - revision-date 2016-11-02; // stable grouping definitions + revision-date 2017-03-13; // stable grouping definitions reference "RFC ZZZZ: TLS Client and Server Models"; } organization "IETF NETCONF (Network Configuration) Working Group"; contact "WG Web: WG List: - WG Chair: Mehmet Ersue - - - WG Chair: Mahesh Jethanandani - - - Editor: Kent Watsen + Author: Kent Watsen "; description "This module contains a collection of YANG definitions for configuring NETCONF servers. Copyright (c) 2014 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 (http://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX; see the RFC itself for full legal notices."; - revision "2016-11-02" { + revision "2017-03-13" { description "Initial version"; reference "RFC XXXX: NETCONF Client and Server Models"; } // Features feature listen { description @@ -1062,39 +1265,39 @@ Layer Security (TLS) with Mutual X.509 Authentication"; } feature call-home { description "The 'call-home' feature indicates that the NETCONF server supports initiating NETCONF call home connections to NETCONF clients using at least one transport (e.g., SSH, TLS, etc.)."; reference - "RFC YYYY: NETCONF Call Home and RESTCONF Call Home"; + "RFC 8071: NETCONF Call Home and RESTCONF Call Home"; } feature ssh-call-home { description "The 'ssh-call-home' feature indicates that the NETCONF server supports initiating a NETCONF over SSH call home connection to NETCONF clients."; reference - "RFC YYYY: NETCONF Call Home and RESTCONF Call Home"; + "RFC 8071: NETCONF Call Home and RESTCONF Call Home"; } feature tls-call-home { description "The 'tls-call-home' feature indicates that the NETCONF server supports initiating a NETCONF over TLS call home connection to NETCONF clients."; reference - "RFC YYYY: NETCONF Call Home and RESTCONF Call Home"; + "RFC 8071: NETCONF Call Home and RESTCONF Call Home"; } // top-level container (groupings below) container netconf-server { description "Top-level container for NETCONF server configuration."; container session-options { // SHOULD WE REMOVE THIS ALTOGETHER? description "NETCONF session options, independent of transport @@ -1133,27 +1336,27 @@ "Specifies the maximum number of seconds that a NETCONF session may remain idle. A NETCONF session will be dropped if it is idle for an interval longer than this number of seconds. If set to zero, then the server will never drop a session because it is idle. Sessions that have a notification subscription active are never dropped."; } list endpoint { key name; description - "List of endpoints to listen for NETCONF connections on."; + "List of endpoints to listen for NETCONF connections."; 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."; @@ -1150,37 +1353,60 @@ 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."; - uses ss:listening-ssh-server-grouping { - refine port { - default 830; + leaf address { + type inet:ip-address; + description + "The IP address of the interface to listen on. The + SSH server will listen on all interfaces if no value + is specified. Please note that some addresses have + special meanings (e.g., '0.0.0.0' and '::')."; } + leaf port { + type inet:port-number; + default 830; + description + "The local port number on this interface the SSH server + listens on."; } + uses ss:ssh-server-grouping; } } case tls { if-feature tls-listen; container tls { description "TLS-specific listening configuration for inbound connections."; - uses ts:listening-tls-server-grouping { - refine port { + leaf address { + type inet:ip-address; + description + "The IP address of the interface to listen on. The + TLS server will listen on all interfaces if no value + is specified. Please note that some addresses have + special meanings (e.g., '0.0.0.0' and '::')."; + } + leaf port { + type inet:port-number; default 6513; + description + "The local port number on this interface the TLS server + listens on."; } + uses ts:tls-server-grouping { augment "client-auth" { description "Augments in the cert-to-name structure."; uses cert-maps-grouping; } } } } } } @@ -1208,35 +1434,35 @@ if-feature ssh-call-home; container ssh { description "Specifies SSH-specific call-home transport configuration."; uses endpoints-container { refine endpoints/endpoint/port { default 4334; } } - uses ss:non-listening-ssh-server-grouping; + uses ss:ssh-server-grouping; } } case tls { if-feature tls-call-home; container tls { description "Specifies TLS-specific call-home transport configuration."; uses endpoints-container { refine endpoints/endpoint/port { default 4335; } } - uses ts:non-listening-tls-server-grouping { + uses ts:tls-server-grouping { augment "client-auth" { description "Augments in the cert-to-name structure."; uses cert-maps-grouping; } } } } } container connection-type { @@ -1272,21 +1497,21 @@ have a notification subscription active are never dropped."; } container keep-alives { description "Configures the keep-alive policy, to proactively test the aliveness of the SSH/TLS client. An unresponsive SSH/TLS client will be dropped after approximately max-attempts * max-wait seconds."; reference - "RFC YYYY: NETCONF Call Home and RESTCONF Call + "RFC 8071: NETCONF Call Home and RESTCONF Call Home, Section 3.1, item S6"; leaf max-wait { type uint16 { range "1..max"; } units seconds; default 30; description "Sets the amount of time in seconds after which if no data has been received from the SSH/TLS @@ -1322,21 +1547,21 @@ description "Specifies the maximum number of seconds that a a NETCONF session may remain idle. A NETCONF session will be dropped if it is idle for an interval longer than this number of seconds. If set to zero, then the server will never drop a session because it is idle. Sessions that have a notification subscription active are never dropped."; } - leaf reconnect_timeout { + leaf reconnect-timeout { type uint16 { range "1..max"; } units minutes; default 60; description "Sets the maximum amount of unconnected time the NETCONF server will wait before re-establishing a connection to the NETCONF client. The NETCONF server may initiate a connection before this @@ -1407,54 +1633,57 @@ valid cert-to-name list entry can be found, then the NETCONF server MUST close the connection, and MUST NOT accept NETCONF messages over it."; reference "RFC WWWW: NETCONF over TLS, Section 7"; } } grouping endpoints-container { description - "This grouping is used by both the ssh and tls containers - for call-home configurations."; + "This grouping is used to configure a set of NETCONF clients + a NETCONF server may initiate call-home connections to."; container endpoints { description "Container for the list of endpoints."; list endpoint { key name; + unique "address port"; min-elements 1; ordered-by user; description - "User-ordered list of endpoints for this NETCONF client. - Defining more than one enables high-availability."; + "A non-empty user-ordered list of endpoints for this NETCONF + server to try to connect to. Defining more than one enables + high-availability."; leaf name { type string; description "An arbitrary name for this endpoint."; } leaf address { type inet:host; mandatory true; description "The IP address or hostname of the endpoint. If a hostname is configured and the DNS resolution results in more than one IP address, the NETCONF server will process the IP addresses as if they had been explicitly configured in place of the hostname."; } leaf port { type inet:port-number; description "The IP port for this endpoint. The NETCONF server will - use the IANA-assigned well-known port if no value is - specified."; + use the IANA-assigned well-known port (set via a refine + statement when uses) if no value is specified."; } + } } } } 4. Design Considerations @@ -1500,28 +1729,27 @@ When a client certificate is used for TLS client authentication, the NETCONF server must be able to derive a username from the authenticated certificate. Thus the modules defined herein should enable this mapping to be configured. 4.5. Support both listening for connections and call home The NETCONF protocols were originally defined as having the server opening a port to listen for client connections. More recently the - NETCONF working group defined support for call-home - ([draft-ietf-netconf-call-home]), enabling the server to initiate the - connection to the client. Thus the modules defined herein should - enable configuration for both listening for connections and calling - home. Because implementations may not support both listening for - connections and calling home, YANG "feature" statements should be - used so that implementation can accurately advertise the connection - types it supports. + NETCONF working group defined support for call-home ([RFC8071]), + enabling the server to initiate the connection to the client. Thus + the modules defined herein should enable configuration for both + listening for connections and calling home. Because implementations + may not support both listening for connections and calling home, YANG + "feature" statements should be used so that implementation can + accurately advertise the connection types it supports. 4.6. For Call Home connections The following objectives only pertain to call home connections. 4.6.1. Support more than one NETCONF client A NETCONF server may be managed by more than one NETCONF client. For instance, a deployment may have one client for provisioning and another for fault monitoring. Therefore, when it is desired for a @@ -1588,40 +1816,81 @@ 5. Security Considerations A denial of service (DoS) attack MAY occur if the NETCONF server limits the maximum number of NETCONF sessions it will accept (i.e. the 'max-sessions' field in the ietf-netconf-server module is not zero) and either the "hello-timeout" or "idle-timeout" fields in ietf-netconf-server module have been set to indicate the NETCONF server should wait forever (i.e. set to zero). + The YANG module defined in this document uses groupings defined in + [I-D.ietf-netconf-ssh-client-server] and + [I-D.ietf-netconf-tls-client-server]. Please see the Security + Considerations section in those documents for concerns related those + groupings. + + The YANG module defined in this document is designed to be accessed + via YANG based management protocols, such as NETCONF [RFC6241] and + RESTCONF [RFC8040]. Both of these protocols have mandatory-to- + implement secure transport layers (e.g., SSH, TLS) with mutual + authentication. + + The NETCONF access control model (NACM) [RFC6536] 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 this YANG module that are + writable/creatable/deletable (i.e., config true, which is the + default). These data nodes may be considered sensitive or vulnerable + in some network environments. Write operations (e.g., edit-config) + to these data nodes without proper protection can have a negative + effect on network operations. These are the subtrees and data nodes + and their sensitivity/vulnerability: + + NONE + + Some of the readable data nodes in this YANG module 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 + + Some of the RPC operations in this YANG module 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: + + NONE + 6. IANA Considerations 6.1. The IETF XML Registry - This document registers two URIs in the IETF XML registry [RFC2119]. + This document registers two URIs in 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 + registry [RFC7950]. Following the format in [RFC7950], 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 @@ -1636,48 +1905,39 @@ and Bert Wijnen. Juergen Schoenwaelder and was partly funded by Flamingo, a Network of Excellence project (ICT-318488) supported by the European Commission under its Seventh Framework Programme. 8. References 8.1. Normative References - [draft-ietf-netconf-keystore] - Watsen, K., "Keystore Model", draft-ieft-netconf- - keystore-00 (work in progress), 2016, - . + [I-D.ietf-netconf-keystore] + Watsen, K. and G. Wu, "Keystore Model", draft-ietf- + netconf-keystore-00 (work in progress), October 2016. - [draft-ietf-netconf-ssh-client-server] - Watsen, K., "SSH Client and Server Models", draft-ieft- - netconf-ssh-client-server-00 (work in progress), 2016, - . + [I-D.ietf-netconf-ssh-client-server] + Watsen, K. and G. Wu, "SSH Client and Server Models", + draft-ietf-netconf-ssh-client-server-01 (work in + progress), November 2016. - [draft-ietf-netconf-tls-client-server] - Watsen, K., "TLS Client and Server Models", draft-ieft- - netconf-tls-client-server-00 (work in progress), 2016, - . + [I-D.ietf-netconf-tls-client-server] + Watsen, K., "TLS Client and Server Models", draft-ietf- + netconf-tls-client-server-01 (work in progress), November + 2016. [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . - [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for - the Network Configuration Protocol (NETCONF)", RFC 6020, - DOI 10.17487/RFC6020, October 2010, - . - [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, . [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, . [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", @@ -1687,27 +1947,25 @@ [RFC7407] Bjorklund, M. and J. Schoenwaelder, "A YANG Data Model for SNMP Configuration", RFC 7407, DOI 10.17487/RFC7407, December 2014, . [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, . -8.2. Informative References + [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", + RFC 7950, DOI 10.17487/RFC7950, August 2016, + . - [draft-ietf-netconf-call-home] - Watsen, K., "NETCONF Call Home and RESTCONF Call Home", - draft-ieft-netconf-call-home-17 (work in progress), 2015, - . +8.2. Informative References [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, . [RFC4252] Ylonen, T. and C. Lonvick, Ed., "The Secure Shell (SSH) Authentication Protocol", RFC 4252, DOI 10.17487/RFC4252, January 2006, . [RFC4253] Ylonen, T. and C. Lonvick, Ed., "The Secure Shell (SSH) @@ -1716,31 +1974,59 @@ [RFC4254] Ylonen, T. and C. Lonvick, Ed., "The Secure Shell (SSH) Connection Protocol", RFC 4254, DOI 10.17487/RFC4254, January 2006, . [RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security (TLS) Protocol Version 1.2", RFC 5246, DOI 10.17487/RFC5246, August 2008, . + [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration + Protocol (NETCONF) Access Control Model", RFC 6536, + DOI 10.17487/RFC6536, March 2012, + . + + [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF + Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, + . + + [RFC8071] Watsen, K., "NETCONF Call Home and RESTCONF Call Home", + RFC 8071, DOI 10.17487/RFC8071, February 2017, + . + Appendix A. Change Log A.1. server-model-09 to 00 o This draft was split out from draft-ietf-netconf-server-model-09. o Added in previously missing ietf-netconf-client module. o Added in new features 'listen' and 'call-home' so future transports can be augmented in. +A.2. 00 to 01 + + o Renamed "keychain" to "keystore". + +A.3. 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 accomodate new groupings in the ssh/tls + drafts. + Appendix B. Open Issues Please see: https://github.com/netconf-wg/netconf-client-server/ issues. Authors' Addresses Kent Watsen Juniper Networks