local

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 11, 2026 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DetectLanguages

func DetectLanguages(path string) []string

DetectLanguages scans the project root for known marker files.

func HasLanguage

func HasLanguage(cfg *AuditConfig, lang string) bool

HasLanguage checks if a language is in the detected set.

func IsTestFile

func IsTestFile(path string) bool

IsTestFile checks if a file path looks like a test file.

func ReadVxIgnore

func ReadVxIgnore(path string) []string

ReadVxIgnore parses a .vxignore file and returns the patterns.

func ShannonEntropy

func ShannonEntropy(s string) float64

ShannonEntropy computes the Shannon entropy of a string.

func WalkFiles

func WalkFiles(root string, ignore []string, extensions []string) ([]string, error)

WalkFiles walks the file tree rooted at root, skipping ignored directories and returning files matching the given extensions.

Types

type AuditConfig

type AuditConfig struct {
	Path      string
	Languages []string // auto-detected: "php", "typescript", "javascript", "go", "java", "python", "rust"
	Verbose   bool
}

AuditConfig holds configuration for local audit runs.

type AuthConfig

type AuthConfig struct{}

AuthConfig audits authentication and framework security configuration.

func (*AuthConfig) Description

func (a *AuthConfig) Description() string

func (*AuthConfig) Name

func (a *AuthConfig) Name() string

func (*AuthConfig) Run

func (a *AuthConfig) Run(cfg *AuditConfig) ([]engine.Finding, error)

type CodeVulns

type CodeVulns struct{}

CodeVulns scans source code for common vulnerability patterns.

func (*CodeVulns) Description

func (c *CodeVulns) Description() string

func (*CodeVulns) Name

func (c *CodeVulns) Name() string

func (*CodeVulns) Run

func (c *CodeVulns) Run(cfg *AuditConfig) ([]engine.Finding, error)

type Deps

type Deps struct{}

Deps scans project dependencies for known vulnerabilities via OSV.dev.

func (*Deps) Description

func (d *Deps) Description() string

func (*Deps) Name

func (d *Deps) Name() string

func (*Deps) Run

func (d *Deps) Run(cfg *AuditConfig) ([]engine.Finding, error)

type EnvFiles

type EnvFiles struct{}

EnvFiles audits environment files for security issues.

func (*EnvFiles) Description

func (e *EnvFiles) Description() string

func (*EnvFiles) Name

func (e *EnvFiles) Name() string

func (*EnvFiles) Run

func (e *EnvFiles) Run(cfg *AuditConfig) ([]engine.Finding, error)

type LocalModule

type LocalModule interface {
	Name() string
	Description() string
	Run(cfg *AuditConfig) ([]engine.Finding, error)
}

LocalModule defines the interface for local audit modules.

type Secrets

type Secrets struct{}

Secrets detects hardcoded secrets, API keys, and high-entropy strings in source files.

func (*Secrets) Description

func (s *Secrets) Description() string

func (*Secrets) Name

func (s *Secrets) Name() string

func (*Secrets) Run

func (s *Secrets) Run(cfg *AuditConfig) ([]engine.Finding, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL