draft-ietf-netmod-factory-default-02.txt   draft-ietf-netmod-factory-default-03.txt 
NETMOD Working Group Q. Wu NETMOD Working Group Q. Wu
Internet-Draft Huawei Internet-Draft Huawei
Intended status: Standards Track B. Lengyel Intended status: Standards Track B. Lengyel
Expires: December 31, 2019 Ericsson Hungary Expires: March 13, 2020 Ericsson Hungary
Y. Niu Y. Niu
Huawei Huawei
June 29, 2019 September 10, 2019
Factory Default Setting Factory Default Setting
draft-ietf-netmod-factory-default-02 draft-ietf-netmod-factory-default-03
Abstract Abstract
This document defines a method to reset a server to its factory- This document defines a method to reset a server to its factory-
default content. The reset operation may be used e.g. during initial default content. The reset operation may be used e.g. during initial
zero-touch configuration or when the existing configuration has major zero-touch configuration or when the existing configuration has major
errors, so re-starting the configuration process from scratch is the errors, so re-starting the configuration process from scratch is the
best option. best option.
A new factory-reset RPC is defined. Several methods of documenting A new factory-reset RPC is defined. Several methods of documenting
skipping to change at page 1, line 44 skipping to change at page 1, line 44
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on December 31, 2019. This Internet-Draft will expire on March 13, 2020.
Copyright Notice Copyright Notice
Copyright (c) 2019 IETF Trust and the persons identified as the Copyright (c) 2019 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
skipping to change at page 2, line 29 skipping to change at page 2, line 29
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
2. Factory-Reset RPC . . . . . . . . . . . . . . . . . . . . . . 4 2. Factory-Reset RPC . . . . . . . . . . . . . . . . . . . . . . 4
3. Factory-Default Datastore . . . . . . . . . . . . . . . . . . 4 3. Factory-Default Datastore . . . . . . . . . . . . . . . . . . 4
4. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 5 4. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 5
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7
6. Security Considerations . . . . . . . . . . . . . . . . . . . 7 6. Security Considerations . . . . . . . . . . . . . . . . . . . 7
7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 7 7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 8
8. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 8 8. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 8
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 8 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 8
9.1. Normative References . . . . . . . . . . . . . . . . . . 8 9.1. Normative References . . . . . . . . . . . . . . . . . . 8
9.2. Informative References . . . . . . . . . . . . . . . . . 8 9.2. Informative References . . . . . . . . . . . . . . . . . 9
Appendix A. Open Issues . . . . . . . . . . . . . . . . . . . . 9 Appendix A. Open Issues . . . . . . . . . . . . . . . . . . . . 9
Appendix B. Difference between <startup> datastore and <factory- Appendix B. Difference between <startup> datastore and <factory-
default> datastore . . . . . . . . . . . . . . . . . 9 default> datastore . . . . . . . . . . . . . . . . . 9
Appendix C. Changes between revisions . . . . . . . . . . . . . 9 Appendix C. Changes between revisions . . . . . . . . . . . . . 9
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 10 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 11
1. Introduction 1. Introduction
This document defines a method to reset a server to its factory- This document defines a method to reset a server to its factory-
default content. The reset operation may be used e.g. during initial default content. The reset operation may be used e.g. during initial
zero-touch configuration [RFC8572] or when the existing configuration zero-touch configuration [RFC8572] or when the existing configuration
has major errors, so re-starting the configuration process from has major errors, so re-starting the configuration process from
scratch is the best option. When resetting a datastore all previous scratch is the best option. When resetting a datastore all previous
configuration settings will be lost and replaced by the factory- configuration settings will be lost and replaced by the factory-
default content. default content.
skipping to change at page 4, line 26 skipping to change at page 4, line 26
1. For the <running>,<candidate> and <startup> datastores as the 1. For the <running>,<candidate> and <startup> datastores as the
content of the <factory-default> datastore, if it exists content of the <factory-default> datastore, if it exists
2. YANG Instance Data [I-D.ietf-netmod-yang-instance-file-format] 2. YANG Instance Data [I-D.ietf-netmod-yang-instance-file-format]
3. In some implementation specific manner 3. In some implementation specific manner
4. For dynamic datastores unless otherwise specified the factory- 4. For dynamic datastores unless otherwise specified the factory-
default content is empty. default content is empty.
In addition to set the content of the read-write configuration In addition,the "factory-reset" RPC might also be used to trigger
datastores, the "factory-reset" RPC might also be used to clean up files cleanup, restarting the node or some of the SW processes, or
files, restart the node or some of the SW processes, or it might set setting some security data/passwords to the default value, removing
some security data/passwords to the default value, remove logs, logs, removing any temporary data (from datastore or elsewhere) etc.
remove any temporary data (from datastore or elsewhere) etc. How the "factory-reset" RPC is triggered is out of scope of this
document.
3. Factory-Default Datastore 3. Factory-Default Datastore
Following guidelines for defining Datastores in the appendix A of Following guidelines for defining Datastores in the appendix A of
[RFC8342], this document introduces a new datastore resource named [RFC8342], this document introduces a new datastore resource named
'Factory-Default' that represents a preconfigured minimal initial 'Factory-Default' that represents a preconfigured minimal initial
configuration that can be used to initialize the configuration of a configuration that can be used to initialize the configuration of a
server. server.
o Name: "factory-default" o Name: "factory-default"
skipping to change at page 5, line 49 skipping to change at page 5, line 50
Editor: Balazs Lengyel Editor: Balazs Lengyel
<mailto:balazs.lengyel@ericsson.com> <mailto:balazs.lengyel@ericsson.com>
Editor: Qin Wu Editor: Qin Wu
<mailto:bill.wu@huawei.com> <mailto:bill.wu@huawei.com>
Editor: Ye Niu Editor: Ye Niu
<mailto:niuye@huawei.com>"; <mailto:niuye@huawei.com>";
description description
"This module defines the "This module defines the
- factory-reset RPC - factory-reset RPC
- factory-default datastore - factory-default datastore
- an extension to the NETCONF <get-config> operation to
allow it to operate on the factory-default datastore.
It provides functionality to reset a server to its It provides functionality to reset a server to its
factory-default content. factory-default content.
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED',
'MAY', and 'OPTIONAL' in this document are to be interpreted as 'MAY', and 'OPTIONAL' in this document are to be interpreted as
described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, described in BCP 14 (RFC 2119) (RFC 8174) when, and only when,
they appear in all capitals, as shown here. they appear in all capitals, as shown here.
skipping to change at page 7, line 36 skipping to change at page 7, line 38
name: ietf-factory-default name: ietf-factory-default
namespace: urn:ietf:params:xml:ns:yang:ietf-factory-default namespace: urn:ietf:params:xml:ns:yang:ietf-factory-default
prefix: fd prefix: fd
RFC: xxxx RFC: xxxx
6. Security Considerations 6. Security Considerations
The <factory-reset> RPC can overwrite important and security The YANG module defined in this document extends the base operations
sensitive information in one of the other datastores e.g. running, for NETCONF [RFC6241] and RESTCONF [RFC8040]. The lowest NETCONF
therefore it is important to restrict access to this RPC using the layer is the secure transport layer, and the mandatory-to-implement
standard access control methods. [RFC8341] secure transport is Secure Shell (SSH) [RFC6242]. The lowest
RESTCONF layer is HTTPS, and the mandatory-to-implement secure
transport is TLS [RFC8446].
The content of the factory-default datastore is usually not security The <factory-reset> RPC operation may be considered sensitive in some
sensitive as it is the same on any device of a certain type. In case network enviroments,e.g., remote access to reset the device or
there is any sensitive content in the factory-default datastore, it overwrite important and security sensitive information in one of the
should be protected in a secure way,e.g.,sign or encrypt the other datastores e.g. running, therefore it is important to restrict
sensitive information. access to this RPC using the standard access control methods.
[RFC8341]
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.
7. Acknowledgements 7. Acknowledgements
Thanks to Juergen Schoenwaelder, Ladislav Lhotka, Alex Campbell,Joe Thanks to Juergen Schoenwaelder, Ladislav Lhotka, Alex Campbell,Joe
Clark,Robert Wilton, Kent Watsen, Joel Jaeggli,Andy Berman,Susan Clark,Robert Wilton, Kent Watsen, Joel Jaeggli, Lou Berger, Andy
Hares to review this draft and provide important input to this Berman,Susan Hares to review this draft and provide important input
document. to this document.
8. Contributors 8. Contributors
Rohit R Ranade Rohit R Ranade
Huawei Huawei
Email: rohitrranade@huawei.com Email: rohitrranade@huawei.com
9. References 9. References
9.1. Normative References 9.1. Normative References
skipping to change at page 8, line 42 skipping to change at page 9, line 9
[RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore Architecture and R. Wilton, "Network Management Datastore Architecture
(NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018,
<https://www.rfc-editor.org/info/rfc8342>. <https://www.rfc-editor.org/info/rfc8342>.
9.2. Informative References 9.2. Informative References
[I-D.ietf-netmod-yang-instance-file-format] [I-D.ietf-netmod-yang-instance-file-format]
Lengyel, B. and B. Claise, "YANG Instance Data File Lengyel, B. and B. Claise, "YANG Instance Data File
Format", draft-ietf-netmod-yang-instance-file-format-02 Format", draft-ietf-netmod-yang-instance-file-format-04
(work in progress), February 2019. (work in progress), August 2019.
[RFC8572] Watsen, K., Farrer, I., and M. Abrahamsson, "Secure Zero [RFC8572] Watsen, K., Farrer, I., and M. Abrahamsson, "Secure Zero
Touch Provisioning (SZTP)", RFC 8572, Touch Provisioning (SZTP)", RFC 8572,
DOI 10.17487/RFC8572, April 2019, DOI 10.17487/RFC8572, April 2019,
<https://www.rfc-editor.org/info/rfc8572>. <https://www.rfc-editor.org/info/rfc8572>.
Appendix A. Open Issues Appendix A. Open Issues
o Do we need an extra parameter that may order a restart of the o Do we need an extra parameter that may order a restart of the
YANG-server or the whole system? YANG-server or the whole system?
skipping to change at page 9, line 24 skipping to change at page 9, line 36
default> datastore default> datastore
When the device first boots up, the content of the <startup> and When the device first boots up, the content of the <startup> and
<factory-default> will be identical. The content of <startup> can be <factory-default> will be identical. The content of <startup> can be
subsequently changed by using <startup> as a target in a <copy- subsequently changed by using <startup> as a target in a <copy-
config> operation. The <factory-default> is a read-only datastore config> operation. The <factory-default> is a read-only datastore
and it is usually static as described in earlier sections. and it is usually static as described in earlier sections.
Appendix C. Changes between revisions Appendix C. Changes between revisions
v02 - 03
o Update security consideration section.
v01 - v02 v01 - v02
o Address security issue in the security consideration section. o Address security issue in the security consideration section.
o Remove an extension to the NETCONF <copy-config> operation which o Remove an extension to the NETCONF <copy-config> operation which
allows it to operate on the factory-default datastore. allows it to operate on the factory-default datastore.
o Add an extension to the NETCONF <get-config.operation which allows o Add an extension to the NETCONF <get-config> operation which
it to operate on the factory-default datastore. allows it to operate on the factory-default datastore.
v00 - v01 v00 - v01
o Change YANG server into server defined in NMDA architecture based o Change YANG server into server defined in NMDA architecture based
on discussion. on discussion.
o Allow reset the content of all read-write configuraton datastores o Allow reset the content of all read-write configuraton datastores
to its factory-default content except <candidate>. to its factory-default content except <candidate>.
o Add clarification text on factory-reset protocol operation o Add clarification text on factory-reset protocol operation
behavior. behavior.
v03 - v00 v03 - v00
 End of changes. 16 change blocks. 
29 lines changed or deleted 41 lines changed or added

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