path: root/doc/rfc/rfc7408.txt

Internet Engineering Task Force (IETF)                     E. Haleplidis
Request for Comments: 7408                          University of Patras
Updates: 5812                                              November 2014
Category: Standards Track
ISSN: 2070-1721


   Forwarding and Control Element Separation (ForCES) Model Extension

Abstract

   This memo extends the Forwarding and Control Element Separation
   (ForCES) model defined in RFC 5812 and updates that RFC to allow
   complex data types for metadata, optional default values for data
   types, and optional access types for structures.  It also fixes an
   issue with Logical Functional Block (LFB) inheritance and introduces
   two new features: a new event condition called eventBecomesEqualTo
   and LFB properties.  The changes introduced in this memo do not alter
   the protocol and retain backward compatibility with older LFB models.

Status of This Memo

   This is an Internet Standards Track document.

   This document is a product of the Internet Engineering Task Force
   (IETF).  It represents the consensus of the IETF community.  It has
   received public review and has been approved for publication by the
   Internet Engineering Steering Group (IESG).  Further information on
   Internet Standards is available in Section 2 of RFC 5741.

   Information about the current status of this document, any errata,
   and how to provide feedback on it may be obtained at
   http://www.rfc-editor.org/info/rfc7408.

Copyright Notice

   Copyright (c) 2014 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.



Haleplidis                   Standards Track                    [Page 1]
^L
RFC 7408                 ForCES Model Extension            November 2014


Table of Contents

   1. Introduction ....................................................2
      1.1. Requirements Language ......................................3
      1.2. Terminology ................................................3
   2. ForCES Model Extensions .........................................3
      2.1. Complex Data Types for Metadata ............................3
      2.2. Optional Default Values for Data Types .....................5
      2.3. Optional Access Types for Structs ..........................8
      2.4. New Event Condition: eventBecomesEqualTo ..................11
      2.5. LFB Properties ............................................12
      2.6. LFB Class Inheritance .....................................14
      2.7. Enhancing XML Validation ..................................15
   3. XML Extension Schema for LFB Class Library Documents ...........15
   4. IANA Considerations ............................................29
   5. Security Considerations ........................................29
   6. References .....................................................30
      6.1. Normative References ......................................30
      6.2. Informative References ....................................30
   Acknowledgements ..................................................31
   Author's Address ..................................................31

1.  Introduction

   The ForCES model [RFC5812] presents a formal way to define Forwarding
   Element (FE) Logical Functional Blocks (LFBs) using the eXtensible
   Markup Language (XML).  [RFC5812] was published several years before
   this document, and experience with its use has demonstrated the need
   to add new modeling concepts and change existing ones.

   Specifically, this document updates the ForCES model [RFC5812] to
   allow complex data types for metadata (Section 2.1), optional default
   values for data types (Section 2.2), and optional access types for
   structures (Section 2.3).  It also fixes an issue with LFB class
   inheritance (Section 2.6).  Additionally, the document introduces two
   new features: a new event condition named eventBecomesEqualTo
   (Section 2.4) and LFB properties (Section 2.5).

   These extensions are an update to the ForCES model [RFC5812] and do
   not require any changes to the ForCES protocol [RFC5810] as they are
   simply changes to the schema definition.  Additionally, backward
   compatibility is ensured as XML libraries produced with the earlier
   schema are still valid with the new one.  In order for XML libraries
   produced by the new schema to be compatible with existing ForCES
   implementations, the XML libraries MUST NOT include any of the
   features described in this document.





Haleplidis                   Standards Track                    [Page 2]
^L
RFC 7408                 ForCES Model Extension            November 2014


   Extensions to the schema and excerpts of the schema include the tags
   <!-- Extension RFC 7408 --> and <!-- /Extension RFC 7408 -->, which
   designate the beginning and ending of extension text specified by
   this document in respect to the schema in the original ForCES model
   [RFC5812].

1.1.  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].

1.2.  Terminology

   This document uses the terminology defined in the ForCES model
   [RFC5812].  In particular, the reader is expected to be familiar with
   the following terms:

      FE Model

      LFB (Logical Functional Block) Class (or type)

      LFB Instance

      LFB Model

      Element

      Attribute

      LFB Metadata

      ForCES Component

      LFB Class Library

2.  ForCES Model Extensions

2.1.  Complex Data Types for Metadata

   Section 4.6 ("<metadataDefs> Element for Metadata Definitions") of
   the ForCES model [RFC5812] limits the data type use in metadata to
   only atomic types.  Figure 1 shows the XML schema excerpt where only
   typeRef and atomic are allowed for a metadata definition.







Haleplidis                   Standards Track                    [Page 3]
^L
RFC 7408                 ForCES Model Extension            November 2014


     <xsd:complexType name="metadataDefsType">
       <xsd:sequence>
         <xsd:element name="metadataDef" maxOccurs="unbounded">
           <xsd:complexType>
             <xsd:sequence>
               <xsd:element name="name" type="xsd:NMTOKEN"/>
               <xsd:element ref="synopsis"/>
               <xsd:element name="metadataID" type="xsd:integer"/>
               <xsd:element ref="description" minOccurs="0"/>
               <xsd:choice>
                 <xsd:element name="typeRef" type="typeRefNMTOKEN"/>
                 <xsd:element name="atomic" type="atomicType"/>
               </xsd:choice>
             </xsd:sequence>
           </xsd:complexType>
         </xsd:element>
       </xsd:sequence>
     </xsd:complexType>

        Figure 1: Initial metadataDefsType Definition in the Schema

   However, there are cases where complex metadata are used in the
   datapath: for example, two simple use cases are described in version
   1.1.0 (and subsequent versions) of the OpenFlow Switch Specification
   [OpenFlowSpec1.1]:

   1.  The Action Set metadata is an array of actions descriptors, which
       traverses the processing pipeline along with the packet data.

   2.  When a packet is received from a controller, it may be
       accompanied by a list of actions, as metadata, to be performed on
       it prior to being sent on the processing pipeline.  This list of
       actions is also an array.

   With the extension shown in Figure 2, complex data types are also
   allowed, specifically structs and arrays as metadata.  The key
   declarations are required to check for validity of content keys in
   arrays and componentIDs in structs.













Haleplidis                   Standards Track                    [Page 4]
^L
RFC 7408                 ForCES Model Extension            November 2014


     <xsd:complexType name="metadataDefsType">
       <xsd:sequence>
         <xsd:element name="metadataDef" maxOccurs="unbounded">
           <xsd:complexType>
             <xsd:sequence>
               <xsd:element name="name" type="xsd:NMTOKEN"/>
               <xsd:element ref="synopsis"/>
               <xsd:element name="metadataID" type="xsd:integer"/>
               <xsd:element ref="description" minOccurs="0"/>
               <xsd:choice>
                 <xsd:element name="typeRef" type="typeRefNMTOKEN"/>
                 <xsd:element name="atomic" type="atomicType"/>
                 <!-- Extension RFC 7408 -->
                 <xsd:element name="array" type="arrayType">
                   <xsd:key name="contentKeyID1">
                     <xsd:selector xpath="lfb:contentKey"/>
                     <xsd:field xpath="@contentKeyID"/>
                   </xsd:key>
                 </xsd:element>
                 <xsd:element name="struct" type="structType">
                   <xsd:key name="structComponentID1">
                     <xsd:selector xpath="lfb:component"/>
                     <xsd:field xpath="@componentID"/>
                   </xsd:key>
                 </xsd:element>
                 <!-- /Extension RFC 7408 -->
               </xsd:choice>
             </xsd:sequence>
           </xsd:complexType>
         </xsd:element>
       </xsd:sequence>
     </xsd:complexType>

          Figure 2: New metadataDefsType Definition in the Schema

