Adding new modules

Modules are added by calling zgrab2.AddCommand("<module-id>", "<module-display-name>", "<module description>", <module default port>, &theModule), where theModule is an instance of the appropriate Module implementation.

A typical module will consist in the following files:

• modules/<module-id>/scanner.go: Package documentation should describe the protocol, the input flags, what the scan does, and the output format. The body should provide the following structs:
  • Flags: Implements zgrab2.ScanFlags. Defines the input arguments from the command line.
    • All modules should include zgrab2.BaseFlags
    • Modules that implement TLS should include zgrab2.TLSFlags
  • ScanResults: This will be returned by the Scanner.Scan() method and JSON-encoded in the output. Ideally, this should provide both a MarshalJSON() and an UnmarshalJSON() method (if the defaults are not sufficient).
  • bar
  • baz
• modules/<module-id>.go: Calls <module>.RegisterModule() in its init() function.