Network Working Group J. Jeong
Internet-Draft E. Kim
Intended status: Standards Track Sungkyunkwan University
Expires: April 5, 2018 T. Ahn
Korea Telecom
R. Kumar
Juniper Networks
S. Hares
Huawei
October 2, 2017
I2NSF Consumer-Facing Interface YANG Data Model
draft-jeong-i2nsf-consumer-facing-interface-dm-04
Abstract
This document describes a YANG data model for high-level security
policies through the Consumer-Facing Interface between an Interface
to Network Security Functions (I2NSF) User and Security Controller in
an I2NSF system under a Network Functions Virtualization (NFV)
environment. The data model is required for enabling different users
of a given I2NSF system to define, manage, and monitor security
policies for specific flows within an administrative domain.
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 April 5, 2018.
Jeong, et al. Expires April 5, 2018 [Page 1]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
Copyright Notice
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
4. Data Modeling for Consumer-Facing Interface . . . . . . . . . 3
5. YANG Data Model for Consumer-Facing Interface . . . . . . . . 8
6. Security Considerations . . . . . . . . . . . . . . . . . . . 38
7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 38
8. References . . . . . . . . . . . . . . . . . . . . . . . . . . 39
8.1. Normative References . . . . . . . . . . . . . . . . . . . 39
8.2. Informative References . . . . . . . . . . . . . . . . . . 39
Appendix A. Changes from
draft-jeong-i2nsf-consumer-facing-interface-dm-03 . . 39
Appendix B. Use Case: Policy Instance Example for VoIP/VoLTE
Security Services . . . . . . . . . . . . . . . . . . 40
Appendix C. Policy Instance YANG Example for VoIP/VoLTE
Security Services . . . . . . . . . . . . . . . . . . 42
Appendix D. Example XML Output for VoIP Service . . . . . . . . . 48
Jeong, et al. Expires April 5, 2018 [Page 2]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
1. Introduction
This document provides a data model defined by YANG [RFC6020] for
high-level security policies through the Consumer-Facing Interface
between an Interface to Network Security Functions (I2NSF) User and
Security Controller in an I2NSF system [i2nsf-framework] under a
Network Functions Virtualization (NFV) environment. The data model
is required for enabling different users of a given I2NSF system to
define, manage and monitor security policies for specific flows
within an administrative domain. This document defines a YANG data
model based on the information model of I2NSF Consumer-Facing
Interface [client-facing-inf-im].
High-level security policies based on the YANG data model can be
translated by Security Controller into low-level security policies
that have many details for security services at Network Securty
Functions (NSFs). Thus, a data model for low-level security policies
needs to provide details of how the required security services can be
performed for the NSFs, e.g., rules explaining how to map managed
objects onto lower-level protocol constructs. Also, since conceptual
models can be implemented in different ways, multiple data models can
be derived by a single information model.
The efficient and flexible provisioning of network functions by NFV
leads to a rapid advance in the network industry. As practical
applications, NSFs (e.g., firewall, intrusion detection system (IDS)/
intrusion prevention system (IPS), and attack mitigation) can also be
provided as virtual network functions (VNF) in the NFV system. By
the efficient virtual technology, these VNFs might be automatically
provisioned and dynamically migrated based on real-time security
requirements. This document presents a YANG data model to implement
security functions based on NFV.
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 RFC 2119 [RFC3444].
3. Terminology
This document uses the terminology described in
[i2nsf-terminology][client-facing-inf-im][client-facing-inf-req].
4. Data Modeling for Consumer-Facing Interface
The main objective of this data model is to fully transform the
information model [client-facing-inf-im] into a YANG data model that
Jeong, et al. Expires April 5, 2018 [Page 3]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
can be used for delivering control and management messages via the
Consumer-Facing Interface between an I2NSF User and Security
Controller for the I2NSF User's high-level security policies.
The semantics of the data model must be aligned with the information
model of the Consumer-Facing Interface. The transformation of the
information model was performed so that this YANG data model can
facilitate the efficient delivery of the control or management
messages.
This data model is designed to support the I2NSF framework that can
be extended according to the security needs. In other words, the
model design is independent of the content and meaning of specific
policies as well as the implementation approach. This document
suggests a VoIP/VoLTE security service as a use case for policy rule
generation.
module: ieft-i2nsf-cf-interface
+--rw ietf-i2nsf-cf-interface
+--rw multi-tenancy
| +--rw policy-domain* [policy-domain-id]
| | +--rw policy-domain-id uint16
| | +--rw name string
| | +--rw address string
| | +--rw contact string
| | +--rw date yang:date-and-time
| | +--rw authentication-method string
| +--rw policy-tenant* [policy-tenant-id]
| | +--rw policy-tenant-id uint16
| | +--rw name string
| | +--rw date yang:date-and-time
| | +--rw domain string
| +--rw policy-role* [policy-role-id]
| | +--rw policy-role-id uint16
| | +--rw name string
| | +--rw date yang:date-and-time
| | +--rw access-profile string
| +--rw policy-user* [policy-user-id]
| | +--rw policy-user-id uint16
| | +--rw name string
| | +--rw date yang:date-and-time
| | +--rw password string
| | +--rw email string
| | +--rw scope-type? string
| | +--rw scope-reference? string
| | +--rw role string
| +--rw policy-mgmt-auth-method* [policy-mgnt-auth-method-id]
| +--rw policy-mgnt-auth-method-id uint16
Jeong, et al. Expires April 5, 2018 [Page 4]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
| +--rw name string
| +--rw date yang:date-and-time
| +--rw authentication-method string
| +--rw mutual-authentication boolean
| +--rw token-server string
| +--rw certificate-server string
| +--rw single-sing-on-server string
+--rw policy-endpoint-groups
| +--rw meta-data-source* [meta-data-source-id]
| | +--rw meta-data-source-id uint16
| | +--rw name string
| | +--rw date yang:date-and-time
| | +--rw tag-type? boolean
| | +--rw tag-server-information? string
| | +--rw tag-application-protocol? string
| | +--rw tag-server-credential? string
| +--rw user-group* [user-group-id]
| | +--rw user-group-id uint16
| | +--rw name? string
| | +--rw date? yang:date-and-time
| | +--rw group-type? string
| | +--rw meta-data-server? string
| | +--rw group-member? string
| | +--rw risk-level? uint16
| +--rw device-group* [device-group-id]
| | +--rw device-group-id uint16
| | +--rw name? string
| | +--rw date? yang:date-and-time
| | +--rw group-type? string
| | +--rw meta-data-server? string
| | +--rw group-member? string
| | +--rw risk-level? uint16
| +--rw application-group* [application-group-id]
| | +--rw application-group-id uint16
| | +--rw name? string
| | +--rw date? yang:date-and-time
| | +--rw group-type? string
| | +--rw meta-data-server? string
| | +--rw group-member? string
| | +--rw risk-level? uint16
| +--rw location-group* [location-group-id]
| +--rw location-group-id uint16
| +--rw name? string
| +--rw date? yang:date-and-time
| +--rw group-type? string
| +--rw meta-data-server? string
| +--rw group-member? string
| +--rw risk-level? uint16
Jeong, et al. Expires April 5, 2018 [Page 5]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
+--rw threat-prevention
| +--rw threat-feed* [threat-feed-id]
| | +--rw threat-feed-id uint16
| | +--rw name? string
| | +--rw date? yang:date-and-time
| | +--rw feed-type? enumeration
| | +--rw feed-server? string
| | +--rw feed-priority? uint16
| +--rw custom-list* [custom-list-id]
| | +--rw custom-list-id uint16
| | +--rw name? string
| | +--rw date? yang:date-and-time
| | +--rw list-type? enumeration
| | +--rw list-property? enumeration
| | +--rw list-content? string
| +--rw malware-scan-group* [malware-scan-group-id]
| | +--rw malware-scan-group-id uint16
| | +--rw name? string
| | +--rw date? yang:date-and-time
| | +--rw signature-server? string
| | +--rw file-types? string
| | +--rw malware-signatures? string
| +--rw event-map-group* [event-map-group-id]
| +--rw event-map-group-id uint16
| +--rw name? string
| +--rw date? yang:date-and-time
| +--rw security-events? string
| +--rw threat-map? string
+--rw telemetry-data
| +--rw telemetry-data* [telemetry-data-id]
| | +--rw telemetry-data-id uint16
| | +--rw name? string
| | +--rw date? yang:date-and-time
| | +--rw logs? boolean
| | +--rw syslogs? boolean
| | +--rw snmp? boolean
| | +--rw sflow? boolean
| | +--rw netflow? boolean
| | +--rw interface-stats? boolean
| +--rw telemetry-source* [telemetry-source-id]
| | +--rw telemetry-source-id uint16
| | +--rw name? string
| | +--rw date? yang:date-and-time
| | +--rw source-type? string
| | +--rw nsf-access-parameters? string
| | +--rw nsf-access-credentials? string
| | +--rw collection-interval? uint16
| | +--rw collection-method? enumeration
Jeong, et al. Expires April 5, 2018 [Page 6]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
| | +--rw heartbeat-interval? uint16
| | +--rw qos-marking? uint8
| +--rw telemetry-destination* [telemetry-destination-id]
| +--rw telemetry-destination-id uint16
| +--rw name? string
| +--rw date? yang:date-and-time
| +--rw collector-state? string
| +--rw collector-access-parameters? string
| +--rw collector-access-credentials? string
| +--rw data-encoding? string
| +--rw data-transport? string
+--rw security-policy-instance
+--rw policy-rule* [policy-rule-id]
| +--rw policy-rule-id uint16
| +--rw name? string
| +--rw date? yang:date-and-time
| +--rw source? -> /ietf-i2nsf-cf-interface
| | /threat-prevention
| | /threat-feed
| | /threat-feed-id
| +--rw destination? -> /ietf-i2nsf-cf-interface
| | /policy-endpoint-groups
| | /user-group/user-group-id
| +--rw exception? boolean
| +--rw exception-detail? string
+--rw action* [action-id]
| +--rw action-id uint16
| +--rw name? string
| +--rw date? yang:date-and-time
| +--rw primary-action? string
| +--rw secondary-action? string
+--rw precedence* [precedence-id]
| +--rw precedence-id uint16
| +--rw rule-exist? boolean
+--rw event* [event-id]
| +--rw event-id uint16
| +--rw security-event? string
| +--rw threat-map? string
| +--rw enable? boolean
+--rw condition* [condition-id]
| +--rw condition-id uint16
| +--rw condition-type string
| +--rw service* [service-id] uint16
| | +--rw service-name string
| | +--rw service-type string
| +--rw traffic* [traffic-id]
| | +--rw traffic-threshold uint16
| +--rw webfilter* [webfilter-id]
Jeong, et al. Expires April 5, 2018 [Page 7]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
| | +--rw webfilter-name string
| | +--rw webfilter-url string
| +--rw firewall* [firewall-id]
| +--rw firewall-name string
| +--rw firewall-type string
| +--rw firewall-address -> /ietf-i2nsf-cf-interface
| /threat-prevention
| /threat-feed
| /threat-feed-id
|
+--rw policy-calendar* [policy-calendar-id]
| +--rw policy-calendar-id uint16
| +--rw name? string
| +--rw date? yang:date-and-time
| +--rw enforcement-type? string
| +--rw begin-time? yang:date-and-time
| +--rw end-time? yang:date-and-time
+--rw policy-instance* [policy-instance-id]
+--rw policy-instance-id string
+--rw name? string
+--rw date? yang:date-and-time
+--rw rules? -> /ietf-i2nsf-cf-interface
| /security-policy-instance
| /policy-rule
| /policy-rule-id
+--rw scheduling? -> /ietf-i2nsf-cf-interface
| /security-policy-instance
| /policy-calendar
| /policy-calendar-id
+--rw owner? string
Figure 1: Generic Data Model for cf Interface
5. YANG Data Model for Consumer-Facing Interface
This section describes a YANG data model for Consumer-Facing
Interface, based on the information model of Consumer-Facing
Interface to security controller [client-facing-inf-im].
<CODE BEGINS> file "ietf-i2nsf-cf-interface.yang"
module ietf-i2nsf-cf-interface {
namespace
"urn:ietf:params:xml:ns:yang:ietf-i2nsf-cf-interface";
prefix
cf-interface;
Jeong, et al. Expires April 5, 2018 [Page 8]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
import ietf-inet-types{
prefix inet;
}
import ietf-yang-types{
prefix yang;
}
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: Jaehoon Paul Jeong
<mailto:pauljeong@skku.edu>";
description
"This module defines a YANG data module for consumer-facing
interface to security controller.";
revision "2017-10-02"{
description "Initial revision";
reference
"draft-kumar-i2nsf-client-facing-interface-im-02";
}
//Groupings
container ietf-i2nsf-consumer-facing-interface {
description
"grouping container";
container multi-tenancy {
description
"The descriptions of multi-tenancy.";
list policy-domain {
key "policy-domain-id";
leaf policy-domain-id {
type uint16;
mandatory true;
description
Jeong, et al. Expires April 5, 2018 [Page 9]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
"This represents the list of domains.";
}
description
"this represent the list of policy domains";
leaf name {
type string;
mandatory true;
description
"Name of the organization or customer representing
this domain.";
}
leaf address {
type string;
description
"address of an organization or customer.";
}
leaf contact {
type string;
mandatory true;
description
"contact information of the organization
or customer.";
}
leaf date {
type yang:date-and-time;
mandatory true;
description
"The date when this account was created
or last modified.";
}
leaf authentication-method {
type string;
mandatory true;
description
"The description of authentication method;
token-based, password, certificate,
single-sign-on";
}
}
list policy-tenant {
key "policy-tenant-id";
leaf policy-tenant-id {
type uint16;
Jeong, et al. Expires April 5, 2018 [Page 10]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
mandatory true;
description
"The policy tenant id.";
}
description
"This represents the list of tenants";
leaf name {
type string;
mandatory true;
description
"Name of the Department or Division within
an organization.";
}
leaf date {
type yang:date-and-time;
mandatory true;
description
"Date this account was created or last modified.";
}
leaf domain {
type string;
mandatory true;
description
"This field identifies the domain to which this
tenant belongs. This should be reference to a
'Policy-Domain' object.";
}
}
list policy-role {
key "policy-role-id";
leaf policy-role-id {
type uint16;
mandatory true;
description
"This defines a set of permissions assigned
to a user in an organization that want to manage
its own Security Policies.";
}
description
"This represents the list of policy roles.";
leaf name {
type string;
mandatory true;
description
"This field identifies name of the role.";
Jeong, et al. Expires April 5, 2018 [Page 11]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
}
leaf date {
type yang:date-and-time;
mandatory true;
description
"Date this role was created or last modified.";
}
leaf access-profile {
type string;
mandatory true;
description
"This field identifies the access profile for the
role. The profile grants or denies access to policy
objects. Multiple access profiles can be
concatenated together.";
}
}
list policy-user {
key "policy-user-id";
leaf policy-user-id {
type uint16;
description
"This represents the policy-user-id.";
}
description
"This represents the list of policy users.";
leaf name {
type string;
mandatory true;
description
"The name of a user.";
}
leaf date {
type yang:date-and-time;
mandatory true;
description
"Date this user was created or last modified";
}
leaf password {
type string;
mandatory true;
description
"User password for basic authentication";
Jeong, et al. Expires April 5, 2018 [Page 12]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
}
leaf email {
type string;
mandatory true;
description
"The email account of a user";
}
leaf scope-type {
type string;
description
"identifies whether a user has domain-wide
or tenant-wide privileges";
}
leaf scope-reference {
type string;
description
"This references policy-domain or policy-tenant
to identify the scope.";
}
leaf role {
type string;
mandatory true;
description
"This references policy-role to define specific
permissions";
}
}
list policy-mgmt-auth-method {
key "policy-mgnt-auth-method-id";
leaf policy-mgnt-auth-method-id {
type uint16;
description
"This represents the authentication method id.";
}
description
"The descriptions of policy management
authentication methods.";
leaf name {
type string;
mandatory true;
description
"name of the authentication method";
}
Jeong, et al. Expires April 5, 2018 [Page 13]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
leaf date {
type yang:date-and-time;
mandatory true;
description
"date when the authentication method
was created";
}
leaf authentication-method {
type string;
mandatory true;
description
"The description of authentication method;
token-based, password, certificate,
single-sign-on";
}
leaf mutual-authentication {
type boolean;
mandatory true;
description
"To identify whether the authentication
is mutual";
}
leaf token-server {
type string;
mandatory true;
description
"The token-server information if the
authentication method is token-based";
}
leaf certificate-server {
type string;
mandatory true;
description
"The certificate-server information if
the authentication method is certificate-based";
}
leaf single-sing-on-server {
type string;
mandatory true;
description
"The single-sign-on-server information
if the authentication method is
single-sign-on-based";
Jeong, et al. Expires April 5, 2018 [Page 14]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
}
}
}
container policy-endpoint-groups {
description
"A logical entity in their business
environment, where a security policy
is to be applied.";
list meta-data-source {
key "meta-data-source-id";
leaf meta-data-source-id {
type uint16;
mandatory true;
description
"This represents the meta-data source id.";
}
description
"This represents the meta-data source.";
leaf name {
type string;
mandatory true;
description
"This identifies the name of the
meta-datas-ource.";
}
leaf date {
type yang:date-and-time;
mandatory true;
description
"This identifies the date this object was
created or last modified.";
}
leaf tag-type {
type boolean;
description
"This identifies the group type; user group,
app group or device group.";
}
leaf tag-server-information {
type string;
description
"The description of suthentication method;
token-based, password, certificate,
single-sign-on";
Jeong, et al. Expires April 5, 2018 [Page 15]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
}
leaf tag-application-protocol {
type string;
description
"This filed identifies the protocol e.g. LDAP,
Active Directory, or CMDB";
}
leaf tag-server-credential {
type string;
description
"This field identifies the credential
information needed to access the tag server";
}
}
list user-group{
key "user-group-id";
leaf user-group-id {
type uint16;
mandatory true;
description
"This represents the the user group id.";
}
description
"This represents the user group.";
leaf name {
type string;
description
"This field identifies the name of user-group.";
}
leaf date {
type yang:date-and-time;
description
"when this user-group was created or last modified.";
}
leaf group-type {
type string;
description
"This describes the group type; User-tag,
User-name or IP-address.";
}
leaf meta-data-server {
type string;
description
"This references metadata source";
}
Jeong, et al. Expires April 5, 2018 [Page 16]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
leaf group-member {
type string;
description
"This describes the user-tag information";
}
leaf risk-level {
type uint16;
description
"This represents the threat level; valid range
may be 0 to 9.";
}
}
list device-group{
key "device-group-id";
leaf device-group-id {
type uint16;
description
"This represents a device group id.";
}
description
"This represents a device group.";
leaf name {
type string;
description
"This field identifies the name of
a device-group.";
}
leaf date {
type yang:date-and-time;
description
"The date when this group was create or
last modified.";
}
leaf group-type {
type string;
description
"This describes the group type; device-tag,
device-name or IP-address.";
}
leaf meta-data-server {
type string;
description
"This references meta-data-source
object.";
Jeong, et al. Expires April 5, 2018 [Page 17]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
}
leaf group-member {
type string;
description
"This describes the device-tag, device-name or
IP-address information";
}
leaf risk-level {
type uint16;
description
"This represents the threat level; valid range
may be 0 to 9.";
}
}
list application-group{
key "application-group-id";
leaf application-group-id {
type uint16;
description
"This represents an application group id.";
}
description
"This represents an application group.";
leaf name {
type string;
description
"This field identifies the name of
an application group";
}
leaf date {
type yang:date-and-time;
description
"The date when this group was created or
last modified.";
}
leaf group-type {
type string;
description
"This identifies the group type;
application-tag, application-name or
IP-address.";
}
Jeong, et al. Expires April 5, 2018 [Page 18]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
leaf meta-data-server {
type string;
description
"This references meta-data-source
object.";
}
leaf group-member {
type string;
description
"This describes the application-tag,
application-name or IP-address information";
}
leaf risk-level {
type uint16;
description
"This represents the threat level; valid range
may be 0 to 9.";
}
}
list location-group{
key "location-group-id";
leaf location-group-id {
type uint16;
description
"This represents a location group id.";
}
description
"This represents a location group.";
leaf name {
type string;
description
"This field identifies the name of
a location group";
}
leaf date {
type yang:date-and-time;
description
"The date when this group was created or
last modified.";
}
leaf group-type {
type string;
Jeong, et al. Expires April 5, 2018 [Page 19]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
description
"This identifies the group type;
location-tag, location-name or
IP-address.";
}
leaf meta-data-server {
type string;
description
"This references meta-data-source
object.";
}
leaf group-member {
type string;
description
"This describes the location-tag,
location-name or IP-address information";
}
leaf risk-level {
type uint16;
description
"This represents the threat level; valid range
may be 0 to 9.";
}
}
}
container threat-prevention {
description
"this describes the list of threat-preventions.";
list threat-feed {
key "threat-feed-id";
leaf threat-feed-id {
type uint16;
mandatory true;
description
"This represents the threat-feed-id.";
}
description
"This represents the threat feed within the
threat-prevention-list.";
leaf name {
type string;
description
"Name of the theat feed.";
Jeong, et al. Expires April 5, 2018 [Page 20]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
}
leaf date {
type yang:date-and-time;
description
"when the threat-feed was created.";
}
leaf feed-type {
type enumeration {
enum unknown {
description
"feed-type is unknown.";
}
enum ip-address {
description
"feed-type is IP address.";
}
enum url {
description
"feed-type is URL.";
}
}
mandatory true;
description
"This determined whether the feed-type is IP address
based or URL based.";
}
leaf feed-server {
type string;
description
"this contains threat feed server information.";
}
leaf feed-priority {
type uint16;
description
"this describes the priority of the threat from
0 to 5, where 0 means the threat is minimum and
5 meaning the maximum.";
}
}
list custom-list {
key "custom-list-id";
leaf custom-list-id {
type uint16;
Jeong, et al. Expires April 5, 2018 [Page 21]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
description
"this describes the custom-list-id.";
}
description
"this describes the threat-prevention custom list.";
leaf name {
type string;
description
"Name of the custom-list.";
}
leaf date {
type yang:date-and-time;
description
"when the custom list was created.";
}
leaf list-type {
type enumeration {
enum unknown {
description
"list-type is unknown.";
}
enum ip-address {
description
"list-type is IP address.";
}
enum mac-address {
description
"list-type is MAC address.";
}
enum url {
description
"list-type is URL.";
}
}
mandatory true;
description
"This determined whether the feed-type is IP address
based or URL based.";
}
leaf list-property {
type enumeration {
enum unknown {
description
"list-property is unknown.";
}
Jeong, et al. Expires April 5, 2018 [Page 22]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
enum blacklist {
description
"list-property is blacklist.";
}
enum whitelist {
description
"list-property is whitelist.";
}
}
mandatory true;
description
"This determined whether the list-type is blacklist
or whitelist.";
}
leaf list-content {
type string;
description
"This describes the contents of the custom-list.";
}
}
list malware-scan-group {
key "malware-scan-group-id";
leaf malware-scan-group-id {
type uint16;
mandatory true;
description
"This is the malware-scan-group-id.";
}
description
"This represents the malware-scan-group.";
leaf name {
type string;
description
"Name of the malware-scan-group.";
}
leaf date {
type yang:date-and-time;
description
"when the malware-scan-group was created.";
}
leaf signature-server {
type string;
description
"This describes the signature server of the
malware-scan-group.";
Jeong, et al. Expires April 5, 2018 [Page 23]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
}
leaf file-types {
type string;
description
"This contains a list of file types needed to
be scanned for the virus.";
}
leaf malware-signatures {
type string;
description
"This contains a list of malware signatures or hash.";
}
}
list event-map-group {
key "event-map-group-id";
leaf event-map-group-id {
type uint16;
mandatory true;
description
"This is the event-map-group-id.";
}
description
"This represents the event map group.";
leaf name {
type string;
description
"Name of the event-map.";
}
leaf date {
type yang:date-and-time;
description
"when the event-map was created.";
}
leaf security-events {
type string;
description
"This contains a list of security events.";
}
leaf threat-map {
type string;
description
Jeong, et al. Expires April 5, 2018 [Page 24]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
"This contains a list of threat levels.";
}
}
}
container telemetry-data {
description
"Telemetry provides visibility into the network
activities which can be tapped for further
security analytics, e.g., detecting potential
vulnerabilities, malicious activities, etc.";
list telemetry-data {
key "telemetry-data-id";
leaf telemetry-data-id {
type uint16;
mandatory true;
description
"This is ID for telemetry-data-id.";
}
description
"This is ID for telemetry-data.";
leaf name {
type string;
description
"Name of the telemetry-data object.";
}
leaf date {
type yang:date-and-time;
description
"This field states when the telemery-data
object was created.";
}
leaf logs {
type boolean;
description
"This field identifies whether logs
need to be collected.";
}
leaf syslogs {
type boolean;
description
"This field identifies whether System logs
need to be collected.";
}
Jeong, et al. Expires April 5, 2018 [Page 25]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
leaf snmp {
type boolean;
description
"This field identifies whether 'SNMP traps' and
'SNMP alarms' need to be collected.";
}
leaf sflow {
type boolean;
description
"This field identifies whether 'sFlow' data
need to be collected.";
}
leaf netflow {
type boolean;
description
"This field identifies whether 'NetFlow' data
need to be collected.";
}
leaf interface-stats {
type boolean;
description
"This field identifies whether 'Interface' data
such as packet bytes and counts need to be
collected.";
}
}
list telemetry-source {
key "telemetry-source-id";
leaf telemetry-source-id {
type uint16;
mandatory true;
description
"This is ID for telemetry-source-id.";
}
description
"This is ID for telemetry-source.";
leaf name {
type string;
description
"This identifies the name of this object.";
}
leaf date {
type yang:date-and-time;
Jeong, et al. Expires April 5, 2018 [Page 26]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
description
"Date this object was created or last modified";
}
leaf source-type {
type string;
description
"This should have one of the following type of
the NSF telemetry source: NETWORK-NSF,
FIREWALL-NSF, IDS-NSF, IPS-NSF,
PROXY-NSF, VPN-NSF, DNS, ACTIVE-DIRECTORY,
IP Reputation Authority, Web Reputation
Authority, Anti-Malware Sandbox, Honey Pot,
DHCP, Other Third Party, ENDPOINT";
}
leaf nsf-access-parameters {
type string;
description
"This field contains information such as
IP address and protocol (UDP or TCP) port
number of the NSF providing telemetry data.";
}
leaf nsf-access-credentials {
type string;
description
"This field contains username and password
to authenticate with the NSF.";
}
leaf collection-interval {
type uint16;
units seconds;
default 5000;
description
"This field contains time in milliseconds
between each data collection. For example,
a value of 5000 means data is streamed to
collector every 5 seconds. Value of 0 means
data streaming is event-based";
}
leaf collection-method {
type enumeration {
enum unknown {
description
"collection-method is unknown.";
Jeong, et al. Expires April 5, 2018 [Page 27]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
}
enum push-based {
description
"collection-method is PUSH-based.";
}
enum pull-based {
description
"collection-method is PULL-based.";
}
}
description
"This field contains a method of collection,
i.e., whether it is PUSH-based or PULL-based.";
}
leaf heartbeat-interval {
type uint16;
units seconds;
description
"time in seconds the source sends telemetry
heartbeat.";
}
leaf qos-marking {
type uint8;
description
"DSCP value must be contained in this field.";
}
}
list telemetry-destination {
key "telemetry-destination-id";
leaf telemetry-destination-id {
type uint16;
description
"this represents the telemetry-destination-id";
}
description
"This object contains information related to
telemetry destination. The destination is
usually a collector which is either a part of
Security Controller or external system
such as Security Information and Event
Management (SIEM).";
leaf name {
type string;
description
"This identifies the name of this object.";
Jeong, et al. Expires April 5, 2018 [Page 28]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
}
leaf date {
type yang:date-and-time;
description
"Date this object was created or last
modified";
}
leaf collector-state {
type string;
description
"This describes collector state information.";
}
leaf collector-credentials {
type string;
description
"iThis field contains the username and
password for the collector.";
}
leaf collector-source {
type string;
description
"This field contains information such as
IP address and protocol (UDP or TCP) port
number for the collector's destination.";
}
leaf data-encoding {
type string;
description
"This field contains the telemetry data encoding
in the form of schema.";
}
leaf data-transport {
type string;
description
"This field contains streaming telemetry data
protocols. This could be gRPC, protocol
buffer over UDP, etc.";
}
}
}
container security-policy-instance {
description
Jeong, et al. Expires April 5, 2018 [Page 29]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
"This object is a policy instance to have
complete information such as where and when
a policy need to be applied.";
list policy-calendar {
key "policy-calendar-id";
leaf policy-calendar-id {
type uint16;
description
"this represents the policy-calendar-id.";
}
description
"This object contains information related to
scheduling a policy. The policy could be
activated based on a time calendar or security
event including threat level changes.";
leaf name {
type string;
description
"Name of the policy-calendar object.";
}
leaf date {
type yang:date-and-time;
description
"The date when this object was created or
last modified.";
}
leaf enforcement-type {
type enumeration {
enum unknown {
description
"enforcement-type is unknown.";
}
enum admin-enforced {
description
"enforcement-type is ADMIN-ENFORCED.";
}
enum time-enforced {
description
"enforcement-type is TIME-ENFORCED.";
}
enum event-enforced {
description
"enforcement-type is EVENT-ENFORCED.";
}
Jeong, et al. Expires April 5, 2018 [Page 30]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
}
description
"This field identifies whether the policy
enforcement is 'ADMIN-ENFORCED' or
'TIME-ENFORCED', or 'EVENT-ENFORCED'.";
}
leaf time-information {
type string;
description
"This field contains time calendar such as
'BEGIN-TIME' and 'END-TIME' for one time
enforcement or recurring time calendar for
periodic enforcement.";
}
leaf event-map {
type string;
description
"This field contains security events and
threat map in order to determine when a
policy need to be activated.";
}
}
list policy-event {
key "policy-event-id";
description
"This represents the security event of a
policy-rule.";
leaf policy-event-id {
type string;
mandatory true;
description
"This represents the event-id.";
}
leaf security-event {
type string;
description
"This references the security event in the
threat-prevention .";
}
leaf threat-map {
type string;
description
"This references the threat-map in the
threat-prevention.";
}
leaf enable {
Jeong, et al. Expires April 5, 2018 [Page 31]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
type boolean;
description
"This determines whether the condition
matches the security event or not.";
}
}
list condition {
key "condition-id";
description
"This represents the condition of a
policy-rule.";
leaf condition-id {
type string;
description
"This represents the condition-id.";
}
leaf condition-type {
type string;
description
"this is the type of the condition.";
}
list service {
key "service-id";
description
"this represents the list of services.";
leaf service-id {
type uint16;
description
"The id of the service.";
}
leaf name {
type string;
description
"The action name.";
}
}
list traffic {
key "traffic-id";
description
"this represents the network traffic.";
leaf traffic-id {
type uint16;
description
"The id of the traffic.";
}
leaf traffic-threshold {
type uint16;
description
Jeong, et al. Expires April 5, 2018 [Page 32]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
"The threshold for the traffic.";
}
list webfilter {
key "webfilter-id";
description
"this represents the webfilter-id.";
leaf webfilter-id {
type uint16;
description
"The id of the webfilter.";
}
leaf webfilter-name {
type string;
description
"The name of the webfilter.";
}
leaf webfilter-url {
type string;
description
"url of the web that action is going to
be performed upon.";
}
list Firewall {
key "firewall-id";
description
"this represents the firewall-id.";
leaf firewall-id {
type uint16;
description
"The id of the firewall.";
}
leaf firewall-name {
type string;
description
"The name of the firewall.";
}
leaf firewall-type {
type string;
description
"the type of a firewall (blacklist/whitelist)";
}
leaf firewall-address {
type string;
description
"the address that action is going to
be performed upon.";
}
}
Jeong, et al. Expires April 5, 2018 [Page 33]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
list policy-action {
key "policy-action-id";
leaf policy-action-id {
type string;
mandatory true;
description
"this represents the policy-action-id.";
}
description
"This object represents actions that a
Security Admin wants to perform based on
a certain traffic class.";
leaf name {
type string;
description
"The name of the policy-action object.";
}
leaf date {
type yang:date-and-time;
description
"When the object was created or last
modified.";
}
leaf primary-action {
type string;
description
"This field identifies the action when a rule
is matched by NSF. The action could be one of
'PERMIT', 'DENY', 'RATE-LIMIT', 'TRAFFIC-CLASS',
'AUTHENTICATE-SESSION', 'IPS, 'APP-FIREWALL', etc.";
}
leaf secondary-action {
type string;
description
"This field identifies additional actions if
a rule is matched. This could be one of 'LOG',
'SYSLOG', 'SESSION-LOG', etc.";
}
}
list policy-rule {
key "policy-rule-id";
leaf policy-rule-id {
type string;
mandatory true;
Jeong, et al. Expires April 5, 2018 [Page 34]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
description
"this represents the policy-rule-id";
}
description
"This object represents rules that a
Security Admin want to define in order
to express its business objectives in
a Security Policy.";
leaf name {
type string;
description
"This field identifies the name of
this object.";
}
leaf date {
type yang:date-and-time;
description
"When the object was created or last
modified.";
}
leaf source {
type leafref {
path "/ietf-i2nsf-consumer-facing-interface/
threat-prevention/threat-feed/threat-feed-id";
}
description
"This field identifies the source of
the traffic. This could be reference to
either 'Policy Endpoint Group' or
'Threat-Feed' or 'Custom-List' if Security
Admin wants to specify the source; otherwise,
the default is to match all traffic.";
}
leaf destination {
type leafref {
path "/ietf-i2nsf-consumer-facing-interface/
policy-endpoint-groups/user-group/user-group-id";
}
description
"This field identifies the destination of
the traffic. This could be reference to
either 'Policy Endpoint Group' or
'Threat-Feed' or 'Custom-List' if Security
Admin wants to specify the destination;
otherwise, the default is to match all
Jeong, et al. Expires April 5, 2018 [Page 35]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
traffic.";
}
leaf exception {
type string;
description
"This field identifies the exception
consideration when 'Source' and
'Destination' are matched for a given
communication. This should be reference
to 'Policy Endpoint Group' object.";
}
leaf action {
type string;
description
"This field identifies the action taken
when 'Source' and 'Destination' are matched
for a given communication.";
}
leaf precedence {
type uint8;
description
"This field identifies the precedence
assigned to this rule by Security Admin.
This is helpful in conflict resolution
when two or more rules match a given
traffic class.";
}
}
list policy-instance {
key "policy-instance-id";
leaf policy-instance-id {
type string;
mandatory true;
description
"this represents the policy-instance-id";
}
description
"This object represents a mechanism to
express a Security Policy by Security Admin
to Security Controller via Consumer-Facing
Interface. The policy would be enforced by
an NSF.";
leaf name {
type string;
Jeong, et al. Expires April 5, 2018 [Page 36]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
description
"This field identifies the name of this
object.";
}
leaf date {
type yang:date-and-time;
description
"Date this object was created or last
modified.";
}
leaf-list rules {
type leafref {
path "/ietf-i2nsf-consumer-facing-interface/
security-policy-instance/policy-rule/policy-rule-id";
}
description
"This field contains a list of rules.
If the rule does not have a user-defined
precedence, then any conflict must be
manually resolved.";
}
leaf scheduling-type {
type enumeration {
enum unknown {
description
"scheduling-type is unknown.";
}
enum time-calendar {
description
"scheduling-type is time-calendar.";
}
enum event-map {
description
"scheduling-type is event-map.";
}
}
description
"This field specifies when this policy
should be scheduled. The policy could be
scheduled based on time calendar or
event-map.";
}
leaf scheduling-information {
type leafref {
Jeong, et al. Expires April 5, 2018 [Page 37]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
path "/ietf-i2nsf-consumer-facing-interface
/security-policy-instance/policy-calendar
/policy-calendar-id";
}
description
"This field contains either the 'Calendar'
or 'Event-map' based on 'Schedule type'.";
}
leaf owner {
type string;
description
"This field defines the owner of this
policy. Only the owner is authorized to
modify the contents of the policy.";
}
}
}
}
}
<CODE ENDS>
Figure 2: YANG for cf_interface
6. Security Considerations
The data model for the I2NSF Consumer-Facing Interface is derived
from the I2NSF Consumer-Facing Interface Information Model
[client-facing-inf-im], so the same security considerations with the
information model should be included in this document. The data
model needs to support a mechanism to protect Consumer-Facing
Interface to Security Controller.
7. Acknowledgements
This work was supported by Institute for Information & communications
Technology Promotion(IITP) grant funded by the Korea government(MSIP)
(No.R-20160222-002755, Cloud based Security Intelligence Technology
Development for the Customized Security Service Provisioning).
This document has greatly benefited from inputs by Hyoungshick Kim,
Hoon Ko, Mahdi F. Dachmehchi, Seungjin Lee, Jinyong Tim Kim, and
Daeyoung Hyun.
8. References
Jeong, et al. Expires April 5, 2018 [Page 38]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
8.1. Normative References
[RFC3444] Pras, A., "On the Difference between
Information Models and Data Models",
RFC 3444, January 2003.
8.2. Informative References
[i2nsf-framework] Lopez, D., Lopez, E., Dunbar, L., Strassner,
J., and R. Kumar, "Framework for Interface
to Network Security Functions",
draft-ietf-i2nsf-framework-07 (work in
progress), August 2017.
[client-facing-inf-req] Kumar, R., Lohiya, A., Qi, D., Bitar, N.,
Palislamovic, S., and L. Xia, "Requirements
for Client-Facing Interface to Security
Controller", draft-ietf-i2nsf-client-facing-
interface-req-03 (work in progress),
July 2017.
[client-facing-inf-im] Kumar, R., Lohiya, A., Qi, D., Bitar, N.,
Palislamovic, S., and L. Xia, "Information
model for Client-Facing Interface to
Security Controller", draft-kumar-i2nsf-
client-facing-interface-im-03 (work in
progress), July 2017.
[i2nsf-terminology] Hares, S., Strassner, J., Lopez, D., Xia,
L., and H. Birkholz, "Information model for
Client-Facing Interface to Security
Controller", draft-ietf-i2nsf-terminology-04
(work in progress), July 2017.
[RFC6020] Bjorklund, M., "YANG - A Data Modeling
Language for the Network Configuration
Protocol (NETCONF)", RFC 6020, October 2010.
Appendix A. Changes from
draft-jeong-i2nsf-consumer-facing-interface-dm-03
The following changes have been made from
draft-jeong-i2nsf-consumer-facing-interface-dm-03:
o Sections 4 and 5 have been revised to produce a data tree model
and a YANG data model according to the information model suggested
in the draft about the I2NSF Consumer-Facing Interface Information
Model in [client-facing-inf-im] and Event-Condition-Action (ECA)
Jeong, et al. Expires April 5, 2018 [Page 39]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
based policy generation as suggested in the I2NSF Framework
[i2nsf-framework].
o The description for the use case scenario of VoIP/VoLTE security
service have been added in Appendix B.
o The data tree model in Appendix B and a YANG data model in
Appendix C have also been modified for ECA-based policy
generation.
o An example XML output has been added in Appendix D for VoIP
service policy.
o Editorial errors have been corrected.
Appendix B. Use Case: Policy Instance Example for VoIP/VoLTE Security
Services
A common scenario for VoIP/VoLTE policy enforcement could be that a
malicious call is made to a benign user of any telecommunication
company. For example, imagine a case wherea company "A" employs a
hacker with a malicious attempt to hack a user's phone with malware.
The company "A" is located in a country, such as Africa, and uses the
user's hacked phone to call the company. The hacked user is unaware
of the company "A" so complains about the international call that was
made to the company "B", which is the user's telecommunications
company. The company "A" charges the company "B" for the
international call. The company "B" cannot charge the user for the
call, and has no choice but to pay the company "A". The following
shows the example data tree model for the VoIP/VoLTE services.
Multi-tenancy, endpoint groups, threat prevention, and telemetry data
components are general part of the tree model, so we can just modify
the policy instance in order to generate and enforce high-level
policies. The policy-calendar can act as a scheduler to set the star
and end time to block calls which uses suspicious ids, or calls from
other countries.
module ietf-i2nsf-cf-interface-policy-instance
+--rw security-policy-instance
+--rw policy-rule* [policy-rule-id]
| +--rw policy-rule-id uint16
| +--rw name? string
| +--rw date? yang:date-and-time
| +--rw source? -> /ietf-i2nsf-cf-interface
| | /threat-prevention
| | /threat-feed
| | /threat-feed-id
| +--rw destination? -> /ietf-i2nsf-cf-interface
Jeong, et al. Expires April 5, 2018 [Page 40]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
| | /policy-endpoint-groups
| | /user-group
| | /user-group-id
| +--rw exception? boolean
| +--rw exception-detail? string
+--rw action* [action-id]
| +--rw action-id uint16
| +--rw name? string
| +--rw date? yang:date-and-time
| +--rw primary-action? string
| +--rw secondary-action? string
+--rw precedence* [precedence-id]
| +--rw precedence-id uint16
| +--rw rule-exist? boolean
+--rw event* [event-id]
| +--rw event-id uint16
| +--rw security-event? string
| +--rw threat-map? string
| +--rw enable? boolean
+--rw condition* [condition-id]
| +--rw condition-id uint16
| +--rw service* [service-id] uint16
| +--rw service-name string
| +--rw service-type string
|
+--rw policy-calendar* [policy-calendar-id]
| +--rw policy-calendar-id uint16
| +--rw name? string
| +--rw date? yang:date-and-time
| +--rw enforcement-type? string
| +--rw begin-time? yang:date-and-time
| +--rw end-time? yang:date-and-time
+--rw policy-instance* [policy-instance-id]
+--rw policy-instance-id string
+--rw name? string
+--rw date? yang:date-and-time
+--rw rules? -> /ietf-i2nsf-cf-interface
| /security-policy-instance
| /policy-rule
| /policy-rule-id
+--rw scheduling? -> /ietf-i2nsf-cf-interface
| /security-policy-instance
| /policy-calendar
| /policy-calendar-id
+--rw owner? string
Figure 3: Policy Instance Example for VoIP/VoLTE Security Services
Jeong, et al. Expires April 5, 2018 [Page 41]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
Appendix C. Policy Instance YANG Example for VoIP/VoLTE Security
Services
The following YANG data model is a policy instance for VoIP/VoLTE
security services. The policy-calendar can act as a scheduler to set
the start time and end time to block malicious calls which use
suspicious IDs or calls from other countries.
<CODE BEGINS> file "ietf-i2nsf-cf-interface-voip.yang"
module ietf-i2nsf-cf-interface-voip{
namespace
"urn:ietf:params:xml:ns:yang:ietf-i2nsf-cf-interface-voip";
prefix
cf-interface;
import ietf-inet-types{
prefix inet;
}
import ietf-yang-types{
prefix yang;
}
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: Jaehoon Paul Jeong
<mailto:pauljeong@skku.edu>";
description
"This module defines a YANG data module for consumer-facing
interface to security controller.";
revision "2017-10-02"{
description "The first version";
reference
Jeong, et al. Expires April 5, 2018 [Page 42]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
"draft-kumar-i2nsf-client-facing-interface-im-03";
}
//Groupings
container security-policy-instance {
description
"this describes the policy instances.";
list policy-rule {
key "policy-rule-id";
description
"This represents the policy-rule of a
policy instance.";
leaf policy-rule-id {
type uint16;
description
"policy rule id.";
}
leaf name {
type string;
description
"Name of the policy-rule.";
}
leaf date {
type yang:date-and-time;
description
"The date when the rule was created.";
}
leaf source {
type leafref {
path "/ietf-i2nsf-consumer-facing-interface/
threat-prevention/threat-feed/threat-feed-id";
}
description
"This references either end-point-group,
threat-feed, or custom-list.";
}
leaf destination {
type leafref {
path "/ietf-i2nsf-consumer-facing-interface/
policy-endpoint-groups/user-group/user-group-id";
}
description
Jeong, et al. Expires April 5, 2018 [Page 43]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
"This references either end-point-group,
threat-feed, or custom-list.";
}
leaf exception {
type boolean;
description
"This describes whether an exception has
occurred or not.";
}
leaf exception-detail{
type string;
description
"This includes detailed information about
source and destination of
an exception.";
}
}
list action {
key "action-id";
description
"This represents the action of a policy-rule.";
leaf action-id {
type string;
mandatory true;
description
"This represents the action-id of a policy-rule.";
}
leaf name {
type string;
description
"The action name.";
}
leaf date {
type yang:date-and-time;
description
"When the action was taken.";
}
leaf primary-action {
type string;
description
"This includes actions such as drop, forward,
mirror, advanced action and etc.";
}
leaf secondary-action {
Jeong, et al. Expires April 5, 2018 [Page 44]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
type string;
description
"This includes optional actions such as
logging, system logging and session logging.";
}
}
list precedence {
key "precedence-id";
description
"This describes whether there is a preceeding
rule and causes problems.";
leaf precedence-id{
type string;
mandatory true;
description
"This represent the precedence-id of
a policy-rule.";
}
leaf rule-exist {
type boolean;
description
"This determines whether there is a preceeding.";
}
}
list event {
key "event-id";
description
"This represents the security event of a
policy-rule.";
leaf event-id {
type string;
mandatory true;
description
"This represents the event-id.";
}
leaf security-event {
type string;
description
"This references the security event in the
threat-prevention .";
}
leaf threat-map {
type string;
description
"This references the threat-map in the
threat-prevention.";
}
leaf enable {
Jeong, et al. Expires April 5, 2018 [Page 45]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
type boolean;
description
"This determines whether the condition
matches the security event or not.";
}
}
list condition {
key "condition-id";
description
"This represents the condition of a
policy-rule.";
leaf condition-id {
type string;
description
"This represents the condition-id.";
}
list service {
key "service-id";
description
"this represents the list of services.";
leaf service-id {
type uint16;
description
"The id of the service.";
}
leaf name {
type string;
description
"The action name.";
}
}
list caller {
key "caller-id";
description
"this represents the list of callers.";
leaf caller-id {
type uint16;
description
"The id of the caller.";
}
leaf caller-id-ip{
type inet:ipv4-address;
description
"The ip of the caller.";
}
leaf caller-country {
type string;
description
Jeong, et al. Expires April 5, 2018 [Page 46]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
"This determines the country of the caller.";
}
leaf caller-city {
type string;
description
"This determines the city of the caller.";
}
}
list callee {
key "callee-id";
description
"this represents the list of callees";
leaf callee-id {
type uint16;
description
"The id of the callee.";
}
leaf callee-id-ip {
type inet:ipv4-address;
description
"The callee's ip address.";
}
leaf callee-country {
type string;
description
"This determines the country of the callee.";
}
leaf callee-city {
type string;
description
"This determines the city of the callee.";
}
}
}
list policy-calendar {
key "policy-calendar-id";
description
"this represents the policy calendar list.";
leaf policy-calendar-id {
type uint16;
description
"The id of the policy calendar.";
}
leaf name {
type string;
description
"The name of the policy-calendar.";
Jeong, et al. Expires April 5, 2018 [Page 47]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
}
leaf date {
type yang:date-and-time;
description
"The date when this calender was
created or last modified.";
}
leaf enforcement-type {
type string;
description
"Whether the policy enforcement is
admin-enforced, time-enforced, or
event-enforced.";
}
leaf begin-time {
type yang:date-and-time;
description
"The starting time for blocking
suspicious calls.";
}
leaf end-time {
type yang:date-and-time;
description
"The time when blocking ends.";
}
}
}
}
<CODE ENDS>
Figure 4: Policy Instance YANG Example for VoIP Security Services
Appendix D. Example XML Output for VoIP Service
In this section, we present an example XML output for VoIP service.
Here, we will drop calls commin from a country with an IP address
from South Africa that is classified as malicious.
<?xml version="1.0" encoding="UTF-8"?>
<rpc message-id="1" xmlns="urn:ietf:params:xml:ns:restconf:base:1.0">
<edit-config>
<target>
<running/>
</target>
<config>
<i2nsf-cf-interface-voip-req nc:operation="create">
<policy-instance>
Jeong, et al. Expires April 5, 2018 [Page 48]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
<policy-name>voip-policy-example</policy-name>
<policy-rule>rule_example_1</policy-rule>
<precedence>
<rule-exist>false</rule-exist>
</precedence>
<source>
<policy-tenant>
<policy-tenant-id>01</policy-tenant-id>
</policy-tenant>
</source>
<destination>
<user-group>
<user-group-id>01</user-group-id>
</user-group>
</destination>
<event>
<security-event>voip-call</security-event>
<threat-level>high</threat-level>
<enable>true</enable>
</event>
<condition>
<service>
<service-type>voip</service-type>
</service>
<caller-ip>105.176.0.0</caller-ip>
<caller-country>South-Africa</caller-country>
<callee-ip>192.168.171.35</callee-ip>
<callee-country>South-Korea</callee-country>
</condition>
<actions>
<action-primary>drop</action-primary>
<action-secondary>log<action-secondary>
</actions>
<policy-calendar>
<policy-calendar-id>01</policy-calendar-id>
<begin-time>22:00</begin-time>
<end-time>08:00</end-time>
<enforcement-type>time-enforced</enforcement-type>
</policy-calendar>
</policy-instance>
</i2nsf-cf-interface-voip-req>
</config>
</edit-config>
</rpc>
Figure 5: An Example XML Output for VoIP Service
Jeong, et al. Expires April 5, 2018 [Page 49]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
Authors' Addresses
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
Eunsoo Kim
Department of Electrical and Computer Engineering
Sungkyunkwan University
2066 Seobu-Ro, Jangan-Gu
Suwon, Gyeonggi-Do 16419
Republic of Korea
Phone: +82 31 299 4104
EMail: eskim86@skku.edu
URI: http://seclab.skku.edu/people/eunsoo-kim/
Tae-Jin Ahn
Korea Telecom
70 Yuseong-Ro, Yuseong-Gu
Daejeon 305-811
Republic of Korea
Phone: +82 42 870 8409
EMail: taejin.ahn@kt.com
Rakesh Kumar
Juniper Networks
1133 Innovation Way
Sunnyvale, CA 94089
USA
Phone:
EMail: rkkumar@juniper.net
Jeong, et al. Expires April 5, 2018 [Page 50]
Internet-Draft Consumer-Facing Interface YANG Data Model October 2017
Susan Hares
Huawei
7453 Hickory Hill
Saline, MI 48176
USA
Phone: +1-734-604-0332
EMail: shares@ndzh.com
Jeong, et al. Expires April 5, 2018 [Page 51]