draft-ietf-netconf-crypto-types-06.txt   draft-ietf-netconf-crypto-types-07.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: October 31, 2019 Huawei Expires: December 9, 2019 Huawei
April 29, 2019 June 7, 2019
Common YANG Data Types for Cryptography Common YANG Data Types for Cryptography
draft-ietf-netconf-crypto-types-06 draft-ietf-netconf-crypto-types-07
Abstract Abstract
This document defines YANG identities, typedefs, the groupings useful This document defines YANG identities, typedefs, the groupings useful
for cryptographic applications. for cryptographic applications.
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
skipping to change at page 1, line 32 skipping to change at page 1, line 32
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-04-29" --> the publication date of this draft o "2019-06-07" --> 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 October 31, 2019. This Internet-Draft will expire on December 9, 2019.
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
skipping to change at page 2, line 29 skipping to change at page 2, line 29
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 . . . . . . . . . . . . . . . . . . . 3
2.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 3 2.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 3
2.2. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 5 2.2. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 4
3. Security Considerations . . . . . . . . . . . . . . . . . . . 42 3. Security Considerations . . . . . . . . . . . . . . . . . . . 41
3.1. Support for Algorithms . . . . . . . . . . . . . . . . . 42 3.1. Support for Algorithms . . . . . . . . . . . . . . . . . 42
3.2. No Support for CRMF . . . . . . . . . . . . . . . . . . . 43 3.2. No Support for CRMF . . . . . . . . . . . . . . . . . . . 42
3.3. Access to Data Nodes . . . . . . . . . . . . . . . . . . 43 3.3. Access to Data Nodes . . . . . . . . . . . . . . . . . . 42
4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 44 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 43
4.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 44 4.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 43
4.2. The YANG Module Names Registry . . . . . . . . . . . . . 44 4.2. The YANG Module Names Registry . . . . . . . . . . . . . 44
5. References . . . . . . . . . . . . . . . . . . . . . . . . . 45 5. References . . . . . . . . . . . . . . . . . . . . . . . . . 44
5.1. Normative References . . . . . . . . . . . . . . . . . . 45 5.1. Normative References . . . . . . . . . . . . . . . . . . 44
5.2. Informative References . . . . . . . . . . . . . . . . . 47 5.2. Informative References . . . . . . . . . . . . . . . . . 46
Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 50 Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 49
A.1. The "asymmetric-key-pair-with-certs-grouping" Grouping . 50 A.1. The "asymmetric-key-pair-with-certs-grouping" Grouping . 49
A.2. The "generate-hidden-key" Action . . . . . . . . . . . . 52 A.2. The "generate-certificate-signing-request" Action . . . . 53
A.3. The "install-hidden-key" Action . . . . . . . . . . . . . 53 A.3. The "certificate-expiration" Notification . . . . . . . . 53
A.4. The "generate-certificate-signing-request" Action . . . . 53 Appendix B. Change Log . . . . . . . . . . . . . . . . . . . . . 54
A.5. The "certificate-expiration" Notification . . . . . . . . 54 B.1. I-D to 00 . . . . . . . . . . . . . . . . . . . . . . . . 54
Appendix B. Change Log . . . . . . . . . . . . . . . . . . . . . 55 B.2. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 54
B.1. I-D to 00 . . . . . . . . . . . . . . . . . . . . . . . . 55 B.3. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 54
B.2. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 55 B.4. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 55
B.3. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 55 B.5. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 55
B.4. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 56 B.6. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 56
B.5. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 56 B.7. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 56
B.6. 04 to 05 . . . . . . . . . . . . . . . . . . . . . . . . 57 B.8. 06 to 07 . . . . . . . . . . . . . . . . . . . . . . . . 56
B.7. 05 to 06 . . . . . . . . . . . . . . . . . . . . . . . . 57
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 57 Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 57
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 58 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 57
1. Introduction 1. Introduction
This document defines a YANG 1.1 [RFC7950] module specifying This document defines a YANG 1.1 [RFC7950] module specifying
identities, typedefs, and groupings useful for cryptography. identities, typedefs, and groupings useful for cryptography.
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
skipping to change at page 3, line 31 skipping to change at page 3, line 30
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 the groupings as represented, as tree diagrams
have no means to represent identities or typedefs. have no means to represent identities or typedefs.
module: ietf-crypto-types module: ietf-crypto-types
grouping public-key-grouping: grouping public-key-grouping:
+---- algorithm? asymmetric-key-algorithm-ref +---- algorithm asymmetric-key-algorithm-ref
+---- public-key? binary +---- public-key binary
grouping asymmetric-key-pair-grouping: grouping asymmetric-key-pair-grouping:
+---- algorithm? asymmetric-key-algorithm-ref +---- algorithm asymmetric-key-algorithm-ref
+---- public-key? binary +---- public-key binary
+---- private-key? union +---- private-key union
+---x generate-hidden-key
| +---- input
| +---w algorithm asymmetric-key-algorithm-ref
+---x install-hidden-key
+---- input
+---w algorithm asymmetric-key-algorithm-ref
+---w public-key? binary
+---w private-key? binary
grouping trust-anchor-cert-grouping: grouping trust-anchor-cert-grouping:
+---- cert? trust-anchor-cert-cms +---- cert? trust-anchor-cert-cms
+---n certificate-expiration +---n certificate-expiration
+--ro expiration-date ietf-yang-types:date-and-time +--ro expiration-date ietf-yang-types:date-and-time
grouping trust-anchor-certs-grouping: grouping trust-anchor-certs-grouping:
+---- cert* trust-anchor-cert-cms +---- cert* trust-anchor-cert-cms
+---n certificate-expiration +---n certificate-expiration
+--ro expiration-date ietf-yang-types:date-and-time +--ro expiration-date ietf-yang-types:date-and-time
grouping end-entity-cert-grouping: grouping end-entity-cert-grouping:
+---- cert? end-entity-cert-cms +---- cert? end-entity-cert-cms
skipping to change at page 4, line 13 skipping to change at page 4, line 4
+---n certificate-expiration +---n certificate-expiration
+--ro expiration-date ietf-yang-types:date-and-time +--ro expiration-date ietf-yang-types: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
+--ro expiration-date ietf-yang-types:date-and-time +--ro expiration-date ietf-yang-types: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
+--ro expiration-date ietf-yang-types:date-and-time +--ro expiration-date ietf-yang-types:date-and-time
grouping asymmetric-key-pair-with-cert-grouping: grouping asymmetric-key-pair-with-cert-grouping:
+---- algorithm? +---- algorithm
| asymmetric-key-algorithm-ref | asymmetric-key-algorithm-ref
+---- public-key? binary +---- public-key binary
+---- private-key? union +---- private-key union
+---x generate-hidden-key
| +---- input
| +---w algorithm asymmetric-key-algorithm-ref
+---x install-hidden-key
| +---- input
| +---w algorithm asymmetric-key-algorithm-ref
| +---w public-key? binary
| +---w private-key? binary
+---- cert? end-entity-cert-cms +---- cert? end-entity-cert-cms
+---n certificate-expiration +---n certificate-expiration
+--ro expiration-date ietf-yang-types:date-and-time +--ro expiration-date ietf-yang-types:date-and-time
+---x generate-certificate-signing-request +---x generate-certificate-signing-request
+---- input +---- input
| +---w subject binary | +---w subject binary
| +---w attributes? binary | +---w attributes? binary
+---- output +---- 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-ref | asymmetric-key-algorithm-ref
+---- public-key? binary +---- public-key binary
+---- private-key? union +---- private-key union
+---x generate-hidden-key
| +---- input
| +---w algorithm asymmetric-key-algorithm-ref
+---x install-hidden-key
| +---- input
| +---w algorithm asymmetric-key-algorithm-ref
| +---w public-key? binary
| +---w private-key? binary
+---- certificates +---- certificates
| +---- certificate* [name] | +---- certificate* [name]
| +---- name string | +---- name string
| +---- cert? end-entity-cert-cms | +---- cert? end-entity-cert-cms
| +---n certificate-expiration | +---n certificate-expiration
| +--ro expiration-date ietf-yang-types:date-and-time | +--ro expiration-date ietf-yang-types:date-and-time
+---x generate-certificate-signing-request +---x generate-certificate-signing-request
+---- input +---- input
| +---w subject binary | +---w subject binary
| +---w attributes? binary | +---w attributes? binary
skipping to change at page 5, line 25 skipping to change at page 4, line 49
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-04-29.yang" <CODE BEGINS> file "ietf-crypto-types@2019-06-07.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";
} }
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
"This module defines common YANG types for cryptographic "This module defines common YANG types for cryptographic
applications. applications.
Copyright (c) 2019 IETF Trust and the persons identified Copyright (c) 2019 IETF Trust and the persons identified
as authors of the code. All rights reserved. as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with Redistribution and use in source and binary forms, with
or without modification, is permitted pursuant to, and or without modification, is permitted pursuant to, and
subject to the license terms contained in, the Simplified subject to the license terms contained in, the Simplified
BSD License set forth in Section 4.c of the IETF Trust's BSD License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents Legal Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info). (https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX This version of this YANG module is part of RFC XXXX
(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-04-29 { revision 2019-06-07 {
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 */ /* Features */
/**************************************/ /****************/
feature generate-key {
description
"Indicates that the server supports the configuration
private key values using the 'value-to-be-generated'
prefix.";
}
identity hash-algorithm { feature hidden-key {
description description
"A base identity for hash algorithm verification."; "Indicates that the server supports the configuration
} of hidden private keys, whether by the using the
'value-to-be-generated-and-hidden' value or the
'value-to-be-hidden' prefix.";
}
identity sha-224 { /**************************************/
base hash-algorithm; /* Identities for Hash Algorithms */
description /**************************************/
"The SHA-224 algorithm.";
reference
"RFC 6234: US Secure Hash Algorithms.";
}
identity sha-256 {
base hash-algorithm;
description
"The SHA-256 algorithm.";
reference
"RFC 6234: US Secure Hash Algorithms.";
}
identity sha-384 { identity hash-algorithm {
base hash-algorithm; description
description "A base identity for hash algorithm verification.";
"The SHA-384 algorithm."; }
reference
"RFC 6234: US Secure Hash Algorithms.";
}
identity sha-512 { identity sha-224 {
base hash-algorithm; base hash-algorithm;
description description
"The SHA-512 algorithm."; "The SHA-224 algorithm.";
reference reference
"RFC 6234: US Secure Hash Algorithms."; "RFC 6234: US Secure Hash Algorithms.";
} }
/***********************************************/ identity sha-256 {
/* Identities for Asymmetric Key Algorithms */ base hash-algorithm;
/***********************************************/ description
"The SHA-256 algorithm.";
reference
"RFC 6234: US Secure Hash Algorithms.";
}
identity asymmetric-key-algorithm { identity sha-384 {
description base hash-algorithm;
"Base identity from which all asymmetric key description
encryption Algorithm."; "The SHA-384 algorithm.";
} reference
"RFC 6234: US Secure Hash Algorithms.";
}
identity rsa1024 { identity sha-512 {
base asymmetric-key-algorithm; base hash-algorithm;
description description
"The RSA algorithm using a 1024-bit key."; "The SHA-512 algorithm.";
reference reference
"RFC 8017: "RFC 6234: US Secure Hash Algorithms.";
PKCS #1: RSA Cryptography Specifications Version 2.2."; }
}
identity rsa2048 { /***********************************************/
base asymmetric-key-algorithm; /* Identities for Asymmetric Key Algorithms */
description /***********************************************/
"The RSA algorithm using a 2048-bit key.";
reference
"RFC 8017:
PKCS #1: RSA Cryptography Specifications Version 2.2.";
}
identity rsa3072 { identity asymmetric-key-algorithm {
base asymmetric-key-algorithm; description
description "Base identity from which all asymmetric key
"The RSA algorithm using a 3072-bit key."; encryption Algorithm.";
reference }
"RFC 8017:
PKCS #1: RSA Cryptography Specifications Version 2.2.";
}
identity rsa4096 { identity rsa1024 {
base asymmetric-key-algorithm; base asymmetric-key-algorithm;
description description
"The RSA algorithm using a 4096-bit key."; "The RSA algorithm using a 1024-bit key.";
reference reference
"RFC 8017: "RFC 8017:
PKCS #1: RSA Cryptography Specifications Version 2.2."; PKCS #1: RSA Cryptography Specifications Version 2.2.";
} }
identity rsa7680 { identity rsa2048 {
base asymmetric-key-algorithm; base asymmetric-key-algorithm;
description description
"The RSA algorithm using a 7680-bit key."; "The RSA algorithm using a 2048-bit key.";
reference reference
"RFC 8017: "RFC 8017:
PKCS #1: RSA Cryptography Specifications Version 2.2."; PKCS #1: RSA Cryptography Specifications Version 2.2.";
} }
identity rsa15360 { identity rsa3072 {
base asymmetric-key-algorithm; base asymmetric-key-algorithm;
description description
"The RSA algorithm using a 15360-bit key."; "The RSA algorithm using a 3072-bit key.";
reference reference
"RFC 8017: "RFC 8017:
PKCS #1: RSA Cryptography Specifications Version 2.2."; PKCS #1: RSA Cryptography Specifications Version 2.2.";
} }
identity secp192r1 { identity rsa4096 {
base asymmetric-key-algorithm; base asymmetric-key-algorithm;
description description
"The ECDSA algorithm using a NIST P256 Curve."; "The RSA algorithm using a 4096-bit key.";
reference reference
"RFC 6090: "RFC 8017:
Fundamental Elliptic Curve Cryptography Algorithms."; PKCS #1: RSA Cryptography Specifications Version 2.2.";
} }
identity secp224r1 {
base asymmetric-key-algorithm;
description
"The ECDSA algorithm using a NIST P256 Curve.";
reference
"RFC 6090:
Fundamental Elliptic Curve Cryptography Algorithms.";
}
identity secp256r1 { identity rsa7680 {
base asymmetric-key-algorithm; base asymmetric-key-algorithm;
description description
"The ECDSA algorithm using a NIST P256 Curve."; "The RSA algorithm using a 7680-bit key.";
reference reference
"RFC 6090: "RFC 8017:
Fundamental Elliptic Curve Cryptography Algorithms."; PKCS #1: RSA Cryptography Specifications Version 2.2.";
} }
identity secp384r1 { identity rsa15360 {
base asymmetric-key-algorithm; base asymmetric-key-algorithm;
description description
"The ECDSA algorithm using a NIST P256 Curve."; "The RSA algorithm using a 15360-bit key.";
reference reference
"RFC 6090: "RFC 8017:
Fundamental Elliptic Curve Cryptography Algorithms."; PKCS #1: RSA Cryptography Specifications Version 2.2.";
} }
identity secp521r1 { identity secp192r1 {
base asymmetric-key-algorithm; base asymmetric-key-algorithm;
description description
"The ECDSA algorithm using a NIST P256 Curve."; "The ECDSA algorithm using a NIST P192 Curve.";
reference reference
"RFC 6090: "RFC 6090:
Fundamental Elliptic Curve Cryptography Algorithms."; Fundamental Elliptic Curve Cryptography Algorithms.
} RFC 5480:
Elliptic Curve Cryptography Subject Public Key Information.";
}
/*************************************/ identity secp224r1 {
/* Identities for MAC Algorithms */ base asymmetric-key-algorithm;
/*************************************/ description
"The ECDSA algorithm using a NIST P224 Curve.";
reference
"RFC 6090:
Fundamental Elliptic Curve Cryptography Algorithms.
RFC 5480:
Elliptic Curve Cryptography Subject Public Key Information.";
}
identity mac-algorithm { identity secp256r1 {
description base asymmetric-key-algorithm;
"A base identity for mac generation."; description
} "The ECDSA algorithm using a NIST P256 Curve.";
reference
"RFC 6090:
Fundamental Elliptic Curve Cryptography Algorithms.
RFC 5480:
Elliptic Curve Cryptography Subject Public Key Information.";
}
identity hmac-sha1 { identity secp384r1 {
base mac-algorithm; base asymmetric-key-algorithm;
description description
"Generating MAC using SHA1 hash function"; "The ECDSA algorithm using a NIST P384 Curve.";
reference reference
"RFC 3174: US Secure Hash Algorithm 1 (SHA1)"; "RFC 6090:
} Fundamental Elliptic Curve Cryptography Algorithms.
RFC 5480:
Elliptic Curve Cryptography Subject Public Key Information.";
}
identity hmac-sha1-96 { identity secp521r1 {
base mac-algorithm; base asymmetric-key-algorithm;
description description
"Generating MAC using SHA1 hash function"; "The ECDSA algorithm using a NIST P521 Curve.";
reference reference
"RFC 2404: The Use of HMAC-SHA-1-96 within ESP and AH"; "RFC 6090:
} Fundamental Elliptic Curve Cryptography Algorithms.
RFC 5480:
Elliptic Curve Cryptography Subject Public Key Information.";
}
identity hmac-sha2-224 { /*************************************/
base mac-algorithm; /* Identities for MAC Algorithms */
description /*************************************/
"Generating MAC using SHA2 hash function";
reference
"RFC 6234:
US Secure Hash Algorithms (SHA and SHA-based HMAC and
HKDF)";
}
identity hmac-sha2-256 { identity mac-algorithm {
base mac-algorithm; description
description "A base identity for mac generation.";
"Generating MAC using SHA2 hash function"; }
reference
"RFC 6234:
US Secure Hash Algorithms (SHA and SHA-based HMAC and
HKDF)";
}
identity hmac-sha2-256-128 { identity hmac-sha1 {
base mac-algorithm; base mac-algorithm;
description description
"Generating a 256 bits MAC using SHA2 hash function and "Generating MAC using SHA1 hash function";
truncate it to 128 bits"; reference
reference "RFC 3174: US Secure Hash Algorithm 1 (SHA1)";
"RFC 4868: }
Using HMAC-SHA-256, HMAC-SHA-384, and HMAC-SHA-512
with IPsec";
}
identity hmac-sha2-384 { identity hmac-sha1-96 {
base mac-algorithm; base mac-algorithm;
description description
"Generating MAC using SHA2 hash function"; "Generating MAC using SHA1 hash function";
reference
"RFC 2404: The Use of HMAC-SHA-1-96 within ESP and AH";
}
reference identity hmac-sha2-224 {
"RFC 6234: base mac-algorithm;
US Secure Hash Algorithms (SHA and SHA-based HMAC and description
HKDF)"; "Generating MAC using SHA2 hash function";
} reference
"RFC 6234:
US Secure Hash Algorithms (SHA and SHA-based HMAC and
HKDF)";
}
identity hmac-sha2-384-192 { identity hmac-sha2-256 {
base mac-algorithm; base mac-algorithm;
description description
"Generating a 384 bits MAC using SHA2 hash function and "Generating MAC using SHA2 hash function";
truncate it to 192 bits"; reference
reference "RFC 6234:
"RFC 4868: US Secure Hash Algorithms (SHA and SHA-based HMAC and
Using HMAC-SHA-256, HMAC-SHA-384, and HMAC-SHA-512 with HKDF)";
IPsec"; }
}
identity hmac-sha2-512 { identity hmac-sha2-256-128 {
base mac-algorithm; base mac-algorithm;
description description
"Generating MAC using SHA2 hash function"; "Generating a 256 bits MAC using SHA2 hash function and
reference truncate it to 128 bits";
"RFC 6234: reference
US Secure Hash Algorithms (SHA and SHA-based HMAC and "RFC 4868:
HKDF)"; Using HMAC-SHA-256, HMAC-SHA-384, and HMAC-SHA-512
} with IPsec";
identity hmac-sha2-512-256 { }
base mac-algorithm;
description
"Generating a 512 bits MAC using SHA2 hash function and
truncating it to 256 bits";
reference
"RFC 4868:
Using HMAC-SHA-256, HMAC-SHA-384, and HMAC-SHA-512 with
IPsec";
}
identity aes-128-gmac { identity hmac-sha2-384 {
base mac-algorithm; base mac-algorithm;
description description
"Generating MAC using the Advanced Encryption Standard (AES) "Generating MAC using SHA2 hash function";
Galois Message Authentication Code (GMAC) as a mechanism to reference
provide data origin authentication"; "RFC 6234:
reference US Secure Hash Algorithms (SHA and SHA-based HMAC and
"RFC 4543: HKDF)";
The Use of Galois Message Authentication Code (GMAC) in }
IPsec ESP and AH";
} identity hmac-sha2-384-192 {
base mac-algorithm;
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";
}
identity aes-192-gmac { identity hmac-sha2-512 {
base mac-algorithm; base mac-algorithm;
description description
"Generating MAC using the Advanced Encryption Standard (AES) "Generating MAC using SHA2 hash function";
Galois Message Authentication Code (GMAC) as a mechanism to reference
provide data origin authentication"; "RFC 6234:
reference US Secure Hash Algorithms (SHA and SHA-based HMAC and
"RFC 4543: HKDF)";
The Use of Galois Message Authentication Code (GMAC) in }
IPsec ESP and AH";
}
identity aes-256-gmac { identity hmac-sha2-512-256 {
base mac-algorithm; base mac-algorithm;
description description
"Generating MAC using the Advanced Encryption Standard (AES) "Generating a 512 bits MAC using SHA2 hash function and
Galois Message Authentication Code (GMAC) as a mechanism to truncating it to 256 bits";
provide data origin authentication"; reference
reference "RFC 4868:
"RFC 4543: Using HMAC-SHA-256, HMAC-SHA-384, and HMAC-SHA-512 with
The Use of Galois Message Authentication Code (GMAC) in IPsec";
IPsec ESP and AH"; }
}
identity aes-cmac-96 { identity aes-128-gmac {
base mac-algorithm; base mac-algorithm;
description description
"Generating MAC using Advanced Encryption Standard (AES) "Generating MAC using the Advanced Encryption Standard (AES)
Cipher-based Message Authentication Code (CMAC)"; Galois Message Authentication Code (GMAC) as a mechanism to
reference provide data origin authentication";
"RFC 4494: The AES-CMAC-96 Algorithm and its Use with IPsec"; reference
} "RFC 4543:
The Use of Galois Message Authentication Code (GMAC) in
IPsec ESP and AH";
}
identity aes-cmac-128 { identity aes-192-gmac {
base mac-algorithm; base mac-algorithm;
description description
"Generating MAC using Advanced Encryption Standard (AES) "Generating MAC using the Advanced Encryption Standard (AES)
Cipher-based Message Authentication Code (CMAC)"; Galois Message Authentication Code (GMAC) as a mechanism to
reference provide data origin authentication";
"RFC 4493: The AES-CMAC Algorithm"; reference
} "RFC 4543:
The Use of Galois Message Authentication Code (GMAC) in
IPsec ESP and AH";
}
/********************************************/ identity aes-256-gmac {
/* Identities for Encryption Algorithms */ base mac-algorithm;
/********************************************/ description
identity encryption-algorithm { "Generating MAC using the Advanced Encryption Standard (AES)
description Galois Message Authentication Code (GMAC) as a mechanism to
"A base identity for encryption algorithm."; provide data origin authentication";
} reference
"RFC 4543:
The Use of Galois Message Authentication Code (GMAC) in
IPsec ESP and AH";
}
identity aes-128-cbc { identity aes-cmac-96 {
base encryption-algorithm; base mac-algorithm;
description description
"Encrypt message with AES algorithm in CBC mode with a key "Generating MAC using Advanced Encryption Standard (AES)
length of 128 bits"; Cipher-based Message Authentication Code (CMAC)";
reference reference
"RFC 3565: "RFC 4494: The AES-CMAC-96 Algorithm and its Use with IPsec";
Use of the Advanced Encryption Standard (AES) Encryption }
Algorithm in Cryptographic Message Syntax (CMS)";
}
identity aes-192-cbc { identity aes-cmac-128 {
base encryption-algorithm; base mac-algorithm;
description description
"Encrypt message with AES algorithm in CBC mode with a key "Generating MAC using Advanced Encryption Standard (AES)
length of 192 bits"; Cipher-based Message Authentication Code (CMAC)";
reference reference
"RFC 3565: "RFC 4493: The AES-CMAC Algorithm";
Use of the Advanced Encryption Standard (AES) Encryption
Algorithm in Cryptographic Message Syntax (CMS)";
}
identity aes-256-cbc { }
base encryption-algorithm;
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)";
}
identity aes-128-ctr { /********************************************/
base encryption-algorithm; /* Identities for Encryption Algorithms */
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)";
}
identity aes-192-ctr {
base encryption-algorithm;
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)";
}
identity aes-256-ctr { identity encryption-algorithm {
base encryption-algorithm; description
description "A base identity for encryption algorithm.";
"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)";
}
/****************************************************/ identity aes-128-cbc {
/* Identities for Encryption and MAC Algorithms */ base encryption-algorithm;
/****************************************************/ 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)";
}
identity encryption-and-mac-algorithm { identity aes-192-cbc {
description base encryption-algorithm;
"A base identity for encryption and MAC algorithm."; 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)";
}
identity aes-128-ccm { identity aes-256-cbc {
base encryption-and-mac-algorithm; base encryption-algorithm;
description description
"Encrypt message with AES algorithm in CCM mode with a key "Encrypt message with AES algorithm in CBC mode with a key
length of 128 bits; it can also be used for generating MAC"; length of 256 bits";
reference reference
"RFC 4309: "RFC 3565:
Using Advanced Encryption Standard (AES) CCM Mode with Use of the Advanced Encryption Standard (AES) Encryption
IPsec Encapsulating Security Payload (ESP)"; Algorithm in Cryptographic Message Syntax (CMS)";
} }
identity aes-192-ccm { identity aes-128-ctr {
base encryption-and-mac-algorithm; base encryption-algorithm;
description description
"Encrypt message with AES algorithm in CCM mode with a key "Encrypt message with AES algorithm in CTR mode with a key
length of 192 bits; it can also be used for generating MAC"; length of 128 bits";
reference reference
"RFC 4309: "RFC 3686:
Using Advanced Encryption Standard (AES) CCM Mode with Using Advanced Encryption Standard (AES) Counter Mode with
IPsec Encapsulating Security Payload (ESP)"; IPsec Encapsulating Security Payload (ESP)";
} }
identity aes-256-ccm { identity aes-192-ctr {
base encryption-and-mac-algorithm; base encryption-algorithm;
description description
"Encrypt message with AES algorithm in CCM mode with a key "Encrypt message with AES algorithm in CTR mode with a key
length of 256 bits; it can also be used for generating MAC"; length of 192 bits";
reference reference
"RFC 4309: "RFC 3686:
Using Advanced Encryption Standard (AES) CCM Mode with Using Advanced Encryption Standard (AES) Counter Mode with
IPsec Encapsulating Security Payload (ESP)"; IPsec Encapsulating Security Payload (ESP)";
} }
identity aes-128-gcm { identity aes-256-ctr {
base encryption-and-mac-algorithm; base encryption-algorithm;
description description
"Encrypt message with AES algorithm in GCM mode with a key "Encrypt message with AES algorithm in CTR mode with a key
length of 128 bits; it can also be used for generating MAC"; length of 256 bits";
reference reference
"RFC 4106: "RFC 3686:
The Use of Galois/Counter Mode (GCM) in IPsec Encapsulating Using Advanced Encryption Standard (AES) Counter Mode with
Security Payload (ESP)"; IPsec Encapsulating Security Payload (ESP)";
} }
identity aes-192-gcm { /****************************************************/
base encryption-and-mac-algorithm; /* Identities for Encryption and MAC Algorithms */
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)";
}
identity mac-aes-256-gcm { identity encryption-and-mac-algorithm {
base encryption-and-mac-algorithm; description
description "A base identity for encryption and MAC algorithm.";
"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)";
}
identity chacha20-poly1305 {
base encryption-and-mac-algorithm;
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";
}
/******************************************/ identity aes-128-ccm {
/* Identities for signature algorithm */ base encryption-and-mac-algorithm;
/******************************************/ 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)";
}
identity aes-192-ccm {
base encryption-and-mac-algorithm;
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)";
}
identity signature-algorithm { identity aes-256-ccm {
description base encryption-and-mac-algorithm;
"A base identity for asymmetric key encryption algorithm."; 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)";
}
identity dsa-sha1 { identity aes-128-gcm {
base signature-algorithm; base encryption-and-mac-algorithm;
description description
"The signature algorithm using DSA algorithm with SHA1 hash "Encrypt message with AES algorithm in GCM mode with a key
algorithm"; length of 128 bits; it can also be used for generating MAC";
reference reference
"RFC 4253: The Secure Shell (SSH) Transport Layer Protocol"; "RFC 4106:
} The Use of Galois/Counter Mode (GCM) in IPsec Encapsulating
Security Payload (ESP)";
}
identity rsassa-pkcs1-sha1 { identity aes-192-gcm {
base signature-algorithm; base encryption-and-mac-algorithm;
description description
"The signature algorithm using RSASSA-PKCS1-v1_5 with the SHA1 "Encrypt message with AES algorithm in GCM mode with a key
hash algorithm."; length of 192 bits; it can also be used for generating MAC";
reference reference
"RFC 4253: The Secure Shell (SSH) Transport Layer Protocol"; "RFC 4106:
} The Use of Galois/Counter Mode (GCM) in IPsec Encapsulating
Security Payload (ESP)";
}
identity rsassa-pkcs1-sha256 { identity mac-aes-256-gcm {
base signature-algorithm; base encryption-and-mac-algorithm;
description description
"The signature algorithm using RSASSA-PKCS1-v1_5 with the "Encrypt message with AES algorithm in GCM mode with a key
SHA256 hash algorithm."; length of 128 bits; it can also be used for generating MAC";
reference reference
"RFC 8332: "RFC 4106:
Use of RSA Keys with SHA-256 and SHA-512 in the Secure Shell The Use of Galois/Counter Mode (GCM) in IPsec Encapsulating
(SSH) Protocol Security Payload (ESP)";
RFC 8446: }
The Transport Layer Security (TLS) Protocol Version 1.3";
}
identity rsassa-pkcs1-sha384 {
base signature-algorithm;
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";
}
identity rsassa-pkcs1-sha512 { identity chacha20-poly1305 {
base signature-algorithm; base encryption-and-mac-algorithm;
description description
"The signature algorithm using RSASSA-PKCS1-v1_5 with the "Encrypt message with chacha20 algorithm and generate MAC with
SHA512 hash algorithm."; POLY1305; it can also be used for generating MAC";
reference reference
"RFC 8332: "RFC 8439: ChaCha20 and Poly1305 for IETF Protocols";
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";
}
identity rsassa-pss-rsae-sha256 { /******************************************/
base signature-algorithm; /* Identities for signature algorithm */
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";
}
identity rsassa-pss-rsae-sha384 { identity signature-algorithm {
base signature-algorithm; description
description "A base identity for asymmetric key encryption algorithm.";
"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";
}
identity rsassa-pss-rsae-sha512 { identity dsa-sha1 {
base signature-algorithm; base signature-algorithm;
description description
"The signature algorithm using RSASSA-PSS with mask generation "The signature algorithm using DSA algorithm with SHA1 hash
function 1 and SHA512 hash algorithm. If the public key is algorithm";
carried in an X.509 certificate, it MUST use the rsaEncryption reference
OID"; "RFC 4253: The Secure Shell (SSH) Transport Layer Protocol";
reference }
"RFC 8446:
The Transport Layer Security (TLS) Protocol Version 1.3";
}
identity rsassa-pss-pss-sha256 { identity rsassa-pkcs1-sha1 {
base signature-algorithm; base signature-algorithm;
description description
"The signature algorithm using RSASSA-PSS with mask generation "The signature algorithm using RSASSA-PKCS1-v1_5 with the SHA1
function 1 and SHA256 hash algorithm. If the public key is hash algorithm.";
carried in an X.509 certificate, it MUST use the RSASSA-PSS reference
OID"; "RFC 4253: The Secure Shell (SSH) Transport Layer Protocol";
reference }
"RFC 8446:
The Transport Layer Security (TLS) Protocol Version 1.3";
}
identity rsassa-pss-pss-sha384 { identity rsassa-pkcs1-sha256 {
base signature-algorithm; base signature-algorithm;
description description
"The signature algorithm using RSASSA-PSS with mask generation "The signature algorithm using RSASSA-PKCS1-v1_5 with the
function 1 and SHA256 hash algorithm. If the public key is SHA256 hash algorithm.";
carried in an X.509 certificate, it MUST use the RSASSA-PSS
OID";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol Version 1.3";
}
identity rsassa-pss-pss-sha512 { reference
base signature-algorithm; "RFC 8332:
description Use of RSA Keys with SHA-256 and SHA-512 in the Secure Shell
"The signature algorithm using RSASSA-PSS with mask generation (SSH) Protocol
function 1 and SHA256 hash algorithm. If the public key is RFC 8446:
carried in an X.509 certificate, it MUST use the RSASSA-PSS The Transport Layer Security (TLS) Protocol Version 1.3";
OID"; }
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol Version 1.3";
}
identity ecdsa-secp256r1-sha256 { identity rsassa-pkcs1-sha384 {
base signature-algorithm; base signature-algorithm;
description description
"The signature algorithm using ECDSA with curve name secp256r1 "The signature algorithm using RSASSA-PKCS1-v1_5 with the
and SHA256 hash algorithm."; SHA384 hash algorithm.";
reference reference
"RFC 5656: Elliptic Curve Algorithm Integration in the "RFC 8446:
Secure Shell Transport Layer The Transport Layer Security (TLS) Protocol Version 1.3";
RFC 8446: }
The Transport Layer Security (TLS) Protocol Version 1.3";
}
identity ecdsa-secp384r1-sha384 { identity rsassa-pkcs1-sha512 {
base signature-algorithm; base signature-algorithm;
description description
"The signature algorithm using ECDSA with curve name secp384r1 "The signature algorithm using RSASSA-PKCS1-v1_5 with the
and SHA384 hash algorithm."; SHA512 hash algorithm.";
reference reference
"RFC 5656: Elliptic Curve Algorithm Integration in the "RFC 8332:
Secure Shell Transport Layer Use of RSA Keys with SHA-256 and SHA-512 in the Secure Shell
RFC 8446: (SSH) Protocol
The Transport Layer Security (TLS) Protocol Version 1.3"; RFC 8446:
} The Transport Layer Security (TLS) Protocol Version 1.3";
}
identity ecdsa-secp521r1-sha512 { identity rsassa-pss-rsae-sha256 {
base signature-algorithm; base signature-algorithm;
description description
"The signature algorithm using ECDSA with curve name secp521r1 "The signature algorithm using RSASSA-PSS with mask generation
and SHA512 hash algorithm."; function 1 and SHA256 hash algorithm. If the public key is
reference carried in an X.509 certificate, it MUST use the rsaEncryption
"RFC 5656: Elliptic Curve Algorithm Integration in the OID";
Secure Shell Transport Layer reference
RFC 8446: "RFC 8446:
The Transport Layer Security (TLS) Protocol Version 1.3"; The Transport Layer Security (TLS) Protocol Version 1.3";
} }
identity ed25519 { identity rsassa-pss-rsae-sha384 {
base signature-algorithm; base signature-algorithm;
description description
"The signature algorithm using EdDSA as defined in RFC 8032 or "The signature algorithm using RSASSA-PSS with mask generation
its successors."; function 1 and SHA384 hash algorithm. If the public key is
reference carried in an X.509 certificate, it MUST use the rsaEncryption
"RFC 8032: Edwards-Curve Digital Signature Algorithm (EdDSA)"; OID";
} reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol Version 1.3";
}
identity ed448 { identity rsassa-pss-rsae-sha512 {
base signature-algorithm; base signature-algorithm;
description description
"The signature algorithm using EdDSA as defined in RFC 8032 or "The signature algorithm using RSASSA-PSS with mask generation
its successors."; function 1 and SHA512 hash algorithm. If the public key is
reference carried in an X.509 certificate, it MUST use the rsaEncryption
"RFC 8032: Edwards-Curve Digital Signature Algorithm (EdDSA)"; OID";
} reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol Version 1.3";
}
identity eccsi { identity rsassa-pss-pss-sha256 {
base signature-algorithm; base signature-algorithm;
description description
"The signature algorithm using ECCSI signature as defined in "The signature algorithm using RSASSA-PSS with mask generation
RFC 6507."; function 1 and SHA256 hash algorithm. If the public key is
reference carried in an X.509 certificate, it MUST use the RSASSA-PSS
"RFC 6507: OID";
Elliptic Curve-Based Certificateless Signatures for reference
Identity-based Encryption (ECCSI)"; "RFC 8446:
} The Transport Layer Security (TLS) Protocol Version 1.3";
}
/**********************************************/ identity rsassa-pss-pss-sha384 {
/* Identities for key exchange algorithms */ base signature-algorithm;
/**********************************************/ 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 RSASSA-PSS
OID";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol Version 1.3";
}
identity key-exchange-algorithm { identity rsassa-pss-pss-sha512 {
description base signature-algorithm;
"A base identity for Diffie-Hellman based key exchange description
algorithm."; "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 RSASSA-PSS
OID";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol Version 1.3";
}
identity psk-only { identity ecdsa-secp256r1-sha256 {
base key-exchange-algorithm; base signature-algorithm;
description description
"Using Pre-shared key for authentication and key exchange"; "The signature algorithm using ECDSA with curve name secp256r1
reference and SHA256 hash algorithm.";
"RFC 4279: reference
Pre-Shared Key cipher suites for Transport Layer Security "RFC 5656: Elliptic Curve Algorithm Integration in the
(TLS)"; Secure Shell Transport Layer
} RFC 8446:
The Transport Layer Security (TLS) Protocol Version 1.3";
}
identity dhe-ffdhe2048 { identity ecdsa-secp384r1-sha384 {
base key-exchange-algorithm; base signature-algorithm;
description description
"Ephemeral Diffie Hellman key exchange with 2048 bit "The signature algorithm using ECDSA with curve name secp384r1
finite field"; and SHA384 hash algorithm.";
reference reference
"RFC 7919: "RFC 5656: Elliptic Curve Algorithm Integration in the
Negotiated Finite Field Diffie-Hellman Ephemeral Parameters Secure Shell Transport Layer
for Transport Layer Security (TLS)"; RFC 8446:
} The Transport Layer Security (TLS) Protocol Version 1.3";
}
identity dhe-ffdhe3072 { identity ecdsa-secp521r1-sha512 {
base key-exchange-algorithm; base signature-algorithm;
description description
"Ephemeral Diffie Hellman key exchange with 3072 bit finite "The signature algorithm using ECDSA with curve name secp521r1
field"; and SHA512 hash algorithm.";
reference reference
"RFC 7919: "RFC 5656: Elliptic Curve Algorithm Integration in the
Negotiated Finite Field Diffie-Hellman Ephemeral Parameters Secure Shell Transport Layer
for Transport Layer Security (TLS)"; RFC 8446:
} The Transport Layer Security (TLS) Protocol Version 1.3";
}
identity dhe-ffdhe4096 { identity ed25519 {
base key-exchange-algorithm; base signature-algorithm;
description description
"Ephemeral Diffie Hellman key exchange with 4096 bit "The signature algorithm using EdDSA as defined in RFC 8032 or
finite field"; its successors.";
reference
"RFC 7919:
Negotiated Finite Field Diffie-Hellman Ephemeral Parameters
for Transport Layer Security (TLS)";
}
identity dhe-ffdhe6144 { reference
base key-exchange-algorithm; "RFC 8032: Edwards-Curve Digital Signature Algorithm (EdDSA)";
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)";
}
identity dhe-ffdhe8192 { identity ed448 {
base key-exchange-algorithm; base signature-algorithm;
description description
"Ephemeral Diffie Hellman key exchange with 8192 bit "The signature algorithm using EdDSA as defined in RFC 8032 or
finite field"; its successors.";
reference reference
"RFC 7919: "RFC 8032: Edwards-Curve Digital Signature Algorithm (EdDSA)";
Negotiated Finite Field Diffie-Hellman Ephemeral Parameters }
for Transport Layer Security (TLS)";
}
identity psk-dhe-ffdhe2048 { identity eccsi {
base key-exchange-algorithm; base signature-algorithm;
description description
"Key exchange using pre-shared key with Diffie-Hellman key "The signature algorithm using ECCSI signature as defined in
generation mechanism, where the DH group is FFDHE2048"; RFC 6507.";
reference
"RFC 6507:
Elliptic Curve-Based Certificateless Signatures for
Identity-based Encryption (ECCSI)";
}
reference /**********************************************/
"RFC 8446: /* Identities for key exchange algorithms */
The Transport Layer Security (TLS) Protocol Version 1.3"; /**********************************************/
}
identity psk-dhe-ffdhe3072 { identity key-exchange-algorithm {
base key-exchange-algorithm; description
description "A base identity for Diffie-Hellman based key exchange
"Key exchange using pre-shared key with Diffie-Hellman key algorithm.";
generation mechanism, where the DH group is FFDHE3072"; }
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol Version 1.3";
}
identity psk-dhe-ffdhe4096 { identity psk-only {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
"Key exchange using pre-shared key with Diffie-Hellman key "Using Pre-shared key for authentication and key exchange";
generation mechanism, where the DH group is FFDHE4096"; reference
reference "RFC 4279:
"RFC 8446: Pre-Shared Key cipher suites for Transport Layer Security
The Transport Layer Security (TLS) Protocol Version 1.3"; (TLS)";
} }
identity psk-dhe-ffdhe6144 { identity dhe-ffdhe2048 {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
"Key exchange using pre-shared key with Diffie-Hellman key "Ephemeral Diffie Hellman key exchange with 2048 bit
generation mechanism, where the DH group is FFDHE6144"; finite field";
reference reference
"RFC 8446: "RFC 7919:
The Transport Layer Security (TLS) Protocol Version 1.3"; Negotiated Finite Field Diffie-Hellman Ephemeral Parameters
} for Transport Layer Security (TLS)";
}
identity psk-dhe-ffdhe8192 { identity dhe-ffdhe3072 {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
"Key exchange using pre-shared key with Diffie-Hellman key "Ephemeral Diffie Hellman key exchange with 3072 bit finite
generation mechanism, where the DH group is FFDHE8192"; field";
reference reference
"RFC 8446: "RFC 7919:
The Transport Layer Security (TLS) Protocol Version 1.3"; Negotiated Finite Field Diffie-Hellman Ephemeral Parameters
} for Transport Layer Security (TLS)";
}
identity ecdhe-secp256r1 { identity dhe-ffdhe4096 {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
"Ephemeral Diffie Hellman key exchange with elliptic group "Ephemeral Diffie Hellman key exchange with 4096 bit
over curve secp256r1"; finite field";
reference reference
"RFC 8422: "RFC 7919:
Elliptic Curve Cryptography (ECC) Cipher Suites for Negotiated Finite Field Diffie-Hellman Ephemeral Parameters
Transport Layer Security (TLS) Versions 1.2 and Earlier"; for Transport Layer Security (TLS)";
} }
identity ecdhe-secp384r1 { identity dhe-ffdhe6144 {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
"Ephemeral Diffie Hellman key exchange with elliptic group "Ephemeral Diffie Hellman key exchange with 6144 bit
over curve secp384r1"; finite field";
reference reference
"RFC 8422: "RFC 7919:
Elliptic Curve Cryptography (ECC) Cipher Suites for Negotiated Finite Field Diffie-Hellman Ephemeral Parameters
Transport Layer Security (TLS) Versions 1.2 and Earlier"; for Transport Layer Security (TLS)";
} }
identity ecdhe-secp521r1 { identity dhe-ffdhe8192 {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
"Ephemeral Diffie Hellman key exchange with elliptic group "Ephemeral Diffie Hellman key exchange with 8192 bit
over curve secp521r1"; finite field";
reference reference
"RFC 8422: "RFC 7919:
Elliptic Curve Cryptography (ECC) Cipher Suites for Negotiated Finite Field Diffie-Hellman Ephemeral Parameters
Transport Layer Security (TLS) Versions 1.2 and Earlier"; for Transport Layer Security (TLS)";
} }
identity ecdhe-x25519 { identity psk-dhe-ffdhe2048 {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
"Ephemeral Diffie Hellman key exchange with elliptic group "Key exchange using pre-shared key with Diffie-Hellman key
over curve x25519"; generation mechanism, where the DH group is FFDHE2048";
reference reference
"RFC 8422: "RFC 8446:
Elliptic Curve Cryptography (ECC) Cipher Suites for The Transport Layer Security (TLS) Protocol Version 1.3";
Transport Layer Security (TLS) Versions 1.2 and Earlier"; }
}
identity ecdhe-x448 { identity psk-dhe-ffdhe3072 {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
"Ephemeral Diffie Hellman key exchange with elliptic group "Key exchange using pre-shared key with Diffie-Hellman key
over curve x448"; generation mechanism, where the DH group is FFDHE3072";
reference reference
"RFC 8422: "RFC 8446:
The Transport Layer Security (TLS) Protocol Version 1.3";
}
Elliptic Curve Cryptography (ECC) Cipher Suites for identity psk-dhe-ffdhe4096 {
Transport Layer Security (TLS) Versions 1.2 and Earlier"; base key-exchange-algorithm;
} 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";
}
identity psk-ecdhe-secp256r1 { identity psk-dhe-ffdhe6144 {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
"Key exchange using pre-shared key with elliptic group-based "Key exchange using pre-shared key with Diffie-Hellman key
Ephemeral Diffie Hellman key exchange over curve secp256r1"; generation mechanism, where the DH group is FFDHE6144";
reference reference
"RFC 8446: "RFC 8446:
The Transport Layer Security (TLS) Protocol Version 1.3"; The Transport Layer Security (TLS) Protocol Version 1.3";
} }
identity psk-ecdhe-secp384r1 { identity psk-dhe-ffdhe8192 {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
"Key exchange using pre-shared key with elliptic group-based "Key exchange using pre-shared key with Diffie-Hellman key
Ephemeral Diffie Hellman key exchange over curve secp384r1"; generation mechanism, where the DH group is FFDHE8192";
reference
"RFC 8446:
The Transport Layer Security (TLS) Protocol Version 1.3";
}
identity psk-ecdhe-secp521r1 { reference
base key-exchange-algorithm; "RFC 8446:
description The Transport Layer Security (TLS) Protocol Version 1.3";
"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";
}
identity psk-ecdhe-x25519 { identity ecdhe-secp256r1 {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
"Key exchange using pre-shared key with elliptic group-based "Ephemeral Diffie Hellman key exchange with elliptic group
Ephemeral Diffie Hellman key exchange over curve x25519"; over curve secp256r1";
reference reference
"RFC 8446: "RFC 8422:
The Transport Layer Security (TLS) Protocol Version 1.3"; Elliptic Curve Cryptography (ECC) Cipher Suites for
} Transport Layer Security (TLS) Versions 1.2 and Earlier";
}
identity psk-ecdhe-x448 { identity ecdhe-secp384r1 {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
"Key exchange using pre-shared key with elliptic group-based "Ephemeral Diffie Hellman key exchange with elliptic group
Ephemeral Diffie Hellman key exchange over curve x448"; over curve secp384r1";
reference reference
"RFC 8446: "RFC 8422:
The Transport Layer Security (TLS) Protocol Version 1.3"; Elliptic Curve Cryptography (ECC) Cipher Suites for
} Transport Layer Security (TLS) Versions 1.2 and Earlier";
}
identity diffie-hellman-group14-sha1 { identity ecdhe-secp521r1 {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
"Using DH group14 and SHA1 for key exchange"; "Ephemeral Diffie Hellman key exchange with elliptic group
reference over curve secp521r1";
"RFC 4253: The Secure Shell (SSH) Transport Layer Protocol"; reference
} "RFC 8422:
Elliptic Curve Cryptography (ECC) Cipher Suites for
Transport Layer Security (TLS) Versions 1.2 and Earlier";
}
identity diffie-hellman-group14-sha256 { identity ecdhe-x25519 {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
"Using DH group14 and SHA256 for key exchange"; "Ephemeral Diffie Hellman key exchange with elliptic group
reference over curve x25519";
"RFC 8268: reference
More Modular Exponentiation (MODP) Diffie-Hellman (DH) "RFC 8422:
Key Exchange (KEX) Groups for Secure Shell (SSH)"; Elliptic Curve Cryptography (ECC) Cipher Suites for
} Transport Layer Security (TLS) Versions 1.2 and Earlier";
}
identity ecdhe-x448 {
base key-exchange-algorithm;
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";
}
identity diffie-hellman-group15-sha512 { identity psk-ecdhe-secp256r1 {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
"Using DH group15 and SHA512 for key exchange"; "Key exchange using pre-shared key with elliptic group-based
reference Ephemeral Diffie Hellman key exchange over curve secp256r1";
"RFC 8268: reference
More Modular Exponentiation (MODP) Diffie-Hellman (DH) "RFC 8446:
Key Exchange (KEX) Groups for Secure Shell (SSH)"; The Transport Layer Security (TLS) Protocol Version 1.3";
} }
identity diffie-hellman-group16-sha512 { identity psk-ecdhe-secp384r1 {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
"Using DH group16 and SHA512 for key exchange"; "Key exchange using pre-shared key with elliptic group-based
reference Ephemeral Diffie Hellman key exchange over curve secp384r1";
"RFC 8268: reference
More Modular Exponentiation (MODP) Diffie-Hellman (DH) "RFC 8446:
Key Exchange (KEX) Groups for Secure Shell (SSH)"; The Transport Layer Security (TLS) Protocol Version 1.3";
} }
identity diffie-hellman-group17-sha512 { identity psk-ecdhe-secp521r1 {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
"Using DH group17 and SHA512 for key exchange"; "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";
}
reference identity psk-ecdhe-x25519 {
"RFC 8268: base key-exchange-algorithm;
More Modular Exponentiation (MODP) Diffie-Hellman (DH) description
Key Exchange (KEX) Groups for Secure Shell (SSH)"; "Key exchange using pre-shared key with elliptic group-based
} Ephemeral Diffie Hellman key exchange over curve x25519";
reference
"RFC 8446:
identity diffie-hellman-group18-sha512 { The Transport Layer Security (TLS) Protocol Version 1.3";
base key-exchange-algorithm; }
description
"Using DH group18 and SHA512 for key exchange";
reference
"RFC 8268:
More Modular Exponentiation (MODP) Diffie-Hellman (DH)
Key Exchange (KEX) Groups for Secure Shell (SSH)";
}
identity ecdh-sha2-secp256r1 { identity psk-ecdhe-x448 {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
"Elliptic curve-based Diffie Hellman key exchange over curve "Key exchange using pre-shared key with elliptic group-based
secp256r1 and using SHA2 for MAC generation"; Ephemeral Diffie Hellman key exchange over curve x448";
reference reference
"RFC 6239: Suite B Cryptographic Suites for Secure Shell "RFC 8446:
(SSH)"; The Transport Layer Security (TLS) Protocol Version 1.3";
} }
identity ecdh-sha2-secp384r1 { identity diffie-hellman-group14-sha1 {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
"Elliptic curve-based Diffie Hellman key exchange over curve "Using DH group14 and SHA1 for key exchange";
secp384r1 and using SHA2 for MAC generation"; reference
reference "RFC 4253: The Secure Shell (SSH) Transport Layer Protocol";
"RFC 6239: Suite B Cryptographic Suites for Secure Shell }
(SSH)";
}
identity rsaes-oaep { identity diffie-hellman-group14-sha256 {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
"RSAES-OAEP combines the RSAEP and RSADP primitives with the "Using DH group14 and SHA256 for key exchange";
EME-OAEP encoding method"; reference
reference "RFC 8268:
"RFC 8017: More Modular Exponentiation (MODP) Diffie-Hellman (DH)
PKCS #1: RSA Cryptography Specifications Version 2.2."; Key Exchange (KEX) Groups for Secure Shell (SSH)";
} }
identity rsaes-pkcs1-v1_5 { identity diffie-hellman-group15-sha512 {
base key-exchange-algorithm; base key-exchange-algorithm;
description description
" RSAES-PKCS1-v1_5 combines the RSAEP and RSADP primitives "Using DH group15 and SHA512 for key exchange";
with the EME-PKCS1-v1_5 encoding method"; reference
reference "RFC 8268:
"RFC 8017: More Modular Exponentiation (MODP) Diffie-Hellman (DH)
PKCS #1: RSA Cryptography Specifications Version 2.2."; Key Exchange (KEX) Groups for Secure Shell (SSH)";
} }
/**********************************************************/ identity diffie-hellman-group16-sha512 {
/* Typedefs for identityrefs to above base identities */ base key-exchange-algorithm;
/**********************************************************/ description
"Using DH group16 and SHA512 for key exchange";
reference
"RFC 8268:
More Modular Exponentiation (MODP) Diffie-Hellman (DH)
Key Exchange (KEX) Groups for Secure Shell (SSH)";
}
typedef hash-algorithm-ref { identity diffie-hellman-group17-sha512 {
type identityref { base key-exchange-algorithm;
base hash-algorithm; description
} "Using DH group17 and SHA512 for key exchange";
description reference
"This typedef enables importing modules to easily define an "RFC 8268:
identityref to the 'hash-algorithm' base identity."; More Modular Exponentiation (MODP) Diffie-Hellman (DH)
} Key Exchange (KEX) Groups for Secure Shell (SSH)";
}
typedef signature-algorithm-ref { identity diffie-hellman-group18-sha512 {
type identityref { base key-exchange-algorithm;
base signature-algorithm; description
} "Using DH group18 and SHA512 for key exchange";
description reference
"This typedef enables importing modules to easily define an "RFC 8268:
identityref to the 'signature-algorithm' base identity."; More Modular Exponentiation (MODP) Diffie-Hellman (DH)
} Key Exchange (KEX) Groups for Secure Shell (SSH)";
}
typedef mac-algorithm-ref { identity ecdh-sha2-secp256r1 {
type identityref { base key-exchange-algorithm;
base mac-algorithm; description
} "Elliptic curve-based Diffie Hellman key exchange over curve
description secp256r1 and using SHA2 for MAC generation";
"This typedef enables importing modules to easily define an reference
identityref to the 'mac-algorithm' base identity."; "RFC 6239: Suite B Cryptographic Suites for Secure Shell
} (SSH)";
}
typedef encryption-algorithm-ref { identity ecdh-sha2-secp384r1 {
type identityref { base key-exchange-algorithm;
base encryption-algorithm; description
} "Elliptic curve-based Diffie Hellman key exchange over curve
description secp384r1 and using SHA2 for MAC generation";
"This typedef enables importing modules to easily define an reference
identityref to the 'encryption-algorithm' "RFC 6239: Suite B Cryptographic Suites for Secure Shell
base identity."; (SSH)";
} }
typedef encryption-and-mac-algorithm-ref {
type identityref {
base encryption-and-mac-algorithm;
}
description
"This typedef enables importing modules to easily define an
identityref to the 'encryption-and-mac-algorithm'
base identity.";
}
typedef asymmetric-key-algorithm-ref { identity rsaes-oaep {
type identityref { base key-exchange-algorithm;
base asymmetric-key-algorithm; description
} "RSAES-OAEP combines the RSAEP and RSADP primitives with the
description EME-OAEP encoding method";
"This typedef enables importing modules to easily define an
identityref to the 'asymmetric-key-algorithm'
base identity.";
}
typedef key-exchange-algorithm-ref { reference
type identityref { "RFC 8017:
base key-exchange-algorithm; PKCS #1: RSA Cryptography Specifications Version 2.2.";
} }
description
"This typedef enables importing modules to easily define an
identityref to the 'key-exchange-algorithm' base identity.";
}
/***************************************************/ identity rsaes-pkcs1-v1_5 {
/* Typedefs for ASN.1 structures from RFC 5280 */ base key-exchange-algorithm;
/***************************************************/ 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.";
}
typedef x509 { /**********************************************************/
type binary; /* Typedefs for identityrefs to above base identities */
description /**********************************************************/
"A Certificate structure, as specified in RFC 5280,
encoded using ASN.1 distinguished encoding rules (DER),
as specified in ITU-T X.690.";
reference
"RFC 5280:
Internet X.509 Public Key Infrastructure Certificate
and Certificate Revocation List (CRL) Profile
ITU-T X.690:
Information technology - ASN.1 encoding rules:
Specification of Basic Encoding Rules (BER),
Canonical Encoding Rules (CER) and Distinguished
Encoding Rules (DER).";
} typedef hash-algorithm-ref {
type identityref {
base hash-algorithm;
}
description
"This typedef enables importing modules to easily define an
identityref to the 'hash-algorithm' base identity.";
}
typedef crl { typedef signature-algorithm-ref {
type binary; type identityref {
description base signature-algorithm;
"A CertificateList structure, as specified in RFC 5280, }
encoded using ASN.1 distinguished encoding rules (DER), description
as specified in ITU-T X.690."; "This typedef enables importing modules to easily define an
reference identityref to the 'signature-algorithm' base identity.";
"RFC 5280: }
Internet X.509 Public Key Infrastructure Certificate
and Certificate Revocation List (CRL) Profile
ITU-T X.690:
Information technology - ASN.1 encoding rules:
Specification of Basic Encoding Rules (BER),
Canonical Encoding Rules (CER) and Distinguished
Encoding Rules (DER).";
}
/***********************************************/ typedef mac-algorithm-ref {
/* Typedefs for ASN.1 structures from 5652 */ type identityref {
/***********************************************/ base mac-algorithm;
}
description
"This typedef enables importing modules to easily define an
identityref to the 'mac-algorithm' base identity.";
}
typedef cms { typedef encryption-algorithm-ref {
type binary; type identityref {
description base encryption-algorithm;
"A ContentInfo structure, as specified in RFC 5652, }
encoded using ASN.1 distinguished encoding rules (DER), description
as specified in ITU-T X.690."; "This typedef enables importing modules to easily define an
reference identityref to the 'encryption-algorithm'
"RFC 5652: base identity.";
Cryptographic Message Syntax (CMS) }
ITU-T X.690:
Information technology - ASN.1 encoding rules:
Specification of Basic Encoding Rules (BER),
Canonical Encoding Rules (CER) and Distinguished
Encoding Rules (DER).";
}
typedef data-content-cms { typedef encryption-and-mac-algorithm-ref {
type cms; type identityref {
description base encryption-and-mac-algorithm;
"A CMS structure whose top-most content type MUST be the }
data content type, as described by Section 4 in RFC 5652."; description
reference "This typedef enables importing modules to easily define an
"RFC 5652: Cryptographic Message Syntax (CMS)"; identityref to the 'encryption-and-mac-algorithm'
} base identity.";
typedef signed-data-cms { }
type cms;
description
"A CMS structure whose top-most content type MUST be the
signed-data content type, as described by Section 5 in
RFC 5652.";
reference
"RFC 5652: Cryptographic Message Syntax (CMS)";
}
typedef enveloped-data-cms { typedef asymmetric-key-algorithm-ref {
type cms; type identityref {
description base asymmetric-key-algorithm;
"A CMS structure whose top-most content type MUST be the }
enveloped-data content type, as described by Section 6 description
in RFC 5652."; "This typedef enables importing modules to easily define an
reference identityref to the 'asymmetric-key-algorithm'
"RFC 5652: Cryptographic Message Syntax (CMS)"; base identity.";
} }
typedef digested-data-cms { typedef key-exchange-algorithm-ref {
type cms; type identityref {
description base key-exchange-algorithm;
"A CMS structure whose top-most content type MUST be the }
digested-data content type, as described by Section 7 description
in RFC 5652."; "This typedef enables importing modules to easily define an
reference identityref to the 'key-exchange-algorithm' base identity.";
"RFC 5652: Cryptographic Message Syntax (CMS)"; }
}
typedef encrypted-data-cms { /***************************************************/
type cms; /* Typedefs for ASN.1 structures from RFC 5280 */
description /***************************************************/
"A CMS structure whose top-most content type MUST be the
encrypted-data content type, as described by Section 8
in RFC 5652.";
reference
"RFC 5652: Cryptographic Message Syntax (CMS)";
}
typedef authenticated-data-cms { typedef x509 {
type cms; type binary;
description description
"A CMS structure whose top-most content type MUST be the "A Certificate structure, as specified in RFC 5280,
authenticated-data content type, as described by Section 9 encoded using ASN.1 distinguished encoding rules (DER),
in RFC 5652."; as specified in ITU-T X.690.";
reference reference
"RFC 5652: Cryptographic Message Syntax (CMS)"; "RFC 5280:
Internet X.509 Public Key Infrastructure Certificate
and Certificate Revocation List (CRL) Profile
ITU-T X.690:
Information technology - ASN.1 encoding rules:
Specification of Basic Encoding Rules (BER),
Canonical Encoding Rules (CER) and Distinguished
Encoding Rules (DER).";
}
} typedef crl {
type binary;
description
"A CertificateList structure, as specified in RFC 5280,
encoded using ASN.1 distinguished encoding rules (DER),
as specified in ITU-T X.690.";
reference
"RFC 5280:
Internet X.509 Public Key Infrastructure Certificate
and Certificate Revocation List (CRL) Profile
ITU-T X.690:
Information technology - ASN.1 encoding rules:
Specification of Basic Encoding Rules (BER),
Canonical Encoding Rules (CER) and Distinguished
Encoding Rules (DER).";
}
/***************************************************/ /***********************************************/
/* Typedefs for structures related to RFC 4253 */ /* Typedefs for ASN.1 structures from 5652 */
/***************************************************/ /***********************************************/
typedef ssh-host-key { typedef cms {
type binary; type binary;
description description
"The binary public key data for this SSH key, as "A ContentInfo structure, as specified in RFC 5652,
specified by RFC 4253, Section 6.6, i.e.: encoded using ASN.1 distinguished encoding rules (DER),
as specified in ITU-T X.690.";
reference
"RFC 5652:
Cryptographic Message Syntax (CMS)
ITU-T X.690:
Information technology - ASN.1 encoding rules:
Specification of Basic Encoding Rules (BER),
Canonical Encoding Rules (CER) and Distinguished
Encoding Rules (DER).";
}
string certificate or public key format typedef data-content-cms {
identifier type cms;
byte[n] key/certificate data."; description
reference "A CMS structure whose top-most content type MUST be the
"RFC 4253: The Secure Shell (SSH) Transport Layer data content type, as described by Section 4 in RFC 5652.";
Protocol"; reference
} "RFC 5652: Cryptographic Message Syntax (CMS)";
}
/*********************************************************/ typedef signed-data-cms {
/* Typedefs for ASN.1 structures related to RFC 5280 */ type cms;
/*********************************************************/ description
"A CMS structure whose top-most content type MUST be the
signed-data content type, as described by Section 5 in
RFC 5652.";
reference
"RFC 5652: Cryptographic Message Syntax (CMS)";
}
typedef trust-anchor-cert-x509 { typedef enveloped-data-cms {
type x509; type cms;
description description
"A Certificate structure that MUST encode a self-signed "A CMS structure whose top-most content type MUST be the
root certificate."; enveloped-data content type, as described by Section 6
} in RFC 5652.";
reference
"RFC 5652: Cryptographic Message Syntax (CMS)";
}
typedef end-entity-cert-x509 { typedef digested-data-cms {
type x509; type cms;
description description
"A Certificate structure that MUST encode a certificate "A CMS structure whose top-most content type MUST be the
that is neither self-signed nor having Basic constraint digested-data content type, as described by Section 7
CA true."; in RFC 5652.";
} reference
"RFC 5652: Cryptographic Message Syntax (CMS)";
}
/*********************************************************/ typedef encrypted-data-cms {
/* Typedefs for ASN.1 structures related to RFC 5652 */ type cms;
/*********************************************************/ description
"A CMS structure whose top-most content type MUST be the
encrypted-data content type, as described by Section 8
in RFC 5652.";
reference
"RFC 5652: Cryptographic Message Syntax (CMS)";
}
typedef authenticated-data-cms {
type cms;
description
"A CMS structure whose top-most content type MUST be the
authenticated-data content type, as described by Section 9
in RFC 5652.";
reference
"RFC 5652: Cryptographic Message Syntax (CMS)";
}
typedef trust-anchor-cert-cms { /***************************************************/
type signed-data-cms; /* Typedefs for structures related to RFC 4253 */
description /***************************************************/
"A CMS SignedData structure that MUST contain the chain of
X.509 certificates needed to authenticate the certificate
presented by a client or end-entity.
The CMS MUST contain only a single chain of certificates. typedef ssh-host-key {
The client or end-entity certificate MUST only authenticate type binary;
to last intermediate CA certificate listed in the chain. description
"The binary public key data for this SSH key, as
specified by RFC 4253, Section 6.6, i.e.:
In all cases, the chain MUST include a self-signed root string certificate or public key format
certificate. In the case where the root certificate is identifier
itself the issuer of the client or end-entity certificate, byte[n] key/certificate data.";
only one certificate is present. reference
"RFC 4253: The Secure Shell (SSH) Transport Layer
Protocol";
}
This CMS structure MAY (as applicable where this type is /*********************************************************/
used) also contain suitably fresh (as defined by local /* Typedefs for ASN.1 structures related to RFC 5280 */
policy) revocation objects with which the device can /*********************************************************/
verify the revocation status of the certificates.
This CMS encodes the degenerate form of the SignedData typedef trust-anchor-cert-x509 {
structure that is commonly used to disseminate X.509 type x509;
certificates and revocation objects (RFC 5280)."; description
reference "A Certificate structure that MUST encode a self-signed
"RFC 5280: root certificate.";
Internet X.509 Public Key Infrastructure Certificate }
and Certificate Revocation List (CRL) Profile.";
}
typedef end-entity-cert-cms { typedef end-entity-cert-x509 {
type signed-data-cms; type x509;
description description
"A CMS SignedData structure that MUST contain the end "A Certificate structure that MUST encode a certificate
entity certificate itself, and MAY contain any number that is neither self-signed nor having Basic constraint
of intermediate certificates leading up to a trust CA true.";
anchor certificate. The trust anchor certificate }
MAY be included as well.
The CMS MUST contain a single end entity certificate. /*********************************************************/
The CMS MUST NOT contain any spurious certificates. /* Typedefs for ASN.1 structures related to RFC 5652 */
/*********************************************************/
This CMS structure MAY (as applicable where this type is typedef trust-anchor-cert-cms {
used) also contain suitably fresh (as defined by local type signed-data-cms;
policy) revocation objects with which the device can description
verify the revocation status of the certificates. "A CMS SignedData structure that MUST contain the chain of
X.509 certificates needed to authenticate the certificate
presented by a client or end-entity.
This CMS encodes the degenerate form of the SignedData The CMS MUST contain only a single chain of certificates.
structure that is commonly used to disseminate X.509 The client or end-entity certificate MUST only authenticate
certificates and revocation objects (RFC 5280)."; to last intermediate CA certificate listed in the chain.
reference
"RFC 5280:
Internet X.509 Public Key Infrastructure Certificate
and Certificate Revocation List (CRL) Profile.";
}
/**********************************************/ In all cases, the chain MUST include a self-signed root
/* Groupings for keys and/or certificates */ certificate. In the case where the root certificate is
/**********************************************/ itself the issuer of the client or end-entity certificate,
only one certificate is present.
grouping public-key-grouping { This CMS structure MAY (as applicable where this type is
description used) also contain suitably fresh (as defined by local
"A public key. policy) revocation objects with which the device can
verify the revocation status of the certificates.
The 'algorithm' and 'public-key' nodes are not This CMS encodes the degenerate form of the SignedData
mandatory because they MAY be defined in <operational>. structure that is commonly used to disseminate X.509
Implementations SHOULD assert that these values are certificates and revocation objects (RFC 5280).";
either configured or that they exist in <operational>."; reference
leaf algorithm { "RFC 5280:
nacm:default-deny-write; Internet X.509 Public Key Infrastructure Certificate
type asymmetric-key-algorithm-ref; and Certificate Revocation List (CRL) Profile.";
must '../public-key'; }
description
"Identifies the key's algorithm. More specifically,
this leaf specifies how the 'public-key' binary leaf
is encoded.";
reference
"RFC CCCC: Common YANG Data Types for Cryptography";
}
leaf public-key {
nacm:default-deny-write;
type binary;
must '../algorithm';
description
"A binary that contains the value of the public key. The
interpretation of the content is defined by the key
algorithm. For example, a DSA key is an integer, an RSA
key is represented as RSAPublicKey as defined in
RFC 8017, and an Elliptic Curve Cryptography (ECC) key
is represented using the 'publicKey' described in
RFC 5915.";
reference
"RFC 8017: Public-Key Cryptography Standards (PKCS) #1:
RSA Cryptography Specifications Version 2.2.
RFC 5915: Elliptic Curve Private Key Structure.";
}
}
grouping asymmetric-key-pair-grouping { typedef end-entity-cert-cms {
description type signed-data-cms;
"A private/public key pair. description
"A CMS SignedData structure that MUST contain the end
entity certificate itself, and MAY contain any number
of intermediate certificates leading up to a trust
anchor certificate. The trust anchor certificate
MAY be included as well.
The 'algorithm', 'public-key', and 'private-key' nodes are The CMS MUST contain a single end entity certificate.
not mandatory because they MAY be defined in <operational>. The CMS MUST NOT contain any spurious certificates.
Implementations SHOULD assert that these values are either
configured or that they exist in <operational>.";
uses public-key-grouping;
leaf private-key {
nacm:default-deny-all;
type union {
type binary;
type enumeration {
enum permanently-hidden {
description
"The private key is inaccessible due to being
protected by the system (e.g., a cryptographic
hardware module).
How such keys are backed-up and restored, if This CMS structure MAY (as applicable where this type is
at all, is implementation specific. used) also contain suitably fresh (as defined by local
policy) revocation objects with which the device can
verify the revocation status of the certificates.
Servers MUST fail any attempt by a client to This CMS encodes the degenerate form of the SignedData
configure this value directly. This value is structure that is commonly used to disseminate X.509
not set by clients, but rather is set by the certificates and revocation objects (RFC 5280).";
'generate-hidden-key' and 'install-hidden-key' reference
actions."; "RFC 5280:
} Internet X.509 Public Key Infrastructure Certificate
} and Certificate Revocation List (CRL) Profile.";
} }
must '../public-key';
description
"A binary that contains the value of the private key. The
interpretation of the content is defined by the key
algorithm. For example, a DSA key is an integer, an RSA
key is represented as RSAPrivateKey as defined in
RFC 8017, and an Elliptic Curve Cryptography (ECC) key
is represented as ECPrivateKey as defined in RFC 5915.";
reference
"RFC 8017: Public-Key Cryptography Standards (PKCS) #1:
RSA Cryptography Specifications Version 2.2.
RFC 5915: Elliptic Curve Private Key Structure.";
} // private-key
action generate-hidden-key { /**********************************************/
nacm:default-deny-all; /* Groupings for keys and/or certificates */
description /**********************************************/
"Requests the device to generate a hidden key using the
specified asymmetric key algorithm. This action is
used to request the system to generate a key that is
'permanently-hidden', perhaps protected by a cryptographic
hardware module. The resulting asymmetric key values are
considered operational state and hence present only in
<operational> and bound to the lifetime of the parent
'config true' node. Subsequent invocations of this or
the 'install-hidden-key' action are denied with error-tag
'data-exists'.";
input {
leaf algorithm {
type asymmetric-key-algorithm-ref;
mandatory true;
description
"The algorithm to be used when generating the
asymmetric key.";
reference
"RFC CCCC: Common YANG Data Types for Cryptography";
}
}
} // generate-hidden-key
action install-hidden-key { grouping public-key-grouping {
nacm:default-deny-all; description
description "A public key and its associated algorithm.";
"Requests the device to load the specified values into leaf algorithm {
a hidden key. The resulting asymmetric key values are nacm:default-deny-write;
considered operational state and hence present only in type asymmetric-key-algorithm-ref;
<operational> and bound to the lifetime of the parent mandatory true;
'config true' node. Subsequent invocations of this description
or the 'generate-hidden-key' action are denied with "Identifies the key's algorithm.";
error-tag 'data-exists'."; reference
input { "RFC CCCC: Common YANG Data Types for Cryptography";
leaf algorithm { }
type asymmetric-key-algorithm-ref; leaf public-key {
mandatory true; nacm:default-deny-write;
description type binary;
"The algorithm to be used when generating the mandatory true;
asymmetric key."; description
reference "The binary value of the public key. The interpretation of
"RFC CCCC: Common YANG Data Types for Cryptography"; the value is defined by 'algorithm'. For example, a DSA
} key is an integer, an RSA key is represented as RSAPublicKey
leaf public-key { per RFC 8017, and an ECC key is represented using the
type binary; 'publicKey' described in RFC 5915.";
description reference
"A binary that contains the value of the public key. "RFC 8017: Public-Key Cryptography Standards (PKCS) #1:
The interpretation of the content is defined by the key RSA Cryptography Specifications Version 2.2.
algorithm. For example, a DSA key is an integer, an RFC 5915: Elliptic Curve Private Key Structure.";
RSA key is represented as RSAPublicKey as defined in }
RFC 8017, and an Elliptic Curve Cryptography (ECC) key }
is represented using the 'publicKey' described in
RFC 5915.";
reference
"RFC 8017: Public-Key Cryptography Standards (PKCS) #1:
RSA Cryptography Specifications Version 2.2.
RFC 5915: Elliptic Curve Private Key Structure.";
}
leaf private-key {
type binary;
description
"A binary that contains the value of the private key.
The interpretation of the content is defined by the key
algorithm. For example, a DSA key is an integer, an RSA
key is represented as RSAPrivateKey as defined in
RFC 8017, and an Elliptic Curve Cryptography (ECC) key
is represented as ECPrivateKey as defined in RFC 5915.";
reference
"RFC 8017: Public-Key Cryptography Standards (PKCS) #1:
RSA Cryptography Specifications Version 2.2.
RFC 5915: Elliptic Curve Private Key Structure.";
}
}
} // install-hidden-key
} // asymmetric-key-pair-grouping
grouping trust-anchor-cert-grouping { grouping asymmetric-key-pair-grouping {
description description
"A trust anchor certificate, and a notification for when "A private key and its associated public key and algorithm.";
it is about to (or already has) expire."; uses public-key-grouping;
leaf cert { leaf private-key {
nacm:default-deny-write; nacm:default-deny-all;
type trust-anchor-cert-cms; type union {
description type binary;
"The binary certificate data for this certificate."; type string {
reference pattern
"RFC YYYY: Common YANG Data Types for Cryptography"; 'permanently-hidden'
} + '|encrypted-by:.*:[A-Za-z0-9+/]+[=]{1,3}'
notification certificate-expiration { + '|value-to-be-generated(-and-hidden)?'
description + '|value-to-be-hidden:[A-Za-z0-9+/]+[=]{1,3}';
"A notification indicating that the configured certificate }
is either about to expire or has already expired. When to }
send notifications is an implementation specific decision, mandatory true;
but it is RECOMMENDED that a notification be sent once a description
month for 3 months, then once a week for four weeks, and "Either the binary value of the private key or a value
then once a day thereafter until the issue is resolved."; indentifing special input and output values described
leaf expiration-date { below. The key's value is interpreted by the 'algorithm'.
type yang:date-and-time; For example, a DSA key is an integer, an RSA key is
mandatory true; represented as RSAPrivateKey as defined in RFC 8017, and
description an ECC key is represented as ECPrivateKey as defined in
"Identifies the expiration date on the certificate."; RFC 5915.
}
}
}
grouping trust-anchor-certs-grouping { Special input and output values:
description
"A list of trust anchor certificates, and a notification
for when one is about to (or already has) expire.";
leaf-list cert {
nacm:default-deny-write;
type trust-anchor-cert-cms;
description
"The binary certificate data for this certificate.";
reference
"RFC YYYY: Common YANG Data Types for Cryptography";
}
notification certificate-expiration {
description
"A notification indicating that the configured certificate
is either about to expire or has already expired. When to
send notifications is an implementation specific decision,
but it is RECOMMENDED that a notification be sent once a
month for 3 months, then once a week for four weeks, and
then once a day thereafter until the issue is resolved.";
leaf expiration-date {
type yang:date-and-time;
mandatory true;
description
"Identifies the expiration date on the certificate.";
}
}
}
grouping end-entity-cert-grouping { permanently-hidden
description
"An end entity certificate, and a notification for when
it is about to (or already has) expire.";
leaf cert {
nacm:default-deny-write;
type end-entity-cert-cms;
description
"The binary certificate data for this certificate.";
reference
"RFC YYYY: Common YANG Data Types for Cryptography";
}
notification certificate-expiration {
description
"A notification indicating that the configured certificate
is either about to expire or has already expired. When to
send notifications is an implementation specific decision,
but it is RECOMMENDED that a notification be sent once a
month for 3 months, then once a week for four weeks, and
then once a day thereafter until the issue is resolved.";
leaf expiration-date {
type yang:date-and-time;
mandatory true;
description
"Identifies the expiration date on the certificate.";
}
}
}
grouping end-entity-certs-grouping { Primarily an output value indicating that the private
description key value is not available in any form. The only time
"A list of end entity certificates, and a notification for this value MAY be used as a input value is when it is
when one is about to (or already has) expire."; being used to copy a manufacturer-generated value from
leaf-list cert { <operational> to <running>.
nacm:default-deny-write;
type end-entity-cert-cms;
description
"The binary certificate data for this certificate.";
reference
"RFC YYYY: Common YANG Data Types for Cryptography";
}
notification certificate-expiration {
description
"A notification indicating that the configured certificate
is either about to expire or has already expired. When to
send notifications is an implementation specific decision,
but it is RECOMMENDED that a notification be sent once a
month for 3 months, then once a week for four weeks, and
then once a day thereafter until the issue is resolved.";
leaf expiration-date {
type yang:date-and-time;
mandatory true;
description
"Identifies the expiration date on the certificate.";
}
}
}
grouping asymmetric-key-pair-with-cert-grouping { encrypted-by:*:[A-Za-z0-9+/]+[=]{1,3}
description
"A private/public key pair and an associated certificate.";
uses asymmetric-key-pair-grouping; Primarily an output value indicating that the private
uses end-entity-cert-grouping; key is encrypted using another key, identified by the
'by' attribute. The only time this value MAY be used
as a input value is when it is being used to copy a
manufacturer-generated value from <operational> to
<running>. Following the prefix is the base64-encoded
value of the encrypted private key.
action generate-certificate-signing-request { value-to-be-generated(-and-hidden)?
nacm:default-deny-all;
description
"Generates a certificate signing request structure for
the associated asymmetric key using the passed subject
and attribute values. The specified assertions need
to be appropriate for the certificate's use. For
example, an entity certificate for a TLS server
SHOULD have values that enable clients to satisfy
RFC 6125 processing.";
input {
leaf subject {
type binary;
mandatory true;
description
"The 'subject' field per the CertificationRequestInfo
structure as specified by RFC 2986, Section 4.1
encoded using the ASN.1 distinguished encoding
rules (DER), as specified in ITU-T X.690.";
reference
"RFC 2986:
PKCS #10: Certification Request Syntax
Specification Version 1.7.
ITU-T X.690:
Information technology - ASN.1 encoding rules:
Specification of Basic Encoding Rules (BER),
Canonical Encoding Rules (CER) and Distinguished
Encoding Rules (DER).";
}
leaf attributes {
type binary;
description
"The 'attributes' field from the structure
CertificationRequestInfo as specified by RFC 2986,
Section 4.1 encoded using the ASN.1 distinguished
encoding rules (DER), as specified in ITU-T X.690.";
reference
"RFC 2986:
PKCS #10: Certification Request Syntax
Specification Version 1.7.
ITU-T X.690:
Information technology - ASN.1 encoding rules:
Specification of Basic Encoding Rules (BER),
Canonical Encoding Rules (CER) and Distinguished
Encoding Rules (DER).";
} An input value used to request the system to generate,
} and optionally hide, the public/private key pair. When
output { used, the 'public-key' value MUST be empty (zero bytes).
leaf certificate-signing-request {
type binary;
mandatory true;
description
"A CertificationRequest structure as specified by
RFC 2986, Section 4.2 encoded using the ASN.1
distinguished encoding rules (DER), as specified
in ITU-T X.690.";
reference
"RFC 2986:
PKCS #10: Certification Request Syntax
Specification Version 1.7.
ITU-T X.690:
Information technology - ASN.1 encoding rules:
Specification of Basic Encoding Rules (BER),
Canonical Encoding Rules (CER) and Distinguished
Encoding Rules (DER).";
}
}
} // generate-certificate-signing-request
} // asymmetric-key-pair-with-cert-grouping
grouping asymmetric-key-pair-with-certs-grouping { Without the optional '-and-hidden' postfix, the generated
description key pair is stored in the configuration data store as if
"A private/public key pair and associated certificates."; the values had been configured by the client.
uses asymmetric-key-pair-grouping;
container certificates {
nacm:default-deny-write;
description
"Certificates associated with this asymmetric key.
More than one certificate supports, for instance,
a TPM-protected asymmetric key that has both IDevID
and LDevID certificates associated.";
list certificate {
key "name";
description
"A certificate for this asymmetric key.";
leaf name {
type string;
description
"An arbitrary name for the certificate. If the name
matches the name of a certificate that exists
independently in <operational> (i.e., an IDevID),
then the 'cert' node MUST NOT be configured.";
} With the optional '-and-hidden' postfix, the generated
uses end-entity-cert-grouping; key pair is 'hidden' and thereafter be reported using
} either 'permanently-hidden' or 'encrypted-by:*:'.
} // certificates
action generate-certificate-signing-request { The server's support for 'value-to-be-generated' input
nacm:default-deny-all; value is known by the 'generate-key' feature, and the
description server's support for 'value-to-be-generated-and-hidden'
"Generates a certificate signing request structure for value is known by the combination of both the 'generate-
the associated asymmetric key using the passed subject key' and 'hidden-key' features.
and attribute values. The specified assertions need
to be appropriate for the certificate's use. For
example, an entity certificate for a TLS server
SHOULD have values that enable clients to satisfy
RFC 6125 processing.";
input {
leaf subject {
type binary;
mandatory true;
description
"The 'subject' field per the CertificationRequestInfo
structure as specified by RFC 2986, Section 4.1
encoded using the ASN.1 distinguished encoding
rules (DER), as specified in ITU-T X.690.";
reference
"RFC 2986:
PKCS #10: Certification Request Syntax
Specification Version 1.7.
ITU-T X.690:
Information technology - ASN.1 encoding rules:
Specification of Basic Encoding Rules (BER),
Canonical Encoding Rules (CER) and Distinguished
Encoding Rules (DER).";
}
leaf attributes {
type binary;
description
"The 'attributes' field from the structure
CertificationRequestInfo as specified by RFC 2986,
Section 4.1 encoded using the ASN.1 distinguished
encoding rules (DER), as specified in ITU-T X.690.";
reference
"RFC 2986:
PKCS #10: Certification Request Syntax
Specification Version 1.7.
ITU-T X.690:
Information technology - ASN.1 encoding rules:
Specification of Basic Encoding Rules (BER),
Canonical Encoding Rules (CER) and Distinguished
Encoding Rules (DER).";
}
}
output {
leaf certificate-signing-request {
type binary;
mandatory true;
description
"A CertificationRequest structure as specified by
RFC 2986, Section 4.2 encoded using the ASN.1
distinguished encoding rules (DER), as specified
in ITU-T X.690.";
reference
"RFC 2986:
PKCS #10: Certification Request Syntax
Specification Version 1.7.
ITU-T X.690:
Information technology - ASN.1 encoding rules:
Specification of Basic Encoding Rules (BER),
Canonical Encoding Rules (CER) and Distinguished
Encoding Rules (DER).";
}
}
} // generate-certificate-signing-request
} // asymmetric-key-pair-with-certs-grouping
}
<CODE ENDS> value-to-be-hidden:[A-Za-z0-9+/]+[=]{1,3}
3. Security Considerations An input value used to request the system to store the
provided private key such that it will thereafter be
reported using either as 'permanently-hidden' or
'encrypted-by:*:'. Following the prefix is the
base64-encoded value of the private key.
The server's support for 'value-to-be-hidden' input
value is known by the 'hidden-key' feature.";
reference
"RFC 8017: Public-Key Cryptography Standards (PKCS) #1:
RSA Cryptography Specifications Version 2.2.
RFC 5915: Elliptic Curve Private Key Structure.";
}
}
grouping trust-anchor-cert-grouping {
description
"A trust anchor certificate, and a notification for when
it is about to (or already has) expire.";
leaf cert {
nacm:default-deny-write;
type trust-anchor-cert-cms;
description
"The binary certificate data for this certificate.";
reference
"RFC YYYY: Common YANG Data Types for Cryptography";
}
notification certificate-expiration {
description
"A notification indicating that the configured certificate
is either about to expire or has already expired. When to
send notifications is an implementation specific decision,
but it is RECOMMENDED that a notification be sent once a
month for 3 months, then once a week for four weeks, and
then once a day thereafter until the issue is resolved.";
leaf expiration-date {
type yang:date-and-time;
mandatory true;
description
"Identifies the expiration date on the certificate.";
}
}
}
grouping trust-anchor-certs-grouping {
description
"A list of trust anchor certificates, and a notification
for when one is about to (or already has) expire.";
leaf-list cert {
nacm:default-deny-write;
type trust-anchor-cert-cms;
description
"The binary certificate data for this certificate.";
reference
"RFC YYYY: Common YANG Data Types for Cryptography";
}
notification certificate-expiration {
description
"A notification indicating that the configured certificate
is either about to expire or has already expired. When to
send notifications is an implementation specific decision,
but it is RECOMMENDED that a notification be sent once a
month for 3 months, then once a week for four weeks, and
then once a day thereafter until the issue is resolved.";
leaf expiration-date {
type yang:date-and-time;
mandatory true;
description
"Identifies the expiration date on the certificate.";
}
}
}
grouping end-entity-cert-grouping {
description
"An end entity certificate, and a notification for when
it is about to (or already has) expire. Implementations
SHOULD assert that, where used, the end entity certificate
contains the expected public key.";
leaf cert {
nacm:default-deny-write;
type end-entity-cert-cms;
description
"The binary certificate data for this certificate.";
reference
"RFC YYYY: Common YANG Data Types for Cryptography";
}
notification certificate-expiration {
description
"A notification indicating that the configured certificate
is either about to expire or has already expired. When to
send notifications is an implementation specific decision,
but it is RECOMMENDED that a notification be sent once a
month for 3 months, then once a week for four weeks, and
then once a day thereafter until the issue is resolved.";
leaf expiration-date {
type yang:date-and-time;
mandatory true;
description
"Identifies the expiration date on the certificate.";
}
}
}
grouping end-entity-certs-grouping {
description
"A list of end entity certificates, and a notification for
when one is about to (or already has) expire.";
leaf-list cert {
nacm:default-deny-write;
type end-entity-cert-cms;
description
"The binary certificate data for this certificate.";
reference
"RFC YYYY: Common YANG Data Types for Cryptography";
}
notification certificate-expiration {
description
"A notification indicating that the configured certificate
is either about to expire or has already expired. When to
send notifications is an implementation specific decision,
but it is RECOMMENDED that a notification be sent once a
month for 3 months, then once a week for four weeks, and
then once a day thereafter until the issue is resolved.";
leaf expiration-date {
type yang:date-and-time;
mandatory true;
description
"Identifies the expiration date on the certificate.";
}
}
}
grouping asymmetric-key-pair-with-cert-grouping {
description
"A private/public key pair and an associated certificate.
Implementations SHOULD assert that certificates contain
the matching public key.";
uses asymmetric-key-pair-grouping;
uses end-entity-cert-grouping;
action generate-certificate-signing-request {
nacm:default-deny-all;
description
"Generates a certificate signing request structure for
the associated asymmetric key using the passed subject
and attribute values. The specified assertions need
to be appropriate for the certificate's use. For
example, an entity certificate for a TLS server
SHOULD have values that enable clients to satisfy
RFC 6125 processing.";
input {
leaf subject {
type binary;
mandatory true;
description
"The 'subject' field per the CertificationRequestInfo
structure as specified by RFC 2986, Section 4.1
encoded using the ASN.1 distinguished encoding
rules (DER), as specified in ITU-T X.690.";
reference
"RFC 2986:
PKCS #10: Certification Request Syntax
Specification Version 1.7.
ITU-T X.690:
Information technology - ASN.1 encoding rules:
Specification of Basic Encoding Rules (BER),
Canonical Encoding Rules (CER) and Distinguished
Encoding Rules (DER).";
}
leaf attributes {
type binary; // FIXME: does this need to be mandatory?
description
"The 'attributes' field from the structure
CertificationRequestInfo as specified by RFC 2986,
Section 4.1 encoded using the ASN.1 distinguished
encoding rules (DER), as specified in ITU-T X.690.";
reference
"RFC 2986:
PKCS #10: Certification Request Syntax
Specification Version 1.7.
ITU-T X.690:
Information technology - ASN.1 encoding rules:
Specification of Basic Encoding Rules (BER),
Canonical Encoding Rules (CER) and Distinguished
Encoding Rules (DER).";
}
}
output {
leaf certificate-signing-request {
type binary;
mandatory true;
description
"A CertificationRequest structure as specified by
RFC 2986, Section 4.2 encoded using the ASN.1
distinguished encoding rules (DER), as specified
in ITU-T X.690.";
reference
"RFC 2986:
PKCS #10: Certification Request Syntax
Specification Version 1.7.
ITU-T X.690:
Information technology - ASN.1 encoding rules:
Specification of Basic Encoding Rules (BER),
Canonical Encoding Rules (CER) and Distinguished
Encoding Rules (DER).";
}
}
} // generate-certificate-signing-request
} // asymmetric-key-pair-with-cert-grouping
grouping asymmetric-key-pair-with-certs-grouping {
description
"A private/public key pair and associated certificates.
Implementations SHOULD assert that certificates contain
the matching public key.";
uses asymmetric-key-pair-grouping;
container certificates {
nacm:default-deny-write;
description
"Certificates associated with this asymmetric key.
More than one certificate supports, for instance,
a TPM-protected asymmetric key that has both IDevID
and LDevID certificates associated.";
list certificate {
key "name";
description
"A certificate for this asymmetric key.";
leaf name {
type string;
description
"An arbitrary name for the certificate. If the name
matches the name of a certificate that exists
independently in <operational> (i.e., an IDevID),
then the 'cert' node MUST NOT be configured.";
}
uses end-entity-cert-grouping;
}
} // certificates
action generate-certificate-signing-request {
nacm:default-deny-all;
description
"Generates a certificate signing request structure for
the associated asymmetric key using the passed subject
and attribute values. The specified assertions need
to be appropriate for the certificate's use. For
example, an entity certificate for a TLS server
SHOULD have values that enable clients to satisfy
RFC 6125 processing.";
input {
leaf subject {
type binary;
mandatory true;
description
"The 'subject' field per the CertificationRequestInfo
structure as specified by RFC 2986, Section 4.1
encoded using the ASN.1 distinguished encoding
rules (DER), as specified in ITU-T X.690.";
reference
"RFC 2986:
PKCS #10: Certification Request Syntax
Specification Version 1.7.
ITU-T X.690:
Information technology - ASN.1 encoding rules:
Specification of Basic Encoding Rules (BER),
Canonical Encoding Rules (CER) and Distinguished
Encoding Rules (DER).";
}
leaf attributes {
type binary; // FIXME: does this need to be mandatory?
description
"The 'attributes' field from the structure
CertificationRequestInfo as specified by RFC 2986,
Section 4.1 encoded using the ASN.1 distinguished
encoding rules (DER), as specified in ITU-T X.690.";
reference
"RFC 2986:
PKCS #10: Certification Request Syntax
Specification Version 1.7.
ITU-T X.690:
Information technology - ASN.1 encoding rules:
Specification of Basic Encoding Rules (BER),
Canonical Encoding Rules (CER) and Distinguished
Encoding Rules (DER).";
}
}
output {
leaf certificate-signing-request {
type binary;
mandatory true;
description
"A CertificationRequest structure as specified by
RFC 2986, Section 4.2 encoded using the ASN.1
distinguished encoding rules (DER), as specified
in ITU-T X.690.";
reference
"RFC 2986:
PKCS #10: Certification Request Syntax
Specification Version 1.7.
ITU-T X.690:
Information technology - ASN.1 encoding rules:
Specification of Basic Encoding Rules (BER),
Canonical Encoding Rules (CER) and Distinguished
Encoding Rules (DER).";
}
}
} // generate-certificate-signing-request
} // asymmetric-key-pair-with-certs-grouping
}
<CODE ENDS>
3. Security Considerations
3.1. Support for Algorithms 3.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
skipping to change at page 52, line 7 skipping to change at page 52, line 5
} }
uses ct:asymmetric-key-pair-with-certs-grouping; uses ct:asymmetric-key-pair-with-certs-grouping;
description description
"An asymmetric key pair with associated certificates."; "An asymmetric key pair with associated certificates.";
} }
} }
} }
Given the above example usage module, the following example Given the above example usage module, the following example
illustrates some configured keys. illustrates some configured keys.
<keys xmlns="http://example.com/ns/example-crypto-types-usage"> <keys xmlns="http://example.com/ns/example-crypto-types-usage">
<key> <key>
<name>ex-key</name> <name>ex-key</name>
<algorithm <algorithm
xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types"> xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types">
ct:rsa2048 ct:rsa2048
</algorithm> </algorithm>
<private-key>base64encodedvalue==</private-key> <public-key>base64encodedvalue==</public-key>
<public-key>base64encodedvalue==</public-key> <private-key>base64encodedvalue==</private-key>
<certificates> <certificates>
<certificate> <certificate>
<name>ex-cert</name> <name>ex-cert</name>
<cert>base64encodedvalue==</cert> <cert>base64encodedvalue==</cert>
</certificate> </certificate>
</certificates> </certificates>
</key> </key>
</keys> <key>
<name>ex-hidden-key</name>
A.2. The "generate-hidden-key" Action <algorithm
xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types">
The following example illustrates the "generate-hidden-key" action in ct:rsa2048
use with the NETCONF protocol. </algorithm>
<public-key>base64encodedvalue==</public-key>
REQUEST <private-key>permanently-hidden</private-key>
<certificates>
<rpc message-id="101" <certificate>
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <name>ex-hidden-key-cert</name>
<action xmlns="urn:ietf:params:xml:ns:yang:1"> <cert>base64encodedvalue==</cert>
<keys xmlns="http://example.com/ns/example-crypto-types-usage"> </certificate>
<key> </certificates>
<name>empty-key</name> </key>
<generate-hidden-key> <key>
<algorithm <name>ex-encrypted-key</name>
xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types"> <algorithm
ct:rsa2048 xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types">
</algorithm> ct:rsa2048
</generate-hidden-key> </algorithm>
</key> <public-key>base64encodedvalue==</public-key>
</keys> <private-key>encrypted-by:ex-key:base64encodedvalue==</private-key>
</action> <certificates>
</rpc> <certificate>
RESPONSE <name>ex-encrypted-key-cert</name>
<cert>base64encodedvalue==</cert>
<rpc-reply message-id="101" </certificate>
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> </certificates>
<ok/> </key>
</rpc-reply> </keys>
A.3. The "install-hidden-key" Action
The following example illustrates the "install-hidden-key" action in
use 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">
<keys xmlns="http://example.com/ns/example-crypto-types-usage">
<key>
<name>empty-key</name>
<install-hidden-key>
<algorithm
xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types">
ct:rsa2048
</algorithm>
<public-key>base64encodedvalue==</public-key>
<private-key>base64encodedvalue==</private-key>
</install-hidden-key>
</key>
</keys>
</action>
</rpc>
RESPONSE
<rpc-reply message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<ok/>
</rpc-reply>
A.4. The "generate-certificate-signing-request" Action A.2. The "generate-certificate-signing-request" Action
The following example illustrates the "generate-certificate-signing- The following example illustrates the "generate-certificate-signing-
request" action in use with the NETCONF protocol. request" action in use with the NETCONF protocol.
REQUEST REQUEST
<rpc message-id="101" <rpc message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<action xmlns="urn:ietf:params:xml:ns:yang:1"> <action xmlns="urn:ietf:params:xml:ns:yang:1">
<keys xmlns="http://example.com/ns/example-crypto-types-usage"> <keys xmlns="http://example.com/ns/example-crypto-types-usage">
skipping to change at page 54, line 32 skipping to change at page 53, line 37
RESPONSE RESPONSE
<rpc-reply message-id="101" <rpc-reply message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<certificate-signing-request <certificate-signing-request
xmlns="http://example.com/ns/example-crypto-types-usage"> xmlns="http://example.com/ns/example-crypto-types-usage">
base64encodedvalue== base64encodedvalue==
</certificate-signing-request> </certificate-signing-request>
</rpc-reply> </rpc-reply>
A.5. The "certificate-expiration" Notification A.3. The "certificate-expiration" Notification
The following example illustrates the "certificate-expiration" The following example illustrates the "certificate-expiration"
notification in use with the NETCONF protocol. notification in use with the NETCONF protocol.
<notification <notification
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2018-05-25T00:01:00Z</eventTime> <eventTime>2018-05-25T00:01:00Z</eventTime>
<keys xmlns="http://example.com/ns/example-crypto-types-usage"> <keys xmlns="http://example.com/ns/example-crypto-types-usage">
<key> <key>
<name>locally-defined key</name> <name>locally-defined key</name>
skipping to change at page 57, line 43 skipping to change at page 56, line 43
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
o Added clarifications that implementations SHOULD assert that
configured certificates contain the matching public key.
o Replaced the 'generate-hidden-key' and 'install-hidden-key'
actions with special 'crypt-hash' -like input/output values.
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,
Balazs Kovacs, Juergen Schoenwaelder, Eric Voit, and Liang Xia. Nick Hancock, Balazs Kovacs, Juergen Schoenwaelder, Eric Voit, and
Liang Xia.
Authors' Addresses Authors' Addresses
Kent Watsen Kent Watsen
Watsen Networks Watsen Networks
EMail: kent+ietf@watsen.net EMail: kent+ietf@watsen.net
Wang Haiguang Wang Haiguang
Huawei Huawei
 End of changes. 193 change blocks. 
1770 lines changed or deleted 1708 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/