draft-ietf-netconf-restconf-client-server-06.txt   draft-ietf-netconf-restconf-client-server-07.txt 
NETCONF Working Group K. Watsen NETCONF Working Group K. Watsen
Internet-Draft Juniper Networks Internet-Draft Juniper Networks
Intended status: Standards Track G. Wu Intended status: Standards Track September 20, 2018
Expires: December 6, 2018 Cisco Networks Expires: March 24, 2019
June 4, 2018
RESTCONF Client and Server Models RESTCONF Client and Server Models
draft-ietf-netconf-restconf-client-server-06 draft-ietf-netconf-restconf-client-server-07
Abstract Abstract
This document defines two YANG modules, one module to configure a This document defines two YANG modules, one module to configure a
RESTCONF client and the other module to configure a RESTCONF server. RESTCONF client and the other module to configure a RESTCONF server.
Both modules support the TLS transport protocol with both standard Both modules support the TLS transport protocol with both standard
RESTCONF and RESTCONF Call Home connections. RESTCONF and RESTCONF Call Home connections.
Editorial Note (To be removed by RFC Editor) Editorial Note (To be removed by RFC Editor)
skipping to change at page 1, line 46 skipping to change at page 1, line 45
progress. Please apply the following replacements: progress. Please apply the following replacements:
o "XXXX" --> the assigned RFC value for this draft o "XXXX" --> the assigned RFC value for this draft
o "ZZZZ" --> the assigned RFC value for I-D.ietf-netconf-tls-client- o "ZZZZ" --> the assigned RFC value for I-D.ietf-netconf-tls-client-
server server
Artwork in this document contains placeholder values for the date of Artwork in this document contains placeholder values for the date of
publication of this draft. Please apply the following replacement: publication of this draft. Please apply the following replacement:
o "2018-06-04" --> the publication date of this draft o "2018-09-20" --> the publication date of this draft
The following Appendix section is to be removed prior to publication: The following Appendix section is to be removed prior to publication:
o Appendix A. Change Log o Appendix A. Change Log
Status of This Memo Status of This Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on December 6, 2018. This Internet-Draft will expire on March 24, 2019.
Copyright Notice Copyright Notice
Copyright (c) 2018 IETF Trust and the persons identified as the Copyright (c) 2018 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
skipping to change at page 2, line 45 skipping to change at page 2, line 43
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
2. The RESTCONF Client Model . . . . . . . . . . . . . . . . . . 3 2. The RESTCONF Client Model . . . . . . . . . . . . . . . . . . 3
2.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 4 2.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 4
2.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 6 2.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 7
2.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 8 2.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 9
3. The RESTCONF Server Model . . . . . . . . . . . . . . . . . . 17 3. The RESTCONF Server Model . . . . . . . . . . . . . . . . . . 18
3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 17 3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 18
3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 20 3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 21
3.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 23 3.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 24
4. Security Considerations . . . . . . . . . . . . . . . . . . . 32 4. Security Considerations . . . . . . . . . . . . . . . . . . . 34
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 33 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 35
5.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 33 5.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 35
5.2. The YANG Module Names Registry . . . . . . . . . . . . . 34 5.2. The YANG Module Names Registry . . . . . . . . . . . . . 35
6. References . . . . . . . . . . . . . . . . . . . . . . . . . 34
6.1. Normative References . . . . . . . . . . . . . . . . . . 34 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 36
6.2. Informative References . . . . . . . . . . . . . . . . . 35 6.1. Normative References . . . . . . . . . . . . . . . . . . 36
Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 37 6.2. Informative References . . . . . . . . . . . . . . . . . 37
A.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 37 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 38
A.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 37 A.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 38
A.3. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 37 A.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 38
A.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 37 A.3. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 38
A.5. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 37 A.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 38
A.6. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 38 A.5. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 38
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 38 A.6. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 39
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 38 A.7. 06 to 07 . . . . . . . . . . . . . . . . . . . . . . . . 39
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 39
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 39
1. Introduction 1. Introduction
This document defines two YANG [RFC7950] modules, one module to This document defines two YANG [RFC7950] modules, one module to
configure a RESTCONF client and the other module to configure a configure a RESTCONF client and the other module to configure a
RESTCONF server [RFC8040]. Both modules support the TLS [RFC5246] RESTCONF server [RFC8040]. Both modules support the TLS [RFC8446]
transport protocol with both standard RESTCONF and RESTCONF Call Home transport protocol with both standard RESTCONF and RESTCONF Call Home
connections [RFC8071]. connections [RFC8071].
1.1. Terminology 1.1. Terminology
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP "OPTIONAL" in this document are to be interpreted as described in BCP
14 [RFC2119] [RFC8174] when, and only when, they appear in all 14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here. capitals, as shown here.
skipping to change at page 4, line 9 skipping to change at page 4, line 9
All private keys and trusted certificates are held in the keystore All private keys and trusted certificates are held in the keystore
model defined in [I-D.ietf-netconf-keystore]. model defined in [I-D.ietf-netconf-keystore].
YANG feature statements are used to enable implementations to YANG feature statements are used to enable implementations to
advertise which parts of the model the RESTCONF client supports. advertise which parts of the model the RESTCONF client supports.
2.1. Tree Diagram 2.1. Tree Diagram
The following tree diagram [RFC8340] provides an overview of the data The following tree diagram [RFC8340] provides an overview of the data
model for the "ietf-restconf-client" module. Just the container is model for the "ietf-restconf-client" module. Just the container is
displayed below, but there is also a reuable grouping by the same displayed below, but there is also a reusable grouping called
name that the container is using. "restconf-client-grouping" that the container is using.
[Note: '\' line wrapping for formatting only] [Note: '\' line wrapping for formatting only]
module: ietf-restconf-client module: ietf-restconf-client
+--rw restconf-client +--rw restconf-client
+--rw initiate! {initiate}? +--rw initiate! {initiate}?
| +--rw restconf-server* [name] | +--rw restconf-server* [name]
| +--rw name string | +--rw name string
| +--rw endpoints | +--rw endpoints
| +--rw endpoint* [name] | +--rw endpoint* [name]
skipping to change at page 4, line 33 skipping to change at page 4, line 33
| | +--:(tls) {tls-initiate}? | | +--:(tls) {tls-initiate}?
| | +--rw tls | | +--rw tls
| | +--rw address inet:host | | +--rw address inet:host
| | +--rw port? inet:port-number | | +--rw port? inet:port-number
| | +--rw client-identity | | +--rw client-identity
| | | +--rw (auth-type) | | | +--rw (auth-type)
| | | +--:(certificate) | | | +--:(certificate)
| | | +--rw certificate | | | +--rw certificate
| | | +--rw (local-or-keystore) | | | +--rw (local-or-keystore)
| | | +--:(local) | | | +--:(local)
| | | | +--rw algorithm | | | | {local-keys-suppor\
ted}?
| | | | +--rw algorithm?
| | | | | ct:key-algorithm\ | | | | | ct:key-algorithm\
-ref -ref
| | | | +--rw public-key | | | | +--rw public-key?
| | | | | binary | | | | | binary
| | | | +--rw private-key | | | | +--rw private-key?
| | | | | union | | | | | union
| | | | +---x generate-hidden-key
| | | | | +---w input
| | | | | +---w algorithm
| | | | | ct:key-alg\
orithm-ref
| | | | +---x install-hidden-key
| | | | | +---w input
| | | | | +---w algorithm
| | | | | | ct:key-alg\
orithm-ref
| | | | | +---w public-key?
| | | | | | binary
| | | | | +---w private-key?
| | | | | binary
| | | | +--rw cert | | | | +--rw cert
| | | | | ct:end-entity-ce\ | | | | | ct:end-entity-ce\
rt-cms rt-cms
| | | | +---n certificate-expira\ | | | | +---n certificate-expira\
tion tion
| | | | +-- expiration-date? | | | | +-- expiration-date?
| | | | yang:date-and\ | | | | yang:date-and\
-time -time
| | | +--:(keystore) | | | +--:(keystore)
| | | {keystore-implemen\ | | | {keystore-supporte\
ted}? d}?
| | | +--rw reference | | | +--rw reference?
| | | ks:asymmetric-ke\ | | | ks:asymmetric-ke\
y-certificate-ref y-certificate-ref
| | +--rw server-auth | | +--rw server-auth
| | | +--rw pinned-ca-certs? | | | +--rw pinned-ca-certs?
| | | | ta:pinned-certificates-ref | | | | ta:pinned-certificates-ref
| | | | {ta:x509-certificates}?
| | | +--rw pinned-server-certs? | | | +--rw pinned-server-certs?
| | | ta:pinned-certificates-ref | | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--rw hello-params | | +--rw hello-params
| | {tls-client-hello-params-config}? | | {tls-client-hello-params-config}?
| | +--rw tls-versions | | +--rw tls-versions
| | | +--rw tls-version* identityref | | | +--rw tls-version* identityref
| | +--rw cipher-suites | | +--rw cipher-suites
| | +--rw cipher-suite* identityref | | +--rw cipher-suite* identityref
| +--rw connection-type | +--rw connection-type
| | +--rw (connection-type)? | | +--rw (connection-type)
| | +--:(persistent-connection) | | +--:(persistent-connection)
| | | +--rw persistent! | | | +--rw persistent!
| | | +--rw idle-timeout? uint32
| | | +--rw keep-alives | | | +--rw keep-alives
| | | +--rw max-wait? uint16 | | | +--rw max-wait? uint16
| | | +--rw max-attempts? uint8 | | | +--rw max-attempts? uint8
| | +--:(periodic-connection) | | +--:(periodic-connection)
| | +--rw periodic! | | +--rw periodic!
| | +--rw idle-timeout? uint16 | | +--rw period? uint16
| | +--rw reconnect-timeout? uint16 | | +--rw anchor-time? yang:date-and-time
| | +--rw idle-timeout? uint16
| +--rw reconnect-strategy | +--rw reconnect-strategy
| +--rw start-with? enumeration | +--rw start-with? enumeration
| +--rw max-attempts? uint8 | +--rw max-attempts? uint8
+--rw listen! {listen}? +--rw listen! {listen}?
+--rw idle-timeout? uint16 +--rw idle-timeout? uint16
+--rw endpoint* [name] +--rw endpoint* [name]
+--rw name string +--rw name string
+--rw (transport) +--rw (transport)
+--:(tls) {tls-listen}? +--:(tls) {tls-listen}?
+--rw tls +--rw tls
+--rw address? inet:ip-address +--rw address? inet:ip-address
+--rw port? inet:port-number +--rw port? inet:port-number
+--rw client-identity +--rw client-identity
| +--rw (auth-type) | +--rw (auth-type)
| +--:(certificate) | +--:(certificate)
| +--rw certificate | +--rw certificate
| +--rw (local-or-keystore) | +--rw (local-or-keystore)
| +--:(local) | +--:(local) {local-keys-supported\
| | +--rw algorithm }?
| | +--rw algorithm?
| | | ct:key-algorithm-ref | | | ct:key-algorithm-ref
| | +--rw public-key | | +--rw public-key?
| | | binary | | | binary
| | +--rw private-key | | +--rw private-key?
| | | union | | | union
| | +---x generate-hidden-key
| | | +---w input
| | | +---w algorithm
| | | ct:key-algorithm\
-ref
| | +---x install-hidden-key
| | | +---w input
| | | +---w algorithm
| | | | ct:key-algorithm\
-ref
| | | +---w public-key? bin\
ary
| | | +---w private-key? bin\
ary
| | +--rw cert | | +--rw cert
| | | ct:end-entity-cert-cms\ | | | ct:end-entity-cert-cms
| | +---n certificate-expiration | | +---n certificate-expiration
| | +-- expiration-date? | | +-- expiration-date?
| | yang:date-and-time | | yang:date-and-time
| +--:(keystore) | +--:(keystore) {keystore-supporte\
| {keystore-implemented}? d}?
| +--rw reference | +--rw reference?
| ks:asymmetric-key-cert\ | ks:asymmetric-key-cert\
ificate-ref ificate-ref
+--rw server-auth +--rw server-auth
| +--rw pinned-ca-certs? | +--rw pinned-ca-certs?
| | ta:pinned-certificates-ref | | ta:pinned-certificates-ref
| | {ta:x509-certificates}?
| +--rw pinned-server-certs? | +--rw pinned-server-certs?
| ta:pinned-certificates-ref | ta:pinned-certificates-ref
| {ta:x509-certificates}?
+--rw hello-params +--rw hello-params
{tls-client-hello-params-config}? {tls-client-hello-params-config}?
+--rw tls-versions +--rw tls-versions
| +--rw tls-version* identityref | +--rw tls-version* identityref
+--rw cipher-suites +--rw cipher-suites
+--rw cipher-suite* identityref +--rw cipher-suite* identityref
2.2. Example Usage 2.2. Example Usage
The following example illustrates configuring a RESTCONF client to The following example illustrates configuring a RESTCONF client to
initiate connections, as well as listening for call-home connections. initiate connections, as well as listening for call-home connections.
This example is consistent with the examples presented in Section 2.2 This example is consistent with the examples presented in Section 3.2
of [I-D.ietf-netconf-keystore]. of [I-D.ietf-netconf-keystore].
[Note: '\' line wrapping for formatting only] [Note: '\' line wrapping for formatting only]
<restconf-client <restconf-client
xmlns="urn:ietf:params:xml:ns:yang:ietf-restconf-client"> xmlns="urn:ietf:params:xml:ns:yang:ietf-restconf-client">
<!-- RESTCONF servers to initiate connections to --> <!-- RESTCONF servers to initiate connections to -->
<initiate> <initiate>
<restconf-server> <restconf-server>
<name>corp-fw1</name> <name>corp-fw1</name>
<endpoints> <endpoints>
<endpoint> <endpoint>
<name>corp-fw1.example.com</name> <name>corp-fw1.example.com</name>
<tls> <tls>
<address>corp-fw1.example.com</address> <address>corp-fw1.example.com</address>
<client-identity> <client-identity>
<certificate> <certificate>
<algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:i\ <algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:iet\
etf-crypto-types">ct:secp521r1</algorithm> f-crypto-types">ct:secp521r1</algorithm>
<private-key>base64encodedvalue==</private-key> <private-key>base64encodedvalue==</private-key>
<public-key>base64encodedvalue==</public-key> <public-key>base64encodedvalue==</public-key>
<cert>base64encodedvalue==</cert> <cert>base64encodedvalue==</cert>
</certificate> </certificate>
</client-identity> </client-identity>
<server-auth> <server-auth>
<pinned-ca-certs>explicitly-trusted-server-ca-certs<\ <pinned-ca-certs>explicitly-trusted-server-ca-certs</p\
/pinned-ca-certs> inned-ca-certs>
<pinned-server-certs>explicitly-trusted-server-certs\ <pinned-server-certs>explicitly-trusted-server-certs</\
</pinned-server-certs> pinned-server-certs>
</server-auth> </server-auth>
</tls>
</endpoint> </tls>
<endpoint> <connection-type>
<name>corp-fw2.example.com</name> <persistent/>
<tls> </connection-type>
<address>corp-fw2.example.com</address> </endpoint>
<client-identity> <endpoint>
<certificate> <name>corp-fw2.example.com</name>
<algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:i\ <tls>
etf-crypto-types">ct:secp521r1</algorithm> <address>corp-fw2.example.com</address>
<private-key>base64encodedvalue==</private-key> <client-identity>
<public-key>base64encodedvalue==</public-key> <certificate>
<cert>base64encodedvalue==</cert> <algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:iet\
</certificate> f-crypto-types">ct:secp521r1</algorithm>
</client-identity> <private-key>base64encodedvalue==</private-key>
<server-auth> <public-key>base64encodedvalue==</public-key>
<pinned-ca-certs>explicitly-trusted-server-ca-certs<\ <cert>base64encodedvalue==</cert>
/pinned-ca-certs> </certificate>
<pinned-server-certs>explicitly-trusted-server-certs\ </client-identity>
</pinned-server-certs> <server-auth>
</server-auth> <pinned-ca-certs>explicitly-trusted-server-ca-certs</p\
</tls> inned-ca-certs>
</endpoint> <pinned-server-certs>explicitly-trusted-server-certs</\
</endpoints> pinned-server-certs>
</server-auth>
</tls>
<connection-type>
<persistent/>
</connection-type>
</endpoint>
</endpoints>
</restconf-server> </restconf-server>
</initiate> </initiate>
<!-- endpoints to listen for RESTCONF Call Home connections on -->\ <!-- endpoints to listen for RESTCONF Call Home connections on -->
<listen> <listen>
<endpoint> <endpoint>
<name>Intranet-facing listener</name> <name>Intranet-facing listener</name>
<tls> <tls>
<address>11.22.33.44</address> <address>11.22.33.44</address>
<client-identity> <client-identity>
<certificate> <certificate>
<algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-cr\ <algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-cr\
ypto-types">ct:secp521r1</algorithm> ypto-types">ct:secp521r1</algorithm>
<private-key>base64encodedvalue==</private-key> <private-key>base64encodedvalue==</private-key>
skipping to change at page 8, line 29 skipping to change at page 9, line 20
</tls> </tls>
</endpoint> </endpoint>
</listen> </listen>
</restconf-client> </restconf-client>
2.3. YANG Module 2.3. YANG Module
This YANG module has normative references to [RFC6991], [RFC8040], This YANG module has normative references to [RFC6991], [RFC8040],
and [RFC8071], and [I-D.ietf-netconf-tls-client-server]. and [RFC8071], and [I-D.ietf-netconf-tls-client-server].
<CODE BEGINS> file "ietf-restconf-client@2018-06-04.yang" <CODE BEGINS> file "ietf-restconf-client@2018-09-20.yang"
module ietf-restconf-client { module ietf-restconf-client {
yang-version 1.1; yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-restconf-client"; namespace "urn:ietf:params:xml:ns:yang:ietf-restconf-client";
prefix "rcc"; prefix "rcc";
import ietf-yang-types {
prefix yang;
reference
"RFC 6991: Common YANG Data Types";
}
import ietf-inet-types { import ietf-inet-types {
prefix inet; prefix inet;
reference reference
"RFC 6991: Common YANG Data Types"; "RFC 6991: Common YANG Data Types";
} }
import ietf-tls-client { import ietf-tls-client {
prefix ts; prefix ts;
revision-date 2018-06-04; // stable grouping definitions revision-date 2018-09-20; // stable grouping definitions
reference reference
"RFC ZZZZ: YANG Groupings for TLS Clients and TLS Servers"; "RFC ZZZZ: YANG Groupings for TLS Clients and TLS Servers";
} }
organization organization
"IETF NETCONF (Network Configuration) Working Group"; "IETF NETCONF (Network Configuration) Working Group";
contact contact
"WG Web: <http://datatracker.ietf.org/wg/restconf/> "WG Web: <http://datatracker.ietf.org/wg/restconf/>
WG List: <mailto:restconf@ietf.org> WG List: <mailto:restconf@ietf.org>
skipping to change at page 9, line 32 skipping to change at page 10, line 27
Redistribution and use in source and binary forms, with or Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD to the license terms contained in, the Simplified BSD
License set forth in Section 4.c of the IETF Trust's License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents Legal Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info). (http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices."; the RFC itself for full legal notices.";
revision "2018-06-04" { revision "2018-09-20" {
description description
"Initial version"; "Initial version";
reference reference
"RFC XXXX: RESTCONF Client and Server Models"; "RFC XXXX: RESTCONF Client and Server Models";
} }
// Features // Features
feature initiate { feature initiate {
description description
skipping to change at page 10, line 32 skipping to change at page 11, line 28
"The 'tls-listen' feature indicates that the RESTCONF client "The 'tls-listen' feature indicates that the RESTCONF client
supports opening a port to listen for incoming RESTCONF supports opening a port to listen for incoming RESTCONF
server call-home TLS connections. This feature exists as server call-home TLS connections. This feature exists as
TLS might not be a mandatory to implement transport in the TLS might not be a mandatory to implement transport in the
future."; future.";
reference reference
"RFC 8071: NETCONF Call Home and RESTCONF Call Home"; "RFC 8071: NETCONF Call Home and RESTCONF Call Home";
} }
container restconf-client { container restconf-client {
uses restconf-client; uses restconf-client-grouping;
description description
"Top-level container for RESTCONF client configuration."; "Top-level container for RESTCONF client configuration.";
} }
grouping restconf-client { grouping restconf-client-grouping {
description description
"Top-level grouping for RESTCONF client configuration."; "Top-level grouping for RESTCONF client configuration.";
container initiate { container initiate {
if-feature initiate; if-feature initiate;
presence "Enables client to initiate TCP connections"; presence "Enables client to initiate TCP connections";
description description
"Configures client initiating underlying TCP connections."; "Configures client initiating underlying TCP connections.";
list restconf-server { list restconf-server {
key name; key name;
skipping to change at page 12, line 26 skipping to change at page 13, line 22
authentication credentials."; authentication credentials.";
} }
} }
} }
} // end tls } // end tls
} // end transport } // end transport
container connection-type { container connection-type {
description description
"Indicates the kind of connection to use."; "Indicates the kind of connection to use.";
choice connection-type { choice connection-type {
default persistent-connection; mandatory true;
description description
"Selects between available connection types."; "Selects between available connection types.";
case persistent-connection { case persistent-connection {
container persistent { container persistent {
presence presence
"Indicates that a persistent connection is "Indicates that a persistent connection is
to be maintained."; to be maintained.";
description description
"Maintain a persistent connection to the "Maintain a persistent connection to the
RESTCONF server. If the connection goes down, RESTCONF server. If the connection goes down,
immediately start trying to reconnect to it, immediately start trying to reconnect to it,
using the reconnection strategy. This using the reconnection strategy. This
connection type minimizes any RESTCONF server connection type minimizes any RESTCONF server
to RESTCONF client data-transfer delay, albeit to RESTCONF client data-transfer delay, albeit
at the expense of holding resources longer."; 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 the underlying TLS session may remain
idle. A TLS 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 { container keep-alives {
description description
"Configures the keep-alive policy, to "Configures the keep-alive policy, to
proactively test the aliveness of the TLS proactively test the aliveness of the TLS
server. An unresponsive TLS server will server. An unresponsive TLS server will
be dropped after approximately max-attempts be dropped after approximately max-attempts
* max-wait seconds."; * max-wait seconds.";
reference
"RFC 8071: NETCONF Call Home and RESTCONF
Call Home, Section 3.1, item S6";
leaf max-wait { leaf max-wait {
type uint16 { type uint16 {
range "1..max"; range "1..max";
} }
units seconds; units seconds;
default 30; default 30;
description description
"Sets the amount of time in seconds after "Sets the amount of time in seconds after
which if no data has been received from which if no data has been received from
the TLS server, a TLS-level message will the TLS server, a TLS-level message will
skipping to change at page 13, line 51 skipping to change at page 14, line 29
} }
} }
} }
} }
case periodic-connection { case periodic-connection {
container periodic { container periodic {
presence presence
"Indicates that a periodic connection is to be "Indicates that a periodic connection is to be
maintained."; maintained.";
description description
"Periodically connect to the RESTCONF server, "Periodically connect to the NETCONF server.
so that, e.g., the RESTCONF client can The RESTCONF server should close the underlying
collect data (logs) from the RESTCONF server. TLS connection upon completing planned
Once the connection is closed, for whatever activities.
reason, the RESTCONF client will restart its
timer until the next connection."; This connection type increases resource
utilization, albeit with increased delay in
RESTCONF server to RESTCONF client
interactions.";
leaf period {
type uint16;
units "minutes";
default 60;
description
"Duration of time between periodic
connections.";
}
leaf anchor-time {
type yang:date-and-time {
// constrained to minute-level granularity
pattern '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}'
+ '(Z|[\+\-]\d{2}:\d{2})';
}
description
"Designates a timestamp before or after which
a series of periodic connections are
determined. The periodic connections occur
at a whole multiple interval from the anchor
time. For example, for an anchor time is 15
minutes past midnight and a period interval
of 24 hours, then a periodic connection will
occur 15 minutes past midnight everyday.";
}
leaf idle-timeout { leaf idle-timeout {
type uint16; type uint16;
units "seconds"; units "seconds";
default 300; // five minutes default 120; // two minutes
description description
"Specifies the maximum number of seconds "Specifies the maximum number of seconds
that the underlying TLS session may remain that the underlying TLS session may remain
idle. A TLS session will be dropped if it idle. A TLS session will be dropped if it
is idle for an interval longer than this is idle for an interval longer than this
number of seconds If set to zero, then the number of seconds If set to zero, then the
server will never drop a session because RESTCONF client will never drop a session
it is idle."; because it is idle.";
}
leaf reconnect-timeout {
type uint16 {
range "1..max";
}
units minutes;
default 60;
description
"Sets the maximum amount of unconnected time
the RESTCONF client will wait before re-
establishing a connection to the RESTCONF
server. The RESTCONF client may initiate
a connection before this time if desired
(e.g., to set configuration).";
} }
} }
} // end periodic-connection } // end periodic-connection
} // end connection-type } // end connection-type
} // end connection-type } // end connection-type
container reconnect-strategy { container reconnect-strategy {
description description
"The reconnection strategy directs how a RESTCONF "The reconnection strategy directs how a RESTCONF
client reconnects to a RESTCONF server, after client reconnects to a RESTCONF server, after
discovering its connection to the server has discovering its connection to the server has
skipping to change at page 15, line 19 skipping to change at page 16, line 10
enum last-connected { enum last-connected {
description description
"Indicates that reconnections should start "Indicates that reconnections should start
with the endpoint last connected to. If with the endpoint last connected to. If
no previous connection has ever been no previous connection has ever been
established, then the first endpoint established, then the first endpoint
configured is used. RESTCONF clients configured is used. RESTCONF clients
SHOULD be able to remember the last SHOULD be able to remember the last
endpoint connected to across reboots."; endpoint connected to across reboots.";
} }
enum random-selection {
description
"Indicates that reconnections should start with
a random endpoint.";
}
} }
default first-listed; default first-listed;
description description
"Specifies which of the RESTCONF server's "Specifies which of the RESTCONF server's
endpoints the RESTCONF client should start endpoints the RESTCONF client should start
with when trying to connect to the RESTCONF with when trying to connect to the RESTCONF
server."; server.";
} }
leaf max-attempts { leaf max-attempts {
type uint8 { type uint8 {
skipping to change at page 17, line 43 skipping to change at page 18, line 39
All private keys and trusted certificates are held in the keystore All private keys and trusted certificates are held in the keystore
model defined in [I-D.ietf-netconf-keystore]. model defined in [I-D.ietf-netconf-keystore].
YANG feature statements are used to enable implementations to YANG feature statements are used to enable implementations to
advertise which parts of the model the RESTCONF server supports. advertise which parts of the model the RESTCONF server supports.
3.1. Tree Diagram 3.1. Tree Diagram
The following tree diagram [RFC8340] provides an overview of the data The following tree diagram [RFC8340] provides an overview of the data
model for the "ietf-restconf-client" module. Just the container is model for the "ietf-restconf-server" module. Just the container is
displayed below, but there is also a reuable grouping by the same displayed below, but there is also a reusable grouping called
name that the container is using. "restconf-server-grouping" that the container is using.
[Note: '\' line wrapping for formatting only] [Note: '\' line wrapping for formatting only]
module: ietf-restconf-server module: ietf-restconf-server
+--rw restconf-server +--rw restconf-server
+--rw listen! {listen}? +--rw listen! {listen}?
| +--rw endpoint* [name] | +--rw endpoint* [name]
| +--rw name string | +--rw name string
| +--rw (transport) | +--rw (transport)
| +--:(tls) {tls-listen}? | +--:(tls) {tls-listen}?
| +--rw tls | +--rw tls
| +--rw address? inet:ip-address | +--rw address? inet:ip-address
| +--rw port? inet:port-number | +--rw port? inet:port-number
| +--rw server-identity | +--rw server-identity
| | +--rw (local-or-keystore) | | +--rw (local-or-keystore)
| | +--:(local) | | +--:(local) {local-keys-supported}?
| | | +--rw algorithm | | | +--rw algorithm?
| | | | ct:key-algorithm-ref | | | | ct:key-algorithm-ref
| | | +--rw public-key binary | | | +--rw public-key? binary
| | | +--rw private-key union | | | +--rw private-key? union
| | | +---x generate-hidden-key
| | | | +---w input
| | | | +---w algorithm
| | | | ct:key-algorithm-ref
| | | +---x install-hidden-key
| | | | +---w input
| | | | +---w algorithm
| | | | | ct:key-algorithm-ref
| | | | +---w public-key? binary
| | | | +---w private-key? binary
| | | +--rw cert | | | +--rw cert
| | | | ct:end-entity-cert-cms | | | | ct:end-entity-cert-cms
| | | +---n certificate-expiration | | | +---n certificate-expiration
| | | +-- expiration-date? | | | +-- expiration-date?
| | | yang:date-and-time | | | yang:date-and-time
| | +--:(keystore) {keystore-implemented}? | | +--:(keystore) {keystore-supported}?
| | +--rw reference | | +--rw reference?
| | ks:asymmetric-key-certificate-r\ | | ks:asymmetric-key-certificate-r\
ef ef
| +--rw client-auth | +--rw client-auth
| | +--rw pinned-ca-certs? | | +--rw pinned-ca-certs?
| | | ta:pinned-certificates-ref | | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--rw pinned-client-certs? | | +--rw pinned-client-certs?
| | | ta:pinned-certificates-ref | | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--rw cert-maps | | +--rw cert-maps
| | +--rw cert-to-name* [id] | | +--rw cert-to-name* [id]
| | +--rw id uint32 | | +--rw id uint32
| | +--rw fingerprint | | +--rw fingerprint
| | | x509c2n:tls-fingerprint | | | x509c2n:tls-fingerprint
| | +--rw map-type identityref | | +--rw map-type identityref
| | +--rw name string | | +--rw name string
| +--rw hello-params | +--rw hello-params
| {tls-server-hello-params-config}? | {tls-server-hello-params-config}?
| +--rw tls-versions | +--rw tls-versions
skipping to change at page 19, line 11 skipping to change at page 20, line 19
+--rw endpoints +--rw endpoints
| +--rw endpoint* [name] | +--rw endpoint* [name]
| +--rw name string | +--rw name string
| +--rw (transport) | +--rw (transport)
| +--:(tls) {tls-call-home}? | +--:(tls) {tls-call-home}?
| +--rw tls | +--rw tls
| +--rw address inet:host | +--rw address inet:host
| +--rw port? inet:port-number | +--rw port? inet:port-number
| +--rw server-identity | +--rw server-identity
| | +--rw (local-or-keystore) | | +--rw (local-or-keystore)
| | +--:(local) | | +--:(local) {local-keys-supported}?
| | | +--rw algorithm | | | +--rw algorithm?
| | | | ct:key-algorithm-ref | | | | ct:key-algorithm-ref
| | | +--rw public-key | | | +--rw public-key?
| | | | binary | | | | binary
| | | +--rw private-key | | | +--rw private-key?
| | | | union | | | | union
| | | +---x generate-hidden-key
| | | | +---w input
| | | | +---w algorithm
| | | | ct:key-algorithm-ref
| | | +---x install-hidden-key
| | | | +---w input
| | | | +---w algorithm
| | | | | ct:key-algorithm-ref
| | | | +---w public-key? binary
| | | | +---w private-key? binary
| | | +--rw cert | | | +--rw cert
| | | | ct:end-entity-cert-cms | | | | ct:end-entity-cert-cms
| | | +---n certificate-expiration | | | +---n certificate-expiration
| | | +-- expiration-date? | | | +-- expiration-date?
| | | yang:date-and-time | | | yang:date-and-time
| | +--:(keystore) {keystore-implemented\ | | +--:(keystore) {keystore-supported}?
}? | | +--rw reference?
| | +--rw reference
| | ks:asymmetric-key-certifi\ | | ks:asymmetric-key-certifi\
cate-ref cate-ref
| +--rw client-auth | +--rw client-auth
| | +--rw pinned-ca-certs? | | +--rw pinned-ca-certs?
| | | ta:pinned-certificates-ref | | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--rw pinned-client-certs? | | +--rw pinned-client-certs?
| | | ta:pinned-certificates-ref | | | ta:pinned-certificates-ref
| | | {ta:x509-certificates}?
| | +--rw cert-maps | | +--rw cert-maps
| | +--rw cert-to-name* [id] | | +--rw cert-to-name* [id]
| | +--rw id uint32 | | +--rw id uint32
| | +--rw fingerprint | | +--rw fingerprint
| | | x509c2n:tls-fingerprint | | | x509c2n:tls-fingerprint
| | +--rw map-type identityref | | +--rw map-type identityref
| | +--rw name string | | +--rw name string
| +--rw hello-params | +--rw hello-params
| {tls-server-hello-params-config}? | {tls-server-hello-params-config}?
| +--rw tls-versions | +--rw tls-versions
| | +--rw tls-version* identityref | | +--rw tls-version* identityref
| +--rw cipher-suites | +--rw cipher-suites
| +--rw cipher-suite* identityref | +--rw cipher-suite* identityref
+--rw connection-type +--rw connection-type
| +--rw (connection-type)? | +--rw (connection-type)
| +--:(persistent-connection) | +--:(persistent-connection)
| | +--rw persistent! | | +--rw persistent!
| | +--rw idle-timeout? uint32
| | +--rw keep-alives | | +--rw keep-alives
| | +--rw max-wait? uint16 | | +--rw max-wait? uint16
| | +--rw max-attempts? uint8 | | +--rw max-attempts? uint8
| +--:(periodic-connection) | +--:(periodic-connection)
| +--rw periodic! | +--rw periodic!
| +--rw idle-timeout? uint16 | +--rw period? uint16
| +--rw reconnect-timeout? uint16 | +--rw anchor-time? yang:date-and-time
| +--rw idle-timeout? uint16
+--rw reconnect-strategy +--rw reconnect-strategy
+--rw start-with? enumeration +--rw start-with? enumeration
+--rw max-attempts? uint8 +--rw max-attempts? uint8
3.2. Example Usage 3.2. Example Usage
The following example illustrates configuring a RESTCONF server to The following example illustrates configuring a RESTCONF server to
listen for RESTCONF client connections, as well as configuring call- listen for RESTCONF client connections, as well as configuring call-
home to one RESTCONF client. home to one RESTCONF client.
This example is consistent with the examples presented in Section 2.2 This example is consistent with the examples presented in Section 3.2
of [I-D.ietf-netconf-keystore]. of [I-D.ietf-netconf-keystore].
[Note: '\' line wrapping for formatting only] [Note: '\' line wrapping for formatting only]
<restconf-server <restconf-server
xmlns="urn:ietf:params:xml:ns:yang:ietf-restconf-server" xmlns="urn:ietf:params:xml:ns:yang:ietf-restconf-server"
xmlns:x509c2n="urn:ietf:params:xml:ns:yang:ietf-x509-cert-to-name"\ xmlns:x509c2n="urn:ietf:params:xml:ns:yang:ietf-x509-cert-to-name">
>
<!-- endpoints to listen for RESTCONF connections on --> <!-- endpoints to listen for RESTCONF connections on -->
<listen> <listen>
<endpoint> <endpoint>
<name>netconf/tls</name> <name>netconf/tls</name>
<tls> <tls>
<address>11.22.33.44</address> <address>11.22.33.44</address>
<server-identity> <server-identity>
<algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-cryp\ <algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-cryp\
to-types">ct:secp521r1</algorithm> to-types">ct:secp521r1</algorithm>
skipping to change at page 22, line 45 skipping to change at page 24, line 14
<name>scooby-doo</name> <name>scooby-doo</name>
</cert-to-name> </cert-to-name>
</cert-maps> </cert-maps>
</client-auth> </client-auth>
</tls> </tls>
</endpoint> </endpoint>
</endpoints> </endpoints>
<connection-type> <connection-type>
<periodic> <periodic>
<idle-timeout>300</idle-timeout> <idle-timeout>300</idle-timeout>
<reconnect-timeout>60</reconnect-timeout> <period>60</period>
</periodic> </periodic>
</connection-type> </connection-type>
<reconnect-strategy> <reconnect-strategy>
<start-with>last-connected</start-with> <start-with>last-connected</start-with>
<max-attempts>3</max-attempts> <max-attempts>3</max-attempts>
</reconnect-strategy> </reconnect-strategy>
</restconf-client> </restconf-client>
</call-home> </call-home>
</restconf-server> </restconf-server>
3.3. YANG Module 3.3. YANG Module
This YANG module has normative references to [RFC6991], [RFC7407], This YANG module has normative references to [RFC6991], [RFC7407],
[RFC8040], [RFC8071], and [I-D.ietf-netconf-tls-client-server]. [RFC8040], [RFC8071], and [I-D.ietf-netconf-tls-client-server].
<CODE BEGINS> file "ietf-restconf-server@2018-06-04.yang" <CODE BEGINS> file "ietf-restconf-server@2018-09-20.yang"
module ietf-restconf-server { module ietf-restconf-server {
yang-version 1.1; yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-restconf-server"; namespace "urn:ietf:params:xml:ns:yang:ietf-restconf-server";
prefix "rcs"; prefix "rcs";
import ietf-yang-types {
prefix yang;
reference
"RFC 6991: Common YANG Data Types";
}
import ietf-inet-types { import ietf-inet-types {
prefix inet; prefix inet;
reference reference
"RFC 6991: Common YANG Data Types"; "RFC 6991: Common YANG Data Types";
} }
import ietf-x509-cert-to-name { import ietf-x509-cert-to-name {
prefix x509c2n; prefix x509c2n;
reference reference
"RFC 7407: A YANG Data Model for SNMP Configuration"; "RFC 7407: A YANG Data Model for SNMP Configuration";
} }
import ietf-tls-server { import ietf-tls-server {
prefix ts; prefix ts;
revision-date 2018-06-04; // stable grouping definitions revision-date 2018-09-20; // stable grouping definitions
reference reference
"RFC ZZZZ: YANG Groupings for TLS Clients and TLS Servers"; "RFC ZZZZ: YANG Groupings for TLS Clients and TLS Servers";
} }
organization organization
"IETF NETCONF (Network Configuration) Working Group"; "IETF NETCONF (Network Configuration) Working Group";
contact contact
"WG Web: <http://datatracker.ietf.org/wg/netconf/> "WG Web: <http://datatracker.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org> WG List: <mailto:netconf@ietf.org>
skipping to change at page 24, line 25 skipping to change at page 25, line 48
Redistribution and use in source and binary forms, with or Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD to the license terms contained in, the Simplified BSD
License set forth in Section 4.c of the IETF Trust's License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents Legal Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info). (http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices."; the RFC itself for full legal notices.";
revision "2018-06-04" { revision "2018-09-20" {
description description
"Initial version"; "Initial version";
reference reference
"RFC XXXX: RESTCONF Client and Server Models"; "RFC XXXX: RESTCONF Client and Server Models";
} }
// Features // Features
feature listen { feature listen {
description description
"The 'listen' feature indicates that the RESTCONF server "The 'listen' feature indicates that the RESTCONF server
supports opening a port to accept RESTCONF client connections supports opening a port to accept RESTCONF client connections
skipping to change at page 25, line 26 skipping to change at page 26, line 51
description description
"The 'tls-call-home' feature indicates that the RESTCONF "The 'tls-call-home' feature indicates that the RESTCONF
server supports initiating connections to RESTCONF clients. server supports initiating connections to RESTCONF clients.
This feature exists as TLS might not be a mandatory to This feature exists as TLS might not be a mandatory to
implement transport in the future."; implement transport in the future.";
reference reference
"RFC 8071: NETCONF Call Home and RESTCONF Call Home"; "RFC 8071: NETCONF Call Home and RESTCONF Call Home";
} }
container restconf-server { container restconf-server {
uses restconf-server; uses restconf-server-grouping;
description description
"Top-level container for RESTCONF server configuration."; "Top-level container for RESTCONF server configuration.";
} }
grouping restconf-server { grouping restconf-server-grouping {
description description
"Top-level grouping for RESTCONF server configuration."; "Top-level grouping for RESTCONF server configuration.";
container listen { container listen {
if-feature listen; if-feature listen;
presence "Enables server to listen for TCP connections"; presence "Enables server to listen for TCP connections";
description "Configures listen behavior"; description "Configures listen behavior";
list endpoint { list endpoint {
key name; key name;
min-elements 1; min-elements 1;
skipping to change at page 29, line 27 skipping to change at page 31, line 4
} }
} }
} }
} // end transport } // end transport
} // end endpoint } // end endpoint
} // end endpoints } // end endpoints
container connection-type { container connection-type {
description description
"Indicates the RESTCONF client's preference for how the "Indicates the RESTCONF client's preference for how the
RESTCONF server's connection is maintained."; RESTCONF server's connection is maintained.";
choice connection-type { choice connection-type {
default persistent-connection; mandatory true;
description description
"Selects between available connection types."; "Selects between available connection types.";
case persistent-connection { case persistent-connection {
container persistent { container persistent {
presence presence
"Indicates that a persistent connection is to be "Indicates that a persistent connection is to be
maintained."; maintained.";
description description
"Maintain a persistent connection to the RESTCONF "Maintain a persistent connection to the RESTCONF
client. If the connection goes down, immediately client. If the connection goes down, immediately
start trying to reconnect to it, using the start trying to reconnect to it, using the
reconnection strategy. reconnection strategy.
This connection type minimizes any RESTCONF This connection type minimizes any RESTCONF
client to RESTCONF server data-transfer delay, client to RESTCONF server data-transfer delay,
albeit at the expense of holding resources albeit at the expense of holding resources
longer."; longer.";
leaf idle-timeout {
type uint32;
units "seconds";
default 86400; // one day;
description
"Specifies the maximum number of seconds that
the underlying TLS session may remain idle.
A TLS 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.";
}
container keep-alives { container keep-alives {
description description
"Configures the keep-alive policy, to "Configures the keep-alive policy, to
proactively test the aliveness of the TLS proactively test the aliveness of the TLS
client. An unresponsive TLS client will client. An unresponsive TLS client will
be dropped after approximately (max-attempts be dropped after approximately (max-attempts
* max-wait) seconds."; * max-wait) seconds.";
reference reference
"RFC 8071: NETCONF Call Home and RESTCONF "RFC 8071: NETCONF Call Home and RESTCONF
Call Home, Section 3.1, item S6"; Call Home, Section 4.1, item S7";
leaf max-wait { leaf max-wait {
type uint16 { type uint16 {
range "1..max"; range "1..max";
} }
units seconds; units seconds;
default 30; default 30;
description description
"Sets the amount of time in seconds after "Sets the amount of time in seconds after
which if no data has been received from which if no data has been received from
the TLS client, a TLS-level message will the TLS client, a TLS-level message will
skipping to change at page 31, line 4 skipping to change at page 32, line 15
the TLS client is no longer alive."; the TLS client is no longer alive.";
} }
} }
} }
} }
case periodic-connection { case periodic-connection {
container periodic { container periodic {
presence presence
"Indicates that a periodic connection is to be "Indicates that a periodic connection is to be
maintained."; maintained.";
description description
"Periodically connect to the RESTCONF client, so "Periodically connect to the RESTCONF client. The
that the RESTCONF client may send requests pending RESTCONF client should close the underlying TLS
for the RESTCONF server. Once the connection has connection upon completing planned activities.
been closed, for whatever reason, the server will
restart its timer until the next connection."; This connection type increases resource
utilization, albeit with increased delay in
RESTCONF client to RESTCONF client interactions.";
leaf period {
type uint16;
units "minutes";
default 60;
description
"Duration of time between periodic connections.";
}
leaf anchor-time {
type yang:date-and-time {
// constrained to minute-level granularity
pattern '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}'
+ '(Z|[\+\-]\d{2}:\d{2})';
}
description
"Designates a timestamp before or after which a
series of periodic connections are determined.
The periodic connections occur at a whole
multiple interval from the anchor time. For
example, for an anchor time is 15 minutes past
midnight and a period interval of 24 hours, then
a periodic connection will occur 15 minutes past
midnight everyday.";
}
leaf idle-timeout { leaf idle-timeout {
type uint16; type uint16;
units "seconds"; units "seconds";
default 300; // five minutes default 120; // two minutes
description description
"Specifies the maximum number of seconds that "Specifies the maximum number of seconds that
the underlying TLS session may remain idle. the underlying TLS session may remain idle.
A TLS session will be dropped if it is idle A TLS session will be dropped if it is idle
for an interval longer than this number of for an interval longer than this number of
seconds. If set to zero, then the server seconds. If set to zero, then the server
will never drop a session because it is idle. 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
"The maximum amount of unconnected time
the RESTCONF server will wait before
re-establishing a connection to the
RESTCONF client. The RESTCONF server
may initiate a connection to the RESTCONF
client before this time if desired
(e.g., to deliver a notification).";
} }
} }
} }
} }
} }
container reconnect-strategy { container reconnect-strategy {
description description
"The reconnection strategy directs how a RESTCONF "The reconnection strategy directs how a RESTCONF server
server reconnects to a RESTCONF client after after reconnects to a RESTCONF client after discovering its
discovering its connection to the client has dropped, connection to the client has dropped, even if due to a
even if due to a reboot. The RESTCONF server starts reboot. The RESTCONF server starts with the specified
with the specified endpoint and tries to connect to endpoint and tries to connect to it max-attempts times
it max-attempts times before trying the next endpoint before trying the next endpoint in the list (round
in the list (round robin)."; robin).";
leaf start-with { leaf start-with {
type enumeration { type enumeration {
enum first-listed { enum first-listed {
description description
"Indicates that reconnections should start with "Indicates that reconnections should start with
the first endpoint listed."; the first endpoint listed.";
} }
enum last-connected { enum last-connected {
description description
"Indicates that reconnections should start with "Indicates that reconnections should start with
the endpoint last connected to. If no previous the endpoint last connected to. If no previous
connection has ever been established, then the connection has ever been established, then the
first endpoint configured is used. RESTCONF first endpoint configured is used. RESTCONF
servers SHOULD be able to remember the last servers SHOULD be able to remember the last
endpoint connected to across reboots."; endpoint connected to across reboots.";
} }
enum random-selection {
description
"Indicates that reconnections should start with
a random endpoint.";
}
} }
default first-listed; default first-listed;
description description
"Specifies which of the RESTCONF client's endpoints "Specifies which of the RESTCONF client's endpoints
the RESTCONF server should start with when trying the RESTCONF server should start with when trying
to connect to the RESTCONF client."; to connect to the RESTCONF client.";
} }
leaf max-attempts { leaf max-attempts {
type uint8 { type uint8 {
range "1..max"; range "1..max";
skipping to change at page 33, line 11 skipping to change at page 34, line 33
[I-D.ietf-netconf-tls-client-server]. Please see the Security [I-D.ietf-netconf-tls-client-server]. Please see the Security
Considerations section in that document for concerns related that Considerations section in that document for concerns related that
grouping. grouping.
The YANG module defined in this document is designed to be accessed The YANG module defined in this document is designed to be accessed
via YANG based management protocols, such as NETCONF [RFC6241] and via YANG based management protocols, such as NETCONF [RFC6241] and
RESTCONF [RFC8040]. Both of these protocols have mandatory-to- RESTCONF [RFC8040]. Both of these protocols have mandatory-to-
implement secure transport layers (e.g., SSH, TLS) with mutual implement secure transport layers (e.g., SSH, TLS) with mutual
authentication. authentication.
The NETCONF access control model (NACM) [RFC6536] provides the means The NETCONF access control model (NACM) [RFC8341] provides the means
to restrict access for particular users to a pre-configured subset of to restrict access for particular users to a pre-configured subset of
all available protocol operations and content. all available protocol operations and content.
There are a number of data nodes defined in this YANG module that are There are a number of data nodes defined in this YANG module that are
writable/creatable/deletable (i.e., config true, which is the writable/creatable/deletable (i.e., config true, which is the
default). These data nodes may be considered sensitive or vulnerable default). These data nodes may be considered sensitive or vulnerable
in some network environments. Write operations (e.g., edit-config) in some network environments. Write operations (e.g., edit-config)
to these data nodes without proper protection can have a negative to these data nodes without proper protection can have a negative
effect on network operations. These are the subtrees and data nodes effect on network operations. These are the subtrees and data nodes
and their sensitivity/vulnerability: and their sensitivity/vulnerability:
skipping to change at page 33, line 50 skipping to change at page 35, line 24
sensitive or vulnerable in some network environments. It is thus sensitive or vulnerable in some network environments. It is thus
important to control access to these operations. These are the important to control access to these operations. These are the
operations and their sensitivity/vulnerability: operations and their sensitivity/vulnerability:
NONE NONE
5. IANA Considerations 5. IANA Considerations
5.1. The IETF XML Registry 5.1. The IETF XML Registry
This document registers two URIs in the IETF XML registry [RFC3688]. This document registers two URIs in the "ns" subregistry of the IETF
Following the format in [RFC3688], the following registrations are XML Registry [RFC3688]. Following the format in [RFC3688], the
requested: following registrations are requested:
URI: urn:ietf:params:xml:ns:yang:ietf-restconf-client URI: urn:ietf:params:xml:ns:yang:ietf-restconf-client
Registrant Contact: The NETCONF WG of the IETF. Registrant Contact: The NETCONF WG of the IETF.
XML: N/A, the requested URI is an XML namespace. XML: N/A, the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:ietf-restconf-server URI: urn:ietf:params:xml:ns:yang:ietf-restconf-server
Registrant Contact: The NETCONF WG of the IETF. Registrant Contact: The NETCONF WG of the IETF.
XML: N/A, the requested URI is an XML namespace. XML: N/A, the requested URI is an XML namespace.
5.2. The YANG Module Names Registry 5.2. The YANG Module Names Registry
This document registers two YANG modules in the YANG Module Names This document registers two YANG modules in the YANG Module Names
registry [RFC7950]. Following the format in [RFC7950], the the registry [RFC6020]. Following the format in [RFC6020], the the
following registrations are requested: following registrations are requested:
name: ietf-restconf-client name: ietf-restconf-client
namespace: urn:ietf:params:xml:ns:yang:ietf-restconf-client namespace: urn:ietf:params:xml:ns:yang:ietf-restconf-client
prefix: ncc prefix: ncc
reference: RFC XXXX reference: RFC XXXX
name: ietf-restconf-server name: ietf-restconf-server
namespace: urn:ietf:params:xml:ns:yang:ietf-restconf-server namespace: urn:ietf:params:xml:ns:yang:ietf-restconf-server
prefix: ncs prefix: ncs
reference: RFC XXXX reference: RFC XXXX
6. References 6. References
6.1. Normative References 6.1. Normative References
[I-D.ietf-netconf-keystore] [I-D.ietf-netconf-keystore]
Watsen, K., "YANG Data Model for a "Keystore" Mechanism", Watsen, K., "YANG Data Model for a Centralized Keystore
draft-ietf-netconf-keystore-04 (work in progress), October Mechanism", draft-ietf-netconf-keystore-06 (work in
2017. progress), September 2018.
[I-D.ietf-netconf-tls-client-server] [I-D.ietf-netconf-tls-client-server]
Watsen, K. and G. Wu, "YANG Groupings for TLS Clients and Watsen, K. and G. Wu, "YANG Groupings for TLS Clients and
TLS Servers", draft-ietf-netconf-tls-client-server-05 TLS Servers", draft-ietf-netconf-tls-client-server-06
(work in progress), October 2017. (work in progress), June 2018.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997, DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>. <https://www.rfc-editor.org/info/rfc2119>.
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010,
<https://www.rfc-editor.org/info/rfc6020>.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6991, DOI 10.17487/RFC6991, July 2013, RFC 6991, DOI 10.17487/RFC6991, July 2013,
<https://www.rfc-editor.org/info/rfc6991>. <https://www.rfc-editor.org/info/rfc6991>.
[RFC7407] Bjorklund, M. and J. Schoenwaelder, "A YANG Data Model for [RFC7407] Bjorklund, M. and J. Schoenwaelder, "A YANG Data Model for
SNMP Configuration", RFC 7407, DOI 10.17487/RFC7407, SNMP Configuration", RFC 7407, DOI 10.17487/RFC7407,
December 2014, <https://www.rfc-editor.org/info/rfc7407>. December 2014, <https://www.rfc-editor.org/info/rfc7407>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016, RFC 7950, DOI 10.17487/RFC7950, August 2016,
skipping to change at page 35, line 29 skipping to change at page 37, line 9
<https://www.rfc-editor.org/info/rfc8071>. <https://www.rfc-editor.org/info/rfc8071>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>. May 2017, <https://www.rfc-editor.org/info/rfc8174>.
6.2. Informative References 6.2. Informative References
[I-D.ietf-netconf-netconf-client-server] [I-D.ietf-netconf-netconf-client-server]
Watsen, K. and G. Wu, "NETCONF Client and Server Models", Watsen, K. and G. Wu, "NETCONF Client and Server Models",
draft-ietf-netconf-netconf-client-server-05 (work in draft-ietf-netconf-netconf-client-server-06 (work in
progress), October 2017. progress), June 2018.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004, DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>. <https://www.rfc-editor.org/info/rfc3688>.
[RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security
(TLS) Protocol Version 1.2", RFC 5246,
DOI 10.17487/RFC5246, August 2008,
<https://www.rfc-editor.org/info/rfc5246>.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>. <https://www.rfc-editor.org/info/rfc6241>.
[RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration
Protocol (NETCONF) Access Control Model", RFC 6536,
DOI 10.17487/RFC6536, March 2012,
<https://www.rfc-editor.org/info/rfc6536>.
[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
<https://www.rfc-editor.org/info/rfc8340>. <https://www.rfc-editor.org/info/rfc8340>.
[RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration
Access Control Model", STD 91, RFC 8341,
DOI 10.17487/RFC8341, March 2018,
<https://www.rfc-editor.org/info/rfc8341>.
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
<https://www.rfc-editor.org/info/rfc8446>.
Appendix A. Change Log Appendix A. Change Log
A.1. 00 to 01 A.1. 00 to 01
o Renamed "keychain" to "keystore". o Renamed "keychain" to "keystore".
A.2. 01 to 02 A.2. 01 to 02
o Filled in previously missing 'ietf-restconf-client' module. o Filled in previously missing 'ietf-restconf-client' module.
skipping to change at page 38, line 14 skipping to change at page 39, line 14
A.6. 05 to 06 A.6. 05 to 06
o Fixed change log missing section issue. o Fixed change log missing section issue.
o Updated examples to match latest updates to the crypto-types, o Updated examples to match latest updates to the crypto-types,
trust-anchors, and keystore drafts. trust-anchors, and keystore drafts.
o Reduced line length of the YANG modules to fit within 69 columns. o Reduced line length of the YANG modules to fit within 69 columns.
A.7. 06 to 07
o removed "idle-timeout" from "persistent" connection config.
o Added "random-selection" for reconnection-strategy's "starts-with"
enum.
o Replaced "connection-type" choice default (persistent) with
"mandatory true".
o Reduced the periodic-connection's "idle-timeout" from 5 to 2
minutes.
o Replaced reconnect-timeout with period/anchor-time combo.
Acknowledgements Acknowledgements
The authors would like to thank for following for lively discussions The authors would like to thank for following for lively discussions
on list and in the halls (ordered by last name): Andy Bierman, Martin on list and in the halls (ordered by last name): Andy Bierman, Martin
Bjorklund, Benoit Claise, Mehmet Ersue, Balazs Kovacs, David Bjorklund, Benoit Claise, Mehmet Ersue, Balazs Kovacs, David
Lamparter, Alan Luchuk, Ladislav Lhotka, Radek Krejci, Tom Petch, Lamparter, Alan Luchuk, Ladislav Lhotka, Radek Krejci, Tom Petch,
Juergen Schoenwaelder, Phil Shafer, Sean Turner, and Bert Wijnen. Juergen Schoenwaelder, Phil Shafer, Sean Turner, and Bert Wijnen.
Authors' Addresses Author's Address
Kent Watsen Kent Watsen
Juniper Networks Juniper Networks
EMail: kwatsen@juniper.net EMail: kwatsen@juniper.net
Gary Wu
Cisco Networks
EMail: garywu@cisco.com
 End of changes. 91 change blocks. 
246 lines changed or deleted 338 lines changed or added

This html diff was produced by rfcdiff 1.47. The latest version is available from http://tools.ietf.org/tools/rfcdiff/