brandonrdn / pupmod-simp-chkrootkit Goto Github PK

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

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

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.

This module configures:

• chkrootkit package
• chkrootkit cron job

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

---
classes:
  - chkrootkit

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.

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

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.

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

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.