Puppet OS hardening
Description
This Puppet module provides secure configuration of your base OS with hardening.
Requirements
- Puppet
Parameters
system_environment = default
define the context in which the system runs. Some options don't work fordocker
/lxc
desktop_enabled = false
true if this is a desktop system, ie Xorg, KDE/GNOME/Unity/etcenable_ipv4_forwarding = false
true if this system requires packet forwarding in IPv4 (eg Router), false otherwiseenable_ipv6_forwarding = false
true if this system requires packet forwarding in IPv6 (eg Router), false otherwiseenable_ipv6 = false
arp_restricted = true
true if you want the behavior of announcing and replying to ARP to be restricted, false otherwiseextra_user_paths = []
add additional paths to the user'sPATH
variable (default is empty).umask = "027"
password_max_age = 60
maximum password agepassword_min_age = 7
minimum password age (before allowing any other password change)auth_retries = 5
the maximum number of authentication attempts, before the account is locked for some timeauth_lockout_time = 600
time in seconds that needs to pass, if the account was locked due to too many failed authentication attemptslogin_timeout = 60
authentication timeout in seconds, so login will exit if this time passesallow_login_without_home = false
true if to allow users without home to loginpasswdqc_enabled = true
true if you want to use strong password checking in PAM using passwdqcpasswdqc_options = "min=disabled,disabled,16,12,8"
set to any option line (as a string) that you want to pass to passwdqcmanage_pam_unix = false
true if you want pam_unix managed by this moduleenable_pw_history = true
true if you want pam_unix to remember password history to prevent reuse of passwords (requiresmanage_pam_unix = true
)pw_remember_last = 5
the number of last passwords (e.g. 5 will prevent user to reuse any of her last 5 passwords)allow_change_user = false
if a user may usesu
to change his loginignore_users = []
array of system user accounts that should not be hardened (password disabled and shell set to/usr/sbin/nologin
)enable_module_loading = true
true if you want to allowed to change kernel modules once the system is running (egmodprobe
,rmmod
)load_modules = []
load this modules via initramfs if enable_module_loading is falseenable_sysrq = false
enable_core_dump = false
enable_stack_protection = true
for Address Space Layout Randomization. ASLR can help defeat certain types of buffer overflow attacks. ASLR can locate the base, libraries, heap, and stack at random positions in a process's address space, which makes it difficult for an attacking program to predict the memory address of the next instruction.cpu_vendor = 'intel'
only required ifenable_module_loading = false
: set the CPU vendor for modules to loadroot_ttys = ["console","tty1","tty2","tty3","tty4","tty5","tty6"]
registered TTYs for rootwhitelist = []
all files which should keep their SUID/SGID bits if set (will be combined with pre-defined whiteliste of files)blacklist = []
all files which should have their SUID/SGID bits removed if set (will be combined with pre-defined blacklist of files)remove_from_unknown = false
true
if you want to remove SUID/SGID bits from any file, that is not explicitly configured in ablacklist
. This will make every Chef run search through the mounted filesystems looking for SUID/SGID bits that are not configured in the default and user blacklist. If it finds an SUID/SGID bit, it will be removed, unless this file is in yourwhitelist
.dry_run_on_unknown = false
likeremove_from_unknown
above, only that SUID/SGID bits aren't removed. It will still search the filesystems to look for SUID/SGID bits but it will only print them in your log. This option is only ever recommended, when you first configureremove_from_unknown
for SUID/SGID bits, so that you can see the files that are being changed and make adjustments to yourwhitelist
andblacklist
.
Usage
After adding this module, you can use the class:
class { 'os_hardening': }
Local Testing
For local testing you can use vagrant and Virtualbox of VMWare to run tests locally. You will have to install Virtualbox and Vagrant on your system. See Vagrant Downloads for a vagrant package suitable for your system. For all our tests we use test-kitchen
. If you are not familiar with test-kitchen
please have a look at their guide.
Next install test-kitchen:
# Install dependencies
gem install bundler
bundle install
# Fetch tests
bundle exec thor kitchen:fetch-remote-tests
# Do lint checks
bundle exec rake lint
# Do spec checks
bundle exec rake spec
# fast test on one machine
bundle exec kitchen test default-ubuntu-1204
# test on Debian-based machines
bundle exec kitchen test
# for development
bundle exec kitchen create default-ubuntu-1204
bundle exec kitchen converge default-ubuntu-1204
For more information see test-kitchen
Contributors + Kudos
- Dominik Richter arlimus
- Edmund Haselwanter ehaselwanter
- Christoph Hartmann chris-rock
- Thomas Dütsch a-tom
- Patrick Meier atomic111
- Artem Sidorenko artem-sidorenko
- Kurt Huwig kurthuwig
- Matthew Haughton 3flex
- Reik Keutterling spielkind
- Daniel Dreier danieldreier
- Timo Goebel timogoebel
- Tristan Helmich fadenb
For the original port of chef-os-hardening
to puppet:
- Artem Sidorenko artem-sidorenko
- Frank Kloeker eumel8
Thank you all!!
License and Author
- Author:: Dominik Richter [email protected]
- Author:: Deutsche Telekom AG
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.