2.2.  Optional Default Values for Data Types

   In the original schema, default values can only be defined for data
   types defined inside LFB components and not inside structures or
   arrays.  Therefore, default values for data types that are constantly
   being reused, e.g., counters with default value of 0, have to be
   constantly respecified.  Additionally, data types inside complex data
   types cannot be defined with a default value, e.g., a counter inside
   a struct that has a default value of 0.

   This extension allows the option to add default values to data types.
   These data types can then be referenced as simple components or
   within complex data types such as structs.  A simple use case would



Haleplidis                   Standards Track                    [Page 5]
^L
RFC 7408                 ForCES Model Extension            November 2014


   be to have a struct component where one of the components is a
   counter with a default value of zero.  To achieve that, the counter
   must first be defined as a data type with the required default value
   and then referenced in the struct.  Default values MUST adhere the
   following formal restrictions:

   1.  Default values MUST be ignored if the data type is not an atomic
       or a base data type.

   2.  When a data type X with default value A is referenced from a data
       type Y with a default value B, the default value of the data type
       that references overrides the referenced default value, e.g., in
       this case, Y's default value will be B.

   3.  Default values of LFB components override any default value
       specified from the dataTypeDef definition.

   4.  Default values of data types referenced in capabilities or
       metadata MUST be ignored.

   This extension simply adds to the definition of dataTypeDefsType in
   the XML schema shown in Figure 3 to allow default values for
   dataTypeDefsType.  The new definition is shown in Figure 4.

     <xsd:complexType name="dataTypeDefsType">
       <xsd:sequence>
         <xsd:element name="dataTypeDef" maxOccurs="unbounded">
           <xsd:complexType>
             <xsd:sequence>
               <xsd:element name="name" type="xsd:NMTOKEN"/>
               <xsd:element name="derivedFrom" type="xsd:NMTOKEN"
                  minOccurs="0"/>
               <xsd:element ref="synopsis"/>
               <xsd:element ref="description" minOccurs="0"/>
               <xsd:group ref="typeDeclarationGroup"/>
             </xsd:sequence>
           </xsd:complexType>
         </xsd:element>
       </xsd:sequence>
     </xsd:complexType>

      Figure 3: Initial Excerpt of dataTypeDefsType Definition in the
                                  Schema








Haleplidis                   Standards Track                    [Page 6]
^L
RFC 7408                 ForCES Model Extension            November 2014


     <xsd:complexType name="dataTypeDefsType">
       <xsd:sequence>
         <xsd:element name="dataTypeDef" maxOccurs="unbounded">
           <xsd:complexType>
             <xsd:sequence>
               <xsd:element name="name" type="xsd:NMTOKEN"/>
               <xsd:element name="derivedFrom" type="xsd:NMTOKEN"
                  minOccurs="0"/>
               <xsd:element ref="synopsis"/>
               <xsd:element ref="description" minOccurs="0"/>
               <xsd:group ref="typeDeclarationGroup"/>
               <!-- Extension RFC 7408 -->
               <xsd:element name="defaultValue" type="xsd:token"
                  minOccurs="0"/>
               <!-- /Extension RFC 7408 -->
             </xsd:sequence>
           </xsd:complexType>
         </xsd:element>
       </xsd:sequence>
     </xsd:complexType>

    Figure 4: New Excerpt of dataTypeDefsType Definition in the Schema





























Haleplidis                   Standards Track                    [Page 7]
^L
RFC 7408                 ForCES Model Extension            November 2014


   Examples of using default values is depicted in Figure 5.

     <dataTypeDef>
       <name>ZeroCounter</name>
       <synopsis>A counter with default 0</synopsis>
       <typeRef>uint32</typeRef>
       <defaultValue>0</defaultValue>
     </dataTypeDef>
     <dataTypeDef>
       <name>CounterValues</name>
       <synopsis>Example default values in struct</synopsis>
       <struct>
         <component componentID="1">
           <name>GoodPacketCounter</name>
           <synopsis>A counter for good packets</synopsis>
           <typeRef>ZeroCounter</typeRef>
         </component>
         <component componentID="2">
           <name>BadPacketCounter</name>
           <synopsis>A counter for bad packets</synopsis>
           <typeRef>ZeroCounter</typeRef>
         </component>
       </struct>
     </dataTypeDef>

               Figure 5: Example of Optional Default Values

2.3.  Optional Access Types for Structs

   In the original schema, the access type can only be defined on
   components of an LFB and not on components within structs or arrays.
   That means that when it is a struct data type, it is not possible to
   fine-tune access type per component within the struct.  A simple use
   case would be to have a read-write struct component where one of the
   components is a counter with an access type that could be read-reset
   or read-only, e.g., a read-reset or a read-only counter inside a
   struct.

   This extension allows the definition of the access type for a struct
   component either in the data type definitions or in the LFB component
   definitions.

   When optional access types for components within a struct are
   defined, the access types for these components MUST override the
   access type of the struct.  For example, if a struct has an access
   type of read-write but has a component that is a read-only counter,
   the counter's access type MUST be read-only.




Haleplidis                   Standards Track                    [Page 8]
^L
RFC 7408                 ForCES Model Extension            November 2014


   Per [RFC5812], the access type for a component in a capability is
   always read-only.  If an access type is provided for a component in a
   capability, the access type MUST be ignored.  Similarly, if an access
   type is provided for a struct in a metadata, the access type MUST be
   ignored.

   This extension alters the definition of the struct in the XML schema
   from the initial definition shown in Figure 6 to the new shown in
   Figure 7.

     <xsd:complexType name="structType">
       <xsd:sequence>
         <xsd:element name="derivedFrom" type="typeRefNMTOKEN"
           minOccurs="0"/>
         <xsd:element name="component" maxOccurs="unbounded">
           <xsd:complexType>
             <xsd:sequence>
               <xsd:element name="name" type="xsd:NMTOKEN"/>
               <xsd:element ref="synopsis"/>
               <xsd:element ref="description" minOccurs="0"/>
               <xsd:element name="optional" minOccurs="0"/>
               <xsd:group ref="typeDeclarationGroup"/>
             </xsd:sequence>
             <xsd:attribute name="componentID" type="xsd:unsignedInt"
              use="required"/>
           </xsd:complexType>
         </xsd:element>
       </xsd:sequence>
     </xsd:complexType>

       Figure 6: Initial XML for the Struct Definition in the Schema




















