lateralblast / lunar

LUNAR ===== Lockdown UNix Auditing and Reporting Version ------- Current version 15.7.2 Refer to lunar.sh and changelog for more up to date version information License ------- CC BY-SA: https://creativecommons.org/licenses/by-sa/4.0/ Fund me here: https://ko-fi.com/richardatlateralblast ** NOTICE ** ------------ Run this code in audit more only, e.g. with -a or --audit switch. Run lockdown at your own risk. As per any system change, have backups. I'm working on improving the recovery mode, but there may still be bugs. I've tried to clean up this script as much as possible using shellcheck, and I've enabled the option to use the -e (errexit) and -u (nounset) shell flags to help protect against errors. The -x (xtrace) shell flag can be enabled by using the script with the -Q or --debug flag. Status ------ In progress: • More flexibility in reporting format(s) e.g. CSV • More inline documentation and documentation output • Adding Azure support (current focus) • Adding Kubernetes support • Adding Apache support Introduction ------------ This scripts generates a scored audit report of a Unix host's security. It is based on the CIS and other frameworks. Where possible there are references to the CIS and other benchmarks in the code documentation. Why a shell script? I wanted a tool that was able to run on locked down systems where other tools may not be available. I also wanted a tool that ran on all versions of UNIX. Having said that there are some differences between sh and bash, so I've used functions only from sh. There is no warranty implied or given with this script. My recommendation is to use this script in audit mode only, and address each warning individually via policy, documentation and configuration management. I am by no means a coder, so there are bound to be bugs and better ways to approach things in this script, so a sincere thank you to the people who have provided feedback, updates and patches to fix bugs/features in code. It can also can perform a lockdown. Unlike some other scripts I have added capability to backout changes. Files are backed up using cpio to a directory based on the date. Although it can perform a lockdown, as previously stated, I'd recommend you address the warnings via policy, documentation and configuration management. This is how I use the tool. The AWS Services audit only supports reporting, it does not provide lockdown capability. Supported Operating Systems --------------------------- The following Operating Systems are supported: • Linux • Rocky Linux • RHEL • Centos • Scientific Linux • SLES • Debian • Ubuntu • Amazon Linux • Solaris • Mac OS X • FreeBSD (needs more testing) • AIX (needs more testing) • ESXi (initial support - some tests) Windows support would require the installation of additional software, so I haven't looked into it. Having said that, Windows support may come in the future via bash. Supported Services ------------------ The following services are supported: • AWS • Azure • Entra ID (not complete) • Storage (not complete) • Compute (not complete) • Docker • Kubernetes (not complete) • Apache (not complete) The AWS Services audit uses the AWS CLI, and as such requires a user with the appropriate rights. It does not currently support the lockdown capability, it only supports generating an audit report against the CIS benchmark. There are a couple of the checks that can only be done or resolved via the GUI. An example of this is enabling billing. Refer to the CIS Benchmark for more information. Where possible I've put suggested fix commands in the verbose audit output. Again in some cases, these can only be done by the CLI. Refer to the CIS Benchmark for more information. In addition I've added a recommendations mode that checks AWS against publicly available best practice from companies like Cloud Conformity. Configuration Management ------------------------ The following configuration management output is supported: • Ansible This option outputs example ansible configuration management code/stanzas for implementing the recommendation. Requirements ------------ For UNIX: • Ubuntu / Debian • sysv-rc-conf • bc • finger For AWS: • AWS • AWS CLI • AWS Credentials (API Access and Secret Keys) • Read rights to appropriate AWS services, e.g. • CloudTrail:DescribeTrails • Config:DescribeConfigurationRecorders • SNS:ListSubscriptionsByTopic For Azure: • Azure • Azure CLI • Extensions • databricks • bastion • resource-graph • application-insights Usage ----- Examples -------- Perform full audit (without recursive file system checks): List tests: List AWS tests: Do a specific test: Create a Ubuntu 24.04 multipass VM for testing: More Information ---------------- For more information refer to wiki: Wiki Usage Ansible Ubuntu Solaris 11 CentOS Amazon Linux AWS Docker Testing ------- Added a simple testing framework for debugging the lunar script itself. This uses docker compose to start a container, mount the lunar directory and run lunar.