draft-ietf-netconf-crypto-types-11.txt   draft-ietf-netconf-crypto-types-12.txt 
NETCONF Working Group K. Watsen NETCONF Working Group K. Watsen
Internet-Draft Watsen Networks Internet-Draft Watsen Networks
Intended status: Standards Track H. Wang Intended status: Standards Track H. Wang
Expires: April 20, 2020 Huawei Expires: May 4, 2020 Huawei
October 18, 2019 November 1, 2019
Common YANG Data Types for Cryptography Common YANG Data Types for Cryptography
draft-ietf-netconf-crypto-types-11 draft-ietf-netconf-crypto-types-12
Abstract Abstract
This document defines YANG identities, typedefs, the groupings useful This document defines four YANG modules for types useful to
for cryptographic applications. cryptographic applications. The modules defined include:
o ietf-crypto-types
o iana-symmetric-algs
o iana-asymmetric-algs
o iana-hash-algs
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 "XXXX" --> the assigned RFC value for this draft 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 B. Change Log o Appendix B. 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. The Crypto Types Module . . . . . . . . . . . . . . . . . . . 3 2. The Crypto Types Module . . . . . . . . . . . . . . . . . . . 4
2.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 3 2.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 4
2.2. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 5 2.2. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 6
3. Security Considerations . . . . . . . . . . . . . . . . . . . 51 2.3. Examples . . . . . . . . . . . . . . . . . . . . . . . . 23
3.1. Support for Algorithms . . . . . . . . . . . . . . . . . 51 3. The Symmetric Algorithms Module . . . . . . . . . . . . . . . 27
3.2. No Support for CRMF . . . . . . . . . . . . . . . . . . . 51 3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 27
3.3. Access to Data Nodes . . . . . . . . . . . . . . . . . . 51 3.2. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 27
4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 52 3.3. Examples . . . . . . . . . . . . . . . . . . . . . . . . 31
4.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 52 4. The Asymmetric Algorithms Module . . . . . . . . . . . . . . 31
4.2. The YANG Module Names Registry . . . . . . . . . . . . . 53 4.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 31
5. References . . . . . . . . . . . . . . . . . . . . . . . . . 53 4.2. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 32
5.1. Normative References . . . . . . . . . . . . . . . . . . 53 4.3. Examples . . . . . . . . . . . . . . . . . . . . . . . . 36
5.2. Informative References . . . . . . . . . . . . . . . . . 55 5. The Hash Algorithms Module . . . . . . . . . . . . . . . . . 36
Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 58 5.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 36
A.1. The "asymmetric-key-pair-with-certs-grouping" Grouping . 58 5.2. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 36
A.2. The "generate-certificate-signing-request" Action . . . . 60 5.3. Examples . . . . . . . . . . . . . . . . . . . . . . . . 40
A.3. The "certificate-expiration" Notification . . . . . . . . 61 6. Security Considerations . . . . . . . . . . . . . . . . . . . 40
Appendix B. Change Log . . . . . . . . . . . . . . . . . . . . . 62 6.1. Support for Algorithms . . . . . . . . . . . . . . . . . 40
B.1. I-D to 00 . . . . . . . . . . . . . . . . . . . . . . . . 62 6.2. No Support for CRMF . . . . . . . . . . . . . . . . . . . 41
B.2. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 62 6.3. Access to Data Nodes . . . . . . . . . . . . . . . . . . 41
B.3. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 62 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 42
B.4. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 63 7.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 42
B.5. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 63 7.2. The YANG Module Names Registry . . . . . . . . . . . . . 43
B.6. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 64 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 43
B.7. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 64 8.1. Normative References . . . . . . . . . . . . . . . . . . 43
B.8. 06 to 07 . . . . . . . . . . . . . . . . . . . . . . . . 64 8.2. Informative References . . . . . . . . . . . . . . . . . 46
B.9. 07 to 08 . . . . . . . . . . . . . . . . . . . . . . . . 65 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 49
B.10. 08 to 09 . . . . . . . . . . . . . . . . . . . . . . . . 65 A.1. I-D to 00 . . . . . . . . . . . . . . . . . . . . . . . . 49
B.11. 09 to 10 . . . . . . . . . . . . . . . . . . . . . . . . 65 A.2. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 49
B.12. 10 to 11 . . . . . . . . . . . . . . . . . . . . . . . . 65 A.3. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 49
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 66 A.4. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 49
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 66 A.5. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 50
A.6. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 50
A.7. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 50
A.8. 06 to 07 . . . . . . . . . . . . . . . . . . . . . . . . 51
A.9. 07 to 08 . . . . . . . . . . . . . . . . . . . . . . . . 51
A.10. 08 to 09 . . . . . . . . . . . . . . . . . . . . . . . . 51
A.11. 09 to 10 . . . . . . . . . . . . . . . . . . . . . . . . 51
A.12. 10 to 11 . . . . . . . . . . . . . . . . . . . . . . . . 52
A.13. 11 to 12 . . . . . . . . . . . . . . . . . . . . . . . . 52
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 52
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 52
1. Introduction 1. Introduction
This document defines a YANG 1.1 [RFC7950] module specifying This document defines four YANG 1.1 [RFC7950] modules for types
identities, typedefs, and groupings useful for cryptography. useful to cryptographic applications. The modules defined include:
o ietf-crypto-types
o iana-symmetric-algs
o iana-asymmetric-algs
o iana-hash-algs
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP "OPTIONAL" in this document are to be interpreted as described in BCP
14 [RFC2119] [RFC8174] when, and only when, they appear in all 14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here. capitals, as shown here.
2. The Crypto Types Module 2. The Crypto Types Module
2.1. Tree Diagram 2.1. Tree Diagram
This section provides a tree diagram [RFC8340] for the "ietf-crypto- This section provides a tree diagram [RFC8340] for the "ietf-crypto-
types" module. Only the groupings as represented, as tree diagrams types" module. Only "grouping" statements are represented, as tree
have no means to represent identities or typedefs. diagrams have no means to represent identities or typedefs.
module: ietf-crypto-types module: ietf-crypto-types
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
grouping public-key-grouping grouping public-key-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
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
grouping trust-anchor-cert-grouping grouping trust-anchor-cert-grouping
+-- cert? trust-anchor-cert-cms +-- cert? trust-anchor-cert-cms
skipping to change at page 4, line 23 skipping to change at page 5, line 4
+---n certificate-expiration +---n certificate-expiration
+-- expiration-date yang:date-and-time +-- expiration-date yang:date-and-time
grouping end-entity-cert-grouping grouping end-entity-cert-grouping
+-- cert? end-entity-cert-cms +-- cert? end-entity-cert-cms
+---n certificate-expiration +---n certificate-expiration
+-- expiration-date yang:date-and-time +-- expiration-date yang:date-and-time
grouping end-entity-certs-grouping grouping end-entity-certs-grouping
+-- cert* end-entity-cert-cms +-- cert* end-entity-cert-cms
+---n certificate-expiration +---n certificate-expiration
+-- expiration-date yang:date-and-time +-- expiration-date yang:date-and-time
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
+-- cert? end-entity-cert-cms +-- cert? end-entity-cert-cms
+---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
+-- certificates +-- certificates
| +-- certificate* [name] | +-- certificate* [name]
skipping to change at page 5, line 31 skipping to change at page 6, line 17
This module has normative references to [RFC2404], [RFC3565], This module has normative references to [RFC2404], [RFC3565],
[RFC3686], [RFC4106], [RFC4253], [RFC4279], [RFC4309], [RFC4494], [RFC3686], [RFC4106], [RFC4253], [RFC4279], [RFC4309], [RFC4494],
[RFC4543], [RFC4868], [RFC5280], [RFC5652], [RFC5656], [RFC6187], [RFC4543], [RFC4868], [RFC5280], [RFC5652], [RFC5656], [RFC6187],
[RFC6991], [RFC7919], [RFC8268], [RFC8332], [RFC8341], [RFC8422], [RFC6991], [RFC7919], [RFC8268], [RFC8332], [RFC8341], [RFC8422],
[RFC8446], and [ITU.X690.2015]. [RFC8446], and [ITU.X690.2015].
This module has an informational reference to [RFC2986], [RFC3174], This module has an informational reference to [RFC2986], [RFC3174],
[RFC4493], [RFC5915], [RFC6125], [RFC6234], [RFC6239], [RFC6507], [RFC4493], [RFC5915], [RFC6125], [RFC6234], [RFC6239], [RFC6507],
[RFC8017], [RFC8032], [RFC8439]. [RFC8017], [RFC8032], [RFC8439].
<CODE BEGINS> file "ietf-crypto-types@2019-10-18.yang" <CODE BEGINS> file "ietf-crypto-types@2019-11-02.yang"
module ietf-crypto-types { module ietf-crypto-types {
yang-version 1.1; yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-crypto-types"; namespace "urn:ietf:params:xml:ns:yang:ietf-crypto-types";
prefix ct; prefix ct;
import ietf-yang-types { import ietf-yang-types {
prefix yang; prefix yang;
reference reference
"RFC 6991: Common YANG Data Types"; "RFC 6991: Common YANG Data Types";
} }
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";
} }
//import iana-hash-algs {
// prefix iha;
// reference
// "RFC XXXX: Common YANG Data Types for Cryptography";
//}
import iana-symmetric-algs {
prefix isa;
reference
"RFC XXXX: Common YANG Data Types for Cryptography";
}
import iana-asymmetric-algs {
prefix iasa;
reference
"RFC XXXX: 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>
Author: Wang Haiguang <wang.haiguang.shieldlab@huawei.com>"; Author: Wang Haiguang <wang.haiguang.shieldlab@huawei.com>";
description description
skipping to change at page 6, line 36 skipping to change at page 7, line 38
(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 XXXX: Common YANG Data Types for Cryptography"; "RFC XXXX: Common YANG Data Types for Cryptography";
} }
/**************************************/
/* Identities for Hash Algorithms */
/**************************************/
typedef hash-algorithm-t {
type union {
type uint16;
type enumeration {
enum NONE {
value 0;
description
"Hash algorithm is NULL.";
}
enum sha1 {
value 1;
status obsolete;
description
"The SHA1 algorithm.";
reference
"RFC 3174: US Secure Hash Algorithms 1 (SHA1).";
}
enum sha-224 {
value 2;
description
"The SHA-224 algorithm.";
reference
"RFC 6234: US Secure Hash Algorithms.";
}
enum sha-256 {
value 3;
description
"The SHA-256 algorithm.";
reference
"RFC 6234: US Secure Hash Algorithms.";
}
enum sha-384 {
value 4;
description
"The SHA-384 algorithm.";
reference
"RFC 6234: US Secure Hash Algorithms.";
}
enum sha-512 {
value 5;
description
"The SHA-512 algorithm.";
reference
"RFC 6234: US Secure Hash Algorithms.";
}
enum shake-128 {
value 6;
description
"The SHA3 algorithm with 128-bits output.";
reference
"National Institute of Standards and Technology,
SHA-3 Standard: Permutation-Based Hash and
Extendable-Output Functions, FIPS PUB 202, DOI
10.6028/NIST.FIPS.202, August 2015.";
}
enum shake-224 {
value 7;
description
"The SHA3 algorithm with 224-bits output.";
reference
"National Institute of Standards and Technology,
SHA-3 Standard: Permutation-Based Hash and
Extendable-Output Functions, FIPS PUB 202, DOI
10.6028/NIST.FIPS.202, August 2015.";
}
enum shake-256 {
value 8;
description
"The SHA3 algorithm with 256-bits output.";
reference
"National Institute of Standards and Technology,
SHA-3 Standard: Permutation-Based Hash and
Extendable-Output Functions, FIPS PUB 202, DOI
10.6028/NIST.FIPS.202, August 2015.";
}
enum shake-384 {
value 9;
description
"The SHA3 algorithm with 384-bits output.";
reference
"National Institute of Standards and Technology,
SHA-3 Standard: Permutation-Based Hash and
Extendable-Output Functions, FIPS PUB 202, DOI
10.6028/NIST.FIPS.202, August 2015.";
}
enum shake-512 {
value 10;
description
"The SHA3 algorithm with 384-bits output.";
reference
"National Institute of Standards and Technology,
SHA-3 Standard: Permutation-Based Hash and
Extendable-Output Functions, FIPS PUB 202, DOI
10.6028/NIST.FIPS.202, August 2015.";
}
}
}
default "0";
description
"The uint16 filed shall be set by individual protocol families
according to the hash algorithm value assigned by IANA. The
setting is optional and by default is 0. The enumeration
filed is set to the selected hash algorithm.";
}
/***********************************************/
/* Identities for Asymmetric Key Algorithms */
/***********************************************/
typedef asymmetric-key-algorithm-t {
type union {
type uint16;
type enumeration {
enum NONE {
value 0;
description
"Asymetric key algorithm is NULL.";
}
enum rsa1024 {
value 1;
description
"The RSA algorithm using a 1024-bit key.";
reference
"RFC 8017: PKCS #1: RSA Cryptography
Specifications Version 2.2.";
}
enum rsa2048 {
value 2;
description
"The RSA algorithm using a 2048-bit key.";
reference
"RFC 8017:
PKCS #1: RSA Cryptography Specifications Version 2.2.";
}
enum rsa3072 {
value 3;
description
"The RSA algorithm using a 3072-bit key.";
reference
"RFC 8017:
PKCS #1: RSA Cryptography Specifications Version 2.2.";
}
enum rsa4096 {
value 4;
description
"The RSA algorithm using a 4096-bit key.";
reference
"RFC 8017:
PKCS #1: RSA Cryptography Specifications Version 2.2.";
}
enum rsa7680 {
value 5;
description
"The RSA algorithm using a 7680-bit key.";
reference
"RFC 8017:
PKCS #1: RSA Cryptography Specifications Version 2.2.";
}
enum rsa15360 {
value 6;
description
"The RSA algorithm using a 15360-bit key.";
reference
"RFC 8017:
PKCS #1: RSA Cryptography Specifications Version 2.2.";
}
enum secp192r1 {
value 7;
description
"The asymmetric algorithm using a NIST P192 Curve.";
reference
"RFC 6090:
Fundamental Elliptic Curve Cryptography Algorithms.
RFC 5480:
Elliptic Curve Cryptography Subject Public Key
Information.";
}
enum secp224r1 {
value 8;
description
"The asymmetric algorithm using a NIST P224 Curve.";
reference
"RFC 6090:
Fundamental Elliptic Curve Cryptography Algorithms.
RFC 5480:
Elliptic Curve Cryptography Subject Public Key
Information.";
}
enum secp256r1 {
value 9;
description
"The asymmetric algorithm using a NIST P256 Curve.";
reference
"RFC 6090:
Fundamental Elliptic Curve Cryptography Algorithms.
RFC 5480:
Elliptic Curve Cryptography Subject Public Key
Information.";
}
enum secp384r1 {
value 10;
description
"The asymmetric algorithm using a NIST P384 Curve.";
reference
"RFC 6090:
Fundamental Elliptic Curve Cryptography Algorithms.
RFC 5480:
Elliptic Curve Cryptography Subject Public Key
Information.";
}
enum secp521r1 {
value 11;
description
"The asymmetric algorithm using a NIST P521 Curve.";
reference
"RFC 6090:
Fundamental Elliptic Curve Cryptography Algorithms.
RFC 5480:
Elliptic Curve Cryptography Subject Public Key
Information.";
}
enum x25519 {
value 12;
description
"The asymmetric algorithm using a x.25519 Curve.";
reference
"RFC 7748:
Elliptic Curves for Security.";
}
enum x448 {
value 13;
description
"The asymmetric algorithm using a x.448 Curve.";
reference
"RFC 7748:
Elliptic Curves for Security.";
}
}
}
default "0";
description
"The uint16 filed shall be set by individual protocol
families according to the asymmetric key algorithm value
assigned by IANA. The setting is optional and by default
is 0. The enumeration filed is set to the selected
asymmetric key algorithm.";
}
/*************************************/
/* Identities for MAC Algorithms */
/*************************************/
typedef mac-algorithm-t {
type union {
type uint16;
type enumeration {
enum NONE {
value 0;
description
"mac algorithm is NULL.";
}
enum hmac-sha1 {
value 1;
description
"Generating MAC using SHA1 hash function";
reference
"RFC 3174: US Secure Hash Algorithm 1 (SHA1)";
}
enum hmac-sha1-96 {
value 2;
description
"Generating MAC using SHA1 hash function";
reference
"RFC 2404: The Use of HMAC-SHA-1-96 within ESP and AH";
}
enum hmac-sha2-224 {
value 3;
description
"Generating MAC using SHA2 hash function";
reference
"RFC 6234: US Secure Hash Algorithms
(SHA and SHA-based HMAC and HKDF)";
}
enum hmac-sha2-256 {
value 4;
description
"Generating MAC using SHA2 hash function";
reference
"RFC 6234: US Secure Hash Algorithms
(SHA and SHA-based HMAC and HKDF)";
}
enum hmac-sha2-256-128 {
value 5;
description
"Generating a 256 bits MAC using SHA2 hash function and
truncate it to 128 bits";
reference
"RFC 4868: Using HMAC-SHA-256, HMAC-SHA-384,
and HMAC-SHA-512 with IPsec";
}
enum hmac-sha2-384 {
value 6;
description
"Generating a 384 bits MAC using SHA2 hash function";
reference
"RFC 6234: US Secure Hash Algorithms
(SHA and SHA-based HMAC and HKDF)";
}
enum hmac-sha2-384-192 {
value 7;
description
"Generating a 384 bits MAC using SHA2 hash function and
truncate it to 192 bits";
reference
"RFC 4868: Using HMAC-SHA-256, HMAC-SHA-384,
and HMAC-SHA-512 with IPsec";
}
enum hmac-sha2-512 {
value 8;
description
"Generating a 512 bits MAC using SHA2 hash function";
reference
"RFC 6234: US Secure Hash Algorithms
(SHA and SHA-based HMAC and HKDF)";
}
enum hmac-sha2-512-256 {
value 9;
description
"Generating a 512 bits MAC using SHA2 hash function and
truncate it to 256 bits";
reference
"RFC 4868: Using HMAC-SHA-256, HMAC-SHA-384,
and HMAC-SHA-512 with IPsec";
}
enum aes-128-gmac {
value 10;
description
"Generating 128-bit MAC using the Advanced Encryption
Standard (AES) Galois Message Authentication Code
(GMAC) as a mechanism to provide data origin
authentication.";
reference
"RFC 4543:
The Use of Galois Message Authentication Code (GMAC)
in IPsec ESP and AH";
}
enum aes-192-gmac {
value 11;
description
"Generating 192-bit MAC using the Advanced Encryption
Standard (AES) Galois Message Authentication Code
(GMAC) as a mechanism to provide data origin
authentication.";
reference
"RFC 4543:
The Use of Galois Message Authentication Code (GMAC)
in IPsec ESP and AH";
}
enum aes-256-gmac {
value 12;
description
"Generating 256-bit MAC using the Advanced Encryption
Standard (AES) Galois Message Authentication Code
(GMAC) as a mechanism to provide data origin
authentication.";
reference
"RFC 4543:
The Use of Galois Message Authentication Code (GMAC)
in IPsec ESP and AH";
}
enum aes-cmac-96 {
value 13;
description
"Generating 96-bit MAC using Advanced Encryption
Standard (AES) Cipher-based Message Authentication
Code (CMAC)";
reference
"RFC 4494:
The AES-CMAC Algorithm and its Use with IPsec";
}
enum aes-cmac-128 {
value 14;
description
"Generating 128-bit MAC using Advanced Encryption
Standard (AES) Cipher-based Message Authentication
Code (CMAC)";
reference
"RFC 4494:
The AES-CMAC Algorithm and its Use with IPsec";
}
enum sha1-des3-kd {
value 15;
description
"Generating MAC using triple DES encryption function";
reference
"RFC 3961:
Encryption and Checksum Specifications for Kerberos
5";
}
}
}
default "0";
description
"The uint16 filed shall be set by individual protocol
families according to the mac algorithm value assigned by
IANA. The setting is optional and by default is 0. The
enumeration filed is set to the selected mac algorithm.";
}
/********************************************/
/* Identities for Encryption Algorithms */
/********************************************/
typedef encryption-algorithm-t {
type union {
type uint16;
type enumeration {
enum NONE {
value 0;
description
"Encryption algorithm is NULL.";
}
enum aes-128-cbc {
value 1;
description
"Encrypt message with AES algorithm in CBC mode with
a key length of 128 bits.";
reference
"RFC 3565: Use of the Advanced Encryption Standard (AES)
Encryption Algorithm in Cryptographic Message Syntax
(CMS)";
}
enum aes-192-cbc {
value 2;
description
"Encrypt message with AES algorithm in CBC mode with
a key length of 192 bits";
reference
"RFC 3565: Use of the Advanced Encryption Standard (AES)
Encryption Algorithm in Cryptographic Message Syntax
(CMS)";
}
enum aes-256-cbc {
value 3;
description
"Encrypt message with AES algorithm in CBC mode with
a key length of 256 bits";
reference
"RFC 3565: Use of the Advanced Encryption Standard (AES)
Encryption Algorithm in Cryptographic Message Syntax
(CMS)";
}
enum aes-128-ctr {
value 4;
description
"Encrypt message with AES algorithm in CTR mode with
a key length of 128 bits";
reference
"RFC 3686:
Using Advanced Encryption Standard (AES) Counter
Mode with IPsec Encapsulating Security Payload
(ESP)";
}
enum aes-192-ctr {
value 5;
description
"Encrypt message with AES algorithm in CTR mode with
a key length of 192 bits";
reference
"RFC 3686:
Using Advanced Encryption Standard (AES) Counter
Mode with IPsec Encapsulating Security Payload
(ESP)";
}
enum aes-256-ctr {
value 6;
description
"Encrypt message with AES algorithm in CTR mode with
a key length of 256 bits";
reference
"RFC 3686:
Using Advanced Encryption Standard (AES) Counter
Mode with IPsec Encapsulating Security Payload
(ESP)";
}
enum des3-cbc-sha1-kd {
value 7;
description
"Encrypt message with 3DES algorithm in CBC mode
with sha1 function for key derivation";
reference
"RFC 3961:
Encryption and Checksum Specifications for
Kerberos 5";
}
enum rc4-hmac {
value 8;
description
"Encrypt message with rc4 algorithm";
reference
"RFC 4757:
The RC4-HMAC Kerberos Encryption Types Used by
Microsoft Windows";
}
enum rc4-hmac-exp {
value 9;
description
"Encrypt message with rc4 algorithm that is exportable";
reference
"RFC 4757:
The RC4-HMAC Kerberos Encryption Types Used by
Microsoft Windows";
}
}
}
default "0";
description
"The uint16 filed shall be set by individual protocol
families according to the encryption algorithm value
assigned by IANA. The setting is optional and by default
is 0. The enumeration filed is set to the selected
encryption algorithm.";
}
/****************************************************/
/* Identities for Encryption and MAC Algorithms */
/****************************************************/
typedef encryption-and-mac-algorithm-t {
type union {
type uint16;
type enumeration {
enum NONE {
value 0;
description
"Encryption and MAC algorithm is NULL.";
reference
"None";
}
enum aes-128-ccm {
value 1;
description
"Encrypt message with AES algorithm in CCM
mode with a key length of 128 bits; it can
also be used for generating MAC";
reference
"RFC 4309: Using Advanced Encryption Standard
(AES) CCM Mode with IPsec Encapsulating Security
Payload (ESP)";
}
enum aes-192-ccm {
value 2;
description
"Encrypt message with AES algorithm in CCM
mode with a key length of 192 bits; it can
also be used for generating MAC";
reference
"RFC 4309: Using Advanced Encryption Standard
(AES) CCM Mode with IPsec Encapsulating Security
Payload (ESP)";
}
enum aes-256-ccm {
value 3;
description
"Encrypt message with AES algorithm in CCM
mode with a key length of 256 bits; it can
also be used for generating MAC";
reference
"RFC 4309: Using Advanced Encryption Standard
(AES) CCM Mode with IPsec Encapsulating Security
Payload (ESP)";
}
enum aes-128-gcm {
value 4;
description
"Encrypt message with AES algorithm in GCM
mode with a key length of 128 bits; it can
also be used for generating MAC";
reference
"RFC 4106: The Use of Galois/Counter Mode (GCM)
in IPsec Encapsulating Security Payload (ESP)";
}
enum aes-192-gcm {
value 5;
description
"Encrypt message with AES algorithm in GCM
mode with a key length of 192 bits; it can
also be used for generating MAC";
reference
"RFC 4106: The Use of Galois/Counter Mode (GCM)
in IPsec Encapsulating Security Payload (ESP)";
}
enum aes-256-gcm {
value 6;
description
"Encrypt message with AES algorithm in GCM
mode with a key length of 256 bits; it can
also be used for generating MAC";
reference
"RFC 4106: The Use of Galois/Counter Mode (GCM)
in IPsec Encapsulating Security Payload (ESP)";
}
enum chacha20-poly1305 {
value 7;
description
"Encrypt message with chacha20 algorithm and generate
MAC with POLY1305; it can also be used for generating
MAC";
reference
"RFC 8439: ChaCha20 and Poly1305 for IETF Protocols";
}
}
}
default "0";
description
"The uint16 filed shall be set by individual protocol
families according to the encryption and mac algorithm value
assigned by IANA. The setting is optional and by default is
0. The enumeration filed is set to the selected encryption
and mac algorithm.";
}
/******************************************/
/* Identities for signature algorithm */
/******************************************/
typedef signature-algorithm-t {
type union {
type uint16;
type enumeration {
enum NONE {
value 0;
description
"Signature algorithm is NULL";
}
enum dsa-sha1 {
value 1;
description
"The signature algorithm using DSA algorithm with SHA1
hash algorithm";
reference
"RFC 4253:
The Secure Shell (SSH) Transport Layer Protocol";
}
enum rsassa-pkcs1-sha1 {
value 2;
description
"The signature algorithm using RSASSA-PKCS1-v1_5 with
the SHA1 hash algorithm.";
reference
"RFC 4253:
The Secure Shell (SSH) Transport Layer Protocol";
}
enum rsassa-pkcs1-sha256 {
value 3;
description
"The signature algorithm using RSASSA-PKCS1-v1_5 with
the SHA256 hash algorithm.";
reference
"RFC 8332:
Use of RSA Keys with SHA-256 and SHA-512 in the
Secure Shell (SSH) Protocol
RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum rsassa-pkcs1-sha384 {
value 4;
description
"The signature algorithm using RSASSA-PKCS1-v1_5 with
the SHA384 hash algorithm.";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum rsassa-pkcs1-sha512 {
value 5;
description
"The signature algorithm using RSASSA-PKCS1-v1_5 with
the SHA512 hash algorithm.";
reference
"RFC 8332:
Use of RSA Keys with SHA-256 and SHA-512 in the
Secure Shell (SSH) Protocol
RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum rsassa-pss-rsae-sha256 {
value 6;
description
"The signature algorithm using RSASSA-PSS with mask
generation function 1 and SHA256 hash algorithm. If
the public key is carried in an X.509 certificate,
it MUST use the rsaEncryption OID";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum rsassa-pss-rsae-sha384 {
value 7;
description
"The signature algorithm using RSASSA-PSS with mask
generation function 1 and SHA384 hash algorithm. If
the public key is carried in an X.509 certificate,
it MUST use the rsaEncryption OID";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum rsassa-pss-rsae-sha512 {
value 8;
description
"The signature algorithm using RSASSA-PSS with mask
generation function 1 and SHA512 hash algorithm. If
the public key is carried in an X.509 certificate,
it MUST use the rsaEncryption OID";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum rsassa-pss-pss-sha256 {
value 9;
description
"The signature algorithm using RSASSA-PSS with mask
generation function 1 and SHA256 hash algorithm. If
the public key is carried in an X.509 certificate,
it MUST use the rsaEncryption OID";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum rsassa-pss-pss-sha384 {
value 10;
description
"The signature algorithm using RSASSA-PSS with mask
generation function 1 and SHA384 hash algorithm. If
the public key is carried in an X.509 certificate,
it MUST use the rsaEncryption OID";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum rsassa-pss-pss-sha512 {
value 11;
description
"The signature algorithm using RSASSA-PSS with mask
generation function 1 and SHA512 hash algorithm. If
the public key is carried in an X.509 certificate,
it MUST use the rsaEncryption OID";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum ecdsa-secp256r1-sha256 {
value 12;
description
"The signature algorithm using ECDSA with curve name
secp256r1 and SHA256 hash algorithm.";
reference
"RFC 5656:
Elliptic Curve Algorithm Integration in the Secure
Shell Transport Layer
RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum ecdsa-secp384r1-sha384 {
value 13;
description
"The signature algorithm using ECDSA with curve name
secp384r1 and SHA384 hash algorithm.";
reference
"RFC 5656:
Elliptic Curve Algorithm Integration in the Secure
Shell Transport Layer
RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum ecdsa-secp521r1-sha512 {
value 14;
description
"The signature algorithm using ECDSA with curve name
secp521r1 and SHA512 hash algorithm.";
reference
"RFC 5656:
Elliptic Curve Algorithm Integration in the Secure
Shell Transport Layer
RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum ed25519 {
value 15;
description
"The signature algorithm using EdDSA with curve x25519";
reference
"RFC 8032:
Edwards-Curve Digital Signature Algorithm (EdDSA)";
}
enum ed25519-cts {
value 16;
description
"The signature algorithm using EdDSA with curve x25519
with phflag = 0";
reference
"RFC 8032:
Edwards-Curve Digital Signature Algorithm (EdDSA)";
}
enum ed25519-ph {
value 17;
description
"The signature algorithm using EdDSA with curve x25519
with phflag = 1";
reference
"RFC 8032:
Edwards-Curve Digital Signature Algorithm (EdDSA)";
}
enum ed25519-sha512 {
value 18;
description
"The signature algorithm using EdDSA with curve x25519
and SHA-512 function";
reference
"RFC 8419:
Use of Edwards-Curve Digital Signature Algorithm
(EdDSA) Signatures in the Cryptographic Message
Syntax (CMS)";
}
enum ed448 {
value 19;
description
"The signature algorithm using EdDSA with curve x448";
reference
"RFC 8032:
Edwards-Curve Digital Signature Algorithm (EdDSA)";
}
enum ed448-ph {
value 20;
description
"The signature algorithm using EdDSA with curve x448
and with PH being SHAKE256(x, 64) and phflag being 1";
reference
"RFC 8032:
Edwards-Curve Digital Signature Algorithm (EdDSA)";
}
enum ed448-shake256 {
value 21;
description
"The signature algorithm using EdDSA with curve x448
and SHAKE-256 function";
reference
"RFC 8419:
Use of Edwards-Curve Digital Signature Algorithm
(EdDSA) Signatures in the Cryptographic Message
Syntax (CMS)";
}
enum ed448-shake256-len {
value 22;
description
"The signature algorithm using EdDSA with curve x448
and SHAKE-256 function and a customized hash output";
reference
"RFC 8419:
Use of Edwards-Curve Digital Signature Algorithm
(EdDSA) Signatures in the Cryptographic Message
Syntax (CMS)";
}
enum rsa-sha2-256 {
value 23;
description
"The signature algorithm using RSA with SHA2 function
for SSH protocol";
reference
"RFC 8332:
Use of RSA Keys with SHA-256 and SHA-512
in the Secure Shell (SSH) Protocol";
}
enum rsa-sha2-512 {
value 24;
description
"The signature algorithm using RSA with SHA2 function
for SSH protocol";
reference
"RFC 8332:
Use of RSA Keys with SHA-256 and SHA-512
in the Secure Shell (SSH) Protocol";
}
enum eccsi {
value 25;
description
"The signature algorithm using ECCSI signature as
defined in RFC 6507.";
reference
"RFC 6507:
Elliptic Curve-Based Certificateless Signatures
for Identity-based Encryption (ECCSI)";
}
}
}
default "0";
description
"The uint16 filed shall be set by individual protocol
families according to the signature algorithm value
assigned by IANA. The setting is optional and by default
is 0. The enumeration filed is set to the selected
signature algorithm.";
}
/**********************************************/
/* Identities for key exchange algorithms */
/**********************************************/
typedef key-exchange-algorithm-t {
type union {
type uint16;
type enumeration {
enum NONE {
value 0;
description
"Key exchange algorithm is NULL.";
}
enum psk-only {
value 1;
description
"Using Pre-shared key for authentication and key
exchange";
reference
"RFC 4279:
Pre-Shared Key cipher suites for Transport Layer
Security (TLS)";
}
enum dhe-ffdhe2048 {
value 2;
description
"Ephemeral Diffie Hellman key exchange with 2048 bit
finite field";
reference
"RFC 7919:
Negotiated Finite Field Diffie-Hellman Ephemeral
Parameters for Transport Layer Security (TLS)";
}
enum dhe-ffdhe3072 {
value 3;
description
"Ephemeral Diffie Hellman key exchange with 3072 bit
finite field";
reference
"RFC 7919:
Negotiated Finite Field Diffie-Hellman Ephemeral
Parameters for Transport Layer Security (TLS)";
}
enum dhe-ffdhe4096 {
value 4;
description
"Ephemeral Diffie Hellman key exchange with 4096 bit
finite field";
reference
"RFC 7919:
Negotiated Finite Field Diffie-Hellman Ephemeral
Parameters for Transport Layer Security (TLS)";
}
enum dhe-ffdhe6144 {
value 5;
description
"Ephemeral Diffie Hellman key exchange with 6144 bit
finite field";
reference
"RFC 7919:
Negotiated Finite Field Diffie-Hellman Ephemeral
Parameters for Transport Layer Security (TLS)";
}
enum dhe-ffdhe8192 {
value 6;
description
"Ephemeral Diffie Hellman key exchange with 8192 bit
finite field";
reference
"RFC 7919:
Negotiated Finite Field Diffie-Hellman Ephemeral
Parameters for Transport Layer Security (TLS)";
}
enum psk-dhe-ffdhe2048 {
value 7;
description
"Key exchange using pre-shared key with Diffie-Hellman
key generation mechanism, where the DH group is
FFDHE2048";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum psk-dhe-ffdhe3072 {
value 8;
description
"Key exchange using pre-shared key with Diffie-Hellman
key generation mechanism, where the DH group is
FFDHE3072";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum psk-dhe-ffdhe4096 {
value 9;
description
"Key exchange using pre-shared key with Diffie-Hellman
key generation mechanism, where the DH group is
FFDHE4096";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum psk-dhe-ffdhe6144 {
value 10;
description
"Key exchange using pre-shared key with Diffie-Hellman
key generation mechanism, where the DH group is
FFDHE6144";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum psk-dhe-ffdhe8192 {
value 11;
description
"Key exchange using pre-shared key with Diffie-Hellman
key generation mechanism, where the DH group is
FFDHE8192";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum ecdhe-secp256r1 {
value 12;
description
"Ephemeral Diffie Hellman key exchange with elliptic
group over curve secp256r1";
reference
"RFC 8422:
Elliptic Curve Cryptography (ECC) Cipher Suites
for Transport Layer Security (TLS) Versions 1.2
and Earlier";
}
enum ecdhe-secp384r1 {
value 13;
description
"Ephemeral Diffie Hellman key exchange with elliptic
group over curve secp384r1";
reference
"RFC 8422:
Elliptic Curve Cryptography (ECC) Cipher Suites
for Transport Layer Security (TLS) Versions 1.2
and Earlier";
}
enum ecdhe-secp521r1 {
value 14;
description
"Ephemeral Diffie Hellman key exchange with elliptic
group over curve secp521r1";
reference
"RFC 8422:
Elliptic Curve Cryptography (ECC) Cipher Suites
for Transport Layer Security (TLS) Versions 1.2
and Earlier";
}
enum ecdhe-x25519 {
value 15;
description
"Ephemeral Diffie Hellman key exchange with elliptic
group over curve x25519";
reference
"RFC 8422:
Elliptic Curve Cryptography (ECC) Cipher Suites
for Transport Layer Security (TLS) Versions 1.2
and Earlier";
}
enum ecdhe-x448 {
value 16;
description
"Ephemeral Diffie Hellman key exchange with elliptic
group over curve x448";
reference
"RFC 8422:
Elliptic Curve Cryptography (ECC) Cipher Suites
for Transport Layer Security (TLS) Versions 1.2
and Earlier";
}
enum psk-ecdhe-secp256r1 {
value 17;
description
"Key exchange using pre-shared key with elliptic
group-based Ephemeral Diffie Hellman key exchange
over curve secp256r1";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum psk-ecdhe-secp384r1 {
value 18;
description
"Key exchange using pre-shared key with elliptic
group-based Ephemeral Diffie Hellman key exchange
over curve secp384r1";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum psk-ecdhe-secp521r1 {
value 19;
description
"Key exchange using pre-shared key with elliptic
group-based Ephemeral Diffie Hellman key exchange
over curve secp521r1";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum psk-ecdhe-x25519 {
value 20;
description
"Key exchange using pre-shared key with elliptic
group-based Ephemeral Diffie Hellman key exchange
over curve x25519";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum psk-ecdhe-x448 {
value 21;
description
"Key exchange using pre-shared key with elliptic
group-based Ephemeral Diffie Hellman key exchange
over curve x448";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol
Version 1.3";
}
enum diffie-hellman-group14-sha1 {
value 22;
description
"Using DH group14 and SHA1 for key exchange";
reference
"RFC 4253:
The Secure Shell (SSH) Transport Layer Protocol";
}
enum diffie-hellman-group14-sha256 {
value 23;
description
"Using DH group14 and SHA-256 for key exchange";
reference
"RFC 8268:
More Modular Exponentiation (MODP) Diffie-Hellman (DH)
Key Exchange (KEX) Groups for Secure Shell (SSH)";
}
enum diffie-hellman-group15-sha512 {
value 24;
description
"Using DH group15 and SHA-512 for key exchange";
reference
"RFC 8268:
More Modular Exponentiation (MODP) Diffie-Hellman (DH)
Key Exchange (KEX) Groups for Secure Shell (SSH)";
}
enum diffie-hellman-group16-sha512 {
value 25;
description
"Using DH group16 and SHA-512 for key exchange";
reference
"RFC 8268:
More Modular Exponentiation (MODP) Diffie-Hellman (DH)
Key Exchange (KEX) Groups for Secure Shell (SSH)";
}
enum diffie-hellman-group17-sha512 {
value 26;
description
"Using DH group17 and SHA-512 for key exchange";
reference
"RFC 8268:
More Modular Exponentiation (MODP) Diffie-Hellman (DH)
Key Exchange (KEX) Groups for Secure Shell (SSH)";
}
enum diffie-hellman-group18-sha512 {
value 27;
description
"Using DH group18 and SHA-512 for key exchange";
reference
"RFC 8268:
More Modular Exponentiation (MODP) Diffie-Hellman (DH)
Key Exchange (KEX) Groups for Secure Shell (SSH)";
}
enum ecdh-sha2-secp256r1 {
value 28;
description
"Elliptic curve-based Diffie Hellman key exchange over
curve ecp256r1 and using SHA2 for MAC generation";
reference
"RFC 6239:
Suite B Cryptographic Suites for Secure Shell (SSH)";
}
enum ecdh-sha2-secp384r1 {
value 29;
description
"Elliptic curve-based Diffie Hellman key exchange over
curve ecp384r1 and using SHA2 for MAC generation";
reference
"RFC 6239:
Suite B Cryptographic Suites for Secure Shell (SSH)";
}
enum ecdh-x25519-x9.63-sha256 {
value 30;
description
"Elliptic curve-based Diffie Hellman key exchange over
curve x.25519 and using ANSI x9.63 with SHA256 as KDF";
reference
"RFC 8418:
Use of the Elliptic Curve Diffie-Hellman Key Agreement
Algorithm with X25519 and X448 in the Cryptographic
Message Syntax (CMS)";
}
enum ecdh-x25519-x9.63-sha384 {
value 31;
description
"Elliptic curve-based Diffie Hellman key exchange over
curve x.25519 and using ANSI x9.63 with SHA384 as KDF";
reference
"RFC 8418:
Use of the Elliptic Curve Diffie-Hellman Key Agreement
Algorithm with X25519 and X448 in the Cryptographic
Message Syntax (CMS)";
}
enum ecdh-x25519-x9.63-sha512 {
value 32;
description
"Elliptic curve-based Diffie Hellman key exchange over
curve x.25519 and using ANSI x9.63 with SHA512 as KDF";
reference
"RFC 8418:
Use of the Elliptic Curve Diffie-Hellman Key Agreement
Algorithm with X25519 and X448 in the Cryptographic
Message Syntax (CMS)";
}
enum ecdh-x25519-hkdf-sha256 {
value 33;
description
"Elliptic curve-based Diffie Hellman key exchange over
curve x.25519 and using HKDF with SHA256 as KDF";
reference
"RFC 8418:
Use of the Elliptic Curve Diffie-Hellman Key Agreement
Algorithm with X25519 and X448 in the Cryptographic
Message Syntax (CMS)";
}
enum ecdh-x25519-hkdf-sha384 {
value 34;
description
"Elliptic curve-based Diffie Hellman key exchange over
curve x.25519 and using HKDF with SHA384 as KDF";
reference
"RFC 8418:
Use of the Elliptic Curve Diffie-Hellman Key Agreement
Algorithm with X25519 and X448 in the Cryptographic
Message Syntax (CMS)";
}
enum ecdh-x25519-hkdf-sha512 {
value 35;
description
"Elliptic curve-based Diffie Hellman key exchange over
curve x.25519 and using HKDF with SHA512 as KDF";
reference
"RFC 8418:
Use of the Elliptic Curve Diffie-Hellman Key Agreement
Algorithm with X25519 and X448 in the Cryptographic
Message Syntax (CMS)";
}
enum ecdh-x448-x9.63-sha256 {
value 36;
description
"Elliptic curve-based Diffie Hellman key exchange over
curve x.448 and using ANSI x9.63 with SHA256 as KDF";
reference
"RFC 8418:
Use of the Elliptic Curve Diffie-Hellman Key Agreement
Algorithm with X25519 and X448 in the Cryptographic
Message Syntax (CMS)";
}
enum ecdh-x448-x9.63-sha384 {
value 37;
description
"Elliptic curve-based Diffie Hellman key exchange over
curve x.448 and using ANSI x9.63 with SHA384 as KDF";
reference
"RFC 8418:
Use of the Elliptic Curve Diffie-Hellman Key Agreement
Algorithm with X25519 and X448 in the Cryptographic
Message Syntax (CMS)";
}
enum ecdh-x448-x9.63-sha512 {
value 38;
description
"Elliptic curve-based Diffie Hellman key exchange over
curve x.448 and using ANSI x9.63 with SHA512 as KDF";
reference
"RFC 8418:
Use of the Elliptic Curve Diffie-Hellman Key Agreement
Algorithm with X25519 and X448 in the Cryptographic
Message Syntax (CMS)";
}
enum ecdh-x448-hkdf-sha256 {
value 39;
description
"Elliptic curve-based Diffie Hellman key exchange over
curve x.448 and using HKDF with SHA256 as KDF";
reference
"RFC 8418:
Use of the Elliptic Curve Diffie-Hellman Key Agreement
Algorithm with X25519 and X448 in the Cryptographic
Message Syntax (CMS)";
}
enum ecdh-x448-hkdf-sha384 {
value 40;
description
"Elliptic curve-based Diffie Hellman key exchange over
curve x.448 and using HKDF with SHA384 as KDF";
reference
"RFC 8418:
Use of the Elliptic Curve Diffie-Hellman Key Agreement
Algorithm with X25519 and X448 in the Cryptographic
Message Syntax (CMS)";
}
enum ecdh-x448-hkdf-sha512 {
value 41;
description
"Elliptic curve-based Diffie Hellman key exchange over
curve x.448 and using HKDF with SHA512 as KDF";
reference
"RFC 8418:
Use of the Elliptic Curve Diffie-Hellman Key Agreement
Algorithm with X25519 and X448 in the Cryptographic
Message Syntax (CMS)";
}
enum rsaes-oaep {
value 42;
description
"RSAES-OAEP combines the RSAEP and RSADP primitives with
the EME-OAEP encoding method";
reference
"RFC 8017:
PKCS #1:
RSA Cryptography Specifications Version 2.2.";
}
enum rsaes-pkcs1-v1_5 {
value 43;
description
"RSAES-PKCS1-v1_5 combines the RSAEP and RSADP
primitives with the EME-PKCS1-v1_5 encoding method";
reference
"RFC 8017:
PKCS #1:
RSA Cryptography Specifications Version 2.2.";
}
}
}
default "0";
description
"The uint16 filed shall be set by individual protocol
families according to the key exchange algorithm value
assigned by IANA. The setting is optional and by default
is 0. The enumeration filed is set to the selected key
exchange algorithm.";
}
/********************************************/ /********************************************/
/* Identities for Key Format Structures */ /* Identities for Key Format Structures */
/********************************************/ /********************************************/
/*** all key format types ****/ /*** all key format types ****/
identity key-format-base { identity key-format-base {
description "Base key-format identity for all keys."; description "Base key-format identity for all keys.";
} }
identity public-key-format { identity public-key-format {
base "key-format-base"; base "key-format-base";
description "Base key-format identity for public keys."; description "Base key-format identity for public keys.";
} }
identity private-key-format { identity private-key-format {
base "key-format-base"; base "key-format-base";
description "Base key-format identity for private keys."; description "Base key-format identity for private keys.";
skipping to change at page 40, line 15 skipping to change at page 12, line 18
type cms; type cms;
description description
"A CMS structure whose top-most content type MUST be the "A CMS structure whose top-most content type MUST be the
authenticated-data content type, as described by Section 9 authenticated-data content type, as described by Section 9
in RFC 5652."; in RFC 5652.";
reference reference
"RFC 5652: Cryptographic Message Syntax (CMS)"; "RFC 5652: Cryptographic Message Syntax (CMS)";
} }
/***************************************************/ /***************************************************/
/* Typedefs for structures related to !!FIXME!! */
/***************************************************/
typedef psk {
type binary;
description
"The binary key data for a PSK (pairwise-symmetric or
pre-shared key). FIXME: specify how it is formmated.";
}
typedef raw-public-key {
type binary;
description
"The binary key data for a raw public key.
FIXME: specify how it is formmated.";
}
/***************************************************/
/* Typedefs for structures related to RFC 4253 */ /* Typedefs for structures related to RFC 4253 */
/***************************************************/ /***************************************************/
typedef ssh-host-key { typedef ssh-host-key {
type binary; type binary;
description description
"The binary public key data for this SSH key, as "The binary public key data for an SSH key, as
specified by RFC 4253, Section 6.6, i.e.: specified by RFC 4253, Section 6.6, i.e.:
string certificate or public key format string certificate or public key format
identifier identifier
byte[n] key/certificate data."; byte[n] key/certificate data.";
reference reference
"RFC 4253: The Secure Shell (SSH) Transport Layer "RFC 4253: The Secure Shell (SSH) Transport Layer
Protocol"; Protocol";
} }
/*********************************************************/ /*********************************************************/
/* Typedefs for ASN.1 structures related to RFC 5280 */ /* Typedefs for ASN.1 structures related to RFC 5280 */
/*********************************************************/ /*********************************************************/
typedef trust-anchor-cert-x509 { typedef trust-anchor-cert-x509 {
type x509; type x509;
description description
"A Certificate structure that MUST encode a self-signed "A Certificate structure that MUST encode a self-signed
root certificate."; root certificate.";
} }
skipping to change at page 42, line 32 skipping to change at page 15, line 4
identifier identifier
byte[n] key/certificate data."; byte[n] key/certificate data.";
reference reference
"RFC 4253: The Secure Shell (SSH) Transport "RFC 4253: The Secure Shell (SSH) Transport
Layer Protocol"; Layer Protocol";
} }
/**********************************************/ /**********************************************/
/* Groupings for keys and/or certificates */ /* Groupings for keys and/or certificates */
/**********************************************/ /**********************************************/
grouping symmetric-key-grouping { grouping symmetric-key-grouping {
description description
"A symmetric key and algorithm."; "A symmetric key and algorithm.";
leaf algorithm { leaf algorithm {
type 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 CCCC: Common YANG Data Types for Cryptography";
} }
leaf key-format { leaf key-format {
nacm:default-deny-write; nacm:default-deny-write;
when "../key"; when "../key";
type identityref { type identityref {
skipping to change at page 43, line 34 skipping to change at page 16, line 5
is outside the scope of this module."; is outside the scope of this module.";
} }
} }
} }
grouping public-key-grouping { grouping public-key-grouping {
description description
"A public key and its associated algorithm."; "A public key and its associated algorithm.";
leaf algorithm { leaf algorithm {
nacm:default-deny-write; nacm:default-deny-write;
type asymmetric-key-algorithm-t; type iasa:asymmetric-algorithm-type;
mandatory true; mandatory true;
description description
"Identifies the key's algorithm."; "Identifies the key's algorithm.";
reference reference
"RFC CCCC: Common YANG Data Types for Cryptography"; "RFC CCCC: Common YANG Data Types for Cryptography";
} }
leaf public-key-format { leaf public-key-format {
nacm:default-deny-write; nacm:default-deny-write;
when "../public-key"; when "../public-key";
type identityref { type identityref {
skipping to change at page 51, line 4 skipping to change at page 23, line 22
ITU-T X.690: ITU-T X.690:
Information technology - ASN.1 encoding rules: Information technology - ASN.1 encoding rules:
Specification of Basic Encoding Rules (BER), Specification of Basic Encoding Rules (BER),
Canonical Encoding Rules (CER) and Distinguished Canonical Encoding Rules (CER) and Distinguished
Encoding Rules (DER)."; Encoding Rules (DER).";
} }
} }
} // generate-certificate-signing-request } // generate-certificate-signing-request
} // asymmetric-key-pair-with-certs-grouping } // asymmetric-key-pair-with-certs-grouping
} }
<CODE ENDS> <CODE ENDS>
3. Security Considerations 2.3. Examples
3.1. Support for Algorithms 2.3.1. The "asymmetric-key-pair-with-certs-grouping" Grouping
The following example module illustrates the use of both the
"symmetric-key-grouping" and the "asymmetric-key-pair-with-certs-
grouping" groupings defined in the "ietf-crypto-types" module.
module ex-crypto-types-usage {
yang-version 1.1;
namespace "http://example.com/ns/example-crypto-types-usage";
prefix "ectu";
import ietf-crypto-types {
prefix ct;
reference
"RFC XXXX: Common YANG Data Types for Cryptography";
}
organization
"Example Corporation";
contact
"Author: YANG Designer <mailto:yang.designer@example.com>";
description
"This module illustrates the grouping
defined in the crypto-types draft called
'asymmetric-key-pair-with-certs-grouping'.";
revision "1001-01-01" {
description
"Initial version";
reference
"RFC ????: Usage Example for RFC XXXX";
}
container symmetric-keys {
description
"A container of symmetric keys.";
list symmetric-key {
key name;
description
"A symmetric key";
leaf name {
type string;
description
"An arbitrary name for this key.";
}
uses ct:symmetric-key-grouping;
}
}
container asymmetric-keys {
description
"A container of asymmetric keys.";
list asymmetric-key {
key name;
leaf name {
type string;
description
"An arbitrary name for this key.";
}
uses ct:asymmetric-key-pair-with-certs-grouping;
description
"An asymmetric key pair with associated certificates.";
}
}
}
Given the above example usage module, the following example
illustrates some configured keys.
<symmetric-keys
xmlns="http://example.com/ns/example-crypto-types-usage"
xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types">
<symmetric-key>
<name>ex-symmetric-key</name>
<algorithm>aes-256-cbc</algorithm>
<key-format>ct:octet-string-key-format</key-format>
<key>base64encodedvalue==</key>
</symmetric-key>
<symmetric-key>
<name>ex-hidden-symmetric-key</name>
<algorithm>aes-256-cbc</algorithm>
<hidden-key/>
</symmetric-key>
</symmetric-keys>
<asymmetric-keys
xmlns="http://example.com/ns/example-crypto-types-usage"
xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types">
<asymmetric-key>
<name>ex-asymmetric-key</name>
<algorithm>rsa2048</algorithm>
<public-key-format>
ct:subject-public-key-info-format
</public-key-format>
<public-key>base64encodedvalue==</public-key>
<private-key-format>
ct:rsa-private-key-format
</private-key-format>
<private-key>base64encodedvalue==</private-key>
<certificates>
<certificate>
<name>ex-cert</name>
<cert>base64encodedvalue==</cert>
</certificate>
</certificates>
</asymmetric-key>
<asymmetric-key>
<name>ex-hidden-asymmetric-key</name>
<algorithm>rsa2048</algorithm>
<public-key-format>
ct:subject-public-key-info-format
</public-key-format>
<public-key>base64encodedvalue==</public-key>
<hidden-private-key/>
<certificates>
<certificate>
<name>ex-hidden-key-cert</name>
<cert>base64encodedvalue==</cert>
</certificate>
</certificates>
</asymmetric-key>
</asymmetric-keys>
2.3.2. The "generate-certificate-signing-request" Action
The following example illustrates the "generate-certificate-signing-
request" action with the NETCONF protocol.
REQUEST
<rpc message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<action xmlns="urn:ietf:params:xml:ns:yang:1">
<asymmetric-keys
xmlns="http://example.com/ns/example-crypto-types-usage">
<asymmetric-key>
<name>ex-key-sect571r1</name>
<generate-certificate-signing-request>
<subject>base64encodedvalue==</subject>
<attributes>base64encodedvalue==</attributes>
</generate-certificate-signing-request>
</asymmetric-key>
</asymmetric-keys>
</action>
</rpc>
RESPONSE
<rpc-reply message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<certificate-signing-request
xmlns="http://example.com/ns/example-crypto-types-usage">
base64encodedvalue==
</certificate-signing-request>
</rpc-reply>
2.3.3. The "certificate-expiration" Notification
The following example illustrates the "certificate-expiration"
notification with the NETCONF protocol.
<notification
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2018-05-25T00:01:00Z</eventTime>
<keys xmlns="http://example.com/ns/example-crypto-types-usage">
<key>
<name>locally-defined key</name>
<certificates>
<certificate>
<name>my-cert</name>
<certificate-expiration>
<expiration-date>
2018-08-05T14:18:53-05:00
</expiration-date>
</certificate-expiration>
</certificate>
</certificates>
</key>
</keys>
</notification>
3. The Symmetric Algorithms Module
3.1. Tree Diagram
This section provides a tree diagram [RFC8340] for the "iana-
symmetric-algs" module. Only the "container" statement is
represented, as tree diagrams have no means to represent "typedef"
statements.
module: iana-symmetric-algs
+--ro supported-symmetric-algorithms
+--ro supported-symmetric-algorithm* [algorithm]
+--ro algorithm symmetric-algorithm-type
3.2. YANG Module
This module has normative references to FIXME...
<CODE BEGINS> file "iana-symmetric-algs@2019-11-02.yang"
module iana-symmetric-algs {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:iana-symmetric-algs";
prefix isa;
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <http://datatracker.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org>
Author: Kent Watsen <mailto:kent+ietf@watsen.net>
Author: Wang Haiguang <wang.haiguang.shieldlab@huawei.com>";
description
"This module defines a typedef for symmetric algorithms, and
a container for a list of symmetric algorithms supported by
the server.
Copyright (c) 2019 IETF Trust and the persons identified
as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with
or without modification, is permitted pursuant to, and
subject to the license terms contained in, the Simplified
BSD License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC
itself for full legal notices.;
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 (RFC 2119)
(RFC 8174) when, and only when, they appear in all
capitals, as shown here.";
revision 2019-11-02 {
description
"Initial version";
reference
"RFC XXXX: Common YANG Data Types for Cryptography";
}
// Typedefs
typedef symmetric-algorithm-type {
type enumeration {
enum aes-128-cbc {
value 1;
description
"Encrypt message with AES algorithm in CBC mode with
a key length of 128 bits.";
reference
"RFC 3565: Use of the Advanced Encryption Standard (AES)
Encryption Algorithm in Cryptographic Message Syntax
(CMS)";
}
enum aes-192-cbc {
value 2;
description
"Encrypt message with AES algorithm in CBC mode with
a key length of 192 bits";
reference
"RFC 3565: Use of the Advanced Encryption Standard (AES)
Encryption Algorithm in Cryptographic Message Syntax
(CMS)";
}
enum aes-256-cbc {
value 3;
description
"Encrypt message with AES algorithm in CBC mode with
a key length of 256 bits";
reference
"RFC 3565: Use of the Advanced Encryption Standard (AES)
Encryption Algorithm in Cryptographic Message Syntax
(CMS)";
}
enum aes-128-ctr {
value 4;
description
"Encrypt message with AES algorithm in CTR mode with
a key length of 128 bits";
reference
"RFC 3686:
Using Advanced Encryption Standard (AES) Counter
Mode with IPsec Encapsulating Security Payload
(ESP)";
}
enum aes-192-ctr {
value 5;
description
"Encrypt message with AES algorithm in CTR mode with
a key length of 192 bits";
reference
"RFC 3686:
Using Advanced Encryption Standard (AES) Counter
Mode with IPsec Encapsulating Security Payload
(ESP)";
}
enum aes-256-ctr {
value 6;
description
"Encrypt message with AES algorithm in CTR mode with
a key length of 256 bits";
reference
"RFC 3686:
Using Advanced Encryption Standard (AES) Counter
Mode with IPsec Encapsulating Security Payload
(ESP)";
}
enum des3-cbc-sha1-kd {
value 7;
description
"Encrypt message with 3DES algorithm in CBC mode
with sha1 function for key derivation";
reference
"RFC 3961:
Encryption and Checksum Specifications for
Kerberos 5";
}
enum rc4-hmac {
value 8;
description
"Encrypt message with rc4 algorithm";
reference
"RFC 4757:
The RC4-HMAC Kerberos Encryption Types Used by
Microsoft Windows";
}
enum rc4-hmac-exp {
value 9;
description
"Encrypt message with rc4 algorithm that is exportable";
reference
"RFC 4757:
The RC4-HMAC Kerberos Encryption Types Used by
Microsoft Windows";
}
}
description
"A typedef enumerating various symmetric key algorithms.";
}
// Protocol-accessible Nodes
container supported-symmetric-algorithms {
config false;
description
"A container for a list of supported symmetric algorithms.
How algorithms come to be supported is outside the scope
of this module.";
list supported-symmetric-algorithm {
key algorithm;
description
"A lists of symmetric algorithms supported by the server.";
leaf algorithm {
type symmetric-algorithm-type;
description
"An symmetric algorithms supported by the server.";
}
}
}
}
<CODE ENDS>
3.3. Examples
The following example illustrates the "supported-symmetric-
algorithms" "container" statement with the NETCONF protocol.
<supported-symmetric-algorithms
xmlns="urn:ietf:params:xml:ns:yang:iana-symmetric-algs">
<supported-symmetric-algorithm>
<algorithm>aes-128-cbc</algorithm>
</supported-symmetric-algorithm>
<supported-symmetric-algorithm>
<algorithm>aes-256-cbc</algorithm>
</supported-symmetric-algorithm>
</supported-symmetric-algorithms>
4. The Asymmetric Algorithms Module
4.1. Tree Diagram
This section provides a tree diagram [RFC8340] for the "iana-
asymmetric-algs" module. Only the "container" statement is
represented, as tree diagrams have no means to represent "typedef"
statements.
module: iana-asymmetric-algs
+--ro supported-asymmetric-algorithms
+--ro supported-asymmetric-algorithm* [algorithm]
+--ro algorithm asymmetric-algorithm-type
4.2. YANG Module
This module has normative references to FIXME...
<CODE BEGINS> file "iana-asymmetric-algs@2019-11-02.yang"
module iana-asymmetric-algs {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:iana-asymmetric-algs";
prefix iasa;
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <http://datatracker.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org>
Author: Kent Watsen <mailto:kent+ietf@watsen.net>
Author: Wang Haiguang <wang.haiguang.shieldlab@huawei.com>";
description
"This module defines a typedef for asymmetric algorithms, and
a container for a list of asymmetric algorithms supported by
the server.
Copyright (c) 2019 IETF Trust and the persons identified
as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with
or without modification, is permitted pursuant to, and
subject to the license terms contained in, the Simplified
BSD License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC
itself for full legal notices.;
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 (RFC 2119)
(RFC 8174) when, and only when, they appear in all
capitals, as shown here.";
revision 2019-11-02 {
description
"Initial version";
reference
"RFC XXXX: Common YANG Data Types for Cryptography";
}
// Typedefs
typedef asymmetric-algorithm-type {
type enumeration {
enum rsa1024 {
value 1;
description
"The RSA algorithm using a 1024-bit key.";
reference
"RFC 8017: PKCS #1: RSA Cryptography
Specifications Version 2.2.";
}
enum rsa2048 {
value 2;
description
"The RSA algorithm using a 2048-bit key.";
reference
"RFC 8017:
PKCS #1: RSA Cryptography Specifications Version 2.2.";
}
enum rsa3072 {
value 3;
description
"The RSA algorithm using a 3072-bit key.";
reference
"RFC 8017:
PKCS #1: RSA Cryptography Specifications Version 2.2.";
}
enum rsa4096 {
value 4;
description
"The RSA algorithm using a 4096-bit key.";
reference
"RFC 8017:
PKCS #1: RSA Cryptography Specifications Version 2.2.";
}
enum rsa7680 {
value 5;
description
"The RSA algorithm using a 7680-bit key.";
reference
"RFC 8017:
PKCS #1: RSA Cryptography Specifications Version 2.2.";
}
enum rsa15360 {
value 6;
description
"The RSA algorithm using a 15360-bit key.";
reference
"RFC 8017:
PKCS #1: RSA Cryptography Specifications Version 2.2.";
}
enum secp192r1 {
value 7;
description
"The asymmetric algorithm using a NIST P192 Curve.";
reference
"RFC 6090:
Fundamental Elliptic Curve Cryptography Algorithms.
RFC 5480:
Elliptic Curve Cryptography Subject Public Key
Information.";
}
enum secp224r1 {
value 8;
description
"The asymmetric algorithm using a NIST P224 Curve.";
reference
"RFC 6090:
Fundamental Elliptic Curve Cryptography Algorithms.
RFC 5480:
Elliptic Curve Cryptography Subject Public Key
Information.";
}
enum secp256r1 {
value 9;
description
"The asymmetric algorithm using a NIST P256 Curve.";
reference
"RFC 6090:
Fundamental Elliptic Curve Cryptography Algorithms.
RFC 5480:
Elliptic Curve Cryptography Subject Public Key
Information.";
}
enum secp384r1 {
value 10;
description
"The asymmetric algorithm using a NIST P384 Curve.";
reference
"RFC 6090:
Fundamental Elliptic Curve Cryptography Algorithms.
RFC 5480:
Elliptic Curve Cryptography Subject Public Key
Information.";
}
enum secp521r1 {
value 11;
description
"The asymmetric algorithm using a NIST P521 Curve.";
reference
"RFC 6090:
Fundamental Elliptic Curve Cryptography Algorithms.
RFC 5480:
Elliptic Curve Cryptography Subject Public Key
Information.";
}
enum x25519 {
value 12;
description
"The asymmetric algorithm using a x.25519 Curve.";
reference
"RFC 7748:
Elliptic Curves for Security.";
}
enum x448 {
value 13;
description
"The asymmetric algorithm using a x.448 Curve.";
reference
"RFC 7748:
Elliptic Curves for Security.";
}
}
description
"A typedef enumerating various asymmetric key algorithms.";
}
// Protocol-accessible Nodes
container supported-asymmetric-algorithms {
config false;
description
"A container for a list of supported asymmetric algorithms.
How algorithms come to be supported is outside the scope
of this module.";
list supported-asymmetric-algorithm {
key algorithm;
description
"A lists of asymmetric algorithms supported by the server.";
leaf algorithm {
type asymmetric-algorithm-type;
description
"An asymmetric algorithms supported by the server.";
}
}
}
}
<CODE ENDS>
4.3. Examples
The following example illustrates the "supported-asymmetric-
algorithms" "container" statement with the NETCONF protocol.
<supported-asymmetric-algorithms
xmlns="urn:ietf:params:xml:ns:yang:iana-asymmetric-algs">
<supported-asymmetric-algorithm>
<algorithm>rsa2048</algorithm>
</supported-asymmetric-algorithm>
<supported-asymmetric-algorithm>
<algorithm>secp256r1</algorithm>
</supported-asymmetric-algorithm>
</supported-asymmetric-algorithms>
5. The Hash Algorithms Module
5.1. Tree Diagram
This section provides a tree diagram [RFC8340] for the "iana-hash-
algs" module. Only the "container" statement is represented, as tree
diagrams have no means to represent "typedef" statements.
module: iana-hash-algs
+--ro supported-hash-algorithms
+--ro supported-hash-algorithm* [algorithm]
+--ro algorithm hash-algorithm-type
5.2. YANG Module
This module has normative references to FIXME...
<CODE BEGINS> file "iana-hash-algs@2019-11-02.yang"
module iana-hash-algs {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:iana-hash-algs";
prefix iha;
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <http://datatracker.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org>
Author: Kent Watsen <mailto:kent+ietf@watsen.net>
Author: Wang Haiguang <wang.haiguang.shieldlab@huawei.com>";
description
"This module defines a typedef for hash algorithms, and
a container for a list of hash algorithms supported by
the server.
Copyright (c) 2019 IETF Trust and the persons identified
as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with
or without modification, is permitted pursuant to, and
subject to the license terms contained in, the Simplified
BSD License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC
itself for full legal notices.;
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 (RFC 2119)
(RFC 8174) when, and only when, they appear in all
capitals, as shown here.";
revision 2019-11-02 {
description
"Initial version";
reference
"RFC XXXX: Common YANG Data Types for Cryptography";
}
// Typedefs
typedef hash-algorithm-type {
type enumeration {
enum sha1 {
value 1;
status obsolete;
description
"The SHA1 algorithm.";
reference
"RFC 3174: US Secure Hash Algorithms 1 (SHA1).";
}
enum sha-224 {
value 2;
description
"The SHA-224 algorithm.";
reference
"RFC 6234: US Secure Hash Algorithms.";
}
enum sha-256 {
value 3;
description
"The SHA-256 algorithm.";
reference
"RFC 6234: US Secure Hash Algorithms.";
}
enum sha-384 {
value 4;
description
"The SHA-384 algorithm.";
reference
"RFC 6234: US Secure Hash Algorithms.";
}
enum sha-512 {
value 5;
description
"The SHA-512 algorithm.";
reference
"RFC 6234: US Secure Hash Algorithms.";
}
enum shake-128 {
value 6;
description
"The SHA3 algorithm with 128-bits output.";
reference
"National Institute of Standards and Technology,
SHA-3 Standard: Permutation-Based Hash and
Extendable-Output Functions, FIPS PUB 202, DOI
10.6028/NIST.FIPS.202, August 2015.";
}
enum shake-224 {
value 7;
description
"The SHA3 algorithm with 224-bits output.";
reference
"National Institute of Standards and Technology,
SHA-3 Standard: Permutation-Based Hash and
Extendable-Output Functions, FIPS PUB 202, DOI
10.6028/NIST.FIPS.202, August 2015.";
}
enum shake-256 {
value 8;
description
"The SHA3 algorithm with 256-bits output.";
reference
"National Institute of Standards and Technology,
SHA-3 Standard: Permutation-Based Hash and
Extendable-Output Functions, FIPS PUB 202, DOI
10.6028/NIST.FIPS.202, August 2015.";
}
enum shake-384 {
value 9;
description
"The SHA3 algorithm with 384-bits output.";
reference
"National Institute of Standards and Technology,
SHA-3 Standard: Permutation-Based Hash and
Extendable-Output Functions, FIPS PUB 202, DOI
10.6028/NIST.FIPS.202, August 2015.";
}
enum shake-512 {
value 10;
description
"The SHA3 algorithm with 384-bits output.";
reference
"National Institute of Standards and Technology,
SHA-3 Standard: Permutation-Based Hash and
Extendable-Output Functions, FIPS PUB 202, DOI
10.6028/NIST.FIPS.202, August 2015.";
}
}
description
"A typedef enumerating various hash key algorithms.";
}
// Protocol-accessible Nodes
container supported-hash-algorithms {
config false;
description
"A container for a list of supported hash algorithms.
How algorithms come to be supported is outside the
scope of this module.";
list supported-hash-algorithm {
key algorithm;
description
"A lists of hash algorithms supported by the server.";
leaf algorithm {
type hash-algorithm-type;
description
"An hash algorithms supported by the server.";
}
}
}
}
<CODE ENDS>
5.3. Examples
The following example illustrates the "supported-hash-algorithms"
"container" statement with the NETCONF protocol.
<supported-hash-algorithms
xmlns="urn:ietf:params:xml:ns:yang:iana-hash-algs">
<supported-hash-algorithm>
<algorithm>sha-256</algorithm>
</supported-hash-algorithm>
<supported-hash-algorithm>
<algorithm>sha-512</algorithm>
</supported-hash-algorithm>
</supported-hash-algorithms>
6. Security Considerations
6.1. Support for Algorithms
In order to use YANG identities for algorithm identifiers, only the In order to use YANG identities for algorithm identifiers, only the
most commonly used RSA key lengths are supported for the RSA most commonly used RSA key lengths are supported for the RSA
algorithm. Additional key lengths can be defined in another module algorithm. Additional key lengths can be defined in another module
or added into a future version of this document. or added into a future version of this document.
This document limits the number of elliptical curves supported. This This document limits the number of elliptical curves supported. This
was done to match industry trends and IETF best practice (e.g., was done to match industry trends and IETF best practice (e.g.,
matching work being done in TLS 1.3). If additional algorithms are matching work being done in TLS 1.3). If additional algorithms are
needed, they can be defined by another module or added into a future needed, they can be defined by another module or added into a future
version of this document. version of this document.
3.2. No Support for CRMF 6.2. No Support for CRMF
This document uses PKCS #10 [RFC2986] for the "generate-certificate- This document uses PKCS #10 [RFC2986] for the "generate-certificate-
signing-request" action. The use of Certificate Request Message signing-request" action. The use of Certificate Request Message
Format (CRMF) [RFC4211] was considered, but is was unclear if there Format (CRMF) [RFC4211] was considered, but is was unclear if there
was market demand for it. If it is desired to support CRMF in the was market demand for it. If it is desired to support CRMF in the
future, a backwards compatible solution can be defined at that time. future, a backwards compatible solution can be defined at that time.
3.3. Access to Data Nodes 6.3. Access to Data Nodes
The YANG module in this document defines "grouping" statements that The YANG module in this document defines "grouping" statements that
are designed to be accessed via YANG based management protocols, such are designed to be accessed via YANG based management protocols, such
as NETCONF [RFC6241] and RESTCONF [RFC8040]. Both of these protocols as NETCONF [RFC6241] and RESTCONF [RFC8040]. Both of these protocols
have mandatory-to-implement secure transport layers (e.g., SSH, TLS) have mandatory-to-implement secure transport layers (e.g., SSH, TLS)
with mutual authentication. with mutual authentication.
The NETCONF access control model (NACM) [RFC8341] provides the means The NETCONF access control model (NACM) [RFC8341] provides the means
to restrict access for particular users to a pre-configured subset of to restrict access for particular users to a pre-configured subset of
all available protocol operations and content. all available protocol operations and content.
skipping to change at page 52, line 42 skipping to change at page 42, line 25
Note that NACM uses "default-deny-all" to protect "RPC" and Note that NACM uses "default-deny-all" to protect "RPC" and
"action" statements; it does not define, e.g., an extension "action" statements; it does not define, e.g., an extension
called "default-deny-execute". called "default-deny-execute".
generate-certificate-signing-request: For this action, it is generate-certificate-signing-request: For this action, it is
RECOMMENDED that implementations assert channel binding RECOMMENDED that implementations assert channel binding
[RFC5056], so as to ensure that the application layer that sent [RFC5056], so as to ensure that the application layer that sent
the request is the same as the device authenticated when the the request is the same as the device authenticated when the
secure transport layer was established. secure transport layer was established.
4. IANA Considerations 7. IANA Considerations
4.1. The IETF XML Registry 7.1. The IETF XML Registry
This document registers one URI in the "ns" subregistry of the IETF This document registers four URIs 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 registrations are requested:
URI: urn:ietf:params:xml:ns:yang:ietf-crypto-types URI: urn:ietf:params:xml:ns:yang:ietf-crypto-types
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.
4.2. The YANG Module Names Registry URI: urn:ietf:params:xml:ns:yang:iana-symmetric-algs
Registrant Contact: The NETCONF WG of the IETF.
XML: N/A, the requested URI is an XML namespace.
This document registers one YANG module in the YANG Module Names URI: urn:ietf:params:xml:ns:yang:iana-ssymmetric-algs
Registrant Contact: The NETCONF WG of the IETF.
XML: N/A, the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:iana-hash-algs
Registrant Contact: The NETCONF WG of the IETF.
XML: N/A, the requested URI is an XML namespace.
7.2. The YANG Module Names Registry
This document registers four YANG modules 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 registrations are requested:
name: ietf-crypto-types name: ietf-crypto-types
namespace: urn:ietf:params:xml:ns:yang:ietf-crypto-types namespace: urn:ietf:params:xml:ns:yang:ietf-crypto-types
prefix: ct prefix: ct
reference: RFC XXXX reference: RFC XXXX
5. References name: iana-symmetric-algs
namespace: urn:ietf:params:xml:ns:yang:iana-symmetric-algs
prefix: isa
reference: RFC XXXX
5.1. Normative References name: iana-asymmetric-algs
namespace: urn:ietf:params:xml:ns:yang:iana-asymmetric-algs
prefix: iasa
reference: RFC XXXX
name: iana-hash-algs
namespace: urn:ietf:params:xml:ns:yang:iana-hash-algs
prefix: iha
reference: RFC XXXX
8. References
8.1. Normative References
[ITU.X690.2015] [ITU.X690.2015]
International Telecommunication Union, "Information International Telecommunication Union, "Information
Technology - ASN.1 encoding rules: Specification of Basic Technology - ASN.1 encoding rules: Specification of Basic
Encoding Rules (BER), Canonical Encoding Rules (CER) and Encoding Rules (BER), Canonical Encoding Rules (CER) and
Distinguished Encoding Rules (DER)", ITU-T Recommendation Distinguished Encoding Rules (DER)", ITU-T Recommendation
X.690, ISO/IEC 8825-1, August 2015, X.690, ISO/IEC 8825-1, August 2015,
<https://www.itu.int/rec/T-REC-X.690/>. <https://www.itu.int/rec/T-REC-X.690/>.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
skipping to change at page 55, line 47 skipping to change at page 46, line 20
[RFC8422] Nir, Y., Josefsson, S., and M. Pegourie-Gonnard, "Elliptic [RFC8422] Nir, Y., Josefsson, S., and M. Pegourie-Gonnard, "Elliptic
Curve Cryptography (ECC) Cipher Suites for Transport Layer Curve Cryptography (ECC) Cipher Suites for Transport Layer
Security (TLS) Versions 1.2 and Earlier", RFC 8422, Security (TLS) Versions 1.2 and Earlier", RFC 8422,
DOI 10.17487/RFC8422, August 2018, DOI 10.17487/RFC8422, August 2018,
<https://www.rfc-editor.org/info/rfc8422>. <https://www.rfc-editor.org/info/rfc8422>.
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
<https://www.rfc-editor.org/info/rfc8446>. <https://www.rfc-editor.org/info/rfc8446>.
5.2. Informative References 8.2. Informative References
[RFC2986] Nystrom, M. and B. Kaliski, "PKCS #10: Certification [RFC2986] Nystrom, M. and B. Kaliski, "PKCS #10: Certification
Request Syntax Specification Version 1.7", RFC 2986, Request Syntax Specification Version 1.7", RFC 2986,
DOI 10.17487/RFC2986, November 2000, DOI 10.17487/RFC2986, November 2000,
<https://www.rfc-editor.org/info/rfc2986>. <https://www.rfc-editor.org/info/rfc2986>.
[RFC3174] Eastlake 3rd, D. and P. Jones, "US Secure Hash Algorithm 1 [RFC3174] Eastlake 3rd, D. and P. Jones, "US Secure Hash Algorithm 1
(SHA1)", RFC 3174, DOI 10.17487/RFC3174, September 2001, (SHA1)", RFC 3174, DOI 10.17487/RFC3174, September 2001,
<https://www.rfc-editor.org/info/rfc3174>. <https://www.rfc-editor.org/info/rfc3174>.
skipping to change at page 58, line 5 skipping to change at page 49, line 5
<https://www.rfc-editor.org/info/rfc8040>. <https://www.rfc-editor.org/info/rfc8040>.
[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
<https://www.rfc-editor.org/info/rfc8340>. <https://www.rfc-editor.org/info/rfc8340>.
[RFC8439] Nir, Y. and A. Langley, "ChaCha20 and Poly1305 for IETF [RFC8439] Nir, Y. and A. Langley, "ChaCha20 and Poly1305 for IETF
Protocols", RFC 8439, DOI 10.17487/RFC8439, June 2018, Protocols", RFC 8439, DOI 10.17487/RFC8439, June 2018,
<https://www.rfc-editor.org/info/rfc8439>. <https://www.rfc-editor.org/info/rfc8439>.
Appendix A. Examples Appendix A. Change Log
A.1. The "asymmetric-key-pair-with-certs-grouping" Grouping
The following example module illustrates the use of both the
"symmetric-key-grouping" and the "asymmetric-key-pair-with-certs-
grouping" groupings defined in the "ietf-crypto-types" module.
module ex-crypto-types-usage {
yang-version 1.1;
namespace "http://example.com/ns/example-crypto-types-usage";
prefix "ectu";
import ietf-crypto-types {
prefix ct;
reference
"RFC XXXX: Common YANG Data Types for Cryptography";
}
organization
"Example Corporation";
contact
"Author: YANG Designer <mailto:yang.designer@example.com>";
description
"This module illustrates the grouping
defined in the crypto-types draft called
'asymmetric-key-pair-with-certs-grouping'.";
revision "1001-01-01" {
description
"Initial version";
reference
"RFC ????: Usage Example for RFC XXXX";
}
container symmetric-keys {
description
"A container of symmetric keys.";
list symmetric-key {
key name;
description
"A symmetric key";
leaf name {
type string;
description
"An arbitrary name for this key.";
}
uses ct:symmetric-key-grouping;
}
}
container asymmetric-keys {
description
"A container of asymmetric keys.";
list asymmetric-key {
key name;
leaf name {
type string;
description
"An arbitrary name for this key.";
}
uses ct:asymmetric-key-pair-with-certs-grouping;
description
"An asymmetric key pair with associated certificates.";
}
}
}
Given the above example usage module, the following example
illustrates some configured keys.
========== NOTE: '\' line wrapping per BCP XXX (RFC XXXX) ===========
<symmetric-keys xmlns="http://example.com/ns/example-crypto-types-us\
age"
xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types">
<symmetric-key>
<name>ex-symmetric-key</name>
<algorithm>aes-256-cbc</algorithm>
<key-format>ct:octet-string-key-format</key-format>
<key>base64encodedvalue==</key>
</symmetric-key>
<symmetric-key>
<name>ex-hidden-symmetric-key</name>
<algorithm>aes-256-cbc</algorithm>
<hidden-key/>
</symmetric-key>
</symmetric-keys>
<asymmetric-keys xmlns="http://example.com/ns/example-crypto-types-u\
sage"
xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types">
<asymmetric-key>
<name>ex-asymmetric-key</name>
<algorithm>rsa2048</algorithm>
<public-key-format>ct:subject-public-key-info-format</public-key\
-format>
<public-key>base64encodedvalue==</public-key>
<private-key-format>ct:rsa-private-key-format</private-key-forma\
t>
<private-key>base64encodedvalue==</private-key>
<certificates>
<certificate>
<name>ex-cert</name>
<cert>base64encodedvalue==</cert>
</certificate>
</certificates>
</asymmetric-key>
<asymmetric-key>
<name>ex-hidden-asymmetric-key</name>
<algorithm>rsa2048</algorithm>
<public-key-format>ct:subject-public-key-info-format</public-key\
-format>
<public-key>base64encodedvalue==</public-key>
<hidden-private-key/>
<certificates>
<certificate>
<name>ex-hidden-key-cert</name>
<cert>base64encodedvalue==</cert>
</certificate>
</certificates>
</asymmetric-key>
</asymmetric-keys>
A.2. The "generate-certificate-signing-request" Action
The following example illustrates the "generate-certificate-signing-
request" action in use with the NETCONF protocol.
REQUEST
========== NOTE: '\' line wrapping per BCP XXX (RFC XXXX) ===========
<rpc message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<action xmlns="urn:ietf:params:xml:ns:yang:1">
<asymmetric-keys xmlns="http://example.com/ns/example-crypto-typ\
es-usage">
<asymmetric-key>
<name>ex-key-sect571r1</name>
<generate-certificate-signing-request>
<subject>base64encodedvalue==</subject>
<attributes>base64encodedvalue==</attributes>
</generate-certificate-signing-request>
</asymmetric-key>
</asymmetric-keys>
</action>
</rpc>
RESPONSE
<rpc-reply message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<certificate-signing-request
xmlns="http://example.com/ns/example-crypto-types-usage">
base64encodedvalue==
</certificate-signing-request>
</rpc-reply>
A.3. The "certificate-expiration" Notification
The following example illustrates the "certificate-expiration"
notification in use with the NETCONF protocol.
<notification
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2018-05-25T00:01:00Z</eventTime>
<keys xmlns="http://example.com/ns/example-crypto-types-usage">
<key>
<name>locally-defined key</name>
<certificates>
<certificate>
<name>my-cert</name>
<certificate-expiration>
<expiration-date>
2018-08-05T14:18:53-05:00
</expiration-date>
</certificate-expiration>
</certificate>
</certificates>
</key>
</keys>
</notification>
Appendix B. Change Log
B.1. I-D to 00 A.1. I-D to 00
o Removed groupings and notifications. o Removed groupings and notifications.
o Added typedefs for identityrefs. o Added typedefs for identityrefs.
o Added typedefs for other RFC 5280 structures. o Added typedefs for other RFC 5280 structures.
o Added typedefs for other RFC 5652 structures. o Added typedefs for other RFC 5652 structures.
o Added convenience typedefs for RFC 4253, RFC 5280, and RFC 5652. o Added convenience typedefs for RFC 4253, RFC 5280, and RFC 5652.
B.2. 00 to 01 A.2. 00 to 01
o Moved groupings from the draft-ietf-netconf-keystore here. o Moved groupings from the draft-ietf-netconf-keystore here.
B.3. 01 to 02 A.3. 01 to 02
o Removed unwanted "mandatory" and "must" statements. o Removed unwanted "mandatory" and "must" statements.
o Added many new crypto algorithms (thanks Haiguang!) o Added many new crypto algorithms (thanks Haiguang!)
o Clarified in asymmetric-key-pair-with-certs-grouping, in o Clarified in asymmetric-key-pair-with-certs-grouping, in
certificates/certificate/name/description, that if the name MUST certificates/certificate/name/description, that if the name MUST
NOT match the name of a certificate that exists independently in NOT match the name of a certificate that exists independently in
<operational>, enabling certs installed by the manufacturer (e.g., <operational>, enabling certs installed by the manufacturer (e.g.,
an IDevID). an IDevID).
B.4. 02 to 03 A.4. 02 to 03
o renamed base identity 'asymmetric-key-encryption-algorithm' to o renamed base identity 'asymmetric-key-encryption-algorithm' to
'asymmetric-key-algorithm'. 'asymmetric-key-algorithm'.
o added new 'asymmetric-key-algorithm' identities for secp192r1, o added new 'asymmetric-key-algorithm' identities for secp192r1,
secp224r1, secp256r1, secp384r1, and secp521r1. secp224r1, secp256r1, secp384r1, and secp521r1.
o removed 'mac-algorithm' identities for mac-aes-128-ccm, mac-aes- o removed 'mac-algorithm' identities for mac-aes-128-ccm, mac-aes-
192-ccm, mac-aes-256-ccm, mac-aes-128-gcm, mac-aes-192-gcm, mac- 192-ccm, mac-aes-256-ccm, mac-aes-128-gcm, mac-aes-192-gcm, mac-
aes-256-gcm, and mac-chacha20-poly1305. aes-256-gcm, and mac-chacha20-poly1305.
skipping to change at page 63, line 46 skipping to change at page 50, line 25
'symmetric-key-algorithm-ref'. 'symmetric-key-algorithm-ref'.
o renamed typedef 'asymmetric-key-encryption-algorithm-ref' to o renamed typedef 'asymmetric-key-encryption-algorithm-ref' to
'asymmetric-key-algorithm-ref'. 'asymmetric-key-algorithm-ref'.
o added typedef 'encryption-and-mac-algorithm-ref'. o added typedef 'encryption-and-mac-algorithm-ref'.
o Updated copyright date, boilerplate template, affiliation, and o Updated copyright date, boilerplate template, affiliation, and
folding algorithm. folding algorithm.
B.5. 03 to 04 A.5. 03 to 04
o ran YANG module through formatter. o ran YANG module through formatter.
B.6. 04 to 05 A.6. 04 to 05
o fixed broken symlink causing reformatted YANG module to not show. o fixed broken symlink causing reformatted YANG module to not show.
B.7. 05 to 06 A.7. 05 to 06
o Added NACM annotations. o Added NACM annotations.
o Updated Security Considerations section. o Updated Security Considerations section.
o Added 'asymmetric-key-pair-with-cert-grouping' grouping. o Added 'asymmetric-key-pair-with-cert-grouping' grouping.
o Removed text from 'permanently-hidden' enum regarding such keys o Removed text from 'permanently-hidden' enum regarding such keys
not being backed up or restored. not being backed up or restored.
skipping to change at page 64, line 43 skipping to change at page 51, line 21
attempt to do so. attempt to do so.
o Added 'trust-anchor-certs-grouping' and 'end-entity-certs- o Added 'trust-anchor-certs-grouping' and 'end-entity-certs-
grouping' (the plural form of existing groupings). grouping' (the plural form of existing groupings).
o Now states that keys created in <operational> by the *-hidden-key o Now states that keys created in <operational> by the *-hidden-key
actions are bound to the lifetime of the parent 'config true' actions are bound to the lifetime of the parent 'config true'
node, and that subsequent invocations of either action results in node, and that subsequent invocations of either action results in
a failure. a failure.
B.8. 06 to 07 A.8. 06 to 07
o Added clarifications that implementations SHOULD assert that o Added clarifications that implementations SHOULD assert that
configured certificates contain the matching public key. configured certificates contain the matching public key.
o Replaced the 'generate-hidden-key' and 'install-hidden-key' o Replaced the 'generate-hidden-key' and 'install-hidden-key'
actions with special 'crypt-hash' -like input/output values. actions with special 'crypt-hash' -like input/output values.
B.9. 07 to 08 A.9. 07 to 08
o Removed the 'generate-key and 'hidden-key' features. o Removed the 'generate-key and 'hidden-key' features.
o Added grouping symmetric-key-grouping o Added grouping symmetric-key-grouping
o Modified 'asymmetric-key-pair-grouping' to have a 'choice' o Modified 'asymmetric-key-pair-grouping' to have a 'choice'
statement for the keystone module to augment into, as well as statement for the keystone module to augment into, as well as
replacing the 'union' with leafs (having different NACM settings. replacing the 'union' with leafs (having different NACM settings.
B.10. 08 to 09 A.10. 08 to 09
o Converting algorithm from identities to enumerations. o Converting algorithm from identities to enumerations.
B.11. 09 to 10 A.11. 09 to 10
o All of the below changes are to the algorithm enumerations defined o All of the below changes are to the algorithm enumerations defined
in ietf-crypto-types. in ietf-crypto-types.
o Add in support for key exchange over x.25519 and x.448 based on o Add in support for key exchange over x.25519 and x.448 based on
RFC 8418. RFC 8418.
o Add in SHAKE-128, SHAKE-224, SHAKE-256, SHAKE-384 and SHAKE 512 o Add in SHAKE-128, SHAKE-224, SHAKE-256, SHAKE-384 and SHAKE 512
o Revise/add in enum of signature algorithm for x25519 and x448 o Revise/add in enum of signature algorithm for x25519 and x448
o Add in des3-cbc-sha1 for IPSec o Add in des3-cbc-sha1 for IPSec
o Add in sha1-des3-kd for IPSec o Add in sha1-des3-kd for IPSec
o Add in definit for rc4-hmac and rc4-hmac-exp. These two o Add in definit for rc4-hmac and rc4-hmac-exp. These two
algorithms have been deprecated in RFC 8429. But some existing algorithms have been deprecated in RFC 8429. But some existing
draft in i2nsf may still want to use them. draft in i2nsf may still want to use them.
skipping to change at page 65, line 47 skipping to change at page 52, line 22
draft in i2nsf may still want to use them. draft in i2nsf may still want to use them.
o Add x25519 and x448 curve for asymmetric algorithms o Add x25519 and x448 curve for asymmetric algorithms
o Add signature algorithms ed25519, ed25519-cts, ed25519ph o Add signature algorithms ed25519, ed25519-cts, ed25519ph
o add signature algorithms ed448, ed448ph o add signature algorithms ed448, ed448ph
o Add in rsa-sha2-256 and rsa-sha2-512 for SSH protocols (rfc8332) o Add in rsa-sha2-256 and rsa-sha2-512 for SSH protocols (rfc8332)
B.12. 10 to 11 A.12. 10 to 11
o Added a "key-format" identity. o Added a "key-format" identity.
o Added symmetric keys to the example in Appendix A. o Added symmetric keys to the example in Section 2.3.
A.13. 11 to 12
o Removed all non-essential (to NC/RC) algorithm types.
o Moved remaining algorithm types each into its own module.
o Added a 'config false' "algorithms-supported" list to each of the
algorithm-type modules.
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 last name): Martin Bjorklund, on list and in the halls (ordered by last name): Martin Bjorklund,
Nick Hancock, Balazs Kovacs, Juergen Schoenwaelder, Eric Voit, and Nick Hancock, Balazs Kovacs, Juergen Schoenwaelder, Eric Voit, and
Liang Xia. Liang Xia.
Authors' Addresses Authors' Addresses
 End of changes. 55 change blocks. 
1672 lines changed or deleted 1007 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/