linux-bench/README.md
Parikshit Hooda 8bb91188a7
Update README.md - refactor documentation
Converted identifying requirements to bullet points rather than plain lines, owing to better comprehensibility.
Changed \####\ to ** ** - Because it makes sense to bolden the bullet points, rather than declaring them as headers
2019-10-11 01:50:31 +05:30

1.8 KiB

Build Status License Coverage Status

Linux-bench is a Go application that checks whether The linux operating system is configured securely by running the checks documented in the CIS Distribution Independent Linux Benchmark.

Tests are configured with YAML files, making this tool easy to update as test specifications evolve.

CIS Linux Benchmark support

linux-bench currently supports tests for benchmark version 1.1.0 only.

linux-bench will determine the test set to run on the host machine based on the following:

  • Operating system platform - ubuntu/debian/rhel/coreos
  • Boot loader - grub/grub2
  • System logging tool - rsyslog/syslog-ng
  • Lsm - selinux/apparmor

Installation

Installing from sources

Intall Go, then clone this repository and run as follows (assuming your $GOPATH is set):

go get github.com/aquasecurity/linux-bench
cd $GOPATH/src/github.com/aquasecurity/linux-bench
go build -o linux-bench .

# See all supported options
./linux-bench --help

# Run checks
./linux-bench

# Run checks for specified linux cis version
./linux-bench --version <version>

Tests

Tests are specified in definition files cfg/<version>/definitions.yaml.

Where <version> is the version of linux cis for which the test applies.

Contributing

We welcome PRs and issue reports.