Haleplidis                   Standards Track                    [Page 9]
^L
RFC 7408                 ForCES Model Extension            November 2014


     <xsd:complexType name="structType">
       <xsd:sequence>
         <xsd:element name="derivedFrom" type="typeRefNMTOKEN"
           minOccurs="0"/>
         <xsd:element name="component" maxOccurs="unbounded">
           <xsd:complexType>
             <xsd:sequence>
               <xsd:element name="name" type="xsd:NMTOKEN"/>
               <xsd:element ref="synopsis"/>
               <xsd:element ref="description" minOccurs="0"/>
               <xsd:element name="optional" minOccurs="0"/>
               <xsd:group ref="typeDeclarationGroup"/>
             </xsd:sequence>
             <!-- Extension RFC 7408 -->
             <xsd:attribute name="access" use="optional"
               default="read-write">
               <xsd:simpleType>
                 <xsd:list itemType="accessModeType"/>
               </xsd:simpleType>
             </xsd:attribute>
             <!-- /Extension RFC 7408 -->
             <xsd:attribute name="componentID" type="xsd:unsignedInt"
               use="required"/>
           </xsd:complexType>
         </xsd:element>
       </xsd:sequence>
     </xsd:complexType>

         Figure 7: New XML for the Struct Definition in the Schema






















Haleplidis                   Standards Track                   [Page 10]
^L
RFC 7408                 ForCES Model Extension            November 2014


   An example of using optional access types for structs is depicted in
   Figure 8.

      <component componentID="1" access="read-write">
         <name>PacketFlows</name>
         <synopsis>Packet Flows, match and counter</synopsis>
         <struct>
          <component componentID="1">
            <name>FlowMatch</name>
            <synopsis>Flow Match</synopsis>
            <typeRef>MatchType</typeRef>
          </component>
          <component componentID="2" access="read-only">
            <name>MatchCounter</name>
            <synopsis>Packets matching the flow match</synopsis>
            <typeRef>ZeroCounter</typeRef>
          </component>
        </struct>
      </component>

           Figure 8: Example of Optional Access Types for Struct

2.4.  New Event Condition: eventBecomesEqualTo

   This extension adds one more event condition in the model schema,
   eventBecomesEqualTo.  eventBecomesEqualTo is different from
   eventGreaterThan and eventLessThan because the event is triggered
   when the value is exactly that of the eventBecomesEqualTo threshold.
   This event condition is particularly useful when there is a need to
   monitor one or more states of an LFB or the FE.  For example, in the
   Control Element High Availability (CEHA) document [RFC7121], it may
   be useful for the master CE to know which backup CEs have just become
   associated in order to connect to them and begin synchronizing the
   state of the FE.  The master CE could always poll for such
   information, but getting such an event will speed up the process, and
   the event may be useful in other cases as well for monitoring state.

   The event MUST be triggered only when the value of the targeted
   component becomes equal to the event condition value.
   Implementations MUST NOT generate subsequent events while the
   targeted component's value remains equal to the event condition's
   value.









Haleplidis                   Standards Track                   [Page 11]
^L
RFC 7408                 ForCES Model Extension            November 2014


   eventBecomesEqualTo is appended to the schema as shown in Figure 9.

     <xsd:element name="eventBecomesEqualTo"
       substitutionGroup="eventCondition"/>

       Figure 9: New Excerpt of eventBecomesEqualTo Event Condition
                         Definition in the Schema

   It can become useful for the CE to be notified when the state has
   changed once the eventBecomesEqualTo event has been triggered, e.g.,
   the CE may need to know when a backup CE has lost association.  Such
   an event can be generated either by defining a second event on the
   same component (namely, an eventChanged) or by simply reusing
   eventBecomesEqualTo and using event properties (in particular,
   eventHysteresis).  We append the following definition to the
   eventHysteresis defined in Section 4.8.5.2 of [RFC5812], with V being
   the hysteresis value:

   o  For an eventBecomesEqualTo condition, after the last notification,
      a new eventBecomesEqualTo notification MUST be generated only one
      time once the value has changed by +/- V.

   For example, using the value of 1 for V will, in effect, create a
   singular event that will notify the CE that the value has changed by
   at least 1.

   A developer of a CE should consider using count or time filtering to
   avoid being overrun by messages, e.g., in the case of rapid state
   changes.

2.5.  LFB Properties

   The previous model definition specifies properties for components of
   LFBs.  Experience has shown that, at least for debug reasons, it
   would be useful to have statistics per LFB instance to monitor sent
   and received messages and errors in communication between a CE and
   FE.  These properties are read-only.

   In order to avoid ambiguity on protocol path semantics, this document
   specifies that the LFB componentID 0 specifically MUST refer to LFB
   properties and ID 0 MUST NOT be used for any component definition.
   This disallowance is backward compatible as no known LFB definition
   uses an LFB componentID 0.  Any command with a path starting from LFB
   componentID 0 refers to LFB properties.  Figures 10 and 11 illustrate
   the change in the XML schema that disallows usage of LFB componentID
   0:





Haleplidis                   Standards Track                   [Page 12]
^L
RFC 7408                 ForCES Model Extension            November 2014


      <xsd:attribute name="componentID" type="xsd:unsignedInt"
       use="required">

                Figure 10: Initial XML for LFB componentIDs

      <!-- Extension added restriction to componentID -->
      <xsd:attribute name="componentID" use="required">
        <xsd:simpleType>
          <xsd:restriction base="xsd:unsignedInt">
            <xsd:minExclusive value="0"/>
          </xsd:restriction>
        </xsd:simpleType>
      </xsd:attribute>
      <!-- End of extension -->

         Figure 11: New XML to Disallow Usage of LFB componentID 0

   The following data type definitions are to be used as properties for
   LFB instances.

      <dataTypeDef>
         <name>LFBProperties</name>
         <synopsis>LFB Properties definition</synopsis>
         <struct>
            <component componentID="1">
               <name>PacketsSentToCE</name>
               <synopsis>Packets sent to CE</synopsis>
               <typeRef>uint32</typeRef>
            </component>
            <component componentID="2">
               <name>SentErrorPacketsToCE</name>
               <synopsis>Error Packets sent to CE</synopsis>
               <typeRef>uint32</typeRef>
            </component>
            <component componentID="3">
               <name>BytesSentToCE</name>
               <synopsis>Bytes sent to CE</synopsis>
               <typeRef>uint32</typeRef>
            </component>
            <component componentID="4">
               <name>SentErrorBytesToCE</name>
               <synopsis>Error Bytes sent to CE</synopsis>
               <typeRef>uint32</typeRef>
            </component>
            <component componentID="5">
               <name>PacketsReceivedFromCE</name>
               <synopsis>Packets received from CE</synopsis>
               <typeRef>uint32</typeRef>



