Version information
This version is compatible with:
- Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
- Puppet >= 7.0.0 < 9.0.0
- ,
Start using this module
Add this module to your Puppetfile:
mod 'puppet-rkhunter', '3.0.0'
Learn more about managing modules with a PuppetfileDocumentation
puppet-rkhunter
Manage rkhunter installation and configuration with Puppet.
Features
- Manage ALL config entries (some of them dont make sense in server environments)
- Manage your whitelists
- The check cronjob is called staggered (predefined timewindow)
- The db update cronjob is configured separately
Supported OS
- Debian (tested on Debian 7.5, 8.1, 10)
- Redhat/CentOS (tested on CentOS 6, 7 and 8)
- FreeBSD (NOT tested yet)
Used Modules
Other than some data types from puppetlabs/stdlib, no other external modules are used.
Configuration
See templates/etc/rkhunter.conf.erb
for detailed explanation of the rkhunter
config options. Important: full possible configuration is visible in params.pp.
Do not uncomment them in params.pp.
Minimal configuration
include rkhunter
include rkhunter::cron
A bit bigger configuration
class { 'rkhunter':
allow_ssh_root_user => 'yes',
shared_lib_whitelist => [ '/lib/snoopy.so' ],
allow_syslog_remote_logging => "1",
scriptwhitelist => [
'/bin/egrep',
'/bin/fgrep',
'/bin/which',
'/usr/bin/groups',
'/usr/bin/ldd',
'/usr/bin/lwp-request',
'/usr/sbin/adduser',
],
}
include rkhunter::cron
List of optional configuration paramaeters
NOTE: there may be more. I do not update this list every time. Have a look into params.pp
rotate_mirrors
update_mirrors
mirrors_mode
mail_on_warning
tmpdir
dbdir
scriptdir
logfile
append_log
copy_log_on_error
use_syslog
color_set2
auto_x_detect
whitelisted_is_white
allow_ssh_root_user
allow_ssh_prot_v1
enable_tests
disable_tests
immutable_set
allow_syslog_remote_logging
suspscan_temp
suspscan_maxsize
suspscan_thresh
use_locking
lock_timeout
show_lockmsgs
disable_unhide
installdir
ssh_config_dir
hash_func
hash_fld_idx
package_manager
pkgmgr_no_verfy
ignore_prelink_dep_err
use_sunsum
existwhitelist
attrwhitelist
writewhitelist
scan_mode_dev
phlanx2_dirtest
inetd_conf_path
inetd_allowed_svc
xinetd_conf_path
xinetd_allowed_svc
startup_paths
passwd_file
user_fileprop_files_dirs
rtkt_file_whitelist
rtkt_dir_whitelist
scriptwhitelist
immutewhitelist
allowhiddendir
allowhiddenfile
allowprocdelfile
allowproclisten
allowpromiscif
allowdevfile
allowipcproc
uid0_accounts
pwdless_accounts
syslog_config_file
app_whitelist
suspscan_dirs
port_whitelist
shared_lib_whitelist
License
This project is licensed under the Apache-2 license
Copyright and origin
This repository was forked from https://github.com/mmz-srf/puppet-rkhunter and is now maintained by the Vox Pupuli community.
Changelog
All notable changes to this project will be documented in this file. Each new release typically also includes the latest modulesync defaults. These should not affect the functionality of the module.
v3.0.0 (2024-02-03)
Breaking changes:
- Drop Debian 9 #26 (zilchms)
- Drop Puppet 6 support #23 (bastelfreak)
- Metadata updates; Drop Debian 7 support; Drop CentOS 5/6 support #17 (kenyon)
Implemented enhancements:
- Add Puppet 8 support #25 (bastelfreak)
- puppetlabs/stdlib: Allow 9.x #24 (bastelfreak)
- Type improvements: allow Boolean and Integer in addition to String where applicable #16 (kenyon)
Merged pull requests:
v2.2.0 (2020-08-23)
Implemented enhancements:
- Add CentOS 8 support #12 (bastelfreak)
Merged pull requests:
- modulesync 3.0.0 & puppet-lint updates #11 (bastelfreak)
v2.1.0 (2020-04-29)
Implemented enhancements:
- Add
language
andupdate_lang
parameters #9 (alexjfisher)
v2.0.0 (2019-12-21)
Breaking changes:
- Modulesync 2.9.0 / Make
disable_unhide
Optional
, convert params to boolean and small fixes #5 (bastelfreak)
Implemented enhancements:
- Add support for different IPC options #3 (bastelfreak)
Fixed bugs:
- remove ß from template #2 (bastelfreak)
Merged pull requests:
- Replace LICENSE with version from apache.org #4 (bastelfreak)
- Add
dependencies
to metadata.json #1 (bastelfreak)
v1.0.1 (2017-05-29)
- Regression fix. re-add hidden files to allowdevfiles
1.0.0 - 2017-03-29
- Sync rkhunter.conf template with default file from version 1.4.2.
- Add and update parameters accordingly
- Remove travis tests for Puppet 3 and Ruby < 2.3.
- Module should still work with older versions, but test tools are not compatible
added parameters
mail_cmd
bindir
unhidetcp_opts
port_path_whitelist
warn_on_os_change
updt_on_os_change
show_summary_warnings_number
show_summary_time
empty_logfiles
missing_logfiles
renamed parameters
hash_func
tohash_cmd
(renamed upstream)phlanx2_dirtest
tophalanx2_dirtest
(fix typo)
0.2.0 - 2016-02-19
Fixed
- ERB deprecation warnings (Puppet 4 support)
Changed
- Updated the metadata to the new format
- Some new defaults for RedHat and Debian
- Added specific OS versions to the metadata
Removed
- FreeBSD support
0.1.4 - 2013-12-09
Changed
- Better RedHat/Centos suport
- Change cron command to use fqdn_rand function.
- Added CHANGELOG
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppetlabs/stdlib (>= 4.25.0 < 10.0.0)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.