<?xml version="1.0" encoding="US-ASCII"?>
<!-- <?xml version="1.0" encoding="UTF-8"?> -->
<!-- edited with XMLSPY v5 rel. 3 U (http://www.xmlspy.com)
     by Daniel M Kohn (private)
-->
<!DOCTYPE rfc SYSTEM "rfc2629.dtd">

<?rfc toc="yes"?>
<?rfc rfcedstyle="yes"?>
<?rfc subcompact="no"?>
<?rfc symrefs="yes"?>
<rfc ipr="trust200902" category="std" docName="draft-ietf-i2nsf-registration-interface-dm-22">

<front>
  <title abbrev="Registration Interface YANG Data Model">
    I2NSF Registration Interface YANG Data Model for NSF Capability Registration
  </title>

  <author role="editor" initials="S." surname="Hyun" fullname="Sangwon Hyun">
    <organization abbrev="Myongji University">
      Department of Computer Engineering
    </organization>

    <address>
      <postal>
        <street> Myongji University</street>
        <street>116 Myongji-ro, Cheoin-gu</street>
        <city>Yongin</city> <region>Gyeonggi-do</region>
        <code>17058</code>
        <country>Republic of Korea</country>
      </postal>
      <email>shyun@mju.ac.kr</email>
    </address>
  </author>

  <author role="editor" initials="J." surname="Jeong" fullname="Jaehoon Paul Jeong">
    <organization abbrev="Sungkyunkwan University">
      Department of Computer Science and Engineering
    </organization>

    <address>
      <postal>
        <street>Sungkyunkwan University</street>
        <street>2066 Seobu-Ro, Jangan-Gu</street>
        <city>Suwon</city> <region>Gyeonggi-Do</region>
        <code>16419</code>
        <country>Republic of Korea</country>
      </postal>
      <phone>+82 31 299 4957</phone>
      <facsimile>+82 31 290 7996</facsimile>
      <email>pauljeong@skku.edu</email>
      <uri>http://iotlab.skku.edu/people-jaehoon-jeong.php</uri>
    </address>
  </author>

  <author initials="T." surname="Roh" fullname="Taekyun Roh">
    <organization abbrev="Sungkyunkwan University">
      Department of Electronic, Electrical and Computer Engineering
    </organization>

    <address>
      <postal>
        <street>Sungkyunkwan University</street>
        <street>2066 Seobu-Ro, Jangan-Gu</street>
        <city>Suwon</city> <region>Gyeonggi-Do</region>
        <code>16419</code>
        <country>Republic of Korea</country>
      </postal>
      <phone>+82 31 290 7222</phone>
      <facsimile>+82 31 299 6673</facsimile>
      <email>tkroh0198@skku.edu</email>
    </address>
  </author>

  <author initials="S." surname="Wi" fullname="Sarang Wi">
    <organization abbrev="Sungkyunkwan University">
      Department of Electronic, Electrical and Computer Engineering
    </organization>

    <address>
      <postal>
        <street>Sungkyunkwan University</street>
        <street>2066 Seobu-Ro, Jangan-Gu</street>
        <city>Suwon</city> <region>Gyeonggi-Do</region>
        <code>16419</code>
        <country>Republic of Korea</country>
      </postal>
      <phone>+82 31 290 7222</phone>
      <facsimile>+82 31 299 6673</facsimile>
      <email>dnl9795@skku.edu</email>
    </address>
  </author>

  <author initials="J." surname="Park" fullname="Jung-Soo Park">
    <organization abbrev="ETRI">
      Electronics and Telecommunications Research Institute
    </organization>

    <address>
      <postal>
        <street>218 Gajeong-Ro, Yuseong-Gu</street>
        <city>Daejeon</city>
        <code>305-700</code>
        <country>Republic of Korea</country>
      </postal>
      <phone>+82 42 860 6514</phone>
      <email>pjs@etri.re.kr</email>
    </address>
  </author>

  <date month="November" day="8" year="2022" />
  <area>Security</area>
  <workgroup>I2NSF Working Group</workgroup>

<!-- [rfced] Please insert any keywords (beyond those that appear in
the title) for use on http://www.rfc-editor.org/rfcsearch.html. -->

  <keyword>Internet-Draft</keyword>

  <abstract>
    <t>
      This document defines an information model and a YANG data 
      model for the Registration Interface between Security Controller 
      and Developer's Management System (DMS) in the Interface to 
      Network Security Functions (I2NSF) framework to register 
      Network Security Functions (NSF) of the DMS with the Security 
      Controller. The objective of these information and data models 
      is to support NSF capability registration and query via I2NSF
      Registration Interface.
    </t>
  </abstract>
  <!-- <note title="Editorial Note (To be removed by RFC Editor)">
        <t>Please update these statements within the document with the RFC
           number to be assigned to this document:<list style="empty">
        <t>"This version of this YANG module is part of RFC XXXX;"</t>

        <t>"RFC XXXX: I2NSF Registration Interface YANG Data Model"</t>

        <t>"reference: RFC XXXX"</t>
    </list>Please update the "revision" date of the YANG module.</t>
</note> -->
</front>

<!-- End of Front -->

<middle>

  <section anchor="section:Introduction" title="Introduction">
    <t>
      A number of Network Security Functions (NSF) may exist in the 
      Interface to Network Security Functions (I2NSF) framework 
      <xref target="RFC8329"/>. Since each of these NSFs likely has 
      different security capabilities from each other, it is important 
      to register the security capabilities of the NSFs to the Security
      Controller (i.e., Network Management Operator System). In addition, it is required to search NSFs of some 
      required security capabilities on demand. As an example, if 
      additional security capabilities are required to serve some 
      security service request(s) from an I2NSF User, the security 
      controller SHOULD be able to request the DMS for NSFs that have 
      the required security capabilities.
    </t>
    
    <t>
      As the main focus of the YANG module defined in
      <xref target="I-D.ietf-i2nsf-capability-data-model"/> is to define
      the security capabilities of an NSF, it lacks in some information
      (e.g., network access information to an NSF) needed by the Security
      Controller. This information can be provided by the
      DMS as it is the vendor system that provides and deploys the NSFs.
      Hence, this document provides extended information for
      the I2NSF Registration Interface.
    </t> 
    
    <t>
      This document describes an information model (see 
      <xref target="section:info-model" />) and an augmented YANG 
      <xref target="RFC7950" /> data model from I2NSF Capability YANG 
      data model <xref target="I-D.ietf-i2nsf-capability-data-model"/> 
      (see <xref target="section:data-model" />) for the I2NSF 
      Registration Interface <xref target="RFC8329" /> between the 
      Security Controller and the developer's management system (DMS) 
      to support NSF capability registration and query via the 
      registration interface. It also describes the operations which 
      SHOULD be performed by the Security Controller and the DMS via the 
      Registration Interface using the defined model.
	  Note that in either NETCONF <xref target = "RFC6241" /> or RESTCONF
      <xref target = "RFC8040" /> parlance through the I2NSF Registration
	  Interface, the Security Controller is the server, and the DMS is
	  the client because the Security Controller and DMS run the server
	  and client for either NETCONF or RESTCONF, respectively.
    </t>
  </section>

<!-- terminology start -->
  <section anchor="section:Terminology" title="Terminology">
    <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>
    <t>
      This document uses the following terms defined in <xref target="RFC3444"/>,
      <xref target="RFC8329" /> and <xref target="I-D.ietf-i2nsf-capability-data-model" />.
    </t>
    <t>
      <list style="symbols">
        <t>
          Network Security Function (NSF): A function that is 
          responsible for a specific treatment of received packets. 
          A Network Security Function can act at various layers of a
          protocol stack (e.g., at the network layer or other OSI layers).
          Sample Network Security Service Functions are as follows:
          Firewall, Intrusion Prevention/Detection System (IPS/IDS), 
          Deep Packet Inspection (DPI), Application Visibility and Control 
          (AVC), network virus and malware scanning, sandbox, Data Loss
          Prevention (DLP), Distributed Denial of Service (DDoS) 
          mitigation and TLS proxy.
        </t>
        <t>
          Data Model: Data Models define managed objects at a lower
          level of abstraction, which include implementation- and
          protocol-specific details, e.g., rules that explain how to
          map managed objects onto lower-level protocol constructs
          <xref target="RFC3444"/>.
        </t>
        <t>
          Information Model: Information Models are primarily useful
          for designers to describe the managed environment, for
          operators to understand the modeled objects, and for
          implementers as a guide to the functionality that must be
          described and coded in the Data Models <xref target="RFC3444"/>. 
        </t>
        <t>
          YANG: This document follows the guidelines of <xref
          target="RFC8407"></xref>, uses the common YANG types defined in <xref
          target="RFC6991"></xref>, and adopts the Network Management Datastore
          Architecture (NMDA) <xref target="RFC8342"/>. The meaning of
          the symbols in tree diagrams is defined in 
          <xref target="RFC8340"/>.
        </t>
      </list>
    </t>

  </section>
  <!-- terminology end -->


     <!-- Objectives start -->
  <section anchor="section:Objectives" title="Objectives">
    <t>
      <list style="symbols">
        <t>
          Registering NSFs with the I2NSF framework: Developer's Management 
          System (DMS) in I2NSF framework is typically run by an NSF
          vendor, and uses Registration Interface to provide NSFs information
          (i.e., capability, specification, and access information)
          developed by the NSF vendor to Security Controller. Since 
          there may be multiple vendors that provide NSFs for a target network,
          the I2NSF Registration Interface can be used as a standard
          interface for the DMSs to provide NSFs capability information
          to the Security Controller. For the registered NSFs, 
          Security Controller maintains a catalog of the capabilities 
          of those NSFs to select appropriate NSFs for the requested 
          security services.
        </t>

        <t>
          Updating the capabilities of registered NSFs: After an NSF
          is registered with Security Controller, some modifications 
          on the capability of the NSF MAY be required later. In this 
          case, DMS uses Registration Interface to deliver the update
		  of the capability of the NSF to the Security Controller, 
		  and this update MUST be reflected on the catalog of NSFs
		  existing in the Security Controller. That is, whenever there
		  are updates on the NSFs, the DMS sends the updated, whole
		  NSF capability information to the Security Controller.
		  The Security Controller updates its catalog of NSFs with the
		  updated NSF capability information.
        </t>

        <t>
          Asking DMS about some required capabilities: In cases that 
          some security capabilities are required to serve the 
          security service request from an I2NSF User, the Security 
          Controller searches through the registered NSFs to find 
          ones that can provide the required capabilities. But 
          Security Controller might fail to find any NSFs having the 
          required capabilities among the registered NSFs. In this 
          case, Security Controller needs to request DMS for 
          additional NSF(s) information that can provide the required
          security capabilities via Registration Interface.
        </t>
      </list>
    </t>
  </section>
<!-- Objectives end -->


<!-- information model start -->
  <section anchor="section:info-model" title="Information Model">
    <t>
      The I2NSF registration interface is used by Security Controller 
      and Developer's Management System (DMS) in I2NSF framework.
      <xref target="the-registration-interface-information-model-design"/> 
      shows the information model of the I2NSF registration interface, 
      which consists of two submodels: NSF capability registration and
      NSF capability query. Each submodel is used for the operations 
      listed above. The remainder of this section will provide in-depth
      explanation of each submodel.
    </t>

    <figure anchor="the-registration-interface-information-model-design" title="I2NSF Registration Interface Information Model">
      <artwork><![CDATA[
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |      I2NSF Registration Interface Information Model       |
  |                                                           |
  |         +-+-+-+-+-+-+-+-+-+  +-+-+-+-+-+-+-+-+-+          |
  |         | NSF Capability  |  | NSF Capability  |          |
  |         | Registration    |  | Query           |          |
  |         +-+-+-+-+-+-+-+-+-+  +-+-+-+-+-+-+-+-+-+          |
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      ]]></artwork>
    </figure>


    <section anchor="subsec:nsf-cap-reg-IM" title="NSF Capability Registration">
      <t>
        This submodel is used by the DMS to register the capabilities of NSFs with the
        Security Controller. <xref target="nsf-cap-info-submodel"/>
        shows how this submodel is constructed. The most important 
        part in <xref target="nsf-cap-info-submodel"/> is the NSF 
        capability, and this specifies the set of capabilities that
        the NSF to be registered can offer. The NSF Name contains a
        unique name of this NSF with the specified set of
        capabilities. The NSF name MUST be unique within the registered
        NSFs in the Security Controller to identify the NSF with the 
        capability. The name can be an arbitrary string including 
        Fully Qualified Domain Name (FQDN). To make sure each vendor 
        does not provide a duplicated name, the name should include 
        the vendor's name (e.g., firewall-cisco, firewall-huawei).
        When registering the NSF, DMS additionally 
        includes the network access information of the NSF which is 
        required to enable network communications with the NSF.
      </t>

      <t>
        The following will further explain the NSF capability 
        information and the NSF access information in more detail.
      </t> 

      <figure anchor="nsf-cap-info-submodel" title="NSF Capability Registration Sub-Model">
        <artwork><![CDATA[
                       +-+-+-+-+-+-+-+-+-+
                       | NSF Capability  |
                       | Registration    |
                       +-+-+-+-+^+-+-+-+-+
                                |
          +---------------------+--------------------+
          |                     |                    |
          |                     |                    |
    +-+-+-+-+-+-+       +-+-+-+-+-+-+-+-+      +-+-+-+-+-+-+-+
    |   NSF     |       | NSF Capability|      | NSF Access  |
    |   Name    |       | Information   |      | Information |
    +-+-+-+-+-+-+       +-+-+-+-+-+-+-+-+      +-+-+-+-+-+-+-+ 
        ]]></artwork>
      </figure>

      <section anchor="subsubsec:nsf-cap-info-IM" title="NSF Capability Information">
        <t>
          NSF Capability Information basically describes the
          security capabilities of an NSF. In 
          <xref target="nsf-profile-overview" />, we show 
          capability objects of an NSF. Following the information
          model of NSF capabilities defined in 
          <xref target="I-D.ietf-i2nsf-capability-data-model" />, 
          we share the same I2NSF security capabilities: Directional 
          Capabilities, Event Capabilities, Condition Capabilities,
          Action Capabilities, Resolution Strategy Capabilities, 
          Default Action Capabilities. Also, NSF Capability 
          Information additionally contains the specification
          of an NSF as shown in 
          <xref target="nsf-profile-overview" />.
        </t>
        <figure anchor="nsf-profile-overview" title="NSF Capability Information">
          <artwork><![CDATA[
                          +-+-+-+-+-+-+-+-+-+
                          | NSF Capability  |
                          |   Information   |
                          +-+-+-+-^-+-+-+-+-+
                                  |
                                  |
           +----------------------+----------------------+
           |                                             |
           |                                             |
   +-+-+-+-+-+-+-+-+                             +-+-+-+-+-+-+-+-+
   |     I2NSF     |                             |      NSF      |
   | Capabilities  |                             | Specification |
   +-+-+-+-+-+-+-+-+                             +-+-+-+-+-+-+-+-+
           |
    +------+-------------+----------------+----------------+-------+
    |                    |                |                |       |
+-+-+-+-+-+-+-+  +-+-+-+-+-+-+-+  +-+-+-+-+-+-+-+  +-+-+-+-+-+-+-+ |
| Directional |  |    Event    |  |  Condition  |  |    Action   | |
| Capabilities|  | Capabilities|  | Capabilities|  | Capabilities| |
+-+-+-+-+-+-+-+  +-+-+-+-+-+-+-+  +-+-+-+-+-+-+-+  +-+-+-+-+-+-+-+ |
                                                                   |
                 +--------------------+--------------------+-------+
                 |                    |              
           +-+-+-+-+-+-+-+      +-+-+-+-+-+-+-+      
           | Resolution  |      |   Default   |      
           | Strategy    |      |   Action    |      
           | Capabilities|      | Capabilities|      
           +-+-+-+-+-+-+-+      +-+-+-+-+-+-+-+
          ]]></artwork>
        </figure>

        <section anchor="subsubsubsec:nsf-spec-IM" title="NSF Specification">
          <t>
            This information represents the specification information 
            (e.g., CPU, memory, disk, and bandwidth) of 
            an NSF. As illustrated in <xref target="nsf-specification-overview"/>, 
            this information consists of CPU, memory, disk, and 
            bandwidth. The CPU information describes the Central Processing
            Unit (CPU) used by the NSF. The information consists of
            model name, cores, clock speed, and threads.
          </t>
            
          <t>
            The memory information describes the hardware that stores 
            information temporarily, i.e., Random Access Memory (RAM).
            The information consists of RAM maximum capacity and RAM speed.
            The disk information describes the storage information, 
            i.e., Hard Disk and Solid-State Drive. The information 
            given is the maximum capacity of the storage available
            in the NSF.
          </t>
            
            
          <t>
            Bandwidth describes the information about available network amount in two cases, 
            such as outbound and inbound. Assuming that the current throughput status of each
            NSF is being collected through NSF monitoring
            <xref target="I-D.ietf-i2nsf-nsf-monitoring-data-model"/>, 
            this capability information of the NSF can be used to 
            determine whether the NSF is in congestion or not by comparing 
            it with the current throughput of the NSF.
          </t>

          <figure anchor="nsf-specification-overview" title="NSF Specification Overview">
            <artwork><![CDATA[
                      +-----------------+
                      |       NSF       |
                      |  Specification  |
                      +--------^--------+
                               |
         +-------------+-------+-----+--------------+
         |             |             |              |
         |             |             |              |
      +--+--+     +----+---+     +---+--+     +-----+-----+
      | CPU |     | Memory |     | Disk |     | Bandwidth |
      +-----+     +--------+     +------+     +-----------+
            ]]></artwork>
          </figure>
        </section>
      </section>

      <section anchor="subsubsec:nsf-access-info-IM" title="NSF Access Information">
        <t>
          NSF Access Information contains the following that 
          are required to communicate with an NSF through NETCONF <xref target = "RFC6241" />
          or RESTCONF <xref target = "RFC8040" />:
          an IP address (i.e., IPv4 or IPv6 address) and a port number.
          Note that TCP is used as a transport layer protocol due to either
          NETCONF or RESTCONF.  In this document, NSF Access Information is
          used to identify a specific NSF instance. That is, NSF Access 
          Information is the signature (i.e., unique identifier) of an 
          NSF instance in the overall I2NSF system.
        </t>
      </section>

    </section>

    <section anchor="subsec:nsf-cap-query-IM" title="NSF Capability Query">
      <t>
        Security Controller MAY require some additional capabilities 
        to serve the security service request from an I2NSF User, but
        none of the registered NSFs has the required capabilities. In
        this case, Security Controller makes a description of the 
        required capabilities by using the NSF capability information
        submodel in <xref target="subsubsec:nsf-cap-info-IM" />, and
        sends DMS a query about which NSF(s) can provide these 
        capabilities.
      </t>
    </section>

  </section>
<!-- information model end -->

<!-- Data model start -->
  <section anchor="section:data-model" title="Data Model">

    <!--YANG Tree Diagram  start -->
    <section anchor="subsec:yang-tree-diagram" title="YANG Tree Diagram">
      <t>
        This section provides the YANG Tree diagram of the I2NSF registration interface.
      </t>
      <!--        define  start -->
      <section anchor="subsubsec:yang-tree-symbol-definitions" title="Definitions of Symbols in Tree Diagrams">
        <t>
          A simplified graphical representation of the data model is 
          used in this section.  The meaning of the symbols used in 
          the following diagrams <xref target="RFC8431" /> is as 
          follows:
        </t>
        <t>
          <list>
            <t>
              Brackets "[" and "]" enclose list keys.
            </t>
            <t>
              Abbreviations before data node names: "rw" means 
              configuration (read-write) and "ro" state data 
              (read-only).
            </t>
            <t>
              Symbols after data node names: "?" means an optional 
              node and "*" denotes a "list" and "leaf-list".
            </t>
            <t>
              Parentheses enclose choice and case nodes, and case 
              nodes are also marked with a colon (":").
            </t>
            <t>
              Ellipsis ("...") stands for contents of subtrees that 
              are not shown.
            </t>
          </list>
        </t>
      </section>
      <!--        define end -->
          
      <!--       i2nsf  registration interface start-->
      <section anchor="subsubsec:yang-tree-diagram-of-reg-inf" title="YANG Tree of I2NSF Registration Interface">
          
        <t>
          The I2NSF Registration Interface is used by the Developer's 
          Management System (DMS) to register NSFs and their capabilities
          with the Security Controller. In case that the Security Controller
          fails to find any NSF among the registered NSFs which can 
          provide some required capabilities, Security Controller 
          uses the registration interface to query DMS about NSF(s) 
          having the required capabilities.

          The following sections describe the YANG data models to support these operations.
        </t>

        <section anchor="subsubsubsec:nsf-cap-reg-DM" title="NSF Capability Registration">
          <t>
            This section describes the YANG tree for the NSF 
            capability registration and capability update.
          </t>

          <figure anchor="yang-tree-i2nsf-cap-reg" title="YANG Tree of NSF Capability Registration Module">
            <artwork><![CDATA[
  NSF Capability Registration
  augment /i2nsfcap:nsf:
    +--rw nsf-specification
    |  +--rw cpu
    |  |  +--rw model?         string
    |  |  +--rw clock-speed?   uint16
    |  |  +--rw cores?         uint8
    |  |  +--rw threads?       uint16
    |  +--rw memory
    |  |  +--rw capacity?   uint32
    |  |  +--rw speed?      uint32
    |  +--rw disk
    |  |  +--rw capacity?   uint32
    |  +--rw bandwidth
    |     +--rw outbound?   uint64
    |     +--rw inbound?    uint64
    +--rw nsf-access-info
       +--rw ip?                    union
       +--rw port?                  inet:port-number
       +--rw management-protocol?   enumeration
       +--rw name?                  string
       +--rw password?              ianach:crypt-hash
            ]]></artwork>
          </figure>

          <t>
            When registering an NSF with Security Controller, DMS uses
            the augmented I2NSF Capability YANG Data Model 
            <xref target="I-D.ietf-i2nsf-capability-data-model"/>
            to describe what capabilities the NSF can offer.
            DMS includes the access information of the NSF 
            which is required to make a network connection with the 
            NSF as well as the specification of the NSFs.
            The NSF access information consists of ip, port,
            and management-protocol. The field of ip can have either 
            an IPv4 address or an IPv6 address. The port field is used 
            to get the transport protocol port number. As I2NSF uses a 
            YANG data model, the management protocol can be either
            NETCONF or RESTCONF. The credentials (i.e., username and
            password)
          </t>
          
          <t>
            The DMS can also include the resource information in 
            terms of CPU, memory, disk, and network 
            bandwidth of the NSF. Detailed overview of NSF specification
            can be seen in <xref target="subsubsubsec:nsf-spec-IM"/>.
          </t>
          
          <t>
            This YANG data model is also used to update the registered
            NSFs. The update operation can be done by changing the 
            configuration information of the same key (i.e., nsf-name)
            and utilize the "replace" operation for NETCONF defined 
            in Section 7.2 of <xref target="RFC6241"/> or the 
            "PUT" method for RESTCONF defined in Section 4.5 of 
            <xref target="RFC8040"/>.
          </t>
          
        </section>

        <section anchor="subsubsubsec:nsf-cap-query-DM" title="NSF Capability Query">
          <t>
            This section describe the YANG tree for the NSF capability
            query.
          </t>

          <figure anchor="yang-tree-i2nsf-cap-query" title="YANG Tree of NSF Capability Query Module">
            <artwork><![CDATA[
  I2NSF Capability Query
  rpcs:
    +---x nsf-capability-query
       +---w input
       |  +---w query-nsf-capability
       |     +---w directional-capabilities*           identityref
       |     +---w event-capabilities
       |     |  +---w system-event-capability*   identityref
       |     |  +---w system-alarm-capability*   identityref
       |     +---w condition-capabilities
       |     |  +---w generic-nsf-capabilities
       |     |  |  +---w ethernet-capability*   identityref
       |     |  |  +---w ipv4-capability*       identityref
       |     |  |  +---w ipv6-capability*       identityref
       |     |  |  +---w icmpv4-capability*     identityref
       |     |  |  +---w icmpv6-capability*     identityref
       |     |  |  +---w tcp-capability*        identityref
       |     |  |  +---w udp-capability*        identityref
       |     |  |  +---w sctp-capability*       identityref
       |     |  |  +---w dccp-capability*       identityref
       |     |  +---w advanced-nsf-capabilities
       |     |  |  +---w anti-ddos-capability*             identityref
       |     |  |  +---w ips-capability*                   identityref
       |     |  |  +---w anti-virus-capability*            identityref
       |     |  |  +---w url-filtering-capability*         identityref
       |     |  |  +---w voip-vocn-filtering-capability*   identityref
       |     |  +---w context-capabilities
       |     |     +---w time-capabilities*                 identityref
       |     |     +---w application-filter-capabilities*   identityref
       |     |     +---w device-type-capabilities*          identityref
       |     |     +---w user-condition-capabilities*       identityref
       |     |     +---w geographic-capabilities*           identityref
       |     +---w action-capabilities
       |     |  +---w ingress-action-capability*   identityref
       |     |  +---w egress-action-capability*    identityref
       |     |  +---w log-action-capability*       identityref
       |     +---w resolution-strategy-capabilities*   identityref
       |     +---w default-action-capabilities*        identityref
       +--ro output
          +--ro nsf-access-info
             +--ro nsf-name?              string
             +--ro ip?                    union
             +--ro port?                  inet:port-number
             +--ro management-protocol?   enumeration
             +--ro name?                  string
             +--ro password?              ianach:crypt-hash
              ]]></artwork>
          </figure>

          <t>
            Security Controller MAY require some additional 
            capabilities to provide the security service requested 
            by an I2NSF User, but none of the registered NSFs has 
            the required capabilities. In this case, Security
            Controller makes a description of the required
            capabilities using this module and then queries DMS about
            which NSF(s) can provide these capabilities. Use NETCONF 
            RPCs to send a NSF capability query. Input data is 
            query-i2nsf-capability-info and output data is 
            nsf-access-info. In <xref target="yang-tree-i2nsf-cap-query"/>,
            the ietf-i2nsf-capability refers to the module defined in 
            <xref target="I-D.ietf-i2nsf-capability-data-model" />.
          </t>

        </section>

      </section>
      <!--  i2nsf registration interface   end -->
    </section>
  <!-- YANG Tree Diagram  end -->

  <!-- YANG Data Modules  start  -->
    <section anchor="subsec:yang-data-module" title="YANG Data Module">
      <t>
        This section provides a YANG module of the data model for 
        the registration interface between Security Controller and 
        Developer's Management System, as defined in
        <xref target="section:info-model" />.
      </t>
          
      <t>
        This YANG module imports from <xref target="RFC6991" />, <xref target="RFC7317" />, and 
        <xref target="I-D.ietf-i2nsf-capability-data-model" />.
        It makes references to <xref target="RFC6241"/> <xref target="RFC8040"/>
      </t>
      
      <figure anchor="ietf-i2nsf-registration-interface" title="Registration Interface YANG Data Model">
        <artwork><![CDATA[
<CODE BEGINS> file "ietf-i2nsf-registration-interface@2022-11-08.yang"
module ietf-i2nsf-registration-interface {
  yang-version 1.1;

  namespace
    "urn:ietf:params:xml:ns:yang:ietf-i2nsf-registration-interface";

  prefix 
    i2nsfri;

  //RFC Ed.: replace occurences of XXXX with actual RFC number and
  //remove this note

  import ietf-inet-types {
    prefix inet;
    reference "RFC 6991";
  }
  import iana-crypt-hash {
    prefix ianach;
    reference "RFC 7317";
  }
  import ietf-i2nsf-capability {
    prefix i2nsfcap;
  // RFC Ed.: replace YYYY with actual RFC number of
  // draft-ietf-i2nsf-capability-data-model and remove this note.
    reference "RFC YYYY: I2NSF Capability YANG Data Model";
  }

  organization
   "IETF I2NSF (Interface to Network Security Functions)
    Working Group";

  contact
    "WG Web: <https://datatracker.ietf.org/wg/i2nsf>
     WG List: <mailto:i2nsf@ietf.org>

     Editor: Sangwon Hyun
     <mailto:shyun@mju.ac.kr>
 
     Editor: Jaehoon Paul Jeong
     <mailto:pauljeong@skku.edu>";

  description
    "This module defines a YANG data model for I2NSF 
     Registration Interface.
     
     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.

     Copyright (c) 2022 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 Revised 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; see
     the RFC itself for full legal notices.";

  revision "2022-11-08" {
    description "Initial revision";
    reference
      "RFC XXXX: I2NSF Registration Interface YANG Data Model";
    // RFC Ed.: replace XXXX with actual RFC number and remove
    // this note     
  }

  grouping nsf-specification {
    description
      "Description of the specification of an NSF";
  
    container cpu {
      description
        "The Central Processing Unit (CPU) specification of the NSF";
  
      leaf model {
        type string;
        description
          "The model name of the CPU used in the NSF.";
      }
      leaf clock-speed {
        type uint16;
        units "MHz";    
        description
          "The number of cycles the CPU executes per second, 
           measured in MHz (MegaHertz).";
      }
      leaf cores {
        type uint8;
        description
          "The number of independent CPU in a single computing 
           component.";
      }
      leaf threads {
        type uint16;
        description
          "The number of total threads of the CPU";
      }
    }
    
    container memory {
      description
        "Memory (i.e., Random Access Memory (RAM)) specification of
         an NSF.";
  
      leaf capacity {
        type uint32;
        units "MB";
        description
          "The total memory capacity in Megabytes (MB).";
      }
      leaf speed {
        type uint32;
        units "MHz";
        description
          "The data transfer rate of the memory in MegaHertz (MHz).";
      }
    }
    
    container disk {
      description
        "Disk or storage specification of an NSF";
  
      leaf capacity {
        type uint32;
        units "MB";
        description
          "The disk or storage maximum capacity in Megabytes (MB).";
      }
    }
    
    container bandwidth {
      description
        "Network bandwidth available on an NSF
         in the unit of Bps (Bytes per second)";
  
      leaf outbound {
        type uint64;
        units "Bps";
        description
          "The maximum outbound network bandwidth available to the
           NSF in bytes per second (Bps)";
      }
      
      leaf inbound {
        type uint64;
        units "Bps";
        description
          "The maximum inbound network bandwidth available to the
           NSF in bytes per second (Bps)";          
      }
    }
  }
 
  grouping nsf-access-info {
    description
      "Information required to access an NSF";
    leaf ip {
      type union {
        type inet:ip-address-no-zone;
        type inet:domain-name;
      }
      description
        "Either an IP (IPv4 or IPv6) address or the domain name of
         this NSF";
    }
    leaf port {
      type inet:port-number;
      description
        "Port available on this NSF";
    }
    leaf management-protocol {
      type enumeration {
        enum NETCONF {
          description
            "Represents the management protocol NETCONF";
          reference
            "RFC 6241: Network Configuration Protocol (NETCONF)";
        }
        enum RESTCONF {
          description
            "Represents the management protocol RESTCONF";
          reference
            "RFC 8040: RESTCONF Protocol";
        }
      }
      description
        "The management protocol used to manage the NSF";
    }
    leaf username {
      type string;
      description
        "The user name string identifying the credentials for the
         authentication.";
    }
    leaf password {
      type ianach:crypt-hash;
      description
        "The password for the username for the authentication.
         Any plain-text password must be converted to a hashed value
         as soon as possible";
    }
  }
  
  augment "/i2nsfcap:nsf" {
    description
      "Augmented information of an NSF's capability that DMS
       registers with Security Controller";
    reference
      "draft-ietf-i2nsf-capability-data-model-32: I2NSF Capability 
       YANG Data Model";
    container nsf-specification {
      description
        "The specification of an NSF";
      uses nsf-specification;
    }
    container nsf-access-info {
      description
        "Network access information of this NSF";
      uses nsf-access-info;
    }
  }
 
  rpc nsf-capability-query {
    description
      "Description of the capabilities that the
       Security Controller requests to the DMS";
    input {
      container query-nsf-capability {
        description
          "Description of the capabilities to request";
        uses i2nsfcap:nsf-capabilities;
        reference "RFC YYYY: I2NSF Capability YANG Data Model";
      //RFC Ed.: replace YYYY with actual RFC number of
      //draft-ietf-i2nsf-capability-data-model and remove this note.
      }
    }
    output {
      container nsf-access-info {
        description
          "Network access information of an NSF
           with the requested capabilities";
        leaf nsf-name {
          type string;
          description
          "The name of this registered NSF. The NSF name MUST be 
           unique to identify the NSF with the capability. The name
           can be an arbitrary string including Fully Qualified
           Domain Name (FQDN).";
        }
        uses nsf-access-info;
      }
    }
  }
}
<CODE ENDS>
        ]]></artwork>
      </figure>

    </section>
    <!-- YANG Data Modules  end  -->

  </section>
  <!-- Data model end -->

  <section anchor="section:IANA" title="IANA Considerations">
    <t>
      This document requests IANA to register the following URI in the
      "IETF XML Registry" <xref target="RFC3688" />:
      <figure>
        <artwork><![CDATA[
URI: urn:ietf:params:xml:ns:yang:ietf-i2nsf-registration-interface
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.
        ]]>
        </artwork>
      </figure>
      This document requests IANA to register the following YANG
      module in the "YANG Module Names" registry 
      <xref target="RFC7950" /><xref target="RFC8525" />:
      <figure>
        <artwork><![CDATA[
Name: ietf-i2nsf-registration-interface
Namespace: urn:ietf:params:xml:ns:yang:ietf-i2nsf-registration-interface
Prefix: i2nsfri
Reference: RFC XXXX

// RFC Ed.: replace XXXX with actual RFC number and remove
// this note
      ]]>
        </artwork>
      </figure>
    </t>
  </section>

  <section anchor="section:Security-Considerations" title="Security Considerations">
    <t>
      The YANG module specified in this document defines a data schema designed
      to be accessed through 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 required secure transport is Secure Shell (SSH)
      <xref target = "RFC6242" />. The lowest RESTCONF layer is HTTPS, and the
      required secure transport is TLS <xref target = "RFC8446" />.
    </t>

    <t>
      The NETCONF access control model <xref target = "RFC8341" /> provides a
      means of restricting access to specific NETCONF or RESTCONF users to a
      preconfigured subset of all available NETCONF or RESTCONF protocol
      operations and content.
    </t>
    
    <t>
      The architecture of I2NSF Framework presents a risk to the 
      implementation of security detection and mitigation activities.
      It is important to have an authentication and authorization
      method between the communication of the Security Controller and
      the DMS. The following are threats that need to be considered and mitigated:
      <list style="hanging">
        <t hangText="Compromised DMS with valid credentials:">
          It can send falsified information to the Security Controller 
          to mislead existing detection or mitigation devices. 
          Currently, there is no in-framework mechanism to mitigate this,
          and it is an issue for such infrastructures. It is important to keep 
          confidential information from unauthorized persons to mitigate
          the possibility of compromising the DMS with this information.
        </t>
        <t hangText="Impersonating DMS:">
          This involves a system trying to send false information
          while imitating as a DMS; client authentication would help 
          the Security Controller to identify this invalid DMS.
        </t>        
      </list>
    </t>
    

    <t>
      The YANG module defined in this document extends the YANG module
      described in <xref target="I-D.ietf-i2nsf-capability-data-model"/>. 
      Hence, this document shares all the security issues
      that are specified in Section 9 of 
      <xref target="I-D.ietf-i2nsf-capability-data-model"/>.
    </t>
    
    <t>
      There are a number of extended 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:

      <list style="symbols">
        <t>
          nsf-specification: The attacker may provide 
          incorrect information of the specification of 
          any target NSF by illegally modifying this.
        </t>
        <t>
          nsf-access-info: The attacker may provide incorrect network
          access information of any target NSF by illegally modifying
          this.
        </t>
      </list>
    </t>

      <t>
        Some of the readable extended 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:

        <list style="symbols">
          <t>
            nsf-specification: The attacker may gather the 
            specification information of any target NSF and
            misuse the information for subsequent attacks.
          </t>

          <t>
            nsf-access-info: The attacker may gather the network 
            access information of any target NSF and misuse the 
            information for subsequent attacks.
          </t>
        </list>
      </t>

      <t>
        The RPC operation in this YANG module MAY be considered 
        sensitive or vulnerable in some network environments. It is 
        thus important to control access to this operation. The 
        following is the operation and its sensitivity/vulnerability:

        <list style="symbols">
          <t>
           nsf-capability-query: The attacker may exploit this RPC
           operation to deteriorate the availability of the DMS 
           and/or gather the information of some interested NSFs 
           from the DMS. Some of the product capabilities provided
           by a vendor may be publicly known, the DMS should provide
           an authentication and authorization method to make sure
           this node cannot be used for exploitation.
          </t>
        </list>
      </t>
  </section>

</middle>

<back>

  <references title="Normative References">

    <?rfc include="reference.RFC.2119"?>
    <?rfc include="reference.RFC.3688"?>
    <?rfc include="reference.RFC.6241"?>
    <?rfc include="reference.RFC.6242"?>
    <?rfc include="reference.RFC.6991"?>
    <?rfc include="reference.RFC.7317"?>
    <?rfc include="reference.RFC.7950"?>
    <?rfc include="reference.RFC.8040"?>
    <?rfc include="reference.RFC.8174"?>
    <?rfc include="reference.RFC.8329"?> 
    <?rfc include="reference.RFC.8340"?>
    <?rfc include="reference.RFC.8341"?>
    <?rfc include="reference.RFC.8342"?>
    <?rfc include="reference.RFC.8407"?>
    <?rfc include="reference.RFC.8431"?>
    <?rfc include="reference.RFC.8446"?>
    <?rfc include="reference.RFC.8525"?>
    <?rfc include='reference.I-D.ietf-i2nsf-capability-data-model'?>

  </references>

  <references title="Informative References">
    <?rfc include="reference.RFC.3444"?>
    <?rfc include="reference.RFC.3849"?>
    <?rfc include="reference.RFC.5737"?>
    <?rfc include="reference.RFC.7348"?>
    <?rfc include='reference.I-D.ietf-i2nsf-nsf-monitoring-data-model'?>
    <?rfc include='reference.I-D.ietf-nvo3-vxlan-gpe'?>  

    <reference anchor="nfv-framework">
      <front>
        <title>Network Functions Virtualisation (NFV); Architectureal Framework</title>
        <author initials="ETSI NFV ISG" />
        <date month="October" year="2013" />
      </front>
      <seriesInfo name="ETSI GS NFV 002" value="ETSI GS NFV 002 V1.1.1" />
    </reference>

  </references>


  <section anchor="section:xml-examples" title="XML Examples of an NSF Registration with I2NSF Registration Interface Data Model">
    <t>
      This section shows XML examples of the I2NSF Registration
      Interface data model for registering the capabilities in 
      either IPv4 networks <xref target="RFC5737" /> or IPv6 
      networks <xref target="RFC3849" /> with Security Controller.
    </t>

    <figure anchor="i2nsf-reg-example1-IPv4" title="Configuration XML for Registration of a General Firewall in an IPv4 Network">
      <artwork><![CDATA[
<nsf
  xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability"
  xmlns:i2nsfri="urn:ietf:params:xml:ns:yang
                 :ietf-i2nsf-registration-interface">
  <nsf-name>ipv4_general_firewall</nsf-name>
  <condition-capabilities>
    <generic-nsf-capabilities>
      <ipv4-capability>next-header</ipv4-capability>
      <ipv4-capability>source-address</ipv4-capability>
      <ipv4-capability>destination-address</ipv4-capability>
      <tcp-capability>source-port-number</tcp-capability>
      <tcp-capability>destination-port-number</tcp-capability>
    </generic-nsf-capabilities>
  </condition-capabilities>
  <action-capabilities>
    <ingress-action-capability>pass</ingress-action-capability>
    <ingress-action-capability>drop</ingress-action-capability>
    <ingress-action-capability>mirror</ingress-action-capability>
    <egress-action-capability>pass</egress-action-capability>
    <egress-action-capability>drop</egress-action-capability>
    <egress-action-capability>mirror</egress-action-capability>
  </action-capabilities>
  <i2nsfri:nsf-specification>
    <i2nsfri:cpu>
      <i2nsfri:model>
        Intel(R) Core(TM) i7-10510U
      </i2nsfri:model>
      <i2nsfri:clock-speed>1800</i2nsfri:clock-speed>
      <i2nsfri:cores>4</i2nsfri:cores>
      <i2nsfri:threads>8</i2nsfri:threads>
    </i2nsfri:cpu>
    <i2nsfri:memory>
      <i2nsfri:capacity>8192</i2nsfri:capacity>
      <i2nsfri:speed>2667</i2nsfri:speed>
    </i2nsfri:memory>
    <i2nsfri:disk>
      <i2nsfri:capacity>239000</i2nsfri:capacity>
    </i2nsfri:disk>
    <i2nsfri:bandwidth>
      <i2nsfri:outbound>1000000000</i2nsfri:outbound>
      <i2nsfri:inbound>1000000000</i2nsfri:inbound>
    </i2nsfri:bandwidth>
  </i2nsfri:nsf-specification>
  <i2nsfri:nsf-access-info>
    <i2nsfri:ip>192.0.2.11</i2nsfri:ip>
    <i2nsfri:port>49152</i2nsfri:port>
    <i2nsfri:management-protocol>
      NETCONF
    </i2nsfri:management-protocol>
    <i2nsfri:username>alice</i2nsfri:username>
    <i2nsfri:password>$0$password123</i2nsfri:password>
  </i2nsfri:nsf-access-info>
</nsf>
        ]]></artwork>
      </figure>

      <t>
        <xref target="i2nsf-reg-example1-IPv4" /> shows the 
        configuration XML for registering a general firewall in an
        IPv4 network <xref target="RFC5737" /> and its capabilities 
        as follows.
      </t>

      <t>
        <list style="numbers">
          <t>
            The instance name of the NSF is ipv4_general_firewall.
          </t>
          <t>
            The NSF can inspect IPv4 protocol header field, source 
            address(es), and destination address(es).
          </t>
          <t>
            The NSF can inspect the port number(s) for the transport 
            layer protocol, i.e., TCP.
          </t>
          <t>
            The NSF can determine whether the packets are allowed to 
            pass, drop, or mirror.
          </t>
          <t>
            The NSF's CPU model is Intel(R) Core(TM) i7-10510U. 
            The clock speed is 1800 MHz, with 4 cores and 8 total threads.
          </t>
          <t>
            The NSF's memory capacity is 8192 MB with the speed 2667 MHz.
          </t>
          <t>
            The NSF's storage can hold maximum 239000 MB.
          </t>
                    
          <t>
            The network bandwidth available on the NSF is 1 GBps for
            both the outbound traffic and inbound traffic.
          </t>
          <t>
            The IPv4 address of the NSF is 192.0.2.11.
          </t>
          <t>
            The port of the NSF is 49152 using the NETCONF protocol. The credentials
            to access the NETCONF are "alice" as the username and "password123"
            for the password.
          </t>
        </list>
      </t>


      <figure anchor="i2nsf-reg-example1-IPv6" title="Configuration XML for Registration of a General Firewall in an IPv6 Network">
        <artwork><![CDATA[
<nsf
  xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability"
  xmlns:i2nsfri="urn:ietf:params:xml:ns:yang
                 :ietf-i2nsf-registration-interface">
  <nsf-name>ipv6_general_firewall</nsf-name>
  <condition-capabilities>
    <generic-nsf-capabilities>
      <ipv6-capability>next-header</ipv6-capability>
      <ipv6-capability>source-address</ipv6-capability>
      <ipv6-capability>destination-address</ipv6-capability>
      <tcp-capability>source-port-number</tcp-capability>
      <tcp-capability>destination-port-number</tcp-capability>
    </generic-nsf-capabilities>
  </condition-capabilities>
  <action-capabilities>
    <ingress-action-capability>pass</ingress-action-capability>
    <ingress-action-capability>drop</ingress-action-capability>
    <ingress-action-capability>mirror</ingress-action-capability>
    <egress-action-capability>pass</egress-action-capability>
    <egress-action-capability>drop</egress-action-capability>
    <egress-action-capability>mirror</egress-action-capability>
  </action-capabilities>
  <i2nsfri:nsf-specification>
    <i2nsfri:cpu>
      <i2nsfri:model>
        Intel(R) Core(TM) i7-10510U
      </i2nsfri:model>
      <i2nsfri:clock-speed>1800</i2nsfri:clock-speed>
      <i2nsfri:cores>4</i2nsfri:cores>
      <i2nsfri:threads>8</i2nsfri:threads>
    </i2nsfri:cpu>
    <i2nsfri:memory>
      <i2nsfri:capacity>8192</i2nsfri:capacity>
      <i2nsfri:speed>2667</i2nsfri:speed>
    </i2nsfri:memory>
    <i2nsfri:disk>
      <i2nsfri:capacity>239000</i2nsfri:capacity>
    </i2nsfri:disk>
    <i2nsfri:bandwidth>
      <i2nsfri:outbound>1000000000</i2nsfri:outbound>
      <i2nsfri:inbound>1000000000</i2nsfri:inbound>
    </i2nsfri:bandwidth>
  </i2nsfri:nsf-specification>
  <i2nsfri:nsf-access-info>
    <i2nsfri:ip>2001:db8:0:1::11</i2nsfri:ip>
    <i2nsfri:port>49152</i2nsfri:port>
    <i2nsfri:management-protocol>
      NETCONF
    </i2nsfri:management-protocol>
    <i2nsfri:username>alice</i2nsfri:username>
    <i2nsfri:password>$0$password123</i2nsfri:password>
  </i2nsfri:nsf-access-info>
</nsf>
        ]]></artwork>
      </figure>

      <t>
        In addition, <xref target="i2nsf-reg-example1-IPv6" /> shows 
        the configuration XML for registering a general firewall in
        an IPv6 network <xref target="RFC3849" /> and its 
        capabilities as follows.
      </t>

      <t>
        <list style="numbers">
          <t>
            The instance name of the NSF is ipv6_general_firewall.
          </t>
          <t>
            The NSF can inspect IPv6 next header, flow direction, 
            source address(es), and destination address(es)
          </t>
          <t>
            The NSF can inspect the port number(s) and flow direction
            for the transport layer protocol, i.e., TCP and UDP.
          </t>
          <t>
            The NSF can determine whether the packets are allowed to
            pass, drop, or mirror.
          </t>
          <t>
            The NSF's CPU model is Intel(R) Core(TM) i7-10510U. 
            The clock speed is 1800 MHz, with 4 cores and 8 total threads.
          </t>
          <t>
            The NSF's memory capacity is 8192 MB with the speed 2667 MHz.
          </t>
          <t>
            The NSF's storage can hold maximum 239 GB.
          </t>
          
          <t>
            The network bandwidth available on the NSF is 1 GBps for
            both the outbound and inbound traffics.
          </t>
          <t>
            The IPv6 address of the NSF is 2001:db8:0:1::11.
          </t>
          <t>
            The port of the NSF is 49152 using the NETCONF protocol. The credentials
            to access the NETCONF are "alice" as the username and "password123"
            for the password.
          </t>
        </list>
      </t>
  </section>
  
  <section anchor="section:xml-examples-2" title="XML Examples of an NSF Query with I2NSF Registration Interface Data Model">
    <t>
      This section shows an XML example of the Security Controller 
      requesting an additional NSF with a certain capability. In this
      example, an I2NSF User requests a security service that is able
      to block the specified websites. When the Security Controller checks
      that no registered NSF can provide such a service, it makes a query
      to the DMS with the following XML:
      
      <figure anchor="i2nsf-reg-example2-query" title="XML for NSF Query of a Web Filter">
        <artwork><![CDATA[
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <nsf-capability-query
  xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-registration-interface">
    <query-nsf-capability>
      <condition-capabilities>
        <advanced-nsf-capabilities>
          <url-filtering-capability>
            user-defined
          </url-filtering-capability>
        </advanced-nsf-capabilities>
      </condition-capabilities>
      <action-capabilities>
        <ingress-action-capability>drop</ingress-action-capability>
        <egress-action-capability>drop</egress-action-capability>
      </action-capabilities>
    </query-nsf-capability>
  </nsf-capability-query>
</rpc>
        ]]></artwork>
      </figure>
    </t>
    
    <t>
      <xref target="i2nsf-reg-example2-query" /> shows 
      the XML for requesting an unregistered web filter with its 
      capabilities as follows.
      <list style="numbers">
        <t>
          The NSF can inspect a URL matched from a user-defined URL 
          where the user can specify their own URL.
        </t>
        <t>
          The NSF can control the network by dropping the packets that
          match the condition. It can drop packets that are entering
          or leaving the target network.
        </t>
      </list>
    </t>
    
    <t>
      After receiving a query given in <xref target="i2nsf-reg-example2-query" />,
      the DMS can reply with following XML:
      <figure anchor="i2nsf-reg-example2-reply" title="XML for the Reply of NSF Query of a Web Filter">
        <artwork><![CDATA[
<rpc-reply message-id="101"
          xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <nsf-access-info
  xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-registration-interface">
    <nsf-name>web_filter</nsf-name>
    <ip>192.0.2.13</ip>
    <port>49152</port>
    <management-protocol>NETCONF</management-protocol>
    <username>alice</username>
    <password>$0$password123</password>
  </nsf-access-info>
</rpc-reply>
        ]]></artwork>
      </figure>
      
    </t>

    <t>
      In the reply shown in <xref target="i2nsf-reg-example2-reply" />,
      the additional NSF called web_filter can be used by accessing
      the NSF with the IPv4 address of 192.0.2.13 and the port number
      of 49152, using the NETCONF management protocol. The credentials
      to access the NETCONF are "alice" as the username and "password123"
      for the password.
    </t>    
    
  </section>
  
  <section anchor="section:nsf-lifecycle-management" title="NSF Lifecycle Management in NFV Environments">
    <t>
      Network Functions Virtualization (NFV) can be used to implement 
      I2NSF framework. In NFV environments, NSFs are deployed as 
      virtual network functions (VNFs). Security Controller can be 
      implemented as an Element Management (EM) of the NFV 
      architecture, and is connected with the VNF Manager (VNFM) via 
      the Ve-Vnfm interface <xref target="nfv-framework"/>. Security
      Controller can use this interface for the purpose of the 
      lifecycle management of NSFs. If some NSFs need to be 
      instantiated to enforce security policies in the I2NSF 
      framework, Security Controller could request the VNFM to 
      instantiate them through the Ve-Vnfm interface. Or if an NSF, 
      running as a VNF, is not used by any traffic flows for a time
      period, Security Controller MAY request deinstantiating it 
      through the interface for efficient resource utilization.
    </t>
  </section>

  <section anchor="section:Acknowledgments" title="Acknowledgments">
    <t>
      This document is a product by the I2NSF Working Group (WG) including
      WG Chairs (i.e., Linda Dunbar and Yoav Nir) and Diego Lopez.
      This document took advantage of the review and comments from the following people: 
      Roman Danyliw, Reshad Rahman (YANG doctor), and Tom Petch. 
      We authors sincerely appreciate their sincere efforts and kind help.
    </t>
    <t>
      This work was supported by Institute of Information &amp;
      Communications Technology Planning &amp; Evaluation (IITP) grant funded by
      the Korea MSIT (Ministry of Science and ICT) (No. 2016-0-00078, Cloud Based
      Security Intelligence Technology Development for the Customized
      Security Service Provisioning).
      This work was supported in part by the IITP (2020-0-00395-003, Standard
      Development of Blockchain based Network Management Automation Technology).
    </t>
  </section>

  <section anchor="section:Contributors" title="Contributors">
    <t> The following are co-authors of this document: </t>
    <t>
	  Patrick Lingga - 
	  <vspace blankLines="0"/>
	  Department of Electrical and Computer Engineering,
      <vspace blankLines="0"/>
	  Sungkyunkwan University,
	  <vspace blankLines="0"/>	
	  2066 Seo-ro Jangan-gu,
	  <vspace blankLines="0"/>
	  Suwon, Gyeonggi-do 16419,
	  <vspace blankLines="0"/>
	  Republic of Korea.
	  <vspace blankLines="1"/>
	  EMail: patricklink@skku.edu
	  <vspace blankLines="1"/>
	</t>
    <t>
      Jinyong (Tim) Kim - 
      <vspace blankLines="0"/>
      Department of Electronic, Electrical and Computer Engineering,
      <vspace blankLines="0"/>
      Sungkyunkwan University,
      <vspace blankLines="0"/>  
      2066 Seo-ro Jangan-gu,
      <vspace blankLines="0"/>
      Suwon, Gyeonggi-do 16419,
      <vspace blankLines="0"/>
      Republic of Korea.
      <vspace blankLines="1"/>
      EMail: timkim@skku.edu
      <vspace blankLines="1"/>
    </t>
    <t>
      Chaehong Chung - 
      <vspace blankLines="0"/>
      Department of Electronic, Electrical and Computer Engineering,
      <vspace blankLines="0"/>
      Sungkyunkwan University,
      <vspace blankLines="0"/>  
      2066 Seo-ro Jangan-gu,
      <vspace blankLines="0"/>
      Suwon, Gyeonggi-do 16419,
      <vspace blankLines="0"/>
      Republic of Korea.
      <vspace blankLines="1"/>
      EMail: darkhong@skku.edu
      <vspace blankLines="1"/>
    </t>
    <t>
      Susan Hares - 
      <vspace blankLines="0"/>
      Huawei,
      <vspace blankLines="0"/>
      7453 Hickory Hill,
      <vspace blankLines="0"/>
      Saline, MI 48176,
      <vspace blankLines="0"/>
      USA.
      <vspace blankLines="1"/>
      EMail: shares@ndzh.com
      <vspace blankLines="1"/>
    </t>
    <t>
      Diego R. Lopez - 
      <vspace blankLines="0"/>
      Telefonica I+D,
      <vspace blankLines="0"/>
      Jose Manuel Lara, 9,
      <vspace blankLines="0"/>
      Seville, 41013,
      <vspace blankLines="0"/>
      Spain.
      <vspace blankLines="1"/>
      EMail: diego.r.lopez@telefonica.com
      <vspace blankLines="1"/>
    </t>
  </section>

<!-- START: Changes from the previous version -->
  <section anchor="section:Changes" title="Changes from draft-ietf-i2nsf-registration-interface-dm-21">
    <t>
    The following changes are made from draft-ietf-i2nsf-registration-interface-dm-21:
      <list style="symbols">
        <t>
        The updates are made with the comments from AD Roman Danyliw.
        </t>
      </list>
    </t>
  </section> 
<!-- END: Changes from the previous version -->

</back>

<!-- <vspace blankLines="100"/> -->
<!-- page break to put addresses onto one page-->

</rfc>