Haleplidis                   Standards Track                   [Page 13]
^L
RFC 7408                 ForCES Model Extension            November 2014


            </component>
            <component componentID="6">
               <name>ReceivedErrorPacketsFromCE</name>
               <synopsis>Error Packets received from CE</synopsis>
               <typeRef>uint32</typeRef>
            </component>
            <component componentID="7">
               <name>BytesReceivedFromCE</name>
               <synopsis>Bytes received from CE</synopsis>
               <typeRef>uint32</typeRef>
            </component>
            <component componentID="8">
               <name>ReceivedErrorBytesFromCE</name>
               <synopsis>Error Bytes received from CE</synopsis>
               <typeRef>uint32</typeRef>
            </component>
         </struct>
      </dataTypeDef>

                  Figure 12: Properties for LFB Instances

2.6.  LFB Class Inheritance

   The ForCES model [RFC5812] allows inheritance for LFB classes.
   However, the XML schema defines only the LFB class from which an LFB
   class inherits.  Recent implementations have identified an issue
   where ambiguity rises when different versions of the parent LFB class
   exist.  This document augments the derivedFrom part of the LFB class
   definition with an optional version attribute when the derivedFrom
   field is used.

   Having the version attribute as optional was a decision based on the
   need to maintain backward compatibility with the XML schema defined
   in [RFC5812].  However, if the version is omitted, then derivedFrom
   will always specify the first version of the parent LFB class, which
   usually is version 1.0.

   This extension alters the definition of derivedFrom in the XML schema
   from the initial definition shown in Figure 13 to the new shown in
   Figure 14.

      <xsd:element name="derivedFrom" minOccurs="0"/>

             Figure 13: Initial XML for LFB Class Inheritance







Haleplidis                   Standards Track                   [Page 14]
^L
RFC 7408                 ForCES Model Extension            November 2014


      <xsd:element name="derivedFrom" minOccurs="0">
        <xsd:complexType>
          <xsd:simpleContent>
            <xsd:extension base="xsd:NMTOKEN">
              <xsd:attribute name="version"
                type="versionType" use="optional"/>
            </xsd:extension>
          </xsd:simpleContent>
        </xsd:complexType>
      </xsd:element>

               Figure 14: New XML for LFB Class Inheritance

   An example of the use of the version attribute is given in Figure 15.

      <derivedFrom version="1.0">EtherPHYCop</derivedFrom>

      Figure 15: Example of Use of New XML for LFB Class Inheritance

2.7.  Enhancing XML Validation

   As specified earlier, this is not an extension but an enhancement of
   the schema to provide additional validation rules.  This includes
   adding new key declarations to provide uniqueness as defined by the
   ForCES model [RFC5812].  Such validations work only within the same
   XML file.

   This document introduces the following validation rules that did not
   exist in the original schema in [RFC5812]:

   1.  Each metadataID must be unique.

   2.  LFBClassIDs must be unique.

   3.  componentID, capabilityID, and Event baseID must be unique per
       LFB.

   4.  eventIDs must be unique per LFB.

   5.  Special values in atomic data types must be unique per atomic
       data type.

3.  XML Extension Schema for LFB Class Library Documents

   This section includes the new XML schema.  Note that the namespace
   number has been updated from 1.0 to 1.1.





Haleplidis                   Standards Track                   [Page 15]
^L
RFC 7408                 ForCES Model Extension            November 2014


   The extensions described in this document are backwards compatible in
   terms of the operation of the ForCES protocol.  In terms of the XML,
   any definitions that were valid under the old namespace are valid
   under the new namespace.  It is to be noted that any auxiliary tools
   that are processing XML definitions written under both namespaces
   will need to be able to understand both.

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
   xmlns="urn:ietf:params:xml:ns:forces:lfbmodel:1.1"
   xmlns:lfb="urn:ietf:params:xml:ns:forces:lfbmodel:1.1"
   targetNamespace="urn:ietf:params:xml:ns:forces:lfbmodel:1.1"
   elementFormDefault="qualified" attributeFormDefault="unqualified">
   <xsd:annotation>
      <xsd:documentation xml:lang="en">
         Schema for Defining LFB Classes and associated types
         (frames, data types for LFB attributes, and metadata).
      </xsd:documentation>
   </xsd:annotation>
   <xsd:element name="description" type="xsd:string"/>
   <xsd:element name="synopsis" type="xsd:string"/>
   <!-- Document root element: LFBLibrary -->
   <xsd:element name="LFBLibrary">
      <xsd:complexType>
         <xsd:sequence>
            <xsd:element ref="description" minOccurs="0"/>
            <xsd:element name="load" type="loadType"
               minOccurs="0" maxOccurs="unbounded"/>
            <xsd:element name="frameDefs" type="frameDefsType"
               minOccurs="0"/>
            <xsd:element name="dataTypeDefs" type="dataTypeDefsType"
               minOccurs="0"/>
            <xsd:element name="metadataDefs" type="metadataDefsType"
               minOccurs="0"/>
            <xsd:element name="LFBClassDefs" type="LFBClassDefsType"
               minOccurs="0"/>
         </xsd:sequence>
         <xsd:attribute name="provides" type="xsd:Name"
            use="required"/>
      </xsd:complexType>
      <!-- Uniqueness constraints -->
      <xsd:key name="frame">
         <xsd:selector xpath="lfb:frameDefs/lfb:frameDef"/>
         <xsd:field xpath="lfb:name"/>
      </xsd:key>
      <xsd:key name="dataType">
         <xsd:selector xpath="lfb:dataTypeDefs/lfb:dataTypeDef"/>
         <xsd:field xpath="lfb:name"/>



Haleplidis                   Standards Track                   [Page 16]
^L
RFC 7408                 ForCES Model Extension            November 2014


      </xsd:key>
      <xsd:key name="metadataDef">
         <xsd:selector xpath="lfb:metadataDefs/lfb:metadataDef"/>
         <xsd:field xpath="lfb:name"/>
      </xsd:key>
      <xsd:key name="metadataDefID">
         <xsd:selector xpath="lfb:metadataDefs/lfb:metadataDef"/>
         <xsd:field xpath="lfb:metadataID"/>
      </xsd:key>
      <xsd:key name="LFBClassDef">
         <xsd:selector xpath="lfb:LFBClassDefs/lfb:LFBClassDef"/>
         <xsd:field xpath="lfb:name"/>
      </xsd:key>
      <xsd:key name="LFBClassDefID">
         <xsd:selector xpath="lfb:LFBClassDefs/lfb:LFBClassDef"/>
         <xsd:field xpath="@LFBClassID"/>
      </xsd:key>
   </xsd:element>
   <xsd:complexType name="loadType">
      <xsd:attribute name="library" type="xsd:Name" use="required"/>
      <xsd:attribute name="location" type="xsd:anyURI"
         use="optional"/>
   </xsd:complexType>
   <xsd:complexType name="frameDefsType">
      <xsd:sequence>
         <xsd:element name="frameDef" maxOccurs="unbounded">
            <xsd:complexType>
               <xsd:sequence>
                  <xsd:element name="name" type="xsd:NMTOKEN"/>
                  <xsd:element ref="synopsis"/>
                  <xsd:element ref="description"
                     minOccurs="0"/>
               </xsd:sequence>
            </xsd:complexType>
         </xsd:element>
      </xsd:sequence>
   </xsd:complexType>
   <xsd:complexType name="dataTypeDefsType">
      <xsd:sequence>
         <xsd:element name="dataTypeDef" maxOccurs="unbounded">
            <xsd:complexType>
               <xsd:sequence>
                  <xsd:element name="name" type="xsd:NMTOKEN"/>
                  <xsd:element name="derivedFrom" type="xsd:NMTOKEN"
                     minOccurs="0"/>
                  <xsd:element ref="synopsis"/>
                  <xsd:element ref="description"
                     minOccurs="0"/>



