-
Notifications
You must be signed in to change notification settings - Fork 158
/
ethernet.go
154 lines (133 loc) · 4.64 KB
/
ethernet.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/*
* NETCAP - Traffic Analysis Framework
* Copyright (c) 2017-2020 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 (
"github.com/dreadl0ck/netcap/encoder"
"strings"
"time"
"github.com/prometheus/client_golang/prometheus"
)
const (
fieldTimestamp = "Timestamp"
fieldSrcMAC = "SrcMAC"
fieldDstMAC = "DstMAC"
fieldEthernetType = "EthernetType"
fieldPayloadEntropy = "PayloadEntropy"
fieldPayloadSize = "PayloadSize"
)
var fieldsEthernet = []string{
fieldTimestamp,
fieldSrcMAC, // string
fieldDstMAC, // string
fieldEthernetType, // int32
fieldPayloadEntropy, // float64
fieldPayloadSize, // int32
}
// CSVHeader returns the CSV header for the audit record.
func (eth *Ethernet) CSVHeader() []string {
return filter(fieldsEthernet)
}
// CSVRecord returns the CSV record for the audit record.
func (eth *Ethernet) CSVRecord() []string {
return filter([]string{
formatTimestamp(eth.Timestamp),
eth.SrcMAC, // string
eth.DstMAC, // string
formatInt32(eth.EthernetType), // int32
formatFloat64(eth.PayloadEntropy), // float64
formatInt32(eth.PayloadSize), // int32
})
}
// Time returns the timestamp associated with the audit record.
func (eth *Ethernet) Time() int64 {
return eth.Timestamp
}
// JSON returns the JSON representation of the audit record.
func (eth *Ethernet) JSON() (string, error) {
// convert unix timestamp from nano to millisecond precision for elastic
eth.Timestamp /= int64(time.Millisecond)
return jsonMarshaler.MarshalToString(eth)
}
var (
ethernetMetric = prometheus.NewCounterVec(
prometheus.CounterOpts{
Name: strings.ToLower(Type_NC_Ethernet.String()),
Help: Type_NC_Ethernet.String() + " audit records",
},
fieldsEthernetMetrics,
)
ethernetPayloadEntropy = prometheus.NewHistogramVec(
prometheus.HistogramOpts{
Name: strings.ToLower(Type_NC_Ethernet.String()) + "_entropy",
Help: Type_NC_Ethernet.String() + " payload entropy",
Buckets: prometheus.LinearBuckets(20, 5, 5),
},
// fieldsEthernetMetrics,
[]string{},
)
ethernetPayloadSize = prometheus.NewHistogramVec(
prometheus.HistogramOpts{
Name: strings.ToLower(Type_NC_Ethernet.String()) + "_size",
Help: Type_NC_Ethernet.String() + " payload sizes",
Buckets: prometheus.LinearBuckets(20, 5, 5),
},
// fieldsEthernetMetrics,
[]string{},
)
)
var fieldsEthernetMetrics = []string{
fieldSrcMAC, // string
fieldDstMAC, // string
fieldEthernetType, // int32
}
func (eth *Ethernet) metricValues() []string {
return []string{
eth.SrcMAC, // string
eth.DstMAC, // string
formatInt32(eth.EthernetType), // int32
}
}
// Inc increments the metrics for the audit record.
func (eth *Ethernet) Inc() {
ethernetMetric.WithLabelValues(eth.metricValues()...).Inc()
ethernetPayloadEntropy.WithLabelValues().Observe(eth.PayloadEntropy)
ethernetPayloadSize.WithLabelValues().Observe(float64(eth.PayloadSize))
}
// SetPacketContext sets the associated packet context for the audit record.
func (eth *Ethernet) SetPacketContext(*PacketContext) {}
// Src returns the source address of the audit record.
func (eth *Ethernet) Src() string {
return eth.SrcMAC
}
// Dst returns the destination address of the audit record.
func (eth *Ethernet) Dst() string {
return eth.DstMAC
}
var ethernetEncoder = encoder.NewValueEncoder()
// Encode will encode categorical values and normalize according to configuration
func (eth *Ethernet) Encode() []string {
return filter([]string{
ethernetEncoder.Int64(fieldTimestamp, eth.Timestamp),
ethernetEncoder.String(fieldSrcMAC, eth.SrcMAC),
ethernetEncoder.String(fieldDstMAC, eth.DstMAC),
ethernetEncoder.Int32(fieldEthernetType, eth.EthernetType),
ethernetEncoder.Float64(fieldPayloadEntropy, eth.PayloadEntropy),
ethernetEncoder.Int32(fieldPayloadSize, eth.PayloadSize),
})
}
// Analyze will invoke the configured analyzer for the audit record and return a score.
func (eth *Ethernet) Analyze() {}
// NetcapType returns the type of the current audit record
func (eth *Ethernet) NetcapType() Type {
return Type_NC_Ethernet
}