Registration Interface YANG Data Model for Interface to Network Security Functions
draft-hyun-i2nsf-registration-interface-dm-00
The information below is for an old version of the document.
| Document | Type |
This is an older version of an Internet-Draft whose latest revision state is "Expired".
|
|
|---|---|---|---|
| Authors | Sangwon Hyun , Jaehoon Paul Jeong , yunsuk@imtl.skku.ac.kr, SangUk Woo , Susan Hares | ||
| Last updated | 2017-03-13 | ||
| RFC stream | (None) | ||
| Formats | |||
| Additional resources | |||
| Stream | Stream state | (No stream defined) | |
| Consensus boilerplate | Unknown | ||
| RFC Editor Note | (None) | ||
| IESG | IESG state | I-D Exists | |
| Telechat date | (None) | ||
| Responsible AD | (None) | ||
| Send notices to | (None) |
draft-hyun-i2nsf-registration-interface-dm-00
Network Working Group S. Hyun
Internet-Draft J. Jeong
Intended status: Standards Track Y. Yeo
Expires: September 14, 2017 S. Woo
Sungkyunkwan University
S. Hares
Huawei
March 13, 2017
Registration Interface YANG Data Model for Interface to Network Security
Functions
draft-hyun-i2nsf-registration-interface-dm-00
Abstract
This document describes a YANG data model for the Registration
Interface between Security Controller and Developer's Management
System in the Interface to Network Security Functions (I2NSF)
framework. The data model is required for the instance registration
of Network Security Functions (NSFs) and the dynamic life cycle
management of NSF instances.
Status of This Memo
This Internet-Draft is submitted to IETF in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that
other groups may also distribute working documents as Internet-
Drafts.
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."
The list of current Internet-Drafts can be accessed at
http://www.ietf.org/ietf/1id-abstracts.txt.
The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html.
This Internet-Draft will expire on September 14, 2017.
Copyright Notice
Hyun, et al. Expires September 14, 2017 [Page 1]
Internet-Draft Registration Interface Data Model March 2017
Copyright (c) 2017 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
(http://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.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Requirements Language . . . . . . . . . . . . . . . . . . . . 3
3. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3
3.1. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 4
4. High-Level YANG . . . . . . . . . . . . . . . . . . . . . . . 4
4.1. Registraion Interface . . . . . . . . . . . . . . . . . . 4
4.2. Registration Request . . . . . . . . . . . . . . . . . . . 5
4.3. Life-Cycle Management Request . . . . . . . . . . . . . . 5
4.4. NSF Profile . . . . . . . . . . . . . . . . . . . . . . . 5
4.5. NSF Access Information . . . . . . . . . . . . . . . . . . 6
4.6. NSF Performance Capability . . . . . . . . . . . . . . . . 6
5. YANG Modules . . . . . . . . . . . . . . . . . . . . . . . . . 6
6. Security Considerations . . . . . . . . . . . . . . . . . . . 10
7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 10
8. References . . . . . . . . . . . . . . . . . . . . . . . . . . 11
8.1. Normative References . . . . . . . . . . . . . . . . . . . 11
8.2. Informative References . . . . . . . . . . . . . . . . . . 11
Hyun, et al. Expires September 14, 2017 [Page 2]
Internet-Draft Registration Interface Data Model March 2017
1. Introduction
This document provides a YANG [RFC6020] data model that defines the
required data for the Registration Interface between Security
Controller and Developer's Management System in the Interface to
Network Security Functions (I2NSF) framework [i2nsf-framework]. This
Registration Interface can be used to dynamically manage a pool of
the instances of Network Security Functions (NSFs). This document
defines a YANG data model based on the [i2nsf-reg-inf-im]. The terms
used in this document are defined in [i2nsf-terminology].
2. Requirements Language
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119].
3. Terminology
This document uses the terminology described in [i2nsf-terminology],
[capability-im], [i2nsf-framework], [nsf-triggered-steering],
[supa-policy-data-model], and [supa-policy-info-model].
o Network Security Function (NSF): A function that is responsible
for 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.
[nsf-triggered-steering]
o Advanced Inspection/Action: As like the I2NSF information model
for NSF facing interface [capability-im], Advanced Inspection/
Action means that a security function calls another security
function for further inspection based on its own inspection
result. [nsf-triggered-steering]
o Network Security Function Profile (NSF Profile): NSF Profile
specifies the inspection capabilities of the associated NSF
instance. Each NSF instance has its own NSF Profile to specify
the type of security service it provides and its resource capacity
etc. [nsf-triggered-steering]
o Data Model: A data model is a representation of concepts of
interest to an environment in a form that is dependent on data
Hyun, et al. Expires September 14, 2017 [Page 3]
Internet-Draft Registration Interface Data Model March 2017
repository, data definition language, query language,
implementation language, and protocol. [supa-policy-info-model]
o Information Model: An information model is a representation of
concepts of interest to an environment in a form that is
independent of data repository, data definition language, query
language, implementation language, and protocol.
[supa-policy-info-model]
3.1. Tree Diagrams
A simplified graphical representation of the data model is used in
this document. The meaning of the symbols in these diagrams
[i2rs-rib-data-model] is as follows:
Brackets "[" and "]" enclose list keys.
Abbreviations before data node names: "rw" means configuration
(read-write) and "ro" state data (read-only).
Symbols after data node names: "?" means an optional node and "*"
denotes a "list" and "leaf-list".
Parentheses enclose choice and case nodes, and case nodes are also
marked with a colon (":").
Ellipsis ("...") stands for contents of subtrees that are not
shown.
4. High-Level YANG
This section provides an overview of the high level YANG.
4.1. Registraion Interface
module : ietf-i2nsf-regs-interface-model
+--rw regs-req
| uses i2nsf-regs-req
+--rw life-cycle-mgnt-req
| uses i2nsf-life-cycle-mgnt-req
Figure 1: High-Level YANG of I2NSF Registration Interface
Each of these sections mirror sections of [i2nsf-reg-inf-im].
Hyun, et al. Expires September 14, 2017 [Page 4]
Internet-Draft Registration Interface Data Model March 2017
4.2. Registration Request
This section expands the i2nsf-regs-req in Figure 1.
Registration Request
+--rw i2nsf-regs-req
+--rw nsf-profile
| uses i2nsf-nsf-profile
+--rw nsf-access-info
| uses i2nsf-nsf-access-info
Figure 2: High-Level YANG of I2NSF Registration Request
Registration Request contains the capability information of newly
created NSF to notify its capability to Security Controller. The
request also contains Network Access Information so that the Security
Controller can access the NSF.
4.3. Life-Cycle Management Request
This section expands the i2nsf-life-cycle-mgnt-req in Figure 1.
Life-Cycle Management Request
+--rw i2nsf-life-cycle-mgnt-req
+--rw req-level uint16
+--rw req-id uint64
+--rw (req-type)?
+--rw (req-creation-type)
+--rw nsf-profile
| uses i2nsf-nsf-profile
+--rw (req-elimination-type)
+--rw nsf-access-info
| uses i2nsf-nsf-access-info
Figure 3: High-Level YANG of I2NSF Life Cycle Mgnt Request
Life-cycle managment request consists of two types: req-creation-type
and req-elimination-type. The creation type is used to request
generation of a new NSF instance with NSF Profile which specifies
required NSF capability information. The elimination type is used to
remove an existing NSF with NSF Access Information.
4.4. NSF Profile
This section expands the i2nsf-nsf-profile in Figure 2 and Figure 3.
Hyun, et al. Expires September 14, 2017 [Page 5]
Internet-Draft Registration Interface Data Model March 2017
NSF Profile
+--rw i2nsf-nsf-profile
+--rw i2nsf-capability
| uses ietf-i2nsf-capability
+--rw performance-capability
| uses i2nsf-nsf-performance-caps
Figure 4: High-Level YANG of I2NSF NSF Profile
In Figure 4, ietf-i2nsf-capability refers module ietf-i2nsf-
capability in [i2nsf-capability-dm]. we add the performance
capability because it is absent in [i2nsf-capability-dm].
4.5. NSF Access Information
This section expands the i2nsf-nsf-access-info in Figure 2 and
Figure 3.
NSF Access Information
+--rw i2nsf-nsf-access-info
+--rw nsf-address inet:ipv4-address
+--rw nsf-port-number inet:port-number
Figure 5: High-Level YANG of I2NSF NSF Access Informantion
This information is used by other components to access an NSF.
4.6. NSF Performance Capability
This section expands the i2nsf-nsf-performance-caps in Figure 4.
NSF Performance Capability
+--rw i2nsf-nsf-performance-caps
+--rw cpu-num uint16
+--rw disk-size uint16
+--rw ram-size uint16
Figure 6: High-Level YANG of I2NSF NSF Performance Capability
When the Security Controller asks the Developer Mgnt System to create
a new NSF instance, the performance capability is used to specify the
spec of the new instance.
5. YANG Modules
This section introduces a YANG module for the information model of
the required data for the registration interface between Security
Controller and Developer's Management System, as defined in the
Hyun, et al. Expires September 14, 2017 [Page 6]
Internet-Draft Registration Interface Data Model March 2017
[i2nsf-reg-inf-im].
<CODE BEGINS> file "ietf-i2nsf-regs-interface@2017-03-13.yang"
module ietf-i2nsf-regs-interface {
namespace
"urn:ietf:params:xml:ns:yang:ietf-i2nsf-regs-interface";
prefix
regs-interface;
import ietf-inet-types{
prefix inet;
}
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: Adrian Farrel
<mailto:Adrain@olddog.co.uk>
WG Chair: Linda Dunbar
<mailto:Linda.duhbar@huawei.com>
Editor: Sangwon Hyun
<mailto:swhyun77@skku.edu>
Editor: Jaehoon Paul Jeong
<mailto:pauljeong@skku.edu>
Editor: Yunsuk Yeo
<mailto:yunsuk@imtl.skku.ac.kr>
Editor: Sanguk Woo
<mailto:suwoo@imtl.skku.ac.kr>
Editor: Susan Hares
<mailto:shares@ndzh.com>";
description
"It defines a YANG data module for Registration Interface.";
revision "2017-03-13"{
description "Initial revision";
reference
Hyun, et al. Expires September 14, 2017 [Page 7]
Internet-Draft Registration Interface Data Model March 2017
"draft-hares-i2nsf-capability-data-model-01
draft-hyun-i2nsf-registration-interface-im-01";
}
grouping i2nsf-nsf-performance-caps {
description
"NSF performance capabbilities";
leaf cpu-num {
type uint16;
description
"cpu-num";
}
leaf disk-size {
type uint16;
description
"disk-size";
}
leaf ram-size {
type uint16;
description
"ram-size";
}
}
grouping i2nsf-nsf-profile {
description
"Detail information of an NSF";
container performance-capability {
description
"Performance Capability";
uses i2nsf-nsf-performance-caps;
}
container i2nsf-capability {
description
"We will use draft-hares-i2nsf-capability-data-model-00.txt
later";
}
}
grouping i2nsf-nsf-access-info {
description
"NSF access information";
Hyun, et al. Expires September 14, 2017 [Page 8]
Internet-Draft Registration Interface Data Model March 2017
leaf nsf-address {
type inet:ipv4-address;
mandatory true;
description
"nsf-address";
}
leaf nsf-port-number {
type inet:port-number;
description
"nsf-port-number";
}
}
grouping i2nsf-regs-req {
description
"The capability information of newly created NSF to notify its
capability to Security Controller";
container nsf-profile {
description
"NSF Profile";
uses i2nsf-nsf-profile;
}
container nsf-access-info {
description
"NSF Access Info";
uses i2nsf-nsf-access-info;
}
}
grouping i2nsf-life-cycle-mgnt-req {
description
"Rquired information for req-creation-type and
req-elimination-type";
leaf req-level {
type uint16;
description
"req-level";
}
leaf req-id {
type uint64;
mandatory true;
description
"req-id";
Hyun, et al. Expires September 14, 2017 [Page 9]
Internet-Draft Registration Interface Data Model March 2017
}
choice req-type {
description
"req-type";
case req-creation-type {
description
"req-creation-type";
container nsf-profile {
description
"NSF Profile";
uses i2nsf-nsf-profile;
}
}
case req-elimination-type {
description
"req-elimination-type";
container nsf-access-info {
description
"NSF Access Info";
uses i2nsf-nsf-access-info;
}
}
}
}
}
<CODE ENDS>
Figure 7: Data Model of I2NSf Registration Interface
6. Security Considerations
The information model of the registration interface is based on the
I2NSF framework without any architectural changes. Thus, this
document shares the security considerations of the I2NSF framwork
architecture that are specified in [i2nsf-framework] for the purpose
of achieving secure communication among components in the proposed
architecture.
7. Acknowledgements
This work was supported by Institute for Information & communications
Technology Promotion(IITP) grant funded by the Korea government(MSIP)
Hyun, et al. Expires September 14, 2017 [Page 10]
Internet-Draft Registration Interface Data Model March 2017
(No.R-20160222-002755, Cloud based Security Intelligence Technology
Development for the Customized Security Service Provisioning).
8. References
8.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs
toIndicate Requirement Levels", RFC 2119,
March 1997.
[RFC6020] Bjorklund, M., "YANG - A Data Modeling
Language for the Network Configuration
Protocol (NETCONF)", RFC 6020,
October 2010.
8.2. Informative References
[capability-im] Xia, L., Strassner, J., Basile, C., and D.
Lopez, "Information Model of NSFs
Capabilities",
draft-xibassnez-i2nsf-capability-01 (work
in progress), March 2017.
[i2nsf-framework] Lopez, D., Lopez, E., Dunbar, L.,
Strassner, J., and R. Kumar, "Framework for
Interface to Network Security Functions",
draft-ietf-i2nsf-framework-04 (work in
progress), October 2016.
[i2nsf-terminology] Hares, S., Strassner, J., Lopez, D., Xia,
L., and H. Birkholz, "Interface to Network
Security Functions (I2NSF) Terminology",
draft-ietf-i2nsf-terminology-03 (work in
progress), March 2017.
[nsf-triggered-steering] Hyun, S., Jeong, J., Woo, S., Yeo, Y., and
J. Park, "NSF-Triggered Traffic Steering",
draft-hyun-i2nsf-nsf-triggered-steering-02
(work in progress), March 2017.
[i2nsf-reg-inf-im] Hyun, S., Jeong, J., Woo, S., Yeo, Y., and
J. Park, "Registration Interface
Information Model for Interface to Network
Security Functions", draft-hyun-i2nsf-
registration-interface-im-01 (work in
progress), March 2017.
Hyun, et al. Expires September 14, 2017 [Page 11]
Internet-Draft Registration Interface Data Model March 2017
[i2nsf-capability-dm] Hares, S., Moskowitz, R., Xia, L., Jeong,
J., and J. Kim, "I2NSF Capability YANG Data
Model",
draft-hares-i2nsf-capability-data-model-01
(work in progress), March 2017.
[supa-policy-info-model] Strassner, J., Halpern, J., and S. Meer,
"Generic Policy Information Model for
Simplified Use of Policy Abstractions
(SUPA)", draft-ietf-supa-generic-policy-
info-model-02 (work in progress),
January 2017.
[supa-policy-data-model] Halpern, J., Strassner, J., and S. Meer,
"Generic Policy Data Model for Simplified
Use of Policy Abstractions (SUPA)", draft-
ietf-supa-generic-policy-data-model-02
(work in progress), October 2016.
[i2rs-rib-data-model] Wang, L., Ananthakrishnan, H., Chen, M.,
Dass, A., Kini, S., and N. Bahadur, "A YANG
Data Model for Routing Information Base
(RIB)", draft-ietf-i2rs-rib-data-model-07
(work in progress), January 2017.
Authors' Addresses
Sangwon Hyun
Department of Software
Sungkyunkwan University
2066 Seobu-Ro, Jangan-Gu
Suwon, Gyeonggi-Do 16419
Republic of Korea
Phone: +82 31 290 7222
Fax: +82 31 299 6673
EMail: swhyun77@skku.edu
URI: http://imtl.skku.ac.kr/
Hyun, et al. Expires September 14, 2017 [Page 12]
Internet-Draft Registration Interface Data Model March 2017
Jaehoon Paul Jeong
Department of Software
Sungkyunkwan University
2066 Seobu-Ro, Jangan-Gu
Suwon, Gyeonggi-Do 16419
Republic of Korea
Phone: +82 31 299 4957
Fax: +82 31 290 7996
EMail: pauljeong@skku.edu
URI: http://iotlab.skku.edu/people-jaehoon-jeong.php
YunSuk Yeo
Department of Software
Sungkyunkwan University
2066 Seobu-Ro, Jangan-Gu
Suwon, Gyeonggi-Do 16419
Republic of Korea
Phone: +82 31 290 7222
Fax: +82 31 299 6673
EMail: yunsuk@imtl.skku.ac.kr,
URI: http://imtl.skku.ac.kr/index.php?mid=member_student
SangUk Woo
Department of Software
Sungkyunkwan University
2066 Seobu-Ro, Jangan-Gu
Suwon, Gyeonggi-Do 16419
Republic of Korea
Phone: +82 31 290 7222
Fax: +82 31 299 6673
EMail: suwoo@imtl.skku.ac.kr,
URI: http://imtl.skku.ac.kr/index.php?mid=member_student
Susan Hares
Huawei
7453 Hickory Hill
Saline, MI 48176
USA
Phone: +1-734-604-0332
EMail: shares@ndzh.com
Hyun, et al. Expires September 14, 2017 [Page 13]