Haleplidis                   Standards Track                   [Page 17]
^L
RFC 7408                 ForCES Model Extension            November 2014


                  <xsd:group ref="typeDeclarationGroup"/>
                  <!-- Extension RFC 7408 -->
                  <xsd:element name="defaultValue" type="xsd:token"
                     minOccurs="0"/>
                  <!-- /Extension RFC 7408 -->
               </xsd:sequence>
            </xsd:complexType>
         </xsd:element>
      </xsd:sequence>
   </xsd:complexType>
   <!-- Predefined (built-in) atomic data-types are: char, uchar,
   int16, uint16, int32, uint32, int64, uint64, string[N], string,
   byte[N], boolean, octetstring[N], float32, float64 -->
   <xsd:group name="typeDeclarationGroup">
      <xsd:choice>
         <xsd:element name="typeRef" type="typeRefNMTOKEN"/>
         <xsd:element name="atomic" type="atomicType"/>
         <xsd:element name="array" type="arrayType">
            <!-- Extension RFC 7408 -->
            <!-- declare keys to have unique IDs -->
            <xsd:key name="contentKeyID">
               <xsd:selector xpath="lfb:contentKey"/>
               <xsd:field xpath="@contentKeyID"/>
            </xsd:key>
            <!-- /Extension RFC 7408 -->
         </xsd:element>
         <xsd:element name="struct" type="structType">
            <!-- Extension RFC 7408 -->
            <!-- key declaration to make componentIDs
              unique in a struct -->
            <xsd:key name="structComponentID">
               <xsd:selector xpath="lfb:component"/>
               <xsd:field xpath="@componentID"/>
            </xsd:key>
            <!-- /Extension RFC 7408 -->
         </xsd:element>
         <xsd:element name="union" type="structType"/>
         <xsd:element name="alias" type="typeRefNMTOKEN"/>
      </xsd:choice>
   </xsd:group>
   <xsd:simpleType name="typeRefNMTOKEN">
      <xsd:restriction base="xsd:token">
         <xsd:pattern value="\c+"/>
         <xsd:pattern value="string\[\d+\]"/>
         <xsd:pattern value="byte\[\d+\]"/>
         <xsd:pattern value="octetstring\[\d+\]"/>
      </xsd:restriction>
   </xsd:simpleType>



Haleplidis                   Standards Track                   [Page 18]
^L
RFC 7408                 ForCES Model Extension            November 2014


   <xsd:complexType name="atomicType">
      <xsd:sequence>
         <xsd:element name="baseType" type="typeRefNMTOKEN"/>
         <xsd:element name="rangeRestriction"
           type="rangeRestrictionType" minOccurs="0"/>
         <xsd:element name="specialValues" type="specialValuesType"
            minOccurs="0">
            <!-- Extension RFC 7408 -->
            <xsd:key name="SpecialValue">
               <xsd:selector xpath="specialValue"/>
               <xsd:field xpath="@value"/>
            </xsd:key>
            <!-- /Extension RFC 7408 -->
         </xsd:element>
      </xsd:sequence>
   </xsd:complexType>
   <xsd:complexType name="rangeRestrictionType">
      <xsd:sequence>
         <xsd:element name="allowedRange" maxOccurs="unbounded">
            <xsd:complexType>
               <xsd:attribute name="min" type="xsd:integer"
                  use="required"/>
               <xsd:attribute name="max" type="xsd:integer"
                  use="required"/>
            </xsd:complexType>
         </xsd:element>
      </xsd:sequence>
   </xsd:complexType>
   <xsd:complexType name="specialValuesType">
      <xsd:sequence>
         <xsd:element name="specialValue" maxOccurs="unbounded">
            <xsd:complexType>
               <xsd:sequence>
                  <xsd:element name="name" type="xsd:NMTOKEN"/>
                  <xsd:element ref="synopsis"/>
               </xsd:sequence>
               <xsd:attribute name="value" type="xsd:token"/>
            </xsd:complexType>
         </xsd:element>
      </xsd:sequence>
   </xsd:complexType>
   <xsd:complexType name="arrayType">
      <xsd:sequence>
         <xsd:group ref="typeDeclarationGroup"/>
         <xsd:element name="contentKey" minOccurs="0"
            maxOccurs="unbounded">
            <xsd:complexType>
               <xsd:sequence>



Haleplidis                   Standards Track                   [Page 19]
^L
RFC 7408                 ForCES Model Extension            November 2014


                  <xsd:element name="contentKeyField"
                     type="xsd:string" maxOccurs="unbounded"/>
               </xsd:sequence>
               <xsd:attribute name="contentKeyID" type="xsd:integer"
                  use="required"/>
            </xsd:complexType>
         </xsd:element>
      </xsd:sequence>
      <xsd:attribute name="type" use="optional" default="variable-size">
         <xsd:simpleType>
            <xsd:restriction base="xsd:string">
               <xsd:enumeration value="fixed-size"/>
               <xsd:enumeration value="variable-size"/>
            </xsd:restriction>
         </xsd:simpleType>
      </xsd:attribute>
      <xsd:attribute name="length" type="xsd:integer"
         use="optional"/>
      <xsd:attribute name="maxLength" type="xsd:integer"
         use="optional"/>
   </xsd:complexType>
   <xsd:complexType name="structType">
      <xsd:sequence>
         <xsd:element name="derivedFrom" type="typeRefNMTOKEN"
            minOccurs="0"/>
         <xsd:element name="component" maxOccurs="unbounded">
            <xsd:complexType>
               <xsd:sequence>
                  <xsd:element name="name" type="xsd:NMTOKEN"/>
                  <xsd:element ref="synopsis"/>
                  <xsd:element ref="description"
                     minOccurs="0"/>
                  <xsd:element name="optional" minOccurs="0"/>
                  <xsd:group ref="typeDeclarationGroup"/>
               </xsd:sequence>
               <!-- Extension RFC 7408 -->
               <xsd:attribute name="access" use="optional"
                  default="read-write">
                  <xsd:simpleType>
                     <xsd:list itemType="accessModeType"/>
                  </xsd:simpleType>
               </xsd:attribute>
               <!-- Extension RFC 7408 -->
               <xsd:attribute name="componentID" type="xsd:unsignedInt"
                  use="required"/>
            </xsd:complexType>
         </xsd:element>
      </xsd:sequence>



