idnits 2.17.00 (12 Aug 2021) /tmp/idnits40196/draft-boucadair-netmod-softwire-iftunnel-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 : ---------------------------------------------------------------------------- ** There is 1 instance of too long lines in the document, the longest one being 2 characters in excess of 72. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year == Line 152 has weird spacing: '...dentity other...' -- The document date (October 19, 2018) is 1303 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: 'RFCXXXX' is mentioned on line 399, but not defined == Unused Reference: 'RFC2119' is defined on line 409, but no explicit reference was found in the text == Unused Reference: 'RFC8174' is defined on line 443, but no explicit reference was found in the text == Outdated reference: draft-ietf-softwire-yang has been published as RFC 8676 Summary: 1 error (**), 0 flaws (~~), 6 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 netmod M. Boucadair 3 Internet-Draft Orange 4 Intended status: Standards Track October 19, 2018 5 Expires: April 22, 2019 7 A Tunnel Extension to the Interface Management YANG Module 8 draft-boucadair-netmod-softwire-iftunnel-00 10 Abstract 12 This document specifies an extension the Interface Management YANG 13 module. 15 Editorial Note (To be removed by RFC Editor) 17 Please update these statements in the document with the RFC number to 18 be assigned to this document: 20 o "This version of this YANG module is part of RFC XXXX;" 22 o "RFC XXXX: A Tunnel Extension to the Interface Management YANG 23 Module"; 25 o "reference: RFC XXXX" 27 Please update the "revision" date of the YANG module. 29 Status of This Memo 31 This Internet-Draft is submitted in full conformance with the 32 provisions of BCP 78 and BCP 79. 34 Internet-Drafts are working documents of the Internet Engineering 35 Task Force (IETF). Note that other groups may also distribute 36 working documents as Internet-Drafts. The list of current Internet- 37 Drafts is at https://datatracker.ietf.org/drafts/current/. 39 Internet-Drafts are draft documents valid for a maximum of six months 40 and may be updated, replaced, or obsoleted by other documents at any 41 time. It is inappropriate to use Internet-Drafts as reference 42 material or to cite them other than as "work in progress." 44 This Internet-Draft will expire on April 22, 2019. 46 Copyright Notice 48 Copyright (c) 2018 IETF Trust and the persons identified as the 49 document authors. All rights reserved. 51 This document is subject to BCP 78 and the IETF Trust's Legal 52 Provisions Relating to IETF Documents 53 (https://trustee.ietf.org/license-info) in effect on the date of 54 publication of this document. Please review these documents 55 carefully, as they describe your rights and restrictions with respect 56 to this document. Code Components extracted from this document must 57 include Simplified BSD License text as described in Section 4.e of 58 the Trust Legal Provisions and are provided without warranty as 59 described in the Simplified BSD License. 61 Table of Contents 63 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 64 2. IANA Tunnel Type YANG Module . . . . . . . . . . . . . . . . 3 65 3. Tunnel Extension to the Interface YANG Module . . . . . . . . 6 66 4. Security Considerations . . . . . . . . . . . . . . . . . . . 7 67 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8 68 6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 9 69 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 9 70 7.1. Normative References . . . . . . . . . . . . . . . . . . 9 71 7.2. Informative References . . . . . . . . . . . . . . . . . 10 72 Appendix A. Example . . . . . . . . . . . . . . . . . . . . . . 11 73 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 13 75 1. Introduction 77 This document specifies the initial version of an IANA-maintained 78 module to identify a collection of tunnel types assigned by IANA 79 (Section 2). Furthermore, the document augments the Interface YANG 80 module [RFC8343] with a new parameter which is meant to indicate the 81 type of a given tunnel (Section 3). The tree structure of this 82 extension is shown below: 84 module: ietf-interface-tunnel 85 augment /if:interfaces/if:interface: 86 +--rw tunnel-type? identityref 88 Tunnel-specific extensions may be added to the Interface module as a 89 function of the tunnel type. A sample example is provided in 90 Appendix A. It is not the intent of this document to define tunnel- 91 specific extension for every tunnel encapsulation technology; those 92 are discussed in dedicated document such as [I-D.ietf-softwire-yang]. 94 This document uses the common YANG types defined in [RFC6991] and 95 adopts the Network Management Datastore Architecture (NMDA). 97 The terminology for describing YANG modules is defined in [RFC7950]. 98 The meaning of the symbols in tree diagrams is defined in [RFC8340]. 100 2. IANA Tunnel Type YANG Module 102 file "iana-tunnel-type@2018-10-19.yang" 104 module iana-tunnel-type { 105 yang-version 1.1; 106 namespace "urn:ietf:params:xml:ns:yang:iana-tunnel-type"; 107 prefix iana-tunnel-type; 109 import iana-if-type { 110 prefix ift; 111 reference 112 "RFC 7224: IANA Interface Type YANG Module"; 113 } 115 organization 116 "IANA"; 117 contact 118 "Internet Assigned Numbers Authority 120 Postal: ICANN 121 12025 Waterfront Drive, Suite 300 122 Los Angeles, CA 90094-2536 123 United States of America 124 Tel: +1 310 301 5800 125 "; 127 description 128 "This module contains a collection of YANG data types defined 129 by IANA and used for tunnel types. 131 Copyright (c) 2018 IETF Trust and the persons identified as 132 authors of the code. All rights reserved. 134 Redistribution and use in source and binary forms, with or 135 without modification, is permitted pursuant to, and subject 136 to the license terms contained in, the Simplified BSD License 137 set forth in Section 4.c of the IETF Trust's Legal Provisions 138 Relating to IETF Documents 139 (http://trustee.ietf.org/license-info). 141 This version of this YANG module is part of RFC XXXX; see 142 the RFC itself for full legal notices."; 144 revision 2018-10-19 { 145 description 146 "Initial revision."; 147 reference 148 "RFC XXXX: A Tunnel Extension to the Interface 149 Management YANG Module"; 150 } 152 identity other { 153 base ift:tunnel; 154 description 155 "None of the following values."; 156 } 157 identity direct { 158 base ift:tunnel; 159 description 160 "No intermediate header."; 161 } 162 identity gre { 163 base ift:tunnel; 164 description 165 "GRE encapsulation."; 166 } 167 identity minimal { 168 base ift:tunnel; 169 description 170 "Minimal encapsulation."; 171 } 172 identity l2tp { 173 base ift:tunnel; 174 description 175 "L2TP encapsulation."; 176 } 177 identity pptp { 178 base ift:tunnel; 179 description 180 "PPTP encapsulation."; 181 } 182 identity l2f { 183 base ift:tunnel; 184 description 185 "L2F encapsulation."; 186 } 187 identity udp { 188 base ift:tunnel; 189 description 190 "UDP encapsulation."; 191 } 192 identity atmp { 193 base ift:tunnel; 194 description 195 "ATMP encapsulation."; 196 } 197 identity msdp { 198 base ift:tunnel; 199 description 200 "MSDP encapsulation."; 201 } 202 identity sixtofour { 203 base ift:tunnel; 204 description 205 "6to4 encapsulation."; 206 } 207 identity sixoverfour { 208 base ift:tunnel; 209 description 210 "6over4 encapsulation."; 211 } 212 identity isatap { 213 base ift:tunnel; 214 description 215 "ISATAP encapsulation."; 216 } 217 identity teredo { 218 base ift:tunnel; 219 description 220 "Teredo encapsulation."; 221 } 222 identity iphttps { 223 base ift:tunnel; 224 description 225 "IP over HTTPS."; 226 } 227 identity softwiremesh { 228 base ift:tunnel; 229 description 230 "softwire mesh tunnel."; 231 } 232 identity dslite { 233 base ift:tunnel; 234 description 235 "DS-Lite tunnel."; 236 } 237 } 238 240 3. Tunnel Extension to the Interface YANG Module 242 The ietf-interface-tunnel module imports the modules defined in 243 [RFC7224] and [RFC8343]. 245 file "ietf-interface-tunnel@2018-10-19.yang" 247 module ietf-interface-tunnel { 248 yang-version 1.1; 250 namespace "urn:ietf:params:xml:ns:yang:ietf-interface-tunnel"; 251 prefix ietf-interface-tunnel; 253 import ietf-interfaces { 254 prefix if; 255 reference 256 "RFC 8343: A YANG Data Model for Interface Management"; 257 } 259 import iana-if-type { 260 prefix ift; 261 reference 262 "RFC 7224: IANA Interface Type YANG Module"; 263 } 265 organization "IETF xxx Working Group"; 267 contact 269 "WG Web: 270 WG List: 272 Editor: Mohamed Boucadair 273 "; 275 description 276 "This module is a YANG module for associating a tunnel type with 277 tunnel interfaces. 279 Copyright (c) 2018 IETF Trust and the persons identified as 280 authors of the code. All rights reserved. 282 Redistribution and use in source and binary forms, with or 283 without modification, is permitted pursuant to, and subject 284 to the license terms contained in, the Simplified BSD License 285 set forth in Section 4.c of the IETF Trust's Legal Provisions 286 Relating to IETF Documents 287 (http://trustee.ietf.org/license-info). 289 This version of this YANG module is part of RFC XXXX; see 290 the RFC itself for full legal notices."; 292 revision 2018-10-19 { 293 description 294 "Initial revision."; 295 reference 296 "RFC XXXX: A Tunnel Extension to the Interface 297 Management YANG Module"; 298 } 300 augment "/if:interfaces/if:interface" { 301 when 'derived-from(if:type, "ift:tunnel")'; 302 description 303 "Augments Interface module with tunnel-specific parameters. 305 IANA interface types are maintained at this registry: 306 https://www.iana.org/assignments/ianaiftype-mib/ianaiftype-mib. 308 tunnel (131), -- Encapsulation interface"; 310 leaf tunnel-type { 311 type identityref { 312 base ift:tunnel; 313 } 314 description 315 "Indicates the type of the tunnel. It corresponds 316 to the IANAtunnelType. 318 IANA tunnel types are maintained at this registry: 319 https://www.iana.org/assignments/ianaiftype-mib/ianaiftype-mib."; 320 } 321 } 322 } 323 325 4. Security Considerations 327 The YANG module defined in this document is designed to be accessed 328 via network management protocols such as NETCONF [RFC6241] or 329 RESTCONF [RFC8040]. The lowest NETCONF layer is the secure transport 330 layer, and the mandatory-to-implement secure transport is Secure 331 Shell (SSH) [RFC6242]. The lowest RESTCONF layer is HTTPS, and the 332 mandatory-to-implement secure transport is TLS [RFC8446]. 334 The NETCONF access control model [RFC8341] provides the means to 335 restrict access for particular NETCONF or RESTCONF users to a 336 preconfigured subset of all available NETCONF or RESTCONF protocol 337 operations and content. 339 All data nodes defined in the YANG module which can be created, 340 modified and deleted (i.e., config true, which is the default) are 341 considered sensitive. Write operations (e.g., edit-config) applied 342 to these data nodes without proper protection can negatively affect 343 network operations. 345 5. IANA Considerations 347 This document requests IANA to register the following URIs in the 348 "IETF XML Registry" [RFC3688]: 350 URI: urn:ietf:params:xml:ns:yang:ietf-interface-tunnel 351 Registrant Contact: The IESG. 352 XML: N/A; the requested URI is an XML namespace. 354 URI: urn:ietf:params:xml:ns:yang:iana-tunnel-type 355 Registrant Contact: IANA. 356 XML: N/A; the requested URI is an XML namespace. 358 This document requests IANA to register the following YANG modules in 359 the "YANG Module Names" registry [RFC7950]. 361 name: ietf-interface-tunnel 362 namespace: urn:ietf:params:xml:ns:yang:ietf-interface-tunnel 363 prefix: ietf-interface-tunnel 364 reference: RFC XXXX 366 name: iana-tunnel-type 367 namespace: urn:ietf:params:xml:ns:yang:iana-tunnel-type 368 prefix: iana-tunnel-type 369 reference: RFC XXXX 371 This document defines the initial version of the IANA-maintained 372 iana-tunnel-type YANG module. IANA is requested to add this note: 374 Tunnel type values must not be directly added to the iana-tunnel- 375 type YANG module. They must instead be respectively added to the 376 "tunnelType" sub-registry (under "ifType definitions" registry). 378 When an tunnel type is added to the "tunnelType" registry, a new 379 "identity" statement must be added to the iana-tunnel-type YANG 380 module. The name of the "identity" is the same as the corresponding 381 enumeration in the IANAifType-MIB. The following substatements to 382 the "identity" statement should be defined: 384 "base": Contains the value of the tunnel type in lowercase. 386 "description": Replicate the description from the registry. 388 "reference": Replicate the reference from the registry and add the 389 title of the document. 391 Unassigned or reserved values are not present in the module. 393 When the iana-tunnel-type YANG module is updated, a new "revision" 394 statement must be added in front of the existing revision statements. 396 IANA is requested to add this note to "tunnelType" registry: 398 When this registry is modified, the YANG module iana-tunnel-type 399 must be updated as defined in [RFCXXXX]. 401 6. Acknowledgements 403 Many thanks to Tom Petch. 405 7. References 407 7.1. Normative References 409 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 410 Requirement Levels", BCP 14, RFC 2119, 411 DOI 10.17487/RFC2119, March 1997, 412 . 414 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 415 DOI 10.17487/RFC3688, January 2004, 416 . 418 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., 419 and A. Bierman, Ed., "Network Configuration Protocol 420 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, 421 . 423 [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure 424 Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, 425 . 427 [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", 428 RFC 6991, DOI 10.17487/RFC6991, July 2013, 429 . 431 [RFC7224] Bjorklund, M., "IANA Interface Type YANG Module", 432 RFC 7224, DOI 10.17487/RFC7224, May 2014, 433 . 435 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 436 RFC 7950, DOI 10.17487/RFC7950, August 2016, 437 . 439 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF 440 Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, 441 . 443 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 444 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 445 May 2017, . 447 [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration 448 Access Control Model", STD 91, RFC 8341, 449 DOI 10.17487/RFC8341, March 2018, 450 . 452 [RFC8343] Bjorklund, M., "A YANG Data Model for Interface 453 Management", RFC 8343, DOI 10.17487/RFC8343, March 2018, 454 . 456 [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol 457 Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, 458 . 460 7.2. Informative References 462 [I-D.ietf-softwire-yang] 463 Cui, Y., Farrer, I., Boucadair, M., Sun, Q., Sun, L., 464 Zechlin, S., and R. Asati, "YANG Modules for IPv4-in-IPv6 465 Address plus Port Softwires", draft-ietf-softwire-yang-06 466 (work in progress), June 2018. 468 [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", 469 BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, 470 . 472 Appendix A. Example 474 The following example illustrate how the interface YANG module can be 475 augmented with tunnel-specific paramters. In this example, the 476 module is augmented with 'remote-endpoint' of the tunnel. A tree 477 structure is also provided below: 479 module: ietf-extension-example 480 augment /if:interfaces/if:interface: 481 +--rw remote-endpoint? inet:ipv6-address 483 The 'extension-example' module imports the modules defined in 484 [RFC6991] and [RFC8343] in addition to the those defined in this 485 document. 487 file "ietf-extension-example@2018-10-19.yang" 489 module ietf-extension-example { 490 yang-version 1.1; 492 namespace "urn:ietf:params:xml:ns:yang:ietf-extension-example"; 493 prefix example; 495 import ietf-inet-types { 496 prefix inet; 497 reference 498 "Section 4 of RFC 6991"; 499 } 501 import ietf-interfaces { 502 prefix if; 503 reference 504 "RFC 8343: A YANG Data Model for Interface Management"; 505 } 507 import iana-tunnel-type { 508 prefix iana-tunnel-type; 509 reference 510 "RFC XXXX: A Tunnel Extension to the Interface Management 511 YANG Module"; 512 } 514 import ietf-interface-tunnel { 515 prefix ift; 516 reference 517 "RFC XXXX: A Tunnel Extension to the Interface Management 518 YANG Module"; 519 } 520 organization "IETF xxxx Working Group"; 522 contact 524 "WG Web: 525 WG List: 527 Editor: Mohamed Boucadair 528 "; 530 description 531 "This is an exampel YANG module. 533 Copyright (c) 2018 IETF Trust and the persons identified as 534 authors of the code. All rights reserved. 536 Redistribution and use in source and binary forms, with or 537 without modification, is permitted pursuant to, and subject 538 to the license terms contained in, the Simplified BSD License 539 set forth in Section 4.c of the IETF Trust's Legal Provisions 540 Relating to IETF Documents 541 (http://trustee.ietf.org/license-info). 543 This version of this YANG module is part of RFC XXXX; see 544 the RFC itself for full legal notices."; 546 revision 2018-10-19 { 547 description 548 "Initial revision."; 549 reference 550 "RFC XXXX: A Tunnel Extension to the Interface Management 551 YANG Module"; 552 } 554 augment "/if:interfaces/if:interface" { 555 when "derived-from(ift:tunnel-type, 'iana-tunnel-type:gre')"; 556 description 557 "Augments Interface module with specific tunnel parameters."; 559 leaf remote-endpoint { 560 type inet:ipv6-address; 561 description 562 "IPv6 address of the local GRE endpoint."; 563 } 564 } 565 } 566 568 Author's Address 570 Mohamed Boucadair 571 Orange 572 Rennes 35000 573 France 575 Email: mohamed.boucadair@orange.com