Network Working Group S. Hyun Internet-Draft J. Jeong Intended status: Standards Track R. Roh Expires: January 4, 2018 W. Wi Sungkyunkwan University J. Park ETRI July 3, 2017 I2NSF Registration Interface YANG Data Model draft-hyun-i2nsf-registration-interface-dm-01 Abstract This document describes a YANG data model for I2NSF Registration Interface between Security Controller and Developer's Management System. The data model is required for the instance registration of Network Security Functions (NSF) 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 January 4, 2018. Copyright Notice Copyright (c) 2017 IETF Trust and the persons identified as the document authors. All rights reserved. Hyun, et al. Expires January 4, 2018 [Page 1] Internet-Draft Registration Interface Data Model July 2017 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. Registration Interface . . . . . . . . . . . . . . . . . . 4 4.2. Registration Request . . . . . . . . . . . . . . . . . . . 4 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 . . . . . . . . . . . . . . . . . . . . . . . . . 7 6. Security Considerations . . . . . . . . . . . . . . . . . . . 13 7. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 14 8. References . . . . . . . . . . . . . . . . . . . . . . . . . . 14 8.1. Normative References . . . . . . . . . . . . . . . . . . . 14 8.2. Informative References . . . . . . . . . . . . . . . . . . 14 Appendix A. Changes from draft-hyun-i2nsf-registration-interface-dm-00 . . . . 15 Hyun, et al. Expires January 4, 2018 [Page 2] Internet-Draft Registration Interface Data Model July 2017 1. Introduction This document provides a YANG [RFC6020] data model that defines the required data for I2NSF Registration Interface between Security Controller and Developer's Management System to dynamically manage a pool of the instances of Network Security Functions (NSF). 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 repository, data definition language, query language, implementation language, and protocol. [supa-policy-info-model] Hyun, et al. Expires January 4, 2018 [Page 3] Internet-Draft Registration Interface Data Model July 2017 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. Registration Interface module : ietf-i2nsf-regs-interface +--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]. 4.2. Registration Request This section expands the i2nsf-regs-req in Figure 1. Hyun, et al. Expires January 4, 2018 [Page 4] Internet-Draft Registration Interface Data Model July 2017 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 January 4, 2018 [Page 5] Internet-Draft Registration Interface Data Model July 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-address 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. Hyun, et al. Expires January 4, 2018 [Page 6] Internet-Draft Registration Interface Data Model July 2017 NSF Performance Capability +--rw i2nsf-nsf-performance-caps +--rw vcpus | +--rw cpu-num uint16 | +--rw cpu-topology | | +-- rw cpu-cores uint16 | | +-- rw cpu-socket uint16 | | +-- rw cpu-threads uint16 | +--rw (cpu-limit uint16)? | +--rw (cpu-reservation uint16)? +--rw disk | +--rw disk-size uint16 | +--rw (disk-limit uint16)? | +--rw (disk-reservation uint16)? +--rw memory | +--rw memory-size uint16 | +--rw (memory-limit uint16)? | +--rw (memory-reservation uint16)? +--rw bandwidth | +--rw outbound | | +--rw outbound-average uint16 | | +--rw outbound-peak uint16 | +--rw inbound | | +--rw inbound-average uint16 | | +--rw inbound-peak 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 [i2nsf-reg-inf-im]. file "ietf-i2nsf-regs-interface@2017-07-03.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; Hyun, et al. Expires January 4, 2018 [Page 7] Internet-Draft Registration Interface Data Model July 2017 } organization "IETF I2NSF (Interface to Network Security Functions) Working Group"; contact "WG Web: WG List: WG Chair: Adrian Farrel WG Chair: Linda Dunbar Editor: Sangwon Hyun Editor: Taekyun Roh Editor: Sarang Wi Editor: Jaehoon Paul Jeong Editor: Jung-Soo Park "; description "It defines a YANG data module for Registration Interface."; revision "2017-07-03"{ description "Initial revision"; reference "draft-hares-i2nsf-capability-data-model-01.txt draft-hyun-i2nsf-registration-interface-im-01.txt"; } grouping i2nsf-nsf-performance-caps { description "NSF performance capailities"; container vcpus{ Hyun, et al. Expires January 4, 2018 [Page 8] Internet-Draft Registration Interface Data Model July 2017 description "vcpus info"; container cpu-topology{ description "cpu-topology"; leaf cores{ type uint16; description "cpu-cores"; } leaf cpu-socket{ type uint16; description "cpu-socket"; } leaf cpu-threads{ type uint16; description "cpu-threads"; } } choice cpu-limitation{ description "cpu-limitation"; leaf cpu-limit{ type uint16; description "cpu-limit"; } } choice cpu-reservation{ description "cpu-reservation"; leaf cpu-reserve{ type uint16; description "cpu-reserve"; } } leaf cpu-num{ type uint16; description "cpu-num"; Hyun, et al. Expires January 4, 2018 [Page 9] Internet-Draft Registration Interface Data Model July 2017 } } container disk{ description "disk info"; leaf disk-size{ type uint16; description "disk-size"; } choice disk-limitation{ description "disk-limitation"; leaf disk-limit{ type uint16; description "disk-limit"; } } choice disk-reservation{ description "disk-reservation"; leaf disk-reserve{ type uint16; description "disk-reserve"; } } } container memory{ description "memory info"; leaf memory-size{ type uint16; description "memory-size"; } choice memory-limitation{ description "memory-limitation"; leaf memory-limit{ type uint16; description "memory-limit"; Hyun, et al. Expires January 4, 2018 [Page 10] Internet-Draft Registration Interface Data Model July 2017 } } choice memory-reservation{ description "memory-reservation"; leaf memory-reserve{ type uint16; description "memory-reserve"; } } } container bandwidth{ description "bandwidth info"; container inbound{ description "inbound"; leaf inbound-average{ type uint16; description "inbound-average"; } leaf inbound-peak{ type uint16; description "inbound-peak"; } } container outbound{ description "outbound"; leaf outbound-average{ type uint16; description "outbound-average"; } leaf outbound-peak{ type uint16; description "outbound-peak"; } } container i2nsf-nsf-profile { description "Detail information of an NSF"; container performance-capability { description Hyun, et al. Expires January 4, 2018 [Page 11] Internet-Draft Registration Interface Data Model July 2017 "performance-capability"; } } container i2nsf-capability { description "It refers draft-hares-i2nsf-capability-data-model-01"; } } grouping i2nsf-nsf-access-info { description "NSF access information"; leaf nsf-address { type inet:ipv4-address; mandatory true; description "nsf-address"; } leaf nsf-port-address { type inet:port-number; description "nsf-port-address"; } } container i2nsf-regs-req { description "The capability information of newly created NSF to notify its capability to Security Controller"; container nsf-profile { description "i2nsf-nsf-profile"; } container nsf-access-info { description "nsf-access-info"; uses i2nsf-nsf-access-info; } } container i2nsf-life-cycle-mgnt-req { description "Rquired information for req-creation-type and req-elimination-type"; leaf req-level { type uint16; description Hyun, et al. Expires January 4, 2018 [Page 12] Internet-Draft Registration Interface Data Model July 2017 "req-level"; } leaf req-id { type uint64; mandatory true; description "req-id"; } choice req-type { description "req-type"; case req-creation-type { description "req-creation-type"; } case req-elimination-type{ description "req-elimination-type"; container nsf-access-info { description "nsf-access-info"; uses i2nsf-nsf-access-info; } } } container nsf-profile { description "i2nsf-nsf-profile"; } } } } Figure 7: Data Model of I2NSf Registration Interface 6. Security Considerations The information model of the I2NSF 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. Hyun, et al. Expires January 4, 2018 [Page 13] Internet-Draft Registration Interface Data Model July 2017 7. Acknowledgments This work was supported by Institute for Information & communications Technology Promotion(IITP) grant funded by the Ministry of Science, ICT & Future Planning (MSIP) (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-05 (work in progress), May 2017. [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., Woo, S., Yeo, Y., Jeong, J., and J. Park, "NSF-Triggered Traffic Steering", draft-hyun-i2nsf-nsf-triggered-steering-in- i2nsf-02 (work in progress), March 2017. [i2nsf-reg-inf-im] Hyun, S., Woo, S., Yeo, Y., Jeong, J., and J. Park, "Registration Interface Hyun, et al. Expires January 4, 2018 [Page 14] Internet-Draft Registration Interface Data Model July 2017 Information Model", draft-hyun-i2nsf- registration-interface-im-02 (work in progress), March 2017. [i2nsf-capability-dm] Hares, S., Moskowitz, R., Xia, L., Jeong, J., and J. Kim, "I2NSF Capability YANG Data Model", i2nsf-capability draft-hares-i2nsf- capability-data-model-01, March 2017. [supa-policy-info-model] Strassner, J., Halpern, J., and S. van der Meer, "Generic Policy Information Model for Simplified Use of Policy Abstractions (SUPA)", draft-ietf-supa-generic-policy- info-model-03 (work in progress), May 2017. [supa-policy-data-model] Halpern, J., Strassner, J., and S. van der Meer, "Generic Policy Data Model for Simplified Use of Policy Abstractions (SUPA)", draft-ietf-supa-generic-policy- data-model-04 (work in progress), June 2017. [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. Appendix A. Changes from draft-hyun-i2nsf-registration-interface-dm-00 The following changes are made from draft-hyun-i2nsf-registration-interface-dm-00: o The description of NSF Performance Capability is specified in more detail than the previous version. o The description of YANG data model for Registration interface was clarified. Hyun, et al. Expires January 4, 2018 [Page 15] Internet-Draft Registration Interface Data Model July 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/ 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 Taekyun Roh Electrical Computer Engineering 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: tkroh@imtl.skku.ac.kr, URI: http://imtl.skku.ac.kr/index.php?mid=member_student Hyun, et al. Expires January 4, 2018 [Page 16] Internet-Draft Registration Interface Data Model July 2017 Sarang Wi Electrical Computer Engineering 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: sarang@imtl.skku.ac.kr, URI: http://imtl.skku.ac.kr/index.php?mid=member_student Jung-Soo Park Electronics and Telecommunications Research Institute 218 Gajeong-Ro, Yuseong-Gu Daejeon 305-700 Republic of Korea Phone: +82 42 860 6514 EMail: pjs@etri.re.kr Hyun, et al. Expires January 4, 2018 [Page 17]