Haleplidis                   Standards Track                   [Page 20]
^L
RFC 7408                 ForCES Model Extension            November 2014


   </xsd:complexType>
   <xsd:complexType name="metadataDefsType">
      <xsd:sequence>
         <xsd:element name="metadataDef" maxOccurs="unbounded">
            <xsd:complexType>
               <xsd:sequence>
                  <xsd:element name="name" type="xsd:NMTOKEN"/>
                  <xsd:element ref="synopsis"/>
                  <xsd:element name="metadataID" type="xsd:integer"/>
                  <xsd:element ref="description"
                     minOccurs="0"/>
                  <xsd:choice>
                     <xsd:element name="typeRef" type="typeRefNMTOKEN"/>
                     <xsd:element name="atomic" type="atomicType"/>
                     <!-- Extension RFC 7408 -->
                     <xsd:element name="array" type="arrayType">
                        <!--declare keys to have unique IDs -->
                        <xsd:key name="contentKeyID1">
                           <xsd:selector xpath="lfb:contentKey"/>
                           <xsd:field xpath="@contentKeyID"/>
                        </xsd:key>
                        <!-- /Extension RFC 7408 -->
                     </xsd:element>
                     <xsd:element name="struct" type="structType">
                        <!-- Extension RFC 7408 -->
                        <!-- key declaration to make componentIDs
                           unique in a struct -->
                        <xsd:key name="structComponentID1">
                           <xsd:selector xpath="lfb:component"/>
                           <xsd:field xpath="@componentID"/>
                        </xsd:key>
                        <!-- /Extension RFC 7408 -->
                     </xsd:element>
                  </xsd:choice>
               </xsd:sequence>
            </xsd:complexType>
         </xsd:element>
      </xsd:sequence>
   </xsd:complexType>
   <xsd:complexType name="LFBClassDefsType">
      <xsd:sequence>
         <xsd:element name="LFBClassDef" maxOccurs="unbounded">
            <xsd:complexType>
               <xsd:sequence>
                  <xsd:element name="name" type="xsd:NMTOKEN"/>
                  <xsd:element ref="synopsis"/>
                  <xsd:element name="version" type="versionType"/>
                  <xsd:element name="derivedFrom" minOccurs="0">



Haleplidis                   Standards Track                   [Page 21]
^L
RFC 7408                 ForCES Model Extension            November 2014


                    <xsd:complexType>
                      <xsd:simpleContent>
                        <xsd:extension base="xsd:NMTOKEN">
                          <xsd:attribute name="version"
                            type="versionType" use="optional"/>
                        </xsd:extension>
                      </xsd:simpleContent>
                    </xsd:complexType>
                  </xsd:element>
                  <xsd:element name="inputPorts"
                   type="inputPortsType" minOccurs="0"/>
                  <xsd:element name="outputPorts"
                   type="outputPortsType" minOccurs="0"/>
                  <xsd:element name="components"
                   type="LFBComponentsType" minOccurs="0"/>
                  <xsd:element name="capabilities"
                   type="LFBCapabilitiesType" minOccurs="0"/>
                  <xsd:element name="events" type="eventsType"
                     minOccurs="0"/>
                  <xsd:element ref="description"
                     minOccurs="0"/>
               </xsd:sequence>
               <xsd:attribute name="LFBClassID" type="xsd:unsignedInt"
                  use="required"/>
            </xsd:complexType>
            <!-- Key constraint to ensure unique attribute names
            within a class: -->
            <xsd:key name="components">
               <xsd:selector xpath="lfb:components/lfb:component"/>
               <xsd:field xpath="lfb:name"/>
            </xsd:key>
            <xsd:key name="capabilities">
               <xsd:selector xpath="lfb:capabilities/lfb:capability"/>
               <xsd:field xpath="lfb:name"/>
            </xsd:key>
            <xsd:key name="events">
               <xsd:selector xpath="lfb:events/lfb:event"/>
               <xsd:field xpath="lfb:name"/>
            </xsd:key>
            <xsd:key name="eventsIDs">
               <xsd:selector xpath="lfb:events/lfb:event"/>
               <xsd:field xpath="@eventID"/>
            </xsd:key>
            <xsd:key name="componentIDs">
               <xsd:selector xpath="lfb:components/lfb:component"/>
               <xsd:field xpath="@componentID"/>
            </xsd:key>
            <xsd:key name="capabilityIDs">



Haleplidis                   Standards Track                   [Page 22]
^L
RFC 7408                 ForCES Model Extension            November 2014


               <xsd:selector xpath="lfb:capabilities/lfb:capability"/>
               <xsd:field xpath="@componentID"/>
            </xsd:key>
            <xsd:key name="ComponentCapabilityComponentIDUniqueness">
               <xsd:selector
                  xpath="lfb:components/lfb:component|
                  lfb:capabilities/lfb:capability|lfb:events"/>
               <xsd:field xpath="@componentID|@baseID"/>
            </xsd:key>
         </xsd:element>
      </xsd:sequence>
   </xsd:complexType>
   <xsd:simpleType name="versionType">
      <xsd:restriction base="xsd:NMTOKEN">
         <xsd:pattern value="[1-9][0-9]*\.([1-9][0-9]*|0)"/>
      </xsd:restriction>
   </xsd:simpleType>
   <xsd:complexType name="inputPortsType">
      <xsd:sequence>
         <xsd:element name="inputPort" type="inputPortType"
            maxOccurs="unbounded"/>
      </xsd:sequence>
   </xsd:complexType>
   <xsd:complexType name="inputPortType">
      <xsd:sequence>
         <xsd:element name="name" type="xsd:NMTOKEN"/>
         <xsd:element ref="synopsis"/>
         <xsd:element name="expectation" type="portExpectationType"/>
         <xsd:element ref="description" minOccurs="0"/>
      </xsd:sequence>
      <xsd:attribute name="group" type="xsd:boolean"
         use="optional" default="0"/>
   </xsd:complexType>
   <xsd:complexType name="portExpectationType">
      <xsd:sequence>
         <xsd:element name="frameExpected" minOccurs="0">
            <xsd:complexType>
               <xsd:sequence>
                  <!-- ref must refer to a name of a defined
                    frame type -->
                  <xsd:element name="ref" type="xsd:string"
                     maxOccurs="unbounded"/>
               </xsd:sequence>
            </xsd:complexType>
         </xsd:element>
         <xsd:element name="metadataExpected" minOccurs="0">
            <xsd:complexType>
               <xsd:choice maxOccurs="unbounded">



