draft-ietf-netconf-keystore-13.txt   draft-ietf-netconf-keystore-14.txt 
NETCONF Working Group K. Watsen NETCONF Working Group K. Watsen
Internet-Draft Watsen Networks Internet-Draft Watsen Networks
Intended status: Standards Track October 18, 2019 Intended status: Standards Track November 1, 2019
Expires: April 20, 2020 Expires: May 4, 2020
A YANG Data Model for a Keystore A YANG Data Model for a Keystore
draft-ietf-netconf-keystore-13 draft-ietf-netconf-keystore-14
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)
This draft contains many placeholder values that need to be replaced This draft contains many placeholder values that need to be replaced
with finalized values at the time of publication. This note with finalized values at the time of publication. This note
summarizes all of the substitutions that are needed. No other RFC summarizes all of the substitutions that are needed. No other RFC
Editor instructions are specified elsewhere in this document. Editor instructions are specified elsewhere in this document.
Artwork in this document contains shorthand references to drafts in Artwork in this document contains shorthand references to drafts in
progress. Please apply the following replacements: progress. Please apply the following replacements:
o "VVVV" --> the assigned RFC value for this draft o "AAAA" --> the assigned RFC value for
[I-D.ietf-netconf-crypto-types].
o "XXXX" --> 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:
o "2019-10-18" --> the publication date of this draft o "2019-11-02" --> 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:
o Appendix A. Change Log o 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 April 20, 2020. This Internet-Draft will expire on May 4, 2020.
Copyright Notice Copyright Notice
Copyright (c) 2019 IETF Trust and the persons identified as the Copyright (c) 2019 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 Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Requirements Language . . . . . . . . . . . . . . . . . . . . 3 2. Requirements Language . . . . . . . . . . . . . . . . . . . . 4
3. The Keystore Model . . . . . . . . . . . . . . . . . . . . . 4 3. The Keystore Model . . . . . . . . . . . . . . . . . . . . . 4
3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 4 3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 4
3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 13 3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 14
3.2.1. A Keystore Instance . . . . . . . . . . . . . . . . . 14 3.2.1. A Keystore Instance . . . . . . . . . . . . . . . . . 14
3.2.2. The "generate-symmetric-key" RPC . . . . . . . . . . 16 3.2.2. The "generate-symmetric-key" RPC . . . . . . . . . . 16
3.2.3. The "generate-asymmetric-key" RPC . . . . . . . . . . 17 3.2.3. The "generate-asymmetric-key" RPC . . . . . . . . . . 17
3.2.4. Notable Keystore Groupings . . . . . . . . . . . . . 18 3.2.4. Notable Keystore Groupings . . . . . . . . . . . . . 18
3.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 22 3.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 22
4. Security Considerations . . . . . . . . . . . . . . . . . . . 31 4. Security Considerations . . . . . . . . . . . . . . . . . . . 32
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 32 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 33
5.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 33 5.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 33
5.2. The YANG Module Names Registry . . . . . . . . . . . . . 33 5.2. The YANG Module Names Registry . . . . . . . . . . . . . 33
6. References . . . . . . . . . . . . . . . . . . . . . . . . . 33 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 33
6.1. Normative References . . . . . . . . . . . . . . . . . . 33 6.1. Normative References . . . . . . . . . . . . . . . . . . 33
6.2. Informative References . . . . . . . . . . . . . . . . . 34 6.2. Informative References . . . . . . . . . . . . . . . . . 34
Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 35 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 35
A.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 35 A.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 35
A.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 35 A.2. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 35
A.3. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 35 A.3. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 35
A.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 35 A.4. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 35
A.5. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 36 A.5. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 36
A.6. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 36 A.6. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 36
A.7. 06 to 07 . . . . . . . . . . . . . . . . . . . . . . . . 36 A.7. 06 to 07 . . . . . . . . . . . . . . . . . . . . . . . . 36
A.8. 07 to 08 . . . . . . . . . . . . . . . . . . . . . . . . 36 A.8. 07 to 08 . . . . . . . . . . . . . . . . . . . . . . . . 36
A.9. 08 to 09 . . . . . . . . . . . . . . . . . . . . . . . . 36 A.9. 08 to 09 . . . . . . . . . . . . . . . . . . . . . . . . 36
A.10. 09 to 10 . . . . . . . . . . . . . . . . . . . . . . . . 37 A.10. 09 to 10 . . . . . . . . . . . . . . . . . . . . . . . . 37
A.11. 10 to 11 . . . . . . . . . . . . . . . . . . . . . . . . 37 A.11. 10 to 11 . . . . . . . . . . . . . . . . . . . . . . . . 37
A.12. 11 to 12 . . . . . . . . . . . . . . . . . . . . . . . . 37 A.12. 11 to 12 . . . . . . . . . . . . . . . . . . . . . . . . 37
A.13. 12 to 13 . . . . . . . . . . . . . . . . . . . . . . . . 38 A.13. 12 to 13 . . . . . . . . . . . . . . . . . . . . . . . . 38
A.14. 13 to 14 . . . . . . . . . . . . . . . . . . . . . . . . 38
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 38 Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 38
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 38 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 38
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 4, line 21 skipping to change at page 4, line 27
This section provides a tree diagrams [RFC8340] for the "ietf- This section provides a tree diagrams [RFC8340] for the "ietf-
keystore" module that presents both the protocol-accessible keystore" module that presents both the protocol-accessible
"keystore" as well the all the groupings intended for external usage. "keystore" as well the all the groupings intended for external usage.
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 algorithm | | +--rw algorithm
| | | asymmetric-key-algorithm-t | | | iasa:asymmetric-algorithm-type
| | +--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) | | | +--:(private-key)
| | | | +--rw private-key? binary | | | | +--rw 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
skipping to change at page 5, line 6 skipping to change at page 5, line 11
| | | +---n certificate-expiration | | | +---n certificate-expiration
| | | +-- expiration-date yang:date-and-time | | | +-- expiration-date yang:date-and-time
| | +---x generate-certificate-signing-request | | +---x generate-certificate-signing-request
| | +---w input | | +---w input
| | | +---w subject binary | | | +---w subject binary
| | | +---w attributes? binary | | | +---w attributes? binary
| | +--ro output | | +--ro output
| | +--ro certificate-signing-request binary | | +--ro certificate-signing-request binary
| +---x generate-asymmetric-key | +---x generate-asymmetric-key
| +---w input | +---w input
| | +---w algorithm ct:asymmetric-key-algorithm-t | | +---w algorithm iasa:asymmetric-algorithm-type
| | +---w encrypt-with! | | +---w encrypt-with!
| | +---w (key-type) | | +---w (key-type)
| | +--:(symmetric-key-ref) | | +--:(symmetric-key-ref)
| | | +---w symmetric-key-ref? leafref | | | +---w symmetric-key-ref? leafref
| | | {keystore-supported}? | | | {keystore-supported}?
| | +--:(asymmetric-key-ref) | | +--:(asymmetric-key-ref)
| | +---w asymmetric-key-ref? leafref | | +---w asymmetric-key-ref? leafref
| | {keystore-supported}? | | {keystore-supported}?
| +--ro output | +--ro output
| +--ro algorithm | +--ro algorithm
| | asymmetric-key-algorithm-t | | iasa:asymmetric-algorithm-type
| +--ro public-key-format? identityref | +--ro public-key-format? identityref
| +--ro public-key binary | +--ro public-key binary
| +--ro private-key-format? identityref | +--ro private-key-format? identityref
| +--ro (private-key-type) | +--ro (private-key-type)
| +--:(private-key) | +--:(private-key)
| | +--ro private-key? binary | | +--ro private-key? binary
| +--:(hidden-private-key) | +--:(hidden-private-key)
| | +--ro hidden-private-key? empty | | +--ro hidden-private-key? empty
| +--:(encrypted-private-key) | +--:(encrypted-private-key)
| +--ro encrypted-private-key | +--ro encrypted-private-key
skipping to change at page 5, line 39 skipping to change at page 5, line 44
| | +--:(symmetric-key-ref) | | +--:(symmetric-key-ref)
| | | +--ro symmetric-key-ref? leafref | | | +--ro symmetric-key-ref? leafref
| | | {keystore-supported}? | | | {keystore-supported}?
| | +--:(asymmetric-key-ref) | | +--:(asymmetric-key-ref)
| | +--ro asymmetric-key-ref? leafref | | +--ro asymmetric-key-ref? leafref
| | {keystore-supported}? | | {keystore-supported}?
| +--ro value? binary | +--ro value? binary
+--rw symmetric-keys +--rw symmetric-keys
+--rw symmetric-key* [name] +--rw symmetric-key* [name]
| +--rw name string | +--rw name string
| +--rw algorithm encryption-algorithm-t | +--rw algorithm isa:symmetric-algorithm-type
| +--rw key-format? identityref | +--rw key-format? identityref
| +--rw (key-type) | +--rw (key-type)
| +--:(key) | +--:(key)
| | +--rw key? binary | | +--rw 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 (key-type) | +--rw (key-type)
| | +--:(symmetric-key-ref) | | +--:(symmetric-key-ref)
| | | +--rw symmetric-key-ref? leafref | | | +--rw symmetric-key-ref? leafref
| | | {keystore-supported}? | | | {keystore-supported}?
| | +--:(asymmetric-key-ref) | | +--:(asymmetric-key-ref)
| | +--rw asymmetric-key-ref? leafref | | +--rw asymmetric-key-ref? leafref
| | {keystore-supported}? | | {keystore-supported}?
| +--rw value? binary | +--rw value? binary
+---x generate-symmetric-key +---x generate-symmetric-key
+---w input +---w input
| +---w algorithm ct:encryption-algorithm-t | +---w algorithm isa:symmetric-algorithm-type
| +---w encrypt-with! | +---w encrypt-with!
| +---w (key-type) | +---w (key-type)
| +--:(symmetric-key-ref) | +--:(symmetric-key-ref)
| | +---w symmetric-key-ref? leafref | | +---w symmetric-key-ref? leafref
| | {keystore-supported}? | | {keystore-supported}?
| +--:(asymmetric-key-ref) | +--:(asymmetric-key-ref)
| +---w asymmetric-key-ref? leafref | +---w asymmetric-key-ref? leafref
| {keystore-supported}? | {keystore-supported}?
+--ro output +--ro output
+--ro algorithm encryption-algorithm-t +--ro algorithm
| isa:symmetric-algorithm-type
+--ro key-format? identityref +--ro key-format? identityref
+--ro (key-type) +--ro (key-type)
+--:(key) +--:(key)
| +--ro key? binary | +--ro key? binary
+--:(hidden-key) +--:(hidden-key)
| +--ro hidden-key? empty | +--ro hidden-key? empty
+--:(encrypted-key) +--:(encrypted-key)
+--ro encrypted-key +--ro encrypted-key
+--ro (key-type) +--ro (key-type)
| +--:(symmetric-key-ref) | +--:(symmetric-key-ref)
skipping to change at page 7, line 12 skipping to change at page 7, line 18
| +--:(symmetric-key-ref) | +--:(symmetric-key-ref)
| | +-- symmetric-key-ref? | | +-- symmetric-key-ref?
| | -> /keystore/symmetric-keys/symmetric-key/name | | -> /keystore/symmetric-keys/symmetric-key/name
| | {keystore-supported}? | | {keystore-supported}?
| +--:(asymmetric-key-ref) | +--:(asymmetric-key-ref)
| +-- asymmetric-key-ref? | +-- asymmetric-key-ref?
| -> /keystore/asymmetric-keys/asymmetric-key/name | -> /keystore/asymmetric-keys/asymmetric-key/name
| {keystore-supported}? | {keystore-supported}?
+-- value? binary +-- value? binary
grouping symmetric-key-grouping grouping symmetric-key-grouping
+-- algorithm encryption-algorithm-t +-- algorithm isa:symmetric-algorithm-type
+-- key-format? identityref +-- key-format? identityref
+-- (key-type) +-- (key-type)
+--:(key) +--:(key)
| +-- key? binary | +-- key? binary
+--:(hidden-key) +--:(hidden-key)
| +-- hidden-key? empty | +-- hidden-key? empty
+--:(encrypted-key) +--:(encrypted-key)
+-- encrypted-key +-- encrypted-key
+-- (key-type) +-- (key-type)
| +--:(symmetric-key-ref) | +--:(symmetric-key-ref)
| | +-- symmetric-key-ref? leafref | | +-- symmetric-key-ref? leafref
| | {keystore-supported}? | | {keystore-supported}?
| +--:(asymmetric-key-ref) | +--:(asymmetric-key-ref)
| +-- asymmetric-key-ref? leafref | +-- asymmetric-key-ref? leafref
| {keystore-supported}? | {keystore-supported}?
+-- value? binary +-- value? binary
grouping asymmetric-key-pair-grouping grouping asymmetric-key-pair-grouping
+-- algorithm asymmetric-key-algorithm-t +-- algorithm iasa:asymmetric-algorithm-type
+-- public-key-format? identityref +-- public-key-format? identityref
+-- public-key binary +-- public-key binary
+-- private-key-format? identityref +-- private-key-format? identityref
+-- (private-key-type) +-- (private-key-type)
+--:(private-key) +--:(private-key)
| +-- private-key? binary | +-- private-key? binary
+--:(hidden-private-key) +--:(hidden-private-key)
| +-- hidden-private-key? empty | +-- hidden-private-key? empty
+--:(encrypted-private-key) +--:(encrypted-private-key)
+-- encrypted-private-key +-- encrypted-private-key
+-- (key-type) +-- (key-type)
| +--:(symmetric-key-ref) | +--:(symmetric-key-ref)
| | +-- symmetric-key-ref? leafref | | +-- symmetric-key-ref? leafref
| | {keystore-supported}? | | {keystore-supported}?
| +--:(asymmetric-key-ref) | +--:(asymmetric-key-ref)
| +-- asymmetric-key-ref? leafref | +-- asymmetric-key-ref? leafref
| {keystore-supported}? | {keystore-supported}?
+-- value? binary +-- value? binary
grouping asymmetric-key-pair-with-cert-grouping grouping asymmetric-key-pair-with-cert-grouping
+-- algorithm +-- algorithm
| asymmetric-key-algorithm-t | iasa:asymmetric-algorithm-type
+-- public-key-format? identityref +-- public-key-format? identityref
+-- public-key binary +-- public-key binary
+-- private-key-format? identityref +-- private-key-format? identityref
+-- (private-key-type) +-- (private-key-type)
| +--:(private-key) | +--:(private-key)
| | +-- private-key? binary | | +-- private-key? binary
| +--:(hidden-private-key) | +--:(hidden-private-key)
| | +-- hidden-private-key? empty | | +-- hidden-private-key? empty
| +--:(encrypted-private-key) | +--:(encrypted-private-key)
| +-- encrypted-private-key | +-- encrypted-private-key
skipping to change at page 8, line 33 skipping to change at page 8, line 39
+---n certificate-expiration +---n certificate-expiration
| +-- expiration-date yang:date-and-time | +-- expiration-date yang:date-and-time
+---x generate-certificate-signing-request +---x generate-certificate-signing-request
+---w input +---w input
| +---w subject binary | +---w subject binary
| +---w attributes? binary | +---w attributes? binary
+--ro output +--ro output
+--ro certificate-signing-request binary +--ro certificate-signing-request binary
grouping asymmetric-key-pair-with-certs-grouping grouping asymmetric-key-pair-with-certs-grouping
+-- algorithm +-- algorithm
| asymmetric-key-algorithm-t | iasa:asymmetric-algorithm-type
+-- public-key-format? identityref +-- public-key-format? identityref
+-- public-key binary +-- public-key binary
+-- private-key-format? identityref +-- private-key-format? identityref
+-- (private-key-type) +-- (private-key-type)
| +--:(private-key) | +--:(private-key)
| | +-- private-key? binary | | +-- private-key? binary
| +--:(hidden-private-key) | +--:(hidden-private-key)
| | +-- hidden-private-key? empty | | +-- hidden-private-key? empty
| +--:(encrypted-private-key) | +--:(encrypted-private-key)
| +-- encrypted-private-key | +-- encrypted-private-key
skipping to change at page 9, line 24 skipping to change at page 9, line 30
+--ro output +--ro output
+--ro certificate-signing-request binary +--ro certificate-signing-request binary
grouping asymmetric-key-certificate-ref-grouping grouping asymmetric-key-certificate-ref-grouping
+-- asymmetric-key? ks:asymmetric-key-ref +-- asymmetric-key? ks:asymmetric-key-ref
+-- certificate? leafref +-- certificate? leafref
grouping local-or-keystore-asymmetric-key-grouping grouping local-or-keystore-asymmetric-key-grouping
+-- (local-or-keystore) +-- (local-or-keystore)
+--:(local) {local-definitions-supported}? +--:(local) {local-definitions-supported}?
| +-- local-definition | +-- local-definition
| +-- algorithm | +-- algorithm
| | asymmetric-key-algorithm-t | | iasa:asymmetric-algorithm-type
| +-- public-key-format? identityref | +-- public-key-format? identityref
| +-- public-key binary | +-- public-key binary
| +-- private-key-format? identityref | +-- private-key-format? identityref
| +-- (private-key-type) | +-- (private-key-type)
| +--:(private-key) | +--:(private-key)
| | +-- private-key? binary | | +-- private-key? binary
| +--:(hidden-private-key) | +--:(hidden-private-key)
| | +-- hidden-private-key? empty | | +-- hidden-private-key? empty
| +--:(encrypted-private-key) | +--:(encrypted-private-key)
| +-- encrypted-private-key | +-- encrypted-private-key
skipping to change at page 9, line 50 skipping to change at page 10, line 8
| | +-- asymmetric-key-ref? leafref | | +-- asymmetric-key-ref? leafref
| | {keystore-supported}? | | {keystore-supported}?
| +-- value? binary | +-- value? binary
+--:(keystore) {keystore-supported}? +--:(keystore) {keystore-supported}?
+-- keystore-reference? ks:asymmetric-key-ref +-- keystore-reference? ks:asymmetric-key-ref
grouping local-or-keystore-asymmetric-key-with-certs-grouping grouping local-or-keystore-asymmetric-key-with-certs-grouping
+-- (local-or-keystore) +-- (local-or-keystore)
+--:(local) {local-definitions-supported}? +--:(local) {local-definitions-supported}?
| +-- local-definition | +-- local-definition
| +-- algorithm | +-- algorithm
| | asymmetric-key-algorithm-t | | iasa:asymmetric-algorithm-type
| +-- public-key-format? identityref | +-- public-key-format? identityref
| +-- public-key binary | +-- public-key binary
| +-- private-key-format? identityref | +-- private-key-format? identityref
| +-- (private-key-type) | +-- (private-key-type)
| | +--:(private-key) | | +--:(private-key)
| | | +-- private-key? binary | | | +-- private-key? binary
| | +--:(hidden-private-key) | | +--:(hidden-private-key)
| | | +-- hidden-private-key? empty | | | +-- hidden-private-key? empty
| | +--:(encrypted-private-key) | | +--:(encrypted-private-key)
| | +-- encrypted-private-key | | +-- encrypted-private-key
skipping to change at page 10, line 40 skipping to change at page 10, line 46
| | +---w attributes? binary | | +---w attributes? binary
| +--ro output | +--ro output
| +--ro certificate-signing-request binary | +--ro certificate-signing-request binary
+--:(keystore) {keystore-supported}? +--:(keystore) {keystore-supported}?
+-- keystore-reference? ks:asymmetric-key-ref +-- keystore-reference? ks:asymmetric-key-ref
grouping local-or-keystore-end-entity-cert-with-key-grouping grouping local-or-keystore-end-entity-cert-with-key-grouping
+-- (local-or-keystore) +-- (local-or-keystore)
+--:(local) {local-definitions-supported}? +--:(local) {local-definitions-supported}?
| +-- local-definition | +-- local-definition
| +-- algorithm | +-- algorithm
| | asymmetric-key-algorithm-t | | iasa:asymmetric-algorithm-type
| +-- public-key-format? identityref | +-- public-key-format? identityref
| +-- public-key binary | +-- public-key binary
| +-- private-key-format? identityref | +-- private-key-format? identityref
| +-- (private-key-type) | +-- (private-key-type)
| | +--:(private-key) | | +--:(private-key)
| | | +-- private-key? binary | | | +-- private-key? binary
| | +--:(hidden-private-key) | | +--:(hidden-private-key)
| | | +-- hidden-private-key? empty | | | +-- hidden-private-key? empty
| | +--:(encrypted-private-key) | | +--:(encrypted-private-key)
| | +-- encrypted-private-key | | +-- encrypted-private-key
skipping to change at page 11, line 30 skipping to change at page 11, line 36
| +--ro certificate-signing-request binary | +--ro certificate-signing-request binary
+--:(keystore) {keystore-supported}? +--:(keystore) {keystore-supported}?
+-- keystore-reference +-- keystore-reference
+-- asymmetric-key? ks:asymmetric-key-ref +-- asymmetric-key? ks:asymmetric-key-ref
+-- certificate? leafref +-- certificate? leafref
grouping keystore-grouping grouping keystore-grouping
+-- asymmetric-keys +-- asymmetric-keys
| +-- asymmetric-key* [name] | +-- asymmetric-key* [name]
| | +-- name? string | | +-- name? string
| | +-- algorithm | | +-- algorithm
| | | asymmetric-key-algorithm-t | | | iasa:asymmetric-algorithm-type
| | +-- public-key-format? identityref | | +-- public-key-format? identityref
| | +-- public-key binary | | +-- public-key binary
| | +-- private-key-format? identityref | | +-- private-key-format? identityref
| | +-- (private-key-type) | | +-- (private-key-type)
| | | +--:(private-key) | | | +--:(private-key)
| | | | +-- private-key? binary | | | | +-- private-key? binary
| | | +--:(hidden-private-key) | | | +--:(hidden-private-key)
| | | | +-- hidden-private-key? empty | | | | +-- hidden-private-key? empty
| | | +--:(encrypted-private-key) | | | +--:(encrypted-private-key)
| | | +-- encrypted-private-key | | | +-- encrypted-private-key
skipping to change at page 12, line 15 skipping to change at page 12, line 21
| | | +---n certificate-expiration | | | +---n certificate-expiration
| | | +-- expiration-date yang:date-and-time | | | +-- expiration-date yang:date-and-time
| | +---x generate-certificate-signing-request | | +---x generate-certificate-signing-request
| | +---w input | | +---w input
| | | +---w subject binary | | | +---w subject binary
| | | +---w attributes? binary | | | +---w attributes? binary
| | +--ro output | | +--ro output
| | +--ro certificate-signing-request binary | | +--ro certificate-signing-request binary
| +---x generate-asymmetric-key | +---x generate-asymmetric-key
| +---w input | +---w input
| | +---w algorithm ct:asymmetric-key-algorithm-t | | +---w algorithm iasa:asymmetric-algorithm-type
| | +---w encrypt-with! | | +---w encrypt-with!
| | +---w (key-type) | | +---w (key-type)
| | +--:(symmetric-key-ref) | | +--:(symmetric-key-ref)
| | | +---w symmetric-key-ref? leafref | | | +---w symmetric-key-ref? leafref
| | | {keystore-supported}? | | | {keystore-supported}?
| | +--:(asymmetric-key-ref) | | +--:(asymmetric-key-ref)
| | +---w asymmetric-key-ref? leafref | | +---w asymmetric-key-ref? leafref
| | {keystore-supported}? | | {keystore-supported}?
| +--ro output | +--ro output
| +--ro algorithm | +--ro algorithm
| | asymmetric-key-algorithm-t | | iasa:asymmetric-algorithm-type
| +--ro public-key-format? identityref | +--ro public-key-format? identityref
| +--ro public-key binary | +--ro public-key binary
| +--ro private-key-format? identityref | +--ro private-key-format? identityref
| +--ro (private-key-type) | +--ro (private-key-type)
| +--:(private-key) | +--:(private-key)
| | +--ro private-key? binary | | +--ro private-key? binary
| +--:(hidden-private-key) | +--:(hidden-private-key)
| | +--ro hidden-private-key? empty | | +--ro hidden-private-key? empty
| +--:(encrypted-private-key) | +--:(encrypted-private-key)
| +--ro encrypted-private-key | +--ro encrypted-private-key
skipping to change at page 12, line 48 skipping to change at page 13, line 6
| | +--:(symmetric-key-ref) | | +--:(symmetric-key-ref)
| | | +--ro symmetric-key-ref? leafref | | | +--ro symmetric-key-ref? leafref
| | | {keystore-supported}? | | | {keystore-supported}?
| | +--:(asymmetric-key-ref) | | +--:(asymmetric-key-ref)
| | +--ro asymmetric-key-ref? leafref | | +--ro asymmetric-key-ref? leafref
| | {keystore-supported}? | | {keystore-supported}?
| +--ro value? binary | +--ro value? binary
+-- symmetric-keys +-- symmetric-keys
+-- symmetric-key* [name] +-- symmetric-key* [name]
| +-- name? string | +-- name? string
| +-- algorithm encryption-algorithm-t | +-- algorithm isa:symmetric-algorithm-type
| +-- key-format? identityref | +-- key-format? identityref
| +-- (key-type) | +-- (key-type)
| +--:(key) | +--:(key)
| | +-- key? binary | | +-- key? binary
| +--:(hidden-key) | +--:(hidden-key)
| | +-- hidden-key? empty | | +-- hidden-key? empty
| +--:(encrypted-key) | +--:(encrypted-key)
| +-- encrypted-key | +-- encrypted-key
| +-- (key-type) | +-- (key-type)
| | +--:(symmetric-key-ref) | | +--:(symmetric-key-ref)
| | | +-- symmetric-key-ref? leafref | | | +-- symmetric-key-ref? leafref
| | | {keystore-supported}? | | | {keystore-supported}?
| | +--:(asymmetric-key-ref) | | +--:(asymmetric-key-ref)
| | +-- asymmetric-key-ref? leafref | | +-- asymmetric-key-ref? leafref
| | {keystore-supported}? | | {keystore-supported}?
| +-- value? binary | +-- value? binary
+---x generate-symmetric-key +---x generate-symmetric-key
+---w input +---w input
| +---w algorithm ct:encryption-algorithm-t | +---w algorithm isa:symmetric-algorithm-type
| +---w encrypt-with! | +---w encrypt-with!
| +---w (key-type) | +---w (key-type)
| +--:(symmetric-key-ref) | +--:(symmetric-key-ref)
| | +---w symmetric-key-ref? leafref | | +---w symmetric-key-ref? leafref
| | {keystore-supported}? | | {keystore-supported}?
| +--:(asymmetric-key-ref) | +--:(asymmetric-key-ref)
| +---w asymmetric-key-ref? leafref | +---w asymmetric-key-ref? leafref
| {keystore-supported}? | {keystore-supported}?
+--ro output +--ro output
+--ro algorithm encryption-algorithm-t +--ro algorithm
| isa:symmetric-algorithm-type
+--ro key-format? identityref +--ro key-format? identityref
+--ro (key-type) +--ro (key-type)
+--:(key) +--:(key)
| +--ro key? binary | +--ro key? binary
+--:(hidden-key) +--:(hidden-key)
| +--ro hidden-key? empty | +--ro hidden-key? empty
+--:(encrypted-key) +--:(encrypted-key)
+--ro encrypted-key +--ro encrypted-key
+--ro (key-type) +--ro (key-type)
| +--:(symmetric-key-ref) | +--:(symmetric-key-ref)
skipping to change at page 18, line 38 skipping to change at page 18, line 38
module ex-keystore-usage { module ex-keystore-usage {
yang-version 1.1; yang-version 1.1;
namespace "http://example.com/ns/example-keystore-usage"; namespace "http://example.com/ns/example-keystore-usage";
prefix "eku"; prefix "eku";
import ietf-keystore { import ietf-keystore {
prefix ks; prefix ks;
reference reference
"RFC VVVV: YANG Data Model for a 'Keystore' Mechanism"; "RFC XXXX: YANG Data Model for a 'Keystore' Mechanism";
} }
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 the grouping in the keystore draft called "This module illustrates the grouping in the keystore draft called
skipping to change at page 22, line 11 skipping to change at page 22, line 11
</end-entity-cert-with-key> </end-entity-cert-with-key>
</keystore-usage> </keystore-usage>
3.3. YANG Module 3.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], and an informative reference to [I-D.ietf-netconf-crypto-types], and an informative reference to
[RFC8342]. [RFC8342].
<CODE BEGINS> file "ietf-keystore@2019-10-18.yang" <CODE BEGINS> file "ietf-keystore@2019-11-02.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 {
prefix nacm;
reference
"RFC 8341: Network Configuration Access Control Model";
}
import ietf-crypto-types { import ietf-crypto-types {
prefix ct; prefix ct;
reference reference
"RFC CCCC: Common YANG Data Types for Cryptography"; "RFC AAAA: Common YANG Data Types for Cryptography";
} }
import ietf-netconf-acm { //import iana-hash-algs {
prefix nacm; // prefix iha;
// reference
// "RFC AAAA: Common YANG Data Types for Cryptography";
//}
import iana-symmetric-algs {
prefix isa;
reference reference
"RFC 8341: Network Configuration Access Control Model"; "RFC AAAA: Common YANG Data Types for Cryptography";
}
import iana-asymmetric-algs {
prefix iasa;
reference
"RFC AAAA: Common YANG Data Types for Cryptography";
} }
organization organization
"IETF NETCONF (Network Configuration) Working Group"; "IETF NETCONF (Network Configuration) Working Group";
contact contact
"WG Web: <http://datatracker.ietf.org/wg/netconf/> "WG Web: <http://datatracker.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org> WG List: <mailto:netconf@ietf.org>
Author: Kent Watsen <mailto:kent+ietf@watsen.net>"; Author: Kent Watsen <mailto:kent+ietf@watsen.net>";
skipping to change at page 23, line 14 skipping to change at page 23, line 32
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC (https://www.rfc-editor.org/info/rfcXXXX); 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 2019-10-18 { revision 2019-11-02 {
description description
"Initial version"; "Initial version";
reference reference
"RFC VVVV: A YANG Data Model for a Keystore"; "RFC XXXX: 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.";
skipping to change at page 29, line 47 skipping to change at page 30, line 18
} }
action generate-asymmetric-key { action generate-asymmetric-key {
//nacm:default-deny-all; //nacm:default-deny-all;
description description
"Requests the device to generate an asymmetric key using "Requests the device to generate an asymmetric key using
the specified key algorithm, optionally encrypted using the specified key algorithm, optionally encrypted using
a key in the keystore. The output is this RPC can be a key in the keystore. The output is this RPC can be
used as input to a subsequent configuration request."; used as input to a subsequent configuration request.";
input { input {
leaf algorithm { leaf algorithm {
type ct:asymmetric-key-algorithm-t; type iasa:asymmetric-algorithm-type;
mandatory true; mandatory true;
description description
"The algorithm to be used when generating the key."; "The algorithm to be used when generating the key.";
reference reference
"RFC CCCC: Common YANG Data Types for Cryptography"; "RFC AAAA: Common YANG Data Types for Cryptography";
} }
container encrypt-with { container encrypt-with {
presence presence
"Indicates that the key should be encrypted using "Indicates that the key should be encrypted using
the specified symmetric or asymmetric key. If not the specified symmetric or asymmetric key. If not
specified, then the private key is not encrypted specified, then the private key is not encrypted
when returned."; when returned.";
description description
"A container for the 'key-type' choice."; "A container for the 'key-type' choice.";
uses key-reference-type-grouping; uses key-reference-type-grouping;
skipping to change at page 30, line 45 skipping to change at page 31, line 17
} }
action generate-symmetric-key { action generate-symmetric-key {
//nacm:default-deny-all; //nacm:default-deny-all;
description description
"Requests the device to generate an symmetric key using "Requests the device to generate an symmetric key using
the specified key algorithm, optionally encrypted using the specified key algorithm, optionally encrypted using
a key in the keystore. The output is this RPC can be a key in the keystore. The output is this RPC can be
used as input to a subsequent configuration request."; used as input to a subsequent configuration request.";
input { input {
leaf algorithm { leaf algorithm {
type ct:encryption-algorithm-t; type isa:symmetric-algorithm-type;
mandatory true; mandatory true;
description description
"The algorithm to be used when generating the key."; "The algorithm to be used when generating the key.";
reference reference
"RFC CCCC: Common YANG Data Types for Cryptography"; "RFC AAAA: Common YANG Data Types for Cryptography";
} }
container encrypt-with { container encrypt-with {
presence presence
"Indicates that the key should be encrypted using "Indicates that the key should be encrypted using
the specified symmetric or asymmetric key. If not the specified symmetric or asymmetric key. If not
specified, then the private key is not encrypted specified, then the private key is not encrypted
when returned."; when returned.";
description description
"A container for the 'key-type' choice."; "A container for the 'key-type' choice.";
uses key-reference-type-grouping; uses key-reference-type-grouping;
skipping to change at page 33, line 23 skipping to change at page 33, line 35
5.2. The YANG Module Names Registry 5.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 VVVV reference: RFC XXXX
6. References 6. References
6.1. Normative References 6.1. Normative References
[I-D.ietf-netconf-crypto-types] [I-D.ietf-netconf-crypto-types]
Watsen, K. and H. Wang, "Common YANG Data Types for Watsen, K. and H. Wang, "Common YANG Data Types for
Cryptography", draft-ietf-netconf-crypto-types-10 (work in Cryptography", draft-ietf-netconf-crypto-types-11 (work in
progress), July 2019. progress), October 2019.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997, DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>. <https://www.rfc-editor.org/info/rfc2119>.
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020, the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010, DOI 10.17487/RFC6020, October 2010,
<https://www.rfc-editor.org/info/rfc6020>. <https://www.rfc-editor.org/info/rfc6020>.
skipping to change at page 38, line 16 skipping to change at page 38, line 16
asymmetric-key' RPCs. asymmetric-key' RPCs.
o Updated the Introduction section. o Updated the Introduction section.
A.13. 12 to 13 A.13. 12 to 13
o Updated examples to incorporate new "key-format" identities. o Updated examples to incorporate new "key-format" identities.
o Made the two "generate-*-key" RPCs be "action" statements instead. o Made the two "generate-*-key" RPCs be "action" statements instead.
A.14. 13 to 14
o Updated YANG module and examples to incorporate the new
iana-*-algorithm modules 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. 43 change blocks. 
44 lines changed or deleted 73 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/