mirror of
https://github.com/aquasecurity/linux-bench.git
synced 2025-02-22 14:15:32 +01:00
63 lines
2.2 KiB
Markdown
63 lines
2.2 KiB
Markdown
[![GitHub Release][release-img]][release]
|
|
[![License][license-img]][license]
|
|
[![Coverage Status][cov-img]][cov]
|
|
[![GitHub Build Actions][build-action-img]][actions]
|
|
[![GitHub Release Actions][release-action-img]][actions]
|
|
|
|
|
|
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
|
|
|
|
Install [Go](https://golang.org/doc/install), then
|
|
clone this repository and run as follows (assuming your [\$GOPATH is set](https://github.com/golang/go/wiki/GOPATH)):
|
|
|
|
|
|
```shell
|
|
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.
|
|
|
|
[actions]: https://github.com/aquasecurity/linux-bench/actions
|
|
[build-action-img]: https://github.com/aquasecurity/linux-bench/workflows/build/badge.svg
|
|
[cov-img]: https://codecov.io/github/aquasecurity/linux-bench/branch/main/graph/badge.svg
|
|
[cov]: https://codecov.io/github/aquasecurity/linux-bench
|
|
[license-img]: https://img.shields.io/badge/License-Apache%202.0-blue.svg
|
|
[license]: https://opensource.org/licenses/Apache-2.0
|
|
[release-img]: https://img.shields.io/github/release/aquasecurity/linux-bench.svg
|
|
[release]: https://github.com/aquasecurity/linux-bench/releases
|
|
[release-action-img]: https://github.com/aquasecurity/linux-bench/workflows/release/badge.svg
|