new: all hid periods are now configurable by dedicated parameters

modules/hid/hid_recon.go

@@ -1,159 +1,11 @@
 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
-}
-
-/*
-TODO:
-
-- parse all Durations as parameters
-- make session.Session.HID JSON serializable for the API
-- fix compilation for unsupported platforms
-- update docs
-- test test test
-*/
-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 <evilsocket@gmail.com> (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 {
@@ -243,11 +95,3 @@ func (mod *HIDRecon) Start() error {
 		mod.Debug("stopped")
 	})
 }
-
-func (mod *HIDRecon) Stop() error {
-	return mod.SetRunning(false, func() {
-		mod.waitGroup.Wait()
-		mod.dongle.Close()
-		mod.Debug("device closed")
-	})
-}