File: module.go

package info (click to toggle)
bettercap 2.33.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 8,668 kB
  • sloc: sh: 154; makefile: 76; python: 52; ansic: 9
file content (349 lines) | stat: -rw-r--r-- 9,030 bytes parent folder | download
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
package graph

import (
	"os"
	"path/filepath"
	"regexp"
	"sync"
	"time"

	"github.com/bettercap/bettercap/caplets"
	"github.com/bettercap/bettercap/modules/wifi"
	"github.com/bettercap/bettercap/network"
	"github.com/bettercap/bettercap/session"
	"github.com/evilsocket/islazy/fs"
	"github.com/evilsocket/islazy/plugin"
	"github.com/evilsocket/islazy/str"
)

const (
	ifaceAnnotation = "<interface>"
	edgeStaleTime   = time.Hour * 24
)

var privacyFilter = regexp.MustCompile("(?i)([a-f0-9]{2}):([a-f0-9]{2}):([a-f0-9]{2}):([a-f0-9]{2}):([a-f0-9]{2}):([a-f0-9]{2})")

type dotSettings struct {
	layout string
	name   string
	output string
}

type jsonSettings struct {
	output string
}

type settings struct {
	path         string
	dot          dotSettings
	json         jsonSettings
	disconnected bool
	privacy      bool
}

type Module struct {
	session.SessionModule

	settings settings
	db       *Graph
	gw       *Node
	iface    *Node
	eventBus session.EventBus
	wLock    sync.Mutex
}

func init() {
	plugin.Defines["graph"] = graphPackage{}
}

func NewModule(s *session.Session) *Module {
	mod := &Module{
		SessionModule: session.NewSessionModule("graph", s),
		settings: settings{
			path: filepath.Join(caplets.InstallBase, "graph"),
			dot: dotSettings{
				layout: "neato",
				name:   "bettergraph",
				output: "bettergraph.dot",
			},
			json: jsonSettings{
				output: "bettergraph.json",
			},
		},
	}

	mod.AddParam(session.NewStringParameter("graph.path",
		mod.settings.path,
		"",
		"Base path for the graph database."))

	mod.AddParam(session.NewStringParameter("graph.dot.name",
		mod.settings.dot.name,
		"",
		"Graph name in the dot output."))

	mod.AddParam(session.NewStringParameter("graph.dot.layout",
		mod.settings.dot.layout,
		"",
		"Layout for dot output."))

	mod.AddParam(session.NewStringParameter("graph.dot.output",
		mod.settings.dot.output,
		"",
		"File name for dot output."))

	mod.AddParam(session.NewStringParameter("graph.json.output",
		mod.settings.json.output,
		"",
		"File name for JSON output."))

	mod.AddParam(session.NewBoolParameter("graph.disconnected",
		"false",
		"Include disconnected edges in then output graph."))

	mod.AddParam(session.NewBoolParameter("graph.privacy",
		"false",
		"Obfuscate mac addresses."))

	mod.AddHandler(session.NewModuleHandler("graph on", "",
		"Start the Module module.",
		func(args []string) error {
			return mod.Start()
		}))

	mod.AddHandler(session.NewModuleHandler("graph off", "",
		"Stop the Module module.",
		func(args []string) error {
			return mod.Stop()
		}))

	mod.AddHandler(session.NewModuleHandler("graph.to_dot MAC?",
		`graph\.to_dot\s*([^\s]*)`,
		"Generate a dot graph file from the current graph.",
		func(args []string) (err error) {
			bssid := ""
			if len(args) == 1 && args[0] != "" {
				bssid = network.NormalizeMac(str.Trim(args[0]))
			}
			return mod.generateDotGraph(bssid)
		}))

	mod.AddHandler(session.NewModuleHandler("graph.to_json MAC?",
		`graph\.to_json\s*([^\s]*)`,
		"Generate a JSON graph file from the current graph.",
		func(args []string) (err error) {
			bssid := ""
			if len(args) == 1 && args[0] != "" {
				bssid = network.NormalizeMac(str.Trim(args[0]))
			}
			return mod.generateJSONGraph(bssid)
		}))

	return mod
}

func (mod *Module) Name() string {
	return "graph"
}

func (mod *Module) Description() string {
	return "A module to build a graph of WiFi and LAN nodes."
}

func (mod *Module) Author() string {
	return "Simone Margaritelli <evilsocket@gmail.com>"
}

func (mod *Module) updateSettings() error {
	var err error

	if err, mod.settings.dot.name = mod.StringParam("graph.dot.name"); err != nil {
		return err
	} else if err, mod.settings.dot.layout = mod.StringParam("graph.dot.layout"); err != nil {
		return err
	} else if err, mod.settings.dot.output = mod.StringParam("graph.dot.output"); err != nil {
		return err
	} else if err, mod.settings.json.output = mod.StringParam("graph.json.output"); err != nil {
		return err
	} else if err, mod.settings.disconnected = mod.BoolParam("graph.disconnected"); err != nil {
		return err
	} else if err, mod.settings.privacy = mod.BoolParam("graph.privacy"); err != nil {
		return err
	} else if err, mod.settings.path = mod.StringParam("graph.path"); err != nil {
		return err
	} else if mod.settings.path, err = filepath.Abs(mod.settings.path); err != nil {
		return err
	} else if !fs.Exists(mod.settings.path) {
		if err = os.MkdirAll(mod.settings.path, os.ModePerm); err != nil {
			return err
		}
	}

	// only reload if needed
	if mod.db != nil && mod.db.path != mod.settings.path {
		mod.db = nil
	}

	if mod.db == nil {
		if mod.db, err = NewGraph(mod.settings.path); err != nil {
			return err
		}
	}

	return nil
}

