<?xml version="1.0" encoding="US-ASCII"?>
<!-- this is version 5 of this xml2rfc template -->
<!--
    DOCTYPE processing

To use this XML template, the rfc2629.dtd from the xml2rfc distribution should 
be in the local directory. The xml2rfc distribution is available from 
http://xml.resource.org/

 The ENTITY clauses create an include of the named XML files, which
contains references written in xml2rfc format.

 XML2RFC offers an include feature described in the XML2RFC README
  file.  That syntax, however, contradicts the DTD requirements to
  have <reference> elements within the <references> element, so an 
  XML parser is likely to find your XML file invalid.  It may be
  possible that XML2RFC will change their DTD so that the XML file
  remains valid when their style of include is used.

Some editors, such as XXE, resolve the ENTITY clauses before displaying the 
document to be edited.
-->
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
<!ENTITY rfc2119 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml">
<!ENTITY rfc2223 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2223.xml">
<!ENTITY rfc2578 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2578.xml">
<!ENTITY rfc2579 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2579.xml">
<!ENTITY rfc2580 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2580.xml">
<!ENTITY rfc2629 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2629.xml">
<!ENTITY rfc3410 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.3410.xml">
<!ENTITY rfc4181 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.4181.xml">
]>
<?rfc toc="yes"?>
<?rfc symrefs="yes"?>
<?rfc compact="yes"?>
<?rfc subcompact="no"?>
<?rfc strict="no"?>
<?rfc rfcedstyle="yes"?>
<?rfc comments="yes"?>
<?rfc inline="yes"?>
<rfc category="std" docName="draft-moriarty-yangsecuritytext-02"
     ipr="trust200902">
  <front>
    <title abbrev="draft-moriarty-yangsecuritytext-01">Security Considerations
    Template for YANG Module Documents</title>

    <author fullname="Kathleen M. Moriarty" initials="K" surname="Moriarty">
      <organization>Center for Internet Security (CIS)</organization>

      <address>
        <postal>
          <street>31 Tech Valley Drive</street>

          <city>East Greenbush, NY</city>

          <country>US</country>
        </postal>

        <email>Kathleen.Moriarty.ietf@gmail.com</email>
      </address>
    </author>

    <date year="2023"/>

    <area>Security</area>

    <workgroup>IETF</workgroup>

    <keyword>YANG</keyword>

    <keyword>Security</keyword>

    <keyword>Considerations</keyword>

    <abstract>
      <t>This document includes the template text agreed upon by the
      Operations Area and Security Area for inclusion in YANG documents. The
      best practices are updated as needed and will result in updates to this
      template for use to provide a consistent set of security considerations
      for authors, developers, and implementors.</t>
    </abstract>
  </front>

  <middle>
    <section title="Introduction">
      <t>This document includes the template text agreed upon by the
      Operations Area and Security Area for inclusion in YANG documents. The
      best practices are updated as needed and will result in updates to this
      template for use to provide a consistent set of security considerations
      for authors, developers, and implementors.</t>

      <t>Updates may be made through errata or a publication of an updated
      document for ease of use by the IETF and other standards organizations.
      The current version is maintained on a wiki.</t>
    </section>

    <section title="YANG Security Considerations Template">
      <t>The following template text, in addition to the guidance provided by
      the Security Area Directors in the Security Area wiki, must be included
      in the applicable IETF YANG publications. The text is provided as a
      template for use by other organizations with a requirement to reference
      it appropriately to this document.</t>

      <t>This RFC contains text intended for use as a template as designated
      below by the markers <figure>
          <artwork><![CDATA[ <BEGIN TEMPLATE TEXT> and <END TEMPLATE TEXT>  ]]></artwork>
        </figure> or other clear designation. Such Template Text is subject to
      the provisions of Section 9(b) of the <!-- <xref target="TLP"> Trust Legal
      Provisions.</xref>
      --></t>

      <figure>
        <artwork><![CDATA[  <BEGIN TEMPLATE TEXT> 
         ]]></artwork>
      </figure>

      <t>Security Considerations</t>

      <t>The YANG module(s) specified in this document defines a schema for
      data that is designed to be accessed via network management protocols
      such as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF
      layer is the secure transport layer, and the mandatory-to-implement
      secure transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF
      layer is HTTPS, and the mandatory-to-implement secure transport is TLS
      [RFC 8446].</t>

      <t>The Network Configuration Access Control Model (NACM) [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>-- if you have any writable data nodes (those are all the -- "config
      true" nodes, and remember, that is the default) -- describe their
      specific sensitivity or vulnerability.</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>&lt;list subtrees and data nodes and state why they are
      sensitive&gt;</t>

      <t>-- for all YANG modules you must evaluate whether any readable data
      -- nodes (those are all the "config false" nodes, but also all other --
      nodes, because they can also be read via operations like get or --
      get-config) are sensitive or vulnerable (for instance, if they -- might
      reveal customer information or violate personal privacy -- laws such as
      those of the European Union if exposed to -- unauthorized parties)</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 are the subtrees and data nodes
      and their sensitivity/vulnerability:</t>

      <t>&lt;list subtrees and data nodes and state why they are
      sensitive&gt;</t>

      <t>-- if your YANG module has defined any rpc operations -- describe
      their specific sensitivity or vulnerability.</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>&lt;list RPC operations and state why they are sensitive&gt;</t>

      <t/>

      <figure>
        <artwork><![CDATA[  <END TEMPLATE TEXT> 
	    ]]></artwork>
      </figure>

      <t>Note: [RFC 8446], [RFC6241], [RFC6242], [RFC8341], and [RFC8040] must
      be "normative references".</t>
    </section>

    <section title="Security Considerations">
      <t>This document defines a template to provide consistent YANG Security
      Considerations on publications by the IETF and other standards bodies
      and organizations.</t>
    </section>

    <section title="IANA Considerations">
      <t>This memo includes no request to IANA.</t>
    </section>

    <section title="Contributors">
      <t>Thank you to reviewers and contributors who helped to improve the
      security consdierations for YANG. The text has been developed and
      refined over many years on an Operations Area working group mailing list
      and to a Security Area wiki. Revisions have been made by IETF Security
      Area Directors and Operations Area Directors similar to the template for
      SNMP security considerations. Thank you to the following known
      contributors: Sean Turner, Stephen Farrell, Beniot Claise, and Erik
      Rescorla.</t>
    </section>
  </middle>

  <back>
    <references title="Normative References">
      <!--
            <reference anchor="TLP"
                 target="https://trustee.ietf.org/documents/trust-legal-provisions/tlp-5/">
          <front>
          <title>Trust Legal Provisions</title>
          </author>
          </front>
      </reference>
      -->

      <?rfc include='reference.RFC.2119'?>

      <?rfc include='reference.RFC.8174'?>

      <!--
      -->
    </references>

    <references title="Informative References">
      <?rfc include='reference.RFC.8446'?>

      <?rfc include='reference.RFC.6241'?>

      <?rfc include='reference.RFC.6242'?>

      <?rfc include='reference.RFC.8341'?>

      <?rfc include='reference.RFC.8040'?>
    </references>

    <section title="Change Log ">
      <t>Note to RFC Editor: if this document does not obsolete an existing
      RFC, please remove this appendix before publication as an RFC.</t>
    </section>
  </back>
</rfc>
