From a2162dbd1b6255ebaa46bbf5ce662b065f8b4cc5 Mon Sep 17 00:00:00 2001 From: "root@DERVISHx" Date: Fri, 24 Nov 2023 15:38:40 +0000 Subject: [PATCH 01/14] Document variables in defaults/main.yml, Fix 2. Signed-off-by: root@DERVISHx --- defaults/main.yml | 321 ++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 281 insertions(+), 40 deletions(-) diff --git a/defaults/main.yml b/defaults/main.yml index 3fe96c1..c515d69 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -11,6 +11,10 @@ system_is_ec2: false # Supported OSs will not need for this to be changed - see README e.g. CentOS os_check: true +## Switching on/off specific baseline sections +# These variables govern whether the tasks of a particular section are to be executed when running the role. +# E.g: If you want to execute the tasks of Section 1 you should set the "_section1" variable to true. +# to "true". If you do not want the tasks from that section to get executed you simply set the variable to "false". rhel9cis_section1: true rhel9cis_section2: true rhel9cis_section3: true @@ -22,6 +26,7 @@ rhel9cis_section6: true # e.g. # - level1-server # - level2-workstation +# Used for audit rhel9cis_level_1: true rhel9cis_level_2: true @@ -39,7 +44,8 @@ benchmark_version: 'v1.0.0' benchmark: RHEL9-CIS -# Whether to skip the reboot +# Whether to skip the system reboot before audit +# System will reboot if false, can give better audit results skip_reboot: true # default value will change to true but wont reboot if not enabled but will error @@ -48,21 +54,39 @@ change_requires_reboot: false #### Basic external goss audit enablement settings #### #### Precise details - per setting can be found at the bottom of this file #### -### Goss is required on the remote host +## Audit setup +# Audits are carried out using Goss. This variable +# determines whether execution of the role prepares for auditing +# by installing the required binary. setup_audit: false -# How to retrive goss +## How to retrive goss # Options are copy or download - detailed settings at the bottom of this file +# provided in variable `audit_conf_copy` for copying or +# the url given in variable `audit_files_url` for downloading. # you will need to access to either github or the file already dowmloaded get_audit_binary_method: download -# how to get audit files onto host options +## How to retrieve the audit role +# The role for auditing is maintained separately. +# This variable specifies the method of how to get the audit role # options are git/copy/get_url - use local if already available to to the host (adjust paths accordingly) +# onto the system. The options are as follows: +# - git: clone from git repository as specified in variable `audit_file_git` in +# the version specified by variable `audit_git_version` +# - copy: copy from path as specified in variable `audit_conf_copy` +# - get_url: Download from url as specified in variable `audit_files_url` audit_content: git -# enable audits to run - this runs the audit and get the latest content +## Enable audits to run +# This variable governs whether the audit using the +# separately maintained audit role using Goss +# is carried out. run_audit: false # Timeout for those cmds that take longer to run where timeout set +# This variable specifies the timeout (in ms) for audit commands that +# take a very long time: if a command takes too long to complete, +# it will be forcefully terminated after the specified duration. audit_cmd_timeout: 60000 ### End Goss enablements #### @@ -72,7 +96,9 @@ audit_cmd_timeout: 60000 # the CIS benchmark documents. # PLEASE NOTE: These work in coordination with the section # group variables and tags. # You must enable an entire section in order for the variables below to take effect. -# Section 1 rules + +# Section 1 is Initial setup (FileSystem Configuration, Configure Software Updates, Filesystem Integrity Checking, Secure Boot Settings, +# Additional Process Hardening, Mandatory Access Control, Command Line Warning Banners, and GNOME Display Manager) rhel9cis_rule_1_1_1_1: true rhel9cis_rule_1_1_1_2: true rhel9cis_rule_1_1_2_1: true @@ -145,7 +171,7 @@ rhel9cis_rule_1_8_10: true rhel9cis_rule_1_9: true rhel9cis_rule_1_10: true -# Section 2 rules +# Section 2 rules are controling Services (Special Purpose Services, and service clients) rhel9cis_rule_2_1_1: true rhel9cis_rule_2_1_2: true rhel9cis_rule_2_2_1: true @@ -173,6 +199,7 @@ rhel9cis_rule_2_3_4: true rhel9cis_rule_2_4: true # Section 3 rules +# Network Configuration rhel9cis_rule_3_1_1: true rhel9cis_rule_3_1_2: true rhel9cis_rule_3_1_3: true @@ -197,7 +224,8 @@ rhel9cis_rule_3_4_2_5: true rhel9cis_rule_3_4_2_6: true rhel9cis_rule_3_4_2_7: true -# Section 4 rules +# Section 4 rules are Logging and Auditing (Configure System Accounting (auditd), +# Configure Data Retention, and Configure Logging) rhel9cis_rule_4_1_1_1: true rhel9cis_rule_4_1_1_2: true rhel9cis_rule_4_1_1_3: true @@ -256,7 +284,8 @@ rhel9cis_rule_4_2_2_7: true rhel9cis_rule_4_2_3: true rhel9cis_rule_4_3: true -# Section 5 rules +# Section 5 rules control Access, Authentication, and Authorization (Configure time-based job schedulers, +# Configure sudo, Configure SSH Server, Configure PAM and User Accounts and Environment) rhel9cis_rule_5_1_1: true rhel9cis_rule_5_1_2: true rhel9cis_rule_5_1_3: true @@ -311,7 +340,8 @@ rhel9cis_rule_5_6_4: true rhel9cis_rule_5_6_5: true rhel9cis_rule_5_6_6: true -# Section 6 rules +# Section 6 rules controls System Maintenance (System File Permissions and User and Group Settings) +rhel9cis_rule_6_1_1: true rhel9cis_rule_6_1_1: true rhel9cis_rule_6_1_2: true rhel9cis_rule_6_1_3: true @@ -377,10 +407,18 @@ rhel9cis_bootloader_password_hash: 'grub.pbkdf2.sha512.10000.9306A36764A7BEA3BF4 rhel9cis_bootloader_password: random # pragma: allowlist secret rhel9cis_set_boot_pass: true -# 1.8 Gnome Desktop + +## Controls 1.8.x - Settings for GDM +# This variable specifies the GNOME configuration database file to which configurations are written. +# (See https://help.gnome.org/admin/system-admin-guide/stable/dconf-keyfiles.html.en) +# The default database is `local` rhel9cis_dconf_db_name: local -rhel9cis_screensaver_idle_delay: 900 # Set max value for idle-delay in seconds (between 1 and 900) -rhel9cis_screensaver_lock_delay: 5 # Set max value for lock-delay in seconds (between 0 and 5) +# This variable governs the number of seconds of inactivity before the screen goes blank. +# Set max value for idle-delay in seconds (between 1 and 900) +rhel9cis_screensaver_idle_delay: 900 +# This variable governs the number of seconds the screen remains blank before it is locked. +# Set max value for lock-delay in seconds (between 0 and 5) +rhel9cis_screensaver_lock_delay: 5 # 1.10/1.11 Set crypto policy (LEGACY, DEFAULT, FUTURE, FIPS) # Control 1.10 states do not use LEGACY and control 1.11 says to use FUTURE or FIPS. @@ -389,27 +427,67 @@ rhel9cis_crypto_policy: 'DEFAULT' rhel9cis_crypto_policy_module: '' # System network parameters (host only OR host and router) +# This variable governs whether specific CIS rules +# concerned with acceptance and routing of packages are skipped. rhel9cis_is_router: false -# IPv6 required +## IPv6 requirement toggle +# This variable governs whether ipv6 is enabled or disabled. rhel9cis_ipv6_required: true -# AIDE +## Control 1.3.1 - allow aide to be configured +# AIDE is a file integrity checking tool, similar in nature to Tripwire. +# While it cannot prevent intrusions, it can detect unauthorized changes +# to configuration files by alerting when the files are changed. Review +# the AIDE quick start guide and AIDE documentation before proceeding. +# By setting this variable to `true`, all of the settings related to AIDE will be applied! rhel9cis_config_aide: true -# AIDE cron settings + +## Control 1.3.2 AIDE cron settings +# These are the crontab settings for periodical checking of the filesystem's integrity using AIDE. +# The sub-settings of this variable provide the parameters required to configure +# the cron job on the target system. +# Cron is a time-based job scheduling program in Unix OS, which allows tasks to be scheduled +# and executed automatically at a certain point in time. rhel9cis_aide_cron: + # This variable represents the user account under which the cron job for AIDE will run. cron_user: root + # This variable represents the path to the AIDE crontab file. cron_file: /etc/cron.d/aide_cron + # This variable represents the actual command or script that the cron job + # will execute for running AIDE. aide_job: '/usr/sbin/aide --check' + # These variables define the schedule for the cron job + # This variable governs the minute of the time of day when the AIDE cronjob is run. + # It must be in the range `0-59`. aide_minute: 0 + # This variable governs the hour of the time of day when the AIDE cronjob is run. + # It must be in the range `0-23`. aide_hour: 5 + # This variable governs the day of the month when the AIDE cronjob is run. + # `*` signifies that the job is run on all days; furthermore, specific days + # can be given in the range `1-31`; several days can be concatenated with a comma. + # The specified day(s) can must be in the range `1-31`. aide_day: '*' - aide_month: '*' + # This variable governs months when the AIDE cronjob is run. + # `*` signifies that the job is run in every month; furthermore, specific months + # can be given in the range `1-12`; several months can be concatenated with commas. + # The specified month(s) can must be in the range `1-12`. + aide_month: '*' + # This variable governs the weekdays, when the AIDE cronjob is run. + # `*` signifies that the job is run on all weekdays; furthermore, specific weekdays + # can be given in the range `0-7` (both `0` and `7` represent Sunday); several weekdays + # can be concatenated with commas. aide_weekday: '*' # SELinux policy +# This selects type of policy; targeted or mls ( multilevel ) +# mls should not be used, since it will disable unconfined policy module +# and may prevent some services from running. rhel9cis_selinux_pol: targeted # chose onf or enfocing or permissive +# CIS expects enforcing since permissive allows operations thet might compromise the system. +# Even though logging still occurs. rhel9cis_selinux_enforce: enforcing # Whether or not to run tasks related to auditing/patching the desktop environment @@ -418,6 +496,11 @@ rhel9cis_selinux_enforce: enforcing ### 2.1 Time Synchronization #### 2.1.2 Time Synchronization servers - used in template file chrony.conf.j2 +# The following variable represents a list of of time servers used +# for configuring chrony, timesyncd, and ntp. +# Each list item contains two settings, `name` (the domain name of the server) and synchronization `options`. +# The default setting for the `options` is `minpoll` but `iburst` can be used, please refer to the documentation +# of the time synchronization mechanism you are using. rhel9cis_time_synchronization_servers: - 0.pool.ntp.org - 1.pool.ntp.org @@ -426,7 +509,9 @@ rhel9cis_time_synchronization_servers: rhel9cis_chrony_server_options: "minpoll 8" ### 2.2 Special Purposes -##### Service configuration booleans set true to keep service +# Service configuration variables (boolean). +# Set the respective variable to true to keep the service. +# otherwise the service is stopped and disabled rhel9cis_gui: false rhel9cis_avahi_server: false rhel9cis_cups_server: false @@ -444,10 +529,12 @@ rhel9cis_squid_server: false rhel9cis_snmp_server: false rhel9cis_telnet_server: false rhel9cis_is_mail_server: false -# Note the options -# Packages are used for client services and Server- only remove if you dont use the client service -# +# Note the options +# Client package configuration variables. +# Packages are used for client services and Server, only remove if you dont use the client service +# Set the respective variable to `true` to keep the +# client package, otherwise it is uninstalled (false). rhel9cis_use_nfs_server: false rhel9cis_use_nfs_service: false @@ -463,8 +550,7 @@ rhel9cis_openldap_clients_required: false rhel9cis_tftp_client: false rhel9cis_ftp_client: false -## Section3 vars -## Sysctl +## Section 3 vars for Sysctl rhel9cis_sysctl_update: false rhel9cis_flush_ipv4_route: false rhel9cis_flush_ipv6_route: false @@ -484,7 +570,11 @@ rhel9cis_firewalld_ports: - number: 80 protocol: tcp -#### nftables +## Controls 3.5.2.x - nftables +# The default nftables table name is "filter". This variable name will be the one all +# "rhel9cis_nft_tables_tablename" is the name of the table in nftables you want to create. +# nftables configs are applied to. +# options are: inet filter rhel9cis_nft_tables_autonewtable: true rhel9cis_nft_tables_tablename: filter rhel9cis_nft_tables_autochaincreate: true @@ -496,23 +586,60 @@ rhel9cis_warning_banner: Authorized uses only. All activity may be monitored and ## Section4 vars ### 4.1 Configure System Accounting #### 4.1.2 Configure Data Retention +## Controls what actions, when log files fill up +# This variable controls how the audit system behaves when +# log files are getting too full and space is getting too low. rhel9cis_auditd: space_left_action: email action_mail_acct: root + # This variable determines the action the audit system should take when disk + # space runs low. + # The options for setting this variable are as follows: + # - `ignore`: the system does nothing when presented with the aforementioned issue; + # - `syslog`: a message is sent to the system log about disk space running low; + # - `suspend`: the system suspends recording audit events until more space is available; + # - `halt`: the system is halted when disk space is critically low. + # - `single`: the audit daemon will put the computer system in single user mode + # CIS prescribes either `halt` or `single`. admin_space_left_action: halt + # This variable determines what action the audit system should take when the maximum + # size of a log file is reached. + # The options for setting this variable are as follows: + # - `ignore`: the system does nothing when the size of a log file is full; + # - `syslog`: a message is sent to the system log indicating the problem; + # - `suspend`: the system suspends recording audit events until the log file is cleared or rotated; + # - `rotate`: the log file is rotated (archived) and a new empty log file is created; + # - `keep_logs`: the system attempts to keep as many logs as possible without violating disk space constraints. + # CIS prescribes the value `keep_logs`. max_log_file_action: keep_logs -# The audit_back_log_limit value should never be below 8192 +## Control 4.1.1.4 - Ensure rhel9cis_audit_back_log_limit is sufficient +# This variable represents the audit backlog limit, i.e., the maximum number of audit records that the +# system can buffer in memory, if the audit subsystem is unable to process them in real-time. +# Buffering in memory is useful in situations, where the audit system is overwhelmed +# with incoming audit events, and needs to temporarily store them until they can be processed. +# This variable should be set to a sufficient value. The CIS baseline recommends at least `8192` as value. rhel9cis_audit_back_log_limit: 8192 -# The max_log_file parameter should be based on your sites policy +## Control 4.1.2.1 - Ensure audit log storage size is configured +# This variable specifies the maximum size in MB that an audit log file can reach +# before it is archived or deleted to make space for the new audit data. +# This should be set based on your sites policy. CIS does not provide a specific value. rhel9cis_max_log_file_size: 10 -### 4.1.3.x audit template +## 4.1.3.x - Audit template +# This variable is set to true by tasks 4.1.3.1 to 4.1.3.20. As a result, the +# audit settings are overwritten with the role's template. In order to exclude +# specific rules, you must set the variable of form `rhel9cis_rule_4_1_3_x` above +# to `false`. update_audit_template: false ## Advanced option found in auditd post +# users whose actions are not logged by auditd rhel9cis_allow_auditd_uid_user_exclusions: false +# add a list of uids to be excluded. +rhel9cis_auditd_uid_exclude: + - 1999 # This can be used to configure other keys in auditd.conf rhel9cis_auditd_extra_conf: {} @@ -528,35 +655,63 @@ rhel9cis_rsyslog_ansiblemanaged: true #### 4.2.1.6 remote and destation log server name rhel9cis_remote_log_server: false -rhel9cis_remote_log_host: logagg.example.com +rhel9cis_remote_log_host: 192.168.2.100 rhel9cis_remote_log_port: 514 rhel9cis_remote_log_protocol: tcp rhel9cis_remote_log_retrycount: 100 rhel9cis_remote_log_queuesize: 1000 #### 4.2.1.7 +# This variable expresses whether the system is used as a log server or not. +# If set to `true`, controls that interfere with log server functionality or +# require that own system logs be sent to some other log server are skipped. rhel9cis_system_is_log_server: false # 4.2.2.1.2 # rhel9cis_journal_upload_url is the ip address to upload the journal entries to rhel9cis_journal_upload_url: 192.168.50.42 -# The paths below have the default paths/files, but allow user to create custom paths/filenames + +## The paths below have the default paths/files, but allow user to create custom paths/filenames +# This variable specifies the path to the private key file used by the remote journal +# server to authenticate itself to the client. This key is used alongside the server's +# public certificate to establish secure communication. rhel9cis_journal_upload_serverkeyfile: "/etc/ssl/private/journal-upload.pem" +# This variable specifies the path to the public certificate file of the remote journal +# server. This certificate is used to verify the authenticity of the remote server. rhel9cis_journal_servercertificatefile: "/etc/ssl/certs/journal-upload.pem" +# This variable specifies the path to a file containing one or more public certificates +# of certificate authorities (CAs) that the client trusts. These trusted certificates are used +# to validate the authenticity of the remote server's certificate. rhel9cis_journal_trustedcertificatefile: "/etc/ssl/ca/trusted.pem" # 4.2.2.1 # The variables below related to journald, please set these to your site specific values +# These variable specifies how much disk space the journal may use up at most +# Specify values in bytes or use K, M, G, T, P, E as units for the specified sizes. +# See https://www.freedesktop.org/software/systemd/man/journald.conf.html for more information. +# ATTENTION: Uncomment the keyword below when values are set! # rhel9cis_journald_systemmaxuse is the max amount of disk space the logs will use rhel9cis_journald_systemmaxuse: 10M # rhel9cis_journald_systemkeepfree is the amount of disk space to keep free rhel9cis_journald_systemkeepfree: 100G +# rhel9cis_journald_runtimemaxuse control how much disk space the journal may use up at most. +# same as rhel9cis_journald_systemmaxuse. rhel9cis_journald_runtimemaxuse: 10M +# rhel9cis_journald_runtimekeepfree is the amount of disk space to keep free +# same as rhel9cis_journald_systemkeepfree. rhel9cis_journald_runtimekeepfree: 100G -# rhel9cis_journald_MaxFileSec is how long in time to keep log files. Values are Xm, Xh, Xday, Xweek, Xmonth, Xyear, for example 2week is two weeks +# rhel9cis_journald_MaxFileSec is how long in time to keep log files. +# This variable specifies, the maximum time to store entries in a single journal +# file before rotating to the next one. Set to 0 to turn off this feature. +# The given values is interpreted as seconds, unless suffixed with the units +# `year`, `month`, `week`, `day`, `h` or `m` to override the default time unit of seconds. +# Values are Xm, Xh, Xday, Xweek, Xmonth, Xyear, for example 2week is two weeks +# ATTENTION: Uncomment the keyword below when values are set! rhel9cis_journald_maxfilesec: 1month #### 4.3 +# This variable defines the log file rotation period. +# Options are: daily, monthly, yearly. rhel9cis_logrotate: "daily" ## Section5 vars @@ -565,20 +720,61 @@ rhel9cis_logrotate: "daily" rhel9_cis_sshd_config_file: /etc/ssh/sshd_config rhel9cis_sshd: - clientalivecountmax: 0 - clientaliveinterval: 900 + # This variable sets the maximum number of unresponsive "keep-alive" messages + # that can be sent from the server to the client before the connection is considered + # inactive and thus, closed. + clientalivecountmax: 3 + # This variable sets the time interval in seconds between sending "keep-alive" + # messages from the server to the client. These types of messages are intended to + # keep the connection alive and prevent it being terminated due to inactivity. + clientaliveinterval: 300 + # This variable specifies the amount of seconds allowed for successful authentication to + # the SSH server. logingracetime: 60 - # WARNING: make sure you understand the precedence when working with these values!! - # allowusers: - # allowgroups: systems dba - # denyusers: - # denygroups: + # This variable, if specified, configures a list of USER name patterns, separated by spaces, to allow SSH + # access for users whose user name matches one of the patterns. This is done + # by setting the value of `AllowUsers` option in `/etc/ssh/sshd_config` file. + # If an USER@HOST format will be used, the specified user will be allowed only on that particular host. + # The allow/deny directives process order: DenyUsers, AllowUsers, DenyGroups, AllowGroups. + # For more info, see https://linux.die.net/man/5/sshd_config + allow_users: "" + # (String) This variable, if spcieifed, configures a list of GROUP name patterns, separated by spaces, to allow SSH access + # for users whose primary group or supplementary group list matches one of the patterns. This is done + # by setting the value of `AllowGroups` option in `/etc/ssh/sshd_config` file. + # The allow/deny directives process order: DenyUsers, AllowUsers, DenyGroups, AllowGroups. + # For more info, https://linux.die.net/man/5/sshd_config + allow_groups: wheel + # This variable, if specified, configures a list of USER name patterns, separated by spaces, to prevent SSH access + # for users whose user name matches one of the patterns. This is done + # by setting the value of `DenyUsers` option in `/etc/ssh/sshd_config` file. + # If an USER@HOST format will be used, the specified user will be restricted only on that particular host. + # The allow/deny directives process order: DenyUsers, AllowUsers, DenyGroups, AllowGroups. + # For more info, see https://linux.die.net/man/5/sshd_config + deny_users: nobody + # This variable, if specified, configures a list of GROUP name patterns, separated by spaces, to prevent SSH access + # for users whose primary group or supplementary group list matches one of the patterns. This is done + # by setting the value of `DenyGroups` option in `/etc/ssh/sshd_config` file. + # The allow/deny directives process order: DenyUsers, AllowUsers, DenyGroups, AllowGroups. + # For more info, see https://linux.die.net/man/5/sshd_config + deny_groups: "" -# 5.2.5 SSH LogLevel setting. Options are INFO or VERBOSE +# 5.2.5 SSH LogLevel setting. +# This variable is used to control the verbosity of the logging produced by the SSH server. +# The options for setting it are as follows: +# - `QUIET`: Minimal logging; +# - `FATAL`: logs only fatal errors; +# - `ERROR`: logs error messages; +# - `INFO`: logs informational messages in addition to errors; +# - `VERBOSE`: logs a higher level of detail, including login attempts and key exchanges; +# - `DEBUG`: generates very detailed debugging information including sensitive information. +# - `DEBUG(x)`: Whereas x = debug level 1 to 3, DEBUG=DEBUG1. rhel9cis_ssh_loglevel: INFO # 5.2.19 SSH MaxSessions setting. Must be 4 our less rhel9cis_ssh_maxsessions: 4 +## Control 5.5.1.4 +# This variable specifies the number of days of inactivity before an account will be locked. +# CIS requires a value of 30 days or less. rhel9cis_inactivelock: lock_days: 30 @@ -596,32 +792,65 @@ rhel9cis_authselect_custom_profile_create: false # 5.3.2 Enable automation to select custom profile options, using the settings above rhel9cis_authselect_custom_profile_select: false +## Controls 5.5.1.x - Password settings rhel9cis_pass: + ## Control 5.5.1.2 + # This variable governs after how many days a password expires. + # CIS requires a value of 365 or less. max_days: 365 + ## Control 5.5.1.1 + # This variable specifies the minimum number of days allowed between changing passwords. + # CIS requires a value of at least 1. min_days: 7 + ## Control 5.5.1.3 + # This variable governs, how many days before a password expires, the user will be warned. + # CIS requires a value of at least 7. warn_age: 7 # 5.5.1 ## PAM rhel9cis_pam_password: + # This variable sets the minimum chars a password needs to be set. minlen: 14 + # This variable set password complexity,the minimum number of + # character types that must be used (i.e., uppercase, lowercase, digits, other) + # Set to 2, passwords cannot have all lower/upper case. + # Set to 3, passwords needs numbers. + # set to 4, passwords will have to include all four types of characters. minclass: 4 rhel9cis_pam_faillock: + # This variable sets the amount of time a user will be unlocked after + # the max amount of password failures. unlock_time: 900 + # This variable sets the amount of tries a password can be entered, before a user is locked. deny: 5 + # This variable represents the number of password change cycles, after which + # a user can re-use a password. + # CIS requires a value of 5 or more. remember: 5 # UID settings for interactive users # These are discovered via logins.def if set true discover_int_uid: false +# This variable sets the minimum number from which to search for UID +# Note that the value will be dynamically overwritten if variable `dicover_int_uid` has +# been set to `true`. min_int_uid: 1000 +# This variable sets the maximum number at which the search stops for UID +# Note that the value will be dynamically overwritten if variable `dicover_int_uid` has +# been set to `true`. max_int_uid: 65533 # 5.3.3 var log location variable +# This variable defines the path and file name of the sudo log file. rhel9cis_sudolog_location: "/var/log/sudo.log" #### 5.3.6 +# This variable sets the duration (in minutes) during which a user's authentication credentials +# are cached after successfully authenticating using "sudo". This allows the user to execute +# multiple commands with elevated privileges without needing to re-enter their password for each +# command within the specified time period. CIS requires a value of at most 15 minutes. rhel9cis_sudo_timestamp_timeout: 15 ### 5.4.2 authselect and faillock @@ -636,12 +865,24 @@ rhel9cis_5_4_2_risks: NEVER # Session timeout setting file (TMOUT setting can be set in multiple files) # Timeout value is in seconds. (60 seconds * 10 = 600) rhel9cis_shell_session_timeout: + # This variable specifies the path of the timeout setting file. + # (TMOUT setting can be set in multiple files, but only one is required for the + # rule to pass. Options are: + # - a file in `/etc/profile.d/` ending in `.s`, + # - `/etc/profile`, or + # - `/etc/bash.bashrc`. file: /etc/profile.d/tmout.sh + # This variable represents the amount of seconds a command or process is allowed to + # run before being forcefully terminated. + # CIS requires a value of at most 900 seconds. timeout: 600 # RHEL-09-5.4.1.5 Allow ansible to expire password for account with a last changed date in the future. False will just display users in violation, true will expire those users passwords rhel9cis_futurepwchgdate_autofix: true -# 5.3.7 +## 5.3.7 +# This variable determines the group of users that are allowed to use the su command. +# one to specify a user group that is allowed to use the "su" command. +# CIS requires that such a group be created (named according to site policy) and be kept empty. rhel9cis_sugroup: nosugroup ## Section6 vars @@ -654,7 +895,7 @@ rhel9cis_no_world_write_adjust: true rhel9cis_passwd_label: "{{ (this_item | default(item)).id }}: {{ (this_item | default(item)).dir }}" # 6.2.16 -## Dont follow symlinks for changes to user home directory thanks to @dulin-gnet and comminty for rhel8-cis reedbacj +## Dont follow symlinks for changes to user home directory thanks to @dulin-gnet and community for rhel8-cis reedbacj rhel_09_6_2_16_home_follow_symlinks: false #### Goss Configuration Settings #### From 34b052196cf14c2609eac3d92076b746c4d1e1ed Mon Sep 17 00:00:00 2001 From: "root@DERVISHx" Date: Wed, 29 Nov 2023 15:50:23 +0000 Subject: [PATCH 02/14] Document variables in defaults/main.yml, Fix 5 from devel Signed-off-by: root@DERVISHx --- defaults/main.yml | 313 ++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 277 insertions(+), 36 deletions(-) diff --git a/defaults/main.yml b/defaults/main.yml index 0bc0137..bf059d1 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -11,6 +11,10 @@ system_is_ec2: false # Supported OSs will not need for this to be changed - see README e.g. CentOS os_check: true +## Switching on/off specific baseline sections +# These variables govern whether the tasks of a particular section are to be executed when running the role. +# E.g: If you want to execute the tasks of Section 1 you should set the "_section1" variable to true. +# to "true". If you do not want the tasks from that section to get executed you simply set the variable to "false". rhel9cis_section1: true rhel9cis_section2: true rhel9cis_section3: true @@ -22,6 +26,7 @@ rhel9cis_section6: true # e.g. # - level1-server # - level2-workstation +# Used for audit rhel9cis_level_1: true rhel9cis_level_2: true @@ -39,7 +44,8 @@ benchmark_version: 'v1.0.0' benchmark: RHEL9-CIS -# Whether to skip the reboot +# Whether to skip the system reboot before audit +# System will reboot if false, can give better audit results skip_reboot: true # default value will change to true but wont reboot if not enabled but will error @@ -48,11 +54,20 @@ change_requires_reboot: false ########################################## ### Goss is required on the remote host ### ## Refer to vars/auditd.yml for any other settings ## +#### Basic external goss audit enablement settings #### +#### Precise details - per setting can be found at the bottom of this file #### -# Allow audit to setup the requirements including installing git (if option chosen and downloading and adding goss binary to system) +## Audit setup +# Audits are carried out using Goss. This variable +# determines whether execution of the role prepares for auditing +# by installing the required binary. setup_audit: false -# enable audits to run - this runs the audit and get the latest content +## Enable audits to run +# This variable governs whether the audit using the +# separately maintained audit role using Goss +# is carried out. +# This runs the audit and get the latest content run_audit: false # Only run Audit do not remediate @@ -63,8 +78,10 @@ fetch_audit_files: false # Path to copy the files to will create dir structure audit_capture_files_dir: /some/location to copy to on control node -# How to retrieve audit binary +## How to retrive goss # Options are copy or download - detailed settings at the bottom of this file +# provided in variable `audit_conf_copy` for copying or +# the url given in variable `audit_files_url` for downloading. # you will need to access to either github or the file already dowmloaded get_audit_binary_method: download @@ -73,8 +90,15 @@ get_audit_binary_method: download ## e.g copy from ansible control node to remote host audit_bin_copy_location: /some/accessible/path -# how to get audit files onto host options +## How to retrieve the audit role +# The role for auditing is maintained separately. +# This variable specifies the method of how to get the audit role # options are git/copy/get_url other e.g. if you wish to run from already downloaded conf +# onto the system. The options are as follows: +# - git: clone from git repository as specified in variable `audit_file_git` in +# the version specified by variable `audit_git_version` +# - copy: copy from path as specified in variable `audit_conf_copy` +# - get_url: Download from url as specified in variable `audit_files_url` audit_content: git # archive or copy: @@ -86,10 +110,11 @@ audit_files_url: "some url maybe s3?" # Run heavy tests - some tests can have more impact on a system enabling these can have greater impact on a system audit_run_heavy_tests: true +# Timeout for those cmds that take longer to run where timeout set # This variable specifies the timeout (in ms) for audit commands that # take a very long time: if a command takes too long to complete, # it will be forcefully terminated after the specified duration. -audit_cmd_timeout: 120000 +audit_cmd_timeout: 60000 ### End Goss enablements #### @@ -97,7 +122,8 @@ audit_cmd_timeout: 120000 # the CIS benchmark documents. # PLEASE NOTE: These work in coordination with the section # group variables and tags. # You must enable an entire section in order for the variables below to take effect. -# Section 1 rules +# Section 1 is Initial setup (FileSystem Configuration, Configure Software Updates, Filesystem Integrity Checking, Secure Boot Settings, +# Additional Process Hardening, Mandatory Access Control, Command Line Warning Banners, and GNOME Display Manager) rhel9cis_rule_1_1_1_1: true rhel9cis_rule_1_1_1_2: true rhel9cis_rule_1_1_2_1: true @@ -170,7 +196,7 @@ rhel9cis_rule_1_8_10: true rhel9cis_rule_1_9: true rhel9cis_rule_1_10: true -# Section 2 rules +# Section 2 rules are controling Services (Special Purpose Services, and service clients) rhel9cis_rule_2_1_1: true rhel9cis_rule_2_1_2: true rhel9cis_rule_2_2_1: true @@ -198,6 +224,7 @@ rhel9cis_rule_2_3_4: true rhel9cis_rule_2_4: true # Section 3 rules +# Network Configuration rhel9cis_rule_3_1_1: true rhel9cis_rule_3_1_2: true rhel9cis_rule_3_1_3: true @@ -222,7 +249,8 @@ rhel9cis_rule_3_4_2_5: true rhel9cis_rule_3_4_2_6: true rhel9cis_rule_3_4_2_7: true -# Section 4 rules +# Section 4 rules are Logging and Auditing (Configure System Accounting (auditd), +# Configure Data Retention, and Configure Logging) rhel9cis_rule_4_1_1_1: true rhel9cis_rule_4_1_1_2: true rhel9cis_rule_4_1_1_3: true @@ -281,7 +309,8 @@ rhel9cis_rule_4_2_2_7: true rhel9cis_rule_4_2_3: true rhel9cis_rule_4_3: true -# Section 5 rules +# Section 5 rules control Access, Authentication, and Authorization (Configure time-based job schedulers, +# Configure sudo, Configure SSH Server, Configure PAM and User Accounts and Environment) rhel9cis_rule_5_1_1: true rhel9cis_rule_5_1_2: true rhel9cis_rule_5_1_3: true @@ -336,7 +365,8 @@ rhel9cis_rule_5_6_4: true rhel9cis_rule_5_6_5: true rhel9cis_rule_5_6_6: true -# Section 6 rules +# Section 6 rules controls System Maintenance (System File Permissions and User and Group Settings) +rhel9cis_rule_6_1_1: true rhel9cis_rule_6_1_1: true rhel9cis_rule_6_1_2: true rhel9cis_rule_6_1_3: true @@ -402,9 +432,16 @@ rhel9cis_bootloader_password_hash: 'grub.pbkdf2.sha512.10000.9306A36764A7BEA3BF4 rhel9cis_bootloader_password: random # pragma: allowlist secret rhel9cis_set_boot_pass: true -# 1.8 Gnome Desktop +## Controls 1.8.x - Settings for GDM +# This variable specifies the GNOME configuration database file to which configurations are written. +# (See https://help.gnome.org/admin/system-admin-guide/stable/dconf-keyfiles.html.en) +# The default database is `local` rhel9cis_dconf_db_name: local + +# This variable governs the number of seconds of inactivity before the screen goes blank. rhel9cis_screensaver_idle_delay: 900 # Set max value for idle-delay in seconds (between 1 and 900) + +# This variable governs the number of seconds the screen remains blank before it is locked. rhel9cis_screensaver_lock_delay: 5 # Set max value for lock-delay in seconds (between 0 and 5) # 1.10/1.11 Set crypto policy (LEGACY, DEFAULT, FUTURE, FIPS) @@ -414,27 +451,67 @@ rhel9cis_crypto_policy: 'DEFAULT' rhel9cis_crypto_policy_module: '' # System network parameters (host only OR host and router) +# This variable governs whether specific CIS rules +# concerned with acceptance and routing of packages are skipped. rhel9cis_is_router: false -# IPv6 required +## IPv6 requirement toggle +# This variable governs whether ipv6 is enabled or disabled. rhel9cis_ipv6_required: true -# AIDE +## Control 1.3.1 - allow aide to be configured +# AIDE is a file integrity checking tool, similar in nature to Tripwire. +# While it cannot prevent intrusions, it can detect unauthorized changes +# to configuration files by alerting when the files are changed. Review +# the AIDE quick start guide and AIDE documentation before proceeding. +# By setting this variable to `true`, all of the settings related to AIDE will be applied! rhel9cis_config_aide: true -# AIDE cron settings + +## Control 1.3.2 AIDE cron settings +# These are the crontab settings for periodical checking of the filesystem's integrity using AIDE. +# The sub-settings of this variable provide the parameters required to configure +# the cron job on the target system. +# Cron is a time-based job scheduling program in Unix OS, which allows tasks to be scheduled +# and executed automatically at a certain point in time. rhel9cis_aide_cron: + # This variable represents the user account under which the cron job for AIDE will run. cron_user: root + # This variable represents the path to the AIDE crontab file. cron_file: /etc/cron.d/aide_cron + # This variable represents the actual command or script that the cron job + # will execute for running AIDE. aide_job: '/usr/sbin/aide --check' + # These variables define the schedule for the cron job + # This variable governs the minute of the time of day when the AIDE cronjob is run. + # It must be in the range `0-59`. aide_minute: 0 + # This variable governs the hour of the time of day when the AIDE cronjob is run. + # It must be in the range `0-23`. aide_hour: 5 + # This variable governs the day of the month when the AIDE cronjob is run. + # `*` signifies that the job is run on all days; furthermore, specific days + # can be given in the range `1-31`; several days can be concatenated with a comma. + # The specified day(s) can must be in the range `1-31`. aide_day: '*' + # This variable governs months when the AIDE cronjob is run. + # `*` signifies that the job is run in every month; furthermore, specific months + # can be given in the range `1-12`; several months can be concatenated with commas. + # The specified month(s) can must be in the range `1-12`. aide_month: '*' + # This variable governs the weekdays, when the AIDE cronjob is run. + # `*` signifies that the job is run on all weekdays; furthermore, specific weekdays + # can be given in the range `0-7` (both `0` and `7` represent Sunday); several weekdays + # can be concatenated with commas. aide_weekday: '*' # SELinux policy +# This selects type of policy; targeted or mls ( multilevel ) +# mls should not be used, since it will disable unconfined policy module +# and may prevent some services from running. rhel9cis_selinux_pol: targeted # chose onf or enfocing or permissive +# CIS expects enforcing since permissive allows operations thet might compromise the system. +# Even though logging still occurs. rhel9cis_selinux_enforce: enforcing # Whether or not to run tasks related to auditing/patching the desktop environment @@ -443,6 +520,11 @@ rhel9cis_selinux_enforce: enforcing ### 2.1 Time Synchronization #### 2.1.2 Time Synchronization servers - used in template file chrony.conf.j2 +# The following variable represents a list of of time servers used +# for configuring chrony, timesyncd, and ntp. +# Each list item contains two settings, `name` (the domain name of the server) and synchronization `options`. +# The default setting for the `options` is `minpoll` but `iburst` can be used, please refer to the documentation +# of the time synchronization mechanism you are using. rhel9cis_time_synchronization_servers: - 0.pool.ntp.org - 1.pool.ntp.org @@ -451,7 +533,9 @@ rhel9cis_time_synchronization_servers: rhel9cis_chrony_server_options: "minpoll 8" ### 2.2 Special Purposes -##### Service configuration booleans set true to keep service +# Service configuration variables (boolean). +# Set the respective variable to true to keep the service. +# otherwise the service is stopped and disabled rhel9cis_gui: false rhel9cis_avahi_server: false rhel9cis_cups_server: false @@ -469,10 +553,12 @@ rhel9cis_squid_server: false rhel9cis_snmp_server: false rhel9cis_telnet_server: false rhel9cis_is_mail_server: false -# Note the options -# Packages are used for client services and Server- only remove if you dont use the client service -# +# Note the options +# Client package configuration variables. +# Packages are used for client services and Server- only remove if you dont use the client service +# Set the respective variable to `true` to keep the +# client package, otherwise it is uninstalled (false). rhel9cis_use_nfs_server: false rhel9cis_use_nfs_service: false @@ -488,7 +574,7 @@ rhel9cis_openldap_clients_required: false rhel9cis_tftp_client: false rhel9cis_ftp_client: false -## Section3 vars +## Section 3 vars for ## Sysctl rhel9cis_sysctl_update: false rhel9cis_flush_ipv4_route: false @@ -509,7 +595,11 @@ rhel9cis_firewalld_ports: - number: 80 protocol: tcp -#### nftables +## Controls 3.5.2.x - nftables +# The default nftables table name is "filter". This variable name will be the one all +# "rhel9cis_nft_tables_tablename" is the name of the table in nftables you want to create. +# nftables configs are applied to. +# options are: inet filter rhel9cis_nft_tables_autonewtable: true rhel9cis_nft_tables_tablename: filter rhel9cis_nft_tables_autochaincreate: true @@ -521,23 +611,60 @@ rhel9cis_warning_banner: Authorized uses only. All activity may be monitored and ## Section4 vars ### 4.1 Configure System Accounting #### 4.1.2 Configure Data Retention +## Controls what actions, when log files fill up +# This variable controls how the audit system behaves when +# log files are getting too full and space is getting too low. rhel9cis_auditd: space_left_action: email action_mail_acct: root + # This variable determines the action the audit system should take when disk + # space runs low. + # The options for setting this variable are as follows: + # - `ignore`: the system does nothing when presented with the aforementioned issue; + # - `syslog`: a message is sent to the system log about disk space running low; + # - `suspend`: the system suspends recording audit events until more space is available; + # - `halt`: the system is halted when disk space is critically low. + # - `single`: the audit daemon will put the computer system in single user mode + # CIS prescribes either `halt` or `single`. admin_space_left_action: halt + # This variable determines what action the audit system should take when the maximum + # size of a log file is reached. + # The options for setting this variable are as follows: + # - `ignore`: the system does nothing when the size of a log file is full; + # - `syslog`: a message is sent to the system log indicating the problem; + # - `suspend`: the system suspends recording audit events until the log file is cleared or rotated; + # - `rotate`: the log file is rotated (archived) and a new empty log file is created; + # - `keep_logs`: the system attempts to keep as many logs as possible without violating disk space constraints. + # CIS prescribes the value `keep_logs`. max_log_file_action: keep_logs -# The audit_back_log_limit value should never be below 8192 +## Control 4.1.1.4 - Ensure rhel9cis_audit_back_log_limit is sufficient +# This variable represents the audit backlog limit, i.e., the maximum number of audit records that the +# system can buffer in memory, if the audit subsystem is unable to process them in real-time. +# Buffering in memory is useful in situations, where the audit system is overwhelmed +# with incoming audit events, and needs to temporarily store them until they can be processed. +# This variable should be set to a sufficient value. The CIS baseline recommends at least `8192` as value. rhel9cis_audit_back_log_limit: 8192 -# The max_log_file parameter should be based on your sites policy +## Control 4.1.2.1 - Ensure audit log storage size is configured +# This variable specifies the maximum size in MB that an audit log file can reach +# before it is archived or deleted to make space for the new audit data. +# This should be set based on your sites policy. CIS does not provide a specific value. rhel9cis_max_log_file_size: 10 -### 4.1.3.x audit template +## 4.1.3.x - Audit template +# This variable is set to true by tasks 4.1.3.1 to 4.1.3.20. As a result, the +# audit settings are overwritten with the role's template. In order to exclude +# specific rules, you must set the variable of form `rhel9cis_rule_4_1_3_x` above +# to `false`. update_audit_template: false ## Advanced option found in auditd post +# users whose actions are not logged by auditd rhel9cis_allow_auditd_uid_user_exclusions: false +# add a list of uids to be excluded. +rhel9cis_auditd_uid_exclude: + - 1999 # This can be used to configure other keys in auditd.conf rhel9cis_auditd_extra_conf: {} @@ -553,35 +680,63 @@ rhel9cis_rsyslog_ansiblemanaged: true #### 4.2.1.6 remote and destation log server name rhel9cis_remote_log_server: false -rhel9cis_remote_log_host: logagg.example.com +rhel9cis_remote_log_host: 192.168.2.100 rhel9cis_remote_log_port: 514 rhel9cis_remote_log_protocol: tcp rhel9cis_remote_log_retrycount: 100 rhel9cis_remote_log_queuesize: 1000 #### 4.2.1.7 +# This variable expresses whether the system is used as a log server or not. +# If set to `true`, controls that interfere with log server functionality or +# require that own system logs be sent to some other log server are skipped. rhel9cis_system_is_log_server: false # 4.2.2.1.2 # rhel9cis_journal_upload_url is the ip address to upload the journal entries to rhel9cis_journal_upload_url: 192.168.50.42 -# The paths below have the default paths/files, but allow user to create custom paths/filenames + +## The paths below have the default paths/files, but allow user to create custom paths/filenames +# This variable specifies the path to the private key file used by the remote journal +# server to authenticate itself to the client. This key is used alongside the server's +# public certificate to establish secure communication. rhel9cis_journal_upload_serverkeyfile: "/etc/ssl/private/journal-upload.pem" +# This variable specifies the path to the public certificate file of the remote journal +# server. This certificate is used to verify the authenticity of the remote server. rhel9cis_journal_servercertificatefile: "/etc/ssl/certs/journal-upload.pem" +# This variable specifies the path to a file containing one or more public certificates +# of certificate authorities (CAs) that the client trusts. These trusted certificates are used +# to validate the authenticity of the remote server's certificate. rhel9cis_journal_trustedcertificatefile: "/etc/ssl/ca/trusted.pem" # 4.2.2.1 # The variables below related to journald, please set these to your site specific values +# These variable specifies how much disk space the journal may use up at most +# Specify values in bytes or use K, M, G, T, P, E as units for the specified sizes. +# See https://www.freedesktop.org/software/systemd/man/journald.conf.html for more information. +# ATTENTION: Uncomment the keyword below when values are set! # rhel9cis_journald_systemmaxuse is the max amount of disk space the logs will use rhel9cis_journald_systemmaxuse: 10M # rhel9cis_journald_systemkeepfree is the amount of disk space to keep free rhel9cis_journald_systemkeepfree: 100G +# rhel9cis_journald_runtimemaxuse control how much disk space the journal may use up at most. +# same as rhel9cis_journald_systemmaxuse. rhel9cis_journald_runtimemaxuse: 10M +# rhel9cis_journald_runtimekeepfree is the amount of disk space to keep free +# same as rhel9cis_journald_systemkeepfree. rhel9cis_journald_runtimekeepfree: 100G -# rhel9cis_journald_MaxFileSec is how long in time to keep log files. Values are Xm, Xh, Xday, Xweek, Xmonth, Xyear, for example 2week is two weeks +# rhel9cis_journald_MaxFileSec is how long in time to keep log files. +# This variable specifies, the maximum time to store entries in a single journal +# file before rotating to the next one. Set to 0 to turn off this feature. +# The given values is interpreted as seconds, unless suffixed with the units +# `year`, `month`, `week`, `day`, `h` or `m` to override the default time unit of seconds. +# Values are Xm, Xh, Xday, Xweek, Xmonth, Xyear, for example 2week is two weeks +# ATTENTION: Uncomment the keyword below when values are set! rhel9cis_journald_maxfilesec: 1month #### 4.3 +# This variable defines the log file rotation period. +# Options are: daily, monthly, yearly. rhel9cis_logrotate: "daily" ## Section5 vars @@ -590,20 +745,61 @@ rhel9cis_logrotate: "daily" rhel9_cis_sshd_config_file: /etc/ssh/sshd_config rhel9cis_sshd: - clientalivecountmax: 0 - clientaliveinterval: 900 + # This variable sets the maximum number of unresponsive "keep-alive" messages + # that can be sent from the server to the client before the connection is considered + # inactive and thus, closed. + clientalivecountmax: 3 + # This variable sets the time interval in seconds between sending "keep-alive" + # messages from the server to the client. These types of messages are intended to + # keep the connection alive and prevent it being terminated due to inactivity. + clientaliveinterval: 300 + # This variable specifies the amount of seconds allowed for successful authentication to + # the SSH server. logingracetime: 60 - # WARNING: make sure you understand the precedence when working with these values!! - # allowusers: - # allowgroups: systems dba - # denyusers: - # denygroups: + # This variable, if specified, configures a list of USER name patterns, separated by spaces, to allow SSH + # access for users whose user name matches one of the patterns. This is done + # by setting the value of `AllowUsers` option in `/etc/ssh/sshd_config` file. + # If an USER@HOST format will be used, the specified user will be allowed only on that particular host. + # The allow/deny directives process order: DenyUsers, AllowUsers, DenyGroups, AllowGroups. + # For more info, see https://linux.die.net/man/5/sshd_config + allow_users: "" + # (String) This variable, if spcieifed, configures a list of GROUP name patterns, separated by spaces, to allow SSH access + # for users whose primary group or supplementary group list matches one of the patterns. This is done + # by setting the value of `AllowGroups` option in `/etc/ssh/sshd_config` file. + # The allow/deny directives process order: DenyUsers, AllowUsers, DenyGroups, AllowGroups. + # For more info, https://linux.die.net/man/5/sshd_config + allow_groups: "wheel" + # This variable, if specified, configures a list of USER name patterns, separated by spaces, to prevent SSH access + # for users whose user name matches one of the patterns. This is done + # by setting the value of `DenyUsers` option in `/etc/ssh/sshd_config` file. + # If an USER@HOST format will be used, the specified user will be restricted only on that particular host. + # The allow/deny directives process order: DenyUsers, AllowUsers, DenyGroups, AllowGroups. + # For more info, see https://linux.die.net/man/5/sshd_config + deny_users: "nobody" + # This variable, if specified, configures a list of GROUP name patterns, separated by spaces, to prevent SSH access + # for users whose primary group or supplementary group list matches one of the patterns. This is done + # by setting the value of `DenyGroups` option in `/etc/ssh/sshd_config` file. + # The allow/deny directives process order: DenyUsers, AllowUsers, DenyGroups, AllowGroups. + # For more info, see https://linux.die.net/man/5/sshd_config + deny_groups: "" -# 5.2.5 SSH LogLevel setting. Options are INFO or VERBOSE +# 5.2.5 SSH LogLevel setting. +# This variable is used to control the verbosity of the logging produced by the SSH server. +# The options for setting it are as follows: +# - `QUIET`: Minimal logging; +# - `FATAL`: logs only fatal errors; +# - `ERROR`: logs error messages; +# - `INFO`: logs informational messages in addition to errors; +# - `VERBOSE`: logs a higher level of detail, including login attempts and key exchanges; +# - `DEBUG`: generates very detailed debugging information including sensitive information. +# - `DEBUG(x)`: Whereas x = debug level 1 to 3, DEBUG=DEBUG1. rhel9cis_ssh_loglevel: INFO # 5.2.19 SSH MaxSessions setting. Must be 4 our less rhel9cis_ssh_maxsessions: 4 +## Control 5.5.1.4 +# This variable specifies the number of days of inactivity before an account will be locked. +# CIS requires a value of 30 days or less. rhel9cis_inactivelock: lock_days: 30 @@ -621,32 +817,65 @@ rhel9cis_authselect_custom_profile_create: false # 5.3.2 Enable automation to select custom profile options, using the settings above rhel9cis_authselect_custom_profile_select: false +## Controls 5.5.1.x - Password settings rhel9cis_pass: + ## Control 5.5.1.2 + # This variable governs after how many days a password expires. + # CIS requires a value of 365 or less. max_days: 365 + ## Control 5.5.1.1 + # This variable specifies the minimum number of days allowed between changing passwords. + # CIS requires a value of at least 1. min_days: 7 + ## Control 5.5.1.3 + # This variable governs, how many days before a password expires, the user will be warned. + # CIS requires a value of at least 7. warn_age: 7 # 5.5.1 ## PAM rhel9cis_pam_password: + # This variable sets the minimum chars a password needs to be set. minlen: 14 + # This variable set password complexity,the minimum number of + # character types that must be used (i.e., uppercase, lowercase, digits, other) + # Set to 2, passwords cannot have all lower/upper case. + # Set to 3, passwords needs numbers. + # set to 4, passwords will have to include all four types of characters. minclass: 4 rhel9cis_pam_faillock: + # This variable sets the amount of time a user will be unlocked after + # the max amount of password failures. unlock_time: 900 + # This variable sets the amount of tries a password can be entered, before a user is locked. deny: 5 + # This variable represents the number of password change cycles, after which + # a user can re-use a password. + # CIS requires a value of 5 or more. remember: 5 # UID settings for interactive users # These are discovered via logins.def if set true discover_int_uid: false +# This variable sets the minimum number from which to search for UID +# Note that the value will be dynamically overwritten if variable `dicover_int_uid` has +# been set to `true`. min_int_uid: 1000 +# This variable sets the maximum number at which the search stops for UID +# Note that the value will be dynamically overwritten if variable `dicover_int_uid` has +# been set to `true`. max_int_uid: 65533 # 5.3.3 var log location variable +# This variable defines the path and file name of the sudo log file. rhel9cis_sudolog_location: "/var/log/sudo.log" #### 5.3.6 +# This variable sets the duration (in minutes) during which a user's authentication credentials +# are cached after successfully authenticating using "sudo". This allows the user to execute +# multiple commands with elevated privileges without needing to re-enter their password for each +# command within the specified time period. CIS requires a value of at most 15 minutes. rhel9cis_sudo_timestamp_timeout: 15 ### 5.4.2 authselect and faillock @@ -661,12 +890,24 @@ rhel9cis_5_4_2_risks: NEVER # Session timeout setting file (TMOUT setting can be set in multiple files) # Timeout value is in seconds. (60 seconds * 10 = 600) rhel9cis_shell_session_timeout: + # This variable specifies the path of the timeout setting file. + # (TMOUT setting can be set in multiple files, but only one is required for the + # rule to pass. Options are: + # - a file in `/etc/profile.d/` ending in `.s`, + # - `/etc/profile`, or + # - `/etc/bash.bashrc`. file: /etc/profile.d/tmout.sh + # This variable represents the amount of seconds a command or process is allowed to + # run before being forcefully terminated. + # CIS requires a value of at most 900 seconds. timeout: 600 # RHEL-09-5.4.1.5 Allow ansible to expire password for account with a last changed date in the future. False will just display users in violation, true will expire those users passwords rhel9cis_futurepwchgdate_autofix: true # 5.3.7 +# This variable determines the group of users that are allowed to use the su command. +# one to specify a user group that is allowed to use the "su" command. +# CIS requires that such a group be created (named according to site policy) and be kept empty. rhel9cis_sugroup: nosugroup ## Section6 vars @@ -679,7 +920,7 @@ rhel9cis_no_world_write_adjust: true rhel9cis_passwd_label: "{{ (this_item | default(item)).id }}: {{ (this_item | default(item)).dir }}" # 6.2.16 -## Dont follow symlinks for changes to user home directory thanks to @dulin-gnet and comminty for rhel8-cis reedbacj +## Dont follow symlinks for changes to user home directory thanks to @dulin-gnet and community for rhel8-cis reedback. rhel_09_6_2_16_home_follow_symlinks: false #### Goss Configuration Settings #### From dc59c320c831de88f774417c6227ad706b56006c Mon Sep 17 00:00:00 2001 From: Ionut Pruteanu Date: Tue, 5 Dec 2023 21:01:06 +0200 Subject: [PATCH 03/14] Small additions to first part of documentation. Signed-off-by: Ionut Pruteanu --- defaults/main.yml | 62 ++++++++++++++++++++++++++++++----------------- 1 file changed, 40 insertions(+), 22 deletions(-) diff --git a/defaults/main.yml b/defaults/main.yml index bf059d1..4ff25a7 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -1,7 +1,19 @@ --- # defaults file for rhel9-cis +# WARNING: +# These values may be overriden by other vars-setting options(e.g. like the below 'container_vars_file'), as explained here: +# https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_variables.html#variable-precedence-where-should-i-put-a-variable +## Usage on containerized images +# The role discovers dynamically (in tasks/main.yml) whether it +# is executed on a container image and sets the variable +# system_is_container the true. Otherwise, the default value +# 'false' is left unchanged. system_is_container: false +# The filename of the existing yml file in role's 'vars/' sub-directory +# to be used for managing the role-behavior when a container was detected: +# (de)activating rules or for other tasks(e.g. disabling Selinux or a specific +# firewall-type). container_vars_file: is_container.yml # rhel9cis is left off the front of this var for consistency in testing pipeline # system_is_ec2 toggle will disable tasks that fail on Amazon EC2 instances. Set true to skip and false to run tasks @@ -14,7 +26,7 @@ os_check: true ## Switching on/off specific baseline sections # These variables govern whether the tasks of a particular section are to be executed when running the role. # E.g: If you want to execute the tasks of Section 1 you should set the "_section1" variable to true. -# to "true". If you do not want the tasks from that section to get executed you simply set the variable to "false". +# If you do not want the tasks from that section to get executed you simply set the variable to "false". rhel9cis_section1: true rhel9cis_section2: true rhel9cis_section3: true @@ -30,7 +42,12 @@ rhel9cis_section6: true rhel9cis_level_1: true rhel9cis_level_2: true +## 1.6 SubSection - Mandatory Access Control +# This variable governs if SELinux is disabled or not. If SELinux is NOT DISABLED by setting +# 'rhel9cis_selinux_disable' to 'true', the 1.6 subsection will be executed. rhel9cis_selinux_disable: false +# This variable is used in a preliminary task, handling grub2 paths either in case of +# UEFI boot('/etc/grub2-efi.cfg') or in case of BIOS legacy-boot('/etc/grub2.cfg'). rhel9cis_legacy_boot: false ## Python Binary @@ -63,29 +80,28 @@ change_requires_reboot: false # by installing the required binary. setup_audit: false -## Enable audits to run +## Enable audits to run - this runs the audit and get the latest content # This variable governs whether the audit using the # separately maintained audit role using Goss # is carried out. -# This runs the audit and get the latest content run_audit: false # Only run Audit do not remediate audit_only: false -# As part of audit_only -# This will enable files to be copied back to control node +# This will enable files to be copied back to control node(part of audit_only) fetch_audit_files: false -# Path to copy the files to will create dir structure +# Path to copy the files to will create dir structure(part of audit_only) audit_capture_files_dir: /some/location to copy to on control node -## How to retrive goss -# Options are copy or download - detailed settings at the bottom of this file -# provided in variable `audit_conf_copy` for copying or -# the url given in variable `audit_files_url` for downloading. -# you will need to access to either github or the file already dowmloaded +## How to retrieve audit binary(Goss) +# Options are 'copy' or 'download' - detailed settings at the bottom of this file +# - if 'copy': +# - the filepath mentioned via the below 'audit_bin_copy_location' var will be used to access already downloaded Goss +# - if 'download': +# - the GitHub Goss-releases URL will be used for a fresh-download, via 'audit_bin_url' and 'audit_pkg_arch_name' vars get_audit_binary_method: download -## if get_audit_binary_method - copy the following needs to be updated for your environment +## if get_audit_binary_method is 'copy', the following var needs to be updated for your environment ## it is expected that it will be copied from somewhere accessible to the control node ## e.g copy from ansible control node to remote host audit_bin_copy_location: /some/accessible/path @@ -95,16 +111,19 @@ audit_bin_copy_location: /some/accessible/path # This variable specifies the method of how to get the audit role # options are git/copy/get_url other e.g. if you wish to run from already downloaded conf # onto the system. The options are as follows: -# - git: clone from git repository as specified in variable `audit_file_git` in -# the version specified by variable `audit_git_version` -# - copy: copy from path as specified in variable `audit_conf_copy` -# - get_url: Download from url as specified in variable `audit_files_url` +# - 'git': clone audit content from GitHub REPOSITORY, set up via `audit_file_git` var, and +# VERSION(e.g. branch, tag name), set up via `audit_git_version` var. +# - 'copy': copy from path as specified in variable `audit_conf_copy`. +# - 'archive': same as 'copy', only that the specified filepath needs to be unpacked. +# - 'get_url': Download from url as specified in variable `audit_files_url` audit_content: git -# archive or copy: +# This variable(only used when 'audit_content' is 'copy' or 'archive') should +# contain the filepath with audit-content to be copied/unarchived on server: audit_conf_copy: "some path to copy from" -# get_url: +# This variable(only used when 'audit_content' is 'get_url') should +# contain the URL from where the audit-content must be downloaded on server: audit_files_url: "some url maybe s3?" # Run heavy tests - some tests can have more impact on a system enabling these can have greater impact on a system @@ -114,7 +133,7 @@ audit_run_heavy_tests: true # This variable specifies the timeout (in ms) for audit commands that # take a very long time: if a command takes too long to complete, # it will be forcefully terminated after the specified duration. -audit_cmd_timeout: 60000 +audit_cmd_timeout: 120000 ### End Goss enablements #### @@ -122,6 +141,7 @@ audit_cmd_timeout: 60000 # the CIS benchmark documents. # PLEASE NOTE: These work in coordination with the section # group variables and tags. # You must enable an entire section in order for the variables below to take effect. + # Section 1 is Initial setup (FileSystem Configuration, Configure Software Updates, Filesystem Integrity Checking, Secure Boot Settings, # Additional Process Hardening, Mandatory Access Control, Command Line Warning Banners, and GNOME Display Manager) rhel9cis_rule_1_1_1_1: true @@ -223,8 +243,7 @@ rhel9cis_rule_2_3_3: true rhel9cis_rule_2_3_4: true rhel9cis_rule_2_4: true -# Section 3 rules -# Network Configuration +# Section 3 rules are used for securely configuring the network configuration(kernel params, ACL, Firewall settings) rhel9cis_rule_3_1_1: true rhel9cis_rule_3_1_2: true rhel9cis_rule_3_1_3: true @@ -367,7 +386,6 @@ rhel9cis_rule_5_6_6: true # Section 6 rules controls System Maintenance (System File Permissions and User and Group Settings) rhel9cis_rule_6_1_1: true -rhel9cis_rule_6_1_1: true rhel9cis_rule_6_1_2: true rhel9cis_rule_6_1_3: true rhel9cis_rule_6_1_4: true From 06489db6a8f60f647c2323d4d227527610a4cbf7 Mon Sep 17 00:00:00 2001 From: Ionut Pruteanu Date: Wed, 6 Dec 2023 22:20:32 +0200 Subject: [PATCH 04/14] Doc additions for: - Yum repos, - bootloader, - crypto policies, - SELinux - NTP Signed-off-by: Ionut Pruteanu --- defaults/main.yml | 51 ++++++++++++++++++++++++++++++++++------------- 1 file changed, 37 insertions(+), 14 deletions(-) diff --git a/defaults/main.yml b/defaults/main.yml index 4ff25a7..e1ef0ce 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -43,7 +43,7 @@ rhel9cis_level_1: true rhel9cis_level_2: true ## 1.6 SubSection - Mandatory Access Control -# This variable governs if SELinux is disabled or not. If SELinux is NOT DISABLED by setting +# This variable governs whether SELinux is disabled or not. If SELinux is NOT DISABLED by setting # 'rhel9cis_selinux_disable' to 'true', the 1.6 subsection will be executed. rhel9cis_selinux_disable: false # This variable is used in a preliminary task, handling grub2 paths either in case of @@ -441,13 +441,21 @@ rhel9cis_rh_sub_password: password # pragma: allowlist secret # RedHat Satellite Subscription items rhel9cis_rhnsd_required: false -# 1.2.4 repo_gpgcheck +# Control 1.2.4 - When installing RHEL from authorized Red Hat source, RHEL will come with default YUM repository. NOT having a default YUM +# repo('rhel9cis_rhel_default_repo' set as 'false'), in conjunction with 'rhel9cis_rule_enable_repogpg' set as 'True', will enable the tasks +# which check the GPG signatures for all the individual YUM repositories. rhel9cis_rhel_default_repo: true +# Control 1.2.4 - When 'rhel9cis_rule_enable_repogpg' is set to 'true'(in conjunction with 'rhel9cis_rhel_default_repo':'false'), conditions are met for +# enabling the GPG signatures-check for all the individual YUM repositories. If GPG signatures-check is enabled on repositories which do not +# support it(like RedHat), installation of packages will fail. rhel9cis_rule_enable_repogpg: true -# 1.4.1 Bootloader password +# Control 1.4.1 - This variable will store the hashed GRUB bootloader password to be stored in '/boot/grub2/user.cfg' file. The default value +# must be changed to a value that may be generated with this command 'grub2-mkpasswd-pbkdf2' and must comply with +# this format: 'grub.pbkdf2.sha512...' rhel9cis_bootloader_password_hash: 'grub.pbkdf2.sha512.10000.9306A36764A7BEA3BF492D1784396B27F52A71812E9955A58709F94EE70697F9BD5366F36E07DEC41B52279A056E2862A93E42069D7BBB08F5DFC2679CD43812.6C32ADA5449303AD5E67A4C150558592A05381331DE6B33463469A236871FA8E70738C6F9066091D877EF88A213C86825E093117F30E9E1BF158D0DB75E7581B' # pragma: allowlist secret rhel9cis_bootloader_password: random # pragma: allowlist secret +# Control 1.4.1 - This variable governs whether a bootloader password should be set in /boot/grub2/user.cfg file. rhel9cis_set_boot_pass: true ## Controls 1.8.x - Settings for GDM @@ -455,17 +463,21 @@ rhel9cis_set_boot_pass: true # (See https://help.gnome.org/admin/system-admin-guide/stable/dconf-keyfiles.html.en) # The default database is `local` rhel9cis_dconf_db_name: local - # This variable governs the number of seconds of inactivity before the screen goes blank. rhel9cis_screensaver_idle_delay: 900 # Set max value for idle-delay in seconds (between 1 and 900) - # This variable governs the number of seconds the screen remains blank before it is locked. rhel9cis_screensaver_lock_delay: 5 # Set max value for lock-delay in seconds (between 0 and 5) -# 1.10/1.11 Set crypto policy (LEGACY, DEFAULT, FUTURE, FIPS) -# Control 1.10 states do not use LEGACY and control 1.11 says to use FUTURE or FIPS. +# Control 1.10 - This variable contains the value to be set as the system-wide crypto policy. Rule 1.10 enforces +# NOT using 'LEGACY' value(as it is less secure, it just ensures compatibility with legacy systems), therefore +# possible values for this variable are, as explained by RedHat docs: +# -'DEFAULT': reasonable default policy for today's standards(balances usability and security) +# -'FUTURE': conservative security level that is believed to withstand any near-term future attacks +# -'FIPS': A level that conforms to the FIPS140-2 requirements rhel9cis_crypto_policy: 'DEFAULT' -# Added module to be allowed as default setting (Allowed options in vars/main.yml) +# Control 1.10 - This variable contains the value of the crypto policy module(combinations of policies and +# sub-policies) to be allowed as default setting. Allowed options are defined in 'vars/main.yml' file, +# using 'rhel9cis_allowed_crypto_policies_modules' variable. rhel9cis_crypto_policy_module: '' # System network parameters (host only OR host and router) @@ -522,13 +534,21 @@ rhel9cis_aide_cron: # can be concatenated with commas. aide_weekday: '*' -# SELinux policy -# This selects type of policy; targeted or mls ( multilevel ) +## Control 1.6.1.3|4|5 - SELinux policy settings +# This selects type of policy; targeted or mls( multilevel ) # mls should not be used, since it will disable unconfined policy module -# and may prevent some services from running. +# and may prevent some services from running. Requires SELinux not being disabled(by +# having 'rhel9cis_selinux_disable' var set as 'true'), otherwise setting will be ignored. rhel9cis_selinux_pol: targeted -# chose onf or enfocing or permissive -# CIS expects enforcing since permissive allows operations thet might compromise the system. +## Control 1.6.1.3|4 - SELinux configured and not disabled +# This variable contains a specific SELinux mode, respectively: +# - 'enforcing': SELinux policy IS enforced, therefore denies operations based on SELinux policy +# rules. If system was installed with SELinux, this is enabled by default. +# - 'permissive': SELinux policy IS NOT enforced, therefore does NOT deny any operation, only +# logs AVC(Access Vector Cache) messages. RedHat docs suggest it "can be used +# briefly to check if SELinux is the culprit in preventing your application +# from working". +# CIS expects enforcing since permissive allows operations that might compromise the system. # Even though logging still occurs. rhel9cis_selinux_enforce: enforcing @@ -538,7 +558,7 @@ rhel9cis_selinux_enforce: enforcing ### 2.1 Time Synchronization #### 2.1.2 Time Synchronization servers - used in template file chrony.conf.j2 -# The following variable represents a list of of time servers used +# The following variable represents a list of time servers used # for configuring chrony, timesyncd, and ntp. # Each list item contains two settings, `name` (the domain name of the server) and synchronization `options`. # The default setting for the `options` is `minpoll` but `iburst` can be used, please refer to the documentation @@ -548,6 +568,9 @@ rhel9cis_time_synchronization_servers: - 1.pool.ntp.org - 2.pool.ntp.org - 3.pool.ntp.org +#### 2.1.2 - Time Synchronization servers +# This variable should contain the default options to be used for every NTP server hostname defined +# within the 'rhel9cis_time_synchronization_servers' var. rhel9cis_chrony_server_options: "minpoll 8" ### 2.2 Special Purposes From 6dfbe18612160de80a232a53978fb226dcf8b342 Mon Sep 17 00:00:00 2001 From: Ionut Pruteanu Date: Thu, 7 Dec 2023 22:53:01 +0200 Subject: [PATCH 05/14] Doc additions for: - Sections 2.2 && 2.3 - Section 3 - Section 4.1 Signed-off-by: Ionut Pruteanu --- defaults/main.yml | 152 ++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 148 insertions(+), 4 deletions(-) diff --git a/defaults/main.yml b/defaults/main.yml index e1ef0ce..1ae5261 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -577,22 +577,60 @@ rhel9cis_chrony_server_options: "minpoll 8" # Service configuration variables (boolean). # Set the respective variable to true to keep the service. # otherwise the service is stopped and disabled + +# This variable governs whether rules dealing with GUI specific packages(and/or their settings) should +# be executed either to: +# - secure GDM(Control 1.8.2-1.8.10), if GUI is needed('rhel9cis_gui: true') +# - or remove GDM(Control 1.8.1) and X-Windows-system(2.2.1), if no GUI is needed('rhel9cis_gui: false') rhel9cis_gui: false +# Control 2.2.2 - Ensure Avahi Server is not installed +# This variable, when set to false, will specify that Avahi Server packages should be uninstalled. rhel9cis_avahi_server: false +# Control 2.2.3 - Ensure CUPS is not installed +# This variable, when set to false, will specify that CUPS(Common UNIX Printing System) package should be uninstalled. rhel9cis_cups_server: false +# Control 2.2.4 - Ensure DHCP Server is not installed +# This variable, when set to false, will specify that DHCP server package should be uninstalled. rhel9cis_dhcp_server: false +# Control 2.2.5 - Ensure DNS Server is not installed +# This variable, when set to false, will specify that DNS server package should be uninstalled. rhel9cis_dns_server: false +# Control 2.2.14 - Ensure dnsmasq is not installed +# This variable, when set to false, will specify that dnsmasq package should be uninstalled. rhel9cis_dnsmasq_server: false +# Control 2.2.6 - Ensure VSFTP Server is not installed +# This variable, when set to false, will specify that VSFTP server package should be uninstalled. rhel9cis_vsftpd_server: false +# Control 2.2.7 - Ensure TFTP Server is not installed +# This variable, when set to false, will specify that TFTP server package should be uninstalled. rhel9cis_tftp_server: false +# Control 2.2.8 - Ensure a web server is not installed - HTTPD +# This variable, when set to false, will specify that webserver packages(HTTPD) should be uninstalled. rhel9cis_httpd_server: false +# Control 2.2.8 - Ensure a web server is not installed - NGINX +# This variable, when set to false, will specify that webserver packages(NGINX) should be uninstalled. rhel9cis_nginx_server: false +# Control 2.2.9 - Ensure IMAP and POP3 server is not installed - dovecot +# This variable, when set to false, will specify that IMAP and POP3 servers(dovecot) should be uninstalled. rhel9cis_dovecot_server: false +# Control 2.2.9 - Ensure IMAP and POP3 server is not installed - cyrus-imapd +# This variable, when set to false, will specify that IMAP and POP3 servers(cyrus-imapd) should be uninstalled. rhel9cis_imap_server: false +# Control 2.2.10 - Ensure Samba is not enabled +# This variable, when set to false, will specify that 'samba' package should be uninstalled. rhel9cis_samba_server: false +# Control 2.2.11 - Ensure HTTP Proxy Server is not installed +# This variable, when set to false, will specify that 'squid' package should be uninstalled. rhel9cis_squid_server: false +# Control 2.2.12 - Ensure net-snmp is not installed +# This variable, when set to false, will specify that 'net-snmp' package should be uninstalled. rhel9cis_snmp_server: false +# Control 2.2.13 - Ensure telnet-server is not installed +# This variable, when set to false, will specify that 'telnet-server' package should be uninstalled. rhel9cis_telnet_server: false +# Control 2.2.15 - Ensure mail transfer agent is configured for local-only mode +# This variable, when system is NOT a mailserver, will configure Postfix to listen only on the loopback interface(the virtual +# network interface that the server uses to communicate internally. rhel9cis_is_mail_server: false # Note the options @@ -600,35 +638,121 @@ rhel9cis_is_mail_server: false # Packages are used for client services and Server- only remove if you dont use the client service # Set the respective variable to `true` to keep the # client package, otherwise it is uninstalled (false). + +# Control 2.2.16 - Ensure nfs-utils is not installed or the nfs-server service is masked" +# This variable specifies if the usage of NFS SERVER is needed. The behavior of 2.2.16 will depend on +# the var used in conjunction('rhel9cis_use_nfs_service') with current one, respectively: +# - if Server IS NOT needed('false') and: +# - Service IS NOT needed('rhel9cis_use_nfs_service: false'): 'nfs-utils' package will be removed +# - Service IS needed('rhel9cis_use_nfs_service: true'): impossible to need the service without the server +# - if Server IS needed('true') and: +# - Service IS NOT needed('rhel9cis_use_nfs_service: false'): 'nfs-server' service will be masked +# - Service IS needed('rhel9cis_use_nfs_service: true'): Rule 2.2.16 will be SKIPPED. +# | Server | Service | Result | +# |---------|---------|-----------------------------------------------------------| +# | false | false | Remove package | +# | false | true | Needing 'service' without needing 'server' makes no sense | +# | true | false | Mask 'service' | +# | true | true | SKIP RULE, BOTH 'service' and 'server' are required | rhel9cis_use_nfs_server: false +# Control 2.2.16 - Ensure nfs-utils is not installed or the nfs-server service is masked. +# This variable specifies if the usage of NFS SERVICE is needed. If it's: +# - needed('true'): rule 2.2.16 will not be executed at all +# - not needed('false'): rule 2.2.16 will be executed, its behavior being controlled by the var +# used in conjunction with current one: +# - removing 'nfs-utils' package('rhel9cis_use_nfs_server' set to 'false') +# - masking the 'nfs-server' service('rhel9cis_use_nfs_server' set to 'true') rhel9cis_use_nfs_service: false +# Control 2.2.17 - Ensure rpcbind is not installed or the rpcbind services are masked +# This variable specifies if the usage of RPC SERVER is needed. The behavior of 2.2.17 will depend on +# the var used in conjunction('rhel9cis_use_rpc_service') with current one, respectively: +# - if Server IS NOT needed('false') and: +# - Service IS NOT needed('rhel9cis_use_rpc_service: false'): 'rpcbind' package will be removed +# - Service IS needed('rhel9cis_use_rpc_service: true'): impossible to need the service without the server +# - if Server IS needed('true') and: +# - Service IS NOT needed('rhel9cis_use_rpc_service: false'): 'rpcbind.socket' service will be masked +# - Service IS needed('rhel9cis_use_rpc_service: true'): Rule 2.2.17 will be SKIPPED. +# | Server | Service | Result | +# |---------|---------|-----------------------------------------------------------| +# | false | false | Remove package | +# | false | true | Needing 'service' without needing 'server' makes no sense | +# | true | false | Mask 'service' | +# | true | true | SKIP RULE, BOTH 'service' and 'server' are required | rhel9cis_use_rpc_server: false +# Control 2.2.17 - Ensure rpcbind is not installed or the rpcbind services are masked +# This variable specifies if the usage of RPC SERVICE is needed. If it's: +# - needed('true'): rule 2.2.17 will not be executed at all +# - not needed('false'): rule 2.2.17 will be executed, its behavior being controlled by the var +# used in conjunction with current one: +# - removing 'rpcbind' package('rhel9cis_use_rpc_server' set to 'false') +# - masking the 'rpcbind.socket' service('rhel9cis_use_rpc_server' set to 'true') rhel9cis_use_rpc_service: false + +# Control 2.2.18 - Ensure rsync service is not enabled +# This variable specifies if the usage of RSYNC SERVER is needed. The behavior of 2.2.18 will depend on +# the var used in conjunction('rhel9cis_use_rsync_service') with current one, respectively: +# - if Server IS NOT needed('false') and: +# - Service IS NOT needed('rhel9cis_use_rsync_service: false'): 'rsync-daemon' package will be removed +# - Service IS needed('rhel9cis_use_rsync_service: true'): impossible to need the service without the server +# - if Server IS needed('true') and: +# - Service IS NOT needed('rhel9cis_use_rsync_service: false'): 'rsyncd' service will be masked +# - Service IS needed('rhel9cis_use_rsync_service: true'): Rule 2.2.18 will be SKIPPED. +# | Server | Service | Result | +# |---------|---------|-----------------------------------------------------------| +# | false | false | Remove package | +# | false | true | Needing 'service' without needing 'server' makes no sense | +# | true | false | Mask 'service' | +# | true | true | SKIP RULE, BOTH 'service' and 'server' are required | rhel9cis_use_rsync_server: false +# Control 2.2.18 - Ensure rsync service is not enabled +# This variable specifies if the usage of RSYNC SERVICE is needed. If it's: +# - needed('true'): rule 2.2.18 will not be executed at all +# - not needed('false'): rule 2.2.18 will be executed, its behavior being controlled by the var +# used in conjunction with current one: +# - removing 'rsync-daemon' package('rhel9cis_use_rsync_server' set to 'false') +# - masking the 'rsyncd' service('rhel9cis_use_rsync_server' set to 'true') rhel9cis_use_rsync_service: false #### 2.3 Service clients +# Control - 2.3.1 - Ensure telnet client is not installed +# Set this variable to `true` to keep package `telnet`; otherwise, the package is uninstalled. rhel9cis_telnet_required: false +# Control - 2.3.2 - Ensure LDAP client is not installed +# Set this variable to `true` to keep package `openldap-clients`; otherwise, the package is uninstalled. rhel9cis_openldap_clients_required: false +# Control - 2.3.3 - Ensure FTP client is not installed +# Set this variable to `true` to keep package `tftp`; otherwise, the package is uninstalled. rhel9cis_tftp_client: false +# Control - 2.3.4 - Ensure FTP client is not installed +# Set this variable to `true` to keep package `ftp`; otherwise, the package is uninstalled. rhel9cis_ftp_client: false ## Section 3 vars for ## Sysctl +# This variable governs if the task which updates sysctl(including sysctl reload) is executed, but current +# default value can be overriden by other tasks(1.5.3, 3.1.1, 3.2.1, 3.2.2, 3.3.1-3.3.9). rhel9cis_sysctl_update: false +# This variable governs if the task which flushes the IPv4 routing table is executed(forcing subsequent connections to +# use the new configuration). Current default value can be overriden by other tasks(3.2.1, 3.2.2, 3.3.1-3.3.8). rhel9cis_flush_ipv4_route: false +# This variable governs if the task which flushes the IPv6 routing table is executed(forcing subsequent connections to +# use the new configuration). Current default value can be overriden by other tasks(3.1.1, 3.2.1, 3.3.1, 3.3.2, 3.3.9). rhel9cis_flush_ipv6_route: false -### Firewall Service - either firewalld, iptables, or nftables +### Firewall Service to install and configure - Option is: +# 1) either 'firewalld'(Controls 3.4.1.2, 3.4.2.1, 3.4.2.4) +# 2) or 'nftables'(Controls ) #### Some control allow for services to be removed or masked #### The options are under each heading #### absent = remove the package #### masked = leave package if installed and mask the service rhel9cis_firewall: firewalld -##### firewalld +# Control 3.4.2.1 - Ensure firewalld default zone is set +# This variable will set the firewalld default zone(that is used for everything that is not explicitly bound/assigned +# to another zone): if there is no zone assigned to a connection, interface or source, only the default zone is used. rhel9cis_default_zone: public # These settings are added to demonstrate how this update can be done (eventually will require a new control) @@ -641,10 +765,26 @@ rhel9cis_firewalld_ports: # "rhel9cis_nft_tables_tablename" is the name of the table in nftables you want to create. # nftables configs are applied to. # options are: inet filter + +# Control 3.4.2.2 - Ensure at least one nftables table exists +# This variable governs if a table will be automatically created in nftables. Without a table (no default one), nftables +# will not filter network traffic, so if this variable is set to 'false' and no tables exist, an alarm will be triggered! rhel9cis_nft_tables_autonewtable: true +# Controls 3.4.2.{2|3|4|6|7} nftables +# This variable stores the name of the table to be used when configuring nftables(creating chains, configuring loopback +# traffic, established connections, default deny). If 'rhel9cis_nft_tables_autonewtable' is set as true, a new table will +# be created using as name the value stored by this variable. rhel9cis_nft_tables_tablename: filter +# Control 3.4.2.3 - Ensure nftables base chains exist +# This variable governs if a nftables base chain(entry point for packets from the networking stack) will be automatically +# created, if needed. Without a chain, a hook for input, forward, and delete, packets that would flow through those +#chains will not be touched by nftables rhel9cis_nft_tables_autochaincreate: true +## Controls: +# - 1.7.1 - Ensure message of the day is configured properly +# - 1.7.2 - Ensure local login warning banner is configured properly +# - 1.7.3 - Ensure remote login warning banner is configured properly # Warning Banner Content (issue, issue.net, motd) rhel9cis_warning_banner: Authorized uses only. All activity may be monitored and reported. # End Banner @@ -656,7 +796,11 @@ rhel9cis_warning_banner: Authorized uses only. All activity may be monitored and # This variable controls how the audit system behaves when # log files are getting too full and space is getting too low. rhel9cis_auditd: + # This variable tells the system what action to take when the system has detected + #that it is starting to get low on disk space. Options are the same as for `admin_space_left_action` space_left_action: email + # This variable should contain a valid email address or alias(default value is root), + # which will be used to send a warning when configured action is 'email'. action_mail_acct: root # This variable determines the action the audit system should take when disk # space runs low. @@ -701,9 +845,9 @@ rhel9cis_max_log_file_size: 10 update_audit_template: false ## Advanced option found in auditd post -# users whose actions are not logged by auditd +# This variable governs if defining user exceptions for auditd logging is acceptable. rhel9cis_allow_auditd_uid_user_exclusions: false -# add a list of uids to be excluded. +# This variable contains a list of uids to be excluded(users whose actions are not logged by auditd) rhel9cis_auditd_uid_exclude: - 1999 From 28a61fa71dc7b0b56c7d07b0e61346e82de280a5 Mon Sep 17 00:00:00 2001 From: Ionut Pruteanu Date: Fri, 8 Dec 2023 20:17:43 +0200 Subject: [PATCH 06/14] Last docs part - additions Signed-off-by: Ionut Pruteanu --- defaults/main.yml | 196 ++++++++++++++++++++++++++++++++++------------ 1 file changed, 147 insertions(+), 49 deletions(-) diff --git a/defaults/main.yml b/defaults/main.yml index 1ae5261..617b692 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -851,65 +851,113 @@ rhel9cis_allow_auditd_uid_user_exclusions: false rhel9cis_auditd_uid_exclude: - 1999 -# This can be used to configure other keys in auditd.conf +## Control 'Configure other keys for auditd.conf' in 4.1.2.x section +# The default auditd configuration should be suitable for most environments, but if your environment must +# meet strict security policies, the extra configuration pairs used for securing auditd(by modifying +# '/etc/audit/auditd.conf' file) can be stored within current variable. rhel9cis_auditd_extra_conf: {} # Example: # rhel9cis_auditd_extra_conf: # admin_space_left: '10%' -## Preferred method of logging ## Whether rsyslog or journald preferred method for local logging -## Affects rsyslog cis 4.2.1.3 and journald cis 4.2.2.5 +## 4.2.1 | Configure rsyslog +## 4.2.2 | Configure journald +# This variable governs which logging service should be used, choosing between 'rsyslog'(CIS recommendation) +# or 'journald'(only one is implemented) will trigger the execution of the associated subsection, as the-best +# practices are written wholly independent of each other. rhel9cis_syslog: rsyslog +## Control 4.2.1.5 | PATCH | Ensure logging is configured +# This variable governs if current Ansible role should manage syslog settings +# in /etc/rsyslog.conf file, namely mail, news and misc(warn, messages) rhel9cis_rsyslog_ansiblemanaged: true -#### 4.2.1.6 remote and destation log server name +#### Control 4.2.1.6 - Ensure rsyslog is configured to send logs to a remote log host +# This variable governs if 'rsyslog' service should be automatically configured to forward messages to a +# remote log server. If set to 'false', the configuration of the 'omfwd' plugin, used to provide forwarding +# over UDP or TCP, will not be performed. rhel9cis_remote_log_server: false -rhel9cis_remote_log_host: 192.168.2.100 +#### Control 4.2.1.6 - Ensure rsyslog is configured to send logs to a remote log host +# This variable configures the value of the 'target' parameter to be configured when enabling +# forwarding syslog messages to a remote log server, thus configuring the actual FQDN/IP address of the +# destination server. For this value to be reflected in the configuration, the variable which enables the +# automatic configuration of rsyslog forwarding must be enabled('rhel9cis_remote_log_server: true'). +rhel9cis_remote_log_host: logagg.example.com +#### Control 4.2.1.6 - Ensure rsyslog is configured to send logs to a remote log host +# This variable configures the value of the 'port' parameter to be configured when enabling +# forwarding syslog messages to a remote log server. The default value for this destination port is 514. +# For this value to be reflected in the configuration, the variable which enables the +# automatic configuration of rsyslog forwarding must be enabled('rhel9cis_remote_log_server: true'). rhel9cis_remote_log_port: 514 +#### Control 4.2.1.6 - Ensure rsyslog is configured to send logs to a remote log host +# This variable configures the value("TCP"/"UDP") of the 'protocol' parameter to be configured when enabling +# forwarding syslog messages to a remote log server. The default value for the 'omfwd' plug-in is UDP. +# For this value to be reflected in the configuration, the variable which enables the +# automatic configuration of rsyslog forwarding must be enabled('rhel9cis_remote_log_server: true'). rhel9cis_remote_log_protocol: tcp +#### Control 4.2.1.6 - Ensure rsyslog is configured to send logs to a remote log host +# This variable governs how often an action is retried(value is passed to 'action.resumeRetryCount' parameter) before +# it is considered to have failed(that roughly translates to discarded messages). The default value is 0, but +# when set to "-1"(eternal), this setting would prevent rsyslog from dropping messages when retrying to connect +# if server is not responding. For this value to be reflected in the configuration, the variable which enables the +# automatic configuration of rsyslog forwarding must be enabled('rhel9cis_remote_log_server: true'). rhel9cis_remote_log_retrycount: 100 +#### Control 4.2.1.6 - Ensure rsyslog is configured to send logs to a remote log host +# This variable configures the maximum number of messages that can be hold(value is passed to 'queue.size' parameter). +# For this value to be reflected in the configuration, the variable which enables the automatic configuration +# of rsyslog forwarding must be enabled('rhel9cis_remote_log_server: true'). rhel9cis_remote_log_queuesize: 1000 -#### 4.2.1.7 -# This variable expresses whether the system is used as a log server or not. -# If set to `true`, controls that interfere with log server functionality or -# require that own system logs be sent to some other log server are skipped. +#### Control 4.2.1.7 - Ensure rsyslog is not configured to receive logs from a remote client +# This variable expresses whether the system is used as a log server or not. If set to: +# - 'false', current system will act as a log CLIENT, thus it should NOT receive data from other hosts. +# - 'true', current system will act as a log SERVER, enabling centralised log management(by protecting log integrity +# from local attacks on remote clients) rhel9cis_system_is_log_server: false -# 4.2.2.1.2 -# rhel9cis_journal_upload_url is the ip address to upload the journal entries to +#### Control 4.2.2.1.2 - Ensure systemd-journal-remote is configured +# 'rhel9cis_journal_upload_url' is the ip address to upload the journal entries to +# URL value may specify either just the hostname or both the protocol and hostname. 'https' is the default. The port +# number may be specified after a colon (":"), otherwise 19532 will be used by default. rhel9cis_journal_upload_url: 192.168.50.42 - ## The paths below have the default paths/files, but allow user to create custom paths/filenames +#### Control 4.2.2.1.2 - Ensure systemd-journal-remote is configured # This variable specifies the path to the private key file used by the remote journal # server to authenticate itself to the client. This key is used alongside the server's # public certificate to establish secure communication. rhel9cis_journal_upload_serverkeyfile: "/etc/ssl/private/journal-upload.pem" +#### Control 4.2.2.1.2 - Ensure systemd-journal-remote is configured # This variable specifies the path to the public certificate file of the remote journal # server. This certificate is used to verify the authenticity of the remote server. rhel9cis_journal_servercertificatefile: "/etc/ssl/certs/journal-upload.pem" +#### Control 4.2.2.1.2 - Ensure systemd-journal-remote is configured # This variable specifies the path to a file containing one or more public certificates # of certificate authorities (CAs) that the client trusts. These trusted certificates are used # to validate the authenticity of the remote server's certificate. rhel9cis_journal_trustedcertificatefile: "/etc/ssl/ca/trusted.pem" -# 4.2.2.1 +# Control 4.2.2.6 - Ensure journald log rotation is configured per site policy # The variables below related to journald, please set these to your site specific values # These variable specifies how much disk space the journal may use up at most # Specify values in bytes or use K, M, G, T, P, E as units for the specified sizes. # See https://www.freedesktop.org/software/systemd/man/journald.conf.html for more information. # ATTENTION: Uncomment the keyword below when values are set! + +# Control 4.2.2.6 - Ensure journald log rotation is configured per site policy # rhel9cis_journald_systemmaxuse is the max amount of disk space the logs will use rhel9cis_journald_systemmaxuse: 10M +# Control 4.2.2.6 - Ensure journald log rotation is configured per site policy # rhel9cis_journald_systemkeepfree is the amount of disk space to keep free rhel9cis_journald_systemkeepfree: 100G +# Control 4.2.2.6 - Ensure journald log rotation is configured per site policy # rhel9cis_journald_runtimemaxuse control how much disk space the journal may use up at most. # same as rhel9cis_journald_systemmaxuse. rhel9cis_journald_runtimemaxuse: 10M +# Control 4.2.2.6 - Ensure journald log rotation is configured per site policy # rhel9cis_journald_runtimekeepfree is the amount of disk space to keep free -# same as rhel9cis_journald_systemkeepfree. +# same as rhel9cis_journald_systemkeepfree, but related to runtime space. rhel9cis_journald_runtimekeepfree: 100G +# Control 4.2.2.6 - Ensure journald log rotation is configured per site policy # rhel9cis_journald_MaxFileSec is how long in time to keep log files. # This variable specifies, the maximum time to store entries in a single journal # file before rotating to the next one. Set to 0 to turn off this feature. @@ -919,16 +967,23 @@ rhel9cis_journald_runtimekeepfree: 100G # ATTENTION: Uncomment the keyword below when values are set! rhel9cis_journald_maxfilesec: 1month -#### 4.3 +#### Control 4.3 - Ensure logrotate is configured # This variable defines the log file rotation period. -# Options are: daily, monthly, yearly. +# Options are: daily, weekly, monthly, yearly. rhel9cis_logrotate: "daily" ## Section5 vars -# This will allow use of drop in files when CIS adopts them. +# Section 5.2 - SSH +# This value, containing the absolute filepath of the produced 'sshd' config file, allows usage of +# drop-in files('/etc/ssh/ssh_config.d/{ssh_drop_in_name}.conf', supported by RHEL9) when CIS adopts them. +# Otherwise, the default value is '/etc/ssh/ssh_config'. rhel9_cis_sshd_config_file: /etc/ssh/sshd_config +#### Controls: +## 5.2.4 - Ensure SSH access is limited +## 5.2.19 - Ensure SSH LoginGraceTime is set to one minute or less +## 5.2.20 - Ensure SSH Idle Timeout Interval is configured rhel9cis_sshd: # This variable sets the maximum number of unresponsive "keep-alive" messages # that can be sent from the server to the client before the connection is considered @@ -968,7 +1023,7 @@ rhel9cis_sshd: # For more info, see https://linux.die.net/man/5/sshd_config deny_groups: "" -# 5.2.5 SSH LogLevel setting. +# Control 5.2.5 - Ensure SSH LogLevel is appropriate # This variable is used to control the verbosity of the logging produced by the SSH server. # The options for setting it are as follows: # - `QUIET`: Minimal logging; @@ -980,45 +1035,59 @@ rhel9cis_sshd: # - `DEBUG(x)`: Whereas x = debug level 1 to 3, DEBUG=DEBUG1. rhel9cis_ssh_loglevel: INFO -# 5.2.19 SSH MaxSessions setting. Must be 4 our less +# Control 5.2.18 - Ensure SSH MaxSessions is set to 10 or less +# This variable value specifies the maximum number of open sessions that are permitted from +# a given location rhel9cis_ssh_maxsessions: 4 -## Control 5.5.1.4 + +## Control 5.6.1.4 - Ensure inactive password lock is 30 days or less # This variable specifies the number of days of inactivity before an account will be locked. # CIS requires a value of 30 days or less. rhel9cis_inactivelock: lock_days: 30 - +# This variable governs if authconfig package should be installed. This package provides a simple method of +# configuring /etc/sysconfig/network to handle NIS, as well as /etc/passwd and /etc/shadow, the files used +# for shadow password support. Basic LDAP, Kerberos 5, and Winbind client configuration is also provided. rhel9cis_use_authconfig: false -# 5.3.1/5.3.2 Custom authselect profile settings. Settings in place now will fail, they are place holders from the control example -# Due to the way many multiple options and ways to configure this control needs to be enabled and settings adjusted to minimise risk + +#### Controls +# SECTION 5.4 - Configure authselect: Custom authselect profile settings(name, profile to customize, options) +# 5.4.1 - Ensure custom authselect profile is used('custom_profile_name', 'default_file_to_copy' subsettings) +# 5.4.2 - Ensure authselect includes with-faillock | with auth select profile('custom_profile_name') +# Settings in place now will fail, they are place holders from the control example. Due to the way many multiple +# options and ways to configure this control needs to be enabled and settings adjusted to minimise risk. rhel9cis_authselect: custom_profile_name: custom-profile default_file_to_copy: "sssd --symlink-meta" options: with-sudo with-faillock without-nullok -# 5.3.1 Enable automation to create custom profile settings, using the settings above +# Control 5.4.1 - Ensure custom authselect profile is used +# This variable governs if an authselect custom profile should be automatically created, by copying and +# customizing one of the default profiles. The default profiles include: sssd, winbind, or the nis. This profile can then be +# customized to follow site specific requirements. rhel9cis_authselect_custom_profile_create: false -# 5.3.2 Enable automation to select custom profile options, using the settings above +# Control 5.4.2 - Ensure authselect includes with-faillock | Create custom profiles +# This variable governs if the existing custom profile should be selected(Note: please keep in mind that all future updates +# to the PAM templates and meta files in the original profile will be reflected in your custom profile, too.) rhel9cis_authselect_custom_profile_select: false -## Controls 5.5.1.x - Password settings +## Section 5.6.1.x: Shadow Password Suite Parameters rhel9cis_pass: - ## Control 5.5.1.2 - # This variable governs after how many days a password expires. + ## Control 5.6.1.1 - Ensure password expiration is 365 days or less + # This variable governs after how many days a password expires. # CIS requires a value of 365 or less. max_days: 365 - ## Control 5.5.1.1 - # This variable specifies the minimum number of days allowed between changing passwords. - # CIS requires a value of at least 1. + ## Control 5.6.1.2 - Ensure minimum days between password changes is 7 or more + # This variable specifies the minimum number of days allowed between changing + # passwords. CIS requires a value of at least 1. min_days: 7 - ## Control 5.5.1.3 + ## Control 5.6.1.3 - Ensure password expiration warning days is 7 or more # This variable governs, how many days before a password expires, the user will be warned. # CIS requires a value of at least 7. warn_age: 7 -# 5.5.1 -## PAM +## Control 5.5.1 - Ensure password creation requirements are configured - PAM rhel9cis_pam_password: # This variable sets the minimum chars a password needs to be set. minlen: 14 @@ -1029,9 +1098,14 @@ rhel9cis_pam_password: # set to 4, passwords will have to include all four types of characters. minclass: 4 +## Controls +# 5.5.2 - Ensure lockout for failed password attempts is configured +# 5.5.3 - Ensure password reuse is limited +# 5.5.4 - Ensure password hashing algorithm is SHA-512 +# 5.4.2 - Ensure authselect includes with-faillock rhel9cis_pam_faillock: - # This variable sets the amount of time a user will be unlocked after - # the max amount of password failures. + # This variable sets the amount of time a user will be unlocked after the max amount of + # password failures. unlock_time: 900 # This variable sets the amount of tries a password can be entered, before a user is locked. deny: 5 @@ -1043,20 +1117,29 @@ rhel9cis_pam_faillock: # UID settings for interactive users # These are discovered via logins.def if set true discover_int_uid: false +### Controls: +# 5.6.2 - Ensure system accounts are secured +# 6.2.10 - Ensure local interactive user home directories exist +# 6.2.11 - Ensure local interactive users own their home directories # This variable sets the minimum number from which to search for UID # Note that the value will be dynamically overwritten if variable `dicover_int_uid` has # been set to `true`. min_int_uid: 1000 +### Controls: +# 6.2.10 - Ensure local interactive user home directories exist +# 6.2.11 - Ensure local interactive users own their home directories # This variable sets the maximum number at which the search stops for UID # Note that the value will be dynamically overwritten if variable `dicover_int_uid` has # been set to `true`. max_int_uid: 65533 -# 5.3.3 var log location variable +### Control 5.3.3 - Ensure sudo log file exists +# By default, sudo logs through syslog(3). However, to specify a custom log file, the +# 'logfile' parameter will be used, setting it with current variable's value. # This variable defines the path and file name of the sudo log file. rhel9cis_sudolog_location: "/var/log/sudo.log" -#### 5.3.6 +#### Control 5.3.6 -Ensure sudo authentication timeout is configured correctly # This variable sets the duration (in minutes) during which a user's authentication credentials # are cached after successfully authenticating using "sudo". This allows the user to execute # multiple commands with elevated privileges without needing to re-enter their password for each @@ -1068,10 +1151,11 @@ rhel9cis_sudo_timestamp_timeout: 15 ## Only to be used on a new clean system if not using authselect ## THIS CAN BREAK ACCESS EVEN FOR ROOT - UNDERSTAND RISKS ## rhel9cis_add_faillock_without_authselect: false -# This needs to be set to ACCEPT +# This needs to be set to 'ACCEPT'(string), besides setting 'rhel9cis_add_faillock_without_authselect' +# to 'true', in order to execute the 5.4.2 sub-tasks dealing with not authselect profile rhel9cis_5_4_2_risks: NEVER -# RHEL-09-5.4.5 +### Control 5.6.3 - Ensure default user shell timeout is 900 seconds or less # Session timeout setting file (TMOUT setting can be set in multiple files) # Timeout value is in seconds. (60 seconds * 10 = 600) rhel9cis_shell_session_timeout: @@ -1086,27 +1170,41 @@ rhel9cis_shell_session_timeout: # run before being forcefully terminated. # CIS requires a value of at most 900 seconds. timeout: 600 -# RHEL-09-5.4.1.5 Allow ansible to expire password for account with a last changed date in the future. False will just display users in violation, true will expire those users passwords + +### Control 5.6.1.5 - Ensure all users last password change date is in the past +# Allow ansible to expire password for account with a last changed date in the future. Setting it +# to 'false' will just display users in violation, while 'true' will expire those users passwords. rhel9cis_futurepwchgdate_autofix: true -# 5.3.7 -# This variable determines the group of users that are allowed to use the su command. -# one to specify a user group that is allowed to use the "su" command. -# CIS requires that such a group be created (named according to site policy) and be kept empty. +### Control 5.3.7 - Ensure access to the 'su' command is restricted +# This variable determines the name of the group of users that are allowed to use the su command. +# CIS requires that such a group be CREATED(named according to site policy) and be kept EMPTY. rhel9cis_sugroup: nosugroup ## Section6 vars -# RHEL-09_6.1.1 +### Control 6.1.15 - Audit system file permissions | Create list and warning +# The RPM package-manager has many useful options. For example, using option: +# - '-V': RPM can automatically check if system packages are correctly installed +# - '-qf': RPM can be used to determine which package a particular file belongs to +# Rule 6.1.15 takes advantage of the combination of those two options and, therefore, is able to +# detect any discrepancy regarding installed packages, redirecting the output of this combined +# command into a specific file. If no output is returned, the package is installed correctly. +# Current variable stores the preferred absolute filepath such a file, therefore if this file +# contains any lines, an alert message will be generated to warn about each discrepancy. rhel9cis_rpm_audit_file: /var/tmp/rpm_file_check -# RHEL-09_6.1.10 Allow ansible to adjust world-writable files. False will just display world-writable files, True will remove world-writable +### Control 6.1.9 - Ensure no world writable files exist +# Allow ansible to adjust world-writable files. False will just display world-writable files, True will remove world-writable. rhel9cis_no_world_write_adjust: true + rhel9cis_passwd_label: "{{ (this_item | default(item)).id }}: {{ (this_item | default(item)).dir }}" -# 6.2.16 -## Dont follow symlinks for changes to user home directory thanks to @dulin-gnet and community for rhel8-cis reedback. +### Control 6.2.16 - Ensure local interactive user dot files are not group or world writable +# This boolean variable governs if current role should follow filesystem links for changes to +# user home directory. rhel_09_6_2_16_home_follow_symlinks: false +# thanks to @dulin-gnet and community for rhel8-cis feedback. #### Goss Configuration Settings #### # Set correct env for the run_audit.sh script from https://github.com/ansible-lockdown/{{ benchmark }}-Audit.git" From a57333dcf1d8230e4d4a9d84ed1aa10b430bb64b Mon Sep 17 00:00:00 2001 From: "root@DERVISHx" Date: Wed, 27 Dec 2023 15:39:46 +0000 Subject: [PATCH 07/14] Added vars for streams. Signed-off-by: root@DERVISHx --- defaults/main.yml | 2 +- vars/AlmaLinux.yml | 6 ++++++ vars/Rocky.yml | 6 ++++++ 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/defaults/main.yml b/defaults/main.yml index 617b692..1ff7a5f 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -866,7 +866,7 @@ rhel9cis_auditd_extra_conf: {} # This variable governs which logging service should be used, choosing between 'rsyslog'(CIS recommendation) # or 'journald'(only one is implemented) will trigger the execution of the associated subsection, as the-best # practices are written wholly independent of each other. -rhel9cis_syslog: rsyslog +rhel9cis_syslog: journald ## Control 4.2.1.5 | PATCH | Ensure logging is configured # This variable governs if current Ansible role should manage syslog settings # in /etc/rsyslog.conf file, namely mail, news and misc(warn, messages) diff --git a/vars/AlmaLinux.yml b/vars/AlmaLinux.yml index b0eb3d9..a0fa6ba 100644 --- a/vars/AlmaLinux.yml +++ b/vars/AlmaLinux.yml @@ -5,3 +5,9 @@ os_gpg_key_pubkey_name: gpg-pubkey-b86b3716-61e69f29 os_gpg_key_pubkey_content: "AlmaLinux OS 9 b86b3716" # disable repo_gpgcheck due to OS default repos rhel9cis_rule_enable_repogpg: false + +rhel9cis_sshd: + # This variable sets the maximum number of unresponsive "keep-alive" messages + # that can be sent from the server to the client before the connection is considered + # inactive and thus, closed. + clientalivecountmax: 3 \ No newline at end of file diff --git a/vars/Rocky.yml b/vars/Rocky.yml index 77af29c..7d9f014 100644 --- a/vars/Rocky.yml +++ b/vars/Rocky.yml @@ -3,3 +3,9 @@ os_gpg_key_pubkey_name: gpg-pubkey-350d275d-6279464b os_gpg_key_pubkey_content: "Rocky Enterprise Software Foundation - Release key 2022 350d275d" + +rhel9cis_sshd: + # This variable sets the maximum number of unresponsive "keep-alive" messages + # that can be sent from the server to the client before the connection is considered + # inactive and thus, closed. + clientalivecountmax: 3 \ No newline at end of file From 560475ea4e1c34b806ddceb0034b6df74e6f5513 Mon Sep 17 00:00:00 2001 From: Ionut Pruteanu Date: Wed, 17 Jan 2024 20:17:21 +0200 Subject: [PATCH 08/14] Finalising the docs content & syntax Signed-off-by: Ionut Pruteanu --- defaults/main.yml | 351 ++++++++++++++++++++++++---------------------- 1 file changed, 183 insertions(+), 168 deletions(-) diff --git a/defaults/main.yml b/defaults/main.yml index 617b692..2481e75 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -42,7 +42,7 @@ rhel9cis_section6: true rhel9cis_level_1: true rhel9cis_level_2: true -## 1.6 SubSection - Mandatory Access Control +## Section 1.6 - Mandatory Access Control # This variable governs whether SELinux is disabled or not. If SELinux is NOT DISABLED by setting # 'rhel9cis_selinux_disable' to 'true', the 1.6 subsection will be executed. rhel9cis_selinux_disable: false @@ -74,6 +74,7 @@ change_requires_reboot: false #### Basic external goss audit enablement settings #### #### Precise details - per setting can be found at the bottom of this file #### + ## Audit setup # Audits are carried out using Goss. This variable # determines whether execution of the role prepares for auditing @@ -419,63 +420,70 @@ rhel9cis_rule_6_2_16: true ## Section 1 vars -#### 1.1.2 -# These settings go into the /etc/fstab file for the /tmp mount settings -# The value must contain nosuid,nodev,noexec to conform to CIS standards -# rhel9cis_tmp_tmpfs_settings: "defaults,rw,nosuid,nodev,noexec,relatime 0 0" -# If set true uses the tmp.mount service else using fstab configuration +## Control 1.1.2 +# If set to `true`, rule will be implemented using the `tmp.mount` systemd-service, +# otherwise fstab configuration will be used. +# These /tmp settings will include nosuid,nodev,noexec to conform to CIS standards. rhel9cis_tmp_svc: false -#### 1.1.9 +## Control 1.1.9 rhel9cis_allow_autofs: false -# 1.2.1 +## Control 1.2.1 # This is the login information for your RedHat Subscription # DO NOT USE PLAIN TEXT PASSWORDS!!!!! # The intent here is to use a password utility like Ansible Vault here rhel9cis_rh_sub_user: user rhel9cis_rh_sub_password: password # pragma: allowlist secret -# 1.2.2 +## Control 1.2.2 # Do you require rhnsd # RedHat Satellite Subscription items rhel9cis_rhnsd_required: false -# Control 1.2.4 - When installing RHEL from authorized Red Hat source, RHEL will come with default YUM repository. NOT having a default YUM -# repo('rhel9cis_rhel_default_repo' set as 'false'), in conjunction with 'rhel9cis_rule_enable_repogpg' set as 'True', will enable the tasks +## Control 1.2.4 +# When installing RHEL from authorized Red Hat source, RHEL will come with default YUM repository. NOT having a default YUM +# repo ('rhel9cis_rhel_default_repo' set as 'false'), in conjunction with 'rhel9cis_rule_enable_repogpg' set as 'True', will enable the tasks # which check the GPG signatures for all the individual YUM repositories. rhel9cis_rhel_default_repo: true -# Control 1.2.4 - When 'rhel9cis_rule_enable_repogpg' is set to 'true'(in conjunction with 'rhel9cis_rhel_default_repo':'false'), conditions are met for +## Control 1.2.4 +# When 'rhel9cis_rule_enable_repogpg' is set to 'true'(in conjunction with 'rhel9cis_rhel_default_repo':'false'), conditions are met for # enabling the GPG signatures-check for all the individual YUM repositories. If GPG signatures-check is enabled on repositories which do not # support it(like RedHat), installation of packages will fail. rhel9cis_rule_enable_repogpg: true -# Control 1.4.1 - This variable will store the hashed GRUB bootloader password to be stored in '/boot/grub2/user.cfg' file. The default value +## Control 1.4.1 +# This variable will store the hashed GRUB bootloader password to be stored in '/boot/grub2/user.cfg' file. The default value # must be changed to a value that may be generated with this command 'grub2-mkpasswd-pbkdf2' and must comply with # this format: 'grub.pbkdf2.sha512...' rhel9cis_bootloader_password_hash: 'grub.pbkdf2.sha512.10000.9306A36764A7BEA3BF492D1784396B27F52A71812E9955A58709F94EE70697F9BD5366F36E07DEC41B52279A056E2862A93E42069D7BBB08F5DFC2679CD43812.6C32ADA5449303AD5E67A4C150558592A05381331DE6B33463469A236871FA8E70738C6F9066091D877EF88A213C86825E093117F30E9E1BF158D0DB75E7581B' # pragma: allowlist secret rhel9cis_bootloader_password: random # pragma: allowlist secret -# Control 1.4.1 - This variable governs whether a bootloader password should be set in /boot/grub2/user.cfg file. +## Control 1.4.1 +# This variable governs whether a bootloader password should be set in '/boot/grub2/user.cfg' file. rhel9cis_set_boot_pass: true -## Controls 1.8.x - Settings for GDM +## Control 1.8.x - Settings for GDM # This variable specifies the GNOME configuration database file to which configurations are written. -# (See https://help.gnome.org/admin/system-admin-guide/stable/dconf-keyfiles.html.en) -# The default database is `local` +# (See "https://help.gnome.org/admin/system-admin-guide/stable/dconf-keyfiles.html.en") +# The default database is 'local'. rhel9cis_dconf_db_name: local # This variable governs the number of seconds of inactivity before the screen goes blank. -rhel9cis_screensaver_idle_delay: 900 # Set max value for idle-delay in seconds (between 1 and 900) +# Set max value for idle-delay in seconds (between 1 and 900) +rhel9cis_screensaver_idle_delay: 900 # This variable governs the number of seconds the screen remains blank before it is locked. -rhel9cis_screensaver_lock_delay: 5 # Set max value for lock-delay in seconds (between 0 and 5) +# Set max value for lock-delay in seconds (between 0 and 5) +rhel9cis_screensaver_lock_delay: 5 -# Control 1.10 - This variable contains the value to be set as the system-wide crypto policy. Rule 1.10 enforces -# NOT using 'LEGACY' value(as it is less secure, it just ensures compatibility with legacy systems), therefore +## Control 1.10 +# This variable contains the value to be set as the system-wide crypto policy. Current rule enforces NOT USING +# 'LEGACY' value(as it is less secure, it just ensures compatibility with legacy systems), therefore # possible values for this variable are, as explained by RedHat docs: -# -'DEFAULT': reasonable default policy for today's standards(balances usability and security) +# -'DEFAULT': reasonable default policy for today's standards (balances usability and security) # -'FUTURE': conservative security level that is believed to withstand any near-term future attacks # -'FIPS': A level that conforms to the FIPS140-2 requirements rhel9cis_crypto_policy: 'DEFAULT' -# Control 1.10 - This variable contains the value of the crypto policy module(combinations of policies and +## Control 1.10 +# This variable contains the value of the crypto policy module(combinations of policies and # sub-policies) to be allowed as default setting. Allowed options are defined in 'vars/main.yml' file, # using 'rhel9cis_allowed_crypto_policies_modules' variable. rhel9cis_crypto_policy_module: '' @@ -537,27 +545,29 @@ rhel9cis_aide_cron: ## Control 1.6.1.3|4|5 - SELinux policy settings # This selects type of policy; targeted or mls( multilevel ) # mls should not be used, since it will disable unconfined policy module -# and may prevent some services from running. Requires SELinux not being disabled(by +# and may prevent some services from running. Requires SELinux not being disabled (by # having 'rhel9cis_selinux_disable' var set as 'true'), otherwise setting will be ignored. rhel9cis_selinux_pol: targeted ## Control 1.6.1.3|4 - SELinux configured and not disabled # This variable contains a specific SELinux mode, respectively: # - 'enforcing': SELinux policy IS enforced, therefore denies operations based on SELinux policy -# rules. If system was installed with SELinux, this is enabled by default. +# rules. If system was installed with SELinux, this is enabled by default. # - 'permissive': SELinux policy IS NOT enforced, therefore does NOT deny any operation, only -# logs AVC(Access Vector Cache) messages. RedHat docs suggest it "can be used -# briefly to check if SELinux is the culprit in preventing your application -# from working". +# logs AVC(Access Vector Cache) messages. RedHat docs suggest it "can be used +# briefly to check if SELinux is the culprit in preventing your application +# from working". # CIS expects enforcing since permissive allows operations that might compromise the system. # Even though logging still occurs. rhel9cis_selinux_enforce: enforcing # Whether or not to run tasks related to auditing/patching the desktop environment -## 2. Services +## Section 2. Services ### 2.1 Time Synchronization -#### 2.1.2 Time Synchronization servers - used in template file chrony.conf.j2 + + +## Control 2.1.2 Time Synchronization servers - used in template file chrony.conf.j2 # The following variable represents a list of time servers used # for configuring chrony, timesyncd, and ntp. # Each list item contains two settings, `name` (the domain name of the server) and synchronization `options`. @@ -568,67 +578,70 @@ rhel9cis_time_synchronization_servers: - 1.pool.ntp.org - 2.pool.ntp.org - 3.pool.ntp.org -#### 2.1.2 - Time Synchronization servers +## Control 2.1.2 - Time Synchronization servers # This variable should contain the default options to be used for every NTP server hostname defined # within the 'rhel9cis_time_synchronization_servers' var. rhel9cis_chrony_server_options: "minpoll 8" + ### 2.2 Special Purposes + # Service configuration variables (boolean). # Set the respective variable to true to keep the service. # otherwise the service is stopped and disabled + # This variable governs whether rules dealing with GUI specific packages(and/or their settings) should # be executed either to: -# - secure GDM(Control 1.8.2-1.8.10), if GUI is needed('rhel9cis_gui: true') -# - or remove GDM(Control 1.8.1) and X-Windows-system(2.2.1), if no GUI is needed('rhel9cis_gui: false') +# - secure GDM, if GUI is needed('rhel9cis_gui: true') +# - or remove GDM and X-Windows-system, if no GUI is needed('rhel9cis_gui: false') rhel9cis_gui: false -# Control 2.2.2 - Ensure Avahi Server is not installed +## Control 2.2.2 - Ensure Avahi Server is not installed # This variable, when set to false, will specify that Avahi Server packages should be uninstalled. rhel9cis_avahi_server: false -# Control 2.2.3 - Ensure CUPS is not installed +## Control 2.2.3 - Ensure CUPS is not installed # This variable, when set to false, will specify that CUPS(Common UNIX Printing System) package should be uninstalled. rhel9cis_cups_server: false -# Control 2.2.4 - Ensure DHCP Server is not installed +## Control 2.2.4 - Ensure DHCP Server is not installed # This variable, when set to false, will specify that DHCP server package should be uninstalled. rhel9cis_dhcp_server: false -# Control 2.2.5 - Ensure DNS Server is not installed +## Control 2.2.5 - Ensure DNS Server is not installed # This variable, when set to false, will specify that DNS server package should be uninstalled. rhel9cis_dns_server: false -# Control 2.2.14 - Ensure dnsmasq is not installed +## Control 2.2.14 - Ensure dnsmasq is not installed # This variable, when set to false, will specify that dnsmasq package should be uninstalled. rhel9cis_dnsmasq_server: false -# Control 2.2.6 - Ensure VSFTP Server is not installed +## Control 2.2.6 - Ensure VSFTP Server is not installed # This variable, when set to false, will specify that VSFTP server package should be uninstalled. rhel9cis_vsftpd_server: false -# Control 2.2.7 - Ensure TFTP Server is not installed +## Control 2.2.7 - Ensure TFTP Server is not installed # This variable, when set to false, will specify that TFTP server package should be uninstalled. rhel9cis_tftp_server: false -# Control 2.2.8 - Ensure a web server is not installed - HTTPD +## Control 2.2.8 - Ensure a web server is not installed - HTTPD # This variable, when set to false, will specify that webserver packages(HTTPD) should be uninstalled. rhel9cis_httpd_server: false -# Control 2.2.8 - Ensure a web server is not installed - NGINX +## Control 2.2.8 - Ensure a web server is not installed - NGINX # This variable, when set to false, will specify that webserver packages(NGINX) should be uninstalled. rhel9cis_nginx_server: false -# Control 2.2.9 - Ensure IMAP and POP3 server is not installed - dovecot +## Control 2.2.9 - Ensure IMAP and POP3 server is not installed - dovecot # This variable, when set to false, will specify that IMAP and POP3 servers(dovecot) should be uninstalled. rhel9cis_dovecot_server: false -# Control 2.2.9 - Ensure IMAP and POP3 server is not installed - cyrus-imapd +## Control 2.2.9 - Ensure IMAP and POP3 server is not installed - cyrus-imapd # This variable, when set to false, will specify that IMAP and POP3 servers(cyrus-imapd) should be uninstalled. rhel9cis_imap_server: false -# Control 2.2.10 - Ensure Samba is not enabled +## Control 2.2.10 - Ensure Samba is not enabled # This variable, when set to false, will specify that 'samba' package should be uninstalled. rhel9cis_samba_server: false -# Control 2.2.11 - Ensure HTTP Proxy Server is not installed +## Control 2.2.11 - Ensure HTTP Proxy Server is not installed # This variable, when set to false, will specify that 'squid' package should be uninstalled. rhel9cis_squid_server: false -# Control 2.2.12 - Ensure net-snmp is not installed +## Control 2.2.12 - Ensure net-snmp is not installed # This variable, when set to false, will specify that 'net-snmp' package should be uninstalled. rhel9cis_snmp_server: false -# Control 2.2.13 - Ensure telnet-server is not installed +## Control 2.2.13 - Ensure telnet-server is not installed # This variable, when set to false, will specify that 'telnet-server' package should be uninstalled. rhel9cis_telnet_server: false -# Control 2.2.15 - Ensure mail transfer agent is configured for local-only mode +## Control 2.2.15 - Ensure mail transfer agent is configured for local-only mode # This variable, when system is NOT a mailserver, will configure Postfix to listen only on the loopback interface(the virtual # network interface that the server uses to communicate internally. rhel9cis_is_mail_server: false @@ -639,15 +652,15 @@ rhel9cis_is_mail_server: false # Set the respective variable to `true` to keep the # client package, otherwise it is uninstalled (false). -# Control 2.2.16 - Ensure nfs-utils is not installed or the nfs-server service is masked" -# This variable specifies if the usage of NFS SERVER is needed. The behavior of 2.2.16 will depend on -# the var used in conjunction('rhel9cis_use_nfs_service') with current one, respectively: +## Control 2.2.16 - Ensure nfs-utils is not installed or the nfs-server service is masked" +# This variable specifies if the usage of NFS SERVER is needed. Execution of the rule which secures (by uninstalling or masking service) +# NFS(if it's NOT needed) will depend on the var used in conjunction('rhel9cis_use_nfs_service') with current one, respectively: # - if Server IS NOT needed('false') and: # - Service IS NOT needed('rhel9cis_use_nfs_service: false'): 'nfs-utils' package will be removed # - Service IS needed('rhel9cis_use_nfs_service: true'): impossible to need the service without the server # - if Server IS needed('true') and: # - Service IS NOT needed('rhel9cis_use_nfs_service: false'): 'nfs-server' service will be masked -# - Service IS needed('rhel9cis_use_nfs_service: true'): Rule 2.2.16 will be SKIPPED. +# - Service IS needed('rhel9cis_use_nfs_service: true'): Rule will be SKIPPED. # | Server | Service | Result | # |---------|---------|-----------------------------------------------------------| # | false | false | Remove package | @@ -655,24 +668,24 @@ rhel9cis_is_mail_server: false # | true | false | Mask 'service' | # | true | true | SKIP RULE, BOTH 'service' and 'server' are required | rhel9cis_use_nfs_server: false -# Control 2.2.16 - Ensure nfs-utils is not installed or the nfs-server service is masked. +## Control 2.2.16 - Ensure nfs-utils is not installed or the nfs-server service is masked. # This variable specifies if the usage of NFS SERVICE is needed. If it's: -# - needed('true'): rule 2.2.16 will not be executed at all -# - not needed('false'): rule 2.2.16 will be executed, its behavior being controlled by the var -# used in conjunction with current one: +# - needed('true'): rule which uninstalls/masks-service WILL NOT be executed at all +# - not needed('false'): rule which uninstalls/masks-service WILL be executed, its behavior being +# controlled by the var used in conjunction with current one: # - removing 'nfs-utils' package('rhel9cis_use_nfs_server' set to 'false') # - masking the 'nfs-server' service('rhel9cis_use_nfs_server' set to 'true') rhel9cis_use_nfs_service: false -# Control 2.2.17 - Ensure rpcbind is not installed or the rpcbind services are masked -# This variable specifies if the usage of RPC SERVER is needed. The behavior of 2.2.17 will depend on -# the var used in conjunction('rhel9cis_use_rpc_service') with current one, respectively: +## Control 2.2.17 - Ensure rpcbind is not installed or the rpcbind services are masked +# This variable specifies if the usage of RPC SERVER is needed. Execution of the rule which secures (by uninstalling or masking service) +# RPC(if it's NOT needed) will depend on the var used in conjunction('rhel9cis_use_rpc_service') with current one, respectively: # - if Server IS NOT needed('false') and: # - Service IS NOT needed('rhel9cis_use_rpc_service: false'): 'rpcbind' package will be removed # - Service IS needed('rhel9cis_use_rpc_service: true'): impossible to need the service without the server # - if Server IS needed('true') and: # - Service IS NOT needed('rhel9cis_use_rpc_service: false'): 'rpcbind.socket' service will be masked -# - Service IS needed('rhel9cis_use_rpc_service: true'): Rule 2.2.17 will be SKIPPED. +# - Service IS needed('rhel9cis_use_rpc_service: true'): Rule will be SKIPPED. # | Server | Service | Result | # |---------|---------|-----------------------------------------------------------| # | false | false | Remove package | @@ -680,25 +693,24 @@ rhel9cis_use_nfs_service: false # | true | false | Mask 'service' | # | true | true | SKIP RULE, BOTH 'service' and 'server' are required | rhel9cis_use_rpc_server: false -# Control 2.2.17 - Ensure rpcbind is not installed or the rpcbind services are masked +## Control 2.2.17 - Ensure rpcbind is not installed or the rpcbind services are masked # This variable specifies if the usage of RPC SERVICE is needed. If it's: -# - needed('true'): rule 2.2.17 will not be executed at all -# - not needed('false'): rule 2.2.17 will be executed, its behavior being controlled by the var +# - needed('true'): rule which uninstalls/masks-service WILL NOT be executed at all +# - not needed('false'): rule which uninstalls/masks-service WILL be executed, its behavior being controlled by the var # used in conjunction with current one: # - removing 'rpcbind' package('rhel9cis_use_rpc_server' set to 'false') # - masking the 'rpcbind.socket' service('rhel9cis_use_rpc_server' set to 'true') rhel9cis_use_rpc_service: false - -# Control 2.2.18 - Ensure rsync service is not enabled -# This variable specifies if the usage of RSYNC SERVER is needed. The behavior of 2.2.18 will depend on -# the var used in conjunction('rhel9cis_use_rsync_service') with current one, respectively: +## Control 2.2.18 - Ensure rsync service is not enabled +# This variable specifies if the usage of RSYNC SERVER is needed. Execution of the rule which secures (by uninstalling or masking service) +# RSYNC(if it's NOT needed) will depend on the var used in conjunction('rhel9cis_use_rsync_service') with current one, respectively: # - if Server IS NOT needed('false') and: # - Service IS NOT needed('rhel9cis_use_rsync_service: false'): 'rsync-daemon' package will be removed # - Service IS needed('rhel9cis_use_rsync_service: true'): impossible to need the service without the server # - if Server IS needed('true') and: # - Service IS NOT needed('rhel9cis_use_rsync_service: false'): 'rsyncd' service will be masked -# - Service IS needed('rhel9cis_use_rsync_service: true'): Rule 2.2.18 will be SKIPPED. +# - Service IS needed('rhel9cis_use_rsync_service: true'): Rule will be SKIPPED. # | Server | Service | Result | # |---------|---------|-----------------------------------------------------------| # | false | false | Remove package | @@ -706,51 +718,57 @@ rhel9cis_use_rpc_service: false # | true | false | Mask 'service' | # | true | true | SKIP RULE, BOTH 'service' and 'server' are required | rhel9cis_use_rsync_server: false -# Control 2.2.18 - Ensure rsync service is not enabled +## Control 2.2.18 - Ensure rsync service is not enabled # This variable specifies if the usage of RSYNC SERVICE is needed. If it's: -# - needed('true'): rule 2.2.18 will not be executed at all -# - not needed('false'): rule 2.2.18 will be executed, its behavior being controlled by the var +# - needed('true'): rule which uninstalls/masks-service WILL NOT be executed at all +# - not needed('false'): rule which uninstalls/masks-service WILL be executed, its behavior being controlled by the var # used in conjunction with current one: # - removing 'rsync-daemon' package('rhel9cis_use_rsync_server' set to 'false') # - masking the 'rsyncd' service('rhel9cis_use_rsync_server' set to 'true') rhel9cis_use_rsync_service: false #### 2.3 Service clients -# Control - 2.3.1 - Ensure telnet client is not installed + + +## Control - 2.3.1 - Ensure telnet client is not installed # Set this variable to `true` to keep package `telnet`; otherwise, the package is uninstalled. rhel9cis_telnet_required: false -# Control - 2.3.2 - Ensure LDAP client is not installed +## Control - 2.3.2 - Ensure LDAP client is not installed # Set this variable to `true` to keep package `openldap-clients`; otherwise, the package is uninstalled. rhel9cis_openldap_clients_required: false -# Control - 2.3.3 - Ensure FTP client is not installed +## Control - 2.3.3 - Ensure FTP client is not installed # Set this variable to `true` to keep package `tftp`; otherwise, the package is uninstalled. rhel9cis_tftp_client: false -# Control - 2.3.4 - Ensure FTP client is not installed +## Control - 2.3.4 - Ensure FTP client is not installed # Set this variable to `true` to keep package `ftp`; otherwise, the package is uninstalled. rhel9cis_ftp_client: false ## Section 3 vars for ## Sysctl -# This variable governs if the task which updates sysctl(including sysctl reload) is executed, but current -# default value can be overriden by other tasks(1.5.3, 3.1.1, 3.2.1, 3.2.2, 3.3.1-3.3.9). + + +# This variable governs if the task which updates sysctl(including sysctl reload) is executed. +# NOTE: The current default value is likely to be overriden by other further tasks(via 'set_fact'). rhel9cis_sysctl_update: false # This variable governs if the task which flushes the IPv4 routing table is executed(forcing subsequent connections to -# use the new configuration). Current default value can be overriden by other tasks(3.2.1, 3.2.2, 3.3.1-3.3.8). +# use the new configuration). +# NOTE: The current default value is likely to be overriden by other further tasks(via 'set_fact'). rhel9cis_flush_ipv4_route: false # This variable governs if the task which flushes the IPv6 routing table is executed(forcing subsequent connections to -# use the new configuration). Current default value can be overriden by other tasks(3.1.1, 3.2.1, 3.3.1, 3.3.2, 3.3.9). +# use the new configuration). +# NOTE: The current default value is likely to be overriden by other further tasks(via 'set_fact'). rhel9cis_flush_ipv6_route: false -### Firewall Service to install and configure - Option is: -# 1) either 'firewalld'(Controls 3.4.1.2, 3.4.2.1, 3.4.2.4) -# 2) or 'nftables'(Controls ) +### Firewall Service to install and configure - Options are: +# 1) either 'firewalld' +# 2) or 'nftables' #### Some control allow for services to be removed or masked #### The options are under each heading #### absent = remove the package #### masked = leave package if installed and mask the service rhel9cis_firewall: firewalld -# Control 3.4.2.1 - Ensure firewalld default zone is set +## Control 3.4.2.1 - Ensure firewalld default zone is set # This variable will set the firewalld default zone(that is used for everything that is not explicitly bound/assigned # to another zone): if there is no zone assigned to a connection, interface or source, only the default zone is used. rhel9cis_default_zone: public @@ -761,31 +779,28 @@ rhel9cis_firewalld_ports: protocol: tcp ## Controls 3.5.2.x - nftables -# The default nftables table name is "filter". This variable name will be the one all -# "rhel9cis_nft_tables_tablename" is the name of the table in nftables you want to create. -# nftables configs are applied to. -# options are: inet filter -# Control 3.4.2.2 - Ensure at least one nftables table exists + +## Control 3.4.2.2 - Ensure at least one nftables table exists # This variable governs if a table will be automatically created in nftables. Without a table (no default one), nftables # will not filter network traffic, so if this variable is set to 'false' and no tables exist, an alarm will be triggered! rhel9cis_nft_tables_autonewtable: true -# Controls 3.4.2.{2|3|4|6|7} nftables +## Controls 3.4.2.{2|3|4|6|7} nftables # This variable stores the name of the table to be used when configuring nftables(creating chains, configuring loopback # traffic, established connections, default deny). If 'rhel9cis_nft_tables_autonewtable' is set as true, a new table will # be created using as name the value stored by this variable. rhel9cis_nft_tables_tablename: filter -# Control 3.4.2.3 - Ensure nftables base chains exist +## Control 3.4.2.3 - Ensure nftables base chains exist # This variable governs if a nftables base chain(entry point for packets from the networking stack) will be automatically # created, if needed. Without a chain, a hook for input, forward, and delete, packets that would flow through those -#chains will not be touched by nftables +# chains will not be touched by nftables. rhel9cis_nft_tables_autochaincreate: true ## Controls: # - 1.7.1 - Ensure message of the day is configured properly # - 1.7.2 - Ensure local login warning banner is configured properly # - 1.7.3 - Ensure remote login warning banner is configured properly -# Warning Banner Content (issue, issue.net, motd) +# This variable stores the content for the Warning Banner(relevant for issue, issue.net, motd). rhel9cis_warning_banner: Authorized uses only. All activity may be monitored and reported. # End Banner @@ -797,7 +812,7 @@ rhel9cis_warning_banner: Authorized uses only. All activity may be monitored and # log files are getting too full and space is getting too low. rhel9cis_auditd: # This variable tells the system what action to take when the system has detected - #that it is starting to get low on disk space. Options are the same as for `admin_space_left_action` + # that it is starting to get low on disk space. Options are the same as for `admin_space_left_action`. space_left_action: email # This variable should contain a valid email address or alias(default value is root), # which will be used to send a warning when configured action is 'email'. @@ -837,11 +852,9 @@ rhel9cis_audit_back_log_limit: 8192 # This should be set based on your sites policy. CIS does not provide a specific value. rhel9cis_max_log_file_size: 10 -## 4.1.3.x - Audit template -# This variable is set to true by tasks 4.1.3.1 to 4.1.3.20. As a result, the -# audit settings are overwritten with the role's template. In order to exclude -# specific rules, you must set the variable of form `rhel9cis_rule_4_1_3_x` above -# to `false`. +## Control 4.1.3.x - Audit template +# This variable governs if the auditd logic should be executed(if value is true). +# NOTE: The current default value is likely to be overriden(via 'set_fact') by other further tasks(in sub-section 'Auditd rules'). update_audit_template: false ## Advanced option found in auditd post @@ -857,12 +870,12 @@ rhel9cis_auditd_uid_exclude: # '/etc/audit/auditd.conf' file) can be stored within current variable. rhel9cis_auditd_extra_conf: {} # Example: -# rhel9cis_auditd_extra_conf: +#rhel9cis_auditd_extra_conf: # admin_space_left: '10%' ## Whether rsyslog or journald preferred method for local logging -## 4.2.1 | Configure rsyslog -## 4.2.2 | Configure journald +## Control 4.2.1 | Configure rsyslog +## Control 4.2.2 | Configure journald # This variable governs which logging service should be used, choosing between 'rsyslog'(CIS recommendation) # or 'journald'(only one is implemented) will trigger the execution of the associated subsection, as the-best # practices are written wholly independent of each other. @@ -872,93 +885,92 @@ rhel9cis_syslog: rsyslog # in /etc/rsyslog.conf file, namely mail, news and misc(warn, messages) rhel9cis_rsyslog_ansiblemanaged: true -#### Control 4.2.1.6 - Ensure rsyslog is configured to send logs to a remote log host +## Control 4.2.1.6 - Ensure rsyslog is configured to send logs to a remote log host # This variable governs if 'rsyslog' service should be automatically configured to forward messages to a # remote log server. If set to 'false', the configuration of the 'omfwd' plugin, used to provide forwarding # over UDP or TCP, will not be performed. rhel9cis_remote_log_server: false -#### Control 4.2.1.6 - Ensure rsyslog is configured to send logs to a remote log host +## Control 4.2.1.6 - Ensure rsyslog is configured to send logs to a remote log host # This variable configures the value of the 'target' parameter to be configured when enabling # forwarding syslog messages to a remote log server, thus configuring the actual FQDN/IP address of the # destination server. For this value to be reflected in the configuration, the variable which enables the # automatic configuration of rsyslog forwarding must be enabled('rhel9cis_remote_log_server: true'). rhel9cis_remote_log_host: logagg.example.com -#### Control 4.2.1.6 - Ensure rsyslog is configured to send logs to a remote log host +## Control 4.2.1.6 - Ensure rsyslog is configured to send logs to a remote log host # This variable configures the value of the 'port' parameter to be configured when enabling # forwarding syslog messages to a remote log server. The default value for this destination port is 514. # For this value to be reflected in the configuration, the variable which enables the # automatic configuration of rsyslog forwarding must be enabled('rhel9cis_remote_log_server: true'). rhel9cis_remote_log_port: 514 -#### Control 4.2.1.6 - Ensure rsyslog is configured to send logs to a remote log host +## Control 4.2.1.6 - Ensure rsyslog is configured to send logs to a remote log host # This variable configures the value("TCP"/"UDP") of the 'protocol' parameter to be configured when enabling # forwarding syslog messages to a remote log server. The default value for the 'omfwd' plug-in is UDP. # For this value to be reflected in the configuration, the variable which enables the # automatic configuration of rsyslog forwarding must be enabled('rhel9cis_remote_log_server: true'). rhel9cis_remote_log_protocol: tcp -#### Control 4.2.1.6 - Ensure rsyslog is configured to send logs to a remote log host +## Control 4.2.1.6 - Ensure rsyslog is configured to send logs to a remote log host # This variable governs how often an action is retried(value is passed to 'action.resumeRetryCount' parameter) before # it is considered to have failed(that roughly translates to discarded messages). The default value is 0, but # when set to "-1"(eternal), this setting would prevent rsyslog from dropping messages when retrying to connect # if server is not responding. For this value to be reflected in the configuration, the variable which enables the # automatic configuration of rsyslog forwarding must be enabled('rhel9cis_remote_log_server: true'). rhel9cis_remote_log_retrycount: 100 -#### Control 4.2.1.6 - Ensure rsyslog is configured to send logs to a remote log host +## Control 4.2.1.6 - Ensure rsyslog is configured to send logs to a remote log host # This variable configures the maximum number of messages that can be hold(value is passed to 'queue.size' parameter). # For this value to be reflected in the configuration, the variable which enables the automatic configuration # of rsyslog forwarding must be enabled('rhel9cis_remote_log_server: true'). rhel9cis_remote_log_queuesize: 1000 -#### Control 4.2.1.7 - Ensure rsyslog is not configured to receive logs from a remote client +## Control 4.2.1.7 - Ensure rsyslog is not configured to receive logs from a remote client # This variable expresses whether the system is used as a log server or not. If set to: # - 'false', current system will act as a log CLIENT, thus it should NOT receive data from other hosts. # - 'true', current system will act as a log SERVER, enabling centralised log management(by protecting log integrity -# from local attacks on remote clients) +# from local attacks on remote clients) rhel9cis_system_is_log_server: false -#### Control 4.2.2.1.2 - Ensure systemd-journal-remote is configured +## Control 4.2.2.1.2 - Ensure systemd-journal-remote is configured # 'rhel9cis_journal_upload_url' is the ip address to upload the journal entries to # URL value may specify either just the hostname or both the protocol and hostname. 'https' is the default. The port # number may be specified after a colon (":"), otherwise 19532 will be used by default. rhel9cis_journal_upload_url: 192.168.50.42 ## The paths below have the default paths/files, but allow user to create custom paths/filenames -#### Control 4.2.2.1.2 - Ensure systemd-journal-remote is configured +## Control 4.2.2.1.2 - Ensure systemd-journal-remote is configured # This variable specifies the path to the private key file used by the remote journal # server to authenticate itself to the client. This key is used alongside the server's # public certificate to establish secure communication. rhel9cis_journal_upload_serverkeyfile: "/etc/ssl/private/journal-upload.pem" -#### Control 4.2.2.1.2 - Ensure systemd-journal-remote is configured +## Control 4.2.2.1.2 - Ensure systemd-journal-remote is configured # This variable specifies the path to the public certificate file of the remote journal # server. This certificate is used to verify the authenticity of the remote server. rhel9cis_journal_servercertificatefile: "/etc/ssl/certs/journal-upload.pem" -#### Control 4.2.2.1.2 - Ensure systemd-journal-remote is configured +## Control 4.2.2.1.2 - Ensure systemd-journal-remote is configured # This variable specifies the path to a file containing one or more public certificates # of certificate authorities (CAs) that the client trusts. These trusted certificates are used # to validate the authenticity of the remote server's certificate. rhel9cis_journal_trustedcertificatefile: "/etc/ssl/ca/trusted.pem" -# Control 4.2.2.6 - Ensure journald log rotation is configured per site policy # The variables below related to journald, please set these to your site specific values # These variable specifies how much disk space the journal may use up at most # Specify values in bytes or use K, M, G, T, P, E as units for the specified sizes. # See https://www.freedesktop.org/software/systemd/man/journald.conf.html for more information. # ATTENTION: Uncomment the keyword below when values are set! -# Control 4.2.2.6 - Ensure journald log rotation is configured per site policy -# rhel9cis_journald_systemmaxuse is the max amount of disk space the logs will use +## Control 4.2.2.6 - Ensure journald log rotation is configured per site policy +# 'rhel9cis_journald_systemmaxuse' is the max amount of disk space the logs will use rhel9cis_journald_systemmaxuse: 10M -# Control 4.2.2.6 - Ensure journald log rotation is configured per site policy -# rhel9cis_journald_systemkeepfree is the amount of disk space to keep free +## Control 4.2.2.6 - Ensure journald log rotation is configured per site policy +# 'rhel9cis_journald_systemkeepfree' is the amount of disk space to keep free rhel9cis_journald_systemkeepfree: 100G -# Control 4.2.2.6 - Ensure journald log rotation is configured per site policy -# rhel9cis_journald_runtimemaxuse control how much disk space the journal may use up at most. -# same as rhel9cis_journald_systemmaxuse. +## Control 4.2.2.6 - Ensure journald log rotation is configured per site policy +# 'rhel9cis_journald_runtimemaxuse' control how much disk space the journal may use up at most. +# same as 'rhel9cis_journald_systemmaxuse'. rhel9cis_journald_runtimemaxuse: 10M -# Control 4.2.2.6 - Ensure journald log rotation is configured per site policy -# rhel9cis_journald_runtimekeepfree is the amount of disk space to keep free -# same as rhel9cis_journald_systemkeepfree, but related to runtime space. +## Control 4.2.2.6 - Ensure journald log rotation is configured per site policy +# 'rhel9cis_journald_runtimekeepfree' is the amount of disk space to keep free +# same as 'rhel9cis_journald_systemkeepfree', but related to runtime space. rhel9cis_journald_runtimekeepfree: 100G -# Control 4.2.2.6 - Ensure journald log rotation is configured per site policy -# rhel9cis_journald_MaxFileSec is how long in time to keep log files. +## Control 4.2.2.6 - Ensure journald log rotation is configured per site policy +# 'rhel9cis_journald_MaxFileSec' is how long in time to keep log files. # This variable specifies, the maximum time to store entries in a single journal # file before rotating to the next one. Set to 0 to turn off this feature. # The given values is interpreted as seconds, unless suffixed with the units @@ -967,23 +979,24 @@ rhel9cis_journald_runtimekeepfree: 100G # ATTENTION: Uncomment the keyword below when values are set! rhel9cis_journald_maxfilesec: 1month -#### Control 4.3 - Ensure logrotate is configured +## Control 4.3 - Ensure logrotate is configured # This variable defines the log file rotation period. # Options are: daily, weekly, monthly, yearly. rhel9cis_logrotate: "daily" ## Section5 vars -# Section 5.2 - SSH +## Section 5.2 - SSH + # This value, containing the absolute filepath of the produced 'sshd' config file, allows usage of # drop-in files('/etc/ssh/ssh_config.d/{ssh_drop_in_name}.conf', supported by RHEL9) when CIS adopts them. # Otherwise, the default value is '/etc/ssh/ssh_config'. rhel9_cis_sshd_config_file: /etc/ssh/sshd_config -#### Controls: -## 5.2.4 - Ensure SSH access is limited -## 5.2.19 - Ensure SSH LoginGraceTime is set to one minute or less -## 5.2.20 - Ensure SSH Idle Timeout Interval is configured +## Controls: +## - 5.2.4 - Ensure SSH access is limited +## - 5.2.19 - Ensure SSH LoginGraceTime is set to one minute or less +## - 5.2.20 - Ensure SSH Idle Timeout Interval is configured rhel9cis_sshd: # This variable sets the maximum number of unresponsive "keep-alive" messages # that can be sent from the server to the client before the connection is considered @@ -1023,7 +1036,7 @@ rhel9cis_sshd: # For more info, see https://linux.die.net/man/5/sshd_config deny_groups: "" -# Control 5.2.5 - Ensure SSH LogLevel is appropriate +## Control 5.2.5 - Ensure SSH LogLevel is appropriate # This variable is used to control the verbosity of the logging produced by the SSH server. # The options for setting it are as follows: # - `QUIET`: Minimal logging; @@ -1035,39 +1048,41 @@ rhel9cis_sshd: # - `DEBUG(x)`: Whereas x = debug level 1 to 3, DEBUG=DEBUG1. rhel9cis_ssh_loglevel: INFO -# Control 5.2.18 - Ensure SSH MaxSessions is set to 10 or less +## Control 5.2.18 - Ensure SSH MaxSessions is set to 10 or less # This variable value specifies the maximum number of open sessions that are permitted from # a given location rhel9cis_ssh_maxsessions: 4 ## Control 5.6.1.4 - Ensure inactive password lock is 30 days or less +rhel9cis_inactivelock: # This variable specifies the number of days of inactivity before an account will be locked. # CIS requires a value of 30 days or less. -rhel9cis_inactivelock: lock_days: 30 # This variable governs if authconfig package should be installed. This package provides a simple method of # configuring /etc/sysconfig/network to handle NIS, as well as /etc/passwd and /etc/shadow, the files used # for shadow password support. Basic LDAP, Kerberos 5, and Winbind client configuration is also provided. rhel9cis_use_authconfig: false -#### Controls -# SECTION 5.4 - Configure authselect: Custom authselect profile settings(name, profile to customize, options) -# 5.4.1 - Ensure custom authselect profile is used('custom_profile_name', 'default_file_to_copy' subsettings) -# 5.4.2 - Ensure authselect includes with-faillock | with auth select profile('custom_profile_name') -# Settings in place now will fail, they are place holders from the control example. Due to the way many multiple +## Section 5.4 - Configure authselect: Custom authselect profile settings(name, profile to customize, options) +## Controls: +# - 5.4.1 - Ensure custom authselect profile is used('custom_profile_name', 'default_file_to_copy' subsettings) +# - 5.4.2 - Ensure authselect includes with-faillock | with auth select profile('custom_profile_name') +# Settings in place now will fail, they are placeholders from the control example. Due to the way many multiple # options and ways to configure this control needs to be enabled and settings adjusted to minimise risk. rhel9cis_authselect: + # This variable configures the name of the custom profile to be created and selected. custom_profile_name: custom-profile + # This variable configures the ID of the existing profile that should be used as a base for the new profile. default_file_to_copy: "sssd --symlink-meta" options: with-sudo with-faillock without-nullok -# Control 5.4.1 - Ensure custom authselect profile is used +## Control 5.4.1 - Ensure custom authselect profile is used # This variable governs if an authselect custom profile should be automatically created, by copying and # customizing one of the default profiles. The default profiles include: sssd, winbind, or the nis. This profile can then be # customized to follow site specific requirements. rhel9cis_authselect_custom_profile_create: false -# Control 5.4.2 - Ensure authselect includes with-faillock | Create custom profiles +## Control 5.4.2 - Ensure authselect includes with-faillock | Create custom profiles # This variable governs if the existing custom profile should be selected(Note: please keep in mind that all future updates # to the PAM templates and meta files in the original profile will be reflected in your custom profile, too.) rhel9cis_authselect_custom_profile_select: false @@ -1098,11 +1113,11 @@ rhel9cis_pam_password: # set to 4, passwords will have to include all four types of characters. minclass: 4 -## Controls -# 5.5.2 - Ensure lockout for failed password attempts is configured -# 5.5.3 - Ensure password reuse is limited -# 5.5.4 - Ensure password hashing algorithm is SHA-512 -# 5.4.2 - Ensure authselect includes with-faillock +## Controls +# - 5.5.2 - Ensure lockout for failed password attempts is configured +# - 5.5.3 - Ensure password reuse is limited +# - 5.5.4 - Ensure password hashing algorithm is SHA-512 +# - 5.4.2 - Ensure authselect includes with-faillock rhel9cis_pam_faillock: # This variable sets the amount of time a user will be unlocked after the max amount of # password failures. @@ -1110,7 +1125,7 @@ rhel9cis_pam_faillock: # This variable sets the amount of tries a password can be entered, before a user is locked. deny: 5 # This variable represents the number of password change cycles, after which - # a user can re-use a password. + # an user can re-use a password. # CIS requires a value of 5 or more. remember: 5 @@ -1118,44 +1133,44 @@ rhel9cis_pam_faillock: # These are discovered via logins.def if set true discover_int_uid: false ### Controls: -# 5.6.2 - Ensure system accounts are secured -# 6.2.10 - Ensure local interactive user home directories exist -# 6.2.11 - Ensure local interactive users own their home directories +# - 5.6.2 - Ensure system accounts are secured +# - 6.2.10 - Ensure local interactive user home directories exist +# - 6.2.11 - Ensure local interactive users own their home directories # This variable sets the minimum number from which to search for UID # Note that the value will be dynamically overwritten if variable `dicover_int_uid` has # been set to `true`. min_int_uid: 1000 ### Controls: -# 6.2.10 - Ensure local interactive user home directories exist -# 6.2.11 - Ensure local interactive users own their home directories +# - 6.2.10 - Ensure local interactive user home directories exist +# - 6.2.11 - Ensure local interactive users own their home directories # This variable sets the maximum number at which the search stops for UID # Note that the value will be dynamically overwritten if variable `dicover_int_uid` has # been set to `true`. max_int_uid: 65533 -### Control 5.3.3 - Ensure sudo log file exists +## Control 5.3.3 - Ensure sudo log file exists # By default, sudo logs through syslog(3). However, to specify a custom log file, the # 'logfile' parameter will be used, setting it with current variable's value. # This variable defines the path and file name of the sudo log file. rhel9cis_sudolog_location: "/var/log/sudo.log" -#### Control 5.3.6 -Ensure sudo authentication timeout is configured correctly +## Control 5.3.6 -Ensure sudo authentication timeout is configured correctly # This variable sets the duration (in minutes) during which a user's authentication credentials # are cached after successfully authenticating using "sudo". This allows the user to execute # multiple commands with elevated privileges without needing to re-enter their password for each # command within the specified time period. CIS requires a value of at most 15 minutes. rhel9cis_sudo_timestamp_timeout: 15 -### 5.4.2 authselect and faillock +## Control 5.4.2 - authselect and faillock ## This option is used at your own risk it will enable faillock for users ## Only to be used on a new clean system if not using authselect -## THIS CAN BREAK ACCESS EVEN FOR ROOT - UNDERSTAND RISKS ## +## THIS CAN BREAK ACCESS EVEN FOR ROOT - PLEASE UNDERSTAND RISKS ! rhel9cis_add_faillock_without_authselect: false -# This needs to be set to 'ACCEPT'(string), besides setting 'rhel9cis_add_faillock_without_authselect' -# to 'true', in order to execute the 5.4.2 sub-tasks dealing with not authselect profile +# This needs to be set to 'ACCEPT'(as string), besides setting 'rhel9cis_add_faillock_without_authselect' +# to 'true', in order to include the 'with-failock' option to the current authselect profile. rhel9cis_5_4_2_risks: NEVER -### Control 5.6.3 - Ensure default user shell timeout is 900 seconds or less +## Control 5.6.3 - Ensure default user shell timeout is 900 seconds or less # Session timeout setting file (TMOUT setting can be set in multiple files) # Timeout value is in seconds. (60 seconds * 10 = 600) rhel9cis_shell_session_timeout: @@ -1171,36 +1186,36 @@ rhel9cis_shell_session_timeout: # CIS requires a value of at most 900 seconds. timeout: 600 -### Control 5.6.1.5 - Ensure all users last password change date is in the past +## Control 5.6.1.5 - Ensure all users last password change date is in the past # Allow ansible to expire password for account with a last changed date in the future. Setting it # to 'false' will just display users in violation, while 'true' will expire those users passwords. rhel9cis_futurepwchgdate_autofix: true -### Control 5.3.7 - Ensure access to the 'su' command is restricted +## Control 5.3.7 - Ensure access to the 'su' command is restricted # This variable determines the name of the group of users that are allowed to use the su command. # CIS requires that such a group be CREATED(named according to site policy) and be kept EMPTY. rhel9cis_sugroup: nosugroup ## Section6 vars -### Control 6.1.15 - Audit system file permissions | Create list and warning +## Control 6.1.15 - Audit system file permissions | Create list and warning # The RPM package-manager has many useful options. For example, using option: # - '-V': RPM can automatically check if system packages are correctly installed # - '-qf': RPM can be used to determine which package a particular file belongs to -# Rule 6.1.15 takes advantage of the combination of those two options and, therefore, is able to +# Auditing system file-permissions takes advantage of the combination of those two options and, therefore, is able to # detect any discrepancy regarding installed packages, redirecting the output of this combined # command into a specific file. If no output is returned, the package is installed correctly. -# Current variable stores the preferred absolute filepath such a file, therefore if this file +# Current variable stores the preferred absolute filepath for such a file, therefore if this file # contains any lines, an alert message will be generated to warn about each discrepancy. rhel9cis_rpm_audit_file: /var/tmp/rpm_file_check -### Control 6.1.9 - Ensure no world writable files exist +## Control 6.1.9 - Ensure no world writable files exist # Allow ansible to adjust world-writable files. False will just display world-writable files, True will remove world-writable. rhel9cis_no_world_write_adjust: true rhel9cis_passwd_label: "{{ (this_item | default(item)).id }}: {{ (this_item | default(item)).dir }}" -### Control 6.2.16 - Ensure local interactive user dot files are not group or world writable +## Control 6.2.16 - Ensure local interactive user dot files are not group or world writable # This boolean variable governs if current role should follow filesystem links for changes to # user home directory. rhel_09_6_2_16_home_follow_symlinks: false From b4bef292ca8a86cf1090b3deaa4b03be037556c2 Mon Sep 17 00:00:00 2001 From: Ionut Pruteanu Date: Fri, 19 Jan 2024 15:37:44 +0200 Subject: [PATCH 09/14] Improving doc for journald log parameters. Signed-off-by: Ionut Pruteanu --- defaults/main.yml | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/defaults/main.yml b/defaults/main.yml index 18b30b0..e398dcb 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -963,30 +963,30 @@ rhel9cis_journal_servercertificatefile: "/etc/ssl/certs/journal-upload.pem" # of certificate authorities (CAs) that the client trusts. These trusted certificates are used # to validate the authenticity of the remote server's certificate. rhel9cis_journal_trustedcertificatefile: "/etc/ssl/ca/trusted.pem" +# ATTENTION: Uncomment the keyword below when values are set! +## Control 4.2.2.6 - Ensure journald log rotation is configured per site policy +# Current variable configures the max amount of disk space the logs will use(thus, journal files +# will not grow without bounds) # The variables below related to journald, please set these to your site specific values # These variable specifies how much disk space the journal may use up at most # Specify values in bytes or use K, M, G, T, P, E as units for the specified sizes. # See https://www.freedesktop.org/software/systemd/man/journald.conf.html for more information. -# ATTENTION: Uncomment the keyword below when values are set! - -## Control 4.2.2.6 - Ensure journald log rotation is configured per site policy -# 'rhel9cis_journald_systemmaxuse' is the max amount of disk space the logs will use rhel9cis_journald_systemmaxuse: 10M ## Control 4.2.2.6 - Ensure journald log rotation is configured per site policy -# 'rhel9cis_journald_systemkeepfree' is the amount of disk space to keep free +# Current variable configures the amount of disk space to keep free for other uses. rhel9cis_journald_systemkeepfree: 100G ## Control 4.2.2.6 - Ensure journald log rotation is configured per site policy -# 'rhel9cis_journald_runtimemaxuse' control how much disk space the journal may use up at most. -# same as 'rhel9cis_journald_systemmaxuse'. +# This variable configures how much disk space the journal may use up at most. +# Similar with 'rhel9cis_journald_systemmaxuse', but related to runtime space. rhel9cis_journald_runtimemaxuse: 10M ## Control 4.2.2.6 - Ensure journald log rotation is configured per site policy -# 'rhel9cis_journald_runtimekeepfree' is the amount of disk space to keep free -# same as 'rhel9cis_journald_systemkeepfree', but related to runtime space. +# This variable configures the actual amount of disk space to keep free +# Similar with 'rhel9cis_journald_systemkeepfree', but related to runtime space. rhel9cis_journald_runtimekeepfree: 100G ## Control 4.2.2.6 - Ensure journald log rotation is configured per site policy -# 'rhel9cis_journald_MaxFileSec' is how long in time to keep log files. -# This variable specifies, the maximum time to store entries in a single journal +# Current variable governs the settings for log retention(how long the log files will be kept). +# Thus, it specifies the maximum time to store entries in a single journal # file before rotating to the next one. Set to 0 to turn off this feature. # The given values is interpreted as seconds, unless suffixed with the units # `year`, `month`, `week`, `day`, `h` or `m` to override the default time unit of seconds. From 073f6b71928d449ac9c3910e68ecaf1f0aecc233 Mon Sep 17 00:00:00 2001 From: Ionut Pruteanu Date: Fri, 19 Jan 2024 15:55:42 +0200 Subject: [PATCH 10/14] Revert "Added vars for streams." [IP] I see no benefit to duplicate vars in defaults/main.yml in other files like specific vars for Alma/Rocky, especially since we're using the same values for those vars. Also, replacing rsyslog with journald is not fine for this current doc-extension proposal. This reverts commit a57333dcf1d8230e4d4a9d84ed1aa10b430bb64b. --- defaults/main.yml | 2 +- vars/AlmaLinux.yml | 6 ------ vars/Rocky.yml | 6 ------ 3 files changed, 1 insertion(+), 13 deletions(-) diff --git a/defaults/main.yml b/defaults/main.yml index e398dcb..4ffa634 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -894,7 +894,7 @@ rhel9cis_auditd_extra_conf: {} # This variable governs which logging service should be used, choosing between 'rsyslog'(CIS recommendation) # or 'journald'(only one is implemented) will trigger the execution of the associated subsection, as the-best # practices are written wholly independent of each other. -rhel9cis_syslog: journald +rhel9cis_syslog: rsyslog ## Control 4.2.1.5 | PATCH | Ensure logging is configured # This variable governs if current Ansible role should manage syslog settings # in /etc/rsyslog.conf file, namely mail, news and misc(warn, messages) diff --git a/vars/AlmaLinux.yml b/vars/AlmaLinux.yml index a0fa6ba..b0eb3d9 100644 --- a/vars/AlmaLinux.yml +++ b/vars/AlmaLinux.yml @@ -5,9 +5,3 @@ os_gpg_key_pubkey_name: gpg-pubkey-b86b3716-61e69f29 os_gpg_key_pubkey_content: "AlmaLinux OS 9 b86b3716" # disable repo_gpgcheck due to OS default repos rhel9cis_rule_enable_repogpg: false - -rhel9cis_sshd: - # This variable sets the maximum number of unresponsive "keep-alive" messages - # that can be sent from the server to the client before the connection is considered - # inactive and thus, closed. - clientalivecountmax: 3 \ No newline at end of file diff --git a/vars/Rocky.yml b/vars/Rocky.yml index 7d9f014..77af29c 100644 --- a/vars/Rocky.yml +++ b/vars/Rocky.yml @@ -3,9 +3,3 @@ os_gpg_key_pubkey_name: gpg-pubkey-350d275d-6279464b os_gpg_key_pubkey_content: "Rocky Enterprise Software Foundation - Release key 2022 350d275d" - -rhel9cis_sshd: - # This variable sets the maximum number of unresponsive "keep-alive" messages - # that can be sent from the server to the client before the connection is considered - # inactive and thus, closed. - clientalivecountmax: 3 \ No newline at end of file From 48f0c7db53f8a2856f1a081a721c721599a6e800 Mon Sep 17 00:00:00 2001 From: Ionut Pruteanu Date: Fri, 19 Jan 2024 16:11:02 +0200 Subject: [PATCH 11/14] Using again the default values used by Lockdown for sshd vars, as they shouldn't be altered Signed-off-by: Ionut Pruteanu --- defaults/main.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/defaults/main.yml b/defaults/main.yml index 4ffa634..888fdd8 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -1016,11 +1016,11 @@ rhel9cis_sshd: # This variable sets the maximum number of unresponsive "keep-alive" messages # that can be sent from the server to the client before the connection is considered # inactive and thus, closed. - clientalivecountmax: 3 + clientalivecountmax: 0 # This variable sets the time interval in seconds between sending "keep-alive" # messages from the server to the client. These types of messages are intended to # keep the connection alive and prevent it being terminated due to inactivity. - clientaliveinterval: 300 + clientaliveinterval: 900 # This variable specifies the amount of seconds allowed for successful authentication to # the SSH server. logingracetime: 60 From 36ab51d60028e96f215122d1918a53f559191f17 Mon Sep 17 00:00:00 2001 From: Ionut Pruteanu Date: Fri, 19 Jan 2024 16:16:18 +0200 Subject: [PATCH 12/14] Removing not useful line from docs Signed-off-by: Ionut Pruteanu --- defaults/main.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/defaults/main.yml b/defaults/main.yml index 888fdd8..75a5167 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -1234,7 +1234,6 @@ rhel9cis_passwd_label: "{{ (this_item | default(item)).id }}: {{ (this_item | de # This boolean variable governs if current role should follow filesystem links for changes to # user home directory. rhel_09_6_2_16_home_follow_symlinks: false -# thanks to @dulin-gnet and community for rhel8-cis feedback. #### Goss Configuration Settings #### # Set correct env for the run_audit.sh script from https://github.com/ansible-lockdown/{{ benchmark }}-Audit.git" From 9ce1fb65564a686804d6713df734df3c6b391a5b Mon Sep 17 00:00:00 2001 From: Marcin Dulinski Date: Wed, 22 Nov 2023 09:17:15 +0000 Subject: [PATCH 13/14] Solved minor conflicts in defaults/main.yml file, when re-basing Signed-off-by: Marcin Dulinski --- defaults/main.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/defaults/main.yml b/defaults/main.yml index 75a5167..888fdd8 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -1234,6 +1234,7 @@ rhel9cis_passwd_label: "{{ (this_item | default(item)).id }}: {{ (this_item | de # This boolean variable governs if current role should follow filesystem links for changes to # user home directory. rhel_09_6_2_16_home_follow_symlinks: false +# thanks to @dulin-gnet and community for rhel8-cis feedback. #### Goss Configuration Settings #### # Set correct env for the run_audit.sh script from https://github.com/ansible-lockdown/{{ benchmark }}-Audit.git" From da62626a9d582e747dca984cc4fc8b35c5b95eee Mon Sep 17 00:00:00 2001 From: "root@DERVISHx" Date: Fri, 24 Nov 2023 15:38:40 +0000 Subject: [PATCH 14/14] Fixing conflicts after rebasing current feature branch onto 'devel' --- defaults/main.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/defaults/main.yml b/defaults/main.yml index 888fdd8..3828ab2 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -137,6 +137,7 @@ audit_run_heavy_tests: true audit_cmd_timeout: 120000 ### End Goss enablements #### +#### Detailed settings found at the end of this document #### # These variables correspond with the CIS rule IDs or paragraph numbers defined in # the CIS benchmark documents. @@ -660,7 +661,6 @@ rhel9cis_telnet_server: false # This variable, when system is NOT a mailserver, will configure Postfix to listen only on the loopback interface(the virtual # network interface that the server uses to communicate internally. rhel9cis_is_mail_server: false - # Note the options # Client package configuration variables. # Packages are used for client services and Server- only remove if you dont use the client service @@ -885,7 +885,7 @@ rhel9cis_auditd_uid_exclude: # '/etc/audit/auditd.conf' file) can be stored within current variable. rhel9cis_auditd_extra_conf: {} # Example: -#rhel9cis_auditd_extra_conf: +# rhel9cis_auditd_extra_conf: # admin_space_left: '10%' ## Whether rsyslog or journald preferred method for local logging