Skip to content

Latest commit

 

History

History
58 lines (43 loc) · 1.95 KB

HACKING.md

File metadata and controls

58 lines (43 loc) · 1.95 KB
Raw

Hacking on Spyre

Source code layout

Core code

  • cmd/spyre: The main program
  • config: Run-time configuration via command line switches.
  • log: Human-readable output.
  • report: Methods that produce output from scanners' match outputs. Output produced by the report subsystem will (hopefully) be processed by other programs.
  • platform: platform-specific logic
  • platform/sys: low-level syscall interface, magic constants, some of it generated code
  • scanner, scanner/*: Scan modules
  • module_config: Compile-time module configuration

Utility packages

  • appendedzip: Locate a ZIP archive appended to another file (such as the Spyre binary).
  • zipfs: An spf13/afero module that supports encrypted ZIP files.

Scratch space

  • _3rdparty: Build space for third-party dependencies not written in Go; see below.
  • _build: Target directory for Spyre binaries
  • _gopath: Local GOPATH

These files are prefixed with an underscore because the Go toolchain won't look at those.

Modules

All scanning functionality is implemented within modules. Currently, three interface types are defined: SystemScanner, FileScanner, ProcScanner. Including and initialization of those modules happens through import statements in module_config/*.go.

SystemScanners are run on program start and should consist of checks that are not computationally or I/O intensive.

FileScanners are run for every file, ProcScanners are run for every process id, but the individual scanner implementations can choose to skip specific files or processes.

Refer to scanner/yara for a concrete FileScanner / ProcScanner implementation and to scanner/eventobj and scanner/registry for a SystemScanner implementation.

Third-party-dependencies

The rules in 3rdparty.mk build C dependencies that are linked in using the CGO foreign function interface. Artifacts are installed into _3rdparty/tgt/<triplet>.