package hid import ( "fmt" "sync" "time" "github.com/bettercap/bettercap/modules/utils" "github.com/bettercap/bettercap/session" "github.com/bettercap/nrf24" ) type HIDRecon struct { session.SessionModule dongle *nrf24.Dongle waitGroup *sync.WaitGroup channel int hopPeriod time.Duration pingPeriod time.Duration sniffPeriod time.Duration lastHop time.Time lastPing time.Time useLNA bool sniffLock *sync.Mutex sniffAddrRaw []byte sniffAddr string pingPayload []byte inSniffMode bool inPromMode bool inInjectMode bool keyLayout string scriptPath string parser DuckyParser selector *utils.ViewSelector } func NewHIDRecon(s *session.Session) *HIDRecon { mod := &HIDRecon{ SessionModule: session.NewSessionModule("hid", s), waitGroup: &sync.WaitGroup{}, sniffLock: &sync.Mutex{}, hopPeriod: 100 * time.Millisecond, pingPeriod: 100 * time.Millisecond, sniffPeriod: 500 * time.Millisecond, lastHop: time.Now(), lastPing: time.Now(), useLNA: true, channel: 1, sniffAddrRaw: nil, sniffAddr: "", inSniffMode: false, inPromMode: false, inInjectMode: false, pingPayload: []byte{0x0f, 0x0f, 0x0f, 0x0f}, keyLayout: "US", scriptPath: "", } mod.AddHandler(session.NewModuleHandler("hid.recon on", "", "Start scanning for HID devices on the 2.4Ghz spectrum.", func(args []string) error { return mod.Start() })) mod.AddHandler(session.NewModuleHandler("hid.recon off", "", "Stop scanning for HID devices on the 2.4Ghz spectrum.", func(args []string) error { return mod.Stop() })) mod.AddParam(session.NewBoolParameter("hid.lna", "true", "If true, enable the LNA power amplifier for CrazyRadio devices.")) sniff := session.NewModuleHandler("hid.sniff ADDRESS", `(?i)^hid\.sniff ([a-f0-9]{2}:[a-f0-9]{2}:[a-f0-9]{2}:[a-f0-9]{2}:[a-f0-9]{2}|clear)$`, "Start sniffing a specific ADDRESS in order to collect payloads, use 'clear' to stop collecting.", func(args []string) error { return mod.setSniffMode(args[0]) }) sniff.Complete("hid.sniff", s.HIDCompleter) mod.AddHandler(sniff) mod.AddHandler(session.NewModuleHandler("hid.show", "", "Show a list of detected HID devices on the 2.4Ghz spectrum.", func(args []string) error { return mod.Show() })) inject := session.NewModuleHandler("hid.inject ADDRESS LAYOUT FILENAME", `(?i)^hid\.inject ([a-f0-9]{2}:[a-f0-9]{2}:[a-f0-9]{2}:[a-f0-9]{2}:[a-f0-9]{2})\s+(.+)\s+(.+)$`, "Parse the duckyscript FILENAME and inject it as HID frames spoofing the device ADDRESS, using the LAYOUT keyboard mapping.", func(args []string) error { if err := mod.setInjectionMode(args[0]); err != nil { return err } mod.keyLayout = args[1] mod.scriptPath = args[2] return nil }) inject.Complete("hid.inject", s.HIDCompleter) mod.AddHandler(inject) mod.parser = DuckyParser{mod} mod.selector = utils.ViewSelectorFor(&mod.SessionModule, "hid.show", []string{"mac", "seen"}, "mac desc") return mod } func (mod HIDRecon) Name() string { return "hid" } func (mod HIDRecon) Description() string { return "A scanner and frames injection module for HID devices on the 2.4Ghz spectrum, using Nordic Semiconductor nRF24LU1+ based USB dongles and Bastille Research RFStorm firmware." } func (mod HIDRecon) Author() string { return "Simone Margaritelli (this module and the nrf24 client library), Bastille Research (the rfstorm firmware and original research), phikshun and infamy for JackIt." } func (mod *HIDRecon) Configure() error { var err error if err, mod.useLNA = mod.BoolParam("hid.lna"); err != nil { return err } if mod.dongle, err = nrf24.Open(); err != nil { return fmt.Errorf("make sure that a nRF24LU1+ based USB dongle is connected and running the rfstorm firmware: %s", err) } mod.Debug("using device %s", mod.dongle.String()) if mod.useLNA { if err = mod.dongle.EnableLNA(); err != nil { return fmt.Errorf("make sure your device supports LNA, otherwise set hid.lna to false and retry: %s", err) } mod.Debug("LNA enabled") } return nil } func (mod *HIDRecon) doHopping() { if mod.inPromMode == false { if err := mod.dongle.EnterPromiscMode(); err != nil { mod.Error("error entering promiscuous mode: %v", err) } else { mod.inSniffMode = false mod.inPromMode = true mod.Debug("device entered promiscuous mode") } } if time.Since(mod.lastHop) >= mod.hopPeriod { mod.channel++ if mod.channel > nrf24.TopChannel { mod.channel = 1 } if err := mod.dongle.SetChannel(mod.channel); err != nil { mod.Warning("error hopping on channel %d: %v", mod.channel, err) } else { mod.lastHop = time.Now() } } } func (mod *HIDRecon) onDeviceDetected(buf []byte) { if sz := len(buf); sz >= 5 { addr, payload := buf[0:5], buf[5:] mod.Debug("detected device %x on channel %d (payload:%x)\n", addr, mod.channel, payload) if isNew, dev := mod.Session.HID.AddIfNew(addr, mod.channel, payload); isNew { // sniff for a while in order to detect the device type go func() { if err := mod.setSniffMode(dev.Address); err == nil { mod.Debug("detecting device type ...") defer func() { mod.sniffLock.Unlock() mod.setSniffMode("clear") }() // make sure nobody can sniff to another // address until we're not done here... mod.sniffLock.Lock() time.Sleep(mod.sniffPeriod) } else { mod.Warning("error while sniffing %s: %v", dev.Address, err) } }() } } } func (mod *HIDRecon) Start() error { if err := mod.Configure(); err != nil { return err } return mod.SetRunning(true, func() { mod.waitGroup.Add(1) defer mod.waitGroup.Done() mod.Info("hopping on %d channels every %s", nrf24.TopChannel, mod.hopPeriod) for mod.Running() { if mod.isSniffing() { mod.doPing() } else { mod.doHopping() } if mod.isInjecting() { mod.doInjection() mod.setInjectionMode("clear") continue } buf, err := mod.dongle.ReceivePayload() if err != nil { mod.Warning("error receiving payload from channel %d: %v", mod.channel, err) continue } if mod.isSniffing() { mod.onSniffedBuffer(buf) } else { mod.onDeviceDetected(buf) } } mod.Debug("stopped") }) } func (mod *HIDRecon) Stop() error { return mod.SetRunning(false, func() { mod.waitGroup.Wait() mod.dongle.Close() mod.Debug("device closed") }) }