Packages

package root

This is documentation for Mothra, a collection of Scala and Spark library functions for working with Internet-related data.

This is documentation for Mothra, a collection of Scala and Spark library functions for working with Internet-related data. Some modules contain APIs of general use to Scala programmers. Some modules make those tools more useful on Spark data-processing systems.

Please see the documentation for the individual packages for more details on their use.

Scala Packages

These packages are useful in Scala code without involving Spark:

org.cert.netsa.data

This package, which is collected as the netsa-data library, provides types for working with various kinds of information:

org.cert.netsa.data.net - types for working with network data
org.cert.netsa.data.time - types for working with time data
org.cert.netsa.data.unsigned - types for working with unsigned integral values

org.cert.netsa.io.ipfix

The netsa-io-ipfix library provides tools for reading and writing IETF IPFIX data from various connections and files.

org.cert.netsa.io.silk

To read and write CERT NetSA SiLK file formats and configuration files, use the netsa-io-silk library.

org.cert.netsa.util

The "junk drawer" of netsa-util so far provides only two features: First, a method for equipping Scala scala.collection.Iterators with exception handling. And second, a way to query the versions of NetSA libraries present in a JVM at runtime.

Spark Packages

These packages require the use of Apache Spark:

org.cert.netsa.mothra.datasources

Spark datasources for CERT file types. This package contains utility features which add methods to Apache Spark DataFrameReader objects, allowing IPFIX and SiLK flows to be opened using simple spark.read... calls.

The mothra-datasources library contains both IPFIX and SiLK functionality, while mothra-datasources-ipfix and mothra-datasources-silk contain only what's needed for the named datasource.

org.cert.netsa.mothra.analysis

A grab-bag of analysis helper functions and example analyses.

org.cert.netsa.mothra.functions

This single Scala object provides Spark SQL functions for working with network data. It is the entirety of the mothra-functions library.

Definition Classes: root

package org

Definition Classes: root

package cert

Definition Classes: org

package netsa

Definition Classes: cert

package io

Definition Classes: netsa

package ipfix

The ipfix package provides classes and objects for reading and writing IPFIX data.

Class / Object Overview

(For a quick overview of the IPFIX format, see the end of this description.)

The Message trait describes the attributes of an IPFIX message, and the CollectedMessage class and object are implementations of that trait when reading data. (Record export does not create specific Message instance.)

The IpfixSet abstract class and object hold the attributes of a Set. The TemplateSet class may represent a Template Set or an Options Template Set.

The Template class and object are used to represent a Template Record or an Options Template Record.

The IEFieldSpecifier class and object represent a Field Specifier within an existing Template. To search for a field within a Template, the user of the ipfix package creates a FieldSpec (the companion object) and attempts to find it within a Template.

The Field Specifier uses the numeric Identifier to identify an Information Element, and an Element is represented by the InfoElement class and object. The InfoModel class and object represent the Information Model.

To describe the attributes of an InfoElement, several support classes are defined: DataTypes is an enumeration that describes the type of data that the element contains, and DataType is a class that extracts a Field Value with that DataType. IESemantics describes the data semantics of an Information Element (e.g., a counter, an identifier, a set of flags), and IEUnits describes its units.

The Data Set is represented by the RecordSet class and object.

A Data Record is represented by the Record abstract class. This class has three subclasses:

The CollectedRecord class and object are its implementation when reading data. Its members are always referenced by numeric position.
The ArrayRecord (I do not like this name) and object may be used to build a Record from Scala objects; its fields are also referenced by numeric position.
ExportRecord is an abstract class that also supports building a Record from Scala objects. The user extends the class and uses the IPFIXExtract annotation to mark the members of the subclass that are to be used when writing the Record.

A user-defined class that extends Fillable trait may use the Record's fill() method to copy fields from a Record to the user's class. It also uses the IPFIXExtract annotation.

A Structured Data Field Value in a Data Record is represented by the ListElement abstract class. That abstract class has three abstract subclasses, and each of those has two concrete subclasses (one for reading and one for writing):

The BasicList abstract class (object) has subclasses CollectedBasicList and ExportBasicList.
The SubTemplateList abstract class (object) has subclasses CollectedSubTemplateList and ExportSubTemplateList.
The SubTemplateMultiList abstract class (object) has subclasses CollectedSubTemplateMultiList and ExportSubTemplateMultiList.

