--- 1/draft-ietf-netconf-netconf-client-server-08.txt 2019-03-09 20:16:34.058972317 -0800
+++ 2/draft-ietf-netconf-netconf-client-server-09.txt 2019-03-09 20:16:34.354979570 -0800
@@ -1,18 +1,18 @@
NETCONF Working Group K. Watsen
-Internet-Draft Juniper Networks
-Intended status: Standards Track October 22, 2018
-Expires: April 25, 2019
+Internet-Draft Watsen Networks
+Intended status: Standards Track March 9, 2019
+Expires: September 10, 2019
NETCONF Client and Server Models
- draft-ietf-netconf-netconf-client-server-08
+ draft-ietf-netconf-netconf-client-server-09
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)
@@ -36,106 +36,110 @@
progress. Please apply the following replacements:
o "XXXX" --> the assigned RFC value for this draft
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
+ o "AAAA" --> the assigned RFC value for I-D.ietf-netconf-tcp-client-
+ server
+
Artwork in this document contains placeholder values for the date of
publication of this draft. Please apply the following replacement:
- o "2018-10-22" --> the publication date of this draft
+ o "2019-03-09" --> the publication date of this draft
The following Appendix section is to be removed prior to publication:
o Appendix A. 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 on April 25, 2019.
+ This Internet-Draft will expire on September 10, 2019.
Copyright Notice
- Copyright (c) 2018 IETF Trust and the persons identified as the
+ 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
+ 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4
2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 4
3. The NETCONF Client Model . . . . . . . . . . . . . . . . . . 4
3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 4
- 3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 12
- 3.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 14
- 4. The NETCONF Server Model . . . . . . . . . . . . . . . . . . 24
+ 3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 13
+ 3.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 16
+ 4. The NETCONF Server Model . . . . . . . . . . . . . . . . . . 25
4.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 25
- 4.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 32
- 4.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 37
- 5. Design Considerations . . . . . . . . . . . . . . . . . . . . 49
- 5.1. Support all NETCONF transports . . . . . . . . . . . . . 49
- 5.2. Enable each transport to select which keys to use . . . . 49
- 5.3. Support authenticating NETCONF clients certificates . . . 49
+ 4.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 34
+ 4.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 39
+ 5. Design Considerations . . . . . . . . . . . . . . . . . . . . 50
+ 5.1. Support all NETCONF transports . . . . . . . . . . . . . 50
+ 5.2. Enable each transport to select which keys to use . . . . 50
+ 5.3. Support authenticating NETCONF clients certificates . . . 50
5.4. Support mapping authenticated NETCONF client certificates
- to usernames . . . . . . . . . . . . . . . . . . . . . . 50
- 5.5. Support both listening for connections and call home . . 50
- 5.6. For Call Home connections . . . . . . . . . . . . . . . . 50
- 5.6.1. Support more than one NETCONF client . . . . . . . . 50
- 5.6.2. Support NETCONF clients having more than one endpoint 50
- 5.6.3. Support a reconnection strategy . . . . . . . . . . . 50
- 5.6.4. Support both persistent and periodic connections . . 51
- 5.6.5. Reconnection strategy for periodic connections . . . 51
- 5.6.6. Keep-alives for persistent connections . . . . . . . 51
- 5.6.7. Customizations for periodic connections . . . . . . . 51
- 6. Security Considerations . . . . . . . . . . . . . . . . . . . 51
- 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 52
- 7.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 52
- 7.2. The YANG Module Names Registry . . . . . . . . . . . . . 53
- 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 53
- 8.1. Normative References . . . . . . . . . . . . . . . . . . 53
- 8.2. Informative References . . . . . . . . . . . . . . . . . 54
- Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 56
- A.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 56
- A.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 56
- A.3. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 56
- A.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 56
- A.5. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 56
- A.6. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 57
- A.7. 06 to 07 . . . . . . . . . . . . . . . . . . . . . . . . 57
- A.8. 07 to 08 . . . . . . . . . . . . . . . . . . . . . . . . 57
- Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 57
- Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 57
+ to usernames . . . . . . . . . . . . . . . . . . . . . . 51
+ 5.5. Support both listening for connections and call home . . 51
+ 5.6. For Call Home connections . . . . . . . . . . . . . . . . 51
+ 5.6.1. Support more than one NETCONF client . . . . . . . . 51
+ 5.6.2. Support NETCONF clients having more than one endpoint 51
+ 5.6.3. Support a reconnection strategy . . . . . . . . . . . 51
+ 5.6.4. Support both persistent and periodic connections . . 52
+ 5.6.5. Reconnection strategy for periodic connections . . . 52
+ 5.6.6. Keep-alives for persistent connections . . . . . . . 52
+ 5.6.7. Customizations for periodic connections . . . . . . . 52
+ 6. Security Considerations . . . . . . . . . . . . . . . . . . . 52
+ 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 53
+ 7.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 53
+ 7.2. The YANG Module Names Registry . . . . . . . . . . . . . 54
+ 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 54
+ 8.1. Normative References . . . . . . . . . . . . . . . . . . 54
+ 8.2. Informative References . . . . . . . . . . . . . . . . . 55
+ Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 57
+ A.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 57
+ A.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 57
+ A.3. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 57
+ A.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 57
+ A.5. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 57
+ A.6. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 58
+ A.7. 06 to 07 . . . . . . . . . . . . . . . . . . . . . . . . 58
+ A.8. 07 to 08 . . . . . . . . . . . . . . . . . . . . . . . . 58
+ Appendix B. 08 to 09 . . . . . . . . . . . . . . . . . . . . . . 58
+ Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 58
+ Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 59
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
@@ -163,543 +167,636 @@
YANG feature statements are used to enable implementations to
advertise which 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. Just the container is
displayed below, but there is also a reusable grouping called
"netconf-client-grouping" that the container is using.
- [Note: '\' line wrapping for formatting only]
+ ========== NOTE: '\\' line wrapping per BCP XX (RFC XXXX) ===========
module: ietf-netconf-client
+--rw netconf-client
+--rw initiate! {initiate}?
| +--rw netconf-server* [name]
| +--rw name string
| +--rw endpoints
| | +--rw endpoint* [name]
| | +--rw name string
| | +--rw (transport)
| | +--:(ssh) {ssh-initiate}?
| | | +--rw ssh
- | | | +--rw address? inet:host
- | | | +--rw port? inet:port-number
- | | | +--rw client-identity
+ | | | +--rw remote-address inet:host
+ | | | +--rw remote-port?
+ | | | | inet:port-number
+ | | | +--rw local-address? inet:ip-addr\
+ \ess
+ | | | +--rw local-port?
+ | | | | inet:port-number
+ | | | +--rw tcp-keepalives {tcp-client-keepalive\
+ \s}?
+ | | | | +--rw idle-time? uint16
+ | | | | +--rw max-probes? uint16
+ | | | | +--rw probe-interval? uint16
+ | | | +--rw ssh-client-identity
| | | | +--rw username? string
| | | | +--rw (auth-type)
| | | | +--:(password)
| | | | | +--rw password? string
| | | | +--:(public-key)
| | | | | +--rw public-key
| | | | | +--rw (local-or-keystore)
| | | | | +--:(local)
| | | | | | {local-keys-suppor\
- ted}?
+ \ted}?
+ | | | | | | +--rw local-definition
| | | | | | +--rw algorithm?
- | | | | | | | asymmetric-key-e\
- ncryption-algorithm-ref
+ | | | | | | | asymmetric-ke\
+ \y-algorithm-ref
| | | | | | +--rw public-key?
| | | | | | | binary
| | | | | | +--rw private-key?
| | | | | | | union
- | | | | | | +---x generate-hidden-key
+ | | | | | | +---x generate-hidden\
+ \-key
| | | | | | | +---w input
| | | | | | | +---w algorithm
- | | | | | | | asymmetric\
- -key-encryption-algorithm-ref
- | | | | | | +---x install-hidden-key
+ | | | | | | | asymmet\
+ \ric-key-algorithm-ref
+ | | | | | | +---x install-hidden-\
+ \key
| | | | | | +---w input
| | | | | | +---w algorithm
- | | | | | | | asymmetric\
- -key-encryption-algorithm-ref
- | | | | | | +---w public-key?
+ | | | | | | | asymmet\
+ \ric-key-algorithm-ref
+ | | | | | | +---w public-ke\
+ \y?
| | | | | | | binary
- | | | | | | +---w private-key?
+ | | | | | | +---w private-k\
+ \ey?
| | | | | | binary
| | | | | +--:(keystore)
| | | | | {keystore-supporte\
- d}?
- | | | | | +--rw reference?
+ \d}?
+ | | | | | +--rw keystore-reference?
| | | | | ks:asymmetric-ke\
- y-ref
+ \y-ref
| | | | +--:(certificate)
| | | | +--rw certificate
| | | | {sshcmn:ssh-x509-certs}?
| | | | +--rw (local-or-keystore)
| | | | +--:(local)
| | | | | {local-keys-suppor\
- ted}?
+ \ted}?
+ | | | | | +--rw local-definition
| | | | | +--rw algorithm?
- | | | | | | asymmetric-key-e\
- ncryption-algorithm-ref
+ | | | | | | asymmetric-ke\
+ \y-algorithm-ref
| | | | | +--rw public-key?
| | | | | | binary
| | | | | +--rw private-key?
| | | | | | union
- | | | | | +---x generate-hidden-key
+ | | | | | +---x generate-hidden\
+ \-key
| | | | | | +---w input
| | | | | | +---w algorithm
- | | | | | | asymmetric\
- -key-encryption-algorithm-ref
- | | | | | +---x install-hidden-key
+ | | | | | | asymmet\
+ \ric-key-algorithm-ref
+ | | | | | +---x install-hidden-\
+ \key
| | | | | | +---w input
| | | | | | +---w algorithm
- | | | | | | | asymmetric\
- -key-encryption-algorithm-ref
- | | | | | | +---w public-key?
+ | | | | | | | asymmet\
+ \ric-key-algorithm-ref
+ | | | | | | +---w public-ke\
+ \y?
| | | | | | | binary
- | | | | | | +---w private-key?
+ | | | | | | +---w private-k\
+ \ey?
| | | | | | binary
| | | | | +--rw cert?
- | | | | | | end-entity-cert-\
- cms
- | | | | | +---n certificate-expira\
- tion
+ | | | | | | end-entity-ce\
+ \rt-cms
+ | | | | | +---n certificate-exp\
+ \iration
| | | | | +-- expiration-date
- | | | | | yang:date-and\
- -time
+ | | | | | yang:date-\
+ \and-time
| | | | +--:(keystore)
| | | | {keystore-supporte\
- d}?
- | | | | +--rw reference?
+ \d}?
+ | | | | +--rw keystore-reference?
| | | | ks:asymmetric-ke\
- y-certificate-ref
- | | | +--rw server-auth
+ \y-certificate-ref
+ | | | +--rw ssh-server-auth
| | | | +--rw pinned-ssh-host-keys?
| | | | | ta:pinned-host-keys-ref
| | | | | {ta:ssh-host-keys}?
| | | | +--rw pinned-ca-certs?
| | | | | ta:pinned-certificates-ref
| | | | | {sshcmn:ssh-x509-certs,ta:x509-\
- certificates}?
+ \certificates}?
| | | | +--rw pinned-server-certs?
| | | | ta:pinned-certificates-ref
| | | | {sshcmn:ssh-x509-certs,ta:x509-\
- certificates}?
- | | | +--rw transport-params
- | | | {ssh-client-transport-params-confi\
- g}?
- | | | +--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
+ \certificates}?
+ | | | +--rw ssh-transport-params
+ | | | | {ssh-client-transport-params-confi\
+ \g}?
+ | | | | +--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 ssh-keepalives {ssh-client-keepalive\
+ \s}?
+ | | | +--rw max-wait? uint16
+ | | | +--rw max-attempts? uint8
| | +--:(tls) {tls-initiate}?
| | +--rw tls
- | | +--rw address? inet:host
- | | +--rw port? inet:port-number
- | | +--rw client-identity
+ | | +--rw remote-address inet:host
+ | | +--rw remote-port? inet:port-num\
+ \ber
+ | | +--rw local-address? inet:ip-addre\
+ \ss
+ | | +--rw local-port? inet:port-num\
+ \ber
+ | | +--rw tcp-keepalives {tcp-client-keepalive\
+
+ \s}?
+ | | | +--rw idle-time? uint16
+ | | | +--rw max-probes? uint16
+ | | | +--rw probe-interval? uint16
+ | | +--rw tls-client-identity
| | | +--rw (auth-type)
| | | +--:(certificate)
| | | +--rw certificate
| | | +--rw (local-or-keystore)
| | | +--:(local)
| | | | {local-keys-suppor\
- ted}?
+ \ted}?
+ | | | | +--rw local-definition
| | | | +--rw algorithm?
- | | | | | asymmetric-key-e\
- ncryption-algorithm-ref
+ | | | | | asymmetric-ke\
+ \y-algorithm-ref
| | | | +--rw public-key?
| | | | | binary
| | | | +--rw private-key?
| | | | | union
- | | | | +---x generate-hidden-key
+ | | | | +---x generate-hidden\
+ \-key
| | | | | +---w input
| | | | | +---w algorithm
- | | | | | asymmetric\
- -key-encryption-algorithm-ref
- | | | | +---x install-hidden-key
+ | | | | | asymmet\
+ \ric-key-algorithm-ref
+ | | | | +---x install-hidden-\
+ \key
| | | | | +---w input
| | | | | +---w algorithm
- | | | | | | asymmetric\
- -key-encryption-algorithm-ref
- | | | | | +---w public-key?
+ | | | | | | asymmet\
+ \ric-key-algorithm-ref
+ | | | | | +---w public-ke\
+ \y?
| | | | | | binary
- | | | | | +---w private-key?
+ | | | | | +---w private-k\
+ \ey?
| | | | | binary
| | | | +--rw cert?
- | | | | | end-entity-cert-\
- cms
- | | | | +---n certificate-expira\
- tion
+ | | | | | end-entity-ce\
+ \rt-cms
+ | | | | +---n certificate-exp\
+ \iration
| | | | +-- expiration-date
- | | | | yang:date-and\
- -time
+ | | | | yang:date-\
+ \and-time
| | | +--:(keystore)
| | | {keystore-supporte\
- d}?
- | | | +--rw reference?
+
+ \d}?
+ | | | +--rw keystore-reference?
| | | ks:asymmetric-ke\
- y-certificate-ref
- | | +--rw server-auth
+ \y-certificate-ref
+ | | +--rw tls-server-auth
| | | +--rw pinned-ca-certs?
| | | | ta:pinned-certificates-ref
| | | | {ta:x509-certificates}?
| | | +--rw pinned-server-certs?
| | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
- | | +--rw hello-params
- | | {tls-client-hello-params-config}?
- | | +--rw tls-versions
- | | | +--rw tls-version* identityref
- | | +--rw cipher-suites
- | | +--rw cipher-suite* identityref
+ | | +--rw tls-hello-params
+ | | | {tls-client-hello-params-config}?
+ | | | +--rw tls-versions
+ | | | | +--rw tls-version* identityref
+ | | | +--rw cipher-suites
+ | | | +--rw cipher-suite* identityref
+ | | +--rw tls-keepalives {tls-client-keepalive\
+ \s}?
+ | | +--rw max-wait? uint16
+ | | +--rw max-attempts? uint8
| +--rw connection-type
| | +--rw (connection-type)
| | +--:(persistent-connection)
| | | +--rw persistent!
- | | | +--rw keep-alives
- | | | +--rw max-wait? uint16
- | | | +--rw max-attempts? uint8
| | +--:(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! {listen}?
+--rw idle-timeout? uint16
+--rw endpoint* [name]
+--rw name string
+--rw (transport)
+--:(ssh) {ssh-listen}?
| +--rw ssh
- | +--rw address? inet:ip-address
- | +--rw port? inet:port-number
- | +--rw client-identity
+ | +--rw local-address inet:ip-address
+ | +--rw local-port? inet:port-number
+ | +--rw tcp-keepalives {tcp-server-keepalives}?
+ | | +--rw idle-time? uint16
+ | | +--rw max-probes? uint16
+ | | +--rw probe-interval? uint16
+ | +--rw ssh-client-identity
| | +--rw username? string
| | +--rw (auth-type)
| | +--:(password)
| | | +--rw password? string
| | +--:(public-key)
| | | +--rw public-key
| | | +--rw (local-or-keystore)
| | | +--:(local) {local-keys-supported\
- }?
+ \}?
+ | | | | +--rw local-definition
| | | | +--rw algorithm?
- | | | | | asymmetric-key-encrypt\
- ion-algorithm-ref
+ | | | | | asymmetric-key-algo\
+ \rithm-ref
| | | | +--rw public-key?
| | | | | binary
| | | | +--rw private-key?
| | | | | union
| | | | +---x generate-hidden-key
| | | | | +---w input
| | | | | +---w algorithm
- | | | | | asymmetric-key-e\
- ncryption-algorithm-ref
+ | | | | | asymmetric-ke\
+ \y-algorithm-ref
| | | | +---x install-hidden-key
| | | | +---w input
| | | | +---w algorithm
- | | | | | asymmetric-key-e\
- ncryption-algorithm-ref
- | | | | +---w public-key? bin\
- ary
- | | | | +---w private-key? bin\
- ary
+ | | | | | asymmetric-ke\
+ \y-algorithm-ref
+ | | | | +---w public-key?
+ | | | | | binary
+ | | | | +---w private-key?
+ | | | | binary
| | | +--:(keystore) {keystore-supporte\
- d}?
- | | | +--rw reference?
+ \d}?
+ | | | +--rw keystore-reference?
| | | ks:asymmetric-key-ref
| | +--:(certificate)
| | +--rw certificate {sshcmn:ssh-x509-cert\
- s}?
+ \s}?
| | +--rw (local-or-keystore)
| | +--:(local) {local-keys-supported\
- }?
+ \}?
+ | | | +--rw local-definition
| | | +--rw algorithm?
- | | | | asymmetric-key-encrypt\
- ion-algorithm-ref
+ | | | | asymmetric-key-algo\
+ \rithm-ref
| | | +--rw public-key?
| | | | binary
| | | +--rw private-key?
| | | | union
| | | +---x generate-hidden-key
| | | | +---w input
| | | | +---w algorithm
- | | | | asymmetric-key-e\
- ncryption-algorithm-ref
+ | | | | asymmetric-ke\
+ \y-algorithm-ref
| | | +---x install-hidden-key
| | | | +---w input
| | | | +---w algorithm
- | | | | | asymmetric-key-e\
- ncryption-algorithm-ref
- | | | | +---w public-key? bin\
- ary
- | | | | +---w private-key? bin\
- ary
+ | | | | | asymmetric-ke\
+ \y-algorithm-ref
+ | | | | +---w public-key?
+ | | | | | binary
+ | | | | +---w private-key?
+ | | | | binary
| | | +--rw cert?
| | | | end-entity-cert-cms
| | | +---n certificate-expiration
| | | +-- expiration-date
- | | | yang:date-and-time
+ | | | yang:date-and-ti\
+ \me
| | +--:(keystore) {keystore-supporte\
- d}?
- | | +--rw reference?
+ \d}?
+ | | +--rw keystore-reference?
| | ks:asymmetric-key-cert\
- ificate-ref
- | +--rw server-auth
+ \ificate-ref
+ | +--rw ssh-server-auth
| | +--rw pinned-ssh-host-keys?
| | | ta:pinned-host-keys-ref
| | | {ta:ssh-host-keys}?
| | +--rw pinned-ca-certs?
| | | ta:pinned-certificates-ref
| | | {sshcmn:ssh-x509-certs,ta:x509-certif\
- icates}?
+ \icates}?
| | +--rw pinned-server-certs?
| | ta:pinned-certificates-ref
| | {sshcmn:ssh-x509-certs,ta:x509-certif\
- icates}?
- | +--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
+ \icates}?
+ | +--rw ssh-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 ssh-keepalives {ssh-client-keepalives}?
+ | +--rw max-wait? uint16
+ | +--rw max-attempts? uint8
+--:(tls) {tls-listen}?
+--rw tls
- +--rw address? inet:ip-address
- +--rw port? inet:port-number
- +--rw client-identity
+ +--rw local-address inet:ip-address
+ +--rw local-port? inet:port-number
+ +--rw tcp-keepalives {tcp-server-keepalives}?
+ | +--rw idle-time? uint16
+ | +--rw max-probes? uint16
+ | +--rw probe-interval? uint16
+ +--rw tls-client-identity
| +--rw (auth-type)
| +--:(certificate)
| +--rw certificate
| +--rw (local-or-keystore)
| +--:(local) {local-keys-supported\
- }?
+ \}?
+ | | +--rw local-definition
| | +--rw algorithm?
- | | | asymmetric-key-encrypt\
- ion-algorithm-ref
+ | | | asymmetric-key-algo\
+ \rithm-ref
| | +--rw public-key?
| | | binary
| | +--rw private-key?
| | | union
| | +---x generate-hidden-key
| | | +---w input
| | | +---w algorithm
- | | | asymmetric-key-e\
- ncryption-algorithm-ref
+ | | | asymmetric-ke\
+ \y-algorithm-ref
| | +---x install-hidden-key
| | | +---w input
| | | +---w algorithm
- | | | | asymmetric-key-e\
- ncryption-algorithm-ref
- | | | +---w public-key? bin\
- ary
- | | | +---w private-key? bin\
- ary
+ | | | | asymmetric-ke\
+ \y-algorithm-ref
+ | | | +---w public-key?
+ | | | | binary
+ | | | +---w private-key?
+ | | | binary
| | +--rw cert?
| | | end-entity-cert-cms
| | +---n certificate-expiration
| | +-- expiration-date
- | | yang:date-and-time
+ | | yang:date-and-ti\
+ \me
| +--:(keystore) {keystore-supporte\
- d}?
- | +--rw reference?
+ \d}?
+ | +--rw keystore-reference?
| ks:asymmetric-key-cert\
- ificate-ref
- +--rw server-auth
+ \ificate-ref
+ +--rw tls-server-auth
| +--rw pinned-ca-certs?
| | ta:pinned-certificates-ref
| | {ta:x509-certificates}?
| +--rw pinned-server-certs?
| ta:pinned-certificates-ref
| {ta:x509-certificates}?
- +--rw hello-params
- {tls-client-hello-params-config}?
- +--rw tls-versions
- | +--rw tls-version* identityref
- +--rw cipher-suites
- +--rw cipher-suite* identityref
+ +--rw tls-hello-params
+ | {tls-client-hello-params-config}?
+ | +--rw tls-versions
+ | | +--rw tls-version* identityref
+ | +--rw cipher-suites
+ | +--rw cipher-suite* identityref
+ +--rw tls-keepalives {tls-client-keepalives}?
+ +--rw max-wait? uint16
+ +--rw max-attempts? uint8
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 3.2
of [I-D.ietf-netconf-keystore].
- [Note: '\' line wrapping for formatting only]
+ ========== NOTE: '\\' line wrapping per BCP XX (RFC XXXX) ===========
corp-fw1
corp-fw1.example.com
- corp-fw1.example.com
-
+ corp-fw1.example.com
+
+ 15
+ 3
+ 30
+
+
foobar
- ct:rsa2048
+
+ ct:rsa2048
base64encodedvalue==
base64encodedvalue==
+
-
-
+
+
explicitly-trusted-server-ca-certs
+ \inned-ca-certs>
explicitly-trusted-server-certs
-
+ \pinned-server-certs>
+
+
+ 30
+ 3
+
corp-fw2.example.com
- corp-fw2.example.com
-
+ corp-fw2.example.com
+
+ 15
+ 3
+ 30
+
+
foobar
- ct:rsa2048
+
+ ct:rsa2048
base64encodedvalue==
base64encodedvalue==
+
-
-
+
+
explicitly-trusted-server-ca-certs
+ \inned-ca-certs>
explicitly-trusted-server-certs
-
+ \pinned-server-certs>
+
+
+ 30
+ 3
+
last-connected
Intranet-facing listener
- 192.0.2.7
-
+ 192.0.2.7
+
foobar
- ct:rsa2048
+
+ ct:rsa2048
base64encodedvalue==
base64encodedvalue==
+
-
-
+
+
explicitly-trusted-server-ca-certs
+ \d-ca-certs>
explicitly-trusted-server-certs
+ \ed-server-certs>
explicitly-trusted-ssh-host-keys
-
-
+ \nned-ssh-host-keys>
+
3.3. YANG Module
This YANG module has normative references to [RFC6242], [RFC6991],
- [RFC7589], [RFC8071], [I-D.ietf-netconf-ssh-client-server], and
+ [RFC7589], [RFC8071], [I-D.kwatsen-netconf-tcp-client-server],
+ [I-D.ietf-netconf-ssh-client-server], and
[I-D.ietf-netconf-tls-client-server].
- file "ietf-netconf-client@2018-10-22.yang"
+ file "ietf-netconf-client@2019-03-09.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-inet-types {
- prefix inet;
+ import ietf-tcp-client {
+ prefix tcpc;
reference
- "RFC 6991: Common YANG Data Types";
+ "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 ss;
- revision-date 2018-10-22; // stable grouping definitions
+ prefix sshc;
+ revision-date 2019-03-09; // stable grouping definitions
reference
"RFC YYYY: YANG Groupings for SSH Clients and SSH Servers";
}
import ietf-tls-client {
- prefix ts;
- revision-date 2018-10-22; // stable grouping definitions
+ prefix tlsc;
+ revision-date 2019-03-09; // stable grouping definitions
reference
"RFC ZZZZ: YANG Groupings for TLS Clients and TLS Servers";
}
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web:
WG List:
-
- Author: Kent Watsen
-
-
- Author: Gary Wu
- ";
+ Author: Kent Watsen
+ Author: Gary Wu ";
description
"This module contains a collection of YANG definitions for
configuring NETCONF clients.
- Copyright (c) 2017 IETF Trust and the persons identified as
+ 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.
+
+ 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
(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 "2018-10-22" {
+ revision "2019-03-09" {
description
"Initial version";
reference
"RFC XXXX: NETCONF Client and Server Models";
}
// Features
feature initiate {
description
@@ -746,25 +843,21 @@
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";
}
- container netconf-client {
- uses netconf-client-grouping;
- description
- "Top-level container for NETCONF client configuration.";
- }
+ // Groupings
grouping netconf-client-grouping {
description
"Top-level grouping for NETCONF client configuration.";
container initiate {
if-feature initiate;
presence "Enables client to initiate TCP connections";
description
"Configures client initiating underlying TCP connections.";
@@ -799,137 +892,89 @@
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.";
- leaf address {
- type inet:host;
- description
- "The IP address or hostname of the endpoint.
- If a domain name is configured, then the
- DNS resolution should happen on each usage
- attempt. If the DNS resolution results in
- multiple IP addresses, the IP addresses will
- be tried according to local preference order
- until a connection has been established or
- until all IP addresses have failed.";
- }
- leaf port {
- type inet:port-number;
+ uses tcpc:tcp-client-grouping {
+ refine "remote-port" {
default 830;
description
- "The IP port for this endpoint. The NETCONF
- client will use the IANA-assigned well-known
- port for 'netconf-ssh' (830) if no value is
+ "The NETCONF client will attempt to connect
+ to the IANA-assigned well-known port value
+ for 'netconf-ssh' (443) if no value is
specified.";
}
- uses ss:ssh-client-grouping;
}
- } // end ssh
+ uses sshc:ssh-client-grouping;
+ } // container ssh
+ } // case ssh
+
case tls {
if-feature tls-initiate;
container tls {
description
"Specifies IP and TLS specific configuration
for the connection.";
- leaf address {
- type inet:host;
- description
- "The IP address or hostname of the endpoint.
- If a domain name is configured, then the
- DNS resolution should happen on each usage
- attempt. If the DNS resolution results in
- multiple IP addresses, the IP addresses will
- be tried according to local preference order
- until a connection has been established or
- until all IP addresses have failed.";
- }
- leaf port {
- type inet:port-number;
+ uses tcpc:tcp-client-grouping {
+ refine "remote-port" {
default 6513;
description
- "The IP port for this endpoint. The NETCONF
- client will use the IANA-assigned well-
- known port for 'netconf-tls' (6513) if no
- value is specified.";
+ "The NETCONF client will attempt to connect
+ to the IANA-assigned well-known port value
+ for 'netconf-tls' (6513) if no value is
+ specified.";
}
- uses ts:tls-client-grouping {
- refine "client-identity/auth-type" {
+ }
+
+ uses tlsc:tls-client-grouping {
+ refine "tls-client-identity/auth-type" {
mandatory true;
description
"NETCONF/TLS clients MUST pass some
authentication credentials.";
}
}
- }
- } // end tls
- }
- }
- }
+
+ } // container tls
+ } // case tls
+
+ } // choice transport
+ } // list endpoint
+ } // container endpoints
container connection-type {
description
- "Indicates the kind of connection to use.";
+ "Indicates the NETCONF client's preference for how the
+ NETCONF connection is maintained.";
choice connection-type {
mandatory true;
description
"Selects between available connection types.";
case persistent-connection {
container persistent {
presence
"Indicates that a persistent connection is to be
maintained.";
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.";
- 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.";
- 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
"Indicates that a periodic connection is to be
maintained.";
description
"Periodically connect to the NETCONF server. The
NETCONF server should close the connection upon
@@ -1019,22 +1063,22 @@
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
+ } // netconf-server
+ } // initiate
container listen {
if-feature listen;
presence "Enables client to accept call-home connections";
description
"Configures client accepting call-home TCP connections.";
leaf idle-timeout {
type uint16;
units "seconds";
@@ -1062,86 +1106,70 @@
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.";
- leaf address {
- type inet:ip-address;
- description
- "The IP address to listen on for incoming call-
- home connections. The NETCONF client will listen
- on all configured interfaces if no value is
- specified. INADDR_ANY (0.0.0.0) or INADDR6_ANY
- (0:0:0:0:0:0:0:0 a.k.a. ::) MUST be used when
- the server is to listen on all IPv4 or IPv6
- addresses, respectively.";
- }
- leaf port {
- type inet:port-number;
+ uses tcps:tcp-server-grouping {
+ refine "local-port" {
default 4334;
description
- "The port number to listen on for call-home
- connections. The NETCONF client will listen
- on the IANA-assigned well-known port for
- 'netconf-ch-ssh' (4334) if no value is
- specified.";
+ "The NETCONF client will listen on the IANA-
+ assigned well-known port for 'netconf-ch-ssh'
+ (4334) if no value is specified.";
}
- uses ss:ssh-client-grouping;
+ }
+ uses sshc:ssh-client-grouping;
}
}
case tls {
if-feature tls-listen;
container tls {
description
"TLS-specific listening configuration for inbound
connections.";
- leaf address {
- type inet:ip-address;
+ uses tcps:tcp-server-grouping {
+ refine "local-port" {
+ default 4334;
description
- "The IP address to listen on for incoming call-
- home connections. The NETCONF client will listen
- on all configured interfaces if no value is
- specified. INADDR_ANY (0.0.0.0) or INADDR6_ANY
- (0:0:0:0:0:0:0:0 a.k.a. ::) MUST be used when
- the server is to listen on all IPv4 or IPv6
- addresses, respectively.";
+ "The NETCONF client will listen on the IANA-
+ assigned well-known port for 'netconf-ch-ssh'
+ (4334) if no value is specified.";
}
- leaf port {
- type inet:port-number;
- default 4335;
- description
- "The port number to listen on for call-home
- connections. The NETCONF client will listen
- on the IANA-assigned well-known port for
- 'netconf-ch-tls' (4335) if no value is
- specified.";
}
- uses ts:tls-client-grouping {
- refine "client-identity/auth-type" {
+ uses tlsc:tls-client-grouping {
+ refine "tls-client-identity/auth-type" {
mandatory true;
description
"NETCONF/TLS clients MUST pass some
authentication credentials.";
}
}
}
}
- } // end transport
- } // end endpoint
- } // end listen
+ } // transport
+ } // endpoint
+ } // listen
+ } // netconf-client
- } // end 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.";
+ }
}
4. 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 supports both the SSH and TLS transport protocols, using
@@ -1156,675 +1183,772 @@
YANG feature statements are used to enable implementations to
advertise which parts of the model the NETCONF server supports.
4.1. Tree Diagram
The following tree diagram [RFC8340] provides an overview of the data
model for the "ietf-netconf-server" module. Just the container is
displayed below, but there is also a reusable grouping called
"netconf-server-grouping" that the container is using.
- [Note: '\' line wrapping for formatting only]
-
+ ========== NOTE: '\\' line wrapping per BCP XX (RFC XXXX) ===========
module: ietf-netconf-server
+--rw netconf-server
+--rw listen! {listen}?
| +--rw idle-timeout? uint16
| +--rw endpoint* [name]
| +--rw name string
| +--rw (transport)
| +--:(ssh) {ssh-listen}?
| | +--rw ssh
- | | +--rw address inet:ip-address
- | | +--rw port? inet:port-number
- | | +--rw server-identity
+ | | +--rw local-address inet:ip-address
+ | | +--rw local-port? inet:port-number
+ | | +--rw tcp-keepalives {tcp-server-keepalives}?
+ | | | +--rw idle-time? uint16
+ | | | +--rw max-probes? uint16
+ | | | +--rw probe-interval? uint16
+ | | +--rw ssh-server-identity
| | | +--rw host-key* [name]
| | | +--rw name string
| | | +--rw (host-key-type)
| | | +--:(public-key)
| | | | +--rw public-key
| | | | +--rw (local-or-keystore)
| | | | +--:(local)
| | | | | {local-keys-supported\
- }?
+ \}?
+ | | | | | +--rw local-definition
| | | | | +--rw algorithm?
- | | | | | | asymmetric-key-encr\
- yption-algorithm-ref
+ | | | | | | asymmetric-key-a\
+ \lgorithm-ref
| | | | | +--rw public-key?
| | | | | | binary
| | | | | +--rw private-key?
| | | | | | union
| | | | | +---x generate-hidden-key
| | | | | | +---w input
| | | | | | +---w algorithm
- | | | | | | asymmetric-ke\
- y-encryption-algorithm-ref
+ | | | | | | asymmetric\
+ \-key-algorithm-ref
| | | | | +---x install-hidden-key
| | | | | +---w input
| | | | | +---w algorithm
- | | | | | | asymmetric-ke\
- y-encryption-algorithm-ref
+ | | | | | | asymmetric\
+ \-key-algorithm-ref
| | | | | +---w public-key?
| | | | | | binary
| | | | | +---w private-key?
| | | | | binary
| | | | +--:(keystore)
| | | | {keystore-supported}?
- | | | | +--rw reference?
+ | | | | +--rw keystore-reference?
| | | | ks:asymmetric-key-r\
- ef
+ \ef
| | | +--:(certificate)
| | | +--rw certificate
| | | {sshcmn:ssh-x509-certs}?
| | | +--rw (local-or-keystore)
| | | +--:(local)
| | | | {local-keys-supported\
- }?
+ \}?
+ | | | | +--rw local-definition
| | | | +--rw algorithm?
- | | | | | asymmetric-key-encr\
- yption-algorithm-ref
+ | | | | | asymmetric-key-a\
+ \lgorithm-ref
| | | | +--rw public-key?
| | | | | binary
| | | | +--rw private-key?
| | | | | union
| | | | +---x generate-hidden-key
| | | | | +---w input
| | | | | +---w algorithm
- | | | | | asymmetric-ke\
- y-encryption-algorithm-ref
+ | | | | | asymmetric\
+ \-key-algorithm-ref
| | | | +---x install-hidden-key
| | | | | +---w input
| | | | | +---w algorithm
- | | | | | | asymmetric-ke\
- y-encryption-algorithm-ref
+ | | | | | | asymmetric\
+ \-key-algorithm-ref
| | | | | +---w public-key?
| | | | | | binary
| | | | | +---w private-key?
| | | | | binary
| | | | +--rw cert?
- | | | | | end-entity-cert-cms
- | | | | +---n certificate-expiration
+ | | | | | end-entity-cert-\
+ \cms
+ | | | | +---n certificate-expira\
+ \tion
| | | | +-- expiration-date
- | | | | yang:date-and-ti\
- me
+ | | | | yang:date-and\
+ \-time
| | | +--:(keystore)
| | | {keystore-supported}?
- | | | +--rw reference?
+ | | | +--rw keystore-reference?
| | | ks:asymmetric-key-c\
- ertificate-ref
- | | +--rw client-cert-auth {sshcmn:ssh-x509-certs}?
+ \ertificate-ref
+ | | +--rw ssh-client-cert-auth {sshcmn:ssh-x509-cert\
+ \s}?
| | | +--rw pinned-ca-certs?
| | | | ta:pinned-certificates-ref
| | | | {ta:x509-certificates}?
| | | +--rw pinned-client-certs?
| | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
- | | +--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 ssh-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 ssh-keepalives {ssh-server-keepalives}?
+ | | +--rw max-wait? uint16
+ | | +--rw max-attempts? uint8
| +--:(tls) {tls-listen}?
| +--rw tls
- | +--rw address inet:ip-address
- | +--rw port? inet:port-number
- | +--rw server-identity
+ | +--rw local-address inet:ip-address
+ | +--rw local-port? inet:port-number
+ | +--rw tcp-keepalives {tcp-server-keepalives}?
+ | | +--rw idle-time? uint16
+ | | +--rw max-probes? uint16
+ | | +--rw probe-interval? uint16
+ | +--rw tls-server-identity
| | +--rw (local-or-keystore)
| | +--:(local) {local-keys-supported}?
+ | | | +--rw local-definition
| | | +--rw algorithm?
- | | | | asymmetric-key-encryption-algor\
- ithm-ref
- | | | +--rw public-key? binary
+ | | | | asymmetric-key-algorithm-ref
+ | | | +--rw public-key? bina\
+ \ry
| | | +--rw private-key? union
| | | +---x generate-hidden-key
| | | | +---w input
| | | | +---w algorithm
- | | | | asymmetric-key-encryption\
- -algorithm-ref
+ | | | | asymmetric-key-algorit\
+ \hm-ref
| | | +---x install-hidden-key
| | | | +---w input
| | | | +---w algorithm
- | | | | | asymmetric-key-encryption\
- -algorithm-ref
+ | | | | | asymmetric-key-algorit\
+ \hm-ref
| | | | +---w public-key? binary
| | | | +---w private-key? binary
| | | +--rw cert?
| | | | end-entity-cert-cms
| | | +---n certificate-expiration
| | | +-- expiration-date
| | | yang:date-and-time
| | +--:(keystore) {keystore-supported}?
- | | +--rw reference?
+ | | +--rw keystore-reference?
| | ks:asymmetric-key-certificate-r\
- ef
- | +--rw client-auth
+ \ef
+ | +--rw tls-client-auth
| | +--rw pinned-ca-certs?
| | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--rw pinned-client-certs?
| | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--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 tls-hello-params
+ | | {tls-server-hello-params-config}?
+ | | +--rw tls-versions
+ | | | +--rw tls-version* identityref
+ | | +--rw cipher-suites
+ | | +--rw cipher-suite* identityref
+ | +--rw tls-keepalives {tls-server-keepalives}?
+ | +--rw max-wait? uint16
+ | +--rw max-attempts? uint8
+--rw call-home! {call-home}?
+--rw netconf-client* [name]
+--rw name string
+--rw endpoints
| +--rw endpoint* [name]
| +--rw name string
| +--rw (transport)
| +--:(ssh) {ssh-call-home}?
| | +--rw ssh
- | | +--rw address inet:host
- | | +--rw port? inet:port-number
- | | +--rw server-identity
+ | | +--rw remote-address inet:host
+ | | +--rw remote-port?
+ | | | inet:port-number
+ | | +--rw local-address? inet:ip-addr\
+ \ess
+ | | +--rw local-port?
+ | | | inet:port-number
+ | | +--rw tcp-keepalives {tcp-client-keepalive\
+ \s}?
+ | | | +--rw idle-time? uint16
+ | | | +--rw max-probes? uint16
+ | | | +--rw probe-interval? uint16
+ | | +--rw ssh-server-identity
| | | +--rw host-key* [name]
| | | +--rw name string
| | | +--rw (host-key-type)
| | | +--:(public-key)
| | | | +--rw public-key
| | | | +--rw (local-or-keystore)
| | | | +--:(local)
| | | | | {local-keys-sup\
- ported}?
+ \ported}?
+ | | | | | +--rw local-definition
| | | | | +--rw algorithm?
- | | | | | | asymmetric-ke\
- y-encryption-algorithm-ref
+ | | | | | | asymmetric\
+ \-key-algorithm-ref
| | | | | +--rw public-key?
| | | | | | binary
| | | | | +--rw private-key?
| | | | | | union
- | | | | | +---x generate-hidden\
- -key
+ | | | | | +---x generate-hid\
+ \den-key
| | | | | | +---w input
- | | | | | | +---w algorithm
- | | | | | | asymmet\
- ric-key-encryption-algorithm-ref
- | | | | | +---x install-hidden-\
- key
+ | | | | | | +---w algori\
+ \thm
+ | | | | | | asym\
+ \metric-key-algorithm-ref
+ | | | | | +---x install-hidd\
+ \en-key
| | | | | +---w input
- | | | | | +---w algorithm
- | | | | | | asymmet\
- ric-key-encryption-algorithm-ref
- | | | | | +---w public-ke\
- y?
- | | | | | | binary
- | | | | | +---w private-k\
- ey?
- | | | | | binary
+ | | | | | +---w algori\
+ \thm
+ | | | | | | asym\
+ \metric-key-algorithm-ref
+ | | | | | +---w public\
+ \-key?
+ | | | | | | bina\
+ \ry
+ | | | | | +---w privat\
+ \e-key?
+ | | | | | bina\
+ \ry
| | | | +--:(keystore)
| | | | {keystore-suppo\
- rted}?
- | | | | +--rw reference?
+ \rted}?
+ | | | | +--rw keystore-refere\
+ \nce?
| | | | ks:asymmetric\
- -key-ref
+ \-key-ref
| | | +--:(certificate)
| | | +--rw certificate
| | | {sshcmn:ssh-x509-certs\
- }?
+ \}?
| | | +--rw (local-or-keystore)
| | | +--:(local)
| | | | {local-keys-sup\
- ported}?
+ \ported}?
+ | | | | +--rw local-definition
| | | | +--rw algorithm?
- | | | | | asymmetric-ke\
- y-encryption-algorithm-ref
+ | | | | | asymmetric\
+ \-key-algorithm-ref
| | | | +--rw public-key?
| | | | | binary
| | | | +--rw private-key?
| | | | | union
- | | | | +---x generate-hidden\
- -key
+ | | | | +---x generate-hid\
+ \den-key
| | | | | +---w input
- | | | | | +---w algorithm
- | | | | | asymmet\
- ric-key-encryption-algorithm-ref
- | | | | +---x install-hidden-\
- key
+ | | | | | +---w algori\
+ \thm
+ | | | | | asym\
+ \metric-key-algorithm-ref
+ | | | | +---x install-hidd\
+ \en-key
| | | | | +---w input
- | | | | | +---w algorithm
- | | | | | | asymmet\
- ric-key-encryption-algorithm-ref
- | | | | | +---w public-ke\
- y?
- | | | | | | binary
- | | | | | +---w private-k\
- ey?
- | | | | | binary
+ | | | | | +---w algori\
+ \thm
+ | | | | | | asym\
+ \metric-key-algorithm-ref
+ | | | | | +---w public\
+ \-key?
+ | | | | | | bina\
+ \ry
+ | | | | | +---w privat\
+ \e-key?
+ | | | | | bina\
+ \ry
| | | | +--rw cert?
- | | | | | end-entity-ce\
- rt-cms
- | | | | +---n certificate-exp\
- iration
- | | | | +-- expiration-date
- | | | | yang:date-\
- and-time
+ | | | | | end-entity\
+ \-cert-cms
+ | | | | +---n certificate-\
+ \expiration
+ | | | | +-- expiration-\
+
+ \date
+ | | | | yang:da\
+ \te-and-time
| | | +--:(keystore)
| | | {keystore-suppo\
- rted}?
- | | | +--rw reference?
+ \rted}?
+ | | | +--rw keystore-refere\
+ \nce?
| | | ks:asymmetric\
- -key-certificate-ref
- | | +--rw client-cert-auth
+ \-key-certificate-ref
+ | | +--rw ssh-client-cert-auth
| | | {sshcmn:ssh-x509-certs}?
| | | +--rw pinned-ca-certs?
| | | | ta:pinned-certificates-ref
| | | | {ta:x509-certificates}?
| | | +--rw pinned-client-certs?
| | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
- | | +--rw transport-params
- | | {ssh-server-transport-params-confi\
- g}?
- | | +--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 ssh-transport-params
+ | | | {ssh-server-transport-params-confi\
+ \g}?
+ | | | +--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 ssh-keepalives {ssh-server-keepalive\
+ \s}?
+ | | +--rw max-wait? uint16
+ | | +--rw max-attempts? uint8
| +--:(tls) {tls-call-home}?
| +--rw tls
- | +--rw address inet:host
- | +--rw port? inet:port-number
- | +--rw server-identity
+ | +--rw remote-address inet:host
+ | +--rw remote-port? inet:port-num\
+ \ber
+ | +--rw local-address? inet:ip-addre\
+ \ss
+ | +--rw local-port? inet:port-num\
+ \ber
+ | +--rw tcp-keepalives {tcp-client-keepalive\
+ \s}?
+ | | +--rw idle-time? uint16
+ | | +--rw max-probes? uint16
+ | | +--rw probe-interval? uint16
+ | +--rw tls-server-identity
| | +--rw (local-or-keystore)
| | +--:(local) {local-keys-supported}?
+ | | | +--rw local-definition
| | | +--rw algorithm?
- | | | | asymmetric-key-encryption\
- -algorithm-ref
+ | | | | asymmetric-key-algorit\
+ \hm-ref
| | | +--rw public-key?
| | | | binary
| | | +--rw private-key?
| | | | union
| | | +---x generate-hidden-key
| | | | +---w input
| | | | +---w algorithm
- | | | | asymmetric-key-encr\
- yption-algorithm-ref
+ | | | | asymmetric-key-a\
+ \lgorithm-ref
| | | +---x install-hidden-key
| | | | +---w input
| | | | +---w algorithm
- | | | | | asymmetric-key-encr\
- yption-algorithm-ref
- | | | | +---w public-key? binary
- | | | | +---w private-key? binary
+ | | | | | asymmetric-key-a\
+ \lgorithm-ref
+ | | | | +---w public-key? bin\
+ \ary
+ | | | | +---w private-key? bin\
+ \ary
| | | +--rw cert?
| | | | end-entity-cert-cms
| | | +---n certificate-expiration
| | | +-- expiration-date
| | | yang:date-and-time
| | +--:(keystore) {keystore-supported}?
- | | +--rw reference?
+ | | +--rw keystore-reference?
| | ks:asymmetric-key-certifi\
- cate-ref
- | +--rw client-auth
+ \cate-ref
+ | +--rw tls-client-auth
| | +--rw pinned-ca-certs?
| | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--rw pinned-client-certs?
| | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--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 tls-hello-params
+ | | {tls-server-hello-params-config}?
+ | | +--rw tls-versions
+ | | | +--rw tls-version* identityref
+ | | +--rw cipher-suites
+ | | +--rw cipher-suite* identityref
+ | +--rw tls-keepalives {tls-server-keepalive\
+ \s}?
+ | +--rw max-wait? uint16
+ | +--rw max-attempts? uint8
+--rw connection-type
| +--rw (connection-type)
| +--:(persistent-connection)
| | +--rw persistent!
- | | +--rw keep-alives
- | | +--rw max-wait? uint16
- | | +--rw max-attempts? uint8
| +--:(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
4.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 3.2
of [I-D.ietf-netconf-keystore].
- [Note: '\' line wrapping for formatting only]
+ ========== NOTE: '\\' line wrapping per BCP XX (RFC XXXX) ===========
netconf/ssh
- 192.0.2.7
-
+ 192.0.2.7
+
deployment-specific-certificate
- ct:rsa2048
+
+ ct:rsa2048
base64encodedvalue==
base64encodedvalue==
+
-
-
+
+
explicitly-trusted-client-ca-certs
+ \d-ca-certs>
explicitly-trusted-client-certs
-
+ \ed-client-certs>
+
netconf/tls
- 192.0.2.7
-
- ct:rsa2048
+ 192.0.2.7
+
+
+ ct:rsa2048
base64encodedvalue==
base64encodedvalue==
base64encodedvalue==
-
-
+
+
+
explicitly-trusted-client-ca-certs
+ \d-ca-certs>
explicitly-trusted-client-certs
+ \ed-client-certs>
1
11:0A:05:11:00
x509c2n:san-any
2
B3:4F:A1:8C:54
x509c2n:specified
scooby-doo
-
+
+
config-mgr
east-data-center
- east.config-mgr.example.com
-
+ east.config-mgr.example.com
+
deployment-specific-certificate
- ct:rsa2048
+
+ ct:rsa2048
base64encodedvalue==
base64encodedvalue==
+
-
-
+
+
explicitly-trusted-client-ca-certs
+ \inned-ca-certs>
explicitly-trusted-client-certs
-
+ \pinned-client-certs>
+
west-data-center
- west.config-mgr.example.com
-
+ west.config-mgr.example.com
+
deployment-specific-certificate
- ct:rsa2048
+
+ ct:rsa2048
base64encodedvalue==
base64encodedvalue==
-
+
-
-
+
+
explicitly-trusted-client-ca-certs
+ \inned-ca-certs>
explicitly-trusted-client-certs
-
+ \pinned-client-certs>
+
300
60
last-connected
3
data-collector
east-data-center
- east.analytics.example.com
-
- ct:rsa2048
+ east.analytics.example.com
+
+
+ ct:rsa2048
base64encodedvalue==
base64encodedvalue==
base64encodedvalue==
-
-
+
+
+
explicitly-trusted-client-ca-certs
+ \inned-ca-certs>
explicitly-trusted-client-certs
+ \pinned-client-certs>
1
11:0A:05:11:00
x509c2n:san-any
2
B3:4F:A1:8C:54
x509c2n:specified
scooby-doo
-
+
+
+ 15
+ 3
+ 30
+
+
+ 30
+ 3
+
west-data-center
- west.analytics.example.com
-
- ct:rsa2048
+ west.analytics.example.com
+
+
+ ct:rsa2048
base64encodedvalue==
base64encodedvalue==
base64encodedvalue==
-
-
+
+
+
explicitly-trusted-client-ca-certs
+ \inned-ca-certs>
explicitly-trusted-client-certs
+ \pinned-client-certs>
1
11:0A:05:11:00
x509c2n:san-any
2
B3:4F:A1:8C:54
x509c2n:specified
scooby-doo
-
+
+
+ 15
+ 3
+ 30
+
+
+ 30
+ 3
+
-
-
- 30
- 3
-
-
-
+
first-listed
3
4.3. YANG Module
This YANG module has normative references to [RFC6242], [RFC6991],
[RFC7407], [RFC7589], [RFC8071],
+ [I-D.kwatsen-netconf-tcp-client-server],
[I-D.ietf-netconf-ssh-client-server], and
[I-D.ietf-netconf-tls-client-server].
This YANG module imports YANG types from [RFC6991], and YANG
groupings from [RFC7407], [I-D.ietf-netconf-ssh-client-server] and
[I-D.ietf-netconf-ssh-client-server].
- file "ietf-netconf-server@2018-10-22.yang"
+ file "ietf-netconf-server@2019-03-09.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-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-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-server {
- prefix ss;
- revision-date 2018-10-22; // stable grouping definitions
+ prefix sshs;
+ revision-date 2019-03-09; // stable grouping definitions
reference
"RFC YYYY: YANG Groupings for SSH Clients and SSH Servers";
}
import ietf-tls-server {
- prefix ts;
- revision-date 2018-10-22; // stable grouping definitions
+ prefix tlss;
+ revision-date 2019-03-09; // stable grouping definitions
reference
"RFC ZZZZ: YANG Groupings for TLS Clients and TLS Servers";
}
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web:
WG List:
-
- Author: Kent Watsen
-
-
- Author: Gary Wu
-
-
+ Author: Kent Watsen
+ Author: Gary Wu
Author: Juergen Schoenwaelder
";
description
"This module contains a collection of YANG definitions for
configuring NETCONF servers.
- Copyright (c) 2017 IETF Trust and the persons identified as
+ 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.
+
+ 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
(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 "2018-10-22" {
+ revision "2019-03-09" {
description
"Initial version";
reference
"RFC XXXX: NETCONF Client and Server Models";
}
// Features
feature listen {
description
@@ -1875,29 +1999,21 @@
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 8071: NETCONF Call Home and RESTCONF Call Home";
}
- // protocol accessible nodes
-
- container netconf-server {
- uses netconf-server-grouping;
- description
- "Top-level container for NETCONF server configuration.";
- }
-
- // reusable groupings
+ // Groupings
grouping netconf-server-grouping {
description
"Top-level grouping for NETCONF server configuration.";
container listen {
if-feature listen;
presence "Enables server to listen for TCP connections";
description "Configures listen behavior";
leaf idle-timeout {
type uint16;
@@ -1925,77 +2041,55 @@
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.";
- leaf address {
- type inet:ip-address;
- mandatory true;
- description
- "The IP address to listen on for incoming
- connections. The NETCONF server will listen
- on all configured interfaces if no value is
- specified. INADDR_ANY (0.0.0.0) or INADDR6_ANY
- (0:0:0:0:0:0:0:0 a.k.a. ::) MUST be used when
- the server is to listen on all IPv4 or IPv6
- addresses, respectively.";
- }
- leaf port {
- type inet:port-number;
+ uses tcps:tcp-server-grouping {
+ refine "local-port" {
default 830;
description
- "The local port number to listen on. If no value
- is specified, the IANA-assigned port value for
- 'netconf-ssh' (830) is used.";
+ "The NETCONF server will listen on the IANA-
+ assigned well-known port value for 'netconf-ssh'
+ (830) if no value is specified.";
}
- uses ss:ssh-server-grouping;
+ }
+ uses sshs:ssh-server-grouping;
}
}
case tls {
if-feature tls-listen;
container tls {
description
"TLS-specific listening configuration for inbound
connections.";
- leaf address {
- type inet:ip-address;
- mandatory true;
- description
- "The IP address to listen on for incoming
- connections. The NETCONF server will listen
- on all configured interfaces if no value is
- specified. INADDR_ANY (0.0.0.0) or INADDR6_ANY
- (0:0:0:0:0:0:0:0 a.k.a. ::) MUST be used when
- the server is to listen on all IPv4 or IPv6
- addresses, respectively.";
- }
- leaf port {
- type inet:port-number;
+ uses tcps:tcp-server-grouping {
+ refine "local-port" {
default 6513;
description
- "The local port number to listen on. If no value
- is specified, the IANA-assigned port value for
- 'netconf-tls' (6513) is used.";
+ "The NETCONF server will listen on the IANA-
+ assigned well-known port value for 'netconf-tls'
+ (6513) if no value is specified.";
}
- uses ts:tls-server-grouping {
- refine "client-auth" {
+ }
+ uses tlss:tls-server-grouping {
+ refine "tls-client-auth" {
must 'pinned-ca-certs or pinned-client-certs';
description
"NETCONF/TLS servers MUST validate client
certiticates.";
}
- augment "client-auth" {
+ augment "tls-client-auth" {
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-
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
@@ -2048,81 +2142,57 @@
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.";
- leaf address {
- type inet:host;
- mandatory true;
- description
- "The IP address or hostname of the endpoint.
- If a domain name is configured, then the
- DNS resolution should happen on each usage
- attempt. If the the DNS resolution results
- in multiple IP addresses, the IP addresses
- will be tried according to local preference
- order until a connection has been established
- or until all IP addresses have failed.";
- }
- leaf port {
- type inet:port-number;
+ uses tcpc:tcp-client-grouping {
+ refine "remote-port" {
default 4334;
description
- "The IP port for this endpoint. The NETCONF
- server will use the IANA-assigned well-known
- port for 'netconf-ch-ssh' (4334) if no value
- is specified.";
+ "The NETCONF server will attempt to connect
+ to the IANA-assigned well-known port for
+ 'netconf-ch-tls' (4334) if no value is
+ specified.";
}
- uses ss:ssh-server-grouping;
+ }
+ uses sshs:ssh-server-grouping;
}
}
case tls {
if-feature tls-call-home;
container tls {
description
"Specifies TLS-specific call-home transport
configuration.";
- leaf address {
- type inet:host;
- mandatory true;
- description
- "The IP address or hostname of the endpoint.
- If a domain name is configured, then the
- DNS resolution should happen on each usage
- attempt. If the the DNS resolution results
- in multiple IP addresses, the IP addresses
- will be tried according to local preference
- order until a connection has been established
- or until all IP addresses have failed.";
- }
- leaf port {
- type inet:port-number;
+ uses tcpc:tcp-client-grouping {
+ refine "remote-port" {
default 4335;
description
- "The IP port for this endpoint. The NETCONF
- server will use the IANA-assigned well-known
- port for 'netconf-ch-tls' (4335) if no value
- is specified.";
+ "The NETCONF server will attempt to connect
+ to the IANA-assigned well-known port for
+ 'netconf-ch-tls' (4335) if no value is
+ specified.";
}
- uses ts:tls-server-grouping {
- refine "client-auth" {
+ }
+ uses tlss:tls-server-grouping {
+ refine "tls-client-auth" {
must 'pinned-ca-certs or pinned-client-certs';
description
"NETCONF/TLS servers MUST validate client
certiticates.";
}
- augment "client-auth" {
+ augment "tls-client-auth" {
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-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
@@ -2125,85 +2195,53 @@
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";
+
}
}
}
}
- } // end tls
- } // end choice
- } // end endpoint
- }
+ } // tls
+ } // choice
+ } // endpoint
+ } // endpoints
container connection-type {
description
- "Indicates the kind of connection to use.";
+ "Indicates the NETCONF server's preference for how the
+ NETCONF connection is maintained.";
choice connection-type {
mandatory true;
description
"Selects between available connection types.";
case persistent-connection {
container persistent {
presence
"Indicates that a persistent connection is to be
maintained.";
description
"Maintain a persistent connection to the NETCONF
client. If the connection goes down, immediately
start trying to reconnect to it, using the
reconnection strategy.
This connection type minimizes any NETCONF client
to NETCONF server data-transfer delay, albeit at
the expense of holding resources longer.";
- 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 8071: NETCONF Call Home and RESTCONF
- Call Home, Section 4.1, item S7";
- 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 client, a SSH/TLS-level message
- will be sent to test the aliveness of the
- SSH/TLS client.";
- }
- 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 client before
- assuming the SSH/TLS client is no longer
- alive.";
- }
- }
- }
- }
+ } // container persistent
+ } // case persistent-connection
case periodic-connection {
container periodic {
presence
"Indicates that a periodic connection is to be
maintained.";
description
"Periodically connect to the NETCONF client. The
NETCONF client should close the underlying TLS
connection upon completing planned activities.
@@ -2239,25 +2277,24 @@
units "seconds";
default 120; // two minutes
description
"Specifies the maximum number of seconds that
a NETCONF session may remain idle. A NETCONF
session will be dropped if it is idle for an
interval longer than this number of seconds.
If set to zero, then the server will never
drop a session because it is idle.";
}
- }
- }
- }
-
- }
+ } // container periodic
+ } // case periodic-connection
+ } // choice connection-type
+ } // container connection-type
container reconnect-strategy {
description
"The reconnection strategy directs how a NETCONF server
reconnects to a NETCONF client, after discovering its
connection to the client has dropped, even if due to a
reboot. The NETCONF server starts with the specified
endpoint and tries to connect to it max-attempts times
before trying the next endpoint in the list (round
robin).";
leaf start-with {
@@ -2291,25 +2328,35 @@
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 in the list (round robin).";
}
+ } // container reconnect-strategy
+ } // list netconf-client
+ } // container call-home
+ } // grouping netconf-server-grouping
+
+ // Protocol accessible node, for servers that *implement*
+ // this module.
+
+ container netconf-server {
+ uses netconf-server-grouping;
+ description
+ "Top-level container for NETCONF server configuration.";
}
- }
- }
- }
+
}
5. Design Considerations
Editorial: this section is a hold over from before, previously called
"Objectives". It was only written two support the "server" (not the
"client"). The question is if it's better to add the missing
"client" parts, or remove this section altogether.
@@ -2516,32 +2563,37 @@
namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-server
prefix: ncs
reference: RFC XXXX
8. References
8.1. Normative References
[I-D.ietf-netconf-keystore]
Watsen, K., "YANG Data Model for a Centralized Keystore
- Mechanism", draft-ietf-netconf-keystore-06 (work in
- progress), September 2018.
+ Mechanism", draft-ietf-netconf-keystore-08 (work in
+ progress), March 2019.
[I-D.ietf-netconf-ssh-client-server]
- Watsen, K. and G. Wu, "YANG Groupings for SSH Clients and
- SSH Servers", draft-ietf-netconf-ssh-client-server-07
- (work in progress), September 2018.
+ Watsen, K., Wu, G., and L. Xia, "YANG Groupings for SSH
+ Clients and SSH Servers", draft-ietf-netconf-ssh-client-
+ server-08 (work in progress), October 2018.
[I-D.ietf-netconf-tls-client-server]
- Watsen, K. and G. Wu, "YANG Groupings for TLS Clients and
- TLS Servers", draft-ietf-netconf-tls-client-server-07
- (work in progress), September 2018.
+ Watsen, K., Wu, G., and L. Xia, "YANG Groupings for TLS
+ Clients and TLS Servers", draft-ietf-netconf-tls-client-
+ server-08 (work in progress), October 2018.
+
+ [I-D.kwatsen-netconf-tcp-client-server]
+ Watsen, K., "YANG Groupings for TCP Clients and TCP
+ Servers", draft-kwatsen-netconf-tcp-client-server-00 (work
+ in progress), March 2019.
[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,
.
@@ -2607,21 +2659,21 @@
o Renamed "keychain" to "keystore".
A.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 accomodate new groupings in the ssh/tls
+ o Updated both modules to accommodate new groupings in the ssh/tls
drafts.
A.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).
A.4. 03 to 04
@@ -2665,24 +2717,37 @@
o Reduced the periodic-connection's "idle-timeout" from 5 to 2
minutes.
o Replaced reconnect-timeout with period/anchor-time combo.
A.8. 07 to 08
o Modified examples to be compatible with new crypto-types algs
+Appendix B. 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.
+
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, Mehmet Ersue, Balazs Kovacs, David
- Lamparter, Alan Luchuk, Ladislav Lhotka, Radek Krejci, Tom Petch,
- Juergen Schoenwaelder, Phil Shafer, Sean Turner, and Bert Wijnen.
+ 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
- Juniper Networks
+ Watsen Networks
- EMail: kwatsen@juniper.net
+ EMail: kent+ietf@watsen.net