idnits 2.17.1 draft-ietf-netconf-trust-anchors-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year == Line 144 has weird spacing: '...ost-key ct:...' -- The document date (June 4, 2018) is 2152 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-00 ** Obsolete normative reference: RFC 6536 (Obsoleted by RFC 8341) Summary: 1 error (**), 0 flaws (~~), 3 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 NETCONF Working Group K. Watsen 3 Internet-Draft Juniper Networks 4 Intended status: Standards Track June 4, 2018 5 Expires: December 6, 2018 7 YANG Data Model for Global Trust Anchors 8 draft-ietf-netconf-trust-anchors-00 10 Abstract 12 This document defines a YANG 1.1 data model for configuring global 13 sets of X.509 certificates and SSH host-keys that can be referenced 14 by other data models for trust. While the SSH host-keys are uniquely 15 for the SSH protocol, the X.509 certificates may have multiple uses, 16 including authenticating protocol peers and verifying signatures. 18 Editorial Note (To be removed by RFC Editor) 20 This draft contains many placeholder values that need to be replaced 21 with finalized values at the time of publication. This note 22 summarizes all of the substitutions that are needed. No other RFC 23 Editor instructions are specified elsewhere in this document. 25 Artwork in this document contains shorthand references to drafts in 26 progress. Please apply the following replacements: 28 o "XXXX" --> the assigned RFC value for this draft 30 o "YYYY" --> the assigned RFC value for draft-ietf-netconf-crypto- 31 types 33 Artwork in this document contains placeholder values for the date of 34 publication of this draft. Please apply the following replacement: 36 o "2018-06-04" --> the publication date of this draft 38 The following Appendix section is to be removed prior to publication: 40 o Appendix A. Change Log 42 Status of This Memo 44 This Internet-Draft is submitted in full conformance with the 45 provisions of BCP 78 and BCP 79. 47 Internet-Drafts are working documents of the Internet Engineering 48 Task Force (IETF). Note that other groups may also distribute 49 working documents as Internet-Drafts. The list of current Internet- 50 Drafts is at https://datatracker.ietf.org/drafts/current/. 52 Internet-Drafts are draft documents valid for a maximum of six months 53 and may be updated, replaced, or obsoleted by other documents at any 54 time. It is inappropriate to use Internet-Drafts as reference 55 material or to cite them other than as "work in progress." 57 This Internet-Draft will expire on December 6, 2018. 59 Copyright Notice 61 Copyright (c) 2018 IETF Trust and the persons identified as the 62 document authors. All rights reserved. 64 This document is subject to BCP 78 and the IETF Trust's Legal 65 Provisions Relating to IETF Documents 66 (https://trustee.ietf.org/license-info) in effect on the date of 67 publication of this document. Please review these documents 68 carefully, as they describe your rights and restrictions with respect 69 to this document. Code Components extracted from this document must 70 include Simplified BSD License text as described in Section 4.e of 71 the Trust Legal Provisions and are provided without warranty as 72 described in the Simplified BSD License. 74 Table of Contents 76 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 77 1.1. Requirements Language . . . . . . . . . . . . . . . . . . 3 78 1.2. Tree Diagram Notation . . . . . . . . . . . . . . . . . . 3 79 2. The Trust Anchors Model . . . . . . . . . . . . . . . . . . . 3 80 2.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 3 81 2.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 4 82 2.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 7 83 3. Security Considerations . . . . . . . . . . . . . . . . . . . 12 84 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 12 85 4.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 12 86 4.2. The YANG Module Names Registry . . . . . . . . . . . . . 13 87 5. References . . . . . . . . . . . . . . . . . . . . . . . . . 13 88 5.1. Normative References . . . . . . . . . . . . . . . . . . 13 89 5.2. Informative References . . . . . . . . . . . . . . . . . 13 90 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 15 91 A.1. I-D to 00 . . . . . . . . . . . . . . . . . . . . . . . . 15 92 Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 15 93 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 15 95 1. Introduction 97 This document defines a YANG 1.1 [RFC7950] data model for configuring 98 global sets of X.509 certificates and SSH host-keys that can be 99 referenced by other data models for trust. While the SSH host-keys 100 are uniquely for the SSH protocol, the X.509 certificates may be used 101 for multiple uses, including authenticating protocol peers and 102 verifying signatures. 104 This document in compliant with Network Management Datastore 105 Architecture (NMDA) [RFC8342]. For instance, to support trust 106 anchors installed during manufacturing, it is expected that such data 107 may appear only in . 109 1.1. Requirements Language 111 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 112 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 113 "OPTIONAL" in this document are to be interpreted as described in BCP 114 14 [RFC2119] [RFC8174] when, and only when, they appear in all 115 capitals, as shown here. 117 1.2. Tree Diagram Notation 119 Tree diagrams used in this document follow the notation defined in 120 [RFC8340]. 122 2. The Trust Anchors Model 124 2.1. Tree Diagram 126 The following tree diagram provides an overview of the "ietf-trust- 127 anchors" module. 129 module: ietf-trust-anchors 130 +--rw trust-anchors 131 +--rw pinned-certificates* [name] 132 | +--rw name string 133 | +--rw description? string 134 | +--rw pinned-certificate* [name] 135 | +--rw name string 136 | +--rw cert ct:trust-anchor-cert-cms 137 | +---n certificate-expiration 138 | +-- expiration-date? yang:date-and-time 139 +--rw pinned-host-keys* [name] 140 +--rw name string 141 +--rw description? string 142 +--rw pinned-host-key* [name] 143 +--rw name string 144 +--rw host-key ct:ssh-host-key 146 2.2. Example Usage 148 The following example illustrates trust anchors in as 149 described by Section 5.3 in [RFC8342]. This datastore view 150 illustrates data set by the manufacturing process alongside 151 conventional configuration. This trust anchors instance has five 152 sets of pinned certificates and one set of pinned host keys. 154 158 159 160 manufacturers-root-ca-certs 161 162 Certificates built into the device for authenticating 163 manufacturer-signed objects, such as TLS server certificates, 164 vouchers, etc. Note, though listed here, these are not 165 configurable; any attempt to do so will be denied. 166 167 168 Manufacturer Root CA cert 1 169 base64encodedvalue== 170 171 172 Manufacturer Root CA cert 2 173 base64encodedvalue== 174 175 176 177 178 explicitly-trusted-server-certs 179 180 Specific server authentication certificates for explicitly 181 trusted servers. These are needed for server certificates 182 that are not signed by a pinned CA. 183 184 185 Fred Flintstone 186 base64encodedvalue== 187 188 190 191 192 explicitly-trusted-server-ca-certs 193 194 Trust anchors (i.e. CA certs) that are used to authenticate 195 server connections. Servers are authenticated if their 196 certificate has a chain of trust to one of these CA 197 certificates. 198 199 200 ca.example.com 201 base64encodedvalue== 202 203 205 206 207 explicitly-trusted-client-certs 208 209 Specific client authentication certificates for explicitly 210 trusted clients. These are needed for client certificates 211 that are not signed by a pinned CA. 212 213 214 George Jetson 215 base64encodedvalue== 216 217 219 220 221 explicitly-trusted-client-ca-certs 222 223 Trust anchors (i.e. CA certs) that are used to authenticate 224 client connections. Clients are authenticated if their 225 certificate has a chain of trust to one of these CA 226 certificates. 227 228 229 ca.example.com 230 base64encodedvalue== 231 232 234 235 236 common-ca-certs 237 238 Trusted certificates to authenticate common HTTPS servers. 239 These certificates are similar to those that might be 240 shipped with a web browser. 241 242 243 ex-certificate-authority 244 base64encodedvalue== 245 246 248 249 250 explicitly-trusted-ssh-host-keys 251 252 Trusted SSH host keys used to authenticate SSH servers. 253 These host keys would be analogous to those stored in 254 a known_hosts file in OpenSSH. 255 256 257 corp-fw1 258 base64encodedvalue== 259 260 262 264 The following example illustrates the "certificate-expiration" 265 notification in use with the NETCONF protocol. 267 [Note: '\' line wrapping for formatting only] 269 271 2018-05-25T00:01:00Z 272 274 275 explicitly-trusted-client-certs 276 277 George Jetson 278 279 2018-08-05T14:18:53-05:00 281 282 283 284 285 287 2.3. YANG Module 289 This YANG module imports modules from [RFC6536], [RFC6991] and 290 [I-D.ietf-netconf-crypto-types]. 292 file "ietf-trust-anchors@2018-06-04.yang" 293 module ietf-trust-anchors { 294 yang-version 1.1; 296 namespace "urn:ietf:params:xml:ns:yang:ietf-trust-anchors"; 297 prefix "ta"; 299 import ietf-yang-types { 300 prefix yang; 301 reference 302 "RFC 6991: Common YANG Data Types"; 303 } 305 import ietf-crypto-types { 306 prefix ct; 307 reference 308 "RFC YYYY: Common YANG Data Types for Cryptography"; 309 } 311 organization 312 "IETF NETCONF (Network Configuration) Working Group"; 314 contact 315 "WG Web: 316 WG List: 318 Author: Kent Watsen 319 "; 321 description 322 "This module defines a data model for configuring global 323 trust anchors used by other data models. The data model 324 enables the configuration of sets of trust anchors. 325 This data model supports configuring trust anchors for 326 both X.509 certificates and SSH host keys. 328 Copyright (c) 2018 IETF Trust and the persons identified 329 as authors of the code. All rights reserved. 331 Redistribution and use in source and binary forms, with 332 or without modification, is permitted pursuant to, and 333 subject to the license terms contained in, the Simplified 334 BSD License set forth in Section 4.c of the IETF Trust's 335 Legal Provisions Relating to IETF Documents 336 (http://trustee.ietf.org/license-info). 338 This version of this YANG module is part of RFC XXXX; see 339 the RFC itself for full legal notices."; 341 revision "2018-06-04" { 342 description 343 "Initial version"; 344 reference 345 "RFC XXXX: YANG Data Model for Global Trust Anchors"; 346 } 348 /************************************************************/ 349 /* Typedefs for leafrefs to commonly referenced objects */ 350 /************************************************************/ 352 typedef pinned-certificates-ref { 353 type leafref { 354 path "/ta:trust-anchors/ta:pinned-certificates/ta:name"; 355 require-instance false; 356 } 357 description 358 "This typedef enables importing modules to easily define a 359 leafref to a 'pinned-certificates' object. The require 360 instance attribute is false to enable the referencing of 361 pinned certificates that exist only in ."; 362 reference 363 "RFC 8342: Network Management Datastore Architecture (NMDA)"; 364 } 366 typedef pinned-host-keys-ref { 367 type leafref { 368 path "/ta:trust-anchors/ta:pinned-host-keys/ta:name"; 369 require-instance false; 370 } 371 description 372 "This typedef enables importing modules to easily define a 373 leafref to a 'pinned-host-keys' object. The require 374 instance attribute is false to enable the referencing of 375 pinned host keys that exist only in ."; 376 reference 377 "RFC 8342: Network Management Datastore Architecture (NMDA)"; 378 } 380 /*********************************/ 381 /* Protocol accessible nodes */ 382 /*********************************/ 384 container trust-anchors { 385 description 386 "Contains sets of X.509 certificates and SSH host keys."; 388 list pinned-certificates { 389 key name; 390 description 391 "A list of pinned certificates. These certificates can be 392 used by a server to authenticate clients, or by a client 393 to authenticate servers. Each list of pinned certificates 394 SHOULD be specific to a purpose, as the list as a whole 395 may be referenced by other modules. For instance, a 396 NETCONF server's configuration might use a specific list 397 of pinned certificates for when authenticating NETCONF 398 client connections."; 399 leaf name { 400 type string; 401 description 402 "An arbitrary name for this list of pinned 403 certificates."; 404 } 405 leaf description { 406 type string; 407 description 408 "An arbitrary description for this list of pinned 409 certificates."; 410 } 411 list pinned-certificate { 412 key name; 413 description 414 "A pinned certificate."; 415 leaf name { 416 type string; 417 description 418 "An arbitrary name for this pinned certificate. The 419 name must be unique across all lists of pinned 420 certificates (not just this list) so that leafrefs 421 from another module can resolve to unique values."; 422 } 423 leaf cert { 424 type ct:trust-anchor-cert-cms; 425 mandatory true; 426 description 427 "The binary certificate data for this pinned 428 certificate."; 429 reference 430 "RFC YYYY: Common YANG Data Types for Cryptography"; 431 } 432 notification certificate-expiration { 433 description 434 "A notification indicating that the configured trust 435 anchor is either about to expire or has already expired. 436 When to send notifications is an implementation specific 437 decision, but it is RECOMMENDED that a notification be 438 sent once a month for 3 months, then once a week for 439 four weeks, and then once a day thereafter until the 440 issue is resolved."; 441 leaf expiration-date { 442 type yang:date-and-time; 443 //mandatory true; 444 description 445 "Identifies the expiration date on the certificate."; 446 } 447 } 449 } 450 } 451 list pinned-host-keys { 452 key name; 453 description 454 "A list of pinned host keys. These pinned host-keys can 455 be used by clients to authenticate SSH servers. Each 456 list of pinned host keys SHOULD be specific to a purpose, 457 so the list as a whole may be referenced by other modules. 458 For instance, a NETCONF client's configuration might 459 point to a specific list of pinned host keys for when 460 authenticating specific SSH servers."; 461 leaf name { 462 type string; 463 description 464 "An arbitrary name for this list of pinned SSH 465 host keys."; 466 } 467 leaf description { 468 type string; 469 description 470 "An arbitrary description for this list of pinned SSH 471 host keys."; 472 } 473 list pinned-host-key { 474 key name; 475 description 476 "A pinned host key."; 477 leaf name { 478 type string; 479 description 480 "An arbitrary name for this pinned host-key. Must be 481 unique across all lists of pinned host-keys (not just 482 this list) so that a leafref to it from another module 483 can resolve to unique values."; 484 } 485 leaf host-key { 486 type ct:ssh-host-key; 487 mandatory true; 488 description 489 "The binary public key data for this pinned host key."; 490 reference 491 "RFC YYYY: Common YANG Data Types for Cryptography"; 492 } 493 } 494 } 495 } 497 } 498 500 3. Security Considerations 502 The YANG module defined in this document is designed to be accessed 503 via YANG based management protocols, such as NETCONF [RFC6241] and 504 RESTCONF [RFC8040]. Both of these protocols have mandatory-to- 505 implement secure transport layers (e.g., SSH, TLS) with mutual 506 authentication. 508 The NETCONF access control model (NACM) [RFC6536] provides the means 509 to restrict access for particular users to a pre-configured subset of 510 all available protocol operations and content. 512 There are a number of data nodes defined in this YANG module that are 513 writable/creatable/deletable (i.e., config true, which is the 514 default). These data nodes may be considered sensitive or vulnerable 515 in some network environments. Write operations (e.g., edit-config) 516 to these data nodes without proper protection can have a negative 517 effect on network operations. These are the subtrees and data nodes 518 and their sensitivity/vulnerability: 520 /: The entire data tree defined by this module is sensitive to 521 write operations. For instance, the addition or removal of any 522 trust anchor may dramatically alter the implemented security 523 policy. However, no NACM annotations are applied as the data 524 SHOULD be editable by users other than a designated 'recovery 525 session'. 527 None of the readable data nodes in this YANG module are considered 528 sensitive or vulnerable in network environments. 530 This module does not define any RPCs, actions, or notifications, and 531 thus the security consideration for such is not provided here. 533 4. IANA Considerations 535 4.1. The IETF XML Registry 537 This document registers one URI in the "ns" subregistry of the IETF 538 XML Registry [RFC3688]. Following the format in [RFC3688], the 539 following registration is requested: 541 URI: urn:ietf:params:xml:ns:yang:ietf-trust-anchors 542 Registrant Contact: The NETCONF WG of the IETF. 543 XML: N/A, the requested URI is an XML namespace. 545 4.2. The YANG Module Names Registry 547 This document registers one YANG module in the YANG Module Names 548 registry [RFC6020]. Following the format in [RFC6020], the the 549 following registration is requested: 551 name: ietf-trust-anchors 552 namespace: urn:ietf:params:xml:ns:yang:ietf-trust-anchors 553 prefix: ta 554 reference: RFC XXXX 556 5. References 558 5.1. Normative References 560 [I-D.ietf-netconf-crypto-types] 561 Watsen, K., "Common YANG Data Types for Cryptography", 562 draft-ietf-netconf-crypto-types-00 (work in progress), 563 June 2018. 565 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 566 Requirement Levels", BCP 14, RFC 2119, 567 DOI 10.17487/RFC2119, March 1997, 568 . 570 [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration 571 Protocol (NETCONF) Access Control Model", RFC 6536, 572 DOI 10.17487/RFC6536, March 2012, 573 . 575 [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", 576 RFC 6991, DOI 10.17487/RFC6991, July 2013, 577 . 579 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 580 RFC 7950, DOI 10.17487/RFC7950, August 2016, 581 . 583 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 584 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 585 May 2017, . 587 5.2. Informative References 589 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 590 DOI 10.17487/RFC3688, January 2004, 591 . 593 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for 594 the Network Configuration Protocol (NETCONF)", RFC 6020, 595 DOI 10.17487/RFC6020, October 2010, 596 . 598 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., 599 and A. Bierman, Ed., "Network Configuration Protocol 600 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, 601 . 603 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF 604 Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, 605 . 607 [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", 608 BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, 609 . 611 [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., 612 and R. Wilton, "Network Management Datastore Architecture 613 (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, 614 . 616 Appendix A. Change Log 618 A.1. I-D to 00 620 o Now imports and uses the crypto-types module. 622 o FIXME 624 o FIXME 626 o FIXME: added notification example... 628 Acknowledgements 630 The authors would like to thank for following for lively discussions 631 on list and in the halls (ordered by last name): Martin Bjorklund, 632 Balazs Kovacs, Eric Voit, and Liang Xia. 634 Author's Address 636 Kent Watsen 637 Juniper Networks 639 EMail: kwatsen@juniper.net