draft-ietf-netmod-factory-default-12.txt   draft-ietf-netmod-factory-default-13.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: August 19, 2020 Ericsson Hungary Expires: August 28, 2020 Ericsson Hungary
Y. Niu Y. Niu
Huawei Huawei
February 16, 2020 February 25, 2020
Factory Default Setting A YANG Data Model for Factory Default Settings
draft-ietf-netmod-factory-default-12 draft-ietf-netmod-factory-default-13
Abstract Abstract
This document defines a method to reset a server to its factory This document defines a YANG data model to allow clients to reset a
default content. The reset operation may be used, e.g., when the server back to its factory default condition. It also defines a
existing configuration has major errors so re-starting the "factory-default" datastore to allow clients to read the factory
configuration process from scratch is the best option. default configuration for the device.
A new "factory-reset" RPC is defined. When resetting a device, all
previous configuration settings will be lost and replaced by the
factory default content.
A new optional "factory-default" read-only datastore is defined, that The YANG data model in this document conforms to the Network
contains the factory default configuration for the device. Management Datastore Architecture (NMDA) defined in RFC 8342.
Status of This Memo Status of This Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on August 19, 2020. This Internet-Draft will expire on August 28, 2020.
Copyright Notice Copyright Notice
Copyright (c) 2020 IETF Trust and the persons identified as the Copyright (c) 2020 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
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 2
2. Factory-Reset RPC . . . . . . . . . . . . . . . . . . . . . . 3 2. Factory-Reset RPC . . . . . . . . . . . . . . . . . . . . . . 3
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. Changes between revisions . . . . . . . . . . . . . 9 Appendix A. Changes between revisions . . . . . . . . . . . . . 9
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 11 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 12
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., when the default content. The reset operation may be used, e.g., when the
existing configuration has major errors so re-starting the existing configuration has major errors so re-starting the
configuration process from scratch is the best option. configuration process from scratch is the best option.
A "factory-reset" RPC is defined. When resetting a device, all A "factory-reset" RPC is defined. When resetting a device, all
previous configuration settings will be lost and replaced by the previous configuration settings will be lost and replaced by the
skipping to change at page 3, line 30 skipping to change at page 3, line 24
o candidate configuration datastore o candidate configuration datastore
o running configuration datastore o running configuration datastore
o intended configuration datastore o intended configuration datastore
o operational state datastore o operational state datastore
o conventional configuration datastore o conventional configuration datastore
o datastore schema
o RPC operation o RPC operation
The following terms are defined in this document as follows: The following terms are defined in this document as follows:
o factory-default datastore: A read-only configuration datastore o factory-default datastore: A read-only configuration datastore
holding a preconfigured initial configuration that is used to holding a preconfigured initial configuration that is used to
initialize the configuration of a server. initialize the configuration of a server. This datastore is
referred to as "<factory-default>".
2. Factory-Reset RPC 2. Factory-Reset RPC
A new "factory-reset" RPC is introduced. Upon receiving the RPC A new "factory-reset" RPC is introduced. Upon receiving the RPC
o All supported conventional read-write configuration datastores o All supported conventional read-write configuration datastores
(i.e. <running>, <startup>, and <candidate>) are all reset to the (i.e. <running>, <startup>, and <candidate>) are reset to the
contents of <factory-default>. contents of <factory-default>.
o Read-only datastores receive their content from other o Read-only datastores receive their content from other
datastores(e.g. <intended> gets its content from <running>). datastores(e.g., <intended> gets its content from <running>).
o All data in any ephemeral datastores MUST be discarded. o All data in any dynamic configuration datastores MUST be
discarded.
o The contents of the <operational> datastore MUST reflect the o The contents of the <operational> datastore MUST reflect the
operational state of the device after applying the factory default operational state of the device after applying the factory default
configuration. configuration.
In addition, the "factory-reset" RPC MUST restore non-volatile In addition, the "factory-reset" RPC MUST restore non-volatile
storage to factory condition. Depending on the system, this may storage to factory condition. Depending on the system, this may
entail deleting dynamically generated files, such as those containing entail deleting dynamically generated files, such as those containing
keys (e.g., /etc/ssl/private), certificates (e.g., /etc/ssl), logs keys (e.g., /etc/ssl/private), certificates (e.g., /etc/ssl), logs
(e.g., /var/log), and temporary files (e.g., /tmp/*). All security (e.g., /var/log), and temporary files (e.g., /tmp/*). All security
skipping to change at page 4, line 30 skipping to change at page 4, line 26
datastores are immediately reset to factory default, the device may datastores are immediately reset to factory default, the device may
become unreachable on the network. It is important to understand how become unreachable on the network. It is important to understand how
a given vendor's device will behave after the RPC is executed. a given vendor's device will behave after the RPC is executed.
Implementors SHOULD reboot the device or otherwise restart processes Implementors SHOULD reboot the device or otherwise restart processes
needed to bootstrap it. needed to bootstrap it.
3. Factory-Default Datastore 3. Factory-Default Datastore
Following the guidelines for defining Datastores in the appendix A of Following the guidelines for defining Datastores in the appendix A of
[RFC8342], this document introduces a new optional datastore resource [RFC8342], this document introduces a new optional datastore resource
named "factory-default" that represents a preconfigured minimal named "factory-default" that represents a preconfigured initial
initial configuration that can be used to initialize the configuration that can be used to initialize the configuration of a
configuration of a server. A device MAY implement the "factory- server. A device MAY implement the "factory-reset" RPC without
reset" RPC without implementing the "factory-default" datastore, implementing the "factory-default" datastore, which would only
which would only eliminate the ability to programmatically determine eliminate the ability to programmatically determine the factory
the factory default configuration. default configuration.
o Name: "factory-default" o Name: "factory-default"
o YANG modules: all o YANG modules: The factory default datastore schema MUST either be
the same as the conventional configuration datastores, or a subset
of the datastore schema for the conventional configuration
datastores.
o YANG nodes: all "config true" data nodes o YANG nodes: all "config true" data nodes
o Management operations: The content of the datastore is set by the o Management operations: The content of the datastore is set by the
server in an implementation dependent manner. The content can not server in an implementation dependent manner. The content can not
be changed by management operations via NETCONF, RESTCONF, the CLI be changed by management operations via NETCONF, RESTCONF, the CLI
etc. unless specialized, dedicated operations are provided. The etc. unless specialized, dedicated operations are provided. The
datastore can be read using the standard NETCONF/RESTCONF protocol datastore can be read using the standard NETCONF/RESTCONF protocol
operations. The "factory-reset" operation copies the factory operations. The "factory-reset" operation copies the factory
default content to <running> and, if present, <startup> and/or default content to <running> and, if present, <startup> and/or
<candidate> and then the content of these datastores is propagated <candidate> and then the content of these datastores is propagated
automatically to any other read only datastores, e.g., <intended> automatically to any other read only datastores, e.g., <intended>
and <operational>. and <operational>.
o Origin: This document does not define a new origin identity as it o Origin: This document does not define a new origin identity as it
does not interact with <operational> datastore. does not interact with the <operational> datastore.
o Protocols: RESTCONF, NETCONF and other management protocol. o Protocols: RESTCONF, NETCONF and other management protocol.
o Defining YANG module: "ietf-factory-default". o Defining YANG module: "ietf-factory-default".
The contents of <factory-default> is defined by the device vendor and The contents of <factory-default> is defined by the device vendor and
MUST persist across device restarts. MUST persist across device restarts. If supported, the factory-
default datastore MUST be included in the list of datastores in YANG
library [RFC 8525].
4. YANG Module 4. YANG Module
This module uses the "datastore" identity [RFC8342], and the This module uses the "datastore" identity [RFC8342], and the
"default-deny-all" extension statement from [RFC8341]. "default-deny-all" extension statement from [RFC8341].
<CODE BEGINS> file "ietf-factory-default@2019-11-27.yang" <CODE BEGINS> file "ietf-factory-default@2019-11-27.yang"
module ietf-factory-default { module ietf-factory-default {
yang-version 1.1; yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-factory-default"; namespace "urn:ietf:params:xml:ns:yang:ietf-factory-default";
prefix fd; prefix fd;
import ietf-datastores { import ietf-datastores {
prefix ds; prefix ds;
reference reference
"RFC 8342: Network Management Datastore Architecture (NMDA)"; "RFC 8342: Network Management Datastore Architecture (NMDA)";
} }
import ietf-netconf-acm { import ietf-netconf-acm {
prefix nacm; prefix nacm;
reference reference
"RFC8341: Network Configuration Access Control Model"; "RFC8341: Network Configuration Access Control Model";
} }
organization organization
"IETF NETMOD (Network Modeling) Working Group"; "IETF NETMOD (Network Modeling) Working Group";
contact contact
"WG Web: <https://tools.ietf.org/wg/netconf/> "WG Web: <https://tools.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org> WG List: <mailto:netconf@ietf.org>
Editor: Qin Wu Editor: Qin Wu
<mailto:bill.wu@huawei.com> <mailto:bill.wu@huawei.com>
Editor: Balazs Lengyel Editor: Balazs Lengyel
<mailto:balazs.lengyel@ericsson.com> <mailto:balazs.lengyel@ericsson.com>
Editor: Ye Niu Editor: Ye Niu
<mailto:niuye@huawei.com>"; <mailto:niuye@huawei.com>";
description description
"This module provides functionality to reset a server to its "This module provides functionality to reset a server to its
factory default configuration and, when supported, to discover factory default configuration and, when supported, to discover
the factory default configuration contents independent of the factory default configuration contents independent of
resetting the server. resetting the server.
Copyright (c) 2020 IETF Trust and the persons identified as Copyright (c) 2020 IETF Trust and the persons identified as
authors of the code. All rights reserved. authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents Relating to IETF Documents
(http://trustee.ietf.org/license-info). (http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; This version of this YANG module is part of RFC XXXX;
see the RFC itself for full legal notices."; see the RFC itself for full legal notices.";
// RFC Ed.: update the date below with the date of RFC publication
// and remove this note.
// RFC Ed.: replace XXXX with actual RFC number and remove this
// note.
revision 2019-11-27 {
description
"Initial revision.";
reference
"RFC XXXX: Factory default Setting";
}
revision 2019-11-27 { feature factory-default-datastore {
description description
"Initial revision."; "Indicates that the factory default configuration is
reference available as a datastore.";
"RFC XXXX: Factory default Setting"; }
}
feature factory-default-datastore { rpc factory-reset {
description nacm:default-deny-all;
"Indicates that the factory default configuration is description
available as a datastore."; "The server resets all datastores to their factory
} default content and any non-volatile storage back to
factory condition, deleting all dynamically generated
files, including those containing keys, certificates,
logs, and other temporary files.
rpc factory-reset { Depending on the factory default configuration, after
nacm:default-deny-all; being reset, the device may become unreachable on the
description network.";
"The server resets the content of all read-write }
configuration datastores (i.e.,<running>, <startup>,
and <candidate>) to their factory default content.";
}
identity factory-default { identity factory-default {
if-feature "factory-default-datastore"; if-feature "factory-default-datastore";
base ds:datastore; base ds:datastore;
description description
"This read-only datastore contains the factory default "This read-only datastore contains the factory default
configuration for the device used to replace the contents configuration for the device used to replace the contents
of the read-write conventional configuration datastores of the read-write conventional configuration datastores
during a 'factory-reset' RPC operation."; during a 'factory-reset' RPC operation.";
} }
} }
<CODE ENDS> <CODE ENDS>
5. IANA Considerations 5. IANA Considerations
This document registers one URI in the IETF XML Registry [RFC3688]. This document registers one URI in the IETF XML Registry [RFC3688].
The following registration has been made: The following registration has been made:
URI: urn:ietf:params:xml:ns:yang:ietf-factory-default URI: urn:ietf:params:xml:ns:yang:ietf-factory-default
Registrant Contact: The IESG. Registrant Contact: The IESG.
XML: N/A, the requested URI is an XML namespace. XML: N/A, the requested URI is an XML namespace.
skipping to change at page 7, line 36 skipping to change at page 7, line 46
layer is the secure transport layer, and the mandatory-to-implement layer is the secure transport layer, and the mandatory-to-implement
secure transport is Secure Shell (SSH) [RFC6242]. The lowest secure transport is Secure Shell (SSH) [RFC6242]. The lowest
RESTCONF layer is HTTPS, and the mandatory-to-implement secure RESTCONF layer is HTTPS, and the mandatory-to-implement secure
transport is TLS [RFC8446]. transport is TLS [RFC8446].
Access to the "factory-reset" RPC operation is considered sensitive Access to the "factory-reset" RPC operation is considered sensitive
and therefore has been restricted using the "default-deny-all" access and therefore has been restricted using the "default-deny-all" access
control defined in [RFC8341]. control defined in [RFC8341].
The "factory-reset" RPC can prevent any further management of the The "factory-reset" RPC can prevent any further management of the
device if the session and client config is included in the factory device if the session and client config are included in the factory
default contents. default contents.
The operational disruption caused by setting the config to factory The operational disruption caused by setting the config to factory
default contents varies greatly depending on the implementation and default contents varies greatly depending on the implementation and
current config. current config.
The non-volatile storage is expected to be wiped clean and reset back
to the factory default state, but there is no guarantee that the data
is wiped according to any particular data cleansing standard, and the
owner of the device MUST NOT rely on any temporary data (e.g.,
including private keys) for recovery after the factory-reset RPC has
been invoked.
7. Acknowledgements 7. Acknowledgements
Thanks to Juergen Schoenwaelder, Ladislav Lhotka, Alex Campbell, Joe Thanks to Juergen Schoenwaelder, Ladislav Lhotka, Alex Campbell, Joe
Clarke, Robert Wilton, Kent Watsen, Joel Jaeggli, Lou Berger, Andy Clarke, Robert Wilton, Kent Watsen, Joel Jaeggli, Lou Berger, Andy
Bierman, Susan Hares to review this draft and provide important input Bierman, Susan Hares for reviewing this draft and providing important
to this document. input 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 47 skipping to change at page 9, line 15
[RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration
Access Control Model", STD 91, RFC 8341, Access Control Model", STD 91, RFC 8341,
DOI 10.17487/RFC8341, March 2018, DOI 10.17487/RFC8341, March 2018,
<https://www.rfc-editor.org/info/rfc8341>. <https://www.rfc-editor.org/info/rfc8341>.
[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>.
[RFC8525] Bierman, A., Bjorklund, M., Schoenwaelder, J., Watsen, K.,
and R. Wilton, "YANG Library", RFC 8525,
DOI 10.17487/RFC8525, March 2019,
<https://www.rfc-editor.org/info/rfc8525>.
9.2. Informative References 9.2. Informative References
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>. <https://www.rfc-editor.org/info/rfc6241>.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
<https://www.rfc-editor.org/info/rfc6242>. <https://www.rfc-editor.org/info/rfc6242>.
skipping to change at page 9, line 21 skipping to change at page 9, line 43
<https://www.rfc-editor.org/info/rfc8040>. <https://www.rfc-editor.org/info/rfc8040>.
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
<https://www.rfc-editor.org/info/rfc8446>. <https://www.rfc-editor.org/info/rfc8446>.
Appendix A. Changes between revisions Appendix A. Changes between revisions
Editorial Note (To be removed by RFC Editor) Editorial Note (To be removed by RFC Editor)
v12 - 13
o Address issues raised during AD review.
v11 - 12 v11 - 12
o Fix IDnits and reference issues from Shepherd review. o Fix IDnits and reference issues from Shepherd review.
v10 - 11 v10 - 11
o Incorporate additional Shepherd review's comments. o Incorporate additional Shepherd review's comments.
v09 - 10 v09 - 10
o Incorporate Shepherd review's comments. o Incorporate Shepherd review's comments.
v08 - 09 v08 - 09
o Provide some guideline for operators and implementor who implement o Provide some guideline for operators and implementor who implement
factory defaut method. factory defaut method.
 End of changes. 36 change blocks. 
106 lines changed or deleted 135 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/