Haleplidis                   Standards Track                   [Page 23]
^L
RFC 7408                 ForCES Model Extension            November 2014


                  <!--ref must refer to a name of a defined metadata-->
                  <xsd:element name="ref" type="metadataInputRefType"/>
                  <xsd:element name="one-of"
                     type="metadataInputChoiceType"/>
               </xsd:choice>
            </xsd:complexType>
         </xsd:element>
      </xsd:sequence>
   </xsd:complexType>
   <xsd:complexType name="metadataInputChoiceType">
      <xsd:choice minOccurs="2" maxOccurs="unbounded">
         <!-- ref must refer to a name of a defined metadata -->
         <xsd:element name="ref" type="xsd:NMTOKEN"/>
         <xsd:element name="one-of" type="metadataInputChoiceType"/>
         <xsd:element name="metadataSet" type="metadataInputSetType"/>
      </xsd:choice>
   </xsd:complexType>
   <xsd:complexType name="metadataInputSetType">
      <xsd:choice minOccurs="2" maxOccurs="unbounded">
         <!-- ref must refer to a name of a defined metadata -->
         <xsd:element name="ref" type="metadataInputRefType"/>
         <xsd:element name="one-of" type="metadataInputChoiceType"/>
      </xsd:choice>
   </xsd:complexType>
   <xsd:complexType name="metadataInputRefType">
      <xsd:simpleContent>
         <xsd:extension base="xsd:NMTOKEN">
            <xsd:attribute name="dependency" use="optional"
               default="required">
               <xsd:simpleType>
                  <xsd:restriction base="xsd:string">
                     <xsd:enumeration value="required"/>
                     <xsd:enumeration value="optional"/>
                  </xsd:restriction>
               </xsd:simpleType>
            </xsd:attribute>
            <xsd:attribute name="defaultValue" type="xsd:token"
               use="optional"/>
         </xsd:extension>
      </xsd:simpleContent>
   </xsd:complexType>
   <xsd:complexType name="outputPortsType">
      <xsd:sequence>
         <xsd:element name="outputPort" type="outputPortType"
            maxOccurs="unbounded"/>
      </xsd:sequence>
   </xsd:complexType>
   <xsd:complexType name="outputPortType">



Haleplidis                   Standards Track                   [Page 24]
^L
RFC 7408                 ForCES Model Extension            November 2014


      <xsd:sequence>
         <xsd:element name="name" type="xsd:NMTOKEN"/>
         <xsd:element ref="synopsis"/>
         <xsd:element name="product" type="portProductType"/>
         <xsd:element ref="description" minOccurs="0"/>
      </xsd:sequence>
      <xsd:attribute name="group" type="xsd:boolean"
         use="optional" default="0"/>
   </xsd:complexType>
   <xsd:complexType name="portProductType">
      <xsd:sequence>
         <xsd:element name="frameProduced" minOccurs="0">
            <xsd:complexType>
               <xsd:sequence>
                  <!-- ref must refer to a name of a defined
                     frame type -->
                  <xsd:element name="ref" type="xsd:NMTOKEN"
                     maxOccurs="unbounded"/>
               </xsd:sequence>
            </xsd:complexType>
         </xsd:element>
         <xsd:element name="metadataProduced" minOccurs="0">
            <xsd:complexType>
               <xsd:choice maxOccurs="unbounded">
                  <!-- ref must refer to a name of a
                     defined metadata -->
                  <xsd:element name="ref"
                     type="metadataOutputRefType"/>
                  <xsd:element name="one-of"
                     type="metadataOutputChoiceType"/>
               </xsd:choice>
            </xsd:complexType>
         </xsd:element>
      </xsd:sequence>
   </xsd:complexType>
   <xsd:complexType name="metadataOutputChoiceType">
      <xsd:choice minOccurs="2" maxOccurs="unbounded">
         <!-- ref must refer to a name of a defined metadata -->
         <xsd:element name="ref" type="xsd:NMTOKEN"/>
         <xsd:element name="one-of" type="metadataOutputChoiceType"/>
         <xsd:element name="metadataSet" type="metadataOutputSetType"/>
      </xsd:choice>
   </xsd:complexType>
   <xsd:complexType name="metadataOutputSetType">
      <xsd:choice minOccurs="2" maxOccurs="unbounded">
         <!-- ref must refer to a name of a defined metadata -->
         <xsd:element name="ref" type="metadataOutputRefType"/>
         <xsd:element name="one-of" type="metadataOutputChoiceType"/>



Haleplidis                   Standards Track                   [Page 25]
^L
RFC 7408                 ForCES Model Extension            November 2014


      </xsd:choice>
   </xsd:complexType>
   <xsd:complexType name="metadataOutputRefType">
      <xsd:simpleContent>
         <xsd:extension base="xsd:NMTOKEN">
            <xsd:attribute name="availability" use="optional"
               default="unconditional">
               <xsd:simpleType>
                  <xsd:restriction base="xsd:string">
                     <xsd:enumeration value="unconditional"/>
                     <xsd:enumeration value="conditional"/>
                  </xsd:restriction>
               </xsd:simpleType>
            </xsd:attribute>
         </xsd:extension>
      </xsd:simpleContent>
   </xsd:complexType>
   <xsd:complexType name="LFBComponentsType">
      <xsd:sequence>
         <xsd:element name="component" maxOccurs="unbounded">
            <xsd:complexType>
               <xsd:sequence>
                  <xsd:element name="name" type="xsd:NMTOKEN"/>
                  <xsd:element ref="synopsis"/>
                  <xsd:element ref="description"
                     minOccurs="0"/>
                  <xsd:element name="optional" minOccurs="0"/>
                  <xsd:group ref="typeDeclarationGroup"/>
                  <xsd:element name="defaultValue" type="xsd:token"
                     minOccurs="0"/>
               </xsd:sequence>
               <xsd:attribute name="access" use="optional"
                  default="read-write">
                  <xsd:simpleType>
                     <xsd:list itemType="accessModeType"/>
                  </xsd:simpleType>
               </xsd:attribute>
               <!-- Extension added restriction to componentID -->
               <xsd:attribute name="componentID" use="required">
                  <xsd:simpleType>
                     <xsd:restriction base="xsd:unsignedInt">
                        <xsd:minExclusive value="0"/>
                     </xsd:restriction>
                  </xsd:simpleType>
               </xsd:attribute>
               <!-- End of extension -->
            </xsd:complexType>
         </xsd:element>



Haleplidis                   Standards Track                   [Page 26]
^L
RFC 7408                 ForCES Model Extension            November 2014


      </xsd:sequence>
   </xsd:complexType>
   <xsd:simpleType name="accessModeType">
      <xsd:restriction base="xsd:NMTOKEN">
         <xsd:enumeration value="read-only"/>
         <xsd:enumeration value="read-write"/>
         <xsd:enumeration value="write-only"/>
         <xsd:enumeration value="read-reset"/>
         <xsd:enumeration value="trigger-only"/>
      </xsd:restriction>
   </xsd:simpleType>
   <xsd:complexType name="LFBCapabilitiesType">
      <xsd:sequence>
         <xsd:element name="capability" maxOccurs="unbounded">
            <xsd:complexType>
               <xsd:sequence>
                  <xsd:element name="name" type="xsd:NMTOKEN"/>
                  <xsd:element ref="synopsis"/>
                  <xsd:element ref="description"
                     minOccurs="0"/>
                  <xsd:element name="optional" minOccurs="0"/>
                  <xsd:group ref="typeDeclarationGroup"/>
               </xsd:sequence>
               <xsd:attribute name="componentID" type="xsd:integer"
                  use="required"/>
            </xsd:complexType>
         </xsd:element>
      </xsd:sequence>
   </xsd:complexType>
   <xsd:complexType name="eventsType">
      <xsd:sequence>
         <xsd:element name="event" maxOccurs="unbounded">
            <xsd:complexType>
               <xsd:sequence>
                  <xsd:element name="name" type="xsd:NMTOKEN"/>
                  <xsd:element ref="synopsis"/>
                  <xsd:element name="eventTarget"
                    type="eventPathType"/>
                  <xsd:element ref="eventCondition"/>
                  <xsd:element name="eventReports"
                   type="eventReportsType" minOccurs="0"/>
                  <xsd:element ref="description"
                     minOccurs="0"/>
               </xsd:sequence>
               <xsd:attribute name="eventID" type="xsd:integer"
                  use="required"/>
            </xsd:complexType>
         </xsd:element>



