draft-ietf-netconf-restconf-client-server-12.txt   draft-ietf-netconf-restconf-client-server-13.txt 
NETCONF Working Group K. Watsen NETCONF Working Group K. Watsen
Internet-Draft Watsen Networks Internet-Draft Watsen Networks
Intended status: Standards Track April 29, 2019 Intended status: Standards Track June 7, 2019
Expires: October 31, 2019 Expires: December 9, 2019
RESTCONF Client and Server Models RESTCONF Client and Server Models
draft-ietf-netconf-restconf-client-server-12 draft-ietf-netconf-restconf-client-server-13
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 2, line 11 skipping to change at page 2, line 11
o "BBBB" --> the assigned RFC value for I-D.ietf-netconf-tls-client- o "BBBB" --> the assigned RFC value for I-D.ietf-netconf-tls-client-
server server
o "CCCC" --> the assigned RFC value for I-D.ietf-netconf-http- o "CCCC" --> the assigned RFC value for I-D.ietf-netconf-http-
client-server client-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 "2019-04-29" --> the publication date of this draft o "2019-06-07" --> 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 B. Change Log o Appendix B. 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 October 31, 2019. This Internet-Draft will expire on December 9, 2019.
Copyright Notice Copyright Notice
Copyright (c) 2019 IETF Trust and the persons identified as the Copyright (c) 2019 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 3, line 15 skipping to change at page 3, line 15
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 4 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 4
2. The RESTCONF Client Model . . . . . . . . . . . . . . . . . . 4 2. The RESTCONF Client Model . . . . . . . . . . . . . . . . . . 4
2.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 4 2.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 4
2.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 6 2.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 6
2.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 9 2.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 9
3. The RESTCONF Server Model . . . . . . . . . . . . . . . . . . 18 3. The RESTCONF Server Model . . . . . . . . . . . . . . . . . . 18
3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 18 3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 18
3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 20 3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 19
3.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 23 3.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 23
4. Security Considerations . . . . . . . . . . . . . . . . . . . 34 4. Security Considerations . . . . . . . . . . . . . . . . . . . 34
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 35 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 35
5.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 35 5.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 35
5.2. The YANG Module Names Registry . . . . . . . . . . . . . 35 5.2. The YANG Module Names Registry . . . . . . . . . . . . . 36
6. References . . . . . . . . . . . . . . . . . . . . . . . . . 35 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 36
6.1. Normative References . . . . . . . . . . . . . . . . . . 35 6.1. Normative References . . . . . . . . . . . . . . . . . . 36
6.2. Informative References . . . . . . . . . . . . . . . . . 37 6.2. Informative References . . . . . . . . . . . . . . . . . 37
Appendix A. Expanded Tree Diagrams . . . . . . . . . . . . . . . 38 Appendix A. Expanded Tree Diagrams . . . . . . . . . . . . . . . 39
A.1. Expanded Tree Diagram for 'ietf-restconf-client' . . . . 38 A.1. Expanded Tree Diagram for 'ietf-restconf-client' . . . . 39
A.2. Expanded Tree Diagram for 'ietf-restconf-server' . . . . 47 A.2. Expanded Tree Diagram for 'ietf-restconf-server' . . . . 48
Appendix B. Change Log . . . . . . . . . . . . . . . . . . . . . 52 Appendix B. Change Log . . . . . . . . . . . . . . . . . . . . . 54
B.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 52 B.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 54
B.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 53 B.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 54
B.3. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 53 B.3. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 55
B.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 53 B.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 55
B.5. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 53 B.5. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 55
B.6. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 53 B.6. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 55
B.7. 06 to 07 . . . . . . . . . . . . . . . . . . . . . . . . 54 B.7. 06 to 07 . . . . . . . . . . . . . . . . . . . . . . . . 55
B.8. 07 to 08 . . . . . . . . . . . . . . . . . . . . . . . . 54 B.8. 07 to 08 . . . . . . . . . . . . . . . . . . . . . . . . 56
B.9. 08 to 09 . . . . . . . . . . . . . . . . . . . . . . . . 54 B.9. 08 to 09 . . . . . . . . . . . . . . . . . . . . . . . . 56
B.10. 09 to 10 . . . . . . . . . . . . . . . . . . . . . . . . 54 B.10. 09 to 10 . . . . . . . . . . . . . . . . . . . . . . . . 56
B.11. 10 to 11 . . . . . . . . . . . . . . . . . . . . . . . . 54 B.11. 10 to 11 . . . . . . . . . . . . . . . . . . . . . . . . 56
B.12. 11 to 12 . . . . . . . . . . . . . . . . . . . . . . . . 55 B.12. 11 to 12 . . . . . . . . . . . . . . . . . . . . . . . . 56
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 55 B.13. 12 to 13 . . . . . . . . . . . . . . . . . . . . . . . . 57
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 55 Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 57
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 57
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 [RFC8446] 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
skipping to change at page 5, line 20 skipping to change at page 5, line 20
+-- initiate! {https-initiate}? +-- initiate! {https-initiate}?
| +-- restconf-server* [name] | +-- restconf-server* [name]
| +-- name? string | +-- name? string
| +-- endpoints | +-- endpoints
| | +-- endpoint* [name] | | +-- endpoint* [name]
| | +-- name? string | | +-- name? string
| | +-- (transport) | | +-- (transport)
| | +--:(https) {https-initiate}? | | +--:(https) {https-initiate}?
| | +-- https | | +-- https
| | +-- tcp-client-parameters | | +-- tcp-client-parameters
| | | +---u restconf-client-grouping | | | +---u tcpc:tcp-client-grouping
| | +-- tls-client-parameters | | +-- tls-client-parameters
| | | +---u restconf-client-grouping | | | +---u tlsc:tls-client-grouping
| | +-- http-client-parameters | | +-- http-client-parameters
| | +---u restconf-client-grouping | | +---u httpc:http-client-grouping
| +-- connection-type | +-- connection-type
| | +-- (connection-type) | | +-- (connection-type)
| | +--:(persistent-connection) | | +--:(persistent-connection)
| | | +-- persistent! | | | +-- persistent!
| | +--:(periodic-connection) | | +--:(periodic-connection)
| | +-- periodic! | | +-- periodic!
| | +-- period? uint16 | | +-- period? uint16
| | +-- anchor-time? yang:date-and-time | | +-- anchor-time? yang:date-and-time
| | +-- idle-timeout? uint16 | | +-- idle-timeout? uint16
| +-- reconnect-strategy | +-- reconnect-strategy
| +-- start-with? enumeration | +-- start-with? enumeration
| +-- max-attempts? uint8 | +-- max-attempts? uint8
+-- listen! {https-listen}? +-- listen! {https-listen}?
+-- idle-timeout? uint16 +-- idle-timeout? uint16
+-- endpoint* [name] +-- endpoint* [name]
+-- name? string +-- name? string
+-- (transport) +-- (transport)
+--:(https) {https-listen}? +--:(https) {https-listen}?
+-- https +-- https
+-- tcp-server-parameters +-- tcp-server-parameters
| +---u restconf-client-grouping | +---u tcps:tcp-server-grouping
+-- tls-client-parameters +-- tls-client-parameters
| +---u restconf-client-grouping | +---u tlsc:tls-client-grouping
+-- http-client-parameters +-- http-client-parameters
+---u restconf-client-grouping +---u httpc:http-client-grouping
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 This example is consistent with the examples presented in Section 2
of [I-D.ietf-netconf-trust-anchors] and Section 3.2 of of [I-D.ietf-netconf-trust-anchors] and Section 3.2 of
[I-D.ietf-netconf-keystore]. [I-D.ietf-netconf-keystore].
skipping to change at page 6, line 48 skipping to change at page 6, line 48
<local-definition> <local-definition>
<algorithm xmlns:ct="urn:ietf:params:xml:ns:yang\ <algorithm xmlns:ct="urn:ietf:params:xml:ns:yang\
:ietf-crypto-types">ct:rsa2048</algorithm> :ietf-crypto-types">ct:rsa2048</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>
</local-definition> </local-definition>
</certificate> </certificate>
</client-identity> </client-identity>
<server-authentication> <server-authentication>
<pinned-ca-certs>explicitly-trusted-server-ca-certs<\ <ca-certs>explicitly-trusted-server-ca-certs</ca-cer\
/pinned-ca-certs> ts>
<pinned-server-certs>explicitly-trusted-server-certs\ <server-certs>explicitly-trusted-server-certs</serve\
</pinned-server-certs> r-certs>
</server-authentication> </server-authentication>
<keepalives> <keepalives>
<max-wait>30</max-wait> <max-wait>30</max-wait>
<max-attempts>3</max-attempts> <max-attempts>3</max-attempts>
</keepalives> </keepalives>
</tls-client-parameters> </tls-client-parameters>
<http-client-parameters> <http-client-parameters>
<protocol-version>HTTP/1.1</protocol-version> <protocol-version>HTTP/1.1</protocol-version>
<client-identity> <client-identity>
<basic> <basic>
skipping to change at page 7, line 44 skipping to change at page 7, line 44
<local-definition> <local-definition>
<algorithm xmlns:ct="urn:ietf:params:xml:ns:yang\ <algorithm xmlns:ct="urn:ietf:params:xml:ns:yang\
:ietf-crypto-types">ct:rsa2048</algorithm> :ietf-crypto-types">ct:rsa2048</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>
</local-definition> </local-definition>
</certificate> </certificate>
</client-identity> </client-identity>
<server-authentication> <server-authentication>
<pinned-ca-certs>explicitly-trusted-server-ca-certs<\ <ca-certs>explicitly-trusted-server-ca-certs</ca-cer\
/pinned-ca-certs> ts>
<pinned-server-certs>explicitly-trusted-server-certs\ <server-certs>explicitly-trusted-server-certs</serve\
</pinned-server-certs> r-certs>
</server-authentication> </server-authentication>
<keepalives> <keepalives>
<max-wait>30</max-wait> <max-wait>30</max-wait>
<max-attempts>3</max-attempts> <max-attempts>3</max-attempts>
</keepalives> </keepalives>
</tls-client-parameters> </tls-client-parameters>
<http-client-parameters> <http-client-parameters>
<protocol-version>HTTP/1.1</protocol-version> <protocol-version>HTTP/1.1</protocol-version>
<client-identity> <client-identity>
skipping to change at page 8, line 46 skipping to change at page 8, line 46
<local-definition> <local-definition>
<algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:iet\ <algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:iet\
f-crypto-types">ct:rsa2048</algorithm> f-crypto-types">ct:rsa2048</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>
</local-definition> </local-definition>
</certificate> </certificate>
</client-identity> </client-identity>
<server-authentication> <server-authentication>
<pinned-ca-certs>explicitly-trusted-server-ca-certs</pin\ <ca-certs>explicitly-trusted-server-ca-certs</ca-certs>
ned-ca-certs> <server-certs>explicitly-trusted-server-certs</server-ce\
<pinned-server-certs>explicitly-trusted-server-certs</pi\ rts>
nned-server-certs>
</server-authentication> </server-authentication>
</tls-client-parameters> </tls-client-parameters>
<http-client-parameters> <http-client-parameters>
<protocol-version>HTTP/1.1</protocol-version> <protocol-version>HTTP/1.1</protocol-version>
<client-identity> <client-identity>
<basic> <basic>
<user-id>bob</user-id> <user-id>bob</user-id>
<password>secret</password> <password>secret</password>
</basic> </basic>
</client-identity> </client-identity>
skipping to change at page 9, line 24 skipping to change at page 9, line 23
</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], [I-D.kwatsen-netconf-tcp-client-server], and [RFC8071], [I-D.kwatsen-netconf-tcp-client-server],
[I-D.ietf-netconf-tls-client-server], and [I-D.ietf-netconf-tls-client-server], and
[I-D.kwatsen-netconf-http-client-server]. [I-D.kwatsen-netconf-http-client-server].
<CODE BEGINS> file "ietf-restconf-client@2019-04-29.yang" <CODE BEGINS> file "ietf-restconf-client@2019-06-07.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 { import ietf-yang-types {
prefix yang; prefix yang;
reference reference
"RFC 6991: Common YANG Data Types"; "RFC 6991: Common YANG Data Types";
} }
skipping to change at page 10, line 47 skipping to change at page 10, line 44
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC (https://www.rfc-editor.org/info/rfcXXXX); see the RFC
itself for full legal notices.; itself for full legal notices.;
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 (RFC 2119) are to be interpreted as described in BCP 14 (RFC 2119)
(RFC 8174) when, and only when, they appear in all (RFC 8174) when, and only when, they appear in all
capitals, as shown here."; capitals, as shown here.";
revision 2019-04-29 { revision 2019-06-07 {
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 https-initiate { feature https-initiate {
description description
"The 'https-initiate' feature indicates that the RESTCONF "The 'https-initiate' feature indicates that the RESTCONF
client supports initiating HTTPS connections to RESTCONF client supports initiating HTTPS connections to RESTCONF
servers. This feature exists as HTTPS might not be a servers. This feature exists as HTTPS might not be a
mandatory to implement transport in the future."; mandatory to implement transport in the future.";
reference reference
"RFC 8040: RESTCONF Protocol"; "RFC 8040: RESTCONF Protocol";
} }
skipping to change at page 19, line 7 skipping to change at page 18, line 30
This tree diagram only shows the nodes defined in this module; it This tree diagram only shows the nodes defined in this module; it
does show the nodes defined by "grouping" statements used by this does show the nodes defined by "grouping" statements used by this
module. module.
Please see Appendix A.2 for a tree diagram that illustrates what the Please see Appendix A.2 for a tree diagram that illustrates what the
module looks like with all the "grouping" statements expanded. module looks like with all the "grouping" statements expanded.
module: ietf-restconf-server module: ietf-restconf-server
+--rw restconf-server +--rw restconf-server
+---u restconf-server-grouping +---u restconf-server-app-grouping
grouping restconf-server-grouping grouping restconf-server-grouping
+-- client-identification
+-- cert-maps
+---u x509c2n:cert-to-name
grouping restconf-server-listen-stack-grouping
+-- (transport)
+--:(http) {http-listen}?
| +-- http
| +-- tcp-server-parameters
| | +---u tcps:tcp-server-grouping
| +-- http-server-parameters
| | +---u https:http-server-grouping
| +-- restconf-server-parameters
| +---u rcs:restconf-server-grouping
+--:(https) {https-listen}?
+-- https
+-- tcp-server-parameters
| +---u tcps:tcp-server-grouping
+-- tls-server-parameters
| +---u tlss:tls-server-grouping
+-- http-server-parameters
| +---u https:http-server-grouping
+-- restconf-server-parameters
+---u rcs:restconf-server-grouping
grouping restconf-server-callhome-stack-grouping
+-- (transport)
+--:(https) {https-listen}?
+-- https
+-- tcp-client-parameters
| +---u tcpc:tcp-client-grouping
+-- tls-server-parameters
| +---u tlss:tls-server-grouping
+-- http-server-parameters
| +---u https:http-server-grouping
+-- restconf-server-parameters
+---u rcs:restconf-server-grouping
grouping restconf-server-app-grouping
+-- listen! {https-listen}? +-- listen! {https-listen}?
| +-- endpoint* [name] | +-- endpoint* [name]
| +-- name? string | +-- name? string
| +-- (transport) | +---u restconf-server-listen-stack-grouping
| +--:(https) {https-listen}?
| +-- https
| +-- tcp-server-parameters
| | +---u restconf-server-grouping
| +-- tls-server-parameters
| | +---u restconf-server-grouping
| +-- http-server-parameters
| +---u restconf-server-grouping
+-- call-home! {https-call-home}? +-- call-home! {https-call-home}?
+-- restconf-client* [name] +-- restconf-client* [name]
+-- name? string +-- name? string
+-- endpoints +-- endpoints
| +-- endpoint* [name] | +-- endpoint* [name]
| +-- name? string | +-- name? string
| +-- (transport) | +---u restconf-server-callhome-stack-grouping
| +--:(https) {https-call-home}?
| +-- https
| +-- tcp-client-parameters
| | +---u restconf-server-grouping
| +-- tls-server-parameters
| | +---u restconf-server-grouping
| +-- http-server-parameters
| +---u restconf-server-grouping
+-- connection-type +-- connection-type
| +-- (connection-type) | +-- (connection-type)
| +--:(persistent-connection) | +--:(persistent-connection)
| | +-- persistent! | | +-- persistent!
| +--:(periodic-connection) | +--:(periodic-connection)
| +-- periodic! | +-- periodic!
| +-- period? uint16 | +-- period? uint16
| +-- anchor-time? yang:date-and-time | +-- anchor-time? yang:date-and-time
| +-- idle-timeout? uint16 | +-- idle-timeout? uint16
+-- reconnect-strategy +-- reconnect-strategy
skipping to change at page 20, line 41 skipping to change at page 20, line 35
<local-definition> <local-definition>
<algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-\ <algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-\
crypto-types">ct:rsa2048</algorithm> crypto-types">ct:rsa2048</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>
</local-definition> </local-definition>
</server-identity> </server-identity>
<client-authentication> <client-authentication>
<required/> <required/>
<pinned-ca-certs>explicitly-trusted-client-ca-certs</pin\ <ca-certs>explicitly-trusted-client-ca-certs</ca-certs>
ned-ca-certs> <client-certs>explicitly-trusted-client-certs</client-ce\
<pinned-client-certs>explicitly-trusted-client-certs</pi\ rts>
nned-client-certs> </client-authentication>
</tls-server-parameters>
<http-server-parameters>
<server-name>foo.example.com</server-name>
<protocol-versions>
<protocol-version>HTTP/1.1</protocol-version>
<protocol-version>HTTP/2.0</protocol-version>
</protocol-versions>
</http-server-parameters>
<restconf-server-parameters>
<client-identification>
<cert-maps> <cert-maps>
<cert-to-name> <cert-to-name>
<id>1</id> <id>1</id>
<fingerprint>11:0A:05:11:00</fingerprint> <fingerprint>11:0A:05:11:00</fingerprint>
<map-type>x509c2n:san-any</map-type> <map-type>x509c2n:san-any</map-type>
</cert-to-name> </cert-to-name>
<cert-to-name> <cert-to-name>
<id>2</id> <id>2</id>
<fingerprint>B3:4F:A1:8C:54</fingerprint> <fingerprint>B3:4F:A1:8C:54</fingerprint>
<map-type>x509c2n:specified</map-type> <map-type>x509c2n:specified</map-type>
<name>scooby-doo</name> <name>scooby-doo</name>
</cert-to-name> </cert-to-name>
</cert-maps> </cert-maps>
</client-authentication> </client-identification>
</tls-server-parameters> </restconf-server-parameters>
<http-server-parameters>
<server-name>foo.example.com</server-name>
<protocol-versions>
<protocol-version>HTTP/1.1</protocol-version>
<protocol-version>HTTP/2.0</protocol-version>
</protocol-versions>
</http-server-parameters>
</https> </https>
</endpoint> </endpoint>
</listen> </listen>
<!-- call home to a RESTCONF client with two endpoints --> <!-- call home to a RESTCONF client with two endpoints -->
<call-home> <call-home>
<restconf-client> <restconf-client>
<name>config-manager</name> <name>config-manager</name>
<endpoints> <endpoints>
<endpoint> <endpoint>
skipping to change at page 21, line 45 skipping to change at page 21, line 42
<local-definition> <local-definition>
<algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:i\ <algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:i\
etf-crypto-types">ct:rsa2048</algorithm> etf-crypto-types">ct:rsa2048</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>
</local-definition> </local-definition>
</server-identity> </server-identity>
<client-authentication> <client-authentication>
<required/> <required/>
<pinned-ca-certs>explicitly-trusted-client-ca-certs<\ <ca-certs>explicitly-trusted-client-ca-certs</ca-cer\
/pinned-ca-certs> ts>
<pinned-client-certs>explicitly-trusted-client-certs\ <client-certs>explicitly-trusted-client-certs</clien\
</pinned-client-certs> t-certs>
</client-authentication>
</tls-server-parameters>
<http-server-parameters>
<server-name>foo.example.com</server-name>
<protocol-versions>
<protocol-version>HTTP/1.1</protocol-version>
<protocol-version>HTTP/2.0</protocol-version>
</protocol-versions>
</http-server-parameters>
<restconf-server-parameters>
<client-identification>
<cert-maps> <cert-maps>
<cert-to-name> <cert-to-name>
<id>1</id> <id>1</id>
<fingerprint>11:0A:05:11:00</fingerprint> <fingerprint>11:0A:05:11:00</fingerprint>
<map-type>x509c2n:san-any</map-type> <map-type>x509c2n:san-any</map-type>
</cert-to-name> </cert-to-name>
<cert-to-name> <cert-to-name>
<id>2</id> <id>2</id>
<fingerprint>B3:4F:A1:8C:54</fingerprint> <fingerprint>B3:4F:A1:8C:54</fingerprint>
<map-type>x509c2n:specified</map-type> <map-type>x509c2n:specified</map-type>
<name>scooby-doo</name> <name>scooby-doo</name>
</cert-to-name> </cert-to-name>
</cert-maps> </cert-maps>
</client-authentication> </client-identification>
</tls-server-parameters> </restconf-server-parameters>
<http-server-parameters>
<server-name>foo.example.com</server-name>
<protocol-versions>
<protocol-version>HTTP/1.1</protocol-version>
<protocol-version>HTTP/2.0</protocol-version>
</protocol-versions>
</http-server-parameters>
</https> </https>
</endpoint> </endpoint>
<endpoint> <endpoint>
<name>west-data-center</name> <name>west-data-center</name>
<https> <https>
<tcp-client-parameters> <tcp-client-parameters>
<remote-address>west.example.com</remote-address> <remote-address>west.example.com</remote-address>
</tcp-client-parameters> </tcp-client-parameters>
<tls-server-parameters> <tls-server-parameters>
<server-identity> <server-identity>
<local-definition> <local-definition>
<algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:i\ <algorithm xmlns:ct="urn:ietf:params:xml:ns:yang:i\
etf-crypto-types">ct:rsa2048</algorithm> etf-crypto-types">ct:rsa2048</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>
</local-definition> </local-definition>
</server-identity> </server-identity>
<client-authentication> <client-authentication>
<required/> <required/>
<pinned-ca-certs>explicitly-trusted-client-ca-certs<\ <ca-certs>explicitly-trusted-client-ca-certs</ca-cer\
/pinned-ca-certs> ts>
<pinned-client-certs>explicitly-trusted-client-certs\ <client-certs>explicitly-trusted-client-certs</clien\
</pinned-client-certs> t-certs>
</client-authentication>
</tls-server-parameters>
<http-server-parameters>
<server-name>foo.example.com</server-name>
<protocol-versions>
<protocol-version>HTTP/1.1</protocol-version>
<protocol-version>HTTP/2.0</protocol-version>
</protocol-versions>
</http-server-parameters>
<restconf-server-parameters>
<client-identification>
<cert-maps> <cert-maps>
<cert-to-name> <cert-to-name>
<id>1</id> <id>1</id>
<fingerprint>11:0A:05:11:00</fingerprint> <fingerprint>11:0A:05:11:00</fingerprint>
<map-type>x509c2n:san-any</map-type> <map-type>x509c2n:san-any</map-type>
</cert-to-name> </cert-to-name>
<cert-to-name> <cert-to-name>
<id>2</id> <id>2</id>
<fingerprint>B3:4F:A1:8C:54</fingerprint> <fingerprint>B3:4F:A1:8C:54</fingerprint>
<map-type>x509c2n:specified</map-type> <map-type>x509c2n:specified</map-type>
<name>scooby-doo</name> <name>scooby-doo</name>
</cert-to-name> </cert-to-name>
</cert-maps> </cert-maps>
</client-authentication> </client-identification>
</tls-server-parameters> </restconf-server-parameters>
<http-server-parameters>
<server-name>foo.example.com</server-name>
<protocol-versions>
<protocol-version>HTTP/1.1</protocol-version>
<protocol-version>HTTP/2.0</protocol-version>
</protocol-versions>
</http-server-parameters>
</https> </https>
</endpoint> </endpoint>
</endpoints> </endpoints>
<connection-type> <connection-type>
<periodic> <periodic>
<idle-timeout>300</idle-timeout> <idle-timeout>300</idle-timeout>
<period>60</period> <period>60</period>
</periodic> </periodic>
</connection-type> </connection-type>
<reconnect-strategy> <reconnect-strategy>
skipping to change at page 23, line 46 skipping to change at page 23, line 50
</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], [I-D.kwatsen-netconf-tcp-client-server], [RFC8040], [RFC8071], [I-D.kwatsen-netconf-tcp-client-server],
[I-D.ietf-netconf-tls-client-server], and [I-D.ietf-netconf-tls-client-server], and
[I-D.kwatsen-netconf-http-client-server]. [I-D.kwatsen-netconf-http-client-server].
<CODE BEGINS> file "ietf-restconf-server@2019-04-29.yang" <CODE BEGINS> file "ietf-restconf-server@2019-06-07.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 { import ietf-yang-types {
prefix yang; prefix yang;
reference reference
"RFC 6991: Common YANG Data Types"; "RFC 6991: Common YANG Data Types";
} }
skipping to change at page 25, line 27 skipping to change at page 25, line 32
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC (https://www.rfc-editor.org/info/rfcXXXX); see the RFC
itself for full legal notices.; itself for full legal notices.;
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 (RFC 2119) are to be interpreted as described in BCP 14 (RFC 2119)
(RFC 8174) when, and only when, they appear in all (RFC 8174) when, and only when, they appear in all
capitals, as shown here."; capitals, as shown here.";
revision 2019-04-29 { revision 2019-06-07 {
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 http-listen {
description
"The 'http-listen' feature indicates that the RESTCONF server
supports opening a port to listen for incoming RESTCONF over
TPC client connections, whereby the TLS connections are
terminated by an external system.";
reference
"RFC 8040: RESTCONF Protocol";
}
feature https-listen { feature https-listen {
description description
"The 'https-listen' feature indicates that the RESTCONF server "The 'https-listen' feature indicates that the RESTCONF server
supports opening a port to listen for incoming RESTCONF supports opening a port to listen for incoming RESTCONF over
client connections. This feature exists as HTTPS might not TLS client connections, whereby the TLS connections are
be a mandatory to implement transport in the future."; terminated by the server itself/";
reference reference
"RFC 8040: RESTCONF Protocol"; "RFC 8040: RESTCONF Protocol";
} }
feature https-call-home { feature https-call-home {
description description
"The 'https-call-home' feature indicates that the RESTCONF "The 'https-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 not all RESTCONF servers may
support RESTCONF call home.";
reference reference
"RFC 8071: NETCONF Call Home and RESTCONF Call Home"; "RFC 8071: NETCONF Call Home and RESTCONF Call Home";
} }
// Groupings // Groupings
grouping restconf-server-grouping { grouping restconf-server-grouping {
description description
"Top-level grouping for RESTCONF server configuration."; "A reusable grouping for configuring a RESTCONF server
without any consideration for how underlying transport
sessions are established.
Note that this grouping uses fairly typical descendent
node names such that a stack of 'uses' statements will
have name conflicts. It is intended that the consuming
data model will resolve the issue (e.g., by wrapping
the 'uses' statement in a container called
'restconf-server-parameters'). This model purposely does
not do this itself so as to provide maximum flexibility
to consuming models.";
container client-identification { // FIXME: if-feature?
description
"Specifies a mapping through which clients MAY be identified
(i.e., the RESTCONF username) from a supplied certificate.
Note that a client MAY alternatively be identified via an
HTTP-level authentication schema. This configuration does
not necessitate clients send a certificate (that can be
controlled via the ietf-restconf-server module).";
container cert-maps {
uses x509c2n:cert-to-name;
description
"The cert-maps container is used by TLS-based RESTCONF
servers (even if the TLS sessions are terminated
externally) to map the RESTCONF client's presented
X.509 certificate to a RESTCONF username. If no
matching and valid cert-to-name list entry can be
found, then the RESTCONF server MUST close the
connection, and MUST NOT accept RESTCONF messages
over it.";
reference
"RFC 7407: A YANG Data Model for SNMP Configuration.";
}
}
}
grouping restconf-server-listen-stack-grouping {
description
"A reusable grouping for configuring a RESTCONF server
'listen' protocol stack, for a single connection.";
choice transport {
mandatory true;
description
"Selects between available transports. This is a
'choice' statement so as to support additional
transport options to be augmented in.";
case http {
if-feature "http-listen";
container http {
description
"Configures RESTCONF server stack assuming that
TLS-termination is handled externally.";
container tcp-server-parameters {
description
"A wrapper around the TCP server parameters
to avoid name collisions.";
uses tcps:tcp-server-grouping {
refine "local-port" {
default "80";
description
"The RESTCONF server will listen on the IANA-
assigned well-known port value for 'http'
(80) if no value is specified.";
}
}
}
container http-server-parameters {
description
"A wrapper around the HTTP server parameters
to avoid name collisions.";
uses https:http-server-grouping;
}
container restconf-server-parameters {
description
"A wrapper around the RESTCONF server parameters
to avoid name collisions.";
uses rcs:restconf-server-grouping;
}
}
}
case https {
if-feature "https-listen";
container https {
description
"Configures RESTCONF server stack assuming that
TLS-termination is handled internally.";
container tcp-server-parameters {
description
"A wrapper around the TCP server parameters
to avoid name collisions.";
uses tcps:tcp-server-grouping {
refine "local-port" {
default "443";
description
"The RESTCONF server will listen on the IANA-
assigned well-known port value for 'https'
(443) if no value is specified.";
}
}
}
container tls-server-parameters {
description
"A wrapper around the TLS server parameters
to avoid name collisions.";
uses tlss:tls-server-grouping;
}
container http-server-parameters {
description
"A wrapper around the HTTP server parameters
to avoid name collisions.";
uses https:http-server-grouping;
}
container restconf-server-parameters {
description
"A wrapper around the RESTCONF server parameters
to avoid name collisions.";
uses rcs:restconf-server-grouping;
}
}
}
}
}
grouping restconf-server-callhome-stack-grouping {
description
"A reusable grouping for configuring a RESTCONF server
'call-home' protocol stack, for a single connection.";
choice transport {
mandatory true;
description
"Selects between available transports. This is a
'choice' statement so as to support additional
transport options to be augmented in.";
case https {
if-feature "https-listen";
container https {
description
"Configures RESTCONF server stack assuming that
TLS-termination is handled internally.";
container tcp-client-parameters {
description
"A wrapper around the TCP client parameters
to avoid name collisions.";
uses tcpc:tcp-client-grouping {
refine "remote-port" {
default "4336";
description
"The RESTCONF server will attempt to
connect to the IANA-assigned well-known
port for 'restconf-ch-tls' (4336) if no
value is specified.";
}
}
}
container tls-server-parameters {
description
"A wrapper around the TLS server parameters
to avoid name collisions.";
uses tlss:tls-server-grouping;
}
container http-server-parameters {
description
"A wrapper around the HTTP server parameters
to avoid name collisions.";
uses https:http-server-grouping;
}
container restconf-server-parameters {
description
"A wrapper around the RESTCONF server parameters
to avoid name collisions.";
uses rcs:restconf-server-grouping;
}
}
}
}
}
grouping restconf-server-app-grouping {
description
"A reusable grouping for configuring a RESTCONF server
application that supports both 'listen' and 'call-home'
protocol stacks and for many connections.";
container listen { container listen {
if-feature "https-listen"; if-feature "https-listen";
presence presence
"Enables the RESTCONF server to listen for RESTCONF "Enables the RESTCONF server to listen for RESTCONF
client connections."; client connections.";
description "Configures listen behavior"; description "Configures listen behavior";
list endpoint { list endpoint {
key "name"; key "name";
min-elements 1; min-elements 1;
description description
"List of endpoints to listen for RESTCONF connections."; "List of endpoints to listen for RESTCONF connections.";
leaf name { leaf name {
type string; type string;
description description
"An arbitrary name for the RESTCONF listen endpoint."; "An arbitrary name for the RESTCONF listen endpoint.";
} }
choice transport { uses restconf-server-listen-stack-grouping;
mandatory true; }
description }
"Selects between available transports. This is a
'choice' statement so as to support additional
transport options to be augmented in.";
case https {
if-feature "https-listen";
container https {
description
"HTTPS-specific listening configuration for inbound
connections.";
container tcp-server-parameters {
description
"A wrapper around the TCP server parameters
to avoid name collisions.";
uses tcps:tcp-server-grouping {
refine "local-port" {
default "443";
description
"The RESTCONF server will listen on the IANA-
assigned well-known port value for 'https'
(443) if no value is specified.";
}
}
}
container tls-server-parameters {
description
"A wrapper around the TLS server parameters
to avoid name collisions.";
uses tlss:tls-server-grouping {
/*
refine
"client-authentication" {
//must 'pinned-ca-certs or pinned-client-certs';
//presence "Enables TLS-level authentication
// using client certificates.";
description
"RESTCONF servers MUST be able to validate
clients.";
}
*/
augment
"client-authentication/local-or-external/local" {
description
"Augments in the cert-to-name structure,
so the RESTCONF server can map TLS-layer
client certificates to RESTCONF usernames.";
container cert-maps {
/*must '../pinned-ca-certs
or ../pinned-client-certs'; */
uses x509c2n:cert-to-name;
description
"The cert-maps container is used by a TLS-
based RESTCONF server to map the RESTCONF
client's presented X.509 certificate to
a RESTCONF username. If no matching and
valid cert-to-name list entry can be found,
then the RESTCONF server MUST close the
connection, and MUST NOT accept RESTCONF
messages over it.";
reference
"RFC 7407: A YANG Data Model for SNMP
Configuration.";
}
//leaf optional {
// type empty;
//}
}
}
}
container http-server-parameters {
description
"A wrapper around the HTTP server parameters
to avoid name collisions.";
uses https:http-server-grouping;
/* {
augment "http-server-parameters" { // HELP!!!
description
"Augments in a flag indicating that the
RESCONF server MUST authenticate the
RESTCONF client using the HTTP 'basic'
authentication scheme. How the RESTCONF
server defines users and passwords is
outside the scope of this data model.";
container client-authentication {
leaf optional {
type empty;
}
choice configured-or-external {
mandatory true;
case external {
leaf user-auth-defined-elsewhere {
type empty;
}
}
}
}
}
}
*/
}
} // https container
} // tls case
} // transport
} // endpoint
} // listen
container call-home { container call-home {
if-feature "https-call-home"; if-feature "https-call-home";
presence presence
"Enables the RESTCONF server to initiate the underlying "Enables the RESTCONF server to initiate the underlying
transport connection to RESTCONF clients."; transport connection to RESTCONF clients.";
description "Configures call-home behavior"; description "Configures call-home behavior";
list restconf-client { list restconf-client {
key "name"; key "name";
min-elements 1; min-elements 1;
description description
skipping to change at page 29, line 26 skipping to change at page 31, line 26
ordered-by user; ordered-by user;
description description
"User-ordered list of endpoints for this RESTCONF "User-ordered list of endpoints for this RESTCONF
client. Defining more than one enables high- client. Defining more than one enables high-
availability."; availability.";
leaf name { leaf name {
type string; type string;
description description
"An arbitrary name for this endpoint."; "An arbitrary name for this endpoint.";
} }
choice transport { uses restconf-server-callhome-stack-grouping;
mandatory true; }
description }
"Selects between available transports. This is a
'choice' statement so as to support additional
transport options to be augmented in.";
case https {
if-feature "https-call-home";
container https {
description
"Specifies HTTPS-specific call-home transport
configuration.";
container tcp-client-parameters {
description
"A wrapper around the TCP client parameters
to avoid name collisions.";
uses tcpc:tcp-client-grouping {
refine "remote-port" {
default "4336";
description
"The RESTCONF server will attempt to
connect to the IANA-assigned well-known
port for 'restconf-ch-tls' (4336) if no
value is specified.";
}
}
}
container tls-server-parameters {
description
"A wrapper around the TLS server parameters
to avoid name collisions.";
uses tlss:tls-server-grouping {
refine "client-authentication" {
/*must 'pinned-ca-certs
or pinned-client-certs'; */
description
"RESTCONF servers MUST be able to validate
clients.";
}
augment "client-authentication" {
description
"Augments in the cert-to-name structure,
so the RESTCONF server can map TLS-layer
client certificates to RESTCONF
usernames.";
container cert-maps {
uses x509c2n:cert-to-name;
description
"The cert-maps container is used by a
TLS-based RESTCONF server to map the
RESTCONF client's presented X.509
certificate to a RESTCONF username. If
no matching and valid cert-to-name list
entry can be found, then the RESTCONF
server MUST close the connection, and
MUST NOT accept RESTCONF messages over
it.";
reference
"RFC 7407: A YANG Data Model for SNMP
Configuration.";
}
}
}
}
container http-server-parameters {
description
"A wrapper around the HTTP server parameters
to avoid name collisions.";
uses https:http-server-grouping;
}
}
}
} // transport
} // endpoint
} // endpoints
container connection-type { container connection-type {
description description
"Indicates the RESTCONF server's preference for how the "Indicates the RESTCONF server's preference for how the
RESTCONF connection is maintained."; RESTCONF connection is maintained.";
choice connection-type { choice connection-type {
mandatory true; mandatory true;
description description
"Selects between available connection types."; "Selects between available connection types.";
case persistent-connection { case persistent-connection {
container persistent { container persistent {
skipping to change at page 33, line 46 skipping to change at page 34, line 21
} }
default "3"; default "3";
description description
"Specifies the number times the RESTCONF server tries "Specifies the number times the RESTCONF server tries
to connect to a specific endpoint before moving on to to connect to a specific endpoint before moving on to
the next endpoint in the list (round robin)."; the next endpoint in the list (round robin).";
} }
} }
} // restconf-client } // restconf-client
} // call-home } // call-home
} // restconf-server-grouping } // restconf-server-app-grouping
// Protocol accessible node, for servers that implement this // Protocol accessible node, for servers that implement this
// module. // module.
container restconf-server { container restconf-server {
uses restconf-server-grouping; uses restconf-server-app-grouping;
description description
"Top-level container for RESTCONF server configuration."; "Top-level container for RESTCONF server configuration.";
} }
} }
<CODE ENDS> <CODE ENDS>
4. Security Considerations 4. Security Considerations
The YANG module defined in this document uses groupings defined in The YANG module defined in this document uses groupings defined in
[I-D.kwatsen-netconf-tcp-client-server], [I-D.kwatsen-netconf-tcp-client-server],
[I-D.ietf-netconf-tls-client-server], and [I-D.ietf-netconf-tls-client-server], and
[I-D.kwatsen-netconf-http-client-server]. Please see the Security [I-D.kwatsen-netconf-http-client-server]. Please see the Security
Considerations section in those documents for concerns related those Considerations section in those documents for concerns related those
skipping to change at page 35, line 48 skipping to change at page 36, line 27
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 Centralized Keystore Watsen, K., "YANG Data Model for a Centralized Keystore
Mechanism", draft-ietf-netconf-keystore-08 (work in Mechanism", draft-ietf-netconf-keystore-09 (work in
progress), March 2019. progress), April 2019.
[I-D.ietf-netconf-tls-client-server] [I-D.ietf-netconf-tls-client-server]
Watsen, K., Wu, G., and L. Xia, "YANG Groupings for TLS Watsen, K., Wu, G., and L. Xia, "YANG Groupings for TLS
Clients and TLS Servers", draft-ietf-netconf-tls-client- Clients and TLS Servers", draft-ietf-netconf-tls-client-
server-11 (work in progress), April 2019. server-12 (work in progress), April 2019.
[I-D.kwatsen-netconf-http-client-server] [I-D.kwatsen-netconf-http-client-server]
Watsen, K., "YANG Groupings for HTTP Clients and HTTP Watsen, K., "YANG Groupings for HTTP Clients and HTTP
Servers", draft-kwatsen-netconf-http-client-server-01 Servers", draft-kwatsen-netconf-http-client-server-02
(work in progress), April 2019. (work in progress), April 2019.
[I-D.kwatsen-netconf-tcp-client-server] [I-D.kwatsen-netconf-tcp-client-server]
Watsen, K., "YANG Groupings for TCP Clients and TCP Watsen, K. and M. Scharf, "YANG Groupings for TCP Clients
Servers", draft-kwatsen-netconf-tcp-client-server-01 (work and TCP Servers", draft-kwatsen-netconf-tcp-client-
in progress), April 2019. server-02 (work in progress), April 2019.
[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 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020, the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010, DOI 10.17487/RFC6020, October 2010,
<https://www.rfc-editor.org/info/rfc6020>. <https://www.rfc-editor.org/info/rfc6020>.
skipping to change at page 37, line 9 skipping to change at page 37, line 38
<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-trust-anchors] [I-D.ietf-netconf-trust-anchors]
Watsen, K., "YANG Data Model for Global Trust Anchors", Watsen, K., "YANG Data Model for Global Trust Anchors",
draft-ietf-netconf-trust-anchors-03 (work in progress), draft-ietf-netconf-trust-anchors-04 (work in progress),
March 2019. April 2019.
[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>.
[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>.
skipping to change at page 38, line 35 skipping to change at page 39, line 35
| +--rw endpoints | +--rw endpoints
| | +--rw endpoint* [name] | | +--rw endpoint* [name]
| | +--rw name string | | +--rw name string
| | +--rw (transport) | | +--rw (transport)
| | +--:(https) {https-initiate}? | | +--:(https) {https-initiate}?
| | +--rw https | | +--rw https
| | +--rw tcp-client-parameters | | +--rw tcp-client-parameters
| | | +--rw remote-address inet:host | | | +--rw remote-address inet:host
| | | +--rw remote-port? inet:port-number | | | +--rw remote-port? inet:port-number
| | | +--rw local-address? inet:ip-address | | | +--rw local-address? inet:ip-address
| | | | {local-binding-supported}?
| | | +--rw local-port? inet:port-number | | | +--rw local-port? inet:port-number
| | | | {local-binding-supported}?
| | | +--rw keepalives! | | | +--rw keepalives!
| | | {keepalives-supported}?
| | | +--rw idle-time uint16 | | | +--rw idle-time uint16
| | | +--rw max-probes uint16 | | | +--rw max-probes uint16
| | | +--rw probe-interval uint16 | | | +--rw probe-interval uint16
| | +--rw tls-client-parameters | | +--rw tls-client-parameters
| | | +--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-sup\ | | | | | {local-definiti\
\ported}? \ons-supported}?
| | | | | +--rw local-definition | | | | | +--rw local-definition
| | | | | +--rw algorithm? | | | | | +--rw algorithm
| | | | | | asymmetric\ | | | | | | asymmetric\
\-key-algorithm-ref \-key-algorithm-ref
| | | | | +--rw public-key? | | | | | +--rw public-key
| | | | | | binary | | | | | | binary
| | | | | +--rw private-key? | | | | | +--rw private-key
| | | | | | union | | | | | | union
| | | | | +---x generate-hid\
\den-key
| | | | | | +---w input
| | | | | | +---w algori\
\thm
| | | | | | asym\
\metric-key-algorithm-ref
| | | | | +---x install-hidd\
\en-key
| | | | | | +---w input
| | | | | | +---w algori\
\thm
| | | | | | | asym\
\metric-key-algorithm-ref
| | | | | | +---w public\
\-key?
| | | | | | | bina\
\ry
| | | | | | +---w privat\
\e-key?
| | | | | | bina\
\ry
| | | | | +--rw cert? | | | | | +--rw cert?
| | | | | | end-entity\ | | | | | | end-entity\
\-cert-cms \-cert-cms
| | | | | +---n certificate-\ | | | | | +---n certificate-\
\expiration \expiration
| | | | | +-- expiration-\ | | | | | | +-- expiration-\
\date \date
| | | | | yang:da\ | | | | | | yang:da\
\te-and-time \te-and-time
| | | | | +---x generate-cer\
\tificate-signing-request
| | | | | +---w input
| | | | | | +---w subject
| | | | | | | bina\
\ry
| | | | | | +---w attrib\
\utes?
| | | | | | bina\
\ry
| | | | | +--ro output
| | | | | +--ro certif\
\icate-signing-request
| | | | | bina\
\ry
| | | | +--:(keystore) | | | | +--:(keystore)
| | | | {keystore-suppo\ | | | | {keystore-suppo\
\rted}? \rted}?
| | | | +--rw keystore-refere\ | | | | +--rw keystore-refere\
\nce? \nce?
| | | | ks:asymmetric\ | | | | ks:asymmetric\
\-key-certificate-ref \-key-certificate-ref
| | | +--rw server-authentication | | | +--rw server-authentication
| | | | +--rw pinned-ca-certs? | | | | +--rw ca-certs?
| | | | | ta:pinned-certificates-ref | | | | | ts:certificates-ref
| | | | | {ta:x509-certificates}? | | | | | {ts:x509-certificates}?
| | | | +--rw pinned-server-certs? | | | | +--rw server-certs?
| | | | ta:pinned-certificates-ref | | | | ts:certificates-ref
| | | | {ta:x509-certificates}? | | | | {ts: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 keepalives! | | | +--rw keepalives!
| | | {tls-client-keepalives}? | | | {tls-client-keepalives}?
| | | +--rw max-wait? uint16 | | | +--rw max-wait? uint16
skipping to change at page 41, line 7 skipping to change at page 41, line 51
| | | | {scram-sha-256-auth}? | | | | {scram-sha-256-auth}?
| | | +--:(vapid) | | | +--:(vapid)
| | | +--rw vapid {vapid-auth}? | | | +--rw vapid {vapid-auth}?
| | +--rw proxy-server! {proxy-connect}? | | +--rw proxy-server! {proxy-connect}?
| | +--rw tcp-client-parameters | | +--rw tcp-client-parameters
| | | +--rw remote-address inet:host | | | +--rw remote-address inet:host
| | | +--rw remote-port? | | | +--rw remote-port?
| | | | inet:port-number | | | | inet:port-number
| | | +--rw local-address? | | | +--rw local-address?
| | | | inet:ip-address | | | | inet:ip-address
| | | | {local-binding-supported}?
| | | +--rw local-port? | | | +--rw local-port?
| | | | inet:port-number | | | | inet:port-number
| | | | {local-binding-supported}?
| | | +--rw keepalives! | | | +--rw keepalives!
| | | {keepalives-supported}?
| | | +--rw idle-time uint16 | | | +--rw idle-time uint16
| | | +--rw max-probes uint16 | | | +--rw max-probes uint16
| | | +--rw probe-interval uint16 | | | +--rw probe-interval uint16
| | +--rw tls-client-parameters | | +--rw tls-client-parameters
| | | +--rw client-identity | | | +--rw client-identity
| | | | +--rw (auth-type)? | | | | +--rw (auth-type)?
| | | | +--:(certificate) | | | | +--:(certificate)
| | | | +--rw certificate | | | | +--rw certificate
| | | | +--rw (local-or-keyst\ | | | | +--rw (local-or-keyst\
\ore) \ore)
| | | | +--:(local) | | | | +--:(local)
| | | | | {local-ke\ | | | | | {local-de\
\ys-supported}? \finitions-supported}?
| | | | | +--rw local-def\ | | | | | +--rw local-def\
\inition \inition
| | | | | +--rw algori\ | | | | | +--rw algori\
\thm? \thm
| | | | | | asym\ | | | | | | asym\
\metric-key-algorithm-ref \metric-key-algorithm-ref
| | | | | +--rw public\ | | | | | +--rw public\
\-key? \-key
| | | | | | bina\ | | | | | | bina\
\ry \ry
| | | | | +--rw privat\ | | | | | +--rw privat\
\e-key? \e-key
| | | | | | union | | | | | | union
| | | | | +---x genera\
\te-hidden-key
| | | | | | +---w inp\
\ut
| | | | | | +---w \
\algorithm
| | | | | | \
\ asymmetric-key-algorithm-ref
| | | | | +---x instal\
\l-hidden-key
| | | | | | +---w inp\
\ut
| | | | | | +---w \
\algorithm
| | | | | | | \
\ asymmetric-key-algorithm-ref
| | | | | | +---w \
\public-key?
| | | | | | | \
\ binary
| | | | | | +---w \
\private-key?
| | | | | | \
\ binary
| | | | | +--rw cert? | | | | | +--rw cert?
| | | | | | end-\ | | | | | | end-\
\entity-cert-cms \entity-cert-cms
| | | | | +---n certif\ | | | | | +---n certif\
\icate-expiration \icate-expiration
| | | | | +-- expir\ | | | | | | +-- expir\
\ation-date \ation-date
| | | | | y\ | | | | | | y\
\ang:date-and-time \ang:date-and-time
| | | | | +---x genera\
\te-certificate-signing-request
| | | | | +---w inp\
\ut
| | | | | | +---w \
\subject
| | | | | | | \
\ binary
| | | | | | +---w \
\attributes?
| | | | | | \
\ binary
| | | | | +--ro out\
\put
| | | | | +--ro \
\certificate-signing-request
| | | | | \
\ binary
| | | | +--:(keystore) | | | | +--:(keystore)
| | | | {keystore\ | | | | {keystore\
\-supported}? \-supported}?
| | | | +--rw keystore-\ | | | | +--rw keystore-\
\reference? \reference?
| | | | ks:asym\ | | | | ks:asym\
\metric-key-certificate-ref \metric-key-certificate-ref
| | | +--rw server-authentication | | | +--rw server-authentication
| | | | +--rw pinned-ca-certs? | | | | +--rw ca-certs?
| | | | | ta:pinned-certificates\ | | | | | ts:certificates-ref
\-ref | | | | | {ts:x509-certificates}?
| | | | | {ta:x509-certificates}? | | | | +--rw server-certs?
| | | | +--rw pinned-server-certs? | | | | ts:certificates-ref
| | | | ta:pinned-certificates\ | | | | {ts:x509-certificates}?
\-ref
| | | | {ta:x509-certificates}?
| | | +--rw hello-params | | | +--rw hello-params
| | | | {tls-client-hello-params-\ | | | | {tls-client-hello-params-\
\config}? \config}?
| | | | +--rw tls-versions | | | | +--rw tls-versions
| | | | | +--rw tls-version* | | | | | +--rw tls-version*
| | | | | identityref | | | | | identityref
| | | | +--rw cipher-suites | | | | +--rw cipher-suites
| | | | +--rw cipher-suite* | | | | +--rw cipher-suite*
| | | | identityref | | | | identityref
| | | +--rw keepalives! | | | +--rw keepalives!
skipping to change at page 43, line 25 skipping to change at page 44, line 16
| +--rw start-with? enumeration | +--rw start-with? enumeration
| +--rw max-attempts? uint8 | +--rw max-attempts? uint8
+--rw listen! {https-listen}? +--rw listen! {https-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)
+--:(https) {https-listen}? +--:(https) {https-listen}?
+--rw https +--rw https
+--rw tcp-server-parameters +--rw tcp-server-parameters
| +--rw local-address inet:ip-address | +--rw local-address
| +--rw local-port? inet:port-number | | inet:ip-address
| +--rw keepalives! | +--rw local-port?
| +--rw idle-time uint16 | | inet:port-number
| +--rw max-probes uint16 | +--rw keepalives! {keepalives-supported}?
| +--rw probe-interval uint16 | | +--rw idle-time uint16
| | +--rw max-probes uint16
| | +--rw probe-interval uint16
| +--rw external-endpoint-values!
| {external-endpoints}?
| +--rw address inet:ip-address
| +--rw port? inet:port-number
+--rw tls-client-parameters +--rw tls-client-parameters
| +--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\ | | | {local-definitions-su\
\}? \pported}?
| | | +--rw local-definition | | | +--rw local-definition
| | | +--rw algorithm? | | | +--rw algorithm
| | | | asymmetric-key-a\ | | | | asymmetric-key-a\
\lgorithm-ref \lgorithm-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
| | | | asymmetric\
\-key-algorithm-ref
| | | +---x install-hidden-key
| | | | +---w input
| | | | +---w algorithm
| | | | | asymmetric\
\-key-algorithm-ref
| | | | +---w public-key?
| | | | | binary
| | | | +---w private-key?
| | | | binary
| | | +--rw cert? | | | +--rw cert?
| | | | end-entity-cert-\ | | | | end-entity-cert-\
\cms \cms
| | | +---n certificate-expira\ | | | +---n certificate-expira\
\tion \tion
| | | +-- expiration-date | | | | +-- expiration-date
| | | yang:date-and\ | | | | yang:date-and\
\-time \-time
| | | +---x generate-certifica\
\te-signing-request
| | | +---w input
| | | | +---w subject
| | | | | binary
| | | | +---w attributes?
| | | | binary
| | | +--ro output
| | | +--ro certificate-\
\signing-request
| | | binary
| | +--:(keystore) | | +--:(keystore)
| | {keystore-supported}? | | {keystore-supported}?
| | +--rw keystore-reference? | | +--rw keystore-reference?
| | ks:asymmetric-key-c\ | | ks:asymmetric-key-c\
\ertificate-ref \ertificate-ref
| +--rw server-authentication | +--rw server-authentication
| | +--rw pinned-ca-certs? | | +--rw ca-certs? ts:certificates-ref
| | | ta:pinned-certificates-ref | | | {ts:x509-certificates}?
| | | {ta:x509-certificates}? | | +--rw server-certs? ts:certificates-ref
| | +--rw pinned-server-certs? | | {ts:x509-certificates}?
| | 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 keepalives! {tls-client-keepalives}? | +--rw keepalives! {tls-client-keepalives}?
| +--rw max-wait? uint16 | +--rw max-wait? uint16
| +--rw max-attempts? uint8 | +--rw max-attempts? uint8
+--rw http-client-parameters +--rw http-client-parameters
skipping to change at page 45, line 30 skipping to change at page 46, line 22
| +--:(scram-sha-256) | +--:(scram-sha-256)
| | +--rw scram-sha-256 | | +--rw scram-sha-256
| | {scram-sha-256-auth}? | | {scram-sha-256-auth}?
| +--:(vapid) | +--:(vapid)
| +--rw vapid {vapid-auth}? | +--rw vapid {vapid-auth}?
+--rw proxy-server! {proxy-connect}? +--rw proxy-server! {proxy-connect}?
+--rw tcp-client-parameters +--rw tcp-client-parameters
| +--rw remote-address inet:host | +--rw remote-address inet:host
| +--rw remote-port? inet:port-number | +--rw remote-port? inet:port-number
| +--rw local-address? inet:ip-address | +--rw local-address? inet:ip-address
| | {local-binding-supported}?
| +--rw local-port? inet:port-number | +--rw local-port? inet:port-number
| | {local-binding-supported}?
| +--rw keepalives! | +--rw keepalives!
| {keepalives-supported}?
| +--rw idle-time uint16 | +--rw idle-time uint16
| +--rw max-probes uint16 | +--rw max-probes uint16
| +--rw probe-interval uint16 | +--rw probe-interval uint16
+--rw tls-client-parameters +--rw tls-client-parameters
| +--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-sup\ | | | {local-definiti\
\ported}? \ons-supported}?
| | | +--rw local-definition | | | +--rw local-definition
| | | +--rw algorithm? | | | +--rw algorithm
| | | | asymmetric\ | | | | asymmetric\
\-key-algorithm-ref \-key-algorithm-ref
| | | +--rw public-key? | | | +--rw public-key
| | | | binary | | | | binary
| | | +--rw private-key? | | | +--rw private-key
| | | | union | | | | union
| | | +---x generate-hid\
\den-key
| | | | +---w input
| | | | +---w algori\
\thm
| | | | asym\
\metric-key-algorithm-ref
| | | +---x install-hidd\
\en-key
| | | | +---w input
| | | | +---w algori\
\thm
| | | | | asym\
\metric-key-algorithm-ref
| | | | +---w public\
\-key?
| | | | | bina\
\ry
| | | | +---w privat\
\e-key?
| | | | bina\
\ry
| | | +--rw cert? | | | +--rw cert?
| | | | end-entity\ | | | | end-entity\
\-cert-cms \-cert-cms
| | | +---n certificate-\ | | | +---n certificate-\
\expiration \expiration
| | | +-- expiration-\ | | | | +-- expiration-\
\date \date
| | | yang:da\ | | | | yang:da\
\te-and-time \te-and-time
| | | +---x generate-cer\
\tificate-signing-request
| | | +---w input
| | | | +---w subject
| | | | | bina\
\ry
| | | | +---w attrib\
\utes?
| | | | bina\
\ry
| | | +--ro output
| | | +--ro certif\
\icate-signing-request
| | | bina\
\ry
| | +--:(keystore) | | +--:(keystore)
| | {keystore-suppo\ | | {keystore-suppo\
\rted}? \rted}?
| | +--rw keystore-refere\ | | +--rw keystore-refere\
\nce? \nce?
| | ks:asymmetric\ | | ks:asymmetric\
\-key-certificate-ref \-key-certificate-ref
| +--rw server-authentication | +--rw server-authentication
| | +--rw pinned-ca-certs? | | +--rw ca-certs?
| | | ta:pinned-certificates-ref | | | ts:certificates-ref
| | | {ta:x509-certificates}? | | | {ts:x509-certificates}?
| | +--rw pinned-server-certs? | | +--rw server-certs?
| | ta:pinned-certificates-ref | | ts:certificates-ref
| | {ta:x509-certificates}? | | {ts: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 keepalives! | +--rw keepalives!
| {tls-client-keepalives}? | {tls-client-keepalives}?
| +--rw max-wait? uint16 | +--rw max-wait? uint16
skipping to change at page 47, line 35 skipping to change at page 48, line 24
module looks like without all the "grouping" statements expanded. module looks like without all the "grouping" statements expanded.
=========== NOTE: '\' line wrapping per BCP XX (RFC XXXX) =========== =========== NOTE: '\' line wrapping per BCP XX (RFC XXXX) ===========
module: ietf-restconf-server module: ietf-restconf-server
+--rw restconf-server +--rw restconf-server
+--rw listen! {https-listen}? +--rw listen! {https-listen}?
| +--rw endpoint* [name] | +--rw endpoint* [name]
| +--rw name string | +--rw name string
| +--rw (transport) | +--rw (transport)
| +--:(http) {http-listen}?
| | +--rw http
| | +--rw tcp-server-parameters
| | | +--rw local-address
| | | | inet:ip-address
| | | +--rw local-port?
| | | | inet:port-number
| | | +--rw keepalives! {keepalives-supported}?
| | | | +--rw idle-time uint16
| | | | +--rw max-probes uint16
| | | | +--rw probe-interval uint16
| | | +--rw external-endpoint-values!
| | | {external-endpoints}?
| | | +--rw address inet:ip-address
| | | +--rw port? inet:port-number
| | +--rw http-server-parameters
| | | +--rw server-name? string
| | | +--rw protocol-versions
| | | | +--rw protocol-version* enumeration
| | | +--rw client-authentication!
| | | +--rw (required-or-optional)
| | | | +--:(required)
| | | | | +--rw required?
| | | | | empty
| | | | +--:(optional)
| | | | +--rw optional?
| | | | empty
| | | +--rw (local-or-external)
| | | +--:(local)
| | | | {local-client-auth-supported}?
| | | | +--rw users
| | | | +--rw user* [name]
| | | | +--rw name string
| | | | +--rw password?
| | | | ianach:crypt-hash
| | | +--:(external)
| | | {external-client-auth-supporte\
d}?
| | | +--rw client-auth-defined-elsewhere?
| | | empty
| | +--rw restconf-server-parameters
| | +--rw client-identification
| | +--rw cert-maps
| | +--rw cert-to-name* [id]
| | +--rw id uint32
| | +--rw fingerprint
| | | x509c2n:tls-fingerprint
| | +--rw map-type identityref
| | +--rw name string
| +--:(https) {https-listen}? | +--:(https) {https-listen}?
| +--rw https | +--rw https
| +--rw tcp-server-parameters | +--rw tcp-server-parameters
| | +--rw local-address inet:ip-address | | +--rw local-address
| | +--rw local-port? inet:port-number | | | inet:ip-address
| | +--rw keepalives! | | +--rw local-port?
| | +--rw idle-time uint16 | | | inet:port-number
| | +--rw max-probes uint16 | | +--rw keepalives! {keepalives-supported}?
| | +--rw probe-interval uint16 | | | +--rw idle-time uint16
| | | +--rw max-probes uint16
| | | +--rw probe-interval uint16
| | +--rw external-endpoint-values!
| | {external-endpoints}?
| | +--rw address inet:ip-address
| | +--rw port? inet:port-number
| +--rw tls-server-parameters | +--rw tls-server-parameters
| | +--rw server-identity | | +--rw server-identity
| | | +--rw (local-or-keystore) | | | +--rw (local-or-keystore)
| | | +--:(local) {local-keys-supported}? | | | +--:(local)
| | | | {local-definitions-supported}?
| | | | +--rw local-definition | | | | +--rw local-definition
| | | | +--rw algorithm? | | | | +--rw algorithm
| | | | | asymmetric-key-algorithm-\ | | | | | asymmetric-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
| | | | | asymmetric-key-algo\
rithm-ref
| | | | +---x install-hidden-key
| | | | | +---w input
| | | | | +---w algorithm
| | | | | | asymmetric-key-algo\
rithm-ref
| | | | | +---w public-key? binary
| | | | | +---w private-key? binary
| | | | +--rw cert? | | | | +--rw cert?
| | | | | end-entity-cert-cms | | | | | end-entity-cert-cms
| | | | +---n certificate-expiration | | | | +---n certificate-expiration
| | | | +-- expiration-date | | | | | +-- expiration-date
| | | | yang:date-and-time | | | | | yang:date-and-time
| | | | +---x generate-certificate-signin\
g-request
| | | | +---w input
| | | | | +---w subject binary
| | | | | +---w attributes? binary
| | | | +--ro output
| | | | +--ro certificate-signing-r\
equest
| | | | binary
| | | +--:(keystore) {keystore-supported}? | | | +--:(keystore) {keystore-supported}?
| | | +--rw keystore-reference? | | | +--rw keystore-reference?
| | | ks:asymmetric-key-certificat\ | | | ks:asymmetric-key-certificat\
e-ref e-ref
| | +--rw client-authentication! | | +--rw client-authentication!
| | | +--rw (required-or-optional) | | | +--rw (required-or-optional)
| | | | +--:(required) | | | | +--:(required)
| | | | | +--rw required? | | | | | +--rw required?
| | | | | empty | | | | | empty
| | | | +--:(optional) | | | | +--:(optional)
| | | | +--rw optional? | | | | +--rw optional?
| | | | empty | | | | empty
| | | +--rw (local-or-external) | | | +--rw (local-or-external)
| | | +--:(local) | | | +--:(local)
| | | | {local-client-auth-supported}? | | | | {local-client-auth-supported}?
| | | | +--rw pinned-ca-certs? | | | | +--rw ca-certs?
| | | | | ta:pinned-certificates-ref | | | | | ts:certificates-ref
| | | | | {ta:x509-certificates}? | | | | | {ts:x509-certificates}?
| | | | +--rw pinned-client-certs? | | | | +--rw client-certs?
| | | | | ta:pinned-certificates-ref | | | | ts:certificates-ref
| | | | | {ta:x509-certificates}? | | | | {ts: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
| | | +--:(external) | | | +--:(external)
| | | {external-client-auth-supporte\ | | | {external-client-auth-supporte\
d}? d}?
| | | +--rw client-auth-defined-elsewhere? | | | +--rw client-auth-defined-elsewhere?
| | | empty | | | empty
| | +--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 keepalives! {tls-server-keepalives}? | | +--rw keepalives! {tls-server-keepalives}?
| | +--rw max-wait? uint16 | | +--rw max-wait? uint16
| | +--rw max-attempts? uint8 | | +--rw max-attempts? uint8
| +--rw http-server-parameters | +--rw http-server-parameters
| +--rw server-name? string | | +--rw server-name? string
| +--rw protocol-versions | | +--rw protocol-versions
| | +--rw protocol-version* enumeration | | | +--rw protocol-version* enumeration
| +--rw client-authentication! | | +--rw client-authentication!
| +--rw (required-or-optional) | | +--rw (required-or-optional)
| | +--:(required) | | | +--:(required)
| | | +--rw required? | | | | +--rw required?
| | | empty | | | | empty
| | +--:(optional) | | | +--:(optional)
| | +--rw optional? | | | +--rw optional?
| | empty | | | empty
| +--rw (local-or-external) | | +--rw (local-or-external)
| +--:(local) | | +--:(local)
| | {local-client-auth-supported}? | | | {local-client-auth-supported}?
| | +--rw users | | | +--rw users
| | +--rw user* [name] | | | +--rw user* [name]
| | +--rw name string | | | +--rw name string
| | +--rw password? | | | +--rw password?
| | ianach:crypt-hash | | | ianach:crypt-hash
| +--:(external) | | +--:(external)
| {external-client-auth-supporte\ | | {external-client-auth-supporte\
d}? d}?
| +--rw client-auth-defined-elsewhere? | | +--rw client-auth-defined-elsewhere?
| empty | | empty
| +--rw restconf-server-parameters
| +--rw client-identification
| +--rw cert-maps
| +--rw cert-to-name* [id]
| +--rw id uint32
| +--rw fingerprint
| | x509c2n:tls-fingerprint
| +--rw map-type identityref
| +--rw name string
+--rw call-home! {https-call-home}? +--rw call-home! {https-call-home}?
+--rw restconf-client* [name] +--rw restconf-client* [name]
+--rw name string +--rw name string
+--rw endpoints +--rw endpoints
| +--rw endpoint* [name] | +--rw endpoint* [name]
| +--rw name string | +--rw name string
| +--rw (transport) | +--rw (transport)
| +--:(https) {https-call-home}? | +--:(https) {https-listen}?
| +--rw https | +--rw https
| +--rw tcp-client-parameters | +--rw tcp-client-parameters
| | +--rw remote-address inet:host | | +--rw remote-address inet:host
| | +--rw remote-port? inet:port-number | | +--rw remote-port? inet:port-number
| | +--rw local-address? inet:ip-address | | +--rw local-address? inet:ip-address
| | | {local-binding-supported}?
| | +--rw local-port? inet:port-number | | +--rw local-port? inet:port-number
| | | {local-binding-supported}?
| | +--rw keepalives! | | +--rw keepalives!
| | {keepalives-supported}?
| | +--rw idle-time uint16 | | +--rw idle-time uint16
| | +--rw max-probes uint16 | | +--rw max-probes uint16
| | +--rw probe-interval uint16 | | +--rw probe-interval uint16
| +--rw tls-server-parameters | +--rw tls-server-parameters
| | +--rw server-identity | | +--rw server-identity
| | | +--rw (local-or-keystore) | | | +--rw (local-or-keystore)
| | | +--:(local) | | | +--:(local)
| | | | {local-keys-supported}? | | | | {local-definitions-suppo\
rted}?
| | | | +--rw local-definition | | | | +--rw local-definition
| | | | +--rw algorithm? | | | | +--rw algorithm
| | | | | asymmetric-key-algo\ | | | | | asymmetric-key-algo\
rithm-ref rithm-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
| | | | | asymmetric-ke\
y-algorithm-ref
| | | | +---x install-hidden-key
| | | | | +---w input
| | | | | +---w algorithm
| | | | | | asymmetric-ke\
y-algorithm-ref
| | | | | +---w public-key?
| | | | | | binary
| | | | | +---w private-key?
| | | | | binary
| | | | +--rw cert? | | | | +--rw cert?
| | | | | end-entity-cert-cms | | | | | end-entity-cert-cms
| | | | +---n certificate-expiration | | | | +---n certificate-expiration
| | | | +-- expiration-date | | | | | +-- expiration-date
| | | | yang:date-and-ti\ | | | | | yang:date-and-ti\
me me
| | | | +---x generate-certificate-\
signing-request
| | | | +---w input
| | | | | +---w subject
| | | | | | binary
| | | | | +---w attributes?
| | | | | binary
| | | | +--ro output
| | | | +--ro certificate-sig\
ning-request
| | | | binary
| | | +--:(keystore) | | | +--:(keystore)
| | | {keystore-supported}? | | | {keystore-supported}?
| | | +--rw keystore-reference? | | | +--rw keystore-reference?
| | | ks:asymmetric-key-cert\ | | | ks:asymmetric-key-cert\
ificate-ref ificate-ref
| | +--rw client-authentication! | | +--rw client-authentication!
| | | +--rw (required-or-optional) | | | +--rw (required-or-optional)
| | | | +--:(required) | | | | +--:(required)
| | | | | +--rw required? | | | | | +--rw required?
| | | | | empty | | | | | empty
| | | | +--:(optional) | | | | +--:(optional)
| | | | +--rw optional? | | | | +--rw optional?
| | | | empty | | | | empty
| | | +--rw (local-or-external) | | | +--rw (local-or-external)
skipping to change at page 51, line 15 skipping to change at page 53, line 9
ificate-ref ificate-ref
| | +--rw client-authentication! | | +--rw client-authentication!
| | | +--rw (required-or-optional) | | | +--rw (required-or-optional)
| | | | +--:(required) | | | | +--:(required)
| | | | | +--rw required? | | | | | +--rw required?
| | | | | empty | | | | | empty
| | | | +--:(optional) | | | | +--:(optional)
| | | | +--rw optional? | | | | +--rw optional?
| | | | empty | | | | empty
| | | +--rw (local-or-external) | | | +--rw (local-or-external)
| | | | +--:(local) | | | +--:(local)
| | | | | {local-client-auth-suppo\ | | | | {local-client-auth-suppo\
rted}? rted}?
| | | | | +--rw pinned-ca-certs? | | | | +--rw ca-certs?
| | | | | | ta:pinned-certificates\ | | | | | ts:certificates-ref
-ref | | | | | {ts:x509-certificates}?
| | | | | | {ta:x509-certificates}? | | | | +--rw client-certs?
| | | | | +--rw pinned-client-certs? | | | | ts:certificates-ref
| | | | | ta:pinned-certificates\ | | | | {ts:x509-certificates}?
-ref | | | +--:(external)
| | | | | {ta:x509-certificates}? | | | {external-client-auth-su\
| | | | +--:(external)
| | | | {external-client-auth-su\
pported}? pported}?
| | | | +--rw client-auth-defined-else\ | | | +--rw client-auth-defined-else\
where? where?
| | | | empty | | | empty
| | | +--rw cert-maps
| | | +--rw cert-to-name* [id]
| | | +--rw id uint32
| | | +--rw fingerprint
| | | | x509c2n:tls-fingerprint
| | | +--rw map-type
| | | | identityref
| | | +--rw name string
| | +--rw hello-params | | +--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 keepalives! | | +--rw keepalives!
| | {tls-server-keepalives}? | | {tls-server-keepalives}?
| | +--rw max-wait? uint16 | | +--rw max-wait? uint16
| | +--rw max-attempts? uint8 | | +--rw max-attempts? uint8
| +--rw http-server-parameters | +--rw http-server-parameters
| +--rw server-name? string | | +--rw server-name? string
| +--rw protocol-versions | | +--rw protocol-versions
| | +--rw protocol-version* enumeration | | | +--rw protocol-version* enumeration
| +--rw client-authentication! | | +--rw client-authentication!
| +--rw (required-or-optional) | | +--rw (required-or-optional)
| | +--:(required) | | | +--:(required)
| | | +--rw required? | | | | +--rw required?
| | | empty | | | | empty
| | +--:(optional) | | | +--:(optional)
| | +--rw optional? | | | +--rw optional?
| | empty | | | empty
| +--rw (local-or-external) | | +--rw (local-or-external)
| +--:(local) | | +--:(local)
| | {local-client-auth-suppo\ | | | {local-client-auth-suppo\
rted}? rted}?
| | +--rw users | | | +--rw users
| | +--rw user* [name] | | | +--rw user* [name]
| | +--rw name string | | | +--rw name string
| | +--rw password? | | | +--rw password?
| | ianach:crypt-hash | | | ianach:crypt-hash
| +--:(external) | | +--:(external)
| {external-client-auth-su\ | | {external-client-auth-su\
pported}? pported}?
| +--rw client-auth-defined-else\ | | +--rw client-auth-defined-else\
where? where?
| empty | | empty
| +--rw restconf-server-parameters
| +--rw client-identification
| +--rw cert-maps
| +--rw cert-to-name* [id]
| +--rw id uint32
| +--rw fingerprint
| | x509c2n:tls-fingerprint
| +--rw map-type
| | identityref
| +--rw name string
+--rw connection-type +--rw connection-type
| +--rw (connection-type) | +--rw (connection-type)
| +--:(persistent-connection) | +--:(persistent-connection)
| | +--rw persistent! | | +--rw persistent!
| +--:(periodic-connection) | +--:(periodic-connection)
| +--rw periodic! | +--rw periodic!
| +--rw period? uint16 | +--rw period? uint16
| +--rw anchor-time? yang:date-and-time | +--rw anchor-time? yang:date-and-time
| +--rw idle-timeout? uint16 | +--rw idle-timeout? uint16
+--rw reconnect-strategy +--rw reconnect-strategy
skipping to change at page 55, line 27 skipping to change at page 57, line 19
o Updated text to better reference where certain examples come from o Updated text to better reference where certain examples come from
(e.g., which Section in which draft). (e.g., which Section in which draft).
o In the server model, commented out the "must 'pinned-ca-certs or o In the server model, commented out the "must 'pinned-ca-certs or
pinned-client-certs'" statement to reflect change made in the TLS pinned-client-certs'" statement to reflect change made in the TLS
draft whereby the trust anchors MAY be defined externally. draft whereby the trust anchors MAY be defined externally.
o Replaced the 'listen', 'initiate', and 'call-home' features with o Replaced the 'listen', 'initiate', and 'call-home' features with
boolean expressions. boolean expressions.
B.13. 12 to 13
o Updated to reflect changes in trust-anchors drafts (e.g., s/trust-
anchors/truststore/g + s/pinned.//)
o In ietf-restconf-server, Added 'http-listen' (not https-listen)
choice, to support case when server is behind a TLS-terminator.
o Refactored server module to be more like other 'server' models.
If folks like it, will also apply to the client model, as well as
to both the netconf client/server models. Now the 'restconf-
server-grouping' is just the RC-specific bits (i.e., the "demux"
container minus the container), 'restconf-server-
[listen|callhome]-stack-grouping' is the protocol stack for a
single connection, and 'restconf-server-app-grouping' is
effectively what was before (both listen+callhome for many
inbound/outbound endpoints).
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, Ramkumar Dhanapal, Mehmet Ersue, Balazs Bjorklund, Benoit Claise, Ramkumar Dhanapal, Mehmet Ersue, Balazs
Kovacs, David Lamparter, Alan Luchuk, Ladislav Lhotka, Radek Krejci, Kovacs, David Lamparter, Alan Luchuk, Ladislav Lhotka, Radek Krejci,
Tom Petch, Juergen Schoenwaelder, Phil Shafer, Sean Turner, and Bert Tom Petch, Juergen Schoenwaelder, Phil Shafer, Sean Turner, and Bert
Wijnen. Wijnen.
Author's Address Author's Address
 End of changes. 124 change blocks. 
587 lines changed or deleted 690 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/