Skip to content

simp/pupmod-simp-rkhunter

Repository files navigation

License CII Best Practices Puppet Forge Puppet Forge Downloads Build Status

Table of Contents

Description

A SIMP Puppet module for managing rkhunter, an application that checks for rootkits on a Linux system.

See REFERENCE.md for more details.

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 rkhunter affects

This module configures:

  • rkhunter package
  • unhide package
  • rkhunter cron jobs

Some tests require single-purpose tools, if rkhunter has them then it will use them. unhide is one such tool.

Beginning with rkhunter

To use this module with its default settings, just instantiate it. The following example adds it to the include list for a SIMP system.

---
simp_classes:
  - rkhunter

Alternatively, you can simply include rkhunter.

Usage

The class will install the packages and cron jobs automatically.

The output of the cron jobs will be sent to the default cron mechanism.

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.