idnits 2.17.1 draft-ietf-netmod-factory-default-05.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 (October 30, 2019) is 1637 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 302, but not defined == Missing Reference: 'RFC6020' is mentioned on line 312, but not defined == Missing Reference: 'RFC6241' is mentioned on line 325, but not defined == Missing Reference: 'RFC8040' is mentioned on line 325, but not defined == Missing Reference: 'RFC6242' is mentioned on line 327, but not defined == Missing Reference: 'RFC8446' is mentioned on line 329, but not defined == Unused Reference: 'RFC7950' is defined on line 364, 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: May 2, 2020 Ericsson Hungary 6 Y. Niu 7 Huawei 8 October 30, 2019 10 Factory Default Setting 11 draft-ietf-netmod-factory-default-05 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 May 2, 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. Difference between datastore and datastore . . . . . . . . . . . . . . . . . 9 76 Appendix B. Changes between revisions . . . . . . . . . . . . . 9 77 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 11 79 1. Introduction 81 This document defines a method to reset a server to its factory- 82 default content. The reset operation may be used e.g. during initial 83 zero-touch configuration [RFC8572] or when the existing configuration 84 has major errors, so re-starting the configuration process from 85 scratch is the best option. When resetting a datastore all previous 86 configuration settings will be lost and replaced by the factory- 87 default content. 89 A new factory-reset RPC is defined. Several methods of documenting 90 the factory-default content are specified. 92 Optionally a new "factory-default" read-only datastore is defined, 93 that contains the data that will be copied over to all read-write 94 configuration datastores at reset. This datastore can also be used 95 in or operations. 97 NETCONF defines the operation that allows resetting the 98 datastore and the operation that copies 99 the content of the datastore into the 100 datastore. However it is not possible to reset the running 101 datastore, to reset the candidate datastore without changing the 102 running datastore or to reset any dynamic datastore. 104 A RESTCONF server MAY implement the above NETCONF operations, but 105 that would still not allow it to reset the running configuration. 107 1.1. Terminology 109 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 110 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 111 "OPTIONAL" in this document are to be interpreted as described in BCP 112 14 [RFC2119] [RFC8174] when, and only when, they appear in all 113 capitals, as shown here. 115 The following terms are defined in [RFC8342] and are not redefined 116 here: 118 o server 120 o startup configuration datastore 122 o candiate configuration datastore 124 o running configuration datastore 126 o intended configuration datastore 128 o operational state datastore 130 The following terms are defined in this document as follows: 132 o factory-default datastore: A read-only datastore holding a 133 preconfigured minimal initial configuration that can be used to 134 initialize the configuration of a server. The content of the 135 datastore is usually static, but MAY depend on external factors 136 like available HW. 138 2. Factory-Reset RPC 140 A new "factory-reset" RPC is introduced. Upon receiveing the RPC the 141 server resets the content of all read-write configuration datastores 142 (e.g., and ) to their factory-default content. 143 Read-only datastores receive their content from other datastores 144 (e.g. gets its content from ). 146 Factory-default content SHALL be specified by one of the following 147 means in descending order of precedence 149 1. For the , and datastores as the 150 content of the datastore, if it exists; 152 2. by vendors using YANG Instance Data 153 [I-D.ietf-netmod-yang-instance-file-format] file format in 154 vendor's website or other places where off-line document is kept; 156 3. In some implementation specific manner; 158 4. For dynamic datastores unless otherwise specified the factory- 159 default content is empty. 161 For the server supporting zero touch bootstrapping mechanisms, the 162 factory default configuration causes the bootstrapping process to 163 execute,e.g.,the server might reset configuration to device's factory 164 default configuration,for the version of operating system software it 165 is running. In addition,the "factory-reset" RPC might also be used 166 to trigger some other restoring and resetting tasks such as files 167 cleanup, restarting the node or some of the software processes, 168 setting some security data/passwords to the default value, removing 169 logs, or removing any temporary data (from datastore or elsewhere), 170 etc. When and why these tasks are triggered is not the scope of this 171 document. 173 3. Factory-Default Datastore 175 Following guidelines for defining Datastores in the appendix A of 176 [RFC8342], this document introduces a new datastore resource named 177 'Factory-Default' that represents a preconfigured minimal initial 178 configuration that can be used to initialize the configuration of a 179 server. 181 o Name: "factory-default" 183 o YANG modules: all 185 o YANG nodes: all "config true" data nodes 186 o Management operations: The content of the datastore is set by the 187 server in an implementation dependent manner. The content can not 188 be changed by management operations via NETCONF, RESTCONF,the CLI 189 etc. unless specialized, dedicated operations are provided. The 190 contents of the datastore can be read using NETCONF, RESTCONF 191 and operations. The operation can be used to copy the factory default content to a set of 193 read-write configuration datastores and then the content of these 194 datastores is propagated automatically to any other read only 195 datastores, e.g., and . 197 o Origin: This document does not define a new origin identity as it 198 does not interact with datastore. 200 o Protocols: RESTCONF, NETCONF and other management protocol. 202 o Defining YANG module: "ietf-factory-default". 204 The datastore content is usually defined by the device vendor. It is 205 usually static, but MAY change e.g., depending on external factors 206 like HW available or during device upgrade. 208 On devices that support non-volatile storage, the contents of 209 MUST persist across restarts. 211 4. YANG Module 213 file "ietf-factory-default.yang" 214 module ietf-factory-default { 215 yang-version 1.1; 216 namespace urn:ietf:params:xml:ns:yang:ietf-factory-default; 217 prefix fd; 219 import ietf-netconf { prefix nc ; } 220 import ietf-datastores { prefix ds; } 222 organization 223 "IETF NETMOD (Network Modeling) Working Group"; 224 contact 225 "WG Web: 226 WG List: 228 Editor: Balazs Lengyel 229 230 Editor: Qin Wu 231 232 Editor: Ye Niu 233 "; 235 description 236 "This module defines the 237 - factory-reset RPC 238 - factory-default datastore 239 - an extension to the NETCONF operation to 240 allow it to operate on the factory-default datastore. 242 It provides functionality to reset a server to its 243 factory-default content. 245 The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL 246 NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 247 'MAY', and 'OPTIONAL' in this document are to be interpreted as 248 described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, 249 they appear in all capitals, as shown here. 251 Copyright (c) 2019 IETF Trust and the persons identified as 252 authors of the code. All rights reserved. 254 Redistribution and use in source and binary forms, with or 255 without modification, is permitted pursuant to, and subject 256 to the license terms contained in, the Simplified BSD License 257 set forth in Section 4.c of the IETF Trust's Legal Provisions 258 Relating to IETF Documents 259 (http://trustee.ietf.org/license-info). 261 This version of this YANG module is part of RFC XXXX; 262 see the RFC itself for full legal notices."; 264 revision 2019-05-03 { 265 description 266 "Initial revision."; 267 reference "RFC XXXX: Factory default Setting"; 268 } 270 feature factory-default-as-datastore { 271 description "Indicates that the factory default configuration is 272 also available as a separate datastore"; 273 } 275 rpc factory-reset { 276 description "The server resets the content of all read-write 277 configuration datastores (e.g., and ) to 278 their factory default content."; 279 } 281 identity factory-default { 282 base ds:datastore; 283 if-feature factory-default-as-datastore; 284 description "The read-only datastore contains the configuration that 285 will be copied into e.g., the running datastore by the 286 factory-reset operation if the target is the running 287 datastore."; 288 } 289 augment /nc:get-config/nc:input/nc:source/nc:config-source { 290 if-feature factory-default-as-datastore; 291 description "Allows the get-config operation to use the 292 factory-default datastore as a source"; 293 leaf factory-default { 294 type empty ; 295 description 296 "The factory-default datastore is the source."; } 297 } 298 300 5. IANA Considerations 302 This document registers one URI in the IETF XML Registry [RFC3688]. 303 The following registration has been made: 305 URI: urn:ietf:params:xml:ns:yang:ietf-factory-default 307 Registrant Contact: The IESG. 309 XML: N/A, the requested URI is an XML namespace. 311 This document registers one YANG module in the YANG Module Names 312 Registry [RFC6020]. The following registration has been made: 314 name: ietf-factory-default 316 namespace: urn:ietf:params:xml:ns:yang:ietf-factory-default 318 prefix: fd 320 RFC: xxxx 322 6. Security Considerations 324 The YANG module defined in this document extends the base operations 325 for NETCONF [RFC6241] and RESTCONF [RFC8040]. The lowest NETCONF 326 layer is the secure transport layer, and the mandatory-to-implement 327 secure transport is Secure Shell (SSH) [RFC6242]. The lowest 328 RESTCONF layer is HTTPS, and the mandatory-to-implement secure 329 transport is TLS [RFC8446]. 331 The RPC operation may be considered sensitive in some 332 network enviroments,e.g., remote access to reset the device or 333 overwrite security sensitive information in one of the other 334 datastores, e.g. running, therefore it is important to restrict 335 access to this RPC using the standard access control methods. 336 [RFC8341] 338 The NETCONF Access Control Model (NACM) [RFC8341] provides the means 339 to restrict access for particular users to a pre-configured subset of 340 all available protocol operations and content. 342 7. Acknowledgements 344 Thanks to Juergen Schoenwaelder, Ladislav Lhotka, Alex Campbell,Joe 345 Clark,Robert Wilton, Kent Watsen, Joel Jaeggli, Lou Berger, Andy 346 Berman,Susan Hares to review this draft and provide important input 347 to this document. 349 8. Contributors 351 Rohit R Ranade 352 Huawei 353 Email: rohitrranade@huawei.com 355 9. References 357 9.1. Normative References 359 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 360 Requirement Levels", BCP 14, RFC 2119, 361 DOI 10.17487/RFC2119, March 1997, 362 . 364 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 365 RFC 7950, DOI 10.17487/RFC7950, August 2016, 366 . 368 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 369 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 370 May 2017, . 372 [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration 373 Access Control Model", STD 91, RFC 8341, 374 DOI 10.17487/RFC8341, March 2018, 375 . 377 [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., 378 and R. Wilton, "Network Management Datastore Architecture 379 (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, 380 . 382 9.2. Informative References 384 [I-D.ietf-netmod-yang-instance-file-format] 385 Lengyel, B. and B. Claise, "YANG Instance Data File 386 Format", draft-ietf-netmod-yang-instance-file-format-04 387 (work in progress), August 2019. 389 [RFC8572] Watsen, K., Farrer, I., and M. Abrahamsson, "Secure Zero 390 Touch Provisioning (SZTP)", RFC 8572, 391 DOI 10.17487/RFC8572, April 2019, 392 . 394 Appendix A. Difference between datastore and datastore 397 When the device first boots up, the content of the and 398 will be identical. The content of can be 399 subsequently changed by using as a target in a operation. The is a read-only datastore 401 and it is usually static as described in earlier sections. 403 Appendix B. Changes between revisions 405 v03 - 04 407 o Additional text to clarify factory-reset RPC usage. 409 v02 - 03 411 o Update security consideration section. 413 v01 - v02 415 o Address security issue in the security consideration section. 417 o Remove an extension to the NETCONF operation which 418 allows it to operate on the factory-default datastore. 420 o Add an extension to the NETCONF operation which 421 allows it to operate on the factory-default datastore. 423 v00 - v01 424 o Change YANG server into server defined in NMDA architecture based 425 on discussion. 427 o Allow reset the content of all read-write configuraton datastores 428 to its factory-default content except . 430 o Add clarification text on factory-reset protocol operation 431 behavior. 433 v03 - v00 435 o Change draft name from draft-wu to draft-ietf-netmod-factory- 436 default-00 without content changes. 438 v02 - v03 440 o Change reset-datastore RPC into factory-reset RPC to allow reset 441 the whole device with factory default content. 443 o Remove target datastore parameter from factory-reset RPC. 445 o Other editorial changes. 447 v01 - v02 449 o Add copy-config based on Rob's comment. 451 o Reference Update. 453 v03 - v00 - v01 455 o Changed name from draft-wu-netconf-restconf-factory-restore to 456 draft-wu-netmod-factory-default 458 o Removed copy-config ; reset-datastore is enough 460 v02 - v03 462 o Restructured 464 o Made new datastore optional 466 o Removed Netconf capability 468 o Listed Open issues 470 v01 - v02 471 o - 473 v00 - v01 475 o - 477 Authors' Addresses 479 Qin Wu 480 Huawei 481 101 Software Avenue, Yuhua District 482 Nanjing, Jiangsu 210012 483 China 485 Email: bill.wu@huawei.com 487 Balazs Lengyel 488 Ericsson Hungary 489 Magyar Tudosok korutja 11 490 1117 Budapest 491 Hungary 493 Phone: +36-70-330-7909 494 Email: balazs.lengyel@ericsson.com 496 Ye Niu 497 Huawei 499 Email: niuye@huawei.com