func (mod *Module) Configure() (err error) {
	if mod.Running() {
		return session.ErrAlreadyStarted(mod.Name())
	} else if err = mod.updateSettings(); err != nil {
		return err
	}

	// if have an IP
	if mod.Session.Gateway != nil && mod.Session.Interface != nil {
		// find or create interface node
		iface := mod.Session.Interface
		if mod.iface, err = mod.db.FindNode(Endpoint, iface.HwAddress); err != nil {
			return err
		} else if mod.iface == nil {
			// create the interface node
			if mod.iface, err = mod.db.CreateNode(Endpoint, iface.HwAddress, iface, ifaceAnnotation); err != nil {
				return err
			}
		} else if err = mod.db.UpdateNode(mod.iface); err != nil {
			return err
		}

		// find or create gateway node
		gw := mod.Session.Gateway
		if mod.gw, err = mod.db.FindNode(Gateway, gw.HwAddress); err != nil {
			return err
		} else if mod.gw == nil {
			if mod.gw, err = mod.db.CreateNode(Gateway, gw.HwAddress, gw, ""); err != nil {
				return err
			}
		} else {
			if err = mod.db.UpdateNode(mod.gw); err != nil {
				return err
			}
		}

		// create relations if needed
		if iface.HwAddress == gw.HwAddress {
			if err = mod.connectAsSame(mod.gw, mod.iface); err != nil {
				return err
			}
		} else {
			if manages, err := mod.db.FindLastRecentEdgeOfType(mod.gw, mod.iface, Manages, edgeStaleTime); err != nil {
				return err
			} else if manages == nil {
				if manages, err = mod.db.CreateEdge(mod.gw, mod.iface, Manages); err != nil {
					return err
				}
			}

			if connects_to, err := mod.db.FindLastEdgeOfType(mod.iface, mod.gw, ConnectsTo); err != nil {
				return err
			} else if connects_to == nil {
				if connects_to, err = mod.db.CreateEdge(mod.iface, mod.gw, ConnectsTo); err != nil {
					return err
				}
			}
		}
	}

	mod.eventBus = mod.Session.Events.Listen()

	return nil
}

func (mod *Module) onEvent(e session.Event) {
	var entities []*Node

	if e.Tag == "endpoint.new" {
		endpoint := e.Data.(*network.Endpoint)
		if entity, _, err := mod.createIPGraph(endpoint); err != nil {
			mod.Error("%s", err)
		} else {
			entities = append(entities, entity)
		}
	} else if e.Tag == "wifi.ap.new" {
		ap := e.Data.(*network.AccessPoint)
		if entity, _, err := mod.createDot11ApGraph(ap); err != nil {
			mod.Error("%s", err)
		} else {
			entities = append(entities, entity)
		}
	} else if e.Tag == "wifi.client.new" {
		ce := e.Data.(wifi.ClientEvent)
		if apEntity, _, staEntity, _, err := mod.createDot11Graph(ce.AP, ce.Client); err != nil {
			mod.Error("%s", err)
		} else {
			entities = append(entities, apEntity)
			entities = append(entities, staEntity)
		}
	} else if e.Tag == "wifi.client.probe" {
		probe := e.Data.(wifi.ProbeEvent)
		station := network.Station{
			RSSI: probe.RSSI,
			Endpoint: &network.Endpoint{
				HwAddress: probe.FromAddr,
				Vendor:    probe.FromVendor,
				Alias:     probe.FromAlias,
			},
		}

		if _, _, staEntity, _, err := mod.createDot11ProbeGraph(probe.SSID, &station); err != nil {
			mod.Error("%s", err)
		} else {
			// don't add fake ap to entities, no need to correlate
			entities = append(entities, staEntity)
		}
	} else if e.Tag == "ble.device.new" {
		// surprisingly some devices, like DLink IPCams have BLE, Dot11 and LAN hardware address in common
		dev := e.Data.(*network.BLEDevice)
		if entity, _, err := mod.createBLEServerGraph(dev); err != nil {
			mod.Error("%s", err)
		} else {
			entities = append(entities, entity)
		}
	}

	// if there's at least an entity node, search for other nodes with the
	// same mac address but different type and connect them as needed
	for _, entity := range entities {
		if others, err := mod.db.FindOtherTypes(entity.Type, entity.ID); err != nil {
			mod.Error("%s", err)
		} else if len(others) > 0 {
			for _, other := range others {
				if err = mod.connectAsSame(entity, other); err != nil {
					mod.Error("%s", err)
				}
			}
		}
	}
}

func (mod *Module) Start() error {
	if err := mod.Configure(); err != nil {
		return err
	}

	return mod.SetRunning(true, func() {
		mod.Info("started with database @ %s", mod.settings.path)

		for mod.Running() {
			select {
			case e := <-mod.eventBus:
				mod.onEvent(e)
			}
		}
	})
}

func (mod *Module) Stop() error {
	return mod.SetRunning(false, func() {
		mod.Session.Events.Unlisten(mod.eventBus)
	})
}