--- 1/draft-ietf-netmod-system-mgmt-05.txt 2013-05-02 07:49:47.285891721 +0100 +++ 2/draft-ietf-netmod-system-mgmt-06.txt 2013-05-02 07:49:47.985908615 +0100 @@ -1,19 +1,19 @@ Network Working Group A. Bierman Internet-Draft YumaWorks Intended status: Standards Track M. Bjorklund -Expires: August 29, 2013 Tail-f Systems - February 25, 2013 +Expires: October 23, 2013 Tail-f Systems + April 21, 2013 YANG Data Model for System Management - draft-ietf-netmod-system-mgmt-05 + draft-ietf-netmod-system-mgmt-06 Abstract This document defines a YANG data model for the configuration and identification of the management system of a device. Status of this Memo This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. @@ -21,21 +21,21 @@ 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 http://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 August 29, 2013. + This Internet-Draft will expire on October 23, 2013. Copyright Notice Copyright (c) 2013 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 (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents @@ -56,39 +56,40 @@ 2.2. System Time Management . . . . . . . . . . . . . . . . . . 5 2.3. User Authentication . . . . . . . . . . . . . . . . . . . 5 3. System Data Model . . . . . . . . . . . . . . . . . . . . . . 6 3.1. System Identification . . . . . . . . . . . . . . . . . . 6 3.2. System Time Management . . . . . . . . . . . . . . . . . . 6 3.3. DNS Resolver Model . . . . . . . . . . . . . . . . . . . . 6 3.4. RADIUS Client Model . . . . . . . . . . . . . . . . . . . 7 3.5. User Authentication Model . . . . . . . . . . . . . . . . 7 3.5.1. SSH Public Key Authentication . . . . . . . . . . . . 8 3.5.2. Local User Password Authentication . . . . . . . . . . 8 - 3.5.3. RADIUS Password Authentication . . . . . . . . . . . . 8 + 3.5.3. RADIUS Password Authentication . . . . . . . . . . . . 9 3.6. System Control . . . . . . . . . . . . . . . . . . . . . . 9 4. System YANG module . . . . . . . . . . . . . . . . . . . . . . 10 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 26 6. Security Considerations . . . . . . . . . . . . . . . . . . . 27 7. Change Log . . . . . . . . . . . . . . . . . . . . . . . . . . 29 7.1. 00-01 . . . . . . . . . . . . . . . . . . . . . . . . . . 29 7.2. 01-02 . . . . . . . . . . . . . . . . . . . . . . . . . . 29 7.3. 02-03 . . . . . . . . . . . . . . . . . . . . . . . . . . 29 7.4. 03-04 . . . . . . . . . . . . . . . . . . . . . . . . . . 29 7.5. 04-05 . . . . . . . . . . . . . . . . . . . . . . . . . . 29 - 8. Normative References . . . . . . . . . . . . . . . . . . . . . 30 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 32 + 7.6. 05-06 . . . . . . . . . . . . . . . . . . . . . . . . . . 30 + 8. Normative References . . . . . . . . . . . . . . . . . . . . . 31 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 33 1. Introduction This document defines a YANG [RFC6020] data model for the - configuration and identification of the management system of a - device. + configuration and identification of some common properties within the + management system of a device. Devices that are managed by NETCONF and perhaps other mechanisms have common properties that need to be configured and monitored in a standard way. The "ietf-system" YANG module defined in this document provides the following features: o system administrative data configuration @@ -136,113 +137,120 @@ o Ellipsis ("...") stands for contents of subtrees that are not shown. 2. Objectives 2.1. System Identification There are many common properties used to identify devices, operating systems, software versions, etc. that need to be supported in the system data module. These objects are defined as operational data - and intended to be specific to the device vendor. + and the information returned by the server is intended to be specific + to the device vendor. - Some user-configurable administrative strings are also provided such + Some user-configurable administrative strings are also provided, such as the system location and description. 2.2. System Time Management The management of the date and time used by the system need to be supported. Use of one or more NTP servers to automatically set the system date and time need to be possible. Utilization of the - Timezone database [RFC6557] also need to be supported. + Timezone database [RFC6557] also need to be supported. It should be + possible for the server, as well as clients, to configure the system + to use NTP. 2.3. User Authentication The authentication mechanism need to support password authentication over RADIUS, to support deployment scenarios with centralized authentication servers. Additionally, local users need to be supported, for scenarios when no centralized authentication server exists, or for situations where the centralized authentication server cannot be reached from the device. Since the mandatory transport protocol for NETCONF is SSH [RFC6242] the authentication model need to support SSH's "publickey" and "password" authentication methods [RFC4252]. The model for authentication configuration should be flexible enough to support authentication methods defined by other standard documents - or by vendors. + or by vendors. It should be possible for the server, as well as + clients, to configure the system authentication properties. 3. System Data Model 3.1. System Identification The data model for system identification has the following structure: +--rw system +--rw contact? string - +--rw name? string + +--rw hostname? inet:domain-name +--rw location? string +--ro platform +--ro os-name? string +--ro os-release? string +--ro os-version? string +--ro machine? string - +--ro nodename? string 3.2. System Time Management The data model for system time management has the following structure: +--rw system +--rw clock | +--ro current-datetime? yang:date-and-time | +--ro boot-datetime? yang:date-and-time | +--rw (timezone)? | +--:(timezone-location) | | +--rw timezone-location? string | +--:(timezone-utc-offset) | +--rw timezone-utc-offset? int16 +--rw ntp - +--rw use-ntp? boolean - +--rw ntp-server [address] + +--rw enabled? boolean + +--rw server [address] +--rw association-type? enumeration +--rw address inet:host +--rw enabled? boolean +--rw iburst? boolean +--rw prefer? boolean 3.3. DNS Resolver Model The data model for configuration of the DNS resolver has the following structure: +--rw system +--rw dns - +--rw search* inet:host + +--rw search* inet:domain-name +--rw server* inet:ip-address +--rw options +--rw timeout? uint8 +--rw attempts? uint8 3.4. RADIUS Client Model The data model for configuration of the RADIUS client has the following structure: +--rw system +--rw radius +--rw server [address] | +--rw address inet:host - | +--rw authentication-port? inet:port-number - | +--rw shared-secret? string + | +--rw (transport) + | | +--:(udp) + | | +--rw udp + | | +--rw authentication-port? inet:port-number + | | +--rw shared-secret string + | +--rw authentication-type? identityref +--rw options +--rw timeout? uint8 +--rw attempts? uint8 3.5. User Authentication Model This document defines three authentication methods for use with NETCONF: o publickey for local users over SSH @@ -323,28 +331,29 @@ 3.6. System Control Two protocol operations are included to restart or shutdown the system. The 'system-restart' operation can be used to restart the entire system (not just the NETCONF server). The 'system-shutdown' operation can be used to power off the entire system. 4. System YANG module This YANG module imports YANG extensions from [RFC6536], and imports - YANG types from [RFC6021] and [I-D.lange-netmod-iana-timezones]. It - also references [RFC1321], [RFC2865], [RFC3418], [RFC5607], - [IEEE-1003.1-2008], and [FIPS.180-3.2008]. + YANG types from [I-D.ietf-netmod-rfc6021-bis] and + [I-D.ietf-netmod-iana-timezones]. It also references [RFC1321], + [RFC2865], [RFC3418], [RFC5607], [IEEE-1003.1-2008], and + [FIPS.180-3.2008]. RFC Ed.: update the date below with the date of RFC publication and remove this note. - file "ietf-system@2013-02-25.yang" + file "ietf-system@2013-04-21.yang" module ietf-system { namespace "urn:ietf:params:xml:ns:yang:ietf-system"; prefix "sys"; import ietf-yang-types { prefix yang; } import ietf-inet-types { @@ -376,108 +385,106 @@ Editor: Martin Bjorklund "; description "This module contains a collection of YANG definitions for the configuration and identification of the management system of a device. - Copyright (c) 2012 IETF Trust and the persons identified as + Copyright (c) 2013 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.: replace XXXX with actual RFC number and remove this // note. // RFC Ed.: remove this note - // Note: extracted from draft-ietf-netmod-system-mgmt-05.txt + // Note: extracted from draft-ietf-netmod-system-mgmt-06.txt // RFC Ed.: update the date below with the date of RFC publication // and remove this note. - revision "2013-02-25" { + revision "2013-04-21" { description "Initial revision."; reference "RFC XXXX: A YANG Data Model for System Management"; } /* * Typedefs */ typedef crypt-hash { type string { - pattern "$0$.*|$(1|5|6)$[a-zA-Z0-9./]{2,16}$.*"; + pattern + '$0$.*' + + '|$1$[a-zA-Z0-9./]{1,8}$[a-zA-Z0-9./]{22}' + + '|$5$(rounds=\d+$)?[a-zA-Z0-9./]{1,16}$[a-zA-Z0-9./]{43}' + + '|$6$(rounds=\d+$)?[a-zA-Z0-9./]{1,16}$[a-zA-Z0-9./]{86}'; } description "The crypt-hash type is used to store passwords using - a hash function. This type is implemented in various UNIX - systems as the function crypt(3). - - When a clear text value is set to a leaf of this type, the - server calculates a password hash, and stores the result - in the datastore. Thus, the password is never stored in - clear text. - - When a leaf of this type is read, the stored password hash is - returned. + a hash function. The algorithms for applying the hash + function and encoding the result are implemented in + various UNIX systems as the function crypt(3). A value of this type matches one of the forms: $0$ $$$ + $$$$ The '$0$' prefix signals that the value is clear text. When such a value is received by the server, a hash value is - calculated, and the string '$$$' is prepended to the - result, where is a random 2-16 characters long salt - used to generate the digest. This value is stored in the - configuration data store. + calculated, and the string '$$$' or + $$$$ is prepended to the result. This + value is stored in the configuration data store. - If a value starting with '$$$' is received, the - server knows that the value already represents a hashed value, - and stores it as is in the data store. + If a value starting with '$$', where is not '0', is + received, the server knows that the value already represents a + hashed value, and stores it as is in the data store. When a server needs to verify a password given by a user, it finds the stored password hash string for that user, extracts the salt, and calculates the hash with the salt and given password as input. If the calculated hash value is the same as the stored value, the password given by the client is correct. This type defines the following hash functions: id | hash function | feature ---+---------------+------------------- 1 | MD5 | crypt-hash-md5 5 | SHA-256 | crypt-hash-sha-256 6 | SHA-512 | crypt-hash-sha-512 The server indicates support for the different hash functions by advertising the corresponding feature."; reference "IEEE Std 1003.1-2008 - crypt() function - Wikipedia: http://en.wikipedia.org/wiki/Crypt_(Unix) + Wikipedia: http://en.wikipedia.org/wiki/Crypt_(C) RFC 1321: The MD5 Message-Digest Algorithm FIPS.180-3.2008: Secure Hash Standard"; } + /* * Features */ feature radius { description "Indicates that the device can be configured as a RADIUS client."; reference "RFC 2865: Remote Authentication Dial In User Service " @@ -611,40 +617,36 @@ leaf contact { type string { length "0..255"; } description "The administrator contact information for the system."; reference "RFC 3418 - Management Information Base (MIB) for the Simple Network Management Protocol (SNMP) SNMPv2-MIB.sysContact"; - } - leaf name { - type string { - length "0..255"; } + + leaf hostname { + type inet:domain-name; description - "The administratively assigned system name."; - reference - "RFC 3418 - Management Information Base (MIB) for the - Simple Network Management Protocol (SNMP) - SNMPv2-MIB.sysName"; + "The name of the host. This name can be a single domain + label, or the fully qualified domain name of the host."; } leaf location { type string { length "0..255"; } description - "The system location"; + "The system location."; reference "RFC 3418 - Management Information Base (MIB) for the Simple Network Management Protocol (SNMP) SNMPv2-MIB.sysLocation"; } container platform { config false; description "Contains vendor-specific information for @@ -684,27 +685,20 @@ leaf machine { type string; description "A vendor-specific identifier string representing the hardware in use."; reference "IEEE Std 1003.1-2008 - utsname.machine"; } - leaf nodename { - type string; - description - "The host name of this system."; - reference - "IEEE Std 1003.1-2008 - utsname.nodename"; - } } container clock { description "Configuration and monitoring of the system date and time properties."; leaf current-datetime { type yang:date-and-time; config false; @@ -746,56 +741,58 @@ } } } container ntp { if-feature ntp; description "Configuration of the NTP client."; - leaf use-ntp { + leaf enabled { type boolean; default true; description "Indicates that the system should attempt to synchronize the system clock with an - NTP server from the 'ntp-server' list."; + NTP server from the 'ntp/server' list."; } - list ntp-server { + list server { key address; description "List of NTP servers to use for - system clock synchronization. If 'use-ntp' + system clock synchronization. If '/system/ntp/enabled' is 'true', then the system will attempt to contact and utilize the specified NTP servers."; leaf association-type { type enumeration { enum server { description - "Use server association mode. This device - is not expected to synchronize with the + "Use client association mode. This device + will not provide synchronization to the configured NTP server."; } enum peer { description - "Use peer association mode. This device - may be expected to synchronize with the - configured NTP server."; + "Use symmetric active association mode. + This device may provide synchronization + to the configured NTP server."; } enum pool { description - "Use pool association mode. This device - is not expected to synchronize with the - configured NTP server."; + "Use client association mode with one or + more of the NTP servers found by DNS + resolution of the domain name given by + the 'address' leaf. This device will not + provide synchronization to the servers."; } } default server; description "The desired association type for this NTP server."; } leaf address { type inet:host; description "The IP address or domain name of the NTP server."; @@ -822,21 +819,21 @@ or not."; } } } container dns { description "Configuration of the DNS resolver."; leaf-list search { - type inet:host; + type inet:domain-name; ordered-by user; description "An ordered list of domains to search when resolving a host name."; } leaf-list server { type inet:ip-address; ordered-by user; description "Addresses of the name servers that the resolver should @@ -885,34 +882,51 @@ key address; ordered-by user; description "List of RADIUS servers used by the device."; leaf address { type inet:host; description "The address of the RADIUS server."; } + choice transport { + mandatory true; + description + "The transport protocol specific parameters + for this server. It is expected that new + case statements will be added over time to + support other transport protocols."; + case udp { + container udp { + description + "Contains UDP specific configuration parameters + for RADIUS."; leaf authentication-port { type inet:port-number; default "1812"; description "The port number of the RADIUS server."; } leaf shared-secret { type string; + mandatory true; nacm:default-deny-all; description - "The shared secret which is known to both the RADIUS - client and server."; + "The shared secret which is known to both the + RADIUS client and server."; reference - "RFC 2865: Remote Authentication Dial In User Service"; + "RFC 2865: Remote Authentication Dial In User + Service"; + } + } + } } leaf authentication-type { type identityref { base radius-authentication-type; } default radius-pap; description "The authentication type requested from the RADIUS server."; } @@ -948,25 +962,27 @@ nacm:default-deny-write; if-feature authentication; description "The authentication configuration subtree."; leaf-list user-authentication-order { type identityref { base authentication-method; } - must '(. = "sys:radius" and ../../radius/server) or' - + '(. != "sys:radius")' { + must '(. != "sys:radius" or ../../radius/server)' { error-message - "When 'radius' is used, a radius server" + "When 'radius' is used, a RADIUS server" + " must be configured."; + description + "When 'radius' is used as an authentication method, + a RADIUS server must be configured."; } ordered-by user; description "When the device authenticates a user with a password, it tries the authentication methods in this leaf-list in order. If authentication with one method fails, the next method is used. If no method succeeds, the user is denied access. @@ -1030,32 +1045,32 @@ } } } rpc set-current-datetime { nacm:default-deny-all; description "Set the /system/clock/current-datetime leaf to the specified value. - If the system is using NTP (e.g., /system/ntp/use-ntp + If the system is using NTP (i.e., /system/ntp/enabled is set to 'true'), then this operation will fail with error-tag 'operation-failed', and error-app-tag value of 'ntp-active'"; + input { leaf current-datetime { type yang:date-and-time; mandatory true; description "The current system date and time."; } - } } rpc system-restart { nacm:default-deny-all; description "Request that the entire system be restarted immediately. A server SHOULD send an rpc reply to the client before restarting the system."; } @@ -1186,32 +1201,78 @@ o added radius-authentication-type identity, and identities for pap and chap, and a leaf to control which authentication type to use when communicating with the radius server o made 0 an invalid value for timeouts and attempts 7.5. 04-05 o updated tree diagram explanation text +7.6. 05-06 + + o changed ntp/use-ntp to ntp/enabled + + o changed ntp/ntp-server to ntp/server + + o removed /system/platform/nodename leaf + + o changed /system/name to /system/hostname + + o simplified must expression in user-authentication-order + + o added optional rounds to sha hash definition + + o clarified the crypt-hash description + + o clarified ntp descriptions + + o clarified YANG module description to indicate that some system + properties are supported, not the entire system + + o clarified that system identification values are vendor specific, + not the data node objects + + o clarified sec. 2.2 and 2.3 to indicate that the server should also + be capable of configuring these properties + + o changed /system/dns/search from inet:host to inet:domain-name + + o changed RFC6021 reference to 6021-bis + + o changed /system/platform/nodename to /system/platform/hostname + + o changed /system/radius/server/{leafs} to be within a choice and + 'udp' case statement so other transport specific parameters can + augment this list or they can be added by the WG to a future + version of this module. {leafs} are authentication-port and + shared-secret. + + o updated YANG tree diagrams for objects added in -05 and -06 + 8. Normative References [FIPS.180-3.2008] National Institute of Standards and Technology, "Secure Hash Standard", FIPS PUB 180-3, October 2008, . - [I-D.lange-netmod-iana-timezones] + [I-D.ietf-netmod-iana-timezones] Lange, J., "IANA Timezone Database YANG Module", - draft-lange-netmod-iana-timezones-01 (work in progress), - June 2012. + draft-ietf-netmod-iana-timezones-00 (work in progress), + July 2012. + + [I-D.ietf-netmod-rfc6021-bis] + Schoenwaelder, J., "Common YANG Data Types", + draft-ietf-netmod-rfc6021-bis-01 (work in progress), + March 2013. [IEEE-1003.1-2008] Institute of Electrical and Electronics Engineers, "POSIX.1-2008", IEEE Standard 1003.1, March 2008. [RFC1321] Rivest, R., "The MD5 Message-Digest Algorithm", RFC 1321, April 1992. [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. @@ -1234,23 +1295,20 @@ Transport Layer Protocol", RFC 4253, January 2006. [RFC5607] Nelson, D. and G. Weber, "Remote Authentication Dial-In User Service (RADIUS) Authorization for Network Access Server (NAS) Management", RFC 5607, July 2009. [RFC6020] Bjorklund, M., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, October 2010. - [RFC6021] Schoenwaelder, J., "Common YANG Data Types", RFC 6021, - October 2010. - [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., and A. Bierman, Ed., "Network Configuration Protocol (NETCONF)", RFC 6241, June 2011. [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure Shell (SSH)", RFC 6242, June 2011. [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration Protocol (NETCONF) Access Control Model", RFC 6536, March 2012.