| NETCONF Working Group | K. Watsen |
| Internet-Draft | Watsen Networks |
| Intended status: Standards Track | H. Wang |
| Expires: May 23, 2020 | Huawei |
| November 20, 2019 |
Common YANG Data Types for Cryptography
draft-ietf-netconf-crypto-types-13
This document defines four YANG modules for types useful to cryptographic applications. The modules defined include:
This draft contains many placeholder values that need to be replaced with finalized values at the time of publication. This note summarizes all of the substitutions that are needed. No other RFC Editor instructions are specified elsewhere in this document.
Artwork in this document contains shorthand references to drafts in progress. Please apply the following replacements:
Artwork in this document contains placeholder values for the date of publication of this draft. Please apply the following replacement:
The following Appendix section is to be removed prior to publication:
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."
This Internet-Draft will expire on May 23, 2020.
Copyright (c) 2019 IETF Trust and the persons identified as the document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
This document defines four YANG 1.1 [RFC7950] modules for types useful to cryptographic applications. The modules defined include:
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.
This section provides a tree diagram [RFC8340] for the "ietf-crypto-types" module. Only "grouping" statements are represented, as tree diagrams have no means to represent identities or typedefs.
module: ietf-crypto-types
grouping symmetric-key-grouping
+-- algorithm isa:symmetric-algorithm-type
+-- key-format? identityref
+-- (key-type)
+--:(key)
| +-- key? binary
+--:(hidden-key)
+-- hidden-key? empty
grouping public-key-grouping
+-- algorithm iasa:asymmetric-algorithm-type
+-- public-key-format? identityref
+-- public-key binary
grouping asymmetric-key-pair-grouping
+-- algorithm iasa:asymmetric-algorithm-type
+-- public-key-format? identityref
+-- public-key binary
+-- private-key-format? identityref
+-- (private-key-type)
+--:(private-key)
| +-- private-key? binary
+--:(hidden-private-key)
+-- hidden-private-key? empty
grouping trust-anchor-cert-grouping
+-- cert? trust-anchor-cert-cms
+---n certificate-expiration
+-- expiration-date yang:date-and-time
grouping trust-anchor-certs-grouping
+-- cert* trust-anchor-cert-cms
+---n certificate-expiration
+-- expiration-date yang:date-and-time
grouping end-entity-cert-grouping
+-- cert? end-entity-cert-cms
+---n certificate-expiration
+-- expiration-date yang:date-and-time
grouping end-entity-certs-grouping
+-- cert* end-entity-cert-cms
+---n certificate-expiration
+-- expiration-date yang:date-and-time
grouping asymmetric-key-pair-with-cert-grouping
+-- algorithm
| iasa:asymmetric-algorithm-type
+-- public-key-format? identityref
+-- public-key binary
+-- private-key-format? identityref
+-- (private-key-type)
| +--:(private-key)
| | +-- private-key? binary
| +--:(hidden-private-key)
| +-- hidden-private-key? empty
+-- cert? end-entity-cert-cms
+---n certificate-expiration
| +-- expiration-date yang:date-and-time
+---x generate-certificate-signing-request
+---w input
| +---w subject binary
| +---w attributes? binary
+--ro output
+--ro certificate-signing-request binary
grouping asymmetric-key-pair-with-certs-grouping
+-- algorithm
| iasa:asymmetric-algorithm-type
+-- public-key-format? identityref
+-- public-key binary
+-- private-key-format? identityref
+-- (private-key-type)
| +--:(private-key)
| | +-- private-key? binary
| +--:(hidden-private-key)
| +-- hidden-private-key? empty
+-- certificates
| +-- certificate* [name]
| +-- name? string
| +-- cert? end-entity-cert-cms
| +---n certificate-expiration
| +-- expiration-date yang:date-and-time
+---x generate-certificate-signing-request
+---w input
| +---w subject binary
| +---w attributes? binary
+--ro output
+--ro certificate-signing-request binary
This module has normative references to [RFC2404], [RFC3565], [RFC3686], [RFC4106], [RFC4253], [RFC4279], [RFC4309], [RFC4494], [RFC4543], [RFC4868], [RFC5280], [RFC5652], [RFC5656], [RFC6187], [RFC6991], [RFC7919], [RFC8268], [RFC8332], [RFC8341], [RFC8422], [RFC8446], and [ITU.X690.2015].
This module has an informational reference to [RFC2986], [RFC3174], [RFC4493], [RFC5915], [RFC6125], [RFC6234], [RFC6239], [RFC6507], [RFC8017], [RFC8032], [RFC8439].
<CODE BEGINS> file "ietf-crypto-types@2019-11-20.yang"
module ietf-crypto-types {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-crypto-types";
prefix ct;
import ietf-yang-types {
prefix yang;
reference
"RFC 6991: Common YANG Data Types";
}
import ietf-netconf-acm {
prefix nacm;
reference
"RFC 8341: Network Configuration Access Control Model";
}
//import iana-hash-algs {
// prefix iha;
// reference
// "RFC XXXX: Common YANG Data Types for Cryptography";
//}
import iana-symmetric-algs {
prefix isa;
reference
"RFC XXXX: Common YANG Data Types for Cryptography";
}
import iana-asymmetric-algs {
prefix iasa;
reference
"RFC XXXX: Common YANG Data Types for Cryptography";
}
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <http://datatracker.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org>
Author: Kent Watsen <mailto:kent+ietf@watsen.net>
Author: Wang Haiguang <wang.haiguang.shieldlab@huawei.com>";
description
"This module defines common YANG types for cryptographic
applications.
Copyright (c) 2019 IETF Trust and the persons identified
as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with
or without modification, is permitted pursuant to, and
subject to the license terms contained in, the Simplified
BSD License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC
itself for full legal notices.
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 (RFC 2119)
(RFC 8174) when, and only when, they appear in all
capitals, as shown here.";
revision 2019-11-20 {
description
"Initial version";
reference
"RFC XXXX: Common YANG Data Types for Cryptography";
}
/****************/
/* Features */
/****************/
feature "one-asymmetric-key-format" {
description
"Indicates that the server supports the
'one-asymmetric-key-format' identity.";
}
feature "one-symmetric-key-format" {
description
"Indicates that the server supports the
'one-symmetric-key-format' identity.";
}
feature "encrypted-one-symmetric-key-format" {
description
"Indicates that the server supports the
'encrypted-one-symmetric-key-format' identity.";
}
feature "encrypted-one-asymmetric-key-format" {
description
"Indicates that the server supports the
'encrypted-one-asymmetric-key-format' identity.";
}
/********************************************/
/* Identities for Key Format Structures */
/********************************************/
/*** base key formats ****/
identity key-format-base {
description "Base key-format identity for all keys.";
}
identity public-key-format {
base "key-format-base";
description "Base key-format identity for public keys.";
}
identity private-key-format {
base "key-format-base";
description "Base key-format identity for private keys.";
}
identity symmetric-key-format {
base "key-format-base";
description "Base key-format identity for symmetric keys.";
}
/**** for private keys ****/
identity rsa-private-key-format {
base "private-key-format";
description
"Indicates that the private key value is encoded
as an RSAPrivateKey (from RFC 3447).";
reference
"RFC 3447: PKCS #1: RSA Cryptography
Specifications Version 2.2";
}
identity ec-private-key-format {
base "private-key-format";
description
"Indicates that the private key value is encoded
as an ECPrivateKey (from RFC 5915)";
reference
"RFC 5915: Elliptic Curve Private Key Structure";
}
identity one-asymmetric-key-format {
if-feature "one-asymmetric-key-format";
base "private-key-format";
description
"Indicates that the private key value is encoded
as a OneAsymmetricKey structure (RFC 6031).";
// FIXME: DER encoded ASN.1, etc...or flex PEM?
reference
"RFC 5958: Asymmetric Key Packages";
}
identity encrypted-one-asymmetric-key-format {
if-feature "encrypted-one-asymmetric-key-format";
base "private-key-format";
description
"Indicates that the private key value is encoded
as a OneAsymmetricKey structure (RFC 5958).";
// FIXME: DER encoded ASN.1, etc...or flex PEM?
reference
"RFC 5652: Cryptographic Message Syntax (CMS)
RFC 5958: Asymmetric Key Packages";
}
/**** for public keys ****/
identity ssh-public-key-format {
base "public-key-format";
description
"Indicates that the public key value is encoded
an SSH public key, as described by RFC 4716.";
reference
"RFC 4716: The Secure Shell (SSH) Public Key
File Format";
}
identity subject-public-key-info-format {
base "public-key-format";
description
"Indicates that the public key value is encoded as
a SubjectPublicKeyInfo structure, as described in
RFC 5280.";
// FIXME: DER encoded ASN.1, etc...
reference
"RFC 5280:
Internet X.509 Public Key Infrastructure Certificate
and Certificate Revocation List (CRL) Profile";
}
/**** for symmetric keys ****/
identity octet-string-key-format {
base "symmetric-key-format";
description
"Indicates that the key is encoded as a raw octet string.";
// FIXME
// Knowing that it is an "OctetString" isn't really helpful.
// Knowing the length of the octet string would be helpful,
// as it relates to the algorithm's block size. We may want
// to only (for now) use "one-symmetric-key-format" for
// symmetric keys...were the usability issues Juergen
// mentioned before only apply to asymmetric keys?
}
identity one-symmetric-key-format {
if-feature "one-symmetric-key-format";
base "symmetric-key-format";
description
"Indicates that the symmetric key value is encoded
as a OneSymmetricKey (from RFC 6031).";
// FIXME: DER encoded ASN.1, etc...or flex PEM?
reference
"RFC 6031: Cryptographic Message Syntax (CMS)
Symmetric Key Package Content Type";
}
identity encrypted-one-symmetric-key-format {
if-feature "encrypted-one-symmetric-key-format";
base "symmetric-key-format";
description
"Indicates that the symmetric key value is encoded
as an EncryptedData structure (RFC 5652) containing
OneSymmetricKey (RFC 6031).";
// FIXME: DER encoded ASN.1, etc...or flex PEM?
reference
"RFC 5652: Cryptographic Message Syntax (CMS)
RFC 6031: Cryptographic Message Syntax (CMS)
Symmetric Key Package Content Type";
}
/***************************************************/
/* Typedefs for ASN.1 structures from RFC 5280 */
/***************************************************/
typedef x509 {
type binary;
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 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 ASN.1 structures from 5652 */
/***********************************************/
typedef cms {
type binary;
description
"A ContentInfo structure, as specified in RFC 5652,
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).";
}
typedef data-content-cms {
type cms;
description
"A CMS structure whose top-most content type MUST be the
data content type, as described by Section 4 in RFC 5652.";
reference
"RFC 5652: Cryptographic Message Syntax (CMS)";
}
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 {
type cms;
description
"A CMS structure whose top-most content type MUST be the
enveloped-data content type, as described by Section 6
in RFC 5652.";
reference
"RFC 5652: Cryptographic Message Syntax (CMS)";
}
typedef digested-data-cms {
type cms;
description
"A CMS structure whose top-most content type MUST be the
digested-data content type, as described by Section 7
in RFC 5652.";
reference
"RFC 5652: Cryptographic Message Syntax (CMS)";
}
typedef encrypted-data-cms {
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)";
}
/***************************************************/
/* Typedefs for structures related to RFC 4253 */
/***************************************************/
typedef ssh-host-key {
type binary;
description
"The binary public key data for an SSH key, as
specified by RFC 4253, Section 6.6, i.e.:
string certificate or public key format
identifier
byte[n] key/certificate data.";
reference
"RFC 4253: The Secure Shell (SSH) Transport Layer
Protocol";
}
/*********************************************************/
/* Typedefs for ASN.1 structures related to RFC 5280 */
/*********************************************************/
typedef trust-anchor-cert-x509 {
type x509;
description
"A Certificate structure that MUST encode a self-signed
root certificate.";
}
typedef end-entity-cert-x509 {
type x509;
description
"A Certificate structure that MUST encode a certificate
that is neither self-signed nor having Basic constraint
CA true.";
}
/*********************************************************/
/* Typedefs for ASN.1 structures related to RFC 5652 */
/*********************************************************/
typedef trust-anchor-cert-cms {
type signed-data-cms;
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.
The client or end-entity certificate MUST only authenticate
to last intermediate CA certificate listed in the chain.
In all cases, the chain MUST include a self-signed root
certificate. In the case where the root certificate is
itself the issuer of the client or end-entity certificate,
only one certificate is present.
This CMS structure MAY (as applicable where this type is
used) also contain suitably fresh (as defined by local
policy) revocation objects with which the device can
verify the revocation status of the certificates.
This CMS encodes the degenerate form of the SignedData
structure that is commonly used to disseminate X.509
certificates and revocation objects (RFC 5280).";
reference
"RFC 5280:
Internet X.509 Public Key Infrastructure Certificate
and Certificate Revocation List (CRL) Profile.";
}
typedef end-entity-cert-cms {
type signed-data-cms;
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 CMS MUST contain a single end entity certificate.
The CMS MUST NOT contain any spurious certificates.
This CMS structure MAY (as applicable where this type is
used) also contain suitably fresh (as defined by local
policy) revocation objects with which the device can
verify the revocation status of the certificates.
This CMS encodes the degenerate form of the SignedData
structure that is commonly used to disseminate X.509
certificates and revocation objects (RFC 5280).";
reference
"RFC 5280:
Internet X.509 Public Key Infrastructure Certificate
and Certificate Revocation List (CRL) Profile.";
}
typedef ssh-public-key-type { // DELETE?
type binary;
description
"The binary public key data for this SSH key, as
specified by RFC 4253, Section 6.6, i.e.:
string certificate or public key format
identifier
byte[n] key/certificate data.";
reference
"RFC 4253: The Secure Shell (SSH) Transport
Layer Protocol";
}
/**********************************************/
/* Groupings for keys and/or certificates */
/**********************************************/
grouping symmetric-key-grouping {
description
"A symmetric key and algorithm.";
leaf algorithm {
type isa:symmetric-algorithm-type;
mandatory true;
description
"The algorithm to be used when generating the key.";
reference
"RFC CCCC: Common YANG Data Types for Cryptography";
}
leaf key-format {
nacm:default-deny-write;
when "../key or ../encrypted-key"; // FIXME: forward ref?!
type identityref {
base symmetric-key-format;
}
description "Identifies the symmetric key's format.";
}
choice key-type {
mandatory true;
description
"Choice between key types.";
leaf key {
nacm:default-deny-all;
type binary;
must "../key-format";
description
"The binary value of the key. The interpretation of
the value is defined by 'key-format'. For example,
FIXME.";
reference
"RFC XXXX: FIXME";
}
leaf hidden-key {
nacm:default-deny-write;
type empty;
description
"A permanently hidden key. How such keys are created
is outside the scope of this module.";
}
}
}
grouping public-key-grouping {
description
"A public key and its associated algorithm.";
leaf algorithm {
nacm:default-deny-write;
type iasa:asymmetric-algorithm-type;
mandatory true;
description
"Identifies the key's algorithm.";
reference
"RFC CCCC: Common YANG Data Types for Cryptography";
}
leaf public-key-format {
nacm:default-deny-write;
when "../public-key";
type identityref {
base public-key-format;
}
description "Identifies the key's format.";
}
leaf public-key {
nacm:default-deny-write;
type binary;
must "../public-key-format";
mandatory true;
description
"The binary value of the public key. The interpretation
of the value is defined by 'public-key-format' field.";
}
}
grouping asymmetric-key-pair-grouping {
description
"A private key and its associated public key and algorithm.";
uses public-key-grouping;
leaf private-key-format {
nacm:default-deny-write;
when "../private-key or ../encrypted-private-key";
// FIXME: forward ref?!
type identityref {
base private-key-format;
}
description "Identifies the key's format.";
}
choice private-key-type {
mandatory true;
description
"Choice between key types.";
leaf private-key {
nacm:default-deny-all;
type binary;
must "../private-key-format";
description
"The value of the binary key The key's value is
interpreted by the 'private-key-format' field.";
}
leaf hidden-private-key {
nacm:default-deny-write;
type empty;
description
"A permanently hidden key. How such keys are created
is outside the scope of this module.";
}
}
}
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;
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;
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>
The following example module illustrates the use of both the "symmetric-key-grouping" and the "asymmetric-key-pair-with-certs-grouping" groupings defined in the "ietf-crypto-types" module.
module ex-crypto-types-usage {
yang-version 1.1;
namespace "http://example.com/ns/example-crypto-types-usage";
prefix "ectu";
import ietf-crypto-types {
prefix ct;
reference
"RFC XXXX: Common YANG Data Types for Cryptography";
}
organization
"Example Corporation";
contact
"Author: YANG Designer <mailto:yang.designer@example.com>";
description
"This module illustrates the grouping
defined in the crypto-types draft called
'asymmetric-key-pair-with-certs-grouping'.";
revision "1001-01-01" {
description
"Initial version";
reference
"RFC ????: Usage Example for RFC XXXX";
}
container symmetric-keys {
description
"A container of symmetric keys.";
list symmetric-key {
key name;
description
"A symmetric key";
leaf name {
type string;
description
"An arbitrary name for this key.";
}
uses ct:symmetric-key-grouping;
}
}
container asymmetric-keys {
description
"A container of asymmetric keys.";
list asymmetric-key {
key name;
leaf name {
type string;
description
"An arbitrary name for this key.";
}
uses ct:asymmetric-key-pair-with-certs-grouping;
description
"An asymmetric key pair with associated certificates.";
}
}
}
Given the above example usage module, the following example illustrates some configured keys.
<symmetric-keys
xmlns="http://example.com/ns/example-crypto-types-usage"
xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types">
<symmetric-key>
<name>ex-symmetric-key</name>
<algorithm>aes-256-cbc</algorithm>
<key-format>ct:octet-string-key-format</key-format>
<key>base64encodedvalue==</key>
</symmetric-key>
<symmetric-key>
<name>ex-hidden-symmetric-key</name>
<algorithm>aes-256-cbc</algorithm>
<hidden-key/>
</symmetric-key>
</symmetric-keys>
<asymmetric-keys
xmlns="http://example.com/ns/example-crypto-types-usage"
xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types">
<asymmetric-key>
<name>ex-asymmetric-key</name>
<algorithm>rsa2048</algorithm>
<public-key-format>
ct:subject-public-key-info-format
</public-key-format>
<public-key>base64encodedvalue==</public-key>
<private-key-format>
ct:rsa-private-key-format
</private-key-format>
<private-key>base64encodedvalue==</private-key>
<certificates>
<certificate>
<name>ex-cert</name>
<cert>base64encodedvalue==</cert>
</certificate>
</certificates>
</asymmetric-key>
<asymmetric-key>
<name>ex-hidden-asymmetric-key</name>
<algorithm>rsa2048</algorithm>
<public-key-format>
ct:subject-public-key-info-format
</public-key-format>
<public-key>base64encodedvalue==</public-key>
<hidden-private-key/>
<certificates>
<certificate>
<name>ex-hidden-key-cert</name>
<cert>base64encodedvalue==</cert>
</certificate>
</certificates>
</asymmetric-key>
</asymmetric-keys>
The following example illustrates the "generate-certificate-signing-request" action with the NETCONF protocol.
REQUEST
<rpc message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<action xmlns="urn:ietf:params:xml:ns:yang:1">
<asymmetric-keys
xmlns="http://example.com/ns/example-crypto-types-usage">
<asymmetric-key>
<name>ex-key-sect571r1</name>
<generate-certificate-signing-request>
<subject>base64encodedvalue==</subject>
<attributes>base64encodedvalue==</attributes>
</generate-certificate-signing-request>
</asymmetric-key>
</asymmetric-keys>
</action>
</rpc>
RESPONSE
<rpc-reply message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<certificate-signing-request
xmlns="http://example.com/ns/example-crypto-types-usage">
base64encodedvalue==
</certificate-signing-request>
</rpc-reply>
The following example illustrates the "certificate-expiration" notification with the NETCONF protocol.
<notification
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2018-05-25T00:01:00Z</eventTime>
<keys xmlns="http://example.com/ns/example-crypto-types-usage">
<key>
<name>locally-defined key</name>
<certificates>
<certificate>
<name>my-cert</name>
<certificate-expiration>
<expiration-date>
2018-08-05T14:18:53-05:00
</expiration-date>
</certificate-expiration>
</certificate>
</certificates>
</key>
</keys>
</notification>
This section provides a tree diagram [RFC8340] for the "iana-symmetric-algs" module. Only the "container" statement is represented, as tree diagrams have no means to represent "typedef" statements.
module: iana-symmetric-algs
+--ro supported-symmetric-algorithms
+--ro supported-symmetric-algorithm* [algorithm]
+--ro algorithm symmetric-algorithm-type
This module has normative references to FIXME...
<CODE BEGINS> file "iana-symmetric-algs@2019-11-20.yang"
module iana-symmetric-algs {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:iana-symmetric-algs";
prefix isa;
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <http://datatracker.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org>
Author: Kent Watsen <mailto:kent+ietf@watsen.net>
Author: Wang Haiguang <wang.haiguang.shieldlab@huawei.com>";
description
"This module defines a typedef for symmetric algorithms, and
a container for a list of symmetric algorithms supported by
the server.
Copyright (c) 2019 IETF Trust and the persons identified
as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with
or without modification, is permitted pursuant to, and
subject to the license terms contained in, the Simplified
BSD License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC
itself for full legal notices.
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 (RFC 2119)
(RFC 8174) when, and only when, they appear in all
capitals, as shown here.";
revision 2019-11-20 {
description
"Initial version";
reference
"RFC XXXX: Common YANG Data Types for Cryptography";
}
// Typedefs
typedef symmetric-algorithm-type {
type enumeration {
enum aes-128-cbc {
value 1;
description
"Encrypt message with AES algorithm in CBC mode with
a key length of 128 bits.";
reference
"RFC 3565: Use of the Advanced Encryption Standard (AES)
Encryption Algorithm in Cryptographic Message Syntax
(CMS)";
}
enum aes-192-cbc {
value 2;
description
"Encrypt message with AES algorithm in CBC mode with
a key length of 192 bits";
reference
"RFC 3565: Use of the Advanced Encryption Standard (AES)
Encryption Algorithm in Cryptographic Message Syntax
(CMS)";
}
enum aes-256-cbc {
value 3;
description
"Encrypt message with AES algorithm in CBC mode with
a key length of 256 bits";
reference
"RFC 3565: Use of the Advanced Encryption Standard (AES)
Encryption Algorithm in Cryptographic Message Syntax
(CMS)";
}
enum aes-128-ctr {
value 4;
description
"Encrypt message with AES algorithm in CTR mode with
a key length of 128 bits";
reference
"RFC 3686:
Using Advanced Encryption Standard (AES) Counter
Mode with IPsec Encapsulating Security Payload
(ESP)";
}
enum aes-192-ctr {
value 5;
description
"Encrypt message with AES algorithm in CTR mode with
a key length of 192 bits";
reference
"RFC 3686:
Using Advanced Encryption Standard (AES) Counter
Mode with IPsec Encapsulating Security Payload
(ESP)";
}
enum aes-256-ctr {
value 6;
description
"Encrypt message with AES algorithm in CTR mode with
a key length of 256 bits";
reference
"RFC 3686:
Using Advanced Encryption Standard (AES) Counter
Mode with IPsec Encapsulating Security Payload
(ESP)";
}
enum des3-cbc-sha1-kd {
value 7;
description
"Encrypt message with 3DES algorithm in CBC mode
with sha1 function for key derivation";
reference
"RFC 3961:
Encryption and Checksum Specifications for
Kerberos 5";
}
enum rc4-hmac {
value 8;
description
"Encrypt message with rc4 algorithm";
reference
"RFC 4757:
The RC4-HMAC Kerberos Encryption Types Used by
Microsoft Windows";
}
enum rc4-hmac-exp {
value 9;
description
"Encrypt message with rc4 algorithm that is exportable";
reference
"RFC 4757:
The RC4-HMAC Kerberos Encryption Types Used by
Microsoft Windows";
}
}
description
"A typedef enumerating various symmetric key algorithms.";
}
// Protocol-accessible Nodes
container supported-symmetric-algorithms {
config false;
description
"A container for a list of supported symmetric algorithms.
How algorithms come to be supported is outside the scope
of this module.";
list supported-symmetric-algorithm {
key algorithm;
description
"A lists of symmetric algorithms supported by the server.";
leaf algorithm {
type symmetric-algorithm-type;
description
"An symmetric algorithms supported by the server.";
}
}
}
}
<CODE ENDS>
The following example illustrates the "supported-symmetric-algorithms" "container" statement with the NETCONF protocol.
<supported-symmetric-algorithms
xmlns="urn:ietf:params:xml:ns:yang:iana-symmetric-algs">
<supported-symmetric-algorithm>
<algorithm>aes-128-cbc</algorithm>
</supported-symmetric-algorithm>
<supported-symmetric-algorithm>
<algorithm>aes-256-cbc</algorithm>
</supported-symmetric-algorithm>
</supported-symmetric-algorithms>
This section provides a tree diagram [RFC8340] for the "iana-asymmetric-algs" module. Only the "container" statement is represented, as tree diagrams have no means to represent "typedef" statements.
module: iana-asymmetric-algs
+--ro supported-asymmetric-algorithms
+--ro supported-asymmetric-algorithm* [algorithm]
+--ro algorithm asymmetric-algorithm-type
This module has normative references to FIXME...
<CODE BEGINS> file "iana-asymmetric-algs@2019-11-20.yang"
module iana-asymmetric-algs {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:iana-asymmetric-algs";
prefix iasa;
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <http://datatracker.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org>
Author: Kent Watsen <mailto:kent+ietf@watsen.net>
Author: Wang Haiguang <wang.haiguang.shieldlab@huawei.com>";
description
"This module defines a typedef for asymmetric algorithms, and
a container for a list of asymmetric algorithms supported by
the server.
Copyright (c) 2019 IETF Trust and the persons identified
as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with
or without modification, is permitted pursuant to, and
subject to the license terms contained in, the Simplified
BSD License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC
itself for full legal notices.
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 (RFC 2119)
(RFC 8174) when, and only when, they appear in all
capitals, as shown here.";
revision 2019-11-20 {
description
"Initial version";
reference
"RFC XXXX: Common YANG Data Types for Cryptography";
}
// Typedefs
typedef asymmetric-algorithm-type {
type enumeration {
enum rsa1024 {
value 1;
description
"The RSA algorithm using a 1024-bit key.";
reference
"RFC 8017: PKCS #1: RSA Cryptography
Specifications Version 2.2.";
}
enum rsa2048 {
value 2;
description
"The RSA algorithm using a 2048-bit key.";
reference
"RFC 8017:
PKCS #1: RSA Cryptography Specifications Version 2.2.";
}
enum rsa3072 {
value 3;
description
"The RSA algorithm using a 3072-bit key.";
reference
"RFC 8017:
PKCS #1: RSA Cryptography Specifications Version 2.2.";
}
enum rsa4096 {
value 4;
description
"The RSA algorithm using a 4096-bit key.";
reference
"RFC 8017:
PKCS #1: RSA Cryptography Specifications Version 2.2.";
}
enum rsa7680 {
value 5;
description
"The RSA algorithm using a 7680-bit key.";
reference
"RFC 8017:
PKCS #1: RSA Cryptography Specifications Version 2.2.";
}
enum rsa15360 {
value 6;
description
"The RSA algorithm using a 15360-bit key.";
reference
"RFC 8017:
PKCS #1: RSA Cryptography Specifications Version 2.2.";
}
enum secp192r1 {
value 7;
description
"The asymmetric algorithm using a NIST P192 Curve.";
reference
"RFC 6090:
Fundamental Elliptic Curve Cryptography Algorithms.
RFC 5480:
Elliptic Curve Cryptography Subject Public Key
Information.";
}
enum secp224r1 {
value 8;
description
"The asymmetric algorithm using a NIST P224 Curve.";
reference
"RFC 6090:
Fundamental Elliptic Curve Cryptography Algorithms.
RFC 5480:
Elliptic Curve Cryptography Subject Public Key
Information.";
}
enum secp256r1 {
value 9;
description
"The asymmetric algorithm using a NIST P256 Curve.";
reference
"RFC 6090:
Fundamental Elliptic Curve Cryptography Algorithms.
RFC 5480:
Elliptic Curve Cryptography Subject Public Key
Information.";
}
enum secp384r1 {
value 10;
description
"The asymmetric algorithm using a NIST P384 Curve.";
reference
"RFC 6090:
Fundamental Elliptic Curve Cryptography Algorithms.
RFC 5480:
Elliptic Curve Cryptography Subject Public Key
Information.";
}
enum secp521r1 {
value 11;
description
"The asymmetric algorithm using a NIST P521 Curve.";
reference
"RFC 6090:
Fundamental Elliptic Curve Cryptography Algorithms.
RFC 5480:
Elliptic Curve Cryptography Subject Public Key
Information.";
}
enum x25519 {
value 12;
description
"The asymmetric algorithm using a x.25519 Curve.";
reference
"RFC 7748:
Elliptic Curves for Security.";
}
enum x448 {
value 13;
description
"The asymmetric algorithm using a x.448 Curve.";
reference
"RFC 7748:
Elliptic Curves for Security.";
}
}
description
"A typedef enumerating various asymmetric key algorithms.";
}
// Protocol-accessible Nodes
container supported-asymmetric-algorithms {
config false;
description
"A container for a list of supported asymmetric algorithms.
How algorithms come to be supported is outside the scope
of this module.";
list supported-asymmetric-algorithm {
key algorithm;
description
"A lists of asymmetric algorithms supported by the server.";
leaf algorithm {
type asymmetric-algorithm-type;
description
"An asymmetric algorithms supported by the server.";
}
}
}
}
<CODE ENDS>
The following example illustrates the "supported-asymmetric-algorithms" "container" statement with the NETCONF protocol.
<supported-asymmetric-algorithms
xmlns="urn:ietf:params:xml:ns:yang:iana-asymmetric-algs">
<supported-asymmetric-algorithm>
<algorithm>rsa2048</algorithm>
</supported-asymmetric-algorithm>
<supported-asymmetric-algorithm>
<algorithm>secp256r1</algorithm>
</supported-asymmetric-algorithm>
</supported-asymmetric-algorithms>
This section provides a tree diagram [RFC8340] for the "iana-hash-algs" module. Only the "container" statement is represented, as tree diagrams have no means to represent "typedef" statements.
module: iana-hash-algs
+--ro supported-hash-algorithms
+--ro supported-hash-algorithm* [algorithm]
+--ro algorithm hash-algorithm-type
This module has normative references to FIXME...
<CODE BEGINS> file "iana-hash-algs@2019-11-20.yang"
module iana-hash-algs {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:iana-hash-algs";
prefix iha;
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <http://datatracker.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org>
Author: Kent Watsen <mailto:kent+ietf@watsen.net>
Author: Wang Haiguang <wang.haiguang.shieldlab@huawei.com>";
description
"This module defines a typedef for hash algorithms, and
a container for a list of hash algorithms supported by
the server.
Copyright (c) 2019 IETF Trust and the persons identified
as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with
or without modification, is permitted pursuant to, and
subject to the license terms contained in, the Simplified
BSD License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC
itself for full legal notices.
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 (RFC 2119)
(RFC 8174) when, and only when, they appear in all
capitals, as shown here.";
revision 2019-11-20 {
description
"Initial version";
reference
"RFC XXXX: Common YANG Data Types for Cryptography";
}
// Typedefs
typedef hash-algorithm-type {
type enumeration {
enum sha1 {
value 1;
status obsolete;
description
"The SHA1 algorithm.";
reference
"RFC 3174: US Secure Hash Algorithms 1 (SHA1).";
}
enum sha-224 {
value 2;
description
"The SHA-224 algorithm.";
reference
"RFC 6234: US Secure Hash Algorithms.";
}
enum sha-256 {
value 3;
description
"The SHA-256 algorithm.";
reference
"RFC 6234: US Secure Hash Algorithms.";
}
enum sha-384 {
value 4;
description
"The SHA-384 algorithm.";
reference
"RFC 6234: US Secure Hash Algorithms.";
}
enum sha-512 {
value 5;
description
"The SHA-512 algorithm.";
reference
"RFC 6234: US Secure Hash Algorithms.";
}
enum shake-128 {
value 6;
description
"The SHA3 algorithm with 128-bits output.";
reference
"National Institute of Standards and Technology,
SHA-3 Standard: Permutation-Based Hash and
Extendable-Output Functions, FIPS PUB 202, DOI
10.6028/NIST.FIPS.202, August 2015.";
}
enum shake-224 {
value 7;
description
"The SHA3 algorithm with 224-bits output.";
reference
"National Institute of Standards and Technology,
SHA-3 Standard: Permutation-Based Hash and
Extendable-Output Functions, FIPS PUB 202, DOI
10.6028/NIST.FIPS.202, August 2015.";
}
enum shake-256 {
value 8;
description
"The SHA3 algorithm with 256-bits output.";
reference
"National Institute of Standards and Technology,
SHA-3 Standard: Permutation-Based Hash and
Extendable-Output Functions, FIPS PUB 202, DOI
10.6028/NIST.FIPS.202, August 2015.";
}
enum shake-384 {
value 9;
description
"The SHA3 algorithm with 384-bits output.";
reference
"National Institute of Standards and Technology,
SHA-3 Standard: Permutation-Based Hash and
Extendable-Output Functions, FIPS PUB 202, DOI
10.6028/NIST.FIPS.202, August 2015.";
}
enum shake-512 {
value 10;
description
"The SHA3 algorithm with 384-bits output.";
reference
"National Institute of Standards and Technology,
SHA-3 Standard: Permutation-Based Hash and
Extendable-Output Functions, FIPS PUB 202, DOI
10.6028/NIST.FIPS.202, August 2015.";
}
}
description
"A typedef enumerating various hash key algorithms.";
}
// Protocol-accessible Nodes
container supported-hash-algorithms {
config false;
description
"A container for a list of supported hash algorithms.
How algorithms come to be supported is outside the
scope of this module.";
list supported-hash-algorithm {
key algorithm;
description
"A lists of hash algorithms supported by the server.";
leaf algorithm {
type hash-algorithm-type;
description
"An hash algorithms supported by the server.";
}
}
}
}
<CODE ENDS>
The following example illustrates the "supported-hash-algorithms" "container" statement with the NETCONF protocol.
<supported-hash-algorithms
xmlns="urn:ietf:params:xml:ns:yang:iana-hash-algs">
<supported-hash-algorithm>
<algorithm>sha-256</algorithm>
</supported-hash-algorithm>
<supported-hash-algorithm>
<algorithm>sha-512</algorithm>
</supported-hash-algorithm>
</supported-hash-algorithms>
In order to use YANG identities for algorithm identifiers, only the most commonly used RSA key lengths are supported for the RSA algorithm. Additional key lengths can be defined in another module or added into a future version of this document.
This document limits the number of elliptical curves supported. This was done to match industry trends and IETF best practice (e.g., matching work being done in TLS 1.3). If additional algorithms are needed, they can be defined by another module or added into a future version of this document.
This document uses PKCS #10 [RFC2986] for the "generate-certificate-signing-request" action. The use of Certificate Request Message Format (CRMF) [RFC4211] was considered, but is was unclear if there was market demand for it. If it is desired to support CRMF in the future, a backwards compatible solution can be defined at that time.
The YANG module in this document defines "grouping" statements that are designed to be accessed via YANG based management protocols, such as NETCONF [RFC6241] and RESTCONF [RFC8040]. Both of these protocols have mandatory-to-implement secure transport layers (e.g., SSH, TLS) with mutual authentication.
The NETCONF access control model (NACM) [RFC8341] provides the means to restrict access for particular users to a pre-configured subset of all available protocol operations and content.
Since the module in this document only define groupings, these considerations are primarily for the designers of other modules that use these groupings.
There are a number of data nodes defined by the grouping statements that are writable/creatable/deletable (i.e., config true, which is the default). Some of these data nodes may be considered sensitive or vulnerable in some network environments. Write operations (e.g., edit-config) to these data nodes without proper protection can have a negative effect on network operations. These are the subtrees and data nodes and their sensitivity/vulnerability:
Some of the readable data nodes in the YANG module may be considered sensitive or vulnerable in some network environments. It is thus important to control read access (e.g., via get, get-config, or notification) to these data nodes. These are the subtrees and data nodes and their sensitivity/vulnerability:
Some of the operations in this YANG module may be considered sensitive or vulnerable in some network environments. It is thus important to control access to these operations. These are the operations and their sensitivity/vulnerability:
This document registers four URIs in the "ns" subregistry of the IETF XML Registry [RFC3688]. Following the format in [RFC3688], the following registrations are requested:
URI: urn:ietf:params:xml:ns:yang:ietf-crypto-types Registrant Contact: The NETCONF WG of the IETF. XML: N/A, the requested URI is an XML namespace. URI: urn:ietf:params:xml:ns:yang:iana-symmetric-algs Registrant Contact: The NETCONF WG of the IETF. XML: N/A, the requested URI is an XML namespace. URI: urn:ietf:params:xml:ns:yang:iana-ssymmetric-algs Registrant Contact: The NETCONF WG of the IETF. XML: N/A, the requested URI is an XML namespace. URI: urn:ietf:params:xml:ns:yang:iana-hash-algs Registrant Contact: The NETCONF WG of the IETF. XML: N/A, the requested URI is an XML namespace.
This document registers four YANG modules in the YANG Module Names registry [RFC6020]. Following the format in [RFC6020], the the following registrations are requested:
name: ietf-crypto-types namespace: urn:ietf:params:xml:ns:yang:ietf-crypto-types prefix: ct reference: RFC XXXX name: iana-symmetric-algs namespace: urn:ietf:params:xml:ns:yang:iana-symmetric-algs prefix: isa reference: RFC XXXX name: iana-asymmetric-algs namespace: urn:ietf:params:xml:ns:yang:iana-asymmetric-algs prefix: iasa reference: RFC XXXX name: iana-hash-algs namespace: urn:ietf:params:xml:ns:yang:iana-hash-algs prefix: iha reference: RFC XXXX
The authors would like to thank for following for lively discussions on list and in the halls (ordered by last name): Martin Bjorklund, Nick Hancock, Balázs Kovács, Juergen Schoenwaelder, Eric Voit, and Liang Xia.