A YANG Data Model for Factory Default SettingsHuawei101 Software AvenueYuhua DistrictNanjingJiangsu210012Chinabill.wu@huawei.comEricsson HungaryMagyar Tudosok korutja 11Budapest1117Hungary+36-70-330-7909balazs.lengyel@ericsson.comHuaweiniuye@huawei.comThis 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 is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by
the Internet Engineering Steering Group (IESG). Further
information on Internet Standards is available in Section 2 of
RFC 7841.
Information about the current status of this document, any
errata, and how to provide feedback on it may be obtained at
.
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
() in effect on the date of
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
. Introduction
. Terminology
. "Factory-Reset" RPC
. "Factory-Default" Datastore
. YANG Module
. IANA Considerations
. Security Considerations
. References
. Normative References
. Informative References
Acknowledgements
Contributors
Authors' Addresses
IntroductionThis document defines a YANG data model and associated mechanism to
reset a server to its factory default contents. This mechanism may be
used, for example, when the existing configuration has major errors and so
restarting the configuration process from scratch is the best
option.A "factory-reset" remote procedure call (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 contents.In addition, an optional "factory-default" read-only datastore is
defined within the YANG data model. This datastore contains the data to replace
the contents of implemented read-write conventional configuration
datastores at reset and 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 .TerminologyThe 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
when, and only
when, they appear in all capitals, as shown here.The following terms are defined in and and are not
redefined here:
server
startup configuration datastore
candidate configuration datastore
running configuration datastore
intended configuration datastore
operational state datastore
conventional configuration datastore
datastore schema
RPC operation
This document defines the following term:
"factory-default" datastore:
A read-only configuration datastore
holding a preset initial configuration that is used to initialize
the configuration of a server. This datastore is referred to as
"<factory-default>".
"Factory-Reset" RPCThis document introduces a new "factory-reset" RPC. Upon
receiving the RPC:
All supported conventional read-write configuration datastores
(i.e., <running>, <startup>, and <candidate>) are
reset to the contents of <factory-default>.
Read-only datastores receive their contents from other datastores
(e.g., <intended> gets its contents from <running>).
All data in any dynamic configuration datastores MUST be
discarded.
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 nonvolatile
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 Initial Device Identifier (IDevID) certificate ). When
this process includes security-sensitive data such as cryptographic keys
or passwords, it is RECOMMENDED to perform the deletion
in as thorough a manner as possible (e.g., overwriting the physical storage medium with
zeros and/or random bits for repurposing 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."Factory-Default" DatastoreFollowing the guidelines for defining datastores in
, this document introduces a new optional datastore resource
named "factory-default" that represents a preset 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.
Name:
"factory-default".
YANG modules:
The "factory-default" datastore schema
MUST be either
(1) the same as the conventional configuration datastores or
(2) a subset of the datastore schema for the conventional configuration datastores.
YANG nodes:
All "config true" data nodes.
Management operations:
The contents of the datastore is set by the
server in an implementation-dependent manner. The contents cannot be
changed by management operations via the Network Configuration
Protocol (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 contents to
<running> and, if present, <startup> and/or
<candidate>. The contents of these datastores is then
propagated automatically to any other read-only datastores, e.g.,
<intended> and <operational>.
Origin:
This document does not define a new origin
identity, as it does not interact with the <operational> datastore.
Protocols:
RESTCONF, NETCONF, and other management protocols.
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 the
YANG library .YANG ModuleThis module uses the "datastore" identity and the
"default‑deny-all" extension statement from .
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
"RFC 8341: Network Configuration Access Control Model";
}
organization
"IETF Network Modeling (netmod) Working Group";
contact
"WG Web: <https://datatracker.ietf.org/wg/netmod/>
WG List: <mailto:netmod@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
independently 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
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC 8808; see the
RFC itself for full legal notices.";
revision 2020-08-31 {
description
"Initial revision.";
reference
"RFC 8808: A YANG Data Model for Factory Default Settings";
}
feature factory-default-datastore {
description
"Indicates that the factory default configuration is
available as a datastore.";
}
rpc factory-reset {
nacm:default-deny-all;
description
"The server resets all datastores to their factory
default contents and any nonvolatile 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.";
}
}IANA Considerations IANA has registered the following URI in the "ns" subregistry within
the "IETF XML Registry" :
URI:
urn:ietf:params:xml:ns:yang:ietf-factory-default
Registrant Contact:
The IESG.
XML:
N/A; the requested URI is an XML namespace.
IANA has registered the following YANG module in the "YANG Module
Names" subregistry within the
"YANG Parameters" registry:
Name:
ietf-factory-default
Namespace:
urn:ietf:params:xml:ns:yang:ietf-factory-default
Prefix:
fd
Reference:
8808
Security ConsiderationsThe YANG module specified in this document defines a schema for data
that is designed to be accessed via network management protocols such
as NETCONF or RESTCONF .
The lowest NETCONF layer is the secure transport layer, and the
mandatory-to-implement secure transport is Secure Shell (SSH)
. The lowest RESTCONF layer is HTTPS, and the
mandatory-to-implement secure transport is TLS .
The Network Configuration Access Control Model (NACM)
provides the means to restrict access for particular NETCONF or RESTCONF users
to a preconfigured subset of all available NETCONF or RESTCONF protocol
operations and content.
Access to the "factory-reset" RPC operation and factory default
values of all configuration data nodes within the "factory-default"
datastore is considered sensitive and therefore has been restricted by
using the "default-deny-all" access control statement defined in .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 configurations are included in the
factory default contents or treated as dynamic files in nonvolatile
storage and overwritten by the "factory-reset" RPC.The operational disruption caused by setting the configuration to factory
default contents or the lack of appropriate security control on the factory
default configuration varies greatly, depending on the implementation and
current configuration.The nonvolatile 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 clean 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 nonvolatile storage
after a "factory-reset" RPC has been invoked.ReferencesNormative ReferencesKey words for use in RFCs to Indicate Requirement LevelsIn many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.The IETF XML RegistryThis document describes an IANA maintained registry for IETF standards which use Extensible Markup Language (XML) related items such as Namespaces, Document Type Declarations (DTDs), Schemas, and Resource Description Framework (RDF) Schemas.YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)YANG is a data modeling language used to model configuration and state data manipulated by the Network Configuration Protocol (NETCONF), NETCONF remote procedure calls, and NETCONF notifications. [STANDARDS-TRACK]Network Configuration Protocol (NETCONF)The Network Configuration Protocol (NETCONF) defined in this document provides mechanisms to install, manipulate, and delete the configuration of network devices. It uses an Extensible Markup Language (XML)-based data encoding for the configuration data as well as the protocol messages. The NETCONF protocol operations are realized as remote procedure calls (RPCs). This document obsoletes RFC 4741. [STANDARDS-TRACK]Using the NETCONF Protocol over Secure Shell (SSH)This document describes a method for invoking and running the Network Configuration Protocol (NETCONF) within a Secure Shell (SSH) session as an SSH subsystem. This document obsoletes RFC 4742. [STANDARDS-TRACK]The YANG 1.1 Data Modeling LanguageYANG is a data modeling language used to model configuration data, state data, Remote Procedure Calls, and notifications for network management protocols. This document describes the syntax and semantics of version 1.1 of the YANG language. YANG version 1.1 is a maintenance release of the YANG language, addressing ambiguities and defects in the original specification. There are a small number of backward incompatibilities from YANG version 1. This document also specifies the YANG mappings to the Network Configuration Protocol (NETCONF).RESTCONF ProtocolThis document describes an HTTP-based protocol that provides a programmatic interface for accessing data defined in YANG, using the datastore concepts defined in the Network Configuration Protocol (NETCONF).Ambiguity of Uppercase vs Lowercase in RFC 2119 Key WordsRFC 2119 specifies common key words that may be used in protocol specifications. This document aims to reduce the ambiguity by clarifying that only UPPERCASE usage of the key words have the defined special meanings.Network Configuration Access Control ModelThe standardization of network configuration interfaces for use with the Network Configuration Protocol (NETCONF) or the RESTCONF protocol requires a structured and secure operating environment that promotes human usability and multi-vendor interoperability. There is a need for standard mechanisms to restrict NETCONF or RESTCONF protocol access for particular users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and content. This document defines such an access control model.This document obsoletes RFC 6536.Network Management Datastore Architecture (NMDA)Datastores are a fundamental concept binding the data models written in the YANG data modeling language to network management protocols such as the Network Configuration Protocol (NETCONF) and RESTCONF. This document defines an architectural framework for datastores based on the experience gained with the initial simpler model, addressing requirements that were not well supported in the initial model. This document updates RFC 7950.The Transport Layer Security (TLS) Protocol Version 1.3This document specifies version 1.3 of the Transport Layer Security (TLS) protocol. TLS allows client/server applications to communicate over the Internet in a way that is designed to prevent eavesdropping, tampering, and message forgery.This document updates RFCs 5705 and 6066, and obsoletes RFCs 5077, 5246, and 6961. This document also specifies new requirements for TLS 1.2 implementations.YANG LibraryThis document describes a YANG library that provides information about the YANG modules, datastores, and datastore schemas used by a network management server. Simple caching mechanisms are provided to allow clients to minimize retrieval of this information. This version of the YANG library supports the Network Management Datastore Architecture (NMDA) by listing all datastores supported by a network management server and the schema that is used by each of these datastores.Informative ReferencesBootstrapping Remote Secure Key Infrastructures (BRSKI)CiscoSandelman Software WorksFuturewei Technologies Inc. USAWatsen Networks This document specifies automated bootstrapping of an Autonomic
Control Plane. To do this a Secure Key Infrastructure is
bootstrapped. This is done using manufacturer-installed X.509
certificates, in combination with a manufacturer's authorizing
service, both online and offline. We call this process the
Bootstrapping Remote Secure Key Infrastructure (BRSKI) protocol.
Bootstrapping a new device can occur using a routable address and a
cloud service, or using only link-local connectivity, or on limited/
disconnected networks. Support for deployment models with less
stringent security requirements is included. Bootstrapping is
complete when the cryptographic identity of the new key
infrastructure is successfully deployed to the device. The
established secure connection can be used to deploy a locally issued
certificate to the device as well.
Work in ProgressAcknowledgements Thanks to ,
, , , , ,
, , , , ,
, , , , , , and for reviewing, and providing
important input to, this document.ContributorsHuaweirohitrranade@huawei.comAuthors' AddressesHuawei101 Software AvenueYuhua DistrictNanjingJiangsu210012Chinabill.wu@huawei.comEricsson HungaryMagyar Tudosok korutja 11Budapest1117Hungary+36-70-330-7909balazs.lengyel@ericsson.comHuaweiniuye@huawei.com