Reading data

When reading data, a Record instance is returned by a RecordReader. The RecordReader uses a class that extends the MessageReader trait. The ipfix package includes two: ByteBufferMessageReader and StreamMessageReader.

A Session value represent an IPFIX session, which is part of a SessionGroup.

Writing data

For writing data, an instance of an ExportStream must be created using a Session and the destination FileChannel. The user adds Records or Templates to the ExportStream and they are written to the FileChannel.

Overview of IPFIX

An IPFIX stream is composed of Messages. Each Message has a 16-byte Message Header followed by one or more Sets. There are three types of Sets: A Data Set, a Template Set, and an Options Template Set.

Each Set has a 4-byte set header followed by one or more Records. A Data Set contains Data Records and a Template Set contains Template Records.

A Template Record describes the shape of the data that appears in a Data Record. A Template Record contains a 4-byte header followed by zero or more Field Specifiers. Each Field Specifier is either a 4-byte or an 8-byte value that describes a field in the Data Record.

A Field Specifier has two parts. The first is the numeric Information Element Identifier that is defined in an Information Model. The second is the number of octets the field occupies in the Data Record.

A Data Set contains one or more Data Records of the same type, where the type is determined by the Template Record that the Data Set Header refers to. Each Data Record contains one or more Field Values, where the order and length of the Field Values is given by the Template.

A Field Value in a Data Record may be a Structured Data. There are three types of Structured Data:

A Basic List contains one or more instances of a Single Information Element.
A SubTemplateList references a single Template ID, and it contains one or more Records that match that Template.
The SubTemplateMultiList contains a series of Template IDs and Records that match that Template ID.

An IPFIX stream exists in a Transport Session, where a Transport Session is part of a Session Group. All Sessions in a Session Group use the same Transport Protocol, and only differ in the numeric Observation Domain that is part of the Message Header.

Definition Classes: io

package datatype

Definition Classes: ipfix

package testing

Definition Classes: ipfix

package util

Definition Classes: ipfix

ArrayRecord

BasicList

BasicListFieldExtractor

ByteBufferMessageReader

CollectedBasicList

CollectedMessage

CollectedRecord

CollectedSubTemplateList

CollectedSubTemplateMultiList

ExportStreamTemplatesFirst

ExportSubTemplateList

ExportSubTemplateMultiList

IPFIXRuntimeException

Identifier

IllegalBasicListException

IllegalFieldSpecifierException

IllegalInfoElementAttributeException

IllegalListException

IllegalSetException

IllegalSubTemplateListException

IllegalSubTemplateMultiListException

IllegalTemplateRecordException

InvalidIPFIXMessageException

InvalidInfoElementException

MessageTooLongException

NoTemplateException

OutOfTemplateIdsException

SessionMismatchException

TruncatedReadException

org.cert.netsa.io.ipfix

Template

Companion object Template

final class Template extends AnyRef

An IPFIX template that describes the data in a Record.

A template is composed of a sequence of information elements with associated lengths. (The IEFieldSpecifier class bundles the InfoElement and length into a single object.) An element's length in the template may be different than the "natural" length (reduced length encoding), and an element that supports variable-length values may have a fixed size.

If a template has a non-zero scope, the template is an Options Template.

When a Template is added to a Session it is given a unique ID within that Session. A Template may be added to multiple Sessions; there is not necessarily a relationship among the IDs given to a Template in the different Sessions.

