<?xml version="1.0" encoding="iso-8859-1" ?>
<!--<!DOCTYPE rfc SYSTEM "rfc4748.dtd"> -->
    <!DOCTYPE rfc SYSTEM 'rfc2629.dtd' [ 
    <!ENTITY rfc2629 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.2629.xml'> 
    <!ENTITY rfc2119 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml'> 
    <!ENTITY rfc5925 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.5925.xml'> 
    <!ENTITY rfc3618 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.3618.xml'> 
		<!ENTITY rfc8407 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8407.xml'>
		<!ENTITY rfc8342 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8342.xml'>
		<!ENTITY rfc6991 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.6991.xml'>
		<!ENTITY rfc8343 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8343.xml'>
		<!ENTITY rfc8344 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8344.xml'>
		<!ENTITY rfc8177 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8177.xml'>
    <!ENTITY rfc6241 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.6241.xml'>
    <!ENTITY rfc8040 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8040.xml'>
    <!ENTITY rfc6242 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.6242.xml'>
    <!ENTITY rfc8446 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8446.xml'>
    <!ENTITY rfc8341 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8341.xml'>
    <!ENTITY rfc6020 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.6020.xml'>
    <!ENTITY rfc3688 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.3688.xml'>
	  <!ENTITY rfc7951 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.7951.xml'>
    <!ENTITY rfc7950 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.7950.xml'>
    <!ENTITY rfc8174 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8174.xml'>
		<!ENTITY rfc8294 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8294.xml'>
		<!ENTITY rfc8340 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8340.xml'>
    <!ENTITY rfc8349 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8349.xml'>
    <!ENTITY rfc8519 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8519.xml'>
		<!ENTITY rfc8639 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8639.xml'>
		<!ENTITY rfc8641 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.8641.xml'>
		<!ENTITY rfc4271 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.4271.xml'>
    <!ENTITY rfc7761 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.7761.xml'>
    <!ENTITY I-D.ietf-pim-yang PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml3/reference.I-D.ietf-pim-yang.xml'>
		]>

<?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>		

<?rfc toc="yes"?>
<?rfc symrefs="yes"?>
<?rfc sortrefs="yes"?>
<?rfc disable-output-escaping="yes"?>

