Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ansible-lockdown/AMAZON2-CIS
Ansible role for Amazon Linux 2 CIS Baseline
https://github.com/ansible-lockdown/AMAZON2-CIS
amazon-linux amazon-linux-2 ansible ansible-playbook ansible-role benchmark benchmark-framework cis cis-benchmark compliance-as-code compliance-automation security security-automation security-tools
Last synced: about 1 month ago
JSON representation
Ansible role for Amazon Linux 2 CIS Baseline
- Host: GitHub
- URL: https://github.com/ansible-lockdown/AMAZON2-CIS
- Owner: ansible-lockdown
- License: mit
- Created: 2022-04-01T14:02:08.000Z (over 2 years ago)
- Default Branch: devel
- Last Pushed: 2024-03-20T14:46:38.000Z (9 months ago)
- Last Synced: 2024-03-21T10:59:27.320Z (9 months ago)
- Topics: amazon-linux, amazon-linux-2, ansible, ansible-playbook, ansible-role, benchmark, benchmark-framework, cis, cis-benchmark, compliance-as-code, compliance-automation, security, security-automation, security-tools
- Language: YAML
- Homepage: https://ansible-lockdown.readthedocs.io
- Size: 120 KB
- Stars: 24
- Watchers: 5
- Forks: 17
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
# Amazon 2 Linux
Configure Amazon Linux 2 machine to be [CIS](https://www.cisecurity.org/cis-benchmarks/) compliant
Untested on OEL
Based on [CIS Amazon Linux 2 Benchmark v3.0.0 - 12-22-2023 ](https://www.cisecurity.org/cis-benchmarks/)
[](https://twitter.com/AnsibleLockdown)
[](https://github.com/ansible-lockdown/AMAZON2-CIS/actions/workflows/main_pipeline_validation.yml)
[](https://github.com/ansible-lockdown/AMAZON2-CIS/actions/workflows/devel_pipeline_validation.yml)
## Join us
On our [Discord Server](https://www.lockdownenterprise.com/discord) to ask questions, discuss features, or just chat with other Ansible-Lockdown users
## Caution(s)
This role **will make changes to the system** which may have unintended consequences. This is not an auditing tool but rather a remediation tool to be used after an audit has been conducted.
Check Mode is not supported! The role will complete in check mode without errors, but it is not supported and should be used with caution. The AMAZON2-CIS-Audit role or a compliance scanner should be used for compliance checking over check mode.
This role was developed against a clean install of the Operating System. If you are implementing to an existing system please review this role for any site specific changes that are needed.
To use release version please point to main branch and relevant release for the cis benchmark you wish to work with.
## Coming from a previous release
CIS release always contains changes, it is highly recommended to review the new references and available variables. This have changed significantly since ansible-lockdown initial release.
This is now compatible with python3 if it is found to be the default interpreter. This does come with pre-requisites which it configures the system accordingly.
Further details can be seen in the [Changelog](./ChangeLog.md)
## Documentation
- [Getting Started](https://www.lockdownenterprise.com/docs/getting-started-with-lockdown)
- [Customizing Roles](https://www.lockdownenterprise.com/docs/customizing-lockdown-enterprise)
- [Per-Host Configuration](https://www.lockdownenterprise.com/docs/per-host-lockdown-enterprise-configuration)
- [Getting the Most Out of the Role](https://www.lockdownenterprise.com/docs/get-the-most-out-of-lockdown-enterprise)
- [Wiki](https://github.com/ansible-lockdown/AMAZON2-CIS/wiki)
- [Repo GitHub Page](https://ansible-lockdown.github.io/AMAZON2-CIS/)
## Requirements
**General:**
- Basic knowledge of Ansible, below are some links to the Ansible documentation to help get started if you are unfamiliar with Ansible
- [Main Ansible documentation page](https://docs.ansible.com)
- [Ansible Getting Started](https://docs.ansible.com/ansible/latest/user_guide/intro_getting_started.html)
- [Tower User Guide](https://docs.ansible.com/ansible-tower/latest/html/userguide/index.html)
- [Ansible Community Info](https://docs.ansible.com/ansible/latest/community/index.html)
- Functioning Ansible and/or Tower Installed, configured, and running. This includes all of the base Ansible/Tower configurations, needed packages installed, and infrastructure setup.
- Please read through the tasks in this role to gain an understanding of what each control is doing. Some of the tasks are disruptive and can have unintended consequences in a live production system. Also familiarize yourself with the variables in the defaults/main.yml file or the [Main Variables Wiki Page](https://github.com/ansible-lockdown/AMAZON2-CIS/wiki/Main-Variables).
**Technical Dependencies:**
- Running Ansible/Tower setup (this role is tested against Ansible version 2.11.1 and newer)
- Python3 Ansible run environment
- python-def - First task sets up the prerequisites (Tag pre-reqs)for python3 and python2 (where required)
- libselinux-python
- python3-rpm (package used by py3 to use the rpm pkg)
- jmespath
## Role Variables
This role is designed that the end user should not have to edit the tasks themselves. All customizing should be done via the defaults/main.yml file or with extra vars within the project, job, workflow, etc. These variables can be found [here](https://github.com/ansible-lockdown/AMAZON2-CIS/wiki/Main-Variables) in the Main Variables Wiki page. All variables are listed there along with descriptions.
## Tags
There are many tags available for added control precision. Each control has it's own set of tags noting what level, if it's scored/notscored, what OS element it relates to, if it's a patch or audit, and the rule number.
Below is an example of the tag section from a control within this role. Using this example if you set your run to skip all controls with the tag services, this task will be skipped. The opposite can also happen where you run only controls tagged with services.
```sh
tags:
- level1
- scored
- avahi
- services
- patch
- rule_2.2.4
```
## Branches
- **devel** - This is the default branch and the working development branch. Community pull requests will pull into this branch
- **main** - This is the release branch
- **all other branches** - Individual community member branches
## Community Contribution
We encourage you (the community) to contribute to this role. Please read the rules below.
- Your work is done in your own individual branch. Make sure to Signed-off and GPG sign all commits you intend to merge.
- All community Pull Requests are pulled into the devel branch
- Pull Requests into devel will confirm your commits have a GPG signature, Signed-off, and a functional test before being approved
- Once your changes are merged and a more detailed review is complete, an authorized member will merge your changes into the main branch for a new release
## Pipeline Testing
uses:
- ansible-core 2.12+
- ansible collections - pulls in the latest version based on requirements file
- runs the audit using the devel branch
- This is an automated test that occurs on pull requests into devel
## Support
This is a community project at its core and will be managed as such.
If you would are interested in dedicated support to assist or provide bespoke setups
- [Ansible Counselor](https://www.mindpointgroup.com/products/ansible-counselor-on-demand-ansible-services-and-consulting/)
- [Try us out](https://engage.mindpointgroup.com/try-ansible-counselor)
## Credits and Thanks
Massive thanks to the fantastic community and all its members.