Table of Contents

1. Description
2. Setup - The basics of getting started with chkrootkit
   • What chkrootkit affects
   • Beginning with chkrootkit
3. Usage - Configuration options and additional functionality
4. Reference - An under-the-hood peek at what the module is doing and how
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module
   • Acceptance Tests - Beaker env variables

Description

chkrootkit is a Puppet module that manages chkrootkit, a daemon that checks for rootkits on Linux system.

This is a SIMP module

This module is a component of the System Integrity Management Platform, a compliance-management framework built on Puppet.

If you find any issues, they may be submitted to our bug tracker.

This module is optimally designed for use within a larger SIMP ecosystem, but it can be used independently:

• When included within the SIMP ecosystem, security compliance settings will be managed from the Puppet server.

Setup

What chkrootkit affects

This module configures:

• chkrootkit package
• chkrootkit cron job

Beginning with chkrootkit

To use this module with it's default settings, just instantiate it. The following example is in hiera:

---
classes:
  - chkrootkit

Usage

The class will install the package and crob job automatically.

The output of the cron job will be sent to the default cron mechanism unless simp_options::syslog or chkrootkit::syslog is set to true.

Reference

Please refer to the inline documentation within each source file, or to the module's generated YARD documentation for reference material.

Limitations

SIMP Puppet modules are generally intended for use on Red Hat Enterprise Linux and compatible distributions, such as CentOS. Please see the metadata.json file for the most up-to-date list of supported operating systems, Puppet versions, and module dependencies.

Development

Please read our [Contribution Guide] (https://simp.readthedocs.io/en/stable/contributors_guide/index.html)

Acceptance tests

This module includes Beaker acceptance tests using the SIMP Beaker Helpers. By default the tests use Vagrant with VirtualBox as a back-end; Vagrant and VirtualBox must both be installed to run these tests without modification. To execute the tests run the following:

bundle install
bundle exec rake beaker:suites

Please refer to the SIMP Beaker Helpers documentation for more information.

Reference

Table of Contents

Classes

• chkrootkit: Sets up chkrootkit to be run once per week with results sent to syslog by default.

Classes

chkrootkit

Sets up chkrootkit to be run once per week with results sent to syslog by default.

Parameters

The following parameters are available in the chkrootkit class:

• minute
• hour
• monthday
• month
• weekday
• syslog
• log_dest
• package_ensure

minute

Data type: Simplib::Cron::Minute

Cron minute

Default value: '0'

hour

Data type: Simplib::Cron::Hour

Cron hour

Default value: '0'

monthday

Data type: Simplib::Cron::MonthDay

Cron monthday

Default value: '*'

month

Data type: Simplib::Cron::Month

Cron month

Default value: '*'

weekday

Data type: Simplib::Cron::Weekday

Cron weekday

Default value: '0'

syslog

Data type: Boolean

Enable syslog log forwarding

Default value: simplib::lookup('simp_options::syslog', { 'default_value' => false })

log_dest

Data type: String

Set to local6.notice, any other syslog destination to forward to syslog. Worthless if $syslog is false.

Default value: 'local6.notice'

package_ensure

Data type: String

The ensure status of packages to be managed

Default value: simplib::lookup('simp_options::package_ensure', { 'default_value' => 'installed' })

• Wed Oct 11 2023 Steven Pritchard steve@sicura.us - 0.6.0

• [puppetsync] Updates for Puppet 8
  • These updates may include the following:
    • Update Gemfile
    • Add support for Puppet 8
    • Drop support for Puppet 6
    • Update module dependencies

• Mon Jun 12 2023 Chris Tessmer chris.tessmer@onyxpoint.com - 0.5.0

• Add RockyLinux 8 support

• Mon Jun 14 2021 Chris Tessmer chris.tessmer@onyxpoint.com - 0.4.0

• Removed support for Puppet 5
• Ensured support for Puppet 7 in requirements and stdlib

• Thu Dec 17 2020 Chris Tessmer chris.tessmer@onyxpoint.com - 0.3.1

• Removed EL6 support

• Mon Mar 02 2020 Trevor Vaughan tvaughan@onyxpoint.com - 0.3.0-0

• Bump upper bound on simplib

• Fri Aug 02 2019 Robert Vincent pillarsdotnet@gmail.com - 0.3.0-0

• Drop Puppet 4 support
• Add Puppet 6 support
• Add puppetlabs-stdlib 6 support

• Mon Mar 25 2019 Joseph Sharkey shark.bruhaha@gmail.com - 0.2.0-0

• Standardized cron datatypes to use the Simplib::Cron::### types. This allows more flexibility in cron scheduling.

• Thu Mar 07 2019 Liz Nemsick lnemsick.simp@gmail.com - 0.1.1-0

• Update the upper bound of stdlib to < 6.0.0
• Update a URL in the README.md

• Thu Nov 01 2018 Jeanne Greulich jeanner.greulich@onyxpoint.com - 0.1.0-0

• Update badges in README.md
• Static asset updates for puppet 5

• Thu Oct 11 2018 Nick Miller nick.miller@onyxpoint.com - 0.1.0-0

• Added $package_ensure parameter
  • Changed the package from 'latest' to 'installed'
  • It will also respect simp_options::package_ensure

• Fri Sep 07 2018 Liz Nemsick lnemsick.simp@gmail.com - 0.1.0-0

• Drop Hiera 4 support

• Sat Mar 17 2018 Trevor Vaughan tvaughan@onyxpoint.com - 0.1.0-0

• Added OEL and Puppet 5 support

• Thu Jul 06 2017 Liz Nemsick lnemsick.simp@gmail.com - 0.0.2-0

• Remove OBE pe dependency in metadata.json

• Wed Dec 7 2016 Nick Miller nick.miller@onyxpoint.com 0.0.1-0

• Initial release of module
• Content used to be in simplib