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

Record

Companion object Record

abstract class Record extends AnyRef

A Record instance represents an IPFIX data record. Each record contains a set of values which are described by the record's Template.

Each IPFIX data type can be mapped to its Java data type as in the table below:

IPFIX data type ⟶ Scala data type
octetArray ⟶ Seq[Byte]¹
unsigned8 ⟶ Int
unsigned16 ⟶ Int
unsigned32 ⟶ Long
unsigned64 ⟶ Long²
signed8 ⟶ Int
signed16 ⟶ Int
signed32 ⟶ Int
signed64 ⟶ Long
float32 ⟶ Float
float64 ⟶ Double
boolean ⟶ Boolean
macAddress ⟶ Seq[Byte]^1,3
string ⟶ String
dateTimeSeconds ⟶ Instant
dateTimeMilliseconds ⟶ Instant
dateTimeMicroseconds ⟶ Instant
dateTimeNanoseconds ⟶ Instant
ipv4Address ⟶ IPv4Address
ipv6Address ⟶ IPv6Address
basicList ⟶ BasicList
subTemplateList ⟶ SubTemplateList
subTemplateMultiList ⟶ SubTemplateMultiList

¹ The Seq[Byte] returned for octetArray or macAddress is a read-only view on the underlying record data. If you want to save the data without keeping the full record data from being garbage collected, you should copy the Seq.

² Long is signed, so an unsigned64 with its high bit set will appear as negative.

³ The Seq[Byte] returned for a macAddress will always be of length 6.

A record's fields are described by a Template, which may be retrieved from the record using the #template value. Using the data from the template, the user can cast the record's objects to the appropriate Java type.

Alternatively, a record's values can be retrieved in a typed manner using either a FieldExtractor, or a Fillable object. A FieldExtractor acts as a reference to a particular field in a record regardless of the current template of the record. A Fillable object is an object which contains fields that have been marked with the IPFIXExtract annotation. A record's fill() method can be used to "fill in" the object's fields from the record.

See also: FieldExtractor
Fillable
Template

Linear Supertypes

AnyRef, Any

Known Subclasses

ArrayRecord, CollectedRecord, ExportRecord

Ordering

Alphabetic
By Inheritance

Inherited

Record
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new Record(template: Template)
template
The Template that describes this Record.
Attributes
protected

Abstract Value Members

abstract def apply(idx: Int): Any
The value of the field in this record at the given field position within the Template.
The value of the field in this record at the given field position within the Template.
Exceptions thrown
java.lang.IndexOutOfBoundsException if the index is out of range.
abstract def detach(): Record
Modifies the current record so that it carries as little data as necessary to exist by itself.
Modifies the current record so that it carries as little data as necessary to exist by itself. More specifically, it detaches itself from as much of its parent Message's data as possible. If non-complete subsets of Records are going to be kept in memory, they should be detached so they don't carry the memory of any discarded Records by association to their parent Messages.
returns
the record itself (not a new record)
abstract def exportTime: Option[Instant]
Gets the export time of the Message that generated this record as an Option.
Gets the export time of the Message that generated this record as an Option.
returns
The export time of the Message or None if the record represents a list element or was not read from a Message.
abstract def message: Option[Message]
Returns the Message object from which the Record was read as an Option or scala.None if the Record was not read from a Message.
abstract def observationDomain: Option[Int]
Returns the observation domain of the Message that generated this record as an Option or None if the record represents a list element or was not read from a Message.
abstract def octetLength: Int
Gets the number of octets required to write the record to a stream.

Concrete 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
final def allBasicListElements(): Set[InfoElement]
Gets a Set containing the InfoElement used by any basic list on the record and by the record's ListElements.
final def allTemplates(): Set[Template]
Gets a Set containing the Template used by the record and the Templates used by any ListElements in the record.
def apply(ie: InfoElement): Any
The value of the first occurrence of the specified Information Element in this Record.
The value of the first occurrence of the specified Information Element in this Record.
Since
1.3.1
Exceptions thrown
java.lang.IndexOutOfBoundsException if this Record's Template does not contain that Information Element.
def apply(spec: FieldSpec): Any
The value of the field within this record matching the given specification.
The value of the field within this record matching the given specification.
Since
1.3.1
Exceptions thrown
java.lang.IndexOutOfBoundsException if the Template does not contain the FieldSpec.
final def apply[T](extractor: FieldExtractor[T]): Option[T]
Gets the value within the record for the field referenced by the extractor as an Option.
Gets the value within the record for the field referenced by the extractor as an Option.
T
The result type of the extractor.
extractor
A field extractor.
returns
The value for the referenced field, or scala.None if the extractor does not match a field in this record.
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def fields: Iterator[Field]
Returns an Iterator where iteration yields a Field.
final def fill(obj: Fillable): Unit
Fills the fields of obj that are marked with the IPFIXExtract annotation from this record.
Fills the fields of obj that are marked with the IPFIXExtract annotation from this record.
obj
the object to fill
See also
IPFIXExtract
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
def formatted: String
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
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()
final lazy val size: Int
Gets the number of fields in the record.
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
final val template: Template
def toBuffer(outbuf: ByteBuffer, session: Session): ByteBuffer
Appends this Record to a buffer for writing to an IPFIX stream.
Appends this Record to a buffer for writing to an IPFIX stream. The function uses the template IDs in session if the Record contains SubTemplateLists or a SubTemplateMultiList. Assumes the Template(s) used by the Record have already been added to the Session and appeneded to the buffer.
def toString(): String
Definition Classes
Record → 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

Record

Companion object Record

abstract class Record extends AnyRef

Instance Constructors

Abstract Value Members

Concrete Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped