-
Notifications
You must be signed in to change notification settings - Fork 158
/
cisco_discovery_info.go
403 lines (349 loc) · 13.9 KB
/
cisco_discovery_info.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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
/*
* 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 (
fieldCDPHello = "CDPHello"
fieldDeviceID = "DeviceID"
fieldAddresses = "Addresses"
fieldPortID = "PortID"
fieldCapabilities = "Capabilities"
fieldPlatform = "Platform"
fieldIPPrefixes = "IPPrefixes"
fieldVTPDomain = "VTPDomain"
fieldNativeVLAN = "NativeVLAN"
fieldFullDuplex = "FullDuplex"
fieldVLANReply = "VLANReply"
fieldVLANQuery = "VLANQuery"
fieldPowerConsumption = "PowerConsumption"
fieldMTU = "MTU"
fieldExtendedTrust = "ExtendedTrust"
fieldUntrustedCOS = "UntrustedCOS"
fieldSysName = "SysName"
fieldSysOID = "SysOID"
fieldMgmtAddresses = "MgmtAddresses"
fieldLocation = "Location"
fieldPowerRequest = "PowerRequest"
fieldPowerAvailable = "PowerAvailable"
fieldSparePairPoe = "SparePairPoe"
fieldEnergyWise = "EnergyWise"
fieldUnknown = "Unknown"
)
var fieldsCiscoDiscoveryInfo = []string{
fieldTimestamp,
fieldCDPHello, // *CDPHello
fieldDeviceID, // string
fieldAddresses, // []string
fieldPortID, // string
fieldCapabilities, // *CDPCapabilities
fieldVersion, // string
fieldPlatform, // string
fieldIPPrefixes, // []*IPNet
fieldVTPDomain, // string
fieldNativeVLAN, // int32
fieldFullDuplex, // bool
fieldVLANReply, // *CDPVLANDialogue
fieldVLANQuery, // *CDPVLANDialogue
fieldPowerConsumption, // int32
fieldMTU, // uint32
fieldExtendedTrust, // int32
fieldUntrustedCOS, // int32
fieldSysName, // string
fieldSysOID, // string
fieldMgmtAddresses, // []string
fieldLocation, // *CDPLocation
fieldPowerRequest, // *CDPPowerDialogue
fieldPowerAvailable, // *CDPPowerDialogue
fieldSparePairPoe, // *CDPSparePairPoE
fieldEnergyWise, // *CDPEnergyWise
fieldUnknown, // []*CiscoDiscoveryValue
}
// CSVHeader returns the CSV header for the audit record.
func (a *CiscoDiscoveryInfo) CSVHeader() []string {
return filter(fieldsCiscoDiscoveryInfo)
}
// CSVRecord returns the CSV record for the audit record.
func (a *CiscoDiscoveryInfo) CSVRecord() []string {
var (
ipNets []string
vals []string
)
for _, v := range a.IPPrefixes {
ipNets = append(ipNets, v.toString())
}
for _, v := range a.Unknown {
vals = append(vals, v.toString())
}
return filter([]string{
formatTimestamp(a.Timestamp),
a.CDPHello.toString(), // *CDPHello
a.DeviceID, // string
join(a.Addresses...), // []string
a.PortID, // string
a.Capabilities.toString(), // *CDPCapabilities
a.Version, // string
a.Platform, // string
join(ipNets...), // []*IPNet
a.VTPDomain, // string
formatInt32(a.NativeVLAN), // int32
strconv.FormatBool(a.FullDuplex), // bool
a.VLANReply.toString(), // *CDPVLANDialogue
a.VLANQuery.toString(), // *CDPVLANDialogue
formatInt32(a.PowerConsumption), // int32
formatUint32(a.MTU), // uint32
formatInt32(a.ExtendedTrust), // int32
formatInt32(a.UntrustedCOS), // int32
a.SysName, // string
a.SysOID, // string
join(a.MgmtAddresses...), // []string
a.Location.toString(), // *CDPLocation
a.PowerRequest.toString(), // *CDPPowerDialogue
a.PowerAvailable.toString(), // *CDPPowerDialogue
a.SparePairPoe.toString(), // *CDPSparePairPoE
a.EnergyWise.toString(), // *CDPEnergyWise
join(vals...), // []*CiscoDiscoveryValue
})
}
// Time returns the timestamp associated with the audit record.
func (a *CiscoDiscoveryInfo) Time() int64 {
return a.Timestamp
}
func (c *CDPHello) toString() string {
var b strings.Builder
b.WriteString(StructureBegin)
b.WriteString(hex.EncodeToString(c.OUI)) // []byte
b.WriteString(FieldSeparator)
b.WriteString(formatInt32(c.ProtocolID)) // int32
b.WriteString(FieldSeparator)
b.WriteString(c.ClusterMaster) // string
b.WriteString(FieldSeparator)
b.WriteString(c.Unknown1) // string
b.WriteString(FieldSeparator)
b.WriteString(formatInt32(c.Version)) // int32
b.WriteString(FieldSeparator)
b.WriteString(formatInt32(c.SubVersion)) // int32
b.WriteString(FieldSeparator)
b.WriteString(formatInt32(c.Status)) // int32
b.WriteString(FieldSeparator)
b.WriteString(formatInt32(c.Unknown2)) // int32
b.WriteString(FieldSeparator)
b.WriteString(c.ClusterCommander) // string
b.WriteString(FieldSeparator)
b.WriteString(c.SwitchMAC) // string
b.WriteString(FieldSeparator)
b.WriteString(formatInt32(c.Unknown3)) // int32
b.WriteString(FieldSeparator)
b.WriteString(formatInt32(c.ManagementVLAN)) // int32
b.WriteString(StructureEnd)
return b.String()
}
func (c *CDPCapabilities) toString() string {
var b strings.Builder
b.WriteString(StructureBegin)
b.WriteString(strconv.FormatBool(c.L3Router)) // bool
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.TBBridge)) // bool
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.SPBridge)) // bool
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.L2Switch)) // bool
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.IsHost)) // bool
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.IGMPFilter)) // bool
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.L1Repeater)) // bool
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.IsPhone)) // bool
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.RemotelyManaged)) // bool
b.WriteString(StructureEnd)
return b.String()
}
func (i *IPNet) toString() string {
var b strings.Builder
b.WriteString(StructureBegin)
b.WriteString(i.IP)
b.WriteString(FieldSeparator)
b.WriteString(i.IPMask)
b.WriteString(StructureEnd)
return b.String()
}
func (c *CDPVLANDialogue) toString() string {
var b strings.Builder
b.WriteString(StructureBegin)
b.WriteString(formatInt32(c.ID))
b.WriteString(FieldSeparator)
b.WriteString(formatInt32(c.VLAN))
b.WriteString(StructureEnd)
return b.String()
}
func (c *CDPPowerDialogue) toString() string {
var vals []string
for _, v := range c.Values {
vals = append(vals, formatUint32(v))
}
var b strings.Builder
b.WriteString(StructureBegin)
b.WriteString(formatInt32(c.ID))
b.WriteString(FieldSeparator)
b.WriteString(formatInt32(c.MgmtID))
b.WriteString(FieldSeparator)
b.WriteString(join(vals...))
b.WriteString(StructureEnd)
return b.String()
}
func (c *CDPSparePairPoE) toString() string {
var b strings.Builder
b.WriteString(StructureBegin)
b.WriteString(strconv.FormatBool(c.PSEFourWire)) // bool
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.PDArchShared)) // bool
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.PDRequestOn)) // bool
b.WriteString(FieldSeparator)
b.WriteString(strconv.FormatBool(c.PSEOn)) // bool
b.WriteString(StructureEnd)
return b.String()
}
func (c *CDPEnergyWise) toString() string {
var b strings.Builder
b.WriteString(StructureBegin)
b.WriteString(hex.EncodeToString(c.EncryptedData)) // []byte
b.WriteString(FieldSeparator)
b.WriteString(formatUint32(c.Unknown1)) // uint32
b.WriteString(FieldSeparator)
b.WriteString(formatUint32(c.SequenceNumber)) // uint32
b.WriteString(FieldSeparator)
b.WriteString(c.ModelNumber) // string
b.WriteString(FieldSeparator)
b.WriteString(formatInt32(c.Unknown2)) // int32
b.WriteString(FieldSeparator)
b.WriteString(c.HardwareID) // string
b.WriteString(FieldSeparator)
b.WriteString(c.SerialNum) // string
b.WriteString(FieldSeparator)
b.WriteString(hex.EncodeToString(c.Unknown3)) // []byte
b.WriteString(FieldSeparator)
b.WriteString(c.Role) // string
b.WriteString(FieldSeparator)
b.WriteString(c.Domain) // string
b.WriteString(FieldSeparator)
b.WriteString(c.Name) // string
b.WriteString(FieldSeparator)
b.WriteString(hex.EncodeToString(c.ReplyUnknown1)) // []byte
b.WriteString(FieldSeparator)
b.WriteString(hex.EncodeToString(c.ReplyPort)) // []byte
b.WriteString(FieldSeparator)
b.WriteString(hex.EncodeToString(c.ReplyAddress)) // []byte
b.WriteString(FieldSeparator)
b.WriteString(hex.EncodeToString(c.ReplyUnknown2)) // []byte
b.WriteString(FieldSeparator)
b.WriteString(hex.EncodeToString(c.ReplyUnknown3)) // []byte
b.WriteString(StructureEnd)
return b.String()
}
func (c *CDPLocation) toString() string {
var b strings.Builder
b.WriteString(StructureBegin)
b.WriteString(formatInt32(c.Type))
b.WriteString(FieldSeparator)
b.WriteString(c.Location)
b.WriteString(StructureEnd)
return b.String()
}
// JSON returns the JSON representation of the audit record.
func (a *CiscoDiscoveryInfo) JSON() (string, error) {
// convert unix timestamp from nano to millisecond precision for elastic
a.Timestamp /= int64(time.Millisecond)
return jsonMarshaler.MarshalToString(a)
}
var ciscoDiscoveryInfoMetric = prometheus.NewCounterVec(
prometheus.CounterOpts{
Name: strings.ToLower(Type_NC_CiscoDiscoveryInfo.String()),
Help: Type_NC_CiscoDiscoveryInfo.String() + " audit records",
},
fieldsCiscoDiscoveryInfo[1:],
)
// Inc increments the metrics for the audit record.
func (a *CiscoDiscoveryInfo) Inc() {
ciscoDiscoveryInfoMetric.WithLabelValues(a.CSVRecord()[1:]...).Inc()
}
// SetPacketContext sets the associated packet context for the audit record.
func (a *CiscoDiscoveryInfo) SetPacketContext(*PacketContext) {}
// Src TODO.
// Src returns the source address of the audit record.
func (a *CiscoDiscoveryInfo) Src() string {
return ""
}
// Dst returns the destination address of the audit record.
func (a *CiscoDiscoveryInfo) Dst() string {
return ""
}
var ciscoDiscoveryInfoEncoder = encoder.NewValueEncoder()
// Encode will encode categorical values and normalize according to configuration
func (a *CiscoDiscoveryInfo) Encode() []string {
var (
ipNets []string
vals []string
)
for _, v := range a.IPPrefixes {
ipNets = append(ipNets, v.toString())
}
for _, v := range a.Unknown {
vals = append(vals, v.toString())
}
return filter([]string{
ciscoDiscoveryInfoEncoder.Int64(fieldTimestamp, a.Timestamp),
ciscoDiscoveryInfoEncoder.String(fieldCDPHello, a.CDPHello.toString()), // *CDPHello
ciscoDiscoveryInfoEncoder.String(fieldDeviceID, a.DeviceID), // string
ciscoDiscoveryInfoEncoder.String(fieldAddresses, join(a.Addresses...)), // []string
ciscoDiscoveryInfoEncoder.String(fieldPortID, a.PortID), // string
ciscoDiscoveryInfoEncoder.String(fieldCapabilities, a.Capabilities.toString()), // *CDPCapabilities
ciscoDiscoveryInfoEncoder.String(fieldVersion, a.Version), // string
ciscoDiscoveryInfoEncoder.String(fieldPlatform, a.Platform), // string
ciscoDiscoveryInfoEncoder.String(fieldIPPrefixes, join(ipNets...)), // []*IPNet
ciscoDiscoveryInfoEncoder.String(fieldVTPDomain, a.VTPDomain), // string
ciscoDiscoveryInfoEncoder.Int32(fieldNativeVLAN, a.NativeVLAN), // int32
ciscoDiscoveryInfoEncoder.Bool(a.FullDuplex), // bool
ciscoDiscoveryInfoEncoder.String(fieldVLANReply, a.VLANReply.toString()), // *CDPVLANDialogue
ciscoDiscoveryInfoEncoder.String(fieldVLANQuery, a.VLANQuery.toString()), // *CDPVLANDialogue
ciscoDiscoveryInfoEncoder.Int32(fieldPowerConsumption, a.PowerConsumption), // int32
ciscoDiscoveryInfoEncoder.Uint32(fieldMTU, a.MTU), // uint32
ciscoDiscoveryInfoEncoder.Int32(fieldExtendedTrust, a.ExtendedTrust), // int32
ciscoDiscoveryInfoEncoder.Int32(fieldUntrustedCOS, a.UntrustedCOS), // int32
ciscoDiscoveryInfoEncoder.String(fieldSysName, a.SysName), // string
ciscoDiscoveryInfoEncoder.String(fieldSysOID, a.SysOID), // string
ciscoDiscoveryInfoEncoder.String(fieldMgmtAddresses, join(a.MgmtAddresses...)), // []string
ciscoDiscoveryInfoEncoder.String(fieldLocation, a.Location.toString()), // *CDPLocation
ciscoDiscoveryInfoEncoder.String(fieldPowerRequest, a.PowerRequest.toString()), // *CDPPowerDialogue
ciscoDiscoveryInfoEncoder.String(fieldPowerAvailable, a.PowerAvailable.toString()), // *CDPPowerDialogue
ciscoDiscoveryInfoEncoder.String(fieldSparePairPoe, a.SparePairPoe.toString()), // *CDPSparePairPoE
ciscoDiscoveryInfoEncoder.String(fieldEnergyWise, a.EnergyWise.toString()), // *CDPEnergyWise
ciscoDiscoveryInfoEncoder.String(fieldUnknown, join(vals...)), // []*CiscoDiscoveryValue
})
}
// Analyze will invoke the configured analyzer for the audit record and return a score.
func (a *CiscoDiscoveryInfo) Analyze() {
}
// NetcapType returns the type of the current audit record
func (a *CiscoDiscoveryInfo) NetcapType() Type {
return Type_NC_CiscoDiscoveryInfo
}