NETCONF Working Group K. Watsen Internet-Draft Watsen Networks Intended status: Standards Track April 7, 2019 Expires: October 9, 2019 RESTCONF Client and Server Models draft-ietf-netconf-restconf-client-server-11 Abstract This document defines two YANG modules, one module to configure a RESTCONF client and the other module to configure a RESTCONF server. Both modules support the TLS transport protocol with both standard RESTCONF and RESTCONF Call Home connections. Editorial Note (To be removed by RFC Editor) This draft contains many placeholder values that need to be replaced with finalized values at the time of publication. This note summarizes all of the substitutions that are needed. No other RFC Editor instructions are specified elsewhere in this document. This document contains references to other drafts in progress, both in the Normative References section, as well as in body text throughout. Please update the following references to reflect their final RFC assignments: o I-D.ietf-netconf-keystore o I-D.ietf-netconf-tcp-client-server o I-D.ietf-netconf-tls-client-server o I-D.ietf-netconf-http-client-server Artwork in this document contains shorthand references to drafts in progress. Please apply the following replacements: o "XXXX" --> the assigned RFC value for this draft o "AAAA" --> the assigned RFC value for I-D.ietf-netconf-tcp-client- server o "BBBB" --> the assigned RFC value for I-D.ietf-netconf-tls-client- server Watsen Expires October 9, 2019 [Page 1] Internet-Draft RESTCONF Client and Server Models April 2019 o "CCCC" --> the assigned RFC value for I-D.ietf-netconf-http- client-server Artwork in this document contains placeholder values for the date of publication of this draft. Please apply the following replacement: o "2019-04-07" --> the publication date of this draft The following Appendix section is to be removed prior to publication: o Appendix B. Change Log Status of This Memo This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet- Drafts is at https://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." This Internet-Draft will expire on October 9, 2019. Copyright Notice Copyright (c) 2019 IETF Trust and the persons identified as the document authors. All rights reserved. This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. Watsen Expires October 9, 2019 [Page 2] Internet-Draft RESTCONF Client and Server Models April 2019 Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 4 2. The RESTCONF Client Model . . . . . . . . . . . . . . . . . . 4 2.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 4 2.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 5 2.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 9 3. The RESTCONF Server Model . . . . . . . . . . . . . . . . . . 17 3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 17 3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 18 3.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 22 4. Security Considerations . . . . . . . . . . . . . . . . . . . 31 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 32 5.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 32 5.2. The YANG Module Names Registry . . . . . . . . . . . . . 33 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 33 6.1. Normative References . . . . . . . . . . . . . . . . . . 33 6.2. Informative References . . . . . . . . . . . . . . . . . 34 Appendix A. Expanded Tree Diagrams . . . . . . . . . . . . . . . 36 A.1. Expanded Tree Diagram for 'ietf-restconf-client' . . . . 36 A.2. Expanded Tree Diagram for 'ietf-restconf-server' . . . . 45 Appendix B. Change Log . . . . . . . . . . . . . . . . . . . . . 49 B.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 49 B.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 49 B.3. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 49 B.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 49 B.5. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 50 B.6. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 50 B.7. 06 to 07 . . . . . . . . . . . . . . . . . . . . . . . . 50 B.8. 07 to 08 . . . . . . . . . . . . . . . . . . . . . . . . 50 B.9. 08 to 09 . . . . . . . . . . . . . . . . . . . . . . . . 50 B.10. 09 to 10 . . . . . . . . . . . . . . . . . . . . . . . . 51 B.11. 10 to 11 . . . . . . . . . . . . . . . . . . . . . . . . 51 Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 51 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 51 1. Introduction This document defines two YANG [RFC7950] modules, one module to configure a RESTCONF client and the other module to configure a RESTCONF server [RFC8040]. Both modules support the TLS [RFC8446] transport protocol with both standard RESTCONF and RESTCONF Call Home connections [RFC8071]. Watsen Expires October 9, 2019 [Page 3] Internet-Draft RESTCONF Client and Server Models April 2019 1.1. Terminology The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here. 2. The RESTCONF Client Model The RESTCONF client model presented in this section supports both clients initiating connections to servers, as well as clients listening for connections from servers calling home. YANG feature statements are used to enable implementations to advertise which potentially uncommon parts of the model the RESTCONF client supports. 2.1. Tree Diagram The following tree diagram [RFC8340] provides an overview of the data model for the "ietf-restconf-client" module. This tree diagram only shows the nodes defined in this module; it does show the nodes defined by "grouping" statements used by this module. Please see Appendix A.1 for a tree diagram that illustrates what the module looks like with all the "grouping" statements expanded. Watsen Expires October 9, 2019 [Page 4] Internet-Draft RESTCONF Client and Server Models April 2019 module: ietf-restconf-client +--rw restconf-client +---u restconf-client-grouping grouping restconf-client-grouping +-- initiate! {initiate}? | +-- restconf-server* [name] | +-- name? string | +-- endpoints | | +-- endpoint* [name] | | +-- name? string | | +-- (transport) | | +--:(https) {https-initiate}? | | +-- https | | +---u restconf-client-grouping | +-- connection-type | | +-- (connection-type) | | +--:(persistent-connection) | | | +-- persistent! | | +--:(periodic-connection) | | +-- periodic! | | +-- period? uint16 | | +-- anchor-time? yang:date-and-time | | +-- idle-timeout? uint16 | +-- reconnect-strategy | +-- start-with? enumeration | +-- max-attempts? uint8 +-- listen! {listen}? +-- idle-timeout? uint16 +-- endpoint* [name] +-- name? string +-- (transport) +--:(https) {https-listen}? +-- https +---u restconf-client-grouping 2.2. Example Usage The following example illustrates configuring a RESTCONF client to initiate connections, as well as listening for call-home connections. This example is consistent with the examples presented in Section 2 of [I-D.ietf-netconf-trust-anchors] and Section 3.2 of [I-D.ietf-netconf-keystore]. =========== NOTE: '\' line wrapping per BCP XX (RFC XXXX) =========== corp-fw1 corp-fw1.example.com corp-fw1.example.com 15 3 30 ct:rsa2048 base64encodedvalue== base64encodedvalue== base64encodedvalue== explicitly-trusted-server-ca-certs<\ /pinned-ca-certs> explicitly-trusted-server-certs\ 30 3 HTTP/1.1 bob secret Watsen Expires October 9, 2019 [Page 6] Internet-Draft RESTCONF Client and Server Models April 2019 corp-fw2.example.com corp-fw2.example.com 15 3 30 ct:rsa2048 base64encodedvalue== base64encodedvalue== base64encodedvalue== explicitly-trusted-server-ca-certs<\ /pinned-ca-certs> explicitly-trusted-server-certs\ 30 3 HTTP/1.1 bob secret Watsen Expires October 9, 2019 [Page 7] Internet-Draft RESTCONF Client and Server Models April 2019 Intranet-facing listener 11.22.33.44 ct:rsa2048 base64encodedvalue== base64encodedvalue== base64encodedvalue== explicitly-trusted-server-ca-certs explicitly-trusted-server-certs HTTP/1.1 bob secret Watsen Expires October 9, 2019 [Page 8] Internet-Draft RESTCONF Client and Server Models April 2019 2.3. YANG Module This YANG module has normative references to [RFC6991], [RFC8040], and [RFC8071], [I-D.kwatsen-netconf-tcp-client-server], [I-D.ietf-netconf-tls-client-server], and [I-D.kwatsen-netconf-http-client-server]. file "ietf-restconf-client@2019-04-07.yang" module ietf-restconf-client { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-restconf-client"; prefix rcc; import ietf-yang-types { prefix yang; reference "RFC 6991: Common YANG Data Types"; } import ietf-tcp-client { prefix tcpc; reference "RFC AAAA: YANG Groupings for TCP Clients and TCP Servers"; } import ietf-tcp-server { prefix tcps; reference "RFC AAAA: YANG Groupings for TCP Clients and TCP Servers"; } import ietf-tls-client { prefix tlsc; reference "RFC BBBB: YANG Groupings for TLS Clients and TLS Servers"; } import ietf-http-client { prefix httpc; reference "RFC CCCC: YANG Groupings for HTTP Clients and HTTP Servers"; } organization "IETF NETCONF (Network Configuration) Working Group"; contact "WG Web: Watsen Expires October 9, 2019 [Page 9] Internet-Draft RESTCONF Client and Server Models April 2019 WG List: Author: Kent Watsen Author: Gary Wu "; description "This module contains a collection of YANG definitions for configuring RESTCONF clients. Copyright (c) 2019 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself for full legal notices.; The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document are to be interpreted as described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, they appear in all capitals, as shown here."; revision 2019-04-07 { description "Initial version"; reference "RFC XXXX: RESTCONF Client and Server Models"; } // Features feature initiate { description "The 'initiate' feature indicates that the RESTCONF client supports initiating RESTCONF connections to RESTCONF servers using at least one transport (e.g., HTTPS, etc.)."; } feature https-initiate { if-feature "initiate"; description Watsen Expires October 9, 2019 [Page 10] Internet-Draft RESTCONF Client and Server Models April 2019 "The 'https-initiate' feature indicates that the RESTCONF client supports initiating HTTPS connections to RESTCONF servers. This feature exists as HTTPS might not be a mandatory to implement transport in the future."; reference "RFC 8040: RESTCONF Protocol"; } feature listen { description "The 'listen' feature indicates that the RESTCONF client supports opening a port to accept RESTCONF server call home connections using at least one transport (e.g., HTTPS, etc.)."; } feature https-listen { if-feature "listen"; description "The 'https-listen' feature indicates that the RESTCONF client supports opening a port to listen for incoming RESTCONF server call-home connections. This feature exists as not all RESTCONF clients may support RESTCONF call home."; reference "RFC 8071: NETCONF Call Home and RESTCONF Call Home"; } // Groupings grouping restconf-client-grouping { description "Top-level grouping for RESTCONF client configuration."; container initiate { if-feature "initiate"; presence "Enables client to initiate TCP connections"; description "Configures client initiating underlying TCP connections."; list restconf-server { key "name"; min-elements 1; description "List of RESTCONF servers the RESTCONF client is to initiate connections to in parallel."; leaf name { type string; description "An arbitrary name for the RESTCONF server."; } Watsen Expires October 9, 2019 [Page 11] Internet-Draft RESTCONF Client and Server Models April 2019 container endpoints { description "Container for the list of endpoints."; list endpoint { key "name"; min-elements 1; ordered-by user; description "A non-empty user-ordered list of endpoints for this RESTCONF client to try to connect to in sequence. Defining more than one enables high-availability."; leaf name { type string; description "An arbitrary name for this endpoint."; } 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-initiate"; container https { description "Specifies HTTPS-specific transport configuration."; uses tcpc:tcp-client-grouping { refine "tcp-client-parameters/remote-port" { default "443"; description "The RESTCONF client will attempt to connect to the IANA-assigned well-known port value for 'https' (443) if no value is specified."; } } uses tlsc:tls-client-grouping { refine "tls-client-parameters/client-identity" + "/auth-type" { mandatory true; description "RESTCONF clients MUST pass some authentication credentials."; } } uses httpc:http-client-grouping; Watsen Expires October 9, 2019 [Page 12] Internet-Draft RESTCONF Client and Server Models April 2019 } } // https } // transport } // endpoint } // endpoints container connection-type { description "Indicates the RESTCONF client's preference for how the RESTCONF connection is maintained."; choice connection-type { mandatory true; description "Selects between available connection types."; case persistent-connection { container persistent { presence "Indicates that a persistent connection is to be maintained."; description "Maintain a persistent connection to the RESTCONF server. If the connection goes down, immediately start trying to reconnect to it, using the reconnection strategy. This connection type minimizes any RESTCONF server to RESTCONF client data-transfer delay, albeit at the expense of holding resources longer."; } } case periodic-connection { container periodic { must 'not (../../endpoints/endpoint/https/' + 'tcp-client-parameters/keepalives ' + 'or ../../endpoints/endpoint/https/' + 'tls-client-parameters/keepalives)'; presence "Indicates that a periodic connection is to be maintained."; description "Periodically connect to the RESTCONF server. The RESTCONF server should close the underlying TCP connection upon completing planned activities. This connection type increases resource utilization, albeit with increased delay in RESTCONF server to RESTCONF client interactions."; leaf period { type uint16; units "minutes"; Watsen Expires October 9, 2019 [Page 13] Internet-Draft RESTCONF Client and Server Models April 2019 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 { type uint16; units "seconds"; default 120; // two minutes description "Specifies the maximum number of seconds that the underlying TCP session may remain idle. A TCP session will be dropped if it is idle for an interval longer than this number of seconds If set to zero, then the RESTCONF client will never drop a session because it is idle."; } } } // periodic-connection } // connection-type } // connection-type container reconnect-strategy { description "The reconnection strategy directs how a RESTCONF client reconnects to a RESTCONF server, after discovering its connection to the server has dropped, even if due to a reboot. The RESTCONF client starts with the specified endpoint and tries to connect to it max-attempts times before trying the next endpoint in the list (round robin)."; Watsen Expires October 9, 2019 [Page 14] Internet-Draft RESTCONF Client and Server Models April 2019 leaf start-with { type enumeration { enum first-listed { description "Indicates that reconnections should start with the first endpoint listed."; } enum last-connected { description "Indicates that reconnections should start with the endpoint last connected to. If no previous connection has ever been established, then the first endpoint configured is used. RESTCONF clients SHOULD be able to remember the last endpoint connected to across reboots."; } enum random-selection { description "Indicates that reconnections should start with a random endpoint."; } } default "first-listed"; description "Specifies which of the RESTCONF server's endpoints the RESTCONF client should start with when trying to connect to the RESTCONF server."; } leaf max-attempts { type uint8 { range "1..max"; } default "3"; description "Specifies the number times the RESTCONF client tries to connect to a specific endpoint before moving on to the next endpoint in the list (round robin)."; } } // reconnect-strategy } // restconf-server } // initiate container listen { if-feature "listen"; presence "Enables client to accept call-home connections"; Watsen Expires October 9, 2019 [Page 15] Internet-Draft RESTCONF Client and Server Models April 2019 description "Configures client accepting call-home TCP connections."; leaf idle-timeout { type uint16; units "seconds"; default 3600; // one hour description "Specifies the maximum number of seconds that an underlying TCP session may remain idle. A TCP session will be dropped if it is idle for an interval longer then this number of seconds. If set to zero, then the server will never drop a session because it is idle. Sessions that have a notification subscription active are never dropped."; } list endpoint { key "name"; min-elements 1; description "List of endpoints to listen for RESTCONF connections."; leaf name { type string; description "An arbitrary name for the RESTCONF listen endpoint."; } 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 "HTTPS-specific listening configuration for inbound connections."; uses tcps:tcp-server-grouping { refine "tcp-server-parameters/local-port" { default "4336"; description "The RESTCONF client will listen on the IANA- assigned well-known port for 'restconf-ch-tls' (4336) if no value is specified."; } } uses tlsc:tls-client-grouping { refine Watsen Expires October 9, 2019 [Page 16] Internet-Draft RESTCONF Client and Server Models April 2019 "tls-client-parameters/client-identity/auth-type" { mandatory true; description "RESTCONF clients MUST pass some authentication credentials."; } } uses httpc:http-client-grouping; } } // case https } // transport } // endpoint } // listen } // restconf-client // Protocol accessible node, for servers that implement this // module. container restconf-client { uses restconf-client-grouping; description "Top-level container for RESTCONF client configuration."; } } 3. The RESTCONF Server Model The RESTCONF server model presented in this section supports both listening for connections as well as initiating call-home connections. YANG feature statements are used to enable implementations to advertise which potentially uncommon parts of the model the RESTCONF server supports. 3.1. Tree Diagram The following tree diagram [RFC8340] provides an overview of the data model for the "ietf-restconf-server" module. This tree diagram only shows the nodes defined in this module; it does show the nodes defined by "grouping" statements used by this module. Please see Appendix A.2 for a tree diagram that illustrates what the module looks like with all the "grouping" statements expanded. Watsen Expires October 9, 2019 [Page 17] Internet-Draft RESTCONF Client and Server Models April 2019 module: ietf-restconf-server +--rw restconf-server +---u restconf-server-grouping grouping restconf-server-grouping +-- listen! {listen}? | +-- endpoint* [name] | +-- name? string | +-- (transport) | +--:(https) {https-listen}? | +-- https | +---u restconf-server-grouping +-- call-home! {call-home}? +-- restconf-client* [name] +-- name? string +-- endpoints | +-- endpoint* [name] | +-- name? string | +-- (transport) | +--:(https) {https-call-home}? | +-- https | +---u restconf-server-grouping +-- connection-type | +-- (connection-type) | +--:(persistent-connection) | | +-- persistent! | +--:(periodic-connection) | +-- periodic! | +-- period? uint16 | +-- anchor-time? yang:date-and-time | +-- idle-timeout? uint16 +-- reconnect-strategy +-- start-with? enumeration +-- max-attempts? uint8 3.2. Example Usage The following example illustrates configuring a RESTCONF server to listen for RESTCONF client connections, as well as configuring call- home to one RESTCONF client. This example is consistent with the examples presented in Section 2 of [I-D.ietf-netconf-trust-anchors] and Section 3.2 of [I-D.ietf-netconf-keystore]. =========== NOTE: '\' line wrapping per BCP XX (RFC XXXX) =========== netconf/tls 11.22.33.44 ct:rsa2048 base64encodedvalue== base64encodedvalue== base64encodedvalue== explicitly-trusted-client-ca-certs explicitly-trusted-client-certs 1 11:0A:05:11:00 x509c2n:san-any 2 B3:4F:A1:8C:54 x509c2n:specified scooby-doo foo.example.com HTTP/1.1 HTTP/2.0 Watsen Expires October 9, 2019 [Page 19] Internet-Draft RESTCONF Client and Server Models April 2019 config-manager east-data-center east.example.com ct:rsa2048 base64encodedvalue== base64encodedvalue== base64encodedvalue== explicitly-trusted-client-ca-certs<\ /pinned-ca-certs> explicitly-trusted-client-certs\ 1 11:0A:05:11:00 x509c2n:san-any 2 B3:4F:A1:8C:54 x509c2n:specified scooby-doo foo.example.com Watsen Expires October 9, 2019 [Page 20] Internet-Draft RESTCONF Client and Server Models April 2019 HTTP/1.1 HTTP/2.0 west-data-center west.example.com ct:rsa2048 base64encodedvalue== base64encodedvalue== base64encodedvalue== explicitly-trusted-client-ca-certs<\ /pinned-ca-certs> explicitly-trusted-client-certs\ 1 11:0A:05:11:00 x509c2n:san-any 2 B3:4F:A1:8C:54 x509c2n:specified scooby-doo foo.example.com HTTP/1.1 HTTP/2.0 Watsen Expires October 9, 2019 [Page 21] Internet-Draft RESTCONF Client and Server Models April 2019 300 60 last-connected 3 3.3. YANG Module This YANG module has normative references to [RFC6991], [RFC7407], [RFC8040], [RFC8071], [I-D.kwatsen-netconf-tcp-client-server], [I-D.ietf-netconf-tls-client-server], and [I-D.kwatsen-netconf-http-client-server]. file "ietf-restconf-server@2019-04-07.yang" module ietf-restconf-server { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-restconf-server"; prefix rcs; import ietf-yang-types { prefix yang; reference "RFC 6991: Common YANG Data Types"; } import ietf-x509-cert-to-name { prefix x509c2n; reference "RFC 7407: A YANG Data Model for SNMP Configuration"; } import ietf-tcp-client { prefix tcpc; reference "RFC AAAA: YANG Groupings for TCP Clients and TCP Servers"; } Watsen Expires October 9, 2019 [Page 22] Internet-Draft RESTCONF Client and Server Models April 2019 import ietf-tcp-server { prefix tcps; reference "RFC AAAA: YANG Groupings for TCP Clients and TCP Servers"; } import ietf-tls-server { prefix tlss; reference "RFC BBBB: YANG Groupings for TLS Clients and TLS Servers"; } import ietf-http-server { prefix https; reference "RFC CCCC: YANG Groupings for HTTP Clients and HTTP Servers"; } organization "IETF NETCONF (Network Configuration) Working Group"; contact "WG Web: WG List: Author: Kent Watsen Author: Gary Wu Author: Juergen Schoenwaelder "; description "This module contains a collection of YANG definitions for configuring RESTCONF servers. Copyright (c) 2019 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself for full legal notices.; The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', Watsen Expires October 9, 2019 [Page 23] Internet-Draft RESTCONF Client and Server Models April 2019 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document are to be interpreted as described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, they appear in all capitals, as shown here."; revision 2019-04-07 { description "Initial version"; reference "RFC XXXX: RESTCONF Client and Server Models"; } // Features feature listen { description "The 'listen' feature indicates that the RESTCONF server supports opening a port to accept RESTCONF client connections using at least one transport (e.g., HTTPS, etc.)."; } feature https-listen { if-feature "listen"; description "The 'https-listen' feature indicates that the RESTCONF server supports opening a port to listen for incoming RESTCONF client connections. This feature exists as HTTPS might not be a mandatory to implement transport in the future."; reference "RFC 8040: RESTCONF Protocol"; } feature call-home { description "The 'call-home' feature indicates that the RESTCONF server supports initiating RESTCONF call home connections to RESTCONF clients using at least one transport (e.g., HTTPS, etc.)."; reference "RFC 8071: NETCONF Call Home and RESTCONF Call Home"; } feature https-call-home { if-feature "call-home"; description "The 'https-call-home' feature indicates that the RESTCONF server supports initiating connections to RESTCONF clients. Watsen Expires October 9, 2019 [Page 24] Internet-Draft RESTCONF Client and Server Models April 2019 This feature exists as not all RESTCONF servers may support RESTCONF call home."; reference "RFC 8071: NETCONF Call Home and RESTCONF Call Home"; } // Groupings grouping restconf-server-grouping { description "Top-level grouping for RESTCONF server configuration."; container listen { if-feature "listen"; presence "Enables server to listen for TCP connections"; description "Configures listen behavior"; list endpoint { key "name"; min-elements 1; description "List of endpoints to listen for RESTCONF connections."; leaf name { type string; description "An arbitrary name for the RESTCONF listen endpoint."; } 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 "HTTPS-specific listening configuration for inbound connections."; uses tcps:tcp-server-grouping { refine "tcp-server-parameters/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."; } } uses tlss:tls-server-grouping { refine Watsen Expires October 9, 2019 [Page 25] Internet-Draft RESTCONF Client and Server Models April 2019 "tls-server-parameters/client-authentication" { must 'pinned-ca-certs or pinned-client-certs'; description "RESTCONF servers MUST be able to validate clients."; } augment "tls-server-parameters/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."; } } } uses https:http-server-grouping; } // https container } // tls case } // transport } // endpoint } // listen container call-home { if-feature "call-home"; presence "Enables server to initiate TCP connections"; description "Configures call-home behavior"; list restconf-client { key "name"; min-elements 1; description "List of RESTCONF clients the RESTCONF server is to initiate call-home connections to in parallel."; leaf name { type string; Watsen Expires October 9, 2019 [Page 26] Internet-Draft RESTCONF Client and Server Models April 2019 description "An arbitrary name for the remote RESTCONF client."; } container endpoints { description "Container for the list of endpoints."; list endpoint { key "name"; min-elements 1; ordered-by user; description "User-ordered list of endpoints for this RESTCONF client. Defining more than one enables high- availability."; leaf name { type string; description "An arbitrary name for this endpoint."; } 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-call-home"; container https { description "Specifies HTTPS-specific call-home transport configuration."; uses tcpc:tcp-client-grouping { refine "tcp-client-parameters/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."; } } uses tlss:tls-server-grouping { refine "tls-server-parameters/client-authentication" { must 'pinned-ca-certs or pinned-client-certs'; description "RESTCONF servers MUST be able to validate clients."; Watsen Expires October 9, 2019 [Page 27] Internet-Draft RESTCONF Client and Server Models April 2019 } augment "tls-server-parameters/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."; } } } uses https:http-server-grouping; } } } // transport } // endpoint } // endpoints container connection-type { description "Indicates the RESTCONF server's preference for how the RESTCONF connection is maintained."; choice connection-type { mandatory true; description "Selects between available connection types."; case persistent-connection { container persistent { presence "Indicates that a persistent connection is to be maintained."; description "Maintain a persistent connection to the RESTCONF client. If the connection goes down, immediately start trying to reconnect to it, using the reconnection strategy. Watsen Expires October 9, 2019 [Page 28] Internet-Draft RESTCONF Client and Server Models April 2019 This connection type minimizes any RESTCONF client to RESTCONF server data-transfer delay, albeit at the expense of holding resources longer."; } } case periodic-connection { container periodic { must 'not (../../endpoints/endpoint/https/' + 'tcp-client-parameters/keepalives ' + 'or ../../endpoints/endpoint/https/' + 'tls-server-parameters/keepalives)'; presence "Indicates that a periodic connection is to be maintained."; description "Periodically connect to the RESTCONF client. The RESTCONF client should close the underlying TCP connection upon completing planned activities. 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 { type uint16; units "seconds"; Watsen Expires October 9, 2019 [Page 29] Internet-Draft RESTCONF Client and Server Models April 2019 default 120; // two minutes description "Specifies the maximum number of seconds that the underlying TCP session may remain idle. A TCP session will be dropped if it is idle for an interval longer than this number of seconds. If set to zero, then the server will never drop a session because it is idle."; } } } } } container reconnect-strategy { description "The reconnection strategy directs how a RESTCONF server reconnects to a RESTCONF client after discovering its connection to the client has dropped, even if due to a reboot. The RESTCONF server starts with the specified endpoint and tries to connect to it max-attempts times before trying the next endpoint in the list (round robin)."; leaf start-with { type enumeration { enum first-listed { description "Indicates that reconnections should start with the first endpoint listed."; } enum last-connected { description "Indicates that reconnections should start with the endpoint last connected to. If no previous connection has ever been established, then the first endpoint configured is used. RESTCONF servers SHOULD be able to remember the last endpoint connected to across reboots."; } enum random-selection { description "Indicates that reconnections should start with a random endpoint."; } } default "first-listed"; description "Specifies which of the RESTCONF client's endpoints the RESTCONF server should start with when trying Watsen Expires October 9, 2019 [Page 30] Internet-Draft RESTCONF Client and Server Models April 2019 to connect to the RESTCONF client."; } leaf max-attempts { type uint8 { range "1..max"; } default "3"; description "Specifies the number times the RESTCONF server tries to connect to a specific endpoint before moving on to the next endpoint in the list (round robin)."; } } } // restconf-client } // call-home } // restconf-server-grouping // Protocol accessible node, for servers that implement this // module. container restconf-server { uses restconf-server-grouping; description "Top-level container for RESTCONF server configuration."; } } 4. Security Considerations The YANG module defined in this document uses groupings defined in [I-D.kwatsen-netconf-tcp-client-server], [I-D.ietf-netconf-tls-client-server], and [I-D.kwatsen-netconf-http-client-server]. Please see the Security Considerations section in those documents for concerns related those groupings. The YANG modules defined in this document are designed to be accessed via YANG based management protocols, such as NETCONF [RFC6241] and RESTCONF [RFC8040]. Both of these protocols have mandatory-to- implement secure transport layers (e.g., SSH, TLS) with mutual authentication. The NETCONF access control model (NACM) [RFC8341] provides the means to restrict access for particular users to a pre-configured subset of all available protocol operations and content. Watsen Expires October 9, 2019 [Page 31] Internet-Draft RESTCONF Client and Server Models April 2019 There are a number of data nodes defined in the YANG modules that are writable/creatable/deletable (i.e., config true, which is the default). Some of these data nodes may be considered sensitive or vulnerable in some network environments. Write operations (e.g., edit-config) to these data nodes without proper protection can have a negative effect on network operations. These are the subtrees and data nodes and their sensitivity/vulnerability: None of the subtrees or data nodes in the modules defined in this document need to be protected from write operations. Some of the readable data nodes in the YANG modules may be considered sensitive or vulnerable in some network environments. It is thus important to control read access (e.g., via get, get-config, or notification) to these data nodes. These are the subtrees and data nodes and their sensitivity/vulnerability: None of the subtrees or data nodes in the modules defined in this document need to be protected from read operations. Some of the RPC operations in the YANG modules may be considered sensitive or vulnerable in some network environments. It is thus important to control access to these operations. These are the operations and their sensitivity/vulnerability: The modules defined in this document do not define any 'RPC' or 'action' statements. 5. IANA Considerations 5.1. The IETF XML Registry This document registers two URIs in the "ns" subregistry of the IETF XML Registry [RFC3688]. Following the format in [RFC3688], the following registrations are requested: URI: urn:ietf:params:xml:ns:yang:ietf-restconf-client Registrant Contact: The NETCONF WG of the IETF. XML: N/A, the requested URI is an XML namespace. URI: urn:ietf:params:xml:ns:yang:ietf-restconf-server Registrant Contact: The NETCONF WG of the IETF. XML: N/A, the requested URI is an XML namespace. Watsen Expires October 9, 2019 [Page 32] Internet-Draft RESTCONF Client and Server Models April 2019 5.2. The YANG Module Names Registry This document registers two YANG modules in the YANG Module Names registry [RFC6020]. Following the format in [RFC6020], the the following registrations are requested: name: ietf-restconf-client namespace: urn:ietf:params:xml:ns:yang:ietf-restconf-client prefix: ncc reference: RFC XXXX name: ietf-restconf-server namespace: urn:ietf:params:xml:ns:yang:ietf-restconf-server prefix: ncs reference: RFC XXXX 6. References 6.1. Normative References [I-D.ietf-netconf-keystore] Watsen, K., "YANG Data Model for a Centralized Keystore Mechanism", draft-ietf-netconf-keystore-08 (work in progress), March 2019. [I-D.ietf-netconf-tls-client-server] Watsen, K., Wu, G., and L. Xia, "YANG Groupings for TLS Clients and TLS Servers", draft-ietf-netconf-tls-client- server-10 (work in progress), March 2019. [I-D.kwatsen-netconf-http-client-server] Watsen, K., "YANG Groupings for HTTP Clients and HTTP Servers", draft-kwatsen-netconf-http-client-server-00 (work in progress), March 2019. [I-D.kwatsen-netconf-tcp-client-server] Watsen, K., "YANG Groupings for TCP Clients and TCP Servers", draft-kwatsen-netconf-tcp-client-server-00 (work in progress), March 2019. [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . Watsen Expires October 9, 2019 [Page 33] Internet-Draft RESTCONF Client and Server Models April 2019 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, DOI 10.17487/RFC6020, October 2010, . [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", RFC 6991, DOI 10.17487/RFC6991, July 2013, . [RFC7407] Bjorklund, M. and J. Schoenwaelder, "A YANG Data Model for SNMP Configuration", RFC 7407, DOI 10.17487/RFC7407, December 2014, . [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", RFC 7950, DOI 10.17487/RFC7950, August 2016, . [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, . [RFC8071] Watsen, K., "NETCONF Call Home and RESTCONF Call Home", RFC 8071, DOI 10.17487/RFC8071, February 2017, . [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, . 6.2. Informative References [I-D.ietf-netconf-trust-anchors] Watsen, K., "YANG Data Model for Global Trust Anchors", draft-ietf-netconf-trust-anchors-03 (work in progress), March 2019. [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, . [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., and A. Bierman, Ed., "Network Configuration Protocol (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, . [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, . Watsen Expires October 9, 2019 [Page 34] Internet-Draft RESTCONF Client and Server Models April 2019 [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration Access Control Model", STD 91, RFC 8341, DOI 10.17487/RFC8341, March 2018, . [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, . Watsen Expires October 9, 2019 [Page 35] Internet-Draft RESTCONF Client and Server Models April 2019 Appendix A. Expanded Tree Diagrams A.1. Expanded Tree Diagram for 'ietf-restconf-client' The following tree diagram [RFC8340] provides an overview of the data model for the "ietf-restconf-client" module. This tree diagram shows all the nodes defined in this module, including those defined by "grouping" statements used by this module. Please see Section 2.1 for a tree diagram that illustrates what the module looks like without all the "grouping" statements expanded. ========== NOTE: '\\' line wrapping per BCP XX (RFC XXXX) =========== module: ietf-restconf-client +--rw restconf-client +--rw initiate! {initiate}? | +--rw restconf-server* [name] | +--rw name string | +--rw endpoints | | +--rw endpoint* [name] | | +--rw name string | | +--rw (transport) | | +--:(https) {https-initiate}? | | +--rw https | | +--rw tcp-client-parameters | | | +--rw remote-address inet:host | | | +--rw remote-port? inet:port-number | | | +--rw local-address? inet:ip-address | | | +--rw local-port? inet:port-number | | | +--rw keepalives! | | | {tcp-client-keepalives}? | | | +--rw idle-time uint16 | | | +--rw max-probes? uint16 | | | +--rw probe-interval? uint16 | | +--rw tls-client-parameters | | | +--rw client-identity | | | | +--rw (auth-type) | | | | +--:(certificate) | | | | +--rw certificate | | | | +--rw (local-or-keystore) | | | | +--:(local) | | | | | {local-keys-sup\ \ported}? | | | | | +--rw local-definition | | | | | +--rw algorithm? | | | | | | asymmetric\ Watsen Expires October 9, 2019 [Page 36] Internet-Draft RESTCONF Client and Server Models April 2019 \-key-algorithm-ref | | | | | +--rw public-key? | | | | | | binary | | | | | +--rw private-key? | | | | | | 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? | | | | | | end-entity\ \-cert-cms | | | | | +---n certificate-\ \expiration | | | | | +-- expiration-\ \date | | | | | yang:da\ \te-and-time | | | | +--:(keystore) | | | | {keystore-suppo\ \rted}? | | | | +--rw keystore-refere\ \nce? | | | | ks:asymmetric\ \-key-certificate-ref | | | +--rw server-authentication | | | | +--rw pinned-ca-certs? | | | | | ta:pinned-certificates-ref | | | | | {ta:x509-certificates}? | | | | +--rw pinned-server-certs? Watsen Expires October 9, 2019 [Page 37] Internet-Draft RESTCONF Client and Server Models April 2019 | | | | ta:pinned-certificates-ref | | | | {ta:x509-certificates}? | | | +--rw hello-params | | | | {tls-client-hello-params-config\ \}? | | | | +--rw tls-versions | | | | | +--rw tls-version* identityref | | | | +--rw cipher-suites | | | | +--rw cipher-suite* identityref | | | +--rw keepalives! | | | {tls-client-keepalives}? | | | +--rw max-wait? uint16 | | | +--rw max-attempts? uint8 | | +--rw http-client-parameters | | +--rw protocol-version? enumeration | | +--rw client-identity | | | +--rw (auth-type)? | | | +--:(basic) | | | | +--rw basic {basic-auth}? | | | | +--rw user-id? string | | | | +--rw password? string | | | +--:(bearer) | | | | +--rw bearer {bearer-auth}? | | | | +--rw token? string | | | +--:(digest) | | | | +--rw digest {digest-auth}? | | | | +--rw username? string | | | | +--rw password? string | | | +--:(hoba) | | | | +--rw hoba {hoba-auth}? | | | +--:(mutual) | | | | +--rw mutual {mutual-auth}? | | | +--:(negotiate) | | | | +--rw negotiate | | | | {negotiate-auth}? | | | +--:(oauth) | | | | +--rw oauth {oauth-auth}? | | | +--:(scram-sha-1) | | | | +--rw scram-sha-1 | | | | {scram-sha-1-auth}? | | | +--:(scram-sha-256) | | | | +--rw scram-sha-256 | | | | {scram-sha-256-auth}? | | | +--:(vapid) | | | +--rw vapid {vapid-auth}? | | +--rw proxy-server! {proxy-connect}? | | +--rw tcp-client-parameters | | | +--rw remote-address inet:host Watsen Expires October 9, 2019 [Page 38] Internet-Draft RESTCONF Client and Server Models April 2019 | | | +--rw remote-port? | | | | inet:port-number | | | +--rw local-address? | | | | inet:ip-address | | | +--rw local-port? | | | | inet:port-number | | | +--rw keepalives! | | | {tcp-client-keepalives}? | | | +--rw idle-time uint16 | | | +--rw max-probes? uint16 | | | +--rw probe-interval? uint16 | | +--rw tls-client-parameters | | | +--rw client-identity | | | | +--rw (auth-type)? | | | | +--:(certificate) | | | | +--rw certificate | | | | +--rw (local-or-keyst\ \ore) | | | | +--:(local) | | | | | {local-ke\ \ys-supported}? | | | | | +--rw local-def\ \inition | | | | | +--rw algori\ \thm? | | | | | | asym\ \metric-key-algorithm-ref | | | | | +--rw public\ \-key? | | | | | | bina\ \ry | | | | | +--rw privat\ \e-key? | | | | | | 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 Watsen Expires October 9, 2019 [Page 39] Internet-Draft RESTCONF Client and Server Models April 2019 | | | | | | | \ \ asymmetric-key-algorithm-ref | | | | | | +---w \ \public-key? | | | | | | | \ \ binary | | | | | | +---w \ \private-key? | | | | | | \ \ binary | | | | | +--rw cert? | | | | | | end-\ \entity-cert-cms | | | | | +---n certif\ \icate-expiration | | | | | +-- expir\ \ation-date | | | | | y\ \ang:date-and-time | | | | +--:(keystore) | | | | {keystore\ \-supported}? | | | | +--rw keystore-\ \reference? | | | | ks:asym\ \metric-key-certificate-ref | | | +--rw server-authentication | | | | +--rw pinned-ca-certs? | | | | | ta:pinned-certificates\ \-ref | | | | | {ta:x509-certificates}? | | | | +--rw pinned-server-certs? | | | | ta:pinned-certificates\ \-ref | | | | {ta:x509-certificates}? | | | +--rw hello-params | | | | {tls-client-hello-params-\ \config}? | | | | +--rw tls-versions | | | | | +--rw tls-version* | | | | | identityref | | | | +--rw cipher-suites | | | | +--rw cipher-suite* | | | | identityref | | | +--rw keepalives! | | | {tls-client-keepalives}? | | | +--rw max-wait? uint16 | | | +--rw max-attempts? uint8 Watsen Expires October 9, 2019 [Page 40] Internet-Draft RESTCONF Client and Server Models April 2019 | | +--rw proxy-client-identity | | +--rw user-id? string | | +--rw password? string | +--rw connection-type | | +--rw (connection-type) | | +--:(persistent-connection) | | | +--rw persistent! | | +--:(periodic-connection) | | +--rw periodic! | | +--rw period? uint16 | | +--rw anchor-time? yang:date-and-time | | +--rw idle-timeout? uint16 | +--rw reconnect-strategy | +--rw start-with? enumeration | +--rw max-attempts? uint8 +--rw listen! {listen}? +--rw idle-timeout? uint16 +--rw endpoint* [name] +--rw name string +--rw (transport) +--:(https) {https-listen}? +--rw https +--rw tcp-server-parameters | +--rw local-address inet:ip-address | +--rw local-port? inet:port-number | +--rw keepalives! {tcp-server-keepalives}? | +--rw idle-time uint16 | +--rw max-probes? uint16 | +--rw probe-interval? uint16 +--rw tls-client-parameters | +--rw client-identity | | +--rw (auth-type) | | +--:(certificate) | | +--rw certificate | | +--rw (local-or-keystore) | | +--:(local) | | | {local-keys-supported\ \}? | | | +--rw local-definition | | | +--rw algorithm? | | | | asymmetric-key-a\ \lgorithm-ref | | | +--rw public-key? | | | | binary | | | +--rw private-key? | | | | union | | | +---x generate-hidden-key | | | | +---w input Watsen Expires October 9, 2019 [Page 41] Internet-Draft RESTCONF Client and Server Models April 2019 | | | | +---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? | | | | end-entity-cert-\ \cms | | | +---n certificate-expira\ \tion | | | +-- expiration-date | | | yang:date-and\ \-time | | +--:(keystore) | | {keystore-supported}? | | +--rw keystore-reference? | | ks:asymmetric-key-c\ \ertificate-ref | +--rw server-authentication | | +--rw pinned-ca-certs? | | | ta:pinned-certificates-ref | | | {ta:x509-certificates}? | | +--rw pinned-server-certs? | | ta:pinned-certificates-ref | | {ta:x509-certificates}? | +--rw hello-params | | {tls-client-hello-params-config}? | | +--rw tls-versions | | | +--rw tls-version* identityref | | +--rw cipher-suites | | +--rw cipher-suite* identityref | +--rw keepalives! {tls-client-keepalives}? | +--rw max-wait? uint16 | +--rw max-attempts? uint8 +--rw http-client-parameters +--rw protocol-version? enumeration +--rw client-identity | +--rw (auth-type)? | +--:(basic) | | +--rw basic {basic-auth}? | | +--rw user-id? string Watsen Expires October 9, 2019 [Page 42] Internet-Draft RESTCONF Client and Server Models April 2019 | | +--rw password? string | +--:(bearer) | | +--rw bearer {bearer-auth}? | | +--rw token? string | +--:(digest) | | +--rw digest {digest-auth}? | | +--rw username? string | | +--rw password? string | +--:(hoba) | | +--rw hoba {hoba-auth}? | +--:(mutual) | | +--rw mutual {mutual-auth}? | +--:(negotiate) | | +--rw negotiate {negotiate-auth}? | +--:(oauth) | | +--rw oauth {oauth-auth}? | +--:(scram-sha-1) | | +--rw scram-sha-1 {scram-sha-1-auth}? | +--:(scram-sha-256) | | +--rw scram-sha-256 | | {scram-sha-256-auth}? | +--:(vapid) | +--rw vapid {vapid-auth}? +--rw proxy-server! {proxy-connect}? +--rw tcp-client-parameters | +--rw remote-address inet:host | +--rw remote-port? inet:port-number | +--rw local-address? inet:ip-address | +--rw local-port? inet:port-number | +--rw keepalives! | {tcp-client-keepalives}? | +--rw idle-time uint16 | +--rw max-probes? uint16 | +--rw probe-interval? uint16 +--rw tls-client-parameters | +--rw client-identity | | +--rw (auth-type)? | | +--:(certificate) | | +--rw certificate | | +--rw (local-or-keystore) | | +--:(local) | | | {local-keys-sup\ \ported}? | | | +--rw local-definition | | | +--rw algorithm? | | | | asymmetric\ \-key-algorithm-ref | | | +--rw public-key? Watsen Expires October 9, 2019 [Page 43] Internet-Draft RESTCONF Client and Server Models April 2019 | | | | binary | | | +--rw private-key? | | | | 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? | | | | end-entity\ \-cert-cms | | | +---n certificate-\ \expiration | | | +-- expiration-\ \date | | | yang:da\ \te-and-time | | +--:(keystore) | | {keystore-suppo\ \rted}? | | +--rw keystore-refere\ \nce? | | ks:asymmetric\ \-key-certificate-ref | +--rw server-authentication | | +--rw pinned-ca-certs? | | | ta:pinned-certificates-ref | | | {ta:x509-certificates}? | | +--rw pinned-server-certs? | | ta:pinned-certificates-ref | | {ta:x509-certificates}? Watsen Expires October 9, 2019 [Page 44] Internet-Draft RESTCONF Client and Server Models April 2019 | +--rw hello-params | | {tls-client-hello-params-config\ \}? | | +--rw tls-versions | | | +--rw tls-version* identityref | | +--rw cipher-suites | | +--rw cipher-suite* identityref | +--rw keepalives! | {tls-client-keepalives}? | +--rw max-wait? uint16 | +--rw max-attempts? uint8 +--rw proxy-client-identity +--rw user-id? string +--rw password? string A.2. Expanded Tree Diagram for 'ietf-restconf-server' The following tree diagram [RFC8340] provides an overview of the data model for the "ietf-restconf-server" module. This tree diagram shows all the nodes defined in this module, including those defined by "grouping" statements used by this module. Please see Section 3.1 for a tree diagram that illustrates what the module looks like without all the "grouping" statements expanded. =========== NOTE: '\' line wrapping per BCP XX (RFC XXXX) =========== module: ietf-restconf-server +--rw restconf-server +--rw listen! {listen}? | +--rw endpoint* [name] | +--rw name string | +--rw (transport) | +--:(https) {https-listen}? | +--rw https | +--rw tcp-server-parameters | | +--rw local-address inet:ip-address | | +--rw local-port? inet:port-number | | +--rw keepalives! {tcp-server-keepalives}? | | +--rw idle-time uint16 | | +--rw max-probes? uint16 | | +--rw probe-interval? uint16 | +--rw tls-server-parameters | | +--rw server-identity | | | +--rw (local-or-keystore) | | | +--:(local) {local-keys-supported}? | | | | +--rw local-definition Watsen Expires October 9, 2019 [Page 45] Internet-Draft RESTCONF Client and Server Models April 2019 | | | | +--rw algorithm? | | | | | asymmetric-key-algorithm-\ ref | | | | +--rw public-key? | | | | | binary | | | | +--rw private-key? | | | | | 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? | | | | | end-entity-cert-cms | | | | +---n certificate-expiration | | | | +-- expiration-date | | | | yang:date-and-time | | | +--:(keystore) {keystore-supported}? | | | +--rw keystore-reference? | | | ks:asymmetric-key-certificat\ e-ref | | +--rw client-authentication | | | +--rw pinned-ca-certs? | | | | ta:pinned-certificates-ref | | | | {ta:x509-certificates}? | | | +--rw pinned-client-certs? | | | | ta:pinned-certificates-ref | | | | {ta:x509-certificates}? | | | +--rw cert-maps | | | +--rw cert-to-name* [id] | | | +--rw id uint32 | | | +--rw fingerprint | | | | x509c2n:tls-fingerprint | | | +--rw map-type identityref | | | +--rw name string | | +--rw hello-params | | | {tls-server-hello-params-config}? | | | +--rw tls-versions | | | | +--rw tls-version* identityref | | | +--rw cipher-suites | | | +--rw cipher-suite* identityref Watsen Expires October 9, 2019 [Page 46] Internet-Draft RESTCONF Client and Server Models April 2019 | | +--rw keepalives! {tls-server-keepalives}? | | +--rw max-wait? uint16 | | +--rw max-attempts? uint8 | +--rw http-server-parameters | +--rw server-name? string | +--rw protocol-versions | +--rw protocol-version* enumeration +--rw call-home! {call-home}? +--rw restconf-client* [name] +--rw name string +--rw endpoints | +--rw endpoint* [name] | +--rw name string | +--rw (transport) | +--:(https) {https-call-home}? | +--rw https | +--rw tcp-client-parameters | | +--rw remote-address inet:host | | +--rw remote-port? inet:port-number | | +--rw local-address? inet:ip-address | | +--rw local-port? inet:port-number | | +--rw keepalives! | | {tcp-client-keepalives}? | | +--rw idle-time uint16 | | +--rw max-probes? uint16 | | +--rw probe-interval? uint16 | +--rw tls-server-parameters | | +--rw server-identity | | | +--rw (local-or-keystore) | | | +--:(local) | | | | {local-keys-supported}? | | | | +--rw local-definition | | | | +--rw algorithm? | | | | | asymmetric-key-algo\ rithm-ref | | | | +--rw public-key? | | | | | binary | | | | +--rw private-key? | | | | | union | | | | +---x generate-hidden-key | | | | | +---w input | | | | | +---w algorithm | | | | | asymmetric-ke\ y-algorithm-ref | | | | +---x install-hidden-key | | | | | +---w input | | | | | +---w algorithm | | | | | | asymmetric-ke\ Watsen Expires October 9, 2019 [Page 47] Internet-Draft RESTCONF Client and Server Models April 2019 y-algorithm-ref | | | | | +---w public-key? | | | | | | binary | | | | | +---w private-key? | | | | | binary | | | | +--rw cert? | | | | | end-entity-cert-cms | | | | +---n certificate-expiration | | | | +-- expiration-date | | | | yang:date-and-ti\ me | | | +--:(keystore) | | | {keystore-supported}? | | | +--rw keystore-reference? | | | ks:asymmetric-key-cert\ ificate-ref | | +--rw client-authentication | | | +--rw pinned-ca-certs? | | | | ta:pinned-certificates-ref | | | | {ta:x509-certificates}? | | | +--rw pinned-client-certs? | | | | ta:pinned-certificates-ref | | | | {ta:x509-certificates}? | | | +--rw cert-maps | | | +--rw cert-to-name* [id] | | | +--rw id uint32 | | | +--rw fingerprint | | | | x509c2n:tls-fingerprint | | | +--rw map-type | | | | identityref | | | +--rw name string | | +--rw hello-params | | | {tls-server-hello-params-config\ }? | | | +--rw tls-versions | | | | +--rw tls-version* identityref | | | +--rw cipher-suites | | | +--rw cipher-suite* identityref | | +--rw keepalives! | | {tls-server-keepalives}? | | +--rw max-wait? uint16 | | +--rw max-attempts? uint8 | +--rw http-server-parameters | +--rw server-name? string | +--rw protocol-versions | +--rw protocol-version* enumeration +--rw connection-type | +--rw (connection-type) Watsen Expires October 9, 2019 [Page 48] Internet-Draft RESTCONF Client and Server Models April 2019 | +--:(persistent-connection) | | +--rw persistent! | +--:(periodic-connection) | +--rw periodic! | +--rw period? uint16 | +--rw anchor-time? yang:date-and-time | +--rw idle-timeout? uint16 +--rw reconnect-strategy +--rw start-with? enumeration +--rw max-attempts? uint8 Appendix B. Change Log B.1. 00 to 01 o Renamed "keychain" to "keystore". B.2. 01 to 02 o Filled in previously missing 'ietf-restconf-client' module. o Updated the ietf-restconf-server module to accommodate new grouping 'ietf-tls-server-grouping'. B.3. 02 to 03 o Refined use of tls-client-grouping to add a must statement indicating that the TLS client must specify a client-certificate. o Changed restconf-client??? to be a grouping (not a container). B.4. 03 to 04 o Added RFC 8174 to Requirements Language Section. o Replaced refine statement in ietf-restconf-client to add a mandatory true. o Added refine statement in ietf-restconf-server to add a must statement. o Now there are containers and groupings, for both the client and server models. o Now tree diagrams reference ietf-netmod-yang-tree-diagrams o Updated examples to inline key and certificates (no longer a leafref to keystore) Watsen Expires October 9, 2019 [Page 49] Internet-Draft RESTCONF Client and Server Models April 2019 B.5. 04 to 05 o Now tree diagrams reference ietf-netmod-yang-tree-diagrams o Updated examples to inline key and certificates (no longer a leafref to keystore) B.6. 05 to 06 o Fixed change log missing section issue. o Updated examples to match latest updates to the crypto-types, trust-anchors, and keystore drafts. o Reduced line length of the YANG modules to fit within 69 columns. B.7. 06 to 07 o removed "idle-timeout" from "persistent" connection config. o Added "random-selection" for reconnection-strategy's "starts-with" enum. o Replaced "connection-type" choice default (persistent) with "mandatory true". o Reduced the periodic-connection's "idle-timeout" from 5 to 2 minutes. o Replaced reconnect-timeout with period/anchor-time combo. B.8. 07 to 08 o Modified examples to be compatible with new crypto-types algs B.9. 08 to 09 o Corrected use of "mandatory true" for "address" leafs. o Updated examples to reflect update to groupings defined in the keystore draft. o Updated to use groupings defined in new TCP and HTTP drafts. o Updated copyright date, boilerplate template, affiliation, and folding algorithm. Watsen Expires October 9, 2019 [Page 50] Internet-Draft RESTCONF Client and Server Models April 2019 B.10. 09 to 10 o Reformatted YANG modules. B.11. 10 to 11 o Adjusted for the top-level "demux container" added to groupings imported from other modules. o Added "must" expressions to ensure that keepalives are not configured for "periodic" connections. o Updated the boilerplate text in module-level "description" statement to match copyeditor convention. o Moved "expanded" tree diagrams to the Appendix. Acknowledgements The authors would like to thank for following for lively discussions on list and in the halls (ordered by last name): Andy Bierman, Martin Bjorklund, Benoit Claise, Ramkumar Dhanapal, Mehmet Ersue, Balazs Kovacs, David Lamparter, Alan Luchuk, Ladislav Lhotka, Radek Krejci, Tom Petch, Juergen Schoenwaelder, Phil Shafer, Sean Turner, and Bert Wijnen. Author's Address Kent Watsen Watsen Networks EMail: kent+ietf@watsen.net Watsen Expires October 9, 2019 [Page 51]