package graph import ( "os" "path/filepath" "regexp" "sync" "time" "github.com/bettercap/bettercap/v2/caplets" "github.com/bettercap/bettercap/v2/modules/wifi" "github.com/bettercap/bettercap/v2/network" "github.com/bettercap/bettercap/v2/session" "github.com/evilsocket/islazy/fs" "github.com/evilsocket/islazy/plugin" "github.com/evilsocket/islazy/str" ) const ( ifaceAnnotation = "" 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 " } 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) }) }