<rfc category="std"  docName="draft-ietf-pim-msdp-yang-18"
     ipr="trust200902">
  <!-- ***** FRONT MATTER ***** -->
  <front>
    <title abbrev="MSDP YANG Model">A YANG Data Model for Multicast Source Discovery Protocol (MSDP)</title>

    <author fullname="Xufeng Liu" initials="X" surname="Liu">
      <organization>Volta Networks</organization>
      <address>
        <postal>
          <street></street>
          <city></city>
          <code></code>
          <country></country>
        </postal>
        <email>xufeng.liu.ietf@gmail.com</email>
      </address>
    </author>

	<author fullname="Zheng Zhang" initials="Z" role="editor" surname="Zhang">
      <organization>ZTE Corporation</organization>  
      <address>
        <postal>
          <street>No. 50 Software Ave, Yuhuatai Distinct</street>
          
          <city>Nanjing</city>
          
          <region></region>
  
          <code></code>

          <country>China</country>
        </postal>

        <email>zzhang_ietf@hotmail.com</email>
      </address>
    </author>
	
	<author fullname="Anish Peter" initials="A" surname="Peter">
      <organization>Individual contributor</organization>

      <address>
        <postal>
          <street></street>
          
          <city></city>
          
          <region></region>
  
          <code></code>

          <country></country>
        </postal>

        <email>anish.ietf@gmail.com</email>
      </address>
    </author>
	
	 <author fullname="Mahesh Sivakumar" initials="M" surname="Sivakumar">
      <organization>Juniper networks</organization>

      <address>
        <postal>
          <street>1133 Innovation Way</street>
          
          <city>Sunnyvale, CALIFORNIA 94089</city>
          
          <region></region>
  
          <code></code>

          <country>USA</country>
        </postal>

        <email>sivakumar.mahesh@gmail.com</email>
      </address>
    </author>

	<author fullname="Feng Guo" initials="F" surname="Guo">
      <organization>Huawei Technologies</organization>  
      <address>
        <postal>
          <street>Huawei Bld., No.156 Beiqing Rd.</street>
          
          <city>Beijing  100095</city>
          
          <region></region>
  
          <code></code>

          <country>China</country>
        </postal>

        <email>guofeng@huawei.com</email>
      </address>
    </author>
	
    <author fullname="Pete McAllister" initials="P" surname="McAllister">
      <organization>Metaswitch Networks</organization>

      <address>
        <postal>
          <street>100 Church Street</street>
          
          <city>Enfield  EN2 6BQ</city>
          
          <region></region>
  
          <code></code>

          <country>UK</country>
        </postal>

        <email>pete.mcallister@metaswitch.com</email>
      </address>
    </author>
	
	<date year="2020"/>	
    <area>Routing</area>
    <workgroup>PIM WG</workgroup>
    <keyword>MSDP, YANG</keyword>
    <abstract>
     <t>
       This document defines a YANG data model for the configuration and
       management of Multicast Source Discovery Protocol (MSDP) Protocol.
     </t>
    </abstract>
  </front>

  <!-- ***** MIDDLE MATTER ***** -->

  <middle>
    <section title="Introduction">
      <t><xref target="RFC3618"/> introduces the protocol definition of MSDP. 
          This document defines a YANG data model that can be used to configure
	  and manage the MSDP protocol. The operational state data and
	  statistics can also be retrieved by this model.
      </t> 
      <t>
	This model is designed to be used along with other multicast
	YANG models such as PIM <xref target="I-D.ietf-pim-yang"/>, which are not covered in this document.
      </t>
	  
	<section title="Terminology">
	<t>The terminology for describing YANG data models is found in 
	<xref target="RFC6020"/> and <xref target="RFC7950"/>, including:</t>
	<t>
     <list style="symbols">
	<t>action</t>
  <t>augment</t>
  <t>container</t>
  <t>choice</t>
	<t>data model</t>
	<t>data node</t>
  <t>grouping</t>
	<t>identity</t>
  <t>leaf</t>
  <t>list</t>
	<t>module</t>
  <t>uses</t>
	  </list>
	</t>
	
	<t>The following abbreviations are used in this document and the defined
    model:</t>
	<t>MSDP: Multicast Source Discovery Protocol <xref target="RFC3618"/>.</t>
  <t>RP: Rendezvous Point <xref target="RFC7761"/></t>
  <t>RPF: Reverse Path Forwarding <xref target="RFC7761"/></t>
  <t>SA: Source-Active <xref target="RFC3618"/>.</t>
	</section>
	
  <section title="Conventions Used in This Document">
	<t>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 <xref target="RFC2119"/> <xref target="RFC8174"/> 
   when, and only when, they appear in all capitals, as shown here.</t>
	</section>
  
	<section title="Tree Diagrams">
	<t>Tree diagrams used in this document follow the notation defined in 
	   <xref target="RFC8340"/>.</t>
	</section>

	<section title="Prefixes in Data Node Names">
	<t>In this document, names of data nodes, actions, and other data model
   objects are often used without a prefix, as long as it is clear from
   the context in which YANG module each name is defined.  Otherwise,
   names are prefixed using the standard prefix associated with the
   corresponding YANG module, as shown in Table 1.</t>
   
    <texttable anchor="TABLE_1" title="">

     <ttcol align="left">Prefix</ttcol>
     <ttcol align="left">YANG module</ttcol>
     <ttcol align="left">Reference</ttcol>

     <c>yang</c>
     <c>ietf-yang-types</c>
     <c><xref target="RFC6991"/></c>

     <c>inet</c>
     <c>ietf-inet-types</c>
     <c><xref target="RFC6991"/></c>
  
     <c>rt</c>
     <c>ietf-routing</c>
     <c><xref target="RFC8349"/></c>

     <c>if</c>
     <c>ietf-interfaces</c>
     <c><xref target="RFC8343"/></c>
	
     <c>ip</c>
     <c>ietf-ip</c>
     <c><xref target="RFC8344"/></c>
	
     <c>key-chain</c>
     <c>ietf-key-chain</c>
     <c><xref target="RFC8177"/></c>
	
     <c>rt-types</c>
     <c>ietf-routing-types</c>
     <c><xref target="RFC8294"/></c>
     
     <c>acl</c>
     <c>ietf-access-control-list</c>
     <c><xref target="RFC8519"/></c>
	</texttable>
	
	</section>
	</section>
	 
	<section title="Design of the Data Model"> 
	<section title="Scope of Model">
	<t>The model covers MSDP <xref target="RFC3618"/>.</t>
	
	<t>This model can be used to configure and manage the 
   MSDP protocol.  The operational state data and statistics
   can be retrieved by this model.  Even though no protocol-specific
   notifications are defined in this model, the subscription and push
   mechanism defined in <xref target="RFC8639"/> 
   and <xref target="RFC8641"/> can be implemented by
   the user to subscribe to notifications on the data nodes in this
   model.</t>
   
	<t>The model contains all the basic configuration parameters to operate
   the protocol.  Depending on the implementation choices,
   some systems may not allow some of the advanced parameters to be
   configurable.  The occasionally implemented parameters are modeled as
   optional features in this model. 
   This model can be extended, and it has been structured in a way that
   such extensions can be conveniently made.</t>
	</section>

    <section title="Specification">
	<t>	
	   The configuration data nodes cover global 
       configuration attributes and per peer configuration 
       attributes. The state data nodes include global, per peer, 
       and source-active information. The container "msdp" is the 
       top level container in this data model.  The presence of 
       this container is expected to enable MSDP protocol functionality.
       No notification is defined in this model.</t>
	</section>
	</section>
	
	<section title="Module Structure">
	 <t>
       This model imports and augments the ietf-routing YANG model 
       defined in <xref target="RFC8349"/>.  Both configuration 
       data nodes and state data nodes of <xref target="RFC8349"/>
       are augmented.
	 </t>
	 
	 <t>The YANG data model defined in this document conforms to the Network
   Management Datastore Architecture (NMDA) <xref target="RFC8342"/>.  
   The operational state data is combined with the associated configuration 
   data in the same hierarchy <xref target="RFC8407"/>.</t>

   <figure align="center">
     <artwork align="center"><![CDATA[
module: ietf-msdp
  augment /rt:routing/rt:control-plane-protocols
            /rt:control-plane-protocol:
    +--rw msdp
       +--rw global
       |  +--rw tcp-connection-source?   if:interface-ref
       |  +--rw default-peer* [peer-addr prefix-policy] 
                              {filter-policy}?
       |  |  +--rw peer-addr        -> ../../../peers/peer/address
       |  |  +--rw prefix-policy    -> /acl:acls/acl/name
       |  +--rw originating-rp
       |  |  +--rw interface?   if:interface-ref
       |  +--rw sa-filter
       |  |  +--rw in?    -> /acl:acls/acl/name
       |  |  +--rw out?   -> /acl:acls/acl/name
       |  +--rw sa-limit?                uint32
       |  +--rw ttl-threshold?           uint8
       +--rw peers
       |  +--rw peer* [address]
       |     +--rw address                  inet:ipv4-address
       |     +---x clear-peer
       |     +--rw authentication {peer-authentication}?
       |     |  +--rw (authentication-type)?
       |     |     +--:(key-chain)
       |     |     |  +--rw key-chain?          key-chain:key-chain-ref
       |     |     +--:(password)
       |     |        +--rw key?                string
       |     |        +--rw crypto-algorithm?   identityref
       |     +--rw enabled?                 boolean
       |     +--rw tcp-connection-source?   if:interface-ref
       |     +--rw description?             string
       |     +--rw mesh-group?              string
       |     +--rw peer-as?                 inet:as-number 
                                            {peer-as-verification}?
       |     +--rw sa-filter
       |     |  +--rw in?    -> /acl:acls/acl/name
       |     |  +--rw out?   -> /acl:acls/acl/name
       |     +--rw sa-limit?                uint32
       |     +--rw timer
       |     |  +--rw connect-retry-interval?   uint16
       |     |  +--rw holdtime-interval?        uint16
       |     |  +--rw keepalive-interval?       uint16
       |     +--rw ttl-threshold?           uint8
       |     +--ro session-state?           enumeration
       |     +--ro elapsed-time?            yang:gauge32
       |     +--ro connect-retry-expire?    uint32
       |     +--ro hold-expire?             uint16
       |     +--ro is-default-peer?         boolean
       |     +--ro keepalive-expire?        uint16
       |     +--ro reset-count?             yang:zero-based-counter32
       |     +--ro statistics
       |        +--ro discontinuity-time?   yang:date-and-time
       |        +--ro error
       |        |  +--ro rpf-failure?   uint32
       |        +--ro queue
       |        |  +--ro size-in?    uint32
       |        |  +--ro size-out?   uint32
       |        +--ro received
       |        |  +--ro keepalive?      yang:counter64
       |        |  +--ro notification?   yang:counter64
       |        |  +--ro sa-message?     yang:counter64
       |        |  +--ro sa-response?    yang:counter64
       |        |  +--ro sa-request?     yang:counter64
       |        |  +--ro total?          yang:counter64
       |        +--ro sent
       |           +--ro keepalive?      yang:counter64
       |           +--ro notification?   yang:counter64
       |           +--ro sa-message?     yang:counter64
       |           +--ro sa-response?    yang:counter64
       |           +--ro sa-request?     yang:counter64
       |           +--ro total?          yang:counter64
       +---x clear-all-peers
       +--ro sa-cache
          +--ro entry* [group source-addr]
          |  +--ro group               
                     rt-types:ipv4-multicast-group-address
          |  +--ro source-addr         
                     rt-types:ipv4-multicast-source-address
          |  +--ro origin-rp* [rp-address]
          |  |  +--ro rp-address       inet:ipv4-address
          |  |  +--ro is-local-rp?     boolean
          |  |  +--ro sa-adv-expire?   uint32
          |  +--ro state-attributes
          |     +--ro up-time?             yang:gauge32
          |     +--ro expire?              yang:gauge32
          |     +--ro holddown-interval?   uint32
          |     +--ro peer-learned-from?   inet:ipv4-address
          |     +--ro rpf-peer?            inet:ipv4-address
          +---x clear
             +---w input
                +---w entry!
                |  +---w group          
                           rt-types:ipv4-multicast-group-address
                |  +---w source-addr?   
                           rt-types:ipv4-multicast-source-address
                +---w peer-address?   inet:ipv4-address
                +---w peer-as?        inet:as-number
            ]]></artwork>
       <postamble></postamble>
      </figure>

    <section title="MSDP Configuration"> 
    <t>
      MSDP operation requires configuration information that is distributed 
      amongst several peers.  Several peers may
   be configured in a mesh-group.  The Source-Active information may be filtered
   by peers.</t>
   <t>The configuration modeling branch is composed of MSDP global and
      peer configurations.  
   The two parts are the most important parts of MSDP.</t>
   <t>Besides the fundamental features of MSDP protocol, several optional features 
   are included in the model. These features help the control of MSDP protocol. 
   The peer features and SA features make the deployment and control easier. The 
   connection parameters can be used to control the TCP connection because MSDP 
   protocol is based on TCP. The authentication features make the protocol more 
   secure. The filter features selectively allow operators to prevent SA information 
   from being forwarded to peers.</t>
    </section>

	<section title="MSDP State"> 
    <t>MSDP states are composed of MSDP global state, MSDP peer state, statistics 
	information and SA cache information. The statistics information and SA cache 
	information helps the operator to retrieve the protocol condition.</t>
    <t>YANG actions are defined to clear the connection of one specific MSDP peer, 
    clear the connections of all MSDP peers, or clear some or all the SA caches.</t>
    </section>
	
    </section>
	
	<section title="MSDP YANG Model"> 
	<t>This module references <xref target="RFC3618"/>, <xref target="RFC4271"/>,
  <xref target="RFC5925"/>, <xref target="RFC6991"/>, <xref target="RFC7761"/>,
	<xref target="RFC8177"/>, <xref target="RFC8294"/>, <xref target="RFC8343"/>, 
  <xref target="RFC8344"/>, <xref target="RFC8349"/>,  <xref target="RFC8519"/>.</t>
		
  <figure align="center">
    <artwork align="center"><![CDATA[
<CODE BEGINS> file "ietf-msdp@2020-04-15.yang"
module ietf-msdp {

  yang-version 1.1;

  namespace "urn:ietf:params:xml:ns:yang:ietf-msdp";
  prefix msdp;

  import ietf-yang-types {
    prefix "yang";
    reference "RFC 6991: Common YANG Data Types";
  }

  import ietf-inet-types {
    prefix "inet";
    reference "RFC 6991: Common YANG Data Types";
  }

  import ietf-routing {
    prefix "rt";
    reference "RFC 8349: A YANG Data Model for Routing Management 
                        (NMDA Version)";
  }

  import ietf-interfaces {
    prefix "if";
    reference "RFC 8343: A YANG Data Model for Interface Management";
  }

  import ietf-ip {
    prefix "ip";
    reference "RFC 8344: A YANG Data Model for IP Management";
  }

  import ietf-key-chain {
    prefix "key-chain";
    reference "RFC 8177: YANG Data Model for Key Chains";
  }

  import ietf-routing-types {
    prefix "rt-types";
    reference "RFC 8294: Common YANG Data Types for the Routing 
                         Area";
  }
   
  import ietf-access-control-list {
    prefix acl;
    reference
      "RFC 8519: YANG Data Model for Network Access Control Lists 
                 (ACLs)";
  }

  organization
    "IETF PIM (Protocols for IP Multicast) Working Group";

  contact
    "WG Web:   <http://tools.ietf.org/wg/pim/>
     WG List:  <mailto:pim@ietf.org>

     Editor:   Xufeng Liu
               <mailto:xufeng.liu.ietf@gmail.com>

     Editor:   Zheng Zhang
               <mailto:zzhang_ietf@hotmail.com>

     Editor:   Anish Peter
               <mailto:anish.ietf@gmail.com>

     Editor:   Mahesh Sivakumar
               <mailto:sivakumar.mahesh@gmail.com>

     Editor:   Feng Guo
               <mailto:guofeng@huawei.com>

     Editor:   Pete McAllister
               <mailto:pete.mcallister@metaswitch.com>";

  // RFC Ed.: replace XXXX with actual RFC number and remove
  // this note
               
  description
    "The module defines the YANG model definitions for 
     Multicast Source Discovery Protocol (MSDP).

     Copyright (c) 2020 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 2020-04-15 {
    description
      "Initial revision.";
    reference
      "RFC XXXX: A YANG Data Model for MSDP.";
  }
   
  /*
   * Features
   */
   
  feature filter-policy {
    description
      "Support policy configuration of peer/message filtering.";
    reference
      "RFC 8519: YANG Data Model for Network Access Control 
       Lists (ACLs)";
  }

  feature peer-as-verification {
    description
      "Support configuration of peer AS number.";
    reference
      "RFC 4271: A Border Gateway Protocol 4 (BGP-4)";
  }

  feature peer-authentication {
    description
      "Support configuration of peer authentication.";
    reference
      "RFC 8177: YANG Data Model for Key Chains.";
  }

  /*
   * Identities
   */

  identity msdp {
    base rt:control-plane-protocol;
    description "Identity for the Multicast Source Discovery 
                 Protocol (MSDP).";
    reference
      "RFC 3618: Multicast Source Discovery Protocol (MSDP)";
  }
   
  /*
   * Groupings
   */
  grouping authentication-container {
    description
      "Authentication attributes.";
    container authentication {
      if-feature peer-authentication;
      description
        "A container defining authentication attributes.";
      choice authentication-type {
        case key-chain {
          leaf key-chain {
            type key-chain:key-chain-ref;
            description
              "Reference to a key-chain.";
            reference
              "RFC 8177: YANG Data Model for Key Chains.";
          }
        }
        case password {
          leaf key {
            type string;
            description
              "This leaf specifies the authentication key.";
          }
          leaf crypto-algorithm {
            type identityref {
              base key-chain:crypto-algorithm;
            }
            must "derived-from-or-self(., 'key-chain:md5')" {
              error-message
                "Only the md5 algorithm can be used for MSDP.";
              description "Check for crypto-algorithm.";
            }
            description
              "Cryptographic algorithm associated with key. 
               Only the md5 algorithm can be used for MSDP. 
               When 'md5' is specified, MSDP control messages 
               are secured by TCP MD5 signatures as described 
               in RFC 3618 and RFC 5925. Both peers of a 
               connection SHOULD be configured to the same 
               algorithm for the connection to be established.
               When this leaf is not configured, unauthenticated 
               TCP is used.";
            reference
              "RFC 8177: YANG Data Model for Key Chains.
               RFC 5925: The TCP Authentication Option.";
          }
        }
        description
          "Choice of authentication.";
      }
    }
  } // authentication-container

  grouping tcp-connect-source {
    description 
      "Attribute to configure peer TCP connection source.";
    leaf tcp-connection-source {
      type if:interface-ref;
      must "/if:interfaces/if:interface[if:name = current()]/"
        + "ip:ipv4/ip:enabled != 'false'" {
        error-message "The interface must have IPv4 enabled.";
        description
          "The interface must have IPv4 enabled.";
        reference 
          "RFC 8343: A YANG Data Model for Interface Management";
      }
      description
        "The interface is to be the source for the TCP 
         connection. It is a reference to an entry in the global 
         interface list.";
    }
  } // tcp-connect-source

  grouping global-config-attributes {
    description "Global MSDP configuration.";

    uses tcp-connect-source;

    list default-peer {
      if-feature filter-policy;
      key "peer-addr prefix-policy";

      description
        "The default peer accepts all MSDP SA messages.
         A default peer is needed in topologies where MSDP peers 
         do not coexist with BGP peers. The reverse path 
         forwarding (RPF) check on SA messages will fail, and no 
         SA messages will be accepted. In these cases, you can 
         configure the peer as a default peer and bypass RPF checks.";

      leaf peer-addr {
        type leafref {
          path "../../../peers/peer/address";
        }
        mandatory true;
        description
          "Reference to a peer that is in the peer list.";
      }
      leaf prefix-policy {
        type leafref {
          path "/acl:acls/acl:acl/acl:name";
        }
        description
          "If specified, only those SA entries whose RP is 
           permitted in the prefix list are allowed;
           if not specified, all SA messages from the default 
           peer are accepted.";
        reference
          "RFC 8519: YANG Data Model for Network Access Control 
           Lists (ACLs)";
      }
    } // default-peer

    container originating-rp {
      description
        "The container of Originating RP.";
      leaf interface {
        type if:interface-ref;
        must "/if:interfaces/if:interface[if:name = current()]/"
              + "ip:ipv4/ip:enabled != 'false'" {
          error-message "The interface must have IPv4 enabled.";
          description
            "The interface must have IPv4 enabled.";
          reference 
            "RFC 8343: A YANG Data Model for Interface Management";
        }
        description
          "Reference to an entry in the global interface
           list.
           IP address of the interface used in the RP field of 
           an SA message entry. When Anycast RPs are used, all 
           RPs use the same IP address. This parameter can be 
           used to define a unique IP address for the RP of each 
           MSDP peer.
           By default, the software uses the RP address of the
           local system.";
      }
    } // originating-rp

    uses sa-filter-container;
    
    leaf sa-limit {
      type uint32;
      description
        "A limit on the number of SA entries accepted. 
         By default, there is no limit.";
    }
    uses ttl-threshold;
  } // global-config-attributes

  grouping peer-config-attributes {
    description "Per peer configuration for MSDP.";

    uses authentication-container;
    leaf enabled {
      type boolean;
      description
        "'true' if peer is enabled;
         'false' if peer is disabled.";
    }
    uses tcp-connect-source;
    
    leaf description {
      type string;
      description
        "The peer description.";
    }
    leaf mesh-group {
      type string;
      description
        "The name of mesh-group which this peer belongs to.";
      reference
        "RFC 3618: Multicast Source Discovery Protocol (MSDP), 
                   section 10.2.";
    }
    leaf peer-as {
      if-feature peer-as-verification;
      type inet:as-number;
      description
        "Peer's autonomous system number (ASN). Using peer-as to 
         do verification can provide more controlled ability. 
         The value can be compared with the BGP peer AS. If they 
         are different, the SA comes from this peer may be rejected.
         If the AS number is the same as the local AS, then the 
         peer is within the same domain; otherwise, this peer is 
         external to the domain. Like the definition and usage 
         in BGP.";
      reference
        "RFC 4271: A Border Gateway Protocol 4 (BGP-4)";
    }
    uses sa-filter-container;
    leaf sa-limit {
      type uint32;
      description
        "A limit on the number of SA entries accepted from this 
         peer. By default, there is no limit.";
    }
    container timer {
      description "Timer attributes.";
      reference
        "RFC 3618: Multicast Source Discovery Protocol (MSDP), 
                   section 5.";
      leaf connect-retry-interval {
        type uint16;
        units seconds;
        default 30;
        description "Peer timer for connect-retry. 
                     By default, MSDP peers wait 30 seconds after
                     session is reset.";
      }
      leaf holdtime-interval {
        type uint16 {
          range "3..65535";
        }
        units seconds;
        default 75;
        description "The SA hold down period of this MSDP peer.";
      }
      leaf keepalive-interval {
        type uint16 {
            range "1..65535";
        }
        units seconds;
        must '. < ../holdtime-interval' {
          error-message
            "The keepalive interval must be smaller than the
             hold time interval";
        }
        default 60;
        description "The keepalive timer of this MSDP peer.";
      }
    } // timer
    uses ttl-threshold;
  } // peer-config-attributes

  grouping peer-state-attributes {
    description "Per peer state attributes for MSDP.";

    leaf session-state {
      type enumeration {
        enum disabled  {
          description "Disabled.";
        }
        enum inactive {
          description "Inactive.";
        }
        enum listen {
          description "Listen.";
        }
        enum connecting {
          description "Connecting.";
        }
        enum established {
          description "Established.";
        }
      }
      config false;
      description
        "Peer session state.";
      reference
        "RFC 3618: Multicast Source Discovery Protocol (MSDP), 
                   section 11.";
    }
    leaf elapsed-time {
      type yang:gauge32;
      units seconds;
      config false;
      description "Elapsed time for being in a state.";
    }
    leaf connect-retry-expire {
      type uint32;
      units seconds;
      config false;
      description "Connect retry expire time of peer connection.";
    }
    leaf hold-expire {
      type uint16;
      units seconds;
      config false;
      description "Hold expire time of peer connection.";
    }
    leaf is-default-peer {
      type boolean;
      config false;
      description "'true' if this peer is one of the default peer.";
    }
    leaf keepalive-expire {
      type uint16;
      units seconds;
      config false;
      description "Keepalive expire time of this peer.";
    }
    leaf reset-count {
      type yang:zero-based-counter32;
      config false;
      description "The reset count of this peer.";
    }

    container statistics {
      config false;
      description
        "A container defining statistics attributes.";

      leaf discontinuity-time {
        type yang:date-and-time;
        description
          "The time on the most recent occasion at which any one
          or more of the statistic counters suffered a
          discontinuity. If no such discontinuities have occurred
          since the last re-initialization of the local
          management subsystem, then this node contains the time
          the local management subsystem re-initialized itself.";
      }

      container error {
        description
          "A grouping defining error statistics attributes.";
        leaf rpf-failure {
          type uint32;
          description "Number of RPF failures.";
        }
      }

      container queue {
        description
          "A container includes queue statistics attributes.";
        leaf size-in {
          type uint32;
          description
            "The number of messages received from the peer 
             currently queued.";
        }
        leaf size-out {
          type uint32;
          description
            "The number of messages queued to be sent to the peer.";
        }
      }

      container received {
        description "Received message counters.";
        uses statistics-sent-received;
      }
      container sent {
        description "Sent message counters.";
        uses statistics-sent-received;
      }
    } // statistics
  } // peer-state-attributes

  grouping sa-filter-container {
    description "A container defining SA filters.";
    container sa-filter {
      description
        "Specifies an access control list (ACL) to filter source
         active (SA) messages coming in to or going out of the 
         peer.";
      leaf in {
        type leafref {
          path "/acl:acls/acl:acl/acl:name";
        }
        description
          "Filters incoming SA messages only. 
           The value is the name to uniquely identify a 
           policy that contains one or more rules used to 
           accept or reject MSDP SA messages.
           If the policy is not specified, all MSDP SA messages are 
           accepted.";
        reference
          "RFC 8519: YANG Data Model for Network Access Control 
           Lists (ACLs)";
      }
      leaf out {
        type leafref {
          path "/acl:acls/acl:acl/acl:name";
        }
        description
          "Filters outgoing SA messages only.
           The value is the name to uniquely identify a 
           policy that contains one or more rules used to 
           accept or reject MSDP SA messages.
           If the policy is not specified, all MSDP SA messages are 
           sent.";
        reference
          "RFC 8519: YANG Data Model for Network Access Control 
           Lists (ACLs)";
      }
    } // sa-filter
  } // sa-filter-container

  grouping ttl-threshold {
    description "Attribute to configure TTL threshold.";
    leaf ttl-threshold {
      type uint8 {
        range 1..255;
      }
      description "Maximum number of hops data packets can 
                   traverse before being dropped.";
    }
  } // ttl-threshold

  grouping statistics-sent-received {
    description
      "A grouping defining sent and received statistics attributes.";
    leaf keepalive {
      type yang:counter64;
      description
        "The number of keepalive messages.";
    }
    leaf notification {
      type yang:counter64;
      description
        "The number of notification messages.";
    }
    leaf sa-message {
      type yang:counter64;
      description
        "The number of SA messages.";
    }
    leaf sa-response {
      type yang:counter64;
      description
        "The number of SA response messages.";
    }
    leaf sa-request {
      type yang:counter64;
      description
        "The number of SA request messages.";
    }
    leaf total {
      type yang:counter64;
      description
        "The number of total messages.";
    }
  } // statistics-sent-received

  /*
   * Data nodes
   */
  augment "/rt:routing/rt:control-plane-protocols/"
         + "rt:control-plane-protocol" {
    when "derived-from-or-self(rt:type, 'msdp:msdp')" {
      description
        "This augmentation is only valid for a routing protocol 
         instance of MSDP.";
    }
    description 
      "MSDP augmentation to routing control-plane protocol 
       configuration and state.";
    container msdp {
      description
        "MSDP configuration and operational state data.";

      container global {
        description
          "Global attributes.";
        uses global-config-attributes;
      }

      container peers {
        description
          "Containing a list of peers.";
        list peer {
          key "address";
          description
            "List of MSDP peers.";
          leaf address {
            type inet:ipv4-address;
            description
              "The address of the peer";
          }
          action clear-peer {
            description
              "Clears the TCP connection to the peer.";
          }
          uses peer-config-attributes;
          uses peer-state-attributes;
        }
      }
      
      action clear-all-peers {
        description
          "'All peers' TCP connection are cleared.";
      }

      container sa-cache {
        config false;
        description
          "The SA cache information.";
        list entry {
          key "group source-addr";
          description "A list of SA cache entries.";
          leaf group {
            type rt-types:ipv4-multicast-group-address;
            description "The group address of this SA cache.";
          }
          leaf source-addr {
            type rt-types:ipv4-multicast-source-address;
            description "Source IPv4 address.";
          }
          list origin-rp {
            key "rp-address";
            description "Origin RP information.";
            leaf rp-address {
              type inet:ipv4-address;
              description 
                "The RP address. IP address used in the RP field 
                 of an SA message entry.";
            }
            leaf is-local-rp {
              type boolean;
              description 
                "'true' if the RP is local;
                 'false' if The RP is not local.";
            }
            leaf sa-adv-expire {
              type uint32;
              units seconds;
              description
                "The remaining time duration before expiration 
                 of the periodic SA advertisement timer on a 
                 local RP.";
            }
          }

          container state-attributes {
            description "SA cache state attributes for MSDP.";

            leaf up-time {
              type yang:gauge32;
              units seconds;
              description 
                "Indicates the duration time when this SA entry is 
                 created in the cache. MSDP is a periodic protocol, 
                 the value can be used to check the state of 
                 SA cache.";
            }
            leaf expire {
              type yang:gauge32;
              units seconds;
              description 
                "Indicates the duration time when this SA entry in 
                 the cache times out. MSDP is a periodic protocol, 
                 the value can be used to check the state of 
                 SA cache.";
            }
            leaf holddown-interval {
              type uint32;
              units seconds;
              description 
                "Hold-down timer value for SA forwarding.";
              reference
                "RFC 3618: Multicast Source Discovery Protocol 
                           (MSDP), section 5.3.";
            }
            leaf peer-learned-from {
              type inet:ipv4-address;
              description
                "The address of the peer that we learned this 
                 SA from.";
            }
            leaf rpf-peer {
              type inet:ipv4-address;
              description 
                "The address is the SA's originating RP.";
            }
          } // state-attributes
        } // entry
        
        action clear {
          description
            "Clears MSDP source active (SA) cache entries.";
          input {
            container entry {
              presence "If a particular entry is cleared.";
              description
                "The SA cache (S,G) or (*,G) entry to be cleared. If 
                 this is not provided, all entries are cleared.";
              leaf group {
                type rt-types:ipv4-multicast-group-address;
                mandatory true;
                description "The group address";
              }
              leaf source-addr {
                type rt-types:ipv4-multicast-source-address;
                description 
                  "Address of multicast source to be cleared. If this 
                   is not provided then all entries related to the 
                   given group are cleared.";
              }
            }
            leaf peer-address {
              type inet:ipv4-address;
              description
                "Peer IP address from which MSDP SA cache entries have 
                 been learned. If this is not provided, entries learned 
                 from all peers are cleared.";
            }
            leaf peer-as {
              type inet:as-number;
              description
                "ASN from which MSDP SA cache entries have been learned.
                 If this is not provided, entries learned from all AS's
                 are cleared.";
            }
          }
        } // clear
      } // sa-cache
    } // msdp
  } // augment
}
<CODE ENDS>
            ]]></artwork>
       <postamble></postamble>
      </figure>
    </section>

   <section title="Security Considerations"> 
	<t>The YANG module specified in this document defines a schema for data
   that is designed to be accessed via network management protocols such
   as NETCONF <xref target="RFC6241"/> or RESTCONF <xref target="RFC8040"/>. 
   The lowest NETCONF layer is the secure transport layer, and the 
   mandatory-to-implement secure transport is Secure Shell (SSH) <xref target="RFC6242"/>. 
   The lowest RESTCONF layer is HTTPS, and the mandatory-to-implement secure 
   transport is TLS <xref target="RFC8446"/>.</t>

   <t>The NETCONF access control model <xref target="RFC8341"/> provides 
   the means to
   restrict access for particular NETCONF or RESTCONF users to a
   preconfigured subset of all available NETCONF or RESTCONF protocol
   operations and content.</t>

   <t>There are a number of data nodes defined in this YANG module that are
   writable/creatable/deletable (i.e., config true, which is the 
   default). 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:</t>
   
   <t>Under /rt:routing/rt:control-plane-protocols/msdp,</t>
   <t>msdp:global
      <list style="simblos">
      <t>This subtree specifies the configuration for the MSDP attributes
      at the global level. Modifying the configuration can cause MSDP default 
	  peers to be deleted or the connection to be rebuilt, and unexpected filtering of the SA.</t>
      </list>
   </t>
   
   <t>msdp:peers
	  <list style="simblos">
      <t>This subtree specifies the configuration for the MSDP attributes
      at the peer level. Modifying the configuration will allow  
	  unexpected MSDP peer establishment and 
      unexpected SA information learning and advertisement.</t>
      <t>The key field writability should be controlled strictly. 
      The key misoperation will break the existing MSDP connection, 
      and the associated SA caches will also be deleted.</t>
      </list>
   </t>
   
   <t>Some of the readable data nodes in this 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 is msdp subtree and key data
   node and their sensitivity/vulnerability:</t>

   <t>/rt:routing/rt:control-plane-protocols/msdp,</t>
   <t>Unauthorized access to any data node of the above subtree can
   disclose the operational state information of MSDP on this
   device. For example, the peer information disclosure may lead to a forged 
   connection attack, the ACL nodes' uncorrected modification may lead to the filter errors. 
   </t>
   
   <t>The "key" 
	  field is also a sensitive readable configuration. Unauthorized 
	  reading may lead to the password leaking. Modification
	  will allow the unexpected rebuilding of connected peers.</t>
    <t>Authentication configuration is supported via the
   specification of key-chains <xref target="RFC8177"/> or the direct specification of
   key and authentication algorithm.  Hence, authentication
   configuration in the
   "authentication" container inherits the security considerations of
   <xref target="RFC8177"/>.  This includes the considerations with respect to the
   local storage and handling of authentication keys.</t>
   
   <t>Some of the RPC 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:
   </t>
   
   <t>/rt:routing/rt:control-plane-protocols/msdp:clear-peer,</t>
   <t>/rt:routing/rt:control-plane-protocols/msdp:clear-sa-cache,</t>
   <t>Unauthorized access to any of the above action operations can lead to 
   the MSDP peers connection rebuilding or delete SA records on this device.
   </t>
   
   </section>

   <section title="IANA Considerations"> 
	<t>RFC Ed.: Please replace all occurrences of 'XXXX' with the
   actual RFC number (and remove this note).</t>
  
  <t> The IANA is requested to assign one new URI from the IETF XML
   registry <xref target="RFC3688"/>.  Authors are suggesting the following URI:</t>

       <t>URI: urn:ietf:params:xml:ns:yang:ietf-msdp</t>
       <t>Registrant Contact: The IESG</t>
       <t>XML: N/A, the requested URI is an XML namespace</t>

   <t>This document also requests one new YANG module name in the YANG
   Module Names registry <xref target="RFC6020"/> with the following suggestion:</t>

       <t>name: ietf-msdp</t>
       <t>namespace: urn:ietf:params:xml:ns:yang:ietf-msdp</t>
       <t>prefix: msdp</t>
       <t>reference: RFC XXXX</t>
   </section>
	
	<section title="Contributors"> 
	<t>The authors would like to thank Yisong Liu (liuyisong@huawei.com), 
   Benchong Xu (xu.benchong@zte.com.cn), 
   Tanmoy Kundu (tanmoy.kundu@alcatel-lucent.com) for their valuable 
   contributions.</t>
	</section>

   <section title="Acknowledgement"> 
	<t>The authors would like to thank Stig Venaas, Jake Holland for their valuable 
   comments and suggestions.</t>
	</section>
	
  </middle>

  <!--  *****BACK MATTER ***** -->

  <back>
  
    <references title='Normative References'>
    &rfc2119;
    &rfc3618;
    &rfc4271;
    &rfc5925;
    &rfc6020;
    &rfc6241;
    &rfc6242;
    &rfc6991;
    &rfc7950;  
    &rfc7951;
    &rfc8040;
    &rfc8174;
    &rfc8177;
    &rfc8294;
    &rfc8340;
    &rfc8341;
    &rfc8342;
    &rfc8343;
    &rfc8344;
    &rfc8349;
    &rfc8446;
    &rfc8519;
    </references>

    <references title='Informative References'>
  	&rfc3688;
    &rfc7761;
    &rfc8407;
    &rfc8639;
    &rfc8641;
    &I-D.ietf-pim-yang;
    </references>
	
  <section title="Data Tree Example"> 
	<t>This section contains an example of an instance data tree in JSON
   encoding <xref target="RFC7951"/>, containing configuration data.</t>
 
  <section title="The global and peer configuration example"> 
      <figure align="center">
     <artwork align="center"><![CDATA[
{
  "ietf-interfaces:interfaces": {
    "interface": [
      {
        "name": "eth1",
        "description": "An interface with MSDP enabled.",
        "type": "iana-if-type:ethernetCsmacd",
        "ietf-ip:ipv4": {
          "forwarding": true,
          "address": [
            {
              "ip": "192.0.2.1",
              "prefix-length": 24
            }
          ]
        }
      }
    ]
  },
  "ietf-access-control-list:acls": {
    "acl": [
      {
        "name": "msdp-default-peer-policy",
        "type": "ietf-access-control-list:ipv4-acl-type",
        "aces": {
          "ace": [
            {
              "name": "accept",
              "actions": {
                "forwarding": "ietf-access-control-list:accept"
              }
            }
          ]
        }
      }
    ]
  },
  "ietf-routing:routing": {
    "router-id": "203.0.113.1",
    "control-plane-protocols": {
      "control-plane-protocol": [
        {
          "type": "ietf-msdp:msdp",
          "name": "msdp-1",
          "ietf-msdp:msdp": {
            "global": {
              "tcp-connection-source": "eth1",
              "default-peer": [
                {
                  "peer-addr": "198.51.100.8",
                  "prefix-policy": "msdp-default-peer-policy"
                }
              ],
              "originating-rp": {
                "interface": "eth1"
              },
              "sa-limit": 0,
              "ttl-threshold": 1
            },
            "peers":{
              "peer":[
                {
                  "address": "198.51.100.8",
                  "enabled": true,
                  "tcp-connection-source": "eth1",
                  "description": "x",
                  "mesh-group": "x",
                  "peer-as": 100,
                  "sa-limit": 0,
                  "timer":{
                    "connect-retry-interval": 0,
                    "holdtime-interval": 3,
                    "keepalive-interval": 1
                  },
                  "ttl-threshold": 1
                }
              ]
            }
          }
        }
      ]
    }
  }
}
            ]]></artwork>
       <postamble></postamble>
      </figure>
  </section>
  
  <section title="The state example"> 
        <figure align="center">
     <artwork align="center"><![CDATA[
{
  "ietf-interfaces:interfaces": {
    "interface": [
      {
        "name": "eth1",
        "description": "An interface with MSDP enabled.",
        "type": "iana-if-type:ethernetCsmacd",
        "phys-address": "00:00:5e:00:53:01",
        "oper-status": "up",
        "statistics": {
          "discontinuity-time": "2020-02-22T11:22:33+02:00"
        },
        "ietf-ip:ipv4": {
          "forwarding": true,
          "mtu": 1500,
          "address": [
            {
              "ip": "192.0.2.1",
              "prefix-length": 24,
              "origin": "static"
            }
          ]
        }
      }
    ]
  },
  "ietf-access-control-list:acls": {
    "acl": [
      {
        "name": "msdp-default-peer-policy",
        "type": "ietf-access-control-list:ipv4-acl-type",
        "aces": {
          "ace": [
            {
              "name": "accept",
              "actions": {
                "forwarding": "ietf-access-control-list:accept"
              }
            }
          ]
        }
      }
    ]
  },
  "ietf-routing:routing": {
    "router-id": "203.0.113.1",
    "control-plane-protocols": {
      "control-plane-protocol": [
        {
          "type": "ietf-msdp:msdp",
          "name": "msdp-1",
          "ietf-msdp:msdp":{
            "global":{
              "tcp-connection-source": "eth1",
              "default-peer": [
                {
                  "peer-addr": "198.51.100.8",
                  "prefix-policy": "msdp-default-peer-policy"
                }
              ],
              "originating-rp": {
                "interface": "eth1"
              },
              "sa-limit": 0,
              "ttl-threshold": 1
            },
            "peers":{
              "peer":[
                {
                  "address": "198.51.100.8",
                  "enabled": true,
                  "tcp-connection-source": "eth1",
                  "description": "x",
                  "mesh-group": "x",
                  "peer-as": 100,
                  "sa-limit": 0,
                  "timer":{
                    "connect-retry-interval": 0,
                    "holdtime-interval": 3,
                    "keepalive-interval": 1
                  },
                  "ttl-threshold": 1,
                  "session-state": "established",
                  "elapsed-time": 5,
                  "is-default-peer": true,
                  "keepalive-expire": 1,
                  "reset-count": 1,
                  "statistics": {
                    "discontinuity-time": "2020-02-22T12:22:33+02:00"
                  }
                }
              ]
            },
            "sa-cache": {
              "entry": [
                {
                  "group": "233.252.0.23",
                  "source-addr": "198.51.100.8",
                  "origin-rp": [
                    {
                      "rp-address": "203.0.113.10",
                      "is-local-rp": false,
                      "sa-adv-expire": 150
                    }
                  ],
                  "state-attributes": {
                    "up-time": 20,
                    "expire": 120,
                    "holddown-interval": 150,
                    "peer-learned-from": "203.0.113.10",
                    "rpf-peer": "203.0.113.10"
                  }
                }
              ]
            }
          }
        }
      ]
    }
  }
}
            ]]></artwork>
       <postamble></postamble>
      </figure>
  </section>
  
  <section title="The actions example"> 
  <t>This example shows the input data (in JSON) for executing an "sa-cache clear" 
  action to clear the cache of all entries which match the group address of 233.252.0.23.</t>
        <figure align="center">
     <artwork align="left"><![CDATA[
  {
    "ietf-msdp:sa-cache":{
      "input":{
        "entry":{
          "group":"233.252.0.23"
        }
      }
    }
  }
            ]]></artwork>
       <postamble></postamble>
      </figure>
  </section>
  
	</section>
  
	</back>
</rfc>
