-
Notifications
You must be signed in to change notification settings - Fork 1
/
flows.go
390 lines (358 loc) · 11.5 KB
/
flows.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
package sink
import (
"context"
"encoding/json"
"fmt"
"net"
"runtime"
"strconv"
"sync"
"time"
"github.com/agalue/gominion/api"
"github.com/agalue/gominion/log"
"github.com/agalue/gominion/protobuf/netflow"
"github.com/prometheus/client_golang/prometheus"
"github.com/rs/dnscache"
"github.com/sony/gobreaker"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/types/known/wrapperspb"
decoder "github.com/cloudflare/goflow/v3/decoders"
goflowMsg "github.com/cloudflare/goflow/v3/pb"
goflow "github.com/cloudflare/goflow/v3/utils"
)
// UDPNetflow5Parser represents the UDP Netflow5 parser name
const UDPNetflow5Parser = "Netflow5UdpParser"
// UDPNetflow9Parser represents the UDP Netflow9 parser name
const UDPNetflow9Parser = "Netflow9UdpParser"
// UDPIpfixParser represents the UDP IPFIX parser name
const UDPIpfixParser = "IpfixUdpParser"
// UDPSFlowParser represents the UDP SFlow parser name
const UDPSFlowParser = "SFlowUdpParser"
// TCPIpfixParser represents the TCP IPFIX parser name
const TCPIpfixParser = "IpfixUdpParser"
// Custom Logger implementation for goflow
type flowLogger struct{}
func (logger flowLogger) Printf(format string, params ...interface{}) {
log.Infof(format, params...)
}
func (logger flowLogger) Errorf(format string, params ...interface{}) {
log.Errorf(format, params...)
}
func (logger flowLogger) Warnf(format string, params ...interface{}) {
log.Warnf(format, params...)
}
func (logger flowLogger) Infof(format string, params ...interface{}) {
log.Infof(format, params...)
}
func (logger flowLogger) Debugf(format string, params ...interface{}) {
log.Debugf(format, params...)
}
func (logger flowLogger) Fatalf(format string, params ...interface{}) {
log.Fatalf(format, params...)
}
func (logger flowLogger) Warn(params ...interface{}) {}
func (logger flowLogger) Error(params ...interface{}) {}
func (logger flowLogger) Debug(params ...interface{}) {}
// NetflowModule represents a generic UDP forward module
// It starts a UDP Listener, and forwards the received data to OpenNMS without alteration
type NetflowModule struct {
name string
goflowID string
sink api.Sink
config *api.MinionConfig
listener *api.MinionListener
conn *net.UDPConn
processor *decoder.Processor
stopping bool
resolver *dnscache.Resolver
breaker *gobreaker.CircuitBreaker
}
// GetID gets the ID of the sink module
func (module *NetflowModule) GetID() string {
return module.name
}
// Start initiates a Netflow UDP receiver
func (module *NetflowModule) Start(config *api.MinionConfig, sink api.Sink) error {
module.stopping = false
module.sink = sink
module.config = config
module.listener = config.GetListener(module.name)
if module.listener == nil {
log.Warnf("Flow Module %s disabled", module.name)
return nil
}
var err error
if module.conn, err = createUDPListener(module.listener.Port); err != nil {
return err
}
var handler = module.getDecoderHandler()
if handler == nil {
log.Warnf("Flow Module %s disabled", module.name)
return nil
}
log.Infof("Starting %s flow receiver on port UDP %d", module.name, module.listener.Port)
module.initDNSResolver()
module.initCircuitBreaker()
module.startProcessor(handler)
localIP := module.conn.LocalAddr().String()
go func() {
payload := make([]byte, 9000)
for {
size, pktAddr, err := module.conn.ReadFromUDP(payload)
if err != nil {
if !module.stopping {
log.Errorf("%s Cannot read from UDP: %s", module.name, err)
}
continue
}
payloadCut := make([]byte, size)
copy(payloadCut, payload[0:size])
baseMessage := goflow.BaseMessage{
Src: pktAddr.IP,
Port: pktAddr.Port,
Payload: payloadCut,
}
module.processor.ProcessMessage(baseMessage)
if module.config.StatsPort > 0 {
goflow.MetricTrafficBytes.With(
prometheus.Labels{
"remote_ip": pktAddr.IP.String(),
"remote_port": strconv.Itoa(pktAddr.Port),
"local_ip": localIP,
"local_port": strconv.Itoa(module.listener.Port),
"type": module.goflowID,
}).
Add(float64(size))
goflow.MetricTrafficPackets.With(
prometheus.Labels{
"remote_ip": pktAddr.IP.String(),
"remote_port": strconv.Itoa(pktAddr.Port),
"local_ip": localIP,
"local_port": strconv.Itoa(module.listener.Port),
"type": module.goflowID,
}).
Inc()
goflow.MetricPacketSizeSum.With(
prometheus.Labels{
"remote_ip": pktAddr.IP.String(),
"remote_port": strconv.Itoa(pktAddr.Port),
"local_ip": localIP,
"local_port": strconv.Itoa(module.listener.Port),
"type": module.goflowID,
}).
Observe(float64(size))
}
}
}()
return nil
}
// Stop shutdowns the sink module
func (module *NetflowModule) Stop() {
log.Warnf("Stopping %s flow receiver", module.name)
module.stopping = true
if module.processor != nil {
module.processor.Stop()
}
if module.conn != nil {
module.conn.Close()
}
}
// Publish represents the Transport interface implementation used by goflow
func (module *NetflowModule) Publish(msgs []*goflowMsg.FlowMessage) {
messages := make([][]byte, len(msgs))
sourceAddress := ""
for idx, flowmsg := range msgs {
if sourceAddress == "" {
sourceAddress = net.IP(flowmsg.SamplerAddress).String()
}
if flowmsg.Type == goflowMsg.FlowMessage_SFLOW_5 {
// DEBUG: start
if bytes, err := json.MarshalIndent(flowmsg, "", " "); err != nil {
log.Debugf("SFlow message received %s", string(bytes))
}
// DEBUG: end
} else {
msg := module.convertToNetflow(flowmsg)
buffer, _ := proto.Marshal(msg)
messages[idx] = buffer
}
}
if bytes := wrapMessageToTelemetry(module.config, sourceAddress, uint32(module.listener.Port), messages); bytes != nil {
sendBytes("Telemetry-"+module.listener.Name, module.config, module.sink, bytes)
}
}
func (module *NetflowModule) getDecoderHandler() decoder.DecoderFunc {
if module.listener == nil {
return nil
}
if module.listener.Is(UDPNetflow5Parser) {
netflow := goflow.StateNFLegacy{
Transport: module,
Logger: flowLogger{},
}
return netflow.DecodeFlow
} else if module.listener.Is(UDPNetflow9Parser) || module.listener.Is(UDPIpfixParser) {
netflow := goflow.StateNetFlow{
Transport: module,
Logger: flowLogger{},
}
netflow.InitTemplates()
return netflow.DecodeFlow
} else if module.listener.Is(UDPSFlowParser) {
sflow := goflow.StateSFlow{
Transport: module,
Logger: flowLogger{},
}
return sflow.DecodeFlow
}
return nil
}
func (module *NetflowModule) startProcessor(handler decoder.DecoderFunc) {
if module.processor != nil {
return
}
ecb := goflow.DefaultErrorCallback{
Logger: flowLogger{},
}
decoderParams := decoder.DecoderParams{
DecoderFunc: handler,
DoneCallback: goflow.DefaultAccountCallback,
ErrorCallback: ecb.Callback,
}
processor := decoder.CreateProcessor(module.getWorkers(), decoderParams, module.goflowID)
module.processor = &processor
module.processor.Start()
}
// DNS processing can slow down flow processing, which is why reverse DNS is disabled by default
func (module *NetflowModule) lookup(addr string) ([]string, error) {
body, err := module.breaker.Execute(func() (interface{}, error) {
return module.resolver.LookupAddr(context.Background(), addr)
})
if err != nil {
return nil, err
}
return body.([]string), err
}
func (module *NetflowModule) initDNSResolver() {
if module.resolver != nil {
return
}
dns := module.config.DNS
module.resolver = &dnscache.Resolver{}
if dns != nil {
if dns.Timeout > 0 {
module.resolver.Timeout = time.Duration(dns.Timeout) * time.Microsecond
}
if dns.NameServer != "" {
module.resolver.Resolver = &net.Resolver{
PreferGo: true,
Dial: func(ctx context.Context, network, address string) (net.Conn, error) {
d := net.Dialer{}
return d.DialContext(ctx, "udp", fmt.Sprintf("%s:%d", dns.NameServer, 53))
},
}
}
}
go func() {
duration := 30 * time.Minute
if dns != nil && dns.CacheRefreshDuration > 0 {
duration = time.Duration(dns.CacheRefreshDuration) * time.Microsecond
}
t := time.NewTicker(duration)
defer t.Stop()
for range t.C {
module.resolver.Refresh(true)
}
}()
}
func (module *NetflowModule) initCircuitBreaker() {
if module.breaker != nil {
return
}
config := gobreaker.Settings{Name: module.GetID()}
dns := module.config.DNS
if dns != nil {
cb := dns.CircuitBreaker
config.MaxRequests = cb.MaxRequests
if cb.Interval > 0 {
config.Interval = time.Duration(cb.Interval) * time.Millisecond
}
if cb.Timeout > 0 {
config.Timeout = time.Duration(cb.Timeout) * time.Millisecond
}
}
module.breaker = gobreaker.NewCircuitBreaker(config)
}
func (module *NetflowModule) isReverseDNSEnabled() bool {
value, ok := module.listener.Properties["dnsLookupsEnabled"]
return ok && value == "true"
}
func (module *NetflowModule) getWorkers() int {
value, ok := module.listener.Properties["workers"]
if ok {
w, err := strconv.Atoi(value)
if err != nil && w > 0 {
return w
}
}
return runtime.NumCPU()
}
func (module *NetflowModule) convertToNetflow(flowmsg *goflowMsg.FlowMessage) *netflow.FlowMessage {
srcAddress := net.IP(flowmsg.SrcAddr).String()
dstAddress := net.IP(flowmsg.DstAddr).String()
nextHopeAddress := net.IP(flowmsg.NextHop).String()
var version netflow.NetflowVersion
switch flowmsg.Type {
case goflowMsg.FlowMessage_NETFLOW_V5:
version = netflow.NetflowVersion_V5
case goflowMsg.FlowMessage_NETFLOW_V9:
version = netflow.NetflowVersion_V9
case goflowMsg.FlowMessage_IPFIX:
version = netflow.NetflowVersion_IPFIX
}
msg := &netflow.FlowMessage{
NetflowVersion: version,
Direction: netflow.Direction(flowmsg.FlowDirection),
Timestamp: flowmsg.TimeReceived * 1000,
SrcAddress: srcAddress,
SrcPort: &wrapperspb.UInt32Value{Value: flowmsg.SrcPort},
SrcAs: &wrapperspb.UInt64Value{Value: uint64(flowmsg.SrcAS)},
SrcMaskLen: &wrapperspb.UInt32Value{Value: flowmsg.SrcNet},
DstAddress: dstAddress,
DstPort: &wrapperspb.UInt32Value{Value: flowmsg.DstPort},
DstAs: &wrapperspb.UInt64Value{Value: uint64(flowmsg.DstAS)},
DstMaskLen: &wrapperspb.UInt32Value{Value: flowmsg.DstNet},
NextHopAddress: nextHopeAddress,
InputSnmpIfindex: &wrapperspb.UInt32Value{Value: flowmsg.InIf},
OutputSnmpIfindex: &wrapperspb.UInt32Value{Value: flowmsg.OutIf},
FirstSwitched: &wrapperspb.UInt64Value{Value: flowmsg.TimeFlowStart * 1000},
LastSwitched: &wrapperspb.UInt64Value{Value: flowmsg.TimeFlowEnd * 1000},
TcpFlags: &wrapperspb.UInt32Value{Value: flowmsg.TCPFlags},
Protocol: &wrapperspb.UInt32Value{Value: flowmsg.Proto},
IpProtocolVersion: &wrapperspb.UInt32Value{Value: flowmsg.Etype},
Tos: &wrapperspb.UInt32Value{Value: flowmsg.IPTos},
FlowSeqNum: &wrapperspb.UInt64Value{Value: uint64(flowmsg.SequenceNum)},
SamplingInterval: &wrapperspb.DoubleValue{Value: float64(flowmsg.SamplingRate)},
NumBytes: &wrapperspb.UInt64Value{Value: flowmsg.Bytes},
NumPackets: &wrapperspb.UInt64Value{Value: flowmsg.Packets},
Vlan: &wrapperspb.UInt32Value{Value: flowmsg.VlanId},
}
if module.isReverseDNSEnabled() {
wg := &sync.WaitGroup{}
wg.Add(2)
go func() {
defer wg.Done()
if array, err := module.lookup(srcAddress); err != nil && len(array) > 0 {
msg.SrcHostname = array[0]
}
}()
go func() {
defer wg.Done()
if array, err := module.lookup(dstAddress); err != nil && len(array) > 0 {
msg.DstHostname = array[0]
}
}()
wg.Wait()
}
return msg
}