idnits 2.17.1 draft-ietf-netmod-factory-default-03.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (September 10, 2019) is 1690 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Missing Reference: 'RFC3688' is mentioned on line 296, but not defined == Missing Reference: 'RFC6020' is mentioned on line 306, but not defined == Missing Reference: 'RFC6241' is mentioned on line 319, but not defined == Missing Reference: 'RFC8040' is mentioned on line 319, but not defined == Missing Reference: 'RFC6242' is mentioned on line 321, but not defined == Missing Reference: 'RFC8446' is mentioned on line 323, but not defined == Unused Reference: 'RFC7950' is defined on line 357, but no explicit reference was found in the text == Outdated reference: A later version (-21) exists of draft-ietf-netmod-yang-instance-file-format-04 Summary: 0 errors (**), 0 flaws (~~), 9 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 NETMOD Working Group Q. Wu 3 Internet-Draft Huawei 4 Intended status: Standards Track B. Lengyel 5 Expires: March 13, 2020 Ericsson Hungary 6 Y. Niu 7 Huawei 8 September 10, 2019 10 Factory Default Setting 11 draft-ietf-netmod-factory-default-03 13 Abstract 15 This document defines a method to reset a server to its factory- 16 default content. The reset operation may be used e.g. during initial 17 zero-touch configuration or when the existing configuration has major 18 errors, so re-starting the configuration process from scratch is the 19 best option. 21 A new factory-reset RPC is defined. Several methods of documenting 22 the factory-default content are specified. 24 Optionally a new "factory-default" read-only datastore is defined, 25 that contains the data that will be copied over to the running 26 datastore at reset. 28 Status of This Memo 30 This Internet-Draft is submitted in full conformance with the 31 provisions of BCP 78 and BCP 79. 33 Internet-Drafts are working documents of the Internet Engineering 34 Task Force (IETF). Note that other groups may also distribute 35 working documents as Internet-Drafts. The list of current Internet- 36 Drafts is at https://datatracker.ietf.org/drafts/current/. 38 Internet-Drafts are draft documents valid for a maximum of six months 39 and may be updated, replaced, or obsoleted by other documents at any 40 time. It is inappropriate to use Internet-Drafts as reference 41 material or to cite them other than as "work in progress." 43 This Internet-Draft will expire on March 13, 2020. 45 Copyright Notice 47 Copyright (c) 2019 IETF Trust and the persons identified as the 48 document authors. All rights reserved. 50 This document is subject to BCP 78 and the IETF Trust's Legal 51 Provisions Relating to IETF Documents 52 (https://trustee.ietf.org/license-info) in effect on the date of 53 publication of this document. Please review these documents 54 carefully, as they describe your rights and restrictions with respect 55 to this document. Code Components extracted from this document must 56 include Simplified BSD License text as described in Section 4.e of 57 the Trust Legal Provisions and are provided without warranty as 58 described in the Simplified BSD License. 60 Table of Contents 62 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 63 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 64 2. Factory-Reset RPC . . . . . . . . . . . . . . . . . . . . . . 4 65 3. Factory-Default Datastore . . . . . . . . . . . . . . . . . . 4 66 4. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 5 67 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7 68 6. Security Considerations . . . . . . . . . . . . . . . . . . . 7 69 7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 8 70 8. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 8 71 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 8 72 9.1. Normative References . . . . . . . . . . . . . . . . . . 8 73 9.2. Informative References . . . . . . . . . . . . . . . . . 9 74 Appendix A. Open Issues . . . . . . . . . . . . . . . . . . . . 9 75 Appendix B. Difference between datastore and datastore . . . . . . . . . . . . . . . . . 9 77 Appendix C. Changes between revisions . . . . . . . . . . . . . 9 78 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 11 80 1. Introduction 82 This document defines a method to reset a server to its factory- 83 default content. The reset operation may be used e.g. during initial 84 zero-touch configuration [RFC8572] or when the existing configuration 85 has major errors, so re-starting the configuration process from 86 scratch is the best option. When resetting a datastore all previous 87 configuration settings will be lost and replaced by the factory- 88 default content. 90 A new factory-reset RPC is defined. Several methods of documenting 91 the factory-default content are specified. 93 Optionally a new "factory-default" read-only datastore is defined, 94 that contains the data that will be copied over to all read-write 95 configuration datastores at reset. This datastore can also be used 96 in or operations. 98 NETCONF defines the operation that allows resetting the 99 datastore and the operation that copies 100 the content of the datastore into the 101 datastore. However it is not possible to reset the running 102 datastore, to reset the candidate datastore without changing the 103 running datastore or to reset any dynamic datastore. 105 A RESTCONF server MAY implement the above NETCONF operations, but 106 that would still not allow it to reset the running configuration. 108 1.1. Terminology 110 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 111 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 112 "OPTIONAL" in this document are to be interpreted as described in BCP 113 14 [RFC2119] [RFC8174] when, and only when, they appear in all 114 capitals, as shown here. 116 The following terms are defined in [RFC8342] and are not redefined 117 here: 119 o server 121 o startup configuration datastore 123 o candiate configuration datastore 125 o running configuration datastore 127 o intended configuration datastore 129 o operational state datastore 131 The following terms are defined in this document as follows: 133 o factory-default datastore: A read-only datastore holding a 134 preconfigured minimal initial configuration that can be used to 135 initialize the configuration of a server. The content of the 136 datastore is usually static, but MAY depend on external factors 137 like available HW. 139 2. Factory-Reset RPC 141 A new "factory-reset" RPC is introduced. Upon receiveing the RPC the 142 server resets the content of all read-write configuration datastores 143 (e.g., and ) to its factory-default content. Read- 144 only datastores receive their content from other datastores (e.g. 145 gets its content from ). 147 Factory-default content SHALL be specified by one of the following 148 means in order of precedence 150 1. For the , and datastores as the 151 content of the datastore, if it exists 153 2. YANG Instance Data [I-D.ietf-netmod-yang-instance-file-format] 155 3. In some implementation specific manner 157 4. For dynamic datastores unless otherwise specified the factory- 158 default content is empty. 160 In addition,the "factory-reset" RPC might also be used to trigger 161 files cleanup, restarting the node or some of the SW processes, or 162 setting some security data/passwords to the default value, removing 163 logs, removing any temporary data (from datastore or elsewhere) etc. 164 How the "factory-reset" RPC is triggered is out of scope of this 165 document. 167 3. Factory-Default Datastore 169 Following guidelines for defining Datastores in the appendix A of 170 [RFC8342], this document introduces a new datastore resource named 171 'Factory-Default' that represents a preconfigured minimal initial 172 configuration that can be used to initialize the configuration of a 173 server. 175 o Name: "factory-default" 177 o YANG modules: all 179 o YANG nodes: all "config true" data nodes 181 o Management operations: The content of the datastore is set by the 182 server in an implementation dependent manner. The content can not 183 be changed by management operations via NETCONF, RESTCONF,the CLI 184 etc. unless specialized, dedicated operations are provided. The 185 contents of the datastore can be read using NETCONF, RESTCONF 186 and operations. The operation can be used to copy the factory default content to a set of 188 read-write configuration datastores and then the content of these 189 datastores is propagated automatically to any other read only 190 datastores, e.g., and . 192 o Origin: This document does not define a new origin identity as it 193 does not interact with datastore. 195 o Protocols: RESTCONF, NETCONF and other management protocol. 197 o Defining YANG module: "ietf-factory-default". 199 The datastore content is usually defined by the device vendor. It is 200 usually static, but MAY change e.g., depending on external factors 201 like HW available or during device upgrade. 203 On devices that support non-volatile storage, the contents of 204 MUST persist across restarts. 206 4. YANG Module 208 file "ietf-factory-default.yang" 209 module ietf-factory-default { 210 yang-version 1.1; 211 namespace urn:ietf:params:xml:ns:yang:ietf-factory-default; 212 prefix fd; 214 import ietf-netconf { prefix nc ; } 215 import ietf-datastores { prefix ds; } 217 organization 218 "IETF NETMOD (Network Modeling) Working Group"; 219 contact 220 "WG Web: 221 WG List: 223 Editor: Balazs Lengyel 224 225 Editor: Qin Wu 226 227 Editor: Ye Niu 228 "; 229 description 230 "This module defines the 231 - factory-reset RPC 232 - factory-default datastore 233 - an extension to the NETCONF operation to 234 allow it to operate on the factory-default datastore. 236 It provides functionality to reset a server to its 237 factory-default content. 239 The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL 240 NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 241 'MAY', and 'OPTIONAL' in this document are to be interpreted as 242 described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, 243 they appear in all capitals, as shown here. 245 Copyright (c) 2019 IETF Trust and the persons identified as 246 authors of the code. All rights reserved. 248 Redistribution and use in source and binary forms, with or 249 without modification, is permitted pursuant to, and subject 250 to the license terms contained in, the Simplified BSD License 251 set forth in Section 4.c of the IETF Trust's Legal Provisions 252 Relating to IETF Documents 253 (http://trustee.ietf.org/license-info). 255 This version of this YANG module is part of RFC XXXX; 256 see the RFC itself for full legal notices."; 258 revision 2019-05-03 { 259 description 260 "Initial revision."; 261 reference "RFC XXXX: Factory default Setting"; 262 } 264 feature factory-default-as-datastore { 265 description "Indicates that the factory default configuration is 266 also available as a separate datastore"; 267 } 269 rpc factory-reset { 270 description "The server resets the content of all read-write 271 configuration datastores (e.g., and ) to 272 its factory default content."; 273 } 275 identity factory-default { 276 base ds:datastore; 277 if-feature factory-default-as-datastore; 278 description "The read-only datastore contains the configuration that 279 will be copied into e.g., the running datastore by the 280 factory-reset operation if the target is the running 281 datastore."; 282 } 283 augment /nc:get-config/nc:input/nc:source/nc:config-source { 284 if-feature factory-default-as-datastore; 285 description "Allows the get-config operation to use the 286 factory-default datastore as a source"; 287 leaf factory-default { 288 type empty ; 289 description 290 "The factory-default datastore is the source."; } 291 } 292 294 5. IANA Considerations 296 This document registers one URI in the IETF XML Registry [RFC3688]. 297 The following registration has been made: 299 URI: urn:ietf:params:xml:ns:yang:ietf-factory-default 301 Registrant Contact: The IESG. 303 XML: N/A, the requested URI is an XML namespace. 305 This document registers one YANG module in the YANG Module Names 306 Registry [RFC6020]. The following registration has been made: 308 name: ietf-factory-default 310 namespace: urn:ietf:params:xml:ns:yang:ietf-factory-default 312 prefix: fd 314 RFC: xxxx 316 6. Security Considerations 318 The YANG module defined in this document extends the base operations 319 for NETCONF [RFC6241] and RESTCONF [RFC8040]. The lowest NETCONF 320 layer is the secure transport layer, and the mandatory-to-implement 321 secure transport is Secure Shell (SSH) [RFC6242]. The lowest 322 RESTCONF layer is HTTPS, and the mandatory-to-implement secure 323 transport is TLS [RFC8446]. 325 The RPC operation may be considered sensitive in some 326 network enviroments,e.g., remote access to reset the device or 327 overwrite important and security sensitive information in one of the 328 other datastores e.g. running, therefore it is important to restrict 329 access to this RPC using the standard access control methods. 330 [RFC8341] 331 The NETCONF Access Control Model (NACM) [RFC8341] provides the means 332 to restrict access for particular users to a pre-configured subset of 333 all available protocol operations and content. 335 7. Acknowledgements 337 Thanks to Juergen Schoenwaelder, Ladislav Lhotka, Alex Campbell,Joe 338 Clark,Robert Wilton, Kent Watsen, Joel Jaeggli, Lou Berger, Andy 339 Berman,Susan Hares to review this draft and provide important input 340 to this document. 342 8. Contributors 344 Rohit R Ranade 345 Huawei 346 Email: rohitrranade@huawei.com 348 9. References 350 9.1. Normative References 352 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 353 Requirement Levels", BCP 14, RFC 2119, 354 DOI 10.17487/RFC2119, March 1997, 355 . 357 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 358 RFC 7950, DOI 10.17487/RFC7950, August 2016, 359 . 361 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 362 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 363 May 2017, . 365 [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration 366 Access Control Model", STD 91, RFC 8341, 367 DOI 10.17487/RFC8341, March 2018, 368 . 370 [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., 371 and R. Wilton, "Network Management Datastore Architecture 372 (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, 373 . 375 9.2. Informative References 377 [I-D.ietf-netmod-yang-instance-file-format] 378 Lengyel, B. and B. Claise, "YANG Instance Data File 379 Format", draft-ietf-netmod-yang-instance-file-format-04 380 (work in progress), August 2019. 382 [RFC8572] Watsen, K., Farrer, I., and M. Abrahamsson, "Secure Zero 383 Touch Provisioning (SZTP)", RFC 8572, 384 DOI 10.17487/RFC8572, April 2019, 385 . 387 Appendix A. Open Issues 389 o Do we need an extra parameter that may order a restart of the 390 YANG-server or the whole system? 392 o Do we allow different datastore have different factory default 393 content? No 395 Appendix B. Difference between datastore and datastore 398 When the device first boots up, the content of the and 399 will be identical. The content of can be 400 subsequently changed by using as a target in a operation. The is a read-only datastore 402 and it is usually static as described in earlier sections. 404 Appendix C. Changes between revisions 406 v02 - 03 408 o Update security consideration section. 410 v01 - v02 412 o Address security issue in the security consideration section. 414 o Remove an extension to the NETCONF operation which 415 allows it to operate on the factory-default datastore. 417 o Add an extension to the NETCONF operation which 418 allows it to operate on the factory-default datastore. 420 v00 - v01 421 o Change YANG server into server defined in NMDA architecture based 422 on discussion. 424 o Allow reset the content of all read-write configuraton datastores 425 to its factory-default content except . 427 o Add clarification text on factory-reset protocol operation 428 behavior. 430 v03 - v00 432 o Change draft name from draft-wu to draft-ietf-netmod-factory- 433 default-00 without content changes. 435 v02 - v03 437 o Change reset-datastore RPC into factory-reset RPC to allow reset 438 the whole device with factory default content. 440 o Remove target datastore parameter from factory-reset RPC. 442 o Other editorial changes. 444 v01 - v02 446 o Add copy-config based on Rob's comment. 448 o Reference Update. 450 v03 - v00 - v01 452 o Changed name from draft-wu-netconf-restconf-factory-restore to 453 draft-wu-netmod-factory-default 455 o Removed copy-config ; reset-datastore is enough 457 v02 - v03 459 o Restructured 461 o Made new datastore optional 463 o Removed Netconf capability 465 o Listed Open issues 467 v01 - v02 468 o - 470 v00 - v01 472 o - 474 Authors' Addresses 476 Qin Wu 477 Huawei 478 101 Software Avenue, Yuhua District 479 Nanjing, Jiangsu 210012 480 China 482 Email: bill.wu@huawei.com 484 Balazs Lengyel 485 Ericsson Hungary 486 Magyar Tudosok korutja 11 487 1117 Budapest 488 Hungary 490 Phone: +36-70-330-7909 491 Email: balazs.lengyel@ericsson.com 493 Ye Niu 494 Huawei 496 Email: niuye@huawei.com