Skip to content

Commit ef4d04b

Browse files
committed
fix descrptions in readme
Signed-off-by: Sebastian Gumprich <[email protected]>
1 parent f602bc6 commit ef4d04b

File tree

2 files changed

+32
-29
lines changed

2 files changed

+32
-29
lines changed

roles/os_hardening/README.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -54,19 +54,18 @@ We disable the following filesystems, because they're most likely not used:
5454
To prevent some of the filesystems from being disabled, add them to the `os_filesystem_whitelist` variable.
5555

5656
<!-- BEGIN_ANSIBLE_DOCS -->
57-
5857
## Supported Operating Systems
59-
60-
| Platform | Versions |
61-
| --------- | -------------------- |
62-
| EL | 7, 8, 9 |
63-
| Ubuntu | bionic, focal, jammy |
64-
| Debian | buster, bullseye |
65-
| Amazon | |
66-
| Fedora | |
67-
| ArchLinux | |
68-
| SmartOS | |
69-
| opensuse | |
58+
- EL
59+
- 7, 8, 9
60+
- Ubuntu
61+
- bionic, focal, jammy
62+
- Debian
63+
- buster, bullseye
64+
- Amazon
65+
- Fedora
66+
- ArchLinux
67+
- SmartOS
68+
- opensuse
7069

7170
## Role Variables
7271

