igmp.go

/*
 * NETCAP - Traffic Analysis Framework
 * Copyright (c) 2017 Philipp Mieden <dreadl0ck [at] protonmail [dot] ch>
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

package types

import (
	"encoding/hex"
	"strconv"
	"strings"

	"github.com/prometheus/client_golang/prometheus"
)

var fieldsIGMP = []string{
	"Timestamp",
	"Type",                    // int32
	"MaxResponseTime",         // uint64
	"Checksum",                // int32
	"GroupAddress",            // []byte
	"SupressRouterProcessing", // bool
	"RobustnessValue",         // int32
	"IntervalTime",            // uint64
	"SourceAddresses",         // []string
	"NumberOfGroupRecords",    // int32
	"NumberOfSources",         // int32
	"GroupRecords",            // []*IGMPv3GroupRecord
	"Version",                 // int32
	"SrcIP",
	"DstIP",
}

func (i IGMP) CSVHeader() []string {
	return filter(fieldsIGMP)
}

func (i IGMP) CSVRecord() []string {
	var records []string
	for _, r := range i.GroupRecords {
		records = append(records, r.ToString())
	}
	// prevent accessing nil pointer
	if i.Context == nil {
		i.Context = &PacketContext{}
	}
	return filter([]string{
		formatTimestamp(i.Timestamp),
		formatInt32(i.Type),                           // int32
		formatUint64(i.MaxResponseTime),               // uint64
		formatInt32(i.Checksum),                       // int32
		hex.EncodeToString(i.GroupAddress),            // []byte
		strconv.FormatBool(i.SupressRouterProcessing), // bool
		formatInt32(i.RobustnessValue),                // int32
		formatUint64(i.IntervalTime),                  // uint64
		join(i.SourceAddresses...),                    // []string
		formatInt32(i.NumberOfGroupRecords),           // int32
		formatInt32(i.NumberOfSources),                // int32
		strings.Join(records, ""),                     // []*IGMPv3GroupRecord
		formatInt32(i.Version),                        // int32
		i.Context.SrcIP,
		i.Context.DstIP,
	})
}

func (i IGMP) Time() string {
	return i.Timestamp
}

func (i IGMPv3GroupRecord) ToString() string {

	var b strings.Builder
	b.WriteString(Begin)
	b.WriteString(formatInt32(i.Type))
	b.WriteString(Separator)
	b.WriteString(formatInt32(i.AuxDataLen))
	b.WriteString(Separator)
	b.WriteString(formatInt32(i.NumberOfSources))
	b.WriteString(Separator)
	b.WriteString(i.MulticastAddress)
	b.WriteString(Separator)
	b.WriteString(join(i.SourceAddresses...))
	b.WriteString(End)

	return b.String()
}

func (a IGMP) JSON() (string, error) {
	return jsonMarshaler.MarshalToString(&a)
}

var igmpMetric = prometheus.NewCounterVec(
	prometheus.CounterOpts{
		Name: strings.ToLower(Type_NC_IGMP.String()),
		Help: Type_NC_IGMP.String() + " audit records",
	},
	fieldsIGMP[1:],
)

func init() {
	prometheus.MustRegister(igmpMetric)
}

func (a IGMP) Inc() {
	igmpMetric.WithLabelValues(a.CSVRecord()[1:]...).Inc()
}

func (a *IGMP) SetPacketContext(ctx *PacketContext) {
	a.Context = ctx
}

func (a IGMP) Src() string {
	if a.Context != nil {
		return a.Context.SrcIP
	}
	return ""
}

func (a IGMP) Dst() string {
	if a.Context != nil {
		return a.Context.DstIP
	}
	return ""
}