idnits 2.17.1 draft-ietf-netconf-tls-client-server-16.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 (November 1, 2019) is 1637 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) == Outdated reference: A later version (-34) exists of draft-ietf-netconf-crypto-types-11 == Outdated reference: A later version (-35) exists of draft-ietf-netconf-keystore-13 == Outdated reference: A later version (-28) exists of draft-ietf-netconf-trust-anchors-06 -- Obsolete informational reference (is this intentional?): RFC 2246 (Obsoleted by RFC 4346) -- Obsolete informational reference (is this intentional?): RFC 2818 (Obsoleted by RFC 9110) -- Obsolete informational reference (is this intentional?): RFC 4346 (Obsoleted by RFC 5246) -- Obsolete informational reference (is this intentional?): RFC 5246 (Obsoleted by RFC 8446) Summary: 0 errors (**), 0 flaws (~~), 4 warnings (==), 5 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 NETCONF Working Group K. Watsen 3 Internet-Draft Watsen Networks 4 Intended status: Standards Track G. Wu 5 Expires: May 4, 2020 Cisco Systems 6 L. Xia 7 Huawei 8 November 1, 2019 10 YANG Groupings for TLS Clients and TLS Servers 11 draft-ietf-netconf-tls-client-server-16 13 Abstract 15 This document defines three YANG modules: the first defines groupings 16 for a generic TLS client, the second defines groupings for a generic 17 TLS server, and the third defines common identities and groupings 18 used by both the client and the server. It is intended that these 19 groupings will be used by applications using the TLS protocol. 21 Editorial Note (To be removed by RFC Editor) 23 This draft contains many placeholder values that need to be replaced 24 with finalized values at the time of publication. This note 25 summarizes all of the substitutions that are needed. No other RFC 26 Editor instructions are specified elsewhere in this document. 28 This document contains references to other drafts in progress, both 29 in the Normative References section, as well as in body text 30 throughout. Please update the following references to reflect their 31 final RFC assignments: 33 o I-D.ietf-netconf-trust-anchors 35 o I-D.ietf-netconf-keystore 37 Artwork in this document contains shorthand references to drafts in 38 progress. Please apply the following replacements: 40 o "XXXX" --> the assigned RFC value for this draft 42 o "YYYY" --> the assigned RFC value for I-D.ietf-netconf-trust- 43 anchors 45 o "ZZZZ" --> the assigned RFC value for I-D.ietf-netconf-keystore 47 Artwork in this document contains placeholder values for the date of 48 publication of this draft. Please apply the following replacement: 50 o "2019-11-02" --> the publication date of this draft 52 The following Appendix section is to be removed prior to publication: 54 o Appendix A. Change Log 56 Status of This Memo 58 This Internet-Draft is submitted in full conformance with the 59 provisions of BCP 78 and BCP 79. 61 Internet-Drafts are working documents of the Internet Engineering 62 Task Force (IETF). Note that other groups may also distribute 63 working documents as Internet-Drafts. The list of current Internet- 64 Drafts is at https://datatracker.ietf.org/drafts/current/. 66 Internet-Drafts are draft documents valid for a maximum of six months 67 and may be updated, replaced, or obsoleted by other documents at any 68 time. It is inappropriate to use Internet-Drafts as reference 69 material or to cite them other than as "work in progress." 71 This Internet-Draft will expire on May 4, 2020. 73 Copyright Notice 75 Copyright (c) 2019 IETF Trust and the persons identified as the 76 document authors. All rights reserved. 78 This document is subject to BCP 78 and the IETF Trust's Legal 79 Provisions Relating to IETF Documents 80 (https://trustee.ietf.org/license-info) in effect on the date of 81 publication of this document. Please review these documents 82 carefully, as they describe your rights and restrictions with respect 83 to this document. Code Components extracted from this document must 84 include Simplified BSD License text as described in Section 4.e of 85 the Trust Legal Provisions and are provided without warranty as 86 described in the Simplified BSD License. 88 Table of Contents 90 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 91 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 4 92 3. The TLS Client Model . . . . . . . . . . . . . . . . . . . . 4 93 3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 4 94 3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 4 95 3.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 6 96 4. The TLS Server Model . . . . . . . . . . . . . . . . . . . . 10 97 4.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 10 98 4.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 11 99 4.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 13 100 5. The TLS Common Model . . . . . . . . . . . . . . . . . . . . 19 101 5.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 28 102 5.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 28 103 5.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 28 104 6. Security Considerations . . . . . . . . . . . . . . . . . . . 37 105 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 38 106 7.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 38 107 7.2. The YANG Module Names Registry . . . . . . . . . . . . . 39 108 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 39 109 8.1. Normative References . . . . . . . . . . . . . . . . . . 39 110 8.2. Informative References . . . . . . . . . . . . . . . . . 41 111 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 43 112 A.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 43 113 A.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 43 114 A.3. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 43 115 A.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 43 116 A.5. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 44 117 A.6. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 44 118 A.7. 06 to 07 . . . . . . . . . . . . . . . . . . . . . . . . 44 119 A.8. 07 to 08 . . . . . . . . . . . . . . . . . . . . . . . . 44 120 A.9. 08 to 09 . . . . . . . . . . . . . . . . . . . . . . . . 44 121 A.10. 09 to 10 . . . . . . . . . . . . . . . . . . . . . . . . 44 122 A.11. 10 to 11 . . . . . . . . . . . . . . . . . . . . . . . . 45 123 A.12. 11 to 12 . . . . . . . . . . . . . . . . . . . . . . . . 45 124 A.13. 12 to 13 . . . . . . . . . . . . . . . . . . . . . . . . 45 125 A.14. 12 to 13 . . . . . . . . . . . . . . . . . . . . . . . . 45 126 A.15. 13 to 14 . . . . . . . . . . . . . . . . . . . . . . . . 46 127 A.16. 14 to 15 . . . . . . . . . . . . . . . . . . . . . . . . 46 128 A.17. 15 to 16 . . . . . . . . . . . . . . . . . . . . . . . . 46 129 Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 46 130 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 46 132 1. Introduction 134 This document defines three YANG 1.1 [RFC7950] modules: the first 135 defines a grouping for a generic TLS client, the second defines a 136 grouping for a generic TLS server, and the third defines identities 137 and groupings common to both the client and the server (TLS is 138 defined in [RFC5246]). It is intended that these groupings will be 139 used by applications using the TLS protocol. For instance, these 140 groupings could be used to help define the data model for an HTTPS 141 [RFC2818] server or a NETCONF over TLS [RFC7589] based server. 143 The client and server YANG modules in this document each define one 144 grouping, which is focused on just TLS-specific configuration, and 145 specifically avoids any transport-level configuration, such as what 146 ports to listen-on or connect-to. This affords applications the 147 opportunity to define their own strategy for how the underlying TCP 148 connection is established. For instance, applications supporting 149 NETCONF Call Home [RFC8071] could use the "ssh-server-grouping" 150 grouping for the TLS parts it provides, while adding data nodes for 151 the TCP-level call-home configuration. 153 2. Terminology 155 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 156 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 157 "OPTIONAL" in this document are to be interpreted as described in BCP 158 14 [RFC2119] [RFC8174] when, and only when, they appear in all 159 capitals, as shown here. 161 3. The TLS Client Model 163 3.1. Tree Diagram 165 This section provides a tree diagram [RFC8340] for the "ietf-tls- 166 client" module that does not have groupings expanded. 168 module: ietf-tls-client 170 grouping tls-client-grouping 171 +-- client-identity 172 | +---u ks:local-or-keystore-end-entity-cert-with-key-grouping 173 +-- server-authentication 174 | +-- ca-certs! 175 | | +---u ts:local-or-truststore-certs-grouping 176 | +-- server-certs! 177 | +---u ts:local-or-truststore-certs-grouping 178 +-- hello-params {tls-client-hello-params-config}? 179 | +---u tlscmn:hello-params-grouping 180 +-- keepalives! {tls-client-keepalives}? 181 +-- max-wait? uint16 182 +-- max-attempts? uint8 184 3.2. Example Usage 186 This section presents two examples showing the tls-client-grouping 187 populated with some data. These examples are effectively the same 188 except the first configures the client identity using a local key 189 while the second uses a key configured in a keystore. Both examples 190 are consistent with the examples presented in Section 2 of 191 [I-D.ietf-netconf-trust-anchors] and Section 3.2 of 192 [I-D.ietf-netconf-keystore]. 194 The following example configures the client identity using a local 195 key: 197 ========== NOTE: '\' line wrapping per BCP XXX (RFC XXXX) =========== 199 201 202 203 204 rsa2048 205 base64encodedvalue== 206 base64encodedvalue== 207 base64encodedvalue== 208 209 211 212 213 214 explicitly-trusted-server-ca-certs 216 217 218 explicitly-trusted-server-certs 220 221 223 224 30 225 3 226 228 230 The following example configures the client identity using a key from 231 the keystore: 233 ========== NOTE: '\' line wrapping per BCP XXX (RFC XXXX) =========== 235 237 238 239 240 rsa-asymmetric-key 241 ex-rsa-cert 242 243 245 246 247 248 explicitly-trusted-server-ca-certs 250 251 252 explicitly-trusted-server-certs 254 255 257 258 30 259 3 260 262 264 3.3. YANG Module 266 This YANG module has normative references to 267 [I-D.ietf-netconf-trust-anchors] and [I-D.ietf-netconf-keystore]. 269 file "ietf-tls-client@2019-11-02.yang" 271 module ietf-tls-client { 272 yang-version 1.1; 273 namespace "urn:ietf:params:xml:ns:yang:ietf-tls-client"; 274 prefix tlsc; 276 import ietf-tls-common { 277 prefix tlscmn; 278 revision-date 2019-11-02; // stable grouping definitions 279 reference 280 "RFC XXXX: YANG Groupings for TLS Clients and TLS Servers"; 282 } 284 import ietf-truststore { 285 prefix ts; 286 reference 287 "RFC YYYY: A YANG Data Model for a Truststore"; 288 } 290 import ietf-keystore { 291 prefix ks; 292 reference 293 "RFC ZZZZ: A YANG Data Model for a Keystore"; 294 } 296 import ietf-netconf-acm { 297 prefix nacm; 298 reference 299 "RFC 8341: Network Configuration Access Control Model"; 300 } 302 organization 303 "IETF NETCONF (Network Configuration) Working Group"; 305 contact 306 "WG Web: 307 WG List: 308 Author: Kent Watsen 309 Author: Gary Wu "; 311 description 312 "This module defines reusable groupings for TLS clients that 313 can be used as a basis for specific TLS client instances. 315 Copyright (c) 2019 IETF Trust and the persons identified 316 as authors of the code. All rights reserved. 318 Redistribution and use in source and binary forms, with 319 or without modification, is permitted pursuant to, and 320 subject to the license terms contained in, the Simplified 321 BSD License set forth in Section 4.c of the IETF Trust's 322 Legal Provisions Relating to IETF Documents 323 (https://trustee.ietf.org/license-info). 325 This version of this YANG module is part of RFC XXXX 326 (https://www.rfc-editor.org/info/rfcXXXX); see the RFC 327 itself for full legal notices.; 329 The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 330 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 331 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document 332 are to be interpreted as described in BCP 14 (RFC 2119) 333 (RFC 8174) when, and only when, they appear in all 334 capitals, as shown here."; 336 revision 2019-11-02 { 337 description 338 "Initial version"; 339 reference 340 "RFC XXXX: YANG Groupings for TLS Clients and TLS Servers"; 341 } 343 // Features 345 feature tls-client-hello-params-config { 346 description 347 "TLS hello message parameters are configurable on a TLS 348 client."; 349 } 351 feature tls-client-keepalives { 352 description 353 "Per socket TLS keepalive parameters are configurable for 354 TLS clients on the server implementing this feature."; 355 } 357 // Groupings 359 grouping tls-client-grouping { 360 description 361 "A reusable grouping for configuring a TLS client without 362 any consideration for how an underlying TCP session is 363 established. 365 Note that this grouping uses fairly typical descendent 366 node names such that a stack of 'uses' statements will 367 have name conflicts. It is intended that the consuming 368 data model will resolve the issue (e.g., by wrapping 369 the 'uses' statement in a container called 370 'tls-client-parameters'). This model purposely does 371 not do this itself so as to provide maximum flexibility 372 to consuming models."; 374 container client-identity { // FIXME: what about PSKs? 375 nacm:default-deny-write; 376 description 377 "A locally-defined or referenced end-entity certificate, 378 including any configured intermediate certificates, the 379 TLS client will present when establishing a TLS connection 380 in its Certificate message, as defined in Section 7.4.2 381 in RFC 5246."; 382 reference 383 "RFC 5246: 384 The Transport Layer Security (TLS) Protocol Version 1.2 385 RFC ZZZZ: 386 YANG Data Model for a 'Keystore' Mechanism"; 387 uses ks:local-or-keystore-end-entity-cert-with-key-grouping; 388 } // container client-identity 390 container server-authentication { // FIXME: what about PSKs? 391 nacm:default-deny-write; 392 must 'ca-certs or server-certs'; 393 description 394 "Trusted server identities. Any combination of trusted 395 server identities is additive and unordered."; 396 container ca-certs { 397 presence 398 "Indicates that the client can authenticate servers 399 using the configured trust anchor certificates."; 400 description 401 "A set of certificate authority (CA) certificates used by 402 the TLS client to authenticate TLS servers. A server 403 is authenticated if its certificate has a valid chain 404 of trust to a configured CA certificate."; 405 uses ts:local-or-truststore-certs-grouping; 406 } 407 container server-certs { 408 presence 409 "Indicates that the client can authenticate servers 410 using the configured server certificates."; 411 description 412 "A set of end-entity certificates used by the TLS client 413 to authenticate TLS servers. A server is authenticated 414 if its certificate is an exact match to a configured 415 server certificate."; 416 uses ts:local-or-truststore-certs-grouping; 417 } 418 } // container server-authentication 420 container hello-params { 421 nacm:default-deny-write; 422 if-feature "tls-client-hello-params-config"; 423 uses tlscmn:hello-params-grouping; 424 description 425 "Configurable parameters for the TLS hello message."; 427 } // container hello-params 429 container keepalives { 430 nacm:default-deny-write; 431 if-feature "tls-client-keepalives"; 432 presence "Indicates that keepalives are enabled."; 433 description 434 "Configures the keep-alive policy, to proactively test 435 the aliveness of the TLS server. An unresponsive 436 TLS server is dropped after approximately max-wait 437 * max-attempts seconds."; 438 leaf max-wait { 439 type uint16 { 440 range "1..max"; 441 } 442 units "seconds"; 443 default "30"; 444 description 445 "Sets the amount of time in seconds after which if 446 no data has been received from the TLS server, a 447 TLS-level message will be sent to test the 448 aliveness of the TLS server."; 449 } 450 leaf max-attempts { 451 type uint8; 452 default "3"; 453 description 454 "Sets the maximum number of sequential keep-alive 455 messages that can fail to obtain a response from 456 the TLS server before assuming the TLS server is 457 no longer alive."; 458 } 459 } // container keepalives 460 } // grouping tls-client-grouping 461 } 463 465 4. The TLS Server Model 467 4.1. Tree Diagram 469 This section provides a tree diagram [RFC8340] for the "ietf-tls- 470 server" module that does not have groupings expanded. 472 module: ietf-tls-server 474 grouping tls-server-grouping 475 +-- server-identity 476 | +---u ks:local-or-keystore-end-entity-cert-with-key-grouping 477 +-- client-authentication! 478 | +-- (required-or-optional) 479 | | +--:(required) 480 | | | +-- required? empty 481 | | +--:(optional) 482 | | +-- optional? empty 483 | +-- (local-or-external) 484 | +--:(local) {local-client-auth-supported}? 485 | | +-- ca-certs! 486 | | | +---u ts:local-or-truststore-certs-grouping 487 | | +-- client-certs! 488 | | +---u ts:local-or-truststore-certs-grouping 489 | +--:(external) {external-client-auth-supported}? 490 | +-- client-auth-defined-elsewhere? empty 491 +-- hello-params {tls-server-hello-params-config}? 492 | +---u tlscmn:hello-params-grouping 493 +-- keepalives! {tls-server-keepalives}? 494 +-- max-wait? uint16 495 +-- max-attempts? uint8 497 4.2. Example Usage 499 This section presents two examples showing the tls-server-grouping 500 populated with some data. These examples are effectively the same 501 except the first configures the server identity using a local key 502 while the second uses a key configured in a keystore. Both examples 503 are consistent with the examples presented in Section 2 of 504 [I-D.ietf-netconf-trust-anchors] and Section 3.2 of 505 [I-D.ietf-netconf-keystore]. 507 The following example configures the server identity using a local 508 key: 510 ========== NOTE: '\' line wrapping per BCP XXX (RFC XXXX) =========== 512 514 515 516 517 rsa2048 518 base64encodedvalue== 519 base64encodedvalue== 520 base64encodedvalue== 521 522 524 525 526 527 528 explicitly-trusted-client-ca-certs 530 531 532 explicitly-trusted-client-certs 534 535 537 539 The following example configures the server identity using a key from 540 the keystore: 542 ========== NOTE: '\' line wrapping per BCP XXX (RFC XXXX) =========== 544 546 547 548 549 rsa-asymmetric-key 550 ex-rsa-cert 551 552 554 555 556 557 558 explicitly-trusted-client-ca-certs 560 561 562 explicitly-trusted-client-certs 564 565 567 569 4.3. YANG Module 571 This YANG module has a normative references to [RFC5246], 572 [I-D.ietf-netconf-trust-anchors] and [I-D.ietf-netconf-keystore]. 574 file "ietf-tls-server@2019-11-02.yang" 576 module ietf-tls-server { 577 yang-version 1.1; 578 namespace "urn:ietf:params:xml:ns:yang:ietf-tls-server"; 579 prefix tlss; 581 import ietf-tls-common { 582 prefix tlscmn; 583 revision-date 2019-11-02; // stable grouping definitions 584 reference 585 "RFC XXXX: YANG Groupings for TLS Clients and TLS Servers"; 586 } 588 import ietf-truststore { 589 prefix ts; 590 reference 591 "RFC YYYY: A YANG Data Model for a Truststore"; 592 } 594 import ietf-keystore { 595 prefix ks; 596 reference 597 "RFC ZZZZ: A YANG Data Model for a Keystore"; 598 } 600 import ietf-netconf-acm { 601 prefix nacm; 602 reference 603 "RFC 8341: Network Configuration Access Control Model"; 604 } 606 organization 607 "IETF NETCONF (Network Configuration) Working Group"; 609 contact 610 "WG Web: 611 WG List: 612 Author: Kent Watsen 613 Author: Gary Wu "; 615 description 616 "This module defines reusable groupings for TLS servers that 617 can be used as a basis for specific TLS server instances. 619 Copyright (c) 2019 IETF Trust and the persons identified 620 as authors of the code. All rights reserved. 622 Redistribution and use in source and binary forms, with 623 or without modification, is permitted pursuant to, and 624 subject to the license terms contained in, the Simplified 625 BSD License set forth in Section 4.c of the IETF Trust's 626 Legal Provisions Relating to IETF Documents 627 (https://trustee.ietf.org/license-info). 629 This version of this YANG module is part of RFC XXXX 630 (https://www.rfc-editor.org/info/rfcXXXX); see the RFC 631 itself for full legal notices.; 633 The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 634 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 635 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document 636 are to be interpreted as described in BCP 14 (RFC 2119) 637 (RFC 8174) when, and only when, they appear in all 638 capitals, as shown here."; 640 revision 2019-11-02 { 641 description 642 "Initial version"; 643 reference 644 "RFC XXXX: YANG Groupings for TLS Clients and TLS Servers"; 645 } 647 // Features 649 feature tls-server-hello-params-config { 650 description 651 "TLS hello message parameters are configurable on a TLS 652 server."; 653 } 655 feature tls-server-keepalives { 656 description 657 "Per socket TLS keepalive parameters are configurable for 658 TLS servers on the server implementing this feature."; 659 } 661 feature local-client-auth-supported { 662 description 663 "Indicates that the TLS server supports local 664 configuration of client credentials."; 665 } 667 feature external-client-auth-supported { 668 description 669 "Indicates that the TLS server supports external 670 configuration of client credentials."; 671 } 673 // Groupings 675 grouping tls-server-grouping { 676 description 677 "A reusable grouping for configuring a TLS server without 678 any consideration for how underlying TCP sessions are 679 established. 681 Note that this grouping uses fairly typical descendent 682 node names such that a stack of 'uses' statements will 683 have name conflicts. It is intended that the consuming 684 data model will resolve the issue (e.g., by wrapping 685 the 'uses' statement in a container called 686 'tls-server-parameters'). This model purposely does 687 not do this itself so as to provide maximum flexibility 688 to consuming models."; 690 container server-identity { // FIXME: what about PSKs? 691 nacm:default-deny-write; 692 description 693 "A locally-defined or referenced end-entity certificate, 694 including any configured intermediate certificates, the 695 TLS server will present when establishing a TLS connection 696 in its Certificate message, as defined in Section 7.4.2 697 in RFC 5246."; 698 reference 699 "RFC 5246: 700 The Transport Layer Security (TLS) Protocol Version 1.2 701 RFC ZZZZ: 702 YANG Data Model for a 'Keystore' Mechanism"; 703 uses ks:local-or-keystore-end-entity-cert-with-key-grouping; 704 } // container server-identity 706 container client-authentication { // FIXME: what about PSKs? 707 nacm:default-deny-write; 708 presence 709 "Indicates that certificate based client authentication 710 is supported (i.e., the server will request that the 711 client send a certificate)."; 712 description 713 "Specifies if TLS client authentication is required or 714 optional, and specifies if the certificates needed to 715 authenticate the TLS client are configured locally or 716 externally. If configured locally, the data model 717 enables both trust anchors and end-entity certificate 718 to be set."; 719 choice required-or-optional { 720 mandatory true; // or default to 'required' ? 721 description 722 "Indicates if TLS-level client authentication is required 723 or optional. This is necessary for some protocols (e.g., 724 RESTCONF) the may optionally authenticate a client via 725 TLS-level authentication, HTTP-level authentication, or 726 both simultaneously)."; 727 leaf required { 728 type empty; 729 description 730 "Indicates that TLS-level client authentication is 731 required."; 732 } 733 leaf optional { 734 type empty; 735 description 736 "Indicates that TLS-level client authentication is 737 optional."; 738 } 739 } 740 choice local-or-external { 741 mandatory true; 742 description 743 "Indicates if the credentials needed to authenticate the 744 clients are configured locally or externally. 746 Configuring credentials externally enables applications 747 to place client authentication with client definitions, 748 rather then in a part of a data model principally 749 concerned with configuring the TLS transport."; 750 case local { 751 if-feature "local-client-auth-supported"; 752 description 753 "The certificates needed to authenticate the clients 754 are configured within this TLS configuration. 756 How to extract an application-level user name from the 757 certificate is outside the scope of this data model."; 758 container ca-certs { 759 presence 760 "Indicates that the server can authenticate clients 761 using the configured trust anchor certificates."; 762 description 763 "A set of certificate authority (CA) certificates used 764 by the TLS server to authenticate TLS clients. A 765 client is authenticated if its certificate has a 766 valid chain of trust to a configured CA certificate."; 767 reference 768 "RFC YYYY: YANG Data Model for Global Trust Anchors"; 769 uses ts:local-or-truststore-certs-grouping; 770 } 771 container client-certs { 772 presence 773 "Indicates that the server can authenticate clients 774 using the configured client certificates."; 775 description 776 "A set of end-entity certificates used by the TLS 777 server to authenticate TLS clients. A client is 778 authenticated if its certificate is an exact match 779 to a configured client certificate."; 780 reference 781 "RFC YYYY: YANG Data Model for Global Trust Anchors"; 782 uses ts:local-or-truststore-certs-grouping; 783 } 784 } 785 case external { 786 if-feature "external-client-auth-supported"; 787 description 788 "The certificates needed to authenticate the clients 789 are configured externally."; 790 leaf client-auth-defined-elsewhere { 791 type empty; 792 description 793 "Indicates that certificates needed to authenticate 794 clients are configured elsewhere."; 795 } 796 } 797 } // choice local-or-external 798 } // container client-authentication 800 container hello-params { 801 nacm:default-deny-write; 802 if-feature "tls-server-hello-params-config"; 803 uses tlscmn:hello-params-grouping; 804 description 805 "Configurable parameters for the TLS hello message."; 806 } // container hello-params 808 container keepalives { 809 nacm:default-deny-write; 810 if-feature "tls-server-keepalives"; 811 presence "Indicates that keepalives are enabled."; 812 description 813 "Configures the keep-alive policy, to proactively test 814 the aliveness of the TLS client. An unresponsive 815 TLS client is dropped after approximately max-wait 816 * max-attempts seconds."; 817 leaf max-wait { 818 type uint16 { 819 range "1..max"; 820 } 821 units "seconds"; 822 default "30"; 823 description 824 "Sets the amount of time in seconds after which if 825 no data has been received from the TLS client, a 826 TLS-level message will be sent to test the 827 aliveness of the TLS client."; 828 } 829 leaf max-attempts { 830 type uint8; 831 default "3"; 832 description 833 "Sets the maximum number of sequential keep-alive 834 messages that can fail to obtain a response from 835 the TLS client before assuming the TLS client is 836 no longer alive."; 837 } 838 } // container keepalives 839 } // grouping tls-server-grouping 840 } 842 844 5. The TLS Common Model 846 The TLS common model presented in this section contains identities 847 and groupings common to both TLS clients and TLS servers. The hello- 848 params-grouping can be used to configure the list of TLS algorithms 849 permitted by the TLS client or TLS server. The lists of algorithms 850 are ordered such that, if multiple algorithms are permitted by the 851 client, the algorithm that appears first in its list that is also 852 permitted by the server is used for the TLS transport layer 853 connection. The ability to restrict the algorithms allowed is 854 provided in this grouping for TLS clients and TLS servers that are 855 capable of doing so and may serve to make TLS clients and TLS servers 856 compliant with local security policies. This model supports both 857 TLS1.2 [RFC5246] and TLS 1.3 [RFC8446]. 859 TLS 1.2 and TLS 1.3 have different ways defining their own supported 860 cryptographic algorithms, see TLS and DTLS IANA registries page 861 (https://www.iana.org/assignments/tls-parameters/tls- 862 parameters.xhtml): 864 o TLS 1.2 defines four categories of registries for cryptographic 865 algorithms: TLS Cipher Suites, TLS SignatureAlgorithm, TLS 866 HashAlgorithm, TLS Supported Groups. TLS Cipher Suites plays the 867 role of combining all of them into one set, as each value of the 868 set represents a unique and feasible combination of all the 869 cryptographic algorithms, and thus the other three registry 870 categories do not need to be considered here. In this document, 871 the TLS common model only chooses those TLS1.2 algorithms in TLS 872 Cipher Suites which are marked as recommended: 873 TLS_DHE_RSA_WITH_AES_128_GCM_SHA256, 874 TLS_DHE_RSA_WITH_AES_256_GCM_SHA384, 875 TLS_DHE_PSK_WITH_AES_128_GCM_SHA256, 876 TLS_DHE_PSK_WITH_AES_256_GCM_SHA384, and so on. All chosen 877 algorithms are enumerated in Table 1-1 below; 879 o TLS 1.3 defines its supported algorithms differently. Firstly, it 880 defines three categories of registries for cryptographic 881 algorithms: TLS Cipher Suites, TLS SignatureScheme, TLS Supported 882 Groups. Secondly, all three of these categories are useful, since 883 they represent different parts of all the supported algorithms 884 respectively. Thus, all of these registries categories are 885 considered here. In this draft, the TLS common model chooses only 886 those TLS1.3 algorithms specified in B.4, 4.2.3, 4.2.7 of 887 [RFC8446]. 889 Thus, in order to support both TLS1.2 and TLS1.3, the cipher-suites 890 part of the hello-params-grouping should include three parameters for 891 configuring its permitted TLS algorithms, which are: TLS Cipher 892 Suites, TLS SignatureScheme, TLS Supported Groups. Note that TLS1.2 893 only uses TLS Cipher Suites. 895 [I-D.ietf-netconf-crypto-types] defines six categories of 896 cryptographic algorithms (hash-algorithm, symmetric-key-encryption- 897 algorithm, mac-algorithm, asymmetric-key-encryption-algorithm, 898 signature-algorithm, key-negotiation-algorithm) and lists several 899 widely accepted algorithms for each of them. The TLS client and 900 server models use one or more of these algorithms. The following 901 tables are provided, in part to define the subset of algorithms 902 defined in the crypto-types model used by TLS, and in part to ensure 903 compatibility of configured TLS cryptographic parameters for 904 configuring its permitted TLS algorithms: 906 +-----------------------------------------------+---------+ 907 | ciper-suites in hello-params-grouping | HASH | 908 +-----------------------------------------------+---------+ 909 | TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 | sha-256 | 910 | TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 | sha-384 | 911 | TLS_DHE_PSK_WITH_AES_128_GCM_SHA256 | sha-256 | 912 | TLS_DHE_PSK_WITH_AES_256_GCM_SHA384 | sha-384 | 913 | TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 | sha-256 | 914 | TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 | sha-384 | 915 | TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 | sha-256 | 916 | TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 | sha-384 | 917 | TLS_DHE_RSA_WITH_AES_128_CCM | sha-256 | 918 | TLS_DHE_RSA_WITH_AES_256_CCM | sha-256 | 919 | TLS_DHE_PSK_WITH_AES_128_CCM | sha-256 | 920 | TLS_DHE_PSK_WITH_AES_256_CCM | sha-256 | 921 | TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 | sha-256 | 922 | TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 | sha-256 | 923 | TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 | sha-256 | 924 | TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256 | sha-256 | 925 | TLS_DHE_PSK_WITH_CHACHA20_POLY1305_SHA256 | sha-256 | 926 | TLS_ECDHE_PSK_WITH_AES_128_GCM_SHA256 | sha-256 | 927 | TLS_ECDHE_PSK_WITH_AES_256_GCM_SHA384 | sha-384 | 928 | TLS_ECDHE_PSK_WITH_AES_128_CCM_SHA256 | sha-256 | 929 +-----------------------------------------------+---------+ 931 Table 1-1 TLS 1.2 Compatibility Matrix Part 1: ciper-suites mapping 932 to hash-algorithm 934 +--------------------------------------------- +---------------------+ 935 | ciper-suites in hello-params-grouping | symmetric | 936 | | | 937 +--------------------------------------------- +---------------------+ 938 | TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 | enc-aes-128-gcm | 939 | TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 | enc-aes-256-gcm | 940 | TLS_DHE_PSK_WITH_AES_128_GCM_SHA256 | enc-aes-128-gcm | 941 | TLS_DHE_PSK_WITH_AES_256_GCM_SHA384 | enc-aes-256-gcm | 942 | TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 | enc-aes-128-gcm | 943 | TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 | enc-aes-256-gcm | 944 | TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 | enc-aes-128-gcm | 945 | TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 | enc-aes-256-gcm | 946 | TLS_DHE_RSA_WITH_AES_128_CCM | enc-aes-128-ccm | 947 | TLS_DHE_RSA_WITH_AES_256_CCM | enc-aes-256-ccm | 948 | TLS_DHE_PSK_WITH_AES_128_CCM | enc-aes-128-ccm | 949 | TLS_DHE_PSK_WITH_AES_256_CCM | enc-aes-256-ccm | 950 | TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 |enc-chacha20-poly1305| 951 | TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256|enc-chacha20-poly1305| 952 | TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 |enc-chacha20-poly1305| 953 | TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256 |enc-chacha20-poly1305| 954 | TLS_DHE_PSK_WITH_CHACHA20_POLY1305_SHA256 |enc-chacha20-poly1305| 955 | TLS_ECDHE_PSK_WITH_AES_128_GCM_SHA256 | enc-aes-128-gcm | 956 | TLS_ECDHE_PSK_WITH_AES_256_GCM_SHA384 | enc-aes-256-gcm | 957 | TLS_ECDHE_PSK_WITH_AES_128_CCM_SHA256 | enc-aes-128-ccm | 958 +--------------------------------------------- +---------------------+ 960 Table 1-2 TLS 1.2 Compatibility Matrix Part 2: ciper-suites mapping 961 to symmetric-key-encryption-algorithm 963 +--------------------------------------------- +---------------------+ 964 | ciper-suites in hello-params-grouping | MAC | 965 | | | 966 +--------------------------------------------- +---------------------+ 967 | TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 | mac-aes-128-gcm | 968 | TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 | mac-aes-256-gcm | 969 | TLS_DHE_PSK_WITH_AES_128_GCM_SHA256 | mac-aes-128-gcm | 970 | TLS_DHE_PSK_WITH_AES_256_GCM_SHA384 | mac-aes-256-gcm | 971 | TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 | mac-aes-128-gcm | 972 | TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 | mac-aes-256-gcm | 973 | TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 | mac-aes-128-gcm | 974 | TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 | mac-aes-256-gcm | 975 | TLS_DHE_RSA_WITH_AES_128_CCM | mac-aes-128-ccm | 976 | TLS_DHE_RSA_WITH_AES_256_CCM | mac-aes-256-ccm | 977 | TLS_DHE_PSK_WITH_AES_128_CCM | mac-aes-128-ccm | 978 | TLS_DHE_PSK_WITH_AES_256_CCM | mac-aes-256-ccm | 979 | TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 |mac-chacha20-poly1305| 980 | TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256|mac-chacha20-poly1305| 981 | TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 |mac-chacha20-poly1305| 982 | TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256 |mac-chacha20-poly1305| 983 | TLS_DHE_PSK_WITH_CHACHA20_POLY1305_SHA256 |mac-chacha20-poly1305| 984 | TLS_ECDHE_PSK_WITH_AES_128_GCM_SHA256 | mac-aes-128-gcm | 985 | TLS_ECDHE_PSK_WITH_AES_256_GCM_SHA384 | mac-aes-256-gcm | 986 | TLS_ECDHE_PSK_WITH_AES_128_CCM_SHA256 | mac-aes-128-ccm | 987 +--------------------------------------------- +---------------------+ 989 Table 1-3 TLS 1.2 Compatibility Matrix Part 3: ciper-suites mapping 990 to MAC-algorithm 992 +----------------------------------------------+----------------------+ 993 |ciper-suites in hello-params-grouping | signature | 994 +--------------------------------------------- +----------------------+ 995 | TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 | rsa-pkcs1-sha256 | 996 | TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 | rsa-pkcs1-sha384 | 997 | TLS_DHE_PSK_WITH_AES_128_GCM_SHA256 | N/A | 998 | TLS_DHE_PSK_WITH_AES_256_GCM_SHA384 | N/A | 999 | TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 |ecdsa-secp256r1-sha256| 1000 | TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 |ecdsa-secp384r1-sha384| 1001 | TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 | rsa-pkcs1-sha256 | 1002 | TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 | rsa-pkcs1-sha384 | 1003 | TLS_DHE_RSA_WITH_AES_128_CCM | rsa-pkcs1-sha256 | 1004 | TLS_DHE_RSA_WITH_AES_256_CCM | rsa-pkcs1-sha256 | 1005 | TLS_DHE_PSK_WITH_AES_128_CCM | N/A | 1006 | TLS_DHE_PSK_WITH_AES_256_CCM | N/A | 1007 | TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 | rsa-pkcs1-sha256 | 1008 | TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256|ecdsa-secp256r1-sha256| 1009 | TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 | rsa-pkcs1-sha256 | 1010 | TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256 | N/A | 1011 | TLS_DHE_PSK_WITH_CHACHA20_POLY1305_SHA256 | N/A | 1012 | TLS_ECDHE_PSK_WITH_AES_128_GCM_SHA256 | N/A | 1013 | TLS_ECDHE_PSK_WITH_AES_256_GCM_SHA384 | N/A | 1014 | TLS_ECDHE_PSK_WITH_AES_128_CCM_SHA256 | N/A | 1015 +----------------------------------------------+----------------------+ 1017 Table 1-4 TLS 1.2 Compatibility Matrix Part 4: ciper-suites mapping 1018 to signature-algorithm 1020 +----------------------------------------------+-----------------------+ 1021 |ciper-suites in hello-params-grouping | key-negotiation | 1022 +----------------------------------------------+-----------------------+ 1023 | TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 | dhe-ffdhe2048, ... | 1024 | TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 | dhe-ffdhe2048, ... | 1025 | TLS_DHE_PSK_WITH_AES_128_GCM_SHA256 | psk-dhe-ffdhe2048, ...| 1026 | TLS_DHE_PSK_WITH_AES_256_GCM_SHA384 | psk-dhe-ffdhe2048, ...| 1027 | TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 | ecdhe-secp256r1, ... | 1028 | TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 | ecdhe-secp256r1, ... | 1029 | TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 | ecdhe-secp256r1, ... | 1030 | TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 | ecdhe-secp256r1, ... | 1031 | TLS_DHE_RSA_WITH_AES_128_CCM | dhe-ffdhe2048, ... | 1032 | TLS_DHE_RSA_WITH_AES_256_CCM | dhe-ffdhe2048, ... | 1033 | TLS_DHE_PSK_WITH_AES_128_CCM | psk-dhe-ffdhe2048, ...| 1034 | TLS_DHE_PSK_WITH_AES_256_CCM | psk-dhe-ffdhe2048, ...| 1035 | TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 | ecdhe-secp256r1, ... | 1036 | TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256| ecdhe-secp256r1, ... | 1037 | TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 | dhe-ffdhe2048, ... | 1038 | TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256 |psk-ecdhe-secp256r1,...| 1039 | TLS_DHE_PSK_WITH_CHACHA20_POLY1305_SHA256 | psk-dhe-ffdhe2048, ...| 1040 | TLS_ECDHE_PSK_WITH_AES_128_GCM_SHA256 |psk-ecdhe-secp256r1,...| 1041 | TLS_ECDHE_PSK_WITH_AES_256_GCM_SHA384 |psk-ecdhe-secp256r1,...| 1042 | TLS_ECDHE_PSK_WITH_AES_128_CCM_SHA256 |psk-ecdhe-secp256r1,...| 1043 +----------------------------------------------+-----------------------+ 1045 Table 1-5 TLS 1.2 Compatibility Matrix Part 5: ciper-suites mapping 1046 to key-negotiation-algorithm 1048 +------------------------------+---------+ 1049 | ciper-suites in hello | HASH | 1050 | -params-grouping | | 1051 +------------------------------+---------+ 1052 | TLS_AES_128_GCM_SHA256 | sha-256 | 1053 | TLS_AES_256_GCM_SHA384 | sha-384 | 1054 | TLS_CHACHA20_POLY1305_SHA256 | sha-256 | 1055 | TLS_AES_128_CCM_SHA256 | sha-256 | 1056 +------------------------------+---------+ 1058 Table 2-1 TLS 1.3 Compatibility Matrix Part 1: ciper-suites mapping 1059 to hash-algorithm 1061 +------------------------------+-----------------------+ 1062 | ciper-suites in hello | symmetric | 1063 | -params-grouping | | 1064 +------------------------------+-----------------------+ 1065 | TLS_AES_128_GCM_SHA256 | enc-aes-128-gcm | 1066 | TLS_AES_256_GCM_SHA384 | enc-aes-128-gcm | 1067 | TLS_CHACHA20_POLY1305_SHA256 | enc-chacha20-poly1305 | 1068 | TLS_AES_128_CCM_SHA256 | enc-aes-128-ccm | 1069 +------------------------------+-----------------------+ 1071 Table 2-2 TLS 1.3 Compatibility Matrix Part 2: ciper-suites mapping 1072 to symmetric-key--encryption-algorithm 1074 +------------------------------+-----------------------+ 1075 | ciper-suites in hello | symmetric | 1076 | -params-grouping | | 1077 +------------------------------+-----------------------+ 1078 | TLS_AES_128_GCM_SHA256 | mac-aes-128-gcm | 1079 | TLS_AES_256_GCM_SHA384 | mac-aes-128-gcm | 1080 | TLS_CHACHA20_POLY1305_SHA256 | mac-chacha20-poly1305 | 1081 | TLS_AES_128_CCM_SHA256 | mac-aes-128-ccm | 1082 +------------------------------+-----------------------+ 1084 Table 2-3 TLS 1.3 Compatibility Matrix Part 3: ciper-suites mapping 1085 to MAC-algorithm 1087 +----------------------------+-------------------------+ 1088 |signatureScheme in hello | signature | 1089 | -params-grouping | | 1090 +----------------------------+-------------------------+ 1091 | rsa-pkcs1-sha256 | rsa-pkcs1-sha256 | 1092 | rsa-pkcs1-sha384 | rsa-pkcs1-sha384 | 1093 | rsa-pkcs1-sha512 | rsa-pkcs1-sha512 | 1094 | rsa-pss-rsae-sha256 | rsa-pss-rsae-sha256 | 1095 | rsa-pss-rsae-sha384 | rsa-pss-rsae-sha384 | 1096 | rsa-pss-rsae-sha512 | rsa-pss-rsae-sha512 | 1097 | rsa-pss-pss-sha256 | rsa-pss-pss-sha256 | 1098 | rsa-pss-pss-sha384 | rsa-pss-pss-sha384 | 1099 | rsa-pss-pss-sha512 | rsa-pss-pss-sha512 | 1100 | ecdsa-secp256r1-sha256 | ecdsa-secp256r1-sha256 | 1101 | ecdsa-secp384r1-sha384 | ecdsa-secp384r1-sha384 | 1102 | ecdsa-secp521r1-sha512 | ecdsa-secp521r1-sha512 | 1103 | ed25519 | ed25519 | 1104 | ed448 | ed448 | 1105 +----------------------------+-------------------------+ 1107 Table 2-4 TLS 1.3 Compatibility Matrix Part 4: SignatureScheme 1108 mapping to signature-algorithm 1110 +----------------------------+-------------------------+ 1111 |supported Groups in hello | key-negotiation | 1112 | -params-grouping | | 1113 +----------------------------+-------------------------+ 1114 | dhe-ffdhe2048 | dhe-ffdhe2048 | 1115 | dhe-ffdhe3072 | dhe-ffdhe3072 | 1116 | dhe-ffdhe4096 | dhe-ffdhe4096 | 1117 | dhe-ffdhe6144 | dhe-ffdhe6144 | 1118 | dhe-ffdhe8192 | dhe-ffdhe8192 | 1119 | psk-dhe-ffdhe2048 | psk-dhe-ffdhe2048 | 1120 | psk-dhe-ffdhe3072 | psk-dhe-ffdhe3072 | 1121 | psk-dhe-ffdhe4096 | psk-dhe-ffdhe4096 | 1122 | psk-dhe-ffdhe6144 | psk-dhe-ffdhe6144 | 1123 | psk-dhe-ffdhe8192 | psk-dhe-ffdhe8192 | 1124 | ecdhe-secp256r1 | ecdhe-secp256r1 | 1125 | ecdhe-secp384r1 | ecdhe-secp384r1 | 1126 | ecdhe-secp521r1 | ecdhe-secp521r1 | 1127 | ecdhe-x25519 | ecdhe-x25519 | 1128 | ecdhe-x448 | ecdhe-x448 | 1129 | psk-ecdhe-secp256r1 | psk-ecdhe-secp256r1 | 1130 | psk-ecdhe-secp384r1 | psk-ecdhe-secp384r1 | 1131 | psk-ecdhe-secp521r1 | psk-ecdhe-secp521r1 | 1132 | psk-ecdhe-x25519 | psk-ecdhe-x25519 | 1133 | psk-ecdhe-x448 | psk-ecdhe-x448 | 1134 +----------------------------+-------------------------+ 1136 Table 2-5 TLS 1.3 Compatibility Matrix Part 5: Supported Groups 1137 mapping to key-negotiation-algorithm 1139 Note that in Table 1-5: 1141 o dhe-ffdhe2048, ... is the abbreviation of dhe-ffdhe2048, dhe- 1142 ffdhe3072, dhe-ffdhe4096, dhe-ffdhe6144, dhe-ffdhe8192; 1144 o psk-dhe-ffdhe2048, ... is the abbreviation of psk-dhe-ffdhe2048, 1145 psk-dhe-ffdhe3072, psk-dhe-ffdhe4096, psk-dhe-ffdhe6144, psk-dhe- 1146 ffdhe8192; 1148 o ecdhe-secp256r1, ... is the abbreviation of ecdhe-secp256r1, 1149 ecdhe-secp384r1, ecdhe-secp521r1, ecdhe-x25519, ecdhe-x448; 1151 o psk-ecdhe-secp256r1, ... is the abbreviation of psk-ecdhe- 1152 secp256r1, psk-ecdhe-secp384r1, psk-ecdhe-secp521r1, psk-ecdhe- 1153 x25519, psk-ecdhe-x448. 1155 Features are defined for algorithms that are OPTIONAL or are not 1156 widely supported by popular implementations. Note that the list of 1157 algorithms is not exhaustive. 1159 5.1. Tree Diagram 1161 The following tree diagram [RFC8340] provides an overview of the data 1162 model for the "ietf-tls-common" module. 1164 module: ietf-tls-common 1166 grouping hello-params-grouping 1167 +-- tls-versions 1168 | +-- tls-version* identityref 1169 +-- cipher-suites 1170 +-- cipher-suite* identityref 1172 5.2. Example Usage 1174 This section shows how it would appear if the transport-params- 1175 grouping were populated with some data. 1177 1180 1181 tlscmn:tls-1.1 1182 tlscmn:tls-1.2 1183 1184 1185 tlscmn:dhe-rsa-with-aes-128-cbc-sha 1186 tlscmn:rsa-with-aes-128-cbc-sha 1187 tlscmn:rsa-with-3des-ede-cbc-sha 1188 1189 1191 5.3. YANG Module 1193 This YANG module has a normative references to [RFC4346], [RFC5246], 1194 [RFC5288], [RFC5289], and [RFC8422]. 1196 This YANG module has a informative references to [RFC2246], 1197 [RFC4346], [RFC5246], and [RFC8446]. 1199 file "ietf-tls-common@2019-11-02.yang" 1201 module ietf-tls-common { 1202 yang-version 1.1; 1203 namespace "urn:ietf:params:xml:ns:yang:ietf-tls-common"; 1204 prefix tlscmn; 1206 organization 1207 "IETF NETCONF (Network Configuration) Working Group"; 1209 contact 1210 "WG Web: 1211 WG List: 1212 Author: Kent Watsen 1213 Author: Gary Wu "; 1215 description 1216 "This module defines a common features, identities, and 1217 groupings for Transport Layer Security (TLS). 1219 Copyright (c) 2019 IETF Trust and the persons identified 1220 as authors of the code. All rights reserved. 1222 Redistribution and use in source and binary forms, with 1223 or without modification, is permitted pursuant to, and 1224 subject to the license terms contained in, the Simplified 1225 BSD License set forth in Section 4.c of the IETF Trust's 1226 Legal Provisions Relating to IETF Documents 1227 (https://trustee.ietf.org/license-info). 1229 This version of this YANG module is part of RFC XXXX 1230 (https://www.rfc-editor.org/info/rfcXXXX); see the RFC 1231 itself for full legal notices.; 1233 The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 1234 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 1235 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document 1236 are to be interpreted as described in BCP 14 (RFC 2119) 1237 (RFC 8174) when, and only when, they appear in all 1238 capitals, as shown here."; 1240 revision 2019-11-02 { 1241 description 1242 "Initial version"; 1243 reference 1244 "RFC XXXX: YANG Groupings for TLS Clients and TLS Servers"; 1245 } 1247 // Features 1249 feature tls-1_0 { 1250 description 1251 "TLS Protocol Version 1.0 is supported."; 1252 reference 1253 "RFC 2246: The TLS Protocol Version 1.0"; 1254 } 1255 feature tls-1_1 { 1256 description 1257 "TLS Protocol Version 1.1 is supported."; 1258 reference 1259 "RFC 4346: The Transport Layer Security (TLS) Protocol 1260 Version 1.1"; 1261 } 1263 feature tls-1_2 { 1264 description 1265 "TLS Protocol Version 1.2 is supported."; 1266 reference 1267 "RFC 5246: The Transport Layer Security (TLS) Protocol 1268 Version 1.2"; 1269 } 1271 feature tls-1_3 { 1272 description 1273 "TLS Protocol Version 1.2 is supported."; 1274 reference 1275 "RFC 8446: The Transport Layer Security (TLS) Protocol 1276 Version 1.3"; 1277 } 1279 feature tls-ecc { 1280 description 1281 "Elliptic Curve Cryptography (ECC) is supported for TLS."; 1282 reference 1283 "RFC 8422: Elliptic Curve Cryptography (ECC) Cipher Suites 1284 for Transport Layer Security (TLS)"; 1285 } 1287 feature tls-dhe { 1288 description 1289 "Ephemeral Diffie-Hellman key exchange is supported for TLS."; 1290 reference 1291 "RFC 5246: The Transport Layer Security (TLS) Protocol 1292 Version 1.2"; 1293 } 1295 feature tls-3des { 1296 description 1297 "The Triple-DES block cipher is supported for TLS."; 1298 reference 1299 "RFC 5246: The Transport Layer Security (TLS) Protocol 1300 Version 1.2"; 1301 } 1302 feature tls-gcm { 1303 description 1304 "The Galois/Counter Mode authenticated encryption mode is 1305 supported for TLS."; 1306 reference 1307 "RFC 5288: AES Galois Counter Mode (GCM) Cipher Suites for 1308 TLS"; 1309 } 1311 feature tls-sha2 { 1312 description 1313 "The SHA2 family of cryptographic hash functions is supported 1314 for TLS."; 1315 reference 1316 "FIPS PUB 180-4: Secure Hash Standard (SHS)"; 1317 } 1319 // Identities 1321 identity tls-version-base { 1322 description 1323 "Base identity used to identify TLS protocol versions."; 1324 } 1326 identity tls-1.0 { 1327 if-feature "tls-1_0"; 1328 base tls-version-base; 1329 description 1330 "TLS Protocol Version 1.0."; 1331 reference 1332 "RFC 2246: The TLS Protocol Version 1.0"; 1333 } 1335 identity tls-1.1 { 1336 if-feature "tls-1_1"; 1337 base tls-version-base; 1338 description 1339 "TLS Protocol Version 1.1."; 1340 reference 1341 "RFC 4346: The Transport Layer Security (TLS) Protocol 1342 Version 1.1"; 1343 } 1345 identity tls-1.2 { 1346 if-feature "tls-1_2"; 1347 base tls-version-base; 1348 description 1349 "TLS Protocol Version 1.2."; 1351 reference 1352 "RFC 5246: The Transport Layer Security (TLS) Protocol 1353 Version 1.2"; 1354 } 1356 identity cipher-suite-base { 1357 description 1358 "Base identity used to identify TLS cipher suites."; 1359 } 1361 identity rsa-with-aes-128-cbc-sha { 1362 base cipher-suite-base; 1363 description 1364 "Cipher suite TLS_RSA_WITH_AES_128_CBC_SHA."; 1365 reference 1366 "RFC 5246: The Transport Layer Security (TLS) Protocol 1367 Version 1.2"; 1368 } 1370 identity rsa-with-aes-256-cbc-sha { 1371 base cipher-suite-base; 1372 description 1373 "Cipher suite TLS_RSA_WITH_AES_256_CBC_SHA."; 1374 reference 1375 "RFC 5246: The Transport Layer Security (TLS) Protocol 1376 Version 1.2"; 1377 } 1379 identity rsa-with-aes-128-cbc-sha256 { 1380 if-feature "tls-sha2"; 1381 base cipher-suite-base; 1382 description 1383 "Cipher suite TLS_RSA_WITH_AES_128_CBC_SHA256."; 1384 reference 1385 "RFC 5246: The Transport Layer Security (TLS) Protocol 1386 Version 1.2"; 1387 } 1389 identity rsa-with-aes-256-cbc-sha256 { 1390 if-feature "tls-sha2"; 1391 base cipher-suite-base; 1392 description 1393 "Cipher suite TLS_RSA_WITH_AES_256_CBC_SHA256."; 1394 reference 1395 "RFC 5246: The Transport Layer Security (TLS) Protocol 1396 Version 1.2"; 1397 } 1398 identity dhe-rsa-with-aes-128-cbc-sha { 1399 if-feature "tls-dhe"; 1400 base cipher-suite-base; 1401 description 1402 "Cipher suite TLS_DHE_RSA_WITH_AES_128_CBC_SHA."; 1403 reference 1404 "RFC 5246: The Transport Layer Security (TLS) Protocol 1405 Version 1.2"; 1406 } 1408 identity dhe-rsa-with-aes-256-cbc-sha { 1409 if-feature "tls-dhe"; 1410 base cipher-suite-base; 1411 description 1412 "Cipher suite TLS_DHE_RSA_WITH_AES_256_CBC_SHA."; 1413 reference 1414 "RFC 5246: The Transport Layer Security (TLS) Protocol 1415 Version 1.2"; 1416 } 1418 identity dhe-rsa-with-aes-128-cbc-sha256 { 1419 if-feature "tls-dhe and tls-sha2"; 1420 base cipher-suite-base; 1421 description 1422 "Cipher suite TLS_DHE_RSA_WITH_AES_128_CBC_SHA256."; 1423 reference 1424 "RFC 5246: The Transport Layer Security (TLS) Protocol 1425 Version 1.2"; 1426 } 1428 identity dhe-rsa-with-aes-256-cbc-sha256 { 1429 if-feature "tls-dhe and tls-sha2"; 1430 base cipher-suite-base; 1431 description 1432 "Cipher suite TLS_DHE_RSA_WITH_AES_256_CBC_SHA256."; 1433 reference 1434 "RFC 5246: The Transport Layer Security (TLS) Protocol 1435 Version 1.2"; 1436 } 1438 identity ecdhe-ecdsa-with-aes-128-cbc-sha256 { 1439 if-feature "tls-ecc and tls-sha2"; 1440 base cipher-suite-base; 1441 description 1442 "Cipher suite TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256."; 1443 reference 1444 "RFC 5289: TLS Elliptic Curve Cipher Suites with 1445 SHA-256/384 and AES Galois Counter Mode (GCM)"; 1447 } 1449 identity ecdhe-ecdsa-with-aes-256-cbc-sha384 { 1450 if-feature "tls-ecc and tls-sha2"; 1451 base cipher-suite-base; 1452 description 1453 "Cipher suite TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384."; 1454 reference 1455 "RFC 5289: TLS Elliptic Curve Cipher Suites with 1456 SHA-256/384 and AES Galois Counter Mode (GCM)"; 1457 } 1459 identity ecdhe-rsa-with-aes-128-cbc-sha256 { 1460 if-feature "tls-ecc and tls-sha2"; 1461 base cipher-suite-base; 1462 description 1463 "Cipher suite TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256."; 1464 reference 1465 "RFC 5289: TLS Elliptic Curve Cipher Suites with 1466 SHA-256/384 and AES Galois Counter Mode (GCM)"; 1467 } 1469 identity ecdhe-rsa-with-aes-256-cbc-sha384 { 1470 if-feature "tls-ecc and tls-sha2"; 1471 base cipher-suite-base; 1472 description 1473 "Cipher suite TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384."; 1474 reference 1475 "RFC 5289: TLS Elliptic Curve Cipher Suites with 1476 SHA-256/384 and AES Galois Counter Mode (GCM)"; 1477 } 1479 identity ecdhe-ecdsa-with-aes-128-gcm-sha256 { 1480 if-feature "tls-ecc and tls-gcm and tls-sha2"; 1481 base cipher-suite-base; 1482 description 1483 "Cipher suite TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256."; 1484 reference 1485 "RFC 5289: TLS Elliptic Curve Cipher Suites with 1486 SHA-256/384 and AES Galois Counter Mode (GCM)"; 1487 } 1489 identity ecdhe-ecdsa-with-aes-256-gcm-sha384 { 1490 if-feature "tls-ecc and tls-gcm and tls-sha2"; 1491 base cipher-suite-base; 1492 description 1493 "Cipher suite TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384."; 1494 reference 1495 "RFC 5289: TLS Elliptic Curve Cipher Suites with 1496 SHA-256/384 and AES Galois Counter Mode (GCM)"; 1497 } 1499 identity ecdhe-rsa-with-aes-128-gcm-sha256 { 1500 if-feature "tls-ecc and tls-gcm and tls-sha2"; 1501 base cipher-suite-base; 1502 description 1503 "Cipher suite TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256."; 1504 reference 1505 "RFC 5289: TLS Elliptic Curve Cipher Suites with 1506 SHA-256/384 and AES Galois Counter Mode (GCM)"; 1507 } 1509 identity ecdhe-rsa-with-aes-256-gcm-sha384 { 1510 if-feature "tls-ecc and tls-gcm and tls-sha2"; 1511 base cipher-suite-base; 1512 description 1513 "Cipher suite TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384."; 1514 reference 1515 "RFC 5289: TLS Elliptic Curve Cipher Suites with 1516 SHA-256/384 and AES Galois Counter Mode (GCM)"; 1517 } 1519 identity rsa-with-3des-ede-cbc-sha { 1520 if-feature "tls-3des"; 1521 base cipher-suite-base; 1522 description 1523 "Cipher suite TLS_RSA_WITH_3DES_EDE_CBC_SHA."; 1524 reference 1525 "RFC 5246: The Transport Layer Security (TLS) Protocol 1526 Version 1.2"; 1527 } 1529 identity ecdhe-rsa-with-3des-ede-cbc-sha { 1530 if-feature "tls-ecc and tls-3des"; 1531 base cipher-suite-base; 1532 description 1533 "Cipher suite TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA."; 1534 reference 1535 "RFC 8422: Elliptic Curve Cryptography (ECC) Cipher Suites 1536 for Transport Layer Security (TLS)"; 1537 } 1539 identity ecdhe-rsa-with-aes-128-cbc-sha { 1540 if-feature "tls-ecc"; 1541 base cipher-suite-base; 1542 description 1543 "Cipher suite TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA."; 1544 reference 1545 "RFC 8422: Elliptic Curve Cryptography (ECC) Cipher Suites 1546 for Transport Layer Security (TLS)"; 1547 } 1549 identity ecdhe-rsa-with-aes-256-cbc-sha { 1550 if-feature "tls-ecc"; 1551 base cipher-suite-base; 1552 description 1553 "Cipher suite TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA."; 1554 reference 1555 "RFC 8422: Elliptic Curve Cryptography (ECC) Cipher Suites 1556 for Transport Layer Security (TLS)"; 1557 } 1559 // Groupings 1561 grouping hello-params-grouping { 1562 description 1563 "A reusable grouping for TLS hello message parameters."; 1564 reference 1565 "RFC 5246: The Transport Layer Security (TLS) Protocol 1566 Version 1.2"; 1567 container tls-versions { 1568 description 1569 "Parameters regarding TLS versions."; 1570 leaf-list tls-version { 1571 type identityref { 1572 base tls-version-base; 1573 } 1574 description 1575 "Acceptable TLS protocol versions. 1577 If this leaf-list is not configured (has zero elements) 1578 the acceptable TLS protocol versions are implementation- 1579 defined."; 1580 } 1581 } 1582 container cipher-suites { 1583 description 1584 "Parameters regarding cipher suites."; 1585 leaf-list cipher-suite { 1586 type identityref { 1587 base cipher-suite-base; 1588 } 1589 ordered-by user; 1590 description 1591 "Acceptable cipher suites in order of descending 1592 preference. The configured host key algorithms should 1593 be compatible with the algorithm used by the configured 1594 private key. Please see Section 5 of RFC XXXX for 1595 valid combinations. 1597 If this leaf-list is not configured (has zero elements) 1598 the acceptable cipher suites are implementation- 1599 defined."; 1600 reference 1601 "RFC XXXX: YANG Groupings for TLS Clients and TLS Servers"; 1602 } 1603 } 1604 } 1605 } 1607 1609 6. Security Considerations 1611 The YANG modules defined in this document are designed to be accessed 1612 via YANG based management protocols, such as NETCONF [RFC6241] and 1613 RESTCONF [RFC8040]. Both of these protocols have mandatory-to- 1614 implement secure transport layers (e.g., SSH, TLS) with mutual 1615 authentication. 1617 The NETCONF access control model (NACM) [RFC8341] provides the means 1618 to restrict access for particular users to a pre-configured subset of 1619 all available protocol operations and content. 1621 Since the modules in this document only define groupings, these 1622 considerations are primarily for the designers of other modules that 1623 use these groupings. 1625 There are a number of data nodes defined in the YANG modules that are 1626 writable/creatable/deletable (i.e., config true, which is the 1627 default). These data nodes may be considered sensitive or vulnerable 1628 in some network environments. Write operations (e.g., edit-config) 1629 to these data nodes without proper protection can have a negative 1630 effect on network operations. These are the subtrees and data nodes 1631 and their sensitivity/vulnerability: 1633 *: The entire subtree defined by the grouping statement in both 1634 the "ietf-ssh-client" and "ietf-ssh-server" modules is 1635 sensitive to write operations. For instance, the addition or 1636 removal of references to keys, certificates, trusted anchors, 1637 etc., or even the modification of transport or keepalive 1638 parameters can dramatically alter the implemented security 1639 policy. For this reason, this node is protected the NACM 1640 extension "default-deny-write". 1642 Some of the readable data nodes in the YANG modules may be considered 1643 sensitive or vulnerable in some network environments. It is thus 1644 important to control read access (e.g., via get, get-config, or 1645 notification) to these data nodes. These are the subtrees and data 1646 nodes and their sensitivity/vulnerability: 1648 /tls-client-parameters/client-identity/: This subtree in the 1649 "ietf-tls-client" module contains nodes that are additionally 1650 sensitive to read operations such that, in normal use cases, 1651 they should never be returned to a client. Some of these nodes 1652 (i.e., public-key/local-definition/private-key and certificate/ 1653 local-definition/private-key) are already protected by the NACM 1654 extension "default-deny-all" set in the "grouping" statements 1655 defined in [I-D.ietf-netconf-crypto-types]. 1657 /tls-server-parameters/server-identity/: This subtree in the 1658 "ietf-tls-server" module contains nodes that are additionally 1659 sensitive to read operations such that, in normal use cases, 1660 they should never be returned to a client. All of these nodes 1661 (i.e., host-key/public-key/local-definition/private-key and 1662 host-key/certificate/local-definition/private-key) are already 1663 protected by the NACM extension "default-deny-all" set in the 1664 "grouping" statements defined in 1665 [I-D.ietf-netconf-crypto-types]. 1667 Some of the operations in this YANG module may be considered 1668 sensitive or vulnerable in some network environments. It is thus 1669 important to control access to these operations. These are the 1670 operations and their sensitivity/vulnerability: 1672 *: The groupings defined in this document include "action" 1673 statements that come from groupings defined in 1674 [I-D.ietf-netconf-crypto-types]. Please consult that document 1675 for the security considerations of the "action" statements 1676 defined by the "grouping" statements defined in this document. 1678 7. IANA Considerations 1680 7.1. The IETF XML Registry 1682 This document registers three URIs in the "ns" subregistry of the 1683 IETF XML Registry [RFC3688]. Following the format in [RFC3688], the 1684 following registrations are requested: 1686 URI: urn:ietf:params:xml:ns:yang:ietf-tls-client 1687 Registrant Contact: The NETCONF WG of the IETF. 1688 XML: N/A, the requested URI is an XML namespace. 1690 URI: urn:ietf:params:xml:ns:yang:ietf-tls-server 1691 Registrant Contact: The NETCONF WG of the IETF. 1692 XML: N/A, the requested URI is an XML namespace. 1694 URI: urn:ietf:params:xml:ns:yang:ietf-tls-common 1695 Registrant Contact: The NETCONF WG of the IETF. 1696 XML: N/A, the requested URI is an XML namespace. 1698 7.2. The YANG Module Names Registry 1700 This document registers three YANG modules in the YANG Module Names 1701 registry [RFC6020]. Following the format in [RFC6020], the following 1702 registrations are requested: 1704 name: ietf-tls-client 1705 namespace: urn:ietf:params:xml:ns:yang:ietf-tls-client 1706 prefix: tlsc 1707 reference: RFC XXXX 1709 name: ietf-tls-server 1710 namespace: urn:ietf:params:xml:ns:yang:ietf-tls-server 1711 prefix: tlss 1712 reference: RFC XXXX 1714 name: ietf-tls-common 1715 namespace: urn:ietf:params:xml:ns:yang:ietf-tls-common 1716 prefix: tlscmn 1717 reference: RFC XXXX 1719 8. References 1721 8.1. Normative References 1723 [I-D.ietf-netconf-crypto-types] 1724 Watsen, K. and H. Wang, "Common YANG Data Types for 1725 Cryptography", draft-ietf-netconf-crypto-types-11 (work in 1726 progress), October 2019. 1728 [I-D.ietf-netconf-keystore] 1729 Watsen, K., "A YANG Data Model for a Keystore", draft- 1730 ietf-netconf-keystore-13 (work in progress), October 2019. 1732 [I-D.ietf-netconf-trust-anchors] 1733 Watsen, K., "A YANG Data Model for a Truststore", draft- 1734 ietf-netconf-trust-anchors-06 (work in progress), October 1735 2019. 1737 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1738 Requirement Levels", BCP 14, RFC 2119, 1739 DOI 10.17487/RFC2119, March 1997, 1740 . 1742 [RFC5288] Salowey, J., Choudhury, A., and D. McGrew, "AES Galois 1743 Counter Mode (GCM) Cipher Suites for TLS", RFC 5288, 1744 DOI 10.17487/RFC5288, August 2008, 1745 . 1747 [RFC5289] Rescorla, E., "TLS Elliptic Curve Cipher Suites with SHA- 1748 256/384 and AES Galois Counter Mode (GCM)", RFC 5289, 1749 DOI 10.17487/RFC5289, August 2008, 1750 . 1752 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for 1753 the Network Configuration Protocol (NETCONF)", RFC 6020, 1754 DOI 10.17487/RFC6020, October 2010, 1755 . 1757 [RFC7589] Badra, M., Luchuk, A., and J. Schoenwaelder, "Using the 1758 NETCONF Protocol over Transport Layer Security (TLS) with 1759 Mutual X.509 Authentication", RFC 7589, 1760 DOI 10.17487/RFC7589, June 2015, 1761 . 1763 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 1764 RFC 7950, DOI 10.17487/RFC7950, August 2016, 1765 . 1767 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 1768 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 1769 May 2017, . 1771 [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration 1772 Access Control Model", STD 91, RFC 8341, 1773 DOI 10.17487/RFC8341, March 2018, 1774 . 1776 [RFC8422] Nir, Y., Josefsson, S., and M. Pegourie-Gonnard, "Elliptic 1777 Curve Cryptography (ECC) Cipher Suites for Transport Layer 1778 Security (TLS) Versions 1.2 and Earlier", RFC 8422, 1779 DOI 10.17487/RFC8422, August 2018, 1780 . 1782 [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol 1783 Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, 1784 . 1786 8.2. Informative References 1788 [RFC2246] Dierks, T. and C. Allen, "The TLS Protocol Version 1.0", 1789 RFC 2246, DOI 10.17487/RFC2246, January 1999, 1790 . 1792 [RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, 1793 DOI 10.17487/RFC2818, May 2000, 1794 . 1796 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 1797 DOI 10.17487/RFC3688, January 2004, 1798 . 1800 [RFC4346] Dierks, T. and E. Rescorla, "The Transport Layer Security 1801 (TLS) Protocol Version 1.1", RFC 4346, 1802 DOI 10.17487/RFC4346, April 2006, 1803 . 1805 [RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security 1806 (TLS) Protocol Version 1.2", RFC 5246, 1807 DOI 10.17487/RFC5246, August 2008, 1808 . 1810 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., 1811 and A. Bierman, Ed., "Network Configuration Protocol 1812 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, 1813 . 1815 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF 1816 Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, 1817 . 1819 [RFC8071] Watsen, K., "NETCONF Call Home and RESTCONF Call Home", 1820 RFC 8071, DOI 10.17487/RFC8071, February 2017, 1821 . 1823 [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", 1824 BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, 1825 . 1827 Appendix A. Change Log 1829 A.1. 00 to 01 1831 o Noted that '0.0.0.0' and '::' might have special meanings. 1833 o Renamed "keychain" to "keystore". 1835 A.2. 01 to 02 1837 o Removed the groupings containing transport-level configuration. 1838 Now modules contain only the transport-independent groupings. 1840 o Filled in previously incomplete 'ietf-tls-client' module. 1842 o Added cipher suites for various algorithms into new 'ietf-tls- 1843 common' module. 1845 A.3. 02 to 03 1847 o Added a 'must' statement to container 'server-auth' asserting that 1848 at least one of the various auth mechanisms must be specified. 1850 o Fixed description statement for leaf 'trusted-ca-certs'. 1852 A.4. 03 to 04 1854 o Updated title to "YANG Groupings for TLS Clients and TLS Servers" 1856 o Updated leafref paths to point to new keystore path 1858 o Changed the YANG prefix for ietf-tls-common from 'tlscom' to 1859 'tlscmn'. 1861 o Added TLS protocol verions 1.0 and 1.1. 1863 o Made author lists consistent 1865 o Now tree diagrams reference ietf-netmod-yang-tree-diagrams 1867 o Updated YANG to use typedefs around leafrefs to common keystore 1868 paths 1870 o Now inlines key and certificates (no longer a leafref to keystore) 1872 A.5. 04 to 05 1874 o Merged changes from co-author. 1876 A.6. 05 to 06 1878 o Updated to use trust anchors from trust-anchors draft (was 1879 keystore draft) 1881 o Now Uses new keystore grouping enabling asymmetric key to be 1882 either locally defined or a reference to the keystore. 1884 A.7. 06 to 07 1886 o factored the tls-[client|server]-groupings into more reusable 1887 groupings. 1889 o added if-feature statements for the new "x509-certificates" 1890 feature defined in draft-ietf-netconf-trust-anchors. 1892 A.8. 07 to 08 1894 o Added a number of compatibility matrices to Section 5 (thanks 1895 Frank!) 1897 o Clarified that any configured "cipher-suite" values need to be 1898 compatible with the configured private key. 1900 A.9. 08 to 09 1902 o Updated examples to reflect update to groupings defined in the 1903 keystore draft. 1905 o Add TLS keepalives features and groupings. 1907 o Prefixed top-level TLS grouping nodes with 'tls-' and support 1908 mashups. 1910 o Updated copyright date, boilerplate template, affiliation, and 1911 folding algorithm. 1913 A.10. 09 to 10 1915 o Reformatted the YANG modules. 1917 A.11. 10 to 11 1919 o Collapsed all the inner groupings into the top-level grouping. 1921 o Added a top-level "demux container" inside the top-level grouping. 1923 o Added NACM statements and updated the Security Considerations 1924 section. 1926 o Added "presence" statements on the "keepalive" containers, as was 1927 needed to address a validation error that appeared after adding 1928 the "must" statements into the NETCONF/RESTCONF client/server 1929 modules. 1931 o Updated the boilerplate text in module-level "description" 1932 statement to match copyeditor convention. 1934 A.12. 11 to 12 1936 o In server model, made 'client-authentication' a 'presence' node 1937 indicating that the server supports client authentication. 1939 o In the server model, added a 'required-or-optional' choice to 1940 'client-authentication' to better support protocols such as 1941 RESTCONF. 1943 o In the server model, added a 'local-or-external' choice to 1944 'client-authentication' to better support consuming data models 1945 that prefer to keep client auth with client definitions than in a 1946 model principally concerned with the "transport". 1948 o In both models, removed the "demux containers", floating the 1949 nacm:default-deny-write to each descendent node, and adding a note 1950 to model designers regarding the potential need to add their own 1951 demux containers. 1953 o Fixed a couple references (section 2 --> section 3) 1955 A.13. 12 to 13 1957 o Updated to reflect changes in trust-anchors drafts (e.g., s/trust- 1958 anchors/truststore/g + s/pinned.//) 1960 A.14. 12 to 13 1962 o Removed 'container' under 'client-identity' to match server model. 1964 o Updated examples to reflect change grouping in keystore module. 1966 A.15. 13 to 14 1968 o Removed the "certificate" container from "client-identity" in the 1969 ietf-tls-client module. 1971 o Updated examples to reflect ietf-crypto-types change (e.g., 1972 identities --> enumerations) 1974 A.16. 14 to 15 1976 o Updated "server-authentication" and "client-authentication" nodes 1977 from being a leaf of type "ts:certificates-ref" to a container 1978 that uses "ts:local-or-truststore-certs-grouping". 1980 A.17. 15 to 16 1982 o Removed unnecessary if-feature statements in the -client and 1983 -server modules. 1985 o Cleaned up some description statements in the -client and -server 1986 modules. 1988 o Fixed a canonical ordering issue in ietf-tls-common detected by 1989 new pyang. 1991 Acknowledgements 1993 The authors would like to thank for following for lively discussions 1994 on list and in the halls (ordered by last name): Andy Bierman, Martin 1995 Bjorklund, Benoit Claise, Mehmet Ersue, Balazs Kovacs, David 1996 Lamparter, Alan Luchuk, Ladislav Lhotka, Radek Krejci, Tom Petch, 1997 Juergen Schoenwaelder, Phil Shafer, Sean Turner, and Bert Wijnen. 1999 Authors' Addresses 2001 Kent Watsen 2002 Watsen Networks 2004 EMail: kent+ietf@watsen.net 2006 Gary Wu 2007 Cisco Systems 2009 EMail: garywu@cisco.com 2010 Liang Xia 2011 Huawei 2013 EMail: frank.xialiang@huawei.com