README
¶
Lava
Lava is an open source vulnerability scanner that makes it easy to run security checks in your local and CI/CD environments.
Lava is part of the Vulcan ecosystem and it is built on top of the same components that power Vulcan. Thus, Lava continuously benefits from Vulcan improvements. In fact, Lava is compatible with the vulcan-checks catalog shipped with Vulcan.
Install
Binary distributions
Official binary distributions are available at https://github.com/adevinta/lava/releases.
Install from source
Install the Lava command with go install.
go install github.com/adevinta/lava/cmd/lava@latest
GitHub Actions
GitHub Actions are provided to make it easy to run Lava from a GitHub Actions workflow. Visit https://adevinta.github.io/lava-docs/github_actions.html for more details.
Documentation
The user documentation is available at https://adevinta.github.io/lava-docs.
Also, the Lava command is self-documented.
Run lava help to get more information about the available commands
and other related topics.
Contributing
This project is in an early stage, we are not accepting external contributions yet.
To contribute, please read the contribution guidelines.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
lava
command
Lava is a tool for running security checks in your local and CI/CD environments.
|
Lava is a tool for running security checks in your local and CI/CD environments. |
|
lava/internal/base
Package base defines shared basic pieces of the Lava command, in particular logging and the Command structure.
|
Package base defines shared basic pieces of the Lava command, in particular logging and the Command structure. |
|
lava/internal/help
Package help implements the help command.
|
Package help implements the help command. |
|
lava/internal/initialize
Package initialize implements the init command.
|
Package initialize implements the init command. |
|
lava/internal/run
Package run implements the run command.
|
Package run implements the run command. |
|
lava/internal/scan
Package scan implements the scan command.
|
Package scan implements the scan command. |
|
lava/internal/version
Package version implements the version command.
|
Package version implements the version command. |
|
internal
|
|
|
assettypes
Package assettypes defines a set of asset types that are valid in the context of Lava.
|
Package assettypes defines a set of asset types that are valid in the context of Lava. |
|
checktypes
Package checktypes provides utilities for working with checktypes and chektype catalogs.
|
Package checktypes provides utilities for working with checktypes and chektype catalogs. |
|
config
Package config implements parsing of Lava configurations.
|
Package config implements parsing of Lava configurations. |
|
containers
Package containers allows to interact with different container engines.
|
Package containers allows to interact with different container engines. |
|
engine
Package engine runs Vulcan checks and retrieves the generated reports.
|
Package engine runs Vulcan checks and retrieves the generated reports. |
|
gitserver
Package gitserver provides a read-only smart HTTP Git server.
|
Package gitserver provides a read-only smart HTTP Git server. |
|
gitserver/gittest
Package gittest provides utilities for Git testing.
|
Package gittest provides utilities for Git testing. |
|
metrics
Package metrics collects Lava execution metrics.
|
Package metrics collects Lava execution metrics. |
|
report
Package report renders Lava reports in different formats using the results returned by the Vulcan checks.
|
Package report renders Lava reports in different formats using the results returned by the Vulcan checks. |
|
urlutil
Package urlutil provides utilities for working with URLs.
|
Package urlutil provides utilities for working with URLs. |