| I2NSF Working Group | S. Hyun, Ed. |
| Internet-Draft | Myongji University |
| Intended status: Standards Track | J. Jeong, Ed. |
| Expires: March 2, 2021 | T. Roh |
| S. Wi | |
| Sungkyunkwan University | |
| J. Park | |
| ETRI | |
| August 29, 2020 |
I2NSF Registration Interface YANG Data Model
draft-ietf-i2nsf-registration-interface-dm-09
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 with 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 March 2, 2021.
Copyright (c) 2020 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 with 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] when, and only when, they appear in all capitals, as shown here.
This document uses the following terms defined in [RFC8329] and [I-D.ietf-i2nsf-capability-data-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 with 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 defined in [I-D.ietf-i2nsf-capability-data-model], we share the same I2NSF security capabilities: Time Capabilities, Event Capabilities, Condition Capabilities, Action Capabilities, Resolution Strategy Capabilities, Default Action Capabilities, and IPsec Method [I-D.ietf-i2nsf-sdn-ipsec-flow-protection]. 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. Assuming that the current workload status of each NSF is being collected through NSF monitoring [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 by comparing it with the current workload of the NSF. Moreover, this information can specify an available amount of each type of resource, 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. These 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) [RFC7348], Generic Protocol Extension for VXLAN (VXLAN-GPE) [I-D.ietf-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 nsf-registrations
rpcs :
+---x i2nsf-capability-query
| uses 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 nsf-registrations
+--rw nsf-information* [capability-name]
+--rw capability-name string
+--rw nsf-capability-info
| uses nsf-capability-info
+--rw security-capability
| uses ietf-i2nsf-capability
+--rw performance-capability
| uses performance-capability
+--rw nsf-access-info
| uses nsf-access-info
+--rw capability-name
+--rw ip
+--rw port
Figure 6: YANG Tree of NSF Capability Registration Module
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 nsf-capability-query in Figure 5.
I2NSF Capability Query
+---x nsf-capability-query
+---w input
| +---w query-nsf-capability
| | uses ietf-i2nsf-capability
+--ro output
+--ro nsf-access-info
| uses nsf-access-info
+--rw capability-name
+--rw ip
+--rw port
Figure 7: YANG Tree of NSF Capability Query Module
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 [I-D.ietf-i2nsf-capability-data-model].
This section expands the nsf-capability-info in Figure 6 and Figure 7.
NSF Capability Information
+--rw nsf-capability-info
+--rw security-capability
| uses ietf-i2nsf-capability
+--rw performance-capability
| uses 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 [I-D.ietf-i2nsf-capability-data-model]. The performance-capability is used to specify the performance capability of an NSF.
This section expands the nsf-performance-capability in Figure 8.
NSF Performance Capability
+--rw 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 nsf-access-info in Figure 6.
NSF Access Information
+--rw nsf-access-info
+--rw capability-name string
+--rw ip inet:ip-address
+--rw port 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. The field of ip can have either an IPv4 address or an IPv6 address.
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 Section 5.
This YANG module imports from [RFC6991], and makes a reference to [I-D.ietf-i2nsf-capability-data-model].
<CODE BEGINS> file "ietf-i2nsf-reg-interface@2020-08-29.yang"
module ietf-i2nsf-reg-interface {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-i2nsf-reg-interface";
prefix nsfreg;
// RFC Ed.: replace occurences of XXXX with actual RFC number and
// remove this note
import ietf-inet-types {
prefix inet;
reference "RFC 6991";
}
import ietf-i2nsf-capability {
prefix cap;
// 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: <http://tools.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.
Copyright (c) 2020 IETF Trust and the persons
identified as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
// RFC Ed.: replace XXXX with actual RFC number and remove
// this note
revision "2020-08-29" {
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-performance-capability {
description
"Description of the performance capabilities of an NSF";
container processing {
description
"Processing power of an NSF in the unit of GHz (gigahertz)";
leaf processing-average {
type uint16;
units "GHz";
description
"Average processing power";
}
leaf processing-peak {
type uint16;
units "GHz";
description
"Peak processing power";
}
}
container bandwidth {
description
"Network bandwidth available on an NSF
in the unit of Mbps (megabits per second)";
container outbound {
description
"Outbound network bandwidth";
leaf outbound-average {
type uint32;
units "Mbps";
description
"Average outbound bandwidth";
}
leaf outbound-peak {
type uint32;
units "Mbps";
description
"Peak outbound bandwidth";
}
}
container inbound {
description
"Inbound network bandwidth";
leaf inbound-average {
type uint32;
units "Mbps";
description
"Average inbound bandwidth";
}
leaf inbound-peak {
type uint32;
units "Mbps";
description
"Peak inbound bandwidth";
}
}
}
}
grouping nsf-capability-info {
description
"Capability description of an NSF";
container security-capability {
description
"Description of the security capabilities of an NSF";
uses cap:nsf-capabilities;
// 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";
}
container performance-capability {
description
"Description of the performance capabilities of an NSF";
uses nsf-performance-capability;
}
}
grouping nsf-access-info {
description
"Information required to access an NSF";
leaf capability-name {
type string;
description
"Unique name of this NSF's capability";
}
leaf ip {
type inet:ip-address;
description
"Either an IPv4 address or an IPv6 address of this NSF";
}
leaf port {
type inet:port-number;
description
"Port available on this NSF";
}
}
container nsf-registrations {
description
"Information of an NSF that DMS registers
to Security Controller";
list nsf-information {
key "capability-name";
description
"Required information for registration";
leaf capability-name {
type string;
mandatory true;
description
"Unique name of this registered NSF";
}
container nsf-capability-info {
description
"Capability description of this NSF";
uses nsf-capability-info;
}
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 cap:nsf-capabilities;
// 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";
}
}
output {
container nsf-access-info {
description
"Network access information of an NSF
with the requested capabilities";
uses nsf-access-info;
}
}
}
}
<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 // RFC Ed.: replace XXXX with actual RFC number and remove // this note
This document requests IANA to register the following URI in the "IETF XML Registry" [RFC3688]: [RFC7950][RFC8525]:
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:
| [I-D.ietf-i2nsf-nsf-monitoring-data-model] | Jeong, J., Chung, C., Hares, S., Xia, L. and H. Birkholz, "I2NSF NSF Monitoring YANG Data Model", Internet-Draft draft-ietf-i2nsf-nsf-monitoring-data-model-03, May 2020. |
| [I-D.ietf-i2nsf-sdn-ipsec-flow-protection] | Lopez, R., Lopez-Millan, G. and F. Pereniguez-Garcia, "Software-Defined Networking (SDN)-based IPsec Flow Protection", Internet-Draft draft-ietf-i2nsf-sdn-ipsec-flow-protection-08, June 2020. |
| [I-D.ietf-nvo3-vxlan-gpe] | Maino, F., Kreeger, L. and U. Elzur, "Generic Protocol Extension for VXLAN (VXLAN-GPE)", Internet-Draft draft-ietf-nvo3-vxlan-gpe-10, July 2020. |
| [nfv-framework] | "Network Functions Virtualisation (NFV); Architectureal Framework", ETSI GS NFV 002 ETSI GS NFV 002 V1.1.1, October 2013. |
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 a general firewall in either IPv4 networks [RFC5737] or IPv6 networks [RFC3849].
<nsf-registrations
xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-reg-interface"
xmlns:cap="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<nsf-information>
<capability-name>general_firewall_capability</capability-name>
<nsf-capability-info>
<security-capability>
<condition-capabilities>
<generic-nsf-capabilities>
<ipv4-capability>cap:ipv4-protocol</ipv4-capability>
<ipv4-capability>cap:exact-ipv4-address</ipv4-capability>
<ipv4-capability>cap:range-ipv4-address</ipv4-capability>
<tcp-capability>cap:exact-tcp-port-num</tcp-capability>
<tcp-capability>cap:range-tcp-port-num</tcp-capability>
</generic-nsf-capabilities>
</condition-capabilities>
<action-capabilities>
<ingress-action-capability>cap:pass</ingress-action-capability>
<ingress-action-capability>cap:drop</ingress-action-capability>
<ingress-action-capability>cap:alert</ingress-action-capability>
<egress-action-capability>cap:pass</egress-action-capability>
<egress-action-capability>cap:drop</egress-action-capability>
<egress-action-capability>cap:alert</egress-action-capability>
</action-capabilities>
<ipsec-method>cap:ikeless</ipsec-method>
</security-capability>
<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>
</performance-capability>
</nsf-capability-info>
<nsf-access-info>
<capability-name>general_firewall</capability-name>
<ip>192.0.2.11</ip>
<port>3000</port>
</nsf-access-info>
</nsf-information>
</nsf-registrations>
Figure 12: Configuration XML for Registration of a General Firewall in an IPv4 Network
Figure 12 shows the configuration XML for registering a general firewall in an IPv4 network [RFC5737] and its capabilities as follows.
<nsf-registrations
xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-reg-interface"
xmlns:cap="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<nsf-information>
<capability-name>general_firewall_capability</capability-name>
<nsf-capability-info>
<security-capability>
<condition-capabilities>
<generic-nsf-capabilities>
<ipv6-capability>cap:ipv6-protocol</ipv6-capability>
<ipv6-capability>cap:exact-ipv6-address</ipv6-capability>
<ipv6-capability>cap:range-ipv6-address</ipv6-capability>
<tcp-capability>cap:exact-tcp-port-num</tcp-capability>
<tcp-capability>cap:range-tcp-port-num</tcp-capability>
</generic-nsf-capabilities>
</condition-capabilities>
<action-capabilities>
<ingress-action-capability>cap:pass</ingress-action-capability>
<ingress-action-capability>cap:drop</ingress-action-capability>
<ingress-action-capability>cap:alert</ingress-action-capability>
<egress-action-capability>cap:pass</egress-action-capability>
<egress-action-capability>cap:drop</egress-action-capability>
<egress-action-capability>cap:alert</egress-action-capability>
</action-capabilities>
<ipsec-method>cap:ikeless</ipsec-method>
</security-capability>
<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>
</performance-capability>
</nsf-capability-info>
<nsf-access-info>
<capability-name>general_firewall</capability-name>
<ip>2001:DB8:0:1::11</ip>
<port>3000</port>
</nsf-access-info>
</nsf-information>
</nsf-registrations>
Figure 13: Configuration XML for Registration of a General Firewall in an IPv6 Network
In addition, Figure 13 shows the configuration XML for registering a general firewall in an IPv6 network [RFC3849] and its capabilities as follows.
This section shows an XML example for registering the capabilities of a time-based firewall in either IPv4 networks [RFC5737] or IPv6 networks [RFC3849].
<nsf-registrations
xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-reg-interface"
xmlns:cap="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<nsf-information>
<capability-name>time_based_firewall_capability</capability-name>
<nsf-capability-info>
<security-capability>
<time-capabilities>absolute-time</time-capabilities>
<time-capabilities>periodic-time</time-capabilities>
<condition-capabilities>
<generic-nsf-capabilities>
<ipv4-capability>cap:ipv4-protocol</ipv4-capability>
<ipv4-capability>cap:exact-ipv4-address</ipv4-capability>
<ipv4-capability>cap:range-ipv4-address</ipv4-capability>
<tcp-capability>cap:exact-tcp-port-num</tcp-capability>
<tcp-capability>cap:range-tcp-port-num</tcp-capability>
</generic-nsf-capabilities>
</condition-capabilities>
<action-capabilities>
<ingress-action-capability>cap:pass</ingress-action-capability>
<ingress-action-capability>cap:drop</ingress-action-capability>
<ingress-action-capability>cap:alert</ingress-action-capability>
<egress-action-capability>cap:pass</egress-action-capability>
<egress-action-capability>cap:drop</egress-action-capability>
<egress-action-capability>cap:alert</egress-action-capability>
</action-capabilities>
<ipsec-method>cap:ike</ipsec-method>
</security-capability>
<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>
</performance-capability>
</nsf-capability-info>
<nsf-access-info>
<capability-name>time_based_firewall</capability-name>
<ip>192.0.2.11</ip>
<port>3000</port>
</nsf-access-info>
</nsf-information>
</nsf-registrations>
Figure 14: Configuration XML for Registration of a Time-based Firewall in an IPv4 Network
Figure 14 shows the configuration XML for registering a time-based firewall in an IPv4 network [RFC5737] and its capabilities as follows.
<nsf-registrations
xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-reg-interface"
xmlns:cap="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<nsf-information>
<capability-name>time_based_firewall_capability</capability-name>
<nsf-capability-info>
<security-capability>
<time-capabilities>absolute-time</time-capabilities>
<time-capabilities>periodic-time</time-capabilities>
<condition-capabilities>
<generic-nsf-capabilities>
<ipv6-capability>cap:ipv6-protocol</ipv6-capability>
<ipv6-capability>cap:exact-ipv6-address</ipv6-capability>
<ipv6-capability>cap:range-ipv6-address</ipv6-capability>
<tcp-capability>cap:exact-tcp-port-num</tcp-capability>
<tcp-capability>cap:range-tcp-port-num</tcp-capability>
</generic-nsf-capabilities>
</condition-capabilities>
<action-capabilities>
<ingress-action-capability>cap:pass</ingress-action-capability>
<ingress-action-capability>cap:drop</ingress-action-capability>
<ingress-action-capability>cap:alert</ingress-action-capability>
<egress-action-capability>cap:pass</egress-action-capability>
<egress-action-capability>cap:drop</egress-action-capability>
<egress-action-capability>cap:alert</egress-action-capability>
</action-capabilities>
<ipsec-method>cap:ike</ipsec-method>
</security-capability>
<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>
</performance-capability>
</nsf-capability-info>
<nsf-access-info>
<capability-name>time_based_firewall</capability-name>
<ip>2001:DB8:0:1::11</ip>
<port>3000</port>
</nsf-access-info>
</nsf-information>
</nsf-registrations>
Figure 15: Configuration XML for Registration of a Time-based Firewall in an IPv6 Network
In addition, Figure 15 shows the configuration XML for registering a time-based firewall in an IPv6 network [RFC3849] and its capabilities as follows.
This section shows an XML example for registering the capabilities of a web filter in either IPv4 networks [RFC5737] or IPv6 networks [RFC3849].
<nsf-registrations
xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-reg-interface"
xmlns:cap="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<nsf-information>
<capability-name>web_filter</capability-name>
<nsf-capability-info>
<security-capability>
<condition-capabilities>
<advanced-nsf-capabilities>
<url-capability>cap:user-defined</url-capability>
</advanced-nsf-capabilities>
</condition-capabilities>
<action-capabilities>
<ingress-action-capability>cap:pass</ingress-action-capability>
<ingress-action-capability>cap:drop</ingress-action-capability>
<ingress-action-capability>cap:alert</ingress-action-capability>
<egress-action-capability>cap:pass</egress-action-capability>
<egress-action-capability>cap:drop</egress-action-capability>
<egress-action-capability>cap:alert</egress-action-capability>
</action-capabilities>
<ipsec-method>cap:ikeless</ipsec-method>
</security-capability>
<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>
</performance-capability>
</nsf-capability-info>
<nsf-access-info>
<capability-name>web_filter</capability-name>
<ip>192.0.2.11</ip>
<port>3000</port>
</nsf-access-info>
</nsf-information>
</nsf-registrations>
Figure 16: Configuration XML for Registration of a Web Filter in an IPv4 Network
Figure 16 shows the configuration XML for registering a web filter in an IPv4 network [RFC5737] and its capabilities are as follows.
<nsf-registrations
xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-reg-interface"
xmlns:cap="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<nsf-information>
<capability-name>web_filter</capability-name>
<nsf-capability-info>
<security-capability>
<condition-capabilities>
<advanced-nsf-capabilities>
<url-capability>cap:user-defined</url-capability>
</advanced-nsf-capabilities>
</condition-capabilities>
<action-capabilities>
<ingress-action-capability>cap:pass</ingress-action-capability>
<ingress-action-capability>cap:drop</ingress-action-capability>
<ingress-action-capability>cap:alert</ingress-action-capability>
<egress-action-capability>cap:pass</egress-action-capability>
<egress-action-capability>cap:drop</egress-action-capability>
<egress-action-capability>cap:alert</egress-action-capability>
</action-capabilities>
<ipsec-method>cap:ikeless</ipsec-method>
</security-capability>
<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>
</performance-capability>
</nsf-capability-info>
<nsf-access-info>
<capability-name>web_filter</capability-name>
<ip>2001:DB8:0:1::11</ip>
<port>3000</port>
</nsf-access-info>
</nsf-information>
</nsf-registrations>
Figure 17: Configuration XML for Registration of a Web Filter in an IPv6 Network
In addition, Figure 17 shows the configuration XML for registering a web filter in an IPv6 network [RFC3849] and its capabilities are as follows.
This section shows an XML example for registering the capabilities of a VoIP/VoLTE filter in either IPv4 networks [RFC5737] or IPv6 networks [RFC3849].
<nsf-registrations
xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-reg-interface"
xmlns:cap="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<nsf-information>
<capability-name>voip_volte_filter</capability-name>
<nsf-capability-info>
<security-capability>
<condition-capabilities>
<advanced-nsf-capabilities>
<voip-volte-capability>cap:voice-id</voip-volte-capability>
</advanced-nsf-capabilities>
</condition-capabilities>
<action-capabilities>
<ingress-action-capability>cap:pass</ingress-action-capability>
<ingress-action-capability>cap:drop</ingress-action-capability>
<ingress-action-capability>cap:alert</ingress-action-capability>
<egress-action-capability>cap:pass</egress-action-capability>
<egress-action-capability>cap:drop</egress-action-capability>
<egress-action-capability>cap:alert</egress-action-capability>
</action-capabilities>
<ipsec-method>cap:ikeless</ipsec-method>
</security-capability>
<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>
</performance-capability>
</nsf-capability-info>
<nsf-access-info>
<capability-name>voip_volte_filter</capability-name>
<ip>192.0.2.11</ip>
<port>3000</port>
</nsf-access-info>
</nsf-information>
</nsf-registrations>
Figure 18: Configuration XML for Registration of a VoIP/VoLTE Filter in an IPv4 Network
Figure 18 shows the configuration XML for registering a VoIP/VoLTE filter in an IPv4 network [RFC5737] and its capabilities are as follows.
<nsf-registrations
xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-reg-interface"
xmlns:cap="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<nsf-information>
<capability-name>voip_volte_filter</capability-name>
<nsf-capability-info>
<security-capability>
<condition-capabilities>
<advanced-nsf-capabilities>
<voip-volte-capability>cap:voice-id</voip-volte-capability>
</advanced-nsf-capabilities>
</condition-capabilities>
<action-capabilities>
<ingress-action-capability>cap:pass</ingress-action-capability>
<ingress-action-capability>cap:drop</ingress-action-capability>
<ingress-action-capability>cap:alert</ingress-action-capability>
<egress-action-capability>cap:pass</egress-action-capability>
<egress-action-capability>cap:drop</egress-action-capability>
<egress-action-capability>cap:alert</egress-action-capability>
</action-capabilities>
<ipsec-method>cap:ikeless</ipsec-method>
</security-capability>
<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>
</performance-capability>
</nsf-capability-info>
<nsf-access-info>
<capability-name>voip_volte_filter</capability-name>
<ip>2001:DB8:0:1::11</ip>
<port>3000</port>
</nsf-access-info>
</nsf-information>
</nsf-registrations>
Figure 19: Configuration XML for Registration of a VoIP/VoLTE Filter in an IPv6 Network
Figure 19 shows the configuration XML for registering a VoIP/VoLTE filter in an IPv6 network [RFC3849] and its capabilities are as follows.
This section shows an XML example for registering the capabilities of an HTTP and HTTPS flood mitigator in either IPv4 networks [RFC5737] or IPv6 networks [RFC3849].
<nsf-registrations
xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-reg-interface"
xmlns:cap="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<nsf-information>
<capability-name>
http_and_https_flood_mitigator
</capability-name>
<nsf-capability-info>
<security-capability>
<condition-capabilities>
<advanced-nsf-capabilities>
<anti-ddos-capability>
cap:http-flood-action
</anti-ddos-capability>
<anti-ddos-capability>
cap:https-flood-action
</anti-ddos-capability>
</advanced-nsf-capabilities>
</condition-capabilities>
<action-capabilities>
<ingress-action-capability>cap:pass</ingress-action-capability>
<ingress-action-capability>cap:drop</ingress-action-capability>
<ingress-action-capability>cap:alert</ingress-action-capability>
<egress-action-capability>cap:pass</egress-action-capability>
<egress-action-capability>cap:drop</egress-action-capability>
<egress-action-capability>cap:alert</egress-action-capability>
</action-capabilities>
<ipsec-method>cap:ike</ipsec-method>
</security-capability>
<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>
</performance-capability>
</nsf-capability-info>
<nsf-access-info>
<capability-name>
http_and_https_flood_mitigation
</capability-name>
<ip>192.0.2.11</ip>
<port>3000</port>
</nsf-access-info>
</nsf-information>
</nsf-registrations>
Figure 20: Configuration XML for Registration of an HTTP and HTTPS Flood Mitigator in an IPv4 Network
Figure 20 shows the configuration XML for registering an HTTP and HTTPS flood mitigator in an IPv4 network [RFC5737] and its capabilities are as follows.
<nsf-registrations
xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-reg-interface"
xmlns:cap="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<nsf-information>
<capability-name>
http_and_https_flood_mitigator
</capability-name>
<nsf-capability-info>
<security-capability>
<condition-capabilities>
<advanced-nsf-capabilities>
<anti-ddos-capability>
cap:http-flood-action
</anti-ddos-capability>
<anti-ddos-capability>
cap:https-flood-action
</anti-ddos-capability>
</advanced-nsf-capabilities>
</condition-capabilities>
<action-capabilities>
<ingress-action-capability>cap:pass</ingress-action-capability>
<ingress-action-capability>cap:drop</ingress-action-capability>
<ingress-action-capability>cap:alert</ingress-action-capability>
<egress-action-capability>cap:pass</egress-action-capability>
<egress-action-capability>cap:drop</egress-action-capability>
<egress-action-capability>cap:alert</egress-action-capability>
</action-capabilities>
<ipsec-method>cap:ike</ipsec-method>
</security-capability>
<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>
</performance-capability>
</nsf-capability-info>
<nsf-access-info>
<capability-name>
http_and_https_flood_mitigation
</capability-name>
<ip>2001:DB8:0:1::11</ip>
<port>3000</port>
</nsf-access-info>
</nsf-information>
</nsf-registrations>
Figure 21: Configuration XML for Registration of an HTTP and HTTPS Flood Mitigator in an IPv6 Network
In addition, Figure 21 shows the configuration XML for registering an HTTP and HTTPS flood mitigator in an IPv6 network [RFC3849] and its capabilities are as follows.
This section shows an XML example for querying the capabilities of a time-based firewall in either IPv4 networks [RFC5737] or IPv6 networks [RFC3849].
<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-reg-interface"
xmlns:cap="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-capability>cap:ipv4-protocol</ipv4-capability>
<ipv4-capability>cap:exact-ipv4-address</ipv4-capability>
<ipv4-capability>cap:range-ipv4-address</ipv4-capability>
</generic-nsf-capabilities>
</condition-capabilities>
<action-capabilities>
<ingress-action-capability>cap:pass</ingress-action-capability>
<ingress-action-capability>cap:drop</ingress-action-capability>
<ingress-action-capability>cap:alert</ingress-action-capability>
<egress-action-capability>cap:pass</egress-action-capability>
<egress-action-capability>cap:drop</egress-action-capability>
<egress-action-capability>cap:alert</egress-action-capability>
</action-capabilities>
<ipsec-method>cap:ikeless</ipsec-method>
</query-i2nsf-capability-info>
</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">
<capability-name>time-based-firewall</capability-name>
<ip>192.0.2.11</ip>
<port>3000</port>
</nsf-access-info>
</rpc-reply>
Figure 22: Configuration XML for Query of a Time-based Firewall in an IPv4 Network
Figure 22 shows the XML configuration for querying the capabilities of a time-based firewall in an IPv4 network [RFC5737]. The access information of the announced time-based firewall has the IPv4 address of 192.0.2.11 and the port number of 3000.
<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-reg-interface"
xmlns:cap="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>
<ipv6-capability>cap:ipv6-protocol</ipv6-capability>
<ipv6-capability>cap:exact-ipv6-address</ipv6-capability>
<ipv6-capability>cap:range-ipv6-address</ipv6-capability>
</generic-nsf-capabilities>
</condition-capabilities>
<action-capabilities>
<ingress-action-capability>cap:pass</ingress-action-capability>
<ingress-action-capability>cap:drop</ingress-action-capability>
<ingress-action-capability>cap:alert</ingress-action-capability>
<egress-action-capability>cap:pass</egress-action-capability>
<egress-action-capability>cap:drop</egress-action-capability>
<egress-action-capability>cap:alert</egress-action-capability>
</action-capabilities>
<ipsec-method>cap:ikeless</ipsec-method>
</query-i2nsf-capability-info>
</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">
<capability-name>time-based-firewall</capability-name>
<ip>2001:DB8:0:1::11</ip>
<port>3000</port>
</nsf-access-info>
</rpc-reply>
Figure 23: Configuration XML for Query of a Time-based Firewall in an IPv6 Network
In addition, Figure 23 shows the XML configuration for querying the capabilities of a time-based firewall in an IPv6 network [RFC3849]. The access information of the announced time-based firewall has the IPv6 address of 2001:DB8:0:1::11 and the port number of 3000.
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.
This work was supported by Institute of Information & Communications Technology Planning & 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 document is made by the group effort of I2NSF working group. Many people actively contributed to this document, such as Reshad Rahman. The authors sincerely appreciate their contributions.
The following are co-authors of this document:
Jinyong Tim Kim
Department of Electronic, Electrical and Computer Engineering
Sungkyunkwan University
2066 Seo-ro Jangan-gu
Suwon, Gyeonggi-do 16419
Republic of Korea
EMail: timkim@skku.edu
Chaehong Chung
Department of Electronic, Electrical and Computer Engineering
Sungkyunkwan University
2066 Seo-ro Jangan-gu
Suwon, Gyeonggi-do 16419
Republic of Korea
EMail: darkhong@skku.edu
Susan Hares
Huawei
7453 Hickory Hill
Saline, MI 48176
USA
EMail: shares@ndzh.com
Diego R. Lopez
Telefonica I+D
Jose Manuel Lara, 9
Seville, 41013
Spain
EMail: diego.r.lopez@telefonica.com