Haleplidis                   Standards Track                   [Page 27]
^L
RFC 7408                 ForCES Model Extension            November 2014


      </xsd:sequence>
      <xsd:attribute name="baseID" type="xsd:integer"
         use="optional"/>
   </xsd:complexType>
   <!-- the substitution group for the event conditions -->
   <xsd:element name="eventCondition" abstract="true"/>
   <xsd:element name="eventCreated"
    substitutionGroup="eventCondition"/>
   <xsd:element name="eventDeleted"
    substitutionGroup="eventCondition"/>
   <xsd:element name="eventChanged"
    substitutionGroup="eventCondition"/>
   <xsd:element name="eventGreaterThan"
    substitutionGroup="eventCondition"/>
   <xsd:element name="eventLessThan"
    substitutionGroup="eventCondition"/>
   <!-- Extension RFC 7408 -->
   <xsd:element name="eventBecomesEqualTo"
      substitutionGroup="eventCondition"/>
   <!-- /Extension RFC 7408 -->
   <xsd:complexType name="eventPathType">
      <xsd:sequence>
         <xsd:element ref="eventPathPart" maxOccurs="unbounded"/>
      </xsd:sequence>
   </xsd:complexType>
   <!-- the substitution group for the event path parts -->
   <xsd:element name="eventPathPart" type="xsd:string"
      abstract="true"/>
   <xsd:element name="eventField" type="xsd:string"
      substitutionGroup="eventPathPart"/>
   <xsd:element name="eventSubscript" type="xsd:string"
      substitutionGroup="eventPathPart"/>
   <xsd:complexType name="eventReportsType">
      <xsd:sequence>
         <xsd:element name="eventReport" type="eventPathType"
            maxOccurs="unbounded"/>
      </xsd:sequence>
   </xsd:complexType>
   <xsd:simpleType name="booleanType">
      <xsd:restriction base="xsd:string">
         <xsd:enumeration value="0"/>
         <xsd:enumeration value="1"/>
      </xsd:restriction>
   </xsd:simpleType>
</xsd:schema>

                           ForCES LFB XML Schema




Haleplidis                   Standards Track                   [Page 28]
^L
RFC 7408                 ForCES Model Extension            November 2014


4.  IANA Considerations

   IANA has registered a new XML namespace, as per the guidelines in RFC
   3688 [RFC3688].

   URI: The URI for this namespace is:

      urn:ietf:params:xml:ns:forces:lfbmodel:1.1

   Registrant Contact: IESG

   XML: none, this is an XML namespace

5.  Security Considerations

   This specification adds only a few constructs to the initial model
   defined in [RFC5812], namely, a new event, some new properties, and a
   way to define optional access types and complex metadata.  In
   addition, this document addresses and clarifies an issue with the
   inheritance model by introducing the version of the derivedFrom LFB
   class.  These constructs and the update to the inheritance model do
   not change the nature of the initial model.

   Thus, the security considerations defined in [RFC5812] apply to this
   specification as well, as the changes proposed here are simply
   constructs to write XML library definitions, as [RFC5812] does.
   These changes, as well as the clarification of the inheritance issue
   of the initial model, have no effect on the security semantics of the
   protocol.

   In regard to pervasive monitoring (PM), as discussed in [RFC7258],
   this specification defines ways to expose more complex information
   (namely, metadata) exchanged between LFBs and between CEs and FEs and
   a new event.  These changes have very little or no effect in terms of
   making PM simpler or more effective to an attacker who controls the
   LFBs.  The new metadata might make for slightly more elegant PM, but
   does not enable any new ways to (ab)use LFBs for PM.  The same
   applies for the new event.

   Finally, this document does not provide any protocol specification
   and, as such, does not specify how information will be transmitted
   between respective entities.  Thus, PM mitigation for a passive
   attacker that simply wants to eavesdrop on the information exchanged
   is out of the scope of this document.







Haleplidis                   Standards Track                   [Page 29]
^L
RFC 7408                 ForCES Model Extension            November 2014


6.  References

6.1.  Normative References

   [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
              Requirement Levels", BCP 14, RFC 2119, March 1997,
              <http://www.rfc-editor.org/info/rfc2119>.

   [RFC3688]  Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
              January 2004, <http://www.rfc-editor.org/info/rfc3688>.

   [RFC5810]  Doria, A., Hadi Salim, J., Haas, R., Khosravi, H., Wang,
              W., Dong, L., Gopal, R., and J. Halpern, "Forwarding and
              Control Element Separation (ForCES) Protocol
              Specification", RFC 5810, March 2010,
              <http://www.rfc-editor.org/info/rfc5810>.

   [RFC5812]  Halpern, J. and J. Hadi Salim, "Forwarding and Control
              Element Separation (ForCES) Forwarding Element Model", RFC
              5812, March 2010,
              <http://www.rfc-editor.org/info/rfc5812>.

   [RFC7121]  Ogawa, K., Wang, W., Haleplidis, E., and J. Hadi Salim,
              "High Availability within a Forwarding and Control Element
              Separation (ForCES) Network Element", RFC 7121, February
              2014, <http://www.rfc-editor.org/info/rfc7121>.

   [RFC7258]  Farrell, S. and H. Tschofenig, "Pervasive Monitoring Is an
              Attack", BCP 188, RFC 7258, May 2014,
              <http://www.rfc-editor.org/info/rfc7258>.

6.2.  Informative References

   [OpenFlowSpec1.1]
              ONF, "OpenFlow Switch Specification", February 2011,
              <https://www.opennetworking.org/images/stories/downloads/
              sdn-resources/onf-specifications/openflow/
              openflow-spec-v1.1.0.pdf>.













Haleplidis                   Standards Track                   [Page 30]
^L
RFC 7408                 ForCES Model Extension            November 2014


Acknowledgements

   The author would like to acknowledge Joel Halpern, Jamal Hadi Salim,
   and Dave Hood for their comments and discussion that helped shape
   this document for the better.  Special acknowledgements to Joel
   Halpern for resolving the issue with the default values, Adrian
   Farrel for his AD review, Ben Campbell for his Gen-ART review, and
   Tom Yu for his security review, all of which improved the quality of
   this document.  Additionally, reviews and comments by the following
   members of the IESG shaped the final version of this document:
   Stephen Farrel, Barry Leiba, and Ted Lemon.  Finally, the author
   would like to acknowledge Julian Reschke for input regarding the
   namespace change issue and Joel Halpern for helping to resolve it.

Author's Address

   Evangelos Haleplidis
   University of Patras
   Department of Electrical and Computer Engineering
   Patras  26500
   Greece

   EMail: ehalep@ece.upatras.gr




























Haleplidis                   Standards Track                   [Page 31]
^L