@@ -290,14 +289,14 @@ To prevent some of the filesystems from being disabled, add them to the `os_file
290289
- Description: true if this is a desktop system, ie Xorg, KDE/GNOME/Unity/etc.
291290
- Type: bool
292291
- Required: no
293-
- `os_env_user_paths`
294-
- Default: `[/usr/local/sbin, /usr/local/bin, /usr/sbin, /usr/bin, /sbin, /bin]`
295-
- Description: Specify paths to the user's `PATH` variable.
296-
- Type: list
297-
- Required: no
298292
- `os_env_extra_user_paths`
299293
- Default: `"[]"`
300-
- Description: add additional paths to the user's `PATH` variable (default is empty).
294+
- Description: Specify additional paths that should be checked for binaries where access will be minimized
295+
- Type: list
296+
- Required: no
297+
- `os_env_user_paths`
298+
- Default: `["/usr/local/sbin", "/usr/local/bin", "/usr/sbin", "/usr/bin", "/sbin", "/bin"]`
299+
- Description: Specify paths that should be checked for binaries where access will be minimized
301300
- Type: list
302301
- Required: no
303302
- `os_filesystem_whitelist`
@@ -856,7 +855,7 @@ To prevent some of the filesystems from being disabled, add them to the `os_file
856855
- Type: str
857856
- Required: no
858857
- `sysctl_config`
859-
- Default: `{"fs.protected_hardlinks": 1, "fs.protected_symlinks": 1, "fs.protected_fifos": 1, "fs.protected_regular": 2, "fs.suid_dumpable": 0, "kernel.core_uses_pid": 1, "kernel.kptr_restrict": 2, "kernel.kexec_load_disabled": 1, "kernel.sysrq": 0, "kernel.randomize_va_space": 2, "kernel.yama.ptrace_scope": 1, "net.ipv4.ip_forward": 0, "net.ipv6.conf.all.forwarding": 0, "net.ipv4.conf.all.rp_filter": 1, "net.ipv4.conf.default.rp_filter": 1, "net.ipv4.icmp_echo_ignore_broadcasts": 1, "net.ipv4.icmp_ignore_bogus_error_responses": 1, "net.ipv4.icmp_ratelimit": 100, "net.ipv4.icmp_ratemask": 88089, "net.ipv4.tcp_timestamps": 0, "net.ipv4.conf.all.arp_ignore": 1, "net.ipv4.conf.all.arp_announce": 2, "net.ipv4.tcp_rfc1337": 1, "net.ipv4.tcp_syncookies": 1, "net.ipv4.conf.all.shared_media": 1, "net.ipv4.conf.default.shared_media": 1, "net.ipv4.conf.all.accept_source_route": 0, "net.ipv4.conf.default.accept_source_route": 0, "net.ipv6.conf.all.accept_source_route": 0, "net.ipv6.conf.default.accept_source_route": 0, "net.ipv4.conf.all.send_redirects": 0, "net.ipv4.conf.default.send_redirects": 0, "net.ipv4.conf.all.log_martians": 1, "net.ipv4.conf.default.log_martians": 1, "net.ipv4.conf.default.accept_redirects": 0, "net.ipv4.conf.all.accept_redirects": 0, "net.ipv4.conf.all.secure_redirects": 0, "net.ipv4.conf.default.secure_redirects": 0, "net.ipv6.conf.default.accept_redirects": 0, "net.ipv6.conf.all.accept_redirects": 0, "net.ipv6.conf.all.accept_ra": 0, "net.ipv6.conf.default.accept_ra": 0, "net.ipv6.conf.default.router_solicitations": 0, "net.ipv6.conf.all.router_solicitations": 0, "net.ipv6.conf.default.accept_ra_rtr_pref": 0, "net.ipv6.conf.default.accept_ra_pinfo": 0, "net.ipv6.conf.default.accept_ra_defrtr": 0, "net.ipv6.conf.default.autoconf": 0, "net.ipv6.conf.all.autoconf": 0, "net.ipv6.conf.default.dad_transmits": 0, "net.ipv6.conf.default.max_addresses": 1, "vm.mmap_min_addr": 65536, "vm.mmap_rnd_bits": 32, "vm.mmap_rnd_compat_bits": 16}`
858+
- Default: `{"fs.protected_hardlinks": 1, "fs.protected_symlinks": 1, "fs.protected_fifos": 1, "fs.protected_regular": 2, "fs.suid_dumpable": 0, "kernel.core_uses_pid": 1, "kernel.kptr_restrict": 2, "kernel.kexec_load_disabled": 1, "kernel.sysrq": 0, "kernel.randomize_va_space": 2, "kernel.yama.ptrace_scope": 1, "net.ipv4.ip_forward": 0, "net.ipv6.conf.all.forwarding": 0, "net.ipv4.conf.all.rp_filter": 1, "net.ipv4.conf.default.rp_filter": 1, "net.ipv4.icmp_echo_ignore_broadcasts": 1, "net.ipv4.icmp_ignore_bogus_error_responses": 0, "net.ipv4.icmp_ratelimit": 100, "net.ipv4.icmp_ratemask": 88089, "net.ipv4.tcp_timestamps": 0, "net.ipv4.conf.all.arp_ignore": 1, "net.ipv4.conf.all.arp_announce": 2, "net.ipv4.tcp_rfc1337": 1, "net.ipv4.tcp_syncookies": 1, "net.ipv4.conf.all.shared_media": 1, "net.ipv4.conf.default.shared_media": 1, "net.ipv4.conf.all.accept_source_route": 0, "net.ipv4.conf.default.accept_source_route": 0, "net.ipv6.conf.all.accept_source_route": 0, "net.ipv6.conf.default.accept_source_route": 0, "net.ipv4.conf.all.send_redirects": 0, "net.ipv4.conf.default.send_redirects": 0, "net.ipv4.conf.all.log_martians": 1, "net.ipv4.conf.default.log_martians": 1, "net.ipv4.conf.default.accept_redirects": 0, "net.ipv4.conf.all.accept_redirects": 0, "net.ipv4.conf.all.secure_redirects": 0, "net.ipv4.conf.default.secure_redirects": 0, "net.ipv6.conf.default.accept_redirects": 0, "net.ipv6.conf.all.accept_redirects": 0, "net.ipv6.conf.all.accept_ra": 0, "net.ipv6.conf.default.accept_ra": 0, "net.ipv6.conf.default.router_solicitations": 0, "net.ipv6.conf.all.router_solicitations": 0, "net.ipv6.conf.default.accept_ra_rtr_pref": 0, "net.ipv6.conf.default.accept_ra_pinfo": 0, "net.ipv6.conf.default.accept_ra_defrtr": 0, "net.ipv6.conf.default.autoconf": 0, "net.ipv6.conf.all.autoconf": 0, "net.ipv6.conf.default.dad_transmits": 0, "net.ipv6.conf.default.max_addresses": 1, "vm.mmap_min_addr": 65536, "vm.mmap_rnd_bits": 32, "vm.mmap_rnd_compat_bits": 16}`
860859
- Description: various sysctl-settings
861860
- Type: dict
862861
- Required: no

