Skip to content

Latest commit

 

History

History
75 lines (58 loc) · 3.3 KB

README.md

File metadata and controls

75 lines (58 loc) · 3.3 KB
Raw

Go Report Card License Build Status test coverage badge Gitter


lxd-probe logo

lxd-probe

Scan your Linux container (LXD / LXC) runtime !!

Lxd-Probe is an open source audit scanner who perform audit check on a linux container manager and output it security report.

The audit tests are the full implementation of CIS Lxd Benchmark specification

audit result now can be leveraged as webhook via user plugin(using go plugin)

Audit checks are performed on linux containers, and output audit report include :

  1. root cause of the security issue.
  2. proposed remediation for security issue

Linux container audit scan output:

lxd-probe

Installation

git clone https://github.com/chen-keinan/lxd-probe
cd lxd-probe
make build
./lxd-probe

Note : lxd-probe require privileged user to execute tests.

Quick Start

Usage: lxd-probe [--version] [--help] <command> [<args>]

Available commands are:
  -r , --report :  run audit tests and generate failure and warn report
  -i , --include:  execute only specific audit test,   example -i=1.2.3,1.4.5
  -e , --exclude:  ignore specific audit tests,  example -e=1.2.3,1.4.5
  -c , --classic:  test report in classic view,  example -c

User Plugin Usage

The lxd-probe expose hook for user plugins Example :

  • LxdBenchAuditResultHook - this hook accepts audit benchmark results as found by audit test
Compile user plugin
go build -buildmode=plugin -o=~/<plugin folder>/bench_plugin.so /<plugin folder>/bench_plugin.go
Copy plugin to folder (.lxd-probe folder is created on the 1st startup)
cp /<plugin folder>/bench_plugin.so ~/.lxd-probe/plugins/compile/bench_plugin.so

Note: Plugin and binary must compile with the same linux env

Supported Specs

The lxd-probe support cis specs and can be easily extended:

  • master config file change spec CIS Lxd Benchmark specification both specs can be easily extended by amended the spec files under ~/.lxd-probe/benchmarks/lxd/v1.0.0 folder

Contribution

  • code contribution is welcome !! , contribution with tests and passing linter is more than welcome :)
  • /.dev folder include vagrantfile to be used for development : Dev Instruction