TLS Client and Server Models

TLS Client and Server Models Juniper Networks

kwatsen@juniper.net

Operations NETCONF Working Group This document defines two YANG modules, one defines groupings for a generic TLS client and the other defines groupings for a generic TLS server. It is intended that these groupings will be used by applications using the TLS protocol. 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. This document contains references to other drafts in progress, both in the Normative References section, as well as in body text throughout. Please update the following references to reflect their final RFC assignments: draft-ietf-netconf-system-keychain Artwork in this document contains shorthand references to drafts in progress. Please apply the following replacements: XXXX --> the assigned RFC value for this draft YYYY --> the assigned RFC value for draft-ietf-netconf-system-keychain Artwork in this document contains placeholder values for the date of publication of this draft. Please apply the following replacement: 2016-07-08 --> the publication date of this draft The following two Appendix sections are to be removed prior to publication: Appendix A. Change Log Appendix B. Open Issues

This document defines two YANG modules, one defines groupings for a generic TLS client and the other defines groupings for a generic TLS server (TLS is defined in ). It is intended that these groupings will be used by applications using the TLS protocol. For instance, these groupings could be used to help define the data model for an HTTPS server or a NETCONF over TLS based server. The two YANG modules in this document each define two groupings. One grouping defines everything other than what's needed for the TCP protocol layer. The other grouping uses the first grouping while adding TCP layer specifics (e.g., addresses to connect to, ports to listen on, etc.). This separation is done in order to enable applications the opportunity to define their own strategy for how the underlying TCP connection is established. For instance, applications supporting NETCONF Call Home could use the first grouping for the TLS parts it provides, while adding data nodes for the reversed TCP layer.

The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 .

A simplified graphical representation of the data models is used in this document. The meaning of the symbols in these diagrams is as follows: Brackets "[" and "]" enclose list keys. Braces "{" and "}" enclose feature names, and indicate that the named feature must be present for the subtree to be present. Abbreviations before data node names: "rw" means configuration (read-write) and "ro" state data (read-only). Symbols after data node names: "?" means an optional node, "!" means a presence container, and "*" denotes a list and leaf-list. Parentheses enclose choice and case nodes, and case nodes are also marked with a colon (":"). Ellipsis ("...") stands for contents of subtrees that are not shown.

EDITOR NOTE: Please ignore this section, it is incomplete. The TLS client model presented in this section contains two YANG groupings, one for a client that initiates the underlying TCP connection and another for a client that has had the TCP connection opened for it already (e.g., call home). Both of these groupings reference data nodes defined by the System Keychain model . For instance, a reference to the keychain model is made to indicate which trusted CA certificate a client should use to authenticate the server's certificate.

The following tree diagram presents the data model for the two groupings defined in the ietf-tls-client module.

This section shows how it would appear if the initiating-tls-client-grouping were populated with some data. This example is consistent with the examples presented in Section 2.2 of .

This YANG module has a normative references to and .

file "ietf-tls-client@2016-07-08.yang" // Editor's Note: // This module is incomplete at this time. Below is // just a skeleton so there's something in the draft. // Please ignore this module for now! module ietf-tls-client { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-tls-client"; prefix "tlsc"; /* import ietf-inet-types { prefix inet; reference "RFC 6991: Common YANG Data Types"; } import ietf-system-keychain { prefix kc; reference "RFC YYYY: System Keychain Model"; } */ organization "IETF NETCONF (Network Configuration) Working Group"; contact "WG Web: WG List: WG Chair: Mehmet Ersue WG Chair: Mahesh Jethanandani Editor: Kent Watsen "; description "This module defines a reusable grouping for a TLS client that can be used as a basis for specific TLS client instances. Copyright (c) 2014 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 (http://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX; see the RFC itself for full legal notices."; revision "2016-07-08" { description "Initial version"; reference "RFC XXXX: TLS Client and Server Models"; } grouping initiating-tls-client-grouping { description "A reusable grouping for a TLS client that initiates the underlying TCP transport connection."; leaf some-TBD-tcp-client-stuff { type string; description ""; } uses non-initiating-tls-client-grouping; } grouping non-initiating-tls-client-grouping { description "A reusable grouping for a TLS client that does not initiate the underlying TCP transport connection."; leaf some-TBD-tls-client-stuff { type string; description ""; } } }

]]>



      

        The TLS server model presented in this section contains two
        YANG groupings, one for a server that opens a socket to accept
        TCP connections and another for a server that has had the TCP
        connection opened for it already (e.g., inetd).

        Both of these groupings reference data nodes defined by the
        System Keychain model .  
        For instance, a reference to the keychain model is made to indicate
        the certificate a server should present.

        
          The following tree diagram presents the data model for
          the two groupings defined in the ietf-tls-server module.
          
            
               /kc:keychain/private-keys/private-key/certi
ficate-chains/certificate-chain/name
     +---- client-auth
        +---- trusted-ca-certs?       -> /kc:keychain/trusted-certifica
tes/name
        +---- trusted-client-certs?   -> /kc:keychain/trusted-certifica
tes/name

  non-listening-tls-server-grouping
     +---- certificates
     |  +---- certificate* [name]
     |     +---- name?   -> /kc:keychain/private-keys/private-key/certi
ficate-chains/certificate-chain/name
     +---- client-auth
        +---- trusted-ca-certs?       -> /kc:keychain/trusted-certifica
tes/name
        +---- trusted-client-certs?   -> /kc:keychain/trusted-certifica
