Internet DRAFT - draft-ietf-netmod-factory-default
draft-ietf-netmod-factory-default
NETMOD Working Group Q. Wu
Internet-Draft Huawei
Intended status: Standards Track B. Lengyel
Expires: October 27, 2020 Ericsson Hungary
Y. Niu
Huawei
April 25, 2020
A YANG Data Model for Factory Default Settings
draft-ietf-netmod-factory-default-15
Abstract
This document defines a YANG data model with the "factory-reset" RPC
to allow clients to reset a server back to its factory default
condition. It also defines an optional "factory-default" datastore
to allow clients to read the factory default configuration for the
device.
The YANG data model in this document conforms to the Network
Management Datastore Architecture (NMDA) defined in RFC 8342.
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 27, 2020.
Copyright Notice
Copyright (c) 2020 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
Wu, et al. Expires October 27, 2020 [Page 1]
Internet-Draft Factory Default Setting April 2020
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.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
2. Factory-Reset RPC . . . . . . . . . . . . . . . . . . . . . . 3
3. Factory-Default Datastore . . . . . . . . . . . . . . . . . . 4
4. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 5
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7
6. Security Considerations . . . . . . . . . . . . . . . . . . . 7
7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 8
8. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 8
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 8
9.1. Normative References . . . . . . . . . . . . . . . . . . 8
9.2. Informative References . . . . . . . . . . . . . . . . . 9
Appendix A. Changes between revisions . . . . . . . . . . . . . 10
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 13
1. Introduction
This document defines a YANG data model and associated mechanism to
reset a server to its factory default content. This mechanism may be
used, e.g., when the existing configuration has major errors so re-
starting the configuration process from scratch is the best option.
A "factory-reset" RPC is defined within the YANG data model. When
resetting a device, all previous configuration settings will be lost
and replaced by the factory default content.
In addition, an optional "factory-default" read-only datastore is
defined within the YANG data model, that contains the data to replace
the contents of implemented read-write conventional configuration
datastores at reset. This datastore can also be used in the <get-
data> operation.
The YANG data model in this document conforms to the Network
Management Datastore Architecture defined in [RFC8342].
Wu, et al. Expires October 27, 2020 [Page 2]
Internet-Draft Factory Default Setting April 2020
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.
The following terms are defined in [RFC8342] [RFC7950] and are not
redefined here:
o server
o startup configuration datastore
o candidate configuration datastore
o running configuration datastore
o intended configuration datastore
o operational state datastore
o conventional configuration datastore
o datastore schema
o RPC operation
The following terms are defined in this document as follows:
o factory-default datastore: A read-only configuration datastore
holding a pre-set initial configuration that is used to initialize
the configuration of a server. This datastore is referred to as
"<factory-default>".
2. Factory-Reset RPC
A new "factory-reset" remote procedure call (RPC) is introduced.
Upon receiving the RPC:
o All supported conventional read-write configuration datastores
(i.e. <running>, <startup>, and <candidate>) are reset to the
contents of <factory-default>.
o Read-only datastores receive their content from other datastores
(e.g., <intended> gets its content from <running>).
Wu, et al. Expires October 27, 2020 [Page 3]
Internet-Draft Factory Default Setting April 2020
o All data in any dynamic configuration datastores MUST be
discarded.
o The contents of the <operational> datastore MUST reflect the
operational state of the device after applying the factory default
configuration.
In addition, the "factory-reset" RPC MUST restore non-volatile
storage to factory condition. Depending on the system, this may
entail deleting dynamically generated files, such as those containing
keys (e.g., /etc/ssl/private), certificates (e.g., /etc/ssl), logs
(e.g., /var/log), and temporary files (e.g., /tmp/*). Any other
cryptographic keys that are part of the factory-installed image will
be retained (such as an IDevID certificate) [I-D.ietf-anima-
bootstrapping-keyinfra]. When this process includes security-
sensitive data such as cryptographic keys or passwords, it is
RECOMMENDED to perform the deletion in a manner as thorough as
possible (e.g., overwriting the physical storage medium with zeros
and/or random bits for repurpose or end of life (EoL) disposal) to
reduce the risk of the sensitive material being recoverable. The
"factory-reset" RPC MAY also be used to trigger some other resetting
tasks such as restarting the node or some of the software processes.
Note that operators should be aware that since all read-write
datastores are immediately reset to factory default, the device may
become unreachable as a host on the network. It is important to
understand how a given vendor's device will behave after the RPC is
executed. Implementors SHOULD reboot the device and get it properly
configured or otherwise restart processes needed to bootstrap it.
3. Factory-Default Datastore
Following the guidelines for defining Datastores in the appendix A of
[RFC8342], this document introduces a new optional datastore resource
named "factory-default" that represents a pre-set initial
configuration that can be used to initialize the configuration of a
server. A device MAY implement the "factory-reset" RPC without
implementing the "factory-default" datastore, which would only
eliminate the ability to programmatically determine the factory
default configuration.
o Name: "factory-default"
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.
Wu, et al. Expires October 27, 2020 [Page 4]
Internet-Draft Factory Default Setting April 2020
o YANG nodes: all "config true" data nodes
o Management operations: The content of the datastore is set by the
server in an implementation dependent manner. The content can not
be changed by management operations via NETCONF, RESTCONF, the CLI
etc. unless specialized, dedicated operations are provided. The
datastore can be read using the standard NETCONF/RESTCONF protocol
operations. The "factory-reset" operation copies the factory
default content to <running> and, if present, <startup> and/or
<candidate> and then the content of these datastores is propagated
automatically to any other read only datastores, e.g., <intended>
and <operational>.
o Origin: This document does not define a new origin identity as it
does not interact with the <operational> datastore.
o Protocols: RESTCONF, NETCONF and other management protocol.
o Defining YANG module: "ietf-factory-default".
The contents of <factory-default> are defined by the device vendor
and 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
This module uses the "datastore" identity [RFC8342], and the
"default-deny-all" extension statement from [RFC8341].
<CODE BEGINS> file "ietf-factory-default@2019-11-27.yang"
module ietf-factory-default {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-factory-default";
prefix fd;
import ietf-datastores {
prefix ds;
reference
"RFC 8342: Network Management Datastore Architecture (NMDA)";
}
import ietf-netconf-acm {
prefix nacm;
reference
"RFC8341: Network Configuration Access Control Model";
}
organization
Wu, et al. Expires October 27, 2020 [Page 5]
Internet-Draft Factory Default Setting April 2020
"IETF NETMOD (Network Modeling) Working Group";
contact
"WG Web: <https://tools.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org>
Editor: Qin Wu
<mailto:bill.wu@huawei.com>
Editor: Balazs Lengyel
<mailto:balazs.lengyel@ericsson.com>
Editor: Ye Niu
<mailto:niuye@huawei.com>";
description
"This module provides functionality to reset a server to its
factory default configuration and, when supported, to discover
the factory default configuration contents independent of
resetting the server.
Copyright (c) 2020 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
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX;
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";
}
feature factory-default-datastore {
description
"Indicates that the factory default configuration is
available as a datastore.";
}
rpc factory-reset {
nacm:default-deny-all;
Wu, et al. Expires October 27, 2020 [Page 6]
Internet-Draft Factory Default Setting April 2020
description
"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.
Depending on the factory default configuration, after
being reset, the device may become unreachable on the
network.";
}
identity factory-default {
if-feature "factory-default-datastore";
base ds:datastore;
description
"This read-only datastore contains the factory default
configuration for the device that will be used to replace
the contents of the read-write conventional configuration
datastores during a 'factory-reset' RPC operation.";
}
}
<CODE ENDS>
5. IANA Considerations
This document registers one URI in the IETF XML Registry [RFC3688].
The following registration has been made:
URI: urn:ietf:params:xml:ns:yang:ietf-factory-default
Registrant Contact: The IESG.
XML: N/A, the requested URI is an XML namespace.
This document registers one YANG module in the YANG Module Names
Registry [RFC6020]. The following registration has been made:
name: ietf-factory-default
namespace: urn:ietf:params:xml:ns:yang:ietf-factory-default
prefix: fd
RFC: xxxx
6. Security Considerations
The YANG module defined in this document extends the base operations
for NETCONF [RFC6241] and RESTCONF [RFC8040]. The lowest NETCONF
layer is the secure transport layer, and the mandatory-to-implement
secure transport is Secure Shell (SSH) [RFC6242]. The lowest
Wu, et al. Expires October 27, 2020 [Page 7]
Internet-Draft Factory Default Setting April 2020
RESTCONF layer is HTTPS, and the mandatory-to-implement secure
transport is TLS [RFC8446].
Access to the "factory-reset" RPC operation and factory default
values of all configuration data nodes within "factory-default"
datastore is considered sensitive and therefore has been restricted
using the "default-deny-all" access control defined in [RFC8341].
The "factory-reset" RPC can prevent any further management of the
device when the server is reset back to its factory default
condition,e.g., the session and client config are included in the
factory default contents or treated as dynamic files on the
nonvoliatile storage and overwritten by the the "factory-reset" RPC.
The operational disruption caused by setting the config to factory
default contents or lacking appropriate security control on factory
default configuration varies greatly depending on the implementation
and 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 sensitive data (e.g.,
private keys) being forensically unrecoverable from the device's non-
volatile storage after a factory-reset RPC has been invoked.
7. Acknowledgements
Thanks to Juergen Schoenwaelder, Ladislav Lhotka, Alex Campbell, Joe
Clarke, Robert Wilton, Kent Watsen, Joel Jaeggli, Lou Berger, Andy
Bierman, Susan Hares, Benjamin Kaduk, Stephen Kent, Stewart Bryant,
Eric Vyncke, Murray Kucherawy, Roman Danyliw, Tony Przygienda, John
Heasley for reviewing this draft and providing important input to
this document.
8. Contributors
Rohit R Ranade
Huawei
Email: rohitrranade@huawei.com
9. References
9.1. Normative References
Wu, et al. Expires October 27, 2020 [Page 8]
Internet-Draft Factory Default Setting April 2020
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>.
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010,
<https://www.rfc-editor.org/info/rfc6020>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016,
<https://www.rfc-editor.org/info/rfc7950>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration
Access Control Model", STD 91, RFC 8341,
DOI 10.17487/RFC8341, March 2018,
<https://www.rfc-editor.org/info/rfc8341>.
[RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore Architecture
(NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018,
<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
[I-D.ietf-anima-bootstrapping-keyinfra]
Pritikin, M., Richardson, M., Eckert, T., Behringer, M.,
and K. Watsen, "Bootstrapping Remote Secure Key
Infrastructures (BRSKI)", draft-ietf-anima-bootstrapping-
keyinfra-41 (work in progress), April 2020.
Wu, et al. Expires October 27, 2020 [Page 9]
Internet-Draft Factory Default Setting April 2020
[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,
<https://www.rfc-editor.org/info/rfc6241>.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
<https://www.rfc-editor.org/info/rfc6242>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>.
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
<https://www.rfc-editor.org/info/rfc8446>.
Appendix A. Changes between revisions
Editorial Note (To be removed by RFC Editor)
v14 -15
o Address comments raised in IESG review.
v13 - 14
o Address additional issues raised during AD review.
v12 - 13
o Address issues raised during AD review.
v11 - 12
o Fix IDnits and reference issues from Shepherd review.
v10 - 11
o Incorporate additional Shepherd review's comments.
v09 - 10
o Incorporate Shepherd review's comments.
v08 - 09
Wu, et al. Expires October 27, 2020 [Page 10]
Internet-Draft Factory Default Setting April 2020
o Provide some guideline for operators and implementor who implement
factory defaut method.
v07 - 08
o Provide clarification and recommendation on the relationship
between factory-reset RPC and reboot.
o Nits fixed based on YANG Doctor Review.
v06 - 07
o Remove Factory default content specification;
o Remove reference to YANG instance data file format and zero touch
provision [RFC8573];
o Remove copy-config operation extension on factory-default
datastore
v05 - 06
o Additional text to enhance security section.
o Add nacm:default-deny-all on "factory-reset" RPC.
o A few clarification on Factory default content specification.
v03 - 04
o Additional text to clarify factory-reset RPC usage.
v02 - 03
o Update security consideration section.
v01 - v02
o Address security issue in the security consideration section.
o Remove an extension to the NETCONF <copy-config> operation which
allows it to operate on the factory-default datastore.
o Add an extension to the NETCONF <get-config> operation which
allows it to operate on the factory-default datastore.
v00 - v01
Wu, et al. Expires October 27, 2020 [Page 11]
Internet-Draft Factory Default Setting April 2020
o Change YANG server into server defined in NMDA architecture based
on discussion.
o Allow reset the content of all read-write configuraton datastores
to its factory default content except <candidate>.
o Add clarification text on factory-reset protocol operation
behavior.
v03 - v00
o Change draft name from draft-wu to draft-ietf-netmod-factory-
default-00 without content changes.
v02 - v03
o Change reset-datastore RPC into factory-reset RPC to allow reset
the whole device with factory default content.
o Remove target datastore parameter from factory-reset RPC.
o Other editorial changes.
v01 - v02
o Add copy-config based on Rob's comment.
o Reference Update.
v03 - v00 - v01
o Changed name from draft-wu-netconf-restconf-factory-restore to
draft-wu-netmod-factory-default
o Removed copy-config ; reset-datastore is enough
v02 - v03
o Restructured
o Made new datastore optional
o Removed Netconf capability
o Listed Open issues
v01 - v02
Wu, et al. Expires October 27, 2020 [Page 12]
Internet-Draft Factory Default Setting April 2020
o -
v00 - v01
o -
Authors' Addresses
Qin Wu
Huawei
101 Software Avenue, Yuhua District
Nanjing, Jiangsu 210012
China
Email: bill.wu@huawei.com
Balazs Lengyel
Ericsson Hungary
Magyar Tudosok korutja 11
1117 Budapest
Hungary
Phone: +36-70-330-7909
Email: balazs.lengyel@ericsson.com
Ye Niu
Huawei
Email: niuye@huawei.com
Wu, et al. Expires October 27, 2020 [Page 13]
