draft-ietf-netconf-keystore-18.txt   draft-ietf-netconf-keystore-19.txt 
NETCONF Working Group K. Watsen NETCONF Working Group K. Watsen
Internet-Draft Watsen Networks Internet-Draft Watsen Networks
Intended status: Standards Track 8 July 2020 Intended status: Standards Track 10 July 2020
Expires: 9 January 2021 Expires: 11 January 2021
A YANG Data Model for a Keystore A YANG Data Model for a Keystore
draft-ietf-netconf-keystore-18 draft-ietf-netconf-keystore-19
Abstract Abstract
This document defines a YANG 1.1 module called "ietf-keystore" that This document defines a YANG 1.1 module called "ietf-keystore" that
enables centralized configuration of both symmetric and asymmetric enables centralized configuration of both symmetric and asymmetric
keys. The secret value for both key types may be encrypted. keys. The secret value for both key types may be encrypted.
Asymmetric keys may be associated with certificates. Notifications Asymmetric keys may be associated with certificates. Notifications
are sent when certificates are about to expire. are sent when certificates are about to expire.
Editorial Note (To be removed by RFC Editor) Editorial Note (To be removed by RFC Editor)
skipping to change at page 1, line 37 skipping to change at page 1, line 37
progress. Please apply the following replacements: progress. Please apply the following replacements:
* "AAAA" --> the assigned RFC value for draft-ietf-netconf-crypto- * "AAAA" --> the assigned RFC value for draft-ietf-netconf-crypto-
types types
* "CCCC" --> the assigned RFC value for this draft * "CCCC" --> the assigned RFC value for this draft
Artwork in this document contains placeholder values for the date of Artwork in this document contains placeholder values for the date of
publication of this draft. Please apply the following replacement: publication of this draft. Please apply the following replacement:
* "2020-07-08" --> the publication date of this draft * "2020-07-10" --> the publication date of this draft
The following Appendix section is to be removed prior to publication: The following Appendix section is to be removed prior to publication:
* Appendix A. Change Log * Appendix A. Change Log
Status of This Memo Status of This Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on 9 January 2021. This Internet-Draft will expire on 11 January 2021.
Copyright Notice Copyright Notice
Copyright (c) 2020 IETF Trust and the persons identified as the Copyright (c) 2020 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents (https://trustee.ietf.org/ Provisions Relating to IETF Documents (https://trustee.ietf.org/
license-info) in effect on the date of publication of this document. license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights Please review these documents carefully, as they describe your rights
skipping to change at page 2, line 47 skipping to change at page 2, line 47
2. The "ietf-keystore" Module . . . . . . . . . . . . . . . . . 5 2. The "ietf-keystore" Module . . . . . . . . . . . . . . . . . 5
2.1. Data Model Overview . . . . . . . . . . . . . . . . . . . 5 2.1. Data Model Overview . . . . . . . . . . . . . . . . . . . 5
2.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 12 2.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 12
2.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 23 2.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 23
3. Support for Built-in Keys . . . . . . . . . . . . . . . . . . 31 3. Support for Built-in Keys . . . . . . . . . . . . . . . . . . 31
4. Encrypting Keys in Configuration . . . . . . . . . . . . . . 34 4. Encrypting Keys in Configuration . . . . . . . . . . . . . . 34
5. Security Considerations . . . . . . . . . . . . . . . . . . . 38 5. Security Considerations . . . . . . . . . . . . . . . . . . . 38
5.1. Data at Rest . . . . . . . . . . . . . . . . . . . . . . 38 5.1. Data at Rest . . . . . . . . . . . . . . . . . . . . . . 38
5.2. The "ietf-keystore" YANG Module . . . . . . . . . . . . . 38 5.2. The "ietf-keystore" YANG Module . . . . . . . . . . . . . 38
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 39 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 39
6.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 39 6.1. The "IETF XML" Registry . . . . . . . . . . . . . . . . . 39
6.2. The YANG Module Names Registry . . . . . . . . . . . . . 39 6.2. The "YANG Module Names" Registry . . . . . . . . . . . . 39
7. References . . . . . . . . . . . . . . . . . . . . . . . . . 39 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 39
7.1. Normative References . . . . . . . . . . . . . . . . . . 39 7.1. Normative References . . . . . . . . . . . . . . . . . . 39
7.2. Informative References . . . . . . . . . . . . . . . . . 40 7.2. Informative References . . . . . . . . . . . . . . . . . 40
Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 42 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 42
A.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 42 A.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 42
A.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 42 A.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 42
A.3. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 42 A.3. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 42
A.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 42 A.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 42
A.5. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 43 A.5. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 43
A.6. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 43 A.6. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 43
skipping to change at page 3, line 22 skipping to change at page 3, line 22
A.9. 08 to 09 . . . . . . . . . . . . . . . . . . . . . . . . 43 A.9. 08 to 09 . . . . . . . . . . . . . . . . . . . . . . . . 43
A.10. 09 to 10 . . . . . . . . . . . . . . . . . . . . . . . . 44 A.10. 09 to 10 . . . . . . . . . . . . . . . . . . . . . . . . 44
A.11. 10 to 11 . . . . . . . . . . . . . . . . . . . . . . . . 44 A.11. 10 to 11 . . . . . . . . . . . . . . . . . . . . . . . . 44
A.12. 11 to 12 . . . . . . . . . . . . . . . . . . . . . . . . 44 A.12. 11 to 12 . . . . . . . . . . . . . . . . . . . . . . . . 44
A.13. 12 to 13 . . . . . . . . . . . . . . . . . . . . . . . . 45 A.13. 12 to 13 . . . . . . . . . . . . . . . . . . . . . . . . 45
A.14. 13 to 14 . . . . . . . . . . . . . . . . . . . . . . . . 45 A.14. 13 to 14 . . . . . . . . . . . . . . . . . . . . . . . . 45
A.15. 14 to 15 . . . . . . . . . . . . . . . . . . . . . . . . 45 A.15. 14 to 15 . . . . . . . . . . . . . . . . . . . . . . . . 45
A.16. 15 to 16 . . . . . . . . . . . . . . . . . . . . . . . . 45 A.16. 15 to 16 . . . . . . . . . . . . . . . . . . . . . . . . 45
A.17. 16 to 17 . . . . . . . . . . . . . . . . . . . . . . . . 45 A.17. 16 to 17 . . . . . . . . . . . . . . . . . . . . . . . . 45
A.18. 17 to 18 . . . . . . . . . . . . . . . . . . . . . . . . 46 A.18. 17 to 18 . . . . . . . . . . . . . . . . . . . . . . . . 46
A.19. 18 to 19 . . . . . . . . . . . . . . . . . . . . . . . . 46
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 46 Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 46
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 46 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 46
1. Introduction 1. Introduction
This document defines a YANG 1.1 [RFC7950] module called "ietf- This document defines a YANG 1.1 [RFC7950] module called "ietf-
keystore" that enables centralized configuration of both symmetric keystore" that enables centralized configuration of both symmetric
and asymmetric keys. The secret value for both key types may be and asymmetric keys. The secret value for both key types may be
encrypted. Asymmetric keys may be associated with certificates. encrypted. Asymmetric keys may be associated with certificates.
Notifications are sent when certificates are about to expire. Notifications are sent when certificates are about to expire.
skipping to change at page 11, line 32 skipping to change at page 11, line 32
module: ietf-keystore module: ietf-keystore
+--rw keystore +--rw keystore
+--rw asymmetric-keys +--rw asymmetric-keys
| +--rw asymmetric-key* [name] | +--rw asymmetric-key* [name]
| +--rw name string | +--rw name string
| +--rw public-key-format identityref | +--rw public-key-format identityref
| +--rw public-key binary | +--rw public-key binary
| +--rw private-key-format? identityref | +--rw private-key-format? identityref
| +--rw (private-key-type) | +--rw (private-key-type)
| | +--:(private-key) | | +--:(cleartext-private-key)
| | | +--rw private-key? binary | | | +--rw cleartext-private-key? binary
| | +--:(hidden-private-key) | | +--:(hidden-private-key)
| | | +--rw hidden-private-key? empty | | | +--rw hidden-private-key? empty
| | +--:(encrypted-private-key) | | +--:(encrypted-private-key)
| | +--rw encrypted-private-key | | +--rw encrypted-private-key
| | +--rw encrypted-by | | +--rw encrypted-by
| | | +--rw (encrypted-by-choice) | | | +--rw (encrypted-by-choice)
| | | +--:(symmetric-key-ref) | | | +--:(symmetric-key-ref)
| | | | +--rw symmetric-key-ref? leafref | | | | +--rw symmetric-key-ref? leafref
| | | +--:(asymmetric-key-ref) | | | +--:(asymmetric-key-ref)
| | | +--rw asymmetric-key-ref? leafref | | | +--rw asymmetric-key-ref? leafref
skipping to change at page 12, line 13 skipping to change at page 12, line 13
| {certificate-signing-request-generation}? | {certificate-signing-request-generation}?
| +---w input | +---w input
| | +---w csr-info ct:csr-info | | +---w csr-info ct:csr-info
| +--ro output | +--ro output
| +--ro certificate-signing-request ct:csr | +--ro certificate-signing-request ct:csr
+--rw symmetric-keys +--rw symmetric-keys
+--rw symmetric-key* [name] +--rw symmetric-key* [name]
+--rw name string +--rw name string
+--rw key-format? identityref +--rw key-format? identityref
+--rw (key-type) +--rw (key-type)
+--:(key) +--:(cleartext-key)
| +--rw key? binary | +--rw cleartext-key? binary
+--:(hidden-key) +--:(hidden-key)
| +--rw hidden-key? empty | +--rw hidden-key? empty
+--:(encrypted-key) +--:(encrypted-key)
+--rw encrypted-key +--rw encrypted-key
+--rw encrypted-by +--rw encrypted-by
| +--rw (encrypted-by-choice) | +--rw (encrypted-by-choice)
| +--:(symmetric-key-ref) | +--:(symmetric-key-ref)
| | +--rw symmetric-key-ref? leafref | | +--rw symmetric-key-ref? leafref
| +--:(asymmetric-key-ref) | +--:(asymmetric-key-ref)
| +--rw asymmetric-key-ref? leafref | +--rw asymmetric-key-ref? leafref
skipping to change at page 13, line 20 skipping to change at page 13, line 20
=============== NOTE: '\' line wrapping per RFC 8792 ================ =============== NOTE: '\' line wrapping per RFC 8792 ================
<keystore xmlns="urn:ietf:params:xml:ns:yang:ietf-keystore" <keystore xmlns="urn:ietf:params:xml:ns:yang:ietf-keystore"
xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types"> xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types">
<symmetric-keys> <symmetric-keys>
<symmetric-key> <symmetric-key>
<name>cleartext-symmetric-key</name> <name>cleartext-symmetric-key</name>
<key-format>ct:octet-string-key-format</key-format> <key-format>ct:octet-string-key-format</key-format>
<key>base64encodedvalue==</key> <cleartext-key>base64encodedvalue==</cleartext-key>
</symmetric-key> </symmetric-key>
<symmetric-key> <symmetric-key>
<name>hidden-symmetric-key</name> <name>hidden-symmetric-key</name>
<hidden-key/> <hidden-key/>
</symmetric-key> </symmetric-key>
<symmetric-key> <symmetric-key>
<name>encrypted-symmetric-key</name> <name>encrypted-symmetric-key</name>
<key-format> <key-format>
ct:encrypted-one-symmetric-key-format ct:encrypted-one-symmetric-key-format
</key-format> </key-format>
skipping to change at page 13, line 51 skipping to change at page 13, line 51
<asymmetric-keys> <asymmetric-keys>
<asymmetric-key> <asymmetric-key>
<name>ssh-rsa-key</name> <name>ssh-rsa-key</name>
<public-key-format> <public-key-format>
ct:ssh-public-key-format ct:ssh-public-key-format
</public-key-format> </public-key-format>
<public-key>base64encodedvalue==</public-key> <public-key>base64encodedvalue==</public-key>
<private-key-format> <private-key-format>
ct:rsa-private-key-format ct:rsa-private-key-format
</private-key-format> </private-key-format>
<private-key>base64encodedvalue==</private-key> <cleartext-private-key>base64encodedvalue==</cleartext-priv\
ate-key>
</asymmetric-key> </asymmetric-key>
<asymmetric-key> <asymmetric-key>
<name>ssh-rsa-key-with-cert</name> <name>ssh-rsa-key-with-cert</name>
<public-key-format> <public-key-format>
ct:subject-public-key-info-format ct:subject-public-key-info-format
</public-key-format> </public-key-format>
<public-key>base64encodedvalue==</public-key> <public-key>base64encodedvalue==</public-key>
<private-key-format> <private-key-format>
ct:rsa-private-key-format ct:rsa-private-key-format
</private-key-format> </private-key-format>
<private-key>base64encodedvalue==</private-key> <cleartext-private-key>base64encodedvalue==</cleartext-priv\
ate-key>
<certificates> <certificates>
<certificate> <certificate>
<name>ex-rsa-cert2</name> <name>ex-rsa-cert2</name>
<cert-data>base64encodedvalue==</cert-data> <cert-data>base64encodedvalue==</cert-data>
</certificate> </certificate>
</certificates> </certificates>
</asymmetric-key> </asymmetric-key>
<asymmetric-key> <asymmetric-key>
<name>raw-private-key</name> <name>raw-private-key</name>
<public-key-format> <public-key-format>
ct:subject-public-key-info-format ct:subject-public-key-info-format
</public-key-format> </public-key-format>
<public-key>base64encodedvalue==</public-key> <public-key>base64encodedvalue==</public-key>
<private-key-format> <private-key-format>
ct:rsa-private-key-format ct:rsa-private-key-format
</private-key-format> </private-key-format>
<private-key>base64encodedvalue==</private-key> <cleartext-private-key>base64encodedvalue==</cleartext-priv\
ate-key>
</asymmetric-key> </asymmetric-key>
<asymmetric-key> <asymmetric-key>
<name>rsa-asymmetric-key</name> <name>rsa-asymmetric-key</name>
<public-key-format> <public-key-format>
ct:subject-public-key-info-format ct:subject-public-key-info-format
</public-key-format> </public-key-format>
<public-key>base64encodedvalue==</public-key> <public-key>base64encodedvalue==</public-key>
<private-key-format> <private-key-format>
ct:rsa-private-key-format ct:rsa-private-key-format
</private-key-format> </private-key-format>
<private-key>base64encodedvalue==</private-key> <cleartext-private-key>base64encodedvalue==</cleartext-priv\
ate-key>
<certificates> <certificates>
<certificate> <certificate>
<name>ex-rsa-cert</name> <name>ex-rsa-cert</name>
<cert-data>base64encodedvalue==</cert-data> <cert-data>base64encodedvalue==</cert-data>
</certificate> </certificate>
</certificates> </certificates>
</asymmetric-key> </asymmetric-key>
<asymmetric-key> <asymmetric-key>
<name>ec-asymmetric-key</name> <name>ec-asymmetric-key</name>
<public-key-format> <public-key-format>
ct:subject-public-key-info-format ct:subject-public-key-info-format
</public-key-format> </public-key-format>
<public-key>base64encodedvalue==</public-key> <public-key>base64encodedvalue==</public-key>
<private-key-format> <private-key-format>
ct:ec-private-key-format ct:ec-private-key-format
</private-key-format> </private-key-format>
skipping to change at page 15, line 10 skipping to change at page 15, line 15
</asymmetric-key> </asymmetric-key>
<asymmetric-key> <asymmetric-key>
<name>ec-asymmetric-key</name> <name>ec-asymmetric-key</name>
<public-key-format> <public-key-format>
ct:subject-public-key-info-format ct:subject-public-key-info-format
</public-key-format> </public-key-format>
<public-key>base64encodedvalue==</public-key> <public-key>base64encodedvalue==</public-key>
<private-key-format> <private-key-format>
ct:ec-private-key-format ct:ec-private-key-format
</private-key-format> </private-key-format>
<private-key>base64encodedvalue==</private-key> <cleartext-private-key>base64encodedvalue==</cleartext-priv\
ate-key>
<certificates> <certificates>
<certificate> <certificate>
<name>ex-ec-cert</name> <name>ex-ec-cert</name>
<cert-data>base64encodedvalue==</cert-data> <cert-data>base64encodedvalue==</cert-data>
</certificate> </certificate>
</certificates> </certificates>
</asymmetric-key> </asymmetric-key>
<asymmetric-key> <asymmetric-key>
<name>hidden-asymmetric-key</name> <name>hidden-asymmetric-key</name>
<public-key-format> <public-key-format>
skipping to change at page 17, line 27 skipping to change at page 17, line 30
organization organization
"Example Corporation"; "Example Corporation";
contact contact
"Author: YANG Designer <mailto:yang.designer@example.com>"; "Author: YANG Designer <mailto:yang.designer@example.com>";
description description
"This module illustrates notable groupings defined in "This module illustrates notable groupings defined in
the 'ietf-keystore' module."; the 'ietf-keystore' module.";
revision "2020-07-08" { revision "2020-07-10" {
description description
"Initial version"; "Initial version";
reference reference
"RFC CCCC: A YANG Data Model for a Keystore"; "RFC CCCC: A YANG Data Model for a Keystore";
} }
container keystore-usage { container keystore-usage {
description description
"An illustration of the various keystore groupings."; "An illustration of the various keystore groupings.";
skipping to change at page 19, line 14 skipping to change at page 19, line 15
module: ex-keystore-usage module: ex-keystore-usage
+--rw keystore-usage +--rw keystore-usage
+--rw symmetric-key* [name] +--rw symmetric-key* [name]
| +--rw name string | +--rw name string
| +--rw (local-or-keystore) | +--rw (local-or-keystore)
| +--:(local) {local-definitions-supported}? | +--:(local) {local-definitions-supported}?
| | +--rw local-definition | | +--rw local-definition
| | +--rw key-format? identityref | | +--rw key-format? identityref
| | +--rw (key-type) | | +--rw (key-type)
| | +--:(key) | | +--:(cleartext-key)
| | | +--rw key? binary | | | +--rw cleartext-key? binary
| | +--:(hidden-key) | | +--:(hidden-key)
| | | +--rw hidden-key? empty | | | +--rw hidden-key? empty
| | +--:(encrypted-key) | | +--:(encrypted-key)
| | +--rw encrypted-key | | +--rw encrypted-key
| | +--rw encrypted-by | | +--rw encrypted-by
| | +--rw encrypted-value binary | | +--rw encrypted-value binary
| +--:(keystore) {keystore-supported}? | +--:(keystore) {keystore-supported}?
| +--rw keystore-reference? ks:symmetric-key-ref | +--rw keystore-reference? ks:symmetric-key-ref
+--rw asymmetric-key* [name] +--rw asymmetric-key* [name]
| +--rw name string | +--rw name string
| +--rw (local-or-keystore) | +--rw (local-or-keystore)
| +--:(local) {local-definitions-supported}? | +--:(local) {local-definitions-supported}?
| | +--rw local-definition | | +--rw local-definition
| | +--rw public-key-format identityref | | +--rw public-key-format identityref
| | +--rw public-key binary | | +--rw public-key binary
| | +--rw private-key-format? identityref | | +--rw private-key-format? identityref
| | +--rw (private-key-type) | | +--rw (private-key-type)
| | +--:(private-key) | | +--:(cleartext-private-key)
| | | +--rw private-key? binary | | | +--rw cleartext-private-key? binary
| | +--:(hidden-private-key) | | +--:(hidden-private-key)
| | | +--rw hidden-private-key? empty | | | +--rw hidden-private-key? empty
| | +--:(encrypted-private-key) | | +--:(encrypted-private-key)
| | +--rw encrypted-private-key | | +--rw encrypted-private-key
| | +--rw encrypted-by | | +--rw encrypted-by
| | +--rw encrypted-value binary | | +--rw encrypted-value binary
| +--:(keystore) {keystore-supported}? | +--:(keystore) {keystore-supported}?
| +--rw keystore-reference? ks:asymmetric-key-ref | +--rw keystore-reference? ks:asymmetric-key-ref
+--rw asymmetric-key-with-certs* [name] +--rw asymmetric-key-with-certs* [name]
| +--rw name string | +--rw name string
| +--rw (local-or-keystore) | +--rw (local-or-keystore)
| +--:(local) {local-definitions-supported}? | +--:(local) {local-definitions-supported}?
| | +--rw local-definition | | +--rw local-definition
| | +--rw public-key-format | | +--rw public-key-format
| | | identityref | | | identityref
| | +--rw public-key binary | | +--rw public-key binary
| | +--rw private-key-format? | | +--rw private-key-format?
| | | identityref | | | identityref
| | +--rw (private-key-type) | | +--rw (private-key-type)
| | | +--:(private-key) | | | +--:(cleartext-private-key)
| | | | +--rw private-key? binary | | | | +--rw cleartext-private-key? binary
| | | +--:(hidden-private-key) | | | +--:(hidden-private-key)
| | | | +--rw hidden-private-key? empty | | | | +--rw hidden-private-key? empty
| | | +--:(encrypted-private-key) | | | +--:(encrypted-private-key)
| | | +--rw encrypted-private-key | | | +--rw encrypted-private-key
| | | +--rw encrypted-by | | | +--rw encrypted-by
| | | +--rw encrypted-value binary | | | +--rw encrypted-value binary
| | +--rw certificates | | +--rw certificates
| | | +--rw certificate* [name] | | | +--rw certificate* [name]
| | | +--rw name string | | | +--rw name string
| | | +--rw cert-data | | | +--rw cert-data
skipping to change at page 20, line 39 skipping to change at page 20, line 41
+--rw name string +--rw name string
+--rw (local-or-keystore) +--rw (local-or-keystore)
+--:(local) {local-definitions-supported}? +--:(local) {local-definitions-supported}?
| +--rw local-definition | +--rw local-definition
| +--rw public-key-format | +--rw public-key-format
| | identityref | | identityref
| +--rw public-key binary | +--rw public-key binary
| +--rw private-key-format? | +--rw private-key-format?
| | identityref | | identityref
| +--rw (private-key-type) | +--rw (private-key-type)
| | +--:(private-key) | | +--:(cleartext-private-key)
| | | +--rw private-key? binary | | | +--rw cleartext-private-key? binary
| | +--:(hidden-private-key) | | +--:(hidden-private-key)
| | | +--rw hidden-private-key? empty | | | +--rw hidden-private-key? empty
| | +--:(encrypted-private-key) | | +--:(encrypted-private-key)
| | +--rw encrypted-private-key | | +--rw encrypted-private-key
| | +--rw encrypted-by | | +--rw encrypted-by
| | +--rw encrypted-value binary | | +--rw encrypted-value binary
| +--rw cert-data? | +--rw cert-data?
| | end-entity-cert-cms | | end-entity-cert-cms
| +---n certificate-expiration | +---n certificate-expiration
| | +-- expiration-date yang:date-and-time | | +-- expiration-date yang:date-and-time
skipping to change at page 21, line 22 skipping to change at page 21, line 24
+--rw certificate? leafref +--rw certificate? leafref
The following example provides two equivalent instances of each The following example provides two equivalent instances of each
grouping, the first being a reference to a keystore and the second grouping, the first being a reference to a keystore and the second
being locally-defined. The instance having a reference to a keystore being locally-defined. The instance having a reference to a keystore
is consistent with the keystore defined in Section 2.2.1. The two is consistent with the keystore defined in Section 2.2.1. The two
instances are equivalent, as the locally-defined instance example instances are equivalent, as the locally-defined instance example
contains the same values defined by the keystore instance referenced contains the same values defined by the keystore instance referenced
by its sibling example. by its sibling example.
=============== NOTE: '\' line wrapping per RFC 8792 ================
<keystore-usage <keystore-usage
xmlns="http://example.com/ns/example-keystore-usage" xmlns="http://example.com/ns/example-keystore-usage"
xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types"> xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types">
<!-- The following two equivalent examples illustrate the --> <!-- The following two equivalent examples illustrate the -->
<!-- "local-or-keystore-symmetric-key-grouping" grouping: --> <!-- "local-or-keystore-symmetric-key-grouping" grouping: -->
<symmetric-key> <symmetric-key>
<name>example 1a</name> <name>example 1a</name>
<keystore-reference>cleartext-symmetric-key</keystore-reference> <keystore-reference>cleartext-symmetric-key</keystore-reference>
</symmetric-key> </symmetric-key>
<symmetric-key> <symmetric-key>
<name>example 1b</name> <name>example 1b</name>
<local-definition> <local-definition>
<key-format>ct:octet-string-key-format</key-format> <key-format>ct:octet-string-key-format</key-format>
<key>base64encodedvalue==</key> <cleartext-key>base64encodedvalue==</cleartext-key>
</local-definition> </local-definition>
</symmetric-key> </symmetric-key>
<!-- The following two equivalent examples illustrate the --> <!-- The following two equivalent examples illustrate the -->
<!-- "local-or-keystore-asymmetric-key-grouping" grouping: --> <!-- "local-or-keystore-asymmetric-key-grouping" grouping: -->
<asymmetric-key> <asymmetric-key>
<name>example 2a</name> <name>example 2a</name>
<keystore-reference>rsa-asymmetric-key</keystore-reference> <keystore-reference>rsa-asymmetric-key</keystore-reference>
</asymmetric-key> </asymmetric-key>
skipping to change at page 22, line 13 skipping to change at page 22, line 17
<asymmetric-key> <asymmetric-key>
<name>example 2b</name> <name>example 2b</name>
<local-definition> <local-definition>
<public-key-format> <public-key-format>
ct:subject-public-key-info-format ct:subject-public-key-info-format
</public-key-format> </public-key-format>
<public-key>base64encodedvalue==</public-key> <public-key>base64encodedvalue==</public-key>
<private-key-format> <private-key-format>
ct:rsa-private-key-format ct:rsa-private-key-format
</private-key-format> </private-key-format>
<private-key>base64encodedvalue==</private-key> <cleartext-private-key>base64encodedvalue==</cleartext-private\
-key>
</local-definition> </local-definition>
</asymmetric-key> </asymmetric-key>
<!-- the following two equivalent examples illustrate --> <!-- the following two equivalent examples illustrate -->
<!-- "local-or-keystore-asymmetric-key-with-certs-grouping": --> <!-- "local-or-keystore-asymmetric-key-with-certs-grouping": -->
<asymmetric-key-with-certs> <asymmetric-key-with-certs>
<name>example 3a</name> <name>example 3a</name>
<keystore-reference>rsa-asymmetric-key</keystore-reference> <keystore-reference>rsa-asymmetric-key</keystore-reference>
</asymmetric-key-with-certs> </asymmetric-key-with-certs>
skipping to change at page 22, line 35 skipping to change at page 22, line 40
<asymmetric-key-with-certs> <asymmetric-key-with-certs>
<name>example 3b</name> <name>example 3b</name>
<local-definition> <local-definition>
<public-key-format> <public-key-format>
ct:subject-public-key-info-format ct:subject-public-key-info-format
</public-key-format> </public-key-format>
<public-key>base64encodedvalue==</public-key> <public-key>base64encodedvalue==</public-key>
<private-key-format> <private-key-format>
ct:rsa-private-key-format ct:rsa-private-key-format
</private-key-format> </private-key-format>
<private-key>base64encodedvalue==</private-key> <cleartext-private-key>base64encodedvalue==</cleartext-private\
-key>
<certificates> <certificates>
<certificate> <certificate>
<name>a locally-defined cert</name> <name>a locally-defined cert</name>
<cert-data>base64encodedvalue==</cert-data> <cert-data>base64encodedvalue==</cert-data>
</certificate> </certificate>
</certificates> </certificates>
</local-definition> </local-definition>
</asymmetric-key-with-certs> </asymmetric-key-with-certs>
<!-- The following two equivalent examples illustrate --> <!-- The following two equivalent examples illustrate -->
<!-- "local-or-keystore-end-entity-cert-with-key-grouping": --> <!-- "local-or-keystore-end-entity-cert-with-key-grouping": -->
<end-entity-cert-with-key> <end-entity-cert-with-key>
<name>example 4a</name> <name>example 4a</name>
<keystore-reference> <keystore-reference>
<asymmetric-key>rsa-asymmetric-key</asymmetric-key> <asymmetric-key>rsa-asymmetric-key</asymmetric-key>
<certificate>ex-rsa-cert</certificate> <certificate>ex-rsa-cert</certificate>
</keystore-reference> </keystore-reference>
</end-entity-cert-with-key> </end-entity-cert-with-key>
skipping to change at page 23, line 20 skipping to change at page 23, line 25
<end-entity-cert-with-key> <end-entity-cert-with-key>
<name>example 4b</name> <name>example 4b</name>
<local-definition> <local-definition>
<public-key-format> <public-key-format>
ct:subject-public-key-info-format ct:subject-public-key-info-format
</public-key-format> </public-key-format>
<public-key>base64encodedvalue==</public-key> <public-key>base64encodedvalue==</public-key>
<private-key-format> <private-key-format>
ct:rsa-private-key-format ct:rsa-private-key-format
</private-key-format> </private-key-format>
<private-key>base64encodedvalue==</private-key> <cleartext-private-key>base64encodedvalue==</cleartext-private\
-key>
<cert-data>base64encodedvalue==</cert-data> <cert-data>base64encodedvalue==</cert-data>
</local-definition> </local-definition>
</end-entity-cert-with-key> </end-entity-cert-with-key>
</keystore-usage> </keystore-usage>
2.3. YANG Module 2.3. YANG Module
This YANG module has normative references to [RFC8341] and This YANG module has normative references to [RFC8341] and
[I-D.ietf-netconf-crypto-types]. [I-D.ietf-netconf-crypto-types].
<CODE BEGINS> file "ietf-keystore@2020-07-08.yang" <CODE BEGINS> file "ietf-keystore@2020-07-10.yang"
module ietf-keystore { module ietf-keystore {
yang-version 1.1; yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-keystore"; namespace "urn:ietf:params:xml:ns:yang:ietf-keystore";
prefix ks; prefix ks;
import ietf-netconf-acm { import ietf-netconf-acm {
prefix nacm; prefix nacm;
reference reference
"RFC 8341: Network Configuration Access Control Model"; "RFC 8341: Network Configuration Access Control Model";
skipping to change at page 24, line 36 skipping to change at page 24, line 42
(https://www.rfc-editor.org/info/rfcCCCC); see the RFC (https://www.rfc-editor.org/info/rfcCCCC); see the RFC
itself for full legal notices. itself for full legal notices.
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 (RFC 2119) are to be interpreted as described in BCP 14 (RFC 2119)
(RFC 8174) when, and only when, they appear in all (RFC 8174) when, and only when, they appear in all
capitals, as shown here."; capitals, as shown here.";
revision 2020-07-08 { revision 2020-07-10 {
description description
"Initial version"; "Initial version";
reference reference
"RFC CCCC: A YANG Data Model for a Keystore"; "RFC CCCC: A YANG Data Model for a Keystore";
} }
/****************/ /****************/
/* Features */ /* Features */
/****************/ /****************/
feature keystore-supported { feature keystore-supported {
description description
"The 'keystore-supported' feature indicates that the server "The 'keystore-supported' feature indicates that the server
supports the Keystore."; supports the Keystore.";
} }
feature local-definitions-supported { feature local-definitions-supported {
description description
"The 'local-definitions-supported' feature indicates that the "The 'local-definitions-supported' feature indicates that the
server supports locally-defined keys."; server supports locally-defined keys.";
} }
/****************/ /****************/
/* Typedefs */ /* Typedefs */
/****************/ /****************/
skipping to change at page 39, line 10 skipping to change at page 39, line 10
environments.. For instance, any modification to a key or reference environments.. For instance, any modification to a key or reference
to a key may dramatically alter the implemented security policy. For to a key may dramatically alter the implemented security policy. For
this reason, the NACM extension "default-deny-write" has been set for this reason, the NACM extension "default-deny-write" has been set for
all data nodes defined in this module. all data nodes defined in this module.
This module does not define any RPCs, actions, or notifications, and This module does not define any RPCs, actions, or notifications, and
thus the security consideration for such is not provided here. thus the security consideration for such is not provided here.
6. IANA Considerations 6. IANA Considerations
6.1. The IETF XML Registry 6.1. The "IETF XML" Registry
This document registers one URI in the "ns" subregistry of the IETF This document registers one URI in the "ns" subregistry of the IETF
XML Registry [RFC3688]. Following the format in [RFC3688], the XML Registry [RFC3688]. Following the format in [RFC3688], the
following registration is requested: following registration is requested:
URI: urn:ietf:params:xml:ns:yang:ietf-keystore URI: urn:ietf:params:xml:ns:yang:ietf-keystore
Registrant Contact: The NETCONF WG of the IETF. Registrant Contact: The NETCONF WG of the IETF.
XML: N/A, the requested URI is an XML namespace. XML: N/A, the requested URI is an XML namespace.
6.2. The YANG Module Names Registry 6.2. The "YANG Module Names" Registry
This document registers one YANG module in the YANG Module Names This document registers one YANG module in the YANG Module Names
registry [RFC6020]. Following the format in [RFC6020], the the registry [RFC6020]. Following the format in [RFC6020], the the
following registration is requested: following registration is requested:
name: ietf-keystore name: ietf-keystore
namespace: urn:ietf:params:xml:ns:yang:ietf-keystore namespace: urn:ietf:params:xml:ns:yang:ietf-keystore
prefix: ks prefix: ks
reference: RFC CCCC reference: RFC CCCC
skipping to change at page 46, line 28 skipping to change at page 46, line 28
* Clarified expected behavior for "built-in" keys in <operational> * Clarified expected behavior for "built-in" keys in <operational>
* Clarified the "Migrating Configuration to Another Server" section. * Clarified the "Migrating Configuration to Another Server" section.
* Expanded "Data Model Overview section(s) [remove "wall" of tree * Expanded "Data Model Overview section(s) [remove "wall" of tree
diagrams]. diagrams].
* Updated the Security Considerations section. * Updated the Security Considerations section.
A.19. 18 to 19
* Updated examples to reflect new "cleartext-" prefix in the crypto-
types draft.
Acknowledgements Acknowledgements
The authors would like to thank for following for lively discussions The authors would like to thank for following for lively discussions
on list and in the halls (ordered by first name): Alan Luchuk, Andy on list and in the halls (ordered by first name): Alan Luchuk, Andy
Bierman, Benoit Claise, Bert Wijnen, Balazs Kovacs, David Lamparter, Bierman, Benoit Claise, Bert Wijnen, Balazs Kovacs, David Lamparter,
Eric Voit, Ladislav Lhotka, Liang Xia, Juergen Schoenwaelder, Mahesh Eric Voit, Ladislav Lhotka, Liang Xia, Juergen Schoenwaelder, Mahesh
Jethanandani, Martin Bjorklund, Mehmet Ersue, Phil Shafer, Radek Jethanandani, Martin Bjorklund, Mehmet Ersue, Phil Shafer, Radek
Krejci, Ramkumar Dhanapal, Reshad Rahman, Sean Turner, and Tom Petch. Krejci, Ramkumar Dhanapal, Reshad Rahman, Sean Turner, and Tom Petch.
Author's Address Author's Address
 End of changes. 33 change blocks. 
36 lines changed or deleted 52 lines changed or added

This html diff was produced by rfcdiff 1.47. The latest version is available from http://tools.ietf.org/tools/rfcdiff/