tes/name

]]>
            
          
        

        
          This section shows how it would appear if the
          listening-tls-server-grouping were populated with some data.
          This example is consistent with the examples presented in
          Section 2.2 of .
          
            
              
  6513
  
    
      ex-key-sect571r1-cert
    
  
  
    
      deployment-specific-ca-certs
    
    
      explicitly-trusted-client-certs
    
  

]]>
            
          
        

        
          This YANG module has a normative references to ,
          and .
          
            
               file "ietf-tls-server@2016-07-08.yang"

module ietf-tls-server {
  yang-version 1.1;

  namespace "urn:ietf:params:xml:ns:yang:ietf-tls-server";
  prefix "tlss";

  import ietf-inet-types {
    prefix inet;
    reference 
      "RFC 6991: Common YANG Data Types";
  }

  import ietf-system-keychain {
    prefix kc;
    reference
      "RFC YYYY: System Keychain Model";
  }

  organization
   "IETF NETCONF (Network Configuration) Working Group";

  contact
   "WG Web:   
    WG List:  

    WG Chair: Mehmet Ersue
              

    WG Chair: Mahesh Jethanandani
              

    Editor:   Kent Watsen
              ";


  description
   "This module defines a reusable grouping for a TLS server that
    can be used as a basis for specific TLS server instances.

    Copyright (c) 2014 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
    (http://trustee.ietf.org/license-info).

    This version of this YANG module is part of RFC XXXX; see
    the RFC itself for full legal notices.";

  revision "2016-07-08" {
    description
     "Initial version";
    reference
     "RFC XXXX: TLS Client and Server Models";
  }


  // grouping
  grouping non-listening-tls-server-grouping {
    description
      "A reusable grouping for a TLS server that can be used as a
       basis for specific TLS server instances.";
    container certificates {
      description
        "The list of certificates the TLS server will present when
         establishing a TLS connection in its Certificate message,
         as defined in Section 7.4.2 in RRC 5246.";
      reference
        "RFC 5246:
           The Transport Layer Security (TLS) Protocol Version 1.2";
      list certificate {
        key name;
        min-elements 1;
        description
          "An unordered list of certificates the TLS server can pick 
           from when sending its Server Certificate message.";
        reference
          "RFC 5246: The TLS Protocol, Section 7.4.2";
        leaf name {
          type leafref {
            path "/kc:keychain/kc:private-keys/kc:private-key/"
                 + "kc:certificate-chains/kc:certificate-chain/"
                 + "kc:name";
          }
          description
            "The name of the certificate in the keychain.";
        }
      }
    }

    container client-auth {
      description
        "A reference to a list of trusted certificate authority (CA)
         certificates and a reference to a list of trusted client
         certificates.";
      leaf trusted-ca-certs {
        type leafref {
          path "/kc:keychain/kc:trusted-certificates/kc:name";
        }
        description
          "A reference to a list of certificate authority (CA) 
           certificates used by the TLS server to authenticate
           TLS client certificates.";
      }
  
      leaf trusted-client-certs {
        type leafref {
          path "/kc:keychain/kc:trusted-certificates/kc:name";
        }
        description
          "A reference to a list of client certificates used by 
           the TLS server to authenticate TLS client certificates.
           A clients certificate is authenticated if it is an
           exact match to a configured trusted client certificate.";
      }
    }
  }


  grouping listening-tls-server-grouping {
    description
      "A reusable grouping for a TLS server that can be used as a
       basis for specific TLS server instances.";
    leaf address {
      type inet:ip-address;
      description
       "The IP address of the interface to listen on.  The TLS
        server will listen on all interfaces if no value is
        specified. Please note that some addresses have special
        meanings (e.g., '0.0.0.0' and '::').";
    }
    leaf port {
      type inet:port-number;
      description
       "The local port number on this interface the TLS server
        listens on.  When this grouping is used, it is RECOMMENDED
        that refine statement is used to either set a default port
        value or to set mandatory true.";
    }
    uses non-listening-tls-server-grouping;
  }
}




]]>
            

          
        

      


      


      

      
        
          This document registers two URIs in the IETF XML 
          registry .  Following the format in 
          , the following registrations are
          requested:
          
            
                
            
          
        

        
          This document registers two YANG modules in the
          YANG Module Names registry .
          Following the format in , the
          the following registrations are requested:
          
            
                
            
          
        
      

      
        The authors would like to thank for following for
        lively discussions on list and in the halls (ordered
        by last name): Andy Bierman, Martin Bjorklund, Benoit Claise,
        Mehmet Ersue, David Lamparter, Alan Luchuk, Ladislav Lhotka,
        Radek Krejci, Tom Petch, Juergen Schoenwaelder, Phil Shafer,
        Sean Turner, and Bert Wijnen.



    
      
        &rfc2119;
        &rfc6020;
        &rfc6991;
        &rfc7589;

        
          
            System Keychain Model
            
              Juniper Networks
            
            
          
          
        
      

      
        
          
            TRANSMISSION CONTROL PROTOCOL
            
              
            
            
          
          
        

        &rfc2818;
        &rfc3688;
        &rfc5246;

        
          
            
              NETCONF Call Home and RESTCONF Call Home
            
            
              Juniper Networks
            
            
          
          
        
      

      
        
          
            
              This draft was split out from draft-ietf-netconf-server-model-09.
              Noted that '0.0.0.0' and '::' might have special meanings.
            
          
        
      

      
        Please see: https://github.com/netconf-wg/tls-client-server/issues.