plugin

Documentation

Overview

Package plugin provides gorisk's plugin loading infrastructure. Plugins are native Go plugins built with "go build -buildmode=plugin". Each plugin .so file must export one or both of:

• "CapabilityDetector" (gorisk.CapabilityDetector)
• "RiskScorer" (gorisk.RiskScorer)

Index

• func PluginDir() string
• type CapabilityDetector
• type LoadedPlugin
  • func Load(path string) (LoadedPlugin, error)
  • func LoadDir(dir string) ([]LoadedPlugin, []error)
• type RiskScorer

Functions

func PluginDir

func PluginDir() string

PluginDir returns the default directory where gorisk looks for plugins. It is $HOME/.gorisk/plugins on Unix and %APPDATA%\gorisk\plugins on Windows.

Types

type CapabilityDetector

type CapabilityDetector interface {
	Language() string
	DetectFile(path string) (map[string]float64, error)
}

CapabilityDetector mirrors gorisk.CapabilityDetector to avoid an import cycle. Plugins are loaded at runtime; we use the same method signatures.

type LoadedPlugin

type LoadedPlugin struct {
	Path     string
	Detector CapabilityDetector // nil if not exported
	Scorer   RiskScorer         // nil if not exported
}

LoadedPlugin holds the symbols resolved from a single .so file.

func Load

func Load(path string) (LoadedPlugin, error)

Load opens a single plugin .so file and resolves known symbols.

func LoadDir

func LoadDir(dir string) ([]LoadedPlugin, []error)

LoadDir loads all .so plugin files from dir. Errors for individual files are collected and returned together; valid plugins are still returned.

type RiskScorer

type RiskScorer interface {
	Name() string
	Score(pkg string, caps []string) float64
}

RiskScorer mirrors gorisk.RiskScorer.