idnits 2.17.1 draft-ietf-dnsop-iana-class-type-yang-03.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 (24 May 2021) is 1066 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 264, but not defined == Missing Reference: 'RFCXXXX' is mentioned on line 264, but not defined == Missing Reference: 'RFC1035' is mentioned on line 264, 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 CZ.NIC 4 Intended status: Standards Track P. Spacek 5 Expires: 25 November 2021 Internet Systems Consortium 6 24 May 2021 8 YANG Types for DNS Classes and Resource Record Types 9 draft-ietf-dnsop-iana-class-type-yang-03 11 Abstract 13 This document introduces the YANG module "iana-dns-class-rr-type" 14 that contains derived types reflecting two IANA registries: DNS 15 CLASSes and Resource Record (RR) TYPEs. These YANG types are 16 intended as a minimum basis for future data modeling work. 18 Status of This Memo 20 This Internet-Draft is submitted in full conformance with the 21 provisions of BCP 78 and BCP 79. 23 Internet-Drafts are working documents of the Internet Engineering 24 Task Force (IETF). Note that other groups may also distribute 25 working documents as Internet-Drafts. The list of current Internet- 26 Drafts is at https://datatracker.ietf.org/drafts/current/. 28 Internet-Drafts are draft documents valid for a maximum of six months 29 and may be updated, replaced, or obsoleted by other documents at any 30 time. It is inappropriate to use Internet-Drafts as reference 31 material or to cite them other than as "work in progress." 33 This Internet-Draft will expire on 25 November 2021. 35 Copyright Notice 37 Copyright (c) 2021 IETF Trust and the persons identified as the 38 document authors. All rights reserved. 40 This document is subject to BCP 78 and the IETF Trust's Legal 41 Provisions Relating to IETF Documents (https://trustee.ietf.org/ 42 license-info) in effect on the date of publication of this document. 43 Please review these documents carefully, as they describe your rights 44 and restrictions with respect to this document. Code Components 45 extracted from this document must include Simplified BSD License text 46 as described in Section 4.e of the Trust Legal Provisions and are 47 provided without warranty as described in the Simplified BSD License. 49 Table of Contents 51 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 52 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3 53 3. YANG Design Considerations . . . . . . . . . . . . . . . . . 3 54 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 5 55 4.1. URI Registrations . . . . . . . . . . . . . . . . . . . . 6 56 4.2. YANG Module Registrations . . . . . . . . . . . . . . . . 6 57 5. Security Considerations . . . . . . . . . . . . . . . . . . . 7 58 6. Normative References . . . . . . . . . . . . . . . . . . . . 7 59 7. Informative References . . . . . . . . . . . . . . . . . . . 7 60 Appendix A. XSLT Stylesheet . . . . . . . . . . . . . . . . . . 8 61 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 13 63 1. Introduction 65 YANG [RFC7950] has become a de facto standard as a language for 66 modeling configuration and state data, as well as specifying 67 management operations and asynchronous notifications. It is 68 reasonable to expect that the approach based on utilizing such data 69 models along with standard management protocols such as NETCONF and 70 RESTCONF can be effectively used in DNS operations, too. In fact, 71 several efforts are currently underway that attempt to use NETCONF or 72 RESTCONF for configuring and managing 74 * authoritative servers 76 * resolvers 78 * zone data. 80 While it is possible to use the management protocols mentioned above 81 with ad hoc or proprietary data models, their real potential can be 82 realized only if there is a (completely or partly) unified data model 83 supported by multiple DNS software implementations. Operators can 84 then, for instance, run several different DNS server implementations 85 in parallel, and use a common configuration and management interface 86 and data for all of them. Also, it becomes considerably easier to 87 migrate to another implementation. 89 Based on the previous experience from the IETF Routing Area, it is to 90 be expected that the development of unified data models for DNS will 91 be a lengthy and complicated process that will require active 92 cooperation and compromises from the vendors and developers of major 93 DNS server platforms. Nevertheless, it is likely that any DNS- 94 related data modeling effort will need to use various DNS parameters 95 and enumerations that are specified in several IANA registries. For 96 use with YANG, these parameters and enumerations have to be 97 translated into corresponding YANG types or other structures. Such 98 translations should be straightforward and relatively 99 uncontroversial. 101 This document provides a translation of two fundamental DNS-related 102 IANA registries to YANG. It contains the initial revision of the 103 YANG module "iana-dns-class-rr-type" that defines derived types for 104 the common parameters of DNS resource records (RR): class and type. 105 These YANG types, "dns-class" and "rr-type", reflect the IANA 106 registries "DNS CLASSes" and "Resource Record (RR) TYPEs" 107 [IANA-DNS-PARAMETERS]. 109 Appendix A contains an XSLT 1.0 stylesheet that is intended to be 110 used by IANA for generating the initial revision of the "iana-dns- 111 class-rr-type" YANG module. Subsequently, whenever a new class or RR 112 type is added to the above registries, IANA will also update the 113 "iana-dns-class-rr-type" YANG module, following the instructions in 114 Section 4 below. 116 2. Terminology 118 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 119 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 120 "OPTIONAL" in this document are to be interpreted as described in 121 BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all 122 capitals, as shown here. 124 The terminology for describing YANG data models is found in 125 [RFC7950]. 127 3. YANG Design Considerations 129 The IANA document "Domain Name System (DNS) Parameters" 130 [IANA-DNS-PARAMETERS] contains altogether thirteen registries. The 131 YANG module "iana-dns-class-rr-type" defines derived types 132 corresponding to only two of the registries that are essential for 133 data models involving zone data, namely "DNS CLASSes" and "Resource 134 Record (RR) TYPEs". It is expected that the remaining registries in 135 [IANA-DNS-PARAMETERS], as well as other DNS-related IANA registries, 136 will be analogically reflected in future YANG modules as necessary. 137 This way, an appropriate combination of YANG modules can be chosen 138 depending on which YANG types are needed for a given data modeling 139 purpose. 141 The registries "DNS CLASSes" and "Resource Record (RR) TYPEs" are 142 transformed into YANG enumeration types "dns-class-name" and "rr- 143 type-name", respectively. This is the initial fragment of the 144 former: 146 typedef dns-class-name { 147 type enumeration { 148 enum IN { 149 value 1; 150 description 151 "Internet (IN)"; 152 reference 153 "RFC 1035"; 154 } 155 ... 156 } 157 ... 158 } 160 The other derived type, "rr-type-name", is defined analogically. 162 [RFC3597] introduced the option of specifying a class or RR type via 163 its assigned decimal number, as an alternative to the mnemonic name. 164 For example, the "IN" class can be equivalently written as "CLASS1", 165 and "AAAA" type can be written as "TYPE28". 167 Accordingly, the derived types "dns-class" and "rr-type" are defined 168 in the YANG module as a union of two member types: 170 * 16-bit decimal integer ("uint16") 172 * mnemonic name belonging to the enumerations "dns-class-name" and 173 "rr-type-name", respectively. 175 For instance, the "rr-type" type is defined as follows: 177 typedef rr-type { 178 type union { 179 type uint16; 180 type rr-type-name; 181 } 182 description 183 "This type allows for referring to a DNS resource record type 184 using either the assigned mnemonic name or numeric value."; 185 } 187 As unassigned and reserved class and RR type values are not included 188 in the mnemonic name enumerations, they can only be specified using 189 their decimal values. 191 4. IANA Considerations 193 RFC Editor: In this section, replace all occurrences of "XXXX" with 194 the actual RFC number (and remove this note). 196 This section deals with actions and processes necessary for IANA to 197 undertake to maintain the "iana-dns-class-rr-type" YANG module. This 198 YANG module is intended to reflect the "DNS CLASSes" and "Resource 199 Record (RR) TYPEs" registries in [IANA-DNS-PARAMETERS]. The most 200 recent revision of the YANG module is available from the "YANG 201 Parameters" registry [IANA-YANG-PARAMETERS]. 203 Upon publication of this document, the initial revision of the "iana- 204 dns-class-rr-type" YANG module SHALL be created by applying the XSLT 205 stylesheet from Appendix A to the XML version of 206 [IANA-DNS-PARAMETERS]. 208 IANA SHALL add this note to the "iana-dns-class-rr-type" item of the 209 "YANG Module Names" registry [IANA-YANG-PARAMETERS]: 211 | Classes and types of DNS resource records must not be directly 212 | added to the "iana-dns-class-rr-type" YANG module. They must 213 | instead be added to the "DNS CLASSes" and "Resource Record (RR) 214 | TYPEs" registries, respectively. 216 When a new DNS class or RR type is added to the "DNS CLASSes" or 217 "Resource Record (RR) TYPEs" registry, a new "enum" statement SHALL 218 be added to the "dns-class-name" or "rr-type-name" type, 219 respectively. The assigned name defined by the "enum" statement 220 SHALL be the same as the mnemonic name of the new class or type. The 221 following substatements to the "enum" statement SHALL be defined: 223 "value": Use the decimal value from the registry. 225 "status": Include only if a class or type registration has been 226 deprecated or obsoleted. In both cases, use the value "obsolete" 227 as the argument of the "status" statement. 229 "description": Replicate the corresponding information from the 230 registry, namely the full name of the new DNS class, or the 231 meaning of the new RR type, if any. 233 "reference": Replicate the reference(s) from the registry. 235 Unassigned or reserved values SHALL NOT be included in the "dns- 236 class-name" and "rr-type-name" enumeration types. 238 Each time the "iana-dns-class-rr-type" YANG module is updated, a new 239 "revision" statement SHALL be added before the existing "revision" 240 statements. 242 IANA SHALL add this new note to the "DNS CLASSes" and "Resource 243 Record (RR) TYPEs" registries: 245 | When this registry is modified, the YANG module "iana-dns-class- 246 | rr-type" must be updated as defined in RFC XXXX. 248 The "Reference" text in the "DNS CLASSes" registry SHALL be updated 249 as follows: 251 | OLD: 252 | [RFC6895] 253 | 254 | NEW: 255 | [RFC6895][RFCXXXX] 257 The "Reference" text in the "Resource Record (RR) TYPEs" registry 258 SHALL be updated as follows: 260 | OLD: 261 | [RFC6895][RFC1035] 262 | 263 | NEW: 264 | [RFC6895][RFC1035][RFCXXXX] 266 4.1. URI Registrations 268 This document registers a URI in the "IETF XML Registry" [RFC3688]. 269 The following registration has been made: 271 | URI: urn:ietf:params:xml:ns:yang:iana-dns-class-rr-type 272 | Registrant Contact: The IESG. 273 | XML: N/A, the requested URI is an XML namespace. 275 4.2. YANG Module Registrations 277 This document registers a YANG module in the "YANG Module Names" 278 registry [RFC6020]. The following registration has been made: 280 | name: iana-dns-class-rr-type 281 | namespace: urn:ietf:params:xml:ns:yang:iana-dns-class-rr-type 282 | prefix: dnsct 283 | reference: RFC XXXX 285 5. Security Considerations 287 This documents translates two IANA registries into YANG data types 288 and otherwise introduces no technology or protocol. Consequently, 289 there are no security issues to be considered for this document. 291 6. Normative References 293 [IANA-DNS-PARAMETERS] 294 Internet Assigned Numbers Authority, "Domain Name System 295 (DNS) Parameters", 296 . 298 [IANA-YANG-PARAMETERS] 299 Internet Assigned Numbers Authority, "YANG Parameters", 300 . 302 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 303 Requirement Levels", BCP 14, RFC 2119, 304 DOI 10.17487/RFC2119, March 1997, 305 . 307 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 308 DOI 10.17487/RFC3688, January 2004, 309 . 311 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for 312 the Network Configuration Protocol (NETCONF)", RFC 6020, 313 DOI 10.17487/RFC6020, October 2010, 314 . 316 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 317 RFC 7950, DOI 10.17487/RFC7950, August 2016, 318 . 320 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 321 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 322 May 2017, . 324 [W3C.REC-xslt-19991116] 325 Clark, J., "XSL Transformations (XSLT) Version 1.0", World 326 Wide Web Consortium Recommendation REC-xslt-19991116, 16 327 November 1999, 328 . 330 7. Informative References 332 [RFC3597] Gustafsson, A., "Handling of Unknown DNS Resource Record 333 (RR) Types", RFC 3597, DOI 10.17487/RFC3597, September 334 2003, . 336 Appendix A. XSLT Stylesheet 338 RFC Editor: In this section, replace all occurrences of "XXXX" with 339 the actual RFC number (and remove this note). 341 This appendix contains an XSLT 1.0 stylesheet [W3C.REC-xslt-19991116] 342 that is intended to be used for generating the initial revision of 343 the "iana-dns-class-rr-type" YANG module. This is achieved by 344 applying the stylesheet to the XML version of the IANA registry 345 "Domain Name System (DNS) Parameters" [IANA-DNS-PARAMETERS] that was 346 current at the time when this document was published. 348 Using the ubiquitous xsltproc tool, the YANG module text can be 349 generated with this command: 351 $ xsltproc iana-dns-class-rr-type.xsl dns-parameters.xml 353 file "iana-dns-class-rr-type.xsl" 354 355 358 359 361 " 362 ' 363 365 366 module iana-dns-class-rr-type { 367 yang-version 1.1; 368 namespace "urn:ietf:params:xml:ns:yang:iana-dns-class-rr-type"; 369 prefix dnsct; 371 organization 372 "Internet Assigned Numbers Authority (IANA)"; 374 contact 375 " Internet Assigned Numbers Authority 377 Postal: ICANN 378 4676 Admiralty Way, Suite 330 379 Marina del Rey, CA 90292 381 Tel: +1 310 823 9358 383 <mailto:iana@iana.org>"; 385 description 386 "This YANG module translates IANA registries 'DNS CLASSes' and 387 'Resource Record (RR) TYPEs' to YANG derived types. 389 Copyright (c) 2020 IETF Trust and the persons identified as 390 authors of the code. All rights reserved. 392 Redistribution and use in source and binary forms, with or 393 without modification, is permitted pursuant to, and subject to 394 the license terms contained in, the Simplified BSD License set 395 forth in Section 4.c of the IETF Trust's Legal Provisions 396 Relating to IETF Documents 397 (https://trustee.ietf.org/license-info). 399 This initial version of this YANG module was generated from 400 the corresponding IANA registries using a XSLT stylesheet 401 from Appendix A of RFC XXXX 402 (https://tools.ietf.org/html/rfcXXXX); see the RFC itself for 403 full legal notices."; 405 reference 406 "IANA 'Domain Name System (DNS) Parameters' registry 407 https://www.iana.org/assignments/dns-parameters"; 408 409 411 428 434 442 455 481 509 527 533 538 566 570 571 573 Authors' Addresses 575 Ladislav Lhotka 576 CZ.NIC 577 Czech Republic 579 Email: ladislav.lhotka@nic.cz 581 Petr Spacek 582 Internet Systems Consortium 583 Czech Republic 585 Email: pspacek@isc.org