idnits 2.17.1 draft-ietf-softwire-iftunnel-01.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 == Line 274 has weird spacing: '...dentity aplus...' -- The document date (December 13, 2018) is 1962 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: 'RFC XXXX' is mentioned on line 346, but not defined -- Possible downref: Non-RFC (?) normative reference: ref. 'TUNNELTYPE-IANA-REGISTRY' == Outdated reference: A later version (-16) exists of draft-ietf-softwire-yang-12 Summary: 0 errors (**), 0 flaws (~~), 4 warnings (==), 2 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Softwire Working Group M. Boucadair 3 Internet-Draft Orange 4 Intended status: Standards Track I. Farrer 5 Expires: June 16, 2019 Deutsche Telekom AG 6 R. Asati 7 Cisco Systems, Inc. 8 December 13, 2018 10 Tunnel Interface Types YANG Module 11 draft-ietf-softwire-iftunnel-01 13 Abstract 15 This document specifies a YANG module containing a collection of IANA 16 maintained YANG identities, used as interface types for tunnel 17 interfaces. 19 Editorial Note (To be removed by RFC Editor) 21 Please update these statements in the document with the RFC number to 22 be assigned to this document: 24 o "This version of this YANG module is part of RFC XXXX;" 26 o "RFC XXXX: Tunnel Interface Types YANG Module"; 28 o "reference: RFC XXXX" 30 Please update the "revision" date of the YANG module. 32 Status of This Memo 34 This Internet-Draft is submitted in full conformance with the 35 provisions of BCP 78 and BCP 79. 37 Internet-Drafts are working documents of the Internet Engineering 38 Task Force (IETF). Note that other groups may also distribute 39 working documents as Internet-Drafts. The list of current Internet- 40 Drafts is at https://datatracker.ietf.org/drafts/current/. 42 Internet-Drafts are draft documents valid for a maximum of six months 43 and may be updated, replaced, or obsoleted by other documents at any 44 time. It is inappropriate to use Internet-Drafts as reference 45 material or to cite them other than as "work in progress." 47 This Internet-Draft will expire on June 16, 2019. 49 Copyright Notice 51 Copyright (c) 2018 IETF Trust and the persons identified as the 52 document authors. All rights reserved. 54 This document is subject to BCP 78 and the IETF Trust's Legal 55 Provisions Relating to IETF Documents 56 (https://trustee.ietf.org/license-info) in effect on the date of 57 publication of this document. Please review these documents 58 carefully, as they describe your rights and restrictions with respect 59 to this document. Code Components extracted from this document must 60 include Simplified BSD License text as described in Section 4.e of 61 the Trust Legal Provisions and are provided without warranty as 62 described in the Simplified BSD License. 64 Table of Contents 66 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 67 2. IANA Tunnel Type YANG Module . . . . . . . . . . . . . . . . 3 68 3. Security Considerations . . . . . . . . . . . . . . . . . . . 7 69 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7 70 5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 8 71 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 8 72 6.1. Normative References . . . . . . . . . . . . . . . . . . 8 73 6.2. Informative References . . . . . . . . . . . . . . . . . 9 74 Appendix A. Example Usage . . . . . . . . . . . . . . . . . . . 10 75 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 12 77 1. Introduction 79 This document specifies the initial version of the iana-tunnel-type 80 YANG module identifying tunnel interface types. The module reflects 81 IANA's registry maintained at [TUNNELTYPE-IANA-REGISTRY]. The latest 82 revision of this module can be obtained from the IANA web site. 84 Tunnel-specific extensions may be added to the Interface module 85 [RFC8343] as a function of the tunnel type. An example of this is 86 provided in Appendix A. It is not the intention of this document to 87 define tunnel-specific extensions for every tunnel encapsulation 88 technology; those are discussed in dedicated documents such as 89 [I-D.ietf-softwire-yang]. 91 This document uses the common YANG types defined in [RFC6991] and 92 adopts the Network Management Datastore Architecture (NMDA 93 [RFC8342]). 95 The terminology for describing YANG modules is defined in [RFC7950]. 96 The meanings of the symbols used in tree diagrams are defined in 97 [RFC8340]. 99 2. IANA Tunnel Type YANG Module 101 The iana-tunnel-type module imports the 'iana-if-type' module defined 102 in [RFC7224]. 104 The initial version of the module includes tunnels types defined in 105 [RFC4087], [RFC7856], [RFC7870], and [RFC6346]. 107 file "iana-tunnel-type@2018-12-14.yang" 109 module iana-tunnel-type { 110 yang-version 1.1; 111 namespace "urn:ietf:params:xml:ns:yang:iana-tunnel-type"; 112 prefix iana-tunnel-type; 114 import iana-if-type { 115 prefix ift; 116 reference 117 "RFC 7224: IANA Interface Type YANG Module"; 118 } 120 organization 121 "IANA"; 122 contact 123 "Internet Assigned Numbers Authority 125 Postal: ICANN 126 12025 Waterfront Drive, Suite 300 127 Los Angeles, CA 90094-2536 128 United States of America 129 Tel: +1 310 301 5800 130 "; 132 description 133 "This module contains a collection of YANG identities defined 134 by IANA and used as interface types for tunnel interfaces. 136 Copyright (c) 2018 IETF Trust and the persons identified as 137 authors of the code. All rights reserved. 139 Redistribution and use in source and binary forms, with or 140 without modification, is permitted pursuant to, and subject 141 to the license terms contained in, the Simplified BSD License 142 set forth in Section 4.c of the IETF Trust's Legal Provisions 143 Relating to IETF Documents 144 (http://trustee.ietf.org/license-info). 146 This version of this YANG module is part of RFC XXXX; see 147 the RFC itself for full legal notices."; 149 revision 2018-12-14 { 150 description 151 "Initial revision."; 152 reference 153 "RFC XXXX: Tunnel Interface Types YANG Module"; 154 } 155 identity other { 156 base ift:tunnel; 157 description 158 "None of the following values."; 159 reference 160 "RFC 4087: IP Tunnel MIB"; 161 } 162 identity direct { 163 base ift:tunnel; 164 description 165 "No intermediate header."; 166 reference 167 "RFC 4087: IP Tunnel MIB"; 168 } 169 identity gre { 170 base ift:tunnel; 171 description 172 "GRE encapsulation."; 173 reference 174 "RFC 4087: IP Tunnel MIB"; 175 } 176 identity minimal { 177 base ift:tunnel; 178 description 179 "Minimal encapsulation."; 180 reference 181 "RFC 4087: IP Tunnel MIB"; 182 } 183 identity l2tp { 184 base ift:tunnel; 185 description 186 "L2TP encapsulation."; 187 reference 188 "RFC 4087: IP Tunnel MIB"; 189 } 190 identity pptp { 191 base ift:tunnel; 192 description 193 "PPTP encapsulation."; 194 reference 195 "RFC 4087: IP Tunnel MIB"; 196 } 197 identity l2f { 198 base ift:tunnel; 199 description 200 "L2F encapsulation."; 201 reference 202 "RFC 4087: IP Tunnel MIB"; 203 } 204 identity udp { 205 base ift:tunnel; 206 description 207 "UDP encapsulation."; 208 reference 209 "RFC 4087: IP Tunnel MIB"; 210 } 211 identity atmp { 212 base ift:tunnel; 213 description 214 "ATMP encapsulation."; 215 reference 216 "RFC 4087: IP Tunnel MIB"; 217 } 218 identity msdp { 219 base ift:tunnel; 220 description 221 "MSDP encapsulation."; 222 reference 223 "RFC 4087: IP Tunnel MIB"; 224 } 225 identity sixtofour { 226 base ift:tunnel; 227 description 228 "6to4 encapsulation."; 229 reference 230 "RFC 4087: IP Tunnel MIB"; 231 } 232 identity sixoverfour { 233 base ift:tunnel; 234 description 235 "6over4 encapsulation."; 236 reference 237 "RFC 4087: IP Tunnel MIB"; 238 } 239 identity isatap { 240 base ift:tunnel; 241 description 242 "ISATAP encapsulation."; 243 reference 244 "RFC 4087: IP Tunnel MIB"; 245 } 246 identity teredo { 247 base ift:tunnel; 248 description 249 "Teredo encapsulation."; 250 reference 251 "RFC 4087: IP Tunnel MIB"; 252 } 253 identity iphttps { 254 base ift:tunnel; 255 description 256 "IP over HTTPS (IP-HTTPS) Tunneling Protocol."; 257 } 258 identity softwiremesh { 259 base ift:tunnel; 260 description 261 "softwire mesh tunnel."; 262 reference 263 "RFC 7856: Softwire Mesh Management Information Base (MIB)"; 264 } 265 identity dslite { 266 base ift:tunnel; 267 description 268 "DS-Lite tunnel."; 269 reference 270 "RFC 7870: Dual-Stack Lite (DS-Lite) Management Information 271 Base (MIB) for Address Family Transition Routers 272 (AFTRs)"; 273 } 274 identity aplusp { 275 base ift:tunnel; 276 description 277 "A+P encapsulation."; 278 reference 279 "RFC 6346: The Address plus Port (A+P) Approach to the IPv4 280 Address Shortage"; 281 } 282 } 283 285 3. Security Considerations 287 The YANG module defined in this document is designed to be accessed 288 via network management protocols such as NETCONF [RFC6241] or 289 RESTCONF [RFC8040]. The lowest NETCONF layer is the secure transport 290 layer, and the mandatory-to-implement secure transport is Secure 291 Shell (SSH) [RFC6242]. The lowest RESTCONF layer is HTTPS, and the 292 mandatory-to-implement secure transport is TLS [RFC8446]. 294 The NETCONF access control model [RFC8341] provides the means to 295 restrict access for particular NETCONF or RESTCONF users to a 296 preconfigured subset of all available NETCONF or RESTCONF protocol 297 operations and content. 299 4. IANA Considerations 301 This document requests IANA to register the following URI in the 302 "IETF XML Registry" [RFC3688]: 304 URI: urn:ietf:params:xml:ns:yang:iana-tunnel-type 305 Registrant Contact: IANA. 306 XML: N/A; the requested URI is an XML namespace. 308 This document requests IANA to register the following YANG module in 309 the "YANG Module Names" registry [RFC7950]. 311 name: iana-tunnel-type 312 namespace: urn:ietf:params:xml:ns:yang:iana-tunnel-type 313 prefix: iana-tunnel-type 314 reference: RFC XXXX 316 This document defines the initial version of the IANA-maintained 317 iana-tunnel-type YANG module. IANA is requested to add this note: 319 Tunnel type values must not be directly added to the iana-tunnel- 320 type YANG module. They must instead be respectively added to the 321 "tunnelType" sub-registry (under "ifType definitions" registry). 323 When a tunnel type is added to the "tunnelType" sub-registry, a new 324 "identity" statement must be added to the iana-tunnel-type YANG 325 module. The name of the "identity" is the same as the corresponding 326 enumeration in the IANAifType-MIB (i.e., IANAtunnelType). The 327 "identity" statement should have the following sub-statements 328 defined: 330 "base": Contains the name assigned to the tunnel type, in 331 lowercase. 333 "description": Replicate the description from the registry. 335 "reference": Replicate the reference from the registry and add the 336 title of the document. 338 Unassigned or reserved values are not present in the module. 340 When the iana-tunnel-type YANG module is updated, a new "revision" 341 statement must be added in front of the existing revision statements. 343 IANA is requested to add this note to "tunnelType" sub-registry: 345 When this registry is modified, the YANG module iana-tunnel-type 346 must be updated as defined in [RFC XXXX]. 348 5. Acknowledgements 350 Special thanks to Tom Petch and Martin Bjorklund for the detailed 351 review and suggestions. 353 6. References 355 6.1. Normative References 357 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 358 DOI 10.17487/RFC3688, January 2004, 359 . 361 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., 362 and A. Bierman, Ed., "Network Configuration Protocol 363 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, 364 . 366 [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure 367 Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, 368 . 370 [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", 371 RFC 6991, DOI 10.17487/RFC6991, July 2013, 372 . 374 [RFC7224] Bjorklund, M., "IANA Interface Type YANG Module", 375 RFC 7224, DOI 10.17487/RFC7224, May 2014, 376 . 378 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 379 RFC 7950, DOI 10.17487/RFC7950, August 2016, 380 . 382 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF 383 Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, 384 . 386 [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration 387 Access Control Model", STD 91, RFC 8341, 388 DOI 10.17487/RFC8341, March 2018, 389 . 391 [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., 392 and R. Wilton, "Network Management Datastore Architecture 393 (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, 394 . 396 [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol 397 Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, 398 . 400 [TUNNELTYPE-IANA-REGISTRY] 401 Internet Assigned Numbers Authority, "tunnelType 402 Definitions", . 405 6.2. Informative References 407 [I-D.ietf-softwire-yang] 408 Cui, Y., Farrer, I., Boucadair, M., Sun, Q., Sun, L., 409 Zechlin, S., and R. Asati, "YANG Modules for IPv4-in-IPv6 410 Address plus Port (A+P) Softwires", draft-ietf-softwire- 411 yang-12 (work in progress), November 2018. 413 [RFC4087] Thaler, D., "IP Tunnel MIB", RFC 4087, 414 DOI 10.17487/RFC4087, June 2005, 415 . 417 [RFC6346] Bush, R., Ed., "The Address plus Port (A+P) Approach to 418 the IPv4 Address Shortage", RFC 6346, 419 DOI 10.17487/RFC6346, August 2011, 420 . 422 [RFC7856] Cui, Y., Dong, J., Wu, P., Xu, M., and A. Yla-Jaaski, 423 "Softwire Mesh Management Information Base (MIB)", 424 RFC 7856, DOI 10.17487/RFC7856, May 2016, 425 . 427 [RFC7870] Fu, Y., Jiang, S., Dong, J., and Y. Chen, "Dual-Stack Lite 428 (DS-Lite) Management Information Base (MIB) for Address 429 Family Transition Routers (AFTRs)", RFC 7870, 430 DOI 10.17487/RFC7870, June 2016, 431 . 433 [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", 434 BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, 435 . 437 [RFC8343] Bjorklund, M., "A YANG Data Model for Interface 438 Management", RFC 8343, DOI 10.17487/RFC8343, March 2018, 439 . 441 Appendix A. Example Usage 443 The following example illustrates how the Interface YANG module can 444 be augmented with tunnel-specific paramters. In this example, the 445 module is augmented with a 'remote-endpoint' for the tunnel. A tree 446 structure is provided below: 448 module: ietf-extension-example 449 augment /if:interfaces/if:interface: 450 +--rw remote-endpoint? inet:ipv6-address 452 The 'extension-example' module imports the modules defined in 453 [RFC6991] and [RFC8343] in addition to the "iana-tunnel-type" module 454 defined in this document. 456 file "ietf-extension-example@2018-11-30.yang" 458 module ietf-extension-example { 459 yang-version 1.1; 461 namespace "urn:ietf:params:xml:ns:yang:ietf-extension-example"; 462 prefix example; 464 import ietf-inet-types { 465 prefix inet; 466 reference 467 "Section 4 of RFC 6991"; 468 } 470 import ietf-interfaces { 471 prefix if; 472 reference 473 "RFC 8343: A YANG Data Model for Interface Management"; 474 } 475 import iana-tunnel-type { 476 prefix iana-tunnel-type; 477 reference 478 "RFC XXXX: A Tunnel Extension to the Interface Management 479 YANG Module"; 480 } 482 organization "IETF Softwire Working Group"; 484 contact 486 "WG Web: 487 WG List: 489 Author: Mohamed Boucadair 490 "; 492 description 493 "This is an example YANG module to extend the Interface YANG 494 module with tunnel-specific parameters. 496 Copyright (c) 2018 IETF Trust and the persons identified as 497 authors of the code. All rights reserved. 499 Redistribution and use in source and binary forms, with or 500 without modification, is permitted pursuant to, and subject 501 to the license terms contained in, the Simplified BSD License 502 set forth in Section 4.c of the IETF Trust's Legal Provisions 503 Relating to IETF Documents 504 (http://trustee.ietf.org/license-info). 506 This version of this YANG module is part of RFC XXXX; see 507 the RFC itself for full legal notices."; 509 revision 2018-11-30 { 510 description 511 "Initial revision."; 512 reference 513 "RFC XXXX: Tunnel Interface Types YANG Module"; 514 } 516 augment "/if:interfaces/if:interface" { 517 when "derived-from(if:type, 'iana-tunnel-type:gre')"; 518 description 519 "Augments Interface module with specific tunnel parameters."; 521 leaf remote-endpoint { 522 type inet:ipv6-address; 523 description 524 "IPv6 address of the local GRE endpoint."; 525 } 526 } 527 } 528 530 Authors' Addresses 532 Mohamed Boucadair 533 Orange 534 Rennes 35000 535 France 537 Email: mohamed.boucadair@orange.com 539 Ian Farrer 540 Deutsche Telekom AG 541 CTO-ATI,Landgrabenweg 151 542 Bonn, NRW 53227 543 Germany 545 Email: ian.farrer@telekom.de 547 Rajiv Asati 548 Cisco Systems, Inc. 549 7025 Kit Creek Rd. 550 RTP, NC 27709 551 USA 553 Email: Rajiva@cisco.com