roles/os_hardening/meta/argument_specs.yml

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,14 @@ argument_specs:
88
default: false
99
type: bool
1010
description: true if this is a desktop system, ie Xorg, KDE/GNOME/Unity/etc.
11+
os_env_user_paths:
12+
default: [/usr/local/sbin, /usr/local/bin, /usr/sbin, /usr/bin, /sbin, /bin]
13+
type: list
14+
description: Specify paths that should be checked for binaries where access will be minimized
1115
os_env_extra_user_paths:
1216
default: '[]'
1317
type: list
14-
description: add additional paths to the user's `PATH` variable (default is
15-
empty).
18+
description: Specify additional paths that should be checked for binaries where access will be minimized
1619
os_auth_pw_max_age:
1720
default: 60
1821
type: int
@@ -235,7 +238,7 @@ argument_specs:
235238
default: SUSPEND
236239
type: str
237240
description: This parameter tells the system what action to take when the
238-
system has detected that it is low on disk space. Valid values are ignore,
241+
system has detected that it is low on disk space. Valid values are ignore,
239242
syslog, rotate, email, exec, suspend, single, and halt.
240243
os_auditd_space_left:
241244
default: 75
@@ -451,11 +454,11 @@ argument_specs:
451454
type: str
452455
description: Configure file system for fstab entry /dev
453456
os_mnt_dev_dump:
454-
default: 0
457+
default: '0'
455458
type: str
456459
description: Configure dump for fstab entry /var/tmp.
457460
os_mnt_dev_passno:
458-
default: 0
461+
default: '0'
459462
type: str
460463
description: Configure passno for fstab entry /var/tmp.
461464
os_mnt_dev_shm_dir_mode:
@@ -479,11 +482,11 @@ argument_specs:
479482
type: str
480483
description: Configure file system for fstab entry /dev/shm
481484
os_mnt_dev_shm_dump:
482-
default: 0
485+
default: '0'
483486
type: str
484487
description: Configure dump for fstab entry /var/tmp.
485488
os_mnt_dev_shm_passno:
486-
default: 0
489+
default: '0'
487490
type: str
488491
description: Configure passno for fstab entry /var/tmp.
489492
os_mnt_home_dir_mode:
@@ -539,11 +542,11 @@ argument_specs:
539542
type: str
540543
description: Configure file system for fstab entry /run
541544
os_mnt_run_dump:
542-
default: 0
545+
default: '0'
543546
type: str
544547
description: Configure dump for fstab entry /var/tmp.
545548
os_mnt_run_passno:
546-
default: 0
549+
default: '0'
547550
type: str
548551
description: Configure passno for fstab entry /var/tmp.
549552
os_mnt_tmp_dir_mode:
@@ -739,7 +742,7 @@ argument_specs:
739742
net.ipv4.conf.all.rp_filter: 1
740743
net.ipv4.conf.default.rp_filter: 1
741744
net.ipv4.icmp_echo_ignore_broadcasts: 1
742-
net.ipv4.icmp_ignore_bogus_error_responses: 1
745+
net.ipv4.icmp_ignore_bogus_error_responses: 0
743746
net.ipv4.icmp_ratelimit: 100
744747
net.ipv4.icmp_ratemask: 88089
745748
net.ipv4.tcp_timestamps: 0
@@ -842,3 +845,4 @@ argument_specs:
842845
description: If this variable is set to 'yes', on stop and reload the built-in
843846
chains are flushed. If it is set to 'no', on stop and reload the ufw secondary
844847
chains are removed and the ufw primary chains are flushed
848+

0 commit comments

Comments
 (0)