Since: 1.3.1 The description is set and fixed at Template creation.

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Template
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def apply(idx: Int): InfoElement
Returns the InfoElement at position idx.
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
def contains(infoElement: InfoElement): Boolean
Returns true if this Template contains the given InfoElement.
Returns true if this Template contains the given InfoElement.
Since
1.3.1
def contains(spec: FieldSpec): Boolean
Returns true if this Template contains an element that matches the given field specifier.
Returns true if this Template contains an element that matches the given field specifier.
Since
1.3.1
def containsAny(ieIterable: Iterable[InfoElement]): Boolean
Returns true if this Template contains *any* of the InfoElements in ieIterable.
Returns true if this Template contains *any* of the InfoElements in ieIterable.
Since
1.3.1
lazy val containsList: Boolean
Indicates whether the template contains at least one structured data element (that is, a BasicList, SubTemplateList, or SubTemplateMultiList).
lazy val containsVarlen: Boolean
Indicates whether the template contains at least one variable-length element.
val description: Option[String]
def elementLength(idx: Int): Int
Returns the length of the element at position idx as specified by the IEFieldSpecifier.
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(other: Any): Boolean
Determines whether two templates are equal.
Determines whether two templates are equal. To be equal, two templates must have the same scope, the same set of elements, the same element order, and all elements must have the same length.
Definition Classes
Template → AnyRef → Any
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hasSameElements(that: Template): Boolean
Determines if two templates have the same set of elements in the same order with the same lengths.
Determines if two templates have the same set of elements in the same order with the same lengths. This method is similar to equals() but it does not consider the scope.
def hashCode(): Int
Definition Classes
Template → AnyRef → Any
def indexOf(infoElement: InfoElement): Int
Returns the position of the first occurrence of the given information element in this Template or returns -1 if the element is not found.
def indexOf(infoElement: InfoElement, from: Int): Int
Returns the position of the given information element in this template occurring at or after from or returns -1 if the element is not found.
def indexOf(spec: FieldSpec): Int
Returns the position of the InfoElement in this Template that matches the given field specifier or returns -1 if the element is not found.
lazy val isInfoElementMetadataTemplate: Boolean
Returns true if this Template is an information element meta-data template.
Returns true if this Template is an information element meta-data template.
An information element meta-data template is used to by records to provide the name, ID, data-type, units, semantics, and range of an information element that is not part of the standard information model. Specifically, the method tests whether the elements informationElementId and informationElementName are present.
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
lazy val isMetadataTemplate: Boolean
Returns true if this Template is a meta-data template.
Returns true if this Template is a meta-data template.
A meta-data template is used to by records that describe an information element or a template.
lazy val isOptionsTemplate: Boolean
Returns true if this Template is an options template.
Returns true if this Template is an options template.
An options template is one whose scope is non-zero.
lazy val isTemplateMetadataTemplate: Boolean
Returns true if this Template is a template meta-data template.
Returns true if this Template is a template meta-data template.
A template meta-data template is used to by records to provide a name and an optional description to a template. Specifically, the method tests whether the elements templateId and templateName are present.
lazy val isWithdrawalTemplate: Boolean
Returns true if this Template is a withdrawal template.
Returns true if this Template is a withdrawal template.
A withdrawal template is one that contains no elements.
def iterator: Iterator[(InfoElement, Int)]
Returns an iterator over the elements in the Template.
Returns an iterator over the elements in the Template. Each iteration returns a Tuple2 containing an InfoElement and its length in this Template.
val minimumLength: Int
Gives the number of octets required to hold the shortest record described by this Template.
val name: Option[String]
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
def octetLength: Int
Returns the number of octets required to write this template definition to an IPFIX stream.
Returns the number of octets required to write this template definition to an IPFIX stream.
See also
minimumLength for the mininum length of a record that uses this template.
val scope: Int
val size: Int
Returns the number of elements in this Template.
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toBuffer(outbuf: ByteBuffer, session: Session): ByteBuffer
Appends the Template to a buffer for writing to an IPFIX stream.
Appends the Template to a buffer for writing to an IPFIX stream. Adds the Template to the Session if necessary.
Exceptions thrown
java.nio.BufferOverflowException if there is not enough room in the buffer for the Template. Because the method makes multiple writes to the buffer, the buffer's position is unknown if an error is thrown.
def toString(expandIEs: Boolean): String
Returns a String describing this Template.
Returns a String describing this Template. If expandIEs is false, includes only the name and element length for each IE in the Template (like toString()). If expandIEs is true, includes a complete description of each IE (including its type, ID, etc).
def toString(): String
Definition Classes
Template → AnyRef → Any
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

Packages

Scala Packages

org.cert.netsa.data

org.cert.netsa.io.ipfix

org.cert.netsa.io.silk

org.cert.netsa.util

Spark Packages

org.cert.netsa.mothra.datasources

org.cert.netsa.mothra.analysis

org.cert.netsa.mothra.functions

Class / Object Overview

Reading data

Writing data

Overview of IPFIX

Template

Companion object Template

final class Template extends AnyRef

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped