You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
32
+
Join us on our [Discord Server](https://www.lockdownenterprise.com/discord) to ask questions, discuss features, or just chat with other Ansible-Lockdown users.
67
+
On our [Discord Server](https://www.lockdownenterprise.com/discord) to ask questions, discuss features, or just chat with other Ansible-Lockdown users
41
68
42
-
## Caution(s)
69
+
---
43
70
44
-
This role **will make changes to the system** that could break things. This is not an auditing tool but rather a remediation tool to be used after an audit has been conducted.
71
+
## 🚨 Caution(s) 🚨
45
72
46
-
This role was developed against a clean install of the Operating System. If you are implementing on an existing system, please review this role for any site-specific changes that are needed.
73
+
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.
47
74
48
-
## Documentation
75
+
- Testing is the most important thing you can do.
49
76
50
-
-[Read The Docs](https://ansible-lockdown.readthedocs.io/en/latest/)
-[Getting the Most Out of the Role](https://www.lockdownenterprise.com/docs/get-the-most-out-of-lockdown-enterprise#GH_AL_UB22_cis)
77
+
- Check Mode is not guaranteed! 🚫 The role will complete in check mode without errors, but it is not supported and should be used with caution.
78
+
79
+
- 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.
80
+
81
+
- To use release version please point to main branch and relevant release for the cis benchmark you wish to work with.
82
+
83
+
- Did we mention testing??
84
+
85
+
---
86
+
87
+
## Coming From A Previous Release ⏪
88
+
89
+
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.
90
+
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.
55
91
56
-
## Requirements
92
+
Further details can be seen in the [Changelog](./ChangeLog.md)
93
+
94
+
---
95
+
96
+
## Matching a security Level for CIS
97
+
98
+
It is possible to only run level 1 or level 2 controls for CIS.
99
+
This is managed using tags:
100
+
101
+
- level1-server
102
+
- level1-workstation
103
+
- level2-server
104
+
- level2-workstation
105
+
106
+
The control found in defaults main also need to reflect this as this control the testing that takes place if you are using the audit component.
107
+
108
+
---
109
+
## Requirements ✅
57
110
58
111
**General:**
59
112
60
113
- Basic knowledge of Ansible, below are some links to the Ansible documentation to help get started if you are unfamiliar with Ansible
-[Tower User Guide](https://docs.ansible.com/ansible-tower/latest/html/userguide/index.html)
64
118
-[Ansible Community Info](https://docs.ansible.com/ansible/latest/community/index.html)
65
119
- Functioning Ansible and/or Tower Installed, configured, and running. This includes all of the base Ansible/Tower configurations, needed packages installed, and infrastructure setup.
66
-
- 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/UBUNTU22-CIS/wiki/Main-Variables).
120
+
- 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.
67
121
68
122
**Technical Dependencies:**
69
123
70
-
- Running Ansible/Tower setup (this role is tested against Ansible version 2.12.1 and newer)
71
-
- Python3 Ansible run environment
72
-
- goss >= 0.4.4 (If using for audit)
124
+
UBUNTU 22 - Other versions are not supported.
125
+
126
+
- Access to download or add the goss binary and content to the system if using auditing
127
+
(other options are available on how to get the content to the system.)
128
+
- Python3.8
129
+
- Ansible 2.12+
130
+
- python-def
131
+
- libselinux-python
73
132
74
-
## Auditing (new)
133
+
---
75
134
76
-
This can be turned on or off within the defaults/main.yml file with the variable run_audit. The value is false by default, please refer to the wiki for more details.
135
+
## Auditing 🔍
136
+
137
+
This can be turned on or off within the defaults/main.yml file with the variable run_audit. The value is false by default, please refer to the wiki for more details. The defaults file also populates the goss checks to check only the controls that have been enabled in the ansible role.
77
138
78
139
This is a much quicker, very lightweight, checking (where possible) config compliance and live/running settings.
79
140
@@ -82,40 +143,121 @@ This audit will not only check the config has the correct setting but aims to ca
82
143
83
144
Refer to [UBUNTU22-CIS-Audit](https://github.com/ansible-lockdown/UBUNTU22-CIS-Audit).
84
145
85
-
Further audit documentation can be found at [Read The Docs](https://ansible-lockdown.readthedocs.io/en/latest/)
146
+
## Example Audit Summary
147
+
148
+
This is based on a vagrant image with selections enabled. e.g. No Gui or firewall.
149
+
Note: More tests are run during audit as we check config and running state.
150
+
151
+
```txt
152
+
153
+
ok: [default] => {
154
+
"msg": [
155
+
"msg": [
156
+
"The pre remediation audit results are: Count: 763, Failed: 234, Skipped: 4, Duration: 9.741s",
157
+
"The post remediation audit results are: Count: 763, Failed: 19, Skipped: 4, Duration: 12.725s",
158
+
"Full breakdown can be found in /opt",
159
+
""
160
+
]
161
+
}
162
+
163
+
PLAY RECAP *******************************************************************************************************************************************
-[Getting the Most Out of the Role](https://www.lockdownenterprise.com/docs/get-the-most-out-of-lockdown-enterprise#GH_AL_UBUNTU22_cis)
174
+
86
175
87
176
## Role Variables
88
177
89
-
This role is designed so 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.
178
+
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.
179
+
180
+
## Tags 🏷️
181
+
182
+
There are many tags available for added control precision. Each control has its own set of tags noting what level, what OS element it relates to, whether it's a patch or audit, and the rule number. Additionally, NIST references follow a specific conversion format for consistency and clarity.
183
+
184
+
### Conversion Format for NIST References:
185
+
186
+
1. Standard Prefix:
90
187
91
-
## Branches
188
+
- All references are prefixed with "NIST".
92
189
93
-
-**devel** - This is the default branch and the working development branch. Community pull requests will be pulled into this branch
94
-
-**main** - This is the release branch
95
-
-**all other branches** - Individual community member branches
190
+
2. Standard Types:
96
191
97
-
## Community Contribution
192
+
- "800-53" references are formatted as NIST800-53.
193
+
- "800-53r5" references are formatted as NIST800-53R5 (with 'R' capitalized).
194
+
- "800-171" references are formatted as NIST800-171.
195
+
196
+
3. Details:
197
+
198
+
- Section and subsection numbers use periods (.) for numeric separators.
199
+
- Parenthetical elements are separated by underscores (_), e.g., IA-5(1)(d) becomes IA-5_1_d.
200
+
- Subsection letters (e.g., "b") are appended with an underscore.
201
+
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.
202
+
203
+
```sh
204
+
tags:
205
+
- level1-server
206
+
- level1-workstation
207
+
- scored
208
+
- avahi
209
+
- services
210
+
- patch
211
+
- rule_2.2.4
212
+
```
213
+
214
+
215
+
## Community Contribution 🧑🤝🧑
98
216
99
217
We encourage you (the community) to contribute to this role. Please read the rules below.
100
218
101
-
- Your work is done in your own individual branch. Make sure to Signed-off and GPG sign all commits you intend to merge.
219
+
- Your work is done in your own individual branch. Make sure to Signed-off-by and GPG sign all commits you intend to merge.
102
220
- All community Pull Requests are pulled into the devel branch
103
-
- Pull Requests into devel will confirm your commits have a GPG signature, Signed-off, and a functional test before being approved
221
+
- Pull Requests into devel will confirm your commits have a GPG signature, Signed-off-by, and a functional test before being approved
104
222
- 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
105
223
106
-
## Pipeline Testing
224
+
## Pipeline Testing 🔄
107
225
108
226
uses:
109
227
110
-
- ansible-core 2.16.6
111
-
- ansible collections - pulls in the latest version based on the requirements file
228
+
- ansible-core 2.16
229
+
- ansible collections - pulls in the latest version based on requirements file
112
230
- runs the audit using the devel branch
113
231
- This is an automated test that occurs on pull requests into devel
232
+
- self-hosted runners using OpenTofu
114
233
115
-
## Added Extras
234
+
## Known Issues
116
235
117
-
-[pre-commit](https://pre-commit.com) can be tested and can be run from within the directory
118
236
119
-
```sh
120
-
pre-commit run
237
+
## Local Testing 💻
238
+
239
+
### example
240
+
241
+
```bash
242
+
molecule test -s default
243
+
molecule converge -s wsl -- --check
244
+
molecule verify -s localhost
121
245
```
246
+
247
+
local testing uses:
248
+
249
+
- ansible-core
250
+
- molecule 4.0.1
251
+
- molecule-docker 2.0.0
252
+
- molecule-podman 2.0.2
253
+
- molecule-vagrant 1.0.0
254
+
- molecule-azure 0.5.0
255
+
256
+
257
+
## Credits and Thanks 🙏
258
+
259
+
Massive thanks to the fantastic community and all its members.
260
+
261
+
This includes a huge thanks and credit to the original authors and maintainers.
262
+
263
+
Mark Bolwell, George Nalen, Steve Williams, Fred Witty
0 commit comments