derdanne / puppet-rkhunter Goto Github PK

#rkhunter

####Table of Contents

1. Overview
2. Module Description - What the module does and why it is useful
3. Setup - The basics of getting started with rkhunter
   • What rkhunter affects
   • Setup requirements
   • Beginning with rkhunter
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module

##Overview

The rkhunter module provides the installation procedure for Rkhunter including the setup of the initial rkhunter database.

##Module Description

The rkhunter module provides a security feature that scan the local system for rootkit fragments and warn you, if detetcted.

##Setup

###What rkhunter affects

• rkhunter package.
• rkhunter configuration file.
• rkhunter database.

You need to activate the EPEL repository before you can setup the SSMTP instance. If you use a rpm based system from the RedHat family you can use my yum module (thbe-yum):

class { "::yum": repo_epel => true }

###Beginning with rkhunter

include '::rkhunter' is enough to get you up and running if the parameters point to proper values. If you wish to pass in parameters like which servers to use then you can use:

class { '::rkhunter':
  rootEmail => '[email protected]',
}

##Usage

All interaction with the rkhunter module can be done through the main rkhunter class. This means you can simply toggle the options in the rkhunter main class to get the full functionality.

###I just want rkhunter, what's the minimum I need?

include '::rkhunter'

###I just want to route all mails to central mail gateway, nothing else.

class { '::rkhunter':
  root_email => '[email protected]',
  tftp => true,
}

##Reference

###Classes

• rkhunter: Main class, includes all the rest.
• rkhunter::install: Handles the packages.
• rkhunter::config: Handles the configuration file.
• rkhunter::service: Handles the database rebuild.

###Parameters

The following parameters are available in the rkhunter module

####root_email

Set the root email adress that get notifications if events occur.

####remote_syslog Set to true if remote syslog is used

####tftp

Ignore check errors forced by tftp.

####check_mk

Ignore check errors forced by check_mk.

####oracle_xe

Ignore check errors forced by Oracle XE.

####sap_daa

Ignore check errors forced by SAP DAA.

####sap_icm

Ignore check errors forced by SAP ICM.

####sap_db

Ignore check errors forced by SAPDB/MaxDB.

####sshd_root

Surpress warning if root login is permit. Should be the same as PermitRootLogin in sshd_config

####web_cmd

Command used to pull files from the internet (ie: when --update is specified)

##Limitations

This module has been built on and tested against Puppet 3.2 and higher.

The module has been tested on:

• RedHat Enterprise Linux 5/6
• Scientific Linux 5/6

Testing on other platforms has been light and cannot be guaranteed.

##Development

If you like to add or improve this module, feel free to fork the module and send me a merge request with the modification.

###Contributors

The list of contributors can be found at: https://github.com/thbe/puppet-rkhunter/graphs/contributors