idnits 2.17.1 draft-ietf-dnsop-iana-class-type-yang-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (17 December 2019) is 1591 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Missing Reference: 'RFC6895' is mentioned on line 261, but not defined == Missing Reference: 'RFCXXXX' is mentioned on line 261, but not defined == Missing Reference: 'RFC1035' is mentioned on line 261, but not defined -- Possible downref: Non-RFC (?) normative reference: ref. 'IANA-DNS-PARAMETERS' -- Possible downref: Non-RFC (?) normative reference: ref. 'IANA-YANG-PARAMETERS' Summary: 0 errors (**), 0 flaws (~~), 4 warnings (==), 3 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 DNSOP Working Group L. Lhotka 3 Internet-Draft P. Spacek 4 Intended status: Standards Track CZ.NIC 5 Expires: 19 June 2020 17 December 2019 7 YANG Types for DNS Classes and Resource Record Types 8 draft-ietf-dnsop-iana-class-type-yang-00 10 Abstract 12 This document introduces the YANG module "iana-dns-class-rr-type" 13 that contains derived types reflecting two IANA registries: DNS 14 CLASSes and Resource Record (RR) TYPEs. These YANG types are 15 intended as a minimum basis for future data modeling work. 17 Status of This Memo 19 This Internet-Draft is submitted in full conformance with the 20 provisions of BCP 78 and BCP 79. 22 Internet-Drafts are working documents of the Internet Engineering 23 Task Force (IETF). Note that other groups may also distribute 24 working documents as Internet-Drafts. The list of current Internet- 25 Drafts is at https://datatracker.ietf.org/drafts/current/. 27 Internet-Drafts are draft documents valid for a maximum of six months 28 and may be updated, replaced, or obsoleted by other documents at any 29 time. It is inappropriate to use Internet-Drafts as reference 30 material or to cite them other than as "work in progress." 32 This Internet-Draft will expire on 19 June 2020. 34 Copyright Notice 36 Copyright (c) 2019 IETF Trust and the persons identified as the 37 document authors. All rights reserved. 39 This document is subject to BCP 78 and the IETF Trust's Legal 40 Provisions Relating to IETF Documents (https://trustee.ietf.org/ 41 license-info) in effect on the date of publication of this document. 42 Please review these documents carefully, as they describe your rights 43 and restrictions with respect to this document. Code Components 44 extracted from this document must include Simplified BSD License text 45 as described in Section 4.e of the Trust Legal Provisions and are 46 provided without warranty as described in the Simplified BSD License. 48 Table of Contents 50 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 51 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3 52 3. YANG Design Considerations . . . . . . . . . . . . . . . . . 3 53 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 5 54 4.1. URI Registrations . . . . . . . . . . . . . . . . . . . . 6 55 4.2. YANG Module Registrations . . . . . . . . . . . . . . . . 6 56 5. Security Considerations . . . . . . . . . . . . . . . . . . . 7 57 6. Normative References . . . . . . . . . . . . . . . . . . . . 7 58 7. Informative References . . . . . . . . . . . . . . . . . . . 7 59 Appendix A. XSLT Stylesheet . . . . . . . . . . . . . . . . . . 8 60 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 13 62 1. Introduction 64 YANG [RFC7950] has become a de facto standard as a language for 65 modeling configuration and state data, as well as specifying 66 management operations and asynchronous notifications. It is 67 reasonable to expect that the approach based on utilizing such data 68 models along with standard management protocols such as NETCONF and 69 RESTCONF can be effectively used in DNS operations, too. In fact, 70 several efforts are currently underway that attempt to use NETCONF or 71 RESTCONF for configuring and managing 73 * authoritative servers 75 * resolvers 77 * zone data. 79 While it is possible to use the management protocols mentioned above 80 with ad hoc or proprietary data models, their real potential can be 81 realized only if there is a (completely or partly) unified data model 82 supported by multiple DNS software implementations. Operators can 83 then, for instance, run several different DNS server implementations 84 in parallel, and use a common configuration and management interface 85 and data for all of them. Also, it becomes considerably easier to 86 migrate to another implementation. 88 Based on the previous experience from the IETF Routing Area, it is to 89 be expected that the development of unified data models for DNS will 90 be a lengthy and complicated process that will require active 91 cooperation and compromises from the vendors and developers of major 92 DNS server platforms. Nevertheless, it is likely that any DNS- 93 related data modeling effort will need to use various DNS parameters 94 and enumerations that are specified in several IANA registries. For 95 use with YANG, these parameters and enumerations have to be 96 translated into corresponding YANG types or other structures. Such 97 translations should be straightforward and relatively 98 uncontroversial. 100 This document is a first step in translating DNS-related IANA 101 registries to YANG. It contains the initial revision of the YANG 102 module "iana-dns-class-rr-type" that defines derived types for the 103 common parameters of DNS resource records (RR): class and type. 104 These YANG types, "dns-class" and "rr-type", reflect the IANA 105 registries "DNS CLASSes" and "Resource Record (RR) TYPEs" 106 [IANA-DNS-PARAMETERS]. 108 Appendix A contains an XSLT 1.0 stylesheet that is intended to be 109 used by IANA for generating the initial revision of the "iana-dns- 110 class-rr-type" YANG module. Subsequently, whenever a new class or RR 111 type is added to the above registries, IANA will also update the 112 "iana-dns-class-rr-type" YANG module, following the instructions in 113 Section 4 below. 115 2. Terminology 117 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 118 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 119 document are to be interpreted as described in [RFC2119]. 121 The terminology for describing YANG data models is found in 122 [RFC7950]. 124 3. YANG Design Considerations 126 The IANA document "Domain Name System (DNS) Parameters" 127 [IANA-DNS-PARAMETERS] contains altogether thirteen registries. The 128 YANG module "iana-dns-class-rr-type" defines derived types 129 corresponding to only two of the registries that are essential for 130 data models involving zone data, namely "DNS CLASSes" and "Resource 131 Record (RR) TYPEs". It is expected that the remaining registries in 132 [IANA-DNS-PARAMETERS], as well as other DNS-related IANA registries, 133 will be analogically reflected in future YANG modules as necessary. 134 This way, an appropriate combination of YANG modules can be chosen 135 depending on which YANG types are needed for a given data modeling 136 purpose. 138 The registries "DNS CLASSes" and "Resource Record (RR) TYPEs" are 139 transformed into YANG enumeration types "dns-class-name" and "rr- 140 type-name", respectively. This is the initial fragment of the 141 former: 143 typedef dns-class-name { 144 type enumeration { 145 enum IN { 146 value 1; 147 description 148 "Internet (IN)"; 149 reference 150 "RFC 1035"; 151 } 152 ... 153 } 154 } 156 The other type, "rr-type-name", is exactly analogical. 158 [RFC3597] introduced the option of specifying a class or RR type via 159 its assigned decimal number, as an alternative to the mnemonic name. 160 For example, the "IN" class can be equivalently written as "CLASS1", 161 and "AAAA" type as "TYPE28". 163 Accordingly, the derived types "dns-class" and "rr-type" are defined 164 in the YANG module as a union of two member types: 166 * 16-bit decimal integer ("uint16") 168 * mnemonic name belonging to the enumerations "dns-class-name" and 169 "rr-type-name", respectively. 171 For instance, the "rr-type" type is defined as follows: 173 typedef rr-type { 174 type union { 175 type uint16; 176 type rr-type-name; 177 } 178 description 179 "This type allows for referring to a DNS resource record type 180 using either the assigned mnemonic name or numeric value."; 181 } 182 } 184 As unassigned and reserved class and RR type values are not included 185 in the mnemonic name enumerations, they can be used only via their 186 decimal codes. 188 4. IANA Considerations 190 RFC Editor: In this section, replace all occurrences of "XXXX" with 191 the actual RFC number (and remove this note). 193 This section deals with actions and processes necessary for IANA to 194 undertake to maintain the "iana-dns-class-rr-type" YANG module. This 195 YANG module is intended to reflect the "DNS CLASSes" and "Resource 196 Record (RR) TYPEs" registries in [IANA-DNS-PARAMETERS]. The most 197 recent revision of the YANG module is available from the "YANG 198 Parameters" registry [IANA-YANG-PARAMETERS]. 200 Upon publication of this document, the initial revision of the "iana- 201 dns-class-rr-type" YANG module SHALL be created by applying the XSLT 202 stylesheet from Appendix A to the XML version of 203 [IANA-DNS-PARAMETERS]. 205 IANA SHALL add this note to the "iana-dns-class-rr-type" item of the 206 "YANG Module Names" registry [IANA-YANG-PARAMETERS]: 208 | Classes and types of DNS resource records must not be directly 209 | added to the "iana-dns-class-rr-type" YANG module. They must 210 | instead be added to the "DNS CLASSes" and "Resource Record (RR) 211 | TYPEs" registries, respectively. 213 When a new DNS class or RR type is added to the "DNS CLASSes" or 214 "Resource Record (RR) TYPEs" registry, a new "enum" statement SHALL 215 be added to the "dns-class-name" or "rr-type-name" type, 216 respectively. The assigned name defined by the "enum" statement 217 SHALL be the same as the mnemonic name of the new class or type. The 218 following substatements to the "enum" statement SHALL be defined: 220 "value": Use the decimal value from the registry. 222 "status": Include only if a class or type registration has been 223 deprecated or obsoleted. In both cases, use the value "obsolete" 224 as the argument of the "status" statement. 226 "description": Replicate the corresponding information from the 227 registry, namely the full name of the new DNS class, or the 228 meaning of the new RR type, if any. 230 "reference": Replicate the reference(s) from the registry. 232 Unassigned or reserved values SHALL NOT be included in the "dns- 233 class-name" and "rr-type-name" enumeration types. 235 Each time the "iana-dns-class-rr-type" YANG module is updated, a new 236 "revision" statement SHALL be added before the existing "revision" 237 statements. 239 IANA SHALL add this new note to the "DNS CLASSes" and "Resource 240 Record (RR) TYPEs" registries: 242 | When this registry is modified, the YANG module "iana-dns-class- 243 | rr-type" must be updated as defined in RFC XXXX. 245 The "Reference" text in the "DNS CLASSes" registry SHALL be updated 246 as follows: 248 | OLD: 249 | [RFC6895] 250 | 251 | NEW: 252 | [RFC6895][RFCXXXX] 254 The "Reference" text in the "Resource Record (RR) TYPEs" registry 255 SHALL be updated as follows: 257 | OLD: 258 | [RFC6895][RFC1035] 259 | 260 | NEW: 261 | [RFC6895][RFC1035][RFCXXXX] 263 4.1. URI Registrations 265 This document registers a URI in the "IETF XML Registry" [RFC3688]. 266 The following registration has been made: 268 | URI: urn:ietf:params:xml:ns:yang:iana-dns-class-rr-type 269 | Registrant Contact: The IESG. 270 | XML: N/A, the requested URI is an XML namespace. 272 4.2. YANG Module Registrations 274 This document registers a YANG module in the "YANG Module Names" 275 registry [RFC6020]. The following registration has been made: 277 | name: iana-dns-class-rr-type 278 | namespace: urn:ietf:params:xml:ns:yang:iana-dns-class-rr-type 279 | prefix: dnsct 280 | reference: RFC XXXX 282 5. Security Considerations 284 This documents translates two IANA registries into YANG data types 285 and otherwise introduces no technology or protocol. Consequently, 286 there are no security issues to be considered for this document. 288 6. Normative References 290 [IANA-DNS-PARAMETERS] 291 Internet Assigned Numbers Authority, "Domain Name System 292 (DNS) Parameters", 293 . 295 [IANA-YANG-PARAMETERS] 296 Internet Assigned Numbers Authority, "YANG Parameters", 297 . 299 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 300 Requirement Levels", BCP 14, RFC 2119, 301 DOI 10.17487/RFC2119, March 1997, 302 . 304 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 305 DOI 10.17487/RFC3688, January 2004, 306 . 308 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for 309 the Network Configuration Protocol (NETCONF)", RFC 6020, 310 DOI 10.17487/RFC6020, October 2010, 311 . 313 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 314 RFC 7950, DOI 10.17487/RFC7950, August 2016, 315 . 317 [W3C.REC-xslt-19991116] 318 Clark, J., "XSL Transformations (XSLT) Version 1.0", World 319 Wide Web Consortium Recommendation REC-xslt-19991116, 16 320 November 1999, 321 . 323 7. Informative References 325 [RFC3597] Gustafsson, A., "Handling of Unknown DNS Resource Record 326 (RR) Types", RFC 3597, DOI 10.17487/RFC3597, September 327 2003, . 329 Appendix A. XSLT Stylesheet 331 RFC Editor: In this section, replace all occurrences of "XXXX" with 332 the actual RFC number (and remove this note). 334 This appendix contains an XSLT 1.0 stylesheet [W3C.REC-xslt-19991116] 335 that is intended to be used for generating the initial revision of 336 the "iana-dns-class-rr-type" YANG module. This is achieved by 337 applying the stylesheet to the XML version of the IANA registry 338 "Domain Name System (DNS) Parameters" [IANA-DNS-PARAMETERS] that was 339 current at the time when this document was published. 341 Using the ubiquitous xsltproc tool, the YANG module text can be 342 generated with this command: 344 $ xsltproc iana-dns-class-rr-type.xsl dns-parameters.xml 346 file "iana-dns-class-rr-type.xsl" 347 348 351 352 354 " 355 ' 356 358 359 module iana-dns-class-rr-type { 361 yang-version 1.1; 363 namespace "urn:ietf:params:xml:ns:yang:iana-dns-class-rr-type"; 365 prefix dnsct; 367 organization 368 "Internet Assigned Numbers Authority (IANA)"; 370 contact 371 " Internet Assigned Numbers Authority 373 Postal: ICANN 374 4676 Admiralty Way, Suite 330 375 Marina del Rey, CA 90292 377 Tel: +1 310 823 9358 379 <mailto:iana@iana.org>"; 381 description 382 "This YANG module translates IANA registries 'DNS CLASSes' and 383 'Resource Record (RR) TYPEs' to YANG derived types. 385 Copyright (c) 2019 IETF Trust and the persons identified as 386 authors of the code. All rights reserved. 388 Redistribution and use in source and binary forms, with or 389 without modification, is permitted pursuant to, and subject to 390 the license terms contained in, the Simplified BSD License set 391 forth in Section 4.c of the IETF Trust's Legal Provisions 392 Relating to IETF Documents 393 (https://trustee.ietf.org/license-info). 395 This initial version of this YANG module was generated from 396 the corresponding IANA registries using a XSLT stylesheet 397 from Appendix A of RFC XXXX 398 (https://tools.ietf.org/html/rfcXXXX); see the RFC itself for 399 full legal notices."; 401 reference 402 "IANA 'Domain Name System (DNS) Parameters' registry 403 https://www.iana.org/assignments/dns-parameters"; 404 405 407 424 430 438 451 477 505 523 529 534 562 566 567 569 Authors' Addresses 571 Ladislav Lhotka 572 CZ.NIC 574 Email: lhotka@nic.cz 576 Petr Spacek 577 CZ.NIC 579 Email: petr.spacek@nic.cz