| I2NSF Working Group | S. Hyun |
| Internet-Draft | Chosun University |
| Intended status: Standards Track | J. Jeong |
| Expires: January 25, 2020 | T. Roh |
| S. Wi | |
| Sungkyunkwan University | |
| J. Park | |
| ETRI | |
| July 24, 2019 |
I2NSF Registration Interface YANG Data Model
draft-ietf-i2nsf-registration-interface-dm-05
This document defines an information model and a YANG data model for 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 into the Security Controller. The objective of these information and data models is to support NSF capability registration and query via I2NSF Registration Interface.
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."
This Internet-Draft will expire on January 25, 2020.
Copyright (c) 2019 IETF Trust and the persons identified as the document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
A number of Network Security Functions (NSF) may exist in the Interface to Network Security Functions (I2NSF) framework [RFC8329]. Since each of these NSFs likely has different security capabilities from each other, it is important to register the security capabilities of the NSF into the security controller. 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.
This document describes an information model (see Section 5) and a YANG [RFC7950] data model (see Section 6) for the I2NSF Registration Interface [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.
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 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.
This document uses the following terms defined in [i2nsf-terminology], [capability-dm], [RFC8329], [supa-policy-data-model], and [supa-policy-info-model]
The I2NSF registration interface is used by Security Controller and Developer's Management System (DMS) in I2NSF framework. The following summarizes the operations done through the registration interface:
Figure 1 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 explanations of each submodel.
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| I2NSF Registration Interface Information Model |
| |
| +-+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+-+ |
| | NSF Capability | | NSF Capability | |
| | Registration | | Query | |
| +-+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+-+ |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Figure 1: I2NSF Registration Interface Information Model
This submodel is used by DMS to register an NSF to Security Controller. Figure 2 shows how this submodel is constructed. The most important part in Figure 2 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. When registering the NSF, DMS additionally includes the network access information of the NSF which is required to enable network communications with the NSF.
The following will further explain the NSF capability information and the NSF access information in more detail.
+-+-+-+-+-+-+-+-+-+
| NSF Capability |
| Registration |
+-+-+-+-^-+-+-+-+-+
|
+---------------------+--------------------+
| | |
| | |
+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+
| NSF | | NSF Capability| | NSF Access |
| Name | | Information | | Information |
+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+
Figure 2: NSF Capability Registration Sub-Model
NSF Capability Information basically describes the security capabilities of an NSF. In Figure 3, we show capability objects of an NSF. Following the information model of NSF capabilities defiend in [capability-dm], we share the same I2NSF security capabilities: Time Capabilities, Event Capabilities, Condition Capabilities, Action Capabilities, Resolution Strategy Capabilities, Default Action Capabilities, and IPsec Method [i2nsf-ipsec]. Also, NSF Capability Information additionally contains the performance capabilities of an NSF as shown in Figure 3.
+-+-+-+-+-+-+-+-+-+
| NSF Capability |
| Information |
+-+-+-+-^-+-+-+-+-+
|
|
+----------------------+----------------------+
| |
| |
+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+
| I2NSF | | Performance |
| Capabilities | | Capabilities |
+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+
|
+--+-----------------+------------------+-----------------+-------+
| | | | |
+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+ |
| Time | | Event | | Condition | | Action | |
| Capabilities| | Capabilities| | Capabilities| | Capabilities| |
+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+ |
|
+----------------------+--------------------+-------+
| | |
+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+ +-+-+-+-+-+-+
| Resolution | | Default | | IPsec |
| Strategy | | Action | | Method |
| Capabilities| | Capabilities| +-+-+-+-+-+-+
+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+
Figure 3: NSF Capability Information
This information represents the processing capability of an NSF. This information can be used to determine whether the NSF is in congestion by comparing this with the workload that the NSF currently undergoes. Moreover, this information can specify an available amount of each type of resources such as processing power which are available on the NSF. (The registration interface can control the usages and limitations of the created instance and make the appropriate request according to the status.) As illustrated in Figure 4, this information consists of two items: Processing and Bandwidth. Processing information describes the NSF's available processing power. Bandwidth describes the information about available network amount in two cases, outbound, inbound. This two information can be used for the NSF's instance request.
+-+-+-+-+-+-+-+-+-+
| Performance |
| Capabilities |
+-+-+-+-^-+-+-+-+-+
|
+----------------------------+
| |
| |
+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+
| Processing | | Bandwidth |
+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+
Figure 4: Performance Capability Overview
NSF Access Information contains the followings that are required to communicate with an NSF: IPv4 address, IPv6 address, port number, and supported transport protocol(s) (e.g., Virtual Extensible LAN (VXLAN) [RFC 7348], Generic Protocol Extension for VXLAN (VXLAN-GPE) [nvo3-vxlan-gpe], Generic Route Encapsulation (GRE), Ethernet etc.). In this document, NSF Access Information is used to identify a specific NSF instance (i.e. NSF Access Information is the signature(unique identifier) of an NSF instance in the overall system).
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 sub-model in Section 5.1.1, and sends DMS a query about which NSF(s) can provide these capabilities.
This section provides the YANG Tree diagram of the I2NSF registration interface.
A simplified graphical representation of the data model is used in this section. The meaning of the symbols used in the following diagrams [RFC8431] is as follows:
module : ietf-i2nsf-reg-interface
+--rw nsf-capability-registration
| uses i2nsf-nsf-registrations
rpcs :
+---x nsf-capability-query
| uses i2nsf-nsf-capability-query
Figure 5: YANG Tree of I2NSF Registration Interface
The I2NSF registration interface is used for the following purposes. Developer's Management System (DMS) registers NSFs and their capabilities into Security Controller via the registration interface. In case that 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.
This section expands the i2nsf-nsf-registrations in Figure 5.
NSF Capability Registration
+--rw i2nsf-nsf-registrations
+--rw i2nsf-nsf-capability-registration* [nsf-name]
+--rw nsf-name string
+--rw nsf-capability-info
| uses i2nsf-nsf-capability-info
+--rw i2nsf-capability
| uses ietf-i2nsf-capability
+--rw nsf-performance-capability
| uses i2nsf-nsf-performance-capability
+--rw nsf-access-info
| uses i2nsf-nsf-access-info
+--rw nsf-instance-name
+--rw i2nsf-nsf-address nsf-address
+--rw nsf-port-number
Figure 6: YANG Tree of NSF Capability Registration
When registering an NSF to Security Controller, DMS uses this module to describe what capabilities the NSF can offer. DMS includes the network access information of the NSF which is required to make a network connection with the NSF as well as the capability description of the NSF.
This section expands the i2nsf-nsf-capability-query in Figure 5.
NSF Capability Query
+---x i2nsf-nsf-capability-query
+---w input
| +---w query-i2nsf-capability-info
| | uses ietf-i2nsf-capability
+--ro output
+--ro nsf-access-info
| uses i2nsf-nsf-access-info
+--rw nsf-instance-name
+--rw i2nsf-nsf-address nsf-address
+--rw nsf-port-number
Figure 7: YANG Tree of NSF Capability Query
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 Figure 7, the ietf-i2nsf-capability refers to the module defined in [capability-dm].
This section expands the i2nsf-nsf-capability-info in Figure 6 and Figure 7.
NSF Capability Information
+--rw i2nsf-nsf-capability-info
+--rw i2nsf-capability
| uses ietf-i2nsf-capability
+--rw nsf-performance-capability
| uses i2nsf-nsf-performance-capability
Figure 8: YANG Tree of I2NSF NSF Capability Information
In Figure 8, the ietf-i2nsf-capability refers to the module defined in [capability-dm]. The i2nsf-nsf-performance-capability is used to specify the performance capability of an NSF.
This section expands the i2nsf-nsf-performance-capability in Figure 8.
NSF Performance Capability
+--rw i2nsf-nsf-performance-capability
+--rw processing
| +--rw processing-average uint16
| +--rw processing-peak uint16
+--rw bandwidth
| +--rw outbound
| | +--rw outbound-average uint16
| | +--rw outbound-peak uint16
| +--rw inbound
| | +--rw inbound-average uint16
| | +--rw inbound-peak uint16
Figure 9: YANG Tree of I2NSF NSF Performance Capability
This module is used to specify the performance capabilities of an NSF when registering or initiating the NSF.
This section expands the i2nsf-nsf-access-info in Figure 6.
NSF Access Information
+--rw i2nsf-nsf-access-info
+--rw nsf-instance-name string
+--rw i2nsf-nsf-address nsf-address
+--rw nsf-port-number inet:port-number
Figure 10: YANG Tree of I2NSF NSF Access Informantion
This module contains the network access information of an NSF that is required to enable network communications with the NSF.
This section provides YANG modules of the data model for the registration interface between Security Controller and Developer's Management System, as defined in Section 5.
<CODE BEGINS> file "ietf-i2nsf-reg-interface@2019-07-24.yang"
module ietf-i2nsf-reg-interface {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-i2nsf-reg-interface";
prefix nsfreg;
import ietf-inet-types {
prefix inet;
reference "RFC 6991";
}
import ietf-i2nsf-capability {
prefix capa;
reference "draft-ietf-i2nsf-capability-data-model-05";
}
organization
"IETF I2NSF (Interface to Network Security
Functions) Working Group";
contact
"WG Web: <http://tools.ietf.org/wg/i2nsf>
WG List: <mailto:i2nsf@ietf.org>
WG Chair: Linda Dunbar
<mailto:Linda.duhbar@huawei.com>
Editor: Sangwon Hyun
<mailto:shyun@chosun.ac.kr>
Editor: Jaehoon Paul Jeong
<mailto:pauljeong@skku.edu>
Editor: Taekyun Roh
<mailto:tkroh0198@skku.edu>
Editor: Sarang Wi
<mailto:dnl9795@skku.edu>
Editor: Jung-Soo Park
<mailto:pjs@etri.re.kr>";
description
"This module defines a YANG data model for
I2NSF registration interface.
Copyright (c) <2019> IETF Trust and the persons
identified as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of
draft-ietf-i2nsf-registration-interface-dm-05; see
the draft itself for full legal notices.";
revision 2019-07-24 {
description "The fifth revision";
reference
"draft-ietf-i2nsf-registration-interface-dm-05";
}
typedef nsf-address {
type union {
type inet:ipv4-address;
type inet:ipv6-address;
}
description
"IPv4/IPv6 address of this NSF";
}
rpc i2nsf-nsf-capability-query {
description
"Description of the capabilities that the
Security Controller requests to the DMS";
input {
container query-i2nsf-capability-info {
description
"Description of the capabilities to request";
uses "capa:nsf-capabilities";
reference
"draft-ietf-i2nsf-capability-data-model-05";
}
}
output {
container nsf-access-info {
description
"Network access information of an NSF
with the requested capabilities";
uses i2nsf-nsf-access-info;
}
}
}
container i2nsf-nsf-registrations {
description
"Information of an NSF that DMS registers
to Security Controller";
list i2nsf-nsf-capability-registration {
key "nsf-name";
description
"Required information for registration";
leaf nsf-name {
type string;
mandatory true;
description
"Unique name of this registered NSF";
}
container nsf-capability-info {
description
"Capability description of this NSF";
uses i2nsf-nsf-capability-info;
}
container nsf-access-info {
description
"Network access information of this NSF";
uses i2nsf-nsf-access-info;
}
}
}
grouping i2nsf-nsf-performance-capability {
description
"Description of the performance capailities
of an NSF";
container processing {
description
"Processing power of an NSF in the unit of GHz (gigahertz)";
leaf processing-average {
type uint16;
description
"Average processing power";
}
leaf processing-peak {
type uint16;
description
"Peak processing power";
}
}
container bandwidth {
description
"Network bandwidth available on an NSF
in the unit of Gbps (gigabits per second)";
container outbound {
description
"Outbound network bandwidth";
leaf outbound-average {
type uint16;
description
"Average outbound bandwidth";
}
leaf outbound-peak {
type uint16;
description
"Peak outbound bandwidth";
}
}
container inbound {
description
"Inbound network bandwidth";
leaf inbound-average {
type uint16;
description
"Average inbound bandwidth";
}
leaf inbound-peak {
type uint16;
description
"Peak inbound bandwidth";
}
}
}
}
grouping i2nsf-nsf-capability-info {
description
"Capability description of an NSF";
container i2nsf-capability {
description
"Description of the security capabilities of an NSF";
uses "capa:nsf-capabilities";
reference "draft-ietf-i2nsf-capability-data-model-05";
}
container nsf-performance-capability {
description
"Description of the performance capabilities of an NSF";
uses i2nsf-nsf-performance-capability;
}
}
grouping i2nsf-nsf-access-info {
description
"Information required to access an NSF";
leaf nsf-instance-name {
type string;
description
"Unique name of this NSF instance";
}
leaf i2nsf-nsf-address {
type nsf-address;
description
"IPv4/IPv6 address of this NSF";
}
leaf nsf-port {
type inet:port-number;
description
"Port available on this NSF";
}
}
}
<CODE ENDS>
Figure 11: Registration Interface YANG Data Model
URI: urn:ietf:params:xml:ns:yang:ietf-i2nsf-reg-interface
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.
Name: ietf-i2nsf-reg-interface
Namespace: urn:ietf:params:xml:ns:yang:ietf-i2nsf-reg-interface
Prefix: nsfreg
Reference: RFC XXXX
This document requests IANA to register the following URI in the "IETF XML Registry" [RFC3688]: [RFC7950].
The YANG module specified in this document defines a data schema designed to be accessed through network management protocols such as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer is the secure transport layer, and the required secure transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer is HTTPS, and the required secure transport is TLS [RFC8446].
The NETCONF access control model [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.
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:
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:
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:
| [RFC2119] | Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997. |
| [RFC3688] | Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004. |
| [RFC6087] | Bierman, A., "Guidelines for Authors and Reviewers of YANG Data Model Documents", RFC 6087, DOI 10.17487/RFC6087, January 2011. |
| [RFC6241] | Enns, R., Bjorklund, M., Schoenwaelder, J. and A. Bierman, "Network Configuration Protocol (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011. |
| [RFC6242] | Wasserman, M., "Using the NETCONF Protocol over Secure Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011. |
| [RFC6991] | Schoenwaelder, J., "Common YANG Data Types", RFC 6991, DOI 10.17487/RFC6991, July 2013. |
| [RFC7950] | Bjorklund, M., "The YANG 1.1 Data Modeling Language", RFC 7950, DOI 10.17487/RFC7950, August 2016. |
| [RFC8040] | Bierman, A., Bjorklund, M. and K. Watsen, "RESTCONF Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017. |
| [RFC8174] | Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017. |
| [RFC8329] | Lopez, D., Lopez, E., Dunbar, L., Strassner, J. and R. Kumar, "Framework for Interface to Network Security Functions", RFC 8329, DOI 10.17487/RFC8329, February 2018. |
| [RFC8340] | Bjorklund, M. and L. Berger, "YANG Tree Diagrams", BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018. |
| [RFC8341] | Bierman, A. and M. Bjorklund, "Network Configuration Access Control Model", STD 91, RFC 8341, DOI 10.17487/RFC8341, March 2018. |
| [RFC8407] | Bierman, A., "Guidelines for Authors and Reviewers of Documents Containing YANG Data Models", BCP 216, RFC 8407, DOI 10.17487/RFC8407, October 2018. |
| [RFC8446] | Rescorla, E., "The Transport Layer Security (TLS) Protocol Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018. |
This section describes XML examples of the I2NSF Registration Interface data model under the assumption of registering several types of NSFs and querying NSF capability.
This section shows an XML example for registering the capabilities of general firewall.
<i2nsf-nsf-registrations
xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-reg-interface"
xmlns:capa="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<i2nsf-nsf-capability-registration>
<nsf-name>general_firewall_capability</nsf-name>
<nsf-capability-info>
<i2nsf-capability>
<condition-capabilities>
<generic-nsf-capabilities>
<ipv4-capa>capa:ipv4-protocol</ipv4-capa>
<ipv4-capa>capa:exact-ipv4-address</ipv4-capa>
<ipv4-capa>capa:range-ipv4-address</ipv4-capa>
<tcp-capa>capa:exact-tcp-port-num</tcp-capa>
<tcp-capa>capa:range-tcp-port-num</tcp-capa>
</generic-nsf-capabilities>
</condition-capabilities>
<action-capabilities>
<ingress-action-capa>capa:pass</ingress-action-capa>
<ingress-action-capa>capa:drop</ingress-action-capa>
<ingress-action-capa>capa:alert</ingress-action-capa>
<egress-action-capa>capa:pass</egress-action-capa>
<egress-action-capa>capa:drop</egress-action-capa>
<egress-action-capa>capa:alert</egress-action-capa>
</action-capabilities>
<ipsec-method>capa:ikeless</ipsec-method>
</i2nsf-capability>
<nsf-performance-capability>
<processing>
<processing-average>1000</processing-average>
<processing-peak>5000</processing-peak>
</processing>
<bandwidth>
<outbound>
<outbound-average>1000</outbound-average>
<outbound-peak>5000</outbound-peak>
</outbound>
<inbound>
<inbound-average>1000</inbound-average>
<inbound-peak>5000</inbound-peak>
</inbound>
</bandwidth>
</nsf-performance-capability>
</nsf-capability-info>
<nsf-access-info>
<nsf-instance-name>general_firewall</nsf-instance-name>
<i2nsf-nsf-address>2001:DB8:8:4::2</i2nsf-nsf-address>
<nsf-port-address>3000</nsf-port-address>
</nsf-access-info>
</i2nsf-nsf-capability-registration>
</i2nsf-nsf-registrations>
Figure 12: Configuration XML for Registration of General Firewall
Figure 12 shows the configuration XML for registering the general firewall and its capabilities as follows.
This section shows an XML example for registering the capabilities of time-based firewall.
<i2nsf-nsf-registrations
xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-reg-interface"
xmlns:capa="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<i2nsf-nsf-capability-registration>
<nsf-name>time_based_firewall_capability</nsf-name>
<nsf-capability-info>
<i2nsf-capability>
<time-capabilities>absolute-time</time-capabilities>
<time-capabilities>periodic-time</time-capabilities>
<condition-capabilities>
<generic-nsf-capabilities>
<ipv4-capa>capa:ipv4-protocol</ipv4-capa>
<ipv4-capa>capa:exact-ipv4-address</ipv4-capa>
<ipv4-capa>capa:range-ipv4-address</ipv4-capa>
</generic-nsf-capabilities>
</condition-capabilities>
<action-capabilities>
<ingress-action-capa>capa:pass</ingress-action-capa>
<ingress-action-capa>capa:drop</ingress-action-capa>
<ingress-action-capa>capa:alert</ingress-action-capa>
<egress-action-capa>capa:pass</egress-action-capa>
<egress-action-capa>capa:drop</egress-action-capa>
<egress-action-capa>capa:alert</egress-action-capa>
</action-capabilities>
<ipsec-method>capa:ike</ipsec-method>
</i2nsf-capability>
<nsf-performance-capability>
<processing>
<processing-average>1000</processing-average>
<processing-peak>5000</processing-peak>
</processing>
<bandwidth>
<outbound>
<outbound-average>1000</outbound-average>
<outbound-peak>5000</outbound-peak>
</outbound>
<inbound>
<inbound-average>1000</inbound-average>
<inbound-peak>5000</inbound-peak>
</inbound>
</bandwidth>
</nsf-performance-capability>
</nsf-capability-info>
<nsf-access-info>
<nsf-instance-name>time_based_firewall</nsf-instance-name>
<i2nsf-nsf-address>2001:DB8:8:4::3</i2nsf-nsf-address>
<nsf-port-address>3000</nsf-port-address>
</nsf-access-info>
</i2nsf-nsf-capability-registration>
</i2nsf-nsf-registrations>
Figure 13: Configuration XML for Registration of Time based Firewall
Figure 13 shows the configuration XML for registering the time-based firewall and its capabilities as follows.
This section shows an XML example for registering the capabilities of web filter.
<i2nsf-nsf-registrations
xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-reg-interface"
xmlns:capa="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<i2nsf-nsf-capability-registration>
<nsf-name>web_filter_capability</nsf-name>
<nsf-capability-info>
<i2nsf-capability>
<condition-capabilities>
<advanced-nsf-capabilities>
<url-capa>capa:user-defined</url-capa>
</advanced-nsf-capabilities>
</condition-capabilities>
<action-capabilities>
<ingress-action-capa>capa:pass</ingress-action-capa>
<ingress-action-capa>capa:drop</ingress-action-capa>
<ingress-action-capa>capa:alert</ingress-action-capa>
<egress-action-capa>capa:pass</egress-action-capa>
<egress-action-capa>capa:drop</egress-action-capa>
<egress-action-capa>capa:alert</egress-action-capa>
</action-capabilities>
<ipsec-method>capa:ikeless</ipsec-method>
</i2nsf-capability>
<nsf-performance-capability>
<processing>
<processing-average>1000</processing-average>
<processing-peak>5000</processing-peak>
</processing>
<bandwidth>
<outbound>
<outbound-average>1000</outbound-average>
<outbound-peak>5000</outbound-peak>
</outbound>
<inbound>
<inbound-average>1000</inbound-average>
<inbound-peak>5000</inbound-peak>
</inbound>
</bandwidth>
</nsf-performance-capability>
</nsf-capability-info>
<nsf-access-info>
<nsf-instance-name>web_filter</nsf-instance-name>
<i2nsf-nsf-address>2001:DB8:8:4::4</i2nsf-nsf-address>
<nsf-port-address>3000</nsf-port-address>
</nsf-access-info>
</i2nsf-nsf-capability-registration>
</i2nsf-nsf-registrations>
Figure 14: Configuration XML for Registration of Web Filter
Figure 14 shows the configuration XML for registering the web filter, and its capabilities are as follows.
This section shows an XML example for registering the capabilities of VoIP/VoLTE filter.
<i2nsf-nsf-registrations
xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-reg-interface"
xmlns:capa="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<i2nsf-nsf-capability-registration>
<nsf-name>voip_volte_filter_capability</nsf-name>
<nsf-capability-info>
<i2nsf-capability>
<condition-capabilities>
<advanced-nsf-capabilities>
<voip-volte-capa>capa:voice-id</voip-volte-capa>
</advanced-nsf-capabilities>
</condition-capabilities>
<action-capabilities>
<ingress-action-capa>capa:pass</ingress-action-capa>
<ingress-action-capa>capa:drop</ingress-action-capa>
<ingress-action-capa>capa:alert</ingress-action-capa>
<egress-action-capa>capa:pass</egress-action-capa>
<egress-action-capa>capa:drop</egress-action-capa>
<egress-action-capa>capa:alert</egress-action-capa>
</action-capabilities>
<ipsec-method>capa:ikeless</ipsec-method>
</i2nsf-capability>
<nsf-performance-capability>
<processing>
<processing-average>1000</processing-average>
<processing-peak>5000</processing-peak>
</processing>
<bandwidth>
<outbound>
<outbound-average>1000</outbound-average>
<outbound-peak>5000</outbound-peak>
</outbound>
<inbound>
<inbound-average>1000</inbound-average>
<inbound-peak>5000</inbound-peak>
</inbound>
</bandwidth>
</nsf-performance-capability>
</nsf-capability-info>
<nsf-access-info>
<nsf-instance-name>voip_volte_filter</nsf-instance-name>
<i2nsf-nsf-address>2001:DB8:8:4::5</i2nsf-nsf-address>
<nsf-port-address>3000</nsf-port-address>
</nsf-access-info>
</i2nsf-nsf-capability-registration>
</i2nsf-nsf-registrations>
Figure 15: Configuration XML for Registration of VoIP/VoLTE Filter
Figure 15 shows the configuration XML for registering VoIP/VoLTE filter, and its capabilities are as follows.
This section shows an XML example for registering the capabilities of http and https flood mitigation.
<i2nsf-nsf-registrations
xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-reg-interface"
xmlns:capa="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<i2nsf-nsf-capability-registration>
<nsf-name>
http_and_h ttps_flood_mitigation_capability
</nsf-name>
<nsf-capability-info>
<i2nsf-capability>
<condition-capabilities>
<advanced-nsf-capabilities>
<antiddos-capa>capa:http-flood-action</antiddos-capa>
<antiddos-capa>capa:https-flood-action</antiddos-capa>
</advanced-nsf-capabilities>
</condition-capabilities>
<action-capabilities>
<ingress-action-capa>capa:pass</ingress-action-capa>
<ingress-action-capa>capa:drop</ingress-action-capa>
<ingress-action-capa>capa:alert</ingress-action-capa>
<egress-action-capa>capa:pass</egress-action-capa>
<egress-action-capa>capa:drop</egress-action-capa>
<egress-action-capa>capa:alert</egress-action-capa>
</action-capabilities>
<ipsec-method>capa:ike</ipsec-method>
</i2nsf-capability>
<nsf-performance-capability>
<processing>
<processing-average>1000</processing-average>
<processing-peak>5000</processing-peak>
</processing>
<bandwidth>
<outbound>
<outbound-average>1000</outbound-average>
<outbound-peak>5000</outbound-peak>
</outbound>
<inbound>
<inbound-average>1000</inbound-average>
<inbound-peak>5000</inbound-peak>
</inbound>
</bandwidth>
</nsf-performance-capability>
</nsf-capability-info>
<nsf-access-info>
<nsf-instance-name>
http_and_https_flood_mitigation
</nsf-instance-name>
<i2nsf-nsf-address>2001:DB8:8:4::6</i2nsf-nsf-address>
<nsf-port-address>3000</nsf-port-address>
</nsf-access-info>
</i2nsf-nsf-capability-registration>
</i2nsf-nsf-registrations>
Figure 16: Configuration XML for Registration of of HTTP and HTTPS Flood Mitigation
Figure 16 shows the configuration XML for registering the http and https flood mitigator, and its capabilities are as follows.
This section shows an XML example for querying the capabilities of time-based firewall.
<rpc message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<i2nsf-nsf-capability-query
xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-reg-interface"
xmlns:capa="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<query-i2nsf-capability-info>
<time-capabilities>absolute-time</time-capabilities>
<time-capabilities>periodic-time</time-capabilities>
<condition-capabilities>
<generic-nsf-capabilities>
<ipv4-capa>capa:ipv4-protocol</ipv4-capa>
<ipv4-capa>capa:exact-ipv4-address</ipv4-capa>
<ipv4-capa>capa:range-ipv4-address</ipv4-capa>
</generic-nsf-capabilities>
</condition-capabilities>
<action-capabilities>
<ingress-action-capa>capa:pass</ingress-action-capa>
<ingress-action-capa>capa:drop</ingress-action-capa>
<ingress-action-capa>capa:alert</ingress-action-capa>
<egress-action-capa>capa:pass</egress-action-capa>
<egress-action-capa>capa:drop</egress-action-capa>
<egress-action-capa>capa:alert</egress-action-capa>
</action-capabilities>
<ipsec-method>capa:ikeless</ipsec-method>
</query-i2nsf-capability-info>
</i2nsf-nsf-capability-query>
</rpc>
<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-reg-interface">
<nsf-instance-name>time-based-firewall</nsf-instance-name>
<i2nsf-nsf-address>2001:DB8:8:4::7</i2nsf-nsf-address>
<nsf-port-address>8080</nsf-port-address>
</nsf-access-info>
</rpc-reply>
Figure 17: Configuration XML for Query of Time-based Firewall
Figure 17 shows the XML configuration for querying the capabilities of the time-based firewall.
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 [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.
The following changes have been made from draft-ietf-i2nsf-registration-interface-dm-04:
This work was supported by Institute of Information & Communications Technology Planning & Evaluation (IITP) grant funded by the Korea MSIT (Ministry of Science and ICT) (R-20160222-002755, Cloud based Security Intelligence Technology Development for the Customized Security Service Provisioning).
This document is made by the group effort of I2NSF working group. Many people actively contributed to this document. The following are considered co-authors: