-
Notifications
You must be signed in to change notification settings - Fork 158
/
lldi.go
218 lines (194 loc) · 6.9 KB
/
lldi.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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/*
* 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 (
"encoding/hex"
"github.com/dreadl0ck/netcap/encoder"
"strconv"
"strings"
"time"
"github.com/prometheus/client_golang/prometheus"
)
const (
fieldPortDescription = "PortDescription"
fieldSysDescription = "SysDescription"
fieldSysCapabilities = "SysCapabilities"
fieldMgmtAddress = "MgmtAddress"
fieldOrgTLVs = "OrgTLVs"
)
var fieldsLLDI = []string{
fieldTimestamp,
fieldPortDescription,
fieldSysName,
fieldSysDescription,
fieldSysCapabilities,
fieldMgmtAddress,
fieldOrgTLVs,
fieldUnknown,
}
// CSVHeader returns the CSV header for the audit record.
func (l *LinkLayerDiscoveryInfo) CSVHeader() []string {
return filter(fieldsLLDI)
}
// CSVRecord returns the CSV record for the audit record.
func (l *LinkLayerDiscoveryInfo) CSVRecord() []string {
var (
tlvs = make([]string, len(l.OrgTLVs))
values = make([]string, len(l.Unknown))
)
for i, v := range l.OrgTLVs {
tlvs[i] = v.toString()
}
for i, v := range l.Unknown {
values[i] = v.toString()
}
return filter([]string{
formatTimestamp(l.Timestamp),
l.PortDescription, // string
l.SysName, // string
l.SysDescription, // string
l.SysCapabilities.toString(), // *LLDPSysCapabilities
l.MgmtAddress.toString(), // *LLDPMgmtAddress
strings.Join(tlvs, ""), // []*LLDPOrgSpecificTLV
strings.Join(values, ""), // []*LinkLayerDiscoveryValue
})
}
// Time returns the timestamp associated with the audit record.
func (l *LinkLayerDiscoveryInfo) Time() int64 {
return l.Timestamp
}
func (lldsc *LLDPSysCapabilities) toString() string {
return lldsc.SystemCap.toString() + lldsc.EnabledCap.toString()
}
func (lldma *LLDPMgmtAddress) toString() string {
var b strings.Builder
b.WriteString(StructureBegin)
b.WriteString(formatInt32(lldma.Subtype)) // int32 // byte
b.WriteString(FieldSeparator)
b.WriteString(hex.EncodeToString(lldma.Address)) // bytes
b.WriteString(FieldSeparator)
b.WriteString(formatInt32(lldma.InterfaceSubtype)) // int32 // byte
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatUint(uint64(lldma.InterfaceNumber), 10)) // uint32
b.WriteString(FieldSeparator)
b.WriteString(lldma.OID) // string
b.WriteString(StructureEnd)
return b.String()
}
func (lldst *LLDPOrgSpecificTLV) toString() string {
var b strings.Builder
b.WriteString(StructureBegin)
b.WriteString(strconv.FormatUint(uint64(lldst.OUI), 10))
b.WriteString(FieldSeparator)
b.WriteString(formatInt32(lldst.SubType))
b.WriteString(FieldSeparator)
b.WriteString(hex.EncodeToString(lldst.Info))
b.WriteString(StructureEnd)
return b.String()
}
func (lldv *LinkLayerDiscoveryValue) toString() string {
var b strings.Builder
b.WriteString(StructureBegin)
b.WriteString(formatInt32(lldv.Type))
b.WriteString(FieldSeparator)
b.WriteString(formatInt32(lldv.Length))
b.WriteString(FieldSeparator)
b.WriteString(hex.EncodeToString(lldv.Value))
b.WriteString(StructureEnd)
return b.String()
}
func (c *LLDPCapabilities) toString() string {
var b strings.Builder
b.WriteString(StructureBegin)
b.WriteString(strconv.FormatBool(c.Other))
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.Repeater))
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.Bridge))
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.WLANAP))
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.Router))
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.Phone))
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.DocSis))
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.StationOnly))
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.CVLAN))
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.SVLAN))
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.TMPR))
b.WriteString(StructureEnd)
return b.String()
}
// JSON returns the JSON representation of the audit record.
func (l *LinkLayerDiscoveryInfo) JSON() (string, error) {
// convert unix timestamp from nano to millisecond precision for elastic
l.Timestamp /= int64(time.Millisecond)
return jsonMarshaler.MarshalToString(l)
}
var lldiMetric = prometheus.NewCounterVec(
prometheus.CounterOpts{
Name: strings.ToLower(Type_NC_LinkLayerDiscoveryInfo.String()),
Help: Type_NC_LinkLayerDiscoveryInfo.String() + " audit records",
},
fieldsLLDI[1:],
)
// Inc increments the metrics for the audit record.
func (l *LinkLayerDiscoveryInfo) Inc() {
lldiMetric.WithLabelValues(l.CSVRecord()[1:]...).Inc()
}
// SetPacketContext sets the associated packet context for the audit record.
func (l *LinkLayerDiscoveryInfo) SetPacketContext(*PacketContext) {}
// Src TODO.
// Src returns the source address of the audit record.
func (l *LinkLayerDiscoveryInfo) Src() string {
return ""
}
// Dst returns the destination address of the audit record.
func (l *LinkLayerDiscoveryInfo) Dst() string {
return ""
}
var lddiEncoder = encoder.NewValueEncoder()
// Encode will encode categorical values and normalize according to configuration
func (l *LinkLayerDiscoveryInfo) Encode() []string {
var (
tlvs = make([]string, len(l.OrgTLVs))
values = make([]string, len(l.Unknown))
)
for i, v := range l.OrgTLVs {
tlvs[i] = v.toString()
}
for i, v := range l.Unknown {
values[i] = v.toString()
}
return filter([]string{
lddiEncoder.Int64(fieldTimestamp, l.Timestamp),
lddiEncoder.String(fieldPortDescription, l.PortDescription), // string
lddiEncoder.String(fieldSysName, l.SysName), // string
lddiEncoder.String(fieldSysDescription, l.SysDescription), // string
lddiEncoder.String(fieldSysCapabilities, l.SysCapabilities.toString()), // *LLDPSysCapabilities
lddiEncoder.String(fieldMgmtAddress, l.MgmtAddress.toString()), // *LLDPMgmtAddress
lddiEncoder.String(fieldOrgTLVs, strings.Join(tlvs, "")), // []*LLDPOrgSpecificTLV
lddiEncoder.String(fieldValues, strings.Join(values, "")), // []*LinkLayerDiscoveryValue
})
}
// Analyze will invoke the configured analyzer for the audit record and return a score.
func (l *LinkLayerDiscoveryInfo) Analyze() {}
// NetcapType returns the type of the current audit record
func (l *LinkLayerDiscoveryInfo) NetcapType() Type {
return Type_NC_LinkLayerDiscoveryInfo
}