draft-ietf-netconf-tls-client-server-03.txt   draft-ietf-netconf-tls-client-server-04.txt 
NETCONF Working Group K. Watsen NETCONF Working Group K. Watsen
Internet-Draft Juniper Networks Internet-Draft Juniper Networks
Intended status: Standards Track G. Wu Intended status: Standards Track G. Wu
Expires: December 15, 2017 Cisco Systems Expires: April 21, 2018 Cisco Systems
June 13, 2017 October 18, 2017
TLS Client and Server Models YANG Groupings for TLS Clients and TLS Servers
draft-ietf-netconf-tls-client-server-03 draft-ietf-netconf-tls-client-server-04
Abstract Abstract
This document defines three YANG modules: the first defines groupings This document defines three YANG modules: the first defines groupings
for a generic TLS client, the second defines groupings for a generic for a generic TLS client, the second defines groupings for a generic
TLS server, and the third defines common identities and groupings TLS server, and the third defines common identities and groupings
used by both the client and the server. It is intended that these used by both the client and the server. It is intended that these
groupings will be used by applications using the TLS protocol. groupings will be used by applications using the TLS protocol.
Editorial Note (To be removed by RFC Editor) Editorial Note (To be removed by RFC Editor)
skipping to change at page 1, line 44 skipping to change at page 1, line 44
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
o "YYYY" --> the assigned RFC value for I-D.ietf-netconf-keystore o "YYYY" --> the assigned RFC value for I-D.ietf-netconf-keystore
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 "2017-06-13" --> the publication date of this draft o "2017-10-19" --> the publication date of this draft
The following Appendix section is to be removed prior to publication: The following Appendix section is to be removed prior to publication:
o Appendix A. Change Log o Appendix A. Change Log
Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
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 http://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 December 15, 2017. This Internet-Draft will expire on April 21, 2018.
Copyright Notice Copyright Notice
Copyright (c) 2017 IETF Trust and the persons identified as the Copyright (c) 2017 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
(http://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
1.2. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 3 1.2. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 4
2. The TLS Client Model . . . . . . . . . . . . . . . . . . . . 4 2. The TLS Client Model . . . . . . . . . . . . . . . . . . . . 4
2.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 4 2.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 4
2.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 5 2.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 5
2.3. YANG Model . . . . . . . . . . . . . . . . . . . . . . . 5 2.3. YANG Model . . . . . . . . . . . . . . . . . . . . . . . 5
3. The TLS Server Model . . . . . . . . . . . . . . . . . . . . 8 3. The TLS Server Model . . . . . . . . . . . . . . . . . . . . 8
3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 9 3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 8
3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 9 3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 9
3.3. YANG Model . . . . . . . . . . . . . . . . . . . . . . . 10 3.3. YANG Model . . . . . . . . . . . . . . . . . . . . . . . 9
4. The TLS Common Model . . . . . . . . . . . . . . . . . . . . 13 4. The TLS Common Model . . . . . . . . . . . . . . . . . . . . 12
4.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 13 4.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 13
4.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 13 4.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 13
4.3. YANG Model . . . . . . . . . . . . . . . . . . . . . . . 14
5. Security Considerations . . . . . . . . . . . . . . . . . . . 21 Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 22
6.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 22 4.3. YANG Model . . . . . . . . . . . . . . . . . . . . . . . 13
6.2. The YANG Module Names Registry . . . . . . . . . . . . . 22 5. Security Considerations . . . . . . . . . . . . . . . . . . . 22
7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 23 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 23
8. References . . . . . . . . . . . . . . . . . . . . . . . . . 23 6.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 23
8.1. Normative References . . . . . . . . . . . . . . . . . . 23 6.2. The YANG Module Names Registry . . . . . . . . . . . . . 23
8.2. Informative References . . . . . . . . . . . . . . . . . 24 7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 24
Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 26 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 24
A.1. server-model-09 to 00 . . . . . . . . . . . . . . . . . . 26 8.1. Normative References . . . . . . . . . . . . . . . . . . 24
A.2. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 26 8.2. Informative References . . . . . . . . . . . . . . . . . 25
A.3. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 26 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 27
A.4. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 26 A.1. server-model-09 to 00 . . . . . . . . . . . . . . . . . . 27
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 26 A.2. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 27
A.3. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 27
A.4. 02 to 03 . . . . . . . . . . . . . . . . . . . . . . . . 27
A.5. 03 to 04 . . . . . . . . . . . . . . . . . . . . . . . . 27
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 27
1. Introduction 1. Introduction
This document defines three YANG [RFC7950] modules: the first defines This document defines three YANG [RFC7950] modules: the first defines
a grouping for a generic TLS client, the second defines a grouping a grouping for a generic TLS client, the second defines a grouping
for a generic TLS server, and the third defines identities and for a generic TLS server, and the third defines identities and
groupings common to both the client and the server (TLS is defined in groupings common to both the client and the server (TLS is defined in
[RFC5246]). It is intended that these groupings will be used by [RFC5246]). It is intended that these groupings will be used by
applications using the TLS protocol. For instance, these groupings applications using the TLS protocol. For instance, these groupings
could be used to help define the data model for an HTTPS [RFC2818] could be used to help define the data model for an HTTPS [RFC2818]
skipping to change at page 3, line 43 skipping to change at page 3, line 47
specifically avoids any transport-level configuration, such as what specifically avoids any transport-level configuration, such as what
ports to listen-on or connect-to. This enables applications the ports to listen-on or connect-to. This enables applications the
opportunity to define their own strategy for how the underlying TCP opportunity to define their own strategy for how the underlying TCP
connection is established. For instance, applications supporting connection is established. For instance, applications supporting
NETCONF Call Home [RFC8071] could use the grouping for the TLS parts NETCONF Call Home [RFC8071] could use the grouping for the TLS parts
it provides, while adding data nodes for the TCP-level call-home it provides, while adding data nodes for the TCP-level call-home
configuration. configuration.
1.1. Terminology 1.1. Terminology
The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
document are to be interpreted as described in RFC 2119 [RFC2119]. "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.
Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
1.2. Tree Diagrams 1.2. Tree Diagrams
A simplified graphical representation of the data models is used in A simplified graphical representation of the data models is used in
this document. The meaning of the symbols in these diagrams is as this document. The meaning of the symbols in these diagrams is as
follows: follows:
o Brackets "[" and "]" enclose list keys. o Brackets "[" and "]" enclose list keys.
o Braces "{" and "}" enclose feature names, and indicate that the o Braces "{" and "}" enclose feature names, and indicate that the
skipping to change at page 4, line 25 skipping to change at page 4, line 33
o Parentheses enclose choice and case nodes, and case nodes are also o Parentheses enclose choice and case nodes, and case nodes are also
marked with a colon (":"). marked with a colon (":").
o Ellipsis ("...") stands for contents of subtrees that are not o Ellipsis ("...") stands for contents of subtrees that are not
shown. shown.
2. The TLS Client Model 2. The TLS Client Model
The TLS client model presented in this section contains one YANG The TLS client model presented in this section contains one YANG
grouping, to just configure the TLS client omitting, for instance, grouping, to just configure the TLS client, omitting, for instance,
any configuration for which IP address or port the client should any configuration for which IP address or port the client should
connect to. connect to.
This grouping references data nodes defined by the keystore model This grouping references data nodes defined by the keystore model
[I-D.ietf-netconf-keystore]. For instance, a reference to the [I-D.ietf-netconf-keystore]. For instance, a reference to the
keystore model is made to indicate which trusted CA certificate a keystore model is made to indicate which trusted CA certificate a
client should use to authenticate the server's certificate. client should use to authenticate the server's certificate.
2.1. Tree Diagram 2.1. Tree Diagram
The following tree diagram presents the data model for the grouping The following tree diagram presents the data model for the grouping
defined in the ietf-tls-client module. Please see Section 1.2 for defined in the ietf-tls-client module. Please see Section 1.2 for
tree diagram notation. tree diagram notation.
Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
module: ietf-tls-client module: ietf-tls-client
groupings:
tls-client-grouping grouping tls-client-grouping
+---- server-auth +---- client-auth
| +---- trusted-ca-certs? | +---- (auth-type)?
| | -> /ks:keystore/trusted-certificates/name | +--:(certificate)
| +---- trusted-server-certs? | +---- certificate? leafref
| -> /ks:keystore/trusted-certificates/name +---- server-auth
+---- client-auth | +---- pinned-ca-certs?
| +---- (auth-type)? | | -> /ks:keystore/pinned-certificates/name
| +--:(certificate) | +---- pinned-server-certs?
| +---- certificate? leafref | -> /ks:keystore/pinned-certificates/name
+---- hello-params {tls-client-hello-params-config}? +---- hello-params {tls-client-hello-params-config}?
+---- tls-versions +---- tls-versions
| +---- tls-version* identityref | +---- tls-version* identityref
+---- cipher-suites +---- cipher-suites
+---- cipher-suite* identityref +---- cipher-suite* identityref
2.2. Example Usage 2.2. Example Usage
This section shows how it would appear if the tls-client-grouping This section shows how it would appear if the tls-client-grouping
were populated with some data. This example is consistent with the were populated with some data. This example is consistent with the
examples presented in Section 2.2 of [I-D.ietf-netconf-keystore]. examples presented in Section 2.2 of [I-D.ietf-netconf-keystore].
<!-- hypothetical example, as groupings don't have instance data --> <!-- hypothetical example, as groupings don't have instance data -->
<tls-client xmlns="urn:ietf:params:xml:ns:yang:ietf-tls-client"> <tls-client xmlns="urn:ietf:params:xml:ns:yang:ietf-tls-client">
<!-- which certificates will this client trust -->
<server-auth>
<trusted-ca-certs>deployment-specific-ca-certs</trusted-ca-certs>
<trusted-server-certs>explicitly-trusted-client-certs</trusted-server-certs>
</server-auth>
<!-- how this client will authenticate itself to the server --> <!-- how this client will authenticate itself to the server -->
<client-auth> <client-auth>
<certificate>builtin-idevid-cert</certificate> <certificate>builtin-idevid-cert</certificate>
</client-auth> </client-auth>
<!-- which certificates will this client trust -->
<server-auth>
<pinned-ca-certs>deployment-specific-ca-certs</pinned-ca-certs>
<pinned-server-certs>explicitly-trusted-client-certs</pinned-server-certs>
</server-auth>
</tls-client> </tls-client>
2.3. YANG Model 2.3. YANG Model
This YANG module has a normative references to [RFC6991] and This YANG module has a normative references to [RFC6991] and
[I-D.ietf-netconf-keystore]. [I-D.ietf-netconf-keystore].
<CODE BEGINS> file "ietf-tls-client@2017-06-13.yang" <CODE BEGINS> file "ietf-tls-client@2017-10-19.yang"
module ietf-tls-client { module ietf-tls-client {
yang-version 1.1; yang-version 1.1;
Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
namespace "urn:ietf:params:xml:ns:yang:ietf-tls-client"; namespace "urn:ietf:params:xml:ns:yang:ietf-tls-client";
prefix "tlsc"; prefix "tlsc";
import ietf-tls-common { import ietf-tls-common {
prefix tlscom; prefix tlscmn;
revision-date 2017-06-13; // stable grouping definitions revision-date 2017-10-19; // stable grouping definitions
reference reference
"RFC XXXX: TLS Client and Server Models"; "RFC XXXX: YANG Groupings for TLS Clients and TLS Servers";
} }
import ietf-keystore { import ietf-keystore {
prefix ks; prefix ks;
reference reference
"RFC YYYY: Keystore Model"; "RFC YYYY: Keystore Model";
} }
organization organization
"IETF NETCONF (Network Configuration) Working Group"; "IETF NETCONF (Network Configuration) Working Group";
contact contact
"WG Web: <http://tools.ietf.org/wg/netconf/> "WG Web: <http://tools.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org> WG List: <mailto:netconf@ietf.org>
Author: Kent Watsen Author: Kent Watsen
<mailto:kwatsen@juniper.net>"; <mailto:kwatsen@juniper.net>
Author: Gary Wu
<mailto:garywu@cisco.com>";
description description
"This module defines a reusable grouping for a TLS client that "This module defines a reusable grouping for a TLS client that
can be used as a basis for specific TLS client instances. can be used as a basis for specific TLS client instances.
Copyright (c) 2014 IETF Trust and the persons identified as Copyright (c) 2017 IETF Trust and the persons identified as
authors of the code. All rights reserved. authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD to the license terms contained in, the Simplified BSD
License set forth in Section 4.c of the IETF Trust's License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents Legal Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info). (http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices."; the RFC itself for full legal notices.";
revision "2017-06-13" { revision "2017-10-19" {
Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
description description
"Initial version"; "Initial version";
reference reference
"RFC XXXX: TLS Client and Server Models"; "RFC XXXX: YANG Groupings for TLS Clients and TLS Servers";
} }
feature tls-client-hello-params-config { feature tls-client-hello-params-config {
description description
"TLS hello message parameters are configurable on a TLS "TLS hello message parameters are configurable on a TLS
client."; client.";
} }
grouping tls-client-grouping { grouping tls-client-grouping {
description description
"A reusable grouping for configuring a TLS client without "A reusable grouping for configuring a TLS client without
any consideration for how an underlying TCP session is any consideration for how an underlying TCP session is
established."; established.";
container client-auth {
description
"The credentials used by the client to authenticate to
the TLS server.";
choice auth-type {
description
"The authentication type.";
leaf certificate {
type leafref {
path "/ks:keystore/ks:keys/ks:key/ks:certificates"
+ "/ks:certificate/ks:name";
}
description
"A certificates to be used for user authentication.";
}
}
}
container server-auth { container server-auth {
must 'trusted-ca-certs or trusted-server-certs'; must 'pinned-ca-certs or pinned-server-certs';
description description
"Trusted server identities."; "Trusted server identities.";
leaf trusted-ca-certs { leaf pinned-ca-certs {
type leafref { type leafref {
path "/ks:keystore/ks:trusted-certificates/ks:name"; path "/ks:keystore/ks:pinned-certificates/ks:name";
} }
description description
"A reference to a list of certificate authority (CA) "A reference to a list of certificate authority (CA)
certificates used by the TLS client to authenticate certificates used by the TLS client to authenticate
Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
TLS server certificates. A server certificate is TLS server certificates. A server certificate is
authenticated if it has a valid chain of trust to authenticated if it has a valid chain of trust to
a configured trusted CA certificate."; a configured pinned CA certificate.";
} }
leaf trusted-server-certs { leaf pinned-server-certs {
type leafref { type leafref {
path "/ks:keystore/ks:trusted-certificates/ks:name"; path "/ks:keystore/ks:pinned-certificates/ks:name";
} }
description description
"A reference to a list of server certificates used by "A reference to a list of server certificates used by
the TLS client to authenticate TLS server certificates. the TLS client to authenticate TLS server certificates.
A server certificate is authenticated if it is an A server certificate is authenticated if it is an
exact match to a configured trusted server certificate."; exact match to a configured pinned server certificate.";
}
}
container client-auth {
description
"The credentials used by the client to authenticate to
the TLS server.";
choice auth-type {
description
"The authentication type.";
leaf certificate {
type leafref {
path "/ks:keystore/ks:keys/ks:key/ks:certificates"
+ "/ks:certificate/ks:name";
}
description
"A certificates to be used for user authentication.";
}
} }
} }
container hello-params { container hello-params {
if-feature tls-client-hello-params-config; if-feature tls-client-hello-params-config;
uses tlscom:hello-params-grouping; uses tlscmn:hello-params-grouping;
description description
"Configurable parameters for the TLS hello message."; "Configurable parameters for the TLS hello message.";
} }
} // end tls-client-grouping } // end tls-client-grouping
} }
<CODE ENDS> <CODE ENDS>
3. The TLS Server Model 3. The TLS Server Model
The TLS server model presented in this section contains one YANG The TLS server model presented in this section contains one YANG
grouping, for just the TLS-level configuration omitting, for grouping, for just the TLS-level configuration, omitting, for
instance, configuration for which ports to open to listen for instance, configuration for which ports to open to listen for
connections on. connections on.
This grouping references data nodes defined by the keystore model This grouping references data nodes defined by the keystore model
[I-D.ietf-netconf-keystore]. For instance, a reference to the [I-D.ietf-netconf-keystore]. For instance, a reference to the
keystore model is made to indicate which certificate a server should keystore model is made to indicate which certificate a server should
present. present.
3.1. Tree Diagram 3.1. Tree Diagram
The following tree diagram presents the data model for the grouping The following tree diagram presents the data model for the grouping
defined in the ietf-tls-server module. Please see Section 1.2 for defined in the ietf-tls-server module. Please see Section 1.2 for
tree diagram notation. tree diagram notation.
Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
module: ietf-tls-server module: ietf-tls-server
groupings:
tls-server-grouping grouping tls-server-grouping
+---- certificates +---- certificates
| +---- certificate* [name] | +---- certificate* [name]
| +---- name? leafref | +---- name? leafref
+---- client-auth +---- client-auth
| +---- trusted-ca-certs? | +---- pinned-ca-certs?
| | -> /ks:keystore/trusted-certificates/name | | -> /ks:keystore/pinned-certificates/name
| +---- trusted-client-certs? | +---- pinned-client-certs?
| -> /ks:keystore/trusted-certificates/name | -> /ks:keystore/pinned-certificates/name
+---- hello-params {tls-server-hello-params-config}? +---- hello-params {tls-server-hello-params-config}?
+---- tls-versions +---- tls-versions
| +---- tls-version* identityref | +---- tls-version* identityref
+---- cipher-suites +---- cipher-suites
+---- cipher-suite* identityref +---- cipher-suite* identityref
3.2. Example Usage 3.2. Example Usage
This section shows how it would appear if the tls-server-grouping This section shows how it would appear if the tls-server-grouping
were populated with some data. This example is consistent with the were populated with some data. This example is consistent with the
examples presented in Section 2.2 of [I-D.ietf-netconf-keystore]. examples presented in Section 2.2 of [I-D.ietf-netconf-keystore].
<!-- hypothetical example, groupings don't have instance data --> <tls-server xmlns="urn:ietf:params:xml:ns:yang:ietf-tls-server">
<tls-server <!-- how this server will authenticate itself to the client -->
xmlns="urn:ietf:params:xml:ns:yang:ietf-tls-server">
<certificates> <certificates>
<certificate> <certificate>
<name>tls-ec-cert</name> <name>tls-ec-cert</name>
</certificate> </certificate>
</certificates> </certificates>
<!-- which certificates will this server trust -->
<client-auth> <client-auth>
<trusted-ca-certs>deployment-specific-ca-certs</trusted-ca-certs> <pinned-ca-certs>deployment-specific-ca-certs</pinned-ca-certs>
<trusted-client-certs>explicitly-trusted-client-certs</trusted-client-certs> <pinned-client-certs>explicitly-trusted-client-certs</pinned-client-certs>
</client-auth> </client-auth>
</tls-server> </tls-server>
3.3. YANG Model 3.3. YANG Model
This YANG module has a normative references to [RFC6991], and This YANG module has a normative references to [RFC6991], and
[I-D.ietf-netconf-keystore]. [I-D.ietf-netconf-keystore].
<CODE BEGINS> file "ietf-tls-server@2017-06-13.yang" <CODE BEGINS> file "ietf-tls-server@2017-10-19.yang"
module ietf-tls-server { module ietf-tls-server {
yang-version 1.1; yang-version 1.1;
Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
namespace "urn:ietf:params:xml:ns:yang:ietf-tls-server"; namespace "urn:ietf:params:xml:ns:yang:ietf-tls-server";
prefix "tlss"; prefix "tlss";
import ietf-tls-common { import ietf-tls-common {
prefix tlscom; prefix tlscmn;
revision-date 2017-06-13; // stable grouping definitions revision-date 2017-10-19; // stable grouping definitions
reference reference
"RFC XXXX: TLS Client and Server Models"; "RFC XXXX: YANG Groupings for TLS Clients and TLS Servers";
} }
import ietf-keystore { import ietf-keystore {
prefix ks; prefix ks;
reference reference
"RFC YYYY: Keystore Model"; "RFC YYYY: Keystore Model";
} }
organization organization
"IETF NETCONF (Network Configuration) Working Group"; "IETF NETCONF (Network Configuration) Working Group";
contact contact
"WG Web: <http://tools.ietf.org/wg/netconf/> "WG Web: <http://tools.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org> WG List: <mailto:netconf@ietf.org>
Author: Kent Watsen Author: Kent Watsen
<mailto:kwatsen@juniper.net>"; <mailto:kwatsen@juniper.net>
Author: Gary Wu
<mailto:garywu@cisco.com>";
description description
"This module defines a reusable grouping for a TLS server that "This module defines a reusable grouping for a TLS server that
can be used as a basis for specific TLS server instances. can be used as a basis for specific TLS server instances.
Copyright (c) 2014 IETF Trust and the persons identified as Copyright (c) 2017 IETF Trust and the persons identified as
authors of the code. All rights reserved. authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD to the license terms contained in, the Simplified BSD
License set forth in Section 4.c of the IETF Trust's License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents Legal Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info). (http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices."; the RFC itself for full legal notices.";
revision "2017-06-13" { revision "2017-10-19" {
Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
description description
"Initial version"; "Initial version";
reference reference
"RFC XXXX: TLS Client and Server Models"; "RFC XXXX: YANG Groupings for TLS Clients and TLS Servers";
} }
feature tls-server-hello-params-config { feature tls-server-hello-params-config {
description description
"TLS hello message parameters are configurable on a TLS "TLS hello message parameters are configurable on a TLS
server."; server.";
} }
// grouping // groupings
grouping tls-server-grouping { grouping tls-server-grouping {
description description
"A reusable grouping for configuring a TLS server without "A reusable grouping for configuring a TLS server without
any consideration for how underlying TCP sessions are any consideration for how underlying TCP sessions are
established."; established.";
container certificates { container certificates {
description description
"The list of certificates the TLS server will present when "The list of certificates the TLS server will present when
establishing a TLS connection in its Certificate message, establishing a TLS connection in its Certificate message,
as defined in Section 7.4.2 in RRC 5246."; as defined in Section 7.4.2 in RFC 5246.";
reference reference
"RFC 5246: "RFC 5246:
The Transport Layer Security (TLS) Protocol Version 1.2"; The Transport Layer Security (TLS) Protocol Version 1.2";
list certificate { list certificate {
key name; key name;
min-elements 1; min-elements 1;
description description
"An unordered list of certificates the TLS server can pick "An unordered list of certificates the TLS server can pick
from when sending its Server Certificate message."; from when sending its Server Certificate message.";
reference reference
skipping to change at page 12, line 9 skipping to change at page 12, line 5
type leafref { type leafref {
path "/ks:keystore/ks:keys/ks:key/ks:certificates/" path "/ks:keystore/ks:keys/ks:key/ks:certificates/"
+ "ks:certificate/ks:name"; + "ks:certificate/ks:name";
} }
description description
"The name of the certificate in the keystore."; "The name of the certificate in the keystore.";
} }
} }
} }
Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
container client-auth { container client-auth {
description description
"A reference to a list of trusted certificate authority (CA) "A reference to a list of pinned certificate authority (CA)
certificates and a reference to a list of trusted client certificates and a reference to a list of pinned client
certificates."; certificates.";
leaf trusted-ca-certs { leaf pinned-ca-certs {
type leafref { type leafref {
path "/ks:keystore/ks:trusted-certificates/ks:name"; path "/ks:keystore/ks:pinned-certificates/ks:name";
} }
description description
"A reference to a list of certificate authority (CA) "A reference to a list of certificate authority (CA)
certificates used by the TLS server to authenticate certificates used by the TLS server to authenticate
TLS client certificates."; TLS client certificates. A client certificate is
authenticated if it has a valid chain of trust to
a configured pinned CA certificate.";
} }
leaf trusted-client-certs { leaf pinned-client-certs {
type leafref { type leafref {
path "/ks:keystore/ks:trusted-certificates/ks:name"; path "/ks:keystore/ks:pinned-certificates/ks:name";
} }
description description
"A reference to a list of client certificates used by "A reference to a list of client certificates used by
the TLS server to authenticate TLS client certificates. the TLS server to authenticate TLS client certificates.
A clients certificate is authenticated if it is an A clients certificate is authenticated if it is an
exact match to a configured trusted client certificate."; exact match to a configured pinned client certificate.";
} }
} }
container hello-params { container hello-params {
if-feature tls-server-hello-params-config; if-feature tls-server-hello-params-config;
uses tlscom:hello-params-grouping; uses tlscmn:hello-params-grouping;
description description
"Configurable parameters for the TLS hello message."; "Configurable parameters for the TLS hello message.";
} }
} // end tls-server-grouping } // end tls-server-grouping
} }
<CODE ENDS> <CODE ENDS>
4. The TLS Common Model 4. The TLS Common Model
The TLS common model presented in this section contains identities The TLS common model presented in this section contains identities
and groupings common to both TLS clients and TLS servers. The hello- and groupings common to both TLS clients and TLS servers. The hello-
params-grouping can be used to configure the list of TLS algorithms params-grouping can be used to configure the list of TLS algorithms
permitted by the TLS client or TLS server. The lists of algorithms permitted by the TLS client or TLS server. The lists of algorithms
are ordered such that, if multiple algorithms are permitted by the are ordered such that, if multiple algorithms are permitted by the
client, the algorithm that appears first in its list that is also client, the algorithm that appears first in its list that is also
skipping to change at page 13, line 13 skipping to change at page 13, line 4
<CODE ENDS> <CODE ENDS>
4. The TLS Common Model 4. The TLS Common Model
The TLS common model presented in this section contains identities The TLS common model presented in this section contains identities
and groupings common to both TLS clients and TLS servers. The hello- and groupings common to both TLS clients and TLS servers. The hello-
params-grouping can be used to configure the list of TLS algorithms params-grouping can be used to configure the list of TLS algorithms
permitted by the TLS client or TLS server. The lists of algorithms permitted by the TLS client or TLS server. The lists of algorithms
are ordered such that, if multiple algorithms are permitted by the are ordered such that, if multiple algorithms are permitted by the
client, the algorithm that appears first in its list that is also client, the algorithm that appears first in its list that is also
Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
permitted by the server is used for the TLS transport layer permitted by the server is used for the TLS transport layer
connection. The ability to restrict the the algorithms allowed is connection. The ability to restrict the the algorithms allowed is
provided in this grouping for TLS clients and TLS servers that are provided in this grouping for TLS clients and TLS servers that are
capable of doing so and may serve to make TLS clients and TLS servers capable of doing so and may serve to make TLS clients and TLS servers
compliant with security policies. compliant with security policies.
Features are defined for algorithms that are OPTIONAL or are not Features are defined for algorithms that are OPTIONAL or are not
widely supported by popular implementations. Note that the list of widely supported by popular implementations. Note that the list of
algorithms is not exhaustive. algorithms is not exhaustive.
4.1. Tree Diagram 4.1. Tree Diagram
The following tree diagram presents the data model for the grouping The following tree diagram presents the data model for the grouping
defined in the ietf-tls-common module. Please see Section 1.2 for defined in the ietf-tls-common module. Please see Section 1.2 for
tree diagram notation. tree diagram notation.
module: ietf-tls-common module: ietf-tls-common
groupings:
hello-params-grouping grouping hello-params-grouping
+---- tls-versions +---- tls-versions
| +---- tls-version* identityref | +---- tls-version* identityref
+---- cipher-suites +---- cipher-suites
+---- cipher-suite* identityref +---- cipher-suite* identityref
4.2. Example Usage 4.2. Example Usage
This section shows how it would appear if the transport-params- This section shows how it would appear if the transport-params-
grouping were populated with some data. grouping were populated with some data.
<!-- hypothetical example, as groupings don't have instance data --> <!-- hypothetical example, as groupings don't have instance data -->
<hello-params xmlns="urn:ietf:params:xml:ns:yang:ietf-tls-common"> <hello-params
xmlns:tlscmn="urn:ietf:params:xml:ns:yang:ietf-tls-common">
<tls-versions> <tls-versions>
<tls-version>tls-1.2</tls-version> <tls-version>tlscmn:tls-1.1</tls-version>
<tls-version>tlscmn:tls-1.2</tls-version>
</tls-versions> </tls-versions>
<cipher-suites> <cipher-suites>
<cipher-suite>ecdhe-rsa-with-3des-ede-cbc-sha</cipher-suite> <cipher-suite>tlscmn:dhe-rsa-with-aes-128-cbc-sha</cipher-suite>
<cipher-suite>dhe-rsa-with-aes-128-cbc-sha</cipher-suite> <cipher-suite>tlscmn:rsa-with-aes-128-cbc-sha</cipher-suite>
<cipher-suite>rsa-with-aes-128-cbc-sha</cipher-suite> <cipher-suite>tlscmn:rsa-with-3des-ede-cbc-sha</cipher-suite>
<cipher-suite>rsa-with-3des-ede-cbc-sha</cipher-suite>
</cipher-suites> </cipher-suites>
</hello-params> </hello-params>
4.3. YANG Model 4.3. YANG Model
This YANG module has a normative references to [RFC4492], [RFC5246], This YANG module has a normative references to [RFC2246], [RFC4346],
[RFC5288], and [RFC5289]. [RFC4492], [RFC5246], [RFC5288], and [RFC5289].
<CODE BEGINS> file "ietf-tls-common@2017-06-13.yang" Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
module ietf-tls-common { <CODE BEGINS> file "ietf-tls-common@2017-10-19.yang"
yang-version 1.1; module ietf-tls-common {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-tls-common"; namespace "urn:ietf:params:xml:ns:yang:ietf-tls-common";
prefix "tlscom"; prefix "tlscmn";
organization organization
"IETF NETCONF (Network Configuration) Working Group"; "IETF NETCONF (Network Configuration) Working Group";
contact contact
"WG Web: <http://tools.ietf.org/wg/netconf/> "WG Web: <http://tools.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org> WG List: <mailto:netconf@ietf.org>
Author: Kent Watsen Author: Kent Watsen
<mailto:kwatsen@juniper.net> <mailto:kwatsen@juniper.net>
Author: Gary Wu Author: Gary Wu
<mailto:garywu@cisco.com>"; <mailto:garywu@cisco.com>";
description description
"This module defines a common features, identities, and groupings "This module defines a common features, identities, and groupings
for Transport Layer Security (TLS). for Transport Layer Security (TLS).
Copyright (c) 2017 IETF Trust and the persons identified as Copyright (c) 2017 IETF Trust and the persons identified as
authors of the code. All rights reserved. authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD to the license terms contained in, the Simplified BSD
License set forth in Section 4.c of the IETF Trust's License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents Legal Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info). (http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices."; the RFC itself for full legal notices.";
revision "2017-06-13" { revision "2017-10-19" {
description description
"Initial version"; "Initial version";
reference reference
"RFC XXXX: TLS Client and Server Models"; "RFC XXXX: YANG Groupings for TLS Clients and TLS Servers";
} }
// features // features
feature tls-ecc { feature tls-1_0 {
description description
"Elliptic Curve Cryptography (ECC) is supported for TLS.";
reference
"RFC 4492: Elliptic Curve Cryptography (ECC) Cipher Suites
for Transport Layer Security (TLS)";
}
feature tls-dhe { Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
description
"Ephemeral Diffie-Hellman key exchange is supported for TLS.";
reference
"RFC 5246: The Transport Layer Security (TLS) Protocol
Version 1.2";
}
feature tls-3des { "TLS Protocol Version 1.0 is supported.";
description reference
"The Triple-DES block cipher is supported for TLS."; "RFC 2246: The TLS Protocol Version 1.0";
reference }
"RFC 5246: The Transport Layer Security (TLS) Protocol
Version 1.2";
}
feature tls-gcm { feature tls-1_1 {
description description
"The Galois/Counter Mode authenticated encryption mode is "TLS Protocol Version 1.1 is supported.";
supported for TLS."; reference
"RFC 4346: The Transport Layer Security (TLS) Protocol
Version 1.1";
}
reference feature tls-1_2 {
"RFC 5288: AES Galois Counter Mode (GCM) Cipher Suites for TLS"; description
} "TLS Protocol Version 1.2 is supported.";
reference
"RFC 5246: The Transport Layer Security (TLS) Protocol
Version 1.2";
}
feature tls-sha2 { feature tls-ecc {
description description
"The SHA2 family of cryptographic hash functions is supported "Elliptic Curve Cryptography (ECC) is supported for TLS.";
for TLS."; reference
reference "RFC 4492: Elliptic Curve Cryptography (ECC) Cipher Suites
"FIPS PUB 180-4: Secure Hash Standard (SHS)"; for Transport Layer Security (TLS)";
} }
// identities feature tls-dhe {
identity tls-version-base { description
description "Ephemeral Diffie-Hellman key exchange is supported for TLS.";
"Base identity used to identify TLS protocol versions."; reference
} "RFC 5246: The Transport Layer Security (TLS) Protocol
Version 1.2";
}
identity tls-1.2 { feature tls-3des {
base tls-version-base; description
description "The Triple-DES block cipher is supported for TLS.";
"TLS protocol version 1.2."; reference
reference "RFC 5246: The Transport Layer Security (TLS) Protocol
"RFC 5246: The Transport Layer Security (TLS) Protocol Version 1.2";
Version 1.2"; }
}
identity cipher-suite-base { feature tls-gcm {
description description
"Base identity used to identify TLS cipher suites."; "The Galois/Counter Mode authenticated encryption mode is
}
identity rsa-with-aes-128-cbc-sha { Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
base cipher-suite-base;
description
"Cipher suite TLS_RSA_WITH_AES_128_CBC_SHA.";
reference
"RFC 5246: The Transport Layer Security (TLS) Protocol
Version 1.2";
}
identity rsa-with-aes-256-cbc-sha { supported for TLS.";
base cipher-suite-base; reference
description "RFC 5288: AES Galois Counter Mode (GCM) Cipher Suites for
"Cipher suite TLS_RSA_WITH_AES_256_CBC_SHA."; TLS";
reference }
"RFC 5246: The Transport Layer Security (TLS) Protocol
Version 1.2";
} feature tls-sha2 {
description
"The SHA2 family of cryptographic hash functions is supported
for TLS.";
reference
"FIPS PUB 180-4: Secure Hash Standard (SHS)";
}
identity rsa-with-aes-128-cbc-sha256 { // identities
base cipher-suite-base; identity tls-version-base {
if-feature tls-sha2; description
description "Base identity used to identify TLS protocol versions.";
"Cipher suite TLS_RSA_WITH_AES_128_CBC_SHA256."; }
reference
"RFC 5246: The Transport Layer Security (TLS) Protocol
Version 1.2";
}
identity rsa-with-aes-256-cbc-sha256 { identity tls-1.0 {
base cipher-suite-base; base tls-version-base;
if-feature tls-sha2; if-feature tls-1_0;
description description
"Cipher suite TLS_RSA_WITH_AES_256_CBC_SHA256."; "TLS Protocol Version 1.0.";
reference reference
"RFC 5246: The Transport Layer Security (TLS) Protocol "RFC 2246: The TLS Protocol Version 1.0";
Version 1.2"; }
}
identity dhe-rsa-with-aes-128-cbc-sha { identity tls-1.1 {
base cipher-suite-base; base tls-version-base;
if-feature tls-dhe; if-feature tls-1_1;
description description
"Cipher suite TLS_DHE_RSA_WITH_AES_128_CBC_SHA."; "TLS Protocol Version 1.1.";
reference reference
"RFC 5246: The Transport Layer Security (TLS) Protocol "RFC 4346: The Transport Layer Security (TLS) Protocol
Version 1.2"; Version 1.1";
} }
identity dhe-rsa-with-aes-256-cbc-sha { identity tls-1.2 {
base cipher-suite-base; base tls-version-base;
if-feature tls-dhe; if-feature tls-1_2;
description description
"Cipher suite TLS_DHE_RSA_WITH_AES_256_CBC_SHA."; "TLS Protocol Version 1.2.";
reference reference
"RFC 5246: The Transport Layer Security (TLS) Protocol "RFC 5246: The Transport Layer Security (TLS) Protocol
Version 1.2"; Version 1.2";
} }
identity dhe-rsa-with-aes-128-cbc-sha256 { Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
base cipher-suite-base;
if-feature "tls-dhe and tls-sha2";
description
"Cipher suite TLS_DHE_RSA_WITH_AES_128_CBC_SHA256.";
reference
"RFC 5246: The Transport Layer Security (TLS) Protocol
Version 1.2";
}
identity dhe-rsa-with-aes-256-cbc-sha256 { identity cipher-suite-base {
base cipher-suite-base; description
if-feature "tls-dhe and tls-sha2"; "Base identity used to identify TLS cipher suites.";
description }
"Cipher suite TLS_DHE_RSA_WITH_AES_256_CBC_SHA256.";
reference
"RFC 5246: The Transport Layer Security (TLS) Protocol
Version 1.2";
}
identity ecdhe-ecdsa-with-aes-128-cbc-sha256 { identity rsa-with-aes-128-cbc-sha {
base cipher-suite-base; base cipher-suite-base;
if-feature "tls-ecc and tls-sha2"; description
description "Cipher suite TLS_RSA_WITH_AES_128_CBC_SHA.";
"Cipher suite TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256."; reference
reference "RFC 5246: The Transport Layer Security (TLS) Protocol
"RFC 5289: TLS Elliptic Curve Cipher Suites with Version 1.2";
SHA-256/384 and AES Galois Counter Mode (GCM)"; }
}
identity ecdhe-ecdsa-with-aes-256-cbc-sha384 { identity rsa-with-aes-256-cbc-sha {
base cipher-suite-base; base cipher-suite-base;
if-feature "tls-ecc and tls-sha2"; description
description "Cipher suite TLS_RSA_WITH_AES_256_CBC_SHA.";
"Cipher suite TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384."; reference
reference "RFC 5246: The Transport Layer Security (TLS) Protocol
"RFC 5289: TLS Elliptic Curve Cipher Suites with Version 1.2";
SHA-256/384 and AES Galois Counter Mode (GCM)"; }
}
identity ecdhe-rsa-with-aes-128-cbc-sha256 { identity rsa-with-aes-128-cbc-sha256 {
base cipher-suite-base; base cipher-suite-base;
if-feature "tls-ecc and tls-sha2"; if-feature tls-sha2;
description description
"Cipher suite TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256."; "Cipher suite TLS_RSA_WITH_AES_128_CBC_SHA256.";
reference reference
"RFC 5289: TLS Elliptic Curve Cipher Suites with "RFC 5246: The Transport Layer Security (TLS) Protocol
SHA-256/384 and AES Galois Counter Mode (GCM)"; Version 1.2";
} }
identity ecdhe-rsa-with-aes-256-cbc-sha384 { identity rsa-with-aes-256-cbc-sha256 {
base cipher-suite-base; base cipher-suite-base;
if-feature "tls-ecc and tls-sha2"; if-feature tls-sha2;
description description
"Cipher suite TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384."; "Cipher suite TLS_RSA_WITH_AES_256_CBC_SHA256.";
reference reference
"RFC 5289: TLS Elliptic Curve Cipher Suites with "RFC 5246: The Transport Layer Security (TLS) Protocol
SHA-256/384 and AES Galois Counter Mode (GCM)"; Version 1.2";
} }
identity ecdhe-ecdsa-with-aes-128-gcm-sha256 { identity dhe-rsa-with-aes-128-cbc-sha {
base cipher-suite-base; base cipher-suite-base;
if-feature "tls-ecc and tls-gcm and tls-sha2"; if-feature tls-dhe;
description description
"Cipher suite TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256."; "Cipher suite TLS_DHE_RSA_WITH_AES_128_CBC_SHA.";
reference
"RFC 5289: TLS Elliptic Curve Cipher Suites with
SHA-256/384 and AES Galois Counter Mode (GCM)";
}
identity ecdhe-ecdsa-with-aes-256-gcm-sha384 { Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
base cipher-suite-base;
if-feature "tls-ecc and tls-gcm and tls-sha2";
description
"Cipher suite TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384.";
reference
"RFC 5289: TLS Elliptic Curve Cipher Suites with
SHA-256/384 and AES Galois Counter Mode (GCM)";
}
identity ecdhe-rsa-with-aes-128-gcm-sha256 { reference
base cipher-suite-base; "RFC 5246: The Transport Layer Security (TLS) Protocol
if-feature "tls-ecc and tls-gcm and tls-sha2"; Version 1.2";
description }
"Cipher suite TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256.";
reference
"RFC 5289: TLS Elliptic Curve Cipher Suites with
SHA-256/384 and AES Galois Counter Mode (GCM)";
}
identity ecdhe-rsa-with-aes-256-gcm-sha384 { identity dhe-rsa-with-aes-256-cbc-sha {
base cipher-suite-base; base cipher-suite-base;
if-feature "tls-ecc and tls-gcm and tls-sha2"; if-feature tls-dhe;
description description
"Cipher suite TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384."; "Cipher suite TLS_DHE_RSA_WITH_AES_256_CBC_SHA.";
reference reference
"RFC 5289: TLS Elliptic Curve Cipher Suites with "RFC 5246: The Transport Layer Security (TLS) Protocol
SHA-256/384 and AES Galois Counter Mode (GCM)"; Version 1.2";
} }
identity rsa-with-3des-ede-cbc-sha { identity dhe-rsa-with-aes-128-cbc-sha256 {
base cipher-suite-base; base cipher-suite-base;
if-feature tls-3des; if-feature "tls-dhe and tls-sha2";
description description
"Cipher suite TLS_RSA_WITH_3DES_EDE_CBC_SHA."; "Cipher suite TLS_DHE_RSA_WITH_AES_128_CBC_SHA256.";
reference reference
"RFC 5246: The Transport Layer Security (TLS) Protocol "RFC 5246: The Transport Layer Security (TLS) Protocol
Version 1.2"; Version 1.2";
} }
identity ecdhe-rsa-with-3des-ede-cbc-sha { identity dhe-rsa-with-aes-256-cbc-sha256 {
base cipher-suite-base; base cipher-suite-base;
if-feature "tls-ecc and tls-3des"; if-feature "tls-dhe and tls-sha2";
description description
"Cipher suite TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA."; "Cipher suite TLS_DHE_RSA_WITH_AES_256_CBC_SHA256.";
reference reference
"RFC 4492: Elliptic Curve Cryptography (ECC) Cipher Suites "RFC 5246: The Transport Layer Security (TLS) Protocol
for Transport Layer Security (TLS)"; Version 1.2";
} }
identity ecdhe-rsa-with-aes-128-cbc-sha { identity ecdhe-ecdsa-with-aes-128-cbc-sha256 {
base cipher-suite-base; base cipher-suite-base;
if-feature "tls-ecc"; if-feature "tls-ecc and tls-sha2";
description description
"Cipher suite TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA."; "Cipher suite TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256.";
reference reference
"RFC 4492: Elliptic Curve Cryptography (ECC) Cipher Suites "RFC 5289: TLS Elliptic Curve Cipher Suites with
for Transport Layer Security (TLS)"; SHA-256/384 and AES Galois Counter Mode (GCM)";
} }
identity ecdhe-rsa-with-aes-256-cbc-sha { identity ecdhe-ecdsa-with-aes-256-cbc-sha384 {
base cipher-suite-base; base cipher-suite-base;
if-feature "tls-ecc"; if-feature "tls-ecc and tls-sha2";
description
"Cipher suite TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA.";
reference
"RFC 4492: Elliptic Curve Cryptography (ECC) Cipher Suites
for Transport Layer Security (TLS)";
}
// groupings Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
grouping hello-params-grouping {
description
"A reusable grouping for TLS hello message parameters. For
configurable parameters, a zero-element leaf-list indicates the
system default configuration for that parameter.";
reference
"RFC 5246: The Transport Layer Security (TLS) Protocol
Version 1.2";
container tls-versions {
description
"Parameters regarding TLS versions.";
leaf-list tls-version {
type identityref {
base tls-version-base;
}
description
"Allowed TLS protocol versions.";
}
}
container cipher-suites {
description
"Parameters regarding cipher suites.";
leaf-list cipher-suite {
type identityref {
base cipher-suite-base;
}
ordered-by user;
description
"Cipher suites in order of descending preference.";
}
}
}
}
<CODE ENDS> description
"Cipher suite TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384.";
reference
"RFC 5289: TLS Elliptic Curve Cipher Suites with
SHA-256/384 and AES Galois Counter Mode (GCM)";
}
identity ecdhe-rsa-with-aes-128-cbc-sha256 {
base cipher-suite-base;
if-feature "tls-ecc and tls-sha2";
description
"Cipher suite TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256.";
reference
"RFC 5289: TLS Elliptic Curve Cipher Suites with
SHA-256/384 and AES Galois Counter Mode (GCM)";
}
identity ecdhe-rsa-with-aes-256-cbc-sha384 {
base cipher-suite-base;
if-feature "tls-ecc and tls-sha2";
description
"Cipher suite TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384.";
reference
"RFC 5289: TLS Elliptic Curve Cipher Suites with
SHA-256/384 and AES Galois Counter Mode (GCM)";
}
identity ecdhe-ecdsa-with-aes-128-gcm-sha256 {
base cipher-suite-base;
if-feature "tls-ecc and tls-gcm and tls-sha2";
description
"Cipher suite TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256.";
reference
"RFC 5289: TLS Elliptic Curve Cipher Suites with
SHA-256/384 and AES Galois Counter Mode (GCM)";
}
identity ecdhe-ecdsa-with-aes-256-gcm-sha384 {
base cipher-suite-base;
if-feature "tls-ecc and tls-gcm and tls-sha2";
description
"Cipher suite TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384.";
reference
"RFC 5289: TLS Elliptic Curve Cipher Suites with
SHA-256/384 and AES Galois Counter Mode (GCM)";
}
identity ecdhe-rsa-with-aes-128-gcm-sha256 {
Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
base cipher-suite-base;
if-feature "tls-ecc and tls-gcm and tls-sha2";
description
"Cipher suite TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256.";
reference
"RFC 5289: TLS Elliptic Curve Cipher Suites with
SHA-256/384 and AES Galois Counter Mode (GCM)";
}
identity ecdhe-rsa-with-aes-256-gcm-sha384 {
base cipher-suite-base;
if-feature "tls-ecc and tls-gcm and tls-sha2";
description
"Cipher suite TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384.";
reference
"RFC 5289: TLS Elliptic Curve Cipher Suites with
SHA-256/384 and AES Galois Counter Mode (GCM)";
}
identity rsa-with-3des-ede-cbc-sha {
base cipher-suite-base;
if-feature tls-3des;
description
"Cipher suite TLS_RSA_WITH_3DES_EDE_CBC_SHA.";
reference
"RFC 5246: The Transport Layer Security (TLS) Protocol
Version 1.2";
}
identity ecdhe-rsa-with-3des-ede-cbc-sha {
base cipher-suite-base;
if-feature "tls-ecc and tls-3des";
description
"Cipher suite TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA.";
reference
"RFC 4492: Elliptic Curve Cryptography (ECC) Cipher Suites
for Transport Layer Security (TLS)";
}
identity ecdhe-rsa-with-aes-128-cbc-sha {
base cipher-suite-base;
if-feature "tls-ecc";
description
"Cipher suite TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA.";
reference
"RFC 4492: Elliptic Curve Cryptography (ECC) Cipher Suites
for Transport Layer Security (TLS)";
}
Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
identity ecdhe-rsa-with-aes-256-cbc-sha {
base cipher-suite-base;
if-feature "tls-ecc";
description
"Cipher suite TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA.";
reference
"RFC 4492: Elliptic Curve Cryptography (ECC) Cipher Suites
for Transport Layer Security (TLS)";
}
// groupings
grouping hello-params-grouping {
description
"A reusable grouping for TLS hello message parameters.";
reference
"RFC 5246: The Transport Layer Security (TLS) Protocol
Version 1.2";
container tls-versions {
description
"Parameters regarding TLS versions.";
leaf-list tls-version {
type identityref {
base tls-version-base;
}
description
"Acceptable TLS protocol versions.
If this leaf-list is not configured (has zero elements)
the acceptable TLS protocol versions are implementation-
defined.";
}
}
container cipher-suites {
description
"Parameters regarding cipher suites.";
leaf-list cipher-suite {
type identityref {
base cipher-suite-base;
}
ordered-by user;
description
"Acceptable cipher suites in order of descending
preference.
If this leaf-list is not configured (has zero elements)
the acceptable cipher suites are implementation-
Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
defined.";
}
}
} // end hello-params-grouping
}
<CODE ENDS>
5. Security Considerations 5. Security Considerations
The YANG module defined in this document is designed to be accessed The YANG modules defined in this document are designed to be accessed
via YANG based management protocols, such as NETCONF [RFC6241] and via YANG based management protocols, such as NETCONF [RFC6241] and
RESTCONF [RFC8040]. Both of these protocols have mandatory-to- RESTCONF [RFC8040]. Both of these protocols have mandatory-to-
implement secure transport layers (e.g., SSH, TLS) with mutual implement secure transport layers (e.g., SSH, TLS) with mutual
authentication. authentication.
The NETCONF access control model (NACM) [RFC6536] provides the means The NETCONF access control model (NACM) [RFC6536] provides the means
to restrict access for particular users to a pre-configured subset of to restrict access for particular users to a pre-configured subset of
all available protocol operations and content. all available protocol operations and content.
There are a number of data nodes defined in this YANG module that are Since the modules defined 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 in the YANG modules that are
writable/creatable/deletable (i.e., config true, which is the writable/creatable/deletable (i.e., config true, which is the
default). These data nodes may be considered sensitive or vulnerable default). These data nodes may be considered sensitive or vulnerable
in some network environments. Write operations (e.g., edit-config) in some network environments. Write operations (e.g., edit-config)
to these data nodes without proper protection can have a negative to these data nodes without proper protection can have a negative
effect on network operations. These are the subtrees and data nodes effect on network operations. These are the subtrees and data nodes
and their sensitivity/vulnerability: and their sensitivity/vulnerability:
/: The entire data tree defined by this module is sensitive to /: The entire data tree of all the groupings defined in this draft
write operations. For instance, the addition or removal of is sensitive to write operations. For instance, the addition
references to keys, certificates, trusted anchors, etc., can or removal of references to keys, certificates, trusted
dramatically alter the implemented security policy. However, anchors, etc., can dramatically alter the implemented security
no NACM annotations are applied as the data SHOULD be editable policy. However, no NACM annotations are applied as the data
by users other than a designated 'recovery session'. SHOULD be editable by users other than a designated 'recovery
session'.
Some of the readable data nodes in this YANG module may be considered Some of the readable data nodes in the YANG modules may be considered
sensitive or vulnerable in some network environments. It is thus sensitive or vulnerable in some network environments. It is thus
important to control read access (e.g., via get, get-config, or important to control read access (e.g., via get, get-config, or
notification) to these data nodes. These are the subtrees and data notification) to these data nodes. These are the subtrees and data
nodes and their sensitivity/vulnerability: nodes and their sensitivity/vulnerability:
NONE NONE
Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
Some of the RPC operations in this YANG module may be considered Some of the RPC operations in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus sensitive or vulnerable in some network environments. It is thus
important to control access to these operations. These are the important to control access to these operations. These are the
operations and their sensitivity/vulnerability: operations and their sensitivity/vulnerability:
NONE NONE
6. IANA Considerations 6. IANA Considerations
6.1. The IETF XML Registry 6.1. The IETF XML Registry
skipping to change at page 23, line 17 skipping to change at page 23, line 52
prefix: tlsc prefix: tlsc
reference: RFC XXXX reference: RFC XXXX
name: ietf-tls-server name: ietf-tls-server
namespace: urn:ietf:params:xml:ns:yang:ietf-tls-server namespace: urn:ietf:params:xml:ns:yang:ietf-tls-server
prefix: tlss prefix: tlss
reference: RFC XXXX reference: RFC XXXX
name: ietf-tls-common name: ietf-tls-common
namespace: urn:ietf:params:xml:ns:yang:ietf-tls-common namespace: urn:ietf:params:xml:ns:yang:ietf-tls-common
prefix: tlss prefix: tlscmn
reference: RFC XXXX reference: RFC XXXX
Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
7. Acknowledgements 7. 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): Andy Bierman, Martin on list and in the halls (ordered by last name): Andy Bierman, Martin
Bjorklund, Benoit Claise, Mehmet Ersue, Balazs Kovacs, David Bjorklund, Benoit Claise, Mehmet Ersue, Balazs Kovacs, David
Lamparter, Alan Luchuk, Ladislav Lhotka, Radek Krejci, Tom Petch, Lamparter, Alan Luchuk, Ladislav Lhotka, Radek Krejci, Tom Petch,
Juergen Schoenwaelder, Phil Shafer, Sean Turner, and Bert Wijnen. Juergen Schoenwaelder, Phil Shafer, Sean Turner, and Bert Wijnen.
8. References 8. References
8.1. Normative References 8.1. Normative References
[I-D.ietf-netconf-keystore] [I-D.ietf-netconf-keystore]
Watsen, K., "Keystore Model", draft-ietf-netconf- Watsen, K., "Keystore Model", draft-ietf-netconf-
keystore-01 (work in progress), March 2017. keystore-02 (work in progress), June 2017.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997, DOI 10.17487/RFC2119, March 1997,
<http://www.rfc-editor.org/info/rfc2119>. <https://www.rfc-editor.org/info/rfc2119>.
[RFC2246] Dierks, T. and C. Allen, "The TLS Protocol Version 1.0",
RFC 2246, DOI 10.17487/RFC2246, January 1999,
<https://www.rfc-editor.org/info/rfc2246>.
[RFC4346] Dierks, T. and E. Rescorla, "The Transport Layer Security
(TLS) Protocol Version 1.1", RFC 4346,
DOI 10.17487/RFC4346, April 2006,
<https://www.rfc-editor.org/info/rfc4346>.
[RFC4492] Blake-Wilson, S., Bolyard, N., Gupta, V., Hawk, C., and B. [RFC4492] Blake-Wilson, S., Bolyard, N., Gupta, V., Hawk, C., and B.
Moeller, "Elliptic Curve Cryptography (ECC) Cipher Suites Moeller, "Elliptic Curve Cryptography (ECC) Cipher Suites
for Transport Layer Security (TLS)", RFC 4492, for Transport Layer Security (TLS)", RFC 4492,
DOI 10.17487/RFC4492, May 2006, DOI 10.17487/RFC4492, May 2006,
<http://www.rfc-editor.org/info/rfc4492>. <https://www.rfc-editor.org/info/rfc4492>.
[RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security [RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security
(TLS) Protocol Version 1.2", RFC 5246, (TLS) Protocol Version 1.2", RFC 5246,
DOI 10.17487/RFC5246, August 2008, DOI 10.17487/RFC5246, August 2008,
<http://www.rfc-editor.org/info/rfc5246>. <https://www.rfc-editor.org/info/rfc5246>.
[RFC5288] Salowey, J., Choudhury, A., and D. McGrew, "AES Galois [RFC5288] Salowey, J., Choudhury, A., and D. McGrew, "AES Galois
Counter Mode (GCM) Cipher Suites for TLS", RFC 5288, Counter Mode (GCM) Cipher Suites for TLS", RFC 5288,
DOI 10.17487/RFC5288, August 2008, DOI 10.17487/RFC5288, August 2008,
<http://www.rfc-editor.org/info/rfc5288>. <https://www.rfc-editor.org/info/rfc5288>.
Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
[RFC5289] Rescorla, E., "TLS Elliptic Curve Cipher Suites with SHA- [RFC5289] Rescorla, E., "TLS Elliptic Curve Cipher Suites with SHA-
256/384 and AES Galois Counter Mode (GCM)", RFC 5289, 256/384 and AES Galois Counter Mode (GCM)", RFC 5289,
DOI 10.17487/RFC5289, August 2008, DOI 10.17487/RFC5289, August 2008,
<http://www.rfc-editor.org/info/rfc5289>. <https://www.rfc-editor.org/info/rfc5289>.
[RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration
Protocol (NETCONF) Access Control Model", RFC 6536, Protocol (NETCONF) Access Control Model", RFC 6536,
DOI 10.17487/RFC6536, March 2012, DOI 10.17487/RFC6536, March 2012,
<http://www.rfc-editor.org/info/rfc6536>. <https://www.rfc-editor.org/info/rfc6536>.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6991, DOI 10.17487/RFC6991, July 2013, RFC 6991, DOI 10.17487/RFC6991, July 2013,
<http://www.rfc-editor.org/info/rfc6991>. <https://www.rfc-editor.org/info/rfc6991>.
[RFC7589] Badra, M., Luchuk, A., and J. Schoenwaelder, "Using the [RFC7589] Badra, M., Luchuk, A., and J. Schoenwaelder, "Using the
NETCONF Protocol over Transport Layer Security (TLS) with NETCONF Protocol over Transport Layer Security (TLS) with
Mutual X.509 Authentication", RFC 7589, Mutual X.509 Authentication", RFC 7589,
DOI 10.17487/RFC7589, June 2015, DOI 10.17487/RFC7589, June 2015,
<http://www.rfc-editor.org/info/rfc7589>. <https://www.rfc-editor.org/info/rfc7589>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016, RFC 7950, DOI 10.17487/RFC7950, August 2016,
<http://www.rfc-editor.org/info/rfc7950>. <https://www.rfc-editor.org/info/rfc7950>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
8.2. Informative References 8.2. Informative References
[RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, [RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818,
DOI 10.17487/RFC2818, May 2000, DOI 10.17487/RFC2818, May 2000,
<http://www.rfc-editor.org/info/rfc2818>. <https://www.rfc-editor.org/info/rfc2818>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004, DOI 10.17487/RFC3688, January 2004,
<http://www.rfc-editor.org/info/rfc3688>. <https://www.rfc-editor.org/info/rfc3688>.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<http://www.rfc-editor.org/info/rfc6241>. <https://www.rfc-editor.org/info/rfc6241>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<http://www.rfc-editor.org/info/rfc8040>. <https://www.rfc-editor.org/info/rfc8040>.
Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
[RFC8071] Watsen, K., "NETCONF Call Home and RESTCONF Call Home", [RFC8071] Watsen, K., "NETCONF Call Home and RESTCONF Call Home",
RFC 8071, DOI 10.17487/RFC8071, February 2017, RFC 8071, DOI 10.17487/RFC8071, February 2017,
<http://www.rfc-editor.org/info/rfc8071>. <https://www.rfc-editor.org/info/rfc8071>.
Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
Appendix A. Change Log Appendix A. Change Log
A.1. server-model-09 to 00 A.1. server-model-09 to 00
o This draft was split out from draft-ietf-netconf-server-model-09. o This draft was split out from draft-ietf-netconf-server-model-09.
o Noted that '0.0.0.0' and '::' might have special meanings. o Noted that '0.0.0.0' and '::' might have special meanings.
A.2. 00 to 01 A.2. 00 to 01
skipping to change at page 26, line 34 skipping to change at page 27, line 36
o Added cipher suites for various algorithms into new 'ietf-tls- o Added cipher suites for various algorithms into new 'ietf-tls-
common' module. common' module.
A.4. 02 to 03 A.4. 02 to 03
o Added a 'must' statement to container 'server-auth' asserting that o Added a 'must' statement to container 'server-auth' asserting that
at least one of the various auth mechanisms must be specified. at least one of the various auth mechanisms must be specified.
o Fixed description statement for leaf 'trusted-ca-certs'. o Fixed description statement for leaf 'trusted-ca-certs'.
A.5. 03 to 04
o Updated title to "YANG Groupings for TLS Clients and TLS Servers"
o Updated leafref paths to point to new keystore path
o Changed the YANG prefix for ietf-tls-common from 'tlscom' to
'tlscmn'.
o Added TLS protocol verions 1.0 and 1.1.
o Made author lists consistent
Authors' Addresses Authors' Addresses
Kent Watsen Kent Watsen
Juniper Networks Juniper Networks
EMail: kwatsen@juniper.net EMail: kwatsen@juniper.net
Internet-DrafYANG Groupings for TLS Clients and TLS Servers October 2017
Gary Wu Gary Wu
Cisco Systems Cisco Systems
EMail: garywu@cisco.com EMail: garywu@cisco.com
 End of changes. 141 change blocks. 
471 lines changed or deleted 630 lines changed or added

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